List of Object Attributes

The variables that are shown in the following tables represent object attributes. The object types in which you can use them are shown in the Object type column. The name of the corresponding attribute is also listed.

Notes:

• The Variable name is the technical name of the predefined variable. It will be replaced by the corresponding value at runtime.

• The Security level is defined by using the setting VAR_SECURITY_LEVEL in the variable UC_SYSTEM_SETTINGS. This setting determines whether the variables of SQL statements are replaced by dynamic Variable objects and, if so, which ones. For more information, see VAR_SECURITY_LEVEL and UC_SYSTEM_SETTINGS - Systemwide Settings. This setting determines whether the variables of SQL statements are replaced by dynamic Variable objects and, if so, which ones.

The security level is always 1 if the value of the predefined variable refers to a script function. Security level 1 should also be assigned if the value is derived from an attribute that the user cannot directly influence using the script element :PUT_ATT.

Example

Attribute: ACCOUNT, Variable: &$ACCOUNT#

Variables for attributes that can be modified at runtime (and therefore pose a security risk) correspond to security level 2.

Example

Attribute: HOST, variable &$AGENT#

Attributes

[A] [C] [D] [E] [F] [G] [H] [I] [J] [L] [M] [N] [O] [Q] [R] [S] [T] [U] [V] [W]

Note: The attributes are listed alphabetically according to their Variable name.

A

• Name: Spool-list recipient (address type)
  Variable name: &$ADDRESSTYPE#
  Description: The type of address
  Attribute: SAP_ADDRESSTYPE
  Object type: JOBS (SAP)
  Security level: 2

• Name: Agent
  Variable name: &$AGENT#
  Description: The name of the agent on which the task is processed
  Attribute: HOST
  Object type: EVNT, JOBQ, JOBS
  Security level: 2

• Name: Agent ID
  Variable name: &$AGENT_ID#
  Description: The name of the agent on which the task is processed
  Attribute: AGENT_ID
  Object type: JOBS (JMX)
  Security level: 2

• Name: Responsibility (application short name) (Oracle)
  Variable name: &$APPL_NAME#
  Description: Profile option for Oracle users: short name of the application
  Attribute: OA_APPL_NAME
  Object type: JOBS (OA)
  Security level: 2

• Name: Archive key 1
  Variable name: &$ARCHIVE_KEY1#
  Description: Freely definable term that is used in the statistics
  Attribute: ARCHIVE_KEY1
  Object type: All executable objects
  Security level: 2

• Name: Archive key 2
  Variable name: &$ARCHIVE_KEY2#
  Description: Freely definable term that is used in the statistics
  Attribute: ARCHIVE_KEY2
  Object type: All executable objects
  Security level: 2

• Name: Attach a file
  Variable name: &$ATTACH_FILE#
  Description: The path and the name of the file that is included with the e-mail
  Attribute: ATTACH_FILE
  Object type: CALL
  Security level: 2

• Name: Attach reports from task (RunID)
  Variable name: &$ATTACH_REPORTS_RUNID#
  Description: The RunID of the task whose reports is attached to the e-mail
  Attribute: ATTACH_REPORTS_RUNID
  Object type: CALL
  Security level: 2

• Name: Attach reports from task (RunID)
  Variable name: &$ATTACH_REPORTS_SOURCE#
  Description: The report sources that are attached to the e-mail (database, external files or all)
  Attribute: ATTACH_REPORTS_SOURCE
  Object type: CALL
  Security level: 2

C

• Name: Queue for child tasks
  Variable name: &$CHILD_QUEUE#
  Description: The name of the Queue object in which the child tasks are processed
  Attribute: CHILD_QUEUE
  Object type: OBG, JOBP, JSCH
  Security level: 2

• Name: Start parameter (command)
  Variable name: &$CMD#
  Description: The individual shell command or sequence of shell commands
  Attribute: The program that is executed
  Object type: UNIX_CMD
  Security level: JOBS (UNIX)

