SmartCOMM DocGen (Pré-visualização)

A Smart Communications é uma empresa líder em tecnologia focada em ajudar as empresas a se envolverem em conversas mais significativas com os clientes.

O SmartCOMM On-Demand Doc-Gen Connector inclui uma integração pré-construída para produzir comunicações omnicanal com o cliente. O conector fornece chamadas de serviço Web RESTful para SmartCOMM para casos de uso sob demanda.

Este conector está disponível nos seguintes produtos e regiões:

A Smart Communications™ é uma plataforma líder baseada na nuvem para comunicações com clientes empresariais. Como a única solução de nuvem classificada como líder no Quadrante Mágico do Gartner para gerenciamento de comunicações com o cliente, mais de 350 marcas globais – muitas nos setores mais altamente regulamentados do mundo – confiam nas comunicações inteligentes para tornar as comunicações multicanal com os clientes mais significativas, ao mesmo tempo em que as ajudam a simplificar seus processos e operar de forma mais eficiente.

O SmartCOMM On Demand Connector for Power Apps inclui uma integração pré-criada para produzir comunicações com o cliente. O conector fornece chamadas de serviço Web RESTful para SmartCOMM para casos de uso sob demanda.

O conector suporta a operação SmartCOMM 'GenerateDocument' que gera uma resposta incluindo a saída byte[] codificada base64. A saída suporta diferentes tipos de saída de canal. (por exemplo, SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)

Pré-requisitos

Para usar o componente SmartCOMM no Power Apps, você precisará de algumas coisas concluídas primeiro:

• Um plano Microsoft Power Apps ou Power Automate com recurso de conector personalizado
• Uma instância SmartCOMM configurada para sua organização com acesso de usuário
• Você precisará trabalhar com seu contato de comunicações inteligentes para configurar um modelo de documento a partir do qual gerar documentos.
• Para definir as configurações do componente - você precisará saber o ID do recurso 'BatchConfigResID' ou SmartCOMM Template Seletor. Peça ao seu contacto Smart Communications para o ajudar a encontrar isto.
• Configure sua instância SmartCOMM com um cliente OAuth 2.0 (tipo de concessão de código de autorização)

Como obter credenciais

1. Entre em contato com o administrador do usuário SmartCOMM para criar seu acesso de usuário
2. Assim que o seu acesso de utilizador for criado, receberá um e-mail para ativar a sua conta
3. Siga as instruções para ativar a sua conta
4. No fluxo do Código de Autorização, o usuário SmartCOMM que possui os recursos na nuvem SmartCOMM autoriza os clientes a acessar sua conta de usuário. Os usuários acessarão o URL de redirecionamento para fazer login na locação. Os usuários podem inserir seu nome de usuário e credenciais para acessar a locação para a primeira tentativa. (as seguintes tentativas irão aparecer diretamente na página de código de acesso)
5. Aceite o pedido para recuperar o código de acesso, clicando no botão Aceitar
6. Em seguida, os clientes usam tokens de acesso para acessar os recursos, não as credenciais do usuário.

Introdução ao conector

1. Forneça a URL do host da instância SmartCOMM
2. Forneça os detalhes do Cliente OAuth 2.0 - ID do Cliente, Segredo do Cliente, URL de Autorização e URL do Token
3. Forneça o URL de redirecionamento gerado pelo Power Apps (por exemplo) https://global.consent.azure-apim.net/redirect
4. Criar uma conexão de dados com a instância SmartCOMM usando uma conta de usuário registrada
   • Precisamos de uma configuração completa do gerador de documentos no SmartCOMM, que contém pelo menos um seletor de modelo, um modelo e um modelo de dados.
5. Criar conector
   • Parâmetros necessários:
     • Region
       • RegionServer para exmaple: eu10-sb
     • ID do cliente
       • É o mesmo que no Forneça os detalhes do cliente OAuth 2.0
     • Segredo do Cliente
       • É o mesmo que no Forneça os detalhes do cliente OAuth 2.0
6. URL de solicitação de fornecimento para gerar o ponto de extremidade Document. Por exemplo, https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • Parâmetros necessários:
     • Incluir dados do documento
       • Sim, como de costume
     • transactionData (Json ou XML)
       • Não há necessidade de codificação base64, porque é feito pelo conector
       • deve ser o mesmo formato que no SmartComm
     • batchConfigResId
       • ID de recurso do Seletor de Modelo Smartcomm
     • projectId
       • padrão vazio, mas tem que ser preenchido quando o projeto SmartComm não é lançado
     • transactionRange
       • ele pode estar vazio, mas quando preenchido deve mostrar quais índices devem ser usados a partir da matriz
     • transactionDataType
       • Aplicativo/JSON ou Aplicativo/XML
       • é o formato do parâmetro transactionData
     • parâmetros extras como merge.pdf podem ser lidos na descrição da API SmartComm
       • https://< servidor.smartcommunications.cloud/one/apiViewer/>
       • Onde <servidor> é o servidor de comunicações inteligentes que você está usando (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud e assim por diante).
