Overview
XMLAPI is commonly used with other software, such as electronic medical records software (EMR), to have two-way communication with FaxMaker for faxing and reporting the fax status back to the end-user through the EMR.
Information
Unlike TextAPI, a licensed user is required for sending faxes and a response file is the only option for a transmission report.
You cannot receive an email transmission report when using XMLAPI.
Enabling XMLAPI
To enable textAPI, follow the setting up XMLAPI article for information about enabling this feature.
Creating XMLAPI Control Files
XMLAPI control files require specific formatting which is covered in the Creating XMLAPI Files article. These files can reference body files and attachments, specify coverpages, list recipients and fax numbers and other information listed in the referenced article.
XMLAPI Response Files
XMLAPI produces response files or transmission reports. Refer to step 4 under TextAPI flow for the specifics as well as the XMLAPI Response file article. These files can be used to tell users the status of the fax but are most commonly used to report back to the sending software so that software can read the response file and report the fax status via its interface to the end-user.
XMLAPI Fax Flow
The fax flow is provided below for your reference, and it also helps in troubleshooting issues.
- The control file and any associated files are dropped into the XMLAPI pickup folder specified in the FaxMaker Configuration. This would include the mandatory XML control file, the optional bdy file and an optional attachment of which the file type could vary between supported attachment file types.
- The fax server service picks up the files, parses the XML information, and then processes them.
- Once the files are processed, the fax data is converted to an image and transmitted via the fax device.
- The transmission report is called a status file. This file is dropped back into the pickup folder, by default. Unlike TextAPI, you must be a licensed FaxMaker user to send faxes using this method, and there is no option to receive a transmission report via email.
Reviewing XMLAPI Faxes in Logging
For XMLAPI the logs to review will be the following:
- faxserver.gfi_log.txt (called faxserver log in this article)
- FaxServer.API.XML.txt (called xmlapi log in this article)
Each log will be covered below with XML control file example:
The control file listed below contains the following:
- Recipient fax number
- Sender information
- Attachment information
The next log to review is the xmlapi log, which shows the parsing of the XML control file.
- This shows the direction of information, coming into the XMP parser
- This shows the sender information
- This shows the recipient information
- This shows the attachment information
In the faxserver log, we can see the fax processing normally, with no differentiation due to the sending method. It logs checking the user, the recipient's fax number and the attachment:
Finally, in the xmlapi log, we can see the XML status/response file created:
