Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

>
</content>
	<description>description</description>
        <notes>
   
&lt;notes&gt;
           <note>
   
&lt;note&gt;
                 <sysId>a8756a120a00010357097d05fa5c558e</sysId>
   
&lt;

sysId

XML Request

JSON Request


<pre>&lt;script
<script retainSysIds="true"
&gt; &lt;

content

&gt;echo
>
	<content>echo %*
&lt;

/content

Expand
titleXML Request
Panel
Html bobswift
Html bobswift
Html bobswift
&gt;
	&lt;

description

Html bobswift
&gt;description&lt;

/description

Html bobswift
Html bobswift
&gt;a8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift&gt;
                 <text>test</text>
   
&lt;

text

Html bobswift
&gt;test&lt;

/text

Html bobswift&gt;
                 
&lt;

title

Html bobswift
&gt;note 1&lt;

/title

Html bobswift&gt;
<title>note 1</title>
              
&lt;/note&gt;
</note>
        
&lt;/notes&gt; &lt;

opswiseGroups

Html bobswift&gt;
</notes>
	<opswiseGroups>
              
&lt;opswiseGroup&gt;1&lt;/opswiseGroup&gt;
<opswiseGroup>1</opswiseGroup>
              
&lt;opswiseGroup&gt;2&lt;/opswiseGroup&gt; &lt;

/opswiseGroups

Html bobswift
&gt;
	&lt;

resolveVariables

Html bobswift
&gt;false&lt;

/resolveVariables

Html bobswift
&gt;
	&lt;

scriptName

Html bobswift
&gt;test.bat&lt;

/scriptName

Html bobswift
&gt;
	&lt;

scriptType

Html bobswift
&gt;Script&lt;

/scriptType

Html bobswift
&gt;
	&lt;

sysId

Html bobswift
&gt;f8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift&gt; &lt;/script&gt; </pre>
<opswiseGroup>2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>



panel<pre>
{
  "
content
": "echo", 
  "
description
": "description",
  "notes": [ {
    "
sysId
": "a8756a120a00010357097d05fa5c558e",
    "
text
": "test",
    "
title
": "note"
  } ],
  "
opswiseGroups
": ["1","2"],
  "
resolveVariables
": false,
  "retainSysIds": true,
  "
scriptName
": "test.bat",
  "
scriptType
": "Script",
  "

sysId

sysId": "f8756a120a00010357097d05fa5c558e"
}
</pre>


Expand
titleJSON Request
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift


Anchor
Create a Script Script Properties
Create a Script Script Properties
Create a Script: Script Properties

<ul> <li> If <b>retainSysIds</b>
  • If retainSysIds="true"
and <code>sysId</code> is included in the
  • and sysId is included in the request/response,
<code>sysId</code> will be persisted to the database. <li> If <b>retainSysIds</b>
  •  sysId will be persisted to the database.
  • If retainSysIds="false"
and <code>sysId</code> is included in the
  • and sysId is included in the request/response,
<code>sysId</code> will be
  •  sysId will be ignored;
  • it
  • will
  • be
  • autogenerated
  • by
  • the
  • Controller.
</ul>

Property

UI Field Name

Description

Specifications

Required

Anchor
content - SCR
content - SCR
content

Content

Content of the script or SAP definition file.


Y

Anchor
description - SCR
description - SCR
description

Description

User-defined; description of this record.


N

Anchor
excludeRelated - SCR
excludeRelated - SCR
excludeRelated

n/a

Specification for whether or not to exclude related records (Notes) from an update, even if they are provided in the request.

Valid values: true/false (default is false).

N

Anchor
exportReleaseLevel - SCR
exportReleaseLevel - SCR
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - SCR
exportTable - SCR
exportTable

n/aRecord table information.read onlyN

Anchor
opswiseGroups - SCR
opswiseGroups - SCR
opswisewGroups

Member of Business Services

Business Services that this record belongs to.
 
XML

<pre> &lt;opswiseGroups&gt;
<opswiseGroups>
      
&lt;opswiseGroup&gt;group1&lt;/opswiseGroup&gt;
<opswiseGroup>group1</opswiseGroup>
      
&lt;opswiseGroup&gt;group2&lt;/opswiseGroup&gt; &lt;/opswiseGroups&gt; </pre>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>
Panel
Html bobswift

 
JSON

panel

html-bobswift
Panel
<pre>
"opswiseGroups": ["group1","group2"]
</pre>



N

Anchor
resolveVariables - SCR
resolveVariables - SCR
resolveVariables

Resolve UAC Variables

