RA - hyperionFM 1 0 0 Hyperion 1.0 AGENT GUIDE en

Rapid Automation
ONE Automation Platform
Hyperion Agent Guide
Version: 1.0
Publication Date: 2016-02
Automic Software GmbH
iiCopyright
Copyright
Automic and the Automic logo are trademarks owned by Automic Software GmbH (Automic). All
such trademarks can be used by permission only and are subject to the written license terms. This
software/computer program is proprietary and confidential to Automic Software and is only available
for access and use under approved written license terms.
This software/computer program is further protected by copyright laws, international treaties and
other domestic and international laws and any unauthorized access or use gives rise to civil and
criminal penalties. Unauthorized copying or other reproduction of any form (in whole or in part),
disassembly, decompilation, reverse engineering, modification, and development of any derivative
works are all strictly prohibited, and any party or person engaging in such will be prosecuted by
Automic.
No liability is accepted for any changes, mistakes, printing or production errors. Reproduction in
whole or in part without permission is prohibited.
Copyright Automic Software GmbH. All rights reserved.
Rapid Automation Hyperion Agent Guide iii
Contents
1 Introduction
1.1 Hyperion FM Integration
1.2 About Rapid Automation Agents
1.3 Using WebHelp at docs.automic.com
2 Installation and Configuration
2.1 General Set-up Information
2.2 Installing the Hyperion FM Agent in an Existing Automation Engine System
2.3 Configuring System Objects
10
2.4 Specifying Automation Engine/Agent Timeout Seconds
12
3 Jobs
13
3.1 Creating Jobs
13
3.2 Job Types
14
3.2.1 Creating an Allocate Job
15
3.2.2 Creating a Calculate Job
17
3.2.3 Creating a Calculate Contribution Job
19
3.2.4 Creating a Clear Data Slice Job
21
3.2.5 Creating a Close Period Job
23
3.2.6 Creating a Consolidate Job
25
3.2.7 Creating a Copy Data Job
27
3.2.8 Creating an Extract Data ToDatabase Job
30
3.2.9 Creating an Extract Data to Flat File Job
34
3.2.10 Creating an Extract Journals Job
38
3.2.11 Creating an Extract Member Lists Job
42
3.2.12 Creating an Extract Metadata Job
44
3.2.13 Creating an Extract Rules Job
48
3.2.14 Creating an Extract Security Job
50
3.2.15 Creating a Load Data Job
53
3.2.16 Creating a Load Journals Job
57
3.2.17 Creating a Load Member Lists Job
59
3.2.18 Creating a Load Metadata Job
61
3.2.19 Creating a Load Rules Job
65
3.2.20 Creating a Load Security Job
67
iv
Contents
3.2.21 Creating a Translate Job
70
3.3 Creating Workflows with Hyperion FM Jobs
72
3.4 Managing Output and Execution Options with the RA Tab
73
3.5 Hyperion FM Job Attributes
75
3.6 Setting Trace
86
Release Notes
Release Notes: Rapid Automation Hyperion FM Agentv1
89
89
Getting the Latest Information
89
V1.0.0
89
Supported Platforms
89
What's New
89
Rapid Automation Hyperion Agent Guide 1
1 Introduction
1.1 Hyperion FM Integration
This integration allows you to run several Hyperion Financial Management (Hyperion FM or HFM)
job types.
Oracle Hyperion Financial Management is a packaged solution for finance users that helps develop
standardized financial data management processes with its Web-based guided workflow user
interface. Its data preparation server can ease integrating and validating financial data from any of
your source systems.
Chapter 1 Introduction
1.2 About Rapid Automation Agents

You define agent-specific connection, agent, and job objects with unique panels.
After loading a Rapid Automation (RA) .jar file into the Automation Engine, you will be able to define
RA agent-specific connection, agent, and job objects with unique panels. The topics in this guide
describe how to use these RA panels, not how to define connection, agent, and job objects. For
information on creating these objects, see your Automation Engine documentation.
Using Object Variables in Fields

You can use object variables in the format &<variable name> in most fields on Rapid Automation
panels. The values of these object variables will be replaced at run time.
It is recommended that you terminate object variable names with an # character.
Overriding Settings on RA Agent-specific Tabs

You can override settings on the RA agent-specific tab for:
l
A single run of a Rapid Automation job you execute. To activate this option for a job, the
Request task parameters option must be checked on the RA tab of a job's definition. For
more information, see Managing Output and Execution Options with the RA Tab.
Rapid Automation jobs added as tasks in a workflow. For more information on editing
workflow tasks, see your Automation Engine documentation.
An instance of a task that is not yet active from the Activities window by right-clicking and
selecting Modify Task Parameters.
1.3 Using WebHelp at docs.automic.com

The format of the documentation at docs.automic.com requires a Web browser. There you will find
the most up to date version of this documentation. In addition you find the latest Automic software
components.
Automic documentation is written as a series of topics. Each topic begins with a heading followed
by a summary paragraph. The summary paragraph states the key concepts presented in the topic.
To get a quick overview of a chapter, read the summary paragraph for each topic and look at the
images and their captions.
Documentation at docs.automic.com contains the most up to date version of this documentation. It
is provided as in both .pdf and HTML5 formats.
The HTML5 documentation is displayed as individual HTML pages. You can:
l
l
l
Find documents in the table of contents.

Find documents with full-text search.
Print individual topics.
Contents
The Contents tab contains the contents of the documentation in a tree-view of the directory
structure. It includes all the individual books that can be opened and contain further books or
documents.
Click on a book to open or close it. A click on a document in the TOC displays its contents in the
browser window.
If you click on a hyperlink that is shown in a document, the new document displays in a browser
window. The TOC also shows the position where the open document is available.
Searching
You can search through the entire documentation using the search field in the top right-hand corner
of the WebHelp. Enter one or more search terms in the field and start the search either by clicking
the magnifying glass icon or using the Enter key. The search results are displayed in a separate
document.
l
l
l
l
l
Uppercase and lowercase letters are not distinguished (not case-sensitive).

You can use any combination of letters (a-z) and numbers (0-9).
You can search for several words. The following combinations can be used: AND relations
(separators: AND, +, &), OR relations (blank or | can be used as a separator) and negations
(^ character in front of the term, NOT will not work).
To combine search operators and expressions, use (). Example: term1 AND (term2 OR
term3)
Variant endings will be found (example: search for run and running, runner and runtime also
will be found)
Search results will be highlighted
Wildcards are not supported.
Chapter 1 Introduction
l
Punctuation marks that are used in the word (such as a dot, colon, semi colon, comma or
hyphen) have the effect that the searched term is split into two words.
Printing
It is possible to print individual pages from a book. Display the document you want to print and click
the Print button in the bar at the top.
2 Installation and Configuration

