On peut vous aider ?

Cherchez des réponses ou parcourez les rubriques de notre documentation

Voir aussi:

< All Topics
Print

Automatisation via l’API Python

Introduction

Installer python >=3.7

Installer virtualenv

pip install virtualenv

Créer un répertoire de développement

mkdir /path/to/dev/folder
cd /path/to/dev/folder

Créer un environnement virtuel

Les environnements virtuels vous permettent d’avoir un espace isolé sur votre ordinateur pour les projets Python, ce qui garantit que chacun de vos projets peut avoir son propre ensemble de dépendances qui ne perturbera aucun de vos autres projets.

virtualenv venv_name

Activer l’environnement virtuel

. .\path\to\dev\folder\venv_name\Script\activate
Vous devrez peut-être autoriser l'exécution du script, ouvrez powershell en tant qu'administrateur
Set-ExecutionPolicy RemoteSigned
...
>> O

Désactiver l’environnement virtuel

deactivate

Pour installer Gt_Automation :

pip install gt_automation_x.x.x.whl

Informations de connexion

Les informations de connexion sont passées via un objet ConnectionInfo qui contient les champs suivants :

Paramètres

  • host (str) – nom du serveur ou adresse IP.
  • port (int) – instance ou port http du serveur.
  • gt_login (str) – nom de l’utilisateur qui se connecte à l’instance.
  • gt_password (str) – mot de passe de l’utilisateur.
  • tcp (bool, optional) – mode de communication : True pour tcp, False pour http, default si False.
  • ssl (bool, optional) – utilise ssl pour la connection tcp (default is False).
  • alias (str, optional) – nom de l’instance seulement pour http.
  • **kwargs (optional) – argument optionnel pour http, voir la documentation du paquet de requêtes, ne pas utiliser ‘param’ et ‘data’.

Exemples :

Voici quelques utilisations simples du package.

Pour le premier exemple, nous allons créer une interface utilisant la communication TCP :

from gt_automation import GtConnectionInfo

IP = '192.168.240.26'
PORT = 3000
GTLOGIN = 'nom de l'utilisateur'
GTPASSWORD = 'mot de passe'

cmd = GtConnectionInfo(IP, PORT, GTLOGIN, GTPASSWORD,tcp=True)

Il est également possible d’utiliser HTTP pour communiquer avec le serveur :

from gt_automation import GtConnectionInfo

IP = '192.168.240.27'
PORT = 80
GTLOGIN = 'nom de l'utilisateur'
GTPASSWORD = 'mot de passe'
ALIAS = 'Math'

cmd = GtConnectionInfo(IP, PORT, GTLOGIN, GTPASSWORD, ALIAS, tcp=False)


Notez que dans cet exemple, nous avons ajouté un autre alias d’argument, cet argument est utilisé pour spécifier le nom de l’instance cible. Lors de l’utilisation de la communication TCP, c’est le port de connexion qui remplit ce rôle.

Classes d’actions

Action de lancement de collecte : action_campaign_launch

action_campaign_launch(namemsgstatement_date=Noneglobal_redirect_address=''user_cypher=Falsewait_terminated=Falsetimeout=0)

Exécute l’action de lancement de campagne.

Paramètres
  • name (str) – nom de l’action
  • msg (GtMessage) – message à envoyer
  • statement_date (date) – date d’arrêté de la campagne
  • global_redirect_address (str, optional) –

Action d’intégration : action_campaign_integration

action_campaign_integration(namestatement_datewait_terminated=Falsetimeout=0)

Exécute l’action d’intégration.

Paramètres
  • name (str) – nom de l’action
  • statement_date (date) – date d’arrêté de la campagne
  • wait_terminated (bool, optional) – attendre la fin de l’exécution de l’action
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
          GtActionResult
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
  • GtActionExeption – Une erreur s’est produite pendant le traitement de l’action côté client ou côté serveur

Action de lancement de restitution : action_reporting

action_reporting(namemsgglobal_redirect_address=''wait_terminated=Falsetimeout=0)

Exécute la restitution d’une action.

Paramètres
  • name (str) – nom de l’action
  • msg (GtMessage) – message à envoyer
  • global_redirect_address (str, optional) –
