:PUT_ATT_APPEND

Read or Modify Objects

:PUT_VAR_COL

---

:PUT_VAR

Script Statement: Stores a value in a Variable object.

Syntax

:PUT[_VAR] Variable, [Key], Value, [Value], [Value], [Value], [Value] 

Comments

A runtime error occurs if a dynamic variable (source: SQL, SQL internal, multi or data type) is used in this script element. Only static Variable objects can be filled using :PUT_VAR.

The following general rules apply:

• Key and Value are added if the variable does not contain a value.
• Value is replaced, if the variable contains a value of the same Key.

Separate the individual values by using commas, if you want to fill several value columns of a variable. Static variables are limited to 5 value columns.

If a key is not specified for a static Variable object, the system automatically selects the key based the Scope setting on the Attributes tab of the Variable object.

The parameter Key is optional if the setting Scope - "no validity key" is selected in the Attributestab. In this case, the variable contains only one value. Ensure that the commas are set in the statement even if Key is not used.

You can also specify the individual values without using inverted commas. Commas are used as separators.

Variable objects may have different numbers of values. If you enter more values than the object provides, an error message is displayed.

When using this script statement with the static Variable object XML, the values for XML data type will be beautified automatically. That means, you may use XML in a single script line for example, but in the object the value will be rearranged according to the XML standard.

For example: Values are entered in all the five value columns.

 :PUT_VAR VARA.TEST, "KEY1", "Value1", "Value2", "Value3", "Value4", "Value5" 

To write a value that includes one or several commas in one line, you must enclose this value in single-quote or double-quote characters.
For example: "Value1" is written to the value column 1 and "Value2, Value3, Value4" to column 2.

:PUT_VAR VARA.TEST, "KEY1", "Value1", "Value2, Value3, Value4"

In the following example for the Variable object XML only one value is used, as the Variable object of the type XML only contains one value field:

:PUT_VAR VARA.XML, "KEY1", "<Value1>this is a test</value1>"

One of the following formats must be selected in order to store a value in a variable  of data type "timestamp":

• "YYYY-MM-DD HH:MM:SS"
• "YYMMDD HHMMSS"
• "YYYYMMDD HHMMSS"
• "YYYYMMDDHH24MISS"

The data types "Time", "Date" and "Number" require the value to be specified in the defined output format (Attributes tab).
Important note for the data type "Number": Redundant decimal places are truncated if an attempt is made to store a number with more decimal places than have been defined in the output format.

This script function writes values to a Variable object even if a user has opened it in order to ensure that there is no interference with processing. A warning displays if a user tries to store the modifications that were made in this Variable object. It contains the information that the variable has been modified in the meantime. The user can now decide whether the modifications should be stored or removed.

For the data type "String", leading blanks remain in the content. Blanks at the end of the string are truncated.

The following peculiarity applies if :PUT_VAR is used before a :READ statement: If script generation is canceled manually using the "Cancel" button or due to invalid default values (see "Generate at runtime"), the Variable object still contains the values that were set with :PUT_VAR.

Examples

In the following example the current date and time are determined and saved in a Variable object of the data type "Time stamp". Date and time are transferred to the script statement as script variables.

:SET &DATE# = SYS_DATE("YYYY-MM-DD")
:SET &TIME# = SYS_TIME("HH:MM:SS")
:PUT_VAR BOOKING.DATE, , "&DATE# &TIME#"

The variable "ATTRIBUTES", which is used in the following example, contains the scope "Freely selected". Therefore, the Key must be entered.

:SET &PRIO# = GET_ATT("UC4_PRIORITY")
:PUT_VAR ATTRIBUTES, "CurrentPriority", &PRIO#

 In the following example, a task's name, object type and parent information are stored with the task's RunID in the Variable object "OBJECT_STAT".

:SET &PNAME# = SYS_ACT_PARENT_NAME()
:SET &PNR# = SYS_ACT_PARENT_NR()
:SET &PTYPE# = SYS_ACT_PARENT_TYPE()
:SET &NAME# = SYS_ACT_ME_NAME()
:SET &NR# = SYS _ACT_ME_NR()
:SET &TYPE# = SYS_ACT_ME_TYPE()

:PUT_VAR OBJECT_STAT, "&NR#", "object name: &NAME#", "object type: &TYPE#", "parent name: &PNAME#", "parent runid: &PNR#", "parent object type: &PTYPE#"

See also:

Script Elements - Read or Modify Objects

Variable

Sample Collection:
Display with Cockpit
Database Maintenance with Options
Calling an MBean

About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function