Introducción
El conector de Hyperscience para Bizagi está disponible en Connectors Xchange de Bizagi.
A través de este conector, podrá conectar sus procesos con Hyperscience para utilizar su capacidad de procesamiento de documentos inteligente. Para más información sobre las capacidades de este conector, visite Connectors Xchange de Bizagi.
Antes de iniciar
Para probar y usar este conector, necesita:
1.Bizagi Studio previamente instalado.
2.Éste conector previamente instalado a través de Connectors Xchange, tal como se describe en https://help.bizagi.com/platform/es/index.html?Connectors_Xchange.htm, o a través de el manual de instalación descrito en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm
Requerimientos del sistema
Los siguientes son los requerimientos para el conector de Hyperscience:
•Bizagi Versión 11.2.2 o superior
•Hyperscience V28 o superior
|
Hyperscience ofrece soporte a los métodos de este conector dependiendo de la versión de Hyperscience de la siguiente manera: •Hyperscience v28 - v30: soporte únicamente para creación de envíos y para recuperación de los resultados del procesamiento de los documentos. •Hyperscience v31: soporte para creación de casos y para recuperación de los resultados del procesamiento de los casos. |
Configurar el conector
Para configurar el conector siga los pasos presentados en el capítulo de configuración en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
Para esta configuración, considere los siguientes parámetros de autenticación:
•Authentication method: Custom.
•API_Key: Clave API Key generada en Hyperscience.
Utilice los siguientes parámetros de conector:
•HOST_URL: URL de su instancia de Hyperscience.
•PORT: si el servidor de Hyperscience está corriendo en un puerto distinto al 80 o al 443 (HTTPS), agregue el número de puerto. Este parámetro es opcional
•API_VERSION: Versión de Huperscience. Los valores posibles son “v4” y “v5”
Usando el conector
Este conector le permite el uso de métodos para procesar y obtener resultados sobre sus documentos de manera inteligente desde sus procesos de Bizagi.
Para aprender en general cómo y dónde configurar el uso de un conector, visite el artículo https://help.bizagi.com/platform/es/index.html?Connectors_Studio.htm.
Al usar el conector, tenga en cuenta que puede necesitar configurar entradas o salidas. Las siguientes imágenes muestran ejemplos de cómo mapear las entradas o salidas de un método.
Acciones disponibles
Submit Documents
Esta acción le permite enviar documentos a Hyperscience como parte de un caso para ser procesados. Si usted utiliza la versión 5 del API y la versión 31 o superior de Hyperscience, los documentos serán enviados a Hyperscience como parte del caso y serán procesados allí. Para configurar sus entradas, tenga en cuenta las siguientes descripciones:
•caseID (Texto): id del caso que agrupará los documentos que se envíen.
oSi utiliza la versión 4 del API de Hyperscience, el cual no soporta casos, el bizagiCaseId es pasado a Hyperscience en la metadata del envío.
oSi utiliza la versión 5 del API de Hyperscience y la versión 28 o 30 de Hyperscience, la información del caso no será enviada a Hyperscience en la metadata ni como parte del caso.
•documents (Colección): conjunto de documentos que se envían a Hyperscience. Los tipos de archivo soportados son JPEG, PNG, TIFF, PDF y XPS.
ofileName (Texto): nombre de cada archivo.
odata (Entero): contenido de cada archivo.
•flowUuid (Texto): en Hyperscience versión 30 y superior, el UUID es el flujo al que desea enviar los documentos. Por defecto, los documentos se envían al flujo predeterminado en Hyperscience, el cual es "Procesamiento de documentos" o "Procesamiento de documentos (V31).
•layoutUUID (Texto): si tiene casos de uso semi estructurados en Hyperscience, mapee este atributo.
•machineOnly (Booleano): este campo le permite seleccionar si desea confiar en el procesamiento inteligente de Hyperscience, o si desea un procesamiento manual dentro del mismo.
|
El tamaño máximo de todos los archivos enviados debe ser de 500MB considerando una red de 100Mbps. Si envía más de 500MB en una sola petición HTTP, puede generarse un error. |
Para configurar las salidas, tenga en cuenta las siguientes descripciones:
•submissionUUID (Entero): mapee el submissionUUID desde Hyperscience hacia Bizagi .
•rawResponse (Texto): este parámetro contiene los resultados del envío sin procesar. No es necesario mapear este parámetro a algún campo en Bizagi.
•submissionUUID (Entero): mapee el submissionUUID desde Hyperscience hacia Bizagi.
Get Submission Results
Esta acción le permite obtener los resultados sobre los documentos enviados. Para configurar sus entradas, tenga en cuenta las siguientes descripciones:
•submissionId (Texto): mapee el submissionUUID desde Bizagi hacia la acción de Hyperscience.
•flat (Booleano): por defecto, los resultados devueltos estarán completos, incluyendo la información del proceso de IDP. Si este parámetro retorna verdadero, los resultados excluirán las carpetas de los documentos, páginas sin asignar y documentos rechazados del objeto Submission object.
Para configurar las salidas, tenga en cuenta las siguientes descripciones:
•hyperscienceCaseId (Texto): mapee el hyperscienceCaseId desde Hyperscience hacia Bizagi
•rawResponse (Texto): este parámetro contiene los resultados del envío sin procesar.
•isCompleted (Booleano): booleano que indica si el procesamiento de los documentos ya terminó.
•isSupervisionRequired (Booleano): este parámetro le informa si se requiere una revisión.
•supervisionUrl (Texto): mapee el parámetro supervisionUrl desde Hyperscience hacia Bizagi para para obtener la URL de la posible revisión.
Get Case Data
Esta acción devuelve la información de un caso particular.
|
la acción de getCaseData sólo se soporta con la versión 5 del API y versión 31 o superior de la aplicación de Hyperscience. |
Para configurar sus entradas, tenga en cuenta las siguientes descripciones:
•bizagiCaseId (Texto): mapee el bizagiCaseId desde Bizagi a la acción de Hyperscience.
•flat (Booleano): por defecto, los resultados incluyen la información disponible del caso, definida en el objeto Case del modelo. Si el parámetro se define como verdadero, los resultados excluirán los arreglos de documentos, de archivos de envío y de páginas sin asignar del objeto Case.
Para configurar las salidas, tenga en cuenta las siguientes descripciones:
•rawResponse (Texto): este parámetro contiene los resultados del envío sin procesar en Hyperscience.
•hyperscienceCaseId (Entero): identificador único generado por el sistema y mostrado en la aplicación de Hyperscience.
•hyperscienceCaseUuid (Texto): identificador único generado por el sistema, pero utilizado cuando se migran datos de casos entre sistemas.
•documentIds (Colección): colección de documentos incluida en el caso.
Para mayor información sobre cómo utilizar el API de Hyperscience, consulte la documentación oficial de Hyperscience en https://docs.hyperscience.com/.
Last Updated 10/24/2022 10:54:57 AM