SmartCOMM DocGen (Vorschau)

Smart Communications ist ein führendes Technologieunternehmen, das darauf abzielt, Unternehmen bei der Teilnahme an aussagekräftigeren Kundengesprächen zu helfen.

Der SmartCOMM On-Demand-Doc-Gen Connector umfasst eine vordefinierte Integration zur Herstellung von Omnichannel-Kundenkommunikation. Der Connector stellt RESTful Webservice-Aufrufe an SmartCOMM für On-Demand-Anwendungsfälle bereit.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Smart Communications™ ist eine führende cloudbasierte Plattform für die Unternehmenskundenkommunikation. Als einzige Cloud-Lösung, die als Leader im Magic Quadrant von Gartner für Customer Communications Management eingestuft wurde, verlassen sich mehr als 350 globale Marken – viele in den streng reguliertsten Branchen der Welt – auf Smart Communications, um die Kommunikation mit mehreren Kanälen aussagekräftiger zu machen, und hilft ihnen auch, ihre Prozesse zu vereinfachen und effizienter zu arbeiten.

Der SmartCOMM On Demand Connector für Power Apps enthält eine vordefinierte Integration für die Erstellung von Kundenkommunikation. Der Connector stellt RESTful Webservice-Aufrufe an SmartCOMM für On-Demand-Anwendungsfälle bereit.

Der Connector unterstützt den SmartCOMM-Vorgang "GenerateDocument", der eine Antwort generiert, einschließlich der base64-codierten Byte[]-Ausgabe. Die Ausgabe unterstützt verschiedene Arten von Kanalausgabe. (z. B. SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)

Voraussetzungen

Um die SmartCOMM-Komponente in Power Apps zu verwenden, benötigen Sie zunächst einige Dinge:

• Ein Microsoft Power Apps- oder Power Automate-Plan mit benutzerdefiniertem Connectorfeature
• Eine SmartCOMM-Instanz, die für Ihre Organisation mit Benutzerzugriff eingerichtet wurde
• Sie müssen mit Ihrem Smart Communications-Kontakt zusammenarbeiten, um eine Dokumentvorlage zum Generieren von Dokumenten einzurichten.
• Um Ihre Komponenteneinstellungen zu konfigurieren – Sie müssen die Ressourcen-ID der SmartCOMM-Vorlagenauswahl kennen. Bitten Sie Ihren Smart Communications-Kontakt, dies zu finden.
• Einrichten Ihrer SmartCOMM-Instanz mit einem OAuth 2.0-Client (Autorisierungscode-Erteilungstyp)

So erhalten Sie Anmeldeinformationen

1. Wenden Sie sich an Ihren SmartCOMM-Benutzeradministrator, um ihren Benutzerzugriff zu erstellen.
2. Nachdem Ihr Benutzerzugriff erstellt wurde, erhalten Sie eine E-Mail zum Aktivieren Ihres Kontos.
3. Folgen Sie den Anweisungen zum Aktivieren Ihres Kontos.
4. Im Autorisierungscodeablauf autorisiert der SmartCOMM-Benutzer, der die Ressourcen in der SmartCOMM-Cloud besitzt, Clients für den Zugriff auf sein Benutzerkonto. Benutzer greifen auf die Umleitungs-URL zu, um den Mandanten anzumelden. Benutzer können den Benutzernamen und die Anmeldeinformationen eingeben, um für den ersten Versuch auf den Mandanten zuzugreifen. (Die folgenden Versuche werden die Zugriffscodeseite direkt auffüllen)
5. Akzeptieren Sie die Anforderung zum Abrufen des Zugriffscodes, indem Sie auf die Schaltfläche "Annehmen" klicken.
6. Clients verwenden dann Zugriffstoken für den Zugriff auf die Ressourcen, nicht die Anmeldeinformationen des Benutzers.

Erste Schritte mit Ihrem Connector

