Automating Planning Administrative Processes Using the Oracle® Hyperion Enterprise Performance Management Architect, Fusion Edition Batch Client 11.1.2

<Do not delete this text because it is a placeholder for the generated list of "main" topics when run in a browser>

Purpose

This tutorial covers how to use the Performance Management Architect Batch Client to create and deploy Oracle® Hyperion Planning, Fusion Edition 11.1.2 applications.

Time to Complete

Approximately 1 hour.

Overview

Performance Management Architect Batch Client enables you to combine processes such as data export, metadata loads, data loads, and calculations and run these operations during your normal nightly or weekly load process. You can use the Batch Client to perform many tasks, including the following:

You can run the Performance Management Architect Batch Client in two modes:

In this tutorial, you perform the steps to create and deploy Planning 11.1.2 applications using the Batch Client in command line mode. After you deploy the application, you access it in Application Library.

Software and Hardware Requirements

The following is a list of software requirements:

Oracle Hyperion Planning Plus 11.1.2 includes the following components:

The batch client is installed automatically when you install Performance Management Architect. You can run Batch Client on Windows platforms. When you install Performance Management Architect, a batch file is automatically created to setup the class paths that are generated during installation.

Prerequisites

Before starting this tutorial, you should:

.

Have administrator access to a working installation of Planning 11.1.2.

 

.

Have administrator access to a working installation of Hyperion® Shared Services 11.1.2.

 

.

Have administrator access to a working installation of Enterprise Performance Management Architect 11.1.2.

 

Preparing to Use Batch Client

To prepare using Batch Client:

Downloading Documentation

To download documentation:

.

Launch your browser.

 

.

Navigate to the Oracle Enterprise Performance Management System, Fusion Edition Release 11.1.2 Documentation Library by using the following URL:

http://download.oracle.com/docs/cd/E17236_01/index.htm


.

In the left menu, click Foundation Services.

 

.

Under Oracle Hyperion Enterprise Performance Management Architect, Fusion Edition, for Batch Client User's Guide, right-click PDF and select Save Link As....

 

.

Navigate to the location where you want to save the file, and click Save.

 

Accessing Batch Client

To access Batch Client:

.

Select Start, Programs, then Oracle Enterprise Performance Management System, then Foundation Services, then Performance Management Architect,and then Start EPMA Batch Client.

The Batch Client command window is displayed:

 

Logging On to Performance Management Architect

To log on to Performance Management Architect:

.

Set the server URLs by using the following commands, and press Enter after each line item:

set bpmaserverurl=http://localhost/hyperion-bpma-server;
set workspaceurl=http://localhost:19000/workspace;

Note: Contact your administrator for your company's server URLs.

 

.

Enter your Performance Management Architect username and password with the following syntax, and press Enter:

login username,password;

 

Creating Planning Applications

Performance Management Architect Batch Client enables you to create a new, empty Planning application with the specified name. Empty applications are oftentimes referred to as shell applications. After creating shell applications, you can create, import, or copy dimensions and members in Shared Library and within Planning applications.

Creating Shell Applications

To create shells for Planning applications:

.

Create the shell application with the following syntax, and press Enter:

Create Application Properties(ApplicationName, ApplicationDescription, ApplicationType) Values('PlanBud', 'Planning Budget Application', 'Planning');

  • Application Name—A string containing a valid name for the application. In this example, 'PlanBud' is used.
  • ApplicationDescription—A string containing a valid description for the application. In this example, 'Planning Budget Application' is used.
  • ApplicationType—Enter 'Planning' for Planning applications.

The following message is displayed: The application "PlanBud" has been created with objectid "1_4".

 

Adding Dimensions and Members

You can create dimensions and members in Shared Library or within an application.

You can add dimensions and members to the Shared Library, or you can copy them from the Shared Library to an application. You can add dimensions as shared dimensions or you can copy them to the application as local dimensions. You can insert a copy of a member as a shared member in an application. However, you can use the Insert Member command only on local dimensions and Shared Library dimensions. You cannot insert members in a shared dimension in an application.

You can also import dimensions and members to an application or Shared Library using an ADS file.

This section covers the different methods of adding dimensions and members by using Batch Client:

.

Create dimensions with the following syntax and press Enter:

Create Dimension Properties(ApplicationName, DimensionName, DimensionDescription, DimensionType) Values(#Shared,'Entity','Entity Dimension','Entity');

  • ApplicationName—The name of an existing application. Use #Shared to create a dimension in the Shared Library.
  • DimensionName—A valid name for the dimension. In this example, 'Entity' is used.
  • Dimension Description—A string containing a valid description for the dimension. In this example, 'Entity Dimension' is used.
  • DimensionType—Dimension Type can be any one of the following: Account, Alias, AllocationType, Attribute, ConsolidationMethod, Country, Currency, Entity, Generic, ICP, Measure, Scenario, SecurityClass, SmartList, Time, UDA, Value, Version, View, Year.

Note: Planning requires six dimensions. If these six dimensions are already created in Dimension Library, you can add them to the application instead.


.

Create members with the following syntax and press Enter:

Create Member Properties(ApplicationName, DimensionName, ParentName, MemberName, MemberDescription) Values('PlanBud','Account', '#root', 'Income Statement', 'Income Statement Accounts');

  • ApplicationName—The name of an existing application. Use #Shared to create a dimension in the Shared Library. In this example, 'PlanBud' is used.
  • DimensionName—The name of an existing dimension. In this example, 'Account' is used.
  • ParentName—The name of the parent under which to insert the newly created member. Use #Root to add a new member at the top level of the tree.
  • MemberName—A valid name for the new member. In this example, 'Income Statement' is used.
  • MemberDescription—A description for the new member. In this example, 'Income Statement Accounts' is used.

 

.

Import dimensions and members by using an ADS file with the following syntax, and press Enter:

Execute Import Parameters(importtype, profilename, filename, waitforcompletion)Values('flatfile', 'PlanApp', '.\AppFiles\PlanApp.ads', 'true');

  • ImportType—The type of import to perform. Allowed values are: FlatFile and InterfaceTables.
  • ProfileName—The name of an existing import profile. In this example, 'PlanApp' is used.
  • FileName—The name of the flat file to import, if performing a flat file type import. In this example, the 'PlanApp.ads' flat file in the AppFiles directory is used.
  • WaitForCompletion—If set to true, Batch Client waits for the job to finish. If set to false, the Batch Client submits the job and continues. Allowed values are: True or False.

The following figure displays a sample ADS file:

 

.

Use the following syntax to copy dimensions within Shared Library, within an application, or between Shared Library and an application, and press Enter:

Copy Dimension Properties(ApplicationName, DimensionName, TargetDimensionName, TargetDimensionDescription, destApplicationName) Values('#Shared', 'Scenario','Scenario', 'Scenario Dimension', 'PlanBud');

  • ApplicationName—The name of an existing application. Use #Shared to copy a dimension from the Shared Library.
  • DimensionName—The name of an existing dimension. In this example, 'Scenario' is used.
  • TargetDimensionName—The name of the target dimension. In this example, 'Scenario' is used.
  • TargetDimensionDescription—The description of the target dimension. In this example, 'Scenario Dimension' is used.
  • destApplicationName—The name of the destination application. In this example, 'PlanBud' is used.

Note: You cannot copy a dimension directly from one application to another.

 

.

Use the following syntax to add an existing dimension from the Shared Library to the specified application, and press Enter after each line item:

SET APPLICATION = 'PlanBud';
Include Dimension Properties(DimensionName, IncludeAsShared) Values('C_Alias', 'true');

  • DimensionName—The name of an existing dimension in the Shared Library. In this example, 'C_Alias' is used.
  • IncludeAsShared—Use a value of true to include the dimension as a shared dimension. Use a value of false to include a local copy of the dimension within the application.

The dimension can be added as a shared dimension or copied to the application as a local dimension.

Note: You must set the application name before the Include Dimension command. By setting the application name, command lines use it if the application is not explicitly defined within a command.

 

.

Use the following syntax to insert a copy of a member as a shared member within an application, and press Enter after each line item:

SET APPLICATION = 'PlanBud';
Insert Member Properties(DimensionName, ParentName, InsertMemberName, MemberToInsertName) Values('Account', 'Par1', ‘Mem1’, ‘Mem2’);

  • DimensionName—The name of an existing dimension. In this example, 'Account' is used.
  • ParentName—Name of the parent to insert the member under. In this example, 'Par' is used.
  • InsertMemberName—Name of the member to insert the member under. In this example, 'Mem1' is used.
  • MemberToInsertName—Name of the shared member to be inserted. In this example, 'Mem2' is used.

You can use the Insert Member command only on local dimensions and Shared Library dimensions. You cannot insert members in a shared dimension within an application.

Note: You must set the application name before the In command. By setting the application name, command lines use it if the application is not explicitly defined within a command. Alternatively, you can set the application name to #Shared if you are copying a member from Shared Library.

 

Deploying Planning Applications

After creating the shell and adding dimensions and members, you deploy the application to make it accessible in Workspace. To deploy Planning applications, you must be provisioned with the Application Creator or Planning Administrator role.

.

Deploy a Planning application with the following syntax, and press Enter:

Execute Deploy Parameters(ApplicationName, InstanceName, ApplicationServer, HubProject, waitforcompletion, dataSourceName, CreateOutline) Values('PlanBud', 'PLANNING', 'PLANNING', 'Default Application Group', 'true', 'ST01PLN3', 'true');

  • ApplicationName—The name of an existing application. In this example, 'PlanBud' is used.
  • InstanceName—The name of the instance to deploy to. In this example, 'PLANNING' is used.
  • ApplicationServer—The name of the application server to deploy to. In this example, 'PLANNING' is used.
  • HubProject—The Shared Services project to add the deployed application to. In this example, 'Default Application Group' is used.
  • WaitForCompletion—If set to true, Batch Client waits for the job to finish. If set to false, Batch Client submits the job and continues. Allowed values are: True or False
  • datasourceName—Creates a data source with the specified name. In this example, 'ST01PLN3' is used.
  • CreateOutline—Creates the Essbase outline if you are deploying the application for the first time. Allowed values are True or False.

For additional Planning parameters, see the Oracle Hyperion Enterprise Performance Management Architect, Fusion Edition 11.1.2 Batch Client's User Guide.

When the deployment is completed, the following message is displayed:

 

Accessing the Deployed Application in Application Library

You must log on to Workspace with an administrator account. To access the deployed application in Application Library:

.

Log on to Workspace.

 

.

Select Navigate, then Administer, and then Application Library.

 

.

Click the Planning application that you deployed in Batch Client. In this example, 'PlanBud' is selected.

When you select an application, the following information is displayed in the lower pane:

  • Summary—Contains the name, type, date created, date last deployed, and the associated data synchronizations.
  • Description—Contains the information that you provided in the Description field when you created the application.
  • Dimensions—Lists the dimensions available in the application.
  • Properties—Displays the status, default currency, and specific properties set for the application.
  • Synchronizations—Lists the data synchronizations for this application.
  • Rules / Rule Set—Enumerates the rules and rule sets defined in Calculation Manager for this application.

 

Summary

In this tutorial, you have learned how to:

Resources

 

About Oracle | Oracle RSS Feeds | Careers | Contact Us | Site Maps | Legal Notices | Terms of Use | Your Privacy Rights