2.1 General Set-up Information
Do the following required steps.
1. Install the license.
2. Install the RA Core with Java version 1.7 or 1.8 on the machine where Oracle Hyperion FMis
installed.
3. Delete the content of the "lib" folder, the folder should remain empty
4. Set the environment variables EPM_ORACLE_HOME and EPM_ORACLE_INSTANCE if
they are not set.
Example for Windows:
SET EPM_ORACLE_HOME=C:\Oracle\Middleware\EPMSystem11R1
SET EPM_ORACLE_INSTANCE=C:\Oracle\Middleware\user_
projects\epmsystem1
5. Make sure the matching agent object is created in client 0.
6. Start the agent with the following command line:
Windows:
java -Xmx512M -cp ucxjcitx.jar;uc4.jar;shared/uc4-ra.jar;groovyall.jar;shared/bsf-2.4.0.jar;shared/commons-codec1.9.jar;shared/commons-logging1.2.jar;C:\Oracle\Middleware\EPMSystem11R1\common\jlib\11.1.2.0\e
pm_hfm_
web.jar;C:\Oracle\Middleware\EPMSystem11R1\common\jlib\11.1.2.0\e
pm_
j2se.jar;C:\Oracle\Middleware\EPMSystem11R1\common\jlib\11.1.2.0\
epm_thrift.jar com.uc4.ex.cit.UCXJCITX
Unix:
java -cp ucxjcitx.jar:uc4.jar:shared/uc4-ra.jar:groovyall.jar:shared/bsf-2.4.0.jar:shared/commons-codec1.9.jar:shared/commons-logging1.2.jar:/u0/Oracle/Middleware/EPMSystem11R1/common/jlib/11.1.2.0/
epm_hfm_
web.jar:/u0/Oracle/Middleware/EPMSystem11R1/common/jlib/11.1.2.0/
epm_
j2se.jar:/u0/Oracle/Middleware/EPMSystem11R1/common/jlib/11.1.2.0
/epm_thrift.jar com.uc4.ex.cit.UCXJCITX
Chapter 2 Installation and Configuration
2.2 Installing the Hyperion FM Agent in an

Existing Automation Engine System
This topic describes how to install the Hyperion FM agent in an existing Automation Engine system.
Java Requirements
On the host and each machine where an Automation Engine user interface is installed, check the
current version of your system's Java Virtual Machine (JVM) using the following command:
java -version
For platform-specific Java requirements on your Automation Engine machine, see your Automation
Engine release notes.
You can get the necessary files to install Java from
http://www.oracle.com/technetwork/java/index.html.
Supplied Files
The files that belong to the RA agent are stored in the Automation Engine's
IMAGE:AGENTS\RAPIDAUTOMATION directory. You can get updated files for another
Automation Engine release by downloading the image for that release from the Automic Download
Center.
File name
Description
ucxjcitx.jar Agent for Rapid Automation

ucxjcitx.ini Configuration file
*.jar
Libraries
uc.msl
Message library
setup.exe
The Windows installation executable for the RA agent core
Setting Trace Before Running the Installation or Upgrade of the

Agent
Before installing or upgrading the agent, it is a good idea to turn Rapid Automation trace on by
adding ra=99 in the ucxjcitx.ini file as shown below.
[TRACE]
file=..\temp\RA_TRACE_##.TXT
max_trace_kb=8000
tcp/ip=0
ra=99
trccount=10
This will give more troubleshooting information if something goes wrong during the install. After a
successful agent install, you can set ra=0, and restart the agent to turn Rapid Automation trace off.
Setting Up a New or Upgraded Agent

To set-up an RA agent, you need:
l
l
l
l
l
A license loaded in the database for the agent.

To put the agent files on the host machine.
To edit the ucxjcitx.ini file.
To execute the setup.exe file.
To load the RAsolution.
License File Requirement

License files for RA agents need to have a EX.RA.<AGENT TYPE> line in them and be loaded into
the database. For more information on loading keyfiles, see your Automation Engine
documentation.
Putting Agent Files on the Host Machine

On the host machine of the agent, create a directory for the RA agent and copy the supplied files
listed above to it using the instructions below for your operating system.
We highly recommend installing the agent in its own directory.
The Hyperion FM agent must be installed on Hyperion Financial Management system.
You can update the agent core by getting updated files for an Automation Engine release by
downloading the image for that release from the Automic Download Center and putting the agent
files in place following these instructions.
For UNIX
1. Create a directory. For example, AE/agent/rapidautomation.
2. Unpack the file using the following commands:
gunzip ucxjcitx.tar.gz
tar -xvf ucxjcitx.tar
For Windows
1. Create a directory. For example, C:\AE\agent\rapidautomation.
2. Execute the setup.exe file.
Creating the cache Directory

The RA Solution to be used by the agent will be stored in the directory named cache. Create this
directory in the installation directory.
Editing the ucxjcitx.ini File

Edit the required parameters in the ucxjcitx.ini file for the RA agent described in the table below.
Parameter Description
system
Automation Engine system name. This entry must be identical to the entry in the .ini
file of the Automation Engine server.
Parameter Description
name
Name of the agent. The agent name is limited to 32 of the following characters: "AZ", "0-9", "_", ".", "$", "@", "-" and "#".
Hyphens ("-") are only allowed in agent names. They must not be used in the names
of any other objects.
Although agent names are limited to 32 characters, you should keep them under
25 characters. The last seven characters are used for adding the suffix
'.NEW.nn' when a new agent is created from its template.
cache_
directory
Directory to which the agent should store the RA solutions. This will be set to cache
by default and does not need to be altered unless you want to change it.
cp
Address of the communication process in the Automation Engine system to which

the agent should connect itself. The format is:
<DNS name or TCP/IP address>:<port number>
ra
Used for additional trace.
For information on the additional parameters in the ucxjcitx.ini file, see your Automation Engine
documentation.
A sample ucxjcitx.ini file is shown below. The required parameters are shown in bold:
[GLOBAL]
name=RA01
system=AE
logcount=10
logging=../temp/RA_LOG_##.TXT
;LogMaxSize: 0...default, qualifiers k...Kilo, M...Mega, G...Giga
LogMaxSize = 0
language=E
helplib=uc.msl
[RA]
cache_directory=cache
ext_directory=external
shared_directory=shared
lib_directory=lib
[TCP/IP]
connect=20
cp=localhost:2217
[AUTHORIZATION]
KeyStore=
InitialPackage=
[VARIABLES]
uc_host_jcl_var=RA
uc_ex_path_bin=.
uc_ex_path_temp=..\temp\
uc_ex_path_jobreport=..\temp\

[TRACE]
;TraceMaxSize: 0...default, qualifiers k...Kilo, M...Mega, G...Giga
TraceMaxSize=0
tcp/ip=0
ra=0
trccount=10
[CP_LIST]
2218=PC01
Loading the RASolution

On the host machine, start the utility AE.DBLoad and select the RA Solution's .jar file. The utility
will then load it to the Automation Engine database. The .jar file can be loaded via the graphical
interface or the Java batch mode (ucybdbld.jar) of the utility AE DB Load. Loading with the AE DB
Load in batch mode (ucybdbld.exe) under Windows is not possible.
The RA agent can only connect to one RA Solution. If you intend to use several RA Solutions,
keep in mind that each solution requires its own RA agent.
You cannot load the same JAR file of an RA Solution to several systems at a time. Any attempt
to do so can cause the utility AE DB Load to abort.
10
2.3 Configuring System Objects

The following guide describes the specific configuration of an Automation Engine's system objects
that are required for the RA agent.
l
l
l
l
Log on to your Automation Engine's system client.

Create and configure a Hyperion FM connection object.
Create and configure a Hyperion FM agent object.
Start the agent.
Connection Object
The connection object determines...
l
Create a new Hyperion FM connection object (new object: CONN -> HYPERIONFM) and
open it.
Field
Description
User Name The Hyperion FM user
Password
The Hyperion FM password
Cluster
The Hyperion FM cluster
Store and close the object.
Agent Object
l
Create a new HYPERIONFM AGENT agent object (preferably in the HOST folder)
Note that the object name must comply with the agent name that is used in the INI file.
The traffic light symbol in the tab's lower bar is shown in green if the agent is active.
There is nothing to define on the Hyperion FMagent's HyperionFM tab.
Store and close the agent object.

