Official translation unavailable. Translate this page with Google:

Info Niveau De Produit

Nécessite un abonnement à NiceLabel Cloud.

Pour en savoir plus sur les déclencheurs en général, consulter l'article Comprendre les déclencheurs.

Pour en savoir plus sur NiceLabel Label Cloud, lire ici.

Le déclencheur de Cloud vous permet d'intégrer votre NiceLabel Cloud ou Control Center sur site à vos systèmes d'entreprise existants exécutés dans des Clouds privés ou des centres de données dédiés. Si un système d'entreprise existant (comme SAP S/4HANA ou Oracle NetSuite) produit une sortie, une API hébergée sur le Cloud vous permet d'envoyer des requêtes HTTP au déclencheur de Cloud.

Le déclencheur de Cloud vous permet d'imprimer des étiquettes en local, dont le contenu provient de systèmes d'informations de type Cloud. Le déclencheur de Cloud exécuté sur un serveur Automation local utilise des méthodes standard pour accéder aux services basés sur le Cloud. De ce fait, vous pouvez déployer une impression en local de manière sûre et efficace.

Le déclencheur de Cloud permet d'intégrer de manière sûre et transparente votre impression d'étiquettes en local via des applications qui communiquent par Internet ouvert.

Comparé au déclencheur serveur HTTP, le déclencheur de Cloud ne vous demande pas d'ouvrir de ports entrants sur votre pare-feu. Le déclencheur de Cloud utilise une API NiceLabel dédiée exécutée dans le Cloud. C'est pourquoi le déclencheur ne nécessite que le port de sortie 443 ou les ports 9350-9354 ouverts. Dans la plupart des cas, ces ports sont déjà ouverts.

En déployant le déclencheur de Cloud, vous avez deux options :

Les deux options se valent pour ce qui est des fonctionnalités proposées. Choisissez votre option préférée selon votre infrastructure disponible.

Déployer le déclencheur de Cloud avec NiceLabel Cloud

Étapes du déploiement pour NiceLabel Cloud

Pour activer l'impression d'étiquettes en local en utilisant le déclencheur de Cloud déployé dans NiceLabel Cloud, vous devez donner trois rôles différents à vos utilisateurs : un utilisateur configure le déclencheur de Cloud sur le serveur Automation local (développeur), un autre paramètre le déclencheur de Cloud dans NiceLabel Cloud, et le troisième s'occupe de la souscription sur le Portail développeur.

UUID-4a7834ab-e9e3-d7ac-d0fd-c550f1520e0e.png
  1. Le développeur configure et déploie la configuration du déclencheur de Cloud sur le serveur local Automation en utilisant Automation Builder et Automation Manager.

    Note

    NiceLabel Automation doit être connecté à NiceLabel Cloud.

  2. L'administrateur NiceLabel Cloud donne à l'intégrateur externe l'accès au déclencheur de Cloud dans Control Center. Ensuite, l'administrateur NiceLabel Cloud envoie la clé d'intégrateur correspondante à l'intégrateur externe.

  3. L'intégrateur externe rejoint le Portail développeur pour regrouper le système d'entreprise du client et NiceLabel Cloud.

    Note

    Le Portail développeur héberge l'API dédiée appelée Déclencheur de Cloud. L'API sert de point d'interconnexion entre les événements se produisant dans le système d'entreprise du client et la configuration de Automation qui s'exécute en local.

    Note

    Le mot « externe » signifie que le rôle de cet utilisateur est de s'occuper de la souscription sur le Portail développeur. La souscription créée authentifie l'intégrateur. Les intégrateurs externes ne sont pas forcément des collaborateurs extérieurs. Ils peuvent être des intégrateurs internes appartenant à l'équipe de développement de l'entreprise.

    L'intégrateur externe effectue les actions suivantes sur le Portail développeur:

    1. Se connecter au Portail développeur. Avant de se connecter pour la première fois, l'intégrateur doit avoir terminé la procédure de souscription.

    2. Souscrire à l'API du déclencheur de Cloud.

    3. Connecter la souscription à la clé d'intégrateur. C'est ainsi que la souscription donne accès aux déclencheurs de Cloud du client.

      Pour plus de détails, voir la section Paramétrer l'API NiceLabel Cloudsur le Portail développeur en détail.

