ONYX - 9.1 - Utilisation - Rollback des formats Designer et Connect/en

Différence entre versions

De MappingDoc
(Page créée avec « ONYX:9.1:Usage:Designer and Connect Format Rollback »)
 
 
(50 révisions intermédiaires par 3 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
 
<languages/>
 
<languages/>
 
==Introduction==
 
==Introduction==
Mapping 9.1 et au-delà intègre dans les écrans des formats Designer et Connect un module permettant la gestion de leurs différentes versions. Cette fonctionnalité donne la possibilité à l'utilisateur de remettre en action des versions précédentes de templates Designer et Connect.
+
Mapping 9.1 and higher includes a graphical interface to rollback Designer and Connect formats to a previous version. Using this feature, the user can easily restore a previous version of a Designer or Connect format in production.
Cela peut être très utile, par exemple, en cas de necessité de faire un rollback vers une version précédente d'un template Designer.
 
  
==Prérequis==
+
==Requirements==
Mapping Onyx 9.1
+
Mapping Onyx 10.2.5 or higher (Partially available since V9.1 but with limited access)
  
==Limites==
+
==How it works==
Cette fonctionnalité est disponible uniquement pour les actions de rollbacks effectuées via l'interface (non disponible lors d'utilisation des commandes map_import et map_export).
+
===Configuration===
  
==Fonctionnement==
+
Five new parameters are available now in the mapping.conf :
===Paramétrage===
+
# '''[VERSIONING_TOGGLE]: ''' Activate the rollback features.
 +
# '''[FORMAT_REPOSITORY_DIR_FULLPATH]: ''' give the path of the folder containing all the different versions.
 +
# '''[VERSIONING_LIMIT_DURATION]: ''' Gives the retention period of the formats (in days). The versions older than this values will be deleted during the next importation.
 +
# '''[VERSIONING_QUOTA_PER_PROJECT]: '''Gives the number of versions maximum per project.
 +
# '''[VERSIONING_QUOTA_GLOBAL]: ''' Gives the maximum number of version all projects included.
  
Une nouveau paramètre est apparu dans le mapping.conf '''[FORMAT_REPOSITORY_DIR_FULLPATH]''' ayant pour valeur le chemin et le nom du répertoire contenant les différentes versions des formats :
+
<div class="mw-translate-fuzzy">
 +
<block name="EXPERT PATH">
 +
    <group>
 +
        <element>
 +
          ...
 +
          '''<info name="[FORMAT_REPOSITORY_DIR_FULLPATH]">/apps/mapping/map400/repository</info>'''
 +
          ...
 +
        </element>
 +
    </group>
 +
  </block>
 +
...
 +
<block name="OTHERS">
 +
    <group>
 +
        <element>
 +
            ...
 +
            '''<info name="[VERSIONING_TOGGLE]">YES</info>'''
 +
            '''<info name="[VERSIONING_LIMIT_DURATION]">5</info>'''
 +
            '''<info name="VERSIONING_QUOTA_PER_PROJECT]">10</info>'''
 +
            '''<info name="[VERSIONING_QUOTA_GLOBAL]">30</info>'''      
 +
            ...
 +
        </element>
 +
    </group>
 +
</block>
 +
</div>
  
<block name="EXPERT PATH">
+
This entry is created automatically when Mapping 10.2.5 is installed and behond.
    <group>
 
      <element>
 
          ...
 
          '''<info name="[FORMAT_REPOSITORY_DIR_FULLPATH]">/apps/mapping/map400/repository</info>'''
 
          ...
 
      </element>
 
    </group>
 
</block>
 
  
Cette entrée est créée automatiquement à l'installation de Mapping 9.1 et a pour valeur par défaut ''/home/mapping/map400/repository''
+
Their default values are :
  
Le répertoire repository est également créé automatiquement.
+
# '''[VERSIONING_TOGGLE]:''' NO
 +
# '''[FORMAT_REPOSITORY_DIR_FULLPATH]: ''' /apps/mapping/map400/repository.
 +
# '''[VERSIONING_LIMIT_DURATION]: ''' : No limit or 0
 +
# '''[VERSIONING_QUOTA_PER_PROJECT]: ''' No limit or 0
 +
# '''[VERSIONING_QUOTA_GLOBAL]: ''' No limit or 0
 +
 
 +
 
 +
The "repository" folder is also created automatically.
  
 
===Interface===
 
===Interface===
Le versioning est disponible pour les formats importés de Designer et de Connect.
+
Format versioning is available for Designer and Connect.
  
====Formats Designer====
+
====Designer Formats====
Sur le serveur Mapping 9.1 et au-delà, aller dans la '''Gestion des formats Designer''':
+
In Mapping 9.1 and higher, go to '''Designer Formats Management''':
  
:Sur le menu Mapping, cliquer sur :
+
:In the Mapping menu, click on:
::#Gestion de formats Designer
+
::#Designer Formats Management
::#Gestion des formats
+
::#Formats Management
  
La liste de formats Designer opérationnels s'affiche alors.
+
The list of all available Designer formats is displayed.
  
 
[[File:OX_S_VERSIONING1.jpg|1000px|center|sans_cadre]]
 
[[File:OX_S_VERSIONING1.jpg|1000px|center|sans_cadre]]
  
Il est alors possible de rentrer dans la gestion des différentes versions d'un format donné en cliquant sur le '''i''' correspondant.
+
There you can manage the different versions of each given format by clicking on the '''i''' icon at the end of the line of icons.
  
La fenêtre suivante listant toutes les versions et l'historique de toutes les activations du format s'ouvre alors :
+
The window below is displayed presenting all versions and the history of versions used:
  
 
[[File:OX_S_VERSIONING2.jpg|1000px|center|sans_cadre]]
 
[[File:OX_S_VERSIONING2.jpg|1000px|center|sans_cadre]]
  
1 : Format concerné<br>
+
<div class="mw-translate-fuzzy">
2 : Numéro de version du format concerné<br>
+
1 : Format<br>
3 : Utilisateur ayant procédé à l'importation ou au dernier rollback<br>
+
2 : Format version number<br>
4 : Commentaire saisi lors d'un rollback<br>
+
3 : User who last imported the format or used the rollback feature (always set to Auto<br>
5 : Date et heure de l'activation de la version<br>
+
4 : Comment written during last rollback (Always set to manual rollback)<br>
6 : Date et heure de jusqu'à quand la version était active<br>
+
5 : Date and time the version was activated for the last time<br>
7 : Bouton de rollback<br>
+
6 : Date and time until which the version was last active<br>
 +
7 : Rollback button<br>
 +
</div>
  
<u>Rollback de la version V4</u> :
+
<u>V4 version rollback</u>:
  
Dans cet exemple, nous allons réactiver la version V4 en cliquant sur son bouton '''Rollback''' :
+
In this example, we want to restore version V4 by clicking on the '''Rollback''' button:
  
 
[[File:OX_S_VERSIONING3.jpg|1000px|center|sans_cadre]]
 
[[File:OX_S_VERSIONING3.jpg|1000px|center|sans_cadre]]
  
Voici le résultat alors obtenu :
+
This is the result:
  
 
[[File:OX_S_VERSIONING4.jpg|1000px|center|sans_cadre]]
 
[[File:OX_S_VERSIONING4.jpg|1000px|center|sans_cadre]]
  
La version 4 du format est alors activé.
+
Version 4 of the format is activated.
  
  
<u>Remarque</u> : Il est également possible d'avoir une vue d'ensemble sur tous les formats et de toutes leurs versions. Pour cela, il faut aller sur le sous-menu '''Historique des formats''' du menu '''Gestion des formats Designer'''
+
<u>Note</u>: You can have a view of all formats and all versions. To do so, open the '''Formats History''' sub-menu under '''Designer Formats Management'''
  
 
[[File:OX_S_VERSIONING5.jpg|1000px|center|sans_cadre]]
 
[[File:OX_S_VERSIONING5.jpg|1000px|center|sans_cadre]]
  
===Format Connect===
+
===Connect Formats===
Le fonctionnement avec les formats Connect est le même qu'avec les formats Designer. Nous vous invitons à vous référer à la partie des formats Designer.
+
Connect formats work the same as Designer formats. Please check the Designer formats section above.
  
==Ligne de commandes==
+
==Command Line==
Il est également possible de faire du versioning en ligne de commande en utilisant le binaire '''mapobjectversioncontrol'''
+
You can also manage format versions from the command line using the '''mapobjectversioncontrol''' binary.
  
<u>Exemple d'utilisation</u> :  
+
<u>Example</u>:  
  // Sauvegarde le projet KUHN en séquence 20 actuellement en production
+
  // Save project KUHN with sequence 20 currently in production
 
  mapobjectversioncontrol backup "KUHN" "00020"
 
  mapobjectversioncontrol backup "KUHN" "00020"
  
  // Restaure le projet KUHN en séquence 10 comme il était en production le 27 avril
+
  // Restore project KUHN wit sequence 10 as it was in production on 27 April
 
  mapobjectversioncontrol restore "2019-04-27T23:59:59.000Z" "KUHN" "00010"
 
  mapobjectversioncontrol restore "2019-04-27T23:59:59.000Z" "KUHN" "00010"
  
  // Liste les projets déjà versionnés
+
  // List of projects where different versions are available
 
  mapobjectversioncontrol list
 
  mapobjectversioncontrol list
  
Toutes les actions ayant un impact sur le repository sont versionnées automatiquement.
+
All actions that have an impact on the repository are versioned automatically.
  
Il sera bientôt possible de restaurer grâce au numéro de version :
+
Soon you will be able to restore using the version number like this:
 
   mapobjectversioncontrol restore "KUHN" "00010" v3
 
   mapobjectversioncontrol restore "KUHN" "00010" v3
  
==Cas particulier==
+
==Special Case==
===Cas des formats déjà présents===
+
===Existing Formats===
  
Dans le cas où des formats sont déjà présents dans l'environnement (créés grâce à la copie du contenu du répertoire MAP400 à partir d'un environnement sans mécanisme de versioning ou lors de l'upgrade d'une version antérieure à la V9.1), la version V0 de ce format ne sera pas sauvegardée dans le mécanisme de versioning.
+
If there are existing formats in the environment (created through copying the contents of the MAP400 folder from an environment where there is no versioning system, or when upgrading from a version older than 9.1), version V0 of each format will not be saved in the versioning mechanism.
  
Par conséquent, lors de l'import de la prochaine version V1 de ce format, la version V1 sera bien sauvegardée mais la V0 sera perdue.
+
As a result, when importing the next version V1 of the format, version V1 will be saved but V0 will be lost.
  
Afin d'éviter cela, avant d'importer la V1 du format, il faut exécuter la commande suivante :
+
To prevent this, before importing version V1, run the command below:
 
  /apps/mapping/bin/mapobjectversioncontrol backup "format" "sequence"
 
  /apps/mapping/bin/mapobjectversioncontrol backup "format" "sequence"
  
Cela aura pour effet de créer une entrée de la version V0 dans le mécanisme de versioning.
+
This will create an entry for version V0 in the versioning system.
Cette version sera alors disponible dans l'interface de rollback des formats.
+
The version will then be available in the Rollback management interface.

Version actuelle datée du 24 décembre 2021 à 16:06

Autres langues :
English • ‎français

Introduction

Mapping 9.1 and higher includes a graphical interface to rollback Designer and Connect formats to a previous version. Using this feature, the user can easily restore a previous version of a Designer or Connect format in production.

Requirements

Mapping Onyx 10.2.5 or higher (Partially available since V9.1 but with limited access)

How it works

Configuration

Five new parameters are available now in the mapping.conf :

  1. [VERSIONING_TOGGLE]: Activate the rollback features.
  2. [FORMAT_REPOSITORY_DIR_FULLPATH]: give the path of the folder containing all the different versions.
  3. [VERSIONING_LIMIT_DURATION]: Gives the retention period of the formats (in days). The versions older than this values will be deleted during the next importation.
  4. [VERSIONING_QUOTA_PER_PROJECT]: Gives the number of versions maximum per project.
  5. [VERSIONING_QUOTA_GLOBAL]: Gives the maximum number of version all projects included.

<block name="EXPERT PATH">

    <group> 
       <element>
          ...
          <info name="[FORMAT_REPOSITORY_DIR_FULLPATH]">/apps/mapping/map400/repository</info>
          ...		
       </element>
    </group>
 </block>
...
<block name="OTHERS">
    <group>
        <element>
            ...
            <info name="[VERSIONING_TOGGLE]">YES</info>
            <info name="[VERSIONING_LIMIT_DURATION]">5</info>
            <info name="VERSIONING_QUOTA_PER_PROJECT]">10</info>
            <info name="[VERSIONING_QUOTA_GLOBAL]">30</info>        
            ...
        </element>
    </group>
</block>

This entry is created automatically when Mapping 10.2.5 is installed and behond.

Their default values are :

  1. [VERSIONING_TOGGLE]: NO
  2. [FORMAT_REPOSITORY_DIR_FULLPATH]: /apps/mapping/map400/repository.
  3. [VERSIONING_LIMIT_DURATION]:  : No limit or 0
  4. [VERSIONING_QUOTA_PER_PROJECT]: No limit or 0
  5. [VERSIONING_QUOTA_GLOBAL]: No limit or 0


The "repository" folder is also created automatically.

Interface

Format versioning is available for Designer and Connect.

Designer Formats

In Mapping 9.1 and higher, go to Designer Formats Management:

In the Mapping menu, click on:
  1. Designer Formats Management
  2. Formats Management

The list of all available Designer formats is displayed.

OX S VERSIONING1.jpg

There you can manage the different versions of each given format by clicking on the i icon at the end of the line of icons.

The window below is displayed presenting all versions and the history of versions used:

OX S VERSIONING2.jpg

1 : Format
2 : Format version number
3 : User who last imported the format or used the rollback feature (always set to Auto
4 : Comment written during last rollback (Always set to manual rollback)
5 : Date and time the version was activated for the last time
6 : Date and time until which the version was last active
7 : Rollback button

V4 version rollback:

In this example, we want to restore version V4 by clicking on the Rollback button:

OX S VERSIONING3.jpg

This is the result:

OX S VERSIONING4.jpg

Version 4 of the format is activated.


Note: You can have a view of all formats and all versions. To do so, open the Formats History sub-menu under Designer Formats Management

OX S VERSIONING5.jpg

Connect Formats

Connect formats work the same as Designer formats. Please check the Designer formats section above.

Command Line

You can also manage format versions from the command line using the mapobjectversioncontrol binary.

Example:

// Save project KUHN with sequence 20 currently in production
mapobjectversioncontrol backup "KUHN" "00020"
// Restore project KUHN wit sequence 10 as it was in production on 27 April
mapobjectversioncontrol restore "2019-04-27T23:59:59.000Z" "KUHN" "00010"
// List of projects where different versions are available
mapobjectversioncontrol list

All actions that have an impact on the repository are versioned automatically.

Soon you will be able to restore using the version number like this:

 mapobjectversioncontrol restore "KUHN" "00010" v3

Special Case

Existing Formats

If there are existing formats in the environment (created through copying the contents of the MAP400 folder from an environment where there is no versioning system, or when upgrading from a version older than 9.1), version V0 of each format will not be saved in the versioning mechanism.

As a result, when importing the next version V1 of the format, version V1 will be saved but V0 will be lost.

To prevent this, before importing version V1, run the command below:

/apps/mapping/bin/mapobjectversioncontrol backup "format" "sequence"

This will create an entry for version V0 in the versioning system. The version will then be available in the Rollback management interface.