Intégrations

La page Integrations contient les connexions qu’utilise TrakIT pour joindre d’autres systèmes : les serveurs SMTP par lesquels il envoie les e-mails, les serveurs FTP sur lesquels il enregistre des fichiers, les canaux par lesquels il envoie des messages texte et des messages instantanés, les API web auxquelles les actions de workflow envoient des données, et les compagnies maritimes qu’il interroge sur les événements des conteneurs.

Pour l’ouvrir, sélectionnez Admin > Integrations. Seuls les administrateurs système peuvent l’ouvrir.

La page a cinq onglets. Elle s’ouvre sur SMTP.

SMTP : les serveurs par lesquels TrakIT envoie les e-mails.
FTP : les serveurs FTP et SFTP sur lesquels TrakIT enregistre des fichiers.
Messaging : les canaux SMS, WhatsApp et de discussion de groupe.
API : les appels aux API web d’autres systèmes.
DCSA : le suivi des transporteurs avec les API DCSA Track & Trace des compagnies maritimes.

Dans chaque onglet, sélectionnez une ligne pour l’ouvrir. Dans les onglets SMTP, FTP, Messaging et API, les lignes inactives apparaissent en rouge.

Onglet SMTP

TrakIT envoie tous ses e-mails, comme les notifications, les rapports et les documents, par un serveur SMTP. Chaque société envoie par le SMTP Server choisi sur sa page de société. Les e-mails d’une société qui n’a pas de serveur propre, et les e-mails qui n’appartiennent à aucune société, passent par le premier serveur actif de la liste.

Le serveur dont l’ID est 1 est [System Default]. C’est le support TrakIT qui s’en occupe : vous ne pouvez ni l’ouvrir ni le supprimer.

Colonne	Affiche
ID	Le numéro du serveur.
Title	Le nom du serveur, tel que la page de la société le liste.
Host, User, Port	L’endroit où TrakIT se connecte et le compte avec lequel il se connecte.
Encryption	SSL, ou None.
Subject Prefix	Le texte placé avant l’objet de ses e-mails. Default en gris : le préfixe par défaut de votre installation.
Sender	Le nom de l’expéditeur, avec l’adresse de l’expéditeur en dessous.
Max Conn	Le nombre de connexions que TrakIT ouvre vers lui en même temps.
Updated By	La personne qui a modifié le serveur en dernier, et quand.

Créer ou modifier un serveur SMTP

Sélectionnez Create, ou sélectionnez un serveur dans la liste. La fenêtre Create SMTP Server ou Modify SMTP Server s’ouvre.
Renseignez les champs ci-dessous.
Pour vérifier les paramètres, sélectionnez Send Test Email. TrakIT envoie un e-mail de test à l’adresse de votre propre compte utilisateur, avec les paramètres tels qu’ils sont dans la fenêtre, enregistrés ou non. Si cela fonctionne, TrakIT affiche SMTP connection succeeded et indique l’adresse ; sinon, il affiche l’erreur du serveur.
Sélectionnez Create, ou Save pour un serveur qui existe déjà.

Champ	Ce qu’il faut saisir
Title	Un nom pour le serveur. Obligatoire, et différent des titres des autres serveurs.
Host	Le nom d’hôte du serveur SMTP. Obligatoire.
User	Le nom d’utilisateur du compte avec lequel TrakIT se connecte.
Password	Le mot de passe du compte.
Port	Le port auquel se connecter. Laissez-le vide pour utiliser le port par défaut.
Encryption	Activé pour se connecter en SSL/TLS.
Subject Prefix	Le texte placé avant l’objet de chaque e-mail envoyé par ce serveur, à la place du préfixe par défaut de votre installation. `#CLIENT#` est remplacé par le nom de votre installation. Laissez-le vide pour conserver le préfixe par défaut.
Sender Email	L’adresse d’où proviennent les e-mails. Obligatoire.
Sender Name	Le nom sous lequel les e-mails sont envoyés. Obligatoire.
Reply To	Les adresses auxquelles les réponses doivent être envoyées, séparées par des virgules. Laissez-le vide pour que les réponses aillent à l’adresse de l’expéditeur.
Max Connections	Le nombre de connexions que TrakIT ouvre vers ce compte en même temps, de 1 à 25. Les nouveaux serveurs démarrent à 3, ce qu’autorise Office 365 ; certains services d’e-mail en autorisent davantage. Les serveurs qui ont le même hôte et le même utilisateur partagent cette limite.
Active	Désactivez-le pour ne plus utiliser le serveur. Les e-mails qui passeraient par un serveur inactif ne sont pas envoyés.

