smoIntegration

Modifié le 23/11/2022 11:27

Note : Uniquement pour les clients On-Premise.

Definition

smoIntegration est l'outil utilisé pour exécuter les modèles d'intégration en dehors des tâches planifiées (i.e., en dehors de l'ordonnanceur smoScheduler de Service Manager).

EndDefinition
  • Il intègre les données externes en provenance de fichiers CSV.
  • Il peut être lancé à partir d'une ligne de commande pour tester / exécuter immédiatement le modèle d'intégration.
  • Il peut également être lancé à partir d'un script (Batch, Powershell, ...) exécuté via un ordonnanceur externe ou une application tierce pour une exécution planifiée.

Remarques

  • L'outil smoIntegration est livré sous la forme d'un exécutable situé dans le répertoire <easyvista>\smoIntegration (Note : <easyvista> identifie le répertoire EasyVista sur votre serveur applicatif).
    Si vous êtes client OnPremise, vous pouvez également le télécharger  - Open url.png voir Procédure

Attention

  • L'outil smoIntegration utilise le nom anglais des modèles d'intégration. Pensez à traduire les libellés pour bien identifier chaque modèle et éviter les doublons.
  • Si les données proviennent d'une base de données, vous devez les intégrer via un préimport avant de lancer le modèle d'intégration. À cet effet, utilisez l'outil smoBackOfficeClient qui peut être lancé par votre ordonnanceur externe.
  • Vous devez désactiver l'exécution du modèle d'intégration par l'ordonnanceur smoScheduler de Service Manager lorsque vous utilisez l'outil smoIntegration. Éditez le modèle via le menu Administration > Intégration > Modèles d'intégration et décochez la case Activée dans la fenêtre d'informations de planification.

Bonnes pratiques

Quand utiliser l'outil smoIntegration ?

  • Lorsque vous souhaitez tester un modèle d'intégration immédiatement. En effet, si vous utilisez l'ordonnanceur smoScheduler de Service Manager, le modèle est placé dans la file d'attente des traitements à exécuter, et s'exécute après les tâches en cours.
  • Lorsque vous souhaitez utiliser un ordonnanceur externe ou une application tierce, pour centraliser au sein d'un seul outil toutes les tâches planifiées et/ou disposer d'options de planification plus poussées.

     Open url.png voir procédure Comment automatiser une intégration en utilisant un ordonnanceur externe

Ligne de commande

Syntaxe

smoIntegration -account=CompanyAccount [-modelname="EnglishModelName"] [-ip=smoServerIpAddress] [-port=smoServerPort] [-test] [-list] [-listall] [-help]

Liste des paramètres

Paramètre obligatoire

Paramètre Description / Exemple
-account Compte Service Manager sur lequel les données doivent être intégrées.

exemple   40000 : base Test ; 50004 : base Production ; 50005 : base Sandbox

Paramètres optionnels

Paramètre Description / Exemple
-modelname Libellé anglais du modèle d'intégration.

Attention

  • Indiquez exclusivement le libellé anglais du modèle.
  • Renseignez le nom entre guillemets.
-ip Adresse IP du service smoServer.

Note : La valeur surcharge celle trouvée dans le fichier smoServer.ini (variable IP_ADDRESS_USED).

-port Port du service smoServer.

Note : La valeur surcharge celle trouvée dans le fichier smoServer.ini (variable IP_ADDRESS_USED).

-test Permet de tester la ligne de commande pour vérifier les paramètres, sans lancer l'intégration.
-list Affiche le libellé anglais de tous les modèles d'intégration existants.
-listall Affiche tous les libellés des modèles d'intégration existants.
–help ou /? Affiche l'aide de l'outil smoIntegration.

Liste des codes retours (Gestion des erreurs)

Code Description
0 Traitement réalisé sans erreur

Note : Un fichier de log est créé.

1 Le serveur n'est pas joignable.
2 Le service smoServer n'est pas trouvé.
3 Le modèle d'intégration n'est pas trouvé.
4 Un paramètre obligatoire est manquant.
9 Échec de l'intégration.

Note : Ce code erreur n'est jamais retourné avec le paramètre -test.

Exemples

Ligne de commande

  • Exécution du modèle d'intégration MD sur la base Test 40000, en utilisant le service smoServer à l'adresse 192.168.0.100
smointegration -account=40000 -modelname="MD" -ip=192.168.0.100 -port=22451
  • Affichage de tous les modèles d'intégration existants sur la base Test 40000, en utilisant le service smoServer à l'adresse 192.168.0.100
smointegration -account=40000 -ip=192.168.0.100 -port=22451 -list

Script (Fichier batch)

Best Practice icon.png  Vous pouvez adapter à votre environnement le fichier batch run_smoIntegration.bat fourni avec l'outil. Remplacez les variables -port = Port du smoServer, -ip = Adresse IP du serveur, -account = Compte de la base Service Manager (50004, 50005), -modelname = nom anglais du modèle

@echo off
cd\
cd "C:\smoIntegration"
@echo Integration is running... Please wait...
smoIntegration.exe -port=25238 -ip=127.0.01 -account=40000 -modelname="Test smoIntegration"   
pause

Procédure : Comment utiliser l'outil smoIntegration

Étape 1 : Installation de l'outil smoIntegration

1. Téléchargez le fichier ci-dessous sur votre ordinateur.
         Download icon.png  smoIntegration.rar

2. Décompressez le fichier .rar dans un répertoire c:\smoIntegration.

Étape 2 : Lancement du modèle d'intégration via l'outil smoIntegration

Attention : Vous devez désactiver l'exécution du modèle d'intégration par l'ordonnanceur smoScheduler de Service Manager lorsque vous utilisez l'outil smoIntegration. Éditez le modèle via le menu Administration > Intégration > Modèles d'intégration et décochez la case Activée dans la fenêtre d'informations de planification.

Exécution immédiate

1. Ouvrez une fenêtre d'invite de commande Windows.

2. Tapez la ligne de commande lançant l'outil smoIntegration, en spécifiant les paramètres souhaités  - Open url.png voir Exemple

Attention : Spécifiez le libellé anglais du modèle.

Best Practice icon.png  Vous pouvez adapter à votre environnement le fichier batch get_all_integration_models.bat fourni avec l'outil pour obtenir la liste des noms des modèles d'intégration en anglais.

Exécution via un script

1. Créez un fichier batch.

2. Insérez la ligne de commande pour exécuter le modèle d'intégration  - Open url.png voir Exemple

Best Practice icon.png  Vous pouvez adapter à votre environnement le fichier batch run_smoIntegration.bat fourni avec l'outil.

Tags :
Powered by XWiki © EasyVista 2022