Oracle Hyperion Profitability and Cost Management

REST API Developer’s Guide

Version 11.1.2.4.110

 

Table of Contents

About the Oracle Hyperion Profitability and Cost Management REST Web Services API 3

Manage Application Resources. 3

Create File based HPCM Application. 3

Create HPCM Application using AAM... 4

Enable File based Application. 5

Get Application Type Details. 5

Get Applications. 6

Get Applications by Type. 6

Get Essbase Application Dimensions. 7

Get Essbase Application Properties. 7

Get Essbase Applications. 8

Update File based Application using a Flat File. 8

Export Template. 9

Import Template. 9

Manage Cube Resources. 10

Clear ASO Cube (SP) 10

Essbase Data Load. 11

ML Deploy Cube. 12

SP Deploy Cube. 13

Manage POV Resources. 14

Clear POV Data (SP, DP) 14

Copy ML POV Data. 16

Copy SP and DP POV Data. 16

Get POVs by an Application. 18

Run ML Clear POV. 19

Manage Rule, Driver, and Stage Resources. 19

Get Assignment Rule Definitions (DP) 19

Get DP Driver Definitions. 20

Get Stages by an Application (SP, DP) 20

ML Rule Balancing. 21

Calculation Resources. 21

Run DP Calculation. 21

Run ML Calculation. 24

Run SP Calculation. 24

Run SP Genealogy Execution Paths. 26

Run SP Genealogy Execution Paths without ASO Cube Clear. 26

Run SP Multi POV Calculation. 27

Reporting Resources. 28

Prepare Detailed Views for Reporting (DP) 28

LCM Resources. 29

Import from Staging (SP, DP) 29

Miscellaneous Resources. 30

Apply Bulk Edit (DP) 30

Get Job Services for a POV. 32

Get Job Services by an Application. 32

Get Task Details by Process Name. 33

Get Task Status by Process Name. 34

REFERENCES. 35

REST Client Plugins. 35

Sample Code for Authentication. 35

Sample Client 35

 

 


 

About the Oracle Hyperion Profitability and Cost Management REST Web Services API

You can use the Oracle Hyperion Profitability and Cost Management REST Web Services API to automate a variety of Profitability and Cost Management tasks. This API provides an alternative to using the web-based user interface or the External Automation Web Services API.

You can use one of a variety of methods to access the Profitability and Cost Management REST API. For example, you can access the REST API through web browsers and other client applications such as cURL and GNU Wget.

Alternatively, you can use the Profitability and Cost Management REST API in REST client applications that are developed in languages such as JavaScript, Ruby, Perl, Java, JavaFX

The Profitability and Cost Management REST API resources are grouped as follows:

Oracle Hyperion Profitability and Cost Management 1

About the Oracle Hyperion Profitability and Cost Management REST Web Services API 3

Manage Application Resources. 3

Manage Cube Resources. 9

Manage POV Resources. 13

Manage Rule, Driver, and Stage Resources. 18

Calculation Resources. 20

Reporting Resources. 27

LCM Resources. 28

Miscellaneous Resources. 29

REFERENCES. 33

 

Information about client plugins and sample code can be found at the end of this document in the References section.

Manage Application Resources

Create File based HPCM Application

Use this resource to create a Management Ledger application using flat files. For more information see Appendix B of the Oracle Profitability and Cost Management Administrator’s Guide, release 11.2.3.4.100 or later.

RESTFUL URL http://{HostName}/profitability/rest/11.1.2.4.000/fileApplications/{applicationName}?description=Test&instanceName=PROFITABILITY_WEB_APP&essApplicationServer=EssbaseCluster-1&sharedServicesProject=EssbaseCluster-1&webServer={HostName}&ruleDimensionName=Value&balanceDimensionName=Value&unicode=True

Web Service API Name

processCreateFileApplication

Input Parameters

Users can run other REST services to get information needed to pass for the following input parameters. Useful REST services are “Get Essbase Applications”, “Get Essbase Application Properties”, and “Get Essbase Application Dimensions”.

·         String applicationName – Name of the application to create

·         String description– Description of application

·         String instanceName – Instance name for the application

·         String essApplicationServer –Essbase Application Server name

·         String sharedServicesProject -  Shared Services Project Name

·         String webserver – Webserver fully qualified name

·         String ruleDimensionName – Name for the Rule dimension

·         String balanceDimensionName  – Name for the Balance dimension

·         String Unicode – True or False based on whether the application is Unicode or not

Output Parameters

@return String 

·         When application is created successfully, "Application for flat file import has been created with name :: {applicationName}”.

·         When fails to create an application, " Application for flat file import could not be created with name :: {applicationName}”.

Resource Type

POST

Parameter Type:          

Path/Query parameters

Example URL

http://{HostName}/profitability/rest/11.1.2.4.000/fileApplications/BksML12?description=Test&instanceName=PROFITABILITY_WEB_APP&essApplicationServer=EssbaseCluster-1&sharedServicesProject=EssbaseCluster-1&webServer={HostName}&ruleDimensionName=Rule1&balanceDimensionName=Balance1&unicode=True

Create HPCM Application using AAM

Use this resource to create an application using the Profitability Applications Console, previously known as AAM.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/aamApplications/{{applicationName}?description=Test&instanceName=PROFITABILITY_WEB_APP&essApplicationServer=EssbaseCluster-1&sharedServicesProject=EssbaseCluster-1&applicationType=STANDARD&essApplication=ASOsamp&essApplicationDatabase=Sample&dimensions=Years,Time,Transaction Type,Payment Type&webServer=yyy00dby.mydomain.com

Web Service API Name

createApplication

Input Parameters

User can run the other REST services to get information needed to pass for below input parameters. Useful REST services are “Get Essbase Applications”, “Get Essbase Application Properties”, “Get Essbase Application Dimensions”.

·         String applicationName – Name of the application to create

·         String description– Description of application

·         String instanceName – Instance name for the application

·         String essApplicationServer – Essbase Application Server name

·         String sharedServicesProject -  Shared Services Project Name

·         String applicationType- Application type whether STANDARD, DETAILED,  or MANAGEMENT_LEDGER

·         String essApplication – Essbase application name

·         String essApplicationDatabase – Essbase application Database Name

·         String dimensions– Comma-separated (,) dimensions for browser based code; underscore- separated (_) dimensions for client code

·         String webserver – Webserver fully qualified name

Output Parameters

@return String – String containing the Taskflow ID

Resource Type

POST

Parameter Type

Path  and Query parameters

Example URL

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/aamApplications/Test1? description=Test&instanceName=PROFITABILITY_WEB_APP&essApplicationServer=EssbaseCluster-1&sharedServicesProject=EssbaseCluster-1&applicationType=STANDARD&essApplication=ASOsamp&essApplicationDatabase=Sample&dimensions=Years,Time,Transaction Type,Payment Type&webServer=yyy00dby.mydomain.com

Delete Application

Use this resource to delete an existing Hyperion Profitability and Cost Management (HPCM) application, and its association with Oracle Hyperion Shared Services.

The application will still be available in the Oracle Hyperion EPM Architect Library. You must run Diagnostics in Oracle Hyperion EPM Architect and set the status back to “Not Deployed” in order to redeploy this application to Profitability and Cost Management.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}

