Making Your Life Easier with the Planning Utilities

Keith Amann Monsanto

Some of you may be asking

There are Planning Utilities? Yes!

So where is all of the documentation? Spread p throughout the Admin guide

Agenda
About Monsanto Understanding the Planning Utilities g g Lessons Learned Q&A

Making Your Life Easier with the Planning Utilities

ABOUT MONSANTO

 Monsanto is an agricultural company. We apply innovation and technology to help pp y gy p farmers around the world produce more while conserving more. We help farmers g p grow yield sustainably so they can be successful, produce healthier foods, better ,p , animal feeds and more fiber, while also reducing agriculture's impact on our g g p environment. 5

Our business is structured in two segments: Seeds and Genomics The Seeds and Genomics segment consists of the company's global seeds and traits business, and genetic technology platforms - including biotechnology, breeding and genomics. Agricultural Productivity The Agricultural Productivity segment consists primarily of crop protection products and residential lawn and lawn-andgarden herbicide products

Making Your Life Easier with the Planning Utilities

UNDERSTANDING THE UTILITIES

Where are the Utilities?

Most can be found in your Planning install directory under the bin folder HYPERION_HOME/products/Planning/bin

PasswordEncryption.cmd

Suppressing Password Prompts

P Passwords can b suppressed when running utilities d be d h i tiliti
Helpful when you dont want to stay up until 2am to launch a process Optional

PasswordEncryption utility
Creates a file that stores the password in encrypted form Each password file contains one password You choose the directory when running the utility

After the password file is created, you can use the f:passwordfile option as the first parameter in the command line
Will skip the password prompt and use the password from the encrypted file

PasswordEncryption.cmd
Windows
PasswordEncryption.cmd nameandpathofpasswordFile

Unix
PasswordEncryption.sh nameandpathofpasswordFile

BroadCastMessage.cmd

BroadCastMessage.cmd
Communicate text message to all Planning users currently logged into the application
Ask folks to log out; communicate upcoming maintenance Only appears in Planning

Cmd is an alternative to Web client Messages can be scheduled (using third p y party scheduler) )

BroadCastMessage.cmd
Launch the broadcastmessage.cmd utility
Broadcastmessage.cmd f:passwordfile, server_name, application_name, username, message Broadcastmessage.cmd epm111server, entbud, cbarkley, entbud cbarkley Save your work now because in 5 minutes Im kicking y g you out of the system. y

ExportSecurity.cmd

ExportSecurity.cmd
Export Planning access permissions to the SecFile.txt file
Exports security for members, data forms, data form folders, task lists, Calculation Manager business rules, C l l ti M M b i l Calculation Manager business rules folders Can export users or groups (but not both)

You can then export / import access permissions across applications i i li ti

ExportSecurity.cmd
ExportSecurity.cmd [-f:passwordFile] /A=appname,/U=username, [/S=searchCriteria|/S_USER=user|/S_GROUP=g | _ | _ g roup], [/S_MEMBER=memberName|/S_MEMBER_ID=memberN ame |/S_MEMBER_D=memberName|/S_MEMBER_IC=membe rName|/S_MEMBER_C=memberName],[/DELIM=deli m] , [/DEBUG=true|false],[/TO_FILE=fileName],[/ HELP=Y]

