Guide M3
6.7.1g
Absyss © 15/17, Boulevard du Général de Gaulle – 92120 Montrouge - +33 (0)1 40 84 89 01 - [Link]
SAS au capital de 500.000 € - RCS Nanterre B 353 281 561 – APE 5829A – FR 94 353 281 561
Visual TOM Guide M3
SOMMAIRE
1 Principes ........................................................................................................................................................................................................... 3
1.1 Introduction...................................................................................................................................................................................................... 3
1.2 Pré-requis ......................................................................................................................................................................................................... 3
1.3 Schéma de l’architecture en environnement AS400 ........................................................................................................................................ 4
1.4 Schéma de l’architecture en environnement Windows.................................................................................................................................... 4
1.5 Principes de fonctionnement ........................................................................................................................................................................... 4
2 Installation ........................................................................................................................................................................................................ 5
2.1 Contenu du package ......................................................................................................................................................................................... 5
2.2 Installation du package ..................................................................................................................................................................................... 5
2.3 Paramétrage ..................................................................................................................................................................................................... 7
2.4 Aide à la mise en œuvre sur M3 ....................................................................................................................................................................... 8
3 Mise en œuvre pour exécution d’un Traitement ............................................................................................................................................ 11
3.1 Introduction.................................................................................................................................................................................................... 11
3.2 Principe de paramétrage des Traitements sous Visual TOM .......................................................................................................................... 11
3.3 Serveur applicatif et modèle de Traitement ................................................................................................................................................... 12
Absyss ©
Réf :Visual TOM Guide M3 2/13
Visual TOM Guide M3
1 PRINCIPES
1.1 INTRODUCTION
La terminologie employée dans ce manuel est la suivante :
• tâche : terme générique désignant un travail à exécuter,
• Traitement : terme désignant l’objet Visual TOM pour l’exécution d’une tâche,
• Travail : terme désignant un travail sous M3 pour l’exécution d’une tâche.
Le module interface Visual TOM – M3 assure la communication avec le progiciel M3. Il permet la planification et
l’ordonnancement des types de tâches planifiées.
1.2 PRÉ-REQUIS
Le module d’interface Visual TOM / M3 est opérationnel pour toutes les versions de Visual TOM. Le module
d’interface Visual TOM / M3 fonctionne avec à partir de la version 10, quelque soit le système d’exploitation et la
base de données.
Java 1.6 minimum doit être opérationnel sur le serveur Windows hébergeant l’agent Visual TOM.
Les utilitaires Java doivent être disponibles dans le « path » de l'administrateur de Visual TOM.
Pour dialoguer avec la base de données, un compte est nécessaire. Ce compte doit disposer de droits d’exécution sur
l’api ZJBCTLMI (fonction M3 SES005).
Le planificateur M3 doit donc être opérationnel. Les travaux ordonnancés doivent être historisés (paramétrage M3)
pour que Visual TOM puisse en assurer le suivi.
L’administrateur M3 doit être disponible pour réaliser les actions d’installation sur M3.
Restrictions d’usage :
• Les jobs qui sont exécutés via Visual TOM ne doivent pas être exécutés par l’utilisateur.
• Le même traitement ne peut pas être exécuté plusieurs fois simultanément en raison d’un risque de
deadlock dans M3.
• Les paramètres (exemple : la société) doivent être déclarés lors de la création du travail.
• Le jeu de caractères pour définir les paramètres du Traitement Visual TOM sont les suivants : caractères
alpha-numériques pour la fonction et l’utilisateur, caractères alpha-numériques et espace pour la
désignation.
• Après une première soumission via Visual TOM, le job ne doit pas être modifié par l’utilisateur dans SHS010.
Pour être ordonnancé par Visual TOM, un Travail doit exister (création avec la transaction SHS030).
Si le Traitement ne doit plus jamais être soumis, sa planification doit être supprimée via SHS010.
La visibilité des serveurs applicatifs et Modèles de Traitements sont soumis au contenu du fichier de licence.
Absyss ©
Réf :Visual TOM Guide M3 3/13
Visual TOM Guide M3
1.3 SCHÉMA DE L’ARCHITECTURE EN ENVIRONNEMENT AS400
Architecture de fonctionnement du module VTOM/M3
1.4 SCHÉMA DE L’ARCHITECTURE EN ENVIRONNEMENT WINDOWS
Architecture de fonctionnement du module VTOM/M3
1.5 PRINCIPES DE FONCTIONNEMENT
Il est nécessaire d’installer un agent Visual TOM.
Afin d'assurer le dialogue avec le progiciel, un contexte d’exécution personnalisé (la Queue batch) et un module
spécifique doivent être mis en place.
L’api fournie dans le package Visual TOM doit être chargée dans un des composants M3.
Le principe de création, d’exécution et de lancement des tâches M3 par Visual TOM se réalise par la définition d’un
Traitement Visual TOM envoyant des paramètres personnalisés à un module de communication VTOM/M3 situé sur
la machine hébergeant l’Agent Visual TOM. Ce programme dialogue avec l’Api chargée dans M3. Il en résulte
l’exécution d’un Travail M3.
Les Asynchrones M3 doivent être opérationnels.
Absyss ©
Réf :Visual TOM Guide M3 4/13
Visual TOM Guide M3
2 INSTALLATION
2.1 CONTENU DU PACKAGE
Sur le DVDROM, le répertoire du package contient les fichiers suivants :
• submit_queue_m3.bat (modèle de Queue Batch),
• [Link] (programme de communication vers M3),
• HFIX_Absyss_CUS1.ZIP (api à charger dans M3),
• HFIX_Absyss_CUS2.ZIP (api à charger dans M3).
2.2 INSTALLATION DU PACKAGE
2.2.1 Visual TOM
Les fichiers « submit_queue_vt2m3.bat » et « [Link] » sont à copier dans le répertoire indiqué par la variable
d'environnement %ABM_BIN% (implicitement « C:\vtom\abm\bin »).
Dans la section « [BDAEMON] » du fichier « [Link] », modifiez le paramètre « ABM_QUEUES= » en y ajoutant la
Queue Batch pour M3 :
ABM_QUEUES=/queue_wnt:20 /queue_vt2m3:n
La valeur « n » est le nombre de traitements simultanés acceptés par l’Agent Visual TOM.
2.2.2 M3
L’administrateur M3 doit définir le composant dans lequel doit être installé le package de communication. Si le
package de destination est différent de « CUS », il faut renommer le package en remplaçant « CUS » par le nom du
package de destination, puis :
• utilisez « LCM » pour charger les packages (CUS1 puis CUS2),
• utilisez le « server view » pour vérifier l’installation ; recherchez la classe « ZJBCTLMI » (modification
BFINE106).
Absyss ©
Réf :Visual TOM Guide M3 5/13
Visual TOM Guide M3
Vérification de l’installation
La planification doit être autorisée dans les propriétés de l’instance M3 ([Link]=1). Si le paramètre
est à 0, modifiez sa valeur à 1 et redémarrez l’instance.
Il est conseillé de dédier une file d’attente (via MNS300) afin que le job ne reste pas bloqué en attente d’exécution.
L’historique des jobs doit être validé (MNS310) ; pour cela la case « Save job hist » doit être cochée.
Validation de l’historisation des exécutions
Absyss ©
Réf :Visual TOM Guide M3 6/13
Visual TOM Guide M3
2.3 PARAMÉTRAGE
Le fichier représentant la Queue batch (« submit_queue_m3.bat ») doit être paramétré comme indiqué ci-
dessous dans l’appel au binaire [Link] :
• - m3server =xxx # nom du serveur hébergeant M3
• - m3port =xxx # numéro de port pour connexion
• - m3user =xxx # utilisateur de connexion
• -m3password=xxx # mot de passe de l’utilisateur de connexion
• - jobname=xxx # nom du travail M3 (premier paramètre du Job)
• - jobuser=xxx # utilisateur d’exécution (deuxième paramètre du Job)
• - joblabel=30000 # désignation du travail M3 (troisième paramètre du Job)
• - pooling =5000 # cycle de vérification du statut du travail, en millisecondes
• - timeout=3600000 # temps maximum à l’issue duquel le traitement est considéré en erreur, en
millisecondes
echo Arguments : %TOM_SCRIPT_ARGS%
echo.
java -jar %ABM_BIN%\[Link] -m3server=[Link] -m3port=6800
-m3user=USER4 -m3password=user4 -jobname=%1 -jobuser=%2 -joblabel=%3
-pooling=5000 -timeout=3600000
echo Code retour : %ERRORLEVEL%
if %ERRORLEVEL% leq 0 goto TERMINE
goto ERREUR
Exemple d’extrait de la queue batch pour exécution d’un travail
Absyss ©
Réf :Visual TOM Guide M3 7/13
Visual TOM Guide M3
Remarques :
• La déclaration du serveur applicatif est réalisée directement depuis l’interface, avec les principaux
paramètres ci-dessus.
• Le connecteur écrit dans le fichier « .\log\[Link] ». l’utilisateur de soumission doit disposer des droits
nécessaires à l’écriture de ce fichier.
2.4 AIDE À LA MISE EN ŒUVRE SUR M3
Les principales transactions M3 à utiliser sont les suivantes :
• SHS030 pour créer le travail dans le planificateur M3 (pré-requis).
• SHS010 pour vérifier la planification d’un Travail.
• MNS320 pour afficher l’historique d’un Travail.
Autorisez la planification du job à soumettre en SHS030. Créez une instance sur le nom de la fonction et le profil qui
planifiera. La catégorie et l’application n’ont pas d’importance, ils ne sont ni contrôlés ni utilisés.
Les paramètres de type date sont gérés nativement par M3 (SHS030).
Exemple de création d’un travail
Planifiez le job. Utilisez l’interactif ; si le paramétrage est correct, l’écran SHS010 doit apparaître. Saisissez les
paramètres d’exécution puis validez jusqu’à l’obtention de l’écran de planification :
• Dans la zone « On day » saisir le numéro du jour précédent ; il est impératif d’exécuter le job avec Visual
TOM avant cette date (délai d’un mois).
• Dans la zone « Description » identifiez le job de façon unique ; cette désignation est utilisée par l’api.
• Les jobs planifiés sont visibles via SHS010, les dates et heures d’exécution sont visibles dans la table
« [Link] ».
Absyss ©
Réf :Visual TOM Guide M3 8/13
Visual TOM Guide M3
Exemple de planification d’un travail
2.4.1 Codes de retour du connecteur vtom2m3
Les codes retour sont les suivants :
0 OK (code 30 sur M3)
1 Absence des paramètres
2 Paramètre invalide
3 Absence d’un paramètre obligatoire
4 Erreur de connection M3
5 Erreur de soumission dans M3
6 Erreur de timeout
7 API non initialisée
25 Job en erreur dans M3
98 Erreur M3 inattendue
99 Erreur inattendue
Absyss ©
Réf :Visual TOM Guide M3 9/13
Visual TOM Guide M3
2.4.2 Statut des travaux sous M3
Les statuts M3 sont les suivants :
00 Le travail n'a pas commencé.
15 Le travail ne peut pas commercer.
20 Le travail est en cours.
25 Le travail contient une erreur.
30 Le travail est bien terminé.
Absyss ©
Réf :Visual TOM Guide M3 10/13
Visual TOM Guide M3
3 MISE EN ŒUVRE POUR EXÉCUTION D’UN TRAITEMENT
3.1 INTRODUCTION
Le module interface Visual TOM – M3 permet l'intégration avec le progiciel M3.
Il permet la planification et l’ordonnancement des tâches M3 sans passage de paramètres applicatifs, ceux-ci étant
gérés soit par les utilisateurs, soit préparés dans le planificateur et prêts pour soumission.
3.2 PRINCIPE DE PARAMÉTRAGE DES TRAITEMENTS SOUS VISUAL TOM
La mise en œuvre consiste à créer un Traitement Visual TOM muni de paramètres spécifiques.
La description du Traitement doit s’inscrire selon la procédure suivante :
• Le champ « Script » doit contenir le nom d’un script quelconque qui doit exister sur la machine où est installé
l’agent Windows gérant l’interface avec M3.
• Le champ « Utilisateur » doit contenir le nom d’un utilisateur connu du système d’exploitation où se trouve
l’agent, si la gestion des utilisateurs en mise en œuvre sur l’agent Windows.
• Le champ « Unité de soumission » doit contenir le nom de celle qui référence l’Agent Visual TOM.
• Le champ « Queue batch » doit contenir la queue batch m3 configurée lors de la phase d’installation.
• Les paramètres du Traitement Visual TOM doivent contenir les 3 paramètres nécessaires à l’identification du
Travail M3 :
o Paramètre 1 : Fonction
o Paramètre 2 : Utilisateur M3
o Paramètre 3 : Description du Travail
Exemple de Traitement Visual TOM pour exécution d’un travail M3
Remarques :
• La taille maximum du label (paramètre 3) est de 30 caractères.
• Lorsque le troisième paramètre contient des blancs significatifs, il doit être encadré par des doubles quotes.
Absyss ©
Réf :Visual TOM Guide M3 11/13
Visual TOM Guide M3
Exemple de log d’exécution du Traitement Visual TOM
Remarque :
Les traitements sont modélisables dans l’interface à partir du Modèle de Traitement M3. Le Serveur applicatif est
défini dans l’interface.
3.3 SERVEUR APPLICATIF ET MODÈLE DE TRAITEMENT
La déclaration du Serveur applicatif et l’utilisation du Modèle de Traitement sont réalisables directement depuis
l’interface graphique, en fonction du contenu du fichier de licence.
Le comportement d’exécution (queue batch) est défini lors de l’installation de l’agent Visual TOM.
Lors de la création d’un traitement depuis un Modèle, l’interface propose d’associer la queue batch appropriée, si
cette action n’a pas déjà été réalisée.
Absyss ©
Réf :Visual TOM Guide M3 12/13
Visual TOM Guide M3
Fenêtre de déclaration d’un Serveur applicatif
Fenêtre de déclaration d’un Traitement
Absyss ©
Réf :Visual TOM Guide M3 13/13