Start the agent by using the following command:
java -jar <Path to the agent's BIN directory>/ucxjcitx.jar
You can also start the agent via the Service Manager. For further information, see your
Automation Engine documentation.
12
2.4 Specifying Automation Engine/Agent

Timeout Seconds
You can specify the timeout seconds between the Automation Engine v9/10/11 UserInterface and
Rapid Automation agents using the agentTimeout setting in the uc4config.xml file.
You can specify the timeout seconds between the Automation Engine v9/10/11 UserInterface and
Rapid Automation agents using the agentTimeout setting in the uc4config.xml file.
<paths>
<docu type="hh">../../docu</docu>


<logging count="10">../temp/UCDJ_LOG_##.TXT</logging>
<trace count="10" ra="9" tcp="10" xml="10">../temp/UCDJ_TRC_
##.TXT</trace>
<tcpip_keepalive>1</tcpip_keepalive>
<tcp_nodelay>1</tcp_nodelay>
<agentTimeout>300</agentTimeout>
<SendBufferSize>1048576</SendBufferSize>
<RecvBufferSize>1048576</RecvBufferSize>
</paths>
If no agentTimeout setting is specified, 100 seconds will be used.
When an agent times out, a pop-up error like the following will be returned.
A sample timeout error
3 Jobs
3.1 Creating Jobs
This document describes how you can create jobs and the peculiarities that must be considered.
Once you have installed and configured the RA agent for Hyperion FM, you can create the
corresponding job objects (new object: JOBS -> HYPERIONFM -><Action type>).
When you have created your jobs, you must enter the particular agent in the Attributes tab.
Verify that this agent is active and available. Otherwise, no data is available in the specific
HyperionFM object tabs.
The specific settings for the relevant action are available in the HyperionFM tab and are described
in the Job Types topics. The other tabs are all the same in each RA job. For further information, see
your Automation Engine documentation.
14
Chapter 3 Jobs
3.2 Job Types

The Hyperion FMagent includes the following Hyperion Financial Management job types:
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
Allocate
Calculate
Calculate Contribution
Clear Data Slice
Close Period
Consolidate
Copy Data
Extract Data to Database
Extract Data to Flat file
Extract Journals
Extract Member Lists
Extract Metadata
Extract Rules
Extract Security
Load Data
Load Journals
Load Member Lists
Load Metadata
Load Rules
Load Security
Translate
3.2.1 Creating an Allocate Job

This job type triggers the allocation action within Hyperion FM. The three main groups of data
allocation include allocating from one entity to many related entities, from one account to many
related accounts and from one period to a range of periods.
ALLOCATE Job
Field
Description
Login data
The Hyperion FM Connection Object.
Application The Hyperion FM application to log into.

POV
The point of view (POV) which contains at least Scenario, Year, Period, Entity and
Value.
Format: S#<SCENARIO>.Y#<YEAR>.P#<PERIOD>.E#<ENTITY>.V#<VALUE>
Job Status
The status of the job is "ENDED_OK - ended normally" if the Allocate action returns 0. Otherwise it
is "ENDED_NOT_OK".
Job Output
If the Allocate action returns 0, then "Execution of AllocationAction succeeded" appears in the
report. Otherwise, an error message is posted to the report.
In the report, you can also see the passed options, which are provided from the UserInterface.
16
Chapter 3 Jobs
Log messages from Hyperion Financial Management can only be correctly translated/displayed
in the job reports if they are either Latin-9 or UTF-16 encoded.
3.2.2 Creating a Calculate Job

This job type triggers the calculation action within Hyperion FM.
CALCULATE Job
Field
Description
Login data

POV
Value.
Force
Forces a calculation.
Job Status
The status of the Job is "ENDED_OK - ended normally" if the Calculate action returns 0. Otherwise
it is "ENDED_NOT_OK".
Job Output
If the Calculate action returns 0, then "Execution of CalculationAction succeeded" appears in the
report. Otherwise, an error message is posted to the report.
18
Chapter 3 Jobs
3.2.3 Creating a Calculate Contribution Job

This job type executes a calculate contribution action within Hyperion FM.
CALCULATE_CONTRIBUTION Job
Field
Description
Login data

POV
Value.
Force
Job Status
The status of the job is "ENDED_OK - ended normally" if the Calculate Contribution action returns
0. Otherwise it is "ENDED_NOT_OK".
Job Output
If the Calculate Contribution action returns 0, then "Execution of CalculationContributionAction
succeeded" appears in the report. Otherwise, an error message is posted to the report.
20
Chapter 3 Jobs
3.2.4 Creating a Clear Data Slice Job

This job type executes a clear data slice action within Hyperion FM.
CLEAR_DATA_SLICE Job
Field
Description
Login data
Application
The Hyperion FM application to log into.
POV
The point of view (POV) which contains at least Scenario, Year, Period,
Entity and Value.
Format:
S#<SCENARIO>.Y#<YEAR>.P#<PERIOD>.E#<ENTITY>.V#<VALUE>
Clear Entity
Currency Data
When checked, entity currency data is cleared.

Default:Unchecked
Clear Rates and

System Data
When checked, rates and system data are cleared.

Default:Unchecked
Enable Detailed
Logging
When checked, detailed logging is enabled.

Default:Unchecked
Job Status
The status of the job is "ENDED_OK - ended normally" if the clear data slice action throws no
exception. Otherwise it is "ENDED_NOT_OK".
Job Output
If clear data slice finished successfully then "Execution of clear data slice succeeded" appears in
the report. Otherwise an error message is posted to the report.
22
Chapter 3 Jobs
In the report you can also see the parameters passed along to the Hyperion FM API call which were
entered in the user interface.
The log of the clear data slice process is added in a new report tab. The file name is "Log" followed
by the RunID of the job.
The report type of the HFM log in the Automation Engine is "W1".
3.2.5 Creating a Close Period Job

This job type triggers the close period action within Hyperion FM. It closes the journal-period for a
specific scenario and year.
CLOSE_PERIOD Job
Field
Description
Login data

Scenario
The scenario for the close period. This is a required field.
Year
The year for the close period. This is a required field.
Period
The period for the close period. This is a required field.
Job Status
The status of the Job is "ENDED_OK - ended normally" if the no exception occurs during the call of
close-period action through the HFM-API, otherwise it returns "ENDED_NOT_OK" and shows the
error in report.
Job Output
If any period parameter is empty, an appropriate error-message is shown. Also if an exception
occurs during call of HFM-API, the error message is posted to the report.
The report also shows the parameters passed along to the Hyperion FM API call which have been
entered in the user interface.
If the job is successful, the message: "Status: Close of period succeeded" is shown at the end of
the report.
24
Chapter 3 Jobs
3.2.6 Creating a Consolidate Job

This job type triggers the consolidation action within Hyperion FM.
CONSOLIDATE Job
Field
Description
Login data

POV
Value.
Type
The consolidation type. Available options:

l
l
l
Impacted
All with data
All
Job Status
The status of the Job is "ENDED_OK - ended normally" if the consolidation executed successfully.
Otherwise it is "ENDED_NOT_OK".
Job Output
If consolidate action returns 0 then "Execution of ConsolidateAction succeeded" appears in the
report. Otherwise an error message is posted to the report.
In the report you can also see the parameters passed along to the Hyperion FM API call which were
entered in the UserInterface.
26
Chapter 3 Jobs
3.2.7 Creating a Copy Data Job

