RosettaNet Connector Record object

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

Structure

<RosettaNetConnectorRecord>
    <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/>
    <knownInitiatingPartnerID/>
    <frameworkVersion/>
    <PIPCode/>
    <PIPVersion/>
    <globalProcessCode/>
    <globalBusinessActionCode/>
    <globalDocumentFunctionCode/>
    <fromGlobalPartnerRoleClassificationCode/>
    <toGlobalPartnerRoleClassificationCode/>
    <fromGlobalBusinessServiceCode/>
    <toGlobalBusinessServiceCode/>
    <businessActivityIdentifier/>
    <processInstanceIdentifier/>
    <transactionInstanceIdentifier/>
    <actionInstanceIdentifier/>
    <inResponseToGlobalBusinessActionCode/>
    <inResponseToInstanceIdentifier/>
    <globalUsageCode/>
    <attemptCount/>
    <dateTime/>
    <isSecureTransportRequired/>
    <timeToAcknowledgeAcceptance/>
    <timeToAcknowledgeReceipt/>
    <timeToPerform/>
    <outboundValidationStatus/>
    <outboundValidationReport/>
</RosettaNetConnectorRecord>

Field	Type	Description
account	string	The ID of the account in which you ran the record.
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 of 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	rosettanet is the connector type for any record.
connectorName	string	The value is Trading Partner** for a RosettaNet trading partner Send operation, or Start for a RosettaNet 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. This field is omitted for a successful interchange.
customFields	string	Custom fields based on the fields configured on the Document Tracking tab of the Setup page. The names of the fields are dependent upon your account setup.
ackStatus	string	The acknowledgment status — either Acknowledged, Error - No Acknowledgement Returned, Exception, or Not Expected.
ackReport	string	The acknowledgment report.
senderID	string	The unique identifier for the sending trading partner.
receiverID	string	The unique identifier for the receiving trading partner.
knownInitiatingPartnerID	string	The unique identifier for the known initiating trading partner. The value is sourced by the document property Known Initiating Partner Global Business Identifier in the process. If this document property is not set in the process, the field’s value is the same as the senderID.
frameworkVersion	string	The version of the RosettaNet Implementation Framework — 1.1 or 2.0 — that specifies the structure of the document represented by this record.
PIPCode	string	The Partner Interface Process (PIP) code.
PIPVersion	string	The unique version number of the PIP document.
globalProcessCode	string	The name of the PIP specification document. For a RosettaNet 2.0 interchange, the value is N/A.
globalBusinessActionCode	string	The business action.
globalDocumentFunctionCode	string	Specifies whether the record represents a Request, Response, or neither; in the latter case the value is N/A. For a RosettaNet 2.0 interchange the value is N/A.
fromGlobalPartnerRoleClassificationCode	string	The code identifying the role the sending trading partner plays in the PIP.
toGlobalPartnerRoleClassificationCode	string	The code identifying the role the receiving trading partner plays in the PIP.
fromGlobalBusinessServiceCode	string	The code identifying the sending trading partner’s business service network component.
toGlobalBusinessServiceCode	string	The code identifying the receiving trading partner’s business service network component.
businessActivityIdentifier	string	The code identifying the business activity within the PIP.
processInstanceIdentifier	string	The unique identifier for the process instance. For a RosettaNet 2.0 interchange, the value is N/A.
transactionInstanceIdentifier	string	The unique identifier for the transaction instance.
actionInstanceIdentifier	string	The unique identifier for the action instance.
inResponseToGlobalBusinessActionCode	string	If the document is a response, the business action of the corresponding request.
inResponseToInstanceIdentifier	string	If the document is a response, the action instance identifier of the corresponding request.
globalUsageCode	string	Indicates whether the record is a Production or Test mode interchange.
attemptCount	string	The number of times you attempted the transaction — for example, 1 for the first attempt. For a RosettaNet 2.0 interchange, the value is N/A.
dateTime	string	The date and time of the message delivery.
isSecureTransportRequired	string	Yes indicates transporting the document from the next hub securely. No suggests the document does not need transporting from the next hub uniquely. For a RosettaNet 1.1 interchange, the value is N/A.
timeToAcknowledgeAcceptance	string	The length of the time-out period, in the format CCYYMMDDThhmmss.sss, for acknowledging acceptance of a message. For a RosettaNet 2.0 interchange, the value is N/A.
timeToAcknowledgeReceipt	string	The length of the time-out period, in the format CCYYMMDDThhmmss.sss, for acknowledging receipt of a message. For a RosettaNet 2.0 interchange, the value is N/A.
timeToPerform	string	The maximum length of the time period, in the format CCYYMMDDThhmmss.sss, that an initiating business activity waits for a responding activity to process a document. For a RosettaNet 2.0 interchange, the value is N/A.
outboundValidationStatus	string	The outbound validation status — is either Success, Error-Message, or N/A. For an outbound message for which you do not select the outbound validation option in the sending trading partner, the value is N/A. Inbound messages omit this field.
outboundValidationReport	string	The outbound validation report. This report contains descriptions of errors present in the outbound message. If you did not select the outbound validation option in the sending trading partner, the value is N/A. Inbound messages omit this field.

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 RosettaNet 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, 2018-09-05T15:32:00Z
id	Any string value
actionType	Send, Get, Listen
connectorType	rosettanet
connectorName	Trading Partner to filter by RosettaNet trading partner Send operations, Start to filter by RosettaNet trading partner Listen operations
operationName	Any string value
documentIndex	Any numeric value
successful	true, false
size	Any numeric value
errorMessage	Any string value
ackStatus	Acknowledged, Error - No Acknowledgement Returned, Exception, Not Expected
ackReport	Any string value
senderID	Any string value
receiverID	Any string value
knownInitiatingPartnerID	Any string value
frameworkVersion	1.1, 2.0
PIPCode	Any string value
PIPVersion	Any string value
globalProcessCode	Any string value
globalBusinessActionCode	Any string value
globalDocumentFunctionCode	N/A, Request, Response
fromGlobalPartnerRoleClassificationCode	Any string value
toGlobalPartnerRoleClassificationCode	Any string value
fromGlobalBusinessServiceCode	Any string value
toGlobalBusinessServiceCode	Any string value
businessActivityIdentifier	Any string value
processInstanceIdentifier	Any string value
transactionInstanceIdentifier	Any string value
actionInstanceIdentifier	Any string value
inResponseToGlobalBusinessActionCode	Any string value
inResponseToInstanceIdentifier	Any string value
globalUsageCode	Production, Test
attemptCount	Any string value
dateTime	Any string value
isSecureTransportRequired	No, Yes, N/A
timeToAcknowledgeAcceptance	Time period with the format CCYYMMDDThhmmss.sss — for example, 00000000T003000.000 — or N/A
timeToAcknowledgeReceipt	Time period with the format CCYYMMDDThhmmss.sss — for example, 00000000T003000.000 — or N/A
timeToPerform	Time period with the format CCYYMMDDThhmmss.sss — for example, 00000000T003000.000 — or N/A
outboundValidationStatus	Success, Error - Message, N/A
outboundValidationReport	Any string value

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

