Data (DT) Parameter - XML Format

When the Deliver application data as XML option is selected (see General Settings), Softdial Campaign Manager™ provides the record data included in the Data (DT) parameter in an XML document format. XML data should be selected if the application data is likely to include characters that are considered invalid in standard SDMP messages - see Invalid Characters on the Configuration Issues page.

The following is an example of contact record data as delivered to an agent application, e.g. Softdial Scripter™ 2. It is passed to and from Softdial Campaign Manager™, via Softdial CallGem™, in the Data (DT) parameter of the agent layer messages, e.g. Begin Preview [BP], Agent Connect [AC], Transaction Complete [TC].

It is formatted on a single line, without carriage return (CR) and linefeed (LF) characters, since in the SDMP protocol, CR LF indicates end of message. The example document below has been formatted for easy reading.

Show example of contact record data

There is no <?xml> header tag specified.

The r element represents a row. Each column (field) in the record is represented with a c element, which has the following attributes:

i - (no longer used but retained for legacy compatibility) index position of the column within the row (note these may not appear in numerical order in the document.)
n - name of the column
m - whether the field type is a kind of numeric field
d - the data value for this field

When an agent application returns a data update in the Transaction Complete [TC] message, the attributes i, n and m must remain constant and as received in the original Agent Connect [AC] message. The d data attribute contains the updated data values.

Other applications can add to this set of data - see The Data (DT) Parameter.

As well as conforming to XML encoding rules, you must ensure that SDMP and XML characters are not directly used and encoded within each data attribute. These must be represented using XML entities, e.g:

CR = 
LF = 

\ = \

For reference, the standard XML reserved characters that must be encoded are:

& = &
" = "
' = '
< = <
> = >

Some fields are reserved by Softdial Campaign Manager™ for its own contact management and attempts to update will be ignored. In the above example, these fields are:

Switch_Result
Agent_Result
Result_TS
Retry_Count
Retry_Username
Retry_Number
Retry_Index
Complete_TS

From V10.6.568 - the i parameter is no longer used (still present for legacy xml/ xsd validation compatibility but now set to '0' and ignored). The n (name) field is now generally used as the key.

This is likely to be a breaking change for existing integrations