7. O conector SmartCOMM On Demand Generation gera a(s) comunicação(ões) e retorna a resposta (incluindo a saída codificada em base64) para o Power App
   • Retorna uma matriz de envelope, que contém os documentos codificados base64.
   • O documento normalmente dentro de <documentEnvelope><envelopes><envelope><primárioCanal><cadeia de< dados>/dados>
8. A(s) comunicação(ões) pode(m) ser exibida(s) no Power App para download, arquivada (por exemplo, SharePoint, bucket do S3) ou enviada para um serviço de entrega de saída, por exemplo, SNS, Outlook, mailhouse, etc.

Problemas conhecidos e limitações

1. Limitação de tarifas (consulte o administrador do SmartCOMM para obter mais detalhes, pois isso faz parte do Contrato de Licença)
2. O tamanho máximo do pedido individual é de 10MB

Erros e soluções comuns

1. Certifique-se de 'transactionDataType' definido como 'application/json' ao usar a carga JSON útil.
2. Certifique-se de especificar 'projectId' quando quiser limitar o escopo dentro de um projeto SmartCOMM
3. Certifique-se de que 'includeDocumentData' seja definido como true quando precisar que a saída seja incluída na resposta
4. Consulte a seção Códigos de erro comuns abaixo.

Códigos de erro comuns

• HTTP 403 - Gerar documento falhou Este erro retorna 'id' (o código de erro SmartCOMM) e o erro 'msg' (a descrição do erro SmartCOMM)

• HTTP 500 - Erro interno do servidor Também recomendamos que, no caso de um erro ao chamar o serviço, aguarde cinco segundos antes de tentar novamente. Em várias falhas contínuas, seu serviço deve alertar os usuários e parar de enviar essa chamada, pois sua solicitação pode ser inválida.

• HTTP 429 - Muitas solicitações Se você receber uma resposta HTTP 429, deverá aguardar 60 segundos e, em seguida, tentar novamente sua solicitação.

• HTTP 503 - Serviço indisponível Uma resposta HTTP 503 é enviada durante a manutenção. Deve aguardar 120 segundos e, em seguida, repetir o seu pedido. As janelas de manutenção podem durar uma hora ou mais durante uma atualização de etapa.

FAQ

«Forneça aqui uma discriminação das perguntas mais frequentes e das respetivas respostas. Isso pode abranger perguntas frequentes sobre a interação com o serviço subjacente ou sobre o próprio conector."

• Onde posso encontrar mais informações sobre o serviço 'GenerateDocument'? - pode ser encontrado aqui - https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• Os dados são criptografados usando esse conector? - Sim, se HTTPS estiver configurado a conexão será criptografada de ponta a ponta.

• Como posso obter uma conta de utilizador SmartCOMM? - Entre em contato com o administrador do usuário SmartCOMM.

• Qual é o tipo de autorização? - OAuth 2.0

• Como posso obter o ID do Cliente OAuth2 e o segredo? - Entre em contato com seu administrador SmartCOMM ou consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• Como posso obter o código de autorização? - Consulte a seção 'Como obter credenciais' acima para obter detalhes completos.

• Como posso obter suporte para este conector? - Contato support@smartcommunications.com para todas as consultas de suporte

• Onde posso encontrar mais informações sobre o produto SmartCOMM? - https://www.smartcommunications.com

• Como posso obter o batchConfigResId? - Entre em contato com sua PME SmartCOMM ou consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Como posso obter o projectId? - Entre em contato com sua PME SmartCOMM ou consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Em quanto tempo receberei a resposta? - O tempo de resposta pode variar com base na velocidade da sua rede, tamanho da carga útil e complexidade dos recursos, etc. SmartCOMM recomenda executar uma linha de base de desempenho para coletar o tempo máximo de resposta e o tempo médio de resposta

• Como posso obter o resultado da resposta? - A resposta bem-sucedida inclui a saída byte[] codificada base64. Para visualizar a saída, ações devem ser tomadas para decodificar a saída byte[] e salvar a cópia em um formato conforme especificado no "mimeType". Para obter mais detalhes, consulte https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Limites de Limitação

Ações

Gerar documento