Tradacoms Connector Record object

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

Structure

<TradacomsConnectorRecord>
    <account/>
    <executionId/>
    <atomId/>
    <dateProcessed/>
    <id/>
    <actionType/>
    <connectorType/>
    <connectorName/>
    <operationName/>
    <documentIndex/>
    <successful/>
    <size/>
    <errorMessage/>
    <customFields>
        <field1>value</field1>
        .
        .
        .
        <fieldN>value</fieldN>
    </customFields>
    <validationStatus/>
    <validationReport/>
    <senderName/>
    <receiverName/>
    <senderCode/>
    <receiverCode/>
    <messageType/>
    <date/>
    <time/>
    <senderTransmissionReference/>
    <receiverTransmissionReference/>
    <applicationReference/>
    <transmissionPriorityCode/>
    <fileGenerationNumber/>
    <fileVersionNumber/>
</TradacomsConnectorRecord>

Field	Type	Description
Filter	Filter	Filter
account	string	The ID of the account in which you ran this record.
executionId	string	The ID of the run.
atomId	string	The Runtime ID from which you process this record.
dateProcessed	string	The processing date and time of this record. The format is yyyy-MM-dd'T'HH:mm:ss'Z', such as 2022-08-10T15: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	Tradacoms is the connector type for any record.
connectorName	string	The value is Trading Partner for a Tradacoms trading partner Send operation, or Start for a Tradacoms trading partner Listen operation.
operationName	string	The name of the operation component from which you 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. Omit this field for a successful interchange.
customFields	string	Custom fields based on the configured fields on the Document Tracking tab of the Setup page. The names of the fields are dependent upon your account setup.
validationStatus	string	The validation status — either Success or Errors.
validationReport	string	The validation report, which contains descriptions of segment validation errors.
senderName	string	The name of the sending trading partner.
receiverName	string	The name of the receiving trading partner.
senderCode	string	The identifier code of the sending trading partner.
receiverCode	string	The identifier code of the receiving trading partner.
messageType	string	The code identifying the type of message.
date	string	The date of the message delivery.
time	string	The time of the message delivery.
senderTransmissionReference	string	The sending trading partner’s reference for the message.
receiverTransmissionReference	string	The receiving trading partner’s reference for the message, if known to the sending trading partner.
applicationReference	string	The code that enables the receiving trading partner to identify whether the message contains data for a particular type of application.
transmissionPriorityCode	string	The code for the message transmission priority.
fileGenerationNumber	string	The number generated by the sending trading partner to uniquely reference the transmitted file.
fileVersionNumber	string	The number generated to uniquely reference a copy of the transmitted file.

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 Tradacoms 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, 2022-08-10T15:32:00Z
id	Any string value
actionType	Send, Get, Listen
connectorType	Tradacoms
connectorName	Trading Partner to filter by Tradacoms trading partner Send operations, Start to filter by Tradacoms trading partner Listen operations
operationName	Any string value
documentIndex	Any numeric value
successful	true, false
size	Any numeric value
errorMessage	Any string value
validationStatus	Success, Errors
validationReport	Any string value
senderName	Any string value
receiverName	Any string value
messageType	Any string value
date	Any string value
time	Any string value
senderTransmissionReference	Any string value
receiverTransmissionReference	Any string value
applicationReference	Any string value
transmissionPriorityCode	Any string value
fileGenerationNumber	Any string value
fileVersionNumber	Any string value

To filter by a custom field, use the format customFields. You can use the fieldName as the filter property where fieldName is the element name of the custom field in the Tradacoms Connector Record structure. To get a list of the available custom fields see the Custom Tracked Field object documentation.

The operators allowed for the Tradacoms 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.

SOAP implementation