Pour supprimer un serveur, ouvrez-le et sélectionnez le X en bas à gauche. Un serveur qu’une société utilise encore ne peut pas être supprimé : TrakIT affiche Unable to delete server.

Si un e-mail ne peut pas être envoyé à cause d’un problème de connexion ou de serveur, TrakIT réessaie de lui-même. Le journal des messages affiche chaque e-mail que TrakIT a envoyé et la raison de l’échec d’un e-mail.

Onglet FTP

TrakIT enregistre des fichiers sur un serveur FTP ou SFTP pour :

les actions d’événements et de données du type Save to FTP Location, qui enregistrent un message ou un document généré lorsqu’un événement ou un champ de données est mis à jour (voir Définitions d’événements et de données) ;
les rapports livrés By FTP : les rapports de requête et les abonnements aux rapports avancés ;
sur certaines installations, la lecture de fichiers de tarifs dans un répertoire SFTP (voir Feeds).

La liste est triée par titre.

Colonne	Affiche
ID, Title	Le numéro et le nom du serveur.
Host, User, Port	L’endroit où TrakIT se connecte et le compte avec lequel il se connecte.
Type	SFTP, ou FTP/FTPS.
Encryption	SSH pour SFTP ; sinon None, Implicit (SSL) ou Explicit (TLS).
Updated By	La personne qui a enregistré le serveur en dernier, et quand.
Last Attempt	Le moment de la dernière connexion de TrakIT, avec Success en vert ou l’erreur en rouge. - s’il ne s’est jamais connecté.

Créer ou modifier un serveur FTP

Sélectionnez Create, ou sélectionnez un serveur dans la liste. La fenêtre Create FTP Server ou Modify FTP Server s’ouvre.
Renseignez les champs ci-dessous.
Pour vérifier les paramètres, sélectionnez Test Connection. TrakIT charge un petit fichier, TrakIT-FTP-Test.txt, dans le répertoire de travail puis le supprime, avec les paramètres tels qu’ils sont dans la fenêtre, enregistrés ou non. Si cela fonctionne, TrakIT affiche FTP connection succeeded.
Sélectionnez Create, ou Save pour un serveur qui existe déjà.

Champ	Ce qu’il faut saisir
Title	Un nom pour le serveur, différent des autres. Lettres, chiffres, espaces et `- ' ( ) [ ]`.
Host	Le nom d’hôte du serveur. Obligatoire.
User, Password	Le compte avec lequel TrakIT se connecte.
Port	Le port, pour FTP et FTPS. Laissez-le vide pour utiliser le port par défaut.
Is SFTP	Activé pour un serveur SFTP (SSH). Désactivé pour FTP ou FTPS.
Encryption	Pour FTP et FTPS : None, Implicit (SSL) ou Explicit (TLS).
SSL Protocol	Pour FTPS : le protocole à utiliser, ou [Default].
Working Directory	Le répertoire dans lequel TrakIT travaille sur le serveur. Les fichiers y sont enregistrés.
Ignore Cert. Error	Pour FTPS : activé pour accepter le certificat du serveur même s’il n’est pas valide.
Active	Désactivez-le pour ne plus utiliser le serveur : l’enregistrement de fichiers sur ce serveur échoue alors avec FTP Server is disabled.

Pour supprimer un serveur, ouvrez-le et sélectionnez le X en bas à gauche. Un serveur vers lequel un rapport de requête ou un abonnement à un rapport avancé effectue sa livraison ne peut pas être supprimé : TrakIT affiche Unable to delete server. Les actions d’événements et de données ne sont pas vérifiées : modifiez d’abord toute action qui enregistre sur ce serveur.

