Set out below are some steps you can take to troubleshoot common issues that arise when using AutoDocs.
1. No document is being generated by AutoDocs
2. The wrong variables are appearing
3. The documents do not look the same as the original template
4. My internal client received an email saying that their document could not be generated
5. I received an email saying my internal client's document could not be generated
6. How do I know which variable is which in the AutoDocs Editor?
7. Why don't you display the name I gave to a custom field in the AutoDocs Editor?
1. No document is being generated by AutoDocs
In order for AutoDocs to generate documents:
- the relevant legal request must be active and available in the Internal Client Portal
- a template must have been uploaded into the AutoDocs tab of the relevant legal request
- the template must be in .docx format
- the template must have been published in the AutoDocs Editor
- the template must be set to 'live' in the Settings action
2. The wrong variables are appearing
It is likely that either the wrong variables have been placed in the template, or they have been placed in the wrong places. Reopen the AutoDocs editor and completely replace the variable code in the document, then insert the correct variable.
3. The documents do not look the same as the original template
Xakia selected the AutoDocs Editor due to its ability to very closely replicate the formatting of original .docx formatted documents. However in some cases, the AutoDocs Editor may not be able to exactly reproduce unique fonts or complex document formatting. We recommend using standard fonts and simplifying formatting where possible.
If you are having trouble with information in headers and footers, consider inserting that information as an image rather than as text, which will prevent that information from being reformatted.
4. My internal client received an email saying that their document could not be generated
If your internal client received an email informing them that their document could not be generated, please undertake the following steps:
- Check that the conditions in question 1 have been met
- Attempt to locate the internal client's legal request in Xakia, and review that request for any unexpected responses or behaviour
- Attempt to reproduce the internal client's document by submitting an identical legal request (making changes to any unexpected response or behaviour) to see if a document is generated
- If not, submit a further dummy legal request with different responses to confirm whether the document is being generated in any circumstances
- Check the template in the AutoDocs editor to confirm whether there have been any recent changes to the document. If there have been, attempt to roll these changes back if possible and retest.
- Contact Xakia support, quoting the Document ID and Request ID stated in the email received by your internal client.
5. I received an email saying my internal client's document could not be generated
Follow the same steps as question 4.
6. How do I know which variable is which in the AutoDocs Editor?
There are 3 different types of variables that appear in the AutoDocs Editor:
- Standard intake field variables - each of these variables is given a name in the AutoDocs Editor that is referable to the standard name for that field in Xakia - for example, "ContactName" is the name of the internal client, "ContactEmail" is their email address and "Name" is the Request Name.
- Background variables - these include a small number of variables which the internal clients did not need to respond, but which exist in relation to any legal request, including "DateReceived" variables (available in 3 date formats), "Number" (the request number generated by Xakia) and "RequestType"
- Custom field variables - each custom field variable is presented using its unique identifier as shown in the Custom Fields tab (e.g. CF24). If you hover over a custom field variable, hover text will show you the label you have given to that custom field, so that you can easily identify what it is.
If you need additional help to identify which variable is which, we suggest having the legal intake request form open on a separate browser page beside the AutoDocs Editor as you are placing variables, so you can confirm each variable against the form.
7. Why don't you display the name I gave to a custom field in the AutoDocs Editor?
Custom field variables in the AutoDocs Editor appear using the custom field unique identifier created at the time you created that custom field in Xakia (e.g. CF24).
In our research while developing AutoDocs, we found that it was common for our customers to label their custom fields with full sentences (e.g. "What is the name of the first party to this contract?"), which is simply too long to display in the AutoDocs Editor.
So, we chose to display all custom fields by their unique identifier, and allow hover text which displays the full label you set up.
If you require more information or support, you can get in touch with the Support team here or email support@xakiatech.com.