Importdimension: Planning Command Utility operation

Updated: 2009-04-30

Use the importdimension command to import dimension members from a CSV formatted file.

Note

You must be a member of the modeler role to use this command.

Important

Members that have existing Member IDs are not imported.

Syntax

ppscmd importdimension [switches] file [files]

Parameter	Required?	Description
/server <ServerUri>	No	Specifies the server URI to connect to. The defaults are those used by Planning Business Modeler.
/application <AppLabel>	No	Specifies the application to open. The defaults are those used by Planning Business Modeler.
/site <SiteLabel>	No	Specifies the model site to open. The default is the Modeler default model site.
/dimension <DimLabel>	Yes	Specifies the dimension object to be imported.
/hierarchy <HierarchyLabel>	No	Specifies the hierarchy object to be imported. If /hierarchy is not specified, members will be imported to the All Members hierarchy of the dimension.
/encoding <FileEncoding>	No	Specifies file encoding for the CSV file. The default is UTF8.

The following flags provide additional instructions to the server when used with the importdimension command.

Flag	Description
/OverrideExistingMember	Overrides existing objects when importing a CSV file. This flag will set the first occurrence of a duplicate label to override the values in the system. If there are duplicates in the file, they will not override each other. Duplicates will be skipped.
/CreateNewProperty	Creates new member properties when importing CSV file. This flag does not support member of dimension property type, unless the member property has already been created through Planning Business Modeler. It is also not applied if the /IgnoreExtraColumns flag is used. When creating a new property, the property will always be created as a string data type, unless specified otherwise in the CSV file. Empty values will be set for all existing members.
/IgnoreExtraColumns	Ignores extra columns in the CSV file.

None

The following command-line examples show the use of the importdimension command.

ppscmd importdimension /app app1 /site site1 /dim dim1 myfile.csv

ppscmd importdimension /app app1 /site site1 /dim dim1 /hierarchy h1 myfile.csv

Use the following CSV file format.

Column	Description
Label	Required. The Member Label. The first column of the CSV file must be the Label column. At a minimum you must always have columns values for Name and Label. Each other header name should correspond to a member property header in the dimension. If there are multiple labels in the list, the first one will be imported and all others will be skipped.
Parent	Optional. The Member Label for this member for parent-child relationships in a member set.
Description	Optional. Description of the member.
Name	Required. Name of the member.

Example:

Label	Parent	Description	Name
Member1		Member1	Member1
Member2	Member1	Member2	Member2

File encoding can be ISO-8859, UTF8, UNICODE, or ASCII. Use ISO-8859 for 8-bit character encoding.

This topic is included in the following downloadable book for easier reading and printing: