After the introduction of multiple cloud offerings from Oracle like PBCS and EPCS there is always a need for managing the Cloud application in an automated fashion. For example wouldn’t it be great to invoke a Calculation, run a job, or know the status of a job using a batch file or a script? In this presentation, we will review the REST API for managing the Oracle PBCS and Data Management and its full potential.
How Does the Epitome of Spyware Differ from Other Malicious Software?
How to best use REST API to Manage and Administer Oracle PBCS
1. How to best use REST API to Manage and
Administer Oracle PBCS
By Dayalan Punniyamoothy
4th April 2017
2. 2
WHO WE ARE
Providing exceptional quality and value, while imparting a customer-focused approach.
Vertical Edge Consulting Group is your trusted partner for business consulting and technology solutions, ensuring reliability and scalability for your growing company.
2010
Year Founded
35
Employees
3
National Practices
2
Locations
1
Inspired Vision for Success
Our Company
Exceptional values, passion for
success, and dedicated commitment
drive our success.
Oracle Platinum Partner
Consultants average 12-15 years of
industry and Big 4 consulting experience
Technology focus on EPM, BI and Cloud
solutions, integrating with leading Tier 1
and 2 ERP systems
IT Strategy & Advisory Practice with CIO
and Fortune 500 leadership experience
In-depth understanding of Cloud
Technology & Solutions, driving today’s
strategic technology decisions
Strong dedication to customer success
and uncompromising values
3. 3
OUR SERVICES
Technology
Enterprise Performance
Management (EPM)
- Oracle Hyperion Financial Management
- Oracle Hyperion Planning
- Oracle Hyperion Planning & Budgeting
Cloud Service (PBCS)
- Oracle Hyperion Essbase
- Oracle Hyperion FDM/FDMEE
- Oracle Hyperion DRM
- Oracle Hyperion Reporting & Analysis
- Oracle Hyperion SmartView
Business Intelligence (BI)
- Oracle Business Intelligence Enterprise
Edition (OBIEE)
- Oracle Business Intelligence Foundation
Suite (BIFS)
- Oracle Business Intelligence Cloud Service
(BICS)
- Oracle Business Intelligence for
Applications (OBIA)
Advisory Services
- CIO Advisory
- IT Strategy
- Cloud Advisory
- Project Management Oversight (PMO)
- Enterprise Resource Planning Advisory
(ERP)
- Enterprise Architecture
Trusted Advisory
Technology Expertise
4. 4
ORACLE EPM EXPERIENCE
Oracle® Certified Platinum Partner
One of the nation’s leading Oracle EPM strategy & implementation firms
Successfully implemented Oracle EPM solutions for dozens of clients in the US, and abroad
Oracle EPM professional average 15 years of hands-on experience
Focused on Fortune 500 companies & large scale, enterprise-wide implementations
Deep expertise from process design to technology implementation
Proven functional and industry templates to leverage best practices
Hyperion Essbase, Planning and HFM certified professionals
Enterprise Planning
& Forecasting
•Planning, Budget & Forecasting
•Workforce & Capital Expenditure
Planning
•Planning System Design &
Implementation
•Balanced Scorecard
•Hyperion Planning™, Workforce
Planning™, Capital Expense
Planning™
Financial
Consolidation
•Financial Close Process Design
•Consolidation System Design &
Implementation
•Financial Reporting & Analysis
•Financial Management™, Financial
Data Quality Management™
Reporting &
Analytics
•Management Dashboards
•Profitability Analysis
•Human Resource Analysis
•Sales & Procurement Analytics
•Essbase™ Solutions, SmartView™,
and reporting tools
Business
Intelligence
•Data Management & Integration
•Content Management
•BI Enterprise Edition™, Data
Relationship Management™ and
integration tools
6. 6
WHAT WE WILL LOOK AT
What is REST API ?
About REST API for Oracle PBCS
How does it work?
Authentication
REST API Resource View
• Lifecycle Management
• Planning
• interop
Demo in Boomerang & Groovy
REST API Methods
7. 7
WHAT IS REST API ?
REpresentational State Transfer (REST)
An architecture for client-server web communication
Application Programming lnterface (API)
Lets products and services communicate with each other
REST describes any simple interface that transmits data over a standardized interface
(such as HTTP).
REST provides a set of design rules for creating stateless services that are viewed as
resources can be identified by their unique Uniform Resource Identifier (URIs).
8. 8
ABOUT REST API FOR ORACLE PBCS
You can integrate EPM Cloud environments using:
A set of REST APIs
The EPM Automate Utility, a command line tool that is implemented on top of the
REST APIs
Audience
The REST API for Oracle PBCS is intended primarily as a tool for infrastructure consultants and
administrators
Prerequisites
Access as a service administrator to the cloud service
Technical and functional knowledge to understand and execute the EPM Automate & REST
APIs, and to administer the product.
Knowledge of Java, cURL, Groovy, and REST programming.
9. 9
HOW DOES IT WORK?
REST API Client applications
An alternative to using the web-based user interface or a command line.
E.g.: Web-browsers, Groovy
REST API Service Request
http://pbcs.us2.oraclecloud.com/HyperionPlanning/rest/v3/
applications/PLDPlan/substitutionvariables
XML Service Response
"planType": "PLD",
"name": "PriorYr",
"value": "FY16"
10. 10
AUTHENTICATION
These REST APIs support basic authentication (name and password) in the format
identitydomain.username for this release.
All HTTP requests to the Oracle PBCS REST API require authentication.
Every HTTP request to EPM Cloud should supply HTTP Basic Authentication credentials through
the Authorization header.
11. 11
REST API METHODS
You can create, view, update, or delete Oracle Enterprise Performance Management
Cloud resources using standard HTTP method requests
GET Retrieve information about the REST API resource (e.g.: Retrieve Job Status Details)
POST Create a REST API resource (e.g.: Execute a Job)
PUT Update a REST API resource (e.g.: Setting Daily maintenance Window Time)
DELETE Delete a REST API resource or related component (e.g.: Delete Files)
12. 12
REST API RESOURCE VIEW – ORACLE PBCS (SOME OF THEM NOT ALL )
REST Resource -//interop/rest/
REST API version {api_version} for Lifecycle Management
is 11.1.2.3.600.
Request More Information
/interop/rest/ GET Get REST API Versions for Migration
/interop/rest/{api_version} GET Get Information about a Specific
Version of Migration
/interop/rest/{api_version}/applicationsnapshots/
{SnapshotName}/contents
GET Download
/interop/rest/{api_version}/Applicationsnapshots GET List Files
/interop/rest/{api_version}/applicationsnapshots/
{nSnapshotName}
DELETE Delete Files
/interop/rest/{api_version}/services GET Get Information About All Services
13. 13
REST API RESOURCE VIEW – ORACLE PBCS (SOME OF THEM NOT ALL )
REST Resource -/HyperionPlanning/rest/
Current REST API {api_version} version for Planning is v3.
Request More Information
/HyperionPlanning/rest/ GET Getting REST API Versions for Planning
/HyperionPlanning/rest/{api_version} GET Get Information about a Specific REST
API Version for Planning
/HyperionPlanning/rest/{api_version}/applications/{app}/jobd
efinitions
GET Get Job Definitions
/HyperionPlanning/rest/{api_version}/applications/{app}/dime
nsions/{dimname}/members
POST Add Member
/HyperionPlanning/rest/{api_version}/applications/{applicatio
n}/subvar
GET Get All Substitution Variables Defined
for the
Application
/HyperionPlanning/rest/{api_version}/applications/{applicatio
n}/plantypes/{plantype}/subvar
GET Get Substitution Variables Defined at
the Plan
Type Level
14. 14
REST API RESOURCE VIEW – ORACLE PBCS (SOME OF THEM NOT ALL )
REST Resource -//interop/rest/
REST API version {api_version} is v1 (interop)
REST API version {api_version} is V1 (aif)
Request More Information
/interop/rest/{api_version}/reports?
q={type:userauditreport,fileName:useraudit.csv,since=2015
-12-10,until=2016-06-10}/interop/rest/{api_version}
POST User Audit Report
/interop/rest/{api_version}/reports?q={type:provisionreport,f
ileName:ProvRep.csv} POST
User Provisioning Report
/interop/rest/{api_version}/dailymaintenance?StartTime={N}
PUT
Setting the Daily Maintenance Window
Time
/aif/rest/{api_version}
/aif/rest/{api_version}/jobs
GET
GET
Get Information about a Specific API
Version for Data Management APIs
Running Data Rules
15. 15
USING BOOMERANG – DEMO
/interop/rest/11.1.2.3.600
• Servcies
• Snanpshots
/HyperionPlanning/rest/v3
• Listing Applications
• Details about a member
• Substitution Variables
• All Filter Type with all Possible Values which User Can Filter Planning Units
• User Display Preference
• Job Definitions
• Job Details
• Job Status
/interop/rest/v1
• Provision Report
• Daily maintenance window time
• User Audit report
16. 16
USING BOOMERANG – DEMO
aif/rest/V1/jobs/
• For Listing the ran jobs under Data Management
17. 17
REST API IN GROOVY
Install groovy from http://groovy-lang.org/download.html
Default install location "C:Program Files (x86)GroovyGroovy-2.4.7bin“
Importing the following package
import org.json.JSONObject
import groovy.json.JsonSlurper
PBCSDetails.properties
serverUrl="https://hypdemo-test-hypdemo.pbcs.us.oraclecloud.com"
domain="hypdemo"
username=“example@example.com"
password=“password"
20. 20
Q&A
For additional questions or additional information, Please contact
Dayalan Punniyamoorthy
Oracle EPM Consultant at Vertical Edge Consulting Group
dayalanp@verticaledgecg.com
My Blog - https://onlyhyperion.blogspot.in/