Onglet Messaging

Un canal de messagerie est un service par lequel TrakIT envoie des messages courts :

SMS et WhatsApp envoient au numéro de mobile d’une personne ;
Google Space, MS Teams, Telegram et Discord publient dans un espace, un canal ou une discussion de groupe partagés.

TrakIT utilise les canaux pour :

Les notifications. Un canal actif avec User Specific activé apparaît comme colonne sur la page Notifications des utilisateurs de sa société (ou de toutes les sociétés), pour que chaque utilisateur puisse choisir de recevoir des notifications sous forme de messages texte à son numéro de mobile.
Les actions d’événements et de données. Une action du type Send Message envoie son message par un canal de la société du workflow ou de toutes les sociétés. Les SMS et les messages WhatsApp vont aux numéros des destinataires ; les autres canaux publient dans leur espace ou leur discussion. Voir Définitions d’événements et de données.
Les codes de connexion. Les utilisateurs dont l’authentification à deux facteurs est SMS And Email reçoivent aussi leur code par SMS, par le canal SMS de leur société ou, à défaut, par un canal destiné à toutes les sociétés. Voir Authentification à deux facteurs.

TrakIT met chaque message en file d’attente et envoie la file chaque minute. L’onglet Messages Sent du journal des messages les liste.

Colonne	Affiche
ID, Title	Le numéro et le nom du canal.
Vendor Type	SMS, WhatsApp, Google Space, MS Teams, Telegram ou Discord.
Code	Le code du fournisseur.
Office	La société à laquelle le canal est destiné. Vide pour toutes les sociétés.
URL, Sender	L’adresse et l’expéditeur du canal.
Created	La personne qui a créé le canal, et quand.

Les canaux configurés par le support TrakIT apparaissent en gris, et vous ne pouvez pas les ouvrir.

Créer ou modifier un canal de messagerie

Sélectionnez Add New, ou sélectionnez un canal dans la liste. La fenêtre Create Messaging Channel ou Modify Messaging Channel s’ouvre.
Choisissez le Type. La fenêtre affiche les champs qu’utilise ce type.
Renseignez les champs ci-dessous.
Sélectionnez Create, ou Update pour un canal qui existe déjà.

Champ	Ce qu’il faut saisir
Type	SMS, WhatsApp, Google Space, MS Teams, Telegram ou Discord. Il ne peut plus être modifié une fois le canal créé.
Title	Un nom pour le canal. Obligatoire.
Company	La société à laquelle le canal est destiné, ou — Select — pour toutes les sociétés.
URL	Pour SMS : l’adresse du fournisseur pour envoyer un message, avec `[RECP]` à l’endroit où va le numéro de mobile et `[MSG]` à l’endroit où va le texte. TrakIT l’appelle pour chaque message. Pour Google Space, MS Teams et Discord : l’adresse du webhook entrant de l’espace ou du canal. Doit commencer par `https://`. Non utilisé pour WhatsApp.
Vendor Code	Obligatoire pour SMS et WhatsApp : lettres, chiffres et traits de soulignement. Seul WhatsApp l’utilise, et il doit alors être `GUPSHUP`, le fournisseur WhatsApp que TrakIT prend en charge.
API Key	Pour WhatsApp : la clé d’API du fournisseur.
Params:	Pour WhatsApp : le nom de l’application enregistrée auprès du fournisseur.
Sender	Pour WhatsApp : le numéro depuis lequel les messages sont envoyés. Lettres, chiffres, `-` et `_`.
Chat ID	Pour Telegram : la discussion dans laquelle publier. Obligatoire.
Bot Token	Pour Telegram : le jeton de votre propre bot. Laissez-le vide pour publier en tant que TrakIT Telegram Bot.
Active	Désactivez-le pour arrêter les envois : les messages en file d’attente pour le canal sont marqués comme ayant échoué avec Channel is not active.
User Specific	Activé pour les canaux qui envoient des messages à des utilisateurs individuels, comme SMS et WhatsApp : les utilisateurs peuvent alors les choisir sur leur page Notifications. Désactivé pour les canaux partagés, comme Google Space, MS Teams, Telegram et Discord.

