To use the Correspondence functionality, you require the predefined
CORRESPONDENCE.xsd provided by Stardust. You can
download it from here:
CORRESPONDENCE.xsd.
This data type will be used in a UI Mashup for creating correspondence. Add this XSD file to the classpath of your Web project.
To use the provided CORRESPONDENCE xsd file, import it as a structured data type:



To create a correspondence data that can be used in the Correspondence UI Mashup, create a structured data of the imported correspondence data type.
The Correspondence data type has the following structure:
| Name | Type | Cardinality |
|---|---|---|
| Recipients | CORRESPONDENCE_RECIPIENT | Zero or More |
| Subject | Text | Exactly One |
| MessageBody | Text | Exactly One |
| MessageBodyFormat | Text | Exactly One |
| Documents | CORRESPONDENCE_ITEM | Zero or More |
| Field Meta Data | CORRESPONDENCE_FIELD_METADATA | Zero or More |

Figure: CORRESPONDENCE Data structured type
The Recipients data entry contains the following attributes:
| Name | Type | Cardinality |
|---|---|---|
| Address | Text | Exactly One |
| DataPath | Text | Exactly One |
| Channel | CORRESPONDENCE_CHANNEL
|
Exactly One |

Figure: Recipients
The Documents data entry contains the following attributes:
| Name | Type | Cardinality | Description |
|---|---|---|---|
| Name | Text | Exactly One | The correspondence name |
| TemplateID | Text | Exactly One | Document ID for outgoing template. Templating should be run if TemplateID is not null and OutgoingDocumentID is null. |
| OutgoingDocumentID | Text | Exactly One | Document ID for outgoing document i.e. contains results after Templating |
| IncomingDocumentID | Text | Exactly One | Used only by Document Triage UI |
| ConvertToPDF | Boolean | Exactly One | If true convert the attachment to PDF before sending it (after processing it as template if applicable). |
| IsAttachment | Boolean | Exactly One | Determines whether the document should be attached to the email or not |
| Required | Boolean | Exactly One | Determines whether the document is required or not |
| Accepted | Boolean | Exactly One | Determines whether the document is accepted or not |
| Comment | Text | Exactly One | A comment about the document (i.e: "Please provide new driver license. The one you provided is expired") |
| ACL | Text | Exactly One | List or roles with read/modify/delete rights |
| RequestedDate | Date | Exactly One | Document requested date |
| ReceivedDate | Date | Exactly One | Document received date |
| DocumentTypeID | Text | Exactly One | DocumentType to be used for incoming document (used by Document Triage UI) |
| DocumentDataPathID | Text | Exactly One | Document "slot" to be used for incoming document e.g. PROCESS_ATTACHMENTS (used by Document Triage UI) |

Figure: Documents
The Documents data entry contains the following attributes:
| Name | Type | Cardinality |
|---|---|---|
| Type | CORRESPONDENCE_FIELD_METADATA_TYPE
|
Exactly One |
| Name | Text | Exactly One |
| Location | Text | Exactly One |
| UseImageSize | Boolean | Exactly One |

Figure: Field Meta Data