Waiting for engine...
Skip to main content

Generic Connector Record object

Use the Generic Connector Record object to programmatically retrieve document metadata for a given process execution by means of a GET and QUERY operation.

note

This object is part of a series of process run-related API objects and operations for viewing and running documents using the Boomi Enterprise Platform API. You can use each object or operation conjunctively with one another to achieve a set of results for viewing or retrieving process run details. For a deeper understanding into the relationships and usability between each of these APIs, see the Community article How to get integration process execution details with the Boomi Enterprise Platform API.

The Generic Connector Record represents the individual documents that are tracked for a given integration process run. Generic Connector Records are obtained through Start, connector, or Return Documents shapes. These records also include both standard connector and user-defined tracked document metadata.

A typical usage pattern when using this object is to:

  1. Query for a particular ExecutionRecord record.
  2. Retrieve the ExecutionConnector records for that run record.
  3. Retrieve the GenericConnectorRecords for a particular ExecutionConnector record.

This record is equivalent to viewing the details of a run through the Process Reporting page.

note

You can query Generic Connector Records within a single process run. You cannot query Generic Connector Records across all available runs at this time.

Structure​

<GenericConnectorRecord id="" executionConnectorId="" executionId="" atomId="" dateProcessed="" actionType="" connectorType="" connectionName="" operationName="" connectionId="" operationId="" documentIndex="" incrementalDocumentIndex="" status="" startShape="" retryable="" size=""/>

FieldTypeDescription
FilterFilterFilter
idstringThe ID of the GenericConnectorRecord. You obtain this ID from querying the GenericConnectorRecord object.
executionConnectorIdstringThe ID of the Execution Connector object. This ID identifies the execution connector of which this document is a part.
executionIdstringThe ID of the process run.
atomIdstringThe ID of the Runtime in which the process ran. In the case of a Runtime cloud, use the ID of the Cloud attachment and not that of the Cloud itself.
dateProcessedyyyy-MM-dd'T'HH:mm:ss'Z' such as, 2021-07-03T15:32:00ZThe processing date and time of the document.
actionTypestringThe type of action the connector performs, for example, GET, SEND, LISTEN, and so on.
connectorTypestringThe internal and unique identifier for the connector type the document was sent into or out of, such as http, ftp, or greatplains.
connectionNamestringWhen sending documents into or out of the Connection component, use this user-defined name.
operationNamestringWhen sending documents into or out of the Operation component, use this user-defined name.
connectionIdstringWhen sending documents into or out of the Connection component, use this ID.
operationIdstringWhen sending documents into or out of the Operation component, use this ID.
documentIndexintegerIndex of the document within the context of its execution connector (starting from 0).
incrementalDocumentIndexintegerIndex of the document in the context of the overall run (starting from 1).
statusstringIndicates whether the document successfully or unsuccessfully ran.
startShapebooleanIf the value is true, this indicates the configuration of the Connector or Trading Partner as a Start shape in the process run. If the value is false, this indicates that you did not configure the Connector or Trading Partner as a Start shape in the process run.
retryablebooleanIf the value is true, this indicates that you can rerun the document using the Rerun Document operation. If the value is false, this indicates that you cannot rerun the document using the Rerun Document operation.
sizeintegerThe size of the document in kilobytes.
errorMessagestringDisplays the corresponding error message for an unsuccessful document.
trackedFieldsstringDisplays all the custom tracked fields from this document.
connectorFieldsstringDisplays all connector-related fields from the connector included in this document.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Supported Supported  Not SupportedNot Supported Not Supported  Not Supported

Using the GET operation​

  • The GET operation allows you to view document metadata for exactly one document based on the provided id.

Using the QUERY operation​

  • The QUERY operation allows you to view document metadata for all documents in the run. You must query by exactly 1 executionId.

  • You can use the following fields as QUERY filters for the Generic Connector Record object:

    note

    You cannot query connectorFields.

FieldAllowed values
idAny string of a valid Generic Connector Record.
executionIdRequires exactly one executionId. EQUALS is the only allowed operator. The value is the id of the process run.
executionConnectorIdAny string of a valid run Connector ID.
atomIdAny valid Runtime ID.
dateProcessedAny date string in the format of yyyy-MM-dd'T'HH:mm:ss'Z', such as, 2021-07-03T15:32:00Z.
actionTypeAny valid Connector action type. For example: SEND, GET and LISTEN.
connectorTypeAny valid Connector type For example: x12, nodata, return, boomiapi, disk, and so on.
connectionNameAny string. This field does not populate for non-connector type components.
operationNameAny string. This field does not populate for non-connector type components.
connectionIdAny valid Connection component ID. This field does not populate for non-connector type components.
operationIdAny valid Operation component ID. This field does not populate for non-connector type components.
documentIndexAny numeric value.
incrementalDocumentIndexAny numeric value.
statusString of SUCCESS or ERROR.
startShapeThe true or false value. Any value other than true is considered false.
retryableThe true or false value. Any value other than true is considered false.
sizeAny numeric value.
trackedFieldsTo filter by a trackedFields, use the format trackedFields/trackedField/fieldName as the filter property where fieldName is the element name of the tracked field in the Generic Connector Record structure. To get a list of the available tracked fields see the Custom Tracked Field object documentation.

SOAP implementation​

  • GET operation

    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>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password123</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
    <api:get>
             <api:objectType>GenericConnectorRecord</api:objectType>
    <api:objectId>A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy</api:objectId>
          </api:get>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
             <bns:result xsi:type="bns:GenericConnectorRecord" id="A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy" executionConnectorId="RVhFQ19DT05OZmFsc2U6UVVFUlk6ZWNmYzdhNDktMjNmNS00ODQ3LTkzMjItZmE3MTE0YTk0MjE0OmFlZDdmZjkyLWUzMjktNDFlMy05YjIzLTJlNzg0MWYwNjM0NDpleGVjdXRpb24tYzVjZWVhYzktZGQwMS00NjM4LTliMTMtZjhhN2NlYWZjNmQwLTIwMjEuMDMuMDk" executionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" atomId="3456789a-bcde-f012-3456-789abcdef012" dateProcessed="2021-03-09T21:16:41Z" actionType="QUERY" connectorType="boomiapi" connectionName="https://boomi.com/api/soap/v1/account123?wsdl" operationName="Account Query" connectionId="1e234567-d88e-4872-9a17-2f1ccdd7281c" operationId="6f78901e-c1f5-4ad0-935f-2dae4be97077" documentIndex="2" incrementalDocumentIndex="4" status="SUCCESS" startShape="false" retryable="false" size="662"/>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns all Disk-type connectors that exist on the account.

    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>user@boomi.com</wsse:Username>
               <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password123</wsse:Password>
            </wsse:UsernameToken>
         </wsse:Security>
      </soapenv:Header>
      <soapenv:Body>
         <api:query>
      <api:objectType>GenericConnectorRecord</api:objectType>
            <api:queryConfig>
               <api:QueryFilter>
                  <api:expression xsi:type="api:GroupingExpression" operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                         <api:nestedExpression xsi:type="api:SimpleExpression" operator="EQUALS" property="executionId">                        
                             <api:argument>execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01</api:argument>
                     </api:nestedExpression>
                     <api:nestedExpression xsi:type="api:SimpleExpression" operator="EQUALS" property="connectorType">               
                        <api:argument>disk</api:argument>
                     </api:nestedExpression>                
                  </api:expression>
               </api:QueryFilter>
            </api:queryConfig>
         </api:query>
      </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <?xml version='1.0' encoding='UTF-8'?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
           <bns:queryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
               <bns:results numberOfResults="1">
                   <bns:result xsi:type="bns:GenericConnectorRecord" id="A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy" executionConnectorId="RVhFQ19DT05OZmFsc2U6R2V0OjE2MTE5YWM0LWJiNjMtNDQzNC04ZDAwLTZlOGQ0OTJiYzc4ZjpmNjEzNTMzMi05MDA1LTRlYTEtODU2ZC02ZmZhZmExMWVmN2Q6ZXhlY3V0aW9uLWM3NTYzYWM1LWRlOGYtNDgwNi05MmY5LTExZDgzOWRkNWZlNi0yMDIxLjAzLjEw" executionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" atomId="3456789a-bcde-f012-3456-789abcdef012" dateProcessed="2021-03-10T19:23:09Z" actionType="Get" connectorType="disk" connectionName="get file from disk" operationName="Read File" connectionId="b9153606-6c45-4780-8d15-e9854f2f5g49" operationId="a6b69451-c57d-4e5f-87gh-i9f177367jk4" documentIndex="0" incrementalDocumentIndex="2" status="SUCCESS" startShape="false" retryable="false" size="244">
                       <bns:connectorFields>
                           <bns:connectorField name="directory" value="/mnt/account123/B2B/source/AS2/AS2 HTTP Connector Request"/>
                           <bns:connectorField name="filename" value="request.txt"/>
                       </bns:connectorFields>
                   </bns:result>
               </bns:results>
           </bns:queryResponse>
       </S:Body>
    </S:Envelope>
On this Page