• Name: Start parameter (command)
  Variable name: &$CMD#
  Description: The program that is executed
  Attribute: WIN_CMD
  Object type: JOBS (WIN)
  Security level: 2

• Name: CodeTable
  Variable name: &$CODE#
  Description: The name of the CodeTable that is used by the task
  Attribute: CODE
  Object type: JOBS
  Security level: 2

D

• Name: Connection (MS Access file name)
  Variable name: &$DATA_SOURCE#
  Description: The path and file name of the MS Access database
  Attribute: DATA_SOURCE
  Object type: JOBS (SQL)
  Security level: 2

• Name: Connection (database)
  Variable name: &$DATABASE_NAME#
  Description: The name of the database
  Attribute: DATABASE_NAME
  Object type: JOBS (SQL)
  Security level: 2

• Name: Target agent
  Variable name: &$DST_AGENT#
  Description: The name of the destination agent
  Attribute: FT_DST_HOST
  Object type: JOBF
  Security level: 2

• Name: Target login info (SAP client)
  Variable name: &$DST_CLIENT#
  Description: The SAP client of the destination's Login object
  Attribute: FT_DST_CLIENT
  Object type: JOBF
  Security level: 1

• Name: Target CodeTable
  Variable name: &$DST_CODE#
  Description: The name of the destination's CodeTable
  Attribute: FT_DST_CODE
  Object type: JOBF
  Security level: 2

• Name: Target file
  Variable name: &$DST_FILE#
  Description: The name of the source file (using directory, folder or ID plus wildcard characters in partially qualified file transfers)
  Attribute: FT_DST_FILE
  Object type: JOBF
  Security level: 2

• Name: Target file attributes
  Variable name: &$DST_FILE_ATTRIBUTES#
  Description: Additional specification of file attributes for the destination file
  Attribute: FT_DST_FILE_ATTRIBUTES
  Object type: JOBF
  Security level: 2

• Name: Target login
  Variable name: &$DST_LOGIN#
  Description: The name of the Login object that is used to log on to the destination system
  Attribute: FT_DST_LOGIN
  Object type: JOBF
  Security level: 2

• Name: Start parameter (destination system)
  Variable name: &$DST_SYSTEM#
  Description: The destination system in SAP
  Attribute: SAP_DST_SYSTEM
  Object type: JOBS (SAP)
  Security level: 2

E

• Name: Enter parameter
  Variable name: &$ENTER_PARAMS#
  Description: Any parameters that is entered
  Attribute: ENTER_PARAMS, ENTER_PAR, EP
  Object type: JOBS (BS2000)
  Security level: 2

• Name: Start parameter (Enterprise Server)
  Variable name: &$ENTERPRISE_SERVER#
  Description: The name of the Enterprise Server
  Attribute: ENTERPRISE_SERVER
  Object type: JOBS (SIEBEL)
  Security level: 2

• Name: Escalation after n minutes
  Variable name: &$ESCAL_TIME#
  Description: The time limit in minutes after which the responsible recipient must respond
  Attribute: CO_RISING_TIME
  Object type: CALL
  Security level: 2

• Name: Escalation notification
  Variable name: &$ESCALATION#
  Description: Additional Notification object that is activated if the responsible recipient does not respond
  Attribute: CO_RISING_NAME
  Object type: CALL
  Security level: 2

F

• Name: File name for the job
  Variable name: &$FILENAME_JOB#
  Description: Name of the file (without path) that the agent creates for the job that is executed
  Attribute: FILENAME_JOB
  Object type: JOBS
  Security level: 1

• Name: File name for the system output (SYSLST)
  Variable name: &$FILENAME_SYSLST#
  Description: The name of the file (without path) that the agent creates for the system output (SYSLST)
  Attribute: FILENAME_SYSLST
  Object type: JOBS
  Security level: 1

