Hierarchy Export

On the Home page, select Export.

Click

.

Select Hierarchy as the export type.

Optional: To create substitution parameters for the export:

Click .
Click Add and add Key-Value pairs.

Note:

Key-Value pairs cannot use "<%" or "%>" sequentially or an equal sign.
Click OK.

On the Source tab, select a version or version variable.

You can select Normal, Baseline, or As-Of versions. The Version list defaults to the Normal versions. To select a Baseline or As-Of version, click Normal under the Version list.

From Hierarchy Selection, select an option:

Top Nodes––Click Add, select a hierarchy, and select a node and then click OK. Repeat until all nodes are added.

Note:

Use the arrows to reposition the nodes, which determine the order in which hierarchy nodes are exported.
Hierarchy Group––Select a hierarchy group property and a hierarchy group.

Note:

You can use substitution variables for the hierarchy group property and the hierarchy group.
- Hierarchy Group Property––Select a hierarchy group property or select [Get Value from Parameter] and then select the parameter to use for the property.
- Hierarchy Group––Select a hierarchy group or select [Get Value from Parameter] and then select the parameter to use for the group.

On the Style tab, select from these options:

Node Selection — Determines which nodes (All Nodes, Limb Nodes Only, Leaf Nodes Only) are included in the export
Recurse from Top Node — Select to include output for all nodes below the top node. If cleared, only the top node is included. This option is useful when exporting a single record for each hierarchy selected.
Include Inactive Nodes — Select to include inactive nodes in the export.
Include Implicitly Shared Nodes — Select to include descendant nodes below shared limb nodes that are explicitly shared. Implicit shared nodes are exported only if not filtered out by another option.
- If a query filter is used in the export, the administrator must explicitly include the shared nodes. For example, the filter (#Children=0) must be changed to ((#Children=0 OR (Shared Node Flag = True)).
- For the implicitly shared node, Parent properties reflect the values of the actual node (the primary node). For example, if your export includes the Parent Node property for an implicitly shared node, it will show the parent as the primary node.
Remove Duplicates Based on Key — Select to use the primary key (defined on the Column Options tab) to suppress duplicate records from being exported.
Tabbed Output — Select to indent the nodes for each level of a hierarchy using tab characters to produce a structured output format.

In the Batch Validations section, select the type of validations to run.

Note:

Batch validations are performed only for the hierarchies and nodes included in the export. Validations are run before the export. If errors occur, the export stops.

None — No validations run.
Assigned — All validations assigned to the version, hierarchies, and nodes for the export run.
Selected — Click to select validations to run.

In the Repeat Parameters section, select from these options:

Repeat Number Property — References a local, node-level, integer property that repeats a node within an export structure. For example, given an A-B-C parent-child hierarchy, if a Repeat Num Property has a value of 2 for node B and a value of 1 for nodes A and C, then the export looks like A,B,B,C (node B is repeated twice).

Note:

When using Repeat Number Property , the value must be set to at least 1 for nodes to be included in the export results. It is recommended to set the Repeat Number Property default value to 1.
Bottom Level Property and Bottom Level Value — Determines the maximum depth of the export structure. This value can be defined as a hierarchy-level, integer property (Bottom Level Property) or as an absolute value (Bottom Level Value.)

If a bottom level is defined, the repeat options are enabled to automatically repeat nodes down to the defined level in the export structure. For example, for nodes A-B-C in a parent-child hierarchy, if the Bottom Level Value is defined as 6, node B has a Repeat Number Property value of 2, and the Repeat Bottom Leaf Node option is selected, then the export structure is A,B,B,C,C,C (the export structure is six levels deep, the leaf node C is repeated until level 6 is reached, and node B is repeated twice).

On the Filter tab, select from these options:

From Validation, select a validation to use to filter the export.
From Query, select a query to apply to the export, or, to define a query, click .
Use text file to include/exclude descendant nodes — Select if you have created a text file with nodes to be included or excluded from the export. The file format is a list of node names with one per line. Select a connection, enter a file name, and select whether to include or exclude the nodes from the export.

On the Columns tab, select the properties to display as columns in the export results and move them from Available to Selected.

For more information, see Export Specific Columns

Tip:

Use the Category list to select a property category to ease navigation. Use the up and down arrows to position the column in the Selected list. The first item in the list is the first column, the second item in the list is the second column, and so on.

On the Column Options tab, select from these options:

Pivot—If the property contains a comma-delimited list of values, a separate record is exported for each value with all other export columns set to the same values. The Pivot option may be selected on only one column.
Skip Defaults—To place a blank (empty string) or NULL (in output to database table) in the export if the field value equals the default value of the property
Primary Key—To define a field (or fields) as the primary key to be used when determining whether duplicates exist. (This is used by the Remove Duplicates option on the Style tab).
Dynamic Value––If you added a Dynamic Column, define the value for the column here. The value can be null or a combination of constant values and substitution variables.

On the Target tab, select the output type for the results:

Client File –– Download results via the browser.
Server File –– Use an external connection and save results to a network file system or an FTP directory.
Database Table –– Save results to a database table.

Perform an action:

If you selected to export to a Client File, choose options:
- Column Headings — Includes column headings in the export based on the labels of the selected properties.
- Quoted Strings — Puts quotation marks around each column value. Any existing quotation marks within the column value are doubled.
  
  For example,
```
=IF("ABC","XYZ",)
```
  changes to
```
"=IF(""ABC"",""XYZ"",)"
```
- Fixed Width — Allows you to specify field widths, left or right justification for the column, and number of pad characters. You can enter column information in the Fixed Width Option section.
- Character Encoding — Select one of the encoding options. Encoding applies to the output file and to the node include/exclude file if specified.
- Replace options — Select up to three characters from the lists to be replaced. All instances in the export are replaced as specified. For example, all commas can be replaced by tabs.
- Header/Footer — Add a line between the header/footer and the body or enter text to be printed on the header and footer of the export results. Enter lines of text into the text box or click to open a text editor.
  
  Note:
  
  You can insert customization tags to further enhance the readability of the export results. For more information, see Customization Tags.
- Delimiter options — To select a field delimiter character and a record delimiter character.
If you selected to export to a Database Table, you must set your connection and select the database table. You must have already created a valid external connection to a database for it to show up in the drop-down list. You can also select from these options:
- Clear table options
  - Do Not Clear Table — Appends to existing data in the specified table.
  - Clear Based on Version IDs — Deletes data in the table where the specified key field equals the current version ID of the data being exported. If this option is selected, a Key field must be specified in the Database Column Options section. When the export is run, all data in the table is first deleted where the Key field equals the current version ID of the data being exported. For the other Clear Table options, the Key field is ignored.
  - Clear All Rows — Deletes data from the table before writing the export output.
- Use Transactions — The export is performed within a database transaction and allows the entire operation to be rolled back if an export error occurs.
- Use Fast Appends — Performs a bulk insert operation into the target database table for improved export performance. Only available with a database-specific connection.
- Use Fast Deletes –– Performs a bulk delete operation on the target database table for improved performance. Only available with a database-specific connection.
- Database Column Options — Each column being exported must be mapped to a field in the external database table. Under Field Name, select the name of a field. If you selected Clear Based on Version ID(s), specify a Key field.
  
  Tip:
  
  The Length option can be left blank so that string lengths up to the database column declaration can be sent to the database.
  
  Note:
  
  The column must be the same data type as the database field to which it is mapped. For example, if a string property is mapped to a numeric database field, an error occurs.
If you selected to export to a Server File, you must set your connection and enter a file name. You must have already set up a valid external connection to a UNC or FTP file. You can also select from these options:
- Column Headings — Includes column headings
- Quoted Strings — Puts quotation marks around each column value. Any existing quotation marks within the column value are doubled.
  
  For example,
```
=IF("ABC","XYZ",)
```
  changes to
```
"=IF(""ABC"",""XYZ"",)"
```
- Fixed Width — Allows you to specify field widths, left or right justification for the column, and number of pad characters. You can enter column information in the Fixed Width Option section.
- Character Encoding — Select one of the encoding options.
- Replace options — Select up to three characters from the lists to be replaced. For example, commas can be replaced by tabs
- Header/Footer — Add a line between the header/footer and the body or enter text to be printed on the header and footer of the export results. Enter lines of text into the text box or click to open a text editor.
  
  Note:
  
  You can insert customization tags to further enhance the readability of the export results. For more information, see Customization Tags.
- Delimiter options — To select a field delimiter character and a record delimiter character

Do any of the following:

To save the export, click .

You are prompted to define a name, description, and an object access group for the export. Select a custom group or one of the following:
- User––Personal objects that are available only to an individual user to view and run.
- Standard––Public objects that are available to all users to view and run. Only Data Manager users can create and modify standard exports.
- System––Restricted objects that are available only to Application Administrator role users to view and run.
To validate the export, click .
To run the export, click .

If you selected to run validations on the Style tab, clicking performs the validations. Then, if no errors occur, the export runs. If validation errors occur, then the export stops and an error is displayed. Click for a list of validation errors.