The following example query returns all Tradacoms Connector records with an executionId of execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10.

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>TradacomsConnectorRecord</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-2019.08.10</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:TradacomsConnectorRecord">
              <bns:account>account-123456</bns:account>
              <bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10</bns:executionId>
              <bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
              <bns:dateProcessed>2019-08-10T06:24:12Z</bns:dateProcessed>
              <bns:id>connector-abcdef01-2345-6789-abcd-ef0123456789</bns:id>
              <bns:actionType>Listen</bns:actionType>
              <bns:connectorType>Tradacoms</bns:connectorType>
              <bns:connectorName>Start</bns:connectorName>
              <bns:operationName>Sample Tradacoms Listen Operation</bns:operationName>
              <bns:documentIndex>0</bns:operationName>
              <bns:successful>true</bns:successful>
              <bns:size>3138</bns:size>
              <bns:customFields>
                <bns:customNumber>13</bns:customNumber>
                <bns:customDate>2019-08-10T10:53:59-0400</bns:customDate>
                <bns:customCharacter>sample</bns:customCharacter>
              </bns:customFields>
              <bns:validationStatus>Errors</bns:validationStatus>
              <bns:validationReport>Loop Error: 3 - VALUE_NOT_FOUND</bns:validationReport>
              <bns:senderName>ka</bns:senderName>
              <bns:senderCode>ka1</bns:senderCode>
              <bns:receiverName>mow</bns:receiverName>
              <bns:receiverCode>mow1</bns:receiverCode>
              <bns:messageType>INVFIL</bns:messageType>
              <bns:date>190810</bns:date>
              <bns:time>144753</bns:time>
              <bns:senderTransmissionReference>STXREF</bns:senderTransmissionReference>
              <bns:receiverTransmissionReference>rcvref</bns:receiverTransmissionReference>
              <bns:applicationReference>CAKHDR</bns:applicationReference>
              <bns:transmissionPriorityCode>C</bns:transmissionPriorityCode>
              <bns:fileGenerationNumber>1</bns:fileGenerationNumber>
              <bns:fileVersionNumber>1</bns:fileVersion>
            </bns:result>
            ...
            <bns:result xsi:type="bns:TradacomsConnectorRecord">
              <bns:account>account-123456</bns:account>
              <bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10</bns:executionId>
              <bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
              <bns:dateProcessed>2019-08-10T06:25:02Z</bns:dateProcessed>
              <bns:id>connector-bcdef012-3456-789a-bcde-f0123456789a</bns:id>
              <bns:actionType>Listen</bns:actionType>
              <bns:connectorType>Tradacoms</bns:connectorType>
              <bns:connectorName>Start</bns:connectorName>
              <bns:operationName>Sample Tradacoms Listen Operation</bns:operationName>
              <bns:documentIndex>49</bns:documentIndex>
              <bns:successful>true</bns:successful>
              <bns:size>2781</bns:size>
              <bns:customFields>
                <bns:customNumber>55</bns:customNumber>
                <bns:customDate>2019-08-10T10:57:14-0400</bns:customDate>
                <bns:customCharacter>sample</bns:customCharacter>
              </bns:customFields>
              <bns:validationStatus>Success</bns:validationStatus>
              <bns:validationReport>Success</bns:validationReport>
              <bns:senderName>mc</bns:senderName>
              <bns:senderCode>mc1</bns:senderCode>
              <bns:receiverName>mow</bns:receiverName>
              <bns:receiverCode>mow1</bns:receiverCode>
              <bns:messageType>INVFIL</bns:messageType>
              <bns:date>190810</bns:date>
              <bns:time>144757</bns:time>
              <bns:senderTransmissionReference>STXREF</bns:senderTransmissionReference>
              <bns:receiverTransmissionReference>rcvref</bns:receiverTransmissionReference>
              <bns:applicationReference>CAKHDR</bns:applicationReference>
              <bns:transmissionPriorityCode>C</bns:transmissionPriorityCode>
              <bns:fileGenerationNumber>1</bns:fileGenerationNumber>
              <bns:fileVersionNumber>1</bns:fileVersion>
            </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.

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation