Automating Hyperion Planning Tasks

www.in2Hyperion.com www.Rolta.com
Automating Hyperion
Planning Tasks
Tuesday, June 25, 2013
Grand Ballroom E, 2:00-3:00
M. Kyle Goodfriend
Rolta Solutions | In2Hyperion

l More time with your family?
l More time to hang with friends?
l Less Stress?
l More opportunity for success?
l Higher customer confidence?
l How about a Best Buy gift card?
Appealing?

l Be interactive, interrupt me! (Really!)
l Tweet and share your thoughts #In2Hyperion or
#Kscope
l It is OK to text your notes
l Stretch – stand up if you get tired!
l None of us know everything there is to know –
please respect other perspectives
Rules For Today

l Share our collective knowledge
l Summarize and review utilities available
l Discuss scripting options
l Highlight Best Practices Guiding Principles
Session Objectives

l Business focus
l Show possibilities
l Technology focus
l Implementation ideas
l Implementation strategies
Something For Everybody

l Career
● Finance
● Accounting
● Financial Reporting
● Education
● University Adjunct Faculty
● Management
● Financial Systems
Speaker Background
● Technical
● Hyperion
● SQL
● .NET/VB
● Corporate
● TheLimited
● Bank One /
JPMorgan Chase
● Rolta Solutions

l Industry Experience
● TV/Entertainment
● Financial
● Retail
● Technology/Software Development
● Travel/Air
● Civil Engineering
Speaker Background

l In2Hyperion
● Free Tools
● Creative Ideas
● Knowledge Sharing
l Published
● Wall Street Journal
● OAUG Insight
l Certification
● Hyperion / Microsoft
Speaker Background

l Automate production tasks
l Notify administrators of errors
l Communicate status to users
l Sync environments
l Backup data/metadata
Automation Ideas

l Fewer Mundane Tasks / More Time To Add
Value – Increased Productivity
l Decrease Human Error
l Improve Customer Satisfaction
l Improve System Stability
l Improve Job Satisfaction / Career
Advancement
Staff Benefits of Automation

l Hyperion Planning Application Areas of
Importance
1. EPMA batch utility
2. Planning command line utilities
3. Essbase scripting
4. Shared Services
Automation Area Summary

l Parameter Driven
l Strong Error Trapping
l Logging
l Notification
● User
● Administrator
l Consistency
l Environment Independent
Guiding Principles

l Windows
● VB Script
● Perl
● DOS
● PowerShell
● Java
l Unix
● Korn Shell
● Perl
● Java
Scripting Options

EPMA Batch Utility
Hierarchy and metadata management

EPMA Batch Utility Possibilities
● Execute
● Import Hierarchies
● Dimension
Synchronization
(Shared/Local libraries)
● Deploy applications
● Redeploy applications
● Validation
● Copy Apps/Dims
● Create/Delete/Update
● Applications
● Dimensions
● Members
● Shared
● New
● Properties
● Rename
● Manage Dimension
Associations

EPMA Batch Utility Script Layout
option StopOnError = true; //StopOnError
option EchoComments = true; //EchoComments
option LogCommands = true; //LogCommands
set bpmaserverurl=http://localhost/hyperion-bpma-server;
set workspaceurl=http://ut03317:19000/workspace;
Setup variables …
Commands …
Exit routine…

Layout of all commands
Command
Parameters ()
Values ()
;
Example
//Import ADS Hierarchy File
Execute Import
Parameters(importtype, profilename, filename, waitforcompletion)
Values('flatfile', 'Post', 'E:DATAhier_Post.ADS', 'true');
EPMA Batch Utility Command Layout

