Using Substitution Variables in Enterprise Profitability and Cost Management REST APIs

Enterprise Profitability and Cost Management jobs support substitution variables as job parameters. These substitution variables are resolved at runtime, and the job executes accordingly.

When using substitution variables as job parameters, keep in mind the following:

  • The substitution variable should start with &.

  • If it does not start with &, it will be treated as a regular parameter.

  • If the substitution variable does not exist or an invalid name is passed, the job fails with an error.

Example:

In the payload below, &currYear and &execType are substitution variables. These substitution variables are resolved at runtime, and the job executes accordingly.

{
    "jobType":"Calculation",
    "jobName":"Calculation",
    "parameters":{
        "povDelimiter":":",
        "povName":"&currYear:Jan:Actual:Working",,
        "modelName":"10 Actuals Allocation Process",
        "executionType":"&execType",
        "rulesetSeqNumStart":"1",
        "rulesetSeqNumEnd":"1",
        "clearCalculatedData":"true",
        "executeCalculations":"true",
        "optimizeForReporting":"true",
        "captureDebugScripts":"false"
    }
}