1) Action de lancement de restitution de questionnaire : action_reporting_qst
action_reporting_qst(namemsgstatement_dateglobal_redirect_address=''wait_terminated=Falsetimeout=0)

Exécute the survey reporting action.

Paramètres
  • name (str) – nom de l’action
  • msg (GetMessage) – message à envoyer
  • statement_date (date) – date d’arrêté de la campagne
  • global_redirect_address (str, optional) –
2) Action de lancement de restitution de campagne : action_reporting_launch
action_restitution_launch(namemsgstatement_date=Noneglobal_redirect_address=''user_cypher=Falsewait_terminated=Falsetimeout=0)

Exécute une action de lancement de restitution de campagne.

Paramètres
  • name (str) – nom de l’action
  • msg (GetMessage) – message à envoyer
  • statement_date (date) – date d’arrêté de la restitution
  • global_redirect_address (str, optional) –

Action de script SQL : action_sql

action_sql(namewait_terminated=Falsetimeout=0)

Exécute une action de script SQL.

Paramètres
  • name (str) – nom de l’action
  • wait_terminated (bool, optional) – attendre la fin de l’exécution de l’action
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
GtActionResult
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
  • GtActionExeption – Une erreur s’est produite pendant le traitement de l’action côté client ou côté serveur

Action de fermeture de campagne : action_campaign_close

action_campaign_close(namemsgstatement_dateis_restitdefault_action_settingsattach_qstattach_histosend_messagewait_terminated=Falsetimeout=0)

Exécute une action de fermeture de campagne.

Paramètres
  • name (str) – nom de l’action
  • msg (GtMessage) – message à envoyer
  • statement_date (date) – date d’arrêté de la campagne
  • is_restit (bool) – la campagne ciblée est une restitution
  • default_action_settings (bool) – utiliser les paramètres d’action par défaut
  • attach_qst (bool) – joindre la dernière réponse ou la dernière enquête envoyée (ignoré si default_action_settings est true)
  • attach_histo (bool) – joindre l’historique de campagne (ignoré si default_action_settings est true)
  • wait_terminated (bool, optional) – attendre la fin de l’exécution de l’action
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
           GtActionResult
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
  • GtActionExeption – Une erreur s’est produite pendant le traitement de l’action côté client ou côté serveur

Action de relance : action_campaign_followup     

action_campaign_followup(model_namemsgstatement_datedefault_action_settingsattach_qstattach_histoselect_no_answersselect_pendingselect_invalidatedentities=[]wait_terminated=Falsetimeout=0)

Exécute une action de relance.

Paramètres
  • model_name (str) – model name
  • msg (GtMessage) – message à envoyer
  • statement_date (date) – date d’arrêté de la campagne
  • default_action_settings (bool) – utiliser les paramètres d’action par défaut
  • attach_qst (bool) – joindre la dernière réponse ou la dernière enquête envoyée (ignoré si default_action_settings est true)
  • attach_histo (bool) – joindre l’historique de campagne (ignoré si default_action_settings est true)
  • select_no_answers (bool) – envoyer un rappel aux entités qui ne répondent pas
  • select_pending (bool) – envoyer un rappel aux entités en attente de validation
  • select_invalidated (bool) – envoyer un rappel pour invalider les entités
  • entities (list of AnswerEntity) – liste des entités à contacter (default=[]), par défaut, relever toutes les entités
  • wait_terminated (bool, optional) – attendre la fin de l’exécution de l’action
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
           GtActionResult
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
  • GtActionExeption – Une erreur s’est produite pendant le traitement de l’action côté client ou côté serveur

Action combinée : action_combined

action_combined(namestatement_date=Nonewait_terminated=Falsetimeout=0)

Exécute une action combinée.

Paramètres
  • name (str) – nom de l’action
  • ( (statement_date) – obj:’datetime.Date’): statement_date used

Action de création d’utilisateurs : action_create_users

action_create_users(namewait_terminated=Falsetimeout=0)

Exécute une action de création d’utilisateurs.

Paramètres
  • name (str) – nom de l’action
  • wait_terminated (bool, optional) – attendre la fin de l’exécution de l’action
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
GtActionResult
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
  • GtActionExeption – Une erreur s’est produite pendant le traitement de l’action côté client ou côté serveur