1. Bereitstellen der Host-URL der SmartCOMM-Instanz
2. Bereitstellen der OAuth 2.0-Clientdetails – Client-ID, geheimer Clientschlüssel, Autorisierungs-URL und Token-URL
3. Bereitstellen der generierten Umleitungs-URL für Power Apps (z. B. https://global.consent.azure-apim.net/redirect)
4. Erstellen einer Datenverbindung mit der SmartCOMM-Instanz mithilfe eines registrierten Benutzerkontos
   • Wir benötigen eine vollständige Einrichtung des Dokumentgenerators bei SmartCOMM, die mindestens eine Vorlagenauswahl, eine Vorlage und ein Datenmodell enthält.
5. Connector erstellen
   • erforderliche Parameter:
     • Region
       • RegionServer für exmaple: eu10-sb
     • Client-ID
       • Sie ist identisch mit den OAuth 2.0-Clientdetails
     • Geheimer Clientschlüssel
       • Sie ist identisch mit den OAuth 2.0-Clientdetails
6. Url der Anforderungsanforderung zum Generieren vonDocument-Endpunkten. Z.B. https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • erforderliche Parameter:
     • Dokumentdaten einschließen
       • Ja wie gewohnt
     • transactionData (Json oder XML)
       • keine Notwendigkeit für die Base64-Codierung, da sie vom Connector durchgeführt wird
       • es sollte das gleiche Format wie in SmartComm sein
     • batchConfigResId
       • Ressourcen-ID der Smartcomm-Vorlagenauswahl
     • projectId
       • Standard leer, muss aber ausgefüllt werden, wenn das SmartComm-Projekt nicht freigegeben wird
     • transactionRange
       • es kann leer sein, aber wenn sie ausgefüllt wird, sollte angezeigt werden, welche Indizes aus dem Array verwendet werden sollen.
     • transactionDataType
       • application/json oder application/xml
       • es ist das Format des transactionData-Parameters.
     • Zusätzliche Params wie merge.pdf können auf der SmartComm-API-Beschreibung gelesen werden
       • <https:// server.smartcommunications.cloud/one/apiViewer/>
       • Dabei <handelt es sich um den verwendeten Smart Communications-Server> (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud usw.).
7. SmartCOMM On Demand Generation Connector generiert die Kommunikation(en) und gibt die Antwort (einschließlich der base64-codierten Ausgabe) an die Power App zurück.
   • Gibt ein Umschlagarray zurück, das die base64-codierten Dokumente enthält.
   • Das Dokument üblicherweise innerhalb von <documentEnvelope-Umschlägen><><umschlag><primärChannel-Datenzeichenfolge><></-daten>
8. Die Kommunikation(n) kann dann in der Power App zum Herunterladen, archiviert (z. B. SharePoint, S3-Bucket) angezeigt oder an einen Ausgabeübermittlungsdienst übertragen werden, z. B. SNS, Outlook, Mailhouse usw.

Bekannte Probleme und Einschränkungen

1. Rate limiting (check with your SmartCOMM Admin for more details as this is part of the Licence Agreement)
2. Einzelne maximale Anforderungsgröße beträgt 10 MB.

Häufige Fehler und Abhilfemaßnahmen

1. Stellen Sie sicher, dass "transactionDataType" bei Verwendung von JSON-Nutzlast auf "application/json" festgelegt ist.
2. Stellen Sie sicher, dass "projectId" angegeben wird, wenn Sie den Bereich innerhalb eines SmartCOMM-Projekts einschränken möchten.
3. Stellen Sie sicher, dass "includeDocumentData" auf "true" festgelegt ist, wenn Die Ausgabe in die Antwort eingeschlossen werden muss.
4. Weitere Informationen finden Sie unten im Abschnitt "Allgemeine Fehlercodes".

Häufige Fehlercodes

• HTTP 403 – Fehler beim Generieren eines Dokuments. Dieser Fehler gibt "id" (den SmartCOMM-Fehlercode) und den Fehler "msg" (die SmartCOMM-Fehlerbeschreibung) zurück.

• HTTP 500 – Interner Serverfehler Es wird auch empfohlen, dass Sie im Falle eines Fehlers beim Aufrufen des Diensts fünf Sekunden warten, bevor Sie den Vorgang wiederholen. Bei mehreren fortlaufenden Fehlern sollte Ihr Dienst Benutzer benachrichtigen und die Übermittlung dieses Anrufs beenden, da Ihre Anforderung möglicherweise ungültig ist.

• HTTP 429 – Zu viele Anforderungen Wenn Sie eine HTTP 429-Antwort erhalten, sollten Sie 60 Sekunden warten und dann die Anforderung erneut versuchen.

• HTTP 503 – Dienst nicht verfügbar Eine HTTP 503-Antwort wird während der Wartung gesendet. Sie sollten 120 Sekunden warten und dann die Anforderung erneut versuchen. Wartungsfenster können während eines Meilensteinupgrades eine Stunde oder mehr dauern.

Häufig gestellte Fragen

"Stellen Sie hier eine Aufschlüsselung der häufig gestellten Fragen und deren jeweilige Antworten bereit. Dies kann häufig gestellte Fragen zur Interaktion mit dem zugrunde liegenden Dienst oder zum Connector selbst sein."

• Wo finde ich weitere Informationen zum Dienst "GenerateDocument"? - finden Sie hier - https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• Werden Daten mit diesem Connector verschlüsselt? - Ja, wenn HTTPS konfiguriert ist, wird die Verbindung am Ende verschlüsselt.

• Wie erhalte ich ein SmartCOMM-Benutzerkonto? – Wenden Sie sich an Ihren SmartCOMM-Benutzeradministrator.

• Was ist der Autorisierungstyp? - OAuth 2.0

• Wie erhalte ich die OAuth2-Client-ID und den geheimen Schlüssel? – Wenden Sie sich an Ihren SmartCOMM-Administrator, oder wenden Sie sich an https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• Wie kann ich den Autorisierungscode abrufen? – Ausführliche Informationen finden Sie im Abschnitt "So erhalten Sie Anmeldeinformationen" weiter oben.

• Wie erhalte ich Support für diesen Connector? - Kontakt support@smartcommunications.com für alle Supportanfragen

• Wo finde ich weitere Informationen zum SmartCOMM-Produkt? - https://www.smartcommunications.com

• Wie kann ich die batchConfigResId abrufen? - Wenden Sie sich an Ihren SmartCOMM SME, oder verweisen Sie auf https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Wie kann ich die projectId abrufen? - Wenden Sie sich an Ihren SmartCOMM SME, oder verweisen Sie auf https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Wie bald erhalte ich die Antwort? – Die Reaktionszeit kann je nach Netzwerkgeschwindigkeit, Nutzlastgröße und Ressourcenkomplexität usw. variieren. SmartCOMM empfiehlt, eine Leistungsbasislinie auszuführen, um die maximale Reaktionszeit und die durchschnittliche Antwortzeit zu erfassen.

• Wie kann ich die Ausgabe aus der Antwort abrufen? - Die erfolgreiche Antwort enthält die base64-codierte Byte[] Ausgabe. Um die Ausgabe anzuzeigen, müssen Aktionen ausgeführt werden, um die Byte[]-Ausgabe zu decodieren und die Kopie in einem Format zu speichern, wie im "mimeType" angegeben. Weitere Details finden Sie unter https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Drosselungsgrenzwerte

Aktionen

Dokument generieren