hyperion lcm utlity

Hyperion Artifact Life Cycle Management

Agenda

Overview

Demo

Tips & Tricks

Takeaways

Queries

Overview – BI+ ALCM

Moving Artifact (Such as objects, folder, etc.,) from one Domain to another.

Objects from all the BI+ 9.3 Modules are supported.

ALCM is Platform Independent.i.e. Objects can be moved from one platform (e.g. Windows, Linux, etc) to another platform (e.g. Windows, Linux, etc)

ALCM is a Command Line Tool.

Features Promotions defined in XML based package files.

Promotes one or more Hyperion applications or application artifacts from one environment to another depending on the definitions in the package file.

Ensures secure access to the utility – Only users with the LCM Manager role can perform

promotions.

Supports promotion of internationalized data

Logs errors to facilitate troubleshooting

Prerequisites Roles - While configuring ALCM, Make sure the specific user

(“admin” or other) user has the following provision as mandatory.

– LCM Manager (Newly added in 9.3) – Needed to run the utility.– BI+ Administrator role.

Source and target applications must be registered with an instance of Oracle's Hyperion® Shared Services.

Shared Services source and target applications must be running during the promotion process.

Prerequisites …Contd

For application-to-application promotions, the source and target applications must be registered with the same Shared Services instance.

If promoting directly from a source to target, both source and target environments should be accessible to the utility on the network.

If promoting using an intermediary file system, both source and target file systems should be accessible to the utility on the network.

Both source and target must use the same user directory.

Packages

The packages from the BI+ Modules that can be moved from one domain to another are

– Repository Objects (Such as BQY, SQR files, etc)– Scheduled Objects (Such as BQY Jobs & its outputs)– Physical Resources (Such as Shared Printers, Output

Directory)– Security Options (File > Preferences in Workspace)– Product Preferences (Favorites, Personal Pages &

Subscriptions)

Direct Move & Indirect Move

Direct Move– Both environment use same Shared Services. i.e. Both

Test and Prod Server are connected to a single Shared Services can use Direct move to move the objects from one server to another.

Indirect Move or Intermediate Storage– Both environment use different or its own Shared Services.

i.e. Both Test and Prod Server are connected to their Shared Services can use Indirect move to move the objects from one server to another.

Demonstration

Running ALCM Utility

ALCM Execution Path

The Location to find the ALCM utility execution file to run on command line resides

<Hyperion_home>\BIPlus\bin\LCMUtility.bat

Packages File Location

Hyperion provides a sample package file to model the package file to be used during promotions.

A sample file to model the package file to be used during promotions is available in

<Hyperion_Home>\common\utilities\LCM\9.3.1\doc\……Or

<LCM_Home>\doc\…

– Sample_ExportPackage.xml – Package file to be used on the source machine to export the content.

– Sample_ImportPackage.xml – Package file to be used on the target machine to import the exported content from the source machine.

Note: Where <LCM_Home> is <Install_Home>/common/utilities/LCM/9.3.1/

XML Schema Outline

Overview of the Package File Credentials - Credentials to use for the operation

User - User account. The user must have the LCM Manager role in Shared Services.

Password - Plain-text password of the user. This password is encrypted after the first run.

Connections - Connection to use for the operation– Three types of connections

HSS File System and Application

Tasks - The tasks to be completed during the operation.– The number of tasks defined in package files depends on the source and

target and the artifact being promoted. If only one source and target are involved, you need to define only one task.

Note: First, take the backup or the copy of the Sample_ExportPackage.xml

....Contd

Task For multiple sources and targets, you must define at least one task per

each source-target combination. seqID - Sequence in which tasks are executed.

Source - Source for this operation. You must define one source and one target per task.

Connection - Connection to use for this task. The connection name must be defined within the package file.

Option - Processing instructions for this operation. Options are product-specific.

….Contd Source

– Artifact - Filter to be used for this operation. This element takes these attributes:

recursive parentPath typepatternstartDateendDate

Note: The parentPath and pattern attributes are required. All other attributes are optional.

….Contd

Target – Target for this operation– Define one Target per task– Option - Processing instructions for this operation. Options are product-

specific.

Promotion Property File

ALCM utility uses the migration.properties file to set the global parameters for promotions.

The properties that can be set include user-friendly path names, grouping size, log file name and location, and promotion report folder path.

