Importing Configuration Packs

A configuration pack import and implementation include the following stages:

1. Uploading a configuration pack to another instance.
2. Preparing a configuration pack.
3. Processing collisions (if any).
4. Deploying a configuration pack.

caution

The result of implementation depends on the Protection policy of VCS records in the configuration pack and on the target instance.

Upload a configuration pack

---

Before importing records for a custom application, ensure that a relevant application is implemented in the target instance or that the configuration pack contains the application VCS record.

Details

How to import custom applications

If there is no relevant custom application on the target instance, complete the steps below to import it:

1. Navigate to Configuration → Applications.
2. Find the application record using the list search or the condition builder and open it.
3. In the Related Lists area, select the VCS Record tab.
4. Open a relevant record (with the selected Is current checkbox). The application will be imported to the target instance even if the Action type of the VCS record is Update.
5. In the VCS Record form, select the necessary local pack in the Local pack field.
6. Click Save or Save and exit.

To import a local pack, complete the steps below:

1. Navigate to Configuration → Retrieved Packs.

2. Click New to create a new configuration pack.

3. Upload a SOP file by clicking the attachments icon .

   note

   If you attach more than one SOP file to a retrieved pack record, only the records from the last file will be imported. The previously attached packs will be ignored.

   If you uploaded records from a wrong SOP file, re-upload a SOP file without creating a new retrieved pack. To do so, follow the steps below:

   1. Click the attachments icon .

   2. Click Upload from your device and upload the file you need.

   3. Click Reload pack.

      As a result:

      • The VCS Preview Log related list has been cleared from the previously uploaded records.

      • The records from the new file are loaded.

   4. Click Import pack to complete the import.

4. Click Save to apply the changes.

5. Click Load pack to load records from the attached SOP file to the temporary Retrieved Records table.

caution

It is impossible to edit the Retrieved Pack records. Only admin users can read and delete the Retrieved Pack records if they are not in the Committed state.

Retrieved Pack form fields

Field	Mandatory	Description
Name	N	The retrieved pack name. This field is populated automatically with the name of the attached SOP file.
State	Y	The state of the current configuration pack. Available options: New Previewed Loaded Committed
Inserted	N	A number of records in this pack with the Insert action.
Updated	N	A number of records in this pack with the Update action.
Deleted	N	A number of records in this pack with the Delete action.
Warning	N	A number of the VCS Preview Log records in the Warning state.
Skipped	N	A number of the VCS Preview Log records in the Skipped state.
Collisions	N	A number of the VCS Preview Log records in the Collision state.
Total	N	The total number of records.
Description	N	A retrieved pack description taken from the SOP file attached.
Committed at	N	The date and time when the configuration pack was applied (its state changes to Committed).
Loaded at	N	The date and time when the record implementation was completed.

As a result:

• The current Retrieved Pack record has an attached SOP file.
• The following fields are populated automatically: Inserted, Updated, Deleted, Warning, Skipped, Collisions.
• The state is Previewed.
• The related list contains the VCS records located in this retrieved pack.

Prepare a configuration pack

---

The Retrieved Records (sys_vcs_retrieved_record) table contains records related to the configuration pack to be imported. The retrieved records are temporary items. The VCS Preview Log displays whether a record causes a collision.

caution

You cannot create records in the Retrieved Records (sys_retrieved_record) table. Only users with the admin role can read, delete records, and edit the JSON Copy field.

When a SOP file is uploaded, you can check the records that will be transferred to your instance. In the Retrieved Records tab, you can find all records loaded from the configurations file. It is possible to filter out the records by state in the Retrieved Records related table.

To preview the configuration pack, complete the steps below:

1. Ensure that the state of the Retrieved Pack record you need is Previewed.
2. In the Related Lists area, select the Retrieved Records tab.

Retrieved Record form fields

Field	Description
Table name	The target table system name in which this record version should be created.
Record	The target record ID for which the current record is created.
Created by	A reference to the user who created the initial record version.
JSON Copy	The record version in the JSON format.
Is strong overwrite	When selected, the current record will be written over the existing version after import.
Action	A transaction type. Available options: Insert Update Delete
Retrieved Pack	A reference to the retrieved pack containing the record version.

VCS Preview Log

---

After loading a SOP file into a retrieved pack record, some VCS records may cause errors, for example, when records for table N on the target instance have a different set of columns.

caution

You cannot create records in the VCS Preview Log (sys_vcs_preview_log) table. Only users with the admin role can read and delete them. Admin users can also edit the State field.

To check if there are any collisions, complete the steps below:

1. Open the Retrieved Pack record you need.
2. In the Related Lists area, select the VCS Preview Log tab.
3. Filter out records with the Good state using the condition builder.
4. If the selection has any records, process them. Repeat the procedure if needed until all necessary records in the VCS Preview Log tab are in the Good state.

tip

If a pack contains records that should not be imported, change the State field value to Skipped.

VCS Preview Log form fields

Field	Description
Local pack	A reference to the local pack containing this preview log record.
Retrieved pack	A reference to the configuration pack containing this preview log record.
Document record	This ID stores the table name and target record ID for which the current record is created.
Record policy	The attribute responsible for the record protection policy. See the Configuration Packs article for more information. Available options: Open Changed Protected
State	The preview log record state. Available states: Good – this configuration pack version will not cause import conflicts. Skipped – this version importing was skipped within the whole import process. Warning – this version cannot be applied partially or entirely. Collision – this version with this state cannot be imported due to critical system conflicts. Allowed – this state is similar to the Good state. The state is set to version after rollback operations (in the Preview Log related list).
Action	The type of action that initiated the object version. Available options: Insert Update Delete If a record with the Update action is absent on the target instance, then it is imported with the Insert action (the new record is created instead of updating the existing one).
Table name	The table system name for the target record.
Record	ID of the target record for which the action has been executed.
JSON copy	The record version data in the JSON format as an associative array. This array stores the object of the target record in a relevant state after the action done. JSON copy contains an array for the Update and Insert actions. If the action is Delete, the JSON copy field is empty.
Message	This field contains the error information in case of collision. The field is populated in case the state is Warning, Skipped or Collision.

Deploy a configuration pack

---

To implement the configuration pack, complete these steps:

1. Double-check record states in the VCS Preview Log related list.
   • Records in the Good and Warning states will be implemented.
   • Records in the Collision and Skipped states will be ignored by the system.
2. Click Import Pack.

As a result of import:

• A new VCS Local Pack record is created on the current instance.
• All versions created on the previous stages are copied into this local pack.
• All records in this local pack have the Is current checkbox selected.
• All records from this local pack are created on the target instance in relevant tables.
• Temporary records from the Retrieved Records table are deleted (related list in the VCS Retrieved Pack record).
• The Retrieved Pack record state changes to Committed.
• The date and time of this operation are displayed in the Committed at field.

Platform update

---

When a new version of SimpleOne platform is implemented, the system creates a snapshot of the records inserted during the update migration. These records are stored in a separate local pack, having the following fields populated automatically:

Field	Value
Name	Simple Application {platform version} (Migrations) {platform version} stands for a version number, such as 1.8.0
Description	Created by the system
Completed by	System User
Application	Simple
State	Completed