Trading Partner Component object

The Trading Partner Component object allows users to retrieve, query, create, update, and delete Trading Partner components through the Boomi Enterprise Platform API.

Structure

This structure example is for a Trading Partner classification="tradingpartner". For an operation on a My Company Trading Partner, set the classification to classification="mycompany" , replace any <AS2SendSettings> tags with corresponding <AS2ReceiveSettings> tags, and if the tag <PartnerDocumentTypes> is not applicable, omit the tag.

The root element’s deleted attribute is unique to deleted Trading Partner components. When the attribute is present, its value is true.

The organizationId field value is the ID of an Organization component, which is reusable across multiple Trading Partners, API Services, and API Proxies. The Organization component structure is identical to that of the ContactInformation fields in the Trading Partner component.

The valid values for the CommunicationSetting field are component (Communication Channel component), custom (custom settings), and default (default settings for the My Company trading partner with which this trading partner is paired on a Start or Trading Partner step). If the CommunicationSetting field value is component, the CommunicationChannel field value specifies the Communication Channel component ID. A CommunicationSetting field value of custom or default corresponds to a null CommunicationChannel field value.

The AS2 message option field maxDocumentCount is type int(eger), and the field’s range of valid values is 1–20. The value is meaningful only if the multipleAttachments field value is true.

note

Although the description field is in the object, operations does not support the field. It ignores the field if it is present in a QUERY, CREATE, or UPDATE request.

<TradingPartnerComponent xmlns:ns1="http://api.platform.boomi.com/" classification="" standard="" identifier="" componentName="" componentId="" organizationId="" folderName="" folderId="" deleted="">
   <ContactInfo>
      <contactName/>
      <address1/>
      <address2/>
      <city/>
      <state/>
      <postalcode/>
      <country/>
      <email/>
      <phone/>
      <fax/>
   </ContactInfo>
   <PartnerInfo>
   See specific structure examples for EDIFACT, HL7, RosettaNet, Tradacoms, EDI, and X12 standards. The related sample should be pasted here.
   </PartnerInfo>
   <PartnerCommunication>
      <AS2CommunicationOptions CommunicationSetting="">
         <SharedCommunicationChannel componentId="">         
         <AS2SendSettings useDefaultSettings="" authenticationType="">
            <url/>
            <sslCertificate componentId="" alias="">
               <certificate/>
            </sslCertificate>
            <clientSSLCertificate componentId="" alias="" passPhrase="">
               <certificate/>
            </clientSSLCertificate>
            <AuthSettings user="" password=""/> 
            <verifyHostname/>
         </AS2SendSettings>
         <AS2SendOptions>
            <AS2PartnerInfo>
               <as2Id/>
               <signingPublicCertificate componentId="" alias="">
                  <certificate/>
               </signingPublicCertificate>
               <encryptionPublicCertificate componentId="" alias="">
                  <certificate/>
               </encryptionPublicCertificate>
               <mdnSignaturePublicCertificate componentId="" alias="">
                  <certificate/>
               </mdnSignaturePublicCertificate>
               <clientSSLCertificate componentId="" alias="">
                  <certificate/>
               </clientSSLCertificate>
               <basicAuthEnabled/>
               <rejectDuplicateMessages/>
               <messagesToCheckForDuplicates/>
               <ListenAuthSettings user="" password=""/>
               <ListenAttachmentSettings multipleAttachments="" attachmentCache="">
                  <attachmentContentType></attachmentContentType>
               </ListenAttachmentSettings>
            </AS2PartnerInfo>
            <AS2MessageOptions encryptionAlgorithm="" dataContentType="" signingDigestAlg="" signed="" encrypted="" compressed="" multipleAttachments="" maxDocumentCount="">
               <subject/>
            </AS2MessageOptions>
            <AS2MDNOptions requestMDN="" synchronous="" signed="" useSSL="" mdnDigestAlg="" useExternalURL="">
               <externalURL></externalURL>
            </AS2MDNOptions>
         </AS2SendOptions>
         <AS2ReceiveOptions>
            <AS2MyCompanyInfo>
               <as2Id></as2Id>
               <enabledLegacySMIME></enabledLegacySMIME>
            </AS2MyCompanyInfo>
         </AS2ReceiveOptions>
      </AS2CommunicationOptions>
      <DiskCommunicationOptions CommunicationSetting="">
        <SharedCommunicationChannel componentId="">         
        <DiskGetOptions useDefaultGetOptions="" deleteAfterRead="" maxFileCount="" filterMatchType="">
            <fileFilter/>
            <getDirectory/>
         </DiskGetOptions>
         <DiskSendOptions useDefaultSendOptions="" createDirectory="" writeOption="">
            <sendDirectory/>
         </DiskSendOptions> 
      </DiskCommunicationOptions>
      <FTPCommunicationOptions CommunicationSetting="">
         <SharedCommunicationChannel componentId="">         
         <FTPSettings useDefaultSettings="" connectionMode="">
            <host/>
            <port/>
            <user/>
            <password/>
            <FTPSSLOptions useClientAuthentication="" sslmode="">
               <clientSSLCertificate alias="" passPhrase="">
                  <certificate/>
               </clientSSLCertificate>
            </FTPSSLOptions>
         </FTPSettings>
         <FTPGetOptions useDefaultGetOptions="" ftpAction="" transferType="">
            <remoteDirectory></remoteDirectory>
            <fileToMove/>
            <maxFileCount/>
         </FTPGetOptions>
         <FTPSendOptions useDefaultSendOptions="" ftpAction="" transferType="">
            <remoteDirectory/>
            <moveToDirectory/>
         </FTPSendOptions>
      </FTPCommunicationOptions>

      <SFTPCommunicationOptions CommunicationSetting="">
         <SharedCommunicationChannel componentId="">         
         <SFTPSettings useDefaultSettings="">
            <host/>
            <port/>
            <user/>
            <password/>
            <SFTPSSHOptions sshkeyauth="">
               <sshkeypath/>
               <sshkeypassword/>
            </SFTPSSHOptions>
         </SFTPSettings>
         <SFTPGetOptions useDefaultGetOptions="" ftpAction="">
            <remoteDirectory/>
            <fileToMove/>
            <maxFileCount/>
         </SFTPGetOptions>
         <SFTPSendOptions useDefaultSendOptions="" ftpAction="">
            <remoteDirectory/>
            <moveToDirectory/>
         </SFTPSendOptions>
      </SFTPCommunicationOptions>
      <MLLPCommunicationOptions>
         <MLLPSendSettings>
            <host/>
            <port/>
            <sendTimeout/>
            <receiveTimeout/>
            <maxRetry/>
            <failOnTimeout/>
            <usePersistentConnections maxPoolSize="" expireTimeout=""/>
            <useTrustedSSLCertificate trustSSLServerCertificate=""/>
            <useClientSSLAuthorization clientSSLCertificate=""/>
         </MLLPSendSettings>
      </MLLPCommunicationOptions>
   </PartnerCommunication>
   <PartnerDocumentTypes>
   See specific structure examples for EDIFACT, HL7, RosettaNet, Tradacoms, and X12 document types. The related sample should be pasted here.
   </PartnerDocumentTypes>
