System Variables - EcoSys - 2.0 - Help - Hexagon PPM

EcoSys Connect Help

Language
English
Product
EcoSys
Search by Category
Help
EcoSys Version
2.0

All system variables can be used as an assignment in SOAP Processors or SOAP Writer as well as SQL Reader, SQL Processor and SQL Writer from Connect 2.0.

Statistic System Variable

Name

Description

$__SYS(SUCCESS_WRITE_CNT)

Success Count which includes stats inside of one step by the moment system variable has been called.

$__SYS(FAILURE_WRITE_CNT)

Failure Count which includes stats inside of one step by the moment system variable has been called.

$__SYS(TOTAL_SUCCESS_WRITE_CNT)

Success Count which includes stats from previous steps as well as from nested and parent jobs by the moment when system variable has been called.

$__SYS(TOTAL_FAILURE_WRITE_CNT)

Failure Count which includes stats from previous steps as well as from nested and parent jobs by the moment when system variable has been called.

$__SYS(RESEND_CNT)

Number of records resent during the current job’s execution

$__SYS(TOTAL_RESEND_CNT)

Number of record results across all the jobs

  • These system variables will only have values of SOAP Processors/Writers that have the Statistic settings configured.

  • Consider introducing Reducer processor before the SOAP processor/SOAP Writer while using system variables inside of one step if previous operation returns entity set. If Reducer processor is not used, all the entities in the SOAP input will be sent with the same statistic values.

Job/User System Variables

Name

Description

$__SYS(ROOT_JOB_NAME)

Job name of the root job

$__SYS(PARENT_JOB_NAME)

Job name of the immediate parent job

$__SYS(JOB_NAME)

Current job name

$__SYS(JOB_PARAMETERS)

Job runtime parameters values

$__SYS(USER)

User name in step component

$__SYS(JOB_EXEC_ID)

Execution ID of the current job

$__SYS(PARENT_JOB_EXEC_ID)

Execution ID of the parent job

$__SYS(ROOT_JOB_EXEC_ID)

Execution ID of the root job

$__SYS(CURRENT_TIME[,formatSpec]

Current time of the job

The IDs ( $__SYS(JOB_EXEC_ID, $__SYS(PARENT_JOB_EXEC_ID), and $__SYS(ROOT_JOB_EXEC_ID) are visible in Connect in the beginning of the Job Execution Logs

For example, 'SystemVariables' job, 'd' step, jobExecutionId='722' started with parameters: {}

In Connect 2.0, the following new Map and Transform functions are added. These are supported only for SQL Processor and SQL Writer:

  • $__MAP(<attr>): Used to get an attribute from an entity set. Similar to $__CTX.

  • For example, if the previous step has a field called NAME, you can reference it in your SQL Statement using $__MAP(NAME)

  • $__TRANSFORM (<what>__,<type>__,<parameters>): Transforms the <what> based on the <type> and <parameters>. The __, is a delimiter. We only support four types of Transform parameters – PREFIX, SUFFIX, DATEFORMAT, and REPLACE.

    • For PREFIX/SUFFIX, the parameter is the actual prefix/suffix string.

    • For DATEFORMAT, the parameter is the date format like mm/dd/yyyy.

    • For REPLACE, the parameter is - ["<Search String>","<Replace String>"]

$__TRANSFORM can be nested.

Example 1: $__TRANSFORM($__TRANSFORM($__MAP(a)__,PREFIX__,pre)__,SUFFIX__,post)

Example 2: Remove single quotes from the EcoSys Response error messages- $__TRANSFORM($__MAP(resultMessageString)__,REPLACE__,["'",""]

Support was added to the following Reader, Processors, Writers for these functions:

$__MAP and $__Transform are only supports in SQL Processor and SQL Writer.

SQL Reader

SQL Processor

SQL Writer

$__PARAM(<var>)

Y

Y

Y

$__SYS(<var>)

Y

Y

Y

$__STORE(<var>)

Y

Y

Y

$__CTX(<var>)

Y

Y

$__MAP(<attr>)

Y

Y

$__TRANSFORM(<what>__,<type>__,<parameters>)

Y

Y