Export Data

Exports application data into a file using the export data settings, including file name, specified in a Planning job of type export data. The file containing the exported data is stored in the Planning repository.

You can also override some of the parameters of the job definition while executing this job with a REST API.

Exporting data supports substitution variables. You can use substitution variables while overriding the rowMembers, columnMembers, and povMembers definition. See Exporting Data and Creating and Assigning Values to Substitution Variables in Administering Planning.

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.

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 5-14 Export Data

Name Description Required Default
jobType Export Data or EXPORT_DATA (both parameters are supported) Yes None
jobName

The name of a job of type export data exactly as it is already defined in the Planning application.

Example: dailydataexport

Yes None
exportFileName

You can specify a file name for the exported data. Data is exported as a ZIP file only. The exported fie is stored in the Planning repository.

The value must use JSON syntax.

No The file name for the exported data will be the same as Job Name.
delimiter

You can use this parameter to override the delimiter parameter.

Allowed value is comma or tab.

No Delimiter used in the job definition.

exportSmartListAs

You can use this parameter to override how Smart Lists are exported.

Allowed value is label or name.

No Smart Lists parameter of the job definition.

includeDynamicMembers

You can use this parameter to include or exclude dynamic members.

Allowed value is true or false.

No Dynamic Members parameter of the job definition.
cube You can use this parameter to run the export data job on a different cube. No Cube parameter of the job definition.
rowMembers You can override the row members defined in the job definition.

Example: "Name,Price,Discount %"

No Row parameter defined in the Slice section of the job definition.
columnMembers You can override the column members defined in the job definition.

Example: "Name,Price,Discount %"

No Column parameter defined in the Slice section of the job definition.
povMembers You can override the POV members defined in the job definition.

Example: "Name,Price,Discount %"

No Point of View parameter defined in the Slice section of the job definition.
exportDataDecimalScale Specify the number of decimal positions (0-16) that will be returned when exporting data from Essbase. If the default None is selected, the data that is returned will not be formatted and will return as Essbase returns it. Selecting a numeric value will result in the exported data displaying that number of digits to the right of the decimal point, wherever applicable. For example, specifying 3 in the Decimals field will result in the exported data being formatted to display three digits to the right of the decimal point. Selecting 0 formats the data to display a whole number.

Example: A value 27.07000001 can be formatted and written as 27.07 in the export data file if the value for this parameter is set to 2.

No Decimals parameter of the job definition

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payloads

Example 1: Executes the export data job ExportJobDaily and overrides the exportFileName parameter.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
     "parameters":{
          "exportFileName":"myExportfile.zip"
          }
}

Example 2: Executes the export data job ExportJobDaily and overrides the delimiter, exportSmartListAs, and includeDynamicMembers parameters.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "delimiter":"tab",
     "exportSmartListAs":"name",
     "includeDynamicMembers":"true"
     }

Example 3: Executes the export data job ExportJobDaily and overrides the cube parameter only. This job will now execute for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "cube":"Vis1ASO
     }
}

Example 4: Executes the export data job ExportJobDaily and overrides the cube name along with the rowMembers, columnMembers, and povMembers parameters. This job will now execute for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "cube":"Vis1ASO",
     "rowMembers":"Current,Variance,Actual,Scenario",
     "columnMembers":"Statistics,Account",
     "povMembers":"Period,Year,Version,Entity,Product,Channel"
     }
}

Example 5: Executes the export data job ExportJobDaily and overrides the cube name along with the parameters rowMembers, columnMembers, and povMembers. We use substitution variables while overriding the rowMembers, columnMembers, and povMembers definition. This job executes for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
 "parameters":{
     "cube":"Vis1ASO",
     "rowMembers":"ILvl0Descendants(&Param1)",
     "columnMembers":"ILvl0Descendants(&Param2)",
     "povMembers":"Period,Year,Version,&Param3,Product,Channel"
     }
}

Example 6: Executes the export data job ExportJobDaily and overrides the cube name along with the parameters exportDataDecimalScale, rowMembers, and columnMembers. We use substitution variables while overriding the rowMembers, columnMembers, and povMembers definition. This job executes for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "cube":"Vis1ASO",
     "rowMembers":"ILvl0Descendants(&Param1)",
     "columnMembers":"ILvl0Descendants(&Param2)",
     "povMembers":"Period,Year,Version,&Param3,Product,Channel",
     "exportDataDecimalScale":"2"
     }
}