Form MultiDoc engine

From All n One's bxp software Wixi

Jump to: navigation, search

1 Overview

When using bxp forms it may be necessary to mail a series of documents to a client.


bxp through its outcomes has the ability to facilitate multi-document creation. Then with the documents created include them as links in the body of an email and have the email sent out to a recipient.


This process also facilitates the in browser signature capture engine available for document creation In_Browser_Signature_Capture


What follows is how to set up and use this feature.


2 Setup

2.1 Initial steps

We need a form and some templates to play with to demonstrate the engine.



2.1.1 Form build

  • Type : Blended
  • ID: 9
  • Advanced Settings > External > Allow External CCL file download > True
  • Basic - Text Box : Customer First Name (strCDA_9_field_0_1)
  • Basic - Text Box : Customer Surname (strCDA_9_field_0_2)
  • Basic - Email Box : Customer Email (strCDA_9_field_0_3)
  • Tidy up the field mapping, as per the question titles

The form should look like multidoc engine 001.png

2.1.2 HTMLTemplate1

  • Template Name : HTMLTemplate1
  • Publicly available : True
  • Enable Signature Capture: False


<font face="Arial" size="3">
Dear --strCDA_9_field_0_1--,<br /><br />
This is a <em>HTML</em> template email.<br /><br />
Kind regards,<br />
--strAgent_FirstName--
</font>


2.1.3 HTMLTemplate2

  • Template Name : HTMLTemplate2
  • Publicly available : True
  • Enable Signature Capture: False


<font face="Arial" size="3">
Dear --strCDA_9_field_0_1--,<br /><br />
This is a <em>HTML</em> template email.<br /><br />
Now the signatures<br /><br />
--bxp_Signature_Capture-- = This will be replaced with the first signature captured<br /><br />
--bxp_Signature_Capture_DateTime-- = This will be replaced with the date and time that the first signature was captured<br /><br />
<br /><br />
--bxp_Signature_Capture_Add1-- = This will be replaced with the second signature captured<br /><br />
--bxp_Signature_Capture_DateTime_Add1-- = This will be replaced with the date and time that the second signature was captured <br /><br />
<br /><br />
Kind regards,<br />
--strAgent_Firstname--
</font>


2.1.4 RTFTemplate1

  • Filename : RTFTemplate1.rtf


{\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang6153{\fonttbl{\f0\fnil\fcharset0 Calibri;}}
\viewkind4\uc1 
\pard\sa200\sl276\slmult1\f0\fs22\lang9 Dear --strCDA_9_field_0_1--\par
This is an \b RTF \b0 Template\par
Kind regards,\par
--strAgent_FirstName--\par
\par
}


2.2 Turn on the MultiDoc engine

The MultiDoc engine is activated by an outcome. Outcome edit the MultiDoc outcome.


  • Use MultiDoc engine : True
  • Notes : Please ensure that you create and select HTMLTemplate1, HTMLTemplate2 and RTFTemplate1 before proceeding.
  • HTML Templates Allowed : HTMLTemplate1 and HTMLTemplate2
  • RTF Templates Allowed : RTFTemplate1.rtf


multidoc engine 002.png


2.3 Set the External Communications email

When we do finally send the email to the end customer we need to have our comms engine working


  • External From Address: multidocDemo@gmail.com
  • External To Field: strCDA_9_field_0_3 - Customer Email
  • External BCC Email address : your own personal address
  • External Subject : Whatever you like, can be useful to put a ref in there e.g. MultiDoc Demo - Wixi example Ref : [ [ --intCDA_9_Id-- ] ]
  • External Body :
Dear --strCDA_9_field_0_1--,<br />
This is the body of the HTML email in the outcome external communications.<br /><br />
--MultiDoc_Docs--
<br /><br /><br />
Kind regards,<br />
--strAgent_FirstName--<br />


multidoc engine 003.png


3 Operation

3.1 Use and log a record

So now we're ready to using the engine. Job number one here is to log a record and choose the MultiDoc as our outcome.


multidoc engine 004.png


You will then be transferred to the MultiDoc engine screen


multidoc engine 006.png

3.2 Using the engine

From here you can use the options to generate attached documents which will link to the record.


From the drop down lists you can choose the template you want to create a document from. Then press the buttons to the right hand side to create those documents.


The first drop down list are all the HTML templates from the Communications Centre module that have been permitted on the outcome. Only HTML templates currently allow signatures to be logged. If In Browser signatures are not required then the templates will just create the PDF.


The second drop down list are all the RTF template documents in the Communications Centre module that have been permitted on the outcome.


Each of the documents will then list below to allow them to be included in the email sent out.


Finally with the documents you want to include ticket, press the blue button and the settings from the Outcomes external email options will be used. The system when the send is complete will return you to the original record you were working on.