AS2 Connector Record object
AS2 Connector Records correspond to the document and trading partner details of the Process Reporting page. Processes send AS2 messages using the AS2 Client connector and receive AS2 messages using the AS2 Shared Server connector. The AS2 Connector Record object contains AS2-specific document information and user-defined tracked field information along with other fields.
Structure
<AS2ConnectorRecord>
<account/>
<executionId/>
<atomId/>
<dateProcessed/>
<id/>
<actionType/>
<connectorType/>
<connectorName/>
<operationName/>
<documentIndex/>
<successful/>
<size/>
<errorMessage/>
<ackStatus/>
<as2FromId/>
<as2ToId/>
<subject/>
<messageId/>
<mdnMessage/>
<contentLength/>
<filename/>
<mimetype/>
</AS2ConnectorRecord>
| Field | Type | Description |
|---|---|---|
| Filter | Filter | Filter |
| account | string | The ID of the account this record was run in. |
| executionId | string | The ID of the run. |
| atomId | string | The ID of the Runtime that processed this record. |
| dateProcessed | string with the format yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2016-01-31T15:32:00Z | The processing date and time of this record. |
| id | string | The ID of this record. |
| actionType | string | The type of action with which this record corresponds — Listen or Send. |
| connectorType | string | The type of connector to which this record corresponds — as2 for AS2 Client (Send), as2sharedserver for AS2 Shared Server (Listen), or x12 for Trading Partner Send or Listen using the X12 standard. |
| connectorName | string | For an AS2 Client (Send) operation, the value is the name of the AS2 Client connection component through which the document that corresponds to this record was sent. The value is as2sharedserver Connector for an AS2 Shared Server (Listen) operation, 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 this record. The component is an AS2 Client operation in the case of a Send action or an AS2 Shared Server operation in the case of a Listen action. |
| 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 | The error message associated with this record if applicable. |
| ackStatus | string | The acknowledgment status — Acknowledged, Acknowledged/Errors, or Not Acknowledged. |
| as2FromId | string | The arbitrary identifier that indicates the sender of the message. |
| as2ToId | string | The arbitrary identifier that indicates the recipient of the message. |
| subject | string | The arbitrary subject name for the message. |
| messageId | string | The arbitrary identifier for the message. |
| mdnMessage | string | The content of the Message Delivery Notification (MDN) message — processed, processed/error, processed/error: authentication-failed, processed/error: decompression-failed, or processed/error: decryption-failed. In a Listen action by the AS2 shared server, an MDN message generates automatically. For a Send action, generating an MDN message is an option for the processing AS2 Client operation. |
| contentLength | string | The length of the message in bytes. |
| fileName | string | The file name of the document that corresponds to this record. |
| mimetype | string | The MIME type of the message — text/plain, application/binary, application/edifact, application/octet-stream, application/edi-x12, or application/xml |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
You can use the following fields as QUERY filters for the AS2 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, 2016-01-31T15:32:00Z |
| id | Any string value |
| actionType | Listen or Send |
| connectorType | as2, as2sharedserver, or x12 |
| connectorName | Any string value to filter by AS2 Client (Send) operations; or as2sharedserver Connector to filter by AS2 Shared Server (Listen) operations, Trading Partner to filter by X12 trading partner Send operations, or Start to filter by X12 trading partner Listen operations |
| operationName | Any string value |
| documentIndex | Any numeric value |
| successful | true or false |
| size | Any numeric value |
| errorMessage | Any string value |
| ackStatus | Acknowledged, Acknowledged/Errors, Not Acknowledged |
| as2FromId | Any string value |
| as2ToId | Any string value |
| subject | Any string value |
| messageId | Any string value |
| mdnMessage | processed, processed/error, processed/error: authentication-failed, processed/error: decompression-failed, processed/error: decryption-failed |
| contentLength | Any string value |
| filename | Any string value |
| mimetype | text/plain, application/binary, application/edifact, application/octet-stream, application/edi-x12, or application/xml |
The operators allowed for the AS2 Connector Record object filters are:
-
EQUALS
-
STARTS_WITH
-
BETWEEN
-
GREATER_THAN
-
GREATER_THAN_OR_EQUAL
-
LESS_THAN
-
LESS_THAN_OR_EQUAL
However, it is important to note that the STARTS_WITH operator accepts only values that do not include spaces.
For general information about the structure of QUERY filters and how to handle the paged results, see the Query filters and Query paging topics.
SOAP implementation
The following example query returns all AS2 Connector records with an executionId of execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11.
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>AS2ConnectorRecord</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-2018.07.11</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:AS2ConnectorRecord">
<bns:account>account-123456</bns:account>
<bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11</bns:executionId>
<bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
<bns:dateProcessed>2018-07-11T06:24:12Z</bns:dateProcessed>
<bns:id>connector-bcdef012-3456-789a-bcde-f0123456789a</bns:id>
<bns:actionType>Send</bns:actionType>
<bns:connectorType>as2</bns:connectorType>
<bns:connectorName>Sample AS2 connection</bns:connectorName>
<bns:operationName>Sample AS2 operation</bns:operationName>
<bns:documentIndex>0</bns:documentIndex>
<bns:successful>true</bns:successful>
<bns:size>654</bns:size>
<bns:ackStatus>Acknowledged</bns:ackStatus>
<bns:as2FromId>DASHER</bns:fromId>
<bns:as2ToId>DANCER</bns:toId>
<bns:subject>Sleigh Order 122518</bns:subject>
<bns:messageId><976473487.15.1527087239460.JavaMail.dasher@northpole></bns:messageId>
<bns:mdnMessage>processed</bns:mdnMessage>
<bns:contentLength>484</bns:contentLength>
<bns:filename>0000000122518.dat</bns:filename>
<bns:mimetype>application/octet-stream</bns:mimetype>
</bns:result>
...
<bns:result xsi:type="bns:AS2ConnectorRecord">
<bns:account>account-123456</bns:account>
<bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11</bns:executionId>
<bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
<bns:dateProcessed>2018-07-11T06:25:02Z</bns:dateProcessed>
<bns:id>connector-bcdef012-3456-789a-bcde-f0123456789a</bns:id>
<bns:actionType>Send</bns:actionType>
<bns:connectorType>as2</bns:connectorType>
<bns:connectorName>Sample AS2 connection</bns:connectorName>
<bns:operationName>Sample AS2 operation</bns:operationName>
<bns:documentIndex>49</bns:documentIndex>
<bns:successful>true</bns:successful>
<bns:size>654</bns:size>
<bns:ackStatus>Acknowledged</bns:ackStatus>
<bns:as2FromId>DASHER</bns:fromId>
<bns:as2ToId>DANCER</bns:toId>
<bns:subject>Sleigh Order 122560</bns:subject>
<bns:messageId><976473487.15.1527087239502.JavaMail.dasher@northpole></bns:messageId>
<bns:mdnMessage>processed</bns:mdnMessage>
<bns:contentLength>610</bns:contentLength>
<bns:filename>0000000122560.dat</bns:filename>
<bns:mimetype>application/octet-stream</bns:mimetype>
</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?
