Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Tip |
---|
Role required: admin. |
Concept
In briefshort, the VCS configuration pack provides pack provides version control in SimpleOne. Version control system allows:
- monitoring changes, seeing tracking who and when updated the record and when
- restoring record versions
- transferring record versions created when updating or developing applications between unrelated instances.
VCS records provide a way to transfer data from one instance to another in an automatic or semi-automatic way. For not to recreate changes on every instance, you You can just import a configuration pack .So, this in order to avoid recreation of changes on every instance.This technology ensures easy update migration between instances.
For example, your team has created a new application on the development instance. Instead of copying scripts and recreating all elements one by one manually, they assemble a configuration pack and import it to the production instance. While importing this pack into the target instance, the system checks changes for possible collisions. This way, you can make sure that these changes work fine.
Configuration pack flow
A good Good practice is to develop new applications and implement changes into existing ones on a separate instance. This will lessen mistakes and risks for everyday processes on the production instance. ThusTherefore, VCS records should be collected into one local pack within the relevant application.
The configuration management involves two main processes:
- Export – collecting VCS records into a local pack on Instance #1, the result of which is a Local Pack in the Completed state and a .SOP file.
- Import – uploading and deployment of the previously prepared configuration pack on Instance #2.
To learn more about version control in SimpleOne and more, see the following articles:
Local packs Anchor local pack local pack
local pack | |
local pack |
Local packs allow developing the development of application configurations on a separate instance, exporting it as a .SOP file, and implementing changes to the production instance. This approach minimizes the risks of mistakes, errors, and conflicts, which may affect the production instance during application development.
Note |
---|
All system configuration activities should be performed within a separate local pack. Do not use the default local pack for these needs. |
Local pack is a record in the VCS Local Pack (sys_vcs_local_pack) table compiling relevant records from the VCS Record (sys_vcs_record) table. This allows associating VCS records with a particular pack and exporting them as a complete set.
Note |
---|
|
Every single version is an atomic state of versioned tables (those ones which have
thethe Is VCS Enabled
checkboxcheckbox selected).
Every record ofAll records in this table
containscontain JSON formatted changes and other attributes described below.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{"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 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 by a single source can be written only in one local pack selected in the Admin Preferences menu at the right. That is, if the selected local pack is Default 3, then all changes will be stored in the Default 3 pack. |
All record versions in a local pack are displayed in the VCS Record related list.
Info |
---|
In the Admin Preferences menu, select the local pack on which you are working. This local pack will be saved as preferablepreferred: if you switch between applications, this pack will be selected automatically. If the preferable preferred local pack has a state other than In Progress, the local pack will switch to the default one. |
Tip |
---|
When If there is no need in assembling a separate local pack for export, all record versions will be compiled into the default local pack. The default pack can also contain VCS records moved from developing local pack (for example, created by mistake). |
VCS Records Anchor VCS records VCS records
VCS records | |
VCS records |
Configuration packs are also used for monitoring to monitor changes in particular records.
After any transaction (create/update/delete) for the versioned table object, the record is created in the VCS Record Records (sys_vcs_record) table corresponding to the object state after the transaction. The record version contains the information described below.
Note |
---|
|
|
Tip | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Please note that removing does not mean 'deletion': removed records are stored in the default local pack. If a local pack includes unwanted VCS records, move them into to the default pack by completing the following steps:
As a result:
|
Restoring VCS Records
All the record versions – both previous and current – are stored in the VCS Record table. Current versions have the Is Current checkbox selected.
If you need to restore one of the record previous record versions, complete complete the steps below:
- Open the record which version you need to restore.
- Scroll down to the Related Lists area and open the VCS Records tab.
- Open the record version you need to restore.
- Click Restore Version.
Info |
---|
Another way to restore a record version is the following:
|
After that, a new VCS record associates is associated with in the current local pack. It will be displayed in the VCS Records related list.
Info |
---|
Some forms may not display the VCS Records related list by default. You can add it to a the versioned table form as a related list. After that, all versions (previous and current) of the current record are displayed on the record form. To add the VCS Record related list, perform the following steps:
|
Protection Policy Anchor protection policy protection policy
protection policy | |
protection policy |
The Protection Policy attribute is responsible for the possibility of the record changing ( for example, overwriting). It is used, in particular, for data protection purposes. That is, the most important elements of the system with the Protected policy cannot be changed.
How it works
After creating a record in the versioned table, the Protection Policy of for this record is Open. When Once the record is updated, the Protection Policy becomes Changed. This These values are transferred to the Record Policy field in the related VCS record, that is, the record version has the same Policy as the record itself.
Administrator can update record with the Open and Changed policies.
Administrators cannot update records with the Protected policy. The exception is records related to the ITSM application: administrators can update ITSM record with Admin can update only the Local Pack and Is Strong Overwrite fields of records with any protection policy.
During the importing process, the records possible to overwrite can be updated. Both record policy values set in the system and in the configuration pack are taken into account. All possible policy combinations are described in the table below.
Source record Protection Policy | Target record Protection Policy | Result |
---|---|---|
Protected | Protected | Success |
Open | Success | |
Changed | Success | |
Changed | Protected | Failed. Use Strong Overwrite to proceed. |
Open | Success | |
Changed | Success | |
Open | Protected | Failed. Use Strong Overwrite to proceed. |
Open | Success | |
Changed | Failed. Use Strong Overwrite to proceed. |
/
Table of Contents | ||||
---|---|---|---|---|
|