Creating an EngageOne™ Vault Journal File

EngageOne™ Enrichment can create an EngageOne™ Vault journal file for the print streams it processes, allowing you to archive EngageOne™ Enrichment output in EngageOne™Vault.

To create an EngageOne™ Vault journal file:

1. In your EngageOne™ Enrichment control file, add the following code. This code creates <XMLELEMENT> tag groups to map the XML elements to user defined variables. The variables are populated by rule file processing, which will be added in a later step.

   <xmlelement>
     <xmlname> endeGAD
     <content>
       </eGAD>
     </content>
   </xmlelement>
   
   <xmlelement>
     <xmlname> jobdata
     <content>
       <?xml version="1.0" encoding="UTF-8" standalone="no"?>
       <!DOCTYPE eGAD SYSTEM "eGAD.Dtd">
       <eGAD pakUID="%%DTD_pakUID" >
       <jobdata>
         <datetime>%%DTD_datetime</datetime>
         <platform>%%DTD_platform</platform>
         <Version major="%%DTD_Version_major"
           minor="%%DTD_Version_minor" >
           %%DTD_Version</Version>
         <JobGUID>%%JOBGUID</JobGUID>
         <JobName>%%DTD_JobName</JobName>
         <JobShortName>%%DTD_JobShortName</JobShortName>
         <NativeFormat value="%%DTD_NativeFormat_value" />
         <!--repeatable-->
         <ResourceGUID value="%%DTD_ResourceGUID_value"
            p="%%DTD_ResourceGUID_p" />
         <!--/repeatable-->
       </jobdata>
     </content>
   </xmlelement>
   
   <xmlelement>
     <xmlname> document
     <content>
       <document docID="%%DTD_docID" 
         docMasterID="%%DTD_docMasterID"
         docInstanceID="%%DOCGUID" >
         <VendorId>%%DTD_VendorId</VendorId>
         <DocTypeId>%%DTD_DocTypeId</DocTypeId>
         <AccNo>%%DTD_AccNo</AccNo>
         <StmtDate>%%DTD_StmtDate</StmtDate>
         <PayDetails>
           <DueDate>%%DTD_PayDetails_DueDate</DueDate>
           <!--repeatable-->
           <Amt type="%%DTD_PayDetails_Amt_type"
             curr="%%DTD_PayDetails_Amt_curr" >
             <Due>%%DTD_PayDetails_Amt_Due</Due>
             <MinDue>%%DTD_PayDetails_Amt_MinDue</MinDue>
           </Amt>
           <!--/repeatable-->
         </PayDetails>
         <!--repeatable-->
         <DDSDocValue name="%%DTD_DDSDocValue_name"
           type="%%DTD_DDSDocValue_type"
           len="%%DTD_DDSDocValue_len"
           UsedBy="%%DTD_DDSDocValue_UsedBy" >
         %%DTD_DDSDocValue</DDSDocValue>
       <!--/repeatable-->
       <CustData>
         <Name>%%DTD_CustData_Name</Name>
         <!--repeatable-->
         <Addr line="%%DTD_CustData_Addr_line" >
           %%DTD_CustData_Addr</Addr>
         <!--/repeatable-->
         <City>%%DTD_CustData_City</City>
         <Region>%%DTD_CustData_Region</Region>
         <PostalCode>%%DTD_CustData_PostalCode
           </PostalCode>
         <Country>%%DTD_CustData_Country</Country>
         <Phone>%%DTD_CustData_Phone</Phone>
       </CustData>
       <NumberOfPages value="%%DTD_NumberOfPages_value" />
       <Skipped>
         <!--repeatable-->
         <SPages>%%DTD_Skipped_SPages</SPages>
         <!--/repeatable-->
       </Skipped>
       <ToC>
         <!--repeatable-->
         <BMark level="%%DTD_ToC_BMark_level"
           name="%%DTD_ToC_BMark_name"
           pageID="%%DTD_ToC_BMark_pageID"
           lref="%%DTD_ToC_BMark_lref" >
         </BMark>
         <!--/repeatable-->
       </ToC>
     </document>
     </content>
   </xmlelement>

2. Create an <OUTPUT> tag group. In the <OUTPUT> tag group:
   • Create an <XMLFILE> tag and specify a file name for the journal file.
   • Specify one or more <XMLPART> tags. The <XMLPART> tag indicates which XML elements to include in the journal file. (For more information, see the EngageOne™ Enrichment Language Reference Guide.) The name you use in the <XMLPART> tag corresponds to the names you assigned to the XML elements with the <XMLNAME> tag.
   For example, the completed <OUTPUT> tag group may look similar to this:

   <output>
     <name> Output1
     <file> c:\myfiles\statements.afp
     <xmlfile> c:\myfiles\journalfile.txt
     <xmlPart> jobdata H
     <xmlPart> document D
     <xmlPart> endeGAD T
   </output>

3. In the rule file, assign values the variables defined in the <XMLELEMENT> tag groups. This will determine the values placed in the journal file’s fields. For example:

   <rule>
     <content>
       DOCUMENT:
       %%DTD_CustData_Addr[0] = %%Name
       %%DTD_CustData_Addr[1] = %%AddressLine1
       %%DTD_CustData_Addr[2] = %%AddressLine2
       %%DTD_CustData_Addr[3] = %%AddressLine3
     </content>
   </rule>

   Note: If a variable is defined in the <XMLELEMENT> tag group but not assigned a value in the rule file, the variable name is used as the value. For example, the variable %%DTD_datetime contains the value for the journal file tag <datetime> as specified in the <XMLELEMENT> tag group. If the variable %%DTD_datetime is not assigned a value in the rule file, then the variable name will be used as the field value in the journal file: <datetime>%%DTD_datetime</datetime>