Using Substitution Parameters with Events

Substitution parameters are placeholders that can be replaced with actual values at runtime. You can use substitution parameters in Event comments, and also to specify directory paths.

Raiser Comments

A raiser comment is a comment that is generated by the user, Job, or Workflow that raised an Event. You can specify default raiser comments in an Event Definition. The following substitution parameters are available for raiser comments in Job and Workflow Definitions.

  • ${jobid}: The ID of the raiser Job or Workflow Call.
  • ${jobdescription}: The name of the Job or Workflow.
  • ${jobstatus}: The status of the Job or Workflow at the time it raised the Event.

The default raiser comment is:

Event raised by process: ${jobid} (${jobdescription}) going to status ${jobstatus}.

File Event Raiser Comments

Events can also be raised by files on servers with a Platform Agent and on AS/400 systems.

The following substitution parameters are available for raiser comments for File Events:

  • ${CurrentDateTime}: The Platform Agent date/time when the file was detected.
  • ${CurrentTimeStamp}: The Platform Agent timestamp at which the file was detected, in a numeric format containing the milliseconds since 1970, usually referred to as epoch or UNIX time.
  • ${FileDateTime}: The file modification date/time.
  • ${FileTimeStamp}: The file modification time in epoch.
  • ${ServerDateTime}: The RunMyJobs server date/time when the Event was raised.
  • ${ServerTimeStamp}: The RunMyJobs server time in epoch when the Event was raised.
  • ${processServer: The name of the Job Server.
  • ${server}: The Platform Agent name.
  • ${filename}: The path of the detected file (before any move).
  • ${finalPath}: The new path of the detected file (after any move).

Note: All DateTime variables use the format yyyyMMddHHmmss. You can specify a Java DateTimeFormatter pattern using the ${FileDateTime:HHmmss} syntax.

Note: ${DateTime} and ${TimeStamp} are deprecated. The new equivalents are ${CurrentDateTime} and ${CurrentTimeStamp}.

The default File Event raiser comment is:

File Event raised by "${filename}" on "${server}"

The following topics cover File Events in more details:

File Event Move Directory

All DateTime variables use the format yyyyMMddHHmmss. You can specify a Java DateTimeFormatter using the ${FileDateTime:HHmmss} syntax.

  • ${BaseDirectory}: The path of the directory containing the detected file.
  • ${BaseName}: The base filename of the detected file.
  • ${Name}: The filename of the detected file.
  • ${Dot}: The dot (.) such as found in filenames before the extension.
  • ${Extension}: The extension of the detected file.
  • ${CurrentDateTime}: The Platform Agent date & time when the file was detected.
  • ${CurrentTimeStamp}: The Platform Agent timestamp at which the file was detected, in a numeric format containing the milliseconds since 1970, usually referred to as epoch or UNIX time.
  • ${DateTime}: Deprecated in favor of CurrentDateTime.
  • ${TimeStamp}: Deprecated in favor of CurrentTimeStamp.
  • ${FileDateTime}: The file modification date & time.
  • ${FileTimeStamp}: The file modification time in epoch time.
  • ${fileName}: The filename (full path of file) of the detected file.
  • ${UniqueId}: The unique ID of the File Event.

Note: ${DateTime} and ${TimeStamp} have been deprecated and should not be used. The equivalents are ${CurrentDateTime} and ${CurrentTimeStamp}, respectively.

Clearer Comments

The following substitution parameters are available for clearer comments in Job and Workflow Definitions.

  • ${jobid}: The ID of the clearer job.
  • ${jobdescription}: The name of the raiser Job or Workflow, as displayed in the Monitor screen at the time the Event is cleared.