Writing custom job items

Write custom job items in C# as follows:

  1. Install the custom job item template.
    • Start workflow XML Designer, and select Option > Custom Job Items... > Install Custom Job Project templates for Visual Studio, or
    • Install the CustomOmniPageJobItem.vsix file in the CSDK bin library by clicking on it.
  2. Open Visual Studio with admin rights.
  3. Create a new project using the Visual C#/Kofax/Workflow XML Designer Custom Job Item Library template.

    This template is in the Installed templates.

  4. Delete the unnecessary code details.
    The created project and code can be built and run by itself. The code contains the following classes:
    • The worker job item, that originates from a job item within the Kofax.OmniPageCSDK.IproPlus namespace.

    • The design job item, that originates from a job item within the Kofax.OmniPageCSDK.IproPlus.JobDesign namespace.

    • The class providing the minimal UI for the design job item it the Workflow XML Designer. It is included in a .xaml file.

  5. If you create custom job item for the first time, test the process flow.
    1. Build the project. Make sure to use the proper version of CSDK (32-bit or 64-bit) and to select the proper platform.
    2. Start workflow XML Designer, and select Option > Custom Job Items....
    3. Browse to the assembly built in 5.a.
      The line is filled with the name and path of the assembly, and the name of the design JobItem class.
    4. Click Ok.
    5. Create a new job.
    6. Find the new job item in the upper right window, and drop it to the job.
    7. Select Output XML File in the lower right window, and enter the SampleParameter.
    8. Select Job > Run.
    In the lower right window, the Content of Output XML File field changes from (none) to (XML Content). It can be viewed by clicking the ... button.