Importing and Exporting Templates

Note:  Users with the user roles listed to the right must also have the Template Access user role.

Accolade provides Administrators and Process Designers the ability to export templates configuration from one Accolade environment and import them into another Accolade environment. For example, your company may have separate test and production environments or company branches hosted in separate Accolade instances. Instead of having to recreate templates in each environment, download the information and import into a different environment.

The download exports the templates configuration into a spreadsheet file with the information grouped into the following tabs within the file:

• Template Details
• Security

To export template settings:

1. From the System menu, select Page Design > Template Library.
2. Select the templates that you want to download.

To narrow the list by template name or system name, add the criteria to filter by in the appropriate filter text box. These filters are case insensitive.

To narrow the list by category, select a category to display in the Category list. To download all templates, select All.

3. Click Download in the top right corner of the page.

Accolade downloads the templates into a zip file which contains a workbook file with all of the template system details, as well as an individual file folder containing each template document, and saves it to a temporary internet files directory. Save the file to a more accessible location.

Note:  Only components to which you have view and/or edit configuration access group rights will download. Components you can only view may be included in the file, but you can only upload changes to areas to which you have explicit edit permission.

To import template settings into Accolade:

1. Ensure the data within the spreadsheet meets the requirements for a successful import.
2. Remove any templates that you do not want to include in the upload from the spreadsheet and save the file.
3. From the System menu, select Page Design > Template Library.
4. Click Upload in the top right corner of the page.
5. Click Load File and select the spreadsheet file to load.
6. Click Upload File.

Accolade uploads the changes to the existing templates in the spreadsheet, and adds any new templates with unique system names.

7. (Optional) Click Print to print the import results for your records.

Note:  Components that are imported are subject to group configuration rules. The user may assign components in a way that the configuration access groups are not consistent. This behavior is not allowed in the UI, and mismatches in either the user's access rights or the component's access group restrictions may result in warning or error messages during the upload, and may result in an incomplete upload.

Template Settings Included in the Spreadsheet File

The columns in the downloaded spreadsheet include the system settings for each template in the order listed below. For a description of each template setting, see Adding Templates to the Template Library.

Important! Using the import and export tools to update configuration can result in unintended changes if information is missing or creates an error during the import process. Sopheon recommends reviewing Importing and Exporting Configuration Components Best Practices before making changes in a production environment.

• Template Details

   

  Column Name	Accepted Values on Upload*	Additional Notes
  Template System Name	Alphanumeric characters, underscore**	Used for matching in the upload. If a template exists, its settings are changed with the values in the uploaded file. If a new, unique system name exists in the file when uploaded, a new template is created.
  Template Name	Any	If blank, the template does not upload.
  Category	Alphanumeric characters	If a new, unique category name exists in the file when uploaded, a new category is created. If left blank, the template is placed in the Default category.
  Description	Any	Can be blank.
  Type	Online Form Process Document Spreadsheet Report Presentation Project Plan Image PDF, Email, Other	If blank, the template does not upload.
  Delete	Yes, Y, True, 1, X*	All other values are treated as No on upload.

  * For any column that accepts Yes, Y, True, 1, or X, you can also enter No, N, False, or 0 if it helps you when entering data in the spreadsheet. All values other than Yes, Y, True, 1, or X are treated as No when you upload the spreadsheet.

  ** Limited to characters between a - z, A - Z, and 0 - 9, and the underscore ( _ ).

   

• Security

   

  Column Name	Accepted Values on Upload	Additional Notes
  Template System Name	Alphanumeric characters, underscore**	Used for matching in the upload. If a template exists, its settings are changed with the values in the uploaded file.
  Access Group	Valid access group system name	Include a separate row for each access group.

  ** Limited to characters between a - z, A - Z, and 0 - 9, and the underscore ( _ ).