SmartCOMM DocGen (preview)

Smart Communications is een toonaangevend technologiebedrijf dat is gericht op het helpen van bedrijven bij zinvollere gesprekken van klanten.

De SmartCOMM On-Demand Doc-Gen Connector bevat een vooraf gebouwde integratie voor het produceren van omnichannel-klantcommunicatie. De connector biedt RESTful-webservice-aanroepen naar SmartCOMM voor gebruiksscenario's op aanvraag.

Deze connector is beschikbaar in de volgende producten en regio's:

Smart Communications™ is een toonaangevende cloudplatform voor zakelijke klantcommunicatie. Aangezien de enige cloudoplossing is gerangschikt als leider in het Magic Quadrant voor Customer Communications Management, vertrouwen meer dan 350 wereldwijde merken – veel in de meest gereglementeerde branches ter wereld – op Smart Communications om communicatie met meerdere kanalen zinvoller te maken, terwijl ze ook hun processen vereenvoudigen en efficiënter werken.

De SmartCOMM On Demand Connector voor Power Apps bevat een vooraf gebouwde integratie voor het produceren van Customer Communications. De connector biedt RESTful-webservice-aanroepen naar SmartCOMM voor gebruiksscenario's op aanvraag.

De connector ondersteunt de SmartCOMM GenerateDocument-bewerking waarmee een antwoord wordt gegenereerd, inclusief de base64-byte[]-uitvoer. Uitvoer ondersteunt verschillende typen kanaaluitvoer. (bijvoorbeeld SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)

Vereiste voorwaarden

Als u het SmartCOMM-onderdeel in Power Apps wilt gebruiken, hebt u eerst enkele dingen nodig:

• Een Microsoft Power Apps- of Power Automate-abonnement met aangepaste connectorfunctie
• Een SmartCOMM-exemplaar dat is ingesteld voor uw organisatie met gebruikerstoegang
• U moet samenwerken met uw contactpersoon voor Smart Communications om een documentsjabloon in te stellen waaruit documenten kunnen worden gegenereerd.
• Als u de onderdeelinstellingen wilt configureren, moet u de resource-id van de SmartCOMM-sjabloonkiezer of SmartCOMM-sjabloon kennen. Vraag uw Smart Communications-contactpersoon om u te helpen dit te vinden.
• Uw SmartCOMM-exemplaar instellen met een OAuth 2.0-client (autorisatiecodetoestemmingstype)

Referenties ophalen

1. Neem contact op met de SmartCOMM-gebruikersbeheerder om uw gebruikerstoegang te maken
2. Zodra uw gebruikerstoegang is gemaakt, ontvangt u een e-mail om uw account te activeren
3. Volg de instructies om uw account te activeren
4. In de autorisatiecodestroom machtigt de SmartCOMM-gebruiker die eigenaar is van de resources in de SmartCOMM-cloud clients toegang tot hun gebruikersaccount. Gebruikers hebben toegang tot de omleidings-URL om zich aan te melden bij de tenancy. Gebruikers kunnen de gebruikersnaam en referenties invoeren om toegang te krijgen tot de tenancy voor de eerste poging. (de volgende pogingen verschijnen rechtstreeks op de pagina met toegangscodes)
5. Accepteer de aanvraag om de toegangscode op te halen door op de knop Accepteren te klikken
6. Clients gebruiken vervolgens toegangstokens voor toegang tot de resources, niet de referenties van de gebruiker.

Aan de slag met uw connector

1. Geef de host-URL van het SmartCOMM-exemplaar op
2. Geef de OAuth 2.0-clientdetails op: client-id, clientgeheim, autorisatie-URL en token-URL
3. Geef de door Power Apps gegenereerde omleidings-URL (bijvoorbeeld ) op https://global.consent.azure-apim.net/redirect
4. Een gegevensverbinding maken met het SmartCOMM-exemplaar met behulp van een geregistreerd gebruikersaccount
   • We hebben een volledige configuratie van de documentgenerator nodig bij SmartCOMM, die ten minste een sjabloonkiezer, een sjabloon en een gegevensmodel bevat.
5. Connector maken
   • vereiste parameters:
     • Region
       • RegionServer voor exmaple: eu10-sb
     • Client-id
       • Dit is hetzelfde als in de OAuth 2.0-clientdetails opgeven
     • Clientgeheim
       • Dit is hetzelfde als in de OAuth 2.0-clientdetails opgeven
6. Url van aanvraag opgeven voor generateDocument-eindpunt. Bijvoorbeeld https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • vereiste parameters:
     • Documentgegevens opnemen
       • Ja zoals gebruikelijk
     • transactionData (Json of XML)
       • geen base64-codering nodig, omdat deze wordt uitgevoerd door de connector
       • deze moet dezelfde indeling hebben als in SmartComm
     • batchConfigResId
       • Resource-id van de Smartcomm-sjabloonkiezer
     • projectId
       • standaard leeg, maar moet worden ingevuld wanneer het SmartComm-project niet wordt vrijgegeven
     • transactionRange
       • het kan leeg zijn, maar wanneer deze wordt ingevuld, moet worden weergegeven welke indexen uit de matrix moeten worden gebruikt
     • transactionDataType
       • application/json of application/xml
       • het is de indeling van de parameter transactionData
     • extra parameters zoals merge.pdf kunnen worden gelezen in de Beschrijving van de SmartComm-API
       • <https:// server.smartcommunications.cloud/one/apiViewer/>
       • Waar <de server de Smart Communications-server> is die u gebruikt (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud enzovoort).
