Export XML

Returning the results of your diagnostic to the calling host

Group - when displayed in the left hand menu, Databoxes are arranged into groups. Select a group from the dropdown list to add the Databox to an existing group or type in a new group name to create a new group.

Type – select from the dropdown list to specify how data is to be exported into the XML. The default options are:

  • General - Standard exporting of data into a node of the export XML.

  • Service - Exporting into a Service Code node in the export XML.

  • Custom - Creates a ‘Custom Key’ node in the Export XML. This is primarily used for backwards compatibility and for specific host systems that require data exported in a ‘Custom Key’ format.

  • Audit - Used for exporting information that requires being audited or logged by Keyfax.

Name – a descriptive name for the Databox. Use a meaningful description to identify the Databox in relation to its purpose for ease of recognition.

Append ‘recorded’ data - checking this option ensures that any data exported by the Databox is appended to any existing data. The data exported will be delimited by a semi-colon. Empty bookmarks allowed – check this box if the Databox can be used in a Task or Message without being required to hold a value. If not allowed, any empty bookmarks will present to the advisor and values must be entered. Read Only – check this box if the Databox will only be available to be read from when used within the Scripts. XPath - the XPath details the node/element of the Export XML that is to be written to by the Databox. This has to be detailed in standard XPath format.

XPath is a language that describes how to locate specific elements, attributes or processing instructions in an XML document. It allows you to locate particular content within a document. XPATH treats an XML document as a logical ordered tree.

XPath statements can get very complex but in the context of Databoxes, this shouldn't get more complicated than NodeName/NodeName/text(), e.g. Fault/Job_Code/text().

Test – if your Databox owns any Expressions, this is how to confirm that they are set up correctly and will work whatever data is passed to it, including null/empty values. Help with Expressions – Help on constructing expressions to manipulate the data, which also includes examples of specific expressions and guidance on where to find extra help.

Last updated