This job type triggers the copy data action within Hyperion FM.
COPY_DATA Job
Field
Description
Login data
Application
Source POV
The source point of view (POV), three dimensions can be defined: Scenario(S),
Year(Y), Period(P), with one entry per dimension.
For example: S#Actual.Y#2006.P#June
Copy
Members
POV
The copy members point of view (POV), two dimensions can be defined:
Account(A) and Entity(E), with more entries per dimension
Destination
POV
The destination point of view (POV), three dimensions can be defined: Scenario
(S), Year(Y), Period(P), with one entry per dimension
For example: A#NetProfit.E#Sales
For example: S#Actual.Y#2006.P#July
28
Chapter 3 Jobs
Field
Description
Mode
The mode. Allowed values:

l
l
l
View
The View. Allowed values:

l
l
Multiplier
Merge
Accumulate
Replace
Periodic
YTD
The multiplier.
If Hyperion FM cannot process the input, the job will fail and with an according
error message.
Entity
Currency
Rate
The entity currency data.
Rates and
System Data
The rates and system data.
Cell Text
The cell text.
Copy Derived
Data
The copy derived data.
Enable
Detailed
Logging
Whether to enable detailed logging.
Job Status
The status of the Job is "ENDED_OK - ended normally" if the no exception occurs during the call of
copy data action through the HFM-API, otherwise it returns "ENDED_NOT_OK" and shows the
error in report.
Job Output
The report also shows the parameters passed to the Hyperion FM API call which have been entered
in the user interface.
If an exception occurs during call of HFM-API, the error message is posted to the report.
If the job is successful, the message: "Status: Execution of Copy Data succeeded" is shown at the
end of the report.
The Hyperion FM log is transfered to the report directory of the agent (typically "temp") and
registered as output file.
The prefix of the file name is "Log" followed by the RunID of the Job.
The report type of the Hyperion FM log in the Automation Engine is "W1".
30
Chapter 3 Jobs
3.2.8 Creating an Extract Data ToDatabase Job

This job type triggers the execution of the extract data to database action in Hyperion FM and as a
result writes the extracted data into a database. The file is on the host where the agent is located.
Be aware that "Extract Data" influences "Line Item Option", "Extract Dynamic Accounts",
"Calculated Data" and "Derived Data". When "Extract Data" is unchecked these controls are
disabled and cannot be set.
EXTRACT_DATA_TO_DATABASE Job
Field
Description
Login data
Application
POV
The point of view (POV) which contains at least Scenario, Year, Period,
Entity and Value.
Format:
Extract format
The Extract format. Allowed values:

l
l
l
l
l
Metadata only (default)

Selected metadata only
Standard
Essbase
Data Warehouse
Field
Description
Schema Actions
The schema actions. Allowed values:

l
l
l
Create Star Schema (default)

Update Star Schema
Delete Star Schema
Destination
Datanase (DSN)
The Destination Database (DSN), which has to be predefined in Hyperion

FM.
Line Item Option
The line item option. Allowed values:

l
l
None (default)
Total Summary for Cell
Relation Table
Prefix
The prefix.
Extract Data
When checked, data is extracted.

Default:Unchecked
Extract Dynamic
Accounts
When checked, dynamic accounts are extracted.

Default:Unchecked
Calculated Data
When checked, data is calculated.

Default:Unchecked
Derived Data
When checked, data is derived.

Default:Unchecked
Job Status
The Job status is "ENDED_NOT_OK - aborted" if an invalid POV is provided.
The status of the Job is "ENDED_OK - ended normally" otherwise.
Known issue: HFM API has issues with handling invalid DSNs as well as update and delete star
schema.
Job Output
The report tab of the job contains the job parameters and the result of the extract action.
32
Chapter 3 Jobs
All entries have a time stamp. The HFM log is transferred to the report directory of the agent
(typically "temp") and registered as output file.
Special Case
When selecting "Delete Starschema" in Schema Actions Combobox, Hyperion FM does not
provide any taskID. Unfortunately the task then can not be monitored. We are working on a solution
on that topic.
34
Chapter 3 Jobs
3.2.9 Creating an Extract Data to Flat File Job

This job type triggers the execution of the extract data to flatfile action in Hyperion FM and as a
result writes the extracted data into a file. The file is on the host where the agent is located. Be
aware that "Extract Data" influences "Line Item Option", "Extract Dynamic Accounts", "Calculated
Data" and "Derived Data". When "Extract Data" is unchecked these controls are disabled and
cannot be set.
EXTRACT_DATA_TO_FLAT_FILE Job
Field
Description
Login data
Application
POV
The point of view (POV) which contains at least Scenario, Year, Period, Entity
and Value.
Format:
File name
The file where extracted data is stored. This path refers to the file system on
the agent host computer (which is also the Hyperion FM file system).
Field
Description
Delimiter
character
The delimiter character. Allowed values:

l
l
l
l
l
l
l
l
l
l
l
l
l
Extract format
The extract format. Allowed values:

l
l
Line Item
Option
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
Flatfile - without header (default)

Flatfile - with header
The line item option. Allowed values:

l
l
l
None (default)
Individual Line Items
Total Summary for Cell
Extract File
Prefix
The prefix.
Extract data
When checked, data is extracted.

Default:Unchecked
Extract
dynamic
accounts
When checked, dynamic accounts are extracted.

Default:Unchecked
Calculated data When checked, data is calculated.

Default:Unchecked
Derived data
When checked, data is derived.

Default:Unchecked
Cell description
When checked, cells are described.

Default:Unchecked
Phased
submission
group data
When checked, phased submission group data is set.

Default:Unchecked
Job Status
The status of the Job is "ENDED_OK - ended normally" if the status is COMPLETED_
SUCCESSFULLY or COMPLETED_WITH_WARNINGS. The Job status is "ENDED_NOT_OK aborted" if the extract status is FAILED or STOPPED.
36
Chapter 3 Jobs
Job Output
38
Chapter 3 Jobs
3.2.10 Creating an Extract Journals Job

Use Extract Journals jobs to extract journals from HFM into a file. This path refers to the file system
on the agent host computer.
EXTRACT_JOURNALS Job
Field
Description
Login data
Application
The Hyperion FM application to log into. This path refers to the file system on
the agent host computer (which is also the Hyperion FM file system).
File Name
The name of the file with a .jlf extension to extract.
Field
Description
Delimiter
character

l
l
l
l
l
l
l
l
l
l
l
l
l
POV
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
The point of view (POV) which contains at least Scenario, Year, Period, Entity
and Value.
Format:
Labels
Labels, list of Strings separated by ; (wildcard % can be used)
Groups
Groups, list of Strings separated by ; (wildcard % can be used)
Extract
Journals
When checked, journals are extracted.

Default: Checked
Extract
Templates
When checked, templates are extracted.

Default:Checked
Extract
Recurring
Templates
When checked, recurring templates are extracted.

Default: Checked
Working
Show working in the log.

Default: Checked
Submitted
Show submitted in the log.

Default: Checked
Approved
Show approved in the log.

Default: Checked
Rejected
Show rejected in the log.

Default: Checked
Posted
Show posted in the log.

Default: Checked
Regular
Show regular in the log.

Default: Checked
Auto-reversing Show auto-reversing in the log.

Default: Checked
Auto-reversal
Show auto-reversal in the log.

Default: Checked
40
Chapter 3 Jobs
Field
Description
Balanced
Show balanced in the log.

Default: Checked
Balanced by
Entity
Show balanced by entity in the log.

Default: Checked
Unbalanced
Show unbalanced in the log.

Default: Checked
Job Status
SUCCESSFULLY or COMPLETED_WITH_WARNINGS. The Job status is "ENDED_NOT_OK aborted" if the extract status is FAILED.
Job Output