Configurer le déclencheur de Cloud dans Automation Builder

Cette section décrit comment configurer le déclencheur de Cloud dans Automation exécuté sur votre serveur local.

  1. Ouvrir votre Automation Builder. S'assurer que Automation Builder est connecté à NiceLabel Cloud. Aller dans Fichier > À propos > Compte NiceLabel Cloud pour confirmer votre connexion.

  2. L'onglet Éléments de configuration s'ouvre. Cliquer sur Déclencheur de Cloud pour créer une nouvelle configuration pour le déclencheur de Cloud.

  3. Définir un Nom et une Description pour retrouver facilement votre déclencheur de Cloud parmi les autres déclencheurs.

  4. Paramétrer le déclencheur Communication :

    • Définir l'identifiant unique. Après avoir déployé le déclencheur, cet identifiant unique est nécessaire pour appeler le déclencheur.

      Si vous exécutez la configuration du déclencheur de Cloud sur plusieurs ordinateurs, vous devez vous assurer que chaque ordinateur utilise automatiquement son propre identifiant unique. Pour empêcher les doublons indésirables, insérer des variables internes dans l'identifiant unique. Vous pouvez utiliser deux variables internes à cette fin :

      • ComputerName : Le nom de l'ordinateur sur lequel tourne la configuration.

      • SystemUserName : Le nom de l'utilisateur actuellement connecté à Windows.

      Pour insérer des variables internes dans l'identifiant unique, cliquer sur Insérer une source de données et sélectionner vos variables internes.

      UUID-7905238a-2b2d-69c4-9856-247bdcb0320c.png
    • Attendre la fin d'exécution du déclencheur : Le protocole HTTP oblige le destinataire (dans ce cas NiceLabel Automation) à renvoyer une réponse numérique à l'expéditeur en indiquant l'état du message reçu. Par défaut, NiceLabel Automation répond avec le code 200. Cela indique que Automation a bien reçu les données, mais n'indique pas si les actions du déclencheur ont bien été effectuées.

      Cette option spécifie qu'un déclencheur n'envoie pas de réponse immédiatement après avoir reçu les données, mais attende que les actions se soient toutes exécutées. Ensuite, un code de réponse est envoyé, indiquant que l'action a bien été exécutée. Avec cette option est activée, la réponse peut être personnalisée et comporter des données (par ex. : la réponse à une requête HTTP est l'aperçu de l'étiquette en format PDF).

      Avec le déclencheur de Cloud, les codes de réponse intégrés standard HTTPAutomation sont :

      Code de réponse HTTP

      Description

      200

      Toutes les actions sont réussies.

      500

      Erreur au cours de l'exécution de l'action.

      Note

      Pour envoyer un rapport d'informations à Automation concernant le processus d'impression, activer le mode d'impression synchrone. Pour plus d'informations, consulter l'article Mode d'impression synchrone.

    • Type de réponse : Spécifie le type du message de réponse. Les types de médias Internet fréquemment utilisés (connus comme types MIME ou types Content) sont prédéfinis dans le menu déroulant. Si votre type de média n'est pas disponible dans la liste, le saisir simplement vous-même. Automation envoie les données de réponse de sortie en tant que retour d'informations, formatées dans le type de média défini. L'option Variable active le type de média variable. Dans ce cas, il faut sélectionner ou créer la variable qui contiendra le type de média.

      Note

      Si le type de contenu n'est pas spécifié, NiceLabel Automation utilise application/octet-stream par défaut.

    • Données de réponse : Définit le contenu de votre message de réponse. Exemples de réponse HTTP : messages d'erreur personnalisés, aperçus d'étiquettes, fichiers PDF, fichiers de flux d'impression (fichier spouleur), fichiers XML avec les détails du moteur d'impression plus l'aperçu d'étiquette (encodé en chaîne Base64).

      Pour sortir seulement un contenu binaire (tel qu'un aperçu de l'étiquette ou un flux d'impression), il faut sélectionner le type de média supporté, par ex. image/jpeg ou application/octet-stream.

    • Entêtes additionnelles : Permet de définir des entêtes MIME pour le message de réponse HTTP.

      La syntaxe de l'entête de la réponse et un exemple sont disponibles dans la section Action requête HTTP.

      Astuce

      Dans les données de réponse et les Entêtes additionnelles, le contenu peut être fixe, un mélange de contenu fixe et variable, ou contenu variable seul. Pour insérer un contenu de variable, cliquer sur le bouton avec une flèche à droite de la zone de données et insérer votre variable de la liste. Vous pouvez aussi créer une nouvelle variable contenant les données que vous voulez utiliser. Pour plus d'informations, consulter l'article Utiliser des valeurs composées.

  5. Déployer et lancer le déclencheur dans Automation Manager. Le déclencheur de Cloud surveille maintenant les requêtes entrantes.

Note

Si votre configuration nécessite une disponibilité et une évolutivité accrues, vous pouvez déployer plusieurs déclencheurs de Cloud identiques. Pour ce faire, installer plusieurs instances de Automation et y déployer les déclencheurs de Cloud. Si les déclencheurs de Cloud déployés partagent le même identifiant unique, la répartition des charges intégrée dans NiceLabel Cloud répartit automatiquement les charges du trafic entre eux.

Paramétrer l'accès au déclencheur de Cloud pour l'intégrateur externe

Note

Pour paramétrer l'accès de l'intégrateur au déclencheur de Cloud, vous devez avoir le droit de gérer l'intégration au Cloud sur le Cloud de Control Center. Voir le Guide utilisateur Control Center pour plus de détails concernant la manière dont gérer vos droits utilisateur.

  1. Aller dans votre Cloud Control Center. Ouvrir le navigateur Web et saisir :

    https://<yourlabelcloudname>.onnicelabel.com/dashboard.
  2. Aller dans Intégrations > Intégrations au Cloud.

  3. Cliquer sur +Ajouter. Ceci ouvre la page Ajouter un nouvel accès intégrateur.

  4. Saisir le Nom de l'intégrateur que vous êtes en train d'ajouter.

    UUID-48984233-2f5c-3b15-04d2-a284439f7360.png
  5. Copier la clé.

  6. Cliquer sur Enregistrer.

  7. Diriger l'intégrateur externe vers le Portail développeur. Envoyer à l'intégrateur externe les informations suivantes :

    • Lien vers NiceLabel Cloud l'API : https://developerportal.onnicelabel.com/

    • La clé d'intégrateur (voir l'étape 5).

    • L'identifiant unique du déclencheur. Vous trouverez cet identifiant unique dans les paramètres de configuration du déclencheur de Cloud Automation (voir étape 4 de la section). Configurer le déclencheur de Cloud dans Automation Builder.

    Note

    L'intégrateur externe doit avoir la clé pour s'authentifier et appeler le déclencheur de Cloud du client.

