1. REST API Reference
  2. APIs for Detailed Profitability
  3. Run DP Calculation

Run DP Calculation

Use this operation to process and run calculations for a selected application.

Table 4-18 Run DP Calculation

Name Description
Action Type POST
Request URI http://myServer.mydomain.com:19000/profitability/rest/v1/applications/BksDP30/povs/2012_January_Actual/jobs/detailedCalculationProcessJob/2012_January_Actual
Request Payload 
{
"comment":"This is run by user1",
"isClearCalculated":"true",
"isExecuteCalculations":"true",
"isCreateContributionDetail":"true",
"isCreateDetailCalculatedDriverTables":"false",
"isAbortOnError":"true",
"isRunSingleCalcRuleSequence":"true",
"calcRuleSequence":1,
"isTransferToSrcStgDb":"false",
"isTransferToDstStgDb":"false",
"isTransferToContribDb":"false",
"postScript":"POST",
"preScript":"PRE",
"stringDelimter":"_"
}
Response 
{
    "type": "Profitability",
    "links": [{
        "href": "http://slc06vya.mydomain.com:19000/profitability/rest/v1/applications/BksDP30/povs/2012_January_Actual/jobs/detailedCalculationProcessJob/2012_January_Actual",
        "action": "POST",
        "rel": "self",
        "data": {
            "isExecuteCalculations": true,
            "isTransferToContribDb": false,
            "isTransferToSrcStgDb": false,
            "postScript": "POST",
            "calcRuleSequence": 1,
            "isRunSingleCalcRuleSequence": true,
            "isTransferToDstStgDb": false,
            "comment": "This is run by user1",
            "isAbortOnError": true,
            "stringDelimter": "_",
            "preScript": "PRE",
            "isClearCalculated": true,
            "isCreateContributionDetail": true,
            "isCreateDetailCalculatedDriverTables": false
        }
    }, {
        "href": "http://SLC06VYA.mydomain.com:19000/profitability/rest/v1/applications/jobs/ChecktaskStatusJob/BksDP30_BksDP30_RunCalcs_D20160113T072425_5fc_1",
        "action": "GET",
        "rel": "Job status"
    }],
    "status": -1,
    "details": "BksDP30_BksDP30_RunCalcs_D20160113T072425_5fc_1",
    "statusMessage": "IN_PROGRESS"
}
Process Type Asynchronous

Table 4-19 Request Parameters

Parameter Description Example
comment Specify a comment for this Run DP Calculation Job. This is run by user1
isClearCalculated Boolean flag specifying whether previously calculated values should be cleared. Valid values are TRUE or FALSE true
isExecuteCalculations

Boolean flag specifying whether calculations should be executed as part of this operation. Valid values are TRUE or FALSE.

Note:

When the isExecuteCalculations flag is set to TRUE, you must provide values for isCreateContributionDetail, isCreateDetailCalculatedDriverTables
true
isCreateContributionDetail Boolean flag specifying contribution detail should be created. Valid values are TRUE or FALSE. true
isCreateDetailCalculatedDriverTables Boolean flag specifying whether previously calculated values should be cleared. Valid values are TRUE or FALSE false
isAbortOnError Boolean flag specifying whether to abort on occurrence of any error while processing calculations. Valid values are TRUE or FALSE. true
isRunSingleCalcRuleSequence

Boolean flag specifying whether to run single calculation Rule Sequence or not. Valid values are TRUE or FALSE.

Note:

When the isRunSingleCalcRuleSequence flag is set to TRUE, you must provide value for calcRuleSequence
true
calcRuleSequence Valid int value (calculation rule sequence number). 1
isTransferToSrcStgDb Boolean flag specifying whether to do data transfers to source stage Database or not. Valid values are TRUE or FALSE. false
isTransferToDstStgDb Boolean flag specifying whether to do data transfers to destination stage Database or not. Valid values are TRUE or FALSE false
isTransferToContribDb Boolean flag specifying whether to do data transfers to Contribution Database or not. Valid values are TRUE or FALSE. false
postScript Name of the post-calculation script POST
preScript Name of the pre-calculation script PRE
stringDelimter

Optional delimiter used to separate logical entities in parameters

For example, when passing POVs at a time, please use this to delimit POVs, such as: 2023_January_ActuaL when passing POV MEMBERS TO 2023, January , Actual

 _

Response Values: None