All entries have a time stamp. The HFM log is transfered to the report directory of the agent
The options that are part of the option groups "Status", "Type", and "Balance Type" will only show
up in the report if they are selected. If they are selected, there will be a line in the report containing
text similar to this: "Filter by Status: JSF_WORKING".
42
Chapter 3 Jobs
3.2.11 Creating an Extract Member Lists Job

Use Extract Member Lists jobs to extract member lists into a file. This path refers to the file system
on the agent host computer.
EXTRACT_MEMBER_LISTSJob
Field
Description
Login data
Application The Hyperion FMapplication to log into.

File Name
The name of the file with an .lst extension to extract to. This path refers to the file
system on the agent host computer (which is also the Hyperion FM file system).
Job Status
The status of the job is "ENDED_OK - ended normally" if the status is COMPLETED_
Job Output
The output contains the status and log file from HFM.
The HFM Log has the Automic report type "W1".
44
Chapter 3 Jobs
3.2.12 Creating an Extract Metadata Job

This job type triggers the execution of the extract metadata action in Hyperion FM and as a result
writes the extracted metadata into a file. The file is on the host where the agent is located.
EXTRACT_METADATA Job
Field
Description
Login data
Application
File Name
The name of the file with an .xml or .app extension. This path refers to the file
Field
Description
Delimiter
character

l
l
l
l
l
l
l
l
l
l
l
l
l
File format
The file format. Allowed values:

l
l
Application
Settings
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
Financial Management (.app)

Financial Management (.xml)
Extract application settings.

Default:Unchecked
Consolidation Extract consolidation methods.

Methods
Default:Unchecked
Cell Text
Labels
Extract cell text labels.

Default:Unchecked
Values
Extract values.
Default:Unchecked
Scenarios
Extract scenarios.
Default:Unchecked
Entities
Extract entities.
Default:Unchecked
Accounts
Extract accounts.
Default:Unchecked
Currencies
Extract currencies.
Default:Unchecked
ICPs
Extract ICPs.
Default:Unchecked
Custom
Dimensions
The custom dimensions to include. To define custom dimensions write the name
(s) in this field. Use ';' to separate various dimensions. Blank characters between
dimensions are allowed. When this field is left empty, no metadata for any
custom dimension is extracted.
Periods, Views, Years are always selected.
46
Chapter 3 Jobs
Job Status
Job Output

48
Chapter 3 Jobs
3.2.13 Creating an Extract Rules Job

This action extracts HFMrules.
EXTRACT_RULESJob
Field
Description
Login data

File Name
The name of the file with an .rle extension to extract to. This path refers to the file
Job Status
The status of the job is "ENDED_OK - ended normally" if the status is COMPLETED_
Job Output
The output contains the status and log file from HFM.
50
Chapter 3 Jobs
3.2.14 Creating an Extract Security Job

This action extracts security information from HFM into a file.
EXTRACT_SECURITY Job
Field
Description
Login data
Application
File Name
The name of the file with an .sec extension to extract to. This path refers to the
file system on the agent host computer (which is also the Hyperion FM file
system).
Delimiter
character

l
l
l
l
l
l
l
l
l
l
l
l
l
Extract Users
and Groups
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
When checked, users and groups are extracted to the file.

Default:Unchecked
Field
Description
Extract
Security
Classes
When checked, security classes are extracted to the file.

Default:Unchecked
Extract Role
Access
When checked, role access is extracted to the file.

Default:Unchecked
Extract
Security
Class Access
When checked, security class access is extracted to the file.

Default:Unchecked
Job Status
Job Output
The output contains the status and log file from HFM..
52
Chapter 3 Jobs
3.2.15 Creating a Load Data Job

This action loads data from a file into HFM. If the agent is not running the Browse button is disabled.
Be aware that "File contains process management data" cannot be used together with "File
contains ownership data" and/or "Accumulate within File". If you select these options together, one
or both are programmatically disabled. Also, if you check "File contains process management data",
"Load Mode" will only support the "Replace" and "Merge" options.
LOAD_DATA Job
Field
Description
Login data
Application
File Name
The name of the file to load (with a .dat extension). To browse the agent file
system (which is also the of the Hyperion FMfile system) for the file, use the
Browse button. If there is no connection to the agent, the Browse button is
disabled.
54
Chapter 3 Jobs
Field
Description
Delimiter
character

l
l
l
l
l
l
l
l
l
l
l
l
l
Load Mode
Allows you to select the load mode:

l
l
l
l
File contains
ownership
data
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
Merge
Replace by security
Replace
Accumulate
When checked, the file will contain ownership data.

Default:Unchecked
File contains When checked, the file will contain process management data.
process
Default:Unchecked
management
"File contains process management data" cannot be used together with "File
data
contains ownership data" and/or "Accumulate within File". If you select these
options together, one or both are programmatically disabled.
If you check "File contains process management data", "Load Mode" will only
support the "Replace" and "Merge" options.
Accumulate
within file
When checked, the file will accumulate within the file.

Default:Unchecked
Scan only
When checked, a scan is done, but the list is not loaded.

Default: Unchecked
Job Status
The load process may run for a long time. After the process has been triggered the status is polled
every 3 seconds. The Job remains active until the load process has finished.
The status of the Job is "ENDED_OK - ended normally" if the status is COMPLETED. The Job
status is "ENDED_NOT_OK - aborted" if the load status is ABORTED, NOT_RESPONDING or
STOPPED.
Further it is "ENDED_NOT_OK - aborted" if the wrong load mode (either "Replace by security" or
"Accumulate") is selected for "File contains process management data".

If you choose "Replace by security" or "Accumulate" then the JOBS will ENDED_NOT_OK with an
error like "Error: Invalid duplicate handling 'Replace by Security'".
Job Output
The report tab of the job contains the job parameters and the result of the load action.
Every 3 seconds (status check) the progress of the load task is written to the report.
In addition the remote status of the Job which is updated in the Job check interval will show the
completion rate in percent for long running jobs.
The Log of the load process is added in a new report tab. The file name is "Log" followed by the
RunID of the Job.
56
Chapter 3 Jobs
3.2.16 Creating a Load Journals Job

This action loads Journals from a file into HFM.
LOAD_JOURNALSJob
Field
Description
Login data

File Name
The name of the file to load (with a .jlf extension). To browse the agent file system
(which is also the of the Hyperion FMfile system) for the file, use the Browse
button. If there is no connection to the agent, the Browse button is disabled.
Delimiter
character

l
l
l
l
l
l
l
l
l
l
l
l
l
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
Job Status
SUCCESSFULLY or COMPLETED_WITH_WARNINGS.The Job status is "ENDED_NOT_OK aborted" if the load status is FAILED.
58
Chapter 3 Jobs
Job Output
All entries have a timestamp. The HFM log is transfered to the report directory of the agent (typically
"temp") and registered as output file.
3.2.17 Creating a Load Member Lists Job

This action loads member lists into HFM.
LOAD_MEMBER_LISTSJob
Field
Description
Login data

File Name
The name of the file to load (with an .lsy extension). To browse the agent file
disabled.
Scan only

Default:Unchecked
Job Status
Job Output
60
Chapter 3 Jobs
3.2.18 Creating a Load Metadata Job

This job type triggers an action within Hyperion FM that loads metadata into Hyperion FM. The
metadata is contained in a file that needs to be located on the host of the agent.
LOAD_METADATA Job
Field
Description
Login data
Application
File Name
The name of the file to load (with an .xml extension). To browse the agent file
disabled.
62
Chapter 3 Jobs
Field
Description
Delimiter
character

