Hierarchy Extracts definition

The Hierarchy Extracts tab is where you create and manage all your hierarchy extract definitions. Creating a hierarchy extract definition tells the system what to extract, which members to include, and how to format the output. You'll see a list of definitions you've already set up, and you can select one to review or edit. Each definition has three selection panels: 

• Select Dimension for Name of Hierarchy Extract — This panel enables you to select your dimension to extract.
• Members for Name of Dimension — After selecting the dimension, you can choose which members to include for your hierarchy extract.
• Extract Details — This section lets you choose what properties to extract, include parent/child paths and keys, exclude shared dimensions, and set the order.

You finish all your definition work on the Hierarchy Extracts tab before running the extract through a separate workflow task.

Select the Models module from the Navigation pane, then select the Hierarchy Extracts tab. Any definitions you've created before will show up here. 

You can create a new hierarchy extract definition or modify an existing one. You can only select one dimension per definition. 

1. From the Hierarchy Extracts tab, next to Select hierarchy extract, select the Add hierarchy extract icon.
2. In the Hierarchy Extract Definition Name dialog, enter a name for your definition, then select OK.
3. In the Select Dimension for [Definition Name] section, select Manage included dimensions.
4. Select the dimension you want to extract from the list.

Specify which members of the selected dimension you want to include in the extract.

• You don't have to include the entire hierarchy - pick only the members your target system needs. For example, don't select the statistical accounts for the Accounts dimension. 
• This lets you send a partial hierarchy rather than the entire hierarchy. 

Select the members:

1. In the Manage for [Dimension Name] section, select Manage members.
2. The Manage members panel will appear. You can either select all members or choose specific members from the hierarchy.
3. For each selected member, you can specify whether to include or exclude it from the extract using the Include and Exclude tabs.
4. Choose which related members to include in the extract based on their relationship to the selected member.

5. Choose Select.

In the Extract Details section, specify the format and options for the extract. 

The Properties tab loads all of the dimension's properties. Select the properties to include in the extract. 

Select the Options tab to make the selections required by your downstream system:

Choose your output order:

In the Extract Details section, select the Order tab. Select an option:

• Hierarchy tree order — Outputs members in the same top-down order you see them in Hierarchy Manager in Financial Consolidation and Reporting. 
• Parents before children — Outputs all parent members before child members. Use this when the target system needs to create a parent record before it can create child records underneath it.

After configuring all the options, select the Save icon on the toolbar to save the definition. The definition becomes available for selection when you build a Hierarchy Extract workflow task. You can edit the definition at any time.

If you need to migrate a hierarchy extract definition to another tenant, once your hierarchy extract definition is complete, you can export it. The export file is in JSON format. Don't edit it. 

Once you save your definition, run the extract using a Workflow Task. In the workflow designer, find the Hierarchy Extract task type under the Application section of the Task Toolbox and configure it.