To update the property file:– At the command line, navigate to <LCM_HOME>/conf directory, for

example, C:\Hyperion\common\utilities\LCM\9.3.1\conf (Windows) or /app/Hyperion/common/utilities/LCM/9.3.1/conf (UNIX).

– Update migration.properties as needed.– Save and close migration.properties.

Promotion Property File Values

grouping.size - Maximum size (in MBs) of artifacts belonging to a group that will be promoted

grouping.size_unknown_artifact_count - Number of artifacts of unknown size (artifacts that cannot be grouped by dependency in the listing) that are to be included in a group

grouping.group_by_type - Indicates whether artifacts are to be grouped by artifact type

threadpool.size - Size of the thread pool available to promotion processes

log.directory - Location of the directory for promotion log files

log.config - Configuration file to use for generating promotion log files parameters to be used for logging errors are identified using the log.properties file in the migration.log directory. Edit this file to specify properties such as error logging level and date pattern.

….Contd report.enabled – Indicates whether to generate a promotion report

report.folder_path – Location of the directory where the promotion reports (which the utility creates for each package file) are to be stored

filesystem.friendlypath - Indicates whether the files for an artifact are to be stored with extended names (a combination of artifact id and name).

If the value is set to true (default value) or if this property is missing, the path for the files corresponds to the artifact path in the listing.xml file. If the value is set to false, the pathAlias value in the listing.xml file is used.

Sample Migrations.properties File grouping.size=10 grouping.size_unknown_artifact_count=1 grouping.group_by_type=Y threadpool.size=1 log.directory=../logs log.config=../conf/log.xml report.enabled=Y report.folder_path=../reports fileSystem.friendlyNames=true

Reporting and Analysis Artifact Types

Artifact Artifact Types Repository folders (and their contents) folder

RepositoryContent

Web Analysis documents (reports); includes dependent database Connections

application/hyperion-analyzer-report

Web Analysis presentations; includes dependent documents and folders

application/hyperion-analyzer-presentation

Web Analysis third-party content (documents, links, URLs, and so on

application/hyperion-analyzer-shortcut

application/hyperion-analyzer-link

Financial Reporting reports application/hyperion-reports-report

application/hyperion-reports-snapshot_report

Financial Reporting books (dynamic and

snapshot)

application/hyperion-reports-book

application/hyperion-reports-snapshot_book

Financial Reporting batches application/hyperion-reports-batch

….Contd

Artifact Artifact TypesFinancial Reporting text objects application/hyperion-reports-text

Financial Reporting grid objects application/hyperion-reports-grid

Financial Reporting image objects application/hyperion-reports-image

Financial Reporting row and column templates

application/hyperion-reports-row_column

Financial Reporting database connections application/hyperion-reports-data_source

Interactive Reporting documents application/x-brioquery

SQR Production Reporting jobs application/x-SQR

Tips & Tricks

Promotions

Tips & Tricks

Local Service Configurator (LSC) Entries– LSC Data Source definitions needs to be created manually on

target system (IR).

Backup Target before import– Useful to restore before image.

Password– If you do not intend to store password in package (xml) file.

Delete file after the run. Clean up user and/or password encrypted after run value

from the package file.

Tips & Tricks Move Select folders as opposed to “All”

– Can include multiple folders.– Filter by type available (FR, IR, etc)– Consider excluding Job Outputs (test to prod for e.g)

Check Target content– For large Repository move check with selected sample data

Scheduling – Can be scheduled externally (e.g cron) using cmd line.

Troubleshooting– Log file– File system folders and files

Info (listing.xml, sourceinfo.xml) Resource (objects stored here alongside metadata xml file)

Tips & Tricks

Promotion Pre-requisites– Refer the documentation

E.g Financial Reporting– Thread Pool Size = 1 (filemigration.properties)– Import Order

1. All report objects (grid, chart, image, text)

2. Reports

3. Books and batches

Conclusion

Feature name is “BI+ Artifact Life Cycle Management”– Available in 9.3, not supported for prior release.

Move Contents between domains– Test to Prod or vice versa.– Indirect benefit – backup and restore.– Sample Package file (xml) provided, modify as needed.

Command Line Tool– Use for running batch jobs.

User Interface

AQ&Q U E S T I O N SQ U E S T I O N S

A N S W E R SA N S W E R S