Différence entre versions

Version actuelle datée du 10 décembre 2019 à 10:27

Autres langues :

English • ‎français

Sommaire

1 Introduction
2 Importing templates
3 Managing Formats using the UI
4 Launching a Project
5 Starting / Stopping the Development Engine
6 Extracting Definitions

Introduction

M-Connect is a module in the Onyx software suite that lets you extract and reprocess raw data in order to produce data files for use with the graphical composition engine (M-Designer). Using M-Connect, the document templates are designed on the PC and generated on the Onyx production server. On the server, you can import and manage the document templates created using M-Connect, administer the development engine, and extract table definitions from the database connected to Onyx Server.

Importing templates

Documents generated from M-Connect cannot be used "as is" on the production server. They need to be imported into Onyx Server first.

Import view

The import interface is divided into two parts: the templates generated using M-Connect, and the templates rolled out from another Onyx Server engine (called Archives).

In the example above:

Three templates are generated from M-Connect and are ready to be imported: ARRAYS, CHANGELOG and FRDEMOCSV formats.
Two templates have been rolled out from another Onyx Server instance: GENEDEMO and LOADDEMO formats.

Actions

Three actions are available for each template in either view:

Import template: imports the template's structure into the specified path. The imported format can then be used in the production environment, in the engine.
Delete template: deletes the template's structure without importing. If the format was used in production on the server, it won't be modified.
View template details: opens a window to see the objects and resources which make up the template.

Overwriting

In the case templates originating from M-Connect, when a template corresponds to a format that is already available on the production environment on the server, the Overwrite box appears. By ticking this box, the user forces the template to be imported, the existing format is then overwritten with the latest edits. When it comes to archives however, we are talking about planned roll-outs. As such, importing a rolled-out format will overwrite the format that is already on the server.

Managing Formats using the UI

This menu lists all M-Connect formats in production on the server. The formats are sorted alphabetically by name. The information available to the user is:

- Name = format name given in M-Connect

- Description = description associated with the format in M-Connect

- Date = date and time the format was imported for the last time on to the server.

Launching a Project

In this menu you can execute an M-Connect format manually. To do this, you need to:

- Select the format you want to execute

- Specify the output file's path

- Specify the format's input parameters, if any

- Click on Execute

Starting / Stopping the Development Engine

The two menus below are actions that let you start or stop M-Connect's Development engine. When started, the Development engine enables the Preview feature from the user's PC.

Extracting Definitions

This option extracts table definitions from the database Onyx Server is connected to. The definition files can then be imported into and used in M-Connect to serve as a basis for designing templates.

@@ Ligne 28 : / Ligne 28 : @@
 Three actions are available for each template in either view:
-*Importer le modèle : importe les structures du modèle dans l’arborescence de fichiers du serveur. Le format alors importé est utilisable en production dans le moteur.
+*Import template: imports the template's structure into the specified path. The imported format can then be used in the production environment, in the engine.
-*Supprimer le modèle : supprime les structures du modèle sans les importer. Si le même format était déjà en production sur le serveur, il n’est pas modifié.
+*Delete template: deletes the template's structure without importing. If the format was used in production on the server, it won't be modified.
-*Visualiser le détail du modèle : ouvre une fenêtre pour consulter la liste des objets composant le modèle.
+*View template details: opens a window to see the objects and resources which make up the template.
-===Notions d'écrasement===
+===Overwriting===
-Pour les modèles provenant de M-Connect, la case <FONT color="green"> Overwrite </FONT>  apparaît lorsqu’un modèle généré correspond à un format déjà disponible en production sur le serveur. Cette case doit être cochée pour forcer l’importation et elle a pour effet d’écraser le format existant avec les dernières modifications générées.
+In the case templates originating from M-Connect, when a template corresponds to a format that is already available on the production environment on the server, the <FONT color="green">Overwrite</FONT> box appears. By ticking this box, the user forces the template to be imported, the existing format is then overwritten with the latest edits.
-Pour les archives en revanche, il s’agit de déploiements. Nous considérons donc qu’ils sont voulus et maitrisés. L’importation d’un format déployé écrase donc systématiquement le format déjà présent sur le serveur.
+When it comes to archives however, we are talking about planned roll-outs. As such, importing a rolled-out format will overwrite the format that is already on the server.
-==Gestion des formats par l'interface management==
+==Managing Formats using the UI==
@@ Ligne 44 : / Ligne 44 : @@
-Cette interface dans la gestion M-Connect liste tous les formats en production sur le serveur. La liste est classée par ordre alphabétique des noms de formats. Les informations présentées à l’utilisateur sont respectivement :
+This menu lists all M-Connect formats in production on the server. The formats are sorted alphabetically by name. The information available to the user is:
-- Nom = nom du format donné dans l’application M-Connect,
+- Name = format name given in M-Connect
-- Description = description associée au format définie dans l’application M-Connect,
+- Description = description associated with the format in M-Connect
-- Date = date de dernière importation du format sur le serveur.
+- Date = date and time the format was imported for the last time on to the server.
-==Lancement d'un Projet==
+==Launching a Project==
 [[Fichier:OX S EXECREPORT.png|centré|sans_cadre|735x735px]]
@@ Ligne 59 : / Ligne 59 : @@
-Cette interface permet de lancer manuellement l’exécution d’un format M-Connect importé sur le serveur.
+In this menu you can execute an M-Connect format manually.
-Pour cela, il faut :
+To do this, you need to:
-- Sélectionner le format à exécuter,
+- Select the format you want to execute
-- Préciser le chemin du fichier de sortie,
+- Specify the output file's path
-- Renseigner les paramètres d’entrée éventuels du format,
+- Specify the format's input parameters, if any
-- Cliquer sur Exécuter.
+- Click on Execute
-==Démarrer / Arrêter le moteur de développement==
+==Starting / Stopping the Development Engine==
@@ Ligne 76 : / Ligne 76 : @@
-Les deux menus suivant ne sont que des actions qui servent à démarrer ou arrêter le moteur de développement M-Connect. Ce dernier est utilisé pour la fonctionnalité d’aperçu dans l’outil installé sur les postes utilisateurs.
+The two menus below are actions that let you start or stop M-Connect's Development engine. When started, the Development engine enables the Preview feature from the user's PC.
-==Extraction de définition==
+==Extracting Definitions==
 [[Fichier:OX S CNNCT EXTRACT.png|centré|sans_cadre|740x740px]]
-Cette option permet d’extraire les définitions de tables dans la base de données configurée au niveau de Onyx Server. Ces fichiers de définitions pourront, ensuite, être importés et utilisés dans l’application M-Connect pour aider à la conception des formats.
+This option extracts table definitions from the database Onyx Server is connected to. The definition files can then be imported into and used in M-Connect to serve as a basis for designing templates.