SMS n’utilise que l’URL : Vendor Code, API Key, Params: et Sender sont pour WhatsApp.

Pour supprimer un canal, ouvrez-le et sélectionnez le X en bas à gauche.

Onglet API

Une intégration d’API décrit un appel à l’API web d’un autre système : son adresse, la façon dont TrakIT se connecte, et ce qu’il envoie. Les actions d’événements et de données du type Post to API effectuent l’appel, par exemple pour envoyer les détails d’un ordre de travail ou un document généré au système d’un client lorsqu’un événement est réalisé. Une action peut utiliser les intégrations actives de la société de son workflow et celles destinées à toutes les sociétés. Voir Définitions d’événements et de données.

Cet onglet sert aux appels que TrakIT fait à d’autres systèmes. Pour les autres systèmes qui appellent TrakIT, voir la référence de l’API.

Colonne	Affiche
ID, Title, Code	Le numéro, le nom et le code de l’intégration.
Office	La société à laquelle elle est destinée. All en gris : toutes les sociétés.
Endpoint	La méthode, en gras, et l’adresse appelée.
Auth, Body	L’Auth Type et le Body Mode.
Updated By	La personne qui l’a modifiée en dernier, et quand.
Last Call	Le moment du dernier appel, avec Success en vert ou l’erreur en rouge. - s’il n’y en a jamais eu.

Créer ou modifier une intégration d’API

Sélectionnez Add New, ou sélectionnez une intégration dans la liste. La fenêtre Create API Integration ou Modify API Integration s’ouvre.
Renseignez les champs ci-dessous. Choisir l’Auth Type, le Body Mode ou le File Mode affiche les champs dont ils ont besoin.
Pour ajouter un en-tête ou un paramètre, sélectionnez + Add Parameter et renseignez la nouvelle ligne.
Pour essayer l’appel, sélectionnez Test Call (voir Tester l’appel).
Sélectionnez Create, ou Save pour une intégration qui existe déjà.

Pour supprimer une intégration, ouvrez-la et sélectionnez le X en bas à gauche. Les actions qui l’utilisent échouent alors avec API Integration not found : modifiez-les d’abord.

Général

Champ	Ce qu’il faut saisir
Title	Un nom, différent des titres des autres intégrations. Lettres, chiffres, espaces et `- ' ( ) [ ]`.
Code	Une clé courte, différente des autres : lettres, chiffres et traits de soulignement. TrakIT l’enregistre en majuscules, sans espaces.
Endpoint	L’adresse à appeler. Elle doit commencer par `https://`, et peut contenir des espaces réservés comme `[WOID]`.
Company	La société à laquelle elle est destinée, ou — Select — pour toutes les sociétés.
Method	GET, POST, PUT, PATCH ou DELETE. Les nouvelles intégrations démarrent sur POST.

Authentification

Auth Type	Comment TrakIT se connecte
None	Il ne se connecte pas.
Basic	Avec un User et un Password.
Bearer	Avec un Token.
API Key	Avec une Key Value, envoyée dans l’en-tête ou le paramètre de requête nommé dans Key Name. Key Sent In vaut Header ou Query.
OAuth2 Client Credentials	TrakIT obtient un jeton d’accès auprès de la Token URL avec le Client ID et le Client Secret, et l’envoie avec chaque appel.
OAuth2 Refresh Token	Comme ci-dessus, avec le Refresh Token que vous saisissez. Lorsque le fournisseur émet un nouveau jeton d’actualisation, TrakIT conserve le nouveau.
OAuth2 Password	TrakIT obtient le jeton d’accès avec un Username et un Password. Aucun secret client n’est envoyé : si le fournisseur a besoin d’un ID client, ajoutez-le dans Extra Token Fields, par exemple `client_id=yourapp`.

Les types OAuth2 ont aussi ces champs :

