Working with webMethods.io B2B connector

Knowledge base
,
1

Working with webMethods.io B2B connector

Introduction

    This article explains about Message Processing and supported operations in Webmethods.io B2B.

Audience

     It is assumed that readers of this article know how to setup B2B enterprise profile and partner on Webmethods.io B2B platform.

Prerequisite

  • Understanding of Webmethods.io B2B.

Why B2B

  • The webMethods.io B2B is Software AG’s secure, format-neutral, business-document gateway
  • It recognizes and processes documents that are exchanged between partners
  • It does not require that all partners in the network use webMethods.io B2B or Software AG software.

         

B2B Supported Operations

  • B2B application available in FlowService provides multiple operations.
  • B2B application is setup using account.
  • Each operation is associated with a B2B account.
  • These operations are used for different purposes.

Operations and its Details

          ChangeUserStatus

  • This operation is used to update the userStatus of the transaction based on TransactionID.

Input Parameters:

  •    TransactionID
  •    userStatus

              

               

Output Parameters:

  •   isUpdated

                  

Generate Response

  • Generates the response for processing rule action.
  • InputContent should be mapped with an appropriate response, as input cannot be null.
  • Generated response is sent back to B2B in case of synchronous mode.
  • In async and reliable mode response is not sent back to B2B.

 

Input Parameters:

  •  inputContent
  •  readContentAs
  • ContentType
  • Errorcode
  • ErrorMessage
  • encoding

    

           

           

Output Parameters:

  • Content
  • Type
  • Encoding
  • Errorcode
  • ErrorMessage

                 

        GetAddresses

  • This operation is used to retrieve all addresses of a partner based on PartnerID

Input Parameters:

  • PartnerID

             

        

Output Parameters:

  • Array of Address

         

          GetContacts

  • This operation is used to retrieve all contacts of a partner based on PartnerID.

Input Parameters:

  • PartnerID

           

 

Output Parameters:

  • Array of Contact.

 

        GetCorporation

  • This operation is used to retrieve corporate information of a partner based on partnerID.

Input Parameters:

  • PartnerID

        

         

Output Parameters:

  • CorporationName
  • OrgUnitName
  • Status
  • IsEnterprise
  • partnerID

       

         GetExternalFields

  • Retrieves a set of extended fields for a partner.
  • This operation is use to retrieve the data on the basis of partnerID and GroupName. GroupName can be CorporationName, ExternalID or any custom field

Input Parameters:

  • GroupName
  • partnerID

                

            

Output Parameters:

          Groups

  • Name
  • ID
  • Fields
  • Name
  • Value

             

            GetpartnerIdentities

  • This operation is used to retrieve all external IDs of a partner based on partnerID.

      Input Parameters:

  • PartnerID

          

       

Output Parameters:

  • Array of identity

               

463×551 55.2 KB

        

           Log

  • Adds an entry into the activity log.

 

Input Parameters:

  • Type
  • Category
  • Message
  • Details
  • TransactionID
  • partnerID
  • Content
  • readContentAs
  • encoding

     

          

Output Parameters:

  • success

            

    

          ParseContent

  • ParseContent operation is required when the message is sent from B2B and it needs to be processed further.
  • Parse the requested content as byte array or string, passed as part of a processing rule action using an integration.
  • In this case, bytes are received from B2B, and when the bytes are parsed XML is obtained.

         

Input Parameters:

  • inputContent
  • LoadContentAs
  • encoding

           

             

         

Output Parameters:

  • outputContent

     

  • Screenshot above shows the parse content of B2B.

          

        QueryMorePartners

  • Loops over the data cached from the queryPartners operation and returns the batchSize of data.

Input Parameters:

  • queryLocator

             

       

Output Parameters:

  • queryLocator
  • Done
  • Size

       QueryPartner

  • Creates a query for partner profiles and returns the first batch of matching results.
  • This operation is used to get the details of partner\enterprise profile based on CorporationName, OrgUnitName or status.
  • It will also provide the option to get the result in sorted manner on the basis of CorporationName, OrgUnitName or status.

Input Parameters:

  • BatchSize
  • isQuery
  • Array of Fields
  • fieldname
  • isQuery
  • Array of filed criteria
  • Operator
  • Value
  • Sort Order
  • FieldName
  • OrderDirection

           

           

Output Parameters:

  • queryLocator
  • Done
  • Size

           

        ResetQueryPartners

  • This operation is used to reset the queryLocator making it available for the next concurrent execution.

Input Parameters:

  • queryLocator

Output Parameters:

  • Status

        Submit

  • This operation is required to submit the message from FlowService to B2B.

Input Parameters:

  • inputContent
  • readContentAs
  • ContentType
  • encoding

          

         

Output Parameters:

Transactions

  • TransactionID
  • SenderID
  • ReceiverID
  • DocumentTypeID
  • userStatus
  • transactionStatus
  • CustomAttributes