Attributes Enumerated

Many attributes are available that provide access to system, settings, process and task attributes. When you use the Insert Variable function, applicable attributes are included in the selection menu.

The following example show a list of System Attributes available when inserting a token into a task variable:

The tables in this section provide a description for each of the different type of attribute objects.

System Attributes

[SYSTEM.ATTRIBUTES.X]

Variable	Description
[SYSTEM.COMPUTER]	The computer name where the scheduler is running.
[SYSTEM.DATE]	The system date of the computer running the scheduler.
[SYSTEM.EXPIRATION_DATE]	The date the license will expire.
[SYSTEM.EXPIRATION_DAYS]	The number of days until the license will expire.
[SYSTEM.PRODUCTION_DATE]	The current production date for the scheduler.
[SYSTEM.PRODUCTION_DAY]	Name of day of the week.
[SYSTEM.ROOT_PATH]	Root directory for scheduler installation.
[SYSTEM.SCHEDULER_NAME]	The name given to the scheduler in settings.
[SYSTEM.SERVER_UID]	The unique ID of the scheduler.
[SYSTEM.START_TIME]	The time the scheduler was last started.
[SYSTEM.TIME]	Current system time of the scheduler.

Process Attributes

[PROCESS.X]

Variable	Description
[PROCESS.ALIAS]	A user defined name assigned to the run instance of the process that displays as a column in the processes list. It can be set with a data mapper or script.
[PROCESS.CATEGORY]	Category assigned to the process.
[PROCESS.DEF_ID]	Definition ID.
[PROCESS.ENDED]	Time that process ended.
[PROCESS.ERROR_MSG]	Error message.
[PROCESS.FOLDER]	Folder that owns this process definition.
[PROCESS.NAME]	Name of this process.
[PROCESS.OUTPUT]	Any output generated by the process.
[PROCESS.PRODUCTION_DATE]	Production date of the process.
[PROCESS.PRODUCTION_DAY]	Production day, 3-digit day in the year count.
[PROCESS.RUN_ID]	Run instance ID of the process.
[PROCESS.START]	Start time for the process.
[PROCESS.STARTED]	Start time including seconds.

[PROCESS.OWNER.X]

Variable	Description
[PROCESS.OWNER.DOMAIN]	Domain of the owner of the process.
[PROCESS.OWNER.EMAIL]	E-mail address of the owner of the process.
[PROCESS.OWNER.LOGIN]	Login of the owner of the process.
[PROCESS.OWNER.NAME]	Name of the owner of the process.
[PROCESS.OWNER.OTHER]	Other field value of the owner of the process.
[PROCESS.OWNER.PHONE]	Telephone number for the owner of the process.

Process Item Attributes

Process item attributes. Replace PROCESS with the alias of your process item.

[ITEMS.PROCESS.X]

Variable	Description
[ITEMS.PROCESS.ALIAS]	Unique name for the item within the process.
[ITEMS.PROCESS.DEF_ID]	ID of the process item definition.
[ITEMS.PROCESS.ENDED]	End time for the item.
[ITEMS.PROCESS.ERROR_MSG]	Error message generated from executing the item.
[ITEMS.PROCESS.FOLDER]	Name of the folder where the item definition is defined.
[ITEMS.PROCESS.NAME]	Name of the item definition.
[ITEMS.PROCESS.OUTPUT]	Output generated by the item.
[ITEMS.PROCESS.RUN_ID]	Run instance ID for the item.
[ITEMS.PROCESS.STARTED]	Time the item started.
[ITEMS.PROCESS.VALUE]	The item value. This can be assigned with a data mapper or script item within the process.

[ITEMS.PROCESS.AGENT.X]

Attributes of the agent assigned to the process.

Variable	Description
[ITEMS.PROCESS.AGENT.COMPUTER]	The name of the computer where the agent is running.
[ITEMS.PROCESS.AGENT.NAME]	The name of the agent.
[ITEMS.PROCESS.AGENT.PORT]	The port number of the agent
[ITEMS.PROCESS.AGENT.SYSTEM]	System information for the agent.

[ITEMS.PROCESS.OWNER.X]

User or Roles Attributes for the process owner. If the owner is a role, there is no login or domain attributes.

Variable	Description
[ITEMS.PROCESS.OWNER.DOMAIN]	Process item owner's domain.
[ITEMS.PROCESS.OWNER.EMAIL]	Process item owner's e-mail address.
[ITEMS.PROCESS.OWNER.LOGIN]	Process item owner's login.
[ITEMS.PROCESS.OWNER.NAME]	Process item owner's name.
[ITEMS.PROCESS.OWNER.OTHER]	Process item owner's other field.
[ITEMS.PROCESS.OWNER.PHONE]	Process item owner's phone number.

Task Item Attributes

Attributes of a task item. Replace TASK with the alias of your task process item