Champ	Ce qu’il faut saisir
Token URL	L’adresse de jeton du fournisseur. Elle doit commencer par `https://`.
Scope	Les étendues à demander, séparées par des espaces. Facultatif.
Credentials Sent As	Basic Auth Header ou Client Secret In Body : la façon dont l’ID client et le secret sont envoyés à l’adresse de jeton.
Extra Token Fields	D’autres champs pour la demande de jeton, sous la forme `name=value&name=value`.
Token Status	Le jeton d’accès que détient TrakIT : No token yet, Valid until une heure, Expired, ou l’erreur de la dernière tentative.

TrakIT obtient un nouveau jeton d’accès lorsqu’il n’en a pas ou que celui qu’il détient expire dans moins de 5 minutes.

Le Password, le Token, la Key Value, le Client Secret et le Refresh Token sont stockés chiffrés et ne sont plus jamais affichés. À côté du champ, (configured) signifie qu’une valeur est stockée et (not set) qu’aucune ne l’est. Laissez le champ vide pour conserver la valeur stockée.

Corps et fichier

Le fichier est ce que l’action envoie : son message, ou le document qu’elle génère.

Champ	Ce qu’il faut saisir
Body Mode	None : pas de corps. JSON : le Payload Template, au format JSON. Form URL Encoded : les paramètres Form Field. Multipart : les paramètres Form Field et le fichier, en tant que parties. Raw : le Payload Template tel quel, ou le fichier lui-même.
File Mode	None : pas de fichier. Multipart Part : le fichier comme partie d’un corps Multipart. Base64 In Template : le fichier, encodé en base64, à l’endroit où `[FILE]` figure dans le Payload Template d’un corps JSON, ou dans un Form Field d’un corps Form URL Encoded ; jusqu’à 10 Mo. Raw Body : le fichier lui-même est le contenu d’un corps Raw.
Content Type	Pour Raw : le type de contenu, par exemple `application/xml`. Obligatoire avec Raw Body.
File Field Name	Pour Multipart Part : le nom de la partie du fichier. `[FILENOEXT]` est le nom du fichier sans son extension.
File Name	Le nom sous lequel envoyer le fichier, s’il doit différer de son propre nom. Les espaces réservés sont autorisés, par exemple `[WOID]_[NAME].pdf`.
Payload Template	Pour JSON et Raw : le corps à envoyer, avec des espaces réservés.

Lorsqu’une action effectue l’appel, TrakIT remplit d’abord le Payload Template comme un modèle de formulaire : il peut donc aussi utiliser les balises d’ordre de travail et de dossier des définitions de formulaires. Dans un corps JSON, les valeurs que TrakIT insère sont échappées pour qu’elles ne puissent pas casser le JSON.

Ces espaces réservés fonctionnent dans l’Endpoint, le Payload Template, le File Name et les valeurs des paramètres :

Espace réservé	Est remplacé par
`[VALUE]`, `[OLDVALUE]`	La nouvelle et l’ancienne valeur de l’événement ou du champ de données qui a déclenché l’action.
`[REM]`	Les remarques saisies avec lui.
`[NAME]`	Le nom de l’événement ou du champ de données.
`[USERID]`, `[USERNAME]`	L’identifiant utilisateur et le nom de l’utilisateur qui l’a mis à jour.
`[WOID]`, `[BOLID]`	L’ID de l’ordre de travail et l’ID du dossier.
`[FILE]`	Le fichier, encodé en base64. Base64 In Template uniquement.
`[FILENAME]`, `[FILENOEXT]`	Le nom du fichier, avec et sans son extension.

Envoi et réponse