Note

Pour plus de détails, lire la section Déclencheurs de Cloud dans votre Guide utilisateur Control Center.

Créer une souscription sur le Portail développeur

Après avoir reçu les informations requises de l'administrateur NiceLabel Cloud, l'intégrateur externe doit d'abord se connecter au Portail développeur et créer des souscriptions (une par client) pour appeler les déclencheurs. Ces appels de déclencheurs proviennent des systèmes d'informations basés sur le Cloud du client.

Note

Si vous ne voyez pas le Portail développeur dans votre messagerie, vérifier dans le Courrier indésirable.

Note

Les clients sont des entreprises qui exécutent les configurations de déclencheurs de Cloud qui reçoivent les données des systèmes d'informations externes.

Note

Chaque intégrateur peut appeler plusieurs déclencheurs de Cloud en utilisant une seule souscription.

  1. Ouvrir votre navigateur et aller dans https://developerportal.onnicelabel.com/

  2. Pour terminer la procédure d'inscription, suivre les instructions à l'écran. Après avoir cliqué sur Se connecter, vous recevez un e-mail de confirmation. Cliquer sur le lien de confirmation pour activer votre compte du Portail développeur.

  3. Ouvrir l'onglet Produits et cliquer sur Label Cloud. La page sur laquelle vous arrivez contient vos API et vos souscriptions existantes.

  4. Cliquer sur Ajouter une souscription. La Page de souscription au produit s'ouvre.

    Note

    Vous pouvez créer plusieurs souscriptions. Cependant, une seule souscription peut être utilisée par client. C'est pourquoi NiceLabel vous recommande d'inclure le nom de votre client au nom de la souscription, tel que Cloud Trigger Example Customer.

  5. Saisir le nom de la souscription.

  6. Cliquer sur Confirmer. La nouvelle souscription créée devient disponible dans Produits > Label Cloud.

  7. De retour sur la page Label Cloud, cliquer sur Connexion Développeur API v1 (Developer Sign Up API v1).

  8. Cliquer sur Essayer. La page des API s'ouvre.

    UUID-233e0250-4199-27da-0968-e7275329f997.png
  9. Insérer la clé d'intégrateur depuis le cloud du client Control Center.

  10. Cliquer sur Envoyer.

    • La réponse est : Subscription <your subscription key> successfully associated with integrator key <integrator key value>.

    Note

    Vous avez reçu la clé d'intégrateur de l'administrateur NiceLabel Cloud. La clé ressemble à ça : 979d7be5df2b473193ac5519f94cd901

    Exemple 26. Exemple

    En transmettant la clé d'intégrateur en tant que paramètre de requête, l'URL ressemble à ça : https://labelcloudapi.onnicelabel.com/SignUpApi/DeveloperSignup?integratorKey=979d7be5df2b473193ac5519f94cd901.


    Une fois effectué en utilisant l'URL comme affichée dans l'exemple, l'opération DeveloperSignup correspond à la souscription avec le client assigné. Voilà comment l'intégrateur s'authentifie en appelant le déclencheur de Cloud exécuté dans le Automation du client.

    Les souscriptions connectées sont également visibles dans le Cloud Control Center. Vérifier si l'intégrateur externe a connecté sa souscription dansIntégrations > Intégrations au Cloud. L'intégration au Cloud devrait avoir le statut Développeur [nom, adresse e-mail] souscrit.

