runCalc

Runs calculations in an application.

Using this command, you can run calculations using rules in a Model POV against data in a different Data POV without copying rules across POVs.

Applies to

Profitability and Cost Management

Required Roles

  • Service Administrator
  • Power User

Usage

epmautomate runCalc APPLICATION_NAME POV_NAME [DATA_POV_NAME] PARAMETER=VALUE [comment="comment"] stringDelimiter="DELIMITER" where:
  • APPLICATION_NAME is the name of the Profitability and Cost Management application that contains the POV to be calculated.

  • POV_NAME is the name of the model POV to be calculated.

  • DATA_POV_NAME is, optionally, the name of the data POV that is to be calculated using the rules of the model POV.

    If DATA_POV_NAME is not specified, by default, POV_NAME will be used.

    You can use only exeType=ALL_RULES if you specify DATA_POV_NAME.

  • PARAMETER=VALUE indicates runtime parameters and their values to run the calculation. Specify as many parameter and value pairings as the process requires. Valid parameters and their values:

    • exeType=ALL_RULES|RULESET_SUBSET|SINGLE_RULE identifies the rule execution type. This is a required parameter.

      Depending on the value set for exeType, the following parameters may be specified:

      • If you specify exeType=ALL_RULES, do not include rule subset or single rule related parameters such as subsetStart, subsetEnd, ruleSetName, and ruleName. Must use this exeType if you set DATA_POV_NAME parameter.
      • If you specify exeType=SINGLE_RULE, specify the values for ruleSetName and ruleName only.
      • If you specify exeType=RULESET_SUBSET, specify the values for subsetStart and subsetEnd.
    • subsetStart specifies the sequence number of the first rule in the rule set to run
    • subsetEnd specifies the sequence number of the last rule in the rule set to run
    • ruleSetName identifies the rule set that contains the calculations you want to run
    • ruleName name of the rule to run (to run a single rule)
    • isClearCalculated=true|false specifies whether to clear existing calculations
    • isExecuteCalculations=true|false specifies whether to run calculations
    • isRunNow=true|false set this value to true to run the process now
    • optimizeReporting=true|false set this optional value to false if the calculations are to be run without optimization for reporting. Default is true

      Best Practice:

      • Set optimizeReporting=false only when necessary to save processing time; for example, when running a single rule or a sequential series of several POVs
      • When running multiple concurrent calculation jobs, set optimizeReporting=true for all jobs; only the last job to complete will perform the aggregation, avoiding redundant processing and preventing running jobs from slowing down.

    Note:

    Parameter values (true or false) must be in all lower case.
  • comment is an optional comment enclosed in double quotation marks
  • stringDelimiter is the delimiter used in POV values. Delimiter must be enclosed in double quotation marks.

Example

epmautomate runCalc BksML12 2012_Jan_Actual Jan-2016 isClearCalculated=true isExecuteCalculations=true isRunNow=true subsetStart=10 subsetEnd=20 ruleSetName="Utilities Expense Adjustment" ruleName="Occupancy Expense Allocations" exeType="ALL_RULES" comment="Test calculation" stringDelimiter="_"