Explore DataManagement REST API - Oracle PBCS/EPBCS with Groovy flavor !!!

In continuation of other series about REST API on Planning ,Migration & User Reports in this post let’s explore the REST APIs for DataManagement to run data rules, run batches, import and export data mapping, and to execute reports. 

To begin let's explore groovy program to get the DataManagement apiVersion details and the Output below

1.DataManagement apiVersion Details

Edit / View Groovy from Notepad++

This will help you if you like to edit or view the Groovy Program using the Notepad ++

Currently, you don't have Groovy listed under Language in Notepad ++ so editing or viewing a Groovy program is not well displayed.

But you can add Groovy language to Notepad ++.

Step 1:

Creare “userDefineLang_Groovy.xml” by copying the following code and saving it

<NotepadPlus>

    <UserLang name="Groovy" ext="groovy" udlVersion="2.1">

        <Settings>

            <Global caseIgnored="no" />

            <Prefix Keywords1="no" Keywords2="no" Keywords3="no" Keywords4="no" />

        </Settings>

        <KeywordLists>

            <Keywords name="Comments">03/* 04*/ 00// 01 02</Keywords>

            <Keywords name="Keywords1">abstract break case catch continue default do else extends final finally for if implements instanceof native new private protected public return static switch synchronized throw throws transient try volatile while strictfp package import false null super this true</Keywords>

            <Keywords name="Keywords2">as assert def mixin property test using in it</Keywords>

            <Keywords name="Keywords3">boolean byte char class double float int interface long short void</Keywords>

            <Keywords name="Keywords4">abs any append asList asWritable call collect compareTo count div dump each eachByte eachFile eachLine every find findAll flatten getAt getErr getIn getOut getText grep immutable inject inspect intersect invokeMethods isCase join leftShift minus multiply newInputStream newOutputStream newPrintWriter newReader newWriter next plus pop power previous print println push putAt read readBytes readLines reverse reverseEach round size sort splitEachLine step subMap times toInteger toList tokenize upto waitForOrKill withPrintWriter withReader withStream withWriter withWriterAppend write writeLine</Keywords>

            <Keywords name="Delimiters">00&quot; 01 02&quot; 03&apos; 04 05&apos;</Keywords>

        </KeywordLists>

        <Styles>

            <WordsStyle name="DEFAULT" fgColor="000000" bgColor="FFFFFF" fontName="" fontStyle="0" fontSize="" nesting="0" />

            <WordsStyle name="COMMENTS" fgColor="008000" bgColor="FFFFFF" fontName="" fontStyle="0" fontSize="" nesting="0" />

            <WordsStyle name="LINE COMMENTS" fgColor="008000" bgColor="FFFFFF" fontName="" fontStyle="0" fontSize="" nesting="0" />

            <WordsStyle name="NUMBERS" fgColor="FF0000" bgColor="FFFFFF" fontName="" fontStyle="0" fontSize="" nesting="0" />

            <WordsStyle name="KEYWORDS1" fgColor="0000FF" bgColor="FFFFFF" fontName="" fontStyle="1" fontSize="" nesting="0" />

            <WordsStyle name="KEYWORDS2" fgColor="006699" bgColor="FFFFFF" fontName="" fontStyle="1" fontSize="" nesting="0" />

            <WordsStyle name="KEYWORDS3" fgColor="FF8000" bgColor="FFFFFF" fontName="" fontStyle="1" fontSize="" nesting="0" />

            <WordsStyle name="KEYWORDS4" fgColor="8000FF" bgColor="FFFFFF" fontName="" fontStyle="1" fontSize="" nesting="0" />

            <WordsStyle name="OPERATORS" fgColor="804000" bgColor="FFFFFF" fontName="" fontStyle="1" fontSize="" nesting="0" />

            <WordsStyle name="DELIMITERS1" fgColor="808080" bgColor="FFFFFF" fontStyle="0" nesting="0" />

            <WordsStyle name="DELIMITERS2" fgColor="808080" bgColor="FFFFFF" fontStyle="0" nesting="0" />

        </Styles>

    </UserLang>

</NotepadPlus>

Explore User Reports & Daily Maint REST API - Oracle PBCS with Groovy flavor !!!

In continuation of other series about REST API on Planning & Migration in this post let’s explore the REST APIs for Provision Reports,User Audit reports and the Daily Maintenance Window Time. 

1.REST API for running Provision report on Oracle PBCS\EPBCS

Straight from the document:

Generates a provisioning report of users in the system and writes the report to the filename provided. This is an asynchronous job and uses the job status URI to determine if the operation is complete.

You can manually generate a Provision Report from Oracle PBCS instance

 Navigate -> Tools

Mass loading of Attribute Dimension into Oracle PBCS!!!

