Command Line Parameters for the Outline Load Utility

The following command line parameters are available for the Outline Load utility. After running the utility, you can verify the results by reviewing the exception file and log file. If no errors are reported in the log file, you can then access the imported metadata and data in the application. It is not necessary to restart the application server.

OutlineLoad [-f:passwordFile][/S:server] /A:application /U:userName [/M] [/E:outputFileName] [/I:inputFileName/D[U]:loadDimensionName|/DA:attributeDimensionName:baseDimensionName] [/TR] [/N] [[/R] [/U]] [/C] [/F] [/K] [/X:exceptionFileName] [L:logFileName] [/DX:HSP_Rates][/DS:HSP_SMARTLISTS] [/8][/?]

Example: Load numeric attribute dimension and values, and associate them with the Entity dimension. (An attribute dimension will be created if it does not exist, but no assignment is made of attribute values to base numbers.)

OutlineLoad /A:Test  /U:admin  /M /I:c:/outline1_attribvals_text.csv /DAN:NumericAttrib:Entity /L:c:/outlineLoad.log /X:c:/outlineLoad.exc
NumericAttrib,Parent 
One,NumericAttrib
1,One 
2,NumericAttrib 

Example: Load Exchange Rates, add EUR as a member of the Currency dimension, and change the year in the .CSV file to match an existing year in the Planning application. The Exchange Rate table is created in the Planning application if it does not exist.

OutlineLoad /A:Test /U:admin /M /I:c:/outline1_rates.csv /DX:HSP_Rates /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
Table, To Currency, From Currency, Method, Historical, Beg Balance, Year, Period, Average, Ending

FX1 , USD, EUR, multiply, 1, 2, FY08, Jan, 3, 4
FX1 , USD, EUR, , , , FY09, Feb, 5, 6

Example: Set Weekly Distribution to Use 445

Account, Parent, Use 445
a11,a1,1

Example: Load a .CSV file that contains all of the properties available for a UDA. The UDA is loaded and associated with a dimension, but it is not assigned to any member in the dimension.

OutlineLoad /A:Test  /U:admin  /M /I:c:/outline1_uda.csv /D:UDA /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
Dimension,UDA 
Account,New2

Example: Load a .CSV file for Currency that does not specify the currency symbol. In this case, the symbol for this currency in the Planning application is set to the ISO symbol, EUR. The scale defaults to 1.

Currency,Parent,Symbol,Scale
EUR,,,

Example: Load a .CSV file for Currency that sets the symbol to the name of the new currency. The symbol is automatically set to NewCurr1 in the Planning application for currency NewCurr1. Currency names are limited to 8 characters.

Currency,Parent,Symbol,Scale
NewCurr1,,,

Example: Use the -f parameter with an encrypted password

If you have generated an encrypted password file, you can use -f as the first parameter in the command line to run the Outline Load utility without entering a password. For example, if you used the PasswordEncryption utility to create a password file called encrypt.txt, you could use this command line:

OutlineLoad -f:c:\encrypt.txt /A:acpt /U:admin /M /I:c:/outline1_accounts.csv /D:Account /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc

Example: /O parameter and .CSV load file order

In the following .CSV load file, if Entity members e1 and e2 already exist in the Entity dimension, e3 could be added as the last sibling, even though it is first in the load file. If /O is used, e3 is loaded as the first sibling. Because /O is the default, you must specify /-O to have e3 loaded as the last sibling.

Entity,Parent,Data Storage,TextAttrib
e3,Entity,Store,
e2,Entity,Store,
e1,Entity,Store,

Example: /H parameter and parent/child order

Assume that member e1 already exists, and A and B are new members being loaded. Without /H, an error would display because member B does not exist. With /H, members are sorted internally, so B is loaded first as child of e1, and then A is loaded successfully as child of B.

Entity,Parent,Data Storage
A,B,Store 
B,e1,Store

Example: /R parameter

If some members already exist in the dimension, only the members in the input load file should exist in the dimension after the load. If an error occurs during the load after the delete operation, all members of the dimension may be deleted, and the dimension may be empty. Attribute dimensions are not deleted. If a planning unit is started, no Entity members are deleted because the Entity member in the planning unit cannot be deleted.

Entity,Parent,Data Storage,TextAttrib
e1,Entity,Store,
e11,e1,Store,orange
e2,Entity,Store,
e21,e2,Store,
e11,e2,shared,yellow

Example: /T parameter

