Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

Description

Lists the specified variable(s).

Syntax

uagcmd ops-variable-list global parameters variable-name=name variable-scope=scope [task-name=name] [trigger-name=name] [options=v]
 

Note
titleNote

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameters

Html bobswift
<ul>
<li> <code>variable-name=</code> <br>Optional; Name or partial name of one or more variables. 

Wildcards

Html bobswift
 are supported.
<li> <code>variable-scope=</code> <br>Optional; One of the following (not case sensitive): <b>global</b> (default), <b>task</b>, <b>trigger</b>, <b>local</b> (task or trigger). Defines the type of variable being listed. A <b>global</b> variable is created independently by selecting 

Variables

Html bobswift
 from the Universal Controller user interface navigator. A <b>trigger</b> variable is attached to a trigger; a <b>task</b> variable is attached to a task. A <b>local</b> variable can be either a task or trigger variable.
<li> <code>task-name=</code> <br>Required if <code>variable-scope=</code><b>task</b>; A single task name.
<li> <code>trigger-name=</code> <br>Required if <code>variable-scope=</code><b>trigger</b>; A single trigger name.
<li> <code>options=</code> <br>Optional; <b>v</b> (Return verbose results.)
</ul>

Example

Panel
html-bobswift
<pre>uagcmd ops-variable-list 

-c config.cfg

Html bobswift
 variable-name=abc variable-scope=task task-name=Task A</pre>

Anchor
ops-variable-set
ops-variable-set
Set Variables

Description

Sets the specified variable.

Syntax

uagcmd ops-variable-set global parameters variable-name=name variable-scope=scope variable-value=string [variable-description=description] [task-name=name] [trigger-name=name] create=option
 

Note
titleNote

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameters

Html bobswift
<ul>
<li> <code>variable-name=</code> <br> Required; Name of a specific variable. The name must begin with an alphabetic character and can consist of: alphabetic characters (a-z, A-Z), numbers (0-9), _ (underscore). White spaces are not permitted; names are not case-sensitive.
<li> <code>variable-scope=</code> <br>Optional; One of the following (not case sensitive}: <b>global</b> (default), <b>task</b>, <b>trigger</b>. In cases where there may be more than one occurrence of the specified variable, <code>variable-scope=</code> defines which one should be set. A global variable is created independently by selecting <b>Variables</b> from the Universal Controller user interface navigation pane. A trigger variable is attached to a trigger; a task variable is attached to a task.
<li> <code>variable-value=</code> <br>Required; String that will become the value of the specified variable. UTF-8 character set is supported.
<li> <code>variable-description=</code> <br>Optional; Description of the variable.
<li> <code>task-name=</code> <br>Required if <code>variable-scope=</code><b>task</b>; A single task name.
<li> <code>trigger-name=</code> <br>Required if <code>variable-scope=</code><b>trigger</b>; A single trigger name.
<li> <code>create=</code> <br>Required; Specification (<b>yes</b> or <b>no</b>) for whether or not a new variable may be created for this request.
</ul>

Example

Panel
Html bobswift
<pre>uagcmd ops-variable-set 

-c config.cfg

Html bobswift
 variable-name=myvar1 variable-value=mydata1 create=yes </pre>
Warning
titleWarning

CLI supports modifying only certain types of variables - see Modifying Variables.