Bizagi

  • Published on Sep 24, 2024
  • 2 minute(s) read

Overview

With the introduction of our Bizagi connector, mutual customers of Bizagi and Hyperscience can leverage Hyperscience's automation capabilities in the processing of Bizagi cases. The connector allows cases to be ingested into Hyperscience and sent back to Bizagi after processing. This flow of cases into and out of Hyperscience happens automatically through our API after you set up the connector in Bizagi Studio. 

The Bizagi integration is available only for on-premise / private cloud instances of Hyperscience.

Sample Use Cases

  • I have a Bizagi case with documents to be processed in Hyperscience before the extracted information is sent back to Bizagi.

  • I want to process documents from an external source in Hyperscience and then send extracted information back to Bizagi.

Compatibility

To use the connector, you must have both of the following:

  • Bizagi Version 11.2.2 or later

  • Hyperscience v28 or later

While you can use the connector with Hyperscience v28-v30, cases are supported as Hyperscience entities only in v31 and later.

Setting Up the Bizagi Integration

Setting up the connector

To set up the connector, download it from the Bizagi Connector Xchange, and install it in Bizagi Studio. Then, follow the instructions in Bizagi's connector user guide to finish setting up the connector. You do not need to set up any input or output connections in Hyperscience.

Processing cases in Hyperscience

After you have set up the connector in Bizagi Studio, the system will process cases from Bizagi as follows:

  1. The connector ingests the case from Bizagi as a single submission containing all of the case's pages.

  2. The system matches the submission's pages to layouts and divides the submission into documents, just as it does for submissions from other sources.

  3. The documents go through the steps in your default flow (“Document Processing,” “Document Processing (V31)”, “Document Processing (V32)”, “Document Processing (V33)”, “Document Processing (V34)”, or “Document Processing V35”).

    • If you’re not sure which flow your submissions are sent to by default, contact your Hyperscience representative.

    • If you set up your connector to process cases without Supervision (machineOnly), then the system does not create Supervision tasks for them, even if those tasks appear in your flow.

    • When the system does create a Supervision task, it will prompt Bizagi to generate a URL for the task and send it to the connector for handling. You must configure these URLs to be prefixed with your host URL and port.

    • Bizagi polls Hyperscience for completed Bizagi submissions. After all the documents in a submission are completed, the system will send all of them back to Bizagi through the connector, where they will be grouped back into a case.

    • You will need to implement this polling as a timed asynchronous activity. For more information, see Bizagi’s Using Asynchronous Activities.

Additional Resources