Workflow XML Designer API
You can write your IWR application with Workflow XML Designer API too.
For more information on the use of Workflow XML Designer API, see Using WorkflowXMLDesigner API available in the MySamples folder via the following paths:
-
32-bit edition:
-
64-bit edition:
Workflow XML Designer API is different from the API used to create custom job items.
Connection of Workflow XML Designer API and IproPlus
Workflow XML Designer API refers to the OmniPageCSDK.IproPlus assembly and uses it as a source. The OmniPageCSDK.IproPlus assembly is a procedural API and cannot be used in Workflow XML Designer on its own.
During the first run, Workflow XML Designer API generates the CSDKConverters.dll and the CSDKWorkflow.dll assemblies in the following local folder:
%localappdata%\Tungsten\ WorkflowXMLDesigner.exe_StrongName_wov0dprpycqdxfxsefh53gp3zarchcxd
The assemblies are used by Workflow XML Designer. Workflow XML Designer API generates these files again if a parameter in the
is updated.If the CSDKConverters.dll and the CSDKWorkflow.dll files are moved to the exe folder, Workflow XML Designer API never connects to the IproPlus again. This way programs created with Workflow XML Designer API do not need an installed CSDK if the end user selects processing by OmniPage Server. If processing through OCRService is selected, an installed CSDK is necessary.
You can get the CSDKConverters.dll and the CSDKWorkflow.dll files in the following way:
-
Copy the CSDKConverters.dll and the CSDKWorkflow.dll files 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.
-
In Workflow XML Designer select
.
The central element of Workflow XML Designer API is the OmniPageCSDK.IproPlus.JobDesign.BuiltIn assembly. It contains the classes of all design job items within Workflow XML Designer.
Workflow XML Designer 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.
For more information, see Using WorkflowXMLDesigner API available in the MySamples folder.
The .ocrjob type is version dependent while the .xml job type is version independent. To upgrade the .ocrjob type proceed as follows:
-
Export an .xml file from Workflow XML Designer of the same version as the one with which the .ocrjob has been created.
-
Import the .xml file to a newer version of Workflow XML Designer.
-
Export the job as an .ocrjob file.