With local packs, it is possible to you can collect all the necessary configuration changes in the same one place and transfer them to another instance. Export the local pack and add it to the Retrieved Packs (sys_vcs_retrieved_pack)table of the target instance. When the pack is loaded, a new local pack is created on that instance. This local pack contains the settings imported from the first instance settings. This approach minimizes the risks of mistakes, errors, and conflicts that may affect the production instance during the application development.
| Note |
|---|
All Perform all system configuration activities should be performed within a separate local pack. Do not Never use the default local pack for these needs of the application for this purpose. |
A local pack is a record in the VCS Local Pack (sys_vcs_local_pack) table, and it compiles relevant to the configuration changes done records from the the VCS Record (sys_vcs_record) table related to the configuration changes. Use local packs to associate VCS records with a particular specific pack and export them as a complete set.
| Note |
|---|
Only users with the admin role can: - manage lockal packs: create, merge, import and remove local packs.
- add VCS records to the local pack or remove them, and their records: create, edit and remove themedit some of their fields.
|
Every single version is an atomic state of the a versioned tables table (those having that has the Is VCS Enabled checkbox selected). All records in this table contain JSON formatted changes and other attributes described below.
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | Example of JSON Copy field in a VCS Record |
|---|
| collapse | true |
|---|
|
{"value": "Report Item", "policy": "Open", "sys_id": 159653803414986194, "column_id": 156941403909472422, "record_id": 159653803414985080, "language_id": 156628684306541141, "application_id": 155931135900000002, "sys_created_at": "2020-08-04 10:47:14", "sys_created_by": 155931135900000001, "sys_updated_at": "2020-08-04 10:47:14", "sys_updated_by": 155931135900000001} |
Application configurations are stored in configuration packs represented that can be exported as a . SOP file. Administrators can create their own applications if needed.
| Tip |
|---|
There can be more than one local pack in the system, but the changes made, for example, within a specific task can only be saved only in the local pack that is selected pack selected in the Admin Preferences menu at the right. That is, if the selected Default 3 local pack is Default 3selected, all changes made by the current user will be stored in the Default 3 pack. 
|
On the form of the local pack, all the record versions are displayed in the VCS RecordRecords related list.
| Info |
|---|
In theAdmin Preferencesmenu, select the local pack that you are going need to work on. This local pack will be saved as the preferred one: if you switch between the applications, this pack will be automatically selected automatically for this the application. Only a local pack in the In progress state In Progress can be selected as the preferred one. Once the state changes, the prefered preferred pack in the Admin Preferences menu switches to the default one for this appthe application. |
VCS Local packs form Pack form fields
| Field | Mandatory | Description |
|---|
| Name | Y |
Name | The name of the local pack. |
| Is |
Default| default | N | Select this checkbox to set the local pack as default. When |
moving versions from other local packs, selected VCS records will be moved to this default pack| you work on the selected application, all changes will ba saved to this local pack unless another local pack is selected in the Admin Preferences → Local Pack. |
| State | Y |
Local The local pack states. Available options: |
current within the same task are - made by the current user are saved to this package.
- Completed – all planned changes
|
have been placed to the package- are packaged.
- Ignored – the package is not finished
|
and, accordingly, cannot - and cannot be exported, also this package cannot be in work.To continue working on the package, change it to the In
|
Progress status again- progress state again.
- Rollback
|
Previewed- previewed – the package records are ready for a rollback
|
, the status of the records is displayed on the form- . The state is set automatically after clicking Rollback preview.
- Rollbacked – the instance displays the records of the version that was
|
relevant - current before the changes were made. The records created during the package creation are
|
missing - removed from the instance, the deleted records are restored. This state is set automatically after clicking Rollback.
|
| Application | N |
Application | Select the application that this local pack |
relates One | A local pack contains only those records that belong to the same application. |
| Description | N |
Local pack description| Add a description for the local pack. |
| Tip |
|---|
If there is no need to assemble a separate local pack to export, all record versions can be stored in the default local pack. The default pack can also contain the VCS records moved from other local packs that are in the In Progressprogress state, for example, when some records were created or moved to the local pack by mistake. |
VCS Records
Use configuration packs to monitor changes in particular specific records.
After any action (create, update, or delete) on a an object of any versioned table object, a record is created for that object in the VCS Records (sys_vcs_record) table for this object. The records displayes display the state of the object after the action was done. The record version contains the information described below.
| Note |
|---|
- VCS records cannot be created, updated, or deleted manually. These records are created automatically by the system and are only available to admin users for reading. Only users with the admin role can read them.
- Admin user can also edit the Local Packpack and Is Strong Overwritestrong overwrite fields.
|
| Tip |
|---|
Note that removing of a record does not mean its 'deletion': the removed records Removed records are not deleted, they are stored in the default local packpacks. If a local pack includes unwanted VCS records, move them to the default pack by completing the following steps: - Navigate to Configuration → Local Packs.
- Open the VCS Local Pack containing the VCS record you need to remove.
- Scroll down to the Related Lists area and open the VCS Record tabIn the Related Lists area, select the VCS Records tab.
- Select a record or records to be removed by selecting the checkboxes and click Move to Defaultdefault.
- These records will be removed to the default local pack of the same application.
As a result: - Selected The selected record versions are moved to the default pack.
- The record versions with the same Record IDas the selected ones are moved to the default pack.
| Note |
|---|
| Anchor |
|---|
| default local pack |
|---|
| default local pack |
|---|
|
VCS record removal is not available in the You can not remove VCS records from default local packs. | Info |
|---|
A default local pack is the local pack with theIs Defaultdefault checkbox selected. |
|
|
VCS Record form fields
| Field | Description |
|---|
| Table Name | System name of the target record table. |
| Record ID | Unique ID of the source record processed by the transaction. |
| Document Record | The target table ID and target record ID for which the current record is created. For example:  Image Removed
|
JSON Copy | This field stores target record attributes in JSON format as an associative massive.
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | Example |
|---|
|
{"value": "Report Item", "policy": "Open", "sys_id": 159653803414986194, "column_id": 156941403909472422, "record_id": 159653803414985080, "language_id": 156628684306541141, "application_id": 155931135900000002, "sys_created_at": "2020-08-04 10:47:14", "sys_created_by": 155931135900000001, "sys_updated_at": "2020-08-04 10:47:14", "sys_updated_by": 155931135900000001} |
| Is Current | Select this checkbox to make this version current. |
| Created by | The user who did the change. |
| Created at | Date and time of the record creation. |
| Local Pack | The local pack that contains this record. |
| Retrieved Pack | The Retrieved pack to which this record is related to. |
| Restored by | A unique ID of the version record from which the current record was restored. |
| Action | Action type. Available options: |
| Record Policy | Current record protection policy after the transaction is over. Available options: |
| Is Strong Overwrite | When the checkbox is selected, the current record will be written over the existing version with the Protected policy. |
Restoring Restore VCS Records
All the record versions, both previous and current, are stored in the VCS Record table. Current The current versions have the Is Current checkbox selected.
To restore one of the record from previous versions of a record, complete the steps below:
- Open a the record that you need to restore to a particular version.
- Scroll down to the Related Lists area and open the VCS Records In the Related Lists area, select the VCS Records tab.
- Open the record version you need to restore.
- Click Restore Versionversion.
| Info |
|---|
Another way to restore a record version is the following: - Navigate to Configuration → VCS Records.
- Find the record to restore. You can use the list search boxes or the Condition Buildercondition builder.
- Open the record you need.
- Click Restore Versionversion.
|
Image Modified
After that, a new VCS record is associated with the current local pack and displayed in its VCS Records related list.
| Info |
|---|
Some forms may not display the VCS Records related list by default. But you can add it to the versioned table form on your own. After that, all versions (previous and current) of the current record will be displayed on the record form. To add a VCS RecordRecords related list, do the following: - Open a record for which you need to add a related table.
- In the hamburger menu
 , select Configure → Related List → Layout. - Move the VCS Record Records → Document Record element from the Available box to the Selected box.
- Click Save to apply the changes.
 Image Modified
|