Cloud Fax and Notifications API 2.5 Documentation
JobSubmit
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  JobSubmit  
These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.
 

31.2.10 DynamicContent

Zero or more DynamicContent elements may appear inside JobSubmitRequest/Message/Contents. See below for a discussion of the Dynamic Content feature.


Tag Name
& type
#Description
DynamicContent   This element can contain one or more document fragments to be used for a given section name for this job. If there are multiple fragments for the same section name, they should each have a distinct DocType or DeliveryFormat.
When a content keyword is found in a message document, the section names associated with it are looked for in the destination list. Then the document fragments associated with those section names are searched for in the job information, and the one with an appropriate format is inserted in the message document.
   SectionName
EncodableStringType
1This is the section name for the document fragment(s).
   SectionDocument1-Each document fragment requires a SectionDocument. The Document (or the one referred to by DocRef) must have a DocType of "text", "HTML" or "HTMLLITE".
   DeliveryFormat
xs:string
0-1This is the delivery format for which this particular document fragment. If this value is not provided, the format will be determined by the DocType of the Document.
If it is provided, then the value must have the form:
   format:charset
Where format may be "email", "html-0" or "html-4", and charset is an ISO character set name.
   DocRef1This indicates the use of a Document specified in the DocumentSet section of the JobSubmitRequest. The value of this element must match the Ref element of one such Document.
Document
DocumentType
1This puts the document right in the Contents section. See DocumentType.

Dynamic Content is a feature that is available for EnhancedEmail jobs that allows messages to be customized using preferences associated with each recipient and a selection of message components. This differs from the more common "insert" method in that the information that is added to the message for each recipient is not directly present in the destination list - instead, each destination includes a set of list of section names associated with each content keyword. The job information connects these section names with a document fragment. This can allow the destination list to be used without change for multiple jobs with different insert material for each job.

Because of the indirection involved in Dynamic Content, care must be taken to properly prepare the message documents, the destination lists, and the job submit request.

A set of "content keywords" must be defined. These keywords may appear in the message documents (in Part elements), enclosed in double square brackets, for instance:

     Get the latest information about [[FOOTBALL_TEAMS]] by visiting our website.

To work properly, content keywords must be relatively short labels and contain no whitespace or punctuation other than underscore. To avoid issues that may arise for documents in various character sets, content keywords should be restricted to ASCII characters.

Next, the destination list must be prepared so that the content keywords are associated with "section names". The content keywords must appear as property names within a segment named "DCONTENT". The value of these properties is a semicolon-separated list of section names. For the Cloud Fax and Notifications API, destinations are usually represented in one of two ways - as an XML structure or as a row in a CSV file. Here is an example in the XML format:

   <Internet ref="ref001">
    <Extension>
     <Segment name="DCONTENT">
      <Property name="FOOTBALL_TEAMS">New York Jets;New York Giants</Property>
      <Property name="BASKETBALL_TEAMS">New York Knicks;Los Angeles Lakers</Property>
     </Segment>
    </Extension>
    <Email>abc@def.com</Email>
   </Internet>

And here is an example in the CSV (Table) format:
   ADDR,TYPE,REF,DCONTENT:FOOTBALL_TEAMS,DCONTENT:BASKETBALL_TEAMS
   abc@def.com,internet,ref001,"New York Jets;New York Giants","New York Knicks;Los Angeles Lakers"

Section names must be less than 512 characters long, and may not include semicolons. Only Unicode values should be used. Leading and trailing whitespace is ignored.

Finally, for a particular JobSubmit request, document fragments must be provided for each section name. Additionally, alternate versions of each fragment can be provided for use with various delivery formats. These document fragments are provided in the DynamicContent element. At least one DynamicContent element must be provided for each section name that will be encountered in processing the job. It is recommended that all the document fragments (each of which are provided in a SectionDocument element) for a given SectionName be included in a single DynamicContent element.

 
    prev  next        Table of Contents  JobSubmit  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified OOctober 06, 2020