[ITEMS.TASK.X]

Variable	Description
[ITEMS.TASK.ALIAS]	Unique name for the item within the process.
[ITEMS.TASK.DEF_ID]	ID of the item definition.
[ITEMS.TASK.ENDED]	End time for the item.
[ITEMS.TASK.ERROR_MSG]	Error message generated from executing the item.
[ITEMS.TASK.FOLDER]	Name of the folder where the item definition is defined.
[ITEMS.TASK.NAME]	Name of the item definition.
[ITEMS.TASK.OUTPUT]	Output generated by the item.
[ITEMS.TASK.RUN_ID]	Run instance ID for the item.
[ITEMS.TASK.STARTED]	Time the item started.
[ITEMS.TASK.VALUE]	The value returned from executing the item. Not all task types return a value.

[ITEMS.TASK.AGENT.X]

Attributes of the agent assigned to the task.

Variable	Description
[ITEMS.TASK.AGENT.COMPUTER]	The name of the computer where the agent is running.
[ITEMS.TASK.AGENT.NAME]	The name of the agent.
[ITEMS.TASK.AGENT.PORT]	The port number of the agent.
[ITEMS.TASK.AGENT.SYSTEM]	System information for the agent.

[ITEMS.TASK.ATTRIBUTE.X]

These are attributes specific to a task service type. The following example shows the attributes from a system command service.

Variable	Description
[ITEMS.TASK.ATTRIBUTE.COMMAND]	Command line for task.
[ITEMS.TASK.ATTRIBUTE.EXIT_CODE]	Actual exit code produced by task.
[ITEMS.TASK.ATTRIBUTE.EXIT_CODES]	Allowed exit codes.
[ITEMS.TASK.ATTRIBUTE.PARAMETERS]	Parameters sent to task.
[ITEMS.TASK.ATTRIBUTE.PROCESS_ID]	Process ID in which the task is member.
[ITEMS.TASK.ATTRIBUTE.START_DIR]	Start directory for task.

See specific task type for enumeration.

[ITEMS.TASK.OWNER.X]

Using the User record found on the Administrator's Workbench, this information is appropriately available to the task designer.

Variable	Description
[ITEMS.TASK.OWNER.DOMAIN]	Task item owner's domain.
[ITEMS.TASK.OWNER.EMAIL]	Task item owner's email.
[ITEMS.TASK.OWNER.LOGIN]	Task item owner's login.
[ITEMS.TASK.OWNER.NAME]	Task item owner's name.
[ITEMS.TASK.OWNER.OTHER]	Task item owner's other field.
[ITEMS.TASK.OWNER.PHONE]	Task item owner's phone.

Dependency Item Attributes

Attributes of a dependency item. Replace DEPENDENCY with the alias of your dependency process item.

[ITEMS.DEPENDENCY.X]

Variable	Description
[ITEMS.DEPENDENCY.ALIAS]	Unique name for the item within the process.
[ITEMS.DEPENDENCY.DEF_ID]	ID of the item definition.
[ITEMS.DEPENDENCY.ENDED]	End time for the item being me.
[ITEMS.DEPENDENCY.ERROR_MSG]	Error message generated from executing the item.
[ITEMS.DEPENDENCY.FOLDER]	Name of the folder where the item definition is defined.
[ITEMS.DEPENDENCY.NAME]	Name of the item definition.
[ITEMS.DEPENDENCY.STARTED]	Time the item started.

[ITEMS.DEPENDENCY.AGENT.X]

Attributes of the agent assigned to the dependency.

Variable	Description
[ITEMS.DEPENDENCY.AGENT.COMPUTER]	The name of the computer where the agent is running.
[ITEMS.DEPENDENCY.AGENT.NAME]	The name of the agent.
[ITEMS.DEPENDENCY.AGENT.PORT]	The port number of the agent
[ITEMS.DEPENDENCY.AGENT.SYSTEM]	System information for the agent.

[ITEMS.DEPENDENCY.OWNER.X]

Information about the owner of the dependency is located here. This reflects information found in the User record located within the Authoring.

Variable	Description
[ITEMS.DEPENDENCY.OWNER.DOMAIN]	Dependency item owner's domain.
[ITEMS.DEPENDENCY.OWNER.EMAIL]	Dependency item owner's email.
[ITEMS.DEPENDENCY.OWNER.LOGIN]	Dependency item owner's login.
[ITEMS.DEPENDENCY.OWNER.NAME]	Dependency item owner's name.
[ITEMS.DEPENDENCY.OWNER.OTHER]	Dependency item owner's other field.
[ITEMS.DEPENDENCY.OWNER.PHONE]	Dependency item owner's phone number.

User Input Item Attributes

User defined Attributes of a user input item. Replace USER_INPUT with the alias of your user input item.

[ITEMS.USER_INPUT.ATTRIBUTES]