Databoxes
An introduction to Databoxes within Keyfax.
Last updated
An introduction to Databoxes within Keyfax.
Last updated
Databoxes are used in scripts to capture, manipulate and evaluate data.
During the process of designing and creating scripts, data are captured when entered by the user. This data may be used in a subsequent task or may be used to control the path taken within the Scripts. This data capture and evaluation is performed using Databoxes.
A Databox can simply be viewed as a ‘box’ which stores information. This ‘box’ can have data stored in it (write), and the same data can then be pulled out of it (read). This means the Administrator does not have to worry about the technicalities of locating where the data is physically stored and how it is accessed.
Data can be manipulated or interrogated by use of Databox Expressions.
These are the six types of Databox and how they relate to the manipulation of data.
A Script Data Databox is used to hold data gathered within a script e.g. an answer to a question. The information being captured or manipulated in Keyfax can be ‘written’ to a Script Data Databox and re-used at a later point within the Scripts. Typically, Script Data Databoxes are used to store data that is to be integrated into a subsequent task (such as an email or letter).
An SQL Query* Databox is linked to a database, either the Keyfax database or an external database via a SQL query. Because of this, SQL Query Databoxes are known as ‘Read Only’. This means that they are only used to pull data from a database and not to write data back into the connected database. Queries can use Views or Stored Procedures.
An Import XML Databox is linked to the information given by the Host System to Keyfax when it is launched. Examples of the type of information passed are TenantID, AssetID, Tenant Address and UserID. A typical breakdown of the elements available in your Startup XML can be obtained from your Keyfax Account Manager or by reviewing the Test page within the administration console.
An Export XML Databox is linked to the information that is passed back to the Host System by Keyfax after clicking the ‘Submit’ button. Depending on the path taken a Script, the information held in the Export XML can vary considerably. An Export XML Databox can be used to change the data passed back to the Host System. A good example of this would be the setting of a Trade or Location Code following the diagnosis of a repair in Keyfax.
A System Values Databox is linked to information associated with the computer running Keyfax. A typical example of this would be the current time/date. These are sometimes seen as ‘Keyfax’ Databoxes.
A Company Data Databox usually contains a list of set values that can be used within the Scripts. An example of this would be a list of email addresses set against their counterpart user names.
Using Keyfax Administrator Tools open the Databoxes tab by clicking the main menu's Databoxes button as shown below...
Select the type of Databox you wish to create or, select an existing Databox to edit from the left-hand menu. If you have already selected a Databox, you can click 'Add' to create a new one.
Databoxes can sometimes appear a little daunting and that's why help is always available when you need it via Keyfax Administrator Tools. Hover over topics in the 'Help with Expressions' pane to learn more and see examples directly within Keyfax Administrator Tools....
If more information or examples are required, click the keyword / item and a popup window will appear.