</TradingPartnerComponent>

EDIFACT partner information

      <EdifactPartnerInfo>
        <EdifactOptions filteracknowledgements="" acknowledgementoption="" envelopeoption="" rejectDuplicateUNB="" includeUNA="" outboundInterchangeValidation="" outboundValidationOption="">
           <elementDelimiter delimiterValue=""/>
           <segmentTerminator segmentTerminatorValue="" segmentTerminatorSpecial=""/>
           <compositeDelimiter delimiterValue="" delimiterSpecial=""/>
        </EdifactOptions>
        <EdifactControlInfo>
           <UNBControlInfo interchangeIdQual="" interchangeId="" interchangeAddress="" interchangeSubAddress="" syntaxId="" syntaxVersion="" priority="" referencePassword="" referencePasswordQualifier="" appReference="" ackRequest="" commAgreement="" testIndicator=""/>
           <UNGControlInfo useFunctionalGroups="" applicationIdQual="" applicationId=""/>
           <UNHControlInfo version="" release="" controllingAgency="" assocAssignedCode="" commonAccessRef=""/>
        </EdifactControlInfo>
     </EdifactPartnerInfo>

note

The valid outboundValidationOption field values are filterError and failAll. The default is filterError.

HL7 partner information

       <HL7PartnerInfo>
         <HL7Options filteracknowledgements="" rejectDuplicates="" acceptackoption="" appackoption="" batchoption="" outboundInterchangeValidation="" outboundValidationOption="">
            <segmentTerminator segmentTerminatorValue=""/>
            <elementDelimiter delimiterValue="" delimiterSpecial=""/>
            <compositeDelimiter delimiterValue=""/>
            <subCompositeDelimiter delimiterValue="" delimiterSpecial=""/>
         </HL7Options>
         <HL7ControlInfo>
            <MSHControlInfo>
               <Application namespaceId="" universalId="" universalIdType=""/>
               <Facility namespaceId="" universalId="" universalIdType=""/>
               <NetworkAddress namespaceId="" universalId="" universalIdType=""/>
               <ProcessingId processingId="" processingMode=""/>
            </MSHControlInfo>
         </HL7ControlInfo>
      </HL7PartnerInfo>

note

The valid outboundValidationOption field values are filterError and failAll. The default is filterError.

Odette partner information

