2.11. Configuration Packages

The Configuration Packages tool allows you to transfer system configuration between different Nectainium environments (for example, between a test and a production environment). Using this tool, you can export system objects (attributes, document types, processes, templates, etc.) to a file, and then import them into another environment.

Note:

It is recommended to transfer configuration between environments with the same system version and the same set of extension packages to avoid compatibility errors.

---

To transfer configuration to another environment, complete the following steps:

• Create a configuration package — form a package by adding the system objects you want to export, then generate a configuration file.

• Import configuration — upload the generated file to the target environment and apply the configuration contained in the package.

2.11.1. Create a Configuration Package

1. In the navigation panel, select the Studio 1 workspace.

2. Select the Configuration Packages 2 shortcut group, then select the Configuration Packages 3 shortcut.

3. In the toolbar, select Create 4.

4. Fill in the fields using the hints from the table below.

   Field	Description
   Code*	Enter a unique code for the configuration package. The code must be short (typically up to 10 characters). Use only Latin letters and digits.
   Name*	Enter the name of the configuration package.
   Description	Optionally, enter a short description of the package contents.

   Note:

   Fields marked with * are required.

5. Go to the Contents tab, then select Add to Package to add system objects for export.

6. In the Object Type 1 field, select the type of object to add to the package, then select Next 2.

   Available object types:

   • Attribute Library — custom attributes
   • Process Library (latest version) — the latest version of the process definition along with forms (if any) and their attributes
   • Process Library (all versions) — all versions of process definitions along with forms (if any) and their attributes
   • Server Module Library — server scripts
   • Widgets
   • Work Schedules
   • Attribute Groups — a set of attributes grouped into a folder in the Attribute Library shortcut
   • Task Execution Actions
   • Trigger Actions — along with related entities (Triggers, Onboarding Scenarios)
   • AI Scenario Tools — please add a description and/or link
   • External Systems — integration settings
   • External APIs — API settings
   • Calendars
   • AI Models
   • AI Evaluation
   • Duplicate Document Control Rules — along with related attributes
   • Email Processing Rules — along with the email source and related attributes
   • Sensitive Data Criticality Levels
   • Pop-up Forms — along with form attributes
   • Onboarding Scenarios
   • AI Scenarios
   • Document Types — along with related entities (attributes, roles, states, processes, forms)
   • Triggers
   • Task Forms
   • Panel Forms
   • Document Templates
   • Email Templates
   • Report Templates
   • Import Templates
   • Search Templates
   • Daily Schedule Templates
   • Recognition Templates
   • Work Cycle Templates
   • Shortcuts — along with the attributes used in the shortcut

   Note:

   If an object contains related custom directories or classifiers, only their settings will be included in the package, without records.

7. Enable the toggles for the items 1 you want to export, then select Save 2.

8. After adding items, when you select an object type 1, the selected items will be displayed on the right side of the screen 2.

   Note:

   You can add multiple system objects to a single package. To add more, repeat steps 3–8.

9. To view the package contents in JSON format, go to the Raw Data 1 tab and review the field value 2.

10. After finishing adding items, select Generate File in the toolbar.

11. The generated file will display the object types 1, items, and their parameters 2. Make sure the file contains the required data.

12. Select Save File.

13. In the Name 1 field, enter the file name.

    Note:

    This field supports localization. Select the icon to add values in other languages, then select Apply.

14. In the Description 2 field, optionally enter a description for the file.

15. Select Save 3.

16. The Files tab will open. Select the icon next to the required file to download it.

The file in the format file-name.imex.json will be downloaded to your device. You can use it to import configuration in another environment.

2.11.2. Import Configuration

1. In the navigation panel, select the Studio 1 workspace.

2. Select the Configuration Packages 2 shortcut group, then select the Import Configuration 3 shortcut.

3. In the toolbar, select Create 4.

4. Select + to upload the configuration package file you created earlier.

5. If needed, in the Name 1 field, change the package name.

6. If needed, in the Description 2 field, change the package description.

7. Select Next 3.

8. The File Validation Result window will open, displaying the compatibility of the package with the current environment:

   • The Text column provides a description of the check.
   • The Criticality column displays the criticality level. If the Criticality column is empty, compatibility is acceptable and you can proceed with the import.

   Select Next to proceed to viewing the package contents.

9. Before confirming the import, you can review the package details on the following tabs:

   • By Types — displays the object types in the package.
     After selecting an object type A, the corresponding items are displayed B.
     For a selected item, the Attributes C tab displays its parameters.

   • Ordered A — shows all items in the package and their related dependencies that will also be imported B.
     For example: if an attribute that belongs to a group is imported, that group will also be imported.

   • Graph — displays the relationships between items as a graph. When you select an item, you can view its settings and code.

   • Raw Data — contains the full JSON of the configuration package.

10. If the result is satisfactory, select Apply File in the toolbar to complete the import.