• Name: File name for the system output (report)
  Variable name: &$FILENAME_SYSOUT#
  Description: The name of the file (without path) that the agent creates for the system output (report)
  Attribute: FILENAME_SYSOUT
  Object type: JOBS
  Security level: 1

• Name: Agent for the file check
  Variable name: &$FSC_AGENT#
  Description: The name of the agent that is used for the Output Scan
  Attribute: FSC_HOST
  Object type: JOBF, JOBQ, JOBS
  Security level: 2

• Name: Login for the file check
  Variable name: &$FSC_LOGIN#
  Description: The name of the Login object that is used for the Output Scan
  Attribute: FSC_LOGIN
  Object type: JOBF, JOBQ, JOBS
  Security level: 2

G

• Name: Start parameter (Gateway Server)
  Variable name: &$GATEWAY_SERVER#
  Description: The network address of the Siebel Gateway computer
  Attribute: GATEWAY_SERVER
  Object type: JOBS (SIEBEL)
  Security level: 2

• Name: Report selection (message classes)
  Variable name: &$GET_MSGCLASSES#
  Description: The message classes that is read and routed
  Attribute: MVS_GETMSGCLASSES
  Object type: JOBS (ZOS)
  Security level: 2

• Name: Group
  Variable name: &$GROUP#
  Description: The name of the group in which the task is processed
  Attribute: GROUP, START_TYPE, S
  Object type: CALL, EVNT, JOB, JOBP, JOBS, JSCH, SCRI
  Security level: 2

H

• Name: Start parameter (virtual terminal)
  Variable name: &$HOME_TERMINAL#
  Description: HP NonStop Server device name
  Attribute: HOME_TERMINAL
  Object type: JOBS (NSK)
  Security level: 2

I

• Name: Initial Context Factory
  Variable name: &$INITIAL_CONTEXT_FACTORY#
  Description: Indicates the Initial Context Factory
  Attribute: INITIAL_CONTEXT_FACTORY
  Object type: JOBS (JMX)
  Security level: 2

• Name: Account
  Variable name: &$INT_ACCOUNT#
  Description: The specification of an internal account
  Attribute: INT_ACCOUNT, INT_ACC, K
  Object type: CALL, EVNT, JOBF, JOBP, JOBS, JSCH, SCRI
  Security level: 2

J

• Name: Runtime options (OS/390 file name)
  Variable name: &$JCL_SOURCE#
  Description: The name of the dataset or member that includes the job's JCL or the job's JCL and its job card
  Attribute: JCL_SOURCE
  Object type: JOBS (ZOS)
  Security level: 2

• Name: Job class
  Variable name: &$JOB_CLASS#
  Description: The job class in which the job should run
  Attribute: JOB_CLASS, JC
  Object type: JOBS (BS2000, SAP, ZOS)
  Security level: 2

• Name: Job name
  Variable name: &$JOB_NAME#
  Description: The name that is used to execute the job in the destination system
  Attribute: JOB_NAME, JN
  Object type: JOBS (BS2000, OS400, SAP, VMS, ZOS)
  Security level: 2

• Name: Runtime option (job parameter)
  Variable name: &$JOB_PARAMS#
  Description: Further job parameters
  Attribute: MVS_JOB_PARAMS
  Object type: JOBS (ZOS)
  Security level: 2

• Name: Job type
  Variable name: &$JOB_TYPE#
  Description: Type of z/OS job (such as JCL from z/OS)
  Attribute: MVS_JOBTYPE
  Object type: JOBS (ZOS)
  Security level: 1

• Name: Job type
  Variable name: &$JOB_TYPE#
  Description: The type of NSK job (such as TACL)
  Attribute: NSK_JOB_TYPE
  Object type: JOBS (NSK)
  Security level: 1

• Name: Job type
  Variable name: &$JOB_TYPE#
  Description: The type of OS/400 job (such as CMD)
  Attribute: OS400_JOBTYPE
  Object type: JOBS (OS400)
  Security level: 2

• Name: Job type
  Variable name: &$JOB_TYPE#
  Description: The type of SAP job (such as ABAP Engine/Business Intelligence)
  Attribute: SAP_JOB_TYPE
  Object type: JOBS (SAP)
  Security level: 1

• Name: Job type
  Variable name: &$JOB_TYPE#
  Description: The type of Unix job (such as Shell)
  Attribute: UNIX_TYPE
  Object type: JOBS (UNIX)
  Security level: 2

• Name: Job type
  Variable name: &$JOB_TYPE#
  Description: The type of Windows job (such as BAT)
  Attribute: WIN_TYPE
  Object type: JOBS (WIN)
  Security level: 2

• Name: Runtime option (job description)
  Variable name: &$JOBD#
  Description: The name of the job description that is used for this job in the form library/job description
  Attribute: OS400_JOBD
  Object type: JOBS (OS400)
  Security level: 2

• Name: Spool
  Variable name: &$JOBLOG#
  Description: Spool extent (for example, only QPJOBLOG or everything)
  Attribute: OS400_JOBLOG
  Object type: JOBS (OS400)
  Security level: 2

• Name: Runtime option (job queue)
  Variable name: &$JOBQ#
  Description: The name of the job queue in which the job is queued
  Attribute: OS400_JOBQ
  Object type: JOBS (OS400)
  Security level: 2

L

• Name: Start parameter (language)
  Variable name: &$LANGUAGE#
  Description: Login language
  Attribute: LANGUAGE
  Object type: JOBS (SIEBEL)
  Security level: 2

• Name: Start parameter (language)
  Variable name: &$LANGUAGE#
  Description: The language that is used in SAP
  Attribute: SAP_LANG
  Object type: JOBS (SAP)
  Security level: 2

• Name: Date of last object usage
  Variable name: &$LAST_DATE#
  Description: Last used on
  Attribute: LAST_DATE
  Object type: All executable objects
  Security level: 1

• Name: User (last object usage)
  Variable name: &$LAST_USER#
  Description: Last used by
  Attribute: LAST_USER
  Object type: All executable objects
  Security level: 1

• Name: Login
  Variable name: &$LOGIN#
  Description: The name of the Login object that is used to log on to the destination system
  Attribute: LOGIN
  Object type: JOBS
  Security level: 2

M

• Name: Max. parallel-running jobs
  Variable name: &$MAX_PARALLEL_START#
  Description: The maximum number of jobs that can run at the same time
  Attribute: MAX_PARALLEL_START
  Object type: JOBQ
  Security level: 2

• Name: Max. parallel-running executions
  Variable name: &$MAX_PARALLEL_TASKS#
  Description: The setting that defines the maximum number of parallel executions for this object
  Attribute: MAX_PARALLEL_TASKS
  Object type: CALL, EVNT, JOBF, JOBP, JOBS, JSCH, SCRI
  Security level: 2

• Name: Max. parallel-running file transfers
  Variable name: &$MAX_PARALLEL_TRANSFERS#
  Description: The maximum number of partially-qualified file transfer files that can be transferred at the same time
  Attribute: MAX_PARALLEL_TRANSFERS
  Object type: JOBF
  Security level: 2

• Name: Runtime option (message class)
  Variable name: &$MSG_CLASS#
  Description: The job log assignment to an output class
  Attribute: MVS_MSGCLASS
  Object type: JOBS (ZOS)
  Security level: 2

• Name: Runtime option (message level)
  Variable name: &$MSG_LEVEL#
  Description: The output option (trace option) for the report
  Attribute: MVS_MSG_LEVEL
  Object type: JOBS (ZOS)
  Security level: 2

N

• Name: Runtime option (notify)
  Variable name: &$NOTIFY#
  Description: The notification indication on OS/390
  Attribute: MVS_NOTIFY
  Object type: JOBS (ZOS)
  Security level: 2

