Customer Engagement EngageOne® Compose ® EngageOne Server Programmer's Reference Guide Version 4.4 Service Pack 9 Table of Contents Feature support for System Data Integration 69 Integration option 1 – XML data source 71 1 - Overview Integration option 2 – callback interface 75 Overview 5 Template designer 5 5 - Additional features in SOAP EngageOne Server components 10 EngageOne administration 13 Trusted Connection 87 EngageOne Interactive 14 Template search 87 Interactive document process flow 14 Write delivery information 96 Managing the work queue 99 Updating work items 102 2 - Integrating with EngageOne Reassigning a work item 106 SOAP Deleting a work item 108 OnDemand 18 6 - EngageOne notifications Interactive 18 Data push processing in EngageOne Overview 110 Interactive 18 Notification components diagram 111 Interactive Document Delivery 32 Topics and queues 113 Sample application 33 Configuration settings 114 OnDemand Document Delivery 36 Messages 118 Communication messages 119 3 - XForms Batch messages 121 Workflow messages 122 Consuming notification messages 123 About XForms 39 Using other JMS implementations 126 XForms processors 41 Sample message consumers 128 XForm/SDI Flow 42 XForms standard files 43 Data definition type and attributes 62 7 - The comparison adapter plug-in 4 - System Data Integration The custom plug-in implementation 130 SDI General Configuration 66 Example implementations 131 Using an XML file as a data source 67 Plug-in Installation and configuration 135 Using the Java callback interface 68 8 - Appendix A - Editor methods LoadContents 137 SaveContents 137 SpellCheck 138 IsComplete 138 IsModified 139 GetVersion 139 9 - Appendix B - SOAP API Identifiers 141 Search filter 142 Promotion service 143 Folder service 164 Data push service 168 Delivery management service 170 Dictionary service 178 Domain service 180 Editor service 182 Keymap service 185 Metadata service 193 Request status update service 196 Security service 198 Template service 204 Workitem service 227 Attachment service 256 Workflow service 268 Delivery service 280 10 - Upgrading 3.X to 4.X SOAP services Licensing changes 301 Security changes 302 WorkItem approval process not supported 304 DataPushService.mapData not supported 304 EngageOne® Compose EngageOne® Server Programmer's Reference Guide 3 1 - Overview EngageOne is an interactive document production system, enabling the creation and delivery of high volume, on demand and interactive customer correspondence. In this section Overview 5 Template designer 5 EngageOne Server components 10 EngageOne administration 13 EngageOne Interactive 14 Interactive document process flow 14 Overview Overview Document templates and optional content objects are defined by the template designer in a core application called Designer, and managed in the content repository. These programs are made available to front-office users through a Web-based interface. This interface allows users to create and modify a document in a controlled manner, and distribute documents through various delivery channels as required. The EngageOne Interactive Web application uses the services provided by the EngageOne Web services interface to access the server functions of EngageOne. Template designer Document templates are created by a template designer, a user who defines the document and its interactions in Designer. A template consists of a traditional publication design, along with interactive data definitions which describe the front office user interactions required to complete a document from that template. This involves designing the overall template and defining: • The data prompts included in the document using the Interactive Editor • Paragraph and content selection, using optional content selections (Active Content) • Free-form text to override content protection using editable paragraphs For more information about these functions, see the Designer User’s Guide. The template designer allows the user to edit or enter free text as required in an EngageOne document design, by selecting a section of text in a paragraph object and defining the text as editable. Any text marked as editable can be changed by the user. Text that is not marked as editable will be protected. In addition to the basic template, the template designer can create optional content. Property values are defined, enabling them to be conditionally placed in an Active Content Group. When Active Content is marked as interactive, the user is dynamically presented with content choices to help them complete their document. Once the EngageOne template has been designed and data fields defined, the template is named and published for EngageOne. The XForm files that define the document's data model are included in the template’s Zip file. The process of importing these files into the EngageOne content repository using the EngageOne Administration client, is called Template deployment. EngageOne® Compose EngageOne® Server Programmer's Reference Guide 5 Overview The interactive data model is defined and exposed using the W3C XForm standard. The XForm can be used by the system integrator to push system data into the interactive document. Content repository The content repository provides file storage and version control for EngageOne. It houses the templates used to create documents, supporting files needed for document composition, and the document instances waiting for delivery. EngageOne® Compose EngageOne® Server Programmer's Reference Guide 6 Overview About the template The template manifest (template_master.xml) describes template attributes and contents. The template manifest is made up of the following: Subfiles The Subfiles section contains a list of files in the template Zip file, and specifies each file type: Template composition HIP HIP files contain design, layout, logic and other resources required for generating publications. These files are used by Generate. There are two types of HIP file: publications, and independently publishable active content. PUB Publication files contain design, layout and logic. These files are used by the Interactive Editor. There are two types of PUB file: template publications, and independently publishable active content. XFRM XForms define electronic forms for collecting general purpose information. INST Instance data file. Initially this file contains default field values. All values entered by the user will be saved in this file. Free form text is stored in the HIP and PUB files, not the instance file. SCHEMA The instance file schema contains standard schema nodes and attributes. The schema ensures data returned in the instance file is well-formed, the right type, and meets defined field criteria. IMG Image file required by the editor for display in the template. DATAMODEL XML representation of the Designer Publication “Sample Data”, whether the original data is keyed data (for example, single value decomposition), delimited (for example, comma separated values), or on-demand XML. The DATAMODEL file type appears only for non-interactive templates. EngageOne® Compose EngageOne® Server Programmer's Reference Guide 7 Overview Template composition PREVIEW PDF file appears for both interactive and non-interactive templates, where Designer Publish for EngageOne has successfully generated a PDF “preview” example of the Designer Publication. The PREVIEW file is generated using “emergency replacement” data, where the Designer Publication data is incomplete, and may not reflect the completed document. PREVIEW file is available for the Interactive user to view a “Preview” of the Template Document at the start of the “Edit Communication” process. PROMPTLOGIC Files containing information used to prompt for, and validate, interactive template data when the ActiveX editor is not used. THUMBNAIL "Scaled" image representation of the first document. Intended as a rough guide to the layout and content of the first document. EngageOne® Compose EngageOne® Server Programmer's Reference Guide 8 Overview Resources The Resources section lists the dependencies of the template. These can be of the following types: ACTCONT Active content IMAGE Image used in the template FONT Font used in the template The following fragment demonstrates the structure of the template manifest: <?xml version="1.0" encoding="utf-8"?> <!--XML meta file for EngageOne Template--> <document ocmmetafile-vers="ocm-metafile1.0" ocm-vers="OCM Template V1.0"> <OcmMetadata> <documentClass> <metadata-field fieldName="Publish Date" fieldValue="05-May-2009" defaultValue="" fieldType="text" /> <metadata-field fieldName="Published By" fieldValue="Administrator" defaultValue="" fieldType="text" /> <metadata-field fieldName="Design Publication Name" fieldValue="Basic" defaultValue="" fieldType="text" /> </documentClass> <Subfiles> <File type="HIP">template.hip</File> <File type="PUB">template.pubx</File> <File type="XFRM">d79f96b60b2a48ee9f59c8bed5655f86.xform</File> <File type="INST">d79f96b60b2a48ee9f59c8bed5655f86.xml</File> <File type="SCHEMA">d79f96b60b2a48ee9f59c8bed5655f86.xsd</File> <File type="IMG">c52767b2d1824366b522589d550cb297.png</File> </Subfiles> <Resources> <Res type="ACTCONT" name="Basic" guid="e06d8fc2009642ddb2740495af6bf785" /> <Res type="FONT" name="Arial 11pt" guid="24e474cc2baa434cb7239457b6b90443" /> <Res type="IMAGE" name="logo.bmp" guid="c52767b2d1824366b522589d550cb297" /> </Resources> <Inputs> <HIP path="" /> <ActiveContent path="" /> </Inputs> </OcmMetadata> </document> EngageOne® Compose EngageOne® Server Programmer's Reference Guide