Web Service API Name

deleteApplication

Input Parameters

String applicationName - Name of the application to be deleted from the Profitability and Cost Management database, and unregistered with Oracle Hyperion Shared Services.

Output Parameters

@return String- Message indicating whether the application is successful  or not

Resource Type

POST

Parameter Type

Path parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks5

Enable File based Application

Use this resource to enable an application created with the Profitability Application Console using flat files, as described in Appendix B of the Oracle Hyperion Profitability and Cost Management Administrator’s Guide, release 11.1.2.4.100 or later.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/fileApplications/{applicationName}/enableApplication

Web Service API Name

enableFileApplication

Input Parameters

String applicationName – Name of the application to be enabled

Output Parameters

@return String – String containing the Taskflow ID

Resource Type

POST

Parameter Type

Path/Query parameters

Example URL

http://{HostName}/profitability/rest/11.1.2.4.000/fileApplications/BksML12/enableApplication

Get Application Type Details

Use this resource to list the application type for all existing Profitability and Cost Management applications. See “Output Parameters” later in this topic for information about returned type values.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}

Web Service API Name

getApplicationType

Input Parameters

String applicationName ­Name of the Profitability and Cost Management application for which the application type is to be retrieved.

Output Parameters

@return String – ApplicationType.return ­The following types are returned:

·         ApplicationType.GENERAL (For Standard Profitability applications)

·         ApplicationType.DETAIL (For Detailed Profitability applications)

·         ApplicationType.MANAGEMENT_LEDGE (For Management Ledger applications)

Resource Type

GET

Parameter Type

Path parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks1

Get Applications

Use this resource to list all existing Profitability and Cost Management applications

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications

Web Service API Name

getApplication

Input Parameters

None.    

Output Parameters

@return List<ApplicationDTO> ­List of ApplicationDTOs containing application information

Resource Type

GET

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications

Get Applications by Type

Use this resource to list all Profitability and Cost Management applications of the selected type.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/applicationsByType?applicationType=appType

Web Service API Name

getApplicationByType

Input Parameters

String applicationType - Specify the type of applications to be fetched from Profitability and Cost Management application server. These are the valid values:

·         ApplicationType.GENERAL (For Standard Profitability applications)

·         ApplicationType.DETAIL (For Detailed Profitability applications)

·         ApplicationType.MANAGEMENT_LEDGE (For Management Ledger applications)

Output Parameters

@return List<ApplicationDTO> - Returns a list of applications for the selected type.

Resource Type

GET

Parameter Type

Query Parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/applicationsByType?applicationType=MANAGEMENT_LEDGER

Get Essbase Application Dimensions

Use this resource to return dimensions for a given application and a given cube name.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/aamApplications/{ essbaseAppServer}/{applicationName}?cubeName=cubeName

Web Service API Name

getEssbaseDimensions

Input Parameters

String essbaseAppServer - Name of the Essbase Application Server

String applicationName – Name of the application for which dimensions will be returned

String cubeName – Cube Name for respective application

Output Parameters

@return String – String containing comma separated dimensions

Resource Type

GET

Parameter Type

Path parameters

Example URL 

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/aamApplications/EssbaseCluster-1/LM1C?cubeName=LM1C

Get Essbase Application Properties

Use this resource to return Essbase application properties.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/aamApplications

Web Service API Name

getApplicationProperties

Input Parameters

None.

Output Parameters

@return String – String containing application properties including essbaseAppServers, webserver, instanceNames, sharedServicesProjects

Resource Type

GET

Parameter Type

Path parameters

Example URL 

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/aamApplications

Get Essbase Applications

Use this resource to return Essbase applications for a given Essbase Application Server.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/aamApplications/{ essbaseAppServer}

Web Service API Name

getEssbaseApplications

Input Parameters

String essbaseAppServer - Name of the Essbase Application Server

Output Parameters

@return String – String containing application names

Resource Type

GET

Parameter Type

Path parameters

Example URL

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/aamApplications/EssbaseCluster-1

Update File based Application using a Flat File

Use this resource to upload a new dimension flat file for an application created using flat files, as described in Appendix B of the Oracle Hyperion Profitability and Cost Management Administrator’s Guide, release 11.1.2.4.100 or later.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/fileApplications/{applicationName}/updateDimension?dataFileName="+dataFileName;

Web Service API Name

processFileApplicationUpdateDimension

Input Parameters

·         String applicationName – Name of the application to update

·         String dataFileName – Data file location path in the client computer

Output Parameters

@return String – True or False

Resource Type

POST

Parameter Type

Path/Query parameters

Example URL

http://{HostName}/profitability/rest/11.1.2.4.000/fileApplications/BksML12/updateDimension?dataFileName=C:\Temp Year.txt

Note: This URL cannot be invoked from the browser REST Console because file content cannot be passed from the browser.

Export Template

Use this resource to export Hyperion Profitability and Cost Management Management Ledger applications as flat template files for later import as new applications. If an existing file name is used, the import overwrites content in an existing file. For details, see Appendix B of the Oracle Hyperion Profitability and Cost Management Administrator’s Guide, release 11.1.2.4.110 or later.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/fileApplications/{applicationName}jobs/templateExportJob? FileName=Value

Web Service API Name

processExportTemplate

Input Parameters

·         String applicationName – Name of the application to export (mandatory parameter)

·         String fileName – Name of the template file; if not given, a default name will be used for the exported file

Output Parameters

@return String – String containing Task Flow ID

Resource Type

GET

Parameter Type

Path/Query parameters

Example URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/BksML12/jobs/templateExportJob?fileName= testFile

Import Template

Use this resource to import a template .zip file, which is the output of resource Export Template. The result is a a new application that contains the same metadata and artifacts as the exported application. For details, see Appendix B of the Oracle Hyperion Profitability and Cost Management Administrator’s Guide, release 11.1.2.4.110 or later.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}jobs/templateImportJob? description=value&instanceName=Value&essApplicationServer=Value&sharedServicesProject=Value&fileName=Value&isApplicationOverwrite=true

Web Service API Name

processImportTemplate

Input Parameters

Users can run the other REST resources to get information needed to pass for the following input parameters. A  useful REST resource is “Get Essbase Application Properties”.

·         String applicationName – Name of the application to create (mandatory parameter)

·         String description – Description of the application (mandatory parameter)

·         String instanceName – Instance name for the application (mandatory parameter)

·         String essApplicationServer – Essbase Application Server name (mandatory parameter)

·         String sharedServicesProject - Shared Services Project Name (mandatory parameter)

·         String fileName - Name of the zip file already present in the export_import location (mandatory parameter)

·         Boolean isApplicationOverwrite – If value is true then it  deletes an existing application and then creates a new application; if false then it returns a message that the application already exists (optional parameter)

Output Parameters

@return String – String containing Task Flow ID

