Generate Import/Export Template Widget

Use the Generate Import/Export Template Widget

The options that appear in the Generate Import/Export Template widget will vary depending on the user’s permissions and how the Widget was configured by the administrator.

To use the Generate Import/Export Template widget to create an empty file for importing data into a repository, edit the available configuration options:

• Template/Preference: Select either:

  • The Import Template that will be used to define the global attributes that will be included in the file and that also defines the set of Category Attributes that are available to be included.

  • The Preference to use when generating the file. If a Preference is specified, the only Category Attributes that will be presented for inclusion are those that are in the Preference.

• Output Format: The format of the file:

  • CSV: Comma Separated Values

  • Excel Workbook (xlsx)

  • Excel Workbook (xlsx) with Format: Regarding the file generated:

    • The columns of required attributes will be highlighted.

    • A worksheet named Lists will display any Code Sets.

    • Attributes of type Code Set will display dropdown menus for user to select a value from the Code Set.

  • Excel 97 - 2003 (xls)

• File Split By Category: If selected, if Category Attributes are to be included in the generated file, instead of generating one file that lists all the Category Attributes from all the selected Taxonomy nodes, a separate file is generated for each Taxonomy node. Each file will include all specified global attributes and only those Category Attributes that are assigned to the Taxonomy node.

  For example, if there are four different nodes that each have ten Category Attributes (with no overlap), not setting this option would produce a file with all the selected global attributes and 40 Category Attributes. If the File Split by Category option is set, four files would be produced, one for each node, that contain all the specified global attributes and the ten Category Attributes associated with that node.

• Include Category Attributes from Taxonomy selection panel: This is used to define the list of Category Attributes that will be included in the file. Select one or more Category Attributes and use the right arrow button and left arrow button to move them between theAvailable Attributes list (on the left) and the Include Category Attributes from Taxonomy list (on the right).

To generate the file, click the button appearing at the bottom of the widget. The label on the button is configurable by the administrator, so it may not say Generate Template like it does in this example.

Configure Import/Export Template Widget

To configure a Generate Import/Export Template widget:

1. Configure a new blank widget. For more information about adding and configuring new widgets, see Add a Widget.

2. Select the Settings icon in the upper right of the new widget’s Activity Bar. Note that a widget’s Activity Bar will not be displayed unless the cursor is hovering over the top of the widget. A Configuration window will appear.

3. Select Generate Import/Export Template from the Type dropdown list on the far right of the Widget Configuration window. The Generate Import Export Template configuration options will appear.
4. The Generate Import Export Template configuration options are:

   • Title: The title of the widget. It is helpful if the title of a widget reflects the source of the data as well as the widget’s type, for instance "Generate Import Export Template".

   • Repository: The repository the file will be generated for.

   • Preference: The Preference to use when generating the file. If a Preference is specified, the only category attributes that will be presented for inclusion are those that are in the Preference.

   • Output Format: The format of the file:

     • CSV (Comma Separated Values)

     • Excel Workbook (xlsx)

     • Excel Workbook (xlsx) with Format: Regarding the file generated:

       • The columns of required attributes are highlighted.

       • A worksheet named Lists displays any Code Sets.

       • Attributes of type Code Set will display dropdown menus for user to select a value from the Code Set.

     • Excel 97 - 2003 (xls)

   • Template: The Import Template that will be used to define the global attributes that will be included in the file and that also defines the set of Category Attributes that are available to be included.

     Note: If a Preference is specified in the Preference option, the selected Preference acts as a filter. Only category attributes that are in both the selected import template and the selected Preference will be presented for inclusion in the generated file.

   • File Split By Category: If selected, if category attributes are to be included in the generated file, instead of generating one file that lists all the category attributes from all the selected Taxonomy nodes, a separate file is generated for each Taxonomy node. Each file would include all specified global attributes and only those category attributes that are assigned to the Taxonomy node.

     For example, if you have four different nodes that each have ten category attributes (with no overlap), not setting this option would produce a file with all the selected global attributes and 40 category attributes. If the File Split by Category option is set, four files would be produced, one for each node, that contain all the specified global attributes and the ten category attributes associated with that node.

   • Show Taxonomy in Widget: If selected, the Include Category Attributes from Taxonomy Node selection panel will appear on the widget and the user will be able to select which category attributes to include in the generated file. If it is not checked, the user will not be able to change the list of category attributes to be included in the file.

   • Download Button Label: The label to be used in the widget’s button that triggers the generation of the file.

   • Include Category Attributes from Taxonomy selection panel: This is used to define the initial list of category attributes the user will be able to select for inclusion in the file if the Include Category Attributes from Taxonomy box is selected.

     

5. Click Apply to save the changes to the widget and close the Configuration window. Click Cancel to close the Configuration window without saving the changes.

6. If you want your Dashboard configuration to remain after you switch tabs or log out, click the Save Layout button on the Dashboard's Activity Bar, otherwise your Dashboard will revert to its last saved configuration.