SqlQuery

This help page is for Desktop Studio. This information is also available for CXone Studio.

Runs a SQL statement against a database connector source and returns a Dynamic Data object.

Dependencies

  • The DB provider must be set up prior to use.
  • The Setdb action does not need to be used prior to this action.

Supported Script Types

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Generic

 Email Chat Phone Voicemail Work Item SMS Digital

Properties

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

GroupName

The name of the database provider as configured by the NICE CXone administrator. This property is case sensitive. Enter the DB Provider name, not the Service name. The Service name is used when you set up your DB Provider.

SQLStatement

The SQL statement to be submitted to the database server. This statement should be expected to return records.

StartRecord

The record from the query result set with which you want to start.

MaxRecords

The maximum number of records to retrieve. The default is 100.
Timeout The number of seconds until the query times out. The default is 10. The maximum number of seconds supported is 30 (though larger numbers can actually be entered in the field).

Output Properties

This action stores the resulting set of data in a Dynamic Data object. Each data object will be unique, based on the query and the amount of data returned.

Property

Description
Result (out) This is the name of the Dynamic Data object that you want the data to be stored in.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description
Default Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnNoRecords Path taken if there are no values for the specified properties. This happens when data is not returned from the database.
OnError Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem. This happens when the SQL query is invalid.
OnTimeout Path taken if there is no response for the number of seconds specified.