› Intelligent Workflow Runner › Overview › Workflow XML Designer API

Workflow XML Designer API

You can write your IWR application with Workflow XML Designer API too. It is not the same as the API used to create custom job items, but the API used by the Workflow XML Designer. The use of this API is demonstrated in the Using WorkflowXMLDesigner API solution, which is available in the MySamples folder. On the Start menu, click the shortcut according to your CSDK edition to open the folder:

  • 32-bit edition: Start > OmniPage Capture SDK 22 x86 > Open MySamples Folder x86

  • 64-bit edition: Start > OmniPage Capture SDK 22 x64 > Open MySamples Folder x64

Connection of API and IproPlus

The API refers to the Kofax.OmniPageCSDK.IproPlus assembly, and uses it as source. The Kofax.OmniPageCSDK.IproPlus assembly is a procedural API, and cannot be used in Worklfow XML Designer on its own.

During the first run, the API generates two assemblies in the local %localappdata%\Kofax_Inc\ WorkflowXMLDesigner.exe_StrongName_wov0dprpycqdxfxsefh53gp3zarchcxd folder: the CSDKConverters.dll-t and the CSDKWorkflow.dll. The Workflow XML Designer uses these assemblies. The API generates these files again if a parameter in the Options > Settings is updated.

If the CSDKConverters.dll and the CSDKWorkflow.dll files are moved to the exe folder, the API never connects the IproPlus again. Thus, programs created with this API does not need an installed CSDK, if the end user selects processing by OmniPage Server, when prompted. If processing through OCRService is selected, an installed CSDK is necessary.

Users can get the CSDKConverters.dll-t and the CSDKWorkflow.dll files the following ways:

  • Copy from the local appdata folder.

  • In command prompt, call Workflow XML Designer with /D option. You can use /A option to export all IproPlus converters.

  • On the UI, select File > Export dynamic class libraries.

The central element of the API is the Kofax.OmniPageCSDK.IproPlus.JobDesign.BuiltIn assembly. It contains the classes of all design job item within the Workflow XML Designer. The API can handle .ocrjob, .xml, and .xwf files. Existing jobs can be loaded and updated, and new jobs can be created through the JobExecutionUnit class. The interface of this class is easy-to use.

The exact use is described in the Using WorkflowXMLDesigner API solution, located in the MySamples folder.