Hyperion Retrieve Functions

This appendix provides the syntax for Hyperion Retrieve functions and examples of their use.

Function Syntax and Examples

The following sections provide the syntax and examples for specific Hyperion Retrieve

functions.

HPACC - Account ID Function

You use the HPACC function to retrieve and show the ID of a specified account. Use this

format:

HPACC("Account","Application")

For example, if the Tax application contains the Cost of Goods Sold account and its ID appears

in cell A7, you can use this formula for cell A23 to show the Cost of Goods Sold account ID in

cell A23:

HPACC(A7,"TAX")

HPAMJ - Major Account ID Function

You use the HPAMJ function to retrieve and show the major account ID for a specified

account. Use this format:

HPAMJ("Account","Application")

For example, suppose you type this formula for cell A23:

HPAMJ(A14,"PROD")

If the account ID SALES.GOLF.SHOES appears in cell A14 and the Product application

contains that account, the major account ID SALES appears in cell A23.

HPAS1 - First-level Subaccount ID Function

You use the HPAS1 function to retrieve and show the first-level subaccount ID for a specified

account. Use this format:

HPAS1("Account","Application")

For example, suppose you type this formula for cell A28:

HPAS1(A14,"PROD")

If the account ID SALES.GOLF.SHOES appears in cell A14 and the Product application

contains that account, the first-level subaccount ID GOLF appears in cell A28.

HPAS2 - Second-level Subaccount ID Function

You use the HPAS2 function to retrieve and show the second-level subaccount ID for a

specified account. Use this format:

HPAS2("Account","Application")

For example, suppose you type this formula for cell A32:

HPAS2(A14,"PROD")

If the account ID SALES.GOLF.SHOES appears in cell A14 and the Product application

contains that account, the second-level subaccount ID SHOES appears in cell A32.

HPBET - Difference Function

You use the HPBET function to calculate and return the difference between two data values for

a specified account. The difference appears with a minus sign (

-

) if it is negative. Use this

format:

HPBET("Account","Value1","Value2","Application")

For example, suppose you want to return the difference between the October 2002 and

November 2002 values of the Cost of Goods Sold account for the current entity and category in

the Tax application. If the account ID appears in cell A5 of the worksheet, the November 2002

value appears in cell D5, and the October 2002 value appears in cell C5, you could use this

formula to return the difference between the two values:

HPBET(A5,D5,C5,"TAX")

You can also use the HPBET function to return the difference between an account's values for

two different categories in the same period. For example, you might want to show the

difference between the Cash account's February values in the Actual and Last Year categories,

or the difference between its values for the Italy and France entities.

HPCAL - Calculated Account Function

You use the HPCAL function to return and show a 1 if a specified account is a calculated

account, or a -1 if it is not. Use this format:

HPCAL("Entity","Category","Account","Application")

For example, this formula returns a 1 because for the entity USWEST in the Product

application, the Total Sales account is a calculated account:

HPCAL("USWEST","ACTUAL","TOTSALES","PROD")

HPCDE - Category Description Function

You use the HPCDE function to retrieve and show the description for a specified category. Use

this format:

HPCDE("Category","Application")

For example, this formula returns the description for the Forecast category in the Tax

application:

HPCDE("FORCST","TAX")

HPCONTRIB - Contribution Data Function

You use the HPCONTRIB function to retrieve contribution data. Use this format:

HPCONTRIB("Entity", "Category", "Account", "Period", "Frequency", "Parent", "Application")

For example, the following formula returns the Actual category’s contribution data for the

Italy entity in the Cables account for the April 2002 period. This formula shows a monthly data

view for the parent Europe in the Tax application:

HPCONTRIB("ITALY""ACTUAL","CABLES","APR 02","MON","EUROPE","TAX")

HPCUR - Currency Function

You use the HPCUR function to retrieve and show the default currency ID for a specified

entity. Use this format:

HPCUR("Entity","Application")

For example, this formula returns the default currency ID for the Italy entity in the Tax

application:

HPCUR("ITALY","TAX")