Un autre exemple de commande statique consiste à créer un nouvel utilisateur et à lui donner des droits.

from gt_automation import GtUser, UserPrivilege

...

MODEL_NAME = 'Edit-Pays-Ville'

# Create the connection Info
cmd = GtConnectionInfo(IP, PORT, GTLOGIN, GTPASSWORD, ALIAS, False)
# create a new user
user = GtUser("test_user", "testtest", UserPrivilege.NONE)
user.must_change_pwd = True
user.add_model_group_couple(MODEL_NAME, "Valideur")
user.add_model_group_couple(MODEL_NAME, "Visualiseur")
# Insert the new user
cmd.insert_user(user)

Les commandes d’actions diffèrent des commandes statiques, elles prennent du temps pour se terminer, dans de nombreux cas, vous voudrez avoir le résultat final de l’action. Toutes les commandes d’action ont deux arguments supplémentaires wait_terminated (bool) et timeout (int) exprimés en minutes.

# start the polling action and wait maximum five minutes to get the result
poll_res = cmd.do_polling(True, 5)

Action de suppression de droit de réponse : action_remove_answer_rights

action_remove_answer_rights(namewait_terminated=Falsetimeout=0)

Exécute une action de suppression de droit de réponse.

Paramètres
  • name (str) – nom de l’action
  • wait_terminated (bool, optional) – attendre la fin de l’exécution de l’action
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
GtActionResult
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
  • GtActionExeption – Une erreur s’est produite pendant le traitement de l’action côté client ou côté serveur

Classes statiques

Gestion des messages : get_message_from_name

get_message_from_name(model_namemsg_name)

Obtient le message donné du modèle donné.

Paramètres
  • model_name (str) – nom du modèle
  • msg_name (str) – nom du message
Returns
GtMessage
Champs
ValueError – Une erreur s’est produite lors de la création de la commande

Gestion du polling : do_polling, is_polling et get_polling_log

1) Demande de polling
do_polling(wait_terminated=Falsetimeout=0)

Exécute la commande de polling.

Note

Si wait_terminated est défini à False, la commande retournera (-1, GtPollingStatus.NONE).

Paramètres
  • wait_terminated (bool, optional) – session id returned by the logon command (default = False).
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
un tuple contenant l’id du polling et le statut du polling.

Retour type

(int, GtPollingStatus)
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client

2) Polling en cours

is_polling()

Vérifie si une commande de polling est en cours.

Renvoie
Vrai si un polling est en cours.
Retour type
bool
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client

3) Log de polling

get_polling_log(poll_id)

Récupère les journaux du polling donné.

Paramètres
poll_id (int) – id du polling
Renvoie
chaîne contenant les journaux
Retour type
str
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client

Gestion des actions : get_action_log et get_action_status

1) get_action_log
get_action_log(action_id)

Récupère les journaux de l’action donnée.

Paramètres
action_id (int) – id de l’action
Renvoie
chaîne contenant les journaux
Retour type
str
ValueError – Une erreur s’est produite lors de la création de la commande
2) get_action_status »
get_action_status

Retourne le statut de l’action donnée.

Paramètres
answer_id (int) – id of the answer to retreive.
Renvoie
GtActionResult
Champs
ValueError – Une erreur s’est produite lors de la création de la commande

Gestion des campagnes : delete_campaign et list_campaign

1) Suppression de campagne : delete_campaign
delete_campaign(model_namestatement_dateis_restitdelete_histo)

Supprime la campagne donnée.

Paramètres
  • model_name (str) – nom du modèle
  • statement_date (date) – date d’arrêté de la campagne
  • is_restit (bool) – la campagne ciblée est une restitution
  • delete_histo (bool) – supprime l’historique de campagne
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
2) liste des campagnes : list_campaign
list_campaign()

Récupère la liste des campagnes de l’instance.

Renvoie
Liste de GtCampaign
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client

Gestion des réponses et des questionnaires

action_open_close_qst(namestatement_date=Nonewait_terminated=Falsetimeout=0)

Exécute l’action d’ouverture et de fermeture des questionnaires.