l
l
l
l
l
l
l
l
l
l
l
l
l
Load Mode
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
Allows you to select the load mode:

l
l
Merge
Replace
Clear
When checked, metadata and data are cleared and the following checkboxes get
metadata and disabled and checked:
data
l
Application Settings
l
Consolidation Methods
l
Cell Text Labels
l
Scenarios
l
Entities
l
Accounts
l
Currencies
Additionally, the Load Mode is forced to "Merge".
Default:Unchecked
Scan only

Default: Unchecked
Application
Settings
When checked, application settings are loaded.

Default:Unchecked
Consolidation When checked, consolidation methods are loaded.

Methods
Default:Unchecked
Cell Text
Labels
When checked, cell text labels are loaded.

Default:Unchecked
System
Accounts
When checked, system accounts are loaded.

Default:Unchecked
Values
When checked, values are loaded.

Default:Unchecked
Scenarios
When checked, scenarios are loaded.

Default:Unchecked
Entities
When checked, entities are loaded.

Default:Unchecked
Field
Description
Accounts
When checked, accounts are loaded.

Default:Unchecked
Currencies
When checked, currencies are loaded.

Default:Unchecked
ICPs
When checked, ICPs are loaded.

Default:Unchecked
Custom
Dimensions
The custom dimensions to include. To define custom dimensions write the name
(s) in this field. Use ';' to separate various dimensions. Blank characters between
dimensions are allowed. When this field is left empty, no metadata for any
custom dimension is loaded.
Periods, Views, Years are always selected.
Job Status
Job Output
64
Chapter 3 Jobs
"temp") and registered as output file. The prefix of the file name is "Log" followed by the RunID of
the Job.
3.2.19 Creating a Load Rules Job

This action loads rules from a file into HFM.
LOAD_RULESJob
Field
Description
Login data

File Name
The name of the file to load (with an .rle extension). To browse the agent file system
(which is also the of the Hyperion FMfile system) for the file, use the Browse
button. If there is no connection to the agent, the Browse button is disabled.
Check
Integrity
When checked, integrity is checked.

Default:Unchecked
Scan only

Default:Unchecked
Job Status
Job Output
66
Chapter 3 Jobs
3.2.20 Creating a Load Security Job

This action loads security information into HFM.
LOAD_SECURITY Job
Field
Description
Login data
Application
File Name
The name of the file to load (with an .sec extension). To browse the agent file
disabled.
Delimiter
character

l
l
l
l
l
l
l
l
l
l
l
l
l
; (default)
,
~
@
#
$
%
^
&
|
:
?
\
68
Chapter 3 Jobs
Field
Description
Clear
Security
Information
Before
Loading
When checked, security information is cleared before loading.

Default:Unchecked
Load Users
and Groups
When checked, users and groups are loaded.

Default:Unchecked
Load
Security
Classes
When checked, security classes are loaded.

Default:Unchecked
Load Role
Access
When checked, role access is loaded.

Default:Unchecked
Load
Security
Class
Access
When checked, security class access isloaded.

Default:Unchecked
Job Status
Job Output

70
Chapter 3 Jobs
3.2.21 Creating a Translate Job

This job type triggers the translation of data within Hyperion FM. Translation in the context of
Hyperion FM means converting financial data between currencies.
TRANSLATEJob
Field
Description
Login data

POV
Value.
Force
Job Status
The status of the job is "ENDED_OK - ended normally" if the Translation action returns 0.
Otherwise it is "ENDED_NOT_OK".
Job Output
If translate action returns 0 then "Execution of TranslateAction succeeded" appears in the report.
Otherwise a error message is posted to the report.
In the report you can also see the passed options which are provided from the UserInterface.
72
Chapter 3 Jobs
3.3 Creating Workflows with Hyperion FM

Jobs
This document describes how you can create jobs and the peculiarities that must be considered.
Automating Hyperion Financial Management (HFM) allows companies financial consolidation,
reporting, and analysis processes involving HFM are more consistent, visible, and controllable.
Exemplary features that covered by Automic's Hyperion FM RA Solution and Automation Engine
include:
l
l
l
l
l
Translating and calculating all base entities.

Loading data files and consolidating data.
Extracting data from one application and loading it into another Application.
Reconsolidating all prior periods and scenarios.
Regularly consolidating main points of view overnight during the close process.
Since the HFM actions are implemented as individual job types, the solution provides maximum
flexibility.
With this flexibility it is possible to model custom use cases as workflows within Automic that
perfectly fit the needs of any use case.
For example, in order to load data into Hyperion FM, then consolidate the data and finally close a
period, you simply create jobs of type LOAD_DATA, CONSOLIDATE and CLOSE_PERIOD and
then arrange them in a workflow as shown below.
3.4 Managing Output and Execution Options

with the RA Tab
Using the RA tab, you can specify how job reports are saved, whether they include agent log
information, and whether the information from the RA agent-specific tab is displayed when
executing the job.
Using the RA tab, you can specify how job reports are saved, whether they include agent log
information, and whether the information from the RA agent-specific tab is displayed when
executing the job. A sample RA tab for a job is shown below.
A sample RA tab for a Rapid Automation Hyperion FM job
Options on the RA tab for jobs are described in the table below.
Field
Description
Database
When checked, the job report is managed in the Automation Engine. After the
execution of a job, the process protocol is transferred to the Automation Engine
database via file transfer.
File
When checked, the job report is managed in the Automation Engine. After the
execution of a job, the process protocol is available in the target system as a file.
Generate
on error
only
When checked, the job report is stored in the Automation Engine database and/or a
file in the target system only if the job has been canceled. This function is only
available when Database and/or File are checked.
Agent log
When checked, job reports will include an agent log tab with an agent log when
there are errors. Keeping this box checked is recommended for troubleshooting
purposes.
Request
When checked, the information from the job's RA agent-specific tab is available in
task
the pop-up window when you execute the job. From this window, you can make one
parameters time changes for a single run of the job. Some fields from RA agent-specific tabs
can only be set in job definitions. These fields are not included in the pop-up window
when the job is requested and the Request task parameters option is checked. A
pop-up window for a sample job is shown below.
74
Chapter 3 Jobs
When Request task parameters is checked, you can edit the information from the job's RA-specific tab for a
single run of the job.
3.5 Hyperion FM Job Attributes

You can read and set the specific attributes of Hyperion FM jobs by using the script elements
:GET_ATT and :PUT_ATT. This topic lists the available attributes for Hyperion FM jobs by job
type. Job attributes are case-sensitive.
Allocate Jobs
Field
XMLName
Available Values
Login data
CONNECTION String
Application APPLICATION
String
POV
String
POV
Calculate Jobs
Field
XMLName
Available Values
Login data
CONNECTION String
String
POV
POV
String
Force
FORCE
l
l
true
false
Calculate Contribution Jobs

Field
XMLName
Available Values
Login data
CONNECTION String
String
POV
POV
String
Force
FORCE
l
l
true
false
Clear Data Slice Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
POV
POV
String
Clear Entity Currency Data
CLEARCURRENCY
l
l
Clear Rates and System Data CLEARRATES
l
l
true
false
true
false
76
Chapter 3 Jobs
Field
XMLName
Enable Detailed Logging
DETAILEDLOGGING
Available Values
l
l
true
false
Close Period Jobs