Champ	Ce qu’il faut saisir
Timeout (sec)	Combien de temps attendre une réponse, de 1 à 300 secondes. Les nouvelles intégrations démarrent à 30.
Retries … every … sec	Le nombre de nouvelles tentatives, jusqu’à 5, et leur intervalle en secondes, jusqu’à 60. TrakIT ne réessaie qu’après un dépassement du délai d’attente, une erreur de connexion, ou une réponse 429 ou 5xx, jamais après une autre réponse 4xx. Laissez-le à 0, sauf si l’autre système peut recevoir sans risque deux fois le même appel.
Success Codes	Les codes d’état qui comptent comme un succès, séparés par des virgules, par exemple `200,201,202`. Laissez-le vide pour accepter tout code 2xx.
Response	Ignore, Log ou Return. Pour l’instant, les actions n’utilisent pas la réponse : sa journalisation dépend de Log Payload.
Log Payload	Activé : le corps que TrakIT envoie et le corps qu’il reçoit en retour sont conservés dans le journal des API, que le support TrakIT utilise pour examiner les appels en échec. Les secrets stockés sont masqués. Désactivé : seul le statut de la réponse est conservé. Désactivez-le si les données sont sensibles.
Active	Désactivez-le pour arrêter les appels : les actions qui l’utilisent échouent avec API Integration is not active.

Headers & Parameters

Chaque ligne de Headers & Parameters est envoyée avec chaque appel :

Colonne	Ce qu’il faut saisir
Kind	Header : un en-tête de requête. Query : un paramètre ajouté à l’adresse. Form Field : un champ d’un corps Form URL Encoded ou Multipart.
Name	Lettres, chiffres, `-` et `_`. Un en-tête ne peut figurer qu’une seule fois.
Value	La valeur. Les espaces réservés sont autorisés ; `[FILE]` n’est pas autorisé dans un paramètre Query.
Secret	Cochez cette case pour une valeur qui doit rester cachée, comme une clé. Elle est stockée chiffrée et affichée sous forme d’astérisques. Laissez les astérisques tels quels pour conserver la valeur stockée.

Sélectionnez le X au bout d’une ligne pour la supprimer.

Tester l’appel

Test Call envoie immédiatement une vraie requête, avec les paramètres tels qu’ils sont dans la fenêtre, enregistrés ou non, même si l’intégration n’est pas active. Les espaces réservés reçoivent des valeurs de test, comme TEST pour [VALUE], 0 pour [WOID] et [BOLID], ainsi que votre propre identifiant utilisateur et votre nom, et le fichier est un petit fichier texte. Les balises du modèle de formulaire ne sont pas remplies lors d’un test.

Si l’appel réussit, TrakIT affiche API call succeeded et montre le statut et le début de la réponse. Sinon, il affiche l’erreur. L’autre système reçoit le test comme n’importe quel autre appel.

Messages

Message	Que faire
Title specified already exists, Code specified already exists	Choisissez un autre titre ou un autre code.
Base URL must start with https://	Corrigez l’Endpoint.
Payload Template is required for this Body Mode	Saisissez un Payload Template, ou choisissez un autre Body Mode.
File Mode ‘Multipart Part’ requires Body Mode ‘Multipart’, et messages similaires	Choisissez un File Mode qui convient au Body Mode.
Form Field parameters need Body Mode ‘Form URL Encoded’ or ‘Multipart’	Modifiez le Kind du paramètre, ou le Body Mode.
Duplicate header	Supprimez la deuxième ligne qui a le même nom d’en-tête.
Token refresh failed	L’adresse de jeton a refusé les identifiants. Vérifiez-les, ainsi que la Token URL.
Timed out after … seconds	L’autre système n’a pas répondu à temps.
API Response: suivi d’un statut	L’autre système a répondu avec un statut qui n’est pas un code de succès.

Onglet DCSA

Avec le suivi des transporteurs, TrakIT demande aux compagnies maritimes, par leurs API DCSA Track & Trace, les événements des conteneurs de vos dossiers. Il les affiche dans l’onglet Tracking du dossier, et peut écrire des valeurs comme l’ETA et le port de déchargement dans les champs des ordres de travail.

Un dossier est suivi auprès d’un transporteur lorsque :

il a un ordre de travail ouvert avec un numéro de conteneur, dont l’entité transporteur a cette compagnie maritime comme Shipping Line (SCAC) (voir Champs de l’entité) ;
le transporteur est configuré et actif ici ;
le dossier a été créé dans le délai défini par le Track Jobs Created Within du transporteur, et appartient à l’un de ses Workflows, s’il en a été choisi.

