Utilising EPM Platform Jobs in Pipelines

Pipelines allow administrators to schedule jobs in the required order, including pre-processing rules, data load rules and post-processing rules in an easy and accessible interface via Data Integration. This is replacing the existing Batch functionality which is currently available in Data Management, but will soon be decommissioned.

Each pipeline is made up of a series of Stages, where a Stage is a group of jobs. There are many job types available, including business rules, integrations, EPM Platform jobs and many more!

Each job has various settings depending on the job type. These settings can reference Pipeline level variables or use a specific setting for that particular job.

In this blog we will focus on the EPM Platform Job types, which are slightly different to the standard pipeline jobs and require custom parameters, based on the REST API commands.

 

Example 1 – Administration Mode

The Administration Mode platform job can be used to set the application login level to admins only or to all users. To do this, add a new job and select:

  • Type = EPM Platform Job
  • Connection = Local
  • Title = Enter title for the job, e.g. Admin Mode On / Off
  • Sequence = the order in the stage
  • Job Type = Administration Mode

Then the parameters must match the REST API parameters, as detailed here: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/pbcs_admin_job.html#reference-1481-0d15b0c8

There is one parameter for this job type. Enter a new parameter as below: 

  • Label = loginLevel
  • Value =
    • Administrators – to enable admin mode
    •  All Users – to disable admin mode

Note: these parameters labels and value are case sensitive so be careful when entering them (recommend copying from the documentation)

 

Example 2 – Restructure Cube

The Restructure Cube job is used to perform a full BSO cube restructure. To do this, add a new job and select:

  •  Type = EPM Platform Job
  •  Connection = Local
  • Title = Enter title for the job, e.g. Restructure Finance Cube
  • Sequence = the order in the stage
  • Job Type = Restructure Cube

Then the parameters must match the REST API parameters, as detailed here:

https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/pbcs_restructure_job.html#GUID-84A931ED-3D16-453E-AA68-DF44F5C22F1D

There is one parameter for this job type. Enter a new parameter as below:

  • Label = cubeName
  • Value = name of the BSO cube e.g. FinCube

Note: these parameters labels and value are case sensitive so be careful when entering them (recommend copying from the documentation)

 

Example 3 – Merge Data Slices

The Merge Data Slices job is used to merge ASO data slices, which should improve performance of the ASO cube. To do this, add a new job and select:

  • Type = EPM Platform Job
  • Connection = Local
  • Title = Enter title for the job, e.g. Merge ASO Data
  • Sequence = the order in the stage
  • Job Type = Restructure Cube

Then the parameters must match the REST API parameters, as detailed here:

https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/pbcs_merge_data_job.html#GUID-59975792-7709-4E19-909D-6114C34F95B2

There are three parameters for this job type.

Enter the 1st parameter as below:

  • Label = cubeName
  • Value = name of the ASO cube e.g. PRJ_RPT

Enter the 2nd parameter as below:

  • Label = keepZeroCells
  • Value = possible values are true or false

Enter the 3rd parameter as below:

  • Label = mergeSliceType
  • Value = Possible values are:
    • allIncrementalSlicesInMain (Merge all into the main slice)
    • allIncrementalSlicesInOneIncremental (Merge all incremental into a single incremental slice)

Note: these parameters labels and value are case sensitive so be careful when entering them (recommend copying from the documentation)

Details of the REST API parameters for other EPM platform job types can be found here: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/execute_a_job.html#planning_rest_apis_3


For the full range of EPM Platform Jobs available to schedule in a Pipeline, see the Oracle documentation here: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/diepm/integrations_pipeline_epm_platform_job.html#GUID-36AD5A62-ADDB-4012-AFBF-4BE7AAB720DA

Happy scheduling!

Comments

Post a Comment

Popular posts from this blog

Loading multi-period row data files using Data Management

Image
The ability to load multi-period data with the Period and/or Year in the rows is not particularly new (since release 16.10), however it is something that most people seem to forget is possible in Data Management. This really is something worth remembering as it eliminates the need to either split the data files into one file per month or try to pivot the month into the columns. In order to set this up, let’s firstly look at how to add the Period and Year columns to the import format. Add the Period and Year columns using the Add -> Source Period Row dropdown, and input: The Source Column name – e.g. PERIOD The Field Number (file column) – e.g. 3 Any required expressions for that field  As these are Period/Year dimensions, the mappings are not held in the usual Data Load Mappings area. Instead they are configured in the Period Mappings , under the Source Mapping tab. Select the Source System as File to add a new mapping calendar for loading the data ...
Read more

Executing Smart View Retrievals using VBA

Image
When working with Hyperion systems, Smart View is a key tool used for reporting, as well as inputting data. It provides a valuable link between Hyperion and Excel, which allows users to retrieve data from the database straight into Excel with ease. Smart View functions are available through the Smart View toolbar and can be used with Essbase, HFM, Planning or Cloud connections. Occasionally, it is necessary to perform Smart View functions behind the scenes using VBA code, rather than manually using the Smart View toolbar. For example, a spreadsheet which will refresh all the Essbase retrieval sheets on opening, so that users can view the most up to date data, without having to remember to refresh each of the retrieval sheets themselves. This blog will be cover how to retrieve data using a Smart View refresh function in VBA. For more information about Smart View Excel VBA functions, go to the Oracle Hyperion Smart View Developers Guide .  System Requirements ...
Read more

Loading Actuals from Fusion ERP Cloud to PBCS

Image
If you’re looking to set up a data load of Actuals from ERP to PBCS and have heard this is an “Out of the box” integration, then good news! Not only is the OOTB connector included within PBCS Data Management but the integration is simple to setup and to schedule using EPM Automate. This blog will detail how to setup the ERP to PBCS connector in Data Management and some of the common errors found when running the data load. The first thing to know about this integration is that the data source is actually the ASO Essbase cube which sits underneath the Fusion ERP tables, holding the period Actuals values. This ERP Essbase cube is created using job ‘Create General Ledger Balances Cube’ when configuring the ERP system. This cube must be created before the integration can be set up correctly and can be accessed directly via Smart View for reconciliations. Set up the Source System As this is an Oracle built connector, it’s as simple as providing a name for the source system ...
Read more