Field
XMLName
Available Values
Login data
CONNECTION String
String
Scenario
SCENARIO
String
Year
YEAR
String
Period
PERIOD
String
Consolidate Jobs
Field
XMLName
Available Values
Login data
CONNECTION String
String
POV
POV
String
Type
TYPE
l
l
l
l
Impacted
All With Data
All_With_Data
All
Copy Data Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
Source POV
SOURCEPOV
String
Copy Members POV
COPYMEMBERSPOV
String
Destination POV
DESTINATIONPOV
String
Mode
MODE
String
View
VIEW
String
Multiplier
MULTIPLIER
Decimal
Entity Currency Rate
ENTITYCURRENCYDATA
l
l
Rates and System Data RATESANDSYSTEMDATA
l
l
Cell Text
CELLTEXT
l
l
true
false
true
false
true
false
Field
XMLName
Copy Derived Data
COPYDERIVEDDATA
Available Values
l
l
Enable Detailed Logging ENABLEDETAILEDLOGGING
l
l
true
false
true
false
Extract Data ToDatabase Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
POV
POV
String
Extract format
EXTRACTFORMAT
l
l
l
l
l
Schema Actions
SCHEMAACTION
Destination Datanase (DSN) DSN

Line Item Option
LINEITEMOPTION
PREFIX
Extract Data
DATA
DYNAMICACCOUNTS
l
l
Calculated Data
CALCULATEDDATA
l
l
Derived Data
DERIVEDDATA
None
Total Summary
for Cell
String
Extract Dynamic Accounts
Create Star
Schema
Update Star
Schema
Delete Star
Schema
String
Relation Table Prefix
Metadata only
Selected
metadata only
Standard
Essbase
Data
Warehouse
l
l
true
false
true
false
true
false
true
false
Extract Data ToFlatfile Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
78
Chapter 3 Jobs
Field
XMLName
Available Values
POV
POV
String
File name
DATAFILE
String
Delimiter character
DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
Extract format
EXTRACTFORMAT
Line Item Option
LINEITEMOPTION
l
l
Extract File Prefix
PREFIX
Extract data
DATA
DYNAMICACCOUNTS
l
l
Calculated data
CALCULATEDDATA
l
l
Derived data
DERIVEDDATA
l
l
Cell description
CELLDESC
l
l
Phased submission group

data
PHASEDSUBMISSIONGROUPDATA
Field
XMLName
Login data
CONNECTION String
Available Values
String
File Name
String
DATAFILE
l
l
Extract Member Lists Jobs
Flatfile - without
header
Flatfile - with
header
None
Individual Line
Items
Total Summary
for Cell
String
Extract dynamic accounts
;
,
~
@
#
$
%
^
&
|
:
?
\
true
false
true
false
true
false
true
false
true
false
true
false
Extract Journals Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
File Name
DATAFILE
String
Delimiter character
DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
POV
POV
String
Labels
LABELS
String
Groups
GROUPS
String
Extract Journals
EXTRACTJOURNALS
l
l
Extract Templates
EXTRACTTEMPLATES
l
l
Extract Recurring Templates RECURRINGTEMPLATES
l
l
Working
WORKING
l
l
Submitted
SUBMITTED
l
l
Approved
APPROVED
l
l
Rejected
REJECTED
l
l
Posted
POSTED
l
l
Regular
REGULAR
l
l
Auto-reversing
AUTOREVERSING
l
l
;
,
~
@
#
$
%
^
&
|
:
?
\
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
80
Chapter 3 Jobs
Field
XMLName
Auto-reversal
AUTOREVERSAL
Available Values
l
l
Balanced
BALANCED
l
l
Balanced by Entity
BALANCEDBYENTITY
l
l
Unbalanced
UNBALANCED
l
l
true
false
true
false
true
false
true
false
Extract Metadata Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
File Name
DATAFILE
String
Delimiter character
DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
File format
FILEFORMAT
l
l
APPLICATIONSETTINGS
l
l
Consolidation Methods CONSOLIDATIONMETHODS
l
l
Cell Text Labels
CELLTEXTLABELS
l
l
Accounts
SYSTEMACCOUNTS
l
l
Values
VALUES
l
l
Scenarios
SCENARIOS
l
l
;
,
~
@
#
$
%
^
&
|
:
?
\
app
xml
true
false
true
false
true
false
true
false
true
false
true
false
Field
XMLName
Entities
ENTITIES
Available Values
l
l
Accounts
ACCOUNTS
l
l
Currencies
CURRENCIES
l
l
ICPs
ICPS
l
l
Custom Dimensions
CUSTOMDIMENSIONS
true
false
true
false
true
false
true
false
String
Extract Rules Jobs

Field
XMLName
Available Values
Login data
CONNECTION String
String
File Name
String
DATAFILE
Extract Security Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
File Name
DATAFILE
String
Delimiter character
DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
Extract Users and Groups
LOADUSERS
l
l
Extract Security Classes
SECURITYCLASSES
l
l
Extract Role Access
ROLEACCESS
l
l
Extract Security Class Access SECURITYCLASSACCESS
l
l
;
,
~
@
#
$
%
^
&
|
:
?
\
true
false
true
false
true
false
true
false
82
Chapter 3 Jobs
Load Data Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
File Name
DATAFILE
String
Delimiter character
DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
Load Mode
LOADMODE
l
l
l
l
File contains ownership data OWNERSHIPDATA
l
l
File contains ownership data PROCESSDATA
l
l
Accumulate within file
ACCUMULATE
l
l
Scan only
SCANONLY
l
l
Load Journals Jobs

Field
XMLName
Available Values
Login data
CONNECTION String
Application
APPLICATION
String
Application
DATAFILE
String
;
,
~
@
#
$
%
^
&
|
:
?
\
Merge
Replace by
Security
Replace
Accumulate
true
false
true
false
true
false
true
false
Field
XMLName
Available Values
Delimiter character DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
;
,
~
@
#
$
%
^
&
|
:
?
\
Load Member Lists Jobs

Field
XMLName
Available Values
Login data
CONNECTION String
String
File Name
DATAFILE
String
Scan only
SCANONLY
l
l
true
false
Load Metadata Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
File Name
DATAFILE
String
Delimiter character
DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
Load Mode
LOADMODE
l
l
;
,
~
@
#
$
%
^
&
|
:
?
\
merge
replace
84
Chapter 3 Jobs
Field
XMLName
Available Values
Clear metadata and data CLEARMETAANDDATA
l
l
Scan only
SCANONLY
l
l
APPLICATIONSETTINGS
l
l
Consolidation Methods
CONSOLIDATIONMETHODS
l
l
Cell Text Labels
CELLTEXTLABELS
l
l
System Accounts
SYSTEMACCOUNTS
l
l
Values
VALUES
l
l
Scenarios
SCENARIOS
l
l
Entities
ENTITIES
l
l
Accounts
ACCOUNTS
l
l
Currencies
CURRENCIES
l
l
ICPs
ICPS
l
l
Custom Dimensions
CUSTOMDIMENSIONS
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
true
false
String
Load Rules Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Application
APPLICATION
String
File Name
DATAFILE
String
Check Integrity CHECKINTEGRITY
l
l
Scan only
SCANONLY
l
l
true
false
true
false
Load Security Jobs

Field
XMLName
Available Values
Login data
CONNECTION
String
Field
XMLName
Available Values
Application
APPLICATION
String
File Name
DATAFILE
String
Delimiter character
DELIMITER
l
l
l
l
l
l
l
l
l
l
l
l
l
Clear Security Information Before Loading CLEARALL
l
l
Load Users and Groups
LOADUSERS
l
l
Load Security Classes
SECURITYCLASSES
l
l
Load Role Access
ROLEACCESS
l
l
Load Security Class Access
SECURITYCLASSACCESS
l
l
Translate Jobs
Field
XMLName
Available Values
Login data
CONNECTION String
String
POV
POV
String
Force
FORCE
l
l
true
false
;
,
~
@
#
$
%
^
&
|
:
?
\
true
false
true
false
true
false
true
false
true
false
86
Chapter 3 Jobs
3.6 Setting Trace