Toutes les 5 minutes, TrakIT trouve les dossiers à suivre et recherche ceux dont le tour est venu. Si les tâches d’arrière-plan sont désactivées sur votre installation, l’onglet l’indique : les transporteurs ne sont alors pas interrogés automatiquement, mais les utilisateurs peuvent toujours sélectionner Track now dans l’onglet Tracking d’un dossier.

Colonne	Affiche
Carrier	La compagnie maritime, avec son code.
Status	Active ; Inactive ; ou Switched off, lorsque TrakIT l’a désactivé parce que le transporteur refusait sans cesse ses appels (pointez sur le statut pour voir l’erreur).
Key	Own key, ou Bitmetric pour une clé que détient le support TrakIT. Sandbox en dessous lorsque le système de test du transporteur est utilisé.
Carrier Entities	Les entités transporteurs actives associées à cette compagnie maritime. En rouge s’il n’y en a aucune : aucun ordre de travail ne sera suivi tant que vous n’aurez pas renseigné le Shipping Line (SCAC) des entités transporteurs.
Poll Every	La fréquence à laquelle chaque dossier suivi est recherché.
Jobs Tracked	Le nombre de dossiers suivis.
Last Poll	Le moment du dernier appel au transporteur, avec Success ou l’erreur.
Updated By	La personne qui a modifié le transporteur en dernier, et quand.

Ajouter ou modifier un transporteur

Avant de commencer, obtenez un accès API auprès de la compagnie maritime : la plupart des transporteurs l’accordent sur leur portail des développeurs ou sur demande. About this carrier, dans la fenêtre, indique ce dont chaque transporteur a besoin, avec un lien vers son portail.

Sélectionnez Add Carrier, ou sélectionnez un transporteur dans la liste.
Choisissez le Carrier. Chaque transporteur ne peut être configuré qu’une fois, et ne peut pas être changé par la suite.
Saisissez les identifiants et les autres champs ci-dessous.
Pour vérifier les paramètres, saisissez un numéro de conteneur ou de document de transport dans Test With, ou laissez-le vide pour utiliser un conteneur récent de ce transporteur, et sélectionnez Test Connection. TrakIT appelle le transporteur avec les paramètres tels qu’ils sont, enregistrés ou non, et affiche ce qui a été renvoyé. Rien n’est enregistré.
Sélectionnez Create, ou Save pour un transporteur qui existe déjà.

