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.

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.