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

Compare with Current View Page History

« Previous Version 26 Next »

Local pack import and implementation include the following stages:

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

The result of implementation depends on the Protection Policy of VCS records in the local pack and on the target instance.

Upload a configuration pack


When Related tables contain records
importing records for a custom application, ensure that a relevant application is implemented in the target instance or that the local pack contains the application VCS record.

If there is no relevant custom application on a target instance, 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. In the Related Lists area, select the VCS Record tab.

  4. Open a relevant record (with the selected Is Current checkbox). 

  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 the changes.
  5. Click Load pack to load records from the attached .SOP file to the temporary Retrieved Records table.

It is impossible to edit the Retrieved Pack records. They are only available for reading to the admin users, who can also delete them if the Retrieved Pack record is not in the Committed state. 

VCS Retrieved Pck form fields

FieldMandatoryDescription
NameNThe retrieved pack name. This field is populated automatically with the attached pack name.
StateY

State of the current configuration pack. Available options:

  • New
  • Previewed
  • Loaded
  • Committed
ApplicationNSpecify the application where the pack should be imported to.
InsertedNNumber of records in this pack with the Insert action.
UpdatedNNumber of records in this pack with the Update action.
DeletedNNumber of records in this pack with the Delete action.
WarningNNumber of the Preview Log records in the Warning state.
SkippedNNumber of the Preview Log records in the Skipped state.
CollisionsNNumber of the Preview Log records in the Collision state.
TotalNTotal number of the records.
DescriptionNRetrieved pack description taken from the .SOP file attached.
Committed atNThe date and time when the configuration pack was applied (its state changes to Committed).
Loaded atNThe date and time when the record implementation was completed.

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 list contains the VCS records located in this local pack.

Prepare 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 a .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. In the Related Lists area, select the Retrieved Records tab.

Field

Description

Table Name

The target table system name in which this record version should be created.

Record IDThe target record ID for which the current record is created.
Created byReference to the user who created the initial record verion.
JSON CopyThe record version in the JSON format.
Is Strong OverwriteWhen selected, the current record will be written over the existing version after import.
Action

Transaction type. Available options:

  • Insert
  • Update
  • Delete
Retrieved PackReference to the retrieved pack containing the record version.

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. In the Related Lists area, select 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.

    Field

    Description

    Local PackReference to the local pack containing this preview log record.
    Retrieved PackReference to the configuration pack containing this preview log record.
    Document Record ID This ID stores the table name and target record ID for which the current record is created.
    Record Policy

    The attribute responsible for the record protection policy. See the Configuration Packs article for more information.

    Available options:

    • Open
    • Changed
    • Protected
    State

    The preview log record state.

    States Information

    Available states:

    • Good – this configuration pack version will not cause import conflicts.
    • Skipped – this version importing was skipped within the whole import process.
    • Warning – this version cannot be applied partially or entirely.
    • Collision – this version with this state cannot be imported due to critical system conflicts.
    • Allowed – this state is similar to the Good state. The state is set to version after rollback operations (in the Preview Log related list).
    Action

    The type of action that initiated the object version. Available options:

    • Insert
    • Update
    • Delete

    If a record with the Update action is absent on the target instance, then it is imported with the the Insert action (the new record is created instead of updating the existing one).

    Table Name

    The table system name for the target record.

    Record IDID of the target record for which the action has been executed.
    JSON Copy

    The record version data in the JSON format as an associative array. This array stores the object of the target record in a relevant state after the action done.

    JSON Copy contains an array for the Update and Insert actions. If the action is Delete, the JSON Copy field is empty.

    MessageThis field contains the error information in case of collision. The field is populated in case the state is Warning or Skipped or Collision.

Deploy 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 a snapshots of the 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