Difference between revisions of "Using a Databox - Read"

From Keyfax Wiki
Jump to: navigation, search
(Created page with "Home > Databoxes > Using a Databox - Read Using a Databox - Read Data held in a Databox can also be ‘read’. Reading from a Databox allows the data to be used elsewhere....")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
Home > Databoxes > Using a Databox - Read
+
Data held in a databox can be read by the system. This can be used so that the information can be:
  
Using a Databox - Read
+
*Used in a message
 +
*Used in a task
 +
*Read and assessed or manipulated
 +
*Used in another databox
  
Data held in a Databox can also be ‘read’. Reading from a Databox allows the data to be used elsewhere. For example, it may be data that is to be:
+
With the Item type selected as '''Databox - Read''' drag the databox into the Script Step column as shown below.
•used in a message
 
•used in a task
 
•read so that the data can be manipulated and then written to another Databox
 
  
To read data from a Databox, open the Script in Edit mode and select the Databox - Read option from the Item Type drop down list in the Navigation Pane. The list of Databoxes that can be read from is displayed. Select the Databox and drag it onto the Script to the position required.
+
[[File:databoxread41.png]]
  
Example: We will use a Databox to read the Keyfax User Name from the Import XML and then write it into the Additional_Info node of the Export XML.
+
The example here reads the '''Import.UserCode''' which will contain the username of whoever is using the system and writes it into the Additional Information element of the Export XML. In this case the user is '''Tom''' and therefore on the results screen this has populated the Additional Information field.
  
For this, we will use an Import XML Databox called ‘UserCode’.
+
[[File:39.png]]
  
In the Navigation Pane select the Databox ‘UserCode’ from the Databox- Read option in the Item Type drop down list, and drag it across to the required position in the Script grid.
+
[[File:40.png]]
 
This shows the ‘UserCode’ Databox being placed at the start of the Script.
 
 
Next, we need to specify where the data is to be placed once it has been read. In this example, we will write it to the Additional Info node of the Export XML. To do this, select the Databox - Write option from the Item Type drop down list in the Navigation Pane and drag the ‘Additional_Info’ Databox onto the Import.UserCode Databox. This will result in the Databox – Write action being placed against the read action.
 
 
This will now read the User code of the Keyfax User and then write it to the Additional Info node in the Export XML.
 
  
Running through the Scripts with a User Code of TOM will result in the Additional Information node being populated with ‘TOM’. As the ‘Additional Information’ section of the Keyfax Results screen reads from this node, it will be visible on the Results screen.
+
[[File:41.png]]

Latest revision as of 14:03, 21 February 2018

Data held in a databox can be read by the system. This can be used so that the information can be:

  • Used in a message
  • Used in a task
  • Read and assessed or manipulated
  • Used in another databox

With the Item type selected as Databox - Read drag the databox into the Script Step column as shown below.

Databoxread41.png

The example here reads the Import.UserCode which will contain the username of whoever is using the system and writes it into the Additional Information element of the Export XML. In this case the user is Tom and therefore on the results screen this has populated the Additional Information field.

39.png

40.png

41.png