Execute ReDeploy
Parameters(ApplicationName, InstanceName, datasourceName,
ApplicationServer, HubProject, ClearAll, CheckIntegrity,
waitforcompletion, purgeTransactions,
deployOption,escapeValidateRules, RefreshOutline,
CreateSecurityFilters, CreateOutline, SharedMembersSecurityFilters,
ValidateSecurityFilterLimit)
Values('FinPln’, 'Default’, ’plan1’, 'Default’, 'Planning', 'false’, 'false’,
'true’, 'false’,'AppView’, 'true’, 'true’, 'true’, 'false’, 'true’, 'true');
EPMA Batch Utility Redeploy Application

// Exclude member 60780000 from application
Exclude Member
Properties(ApplicationName, DimensionName, ParentName,
MemberName)
Values('FinPln’, 'Account’, '60010000', '60780000');
// Make Member 10010000 NOT Valid For Plan2
Update Member
Properties(ApplicationName, DimensionName, ParentName,
MemberName, MemberValidForPlan2)
Values('FinPln’, 'Account’, '10000000', '10010000', 'False');
EPMA Batch Utility Member Management

// Delete member 10000 from application
Delete Member
Properties(ApplicationName, DimensionName , ParentName ,
MemberName , RemoveChildren)
Values('#Shared’, 'Department’, 'All_Departments' ,'10000’, 'true');
EPMA Batch Utility Member Management

var DataSource = 'PlanApp3';
var AppName = ’FinPlan';
Execute ReDeploy
Parameters(ApplicationName, InstanceName, datasourceName, ApplicationServer,
HubProject, ClearAll, CheckIntegrity, waitforcompletion, purgeTransactions,
deployOption,escapeValidateRules, RefreshOutline, CreateSecurityFilters,
CreateOutline, SharedMembersSecurityFilters, ValidateSecurityFilterLimit)
Values(’$AppName’,'Default’,'$DataSource','Default','Planning','false','
false','true','false','AppView','true','true','true','false','true','true');
EPMA Batch Utility Using Variables

l Location
● EPM_ORACLE_INSTANCEproductsFoundationBPMAEPMABatchClient
l Batch Client
● epma-batch-client.bat
l Command Line Options
● -C [Specifies the name of the script file to execute]
● -R [Specifies the name of the file to write the results to on your machine]
● -L [Specifies if commands are logged. The default value is 0]
● -S [Stops execution of the script if a command fails]
● -U [Specifies the user name]
● -P [Specifies the password]
EPMA Batch Utility Batch Client

set today=%date:~-4%_%date:~4,2%_%date:~7,2%
call pathepma-batch-client.bat
-C"E:/DATA/hier_StaffPln.txt"
-R"E:/DATA/Logs/hier_StaffPln_err_%today%.txt"
exit %errorlevel%
*Actual scripts should not be on multiple lines
EPMA Batch Utility Batch Client

EPMA Batch Utility Logs

Planning Utilities
Hyperion Planning Tasks

l Export/Import Security
l Export/Import Forms
l Execute business rules and rulesets
l Create encrypted password files
l Export/Import Tasks
l HspUnlockApp
l Classic Planning Management
● Hierarchy Management
● Sort Members
● Import Metadata
● Migrate Security
● Cube Refresh
Planning Batch Utilities

Planning Utilities Import Security Load File
l All Planning specific security can be loaded
● Dimensional security
● Web form security
● Business rule security
● Task list security
l Required
● Named SecFile.txt
● Located in the same directory as the batch utility

l Formatted in a 5 column delimited text file
● User/group
● Artifact name
● Access permissions
● Access flag
● Artifact type (required for web forms, rules and task
lists)

l Artifact
● Dimensional member
● Folder or artifact for non dimensional security
l Access permissions
● NONE
● READWRITE
● READ

l Access flag
● @CHILDREN
● @ICHILDREN
● @DESCENDANTS
● @IDESCENDANTS
● MEMBER
*Identifying a level 0 member with anything other than MEMBER
produces mixed results

l Artifact type
● SL_FORM - for data forms
● SL_COMPOSITE - for composite data forms
● SL_TASKLIST - for task lists
● SL_CALCRULE - for Calculation Manager business
rules

User1,Account1,READ,@CHILDREN
Group2,DataForm08,READWRITE,MEMBER,SL_FORM
User3,TaskList09,READWRITE,MEMBER,SL_TASKLIST
NorthAmericaGroup,Sales,READWRITE,@IDESCENDANTS,SL_FORMFOLDER

Planning Utilities Import Security Batch Client
l The ImportSecurity utility is located in the
Planning directory on the Planning server
l Parameters
● Required
● Application name
● User executing the process
● Optional
● RUN_SILENT [default is 0, meaning no progress messages
displayed]
● SL_CLEARALL [clears all security prior to importing]
● -f:passwordFile

Planning Utilities Import Security Batch Client
l Example using default delimiter
ImportSecurity “WrkForce,admin”
l Example using default delimiter and password
file
ImportSecurity -f:EncryptedPassword.txt “WrkForce,admin”

Planning Utilities Export Security Batch Client
l Located in the Planning directory on the
Planning server
l ExportSecurity
l Parameters
● -f:encrypted password file
● /A=application
● /U=username
● /TO_FILE=”path”

Planning Utilities Export Security Sample
DATE=`date '+_%m-%d-%y_%H.%M.%S'`
ExportSecurity.sh -f:PassFile.txt
/A=FinPln, /U=admin,
/TO_FILE=
”c:backupdimSec_FinPln${DATE}.sec”

Planning Utilities Import/Export Forms
l Export and Import web forms
● Quick backup during development
● Easily make bulk changes

l Located in the Planning directory on the
Planning server
l All forms are exported to the Planning directory

l FormDefUtil parameters
● import|export
● filename|formname|-all
● Server name
● User name
● Password
● Application

Planning Utilities Import/Export Forms Sample
DATE=`date '+_%m-%d-%y_%H.%M.%S'`
FormDefUtil.sh -f:PassFile.txt export -all localhost
planadmin "FinPln”
zip
/usr/appl/fpf/home/ftpfpf/Outbound/exp_FinPln_F
orms${DATE}.zip *.xml

Planning Utilities Business Rules Batch Client
l CalcMgrCmdLineLauncher located in the
planning directory
l Parameters
● -f:passwordFile
● /A:appname
● /U:username
● /D:database
● /R:business rule name OR |/S:business ruleset
name
● /F:runtime prompts file

Planning Utilities Batch Client Example
CalcMgrCmdLineLauncher -f:c:passfile.txt
/A:WrkForce /U:admin /D:Wrkforce
/R:agg_all /F:agg_all_prompts.xml

Planning Utilities Business Rule Parameter File
l Every prompt must be identified
Prompt Name::Prompt Value

Planning Utilities Encrypt Passwords
l Allows for hidden passwords
l Promotes environment independence in scripts
l PasswordEncryption.bat(sh) is located in a
number of areas depending on the components
installed

Planning Utilities Encrypt Passwords
l Parameters
● passwordFile – the file to hold the encrypted
password
l Prompts
● Password to encrypt

Life Cycle Management
Repository Management

Life Cycle Management Overview
l Migration between environments
l Backup & restore
● Hierarchies (Shared/Local libraries)
● Planning application settings and overrides
● Shared Services security
● Essbase objects

Life Cycle Management Parameter XML File
l Creating XML
● Can be created manually
● Is created when an export is performed from Shared
Services
l Password will be added when the batch client is
executed the first time

Life Cycle Management Parameter XML File

Life Cycle Management Batch Client
l Located in
MIDDLEWARE_HOME/user_projects/epmsystem1/bin
l Parameters
● Xml file definition
● [-estimate]: Estimates the Number of Artifacts in a
Migration
● [-b]: Specifies the Base Path for the exports
● [-ls]: Lists EPM System Contents

Life Cycle Management Batch Client Example
l Utility Back_SS.xml –b c:backupsSS

Essbase
Data Management

l MaxL
l EssCmd (precursor to MaxL)
l API (C, VB, Java)
Essbase

MaxL
Hyperion Essbase Scripting

MaxL Possibilities
● Create/Delete/Edit
● Apps/DBs
● Calculations
● Security
● Location Aliases
● Partitions
● …
● Execute
● Calculations
● Aggregations
● Display
● Export
● Data
● Dimensions to XML
● Security File
● Import
● Data
● Dimensions

MaxL Railroad Diagrams

l Set general variables
l Set logging
l Set script level variables
l Login
l Execute processes
l Run exit routine
MaxL Script Layout

l Spooling
● spool stdout on to "$(logPath)$(1)$(2).txt";
● spool stderr on to "$(errorPath)$(1)$(2).txt”;
MaxL Script Concepts (Logging)

l Compartmentalize reusable scripts
● Login
● Set global variables
● Processes used in many scripts
l Example Login (login.msh)
login $key ABC $key XYZ on "$(svrName)";
iferror 'errHandler';
l Include the login script
msh login.msh;
MaxL Script Concepts (Includes)

l Error handling
iferror 'errHandler'; (call after every command)
…
define label 'errHandler'; (define label)
spool off;
logout;
exit 1;
MaxL Script Concepts (Error Handling)

l Commonly used strings set in one place
set logPath = "/usr/appl/fpf/home/ftpfpf/Logs/";
set appName = "StaffPln";
set dbName = "StaffPln";
l Reference variables
spool stdout on to "$(logPath)errors.txt”;
execute calculation
"$(appName)".”$(dbName)"."pAgg";
MaxL Script Concepts (Variables)

l Use command line parameters when applicable
set procName = $(1);
set procDate = $(2);
l Reference command line parameters
spool stdout on to “$(1)$(2).txt”;
l Example
● essmsh script.msh processXYZ 2013_06_20
MaxL Script Concepts (Parameters)
Param Param
space

MaxL Import Data
import database $(appName).$(dbName) data
from local text data_file "$(dataPath)$(dataFile)" using
server rules_file "$(ruleFile)"
on error write to
"$(rejectPath)$(procName)_$(dataFile)$(procDate).err";

execute calculation
"$(appName1)"."$(dbName1)"."GLActCvn";
MaxL Execute Calculation

l Execution
● Essmsh
● startMaxl (sets environment variables)
l Parameters
● Maxl script filename
● -u [username] (not required when using filename)
● -p [password] (not required when using filename)
● -s [message level] (not required when using
filename)
MaxL Batch Client Parameters

Essmsh c:scriptsaggscript.msh appname dbname
Startmaxl c:scriptsaggscript.msh appname dbname
MaxL Batch Client Example

l MaxL is a text file and can be written in any text editor
l Help getting started
● EAS MaxL editor (File/New/Scripts/MaxL)
● Auto complete
● Quick to build templates
● Verification
● Editors with user built addins
● Notepad++
● UltraEdit
Maxl Editors

l Email
● In2Hyperion@gmail.com
● Kyle.Goodfriend@Rolta.com
l In2Hyperion
● Sign up for email updates at www.In2Hyperion.com
● Follow us via Twitter (@In2Hyperion)
● Like us on Facebook
● Join the In2Hyperion LinkedIn group
● More than 2,000 people follow In2Hyperion through social
media
● More than 3,000 people visit In2hyperion daily
Stay In Touch

Other Collateral
l Collaborate 2011 – Business Presentation
● Download Presentation
l Kscope12 – Unlimited Custom Spreads
● Download Presentation
l OAUG Insight - Summer 2012 issue
● Download Article at ODTUG.com
● Request a copy by emailing me at
in2hyperion@gmail.com

Questions?

Automating Hyperion Planning Tasks

Recommended

Recommended

More Related Content

Similar to Automating Hyperion Planning Tasks

Similar to Automating Hyperion Planning Tasks (20)

More from Kyle Goodfriend

More from Kyle Goodfriend (20)

Recently uploaded

Recently uploaded (20)

Automating Hyperion Planning Tasks