Intelligent Agent Core User Guide

Please email support@awaken.io for omissions or errors.
×
Menu
Search
 
   
   
   
 

External Data Source

 
The External Data Source Control allows the Intelligent Agent to read data from or write data to a database, file, API web service, or Field or Variable.
 
Unlike the Table, any retrieved data isn't directly displayed in the External Data Source, and only the first row is returned if reading data.
 
It can be configured so that it is either displayed to the agent as a simple button, or completely hidden.
 
 
 
It is most frequently used during a Workflow to interface with a database or API, and then read or write details related to the interaction.
 
This Control is part of the Intermediate Control pack, and will only be available if your System has the appropriate licence.
 
 

How To

Add an External Data Source to the Page. The options and style can be configured in the Options tab and Styling tab of the Field Properties.
 
External Data Source Fields can be styled in a Stylesheet by referencing the control-external-data-source class.
 
To configure the data source, use the Datasource Wizard in the Advanced Options tab.
 
The External Data Source Control has one unique option available in its Options tab:
Option
Description
Display Error Dialog
While this option is enabled, any errors encountered during the operation of the External Data Source (e.g., a database query timed out, or a webservice returned a failing HTTP status code) will be displayed to the agent in a dialog. If disabled, then the error dialog will be hidden from the agent.
 
 

Notes

The External Data Source is designed to only return a single row, so if your query returns multiple rows then the top row will be selected. It's recommended that the query always be sorted, so that the expected row is always returned in case of multiple rows.
 
If trying to display or bring multiple rows of data into Intelligent Agent, it may be better to use the Table.
 
As with other button-type Fields, it is possible to require that a Page passes Validation before the button will activate. This prevents the query from being executed before all requisite details have been collected.
 
As with other button-type Fields, upon activation the button will then be temporarily disabled until the action has completed.
 
As with other button-type Fields, it is possible to trigger this by JavaScript or Update Links. Please see the .click() article for more information and an example regarding using JavaScript.