Versions Compared

Old Version 3

changes.mady.by.user Irina Grishina

Saved on

compared with

New Version Current

changes.mady.by.user Irina Grishina

Saved on

Key

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

Role required: admin.

Concept

In short, the VCS configuration pack provides version control in SimpleOne. Version control system allows:

  • monitoring changes, tracking who updated the record and when 
  • restoring record versions
  • transferring record versions created when updating or developing applications between unrelated instances.

...

The VCS records enable data transfer from one instance to another in an automatic or semi-automatic way. You can

...

import a configuration pack

...

to avoid recreation of changes on every instance.This

...

method ensures an easy update migration between instances.

For example, your team has created a new application on

...

a development instance. Instead of copying the 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 the changes for possible collisions. This

...

procedure ensures a stable process for the system update.

Configuration pack flow

Tip

Role required: admin.

Good practice is to develop new applications and implement changes into existing ones on a separate instance. This

...

reduces the number of possible mistakes and risks for everyday processes on the production instance. Therefore, the VCS records should be collected into one local pack within the relevant application.

There are two types of the packages:

  • local – to collect changes on the current instance.
  • retrieved – to apply the changes that were transferred from another instance. 

The configuration management involves two main processes:

...

  • Preparation and export of the configuration change – collecting

...

  • the VCS records into a local pack on Instance #1,

...

  • as a result the Local Pack changes its state to Completed and a SOP file is created.
  • Import and deployment –
  • 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:

Image Removed

...

Local packs allow 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 Configuration Packs 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
  • Only users with the admin role can 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 versioned tables (those ones which have 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 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, all changes will be stored in the Default 3 pack.

Image Removed

All record versions in a local pack are displayed in the VCS Record related list.

Image Removed

Info

In the Admin Preferences menu, select the local pack on which you are working. This local pack will be saved as preferred: if you switch between 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 one.

Tip

If there is no need in assembling a separate local pack for export, all record versions will be compiled into the Configuration Packs. The default pack can also contain VCS records moved from developing local pack (for example, created by mistake).

...

Image Added

Table of Contents
absoluteUrltrue
classfixedCondition
printablefalse

...