O

• Name: Object title
  Variable name: &$OBJECT_TITLE#
  Description: The title of the object
  Attribute: OBJECT_TITLE
  Object type: All executable objects
  Security level: 1

Q

• Name: Queue
  Variable name: &$QUEUE#
  Description: The name of the Queue object in which the task will be processed
  Attribute: QUEUE
  Object type: CALL, EVNT, JOBF, JOBG, JOBP, JOBQ, JOBS, JSCH, SCRI
  Security level: 2

R

• Name: Spool-list recipient (receipt)
  Variable name: &$RECEIPT#
  Description: Sends a receipt of delivery
  Attribute: SAP_DELIVER
  Object type: JOBS (SAP)
  Security level: 2

• Name: Spool-list recipient (address)
  Variable name: &$RECIPIENT#
  Description: Recipient
  Attribute: SAP_RECIPIENT
  Object type: JOBS (SAP)
  Security level: 2

• Name: Report handling (release)
  Variable name: &$RELMSGCLASS#
  Description: Releases the job log for printing
  Attribute: MVS_RELMSGCLASS
  Object type: JOBS (ZOS)
  Security level: 2

• Name: Resource consumption
  Variable name: &$RESOURCE_CONSUMPTION#
  Description: The resources that are consumed during the execution
  Attribute: RESOURCE_CONSUMPTION
  Object type: JOBF, JOBQ, JOBS
  Security level: 2

• Name: Responsibility (key)
  Variable name: &$RESP_NAME#
  Description: The profile option for the Oracle user: Responsibility key
  Attribute: OA_RESP_NAME
  Object type: JOBS (OA)
  Security level: 2

• Name: Report handling (route)
  Variable name: &$ROUTEMSGCLASS#
  Description: The message classes that is routed
  Attribute: MVS_ROUTEMSGCLASS
  Object type: JOBS (ZOS)
  Security level: 2

• Name: Runtime option (routing data)
  Variable name: &$RTGDTA#
  Description: The routing data that initiates the job's first routing step
  Attribute: OS400_RTGDTA
  Object type: JOBS (OS400)
  Security level: 2

S

• Name: Login info (SAP client)
  Variable name: &$SAP_CLIENT#
  Description: The SAP client that is specified in the Login object
  Attribute: SAP_CLIENT
  Object type: JOBS (SAP)
  Security level: 2

• Name: Connection (Server)
  Variable name: &$SERVER_NAME#
  Description: The name of the computer on which the database is available
  Attribute: SERVER_NAME
  Object type: SERVER_NAME
  Security level: 2

