Preparing the Workflow for Correspondence

To prepare our workflow for correspondence, we have to import the predefined correspondence structured data type and create a UI Mashup application for Correspondence. The UI Mashup application is created in the same way for both example models.

Required Jar Files

Note that you require additional jar files to use the templating feature with substitution functionality in a Correspondence. Please refer to section Configuration of chapter Using Correspondence Templates for details.

Creating the Correspondence Data

The predefined CORRESPONDENCE.xsd file defines document request data required for correspondence. You find it in the correspondence/dat folder of the all-tutorials.zip file.

This data type will be used in a UI Mashup for creating correspondence. Add this XSD file to the classpath of your Web project, e.g. to the ipp-resources folder in a RAD environment.

Importing the XSD Type

In our example model, we create a structured data type CORRESPONDENCE:

  1. In the example model, right-click Structured Types and select Import Type Declarations.

    Import Type Declarations

  2. In the XSD Data Structure Import dialog, enter CORRESPONDENCE.xsd in the URL field and click Load.

    Enter URL

  3. The type declarations from the imported CORRESPONDENCE schema are displayed. Select the Select/Deselect All checkbox and click Import.

    Import XSD

Now you can see the imported structured type in the model tree.

CORRESPONDENCE SDT Type
Figure: CORRESPONDENCE SDT Type

Creating the Structured Data

Now create a structure data CORRESPONDENCE of type CORRESPONDENCE.

Structured Data
Figure: Structured Data to be used as in- out-data for UI Mashup

Creating the Correspondence UI Mashup

To prepare a process to create correspondence, we need to set up a UI Mashup application. This UI Mashup application will be complimented with correspondence request data.

In the UI Mashup application, create a parameter with name CORRESPONDENCE with in and out direction and of structured data type CORRESPONDENCE. Note that it is important to name the parameter CORRESPONDENCE!

UI Mashup Parameter
Figure: Correspondence UI Mashup Parameter

In the Configuration tab select Via URI and enter the following URL:

http://<hostname>:<portnumber>/<context-root>/plugins/html5-views-common/views/correspondenceContainer.html

For example:

http://localhost:8080/tut-proj/plugins/html5-views-common/views/correspondenceContainer.html

UI Mashup configuration URL
Figure: Example UI Mashup configuration URL

Add structured data CORRESPONDENCE as in- and out-data for the UI Mashup parameter.