X12 Connector Record object
X12 Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The X12 Connector Record object contains X12-specific document information and user-defined tracked field information along with other fields.
Structure
<X12ConnectorRecord>
<account/>
<executionId/>
<atomId/>
<dateProcessed/>
<id/>
<actionType/>
<connectorType/>
<connectorName/>
<operationName/>
<documentIndex/>
<successful/>
<size/>
<errorMessage/>
<customFields>
<field1>value</field1>
.
.
.
<fieldN>value</fieldN>
</customFields>
<isaAckStatus/>
<isaAckReport/>
<ackStatus/>
<ackReport/>
<isaControl/>
<gsControl/>
<stControl/>
<functionalID/>
<transactionSet/>
<testIndicator/>
<senderIDQualifier/>
<senderID/>
<receiverIDQualifier/>
<receiverID/>
<appSenderID/>
<appReceiverID/>
<standardID/>
<standard/>
<gsVersion/>
<agencyCode/>
<gsDate/>
<gsTime/>
<outboundValidationStatus/>
<outboundValidationReport/>
</X12ConnectorRecord>
| Field | Type | Description |
|---|---|---|
| Filter | Filter | Filter |
| account | string | The ID of the account in which this record ran. |
| executionId | string | The ID of the run. |
| atomId | string | The ID of the Runtime that processed this record. |
| dateProcessed | string | The processing date and time for this record. The format is yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2016-01-31T15: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 | x12 is the connector type for any record. |
| connectorName | string | The value is Trading Partner for an X12 trading partner Send operation, or Start for an X12 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 run. |
| successful | boolean | Whether the record is a success or 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 those configured on the Document Tracking tab of the Setup page. The names of the fields depend on your account setup. |
| isaAckStatus | string | The interchange acknowledgment status — either Accepted, Accepted with Errors, Partially Accepted, or Rejected |
| isaAckReport | string | The interchange acknowledgment report, which contains descriptions of interchange segment validation errors. |
| ackStatus | string | The acknowledgment status — either Accepted, Accepted with Errors, Partially Accepted, or Rejected. |
| ackReport | string | The acknowledgment report. |
| isaControl | string | The number that uniquely identifies the interchange. |
| gsControl | string | The group control number. |
| stControl | string | The transaction set control number. |
| functionalID | string | The identifier for the type of message in the functional group. |
| transactionSet | string | The identifier code for the transaction set. |
| testIndicator | string | Specifies whether the interchange is for testing or production. |
| senderIDQualifier | string | For outbound interchanges, the Interchange ID Qualifier, which categorizes the Sender ID. |
| senderID | string | For outbound interchanges, the Interchange Sender ID, which identifies the sender. |
| receiverIDQualifier | string | For inbound interchanges, the Interchange ID Qualifier, which categorizes the Receiver ID. |
| receiverID | string | For inbound interchanges, the Interchange Receiver ID, which identifies the receiver. |
| appSenderID | string | For outbound interchanges, the Application Sender’s Code, which identifies the sender. |
| appReceiverID | string | For inbound interchanges, the Application Receiver’s Code, which identifies the receiver. |
| standardID | string | Displays the same information as in the Standard column of the user interface. |
| standard | string | The Interchange Control standard. |
| gsVersion | string | The Version, Release, and Industry identifier code. |
| agencyCode | string | The Responsible Agency Code. |
| gsDate | string | The preparation date of the interchange. |
| gsTime | string | The preparation time of the interchange. |
| outboundValidationStatus | string | The outbound validation status — is either Success, Error-Interchange, Error-Transaction Set, or N/A. For an outbound interchange for which you did not select the outbound validation option in the sending trading partner, the value is N/A. The platform omits this field for an inbound interchange. |
| outboundValidationReport | string | The outbound validation report. This report contains descriptions of errors present in the outbound interchange. If you did not select the outbound validation option in the sending trading partner, the value is N/A. The platform omits this field for an inbound interchange. |
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 X12 Connector Record object:
| Field | Allowed values |
|---|---|
| executionId | Any string value |
| atomId | Any string value |
| dateProcessed | Date with the format yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2016-01-31T15:32:00Z |
| id | Any string value |
| actionType | Send, Get, Listen |
| connectorType | x12 |
| connectorName | Use Trading Partner to filter by X12 trading partner Send operations, use Start to filter by X12 trading partner Listen operations. |
| operationName | Any string value |
| documentIndex | Any numeric value |
| successful | true, false |
| size | Any numeric value |
| errorMessage | Any string value |
| isaAckStatus | - Accepted - Accepted with Errors - Partially Accepted - Rejected |
| isaAckReport | Any string value |
| ackStatus | - Accepted - Accepted with Errors - Partially Accepted - Rejected |
| ackReport | Any string value |
| isaControl | Any string value |
| gsControl | Any string value |
| stControl | Any string value |
| functionalID | Any string value |
| transactionSet | Any string value |
| testIndicator | Any string value |
| senderIDQualifier | Any string value |
| senderID | Any string value |
| receiverIDQualifier | Any string value |
| receiverID | Any string value |
| appSenderID | Any string value |
| appReceiverID | Any string value |
| standardID | Any string value |
| standard | Any string value |
| gsVersion | Any string value |
| agencyCode | Any string value |
| gsDate | Any string value |
| gsTime | Any string value |
| outboundValidationStatus | - Success - Error-Interchange - Error-Transaction Set - N/A |
| outboundValidationReport | Any string value |
To filter by a custom field, use the format customFields. Use the fieldName as the filter property where fieldName is the element name of the custom field in the X12 Connector Record structure. To get a list of the available custom fields see the Custom Tracked Field object documentation.
The operators allowed for the X12 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 only accepts values that do not include spaces.
For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.
SOAP implementation
The following example query returns all X12 Connector records with an executionId of execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.21.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:query>
<api:objectType>X12ConnectorRecord</api:objectType>
<api:queryConfig>
<api:QueryFilter>
<api:expression operator="EQUALS" property="executionId"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
<api:argument>execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.21</api:argument>
</api:expression>
</api:QueryFilter>
</api:queryConfig>
</api:query>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<bns:queryResponse xmlns="http://api.platform.boomi.com/">
<bns:results numberOfResults="100">
<bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
<bns:result xsi:type="bns:X12ConnectorRecord">
<bns:account>account-123456</bns:account>
<bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.28</bns:executionId>
<bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
<bns:dateProcessed>2016-05-28T06:24:12Z</bns:dateProcessed>
<bns:id>connector-abcdef01-2345-6789-abcd-ef0123456789</bns:id>
<bns:actionType>Send</bns:actionType>
<bns:connectorType>x12</bns:connectorType>
<bns:connectorName>Trading Partner</bns:connectorName>
<bns:operationName>Xmit Message</bns:operationName>
<bns:documentIndex>0</bns:operationName>
<bns:successful>true</bns:successful>
<bns:size>654</bns:size>
<bns:customFields>
<bns:field1>13</bns:field1>
<bns:field2>ASA</bns:field2>
</bns:customFields>
<bns:isaAckStatus>Accepted</bns:isaAckStatus>
<bns:isaAckReport>Acknowledgment Report for Interchange Control Number 000000852
Date: 160528
Time: 0624
Acknowledgment Status: Accepted
Note: No Error</bns:isaAckReport>
<bns:ackStatus>Accepted</bns:ackStatus>
<bns:ackReport>Group Control #: 852
Acknowledgement Status: A</bns:ackReport>
<bns:isaControl>000000852</bns:isaControl>
<bns:gsControl>852</bns:gsControl>
<bns:stControl>0001</bns:stControl>
<bns:functionalID>SM</bns:functionalID>
<bns:transactionSet>204</bns:transactionSet>
<bns:testIndicator>P</bns:testIndicator>
<bns:senderIDQualifier>02</bns:senderIDQualifier>
<bns:senderID>NDTL</bns:senderID>
<bns:receiverIDQualifier>ZZ</bns:receiverIDQualifier>
<bns:receiverID>D1T1</bns:receiverID>
<bns:appSenderID>NDTL</bns:appSenderID>
<bns:appReceiverID>D1T1</bns:appReceiverID>
<bns:standardID>U</bns:standardID>
<bns:standard>U</bns:standard>
<bns:gsVersion>003050</bns:gsVersion>
<bns:agencyCode>X</bns:agencyCode>
<bns:gsDate>130528</bns:gsDate>
<bns:gsTime>0224</bns:gsTime>
<bns:outboundValidationStatus>Success</bns:outboundValidationStatus>
<bns:outboundValidationReport>Transaction Set #: 19 Acknowledgement Status: A</bns:outboundValidationReport>
</bns:result>
...
<bns:result xsi:type="bns:X12ConnectorRecord">
<bns:account>account-123456</bns:account>
<bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.28</bns:executionId>
<bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
<bns:dateProcessed>2016-05-28T06:25:02Z</bns:dateProcessed>
<bns:id>connector-bcdef012-3456-789a-bcde-f0123456789a</bns:id>
<bns:actionType>Send</bns:actionType>
<bns:connectorType>x12</bns:connectorType>
<bns:connectorName>Trading Partner</bns:connectorName>
<bns:operationName>Xmit Message</bns:operationName>
<bns:documentIndex>49</bns:operationName>
<bns:successful>true</bns:successful>
<bns:size>654</bns:size>
<bns:customFields>
<bns:field1>55</bns:field1>
<bns:field2>ASA</bns:field2>
</bns:customFields>
<bns:isaAckStatus>Accepted</bns:isaAckStatus>
<bns:isaAckReport>Acknowledgment Report for Interchange Control Number 000000913
Date: 160528
Time: 0625
Acknowledgment Status: Accepted
Note: No Error</bns:isaAckReport>
<bns:ackStatus>Accepted</bns:ackStatus>
<bns:ackReport>Group Control #: 913
Acknowledgement Status: A</bns:ackReport>
<bns:isaControl>000000913</bns:isaControl>
<bns:gsControl>913</bns:gsControl>
<bns:stControl>0001</bns:stControl>
<bns:functionalID>SM</bns:functionalID>
<bns:transactionSet>253</bns:transactionSet>
<bns:testIndicator>P</bns:testIndicator>
<bns:senderIDQualifier>02</bns:senderIDQualifier>
<bns:senderID>NDTL</bns:senderID>
<bns:receiverIDQualifier>ZZ</bns:receiverIDQualifier>
<bns:receiverID>D1T1</bns:receiverID>
<bns:appSenderID>NDTL</bns:appSenderID>
<bns:appReceiverID>D1T1</bns:appReceiverID>
<bns:standardID>U</bns:standardID>
<bns:standard>U</bns:standard>
<bns:gsVersion>003050</bns:gsVersion>
<bns:agencyCode>X</bns:agencyCode>
<bns:gsDate>130528</bns:gsDate>
<bns:gsTime>0225</bns:gsTime>
<bns:outboundValidationStatus>Success</bns:outboundValidationStatus>
<bns:outboundValidationReport>Transaction Set #: 19 Acknowledgement Status: A</bns:outboundValidationReport>
</bns:result>
</bns:results>
</bns:queryResponse>
</S:Body>
</S:Envelope>
The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.
Was this topic helpful?
