WorkBook

Settings Export/Import

Use the Settings Export/Import submodule to export system and company variable settings to a file that can be imported into another WorkBook system. This functionality helps minimize the errors that may otherwise occur when settings are manually recreated.

To use the Settings Export/Import submodule, you must have access to Settings as defined in the Employee cross-company access submodule under Settings.

Overview

Many of WorkBook's customizations are based on system 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. System and company variables are managed under Settings.

You can export the system and company variables of any of your WorkBook systems, and import these settings into another WorkBook system. The import process overwrites any settings that are currently in the receiving system.

The 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 and Company Settings

The export process creates a file that contains the values of all system and company variables (for each company) of your source system. The export file is stored in the WorkBook server for a period of three months within which it can be retrieved through an equivalent import functionality.

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

Importing System and Company Settings

The import process allows you to retrieve the export file and use it to overwrite any current values of all system and company variables of the receiving system.

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

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

Limitations

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

Security

WorkBook implemented 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 manually edited or modified.
  • Only expired export files can be deleted.
  • An exception list is made 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.