Appeler votre déclencheur de Cloud (déploiement de NiceLabel Cloud)

Cette étape s'assure que les sorties des systèmes d'entreprise externes exécutent correctement les déclencheurs de Cloud exécutés en local. C'est le but de l'opération CloudTrigger (déclencheur de Cloud). Dans l'URL de l'opération, spécifier le nom du déclencheur que vous appelez.

Pour appeler un déclencheur avec l'identifiant unique MyCloudTrigger, utiliser cette URL :

https://labelcloudapi.onnicelabel.com/TriggerApi/CloudTrigger/MyCloudTrigger

Pour chaque événement (sortie) dans le système d'entreprise, appeler l'URL comme dans l'exemple. Chaque appel exécute le déclencheur de Cloud exécuté sur le serveur Automation local.

Toutes les opérations API doivent inclure ces deux entêtes :

  • Api-Version est la version de l'API que vous utilisez. Actuellement, la seule version API disponible est v1.

  • Ocp-Apim-Subscription-Key est la clé qui identifie votre souscription.

Tester les appels CloudTrigger

Pour vous familiariser avec la manière dont fonctionnent les appels CloudTrigger, le Portail développeur vous permet de tester ces appels.

Avant de pouvoir tester un appel, vous devez paramétrer une configuration de Automation.

  1. Ouvrir le Portail développeur, ouvrir l'onglet Produits et cliquer sur Label Cloud.

  2. Sélectionner Déclencheur de Cloud API v1 (Cloud Trigger API v1).

  3. Créer un masque pour les méthodes GET ou POST. Cliquer sur le lien approprié.

    • Après avoir sélectionné la méthode, cliquer sur Essayer. Une nouvelle page s'ouvre. Le triggerID est déjà ajouté sous Paramètres de requête.

    • Dans le champ Valeur, copier-coller le triggerID du développeur de la configuration d'Automation. C'est l'identifiant unique du déclencheur. L'identifiant unique est disponible dans Automation Builder > Paramètres des déclencheurs > Général.

      UUID-b2a4eb67-50bc-91d5-4b8c-709a50ee1587.png
  4. Sous Autorisation, sélectionner la clé de souscription. Étant donné que vous avez déjà au moins une souscription définie, la liste déroulante inclut déjà la clé pour la souscription définie. Sélectionner cette clé, principale ou secondaire.

  5. Cliquer sur Envoyer.

    • Le statut de la réponse est 200 OK.

