This page contains technical instructions on how to access and construct the relevant URLs required to integrate the power of XpressDox Document Assembly into your own websites or web applications.
- XpressDox Desktop (Version 4 or higher). XpressDox is a Microsoft® Word Add-In Application for authoring templates. This can be downloaded from: http://www.xpressdox.com/download/
- XpressDox Cloud Account – Go to https://server.xpressdox.com and click on the “Register” Tab to register an account. – Your Username and Password will be emailed to you upon registration.
- Your existing website or web application that you plan to integrate with XpressDox.
Display the XpressDox interview in your site or application
Upload your XpressDox template to the cloud
Templates can be uploaded to your cloud account it two ways:
- Using the XpressDox Cloud Manager launched from the XpressDox ribbon in Microsoft® Word.
(a) Login with your Username and Password and then upload your template to your cloud account.
(b) You can simply drag templates from your desktop into the XpressDox Cloud Manager.
- Using the “Upload File” link on the website to upload your templates.
(a) Go to https://server.xpressdox.com to login.
(b) Certain browsers support drag and drop as well. E.g. Chrome and Firefox.
Your template is now in the Cloud and ready to be integrated into your website and business process.
Generate the interview URL
- Using the Cloud Manger select your template and click the “Embed Interview in your Website” button.
- Using the below dialog, generate the interview URL to be used in your site.
- Once the interview is completed you can choose to use the default results page, this will simply list the assembled documents and allow them to be downloaded by the user.
- Alternatively you can specify a custom return URL to a page where you can handle the assembled documents and display to the user as you wish. (See following sections for more information)
(1) This approach is ideal for importing the documents into your business process or into your own document management system.
(2) It is also required if you do not want the user to be able to download the assembled documents.
- Finally, click the “Generate iFrame HTML” button to generate the HTML required to display the interview in your site.
- Copy the html and paste it into the html (code) of your page where you want the interview to appear.
Set the color theme of the interview
You can choose from a number of different color themes in order to best match the interview display to your existing website.
- Login to https://server.xpressdox.com
- Click the “Settings” menu item.
- Then select from the available list of themes.
- Click “Set Theme” to save your settings.
URL structure for developing a custom return page
This is the URL that your user will be redirected to after completing the XpressDox interview if you have specified a custom return page URL.
Structure of the return URL
must be https
The parameters explained:
Return_URL_as_specified_above – The URL identifying the page to which your user will be redirected to on completion of the XpressDox interview. E.g. www.yourdomain.com/documentAssembled.php
UsageIDs – This parameter will contain multiple records in the following format depending on the number of document assembled.
USAGEID – The Unique Usage Code used to identify the assembled document.
DOCUMENT_NAME – The display name of the assembled document.
UsageID and Document_Name are separated by the pipe character ‘|’. In the event that multiple documents are generated, the Usage|DocumentName items will be further separated by the caret character ‘^’.
Please Note: If a document is configured to be assembled in two different formats, e.g. .docx and .pdf, this does not constitute multiple documents being assembled, it is simply the same document in different formats. See below for downloading instructions.
CustomParam=[CUSTOMINFO] – You can choose to add custom parameters to the interview URL (generated using the above dialog). Any custom parameters added, will be returned to your application via the return URL. These parameters can be used to retain context that may be important to your application.
Please Note: Although HTTPS is the recommended protocol, XpressDox cloud can be integration with HTTP or HTTPS.
Structure of the download URL
If you choose to use a custom return page, you will need to handle the downloading of assembled documents. To download assembled documents, use the following URL structure.
The parameters explained:
UsageID – The Unique Usage Code identifying an assembled document as returned in the return URL discussed above.
FileType – The type of file format you want to download for the identified assembly. Each assembly can generate 3 possible files:
Microsoft Word Document (docx format) (Set FileType to ‘doc’)
PDF Document (Set FileType to ‘pdf’)
XML Data File (Set FileType to ‘xml’)
Please Note: Not all file types are automatically assembled for each template, these file types need to be configured.
Send initial data to the XpressDox interview
Data can be sent to the XpressDox interview in two ways. Either way, the data must be in XML format and be base64 encoded for it to be sent and used successfully.
As part of the interview URL
- Add an “initialData” parameter to the interview URL and set the value to the base64 encoded XML data.
- Only use this method for sending a small amount of data.
- Example below:
Please Note: If you choose to use this method the parameter must also be URL Encoded before it is sent.
Post the data as part of a HTML form to the interview URL
- Create an HTML form containing an “initialData” parameter.
- Example below:
<form action="XpressDox Interview URL " method="post">
<input name="initialData" type="hidden" value="PD94bWwgdmVyc2lvbj0iMS4wIj8%2BCjxSb290RWxlbWVudD48QmFyX051bWJlcl9fYz4xMjM0PC9CYXJfTnVtYmVyX19j" >