Run ML Calculations

Run or clear calculations for a selected application. You can run calculations using rules in a model POV against data in a different data POV without copying rules.

REST Resource

POST /epm/rest/{api_version}/applications/{application}/povs/{povGroupMember}/jobs/runLedgerCalculationJob


Supported Media Types: application/json


The following table summarizes the client request.

Table 13-18 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application Name of the application for which to run calculations Path Yes None

The model POV group member from which the rules will be used for calculations, such as 2016_January_Actual

If dataPOVName is not passed, povGroupMember is used as both model and data POV.

Path Yes None

The data POV group member for which to run calculations, such as 2015_January_Actual

exeType=ALL_RULES is the valid combination while using dataPOVName.

Payload No None
isClearCalculated Whether to clear the calculation data, true or false Payload No None
isRunNow Whether to run now (true) or schedule for later (false); schedule for later is not currently supported Payload Yes true

Whether to optimize for reporting (true) or not (false).

When optimizieReporting is used, Profitability and Cost Management runs default aggregations on the Essbase cube when the calculation is complete. You can also run this setting by itself, which improves performance for queries and analytics.

If you don't pass this parameter, its setting is assumed to be true ("About Optimizing for Reporting" in Administering Profitability and Cost Management ).

Payload No true
subsetStart Rule Set Starting Sequence Number Payload No None
subsetEnd Rule Set Ending Sequence Number Payload No None
ruleName Rule Name for a SINGLE_RULE option Payload No None
ruleSetName Rule Set Name for a SINGLE_RULE option Payload No None

The execution type specifies which rules to run; possible values are ALL_RULES, RULESET_SUBSET, SINGLE_RULE. Other parameters are required based on the exeType value:

  • exeType = ALL_RULES overrides all other options like subsetStart, subsetEnd, ruleSetName, and ruleName.

  • exeType = RULESET_SUBSET considers only subsetStart and subsetEnd.

  • exeType = SINGLE_RULE considers only ruleSetName and ruleName.

Payload Yes None
comment Use comment text, such as "This is run by user1" Payload No None
stringDelimiter String delimiter for POV group members, such as _ Payload No None

Example URL and Payload without Passing Data POV

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>{api_version}/applications/{application}/povs/{povGroupMember}/jobs /runLedgerCalculationJob

{"isClearCalculated":"true","isExecuteCalculations":"true","isRunNow":"true","optimizeReporting":"false","comment":"This is run by user1","exeType":"ALL_RULES","stringDelimiter":"_"}

Example URL and Payload with Data POV Passed


{"dataPOVName":"2015_January_Actual","isClearCalculated":"true","isExecuteCalculations":"true","isRunNow":"true","optimizeReporting":"false","comment":"This is run by user1","exeType":"ALL_RULES","stringDelimiter":"_"}

Response Body

Supported Media Types: application/json

Table 13-19 Parameters

Name Description
details Task ID, such as BksML1_BksML1_RunCalcs_D20160113T070358_1da_1
status See Migration Status Codes
statusMessage Message about the status, such as In Progress
type Profitability
links Detailed information about the link
href Links to API call
action The HTTP call type
rel Relationship type
data Parameters as key value pairs passed in the request

Example of Response Body:

The following shows an example of the response body in JSON format.

     "type": "Profitability",
     "status": -1,
     "statusMessage": "In Progress",
     "details": "BksML1_BksML30_RunCalcs_D20180201T203648_b92",
     "links": [
          "data": {
             "isExecuteCalculations": true,					 "subsetStart": 10,             "ruleSetName": "Occupancy Expense Allocations",             "comment": "This is run by sasi",             "subsetEnd": 20,             "ruleName": "Utilities Expense Adjustment",					 "isClearCalculated": true,             "isRunNow": true,             "exeType": "ALL_RULES",					 "optimizeReporting": false,             "stringDelimiter": "_"
          "action": "POST",
          "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>",
          "rel": "self",
          "action": "GET",
          "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>",
          "action": "GET",
           "rel": "Job status"