SmartCOMM DocGen (préversion)

Smart Communications est une société technologique de premier plan axée sur l’aide aux entreprises qui participent à des conversations client plus significatives.

Le connecteur smartCOMM à la demande Doc-Gen comprend une intégration prédéfini pour produire des communications client omnicanales. Le connecteur fournit des appels de service web RESTful à SmartCOMM pour les cas d’utilisation à la demande.

Ce connecteur est disponible dans les produits et régions suivants :

Smart Communications™ est une plateforme cloud de pointe pour les communications client d’entreprise. En tant que seule solution cloud classée leader dans le Magic Quadrant de Gartner pour la gestion des communications client, plus de 350 marques mondiales – beaucoup dans les secteurs les plus hautement réglementés du monde – s’appuient sur Smart Communications pour rendre les communications client multicanal plus significatives, tout en les aidant à simplifier leurs processus et à fonctionner plus efficacement.

Le connecteur SmartCOMM à la demande pour Power Apps inclut une intégration prédéfini pour la production de Customer Communications. Le connecteur fournit des appels de service web RESTful à SmartCOMM pour les cas d’utilisation à la demande.

Le connecteur prend en charge l’opération SmartCOMM « GenerateDocument » qui génère une réponse, y compris la sortie d’octet encodée en base64[]. La sortie prend en charge différents types de sortie de canal. (par exemple, SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)

Prerequisites

Pour utiliser le composant SmartCOMM dans Power Apps, vous devez d’abord effectuer quelques opérations :

• Un plan Microsoft Power Apps ou Power Automate avec une fonctionnalité de connecteur personnalisée
• Une instance SmartCOMM configurée pour votre organisation avec accès utilisateur
• Vous devrez utiliser votre contact Smart Communications pour configurer un modèle de document à partir duquel générer des documents.
• Pour configurer vos paramètres de composant, vous devez connaître l’ID de ressource de sélecteur de modèle BatchConfigResID ou SmartCOMM. Demandez à votre contact Smart Communications de vous aider à le trouver.
• Configurer votre instance SmartCOMM avec un client OAuth 2.0 (type d’octroi de code d’autorisation)

Comment obtenir des informations d’identification

1. Contactez votre administrateur d’utilisateur SmartCOMM pour créer votre accès utilisateur
2. Une fois votre accès utilisateur créé, vous recevrez un e-mail pour activer votre compte
3. Suivez les instructions pour activer votre compte
4. Dans le flux du code d’autorisation, l’utilisateur SmartCOMM propriétaire des ressources dans le cloud SmartCOMM autorise les clients à accéder à leur compte d’utilisateur. Les utilisateurs accèdent à l’URL de redirection pour connecter la location. Les utilisateurs peuvent entrer leur nom d’utilisateur et leurs informations d’identification pour accéder à la location pour la première tentative. (les tentatives suivantes affichent directement la page de codes d’accès)
5. Acceptez la demande pour récupérer le code d’accès, en cliquant sur le bouton Accepter
6. Les clients utilisent ensuite des jetons d’accès pour accéder aux ressources, et non les informations d’identification de l’utilisateur.

Bien démarrer avec votre connecteur

