Show TOC

Background documentationSubstitution Parameters Locate this document in the navigation structure

 

You use substitution parameters in specific objects to insert dynamic values, like a file name or a job id. Depending on the repository object, specific substitution parameters can be used.

Job Definitions

The following substitution parameters can be used in some job definitions:

  • ${SystemId} - system id with all characters except A-Z, a-z and 0-9 replaced with underscores.

  • ${date:format} - date using format 'format'. The format is any valid Java SimpleDateFormat.

Platform agent

The platform agent (see the documentation shipped with SAP CPS for more information on this feature) logfile can contain a filename pattern, stderr, or - (for stderr). May contain any of the following substitution parameters:

  • ${ProcessId} - Process id of the process

  • ${ProcessType} - Process type (standalone, service, ...)

  • ${ProcessName} - Process name (network-processor, ...)

  • ${InstallDirectory} - install directory.

  • ${TraceDirectory} - ${DataRootDirectory}/trc.

  • ${DataRootDirectory} - Base directory for platform agent files.

  • ${ProcessServer} - Name of the process server that the agent is configured for.

  • ${FileSeparator} - Character(s) between directory and file (for example / on Unix and \ on Windows).

Events

The following substitution parameters are available for raiser comments in job definitions and job chains:

  • ${jobid} - The job id of the raiser job

  • ${jobdescription} - the raiser job name, as displayed by the job monitor at the time of raising the event.

  • ${jobstatus} - The status of the job at the time it raised the event.

The following substitution parameters are available for raiser comments of file events:

  • ${CurrentDateTime} - Current date & time

  • ${CurrentTimeStamp} - Current time in epoch

  • ${FileDateTime} - File modification date & time

  • ${FileTimeStamp} - File modification time in epoch

  • ${ServerDateTime} - Central server date & time

  • ${ServerTimeStamp} - Central server time in epoch

  • ${server} - Platform agent name

  • ${filename} - file name

For the above, you can specify a JavaDateFormat for the *DateTime variables as follows:

${FileDateTime:HHmmss}

The following substitution parameters are available for the Move Directory field of file events:

  • ${Name} - The base filename plus extension of the detected file.

  • ${BaseName} - The base filename of the detected file.

  • ${Extension} - The extension of the detected file.

  • ${Dot} - A dot if the detected file had an extension, and nothing otherwise.

  • ${TimeStamp} - The modification timestamp that the detected file has, in a numeric format containing the milliseconds since 1970, usually referred to as epoch or Unix time.

  • ${DateTime} - The modification timestamp that the detected file has, in a string format YYYYMMDDHHMMSS.

Queries

The columnFormat parameters of the Table.formatRow(table, key, rowStart, columnFormat, columnSeparator, rowEnd) function takes the following substitution parameters:

  • {0} - column header

  • {1} - value

  • {2} - columnSeparator (should always be the first)