HPDCTRL - Direct Control Function

You use the HPDCTRL function to retrieve either the amount of voting shares owned or the

percentage directly controlled, depending on whether you input shares as units or percentages.

Use this format:

HPDCTRL("Parent", "Child", "Category", "Period", "Application")

For example, this formula returns the amount of voting shares for the parent Europe with the

child Italy in the Actual category for the period April 2002 in the Tax application.

HPDCTRL("EUROPE","ITALY","ACTUAL","APR 02","TAX")

HPDOWN - Direct Ownership Function

You use the HPDOWN function either to retrieve the number of shares that the partner

directly owns or to retrieve a direct ownership percentage, depending on whether you input

shares as units or percentages. Use this format:

HPDOWN("Parent", "Child", "Category", "Period", "Application")

For example, this formula returns the number of shares that the parent Europe owns of the

child Italy in the Actual category for the period of April 2002 in the Tax application:

HPDOWN("EUROPE","ITALY","ACTUAL","APR 02","TAX")

HPDRV - Derived Sum Function

The results of the HPDRV function depend on the account type of a specified account. If you

specify an income, expense, or flow account, the HPDRV function returns the sum of the

account's values for two specified periods for the current entity and category. If you specify an

asset, liability, or balance account, the HPDRV function returns a value for the later of two

periods for the current entity and category without adding that value to the earlier value.

Use this format:

HPDRV("Account","Value1","Value2","Application")

For example, suppose the Cost of Goods Sold account in the Tax application is a flow account,

and you want to total its October 2002 and November 2002 values. If the account ID appears

in cell A5 of the worksheet, the November 2002 value appears in cell D5, and the October 2002

value appears in cell C5, you could use this formula to return the sum of the values:

HPDRV(A5,D5,C5,"TAX")

HPECODE - Entity Code Function

You use the HPECODE function to retrieve the entity code, which is a user-assigned code

associated with the entity for a particular category and period. Use this format:

HPECODE("Entity", "Category", "Period", "Application")

For example, this formula returns the entity code for the Italy entity in the Actual category for

the April 2002 period in the Tax application:

HPECODE("ITALY","ACTUAL","APR 02","TAX")

HPELIM - Elimination Data Function

You use the HPELIM function to retrieve elimination data. Use this format:

HPELIM("Entity", "Category", "Account", "Period", "Frequency", "Parent", "Application")

For example, this formula returns elimination data for the Italy entity in the Actual category

for the Cables account for the April 2002 period with a monthly data view for the parent

Europe in the Tax application:

HPELIM("ITALY","ACTUAL","CABLES","APR 02","MON","EUROPE","TAX")

HPFLW - Flow Function

You use the HPFLW function to return a 1 if a specified account is an income, expense, or flow

account, or a -1 if it is any other type of account. You can use the results returned by the

HPFLW function in Lotus 1-2-3 or Excel formulas to differentiate income statement accounts

from balance sheet accounts. Use this format:

HPFLW("Account","Application")

For example, this formula returns a 1 because the Pretax Earnings account in the Tax

application is a flow account:

HPFLW("PTE","TAX")

HPFNA - First Entity Description Function

You use the HPFNA function to retrieve and show the first entity description for a specified

entity. Use this format:

HPFNA("Entity","Application")

For example, suppose you type this formula for cell D27:

HPFNA(B14,"TAX")

If the entity USELIM.PADJ in the Tax application appears in cell B14 and the description for

USELIM is United States Eliminations, that description appears in the cell D27.

HPFRE - Default Frequency Function

You use the HPFRE function to retrieve and show the default frequency ID for a specified

category. Use this format:

HPFRE("Category","Application")

For example, this formula returns the ID of the default frequency for the Forecast category in

the Tax application:

HPFRE("FORCST","TAX")

HPFSN - Subentity Description Function

You can use the HPFSN function to retrieve and show the descriptions of all specified

subentities. Use this format:

HPFSN("Entity","Application")

For example, suppose you type this formula for cell D27:

HPFSN(B14,"TAX)

If the entity USELIM.PADJ in the Tax application appears in cell B14 and the description for

PADJ is Post-Adjustment, that description appears in the cell D27.

HPFUL - Entity Description Function

You use the HPFUL function to retrieve and show the description for a specified entity.

Use this format:

HPFUL("Entity","Application")

For example, this formula returns the description for the Belgium-Netherlands-Luxembourg

entity in the Tax application:

HPFUL("BENELUX","TAX")

HPHEA - Account Description Function

You use the HPHEA function to retrieve and show the description for a specified account in a

specified application. Use this format:

HPHEA("Account","Application")

For example, this formula returns the description for the SALES.FBALL.HLM account ID in

the Product application:

HPHEA("SALES.FBALL.HLM","PROD")

If the account description is Sales.Football.Helmets, that description appears in the cell that

contains the formula.

HPHMJ - Major Account Description Function

You use the HPHMJ function to retrieve and show the major account description for a

specified account. Use this format:

HPHMJ("Account","Application")

For example, suppose you type this formula for cell A23:

HPHMJ(A14,"PROD")

If the account ID SALES.FBALL.HLM in the Product application appears in cell A14 and the

SALES account description is Sales by Product, that description appears in cell A23.

HPHS1 - First-level Subaccount Description Function

You use the HPHS1 function to retrieve and show the first-level subaccount description for a

specified account. Use this format:

HPHS1("Account","Application")

For example, suppose you type this formula for cell A28:

HPHS1(A14,"PROD")

If the account ID SALES.FBALL.HLM in the Product application appears in cell A14 and the

FBALL subaccount description is Football, that description appears in cell A28.

HPHS2 - Second-level Subaccount Description Function

You use the HPHS2 function to retrieve and show the second-level subaccount description for

a specified account. Use this format:

HPHS2("Account","Application")

For example, suppose you type this formula for cell A32:

HPHS2(A14,"PROD")

If the account ID SALES.FBALL.HLM in the Product application appears in cell A14 and the

HLM subaccount description is Helmets, that description appears in cell A32.

HPINC - Income Account Function

You use the HPINC function to return and show a 1 if a specified account is an income or

liability account, or a -1 if it is an asset, balance, expense, or flow account. You can use the

results returned by the HPINC function in Lotus 1-2-3 or Excel formulas to show the values of

income or liability accounts as positive numbers and the values of asset, balance, expense, and

flow accounts as negative numbers. Use this format:

HPINC("Account","Application")

For example, this formula returns a 1 because the Sales.Golf account in the Product

application is an income account:

HPINC("SALES.GOLF","PROD")

HPINP - Input Account Function

You use the HPINP function to return and show a 1 if a specified account is an input account,

or a -1 if it is not. Use this format:

HPINP("Entity","Category","Account","Application")

For example, this formula returns a 1 because for the entity USWEST in the Sales category of

the Product application, the Sales.Golf account is an input account:

HPINP("USWEST","ACTUAL","SALES.GOLF","PROD")

HPJAC - Journal Account Function

You use the HPJAC function to retrieve the account for a specified journal detail row. Use this

format:

HPJAC("Journal", "Table", "Category", "Period", "Application", "Detail")

For example, to display the account IDs for a journal entry, you can use the following formula:

HPJAC("RECLASS1","JOURNAL","ACTUAL","1","APP1","0")

HPJCR - Journal Credit Value Function

You use the HPJCR function to retrieve the credit value for a specified journal detail row. Use

this format:

HPJCR("Journal", "Table", "Category", "Period", "Application", "Detail")

For example, to display the credit value for a journal entry, you can use the following formula:

HPJCR("RECLASS1","JOURNAL","ACTUAL","1","APP1","1")

HPJDB - Journal Debit Value Function

You use the HPJDB function to retrieve the debit value for a specified journal detail row. Use

this format:

HPJDB("Journal", "Table", "Category", "Period", "Application","Detail")

For example, to display the debit value for a journal entry, you can use the following formula:

HPJDB("RECLASS1","JOURNAL","ACTUAL","1","APP1","0")

HPJDS - Journal Description Function

You use the HPJDS function to retrieve the journal description. Use this format:

HPJDS("Journal", "Table", "Category", "Period", "Application")

For example, to display the journal entry description for a journal entry, you would use the

following formula:

HPJDS("RECLASS1","JOURNAL","ACTUAL","1","APP1")

HPJEN - Journal Entity Function

You use the HPJEN function to retrieve the entity for a specified journal detail row. Use this

format:

HPJEN("Journal", "Table", "Category", "Period", "Application", "Detail")

For example, to display the entity for a journal entry, you can use the following formula:

HPJEN("RECLASS1","JOURNAL","ACTUAL","1","APP1","0")

HPJNO - Journal Number Function

You use the HPJNO function to retrieve the number that was assigned to the journal by the

system. Use this format:

HPJNO("Journal", "Table", "Category", "Period", "Application")

For example, to display the journal number for a journal entry, you would use the following

formula:

HPJNO("RECLASS1","JOURNAL","ACTUAL","1","APP1")

HPJST - Journal Status Function

You use the HPJST function to retrieve the journal status. Use this format:

HPJST("Journal", "Table", "Category", "Period", "Application")

For example, to display the journal status for a journal entry, you would use the following

formula:

HPJST("RECLASS1","JOURNAL","ACTUAL","1","APP1")

HPKEY - Default ID Function

You use the HPKEY function to retrieve and show the ID for the default account, entity,

category, or period.

Use this format:

HPKEY("Element","Application")

For example, suppose you type this formula for cell A10:

HPKEY("CATEGORY","PROD")

If the default category for the Product application is Last Year and its ID is LASTYR, that ID

appears in cell A10.

HPLNK - Link Data Value Function

You use the HPLNK function to send a data value from a spreadsheet to the Hyperion

Enterprise database for a specified entity, category, account, period, frequency, and

application.

The name and account to which you are exporting data must be an input name and account.

You must select either PER or CTD, rather than YTD, as the frequency view. You cannot

export data from a spreadsheet to an open data file. If you are exporting to a journal entity,

make sure that it does not have a journal lock applied. Turn off all cell protection in the

worksheet when using the HPLNK option. Use this format:

HPLNK(Value,"Entity","Category","Account","Period","Frequency",

"Application")

For example, this formula sends the value in cell A20 to the Forecast category's October 2002

value for the Cables account and the Italy entity in the Tax application, with a monthly data

view:

HPLNK(A20,"ITALY","FORCST","CABLES","OCT 02","MON","TAX")

For more information, see "Period Values in Hyperion Retrieve Functions" on page 224.

HPNAM - Entity Function

You use the HPNAM function to retrieve and show the ID for a specified entity. Use this

format:

HPNAM("Entity","Application")

For example, this formula returns the ID for the US100 entity in the Tax application:

HPNAM("US100","TAX")

HPNNA - First Entity ID Function

You use the HPNNA function to retrieve and show the first entity ID for a specified entity. Use

this format:

HPNNA("Entity","Application")

For example, suppose you type this formula for cell D27:

HPNNA(B14,"TAX")

If the entity USELIM.PADJ in the Tax application appears in cell B14, the first entity USELIM

appears in cell D27.

HPNSN - Subentity ID Function

You use the HPNSN function to retrieve and show the subentity ID for a specified entity. Use

this format:

HPNSN("Entity","Application")

For example, suppose you type this formula for cell D27:

HPNSN(B14,"TAX")

If the entity USELIM.PADJ in the Tax application appears in cell B14, the subentity PADJ

appears in cell D27.

HPPARADJ - Parent Adjustment Data Function

You use the HPPARADJ function to retrieve parent adjustment data. Use this format:

HPPARADJ("Entity", "Category", "Account", "Period", "Frequency", "Parent", "Application")

For example, this formula returns the parent adjustment data for the Italy entity in the Actual

category for the Cables account for the April 2002 period. The formula shows a monthly data

view for the parent Europe in the Tax application:

HPPARADJ("ITALY","ACTUAL","CABLES","APR 02","MON","EUROPE","TAX")

HPPBE - Percentage Difference Function

You use the HPPBE function to return the percentage difference between two values for a

specified account. The difference appears with a plus sign (

+

) if it is positive or a minus sign

(

-

) if it is negative. Use this format:

HPPBE("Account","Value1","Value2","Application")

For example, suppose you want to return the percentage difference between the October 2002

and November 2002 values of the Cost of Goods Sold account for the Tax application. If the

account ID appears in cell A5 of the worksheet, the November 2002 value appears in cell D5,

the October 2002 value appears in cell C5, and the application ID appears in cell A1, you could

use this formula to return the percentage difference between the two values:

HPPBE(A5,D5,C5,A1)

You could also use the HPPBE function to return the percentage difference between an

account's values for two different categories or entities in the same period. For example, you

might want to show the percentage difference between the Cash account's February values in

the Actual and Last Year categories, or the percentage difference between its values for the Italy

and France entities.

HPPCH - Percentage Change Function

You use the HPPCH function to return the percentage change between two values. The system

uses this formula:

Value1Value2

Value2--------------------------------------------100×

You might use the HPPCH function to calculate the percentage change between an account's

values for two periods, regardless of account type. You might also use it to calculate the

percentage change between an account's values in the same period for two different categories

or two different entities. The system does not evaluate whether the percentage change is

positive or negative. Use this format:

HPPCH("Value1","Value2","Application")

For example, suppose you want to return the percentage change between the October 2002 and

October 2003 values of an account for the Tax application. If the account's October 2003 value

appears in cell D5 of the worksheet and the account's October 2002 value appears in cell C5,

you could use this formula to return the percentage change between the values:

HPPCH(D5,C5,"TAX")

HPPCONS - Ultimate Percent Consolidated Function

You use the HPPCONS function to retrieve the ultimate percent consolidated. Use this format:

HPPCONS("Parent", "Child", "Category", "Period", "Application")

For example, this formula returns the ultimate percent consolidated for the parent Europe

with the child Italy in the Actual category for the period of April 2002 in the Tax application:

HPPCONS("EUROPE","ITALY","ACTUAL","APR 02","TAX")

HPPCTRL - Ultimate Percent Control Function

You use the HPPCTRL function to retrieve the ultimate percent control. Use this format:

HPPCTRL("Parent", "Child", "Category", "Period", "Application")

For example, this formula returns the ultimate percent control for the parent Europe with the

child Italy in the Actual category for the April 2002 period in the Tax application.

HPPCTRL("EUROPE","ITALY","ACTUAL","APR 02","TAX")

HPPOWN - Ultimate Percent Ownership Function

You use the HPPOWN function to retrieve the ultimate percent ownership. Use this format:

HPPOWN("Parent", "Child", "Category", "Period", "Application")

For example, this formula returns the ultimate percent ownership for the parent Europe with

the child Italy in the Actual category in the April 2002 period in the Tax application:

HPPOWN("EUROPE","ITALY","ACTUAL","APR 02","TAX")

HPPROP - Proportion Data Function

You use the HPPROP function to retrieve proportion data. Use this format:

HPPROP("Entity", "Category", "Account", "Period", "Frequency", "Parent", "Application")

For example, this formula returns the proportion data for the Italy entity in the Actual

category for the Cables account for the April 2002 period with a monthly data view for the

parent Europe in the Tax application:

HPPROP("ITALY","ACTUAL","CABLES",

"APR 02","MON","EUROPE","TAX")

HPSCA - Scale Function

You use the HPSCA function to retrieve the scaling factor for a specified entity, category, and

account. The scaling factor is returned as a power of 10. For example, a scale of 3 in Hyperion

Enterprise is returned as 100. If the entity has scaling defined, the scaling for the entity is

returned. Otherwise, the scaling for the category is returned. If the Scaling option for the

account is turned off in the Chart of Accounts window, the HPSCA function returns a value of

1. Use this format:

HPSCA("Entity","Category","Account","Application")

For example, this formula returns the scaling factor for the Cables account and the Italy entity

in the Budget category for the Tax application:

HPSCA("ITALY","BUDGET","CABLES","TAX")

HPSHAROS - Shares Outstanding Function

You use the HPSHAROS function to return the total shares outstanding. Use this format:

HPSHAROS("Entity","Category", "Period", "Application")

For example, this formula returns the total shares outstanding for the entity USWEST in the

Actual category in the April 2002 period in the Product application:

HPSHAROS("USWEST","ACTUAL","APR 02","PROD")

HPSHAROW - Shares Owned by Other Entities Function

You use the HPSHAROW function to return the total shares owned by other entities. Use this

format:

HPSHAROW("Entity", "Category", "Period", "Application")

For example, this formula returns the total shares owned for the entity USWEST in the Actual

category in the April 2002 period in the Product application:

HPSHAROW("USWEST","ACTUAL","APR 02","PROD")

HPTRAN - Translation Data Function

You use the HPTRAN function to retrieve translation data. Use this format:

HPTRAN("Entity", "Category", "Account", "Period", "Frequency", "Parent, "Application")

For example, this formula returns the translation data for the Italy entity in the Actual category

for the Cables account in the April 2002 period with a monthly data view for the parent Europe

in the Tax application:

HPTRAN("ITALY","ACTUAL","CABLES","APR 02","MON","EUROPE","TAX")

HPVAL - Data Value Function

You use the HPVAL function to retrieve and show the data value for a specified entity,

category, account, period, frequency, and application. You can view values for a category in the

frequency assigned to the category or in larger time increments. For example, if the monthly

frequency is assigned to the Actual category, you can view quarterly values but not weekly

values. Use this format:

HPVAL("Entity","Category","Account","Period","Frequency",

"Application")

For example, this formula returns the Forecast category's October 2002 value for the Cables

account and the Italy entity in the Tax application, with a monthly data view:

HPVAL("ITALY","FORCST","CABLES","OCT 02","MON","TAX")

Hyperion Autopilot

Building and executing task flows

Building task flows

You build a task flow in Hyperion AutoPilot32 by dragging icons from the Task

Palette and dropping them into the Task Flow window in the order you want them

to be performed. Then you specify values in the Properties window.

➤ To build a task flow:

1. Start Hyperion AutoPilot32.

2. Drag an icon from the Task Palette to the Task Flow window.

– To add the icon to the end of the flow, drop it anywhere in the Task Flow

window except on top of another icon.

– To add the icon so it precedes a task icon already in the flow, drag it on

top of an existing task icon in the Task Flow window. (The color of the

existing icon changes to red.) Then drop the new icon.

3. In the Properties window, specify values for the task properties.

4. Repeat steps 2 and 3 for each task you want to include in the task flow.

5. Select File > Save.

6. The Save As dialog box displays.

7. Select the folder where you want to save the task flow, type a file name, and

click OK.

Executing task flows

After you build a task flow and save it as a file, you can run it in Hyperion

AutoPilot32.

➤To run a task flow:

1. Select File > Open.

2. From the Open dialog box, select the task flow file.

3. Do one of the following:

– Select Tasks > Run Task Flow.

– Press F5.

– Click the Run Task Flow button on the toolbar.

As each task executes, Hyperion AutoPilot32 displays the status in the status

message bar.

4. Follow any prompts in the task flow.

Editing task flows

You can edit a task flow by:

• Adding tasks

• Deleting tasks

• Changing the task sequence

• Changing the values for task properties

Each of these options is discussed in the following sections.

Adding tasks to a task flow

You can add tasks to an existing task flow.

Tip: In general, it’s a good idea to build a task flow with just a few tasks, run it to make

sure it works, and then add more tasks.

To add a task to a task flow:

1. Drag an icon from the Task Palette window to the Task Flow window:

– To add the task icon to the end of the flow, drop it anywhere in the Task

Flow window except on top of another icon.

– To add the task icon so it precedes a task already in the flow, drag it on

top of the existing icon in the Task Flow window. The color of the

existing icon changes to red. Then drop the new icon.

2. To save your changes, do one of the following:

– To save your changes in the current task flow file, select File > Save.

– To save the edited task flow in a different file, leaving the original task

flow unchanged, select File > Save As. In the Save As dialog box, select

a folder, type a file name, and click OK.

Deleting tasks from a task flow

You can delete tasks from an existing task flow.

To delete a task from a task flow:

1. Click the task icon in the Task Flow window to select it.

2. Press Delete.

3. To save your changes, do one of the following:

– To save your changes in the current task flow file, select File > Save.

– To save the edited task flow in a different file, leaving the original task

flow unchanged, select File > Save As. In the Save As dialog box, select

a folder, type a file name, and click OK.

Deleting Line Items

Using Hyperion AutoPilot, you can delete line items from a specified report in a

Hyperion Pillar plan file.

Note: All line items are deleted from the specified user report when you use the delete line item task.

Note: Template line items cannot be deleted.

➤ To delete line items:

1. Drag the Delete Line Item icon form the Task Palette to the Task Flow

window.

2. In the Properties window, specify a Hyperion Pillar file, a user name, a

password, and a Hyperion Pillar User Report.

3. Repeat steps 1 and 2 for each line item you want to delete.

4. Select File > Save.

5. The Save As dialog box displays. Select the folder where you want to save

the task flow, type a file name, and click OK.

You are now ready to run the task flow.

6. Select File > Open.

7. From the Open Dialog box, select the task flow file.

8. Do one of the following:

9. Select Tasks > Run Task Flow.

10. Press F5.

11. Click the Run Task Flow button on the toolbar.

As your task executes, Hyperion AutoPilot displays the status in the status

message bar.

Hyperion Autopilot Introduction

Hyperion Autopilot32

What is Hyperion AutoPilot32?
Hyperion AutoPilot32 is a graphical tool that provides you with a drag and drop method for chaining together a series of tasks into a task flow. You can use Hyperion AutoPilot32 to automate tasks you commonly perform using Hyperion products and other Windows software.

Tasks and task flows
When you work with Hyperion products or other Windows applications, you routinely perform tasks like starting applications, consolidating and calculating files, saving files,
and printing reports.

In Hyperion AutoPilot32, tasks are represented as task icons in the Task Palette.
There are sets of product-specific tasks for Hyperion products like Hyperion Enterprise™ and Hyperion Pillar®. There is also a set of common tasks that work
with any Windows application you have installed.

A task flow is a sequence of tasks you can create in Hyperion AutoPilot32. After
you create a task flow, you save it as a file and then run it in Hyperion AutoPilot32.
As the task flow runs, each event that occurs is recorded in a log file you can use
as a troubleshooting tool.

The Hyperion AutoPilot32 workspace
You build and edit task flows in the Hyperion AutoPilot32 workspace. The
workspace includes the Task Palette along with the Properties and Task Flow
windows.



You can maximize, minimize, move, and resize the windows to customize the Hyperion AutoPilot32 workspace. You can also use the commands on the
Windows menu to arrange the windows


Sample task flows
The following sample task flows show you how you can use Hyperion
AutoPilot32 to automate your everyday tasks.

Hyperion Pillar example
The following task flow illustrates how you can use Hyperion AutoPilot32 to
automate your Hyperion Pillar tasks.



This task flow:
1. Waits for a specific Hyperion Pillar file to exist on your machine.
2. Calculates the file.
3. Distributes the file.
4. Prints the file.

Hyperion Enterprise example
The following task flow illustrates how you can use Hyperion AutoPilot32 to
automate your Hyperion Enterprise tasks.



This task flow:
1. Loads Hyperion Enterprise data.
2. Runs a consolidation.
3. Prints a report.

Working with Hyperion AutoPilot32
The following sections describe how to use the Task Palette and the Task Flow and
Properties windows.

Task Palette
Tasks you can automate display as icons in the Task Palette. There are task icons
for:

_ Common tasks, which work with all Windows applications
_ Plug-in tasks, which are product-specific tasks for Hyperion Enterprise,
Hyperion Pillar, and other Hyperion applications
Select one or more of the following buttons on the toolbar to display the task icons
in the Task Palette window:

You can create task flows that include any combination of common tasks and
plug-in tasks.

Note: The plug-in tasks you see will vary depending on the Hyperion applications you
have installed on your computer.

Task Flow window
You build task flows by dragging task icons fromthe Task Palette to the Task Flow
window. Hyperion AutoPilot32 performs the tasks in the order they display in the
Task Flow window.

You can select one of the following three views for the Task Flow window:
_ The Icon view shows icons only



_ The List view shows a list of icons with simple descriptions


The Details view shows a list of icons with descriptions, properties, and values


To change the Task Flow window view, select View > Icon, List, or Details. Or,
click one of the View buttons on the toolbar

Properties window
The Properties window shows you the properties associated with the currently
selected task in the Task Flow window. It includes fields where you specify values
for each of the properties. When you run the task flow, those values determine
exactly what happens as the task is performed.


Properties window elements
The Properties window is made up of the following elements:
_ The Property column, which displays the property names for the specified
task.
_ The Value column displays the fields where you specify values for each task
property.
_ The Ellipse button, which you click to display a dialog box from which you
can select property values.
_ The Down Arrow button, which you click to display a drop-down list where
you can select task property values.


Setting Hyperion AutoPilot32 preferences
You can set the following Hyperion AutoPilot32 preferences:
• The language for text displayed in Hyperion AutoPilot32.
• The font for text in the Task Flow and Properties windows, the Log View and Set Preferences dialog boxes, and the status bar.
• The task sets to load when you start Hyperion AutoPilot32. You can choose to load all the task sets available, or you can choose to decide which tasks to load each time you start Hyperion AutoPilot32.

To set Hyperion AutoPilot32 preferences:

1. Start Hyperion AutoPilot32.

2. Select Tasks > Set Preferences.



3. In the Language drop-down list, select the language for all text displayed in
Hyperion AutoPilot32. Your change takes effect the next time you start
Hyperion AutoPilot32.

Note: The languages you see will vary depending on the languages you have
installed on your computer.

4. In the Font drop-down list, select the font for all text displayed in the Task
Flow and Properties windows, the Log View and Set Preferences dialog
boxes, and the status bar. Your change takes effect when you click OK in step

5. In the Load Plug-ins area of the dialog box, specify how you want task sets to
load when you start Hyperion AutoPilot32.
– Select Automatically Load Plug-ins to load all the available task sets
when Hyperion AutoPilot32 starts. If you choose this option, all the
common and product-specific task sets are loaded the next time you start
Hyperion AutoPilot32, and a Show Tasks button for each task set displays
on the toolbar.
Hyperion AutoPilot32 Getting Started
Hyperion AutoPilot Getting Started _ 13
– Select Prompt at Program Startup if youwant to choose which task sets
to load each time you start Hyperion AutoPilot32. If you select this
option, the Select Plug-ins dialog box displays the next time you start
Hyperion AutoPilot32.


When the Select Plug-ins dialog box displays, all task sets are selected by
default. If there is a task set you do not want to load, deselect it.
6. Click OK.
Viewing the log file
The log file lists the events that occur when you run a Hyperion AutoPilot32 task
flow. For each task, the file shows the date and time it ran, the name of the product
that generated the message, the name of the user who ran it, and other information
about the task.
To view the log file, select View > Log in the Hyperion AutoPilot32 workspace,
or click the View Log button on the toolbar.

Click OK to close the AutoPilot32 Log View dialog box and return to the
Hyperion AutoPilot32 workspace.
Click Clear Log to delete the contents of the log file, close the AutoPilot32 Log
View dialog box, and return to the Hyperion AutoPilot32 workspace.