7. SmartCOMM On Demand Generation-connector genereert de communicatie(s) en retourneert het antwoord (inclusief de met base64 gecodeerde uitvoer) naar de Power App
   • Retourneert een envelopmatrix, die de met Base64 gecodeerde documenten bevat.
   • Het document normaal gesproken binnen in <documentEnvelope><enveloppen><enveloppen primaireChannel-gegevenstekenreeks>><><</-gegevens>
8. De communicatie(s) kunnen vervolgens worden weergegeven in de Power App voor downloaden, gearchiveerd (bijvoorbeeld SharePoint, S3-bucket) of naar een uitvoerleveringsservice worden gepusht, zoals SNS, Outlook, mailhouse, enzovoort.

Bekende problemen en beperkingen

1. Snelheidsbeperking (neem contact op met uw SmartCOMM-beheerder voor meer informatie omdat dit deel uitmaakt van de licentieovereenkomst)
2. Afzonderlijke maximale aanvraaggrootte is 10 MB

Veelvoorkomende fouten en oplossingen

1. Zorg ervoor dat transactionDataType is ingesteld op 'application/json' wanneer u JSON-nettolading gebruikt.
2. Zorg ervoor dat u 'projectId' opgeeft wanneer u het bereik binnen een SmartCOMM-project wilt beperken
3. Zorg ervoor dat includeDocumentData is ingesteld op true wanneer u de uitvoer nodig hebt om in het antwoord te worden opgenomen
4. Raadpleeg de sectie Algemene foutcodes hieronder.

Veelvoorkomende foutcodes

• HTTP 403 - Document genereren is mislukt. Deze fout retourneert 'id' (de SmartCOMM-foutcode) en de fout 'msg' (de beschrijving van de SmartCOMM-fout)

• HTTP 500 - Interne serverfout We raden u ook aan in het geval van een fout wanneer u de service aanroept, wacht u vijf seconden voordat u het opnieuw probeert. Bij meerdere doorlopende fouten moet uw service gebruikers waarschuwen en stoppen met het indienen van die oproep, omdat uw aanvraag mogelijk ongeldig is.

• HTTP 429 - Te veel aanvragen Als u een HTTP 429-antwoord krijgt, moet u 60 seconden wachten en uw aanvraag opnieuw proberen.

• HTTP 503 - Service niet beschikbaar Een HTTP 503-antwoord wordt verzonden tijdens onderhoud. Wacht 120 seconden en voer uw aanvraag opnieuw uit. Onderhoudsvensters kunnen een uur of langer duren tijdens een mijlpaalupgrade.

Veelgestelde vragen

'Geef hier een uitsplitsing van veelgestelde vragen en hun respectieve antwoorden. Dit kan betrekking hebben op veelgestelde vragen over interactie met de onderliggende service of over de connector zelf.'

• Waar vind ik meer informatie over de GenerateDocument-service? - hier te vinden - https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• Worden gegevens versleuteld met deze connector? - Ja, als HTTPS is geconfigureerd, wordt de verbinding end-to-end versleuteld.

• Hoe kan ik een SmartCOMM-gebruikersaccount krijgen? - Neem contact op met de SmartCOMM-gebruikerbeheerder.

• Wat is het autorisatietype? - OAuth 2.0

• Hoe kan ik de OAuth2-client-id en het geheim ophalen? - Neem contact op met uw SmartCOMM-beheerder of raadpleeg https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• Hoe kan ik de autorisatiecode ophalen? - Raadpleeg de sectie 'Referenties ophalen' hierboven voor volledige informatie.

• Hoe krijg ik ondersteuning voor deze connector? - Contact opnemen support@smartcommunications.com voor alle ondersteuningsaanvragen

• Waar vind ik meer informatie over het SmartCOMM-product? - https://www.smartcommunications.com

• Hoe kan ik de batchConfigResId ophalen? - Neem contact op met uw SmartCOMM SME of raadpleeg https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Hoe kan ik de projectId ophalen? - Neem contact op met uw SmartCOMM SME of raadpleeg https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Hoe snel krijg ik het antwoord? - De reactietijd kan variëren op basis van uw netwerksnelheid, nettoladingsgrootte en resourcecomplexiteit, enzovoort. SmartCOMM raadt aan een prestatiebasislijn uit te voeren om de maximale reactietijd en gemiddelde reactietijd te verzamelen

• Hoe kan ik de uitvoer van het antwoord ophalen? - Het geslaagde antwoord bevat de base64-gecodeerde byte[] uitvoer. Als u de uitvoer wilt weergeven, moeten acties worden uitgevoerd om de byte[] uitvoer te decoderen en de kopie op te slaan in een indeling zoals opgegeven in het mimeType. Raadpleeg https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job> voor meer informatie

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Beperkingslimieten

Acties

Document genereren