Plan Type Map

Copies data from a block storage cube to an aggregate storage cube or from one to another based on the settings specified in a job of type plan type map.

For details about data maps, see Defining Data Maps in Administering Data Integration for Oracle Enterprise Performance Management Cloud.

This API is not supported for Financial Consolidation and Close or Tax Reporting.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job. For additional parameters that are common to all jobs, see Execute a Job.

Table 8-12 Plan Type Map

Name	Description	Required	Default
jobType	Plan Type Map or PLAN_TYPE_MAP (both parameters are supported)	Yes	None
jobName	The name of a job of type plan type map that is already defined in the application. Example: CampaignToReporting	Yes	None
parameters	Optionally, you can specify these parameters: clearData - Whether the data in the target database should be moved before copying data (defult: true). The value must use JSON syntax. Example: {clearData:false} overrideMembersMap - A map containing the dimension name as the key and a member selection string as a value. Members specified in the map will replace the members in the data map definition during execution. overrideExclusionMembersMap - A map containing the dimension name as the key and a member selection string as a value. Members specified in the map will be excluded from the member selection in the data map definition during execution. Any members from the evaluated exclusion selection not present in the evaluated member selection from the data map definition will be ignored. Notes: The override parameters execute this data map using the specified override members map, clearing data in the target region beforehand if requested. The data map push will error out when the override members map contains members from unmapped dimensions of the target location. The member selection string is a comma-separated string consisting of member names, functions or expressions.	No	None

Example URL and Payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/jobs

{
  "jobType": "PLAN_TYPE_MAP",
  "jobName": "MapReporting",
  "parameters": {
    "cubeLinkName": "name",
    "clearData": true
  }
}

Examples of overriding selections of the data map:

{
  "jobType": "PLAN_TYPE_MAP",
  "jobName": " MapReporting",
  "parameters": {
    "cubeLinkName": "MapChannels",
    "clearData": true,
    "overrideMembersMap": {
      "Period": "ILvl0Descendants(Q1)"
    },
    "overrideExclusionMembersMap": {
      "Period": "Jan"
    }
  }
}

  "overrideMembersMap": {
    "Period": "ILvl0Descendants(Q1)"
  }

  "overrideMembersMap": {
    "Period": "ILvl0Descendants(Q1)",
    "Account": "Sales"
  }

Examples of excluding members:

"overrideExclusionMembersMap": {
    "Period": "Jan"
  }

  "overrideExclusionMembersMap": {
    "Period": "Jan, Feb, &CurrMonth, ILvl0Descendants(Q1), YearTotal, Red"
  }