The operators allowed for the RosettaNet 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 RosettaNet Connector records with an executionId of execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05.

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>RosettaNetConnectorRecord</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.09.05</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:RosettaNetConnectorRecord">
              <bns:account>account-123456</bns:account>
              <bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05</bns:executionId>
              <bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
              <bns:dateProcessed>2018-09-05T06:24:12Z</bns:dateProcessed>
              <bns:id>connector-abcdef01-2345-6789-abcd-ef0123456789</bns:id>
              <bns:actionType>Listen</bns:actionType>
              <bns:connectorType>rosettanet</bns:connectorType>
              <bns:connectorName>Start</bns:connectorName>
              <bns:operationName>Sample RosettaNet Listen Operation</bns:operationName>
              <bns:documentIndex>0</bns:operationName>
              <bns:successful>true</bns:successful>
              <bns:size>654</bns:size>
              <bns:customFields>
                <bns:customNumber>13</bns:customNumber>
                <bns:customDate>2018-09-05T10:53:59-0400</bns:customDate>
                <bns:customCharacter>sample</bns:customCharacter>
              </bns:customFields>
              <bns:ackStatus>Acknowledged</bns:ackStatus>
              <bns:ackReport>Success</bns:ackReport>
              <bns:senderID>951751851</bns:senderID>
              <bns:receiverID>928523723</bns:receiverID>
              <bns:knownInitiatingPartnerID>951751851</bns:knownInitiatingPartnerID>
              <bns:frameworkVersion>2.0</bns:frameworkVersion>
              <bns:PIPCode>3A4</bns:PIPCode>
              <bns:PIPVersion>V02.00.00</bns:PIPVersion>
              <bns:globalProcessCode>N/A</bns:globalProcessCode>
              <bns:globalBusinessActionCode>N/A</bns:globalBusinessActionCode>
              <bns:globalDocumentFunctionCode>N/A</bns:globalDocumentFunctionCode>
              <bns:fromGlobalPartnerRoleClassificationCode>Seller</bns:fromGlobalPartnerRoleClassificationCode>
              <bns:toGlobalPartnerRoleClassificationCode>42</bns:toGlobalPartnerRoleClassificationCode>
              <bns:fromGlobalBusinessServiceCode>Seller Service</bns:fromGlobalBusinessServiceCode>
              <bns:toGlobalBusinessServiceCode>Buyer Service</bns:toGlobalBusinessServiceCode>
              <bns:businessActivityIdentifier>Request Purchase Order</bns:businessActivityIdentifier>
              <bns:processInstanceIdentifier>N/A</bns:processInstanceIdentifier>
              <bns:transactionInstanceIdentifier>9</bns:transactionInstanceIdentifier>
              <bns:actionInstanceIdentifier>2</bns:actionInstanceIdentifier>
              <bns:inResponseToGlobalBusinessActionCode>Purchase Order Request</bns:inResponseToGlobalBusinessActionCode>
              <bns:inResponseToInstanceIdentifier>9</bns:inResponseToInstanceIdentifier>
              <bns:globalUsageCode>Test</bns:globalUsageCode>
              <bns:attemptCount>N/A</bns:attemptCount>
              <bns:dateTime>20180905T062412.327Z</bns:dateTime>
              <bns:isSecureTransportRequired>Yes</bns:isSecureTransportRequired>
              <bns:timeToAcknowledgeAcceptance>N/A</bns:timeToAcknowledgeAcceptance>
              <bns:timeToAcknowledgeReceipt>N/A</bns:timeToAcknowledgeReceipt>
              <bns:timeToPerform>N/A</bns:timeToPerform>
            </bns:result>
            ...
            <bns:result xsi:type="bns:RosettaNetConnectorRecord">
              <bns:account>account-123456</bns:account>
              <bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05</bns:executionId>
              <bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
              <bns:dateProcessed>2018-09-05T06:25:02Z</bns:dateProcessed>
              <bns:id>connector-bcdef012-3456-789a-bcde-f0123456789a</bns:id>
              <bns:actionType>Listen</bns:actionType>
              <bns:connectorType>rosettanet</bns:connectorType>
              <bns:connectorName>Start</bns:connectorName>
              <bns:operationName>Sample RosettaNet Listen Operation</bns:operationName>
              <bns:documentIndex>49</bns:documentIndex>
              <bns:successful>true</bns:successful>
              <bns:size>564</bns:size>
              <bns:customFields>
                <bns:customNumber>55</bns:customNumber>
                <bns:customDate>2018-09-05T10:57:14-0400</bns:customDate>
                <bns:customCharacter>sample</bns:customCharacter>
              </bns:customFields>
              <bns:ackStatus>Acknowledged</bns:ackStatus>
              <bns:ackReport>Success</bns:ackReport>
              <bns:senderID>951751851</bns:senderID>
              <bns:receiverID>928523723</bns:receiverID>
              <bns:knownInitiatingPartnerID>951751851</bns:knownInitiatingPartnerID>
              <bns:frameworkVersion>2.0</bns:frameworkVersion>
              <bns:PIPCode>3A4</bns:PIPCode>
              <bns:PIPVersion>V02.00.00</bns:PIPVersion>
              <bns:globalProcessCode>N/A</bns:globalProcessCode>
              <bns:globalBusinessActionCode>N/A</bns:globalBusinessActionCode>
              <bns:globalDocumentFunctionCode>N/A</bns:globalDocumentFunctionCode>
              <bns:fromGlobalPartnerRoleClassificationCode>Seller</bns:fromGlobalPartnerRoleClassificationCode>
              <bns:toGlobalPartnerRoleClassificationCode>42</bns:toGlobalPartnerRoleClassificationCode>
              <bns:fromGlobalBusinessServiceCode>Seller Service</bns:fromGlobalBusinessServiceCode>
              <bns:toGlobalBusinessServiceCode>Buyer Service</bns:toGlobalBusinessServiceCode>
              <bns:businessActivityIdentifier>Request Purchase Order</bns:businessActivityIdentifier>
              <bns:processInstanceIdentifier>N/A</bns:processInstanceIdentifier>
              <bns:transactionInstanceIdentifier>9</bns:transactionInstanceIdentifier>
              <bns:actionInstanceIdentifier>2</bns:actionInstanceIdentifier>
              <bns:inResponseToGlobalBusinessActionCode>Purchase Order Request</bns:inResponseToGlobalBusinessActionCode>
              <bns:inResponseToInstanceIdentifier>9</bns:inResponseToInstanceIdentifier>
              <bns:globalUsageCode>Test</bns:globalUsageCode>
              <bns:attemptCount>N/A</bns:attemptCount>
              <bns:dateTime>20180905T062502.327Z</bns:dateTime>
              <bns:isSecureTransportRequired>Yes</bns:isSecureTransportRequired>
              <bns:timeToAcknowledgeAcceptance>N/A</bns:timeToAcknowledgeAcceptance>
              <bns:timeToAcknowledgeReceipt>N/A</bns:timeToAcknowledgeReceipt>
              <bns:timeToPerform>N/A</bns:timeToPerform>
            </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