Champ	Ce qu’il faut saisir
Carrier	La compagnie maritime.
Active	Activé pour suivre les dossiers avec ce transporteur.
Carrier Entities	Affiche les entités transporteurs actives dont le Shipping Line (SCAC) est ce transporteur, ou un avertissement en rouge s’il n’y en a aucune.
About this carrier	Affiche la façon dont le transporteur accorde l’accès, un lien Developer portal s’il en a un, et la façon de s’y connecter.
Credentials	Own key : les propres identifiants de votre installation chez le transporteur. Bitmetric key : une clé que le support TrakIT détient pour le transporteur ; elle n’apparaît que si le support TrakIT a configuré le transporteur avec elle. Les appels utilisent alors cette clé, qui n’est pas stockée dans votre base de données. Vous pouvez faire passer un transporteur de cette clé à Own key, mais pas l’inverse.
Environment	Production, ou Sandbox pour appeler le système de test du transporteur, s’il en a un.
Les champs d’identifiants	Avec Own key, les champs qu’utilise le transporteur, nommés comme sur son portail des développeurs : par exemple Client ID, API Key et Client Secret. Les clés et les secrets sont stockés chiffrés et ne sont plus jamais affichés. Laissez-les vides pour conserver les valeurs stockées.
Certificate (.pfx), Certificate Password	Pour un transporteur auquel on se connecte avec un certificat : le certificat enregistré auprès du transporteur, et son mot de passe. Laissez-les vides pour conserver ceux qui sont stockés.
Scope	Pour les transporteurs auxquels on se connecte avec OAuth : l’étendue que le transporteur vous a donnée.
Events URL, Token URL	Affichés uniquement pour les transporteurs qui fournissent leurs propres adresses lors de l’approbation : saisissez les adresses que le transporteur a fournies.
Look Up By	L’ordre dans lequel les références d’un dossier sont essayées, par exemple Transport document, booking, container. Les numéros de conteneur ne sont recherchés que pour les conteneurs que le transporteur n’a pas renvoyés.
Strip Suffix	Activé pour ignorer tout ce qui suit un tiret dans le document de transport (`ABC123-CFS` est recherché comme `ABC123`) et pour ignorer les valeurs provisoires comme `TBA`.
Workflows	Ne suivre que les dossiers de ces workflows. N’en choisissez aucun pour tous les suivre.
Transport Document Fields	Les codes des champs qui contiennent le connaissement du transporteur, dans l’ordre où les essayer, séparés par des virgules. `#BOLNUM` est le numéro du dossier.
Booking Fields	Les codes des champs qui contiennent le numéro de réservation du transporteur, dans l’ordre où les essayer.
Track Jobs Created Within	Les dossiers plus anciens que ce nombre de jours ne sont pas pris en compte, de 1 à 730. Track now sur le dossier fonctionne toujours.
Stop Tracking	Un dossier n’est plus recherché ce nombre de jours après l’arrivée de son dernier conteneur, de 0 à 60.
Poll Every	La fréquence à laquelle un dossier suivi est de nouveau recherché : de toutes les heures à toutes les 24 heures.
Max Calls per Hour	Le nombre maximal d’appels que TrakIT fait au transporteur en une heure, pour rester dans sa limite. Les dossiers au-delà attendent le passage suivant.
Update Job Fields	Activé pour écrire les valeurs du transporteur dans les champs définis dans Field Mapping. Désactivé : elles sont seulement affichées dans l’onglet Tracking du dossier.
Test With	Un numéro de conteneur ou de document de transport pour Test Connection.

Pour retirer un transporteur, ouvrez-le, sélectionnez le X en bas à gauche et confirmez. Les dossiers, conteneurs et événements suivis avec lui sont aussi supprimés ; les valeurs déjà écrites dans les champs des ordres de travail restent.

Si le transporteur refuse les identifiants de TrakIT 10 fois sans appel réussi entre-temps, TrakIT désactive le transporteur, l’affiche comme Switched off et envoie un e-mail aux administrateurs système (Carrier Tracking Switched Off), ou au support TrakIT pour un transporteur utilisant la Bitmetric key. Corrigez les identifiants, réactivez Active et enregistrez.

Correspondance des champs

Field Mapping définit dans quels champs de workflow les valeurs des transporteurs sont écrites. La correspondance est la même pour tous les transporteurs.

Sélectionnez Field Mapping. La fenêtre DCSA Field Mapping s’ouvre. Si aucune correspondance n’est encore enregistrée, TrakIT en propose une à partir des champs habituels d’ETA et de port de déchargement de vos workflows.
Pour chaque Carrier Value, choisissez les codes de champ dans Workflow Fields. Pointez sur un code pour voir combien de workflows l’ont.
Cochez Overwrite pour remplacer une valeur que le champ a déjà.
Sélectionnez Save.

Valeurs du transporteur	Peuvent aller dans
ETA at port of discharge, Arrival (actual) at port of discharge, ETD from port of loading, Departure (actual) from port of loading, Discharged at port of discharge, Gate out full at port of discharge, Empty returned	Les champs d’événement et de date.
Port of discharge, Port of loading	Les champs de lieu et de texte.
Vessel, Voyage	Les champs de texte.

Un ordre de travail dont le workflow n’a pas un champ l’ignore. Sans Overwrite, un champ qui a déjà une valeur la conserve. Les dates qui changent de moins de 12 heures restent telles quelles.

Qui peut utiliser cette page

Seuls les administrateurs système peuvent ouvrir la page Integrations. Ils peuvent y configurer toutes les intégrations, sauf ce dont s’occupe le support TrakIT : le serveur SMTP [System Default], les canaux de messagerie configurés par le support TrakIT, et le passage d’un transporteur à la Bitmetric key.