Paramètres
  • name (str) – nom de l’action
  • statement_date (date) – date d’arrêté de la restitution
  • wait_terminated (bool, optional) – attendre la fin de l’exécution de l’action
  • timeout (int, optional) – timeout par minute si wait_terminated est True
Renvoie
GtActionResult
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
  • GtActionExeption – Une erreur s’est produite pendant le traitement de l’action côté client ou côté serveur
1) Date de dernière réponse : last_answer_date_for_campaign
last_answer_date_for_campaign(model_namestatement_date)

Récupère la date de la réponse la plus récente pour la campagne donnée.

Paramètres
  • model_name (str) – nom du modèle
  • statement_date (date) – date d’arrêté de la campagne
Renvoie
date
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
2) Liste des réponses : list_answer
list_answer(model_namestatement_date)

Liste les réponses pour la campagne donnée.

Paramètres
  • model_name (str) – nom du modèle
  • statement_date (date) – date d’arrêté de la campagne
Renvoie
liste de AnswerEntities
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
3) Obtenir le questionnaire d’une réponse : get_answer
get_answer(dst_fileanswer_ideditable=False)

Sauvegarde la réponse donnée dans le fichier de destination.

Paramètres
  • dst_file (str) – Chemin vers le fichier où le qstx sera sauvegardé
  • answer_id (int) – l’identifiant de la réponse à récupérer
  • editable (boll, optional) – si True le qstx sera modifiable, sinon ce sera un aperçu
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
4) Obtenir un questionnaire envoyé : get_qst_sent
get_qst_sent(dst_fileqst_ideditable=False)

Enregistre l’enquête donnée dans le fichier de destination.

Paramètres
  • dst_file (str) – Chemin vers le fichier où le qstx sera sauvegardé
  • qst_id (int) – l’identifiant de la réponse à récupérer
  • editable (bool, optional) – si True le qstx sera modifiable, sinon ce sera un aperçu
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
5) Fermeture d’un questionnaire : close_qst
close_qst(qst_idpast_and_future=False)

Ferme l’enquête donnée.

Paramètres
  • qst_id (int) – id de l’enquête à fermer
  • past_and_future (bool) – si true refuse toute réponse future ou refuse toutes les réponses, y compris les réponses passées
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
6) Suppression d’une réponse : delete_anwser
delete_answer(answer_id)

Efface la réponse donnée.

Paramètres
answer_id (int) – l’identifiant de la réponse à récupérer
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client

Gestion des modèles

list_model() 

Gestion des projets

list_project() 

Gestion des utilisateurs

1) Création de nouveaux utilisateurs et affectation des droits pour ces nouveaux utilisateurs
insert_user(user)

Ajoute un nouvel utilisateur à l’instance.

Paramètres
user (GtUser) – utilisateur à ajouter
Champs
ValueError – Une erreur s’est produite lors de la création de la commande
2) Liste des utilisateurs
list_user()

Récupère la liste des utilisateurs de l’instance.

Renvoie
liste de GtUser
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
3) Modification des utilisateurs
edit_user(user)

Édite un utilisateur, l’identifiant de l’utilisateur doit être rempli.

Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
4) Suppression des utilisateurs
delete_user(id)

Supprime un utilisateur, l’identifiant de l’utilisateur doit être rempli.

Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client

Connexion avec le serveur

1) Établir la connexion avec le serveur.
logon()

Établir la connexion avec le serveur.

Note

La commande de connexion est incluse dans d’autres commandes.

Renvoie
identifiant de la session de connexion
Retour type
str
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
2) Couper la connexion avec le serveur
logout(sessionId)

Couper la connexion avec le serveur

Note

La commande de connexion est incluse dans d’autres commandes.

Paramètres
sessionId (str) – identifiant de session renvoyé par la commande de connexion
Renvoie
True si la déconnexion réussit.
Retour type
bool
Champs
  • ValueError – Une erreur s’est produite pendant la création de la commande ou l’analyse de la réponse
  • GtCommandExeption – Une erreur s’est produite pendant le traitement de la commande côté client
Was this article helpful?
0 out Of 5 Stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
How Can We Improve This Article?
Previous Déclencheurs
Table of Contents