Resource Type

POST

Parameter Type

Path/Query parameters

Example URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/ BksML12/jobs/templateImportJob?description=value&instanceName=Value&essApplicationServer=Value&sharedServicesProject=Value&fileName=testFile&isApplicationOverwrite=true

Manage Cube Resources

Clear ASO Cube (SP)

Use this resource to clear the ASO cube for a given App name, POV and Layer combination.

RESTFUL URL

http://{HostName} /profitability/rest/11.1.2.4.000/applications/{ApplicationName}/povs/{povMemberGroup} /jobs/clearASOCube?layerName=value

Web Service API Name

clearASOCube

Input Parameters

String applicationName - Name of the Standard Profitability and Cost Management application for which Calculation Scripts should be generated and executed, depending on the options selected.

Variable

Description

Example

povMemberGroups

POV information for which Calculation Script generation and execution should be performed.

2011_January_Actual

layerName

Layer name for which Calculation scripts should be generated and executed. Valid Values:

COST

REVENUE

COST

Output Parameters

@return String - CES Task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2011_January_Actual/jobs/clearASOCube?layerName=COST

Essbase Data Load

Use this convenient resource to load data into Essbase without using Oracle Essbase Administration Services console. You can load one data or optional rule file at a time, as described in Chapter 25 of the Oracle Hyperion Profitability and Cost Management User’s Guide, release 11.1.2.4.100 or later.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/jobs/essbaseDataLoadJob?clearAllDataFlag=true&dataLoadValue=OVERWRITE_EXISTING_VALUES& dataFileName=Value& rulesFileName=Value

Web Service API Name

EssbaseDataLoad

Input Parameters

·         String applicationName – Name of the Profitability and Cost Management application for which the data is being loaded

·         String clearAllDataFlag – True/False; all the data in the active cube of application from which it is invoked will be cleared

·         String dataLoadValue – The wildcard data file will overwrite the existing values. Allowed values are:
OVERWRITE_EXISTING_VALUES
ADD_EXISTING_VALUES

·         String dataFileName – Name of data file to be uploaded

·         String ruleFileName – Name of rule file to be uploaded

Output Parameters

None

Resource Type

POST

Parameter Type

Path, Query & MultiPart parameters

Example URL

http://slc04ljy.us.oracle.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks1/jobs/essbaseDataLoadJob?clearAllDataFlag=true&dataLoadValue=OVERWRITE_EXISTING_VALUES&dataFileName=Value&rulesFileName=Value

Example Command

With Rule File:

hpm_ws_rest_client processEssbaseloadData appName dataRuleFilesDirectory dataFileName clearAllDataFlag  dataLoadValue rulesFileName

hpm_ws_rest_client processEssbaseloadData BksML12 C:\Temp CCStat.txt true OVERWRITE_EXISTING_VALUES CCStat.rul

Without Rule File:

hpm_ws_rest_client processEssbaseloadData appName dataRuleFilesDirectory dataFileName clearAllDataFlag  dataLoadValue

hpm_ws_rest_client processEssbaseloadData BksML12 C:\Temp CCStat.txt true OVERWRITE_EXISTING_VALUES

Note: This URL cannot be invoked from browser REST Console due to additional information needed along with each file in the parameters.

ML Deploy Cube

Use this resource to deploy or redeploy the calculation cube for a selected Management Ledger Profitability application. The LedgerDeployOptionsDTO options relate to the check boxes you see in the application when you select Deploy Cube in the Manage Database screen.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/jobs/ledgerDeployCubeJob?isKeepData=Value&isReplaceCube=Value&isRunNow=Value&comment=Value

Web Service API Name

processLedgerDeployCube

Input Parameters

String applicationName - Name of the Management Ledger application for which the cube is to be deployed.

LedgerDeployCubeOptionsDTO ledgerDeployOptions - Selection details for Deploy Cube functionality. All the Boolean values in this DTO correspond to check boxes available on the Deploy Cube screen.

Output Parameters

@return String- CES Task ID generated for this resource.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks3/jobs/ledgerDeployCubeJob?isKeepData=true&isReplaceCube=true&isRunNow=true&comment=Test

SP Deploy Cube

Use this resource to deploy or redeploy the Calculation Cube or Reporting Cube for a selected Standard Profitability application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/jobs/ spDeployCubeJob?cubeType=CALCULATION_CUBE&isFirstTimeDeployment=false&isUpdateDatabase=false&isReplaceDatabase=true

Web Service API Name

deployCube

Input Parameters

String applicationName - Name of the Standard Profitability application to deploy.

Variable

Description

Example

cubeType

Valid values:

CALCULATION_CUBE

REPORTING_CUBE

CALCULATION_CUBE

isFirstTimeDeployment

Boolean flag specifying whether the cube is being deployed for the first time for this application. Valid values are TRUE or FALSE.

FALSE

isUpdateDatabase

Boolean flag specifying whether the database should be updated. Valid values are TRUE or FALSE.

TRUE

isReplaceDatabase

Boolean flag specifying whether the database should be replaced. Valid values are TRUE or FALSE. If its value is true you cannot enter values for

isarchiveDataBeforeDeploy,

isArchiveDataAndReloadAfterDeploy

isDeleteDataArchiveAfterReload

FALSE

isarchiveDataBeforeDeploy

Boolean flag specifying whether the data should be archived before deployment begins. Valid values are TRUE or FALSE.

TRUE

isArchiveDataAndReloadAfterDeploy

Boolean flag specifying whether the data archived before deployment should be reloaded after deployment completes. Valid values are TRUE or FALSE.

FALSE

isDeleteDataArchiveAfterReload

Boolean flag specifying whether to delete the archived data after reload. Valid values are TRUE or FALSE.

FALSE

Output Parameters

@return String- Process CES task ID generated for the deploy cube action.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/m11/jobs/spDeployCubeJob?cubeType=CALCULATION_CUBE&isFirstTimeDeployment=false&isUpdateDatabase=false&isReplaceDatabase=true

Manage POV Resources

Clear POV Data (SP, DP)

Use this resource to clear the POV data for selection stage and other details. Use with Standard Profitability and Detailed Profitability applications.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povGroupMembers}/jobs/clearSpDpPOVJob?stages=values&clearCostLayer=value&clearRevenueLayer=Value&clearDriverSelectionRules=Value&clearDriverSelectionExceptions=Value&clearAssignmentRuleSelections=Value&clearRegularAssignments=Value&clearCalculationRules=ValueWeb Service

Web Service API Name

clearPOVData

Input Parameters

applicationName - Name of the Profitability and Cost Management application.

ClearPOVDTO - POV clear options.

Variable

Description

Example

clearAssignmentRuleSelections

Boolean flag specifying whether Assignment Rule Selections should be cleared. Valid values are TRUE or FALSE.

TRUE

clearCalculationRules

Boolean flag specifying whether Calculation Rules should be cleared. Valid values are TRUE or FALSE.

TRUE

clearCostLayer

Boolean flag specifying whether Cost Layer should be cleared. Valid values are TRUE or FALSE.