Vérifier rapidement si votre déclencheur de Cloud fonctionne

Une fois que vous avez défini votre API NiceLabel Cloud sur le Portail développeur, vous pouvez effectuer une configuration simple dans Automation Builder pour vérifier que le déclencheur de Cloud fonctionne. Si le déclencheur fonctionne, vous recevez le message « Le déclencheur fonctionne » sur la page API du déclencheur de Cloud après avoir cliqué sur Essayer.

  1. Ouvrir Automation Builder et créer une nouvelle configuration. Assurez-vous que votre Automation Manager est connecté à NiceLabel Cloud.

  2. Ajouter un nouveau Déclencheur de Cloud.

  3. Définir le Nom et la Description, et définir l'identifiant unique. Utilisons l'identifiant unique TestCloudTrigger dans ce cas.

  4. Activer Attendre la fin d'exécution du déclencheur. Cela vous permet de suivre les réponses des déclencheurs.

    • Sélectionner texte/brut en tant que Type de réponse.

    • Définir les données de réponse. C'est ce que vous recevez si le déclencheur fonctionne. Utilisons la chaîne suivante : «Le déclencheur fonctionne.»

    • Définir les Entêtes additionnelles. Utiliser le format Heading:Value.

  5. Déployer la configuration.

  6. Ouvrir votre Portail développeur et aller sur la page d'API du déclencheur Cloud v1.

  7. Cliquer sur Essayer.

  8. Coller TestCloudTrigger au champ triggerID. Cliquer sur Envoyer.

    • Le contenu de la réponse inclut la confirmation : «Le déclencheur fonctionne.»

      UUID-7a2db5bb-633b-5b19-e8f2-16e863b1d8b3.png

Déployer le déclencheur de Cloud avec votre Control Center sur site

Configurer le déclencheur de Cloud dans Automation Builder