When you need to troubleshoot a Rapid Automation agent, you can turn on Rapid Automation trace
for AGENT and JOBS objects from either the System Overview window in the Automation Engine
user interface or the ucxjcitx.ini file. You can turn on Rapid Automation user interface trace from the
uc4config.xml file.
Turning Rapid Automation Trace On or Off From the System

Overview Window
To turn on trace for Rapid Automation AGENT and JOBS objects in the user interface, go to
System Overview window, right-click the agent, pick Properties. In the window that pops up, set
RA to 9 to turn trace on or set RA to 0 to turn trace off.
Turning Rapid Automation Trace On or Off From the ucxjcitx.ini

File
To turn on trace for Rapid Automation AGENT and JOBS objects with the ucxjcitx.ini file:
1. Stop the agent(s) from the ServiceManager window or command line.
2. Edit the ucxjcitx.ini file.
To turn trace:
Set:
On for the Rapid automation agent, and its third-party libraries ra=99
Off
ra=0
Third-party library trace can only be set in the ucxjcitx.ini file. It cannot be set through
the UserInterface like for other agents
3. In the code below, ra=9 turns Rapid Automation trace on:
[TRACE]
max_trace_kb=8000
tcp/ip=0
ra=9
trccount=10
4. Restart the agent(s).
Turning On Rapid Automation User Interface Trace

To turn on Rapid Automation user interface trace:
1. Exit out of the Automation Engine user interface.
2. From the uc4config.xml file, add ra="9" to the trace line as shown below:
<trace ra="9" count="10" xml="0" tcp="0">..\temp\UCDJ_TRC_
##.TXT</trace>
3. Open the user interface.
Turning Off Rapid Automation User Interface Trace

To turn off Rapid Automation user interface trace:

1. Exit out of the Automation Engine user interface.
2. From the uc4config.xml file, add ra="0" to the trace line as shown below:
<trace ra="0" count="10" xml="0" tcp="0">..\temp\UCDJ_TRC_
##.TXT</trace>
3. Open the user interface.
For more information on setting trace, see your Automation Engine documentation.
88
Chapter 3 Jobs
Release Notes
Release Notes: Rapid Automation Hyperion
FM Agentv1
Getting the Latest Information
Documentation in .pdf format is included on the dowload center for Automic software releases. That
version of the documentation is created when the software is released. It is available for users who
don't have internet access to view the latest version of the documentation.
Documentation, release notes, and other information is often updated after software is released.
The table below shows where to find the most recent information for Automic software releases.
To find the most recent:
Go to the:
Bug fixes, known issues, and workarounds
Automic Download Center
HTML5 documentation and .pdf files for documentation and release

notes
Automic Hosted
Documentation
Compatibility for Automic software components, versions, and subcomponents
Automic Compatibility
Checker
V1.0.0
Supported Platforms
This pre-release version of the Hyperion FM agent is tested only on Automation Engine 11.1. The
Automic Web User Interface (ECC) is not supported . The agent and it's documentation are only
supplied in English. It requires Oracle Hyperion Financial Management 11.1.2.4
Hyperion Financial Management 11.1.2.3 doesn't have the Java API.
Version 1.0.0 of the Hyperion FM RA Solution officially supports AE 11.1+.
English is the only supported language for version 1.0.0 of the Hyperion FM RA Solution. Version
1.0.0 of the Hyperion FM RA Solution only supports Hyperion Financial Management version
11.1.2.4. Version 1.0.0 of the Hyperion FM RA Solution does not support ECC. Log messages from
Hyperion Financial Management can only be correctly translated/displayed in the job reports if they
are either Latin-9 or UTF-16 encoded.
What's New
This is the first release of the Hyperion FM agent. With it you can create the following Hyperion
Financial Management job types.
l
l
l
l
Allocate
Calculate
Calculate Contribution
Clear Data Slice
90 Release Notes
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
Close Period
Consolidate
Copy Data
Extract Data to Database
Extract Data to Flat file
Extract Journals
Extract Member Lists
Extract Metadata
Extract Rules
Extract Security
Load Data
Load Journals
Load Member Lists
Load Metadata
Load Rules
Load Security
Translate
The user interface and documentation for this agent are currently available only in English.

RA - hyperionFM 1 0 0 Hyperion 1.0 AGENT GUIDE en

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

RA - hyperionFM 1 0 0 Hyperion 1.0 AGENT GUIDE en

Uploaded by

Copyright:

Available Formats

Rapid Automation

ONE Automation Platform

Hyperion Agent Guide

Rapid Automation Hyperion Agent Guide iii

1.1 Hyperion FM Integration

1.2 About Rapid Automation Agents

1.3 Using WebHelp at docs.automic.com

2 Installation and Configuration

2.1 General Set-up Information

2.2 Installing the Hyperion FM Agent in an Existing Automation Engine System

2.3 Configuring System Objects

2.4 Specifying Automation Engine/Agent Timeout Seconds

3.1 Creating Jobs

3.2 Job Types

3.2.1 Creating an Allocate Job

3.2.2 Creating a Calculate Job

3.2.3 Creating a Calculate Contribution Job

3.2.4 Creating a Clear Data Slice Job

3.2.5 Creating a Close Period Job

3.2.6 Creating a Consolidate Job

3.2.7 Creating a Copy Data Job

3.2.8 Creating an Extract Data ToDatabase Job

3.2.9 Creating an Extract Data to Flat File Job

3.2.10 Creating an Extract Journals Job

3.2.11 Creating an Extract Member Lists Job

3.2.12 Creating an Extract Metadata Job

3.2.13 Creating an Extract Rules Job

3.2.14 Creating an Extract Security Job

3.2.15 Creating a Load Data Job

3.2.16 Creating a Load Journals Job

3.2.17 Creating a Load Member Lists Job

3.2.18 Creating a Load Metadata Job

3.2.19 Creating a Load Rules Job

3.2.20 Creating a Load Security Job

3.2.21 Creating a Translate Job

3.3 Creating Workflows with Hyperion FM Jobs

3.4 Managing Output and Execution Options with the RA Tab

3.5 Hyperion FM Job Attributes

3.6 Setting Trace

Getting the Latest Information

Rapid Automation Hyperion Agent Guide 1

1.2 About Rapid Automation Agents

Using Object Variables in Fields

Overriding Settings on RA Agent-specific Tabs

Rapid Automation Hyperion Agent Guide 3

1.3 Using WebHelp at docs.automic.com

Find documents in the table of contents.

Uppercase and lowercase letters are not distinguished (not case-sensitive).

Rapid Automation Hyperion Agent Guide 5

2 Installation and Configuration

Chapter 2 Installation and Configuration

2.2 Installing the Hyperion FM Agent in an

ucxjcitx.jar Agent for Rapid Automation

The Windows installation executable for the RA agent core

Setting Trace Before Running the Installation or Upgrade of the

Rapid Automation Hyperion Agent Guide 7

Setting Up a New or Upgraded Agent

A license loaded in the database for the agent.

License File Requirement

Putting Agent Files on the Host Machine

Creating the cache Directory

Editing the ucxjcitx.ini File

Chapter 2 Installation and Configuration