We all knew what is an Attribute dimension and how to create one in Oracle PBCS/EPBCS. In this post lets see how to bulk load the Attribute dimension into Oracle PBCS/EPBCS.

If we want to create/update more than 100/1000 of attribute dimension it will be cumbersome to get them created/updated via the Standard Interface.

In my case I need to load around 100 attribute dimension members, let's call the attribute dimension as “JobTitle” and need to associate them with the Employee dimension.

  

Yes, just like any other dimensions you can Export/Import them from the Simplified Interface. The trick is you won't find them listed under Dimension,

But when you click on Export/Import button 

Explore Migration REST API - Oracle PBCS with Groovy flavor !!!

I hope you have enjoyed the Introduction and the Planning REST API posts which were posted earlier. Lets explore the Migration related REST API for the Oracle PBCS in this post.

Migration REST APIs

Use the Migration REST APIs to get API versions, work with files, and manage
services and application snapshots.

Explore Planning REST API - Oracle PBCS with Groovy flavor !!!

After the introduction to the REST API & Groovy lets explore the Planning REST API in this post.

1. Get REST API version for Planning

Returns information about which versions are available and supported. Multiple versions might be supported simultaneously by Oracle Hyperion Planning.

This is already covered but lets see how to get the apiVersion details using Groovy.

Output of the program

Finally REST(REST API) on Oracle PBCS!!!

This was a lying in my draft for a quite long time after my webinar on this topic, finally publishing it :-)  have fun.

The complete documentation for the REST API for Oracle EPM Cloud is here

Straight from document:

REST describes any simple interface that transmits data over a standardized interface (such as HTTP) without an additional messaging layer, such as SOAP. REST provides a set of design rules for creating stateless services that are viewed as resources, or sources of specific information, and can be identified by their unique URIs. RESTful web services are services that are built according to REST principles and, as such, are designed to work well on the web. Typically, RESTful web services are built on the HTTP protocol and implement operations that map to the common HTTP methods, such as GET, POST, PUT, and DELETE to retrieve, create, update, and delete resources, respectively. 

REST API Methods

You can create, view, update, or delete Oracle Enterprise Performance Management
Cloud resources using standard HTTP method requests, as shown below

Method	Description
GET	Retrieve information about the REST API resource
POST	Create a REST API resource
PUT	Update a REST API resource
DELETE	Delete a REST API resource or related component

Current REST API Version

Covering only majorly used components

REST Resource	REST API version	Getting REST API Versions
Planning	v3	/HyperionPlanning/rest/
Migration	11.1.2.3.600	/interop/rest/
Data Management	V1	/aif/rest/

There are multiple REST API clients available for free, you can pick as per your choice.

Direct URL for Accessing Data Management!!!

Have seen this question multiple times in the public forum on how to access the Data Management directly rather than accessing it via the Workspace?

The URL for On-Premise to access the Data Management directly

http://Foundationserver:19000/workspace/index.jsp?module=aif.launch

The URL for PBCS/EPCS to access the Data Management directly

https://vecghypdemo.pbcs.us2.oraclecloud.com/workspace/index.jsp?module=aif.launch

While accessing the above URL if the Workpace is already opened it opens in a seperate tab. If not logged in before opens up in the same tab in IE.

Note: This is applicable to both On-Premise and PBCS/EPCS

What does EPM Automate Utility offer - Part 4

In this series lets see how to read a file and strip a particular value from a column of a CSV file and use that value in the EPM automate script.

Requirement:

Every month the pay details are extracted from the source system and the data file is loaded into the PBCS, to get this automated the file name should be named as MMM-YY (Pay month and year format).

Let us explore how this is achieved using the EPM  automate.

Using Substitution Variables in Direct Page Links for Forms and Dashboards in PBCS!!!

In my other post Using Direct Page Links for Formsand Dashboards in PBCS!!! We used the POV with hardcoded members for accessing the forms. A anonymous comment on the post asked

So thought of posting on Using the Direct Page Links for forms using substantiation Variables.

In the POV call the Substitution variables as “&SubVar” instead of the actual member. 

https://demo-test-demo.pbcs.us2.oraclecloud.com/HyperionPlanning/faces/LogOn?

Direct=True&ObjectType=FORM&ObjectName=ForHeadCountExt&POV="&FcstStartMth","&ActCurYr"

And the Forms is called using the sub var

Hope this helps !!!

What does EPM Automate Utility offer - Part 3

After the EPM automate serious 1 & 2 let me cover downloading the latest exported file & logs related to a specific Data export job.

Currently we don’t have a specific command to download the latest exported file and when you run a export data command it prefix the job id ad the end and created the export file.

Let’s see how to download the latest file or the latest log file using EPM automate