SmartCOMM DocGen (anteprima)
Smart Communications è una società tecnologica leader incentrata sull'aiutare le aziende a partecipare a conversazioni dei clienti più significative.
SmartCOMM On Demand Doc-Gen Connector include un'integrazione predefinita per la produzione di comunicazioni dei clienti multicanale. Il connettore fornisce chiamate di servizi Web RESTful a SmartCOMM per casi d'uso su richiesta.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Supporto per le comunicazioni intelligenti |
| URL | http://support.smartcommunications.com |
| support@smartcommunications.com |
| Metadati del connettore | |
|---|---|
| Editore | Comunicazioni intelligenti |
| Sito web | https://www.smartcommunications.com |
| Informativa sulla privacy | https://www.smartcommunications.com/external-privacy-policy |
| Categorie | Comunicazione; Contenuto e file |
Smart Communications™ è una piattaforma leader basata sul cloud per le comunicazioni dei clienti aziendali. Come unica soluzione cloud classificata come leader nel Magic Quadrant for Customer Communications Management di Gartner, più di 350 marchi globali, molti dei settori più altamente regolamentati del mondo, si affidano a Smart Communications per rendere le comunicazioni dei clienti multicanale più significative, aiutandoli a semplificare i processi e operare in modo più efficiente.
SmartCOMM On Demand Connector per Power Apps include un'integrazione predefinita per la produzione di comunicazioni dei clienti. Il connettore fornisce chiamate di servizi Web RESTful a SmartCOMM per casi d'uso su richiesta.
Il connettore supporta l'operazione SmartCOMM 'GenerateDocument' che genera una risposta, incluso l'output byte codificato in base64. L'output supporta diversi tipi di output del canale. ad esempio SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)
Prerequisiti
Per usare il componente SmartCOMM in Power Apps, sono necessari alcuni passaggi completati per primi:
- Un piano di Microsoft Power Apps o Power Automate con funzionalità di connettore personalizzato
- Un'istanza SmartCOMM configurata per l'organizzazione con accesso utente
- Per configurare un modello di documento da cui generare documenti, è necessario collaborare con il contatto Comunicazioni intelligenti.
- Per configurare le impostazioni del componente, è necessario conoscere l'ID risorsa 'BatchConfigResID' o smartCOMM Template Selector. Chiedi al tuo contatto comunicazioni intelligenti di aiutarti a trovarlo.
- Configurare l'istanza SmartCOMM con un client OAuth 2.0 (tipo di concessione del codice di autorizzazione)
Come ottenere le credenziali
- Contattare l'amministratore utente SmartCOMM per creare l'accesso utente
- Dopo aver creato l'accesso utente, si riceverà un messaggio di posta elettronica per attivare l'account
- Seguire le istruzioni per attivare l'account
- Nel flusso del codice di autorizzazione, l'utente SmartCOMM proprietario delle risorse nel cloud SmartCOMM autorizza i client ad accedere al proprio account utente. Gli utenti accederanno all'URL di reindirizzamento per accedere alla tenancy. Gli utenti possono immettere il nome utente e le credenziali per accedere al tenancy per il primo tentativo. (i tentativi seguenti verranno visualizzati direttamente nella tabella codici di accesso)
- Accettare la richiesta di recuperare il codice di accesso facendo clic sul pulsante Accetta
- I client usano quindi i token di accesso per accedere alle risorse, non le credenziali dell'utente.
Introduzione al connettore
- Specificare l'URL host dell'istanza SmartCOMM
- Specificare i dettagli del client OAuth 2.0 - ID client, segreto client, URL di autorizzazione e URL del token
- Specificare l'URL di reindirizzamento generato da Power Apps (ad esempio https://global.consent.azure-apim.net/redirect)
- Creare una connessione dati all'istanza smartCOMM usando un account utente registrato
- È necessaria una configurazione completa del generatore di documenti in SmartCOMM, che contiene almeno un selettore di modello, un modello e un modello di dati.
- Creare un connettore
- Parametri obbligatori:
- Region
- RegionServer per exmaple: eu10-sb
- Client Id
- È uguale a in Specificare i dettagli del client OAuth 2.0
- Segreto client
- È uguale a in Specificare i dettagli del client OAuth 2.0
- Region
- Parametri obbligatori:
- Specificare l'URL della richiesta per generare l'endpointDocument. Ad esempio, https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
- Parametri obbligatori:
- Includi dati documento
- Sì come di consueto
- transactionData (Json o XML)
- non è necessaria la codifica Base64, perché viene eseguita dal connettore
- deve essere lo stesso formato di in SmartComm
- batchConfigResId
- ID risorsa del selettore del modello Smartcomm
- projectId
- predefinito vuoto, ma deve essere compilato quando il progetto SmartComm non viene rilasciato
- transactionRange
- può essere vuoto, ma quando viene compilato dovrebbe mostrare quali indici devono essere usati dalla matrice
- transactionDataType
- application/json o application/xml
- è il formato del parametro transactionData
- parametri aggiuntivi come merge.pdf possono essere letti nella descrizione dell'API SmartComm
- <https:// server.smartcommunications.cloud/one/apiViewer/>
- Dove <server è il server> comunicazioni intelligenti in uso (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud e così via).
- Includi dati documento
- Parametri obbligatori:
- Il connettore smartCOMM On Demand Generation genera le comunicazioni e restituisce la risposta (incluso l'output con codifica Base64) a Power App
- Restituisce una matrice di buste contenente i documenti con codifica Base64.
- Il documento solitamente all'interno di <documentEnvelope><envelopes><envelope><primaryChannel>><data string</data>
- Le comunicazioni possono quindi essere visualizzate in Power App per il download, archiviate (ad esempio, SharePoint, bucket S3) o inoltrate a un servizio di recapito di output, ad esempio SNS, Outlook, mailhouse e così via.
Problemi noti e limitazioni
- Limitazione della frequenza (rivolgersi all'amministratore SmartCOMM per maggiori dettagli perché fa parte del Contratto di licenza)
- Le dimensioni massime delle singole richieste sono di 10 MB
Errori e rimedi comuni
- Assicurarsi che 'transactionDataType' sia impostato su 'application/json' quando si usa il payload JSON.
- Assicurarsi di specificare "projectId" quando si vuole limitare l'ambito all'interno di un progetto SmartCOMM
- Assicurarsi che 'includeDocumentData' sia impostato su true quando è necessario includere l'output nella risposta
- Fare riferimento alla sezione Codici di errore comuni di seguito.
Codici di errore comuni
HTTP 403 - La generazione del documento non è riuscita. Questo errore restituisce 'id' (codice errore SmartCOMM) e l'errore 'msg' (la descrizione dell'errore SmartCOMM)
HTTP 500 - Errore interno del server È consigliabile anche che, in caso di errore quando si chiama il servizio, attendere cinque secondi prima di riprovare. In caso di più errori continui, il servizio deve avvisare gli utenti e interrompere l'invio di tale chiamata, perché la richiesta potrebbe non essere valida.
HTTP 429 - Troppe richieste Se si riceve una risposta HTTP 429, attendere 60 secondi, quindi ripetere la richiesta.
HTTP 503 - Servizio non disponibile Una risposta HTTP 503 viene inviata durante la manutenzione. Attendere 120 secondi, quindi ripetere la richiesta. Le finestre di manutenzione potrebbero durare un'ora o più durante un aggiornamento cardine.
Domande frequenti
"Fornire una suddivisione delle domande frequenti e le rispettive risposte qui. Ciò può riguardare le domande frequenti sull'interazione con il servizio sottostante o sul connettore stesso".
Dove è possibile trovare ulteriori informazioni sul servizio 'GenerateDocument'? - è disponibile qui - https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>
I dati vengono crittografati con questo connettore? - Sì, se HTTPS è configurato, la connessione verrà crittografata end-to-end.
Come è possibile ottenere un account utente SmartCOMM? - Contattare l'amministratore dell'utente SmartCOMM.
Qual è il tipo di autorizzazione? - OAuth 2.0
Come è possibile ottenere l'ID client OAuth2 e il segreto? - Contattare l'amministratore smartCOMM o fare riferimento a https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm
Come è possibile ottenere il codice di autorizzazione? - Per informazioni dettagliate, vedere la sezione "Come ottenere le credenziali".
Come è possibile ottenere supporto per questo connettore? - Contatta support@smartcommunications.com per tutte le richieste di supporto
Dove posso trovare altre informazioni sul prodotto SmartCOMM? - https://www.smartcommunications.com
Come è possibile ottenere batchConfigResId? - Contattare smartCOMM SME o fare riferimento a https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.
Come è possibile ottenere il projectId? - Contattare smartCOMM SME o fare riferimento a https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.
Quanto tempo riceverò la risposta? - Il tempo di risposta può variare in base alla velocità di rete, alle dimensioni del payload e alla complessità delle risorse e così via. SmartCOMM consiglia di eseguire una baseline delle prestazioni per raccogliere il tempo di risposta massimo e il tempo medio di risposta
Come è possibile ottenere l'output dalla risposta? - La risposta con esito positivo include l'output byte con codifica Base64[]. Per visualizzare l'output, è necessario eseguire azioni per decodificare l'output di byte[] e salvare la copia in un formato come specificato in "mimeType". Per altri dettagli, vedere https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| Predefinita | Parametri per la creazione della connessione. | Tutte le aree geografiche | Non condivisibile |
Predefinito
Applicabile: tutte le aree
Parametri per la creazione della connessione.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Area geografica | corda | Immettere l'area comunicazioni intelligenti | Vero |
| ID Client | corda | Immettere l'ID client OAuth | Vero |
| Segreto del cliente | corda | Immettere il segreto client OAuth | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Genera documento |
Questa funzione genera un documento. |
Genera documento
Questa funzione genera un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Includi dati documento
|
includeDocumentData | True | boolean |
Flag booleano per determinare se i dati dei documenti generati devono essere forniti direttamente. I valori possibili sono true o false. Se true, verranno forniti dati base64 per ogni risultato del canale. Se false, verrà fornito un URL per il recupero dei dati per ogni risultato del canale. I dati del documento restituiti nella risposta saranno codificati in Base64. |
|
projectId
|
projectId | integer |
ID del progetto CMS usato per definire l'ambito dell'esecuzione della richiesta. Se questo valore non viene specificato, il processo verrà eseguito in modalità di produzione. |
|
|
transactionData
|
transactionData | True | string |
Dati di esempio. |
|
batchConfigResId
|
batchConfigResId | True | integer |
ID CMS della risorsa Selettore modello. Il selettore modello viene usato per eseguire il mapping dei dati delle transazioni al modello e al modello di dati. |
|
transactionRange
|
transactionRange | integer |
transactionRange |
|
|
transactionDataType
|
transactionDataType | string |
Tipo di contenuto dei dati della transazione. Può essere 'application/xml' o 'application/json'. Il valore predefinito è 'application/xml'. |
|
|
nome
|
name | string |
Nome della proprietà. |
|
|
value
|
value | string |
Valore della proprietà. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
eccezioni
|
exceptions | array of object |
eccezioni |
|
classId
|
exceptions.classId | integer |
Codice dell'eccezione aziendale. |
|
id
|
exceptions.id | integer |
ID univoco dell'eccezione aziendale. |
|
className
|
exceptions.className | string |
Descrizione dell'eccezione aziendale. |
|
msg
|
exceptions.msg | string |
Messaggio di eccezione definito dall'utente. |
|
previewKey
|
previewKey | string |
La chiave viene usata per recuperare le parti del documento. Non utilizzato quando includeDocumentData è impostato su true nella richiesta. |
|
numberTransactions
|
numberTransactions | integer |
Numero di transazioni rilevate nel processo. |
|
dataModelValuesLocation
|
dataModelValuesLocation | string |
Riferimento alla parte dei valori del modello di dati. |
|
inviluppi
|
envelopes | array of object |
inviluppi |
|
startPage
|
envelopes.primaryChannel.startPage | integer |
Numero di pagina iniziale di un documento racchiuso nel documento di stampa unito principale. |
|
pageCount
|
envelopes.primaryChannel.pageCount | integer |
Numero di pagine nel documento generato. |
|
channelType
|
envelopes.primaryChannel.channelType | integer |
Tipo del canale. I tipi possibili sono: '1' TYPE_HTML '2' TYPE_PRINT '3' TYPE_SMS '4' TYPE_TEXT '5' TYPE_TML '6' TYPE_XML '7' TYPE_WORDML '8' TYPE_XSLFO. |
|
Nome canale
|
envelopes.primaryChannel.channelName | string |
Nome del canale. |
|
proprietà
|
envelopes.primaryChannel.properties | array of object |
proprietà |
|
nome
|
envelopes.primaryChannel.properties.name | string |
nome |
|
value
|
envelopes.primaryChannel.properties.value | string |
value |
|
data
|
envelopes.primaryChannel.data | string |
Dati del documento codificati come Base64. Popolato solo quando includeDocumentData è impostato su true nella richiesta. |
|
Nome documento
|
envelopes.primaryChannel.documentName | string |
Nome del documento generato. |
|
tipo MIME
|
envelopes.primaryChannel.mimeType | string |
Tipo di contenuto del documento. |
|
ID canale
|
envelopes.primaryChannel.channelId | integer |
ID del canale del documento. |
|
partLocation
|
envelopes.primaryChannel.partLocation | string |
Riferimento alla parte del documento per il recupero tramite il metodo cachedItems. Questa operazione non viene utilizzata quando includeDocumentData è impostato su true nella richiesta. |
|
enclosureChannels
|
envelopes.enclosureChannels | array of object |
enclosureChannels |
|
startPage
|
envelopes.enclosureChannels.startPage | integer |
startPage |
|
pageCount
|
envelopes.enclosureChannels.pageCount | integer |
pageCount |
|
channelType
|
envelopes.enclosureChannels.channelType | integer |
channelType |
|
Nome canale
|
envelopes.enclosureChannels.channelName | string |
Nome canale |
|
proprietà
|
envelopes.enclosureChannels.properties | array of object |
proprietà |
|
nome
|
envelopes.enclosureChannels.properties.name | string |
nome |
|
value
|
envelopes.enclosureChannels.properties.value | string |
value |
|
data
|
envelopes.enclosureChannels.data | string |
data |
|
Nome documento
|
envelopes.enclosureChannels.documentName | string |
Nome documento |
|
tipo MIME
|
envelopes.enclosureChannels.mimeType | string |
tipo MIME |
|
ID canale
|
envelopes.enclosureChannels.channelId | integer |
ID canale |
|
partLocation
|
envelopes.enclosureChannels.partLocation | string |
partLocation |
|
jobMessages
|
jobMessages | array of object |
jobMessages |
|
argomenti
|
jobMessages.args | array of string |
argomenti |
|
msgID
|
jobMessages.msgID | integer |
ID del messaggio. |
|
destID
|
jobMessages.destID | integer |
ID della destinazione. |
|
msgType
|
jobMessages.msgType | string |
Tipo di messaggio: info (I), avvisa (W) o errore (E). |
|
msgText
|
jobMessages.msgText | string |
Testo del messaggio. |
|
msgDate
|
jobMessages.msgDate | string |
Data/ora del messaggio. |
|
transactionNo
|
jobMessages.transactionNo | integer |
Numero della transazione. |
|
packageID
|
jobMessages.packageID | integer |
ID del pacchetto. |
|
batchID
|
jobMessages.batchID | integer |
ID del batch. |
|
docID
|
jobMessages.docID | integer |
ID del documento. |
|
channelID
|
jobMessages.channelID | integer |
ID canale del documento. |