SmartCOMM DocGen (versión preliminar)

Smart Communications es una empresa tecnológica líder centrada en ayudar a las empresas a participar en conversaciones de clientes más significativas.

SmartCOMM On-Demand Doc-Gen Connector incluye una integración pregenerada para producir comunicaciones de clientes omnicanal. El conector proporciona llamadas de servicio web RESTful a SmartCOMM para casos de uso a petición.

Este conector está disponible en los siguientes productos y regiones:

Smart Communications™ es una plataforma líder basada en la nube para las comunicaciones de clientes empresariales. Como la única solución en la nube clasificada como líder en el cuadrante mágico de Gartner para la administración de comunicaciones de clientes, más de 350 marcas globales , muchas de las industrias más reguladas del mundo, dependen de Smart Communications para que las comunicaciones de clientes multicanal sean más significativas, a la vez que les ayudan a simplificar sus procesos y funcionar de forma más eficaz.

SmartCOMM On Demand Connector para Power Apps incluye una integración pregenerada para producir comunicaciones de cliente. El conector proporciona llamadas de servicio web RESTful a SmartCOMM para casos de uso a petición.

El conector admite la operación "GenerateDocument" de SmartCOMM, que genera una respuesta que incluye la salida byte[] codificada en base64. La salida admite diferentes tipos de salida de canal. (por ejemplo, SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)

Prerrequisitos

Para usar el componente SmartCOMM en Power Apps, necesitará algunas cosas completadas primero:

• Un plan de Microsoft Power Apps o Power Automate con una característica de conector personalizada
• Una instancia de SmartCOMM configurada para su organización con acceso de usuario
• Deberá trabajar con el contacto de Smart Communications para configurar una plantilla de documento a partir de la que generar documentos.
• Para configurar los valores de los componentes, deberá conocer el identificador de recurso del selector de plantillas de BatchConfigResID o SmartCOMM. Pida al contacto de Smart Communications que le ayude a encontrar esto.
• Configurar la instancia de SmartCOMM con un cliente de OAuth 2.0 (tipo de concesión de código de autorización)

Obtención de credenciales

1. Póngase en contacto con el administrador de usuarios de SmartCOMM para crear el acceso de usuario.
2. Una vez creado el acceso de usuario, recibirá un correo electrónico para activar su cuenta.
3. Siga las instrucciones para activar su cuenta.
4. En el flujo de código de autorización, el usuario de SmartCOMM que posee los recursos de la nube de SmartCOMM autoriza a los clientes a acceder a su cuenta de usuario. Los usuarios accederán a la dirección URL de redireccionamiento para iniciar sesión en el inquilino. Los usuarios pueden escribir el nombre de usuario y las credenciales para acceder al inquilino para el primer intento. (los siguientes intentos aparecerán directamente en la página de códigos de acceso).
5. Acepte la solicitud para recuperar el código de acceso; para ello, haga clic en el botón Aceptar.
6. A continuación, los clientes usan tokens de acceso para acceder a los recursos, no a las credenciales del usuario.

Introducción al conector

