Manage solutions

Use the Solution Dashboard to manage and monitor deployed solutions. Deployed solutions include any compiled flows that you deploy.

Only users with site admin or Marketplace Admin permissions can deploy, update, or delete solutions. Any user can run or schedule deployed solutions, and view solution metrics.

Deploying a solution

Deploying a solution copies the flow binary into a central location and adds the solution to the Solution Dashboard so you can manage and monitor it.

Only users with site admin or Marketplace Admin permissions can deploy, update, or delete solutions.

Before you begin

The flow you want to deploy must be compiled.

  1. In the Solution Builder Flows tab, on the Compiled output tab for the flow you want to deploy, click Create app.

  2. When the solution finishes deploying, click Open app to view it in the Solution Dashboard.

  1. In Solution Dashboard, click Deploy Solution.

  2. Click Select Flow Binary to Publish, navigate to and select the compiled flow binary (.ibflowbin file), then click Select.

  3. Enter a solution name and version and click Publish Solution.

Running a solution

Running deployed solutions from the Solution Dashboard enables automation metrics for the solution and provides a history of jobs.

Before you begin

The files that you want to process must be uploaded to the Instabase file system.

  1. From the Solution Dashboard, select the solution you want to run, and click Run.

  2. Click Select Input Files for Job, select the folder that contains the files you want to process, and click Select.

    Tip

    Expand Advanced options to specify notification emails, webhook URL, runtime config, and other settings.

  3. Click Run Job.

    The flow runs in the background and displays status in the dashboard. When the flow reaches a checkpoint or completes, you can click the batch ID link to open the flow in Flow Review.

Scheduling a solution

If you want to run a solution on a regular cadence, you can schedule it in Solution Dashboard.

Before you begin

You must have a valid OAuth token, which is used to authorize calls to the Scheduler API.

  1. From the Solution Dashboard, select the solution you want to schedule, and click the Scheduler tab.

  2. Click Schedule a Solution.

  3. Specify details about your scheduled job, then click Schedule Job.

    • Name — Specify a name for the scheduled job.

    • Authentication Token — Enter the authentication token to use for calls to the Scheduler API.

    • Version — Specify a version for the scheduled job.

    • Schedule — Select how often to run the job. Automatic triggers the flow whenever new files are saved to the specified folder. Cron lets you specify any valid cron expression.

    • Files/Dataset — Click Select Folder, select the folder that contains the files you want to process, and click Select.

    Tip

    Click Show Optional Settings to add pipelines, tags, notification email, runtime config, and other parameters to the scheduled job.

Viewing solution metrics

Deployed solutions triggered from the Solution Dashboard or using the Deployed Solutions run endpoint generate metrics to help you better understand automation and human reviewer efficacy.

The Solution Dashboard reports two types of metrics, and various indices for each.

Note

Document-based reviews aren’t included in metrics reported in the Solution Dashboard.

Solution Metrics include validation and correction rates, processing volume, and overall automation value. Use this tab to understand how accurate and efficient your solutions are, and to identify classes or fields that might need further development or refinement.

At the top right of the page, specify the time period for all displayed metrics.

Solution metrics include these visualizations:

  • Automation Value shows the percentage of documents that were successfully processed, where success includes either documents that passed all validations, or documents that had validation errors which were corrected in human review.

  • Automation States by Class shows the state of a given field after human review, plotted across the specified time period so you can see trends. States include valid and unmodified, invalid and modified, valid and modified, and invalid and unmodified. Valid results include those that either aren’t subject to validation or that pass validation rules specified in the flow. Modified results are those that are changed in human review. Use the class and field selectors to drill into a specific field.

  • Automation States by Field shows the state of all fields after human review: valid and unmodified, invalid and modified, valid and modified, and invalid and unmodified. Valid results include those that either aren’t subject to validation or that pass validation rules specified in the flow. Modified results are those that are changed in human review. By default, you see only fields with data. Enable Show all fields to see all fields.

  • Reclassification Rate shows the percentage of documents for which class was corrected in human review.

  • Pages Processed shows the total number of pages processed.

Human Review Metrics include time spent reviewing by reviewer, class, or field. Use this tab to understand how efficient reviewers are across various data points, and to identify areas where more training or support might be needed.

Review time is the cumulative length of time a reviewer spends focused on a document, class, or field. Review time begins when a reviewer opens a document or clicks on a field, and ends when they either mark the document or the batch as reviewed, or deselect the field.