TRUE

clearDriverSelectionExceptions

Boolean flag specifying whether Driver Selection Exceptions should be cleared. Valid values are TRUE or FALSE.

TRUE

clearDriverSelectionRules

Boolean flag specifying whether Driver Selection Rules should be cleared. Valid values are TRUE or FALSE.

TRUE

clearRegularAssignments

Boolean flag specifying whether Regular Assignments should be cleared. Valid values are TRUE or FALSE

TRUE

clearRevenueLayer

Boolean flag specifying whether Revenue Layers should be cleared. Valid values are TRUE or FALSE.

TRUE

povGrp

Specify dimension member names of the POV for which this clear POV data resource should be applied:

povDimensionMember1

povDimensionMember2

povDimensionMember3

povDimensionMember4

povDimensionMember1 = 2012

povDimensionMember2 = January

povDimensionMember3 = Actual

stages

Specify dimension member names of the POV for which this Bulk Edit resource should be applied:

stages 1

stages 2

stages 3

stages N, stages N = [displayOrder = (int),

example:1 stageName = (string)

Ledger Data

 

Output Parameters

None.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2010_January_Actual/jobs/clearSpDpPOVJob?stages=Ledger Data_Activity&clearCostLayer=true&clearRevenueLayer=true&clearDriverSelectionRules=true&clearDriverSelectionExceptions=true&clearAssignmentRuleSelections=true&clearRegularAssignments=true&clearCalculationRules=false

Copy ML POV Data

Use this resource to copy model artifacts and data from a Source POV combination to a Destination POV combination for Management Ledger applications. This resource is equivalent to the functionality supported by the Point of View Manager screen’s Copy POV Data control. Use with Management Ledger Profitability applications.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{srcPOVMemberGroup}/jobs/copyPOVJob/{destPOVMemberGroup}?manageRule=Value&inputData=Value&adjustmentValues=Value&allocatedValues=Value

Web Service API Name

processLedgerCopyPOV

Input Parameters

·         String applicationName - Name of the Profitability and Cost Management ManagementLedger application for which the clearPOVData resource is to be performed.

·         LedgerCopyPOVOptionsDTO copyPOVData  - Selection details for Copy POV functionality. All the Boolean values in this DTO correspond to check boxes available on the Point of View Manager’s Copy POV screen.

Output Parameters

@return String- CES Task ID generated for this resource.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks1/povs/2010_February_Actual/jobs/copyPOVJob/2011_March_Actual?isManageRule=true&isInputData=true&isAdjustmentValues=false&isAllocatedValues=true

Copy SP and DP POV Data

Use this resource to copy Model artifacts and Data from a Source POV combination to a Destination POV combination. This resource is equivalent to functionality supported by selecting Manage Model, then POV Manager, and then Copy on the screen, invoke this resource by using the following RESTFUL URL.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{sourcePOVGroupMember}/jobs/ copySpDpPOVJob /{destinationPOVGroupMember}

Web Service API Name

processCopyPOVData

Input Parameters

Variable

Description

Example

sourcePOV

Specify dimension member names of the POV for which this Bulk Edit resource should be applied:

povDimensionMember1

povDimensionMember2

povDimensionMember3

povDimensionMember4

povDimensionMember1 = 2012

povDimensionMember2 = January

povDimensionMember3 = Actual

targetPOV

Specify dimension member names of the POV for which this Bulk Edit resource should be applied:

povDimensionMember1

povDimensionMember2

povDimensionMember3

povDimensionMember4

povDimensionMember1 = 2012

povDimensionMember2 = March povDimensionMember3 = Actual

copyCostLayerData

Boolean flag specifying whether Cost Layer data should be copied. Valid values are TRUE or FALSE.

TRUE

copyRevenueLayerData

Boolean flag specifying whether Revenue Layer data should be copied. Valid values are TRUE or FALSE.

TRUE

copyAssignments

Boolean flag specifying whether assignments data should be copied. Valid values are TRUE or FALSE.

TRUE

copyDriverAssociations

Boolean flag specifying whether driver associations data should be copied. Valid values are TRUE or FALSE.

TRUE

copyDriverValues

Boolean flag specifying whether driver data should be copied. Valid values are TRUE or FALSE.

FALSE

copyCostRevenueValues

Boolean flag specifying whether Cost/Revenue values should be copied. Valid values are TRUE or FALSE.

FALSE

copyCalculationRules

Boolean flag specifying whether Calculation Rules should be copied for a Profitability and Cost Management Detailed Application. Valid values are TRUE or FALSE.

FALSE

Output Parameters

@return String - CES Task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2010_February_Actual/jobs/copySpDpPOVJob/2012_February_Actual?copyCostLayerData=true&copyRevenueLayerData=true&copyAssignments=true&copyDriverAssociations=true&copyDriverValues=true&copyCostRevenueValues=true&copyCalculationRules=false

Delete POV

Use this resource to delete an existing POV in a Profitability and Cost Management application. Exercise caution when using this resource, because all model data associated with this POV will also be deleted with this resource

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povMemberGroup}

Web Service API Name

deletePOV

Input Parameters

·         String applicationName - Name of the Profitability and Cost Management application from which the POV is to be deleted.

·         String povMemberGroup - povDimensionMember1_ povDimensionMember2_ povDimensionMember3_ povDimensionMember4

Description

Variable

Description

Example

povDimensionMember1

POV Dimension Member Name at Position 1

2012

povDimensionMember2

POV Dimension Member Name at Position 2

January

povDimensionMember3

POV Dimension Member Name at Position 3

Actual

povDimensionMember4

POV Dimension Member Name at Position 4

Plan

Output Parameters

@return String- CES Task ID generated for this resource.

Resource Type

POST

Parameter Type

Path parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks5/povs/2011_March_Budget

Get POVs by an Application

Use this resource to retrieve all POV details for a selected application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs

Web Service API Name

getPOV

Input Parameters

String applicationName - Name of the Profitability and Cost Management application for which the POVs should be retrieved.

Output Parameters

@return List<POVMemberGroupDTO> - list of POVMemberGroupDTOs containing POV information.

Resource Type

GET

Parameter Type

Path parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks5/povs

Run ML Clear POV

Use this resource to clear model artifacts and data from a POV combination for Management Ledger applications. This resource is equivalent to the functionality supported by the Point of View Manager screen’s Clear POV Data control. Use with Management Ledger Profitability.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povMemberGroup}/jobs/clearPOVJob?manageRule=Value&inputData=Value&adjustmentValues=Value&allocatedValues=Value

Web Service API Name

processLedgerClearPOV

Input Parameters

·         String applicationName - Name of the Profitability and Cost Management ManagementLedger application for which the clearPOVData resource is to be performed.

·         LedgerClearPOVOptionsDTO clearPOVData  - Selection details for Clear POV functionality. All the Boolean values in this DTO correspond to check boxes available on the Point of View Manager’s Clear POV screen.

Output Parameters

@return String- CES Task ID generated for this resource.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks1/povs/2011_March_Actual/jobs/clearPOVJob?isManageRule=true&isInputData=true&isAdjustmentValues=false&isAllocatedValues=true

Manage Rule, Driver, and Stage Resources

Get Assignment Rule Definitions (DP)

Use this resource to retrieve all Assignment Rule Definitions, not associations, for a particular stage for a given Detailed Profitability application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/assignmentRules?stageName=value

Web Service API Name

getAssignmentRuleDefinitions

Input Parameters

String applicationName - Name of the Detailed Profitability and Cost Management application for which the Assignment Rule Definitions are being retrieved.

String stageName - Specify the stage name for which assignment rule definitions should be retrieved.

Output Parameters

@return List<AssignmentRuleDTO> - List of AssignmentRuleDTOs matching the above input parameters.

Resource Type

GET

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/assignmentRules?stageName=Customer Activity Cost

Get DP Driver Definitions

Use this resource to list all Driver definitions for a Profitability and Cost Management Detailed application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/ getDriverDefinitions

Web Service API Name

getDriverDefinitions

Input Parameters

String applicationName - Name of the Profitability and Cost Management Detailed application for which you want to view the Driver Definitions.

Output Parameters

@return List<DriverDTO> - Returns a list of DriverDTOs.

Resource Type

GET

Parameter Type

Path parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/getDriverDefinitions

Get Stages by an Application (SP, DP)

Use this resource to retrieve all stage details for the given Standard or Detailed Profitability application name. This resources returns name and display order of a stage by using the following rest URL.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/stages

Web Service API Name

getStagesByApplication

Input Parameters

String applicationName - Name of the Standard or Detailed Profitability application for which stage details will be retrieved.

Output Parameters

@return List<StageDTO> - Returns a list of StageDTOs containing stage information.

Resource Type

GET

Parameter Type

Path parameters

Example URL

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/stages

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/stages

ML Rule Balancing

Use this resource to retrieve Rule Balancing Data for a particular POV for a given Detailed Profitability application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/ povs/ {povGroupMembers}/ruleBalance?modelViewName=Test

Web Service API Name

runRuleBalancing

Input Parameters

·         String applicationName - Name of the Detailed Profitability and Cost Management application for which the Assignment Rule Definitions are being retrieved.

·         String povGroupMembers – POV Dimension members separated by ‘_’

·         String modelViewName – Optional Model View Name

Output Parameters

@return List<RulesetDTO> - List of RulesetDTOs matching the above input parameters.

Resource Type

GET

Parameter Type

Path and Query parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks1/povs/2014_January_Actual/ruleBalance?modelViewName=Test

Calculation Resources

Run DP Calculation

Use this resource to process and run calculations for a selected Detailed Profitability application. The following actions relate to the check boxes on the Manage Calculation tab of the application:

·         clearCalculated - “Processing Options” then “Clear Calculation Values”

·         createContributionDetail - “Processing Options” then “Execute Calculations” then “Create Contribution Detail”

·         createStageBalanceDetail - “Processing Options” then “Execute Calculations” then “Create Stage Balance Detail”

·         createDriverTables - “Processing Options” then “Execute Calculations” then “Create Detailed Calculated Driver Tables”

·         executeCalculations - “Processing Options” then “Execute Calculations”

·         limitedPreview - “Processing Options” then “Preview with Limited Source Set”

·         abortOnError - “Processing Options” then “Abort Task Flow if any POV fails”

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/jobs/detailedCalculationProcessJob/{dataPovGroupMembers}/{modelPOVGroupMembers}?comment=Value&isClearCalculated=Value&isExecuteCalculations=Value&isCreateContributionDetail=Value&isCreateDetailCalculatedDriverTables=Value&isAbortOnError=Value&isRunSingleCalcRuleSequence=Value&calcRuleSequence=Value&isTransferToSrcStgDb=Value&isTransferToDstStgDb=Value&isTransferToContribDb=Value&preScript=Value&postScript

Web Service API Name

processDetailedCalculations

Input Parameters

String applicationName - Name of the Detailed Profitability and Cost Management application that is to be calculated

Variable

Description

Examples

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 resource. 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.

TRUE

isAbortOnError

Boolean flag specifying whether to abort on occurrence of any error while processing calculations. Valid values are TRUE or FALSE.

TRUE

dataPOVMemberGroup

List of POV Dimension Member Group details that should be considered for Data POV when calculating..

2012_January_Actuall

modelPOVMemberGroup

Model POV dimension member group details when performing calculations.

2012_January_Actual

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

FALSE

calcRuleSequence

Valid int value ie 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

Output Parameters

@return String - CES Task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/povs/jobs/detailedCalculationProcessJob/2012_January_Actual/2012_January_Actual?comment=Calculation to be done&isClearCalculated=true&isExecuteCalculations=true&isCreateContributionDetail=true&isCreateDetailCalculatedDriverTables=false&isAbortOnError=true&isRunSingleCalcRuleSequence=false&isTransferToSrcStgDb=false&isTransferToDstStgDb=false&isTransferToContribDb=false

Run ML Calculation

Use this resource to run calculations for a selected Management Ledger Profitability application. The LedgerCalculationOptionsDTO options relate to the check boxes you see in the application when you select Run Calculation in the Manage Calculations screen

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povGroupMember}/jobs/runLedgerCalculationJob?isClearCalculated=Value&isExecuteCalculations=Value&isRunNow=Value&comment=Value&subsetStart=value&subsetEnd=Value&ruleName=Value&ruleSetName=Value&exeType=Value

Web Service API Name

processRunLedgerCalculation

Input Parameters

·         String applicationName - Name of the Profitability and Cost Management Management Ledger application to calculate.

·         LedgerCalculationOptionsDTO ledgerCalculationOptions.

Resource Type

POST

Output Parameters

@return String- CES Task ID generated for this resource.

Parameter Type

Path and Query parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks1/povs/2010_February_Actual/jobs/runLedgerCalculationJob?isClearCalculated=true&isExecuteCalculations=true&isRunNow=true&comment=This is run by user1&subsetStart=10&subsetEnd=20&ruleName=MyRule1&ruleSetName=MyRuleSetName1&exeType=Value

Run SP Calculation

Use this resource to initiate the process and run calculation scripts for a selected Standard Profitability application. The following actions relate to the check boxes on the Mange Calculation tab of the application:

Clear All

Clear Calculated

Generate

Calculate

Transfer data after calculation.

Calculate

Note: If you select the clearAllStageList or clearAllCalculatedStageList, list all stages that are to be cleared. If you do not want to clear any stages, use empty quotes “”.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povMemberGroups}/jobs/calcScriptsProcessJob?layerName=value&clearCalculatedStageList=Value&clearAllStageList=Value&generateStageList=Value&calculateStageList=Value&isTransferData=value

Web Service API Name

processCalcScript

Input Parameters

String applicationName - Name of the Standard Profitability and Cost Management application for which Calculation Scripts should be generated and executed, depending on the options selected.

Variable

Description

Example

povMemberGroups

POV information for which Calculation Script generation and execution should be performed.

2011_January_Actual

layerName

Layer name for which Calculation scripts should be generated and executed. Valid Values:

COST

REVENUE

COST

clearCalculatedStageList

List of stage names for which generated calc scripts need to be cleared.

Ledger Data, Activity

clearAllStageList

List of stage names for which all information must be cleared.

Ledger Data, Activity

generateStageList

List of stage names for which calc scripts need to be generated

Ledger Data, Activity

calculateStageList

List of stage names for which calc scripts should be executed

Ledger Data, Activity

isTransferData

Boolean flag specifying whether a data transfer need to be performed. Valid values are TRUE or FALSE.

FALSE

Output Parameters

@return String - CES Task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2011_January_Actual/jobs/calcScriptsProcessJob?layerName=COST&clearCalculatedStageList=Ledger Data&clearAllStageList=Ledger Data&generateStageList=Ledger Data&calculateStageList=Ledger Data&isTransferData=true

For giving list of parameters for generateStageList:

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2011_January_Actual/jobs/calcScriptsProcessJob?layerName=0&clearCalculatedStageList=Ledger Data&clearAllStageList=Ledger Data&generateStageList=Ledger Data&generateStageList=Activity&calculateStageList=Ledger Data&isTransferData=true

For not giving certain parameter like calculateStageList:

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2011_January_Actual/jobs/calcScriptsProcessJob?layerName=0&clearCalculatedStageList=Ledger Data&clearAllStageList=Ledger Data&generateStageList=Ledger Data&isTransferData=true

Run SP Genealogy Execution Paths

Use this resource to execute the genealogy paths that have been defined for a selected Standard Profitability application. The following actions relate to the check boxes when you select Calculate, then Manage Calculation, and then the Genealogy tab.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povGroupMembers}/jobs/geneologyExecutionPathProcessJob?layerName=Value&paths=Value

Web Service API Name

processGenealogyExecutionPaths

Input Parameters

String applicationName - Name of the Profitability and Cost Management application for which the genealogy paths are to be calculated.

Variable

Description

Example

layerName

Layer name for which Calculation scripts should be generated and executed. Valid Values:

COST

REVENUE

COST

paths

List of genealogy execution paths

1-3-5

povGrp

Specify the POV dimension member group information pertaining to this genealogy paths execution.

2011_January_Actual

Output Parameters

@return String - CES Task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

GET

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2011_January_Actual/jobs/geneologyExecutionPathProcessJob?layerName=COST&paths=1-2-3-4

Run SP Genealogy Execution Paths without ASO Cube Clear

Use this resource to execute the genealogy paths that have been defined for a selected Standard Profitability application without ASO cube clear. The following actions relate to the check boxes when you select Calculate, then Manage Calculation, and then the Genealogy tab.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povGroupMembers}/jobs/ geneologyExecutionPathWithoutASOCubeClearProcessJob?layerName=Value&paths=Value

Web Service API Name

processGenealogyPathsWithOutASOCubeClear

Input Parameters

String applicationName - Name of the Profitability and Cost Management application for which the genealogy paths are to be calculated.

Variable

Description

Example

layerName

Layer name for which Calculation scripts should be generated and executed. Valid Values:

COST

REVENUE

COST

paths

List of genealogy execution paths

1-3-5

povGrp

Specify the POV dimension member group information pertaining to this genealogy paths execution.

2011_January_Actual

Output Parameters

@return String - CES Task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

GET

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/2011_January_Actual/jobs/geneologyExecutionPathWithoutASOCubeClearProcessJob?layerName=COST&paths=1-2-3-4

Run SP Multi POV Calculation

Use this resource to process multi-POV calculations for a selected Standard Profitability application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/jobs/multiPovCalcScriptProcessJob/{startPovMemberGroup}/{endPovMemberGroup}?layerName=value&clearCalculatedData=value&saveScripts=value

Web Service API Name

processMultiPOVCalcScript

Input Parameters

String applicationName - Name of the Detailed Profitability and Cost Management application that is to be calculated

Variable

Description

Examples

layerName

Layer name for which Calculation scripts should be generated and executed. Valid Values:

COST

REVENUE

COST

clearCalculatedData

Boolean flag specifying whether to clear calculated values. Valid values are TRUE or FALSE.

TRUE

saveScripts

Boolean flag specifying to save scripts generated while multi pov calculation.Valid values are TRUE or FALSE.

TRUE

Output Parameters

@return String - CES Task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

GET

Parameter Type

Path and Query parameters

Example URL

http://yyy06vya.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/povs/jobs/multiPovCalcScriptProcessJob/2009_January_Actual/2012_January_Actual?layerName=COST&clearCalculatedData=false&saveScripts=false

Reporting Resources

Prepare Detailed Views for Reporting (DP)

Use this resource to prepare views for a Detailed Profitability application. Invoke this resource with the following RESTFUL URL.

Note: This resource is valid for DP applications. Dimensions are optional. If dimensions are not specified, they are picked up at application level and processed.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/jobs/reportingViewGeneratorJob?dimensionNames= values

Web Service API Name

prepareDetailedViewsForReporting

Input Parameters

·         String applicationName - Name of the Detailed Profitability and Cost Management application for which the reporting views are to be prepared.

·         List<DimensionDTO> dimensions- Specify the list of name and short name properties for dimension(s) to be included in generating the reporting views.

Output Parameters

None.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

For application level : http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/jobs/reportingViewGeneratorJob

For single dimension : http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/jobs/reportingViewGeneratorJob?dimensions=Scenario_TScenario

For multiple dimensions : http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/jobs/reportingViewGeneratorJob?dimensions=Accounts_TACC,Scenario_TScen

LCM Resources

Import from Staging (SP, DP)

Use this resource to execute the selected import configuration into a Standard or Detailed Profitability application. Invoke this resource with the following RESTFUL URL.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/jobs/importConfigJob?importConfigName=value

Web Service API Name

processRunImportFromStaging

Input Parameters

String applicationName - Name of the Profitability and Cost Management application into which the import configuration will import the data.

String importConfigName” - Name of the import configuration to be executed.

Output Parameters

@return String - CES Task ID generated for executing the Import Configuration.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksSP82/jobs/importConfigJob?importConfigName=Import_Config_Test

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDP30/jobs/importConfigJob?importConfigName=DP_import_configt_test

Miscellaneous Resources

Apply Bulk Edit (DP)

Use this resource to perform Bulk Edit for the given source assignment rules with destination rules or Drivers for a Detailed Profitability application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/{povGroupMembers}/jobs/applyBulkEditJob?comment=Value&sourceRules=Value&drivers=Value&destinationRules=Value&isSelectEntireStageForDelete=Value&isSelectAllRulesOrDriversForDelete=Value

Web Service API Name

processBulkEdit

Input Parameters

·         String applicationName - Name of the Profitability and Cost Management application to which this Bulk Edit resource is to be applied.

·         BulkEditOptionsDTO bulkEditOptions - DTO containing information required to perform the Apply Bulk Edit Resource.

BulkEditOptionsDTO 

Variable

Description

Example

sourceRules

A List of Source Assignment Rule names being selected for this Bulk Edit Resource

Apply All Building Activities

destinationRules

A List of Destination Assignment Rule names being selected for this Bulk Edit Resource,

Note:

This value should be passed only with BulkEditResources.ADD_ASSIGNMENT_RULES and BulkEditResources.REMOVE_ASSIGNMENT_RULES.

Sales Order to Invoice

Drivers

Name of the Driver to be applied to the selected Source Assignment Rules as part of this Bulk Edit Resource.

Note:

Only one Driver name may be provided when using the BulkEditResources.ADD_DRIVER resource; however, a list of Driver names can be provided when using the BulkEditResources.REMOVE_DRIVERS resource

DRV Build Product

Resource

Specify the Bulk Edit resource:

BulkEditResources.ADD_DRIVERS

BulkEditResources.REMOVE_DRIVERS

BulkEditResources.ADD_ASSIGNMENT_RULES

BulkEditResources.REMOVE_ASSIGNMENT_RULES

BulkEditResources.ADD_DRIVERS

povGrp

Specify dimension members names for the POV for which this Bulk Edit resource is to be applied:

povDimensionMember1

povDimensionMember2

povDimensionMember3

povDimensionMember4

povDimensionMember1 = 2012 povDimensionMember2 = January povDimensionMember3 = Actual

selectAllRulesOrDriversForDelete

Boolean flag specifying if all the destination assignment rules or drivers should be selected for delete.

Valid values are TRUE or FALSE.

FALSE

selectEntireStageForDelete

Boolean flag specifying if the entire stage should be selected for delete.

Valid values are TRUE or FALSE.

FALSE

Comment

Specify a comment for this Bulk Edit Resource.

“Bulk Edit Resource to Add Drivers”

 

Output Parameters

@return String - CES task ID generated for this resource.

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

POST

Parameter Type

Path and Query parameters

Example URL

Add Drivers:

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDp30/povs/2012_January_Actual/jobs/applyBulkEditJob?resource=Add Drivers&comment=bulk edit test&sourceRules=Apply All Building Activities,Apply Business Support Driver,Apply CoMarket&drivers=DRV Business Support&isSelectEntireStageForDelete=Y&isSelectAllRulesOrDriversForDelete=Y

Remove Drivers:

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDp30/povs/2012_January_Actual/jobs/applyBulkEditJob?resource=Remove Drivers&comment=bulk edit test&sourceRules=Apply All Building Activities,Apply Business Support Driver,Apply CoMarket&drivers=DRV Business Support&isSelectEntireStageForDelete=Y&isSelectAllRulesOrDriversForDelete=Y

Add Assignment Rules:

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDp30/povs/2012_January_Actual/jobs/applyBulkEditJob?resource=Add Assignment Rules&comment=bulk edit test&sourceRules=Apply All Building Activities,Apply Business Support Driver&destinationRules=All to Invoice,Building to Invoice&isSelectEntireStageForDelete=Y&isSelectAllRulesOrDriversForDelete=Y

Remove Assignment Rules:

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/BksDp30/povs/2012_January_Actual/jobs/applyBulkEditJob?resource=Remove Assignment Rules&comment=bulk edit test&sourceRules=Apply All Building Activities,Apply Business Support Driver&destinationRules=All to Invoice,Building to Invoice&isSelectEntireStageForDelete=Y&isSelectAllRulesOrDriversForDelete=Y

Get Job Services for a POV

Use this resource to retrieve all POV Job details for a selected application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/povs/jobs

Web Service API Name

getPOVJobs

Input Parameters

String applicationName - Name of the Profitability and Cost Management application for which the POV related Job services should be retrieved.

Output Parameters

@return String - Returns a list of job services that are available for the given POV based on its application type.

Resource Type

GET

Parameter Type

Path parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks5/povs/jobs

Get Job Services by an Application

Use this resource to list all Profitability and Cost Management application jobs for the selected application.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/{applicationName}/jobs

Web Service API Name

getJobToApplication

Input Parameters

String applicationName - Name of the Profitability and Cost Management application for which the application type is to be retrieved.

Output Parameters

@return String - Returns a list of job services that are available for the given application based on its type.

Resource Type

GET

Parameter Type

Query Parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/MLBks1/jobs

Get Task Details by Process Name

Use this resource to retrieve the details like job id, name, start time, end time, user id and etc. for the given taskflowId.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/jobs/taskDetails/{processName}

Web Service API Name

processGetTaskDetailsByProcessName

Input Parameters

String processName - Enter the process name or taskflow ID for which the status should be retrieved.

Output Parameters

@return JobDTO – JobDTO contains the details of the given taskflowId.

JobDTO

Variable

Description

Example

applicationName

Name of the Application for the given process name

BksSP82

comment

Comment given for the job/process

Testing bulk edit resource

jobType

Type of the job submitted.

Standard Calculation

startTime

Start time of the process

2014-10-27T06:25:21.446-06:00

executionType

Execution type of the process

CES

jobProperties

Parameters given for the job execution

editResource: Remove Driver, removeFromAllSources:N, removeAllRules:N, numberOfRules:0 and etc.

Status

Status of the submitted process.SUCCESS/FAILURE

Success

taskflowID

Name of the process

BksDP30_BulkEdit_D20141027T062515_281

 

endTime

End time of the process

2014-10-27T06:25:21.446-06:00

User

Id  of the user who submitted the process

Admin

povName

Specify dimension member names of the POV for which this task details resource has been applied:

povDimensionMember1

povDimensionMember2

povDimensionMember3

povDimensionMember4

povDimensionMember1 = 2012

povDimensionMember2 = January

povDimensionMember3 = Actual

 

Note: You can use the “Get Task Status by Process Name” resource to get the status of this CES task ID.

Resource Type

POST

Parameter Type

Path parameters

Example URL

http://yyy00dby.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications /jobs/taskDetails/BksDP30_BulkEdit_D20141027T053021_c91

Get Task Status by Process Name

Use this resource to view the current status of the job process name (CES taskflow) as it is displayed on the Taskflow Status Summary. The status message contains Success or Failure details of the individual stages, along with the In-Progress or Completion status of the taskflow as a whole.

RESTFUL URL

http://{HostName}/profitability/rest/11.1.2.4.000/applications/jobs/ChecktaskStatusJob/{processName}

Web Service API Name

getTaskStatusByProcessName

Input Parameters

String processName - Enter the process name or taskflow ID for which the status should be retrieved.

Output Parameters

@return String- Comma-separated values of all tasks and their statuses for the specified taskflow process name. This is the taskflow from the Taskflow Status screen in the application.

For example, if the process has two tasks created for it with the IDs 12345 and 123455, the task IDs and status are displayed as follows: 12345=Done,123455=Active

Resource Type

GET

Parameter Type

Path parameters

Example URL

http://yyy04ljy.mydomain.com:19000/profitability/rest/11.1.2.4.000/applications/jobs/ChecktaskStatusJob/MLBks1_CopyMLPOV_D20141014T071124_a5e

REFERENCES

REST Client Plugins

Mozilla :

https://www.google.co.in/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=0CBwQFjAA&url=https%3A%2F%2Faddons.mozilla.org%2Fen-US%2Ffirefox%2Faddon%2Frestclient%2F&ei=n1U9VK-LHuvY7AaX-oGACw&usg=AFQjCNHTj5bfy3my21xQVUUP0RJGD5hRLw&sig2=LT0eGnKJipvQm6sQ0200ew&bvm=bv.77412846,d.ZWU

Chrome:

https://chrome.google.com/webstore/detail/rest-console/cokgbflfommojglbmbpenpphppikmonn?hl=en

Sample Code for Authentication


package oracle.epm.webservices.profitability.util;

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.core.util.Base64;

public class RestClient {

    public static void main(String[] args) {
            // TODO Auto-generated method stub
            String auth = new String(Base64.encode("admin:password1"));
            Client client = Client.create();
            WebResource webResource =
               client.resource("http://yyy04ljy.mydomain.com:19000/
               profitability/rest/11.1.2.4.000/applications");
            ClientResponse response = webResource.header("Authorization",
               "Basic " + auth).type("application/json").
               accept("application/json").get(ClientResponse.class);
            int statusCode = response.getStatus();
            if (statusCode == 401) {
                System.out.println("error");
            }
            
            System.out.println(response);
            String responseStr = response.getEntity(String.class);
            System.out.println(responseStr);

    }
  }

Sample Client

Using the Profitability and Cost Management Sample REST Client File

The Sample Client File for Web Services displays the commands that can be used in your custom script for automating Profitability and Cost Management tasks, and identifies data within your Profitability and Cost Management model. The sample client file is intended as a guide only, to assist you in creating your custom scripts.

Setting Up the Sample Client Environment

To set up the sample client environment:

1.       Open a command window.

2.       Optional: If you are not running on the same computer on which Oracle Hyperion Enterprise Performance Management Workspace is installed, copy the folder %EPM_ORACLE_HOME%/products/ Profitability/samples/wsclient to the computer on which the sample is to be accessed (for example, C:\wsclient).

3.       Edit the hpm_ws_client.properties file to reflect your local settings (Note: These are all described in the properties file.):

·         Delimiter used to separate String literals in parameters (for example: string.delimiter=_).

·         Delimiter used to separate logical entities in parameters (for example, when passing multiple POVs at one time). For example, the following expression defines the delimiter as #: string.logical.delimiter=#, used as follows: 2009_January_Actual#2009_March_Actual.

·         SecurityPolicy associated with ProfitabilityService, that needs to be used by the Sample Client. For the sample client, this is USERNAME_TOKEN (for example, hpcm.service.security.policy=USERNAME_TOKEN).

·         These next two values are needed for the security policy USERNAME_TOKEN:

HSS user name for the Profitability user (for example, hss.username=admin).

Password for the username above (for example, hss.password=password123).

·         These next two values are needed for RESTFUL Web Service URL purposes:

HPCM REST URL which is to be accessed (for example, hpcm.rest.url.host=http://yyy00dby.mydomain.com:19000).

HPCM REST URL version which is to be accessed (for example, version=11.1.2.4.000).

4.       Optional: If you are not running on the same computer on which the Oracle Hyperion Enterprise Performance Management Workspace is installed, download and install JDeveloper 11.1.1.6.0 locally to obtain the appropriate JAVA_HOME and MIDDLEWARE_HOME folders.

5.       From a command or shell window, set the following environment variables:

Sample Client Environment Variables

Environment Variable

Location

JAVA_HOME

Location in which Java Development Kit is available:

l For Windows, enter SET JAVA_HOME=C:/Oracle/Middleware/jdk160_29 l For UNIX, enter export JAVA_HOME=/usr/c/Oracle/Middleware/jdk160_29

MIDDLEWARE_HOME

Location in which Oracle Middleware home is installed.

l For Windows, enter SET MIDDLEWARE_HOME=C:/Oracle/Middleware l For UNIX, enter export MIDDLEWARE_HOME=/usr/c/Oracle/Middleware

6.       In the command window, go to C:\wsclient, and then enter the following command:

hpm_ws_rest_client.bat -help

A list of all available functions is displayed.

7.       Use the format and resources specified in the sample client file to build your custom script. See Using the Sample Client File” on page 36.

Using the Sample Client File

The sample client file is intended as a guide for you to build your own custom scripts to access Oracle Hyperion Profitability and Cost Management data through Web Services. The sample client files are available at %EPM_ORACLE_HOME%/products/Profitability/samples/wsclient. These files were created using Batch Script (Windows OS) and Shell Script (UNIX/Linux OS).

To use the sample client file:

1.       In the command window, go to C:\wsclient. See “Using the Profitability and Cost Management Sample REST Client File” on page 35.

2.       Enter the following command: hpm_ws_rest_client.bat -help

3.       Select the resource to be performed, and enter the command in the following format:

hpm_ws_rest_client.bat -help <resource_name>

For example, to obtain the usage details of getPovs resource, enter the command in the following format:

hpm_ws_rest_client.bat -help getPovs

4.       To use the sample client file to perform a task, enter the command in the following format:

hpm_ws_rest_client.bat <resource_name> <<parameters>>

Example 1: List All Applications

For example, to obtain a list of all available applications, enter the command:

hpm_ws_client.bat getApplications

Example 2: List All POVs

For example, to obtain a list of all POVs for a given application, enter the command:

hpm_ws_rest_client.bat getPovs <<application name>>

Example 3: Get Stages

For example, to retrieve the stages for an application, enter the command:

hpm_ws_rest_client.bat getStages <<application name>>

Compiling the Code

The client sample is provided in the following formats:

·         As source code (in wsclient/src/oracle/epm/webservices/profitability/ client/ProfitabilityServicePortTypeRestClientSample.java)

·         As a compiled binary file (in wsclient/lib/hpcmwsclient-sample.jar)

To successfully compile the code, you must specify the location of the common.components.home folder.

If the source code needs to be recompiled for any reason, you can recompile using Ant. The build.xml file for Ant is available in the wsclient folder.

To recompile the source code:

1.       Open a command or shell window to specify the location of the common.components.home folder.

This folder is defined as MIDDLEWARE_HOME/oracle_common, where MIDDLEWARE_HOME is set as follows:

·         For Windows: SET MIDDLEWARE_HOME=C:/Oracle/Middleware

·         For UNIX: export MIDDLEWARE_HOME=/usr/c/Oracle/Middleware

2.       Pass the folder location to Ant, using one of the following methods:

·         As a command line parameter. For example:

ant -Dcommon.components.home=C:/Oracle/Middleware/oracle_common

·         In the build.properties file, open the file for editing and uncomment the definition of the common.components.home variable. For example:

common.components.home=C:/Oracle/Middleware/oracle_common

3.       Recompile the source code.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

______________________________________________________________________________________

Copyright ©2015, Oracle and/or its affiliates. All rights reserved. http://www.oracle.com