1. Proporcione la dirección URL del host de la instancia de SmartCOMM.
2. Proporcione los detalles del cliente de OAuth 2.0: identificador de cliente, secreto de cliente, dirección URL de autorización y dirección URL del token.
3. Proporcione la dirección URL de redireccionamiento generada por Power Apps (por ejemplo, https://global.consent.azure-apim.net/redirect)
4. Creación de una conexión de datos a la instancia de SmartCOMM mediante una cuenta de usuario registrada
   • Necesitamos una configuración completa del generador de documentos en SmartCOMM, que contiene al menos un selector de plantillas, una plantilla y un modelo de datos.
5. Creación de un conector
   • parámetros obligatorios:
     • Region
       • RegionServer para exmaple: eu10-sb
     • Id. de cliente
       • Es lo mismo que en proporcionar los detalles del cliente de OAuth 2.0.
     • Secreto de cliente
       • Es lo mismo que en proporcionar los detalles del cliente de OAuth 2.0.
6. Proporcione la dirección URL de solicitud para generar el punto de conexióndocumento. Por ejemplo, https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • parámetros obligatorios:
     • Incluir datos de documento
       • Sí como de costumbre
     • transactionData (Json o XML)
       • no es necesario codificar base64, ya que el conector lo realiza.
       • debe ser el mismo formato que en SmartComm.
     • batchConfigResId
       • Identificador de recurso del selector de plantillas de Smartcomm
     • projectId
       • el valor predeterminado está vacío, pero debe rellenarse cuando no se libere el proyecto SmartComm.
     • transactionRange
       • puede estar vacío, pero cuando se rellena debe mostrar qué índices se deben usar desde la matriz.
     • transactionDataType
       • application/json o application/xml
       • es el formato del parámetro transactionData.
     • se pueden leer parámetros adicionales como merge.pdf en la descripción de la API de SmartComm.
       • <https:// server.smartcommunications.cloud/one/apiViewer/>
       • Donde <servidor> es el servidor de comunicaciones inteligentes que está usando (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud, etc.).
7. El conector SmartCOMM On Demand Generation genera las comunicaciones y devuelve la respuesta (incluida la salida codificada en base64) a Power App.
   • Devuelve una matriz de sobres, que contiene los documentos codificados en base64.
   • El documento habitualmente dentro de <los sobres><documentEnvelope><sobres><primaryChannel><data>/<data>
8. Después, las comunicaciones se pueden mostrar en Power App para su descarga, archivadas (por ejemplo, cubos de SharePoint, S3) o insertadas en un servicio de entrega de salida, por ejemplo, SNS, Outlook, mailhouse, etc.

Problemas y limitaciones conocidos

1. Limitación de velocidad (consulte con el administrador de SmartCOMM para obtener más detalles, ya que forma parte del Contrato de licencia)
2. El tamaño máximo de solicitud individual es de 10 MB

Errores y soluciones comunes

1. Asegúrese de que "transactionDataType" esté establecido en "application/json" al usar la carga JSON.
2. Asegúrese de especificar "projectId" cuando desee limitar el ámbito dentro de un proyecto smartCOMM.
3. Asegúrese de que "includeDocumentData" se establece en true cuando necesite incluir la salida en la respuesta.
4. Consulte la sección Códigos de error comunes a continuación.

Códigos de error comunes

• HTTP 403: Error al generar documento: este error devuelve "id" (el código de error de SmartCOMM) y el error "msg" (descripción del error de SmartCOMM).

• HTTP 500: error interno del servidor También se recomienda que, en caso de error al llamar al servicio, espere cinco segundos antes de volver a intentarlo. En varios errores continuos, el servicio debe alertar a los usuarios y dejar de enviar esa llamada, ya que la solicitud puede no ser válida.

• HTTP 429: demasiadas solicitudes Si recibe una respuesta HTTP 429, debe esperar 60 segundos y volver a intentar la solicitud.

• HTTP 503: servicio no disponible Se envía una respuesta HTTP 503 durante el mantenimiento. Debe esperar 120 segundos y volver a intentar la solicitud. Las ventanas de mantenimiento pueden durar una hora o más durante una actualización de hitos.

Preguntas más frecuentes

"Proporcione un desglose de las preguntas más frecuentes y sus respectivas respuestas aquí. Esto puede abarcar preguntas más frecuentes sobre la interacción con el servicio subyacente o sobre el propio conector.

• ¿Dónde puedo encontrar más información sobre el servicio "GenerateDocument"? - se puede encontrar aquí - https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• ¿Los datos se cifran mediante este conector? - Sí, si HTTPS está configurado, la conexión se cifrará de un extremo a otro.

• ¿Cómo puedo obtener una cuenta de usuario de SmartCOMM? - Póngase en contacto con el administrador del usuario de SmartCOMM.

• ¿Cuál es el tipo de autorización? - OAuth 2.0

• ¿Cómo puedo obtener el identificador de cliente y el secreto de OAuth2? - Póngase en contacto con el administrador de SmartCOMM o consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• ¿Cómo puedo obtener el código de autorización? - Consulte la sección "Cómo obtener credenciales" anterior para obtener detalles completos.

• ¿Cómo puedo obtener soporte técnico para este conector? - Contacto para support@smartcommunications.com todas las consultas de soporte técnico

• ¿Dónde puedo encontrar más información sobre el producto SmartCOMM? - https://www.smartcommunications.com

• ¿Cómo puedo obtener batchConfigResId? - Póngase en contacto con el SME de SmartCOMM o consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• ¿Cómo puedo obtener el projectId? - Póngase en contacto con el SME de SmartCOMM o consulte https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• ¿Qué tan pronto obtendré la respuesta? - El tiempo de respuesta puede variar en función de la velocidad de la red, el tamaño de la carga y la complejidad de los recursos, etc. SmartCOMM recomienda ejecutar una línea base de rendimiento para recopilar el tiempo máximo de respuesta y el tiempo medio de respuesta.

• ¿Cómo puedo obtener la salida de la respuesta? - La respuesta correcta incluye la salida byte[] codificada en base64. Para ver la salida, se deben realizar acciones para descodificar la salida byte[] y guardar la copia en un formato como se especifica en "mimeType". Para obtener más información, consulte https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Limitaciones

Acciones

Generar documento