Load the Account dimension with /T to inherit plan types not explicitly specified in the load file from the parent when adding new members. Assume that member a1 already exists in the application and is valid for all three plan types. After the load completes, member a11 is valid for all three plan types, even though only Plan1 and Plan3 are specified in the load file.

Account, Parent, Source Plan Type, Plan Type (Plan1), Plan Type (Plan2), Plan Type (Plan3)
a11,a1,Plan1,1,,1

Example: /-T parameter

Load the Account dimension with /-T to force explicit setting of plan types for new members. Assume that member a1 already exists in the application and is valid for all three plan types. After the load, member a11 will be valid only for the Plan1 and Plan3 plan types specified in the load file, and not for Plan2.

Example: /TR parameter

OutlineLoad /A:acpt1 /U:admin /M /I:c:\outline1data.csv /TR /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
Value,Driver Member,Point-of-View,Data Load Cube Name
14,a1,"Jan,Local,e1,Current,Version1,FY08",Plan1
sl1_value2,a2,"Jan,Local,e1,Current,Version1,FY08",Plan1

Example: Load Smart List dimensions and Smart List dimension entries using the /DX:HSP_SMARTLISTS parameter.

OutlineLoad /A:acpt /U:admin /M /I:c:/smartlist_create1.csv /DS:HSP_SMARTLISTS /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
SmartList Name, Operation, Label, Display Order, Missing Label, Data Form Setting, Entry ID, Entry Name, Entry Label
SL1,addsmartlist,SL1Label,,,,,,
SL1,addEntry,,,,,,entry1,entrylabel1
SL1,addEntry,,,,,,entry2,entrylabel2

Example: Perform incremental data loads using the LINEITEM flag.

You can include a LINEITEM flag in the data load file to perform incremental data loads for a child of the data load dimension based on unique driver dimension identifiers. This specifies that data should be overwritten if a row with the specified unique identifiers already exists on the data form. If the row does not exist, data is entered as long as enough child members exist under the Data Load Dimension Parent member.

For example, when loading employee data, you can load budget line item detail for predefined Salary Grades. This example shows a command that could be used with a data load file that includes the LINEITEM flag.

OutlineLoad /A:pln1dv /U:admin  /M /I:c:\dataload_file.csv /D:”Budget Item”

This sample data load file loads data for the Budget Item dimension for children of Grade Changes.

"Budget Item","Data Load Cube Name","Point-of-View","Grade Step","Option Value","Start Date","End Date"
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step1","31721","7/1/09",""
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step2","32673","7/1/09",""
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step3","33654","7/1/09",""
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step4","33654","7/1/09",""

In this case, <LINEITEM("Grade Changes")> finds the first available member from Budget Item that is a child of the Grade Changes member, based on these unique identifiers selected in the Data Load Settings page: Grade Step, Option Value, Start Date, and End Date.

During data load, if any child members of Grade Changes already have data for Step1 and 7/1/09, the corresponding member is used to update the remaining data values. If not, the next available empty data row is assigned to Step1 and 7/1/09.

When the first data row is processed, the member Grade1 is assigned. Similarly, the next two members, Grade2 and Grade3 are assigned to the second and third data rows. When the fourth data row is processed, Step1 and 7/1/09 are already assigned to the member Grade1, so that row is used to update the value of the remaining fields.

Example: Import a planning unit hierarchy using the /Dparameter.

OutlineLoad /A:acpt /U:admin /I:c:\puh1.csv /D:PUH1

When using /D to import a planning unit hierarchy, you must specify the name of a planning unit hierarchy (not a dimension). The planning unit hierarchy must already exist in a Planning application before new members can be loaded into it.

Example: Export a planning unit hierarchy using the /E parameter.

OutlineLoad /S:planqe4 /A:acpt_580 /U:admin /M /E:puh_test2.csv /D:test2
Primary Member, Primary Enabled, Secondary Dimension, Secondary Parent, Relative Generation, Auto Include, Secondary Member, Include, Owner, Reviewers, Notifiees
e1, true, <none>, <none>, <none>, false, , true, <none>, admin, planner
e11, true, <none>, <none>, <none>, false, , true, <none>, <none>, <none>
e2, true, <none>, <none>, <none>, false, , true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, , true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a11, true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a12, true, admin, <none>, "admin,admin"
e21, true, Account, a1, 1, false, a13, true, planner, "planner2,admin", admin
e21, true, Account, a1, 1, false, a14, true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a15, true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a16, true, <none>, <none>, <none>
e21, true, Account, a1, 1-2, false, a111, true, <none>, <none>, <none>