Cette section décrit comment configurer le déclencheur de Cloud dans Automation exécuté sur votre serveur local.

  1. Ouvrir votre Automation Builder. S'assurer que Automation Builder est associé à votre Control Center. Pour vérifier, aller dans Fichier > Options > Control Center et voir si l'adresse URL de votre Control Center est là.

    Note

    Automation Builder et Control Center « associés » signifient aussi que les deux applications utilisent la même clé de licence.

  2. L'onglet Éléments de configuration s'ouvre. Cliquer sur Déclencheur de Cloud pour créer une nouvelle configuration pour le déclencheur de Cloud.

  3. Définir un Nom et une Description pour retrouver facilement votre déclencheur de Cloud parmi les autres déclencheurs.

  4. Paramétrer le déclencheur Communication :

    • Définir l'identifiant unique. Après avoir déployé le déclencheur, cet identifiant unique enregistre le déclencheur sur votre Control Center. N'utiliser que des caractères alphanumériques. Les caractères spéciaux ne sont pas autorisés.

      Si vous exécutez la configuration du déclencheur de Cloud sur plusieurs ordinateurs, vous devez vous assurer que chaque ordinateur utilise automatiquement son propre identifiant unique. Pour empêcher les doublons indésirables, insérer des variables internes dans l'identifiant unique. Vous pouvez utiliser deux variables internes à cette fin :

      • ComputerName : Le nom de l'ordinateur sur lequel tourne la configuration.

      • SystemUserName : Le nom de l'utilisateur actuellement connecté à Windows.

      Pour insérer des variables internes dans l'identifiant unique, cliquer sur Insérer une source de données et sélectionner vos variables internes.

      UUID-7905238a-2b2d-69c4-9856-247bdcb0320c.png
    • Attendre la fin d'exécution du déclencheur : Le protocole HTTP oblige le destinataire (dans ce cas NiceLabel Automation) à renvoyer une réponse numérique à l'expéditeur en indiquant l'état du message reçu. Par défaut, NiceLabel Automation répond avec le code 200. Cela indique que Automation a bien reçu les données, mais n'indique pas si les actions du déclencheur ont bien été effectuées.

      Cette option spécifie qu'un déclencheur n'envoie pas de réponse immédiatement après avoir reçu les données, mais attende que les actions se soient toutes exécutées. Ensuite, un code de réponse est envoyé, indiquant que l'action a bien été exécutée. Avec cette option est activée, la réponse peut être personnalisée et comporter des données (par ex. : la réponse à une requête HTTP est l'aperçu de l'étiquette en format PDF).

      Avec le déclencheur de Cloud, les codes de réponse intégrés standard HTTPAutomation sont :

      Code de réponse HTTP

      Description

      200

      Toutes les actions sont réussies.

      400

      Aucune configuration disponible.

      500

      Erreur au cours de l'exécution de l'action.

      Note

      Pour envoyer un rapport d'informations à Automation concernant le processus d'impression, activer le mode d'impression synchrone. Pour plus d'informations, consulter l'article Mode d'impression synchrone.

    • Type de réponse : Spécifie le type du message de réponse. Les types de médias Internet fréquemment utilisés (connus comme types MIME ou types Content) sont prédéfinis dans le menu déroulant. Si votre type de média n'est pas disponible dans la liste, le saisir simplement vous-même. Automation envoie les données de réponse de sortie en tant que retour d'informations, formatées dans le type de média défini. L'option Variable active le type de média variable. Dans ce cas, il faut sélectionner ou créer la variable qui contiendra le type de média.

      Note

      Si le type de contenu n'est pas spécifié, NiceLabel Automation utilise application/octet-stream par défaut.

    • Données de réponse : Définit le contenu de votre message de réponse. Exemples de réponse HTTP : messages d'erreur personnalisés, aperçus d'étiquettes, fichiers PDF, fichiers de flux d'impression (fichier spouleur), fichiers XML avec les détails du moteur d'impression plus l'aperçu d'étiquette (encodé en chaîne Base64).

      Pour sortir seulement un contenu binaire (tel qu'un aperçu de l'étiquette ou un flux d'impression), il faut sélectionner le type de média supporté, par ex. image/jpeg ou application/octet-stream.

    • Entêtes additionnelles : Permet de définir des entêtes MIME pour le message de réponse HTTP.

      La syntaxe de l'entête de la réponse et un exemple sont disponibles dans la section Action requête HTTP.

      Astuce

      Dans les données de réponse et les Entêtes additionnelles, le contenu peut être fixe, un mélange de contenu fixe et variable, ou contenu variable seul. Pour insérer un contenu de variable, cliquer sur le bouton avec une flèche à droite de la zone de données et insérer votre variable de la liste. Vous pouvez aussi créer une nouvelle variable contenant les données que vous voulez utiliser. Pour plus d'informations, consulter l'article Utiliser des valeurs composées.

  5. Déployer et lancer le déclencheur dans Automation Manager. Le déclencheur de Cloud surveille maintenant les requêtes entrantes.

Note

Si votre configuration nécessite une disponibilité et une évolutivité accrues, vous pouvez déployer plusieurs déclencheurs de Cloud identiques. Pour ce faire, installer plusieurs instances de Automation et y déployer les déclencheurs de Cloud. Si les déclencheurs de Cloud déployés partagent le même identifiant unique, la répartition des charges intégrée dans NiceLabel Cloud répartit automatiquement les charges du trafic entre eux.

Appeler le déclencheur de Cloud (déploiement sur site)

Cette étape s'assure que les sorties des systèmes d'entreprise externes exécutent correctement les déclencheurs de Cloud exécutés en local. C'est le but de l'opération CloudTrigger (déclencheur de Cloud). Dans l'URL de l'opération, spécifier le nom du déclencheur que vous appelez.

Pour appeler le déclencheur avec l'identifiant unique MyCloudTrigger, appeler cette URL :

https://<YourServerName>/epm/api/trigger/<MyCloudTriggerID>

Note

L'URL peut commencer par «http» ou «https» – selon la manière dont vous configurez votre Control Center lors de l'installation. Voir le Guide d'installation Control Center, section Définir le site Web et le stockage.

Pour chaque événement (sortie) dans le système d'entreprise, appeler l'URL comme dans l'exemple. Chaque appel exécute le déclencheur de Cloud exécuté sur le serveur Automation local.

Tous les appels doivent inclure l'entête nommée Integrator-Key (clé d'intégrateur).

Exemple 27. Exemple

Integrator-Key : 9d59d7d444da412b8acfb488a01bb632