Skip to content

Manage DbIo Templates

Jump to bottom
lat9 edited this page Apr 22, 2025 · 1 revision

This section describes how to use the Configure DbIo Templates tool, available via click of the "Manage Templates" button from Tools :: Database I/O Manager when the currently-selected handler supports export templating.

The DbIo's templating support allows you to choose a subset of the fields provided by the currently-selected handler for a customized export and subsequent import. There are a couple of pre-defined templates for the Products handler that will give you an idea of what you can do with this feature.

Listing Display

On initial entry to the DbIo template-manager, the templates for the currently-selected handler are displayed. The following information is displayed for each:

  • Scope. Indicates whether the template is Public — available for all authorized admins — or Private — available only for the currently-logged-in admin's use.
  • Template Name. Contains the "name" of the template; the value must contain only alphanumeric and underscore (_) characters, since the value is used to form a portion of an exported CSV file's name when the export is performed with the template.
  • Description. Contains a text-blob (no HTML allowed) that you can use to remind yourself of the purpose of this template. When you select the template in the Database I/O Manager's export section, this description is displayed.
  • Last Updated By. Identifies the name and ID of the admin who last updated the template; the value displays as System for any pre-defined templates.
  • Last Update Date. Identifies the date and time of the templates last update.

template_listing

Create or Edit a Template

When you create or edit a DbIo template, a page similar to the following is displayed. Within this page, you identify the scope, name and description of the template and then use the Choose Template Fields block to select the fields to be included in a template-based export as well as the order that those fields will appear in the output .CSV file. Some features of that section are:

  1. Each of the multi-select dropdown lists can be stretched vertically to allow you to view all associated fields.
  2. If the handler supports an import action on the generated CSV, there might be some "key" fields that are required; these are pre-filled into the right-side block and are required fields.
  3. Use the left- and right-arrows to move fields between the left-side (all available fields) and right-side (your customized fields) blocks.
  4. Use the up- and down-arrows to order the fields within the customized-fields' block.

new_template

Copy a Template

When you copy an existing template, you can change the template's scope and/or name but the name you choose must be unique within its scope. This feature allows you to make a private copy of a public template and further customize it for your use. You can also make a public copy of a private template that all authorized admins can use.

copy_template

Clone this wiki locally