This Help Center is a preview of a future release. The final Help Center will be available on the Validation date.

Configure B2B integrations

System Administrators can now configure various settings in the OPUS Platform that enable network Owners and their Partners to exchange B2B messages using the Administration solution. After creating a B2B connection, IT system administrators must create a B2B connection using AS2, SFTP, or SMTP protocols in the Extensible Transfer Help Center app. Owners can also update, search and view the details of an exchanged B2B message in the Extensible TraceLink Transfer (XTT) app. For more information about creating B2B integrations, see the Extensible TraceLink Transfer Help Center.

A B2B integration is a configured B2B gateway account that enables file exchange between a company or location on the TraceLink Network and an external system (e.g. an ERP system). Each B2B integration is uniquely identified by a username and includes the security credentials (e.g. certificates, public keys) required to establish the connection using the associated protocol.

System Administrators and B2B Integration Administrators can configure B2B settings if they are assigned the role rights to the applications they are configuring.

System Administrators can set up message settings to exchange message transactions with partners.

  1. Select the Main Menu icon.

  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Message Settings from the left menu.
  5. Select the New button.
  6. Fill in the following fields in the New Message Settings screen:
    1. Link section:
      1. Application (Owner) drop-down – Required. The applications licensed to the company and the apps for which users company has been added as a Partner.
      2. Company or Location drop-down – Required. The specific company or location for which the configuration has been added (e.g. owner company, company location, Partner company, or Partner location).
      3. Routing Transform Set drop-down – The transform sets that are linked to the inbound configuration.
    1. Link Identifier (Inbound) section:
      1. Linked Identifier field. The identifier for the company or location, in the format [App Abbreviation].[My Company ID Value], (e.g. MPC.GLN.111111111111.GLN.222222222222). Select the Add icon to add another Linked Identifier field.

    1. Message Delivery Rules (Outbound) section:

      1. Owner to Owner switch – Indicates whether the sender and the receiver both own the same app (e.g. both Kendall Phara and Watson Distributors own Multienterprise Process Connect and are linked to each others' networks).
        • Yes – (default) The sender and receiver both own the same app.
        • Not Set – This value has not been explicitly configured.
        • No – The sender and receiver do not own the same app.
      2. Delivery Option drop-down – The method of delivery for the message from the sender to the receiver.
        • No Processing – A response is sent back to the requesting app without transforming the file or attempting to deliver the file.
        • Transform Only – The B2B message transforms the outbound file and the requester responds back without any errors.
        • Transform and Deliver – The B2B message is delivered to the to XTT app for outbound delivery.
      3. Message Type drop-down – The message type for the selected app.
      4. Select the Add icon to add another Owner to Owner switch, Delivery option drop-down and Message Type drop-down.
  7. Select the Save button.

    The B2B connection is configured so that inbound and outbound messages route to the correct company or location.

Tip

  • Select the Save and New button to save the new message settings and add another.

System Administrators can set up message settings to exchange message transactions with partners.

  1. Select the Main Menu icon.

  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Message Settings from the left menu.
  5. Select the Filter button.
  6. In the Filters side panel, select any network or app from the Application(Owner) drop-down list. 

  7. Select Apply.

    The filtered results display in the table.

  8. Select the Company or Location hyperlink in the results table.

  9. View the following information in the Message Setting Details screen:
    1. Link section:
      1. Application (Owner) field – The applications licensed to the company and the apps for which users company has been added as a Partner.
      2. Company or Location field – The specific company or location for which the configuration has been added (e.g. owner company, company location, Partner company, or Partner location).
      3. Routing Transform Set field – The transform sets that are linked to the inbound configuration.
    2. Link Identifier (Inbound) section:
      1. Linked Identifier field – The identifier for the company or location, in the format [App Abbreviation].[My Company ID Value], (e.g. MPC.GLN.111111111111.GLN.222222222222). Select the Add icon to add another Linked Identifier field.

    3. Message Delivery Rules (Outbound) section:

      1. Owner to Owner field – Indicates whether the sender and the receiver both own the same app (e.g. both Kendall Phara and Watson Distributors own Multienterprise Process Connect and are linked to each others' networks).
        • Yes – (default) The sender and receiver both own the same app.
        • Not Set – This value has not been explicitly configured.
        • No – The sender and receiver do not own the same app.
      2. Delivery Option field – The method of delivery for the message from the sender to the receiver.
        • No Processing – A response is sent back to the requesting app without transforming the file or attempting to deliver the file.
        • Transform Only – The B2B message transforms the outbound file and the requester responds back without any errors.
        • Transform and Deliver – The B2B message is delivered to the to XTT app for outbound delivery.
      3. Message Type field – The message type for the selected app.

    10. Tip

    Select the Edit button to update message settings details. In the Link section, the Application(Owner) and Company or Location fields are read-only.

Create new link settings

System Administrators can add X12, EDIFACT, or IDoc location settings information to complete adding a B2B connection. System Administrators must configure an inbound or outbound message prior to adding the connection type information. For more information on the message connection types, see the Tips section.

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Link Settings from the left menu.
  5. Select the New button.
  6. Fill in the following fields in the New Link Settings screen:
    1. General section:
      1. B2B Connection drop-down – Required. The list of B2B connections created for the company in the XTT app.
      2. B2B Choreography Type field – Populated automatically based on the selected B2B Connection. The identifier type and values for the specific configuration of B2B connections, determining the format and processing rules for transactions (e.g. X12, EDIFACT, or OTHER).
      3. Linked Entity field – Required.
      4. Linked Entity Location field – Required.
      5. Company or Location ID field – Required. The identifier type and values for the specific company or location for which the configuration has been added.

  7. Select one of the following buttons:

    • Save – Creates the new link settings and opens the Search Link Settings screen.

    • Save and New – Creates the new link settings and opens a new New Link Settings screen to create another link settings configuration.

    • New – Clears the current entries and opens a New Link Settings screen.

    The new connection type is created and displayed in the results table.

Filter, view, and edit link settings

  1. Select the Main Menu icon.

  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Link Settings from the left menu.
  5. Select the Filter button.
  6. In the Filters side panel, select a B2B Connection, Linked Entity, Linked Entity Location and Company or Location ID from their respective drop-downs.

  7. Select Apply.

    The filtered results display in the table.

  8. Select the Company or Location hyperlink in the results table.

  9. View the following information in the Link Setting Details screen:
  10. View the following information:
    1. General section - Displays the B2B connection, B2B choreography type, linked entity, and company or location ID.

    2. Additional Routing Identifiers section – Displays the identifier type and associated identifier value for the B2B integration link configuration.

    3. Connection Type Information section – Displays the EDI version, syntax identifier and syntax version number, EDI interchange party value, EDI envelope party type, and population settings.

    4. OTHER (IDoc) Transaction Details section – Displays the message type, message function, and message code for the IDoc transaction.

  1.  Edit the following information in the Link Setting Details screen:
    1. General section:
      1. Company or Location ID field – Required. The identifier type and values for the specific company or location for which the configuration has been added.
    1. Additional Routing Identifiers section:
      1. Identifier Type drop-down – The type of company or location identifier used for the specific B2B integration link configuration.
      2. Identifier Value field – The identifier value associated with the selected identifier type for the specific B2B integration link configuration.
    1. Connection Type Information section:
        • EDI Version drop-down – The EDI version indicates the standards version you are using for your EDI messages. Different versions might have slight variations in how data is structured. Determine and specify the version of the X12 standard that you will be using and ensure that both trading Partners agree on the same version (e.g. common versions include 4010 and 5010).

          Valid Values

          • 001000
          • 002000
          • 002001
          • 002002
          • 002003
          • 002031
          • 002040
          • 002041
          • 002042
          • 003000
          • 003010
          • 003011
          • 003012
          • 003020
          • 003021
          • 003022
          • 003030
          • 003031
          • 003032
          • 003040
          • 003041
          • 003042
          • 003050
          • 003051
          • 003052
          • 003060
          • 003061
          • 003062
          • 003070
          • 003071
          • 003072
          • 004000
          • 004010
          • 004011
          • 004012
          • 004020
          • 004021
          • 004022
          • 004030
          • 004031
          • 004032
          • 004040
          • 004041
          • 004042
          • 004050
          • 004051
          • 004052
          • 004060
          • 004061
          • 004062
          • 005000
          • 005010
          • 005011
          • 005012
          • 005020
          • 005021
          • 005022
          • 005030
          • 005031
          • 005032
          • 005040
          • 005041
          • 005042
          • 005050
          • 005051
          • 005052
          • 006000
          • 006010
          • 006011
          • 006012
          • 006020
          • 006021
          • 006022
          • 006030
          • 006031
          • 006032
          • 006040
          • 006041
          • 006042
          • 006050
          • 006051
          • 006052
          • 007000
          • 007010
          • 007011
          • 007012
          • 007020
          • 007021
          • 007022
          • 007030
          • 007031
          • 007032
          • 007040
          • 007041
          • 007042
          • 007050
          • 007051
          • 007052
          • 007060
          • 007061
          • 007062
          • 008000
          • 008010
          • 008020
          • 008030
          • 008040
          • 008050
        • EDI Envelop Party Type drop-down – Indicates the role of the party in the EDI envelope. Specify if you what are providing is for the sender or the receiver of the EDI.

          Valid Values

          • 1
          • 2
          • 3
          • 4
          • 5
          • 6
          • 7
          • 8
          • 9
          • 10
          • 11
          • 12
          • 13
          • 14
          • 15
          • 16
          • 17
          • 18
          • 19
          • 20
          • 21
          • 22
          • 23
          • 24
          • 25
          • 26
          • 27
          • 28
          • 29
          • 30
          • 31
          • 32
          • 33
          • 34
          • 35
          • 36
          • 37
          • 38
          • AM
          • NR
          • SA
          • SN
          • ZZ
        • EDI Interchange Party Value field – These values, for both the sender and receiver, are used within the interchange envelope (ISA segment in X12) to identify the sender and receiver. They are often the same as the sender or receiver code but can also include additional qualifiers. These values ensure that the EDI interchange is correctly routed between the parties.

        • EDI Version drop-down – Indicates the standards version that you are using for your EDIFACT messages. Each version corresponds to a specific set of rules and message definitions. EDIFACT versions are released periodically and include updates and enhancements.

          Valid Values

          • D96A
          • D96B
          • D97A
          • D97B
          • D98A
          • D98B
          • D99A
          • D99B
          • D00A
          • D00B
          • D01A
          • D01B
          • D01C
          • D02A
          • D02B
          • D03A
          • D03B
          • D04A
          • D04B
          • D05A
          • D05B
          • D06A
          • D06B
          • D07A
          • D07B
          • D08A
          • D08B
          • D09A
          • D09B
          • D10A
          • D10B
          • D11A
          • D11B
          • D12A
          • D12B
          • D13A
          • D13B
          • D14A
          • D14B
          • D15A
          • D15B
          • D16A
          • D16B
          • D17A
          • D17B
          • D18A
          • D18B
          • D19A
          • D19B
          • D20A
          • D20B
          • D21A
        • Syntax Identifier drop-down – Required. Identifies the syntax and version of the EDIFACT syntax rules being used. It ensures that the receiving system understands the syntax format of the message. For EDIFACT, the syntax identifier usually appears in the UNB segment:
        • Syntax Version Number drop-down – Required. Indicates the version of the syntax rules that the message adheres to. This helps the receiving system to parse the message correctly according to the specific version of the syntax being used: 

        Valid Values

        • 1
        • 2
        • 3

        • EDI Envelop Party Type field – The EDI envelop party type indicates the role of the party involved in the EDI communication (e.g UNB.2.1: Interchange sender, UNB.3.1: Interchange recipient).

          Valid Values

          • 1
          • 4
          • 5
          • 8
          • 9
          • 12
          • 14
          • 18
          • 22
          • 18
          • 30
          • 31
          • 33
          • 34
          • 51
          • 52
          • 53
          • 54
          • 57
          • 58
          • 59
          • 61
          • 63
          • 65
          • 80
          • 82
          • 84
          • 85
          • 86
          • 87
          • 89
          • 90
          • 91
          • 92
          • 103
          • 128
          • 129
          • 144
          • 145
          • 146
          • 147
          • 148
          • 500
          • 501
          • 502
          • Z01
          • ZZZ
          • UNOA
          • UNOB
          • UNOC
          • UNOD
          • UNOE
          • UNOF
        • EDI Interchange Party Value field – The EDI Envelope Party Value is the identifier of the party involved in the EDI interchange. This value uniquely identifies the sender or recipient of the message and is used for routing and processing purposes.
        • Populated switch – Populated in the context of EDIFACT typically means that the specific field has been filled with the required data. If a field is not populated, it has been left empty. The values are:
          • Yes – The specific EDIFACT fields are filled with the required data.
          • No – The specific EDIFACT fields are not filled with the required data.
        • Service String Advice Populated switch – Indicates whether the UNA segment is included in the message to define the delimiters used in the interchange.
          • Yes – The UNA segment is included in the message to define the delimiters used in the interchange.
          • No – The UNA segment is not included in the message to define the delimiters used in the interchange.
        • Sender Port field – A unique identifier that defines the source of the IDoc. It indicates if the system or app from which the IDoc is being sent. The sender port is specified in the Partner profiles in SAP and helps in identifying and routing the IDoc correctly.
        • Partner Number field – Identifies the business Partner involved in the IDoc exchange. It can represent a customer, vendor, or any other entity that is part of the business process. The partner number is used to distinguish different Partners and is necessary to ensure that the IDoc reaches the correct recipient.

        • Partner Function field – Indicates the role of the Partner in the IDoc message. Each Partner function defines the specific role and responsibilities of the Partner within the context of the business transaction:

          • LI – Vendor
          • AG – Ordering party

          • RE – Payee

          • WE – Goods recipient

        • Partner Type field – Indicates the type of business Partner involved in the IDoc exchange. The partner type helps in determining the nature of the Partner and the type of data exchange:

          • KU – Customer
          • LI – Vendor
          • LS – Logical system is used for internal SAP system communications.

          • AG – Agent

          • LF – Delivery
        • Client Number field – A unique identifier for the client within the SAP system. In SAP, a client is an independent business unit with its own data and configuration. The client number helps in ensuring that the IDoc is processed within the correct client environment.
        • Receiver Port field – A unique identifier that defines the destination of the IDoc. It identifies the system or app to which the IDoc is being sent. The receiver port is specified in the Partner profiles and is crucial for routing the IDoc to the correct destination.
    2. Select the Add icon in the OTHER (IDoc) Transaction Details section. This section appears only when CA-OTHER is selected in the B2B Connection field:
      1. Message Type field. Indicates the type of IDoc message being sent.
      2. Message Function field. Specifies the purpose of the message.
      3. Message Code field. A unique identifier that defines the type of IDoc message being processed. It helps categorize the transaction and ensures it is handled according to the correct processing rules.
      4. Select Apply.

        5. The new transaction settings are added in the OTHER (IDoc) Transaction Details table.

    3. Select Save.

      The new link setting details are updated.

    2. Tips

      • X12 is a standard developed by the American National Standards Institute (ANSI) for electronic data interchange (EDI). It is primarily used in North America to facilitate the automated exchange of business documents between different computer systems, particularly in industries such as healthcare, supply chain management, finance, and government.

      • EDIFACT is an international standard developed by the United Nations for the electronic exchange of business documents between different systems and organizations. It is widely used in global trade to facilitate the seamless exchange of structured data, reducing the need for manual intervention and improving the efficiency of business transactions.

      • IDoc is a standard data structure used in SAP applications for exchanging information between systems. It is primarily used in SAP's EDI (Electronic Data Interchange) processes and ALE (Application Link Enabling) scenarios.

      • In the Add Routing Identifiers and OTHER (IDoc) Transaction Details sections, select Add or Remove icon to add or remove entries.

      • In the OTHER (IDoc) Transaction Details sections, select an entry and select Edit icon modify it.

Create and enable transform sets

System Administrators can create a transform set which is a collection of transforms that can be used to send or receive different B2B messages. A transform is a map used to convert data from one format to another (e.g. CSV file to JSON file). A company can have one or multiple transform sets and each set can have many B2B message type collections such as purchase orders, invoices, etc.

Once a transform set is created, it can be associated with a B2B connection, a company, or an internal location of the company. After a System Administrator associates a transform set to a B2B connection, all the messages flowing from the specific B2B connection use this transform set. A company can have multiple B2B connections and use different transform sets for those connections.

  • If a transform set is associated at the company level, all the messages being exchanged use the same transform set regardless of the location.
  • If a transform set is associated at the location level, all the messages being exchanged from that internal location use the same transform set.

System Administrators can create a transform set, which is a collection of maps used to convert data from one format to another (e.g. CSV file to JSON file).

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Transform Sets from the left menu.
  5. Select the New button.
  6. Fill in the following fields in the General section:
    1. Transform Set Name field – The unique name for the new transform set.
  7.  Select the Add icon in the Transforms section. In the Add Transforms side panel that opens, fill in the following fields:
    • Application drop-down – The app that is licensed to the company.
    • Message Type drop-down – The type of B2B message defined in the app.

    • Direction drop-down – The direction of the message.

      • Inbound – A B2B message that TraceLink receives from outside of the organization.
      • Outbound – A B2B message that TraceLink sends outside of the organization.

    • Catalog drop-down – The type of transform that has been associated to this transform set.

      • Private – The private transform catalog for a specific company.
      • Public – The transform catalog is available to all companies and Partners.
    • Transform drop-down – The name of the transform that is being mapped to the new transform set.
    • Transform Version field – The version of the transform that is associated to the B2B message. By default, the transform version is 1.
  8. Select Apply.

    The new transform set is added in the Transforms table.

  9. Select the Add icon to add another transforms.

  10. Select Save.

    The new transform set is created.

Tips

  • Select the Save and New button to save the new transform set and add another.

  • Select the New button to add another new transform set.

  • Updating a transform set has no impact on the transform set association.

Once a transform set is added, a System Administrator can associate it with a B2B integration, a company, or an internal location of the company. Then, all the messages flowing from the specific B2B integration use this transform set. A company can have multiple B2B connections and use different transform sets for those connections. If a transform set is associated at the company level, all the messages being exchanged use the same transform set regardless of the location. If a transform set is associated at the location level, all the messages being exchanged from that internal location use the same transform set.

A transform set must be created prior to associating the transform set with a B2B connection, a company, or a company location.

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Transform Sets from the left menu.

  5. Select the transform set hyperlink that you want to enable.

  6. Select the Edit button to associate the transform set.

  7.  Select the Add icon in the Transforms section. In the Add Transforms side panel that opens, fill in the following fields:
    • Application drop-down – The app that is licensed to the company.
    • Message Type drop-down – The type of B2B message defined in the app.

    • Direction drop-down – The direction of the message.

      • Inbound – A B2B message that TraceLink receives from outside of the organization.
      • Outbound – A B2B message that TraceLink sends outside of the organization.

    • Catalog drop-down – The type of transform that has been associated to this transform set.

      • Private – The private transform catalog for a specific company.
      • Public – The transform catalog is available to all companies and Partners.
    • Transform Name drop-down – The name of the transform that is being mapped to the new transform set.
    • Transform Version field – The version of the transform that is associated to the B2B message. By default, the transform version is 1.
  8. Select Apply.

    The new transform set is added in the Transforms table.

  9. In the Associate with section, select an Association Type from the drop-down list to associate the transform set with the selected entity.

    • Company – The specific location is associated with your company.
    • B2B Connections – The transform set is associated with a B2B connection type defined in the app.
    • Linked Entity – The transform set is associated with the direction of the message.
    • No Association –The transform set is not associated with any entity.
  10. Select Save.

    The transform set is associated with the selected entity.

Tips

  • In the Transforms table, select an entry and select Remove all Associations button, and then select Apply in the right panel to remove all associations from the transform set. You must remove each association individually.

  • Updating the transform set association has no impact on the transform set.

If you add a transform set with no associations, then it will not appear on this Filter and View screen.

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Transform Sets from the left menu.
  5. Fill in the required Name field, which is the unique name for the new transform set, to filter the results.
  6. Select Apply.

The results display in the table.

  • Name field – The unique name for the new transform set.
  • Application – The app that is licensed to the company.
  • Message Type – The B2B message type that the application has registered with.
  • Direction – The direction of the message.
  • Catalog – The type of transform that has been associated to this transform set.
  • Transform Name – The name of the transform that is being mapped to the new transform set.
  • Transform Version – The version of the transform that is associated to the B2B message. By default, the transform version is 1.

Tip

  • In the Transforms table, select an entry and select Remove all Associations button, and then select Apply in the right panel to remove all associations from the transform set. You must remove each association individually.

Inbound Connection Rules

Inbound Connection Rules allow users to associate B2B connections with a company or location for inbound message processing. Users can view and update the company or location associated with an existing inbound B2B connection.

A B2B connection must be created before it can be associated with a company or internal location for inbound messages.

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Inbound Connection Rules from the left menu.

  5. View the following information in the Connection Details table on the Inbound Connection Rules screen:

    • B2B Connection – Displays the B2B connection associated with the inbound connection rule.

    • Company or Location – Displays the company or location associated with the selected B2B connection.

  6. Select a connection in the Connection Details table and select the Edit icon.

    1. In the side panel, select a Company or Location from the drop-down list.

    2. Select Apply.

      The selected company or location is updated in the Connection Details table.

  7. Select the Save button.

    The Inbound connection rule is updated and displayed in the results table.

Outbound Connection Rules

Outbound Connection Rules allow users to configure the default B2B connections used for outbound message processing. Users can define default B2B connections for the company and locations, and configure override settings for specific company or location, application, and message type combinations.

A B2B connection must be created before it can be associated with a company, internal location, application, and message type for outbound messages.

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Outbound Connection Rules from the left menu.

  5. View the following information on the Outbound Connection Rules screen:

    • Default Connection for Company section – Displays the default B2B connection configured for the company.

    • Default Connections for Locations section – Displays the locations and their associated default B2B connections.

    • Override Default Settings section – Displays the company or location overrides configured for specific applications, message types, and B2B connections.

  6. Select the Edit button.

  7. Fill the following information in the Default Connection for Company section.

    • B2B Connection Name drop-down. Select the default B2B connection for the company.

  8. In the Default Connections for Locations section, select the Add icon.

  9. In the side panel, fill in the following information:

    • Location drop-down - Required. The location associated with the default outbound B2B connection.
    • B2B Connection drop-down - Required. The default B2B connection used for outbound messages from the selected location.

  10. Select Apply.

    11. The location connection is added to the Default Connections for Locations table.

  11. In the Override Default Settings section, select the Add icon.

  12. In the side panel, fill in the following information:

    • Company or Location drop-down - Required. The company or location for which the default outbound connection is overridden.
    • Application drop-down - The application associated with the override default setting.
    • Message Type drop-down - The message type associated with the override default setting.
    • B2B Connection drop-down - Required. The B2B connection used for the selected override default setting.

    Each override and default settings must be unique for the selected company or location and application or message type combination.

  13. Select Apply.

    14. The override default setting is added to the Override Default Settings table.

  14. Select the Save button.

    The updated outbound connection rules are saved.

Tip

  • In the Default Connections for Locations and Override Default Settings tables, select an entry and select the Edit or Remove icon to edit or delete the selected connection.

Create Integration Principals

An integration principal allows multiple users to send and receive B2B messages between TraceLink apps without requiring each user to be a member of both the sending and receiving apps. A system integration principal is created by default to support immediate app-to-app communication. This system-generated principal cannot be modified or deactivated by System Administrators. However, System Administrators can create new integration principals if needed. For example, to support specific routing logic or to manage credentials separately.

The integration principal enables multiple users to send and receive B2B messages from one app to another without needing each individual user to be a member of both the sending and receiving apps.

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Integration Principals from the left menu.
  5. Select the New button.
  6. Fill in the following field in the General section:
    • Integration Principal Name field – Required. The unique user name for the Integration Principal user. If the name already exists for the company, an error will display while adding the user.
  7. In the Integration Access section, select the Add icon. In the Add Integration Access side panel that opens, fill in the following fields:
    1. Application drop-down – The applications licensed to the company and the apps for which users company has been added as a Partner.
    2. Network drop-down – The networks that are created for the selected multienterprise app. If the selected app does not support network creation, this field will be empty. For single network apps, only the networks available for that app are visible.
    3. Roles drop-down – The roles that are available based on the selected app and network.
    4. Select Apply.

      5. The new integration access entry appears in the Integration Access table.

    5. Select the Add icon to add another Application, Network, and Roles fields.

  8. Select the Save button.

    The new integration principal is created.

Tips

  • Select the Save and New button to save the new integration principal and add another.

  • Select the New button to add another new integration principal.

  • In the Integration Access table, select an entry and select the Remove icon to delete the integration access.

  • In the Integration Access table, select an entry and select the Edit icon to edit the integration access.

System Administrators can view and edit an integration principal to manage its integration access, generate API keys, and update API key status.

  1. Select the Main Menu icon.
  2. Select Administration in the main menu.
  3. Select B2B Integration from the left menu.
  4. Select Integration Principals from the left menu.
  5. Select the Integration Principal Name hyperlink from the results table.

    The Integration Principal Details screen displays.

  6. View the following information on the Integration Principal Details screen:

    • General section – Displays the integration principal details.

    • Integration Access section – Displays the applications, networks, and roles assigned to the integration principal.

    • API Keys section – Displays the API keys associated with the integration principal.

  7. Select the Edit button.

  8. In the Integration Access section, select the Add icon. In the Add Integration Access side panel that opens, fill in the following fields:

    • Application drop-down – The applications licensed to the company and the apps for which users company has been added as a Partner.
    • Network drop-down – The networks that are created for the selected multienterprise app. If the selected app does not support network creation, this field will be empty. For single network apps, only the networks available for that app are visible.
    • Roles drop-down – The roles that are available based on the selected app and network.
    • Select Apply.

      • The new integration access entry appears in the Integration Access table.

    • Select the Add icon to add another Application, Network, and Roles fields.

  9. To generate an API key:

    • Select the Generate API Key icon.

    • In the Generate API Key side panel that opens, select Apply.

      • A new API key is generated and added to the API Keys table.

      The private key is displayed for 5 minutes after it is generated. Copy and securely store the private key before it expires. After 5 minutes, the private key is no longer visible and cannot be retrieved. To obtain a new private key, generate a new API key.

  1. To update an API key status:

    • In the API Keys table, select an API key and select the Edit icon.

    • In the Edit API Key side panel that opens, select a status from the Status drop-down list.

    • Select Apply.

      • The API key status is updated in the API Keys table.

  2. Select the Save button.

    The integration principal details are updated.

System Administrators can activate an integration principal to enable secure system-to-system communication with integration specific access to an app or network they are assigned.

  1. Select Administration in the main menu.
  2. Select B2B Integration from the left menu.
  3. Select Integration Principals from the left menu.
  4. In the Search Integration Principals screen, select an entry and select the Update Status button.
  5. In the Activate/Deactivate Integration Principal side panel, open the User Status drop-down.
  6. Select Activate or Deactivate to change the integration principal's status.
  7. Select Apply.

    8. The updated status of the integration principal appears in the table.