Hyperion Planning Utilities Syntax – Reference Guide


Dears,

As we all know there are different utilities available in Hyperion planning. In this post i tried to cover some of them.

  • ExportSecurity
  • ImportSecurity
  • FormDefUtil
  • ProvisionUsers
  • UpdateUsers/UpdateNativeDir

By default, Planning utilities are installed in the EPM_ORACLE_INSTANCE/Planning/planning1 directory.

ExportSecurity

The ExportSecurity utility exports Planning access permissions to the SecFile.txt file, enabling you to export and import access permissions across applications.

  • If you specify only mandatory (not optional) parameters, all access permissions to all artifacts for all users and groups are exported. You can limit the export by specifying a member parameter (but only one member-based parameter).
  • You can specify the optional parameters in any order.
  • You can use only /S_USER or /S_GROUP, not both.
  • Use the /S=searchCriteria parameter to specify users and groups with the same name.
  • Running the utility creates a file named SecFile.txt, which contains the exported access permissions.

Usage:

ExportSecurity [-f:passwordFile] /A=appname,/U=username, [/S=searchCriteria|/S_USER=user|/S_GROUP=group], [/S_MEMBER=memberName|/S_MEMBER_ID=memberName |/S_MEMBER_D=memberName|/S_MEMBER_IC=memberName|/S_MEMBER_C=memberName],[/DELIM=delim] , [/DEBUG=true|false],[/TO_FILE=fileName],[/HELP=Y]

For example, to export access permissions for a user and group named Sales, enter:

ExportSecurity /A=app1,/U=admin,/S=Sales

The exported file will have same format as SecFile.txt example in the ImportSecurity section.

ImportSecurity

The ImportSecurity utility loads access permissions for users or groups from a text file into Planning.

  • All users, groups, and artifacts must be defined in the application.
  • Before importing access permissions on a user-defined custom dimension, you must allow access permissions to be set on it by selecting Apply Security.
  • You must name the text file SecFile.txt and save it in the planning1 directory.
  • Each line in the SecFile.txt file must specify access permissions information.

Example SecFile.txt:

User1,Account1,read,@CHILDREN
User2,Entity2,readwrite,@DESCENDANTS
User3,Version_1,readwrite,MEMBER
North America,Account101,write,@ICHILDREN

Usage:

ImportSecurity [-f:passwordFile] “appname,username,[delimiter],[RUN_SILENT],[SL_CLEARALL]”

(-f passwordFile is optional)

For example:

ImportSecurity “app1,admin,SL_TAB,1”.
FormDefUtil

Use the FormDefUtil.cmd utility to move data form definitions from one Planning application to another.

Usage:

formdefutil [-f:passwordFile]import|exportfilename|formname|-all server name user name application

To import one file:

FormDefUtil.cmd import c:\EPM_ORACLE_INSTANCE\Planning\planning1\form1.xml localhost admin APP1

To export one file:

FormDefUtil.cmd export Form1 localhost admin APP1

To export all data form definitions:

FormDefUtil.cmd export -all localhost admin APP1

To import all data form definitions:

FormDefUtil.cmd import -all localhost admin APP1.
ProvisionUsers

The ProvisionUsers utility synchronizes Planning users, groups, and roles in Shared Services Console with a Planning application and with Essbase.

Usage:

ProvisionUsers [-f:passwordFile] /ADMIN:adminName /A:appName [/U:user1[;user2;user3]] [/R:n]

To Synchronize all users in the App1 application:

ProvisionUsers /ADMIN:admin /A:App1

To Synchronize user Planner1 in the App2 application every 60 minutes:

ProvisionUsers /ADMIN:admin /A:App2 /U:Planner1 /R:60.
UpdateUsers

If you move users and groups, their identities (SIDs) change, unless you synchronize their identities between Planning and Shared Services, their assigned access permissions are lost. This command is used in concert with the UpdateNativeDir Utility. This utility and its documentation can be found in the EPM_ORACLE_INSTANCE/common/utilities/UpdateNativeDir directory. You use two utilities in concert to synchronize changes.

It is important to run the utilities in this order.
  1. Run the UpdateNativeDir utility to update user and group identities in Shared Services (refer to the documentation on usage).
  2. Run the UpdateUsers.cmd utility to update the SIDs in Planning with the changes in Shared Services.

Usage:

UpdateUsers [-f:passwordFile] serverName adminName applicationName

Example:

UpdateUsers.cmd ABCserver admin Planningapp.
HBRMigrateSecurity

If your application formerly used Business Rules, but now Calculation Manager is the selected calculation module for your application, administrators can migrate launch access permissions on business rules and their projects from Business Rules to Calculation Manager business rules in Planning using this command.

  • Overwrites launch access permissions that are already assigned to business rules in the specified Planning application.
  • Migrates access permissions only for users and groups that are provisioned for the specified Planning application in Shared Services Console.

Before running HBRMigrateSecurity.cmd:

  • If you are using Classic application administration, ensure that Calculation Manager is the selected calculation module for the application (see “Specifying System Settings” on page 231). If you upgraded the application to Performance Management Architect, then Calculation Manager is automatically selected as the calculation module.
  • Migrate business rules from Business Rules to Calculation Manager. See the Calculation Manager Designer’s Guide.
  • Deploy the business rules to Planning.

Example:

HBRMigrateSecurity.cmd /A:appname /U:admin /F:C:\temp \HBRExportedSecurity.xml.

TaskListDefUtil

Administrators can use TaskListDefUtil.cmd (Windows) or TaskListDefUtil.sh (UNIX) to move task list definitions between Planning applications. You can export or import task list definitions to or from an XML file. When you export task list definitions, the utility creates an XML file in the current directory and logs errors in TaskListDefUtil.log in the EPM_ORACLE_INSTANCE/diagnostics/logs/ planning directory. You can copy the utility to any directory and launch it from there to save files to another directory.

TaskListDefUtil [-f:passwordFile] import|exportFILE_NAME|TASK_LIST_NAME|-all SERVER_NAME USER_NAME APPLICATION

To import one file:

TaskListDefUtil.cmd import c:\EPM_ORACLE_INSTANCE\Planning\planning1\TaskList1.xml localhost admin APP1

To export one file:

TaskListDefUtil.cmd export TaskList1 localhost admin APP1

To export all task list definitions:

TaskListDefUtil.cmd export -all localhost admin APP1

To import all task list definitions:

TaskListDefUtil.cmd import -all localhost admin APP1
Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s