Skip to content

Ephesoft-Labs/Transact.Integration.Workato

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Transact.Integration.Workato

A repository to integrate Ephesoft Transact to workato. This repository can be used with the Ephesoft Workato connector.

Architecture

This solution uses the Workato custom connector to get information into Ephesoft Transact from Workato. To get information back into Workato from Transact, webhooks are used to trigger Workato recipes. To trigger the Workato webhooks the Ephesoft Export Script plugin is used to push data to workato via a webhook. The Webhook is used Only to move Transact extraction metadata to Workato. If a project needs the exported images from Transact to Workato it is recommended to use an online file repository such as Box.com or Amazon S3.

Workato Recipe Library

Ephesoft has published a few starter recipes to help show how the data that Ephesoft classifies and extracts can flow into downstream systems and processes. Below are links to the recipes in Workato. You can find recipes like these by searching the keyword "Ephesoft" in the Workato community recipe library. You can read more about what these recipes do in the recipe description.

Prerequisites

  • Ephesoft Transact with an Ephesoft Webservice License (web service is needed to work with the workato custom connector)
  • Batch Class Management access and the ability to deploy Transact workflow scripts

Artifacts:

Workato Recipe Configuration

  1. Log into Workato and navigate to the example recipe Ephesoft Transact - Export Batch Processing Example
  2. Click the Use This Recipe button to add a copy of the recipe to your account
  3. Edit the recipe and copy the webhook address webhook edit Image
  4. Fix any Recipe connection errors or empty fields and start the recipe

Note: If the recipe is not running the Ephesoft batch instance will go into error status, and you will need to start the recipe and restart the batch at Export.

Configuration in ExportScript.java

  1. Edit the Ephesoft export script file [ExportScript.java](Script Source/ScriptExport.java). In the script replace the WEBHOOK_MAPPING_BATCH_URL variable to be the value of the webhook address copied from the recipe.

         public static String WEBHOOK_MAPPING_BATCH_URL = "https://www.workato.com/webhooks/rest/xxxxxxx-xxxxx-xxxx-xxxxxx/ephesoftbatchexport";
    
  2. Move the ScriptExport.java to the scripts' folder for your chosen batch class, at [Ephesoft_Directory]\Shared-Folders<your batch class>\Scripts. or use the Ephesoft File Management Screen to upload the Export Script to your batch class

  3. Add the following plugin to the batch classes export module EXPORT_SCRIPTING_PLUGIN

  4. Optional Step: If Ephesoft output images are needed for your project, an export location for the image will be needed. The Ephesoft Amazon S3 export plugin is used as an example but other supported file content repertoires can be used as well.

Note: the order of the plugins are important. The EXPORT_SCRIPTING_PLUGIN needs execute after the S3_EXPORT_PLUGIN. This will ensure that the images are exported prior to having the recipe to download them.

Known Unsupported Data

  • Currently, this export script does not support Ephesoft table extracted data.

License

Ephesoft Labs is licensed under the Ephesoft Source Code License.

About

This repository holds instructions on how to integrate Ephesoft Transact with Workato

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages