Skip to main content

Global variables

When an interface program runs a function, it automatically defines three associative array variables at global scope. These variables are:

general

Contains key-value pairs that describe the event, such as the operation name, date and time of the event, as well as the IP address of the user that generated the event. The key-value pairs include:

  • operation The name of the event

  • sessid The identifier for the event

  • batchsig The batch identifier for the event

  • hextime The number of seconds since January 1, 1970

  • ctime The time that the event occurred as a human-readable string

  • date The date the event occurred in YYYYMMDD format

  • hhmmss The time the event occurred in HH:MM:SS format

  • remote_addr The address of the person who made the request

  • logfilename The log file for the program that ran pxnull

  • adminid The target administrator for the external system, if configured for a IT Service Management (Ticket) system target

  • adminpwd The password for the external system administrator

  • sysid The system administrator for the external system, if supported by the target type

  • syspwd The system administrator password, if supported by the target type

  • targetaddress The target address for the external system, if configured for a ticket system target.

sessdat

Contains key-value pairs in the session of the user that generated the event. The contents will vary greatly from one event to another, but typically includes:

  • adminid The ID of the console/help desk user who made the request

  • userid The ID of the person who made the request

  • username The full name of the person who made the request

sesslog

This variable is an array of associative arrays. Each associative array in sesslog corresponds to a single entry in the session log for the current login.

Each associative array includes the following key-value pairs:

  • tstart Hexadecimal representation of the start time, in the Unix epoch, counted in seconds

  • tend End time (as above)

  • reqby The user that issued the operation user The user affected by the operation

  • hostid The ID of the target system affected by the operation

  • host The description of the target system affected by the operation

  • longid This is the account ID of the user on the target specified in the hostid value

  • oper The type of operation

  • result The result code or the error message

    Key names are case sensitive and must be lowercase.

In this section: