Versions Compared

Old Version 4

changes.mady.by.user Irina Grishina

Saved on

compared with

New Version Current

changes.mady.by.user Dina Baksheeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With local packs, it is possible to continue the development of application configurations on a separate instance. Export it as a .SOP file, and implement changes to the production you can collect all necessary configuration changes in 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. This approach minimizes the risks of mistakes, errors, and conflicts , which 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 compiling relevant , and compiles records from the the VCS Record (sys_vcs_record) table . This allows associating related to the configuration changes. Use local packs to associate VCS records with a particular specific pack and exporting export them as a complete set.

Note

Only users with the admin role can:

  • create, merge, import and remove local packs.
  • add VCS records to the local pack or remove them, and edit some of their fields.
    • create and read VCS Local Pack records. 
  • Admin users can edit the Name, Is Default, Description, State fields. 
  • They can also delete VCS Local Pack records that have empty VCS records or no VCS records at all. 

Every single version is an atomic state of 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
languagejs
themeEclipse
titleExample of JSON Copy field in a VCS Record
collapsetrue
{"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 by a single source can be written only in one local pack selected , for example, within a specific task can only be saved in the local 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.

All On the form of the local pack, all the record versions in a local pack are displayed in the VCS RecordRecords related list.

Info

In theAdmin Preferencesmenu, select the local pack that you are working need to work on. This local pack will be saved as the preferred one: if you switch between the applications, this pack will be selected automatically. If the preferred local pack has a state other than In Progress, the local pack will switch to the default oneautomatically selected for the application.

Only a local pack in the In progress statecan be selected as the preferred one. Once the state changes, the preferred pack in the Admin Preferences menu switches to the default one for the application.

VCS Local Pack form fields

FieldMandatoryDescription
NameYThe name of the local pack.
Is defaultNSelect this checkbox to set the local pack as default. When 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.
StateY

The local pack states. Available options:

  • In progress – all changes made by the current user are saved to this package.
  • Completed – all planned changes are packaged.
  • Ignored – the package is not finished and cannot be exported, also this package cannot be in work. To continue working on the package, change it to the In progress state again.
  • Rollback previewed – the package records are ready for a rollback. The state is set automatically after clicking Rollback preview.
  • Rollbacked – the instance displays the records of the version that was current before the changes were made. The records created during the package creation are removed from the instance, the deleted records are restored. This state is set automatically after clicking Rollback.
ApplicationNSelect the application that this local pack belongs to. A local pack contains only those records that belong to the same application.
DescriptionNAdd a description for the local pack.


Tip

If there is no need into assembling a assemble a separate local pack to export, all record versions will can be compiled into stored in the default local pack. The default pack can also contain the VCS records moved from developing local pack (other local packs that are in the In progress state, for example, when some records were created or moved to the local pack by mistake).

VCS Records
Anchor
VCS records
VCS records

Use configuration packs to monitor changes in particular specific records.

After any transaction action (create/, update/, or delete) for the on an object of any versioned table object, a record is created for that object in the VCS Records (sys_vcs_record) table corresponding to . The records display the state of the object state after the transactionaction 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. Only users with the admin role can read them.
  • Admin can also edit the Local Packpack and Is Strong Overwritestrong overwrite fields. 


Tip

Note that removing does not mean 'deletion': 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:

  1. Navigate to Configuration → Local Packs.
  2. Open the VCS Local Pack containing the VCS record you need to remove.
  3. Scroll down to the Related Lists area and open the VCS Record tabIn the Related Lists area, select the VCS Records tab.
  4. Select a record or records to be removed by selecting the checkboxes and click Move to Defaultdefault.
  5. These records will be removed to the default local pack of the same application.

As a result:

  • Selected The selected record versions are removed moved to the default pack.
  • Record The record versions with the same Record IDas the selected ones are removed moved to the default pack.
Note
Anchor
default local pack
default local pack

VCS record removal is not available in You can not remove VCS records from default local packs.

Info

Default A default local pack is a the local pack with theIs Defaultdefault checkbox selected. 

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:

  1. Open a the record that you need to restore to a particular version.
  2. Scroll down to the Related Lists area and open the VCS Records In the Related Lists area, select the VCS Records tab.
  3. Open the record version you need to restore.
  4. Click Restore Versionversion.
Info

Another way to restore a record version is the following:

  1. Navigate to Configuration → VCS Records.
  2. Find the record to be recoveredrestore. You can use the list search boxes or the Condition Buildercondition builder.
  3. Open the record you need.
  4. Click Restore Versionversion.


Image Modified

After that, a new VCS record is associated with the current local pack . It is and displayed in the its VCS Records related list.

Info

Some forms may not display the VCS Records related list by default. You But you can add it to the versioned table form as a related liston your own. After that, all versions (previous and current) of the current record are will be displayed on the record form.

To add a VCS RecordRecords related list, perform do the following steps:

  1. Open a record for which you need to add the a related table.
  2. In the hamburger menu, select Configure → Related List → Layout.
  3. Move the VCS Record Records → Document Record element from the Available box to the Selected box.
  4. Click Save to apply the changes.

Image Modified


Table of Contents
absoluteUrltrue
classfixedCondition
printablefalse