Create or Edit a CSV, XLS, XLSX, JSON or XML Export Template - Precisely_EnterWorks - EnterWorks - 11.0

Create a template

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. The Export Template tab will open.

2. The export template folders are listed at the top of the list of templates. Select the folder you want the template to be created in. The list of templates in the folder will be displayed.

3. 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.

4. The Details page will appear. Edit the settings as described in Details.

5. After you are finished enter the fields in the Details page, click the Save and Continue button.

6. The remaining Manage Export Template editor pages will appear. Edit them as described in:

   • Related Repositories

   • Output File Layout

   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.

7. Export templates are securable objects and must be made accessible to the groups that need to access them. Define security for this template: Define Access to Securable Objects.

Edit an existing template

1. 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.

2. The Manage Export Template editor has three pages of configuration options:

   • Details

   • Related Repositories

   • Output File Layout

   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.

3. Export templates are securable objects and must be made accessible to the groups that need to access them. If you need to update security for this template, do so: Define Access to Securable Objects.

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 of the export template.

5. Output Type: (Required) This field can only be edited if this is a new export template. Select the desired format for the output file: XLS, XLSX, CVS, JSON, or XML.

6. Validation Level: Select the minimum validation level that any record must meet to be included in the export.

7. Root Repository: (Required) The root repository that will be the source for content. This field can only be edited if this is a new export template.

8. Output File Alias Format Type: (Required) By default, the attribute's name is used as the name of the attribute's column in the output file, but you can specify an alias to be used instead. You can the Output File Alias Format Type setting allows you to generate alias names by appending the short name of an attribute's repository to the attribute name. This is useful to distinguish between attributes with the same name from different repositories.

   • Prefix: The repository's short name will be added before the attribute's name.
   • Suffix: The repository's short name will be added after the attribute's name.
   • None: No prefix or suffix will be appended to the attribute's name.

   If this is not a new export template, this setting will be grayed-out. To edit this setting, click the Reset button. A warning will appear that asks you to confirm that you want to reset all existing column aliases. If you select OK, you will be allowed to change the Alias Format Type.

9. If you selected CSV as the Output Type, 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.

10. 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.

11. 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.

12. 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 want 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 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. 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.

3. 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.

4. Category: This allows you to filter the attributes based on their category. If you select a category, that category's category attributes will be displayed in the Select Attribute list.

5. 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 menu allows you to select an Attribute Filter if so desired. To include attributes in the export, select them and use the right-arrow button to move them to the Current Columns list.

6. Current Columns: This column contains a list of the attributes that have been selected to be included in the export template. To exclude attributes from the export, select them and use the left-arrow button to move them to the Select Attribute list.

7. The Add Image Information list allows you to select an image to be included in the export. For each image, select an Image Context, an Image Type, and an Image Priority, then click the right-arrow to move it to the Selected Image Information column.

8. The Selected Image Information list contains the list of images that will be included in the export. To exclude an image from the export, select it and use the left-arrow key to remove it from the Selected Image Information list.

9. Need Image Caption: Check this if image captions are to be included in the export template.

10. 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. If you move off the Output File Layout page before clicking the Save and Finish button, your changes will not be saved.

1. To modify the Column Alias for an attribute (the name that will appear at the top of the column in the output file):

   • To manually edit a Column Alias, double-click the attribute's Column Alias cell and edit the value inline.
   • To automatically generate the Column Aliases based on the Output File Alias Format Type, click the Autofill Aliases button at the bottom of the screen.
   • To remove all Column Aliases, click the Clear Aliases button at the bottom of the screen.

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 restore the Output Layout page settings to the values they had when you began editing the template, click the Reset button at the bottom of the screen.

4. To save your changes to the export template, click the Save and Finish button.