ODETTE Connector Record object

ODETTE Connector Records correspond to the document and trading partner details of the Process Reporting page. The ODETTE Connector Record object contains ODETTE-specific document information and user-defined tracked field information along with other fields.

Structure

<ODETTEConnectorRecord>
    <account/>
    <executionId/>
    <atomId/>
    <dateProcessed/>
    <id/>
    <actionType/>
    <connectorType/>
    <connectorName/>
    <operationName/>
    <documentIndex/>
    <successful/>
    <size/>
    <errorMessage/>
    <customFields>
        <field1>value</field1>
        .
        .
        .
        <fieldN>value</fieldN>
    </customFields>
    <ackStatus/>
    <ackReport/>
    <senderID/>
    <receiverID/>
    <interchangeControlReference/>
    <messageType/>
    <messageReferenceNumber/>
    <interchangeDate/>
    <interchangeTime/>
    <ackRequested/>
    <version/>
    <release/>
    <controllingAgency/>
    <outboundValidationStatus/>
    <outboundValidationReport/>
</ODETTEConnectorRecord>

Field	Type	Description
Filter	Filter	Filter
account	string	The ID of the account from which you ran this record.
executionId	string	The ID of the execution run.
atomId	string	The ID of the Runtime that processed this record.
dateProcessed	string	The processing date and time of this record. The format is yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2018-08-08T15:32:00Z.
id	string	The ID of this record.
actionType	string	The type of action with which this record corresponds – Send for an outbound interchange, Get for an inbound interchange using the Disk, FTP, or SFTP communication method, or Listen for an inbound interchange using the AS2 or HTTP communication method.
connectorType	string	odette is the connector type for any record.
connectorName	string	The value is Trading Partner for an ODETTE trading partner Send operation, or Start for an ODETTE trading partner Listen operation.
operationName	string	The name of the operation component that processed the record.
documentIndex	int	The numerical index of this record in the execution run.
successful	boolean	Whether the record is a success or an error.
size	long	The size, in bytes, of the document that corresponds to this record.
errorMessage	string	Any error message associated with this record.
customFields	string	Custom fields based on the fields configured on the Setup page's Document Tracking tab in the Integration user interface. The names of the fields are dependent upon your account setup.
ackStatus	stringstring	The acknowledgement status – either Accepted, Received, or Rejected.
ackReport	string	The acknowledgement report.
senderID	string	For an outbound interchange, the UNB02, Interchange Sender ID, field value, which identifies the sender.
receiverID	string	For an inbound interchange, the UNB03, Interchange Receiver ID, field value, which identifies the receiver.
interchangeControlReference	string	The number that uniquely identifies the interchange.
messageType	string	The code identifying the type of message.
messageReferenceNumber	string	The unique message reference assigned by the sender.
interchangeDate	string	The date of preparation. The format is yyMMdd.
interchangeTime	string	The time of preparation. The format is HHmm.
ackRequested	string	The UNB09, the Acknowledgement Request field value, determines whether the sending trading partner requests a CONTRL message as functional acknowledgement. A value of 1 indicates that there is an acknowledgement request. An empty value means there is no acknowledgement request.
version	string	The message type version number.
release	string	The message type release number.
controllingAgency	string	The controlling agency for the message type.
outboundValidationStatus	string	The outbound validation status – either Success, Error - Interchange, Error - Message, or N/A. For an outbound interchange for which the outbound validation option is not selected in the sending trading partner, the value is N/A. An inbound interchange omits this field.
outboundValidationReport	string	The outbound validation report. This report contains descriptions of errors present in the outbound interchange. If the outbound validation option is not selected in the sending trading partner, the value is N/A. An inbound interchange omits this field.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported	Supported	Not Supported	Not Supported	Not Supported	Not Supported

The following fields can be used as QUERY filters for the ODETTE Connector Record object:

Field	Allowed values
Filter	Filter
executionId	Any string value
atomId	Any string value
dateProcessed	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2018-08-08T15:32:00Z
id	Any string value
actionType	Send, Get, Listen
connectorType	odette
connectorName	Trading Partner to filter by ODETTE trading partner Send operations, Start to filter by ODETTE trading partner Listen operations
operationName	Any string value
documentIndex	Any numeric value
successful	true, false
size	Any numeric value
errorMessage	Any string value
ackStatus	Accepted, Received, Rejected
ackReport	Any string value
senderID	Any string value
receiverID	Any string value
interchangeControlReference	Any string value
messageType	Any string value
messageReferenceNumber	Any string value
interchangeDate	Any string value
interchangeTime	Any string value
ackRequested	1 to filter by whether acknowledgment is requested, an empty value to filter by whether acknowledgment is not requested
outboundValidationStatus	Success, Error - Interchange, Error - Message, N/A
outboundValidationReport	Any string value

To filter by a customField, use the format customFields/fieldName as the filter property where fieldName is the element name of the custom field in the ODETTE Connector Record structure. To get a list of the available custom fields, refer to the topic Custom Tracked Field object.

The operators allowed for the ODETTE Connector Record object filters are:

BETWEEN
EQUALS
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
STARTS_WITH

However, it is important to note that the STARTS_WITH operator accepts values that do not include spaces only.

For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

Structure​

Supported operations​

Structure

Supported operations