<OdettePartnerInfo>
    <OdetteOptions filteracknowledgements="" acknowledgementoption="" envelopeoption="" rejectDuplicateUNB="" includeUNA="" outboundInterchangeValidation="" outboundValidationOption="">
       <elementDelimiter delimiterValue="" />
       <segmentTerminator segmentTerminatorValue="" />
       <compositeDelimiter delimiterValue="" />
    </OdetteOptions>
    <OdetteControlInfo>
       <OdetteUNBControlInfo interchangeIdQual="" syntaxId="" syntaxVersion="" priority="" referencePasswordQualifier="" ackRequest="" testIndicator="" />
       <OdetteUNHControlInfo version="" release="" controllingAgency="" />
    </OdetteControlInfo>
</OdettePartnerInfo>

RosettaNet partner information

<RosettaNetPartnerInfo>
    <RosettaNetOptions version="" filterSignals="" rejectDuplicateTransactions="" outboundDocumentValidation=""/> 
    <RosettaNetControlInfo partnerId="" partnerIdType="" partnerLocation="" globalPartnerClassificationCode="" globalUsageCode="" supplyChainCode="">
       <encryptionPublicCertificate componentId="" alias="">
          <certificate/>
       </encryptionPublicCertificate>
       <signingPublicCertificate/></signingPublicCertificate>
    </RosettaNetControlInfo>
    <RosettaNetMessageOptions compressed="" signed="" signatureDigestAlgorithm="" encrypted="" encryptServiceHeader="" encryptionAlgorithm="" contentTransferEncoding="" attachmentCache=""/>
</RosettaNetPartnerInfo>

note

The valid contentTransferEncoding field values are binary and base64. The default is binary.

Tradacoms partner information

 <TradacomsPartnerInfo>
    <TradacomsOptions useReconcilationMessage="" filterAcknowledgements="">
       <elementDelimiter delimiterValue=""/>
       <segmentTerminator segmentTerminatorValue=""/>
       <compositeDelimiter delimiterValue=""/>
    </TradacomsOptions>  
    <TradacomsControlInfo>
       <STXControlInfo interchangeId="" interchangeIdQualifier=""/>
    </TradacomsControlInfo>
</TradacomsPartnerInfo>

X12 partner information

   <X12PartnerInfo>
      <X12PartnerInfo>
         <X12Options filteracknowledgements="" acknowledgementoption="" envelopeoption="" rejectDuplicateInterchange="" outboundInterchangeValidation="" outboundValidationOption="">
            <elementDelimiter delimiterValue="" delimiterSpecial=""/>
            <segmentTerminator segmentTerminatorValue="" segmentTerminatorSpecial=""/>
         </X12Options>
      <X12ControlInfo>
        <ISAControlInfo interchangeIdQualifier="" securityInformationQualifier="" authorizationInformationQualifier="" componentElementSeparator="" ackrequested="" version="" interchangeId="" securityInformation="" authorizationInformation="" standardIdentification="" testindicator=""/>
        <GSControlInfo respagencycode="" applicationcode="" gsVersion=""/>	
      </X12ControlInfo>
    </X12PartnerInfo>

note

The valid outboundValidationOption field values are filterError and failAll. The default is filterError.

EDI Custom partner information

  <CustomPartnerInfo customStandardId="">
      <CustomOptions outboundMessageValidation="" rejectDuplicateMessage=""></CustomOptions>
      <CustomControlInfo messageId="" messageIdQual=""></CustomControlInfo>
  </CustomPartnerInfo>

EDIFACT partner document types

<PartnerDocumentType typeId="" profileId="" expectAckForOutbound="" validateOutboundTransactionSets="" invalidDocumentRouting="" qualifierValidation=""/>

note

The valid invalidDocumentRouting field values are documentsPath and errorsPath. The default is errorsPath.

HL7 partner document types

<PartnerDocumentType typeId="" profileId="" expectAckForOutbound="" validateOutboundTransactionSets="" qualifierValidaton=""/>

Odette partner document types

<PartnerDocumentType typeId="" expectAckForOutbound="" validateOutboundTransactionSets="" invalidDocumentRouting="" qualifierValidation="" />

RosettaNet partner document types

<PartnerDocumentType typeId="" profileId="" expectAckForOutbound="" validateOutboundTransactionSets=""/>

The typeId value corresponds to the docTypeSystemId attribute value in a RosettaNet document type XML schema. When you import a RosettaNet document type XML schema into an XML profile component in , the docTypeSystemId value appears in the Document Type System ID field on the profile’s Options tab.

Tradacoms partner document types

<PartnerDocumentType typeId="" profileId=""/>

X12 partner document types

<PartnerDocumentType typeId="" profileId="" use999Ack="" useTA1Ack="" expectAckForOutbound="" validateOutboundTransactionSets="" qualifierValidation=""/>