SmartCOMM DocGen (versão prévia)

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é-criada para produzir comunicações de clientes omnichannel. O conector fornece chamadas de serviço Web RESTful para SmartCOMM para casos de uso sob demanda.

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

A Smart Communications™ é uma plataforma líder em nuvem para comunicações de clientes empresariais. Como a única solução de nuvem classificada como líder no Magic Quadrant for Customer Communications Management da Gartner, mais de 350 marcas globais – muitas nos setores mais altamente regulamentados do mundo – dependem da Smart Communications para tornar as comunicações de clientes multicanais mais significativas, ao mesmo tempo em que as ajudam a simplificar seus processos e operar com mais eficiência.

O Conector SmartCOMM sob Demanda para 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 dá suporte à operação "GenerateDocument" do SmartCOMM, que gera uma resposta, incluindo a saída de bytes codificados em base64. A saída dá suporte a 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 do Microsoft Power Apps ou do Power Automate com o recurso de conector personalizado
• Uma instância do SmartCOMM configurada para sua organização com acesso do usuário
• Você precisará trabalhar com seu contato de Comunicações Inteligentes para configurar um modelo de documento do qual gerar documentos.
• Para definir as configurações do componente, você precisará saber a ID do recurso 'BatchConfigResID' ou do Seletor de Modelos smartCOMM. Peça ao seu contato de Comunicações Inteligentes para ajudá-lo a encontrar isso.
• Configurar sua instância do 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 de usuário do SmartCOMM para criar o acesso do usuário
2. Depois que o acesso do usuário for criado, você receberá um email para ativar sua conta
3. Siga as instruções para ativar sua conta
4. No fluxo 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 a URL de redirecionamento para fazer logon no locatário. Os usuários podem inserir o nome de usuário e as credenciais para acessar o locatário da primeira tentativa. (as tentativas a seguir aparecerão diretamente na página de código de acesso)
5. Aceite a solicitação para recuperar o código de acesso, clicando no botão Aceitar
6. Os clientes usam tokens de acesso para acessar os recursos, não as credenciais do usuário.

Introdução ao conector

1. Fornecer a URL do host da instância do SmartCOMM
2. Forneça os detalhes do cliente OAuth 2.0 – ID do cliente, segredo do cliente, URL de autorização e URL de token
3. Forneça a URL de Redirecionamento gerada pelo Power Apps (por exemplo https://global.consent.azure-apim.net/redirect)
4. Criar uma conexão de dados com a instância do SmartCOMM usando uma conta de usuário registrada
   • Precisamos de uma configuração completa do gerador de documentos no SmartCOMM, que contenha pelo menos um seletor de modelo, um modelo e um modelo de dados.
5. Criar conector
   • parâmetros necessários:
     • Região
       • RegionServer para exmaple: eu10-sb
     • ID do cliente
       • Ele é o mesmo que nos detalhes do cliente do OAuth 2.0
     • Segredo do cliente
       • Ele é o mesmo que nos detalhes do cliente do OAuth 2.0
6. URL da 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 ela é feita pelo conector
       • deve ser o mesmo formato que no SmartComm
     • batchConfigResId
       • ID do recurso do seletor de modelo smartcomm
     • projectId
       • padrão vazio, mas tem que ser preenchido quando o projeto SmartComm não é lançado
     • transactionRange
       • pode estar vazio, mas quando preenchido deve mostrar quais índices devem ser usados da matriz
     • transactionDataType
       • application/json ou application/xml
       • é o formato do parâmetro transactionData
     • parâmetros extras como merge.pdf podem ser lidos na descrição da API do SmartComm
       • <https:// server.smartcommunications.cloud/one/apiViewer/>
       • Onde <o servidor> é o servidor de Comunicações Inteligentes que você está usando (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud e assim por diante).
7. O conector de Geração SmartCOMM Sob Demanda gera as comunicaçõ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 em base64.
   • O documento usual dentro de <envelopes documentEnvelope><envelope><primaryChannel><><cadeia< de dados>/dados>
8. As comunicações podem ser exibidas no Power App para download, arquivadas (por exemplo, SharePoint, S3 bucket) ou enviadas por push para um serviço de entrega de saída, por exemplo, SNS, Outlook, mailhouse etc.

Problemas e limitações conhecidos

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

Erros e soluções comuns

1. Verifique se 'transactionDataType' é definido como 'application/json' ao usar o conteúdo JSON.
2. Especifique 'projectId' quando você quiser limitar o escopo em um projeto SmartCOMM
3. Certifique-se de que 'includeDocumentData' seja definido como true quando você 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 – Falha ao gerar documento 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, você 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 tentar novamente sua solicitação.

• HTTP 503 – Serviço indisponível Uma resposta HTTP 503 é enviada durante a manutenção. Você deve aguardar 120 segundos e tentar novamente sua solicitação. As janelas de manutenção podem durar uma hora ou mais durante uma atualização de marco.

perguntas frequentes

Forneça um detalhamento das perguntas frequentes e suas respectivas respostas aqui. Isso pode abranger perguntas frequentes sobre como interagir 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 usuário do SmartCOMM? – Contate o administrador de usuários do SmartCOMM.

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

• Como posso obter a ID e o segredo do cliente OAuth2? – Contate o administrador do 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 esse conector? – Contato support@smartcommunications.com para todas as investigações 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 seu SME do SmartCOMM ou consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Como posso obter a projectId? – Entre em contato com seu SME do SmartCOMM ou consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Quanto tempo obterei a resposta? - O tempo de resposta pode variar com base na velocidade da rede, no tamanho da carga e na complexidade dos recursos, etc. O 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 a saída da resposta? - A resposta bem-sucedida inclui a saída de bytes codificados em base64[]. Para exibir a saída, é necessário executar ações para decodificar a saída de bytes[] 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>

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Limitações

Ações

Gerar Documento