Importing configuration packs

In SimpleOne, you can implement updates and applications to other instances using configuration packs and .SOP files.

To import a prepared local pack, use the following elements:

Retrieved Pack – contains a .SOP file to upload to an instance from another source. Here, you can find all necessary records for implementing a configuration pack. Operate configuration pack import from a retrieved pack record.
VCS Retrieved Record – contains records from the .SOP file. Retrieved records are temporary records equal to VCS records from the uploaded configuration pack. Once the import is completed, these records are deleted.
VCS Preview Log – provides information about implementation results before importing the configuration pack into the instance. Previewing log records warns you about possible collisions and helps to fix them.

Local pack import and implementation include the following important stages:

Uploading a configuration pack.
Preparing a configuration pack.
Processing collisions (if there are any).
Deploying a configuration pack.

Please note that the result of implementation depends on the Protection Policy of VCS records in the local pack and on the target instance.

Uploading a configuration pack

If you are importing records for a custom application, make sure that the relevant application is implemented in the target instance or that the local pack contains the application VCS record.

If the target instance does not have a relevant custom application, import it by performing the steps below:

Navigate to Configuration → Applications.
Find the application record using the list search or the Condition Builder and open it.
Scroll down to the Related Lists area.
In the VCS Record tab, open a relevant record (with the Is Current=true).
In the VCS Record form, select the local pack you need in the Local Pack field.
Click Save or Save and Exit.

To import a local pack, please complete the steps below:

Navigate to Configuration → Retrieved Packs.
Click New to create a new configuration pack.
Upload a .SOP file by clicking on the attachments icon.
Please note that if you attach more than one .SOP file to a retrieved pack record, then records only from the last file will be imported. Packs attached earlier will be ignored.
If you have loaded records from a wrong .SOP file, and you need to re-upload a .SOP file without creating a new retrieved pack, perform the following steps:
Click on the attachments icon.
Click Add files and upload the file you need.
Click Reload pack.
As a result:
The VCS Preview Log related list has been cleared from previously uploaded records.
Records from the new file are loaded.
Complete the import by clicking Import pack.
Click Save or Save and Exit to apply changes.
Click Load pack to load records from the attached .SOP file to the temporary Retrieved Records table.

You cannot edit Retrieved Pack records Only users with the admin role can create and read records. Admin users can also delete them if the Retrieved Pack record is not in the Commited state.

Retrieved Pack form fields

Field	Mandatory	Description
Name	N	Retrieved pack name. This field is populated automatically with the attached pack name.
State	Y	State of the current configuration pack. Available options: New Previewed Committed.
Application	N	Specify the application within which the pack should be imported.
Inserted	N	Number of records in this pack with the Insert action.
Updated	N	Number of records in this pack with the Update action.
Deleted	N	Number of records in this pack with the Delete action.
Warning	N	Number of the Preview Log records in the Warning state.
Skipped	N	Number of the Preview Log records in the Skipped state.
Collisions	N	Number of the Preview Log records in the Collision state.
Total	N	Total records number.
Description	N	Retrieved pack description, taken from the SOP file attached.
Committed at	N	The date and time when the configuration pack has been 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.
Related tables contain records.

Preparing a configuration pack

Retrieved Records

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

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 the .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. The Retrieved Records related table allows you to filter records out by state.

To preview the configuration pack, complete the steps below:

Make sure that the state of the Retrieved Pack record you need is Previewed.
Scroll down to the Related Lists area.
Click on 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	Reference to the user who created the initial record.
JSON Copy	Record version in JSON format.
Is Strong Overwrite	When selected, the current record will be written over the existing version after import.
Action	Transaction type. Available options: Insert Update Delete.
Retrieved Pack	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 some errors, for example, when records for table N on the target instance have a different set of columns.

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, perform the steps below:

Open the Retrieved Pack record you need.
Scroll down to the Related Lists area and open the VCS Preview Log tab.
Filter out records with the Good state using the Condition Builder.
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.
If the pack contains records that should not be imported, change the State field value to Skipped.

VCS Preview Log form fields

Field	Description
Local Pack	Reference to the local pack containing this preview log record.
Retrieved Pack	Reference to the configuration pack containing this preview log record.
Document Record	This ID stores 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. States Information 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 transaction created the version object. Available options: Insert Update Delete If the record with the Update action is absent on the target instance, then it is imported with the 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 transaction has been executed.
JSON Copy	The record version data in JSON format as an associative array. This array stores the target record object relevant state after the transaction. JSON Copy contains an array for the Update and Insert actions. If the action is Delete, the JSON Copy field is empty.
Message	The error text displayed in case of collision. The field is populated in case the state is Warning or Skipped or Collision).

Deploying a configuration pack

To implement the configuration pack, complete these steps:

Doublecheck 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.
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 at the Committed at field.

Platform update

When a new version of SimpleOne platform is implemented, the system creates snapshots of records inserted during the update migration. These records will be 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	Automatically created by the system
Completed by	System User
Application	Simple
State	Completed

Page tree