Controls whether or not the Script will be parsed in pursuit of Universal Controller variables. It allows the Controller to avoid the overhead of parsing a Script that does not contain variables.


N

Anchor
retainSysIds - SCR
retainSysIds - SCR
retainSysIds

n/a

Specification for whether or not the Create a Script web service will persist the sysId property.

Html bobswift
Note
titleNote

In XML web services, retainSysIds is specified as an attribute in the <script> element.


Valid values: true/false (default is true).

N

Anchor
scriptName - SCR
scriptName - SCR
scriptName

Script Name

Name of the script.

This name can be the same as the name of the script file.
 
You also can specify a file extension; the default file extension for Windows is .bat.
 
If the name has the extension .ps1, Windows will run the script as a powershell script.
 
You may have to create the appropriate file association and security for this to work.

Y

Anchor
scriptType - SCR
scriptType - SCR
scriptType

Script Type

Type of Script

Valid Values:

html-bobswift

<ul> <li>

  • As
  • String
  • =
  • Script,
  • As
  • Value
  • =
  • 1
  • (for
  • use
  • in
  • Windows
  • or
  • Linux/Unix
  • tasks)
<li>
  • As
  • String
  • =
  • SAP
  • Definition,
  • As
  • Value
  • =
  • 2
  • (for
  • use
  • in
  • SAP
  • tasks)
<li>
  • As
  • String
  • =
  • UDM
  • Script,
  • As
  • Value
  • =
  • 3
  • (for
  • use
  • in
  • UDM
  • File
  • Transfer
  • tasks)
<li>
  • As
  • String
  • =
  • Web
  • Service
  • Payload,
  • As
  • Value
  • =
  • 4
  • (for
  • use
  • in
  • Web
  • Service
  • tasks)
<li>
  • As
  • String
  • =
  • Data,
  • As
  • Value
  • =
  • 5
  • (for
  • use
  • in
  • a
  • script
  • or
  • task)
</ul>

Default is Script (1).

N

Anchor
sysId - SCR
sysId - SCR
sysId

n/a

System ID field in the database for this Script record.

Persisted only if retainSysIds is set to true.

N

...

&gt;&gt;
<sysId>a8756a120a00010357097d05fa5c558e</sysId>
                    
&lt;

text

XML Request

JSON Request


Expand
titleXML Request
Panel
Html bobswift
<pre>&lt;script&gt;
	&lt;

content

Html bobswift
&gt;echo %*&lt;

/content

Html bobswift
&gt;
	&lt;

description

Html bobswift
&gt;description&lt;

/description

Html bobswift
<script retainSysIds="true">
	<content>echo %*</content>
	<description>description</description>
        
&lt;notes&gt;
<notes>
              
&lt;note&gt;
<note>
                    
&lt;

sysId

Html bobswift
&gt;a8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift
Html bobswift
&gt;test&lt;

/text

Html bobswift&gt;
<text>test</text>
                    
&lt;

title

Html bobswift
&gt;note 1&lt;

/title

Html bobswift&gt;
<title>note 1</title>
              
&lt;/note&gt;
</note>
        
&lt;/notes&gt; &lt;

opswiseGroups

Html bobswift&gt;
</notes>
	<opswiseGroups>
              
&lt;opswiseGroup&gt;group1&lt;/opswiseGroup&gt;
<opswiseGroup>1</opswiseGroup>
              
&lt;opswiseGroup&gt;group2&lt;/opswiseGroup&gt; &lt;

/opswiseGroups

Html bobswift
&gt;
	&lt;

resolveVariables

Html bobswift
&gt;false&lt;

/resolveVariables

Html bobswift
&gt;
	&lt;

scriptName

Html bobswift
&gt;test.bat&lt;

/scriptName

Html bobswift
&gt;
	&lt;

scriptType

Html bobswift
&gt;Script&lt;

/scriptType

Html bobswift
&gt;
	&lt;

sysId

Html bobswift
&gt;f8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift&gt; &lt;/script&gt; </pre>
<opswiseGroup>2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>




html-bobswift

description

": "echo", 
  "
description": "description",
  "notes": [ {
    "
sysId
": "a8756a120a00010357097d05fa5c558e",
    "
text
": "test",
    "
title
": "note"
  } ],
  "
opswiseGroups
": ["
group1
1","
group2
2"],
  "
resolveVariables
": false,
  "

scriptName

retainSysIds": true,
  "scriptName": "test.bat",
  "
scriptType
": "Script",
  "
sysId
": "f8756a120a00010357097d05fa5c558e"
}
</pre>


Expand
titleJSON Request
Panel
<pre>
{
  "
content
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift


Anchor
Read a Script
Read a Script
Read a Script

...