Data access node

A data access node exchanges information with an external system, typically by retrieving information from a database or application. In a node object literal, the data access node element is identified with this key: dataAccessNode.

Elements of a data access node object literal
Element Type Description
name String Name of the node (see Naming guidelines)
description String Description of the node (maximum 1000 characters)
outputVariables Array of variables One or more variables to be returned by the backend system
processingItems Processing item group object Data access latency message (maximum one static message, that is, a single prompt group and no annotations in the prompt payloads)
serviceName String Deprecated
externalFetchEnabled Boolean true if the data access layer uses an external service to exchange data (client-side integration); otherwise, false (server-side integration)
successNodeId String UUID of the node to transition to if the query to the backend system succeeded
failureNodeId String UUID of the node to transition to if the query to the backend system query failed
inputVariablesConcepts Array of inputs Key-value pairs representing variables, entities, and other objects to pass on to a backend system
urlExtension String Deprecated
fetchTimeout Number Deprecated
connectTimeout Number Deprecated
methodType String Deprecated
sourceExpression String Deprecated
headers String Deprecated
view View object Formatting information to pass to the client application for the latency message
backendConfig Backend connection data object Information required by the dialog service to interact directly with a backend system—used when externalFetchEnabled is false (server-side integration)
nodeSettingOverride Array of node setting overrides Overrides to the default global settings for this node
processingItemsId String UUID of the processing item group
outputVariableIds Array UUIDs of the variables to be returned by the backend system (possibly including SYS_VAR_channel if using the predefined variable channel)
timestamp String Date and time of the last modification, in this format: YYYY-MM-DD hh:mm:ssZ—for example, 2019-08-21T08:34:27Z
  Data access node example  

Backend connection data

Represents the information to access a backend web service from a data access node.

Elements of a backend connection data object literal
Element Type Description
id String Not used
urlExtension String URL extension (maximum 2000 characters)
fetchTimeout Number Fetch timeout in milliseconds (default: 0)
connectTimeout Number Connection timeout in milliseconds (default: 0)
method String Method; one of: POST, GET, PUT, DELETE, PATCH, NOT_SET (default)
dressName String Deprecated (superseded by dressAliasId)
headers Array of headers Headers used to query the backend system
dressAliasId String Numeric ID of the connection profile for the backend system

Represents a header in the backend connection data for a data access node, or in a backend connection preset.

Elements of a header object literal
Element Type Description
key String Name of the header
header Object Key-value pair representing one of the supported header types.
variableId String Only present for headers of type variable—UUID of the variable (or SYS_VAR_channel if using the predefined variable channel)
variableExpressionId String Only present for headers of type variableExpression—UUID of the complex variable field

Supported header types

Types of header for header object literals
Element key Value type Description
constant String Static header data (maximum 2048 characters)
variable Variable object Variable used as dynamic header data
variableExpression Variable expression object Complex variable field, used as dynamic header data

Supported input types

Self-hosted environments: Using specialOperand value LAST_MESSAGE_OBJECT requires engine pack 2.3 (or later) for Speech Suite deployments; engine pack 3.11 (or later) for self-hosted Mix deployments.

Represents information to send to a backend system (from a data access node), or to the client application (from an external actions node, or from a question and answer node).

Types of send data parameters
Element key Value type Description
variable Variable Variable to pass on to the backend system
variableId String Only present for inputs of type variable—UUID of the variable (or SYS_VAR_channel if using the predefined variable channel)
concept Entity Entity to pass on to the backend system
conceptId String Only present for inputs of type concept—UUID of the entity
intent String One of: INTENT_VALUE (active intent value), INTENT_LITERAL (active intent literal), INTENT_FORMATTED_LITERAL (formatted version of the active intent literal), INTENT_CONFIDENCE (active intent confidence score)
specialOperand String One of: LAST_COLLECTION_INTERPRETATION (last collection interpretation), LAST_CONFIRMATION_INTERPRETATION (last confirmation interpretation), LAST_MESSAGE_OBJECT (last message object—that is, messages generated from the last visited message node, or from the latest step of the last visited question and answer node)