Create or Edit an Export Template

While users with sufficient permissions can create and edit export templates, it is recommended that the system administrator verifies and tests them to make sure they work correctly. Export templates should be tested with one or two records on your development environment before using them on your production system.

The configuration options are the same for creating and editing export templates. The only difference is in how the Manage Export Template editor is opened.

Procedure

To create or edit an export template:

  1. Open the Export Template tab: Open the Feature Sidebar, open the Administration folder, open the Templates folder, and select Export Template.

  2. To create an export template, click the Add button in the Export Template tab’s Activity Bar. A new export template will be opened in the Manage Export Template editor tab. The Manage Export Template editor tab will initially contain only the Details page, however, after you enter the required fields in the Details page and click the Save and Continue button, the remaining Manage Export Template editor pages will appear and all the pages can be edited as described in the following steps.
  3. To edit an existing export template, select the export template and click the Edit button in the Export Template pane’s Activity Bar. The export template will be opened in the Manage Export Template editor tab.
  4. The Manage Export Template editor has three pages of configuration options: Edit the configuration options as desired. To save your changes to the export template, open the Attribute Mapping page of the Manage Export Template editor and click Save.

Details

Edit the configuration options as desired:

  1. Template Type: This field is not editable. It will be set to Export Template.
  2. Folder Name: (Required) This field can only be edited if this is a new export template. Select the export template folder you want to hold the export template.
  3. Name: (Required; Multi-language) The export template’s name.
  4. Description: (Optional; Multi-language) A description about the export template.
  5. Output Type: (Required) Select the desired format for the output file. If you select CSV, you can specify:

    • Field Delimiter: Indicates the delimiter used to separate attribute values. It can be any single character, including a digit.

    • Text Qualifier: A character that indicates the delimiter character should be processed as a character, not a delimiter. It is placed before and after a string that contains the delimiter character. If the text qualifier appears twice in a row, it indicates that it is to be processed as a character, not a text qualifier. For example, if the delimiter is a comma , and the text qualifier is a double quote " then the value: ,"3"" x 4"", Rough Cut" would be stored as: 3" x 4", Rough Cut.

  6. Validation Level: Select the minimum validation level that any record must meet to be included in the export.
  7. Root Repository: (Required) The primary repository that will be the source for content.
  8. Output File Alias Format Type: (Required) Reset -- you can add a suffix or prefix to distinguish atts with the same name from different repositories -- It will use the "short name" as the suffix or prefix.
  9. Advanced Callout Function: (Optional) Depending on system configuration, this option may or may not appear. It allows you to select a custom process to post-process the export. The list of Callout functions available depends on the Output Type selected. If an Advanced Callout Function is selected, additional configuration options may appear, according to which the Advanced Callout Function is selected.
  10. Advanced Callout Class Path: Depending on the Advanced Callout Function selected, this configuration option may or may not appear. It is the Java class path identifying the class that will be invoked to post-process the export.
  11. When you are finished editing the configuration options, click the Continue button to move to the Related Repositories page.

Related Repositories

The left side of the Related Repositories page contains a list of the root repository's link relationship's.

The right side of the Related Repositories page allows you to configure the output for the currently selected related repository.

For each related repository that has attributes you wish to include in the export template:

  1. Checking the checkbox to the left of a link relationship's name makes the link relationship's repository's attributes available to be included in the export template. To check the checkbox of a child link relationship, you must check its parent link relationship first. Once the child link relationship has been checked, you can uncheck the parent link relationship. To the right of the link relationship's name is a selector icon . You can click on it to select a link relationship without changing its checkbox. Expand the relationship tree to find the desired link relationship and check it. The linked repository's details will appear in the right side of the Related Repositories page
  2. Short Name: (Optional) You may enter an alias for the repository. This can be useful if you want to make a repository's name easier for users to read. This name will be used in this export template only.
  3. Split File Control: (Optional) If the repository has category attributes, if this is checked, a separate file will be generated for each taxonomy node. Each of the files will contain all global attributes, any attributes selected in the Current Columns column, and the node's category attributes. This setting overrides the Include All Category Attributes setting. An export template can only have this setting selected for one related repository.
  4. Include All Category Attributes: If this option is checked, all category attributes will be included in the output file. If the Split File Control option is selected, this setting will be ignored.
  5. Category:
  6. Select Attribute: This column contains a list of the repository's attributes that have not been included in the export template. The Attribute Filter dropdown list allows you to select an Attribute Filter if so desired. Current Columns: This column contains a list of the attributes that have been selected to be included in the export template. Select the desired attributes and use the arrow buttons to move them to the desired column.
  7. Define any images to be included in the export template in the same manner. For each image, select an Image Context, an Image Type, and an Image Priority, then click the left arrow to move it to the Selected Image Information column.
  8. Need Image Caption: Check this if image captions are to be included in the export template.
  9. Click the Continue button to continue to the Output File Layout page.

Output File Layout

The Output File Layout page is used to define the layout of the generated output file. Edit the layout options as desired.

  1. To modify the Column Alias for an attribute (the name that will appear at the top of the column in the output file), double-click the value and edit it inline.
  2. To change the order of the attribute columns in the output file, click and hold the icon to the left of an attribute's selection box and drag and drop the attribute to the desired order in the list.
  3. To save your changes to the export template, click the Save and Finish button.