WorkBook

Settings Export/Import

Use Settings Export/Import in the Advanced Tools submodule in the Settings module to export System Variable and Company Variable settings to a file that you can import into another WorkBook system. This functionality helps to minimize the errors that can otherwise occur when you recreate settings manually.

To use Settings Export/Import, you must have access to Settings as defined in Employee Cross-Company Access under Settings.

Overview

Many of WorkBook's customizations are based on System Variables and Company Variables. These variables control what your users can and cannot do within a module or submodule. Examples include allowing data import, allowing the manual editing of payment data, and customizing workflows. You manage System Variables and Company Variables in the Settings module.

You can export the System Variables and Company Variables of any of your WorkBook systems, and import these settings into another WorkBook system. The import process overwrites any settings in the receiving WorkBook system.

This export/import functionality can be useful when you want to:
  • Test implementations and configurations in a UAT or testing environment before setting up a production environment.
  • Test new configurations in preparation for a new release or a change in your business process.

Prerequisites

To perform the export/import:
  • You must have System Administrator access.
  • You must have a valid WorkBook License (valid and verified WorkBook Subscription Key).

Exporting System Variable and Company Variable Values

The export process creates a file that contains the values of all System Variables and Company Variables (for each Company) in your source WorkBook system. The export file is stored on the WorkBook server for three months, within which time you can retrieve it through an equivalent import functionality.

You perform the export process via Settings > Advanced Tools > Settings Export/Import > Settings Export tab.

Importing System Variable and Company Variable Values

The import process enables you to retrieve the export file and use it to overwrite the values of all System Variables and Company Variables of the receiving WorkBook system.

WorkBook performs validation checks based on the Company name, Company initials, and Company active/inactive status, among others.

You perform the import process via Settings > Advanced Tools > Settings Export/Import > Settings Import tab.

Limitations

Note the following limitations:
  • You can import settings from an older WorkBook version into a newer one or vice versa. However, a setting is not imported if it does not exist in the receiving WorkBook system.
  • The source and receiving WorkBook systems' Company initials must match. Otherwise, System Variables and Company Variables whose Company initials do not exist in the receiving Ccompany are not imported.
  • The settings export/import functionality excludes the import of system-specific settings and settings that relate to sensitive or encrypted information. You must manually update each setting after you perform an import. For more information, see System Variables Exception List.

Security

WorkBook implements the following restrictions to ensure that your export data is secure:
  • Export files are valid for a limited period of time.
  • Export files cannot be accessed outside WorkBook.
  • Export files cannot be edited or modified manually.
  • Only expired export files can be deleted.
  • An exception list is created to prevent moving sensitive data (such as passwords and certificates) and system-related System Variables (such as Storage Provider ID, Job IDs, and Resource IDs) back and forth. For the complete list, see System Variables Exception List.