Creating User Variable

To create a user variable:

  1. In Resource Manager, in the Folder Tree panel, select the folder where you want to create the user variable.

  2. In the Folder Tree panel, click Resource, and then click User Variable.

  3. Complete the remaining fields as described in the User Variable Fields section. Active from and to dates can be set in the Advanced tab.

    Unified CCE requires that all user variable names begin with the string user. The Code Text will therefore automatically be prefixed with this string on saving.For example, if you enter a Code Text of Temp, the resulting user variable will be called userTemp.

  4. Click Save.

In addition to creating user variables one at a time, you can also bulk load user variable records previously output to a CSV (comma separated values) file. For more information see About Bulk Upload.

User Variable Fields

This table shows the tabs and fields available for user variables.

 

Field

Description

Entry

Default

Required

Details Tab

Code Text

The name of the user variable.

Up to 28 characters, consisting of letters, numbers, and underscores only.

Automatically prefixed with ‘user’ by the system upon saving.

Null

Yes

Object Type

The type of object with which to associate the variable. You may choose not to associate the user variable with an object by selecting OT_USER_VARIABLE.

Select from list

Null

Yes

Data Type

The data type for the variable.

Select from list

Long

No

Persistent

Whether the user variable retains value across Central Controller restarts.

Check box

Checked

No

Description

A description of the record.

Up to 255 characters.

Null

No

Path

Only shown when resource is first created. The location in the folder tree where the resource is to be created.

Click on the drop-down arrow to show the folder tree, then select the required location.

Current location in folder tree.

Yes

Advanced Tab

Active From Date

The date from which this variable will be active within the system.

Select date from calendar.

Current Date

Yes

Active To Date

The date after which this variable will be deleted from the system.

Either leave Forever checked, or uncheck Forever and select date from calendar.

Forever

No

Custom Data Tab

Key

The key for this custom data item.

Unique. Up to 50 characters, alphanumeric, period, and underscore characters only. Must begin with alphanumeric.

If this resource type has default keys defined in a custom data template, there will be a an initial entry for each default key.

Either an entry for each default key, or null if no default keys.

No

Value

The value to associate with this key.

Up to 500 characters.

To add a new custom data key-value pair, complete both fields, and click Add. You can have a maximum of ten custom data key-value pairs.

To edit an existing key-value pair, rest the mouse briefly on the entry, select the edit icon ( ) and make your changes. Then select the tick to confirm the change, or the cross to undo the change.

To delete an existing key-value pair, rest the mouse briefly on the entry, select the delete icon ( ), then click OK to confirm the deletion.

Note: For predefined default keys you cannot delete the entry or edit the key field. You can only edit the value field.

Null

  • No: For predefined default keys.

  • Yes: If new key being defined.
Related Information