/S=Searchcriteria (search for a user or group) /S_USER=user (specify a user) /S_GROUP=group ( p _ g p (specify a g p) y group) /S_MEMBER=membername (specify a member) /S_MEMBER_ID=membername (specify a member and its descendants) /S_MEMBER_D=membername (specify a members descendants) /S_MEMBER_IC=membername (specify a member and its children) /S_MEMBER_C=membername ( /S MEMBER C b (specify a members d if b descendants) d t ) /DELIM=delim (specify a delimiter) /DEBUG= true/false /TO_FILE = (specify the path to the SecFile.txt ( /HELP = Y

ExportSecurity.cmd Optional Parameters

ExportSecurity.cmd
Exportsecurity.cmd f:passwordfile /A=entbud, /U=admin Exportsecurity.cmd f:passwordfile f:passwordfile /A=entbud, /U admin,/TO_FILE D:\\Hyperion\\Produc /U=admin,/TO FILE=D:\\Hyperion\\Produc t\\Planning\\bin\\Sales,/S_MEMBER_ID=S ales/DELIM ; ales/DELIM=;

ExportSecurity.cmd
Cant export access permissions to task lists for administrators
But you can manually add those records into the file for future importing

SecFile.txt

Artifacts
SL_FORM SL_COMPOSITE SL_TASKLIST SL_CALCRULE SL CALCRULE SL_FORMFOLDER SL_CALCFOLDER

ImportSecurity.cmd

ImportSecurity.cmd
Load access permissions for users and groups from a text file Imports security for members, data forms, data form folders, task lists, Calculation Manager business rules, Calculation Manager business rules folders Overwrites existing permissions SL CLEARALL clears existing access SL_CLEARALL permissions

ImportSecurity.cmd
All users, groups and objects must be defined in the application SecFile.txt is the file name and must be in the bin folder Available delimiters for the secfile.txt:
Comma tab, semi-colon pipe colon space Comma, tab semi colon, pipe, colon, Comma is default

Verify results in importsecurity log importsecurity.log

ImportSecurity.cmd
ImportSecurity.cmd [f:passwordFile] appname,username,[delimiter],[ RUN_SILENT],[SL_CLEARALL] ImportSecurity.cmd entbud,admin,SL_TAB,1

ProvisionUsers.cmd

ProvisionUsers.cmd
Synchronizes Planning users, groups and roles in Shared Services with a Planning application and Essbase Alternative to refreshing security filters ProvisionUsers [f:passwordFile] /ADMIN:adminName /A:appName [/U:user1[;user2;user3]] [/R:n]

ProvisionUsers.cmd
ProvisionUsers /ADMIN:admin /A:entbud
Syncs all users for entbud application

ProvisionUsers /ADMIN:admin /A:entbud /U:cbarkley /R:60

Syncs user cbarkley in entbud every 60 minutes

ProvisionUsers.cmd
/U: - Specifies the users to sync /R: - Specifies the interval in minutes for the sync to run (no argument runs the sync once)

UpdateUsers.cmd

UpdateUsers.cmd
If you move users and groups, their identities or SIDS change
Change authentication Users, groups or organization units are moved in an external provider Migrate application from one environment to an another with different Shared Services instances

M Must sync identities b id i i between Pl Planning and i d Shared Services

Steps to Refresh
1. Run the UpdateNativeDir utility to update user and group identities in Shared Services
UpdateNativeDir and its documentation are in the HYPERION_HOME/Common/Utilities/SyncOp enLDAPUtility directory directory.

2. Run the UpdateUsers.cmd to update SIDs in Pl i Planning with the changes in Sh d i ith th h i Shared Services

UpdateUsers.cmd
updateusers.cmd [f:passwordFile] serverName adminName applicationName Check out results in UpdateUsers.log in the bin directory

UserMigrUtil.cmd

UserMigrUtil.cmd
Used to delete the underscore users when you were migrating from Planning 3.5 or 4x

HspUnlockApp.cmd

HspUnlockApp.cmd
Unfortunately most of you know this utility Planning apps can become locked (g g (gasp) ) This utility clears the HSP_Lock table Must be run from the Planning server

HspUnlockApp.cmd[f:passwordFile] servername username appname

FormDefUtil.cmd

FormDefUtil.cmd
Move data forms between Planning applications E Export or import form definitions t and t i tf d fi iti to d from an XML file -all allows you to import / export all forms formdefutil [f:passwordFile]import|exportfil ename|formname|-all server name user name application

FormDefUtil.cmd
Import a form definition
FormDefUtil.cmd import c:\Hyperion\products\Planning\bin\ form1.xml localhost admin entbud

Export a form definition

FormDefUtil.cmd export Form1 localhost admin entbud

Check out results in FormDefUtil.log

CubeRefresh.cmd

CubeRefresh.cmd
Refresh the Planning application via command line
P shing web client changes to Essbase database Pushing eb

CubeRefresh cmd [ f:passwordFile] CubeRefresh.cmd [-f:passwordFile] /A:application_name /U:user_name [/ |/ ] /D [/C|/R] / [/F[S|V]][/RMIPORT:rmi_port] [/L] [/DEBUG] CubeRefresh.cmd f:passwordFile /A:entbud /U:cbarkley /R /D /FS

CubeRefresh.cmd
/C - C t the d t b Creates th database outline tli /R Refreshes the database outline /D Specify the database during create or refresh /F Refreshes all security filters /FS Generate shared member security filters /FV Validate security filters but dont save don t /FSV Validate the shared member security filters /RMIPORT Specify an RMI port number if is different than default /-L Default ti (connecting t an app server locally or remote) / L D f lt option ( ti to l ll t ) /L Create or refresh without connecting to the application server /DEBUG Specify detailed error messages

CubeRefresh.cmd
Make sure the application is not locked Must be run on the Planning server g Take same cautions as when refreshing the application through the web client

DeleteSharedDescendants.cmd

DeleteSharedDescendants.cmd
Delete shared members that are descendants of a given member DeleteSharedDescendants [f:passwordFile] servername username application member name DeleteSharedDescendants f:passwordFile epm111server cbarkley entbud Southwest Region

DeleteSharedDescendants.cmd
You might see java.rmi or port already in use errors but they do not affect the functionality of the utility Make sure the Manage Database task is not open To view results, check out the following logs in the bin directory
DeleteSharedDescendants log (status) DeleteSharedDescendants.log DeleteSharedDescendantsExceptions.log (errors)

MemberFormulaSync.cmd

MemberFormulaSync.cmd
Syncs the formulas in the Planning application with Essbase MemberFormulaSync /A:appname

OutlineLoad.cmd

Outline Load Utility

Used to load metadata or data for Account, Period, Year, Scenario, Version, Currency, Entity, user-defined dimensions, attributes, UDAs and exchange rates Steps
1. 2. 3. 4. Set the DIRECT_DATA_LOAD AND DATA_LOAD_FILE_PATH DATA LOAD FILE PATH system variables if l di d t t i bl loading data Create the load file for each dimension and/or data set to load Test the load files Run the utility

SortMember.cmd

SortMember.cmd
Sort dimension members after loading to Planning SortMember [-f:passwordFile] servername username application member children|descendants ascend|descend

TaskListDefUtil.cmd

TaskListDefUtil.cmd
Export or import task list definitions to or from an XML file U d t move t k lists b t Used to task li t between applications li ti TaskListDefUtil [-f:passwordFile] import|exportFILE_NAME|TASK_LIST_NAM E|-all SERVER_NAME USER_NAME E| all SERVER NAME USER NAME APPLICATION

CalcMgrCmdLineLauncher.cmd

CalcMgrCmdLineLauncher.cmd
L Launch b i h business rules or rules sets created with th l l t t d ith the Calculation Manager CalcMgrCmdLineLauncher.cmd [ f:passwordFile] CalcMgrCmdLineLauncher cmd [-f:passwordFile] /A:appname /U:username /D:database [/R:business rule name | /S:business ruleset name] /F l t ] /F:runtime prompts fil ti t file [/validate] CalcMgrCmdLineLauncher.cmd -f:passwordFile g p /A:entbud /U:cbarkley /D:plan1 /R:MarketAgg /F:RTPValues.xml O space between each parameter One b t h t

CalcMgrCmdLineLauncher.cmd
Can run for a business rule or ruleset but not both / lid t checks th command syntax f th /validate h k the d t for the utility
Not the business rule or ruleset syntax Errors are displayed on console or written to Calc Manager log file g g

Runtime prompts file is only required when business rule or rule set contains run time prompts

Run Times Prompt File

Must create a file containing the runtime prompt values T Two ways
Specify the name of the runtime prompt values file that you generated on the RunTimesPrompt page Create runtime prompt ASCII file
On separate lines, lists each runtime prompt and its value Separate name and value with :: MarketRTP:: East Save the file in the Planning bin directory or specify full path when running the utility

Making Your Life Easier with the Planning Utilities

LESSONS LEARNED FROM MONSANTO

System 9 Utilities Lessons Learned

Shared Services Utilities
CSSImport.bat / CSSExport.bat p p
Great tool to create application security from a file and to migrate security through our environments. Include the source environments native object SIDs when importing in target environments. Keeping SIDs identical in all environments simplifies application migration if you decide to do a schema copy to move a planning application. Modify the export.properties file to use filters to select specific objects to export. This will cut down on editing of the export.csv file. export.user.filter=none@Native Directory export.group.filter=PLAN_OT*@Native Directory export.provisioning.apps=(Dev Planning Applications=PLAN_OT)

Planning Utilities g
ImportSecurity.cmd / ExportSecurity.cmd
Used to create security on dimension members from a text file. The application owner account must be used with this utility in 9.3.1 For a full security refresh use the SL_CLEARALL switch to remove any security then re-apply the security importsecurity.cmd "appname,appOwnerAcct,password,,,SL_CLEARALL

Before adding security the groups must be defined in SS

ProvisionUsers.cmd
We use it to clean up dead accounts. When a user leaves the company his account information can be orphaned in the Planning tables. When this utility is run any user information not found in Shared Services is removed. I di id l applications can b t d Individual li ti be targeted. t d provisionusers.cmd /ADMIN:%user% /PASS:%password% /A:%appname%

62

Utilities Lessons Learned Continued FormDefUtil.cmd

Used to export/import form definitions. Good for migrating forms. For existing forms you must answer positively that you want to overwrite them. We created a low tech solution to this problem by creating a file with a bunch of ys we pipe into the utility. ImportForms.bat
set /p user=Username? set /p password=Password? set /p appname=Appname? call FormDefUtil.cmd import -all servername %user% %password% %appname% >> formimport.log < answerY.txt timeout /t 10

answerY.txt answerY txt

y y y .

Smart View Connection Creator Macro

Smart View Setup Tools

Select Connection(s) Production Test Development

Click Create button macro will configure database connections for you

64

64

Thanks for your time time.

Keith Amann Monsanto