1. Indiquez l’URL de l’hôte de l’instance SmartCOMM
2. Fournissez les détails du client OAuth 2.0 - ID client, Secret client, URL d’autorisation et URL du jeton
3. Fournissez l’URL de redirection générée par Power Apps (par exemple https://global.consent.azure-apim.net/redirect)
4. Créer une connexion de données à l’instance SmartCOMM à l’aide d’un compte d’utilisateur inscrit
   • Nous avons besoin d’une configuration complète du générateur de documents chez SmartCOMM, qui contient au moins un sélecteur de modèle, un modèle et un modèle de données.
5. Créer un connecteur
   • paramètres requis :
     • Region
       • RegionServer pour exmaple : eu10-sb
     • Client Id
       • Il est identique à celui de Fournir les détails du client OAuth 2.0
     • Clé secrète client
       • Il est identique à celui de Fournir les détails du client OAuth 2.0
6. Fournissez l’URL de la demande pour générer le point de terminaisonDocument. Par exemple, https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • paramètres requis :
     • Inclure des données de document
       • Oui comme d’habitude
     • transactionData (Json ou XML)
       • aucun besoin d’encodage en base64, car il est effectué par le connecteur
       • il doit s’agir du même format que dans SmartComm
     • batchConfigResId
       • ID de ressource du sélecteur de modèle Smartcomm
     • projectId
       • valeur par défaut vide, mais doit être renseigné lorsque le projet SmartComm n’est pas publié
     • transactionRange
       • il peut être vide, mais lorsqu’il est rempli, il doit afficher les index à utiliser à partir du tableau
     • transactionDataType
       • application/json ou application/xml
       • il s’agit du format du paramètre transactionData
     • des paramètres supplémentaires comme merge.pdf peuvent être lus sur la description de l’API SmartComm
       • <https:// server.smartcommunications.cloud/one/apiViewer/>
       • Où <le serveur> est le serveur Smart Communications que vous utilisez (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud, etc.).
7. Le connecteur SmartCOMM On Demand Generation génère les communications et retourne la réponse (y compris la sortie encodée en base64) à l’application Power App
   • Retourne un tableau d’enveloppes qui contient les documents encodés en base64.
   • Le document d’habitude à l’intérieur de l’enveloppe <documentEnvelope><enveloppe><primaryChannel><><data>string</data>
8. Les communications peuvent ensuite être affichées dans l’application Power App à télécharger, archiver (par exemple SharePoint, compartiment S3) ou envoyer (push) à un service de remise de sortie, par exemple SNS, Outlook, mailhouse, etc.

Problèmes connus et limitations

1. Limitation du débit (consultez votre administrateur SmartCOMM pour plus d’informations, car il fait partie du contrat de licence)
2. La taille maximale de la demande individuelle est de 10 Mo

Erreurs courantes et solutions

1. Vérifiez que « transactionDataType » est défini sur « application/json » lors de l’utilisation de la charge utile JSON.
2. Vérifiez que spécifiez « projectId » lorsque vous souhaitez limiter l’étendue dans un projet SmartCOMM
3. Vérifiez que « includeDocumentData » a la valeur true lorsque vous avez besoin de la ième sortie à inclure dans la réponse
4. Reportez-vous à la section Codes d’erreur courants ci-dessous.

Codes d’erreur courants

• HTTP 403 - La génération du document a échoué Cette erreur renvoie « id » (le code d’erreur SmartCOMM) et l’erreur « msg » (description de l’erreur SmartCOMM)

• HTTP 500 - Erreur de serveur interne Nous vous recommandons également de patienter cinq secondes avant de réessayer en cas d’erreur lorsque vous appelez le service. Sur plusieurs échecs continus, votre service doit alerter les utilisateurs et cesser de soumettre cet appel, car votre demande peut ne pas être valide.

• HTTP 429 - Trop de requêtes si vous obtenez une réponse HTTP 429, vous devez attendre 60 secondes, puis réessayer votre requête.

• HTTP 503 - Service indisponible Une réponse HTTP 503 est envoyée pendant la maintenance. Vous devez attendre 120 secondes, puis réessayer votre demande. Les fenêtres de maintenance peuvent durer une heure ou plus pendant une mise à niveau jalon.

Questions fréquentes (FAQ)

« Fournissez une répartition des questions fréquemment posées et de leurs réponses respectives ici. Cela peut couvrir les questions fréquentes sur l’interaction avec le service sous-jacent ou sur le connecteur lui-même.

• Où puis-je trouver des informations supplémentaires sur le service « GenerateDocument » ? - est disponible ici - https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• Les données sont-elles chiffrées à l’aide de ce connecteur ? - Oui, si HTTPS est configuré, la connexion est chiffrée de bout en bout.

• Comment puis-je obtenir un compte d’utilisateur SmartCOMM ? - Contactez votre administrateur utilisateur SmartCOMM.

• Quel est le type d’autorisation ? - OAuth 2.0

• Comment puis-je obtenir l’ID client et le secret OAuth2 ? - Contactez votre administrateur SmartCOMM ou reportez-vous à https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• Comment puis-je obtenir le code d’autorisation ? - Reportez-vous à la section « Comment obtenir les informations d’identification » ci-dessus pour obtenir des détails complets.

• Comment puis-je obtenir la prise en charge de ce connecteur ? - Contacter support@smartcommunications.com toutes les demandes de support

• Où puis-je trouver plus d’informations sur le produit SmartCOMM ? - https://www.smartcommunications.com

• Comment puis-je obtenir le batchConfigResId ? - Contactez votre PME SmartCOMM ou reportez-vous à https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Comment puis-je obtenir l’ID de projet ? - Contactez votre PME SmartCOMM ou reportez-vous à https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Combien de temps vais-je recevoir la réponse ? - Le temps de réponse peut varier en fonction de la vitesse de votre réseau, de la taille de la charge utile et de la complexité des ressources, etc. SmartCOMM recommande d’exécuter une base de référence de performances pour collecter le temps de réponse maximal et le temps de réponse moyen

• Comment puis-je obtenir la sortie de la réponse ? - La réponse réussie inclut la sortie d’octet encodée en base64[]. Pour afficher la sortie, les actions doivent être effectuées pour décoder la sortie d’octet[] et enregistrer la copie dans un format tel que spécifié dans le « mimeType ». Pour plus d’informations, consultez https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Limitations

Actions

Générer un document