You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

In SimpleOne, you can implement updates and applications to other instances using the 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. The file contains 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 the VCS records from the uploaded configuration pack. Once the import is completed, these records are deleted.
  • VCS Preview Log – provides information about the implementation results before importing the configuration pack into the instance. Previewing log records warns the user about possible collisions and helps to fix them.

Local pack import and implementation include the following stages:

  1. Uploading a configuration pack
  2. Preparing a configuration pack
  3. Processing collisions (if any)
  4. Deploying a configuration pack

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 a relevant application is implemented in the target instance or that the local pack contains the application VCS record.

If a target instance does not have a relevant custom application, complete the steps below to import it.

  1. Navigate to Configuration → Applications.
  2. Find the application record using the list search or the Condition Builder and open it.
  3. Scroll down to the Related Lists area.

  4. In the VCS Record tab, open a relevant record (with the Is Current=true). 

  5. In the VCS Record form, select the necessary local pack in the Local Pack field.
  6. Click Save or Save and Exit.

To import a local pack, complete the steps below:

  1. Navigate to Configuration → Retrieved Packs.
  2. Click New to create a new configuration pack.

  3. Upload a .SOP file by clicking on the attachments icon.

    Note that when attaching more than one .SOP file to a retrieved pack record, only the records from the last file will be imported. The packs attached earlier will be ignored.

    In case of loading records from a wrong .SOP file, it is possible to re-upload a .SOP file without creating a new retrieved pack. To do so, follow the steps below:

    1. Click on the attachments icon.
    2. Click Add files and upload the file you need.
    3. Click Reload pack.
      As a result:
      1. The VCS Preview Log related list has been cleared from the previously uploaded records.
      2. The records from the new file are loaded.
    4. Click Import pack to complete the import.
  4. Click Save or Save and Exit to apply changes.
  5. 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. 

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. It is possible to filter records out by state in the Retrieved Records related table.

To preview the configuration pack, complete the steps below:

  1. Make sure that the state of the Retrieved Pack record you need is Previewed.
  2. Scroll down to the Related Lists area.
  3. Click on the Retrieved Records tab.

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

  1. Open the Retrieved Pack record you need.
  2. Scroll down to the Related Lists area and open the VCS Preview Log tab.
  3. Filter out records with the Good state using the Condition Builder.

  4. 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 a pack contains records that should not be imported, change the State field value to Skipped.

Deploying a configuration pack

To implement the configuration pack, complete these steps:

  1. 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.
  2. 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 are stored in a separate local pack having the following fields populated automatically:

FieldValue
Name

Simple Application {platform version} (Migrations)

{platform version} stands for a version number such as 1.8.0

DescriptionAutomatically created by the system
Completed bySystem User
ApplicationSimple
StateCompleted

/


  • No labels

© 2019-2024, SimpleOne

https://simpleone.ru