• Name: Server URL
  Variable name: &$SERVER_URL#
  Description: The URL of the computer on which the MBean Server is available
  Attribute: SERVER_URL
  Object type: JOBS (JMX
  Security level: 2

• Name: Start parameter (Shell)
  Variable name: &$SHELL#
  Description: The Unix Shell that is used to run the job
  Attribute: UNIX_SHELL
  Object type: JOBS (UNIX)
  Security level: 2

• Name: Start parameter (Shell options)
  Variable name: &$SHELL_OPTIONS#
  Description: Indication of Shell options
  Attribute: UNIX_SHELL_OPTIONS
  Object type: JOBS (UNIX)
  Security level: 2

• Name: Start parameter (Siebel Server)
  Variable name: &$SIEBEL_SERVERS#
  Description: The name of the Siebel Server
  Attribute: SIEBEL_SERVERS
  Object type: JOBS (SIEBEL)
  Security level: 2

• Name: Source agent
  Variable name: &$SRC_AGENT#
  Description: The name of the source agent
  Attribute: FT_SRC_HOST
  Object type: JOBF
  Security level: 2

• Name: Source login info (SAP client)
  Variable name: &$SRC_CLIENT#
  Description: The SAP client of the source's Login object
  Attribute: FT_SRC_CLIENT
  Object type: JOBF
  Security level: 1

• Name: Source CodeTable
  Variable name: &$SRC_CODE#
  Description: The name of the source's CodeTable
  Attribute: FT_SRC_CODE
  Object type: JOBF
  Security level: 2

• Name: Source file
  Variable name: &$SRC_FILE#
  Description: The name of the destination using a file name, directory, folder or ID
  Attribute: FT_SRC_FILE
  Object type: JOBF
  Security level: 2

• Name: Source file attributes
  Variable name: &$SRC_FILE_ATTRIBUTES#
  Description: Additional specification of file attributes for the source file
  Attribute: FT_SRC_FILE _ATTRIBUTES
  Object type: JOBF
  Security level: 2

• Name: Source login
  Variable name: &$SRC_LOGIN#
  Description: The name of the Login object that is used in order to log on to the source system
  Attribute: FT_SRC_LOGIN
  Object type: JOBF
  Security level: 2

• Name: Start parameter (start mode)
  Variable name: &$STARTMODE#
  Description: The method that is used to start the job (such as immediately)
  Attribute: SAP_STARTMODE
  Object type: JOBS (SAP)
  Security level: 2

• Name: Spool list recipient (report status by mail)
  Variable name: &$STARTMODE#
  Description: Sends a confirmation of receipt by e-mail
  Attribute: SAP_STATUSBYMAIL
  Object type: JOBS (SAP)
  Security level: 2

• Name: Subject
  Variable name: &$STATUSBYMAIL#
  Description: Subject of the notification
  Attribute: SUBJECT
  Object type: CALL
  Security level: 2

   

T

• Name: TimeZone
  Variable name: &$TIMEZONE#
  Description: The name of a TimeZone object
  Attribute: TIMEZONE
  Object type: CALL, EVNT, JOBF, JOBG, JOBP, JOBQ, JOBS, JSCH, SCRI
  Security level: 2

• Name: Type
  Variable name: &$TYPE#
  Description: Notification types are request, alert, etc.
  Attribute: CO_TYPE
  Object type: CALL
  Security level: 2

• Name: Type
  Variable name: &$TYPE#
  Description: The type of Event object
  Attribute: EVENT_TYPE, EVENT_TYP
  Object type: EVNT
  Security level: 2

U

• Name: AE priority
  Variable name: &$UC4_PRIORITY#
  Description: The priority that is used in order to execute this object in AE
  Attribute: UC4_PRIORITY
  Object type: CALL, EVNT, JOBF, JOBP, JOBQ, JOBS, JSCH, SCRI
  Security level: 2

• Name: Number of object usages
  Variable name: &$USAGE_COUNT#
  Description: The number of times that the object has been used so far
  Attribute: USAGE_COUNT
  Object type: All executable objects
  Security level: 1

• Name: User (object creator)
  Variable name: &$USER_CREATED#
  Description: The name of the User object
  Attribute: USAGE_CREATED
  Object type: All executable objects
  Security level: 1

• Name: User (last object modification)
  Variable name: &$USER_MODIFIED#
  Description: The name of the User object
  Attribute: USER_MODIFIED
  Object type: All executable objects
  Security level: 1

V

• Name: Start parameter (Queue name)
  Variable name: &$VMS_QUEUE#
  Description: The VMS queue in which the job is executed
  Attribute: VMS_QUEUE_NAME
  Object type: JOBS (VMS)
  Security level: 2

W

• Name: Start parameter (start directory)
  Variable name: &$WORK_DIR#
  Description: The working directory in which the job should run
  Attribute: WIN_WORK_DIR
  Object type: JOBS (WIN)
  Security level: 2

See also:

• Variables for System and Object Values
• List of System Properties
• List of Object Script Values
• Date and Time Formats Variable
• Variables and VARA Objects
• VARA Objects
• List of VARA Objects for System and Client Values
• List of Agent Variables
• List of Predefined Read Buffer Variables