Set up Partners

Tip

Summary: This chapter provides instructions on how to set up a partner card to exchange messages with other parties. It covers different transport types such as None, Company, Web Service, Azure Storage, and Custom.

If you want to have a place with which information (Messages) are to be exchanged, you must set up a partner card.

To create a partner card

  • How do I create a partner card?
  • What are the options for transmitting messages?
  • What are the details for the Transport Type - None?
  • What are the details for the Transport Type - Company?
  • What are the details for the Transport Type - Web Service?
  • What are the details for the Transport Type - Azure Storage?
  • What are the details for the Transport Type - Custom?
Tip

Summary: This chapter provides instructions on how to set up a partner card in the COSMO Data Integration Framework, including details on the available options for message transmission and authentication.

  1. Choose the Lightbulb that opens the Tell Me feature icon, enter Partners - Data Integration Framework, and then choose the related link.
  2. Choose the New action.
  3. On the Partner Card page, fill in the fields as necessary. Hover over a field to read a short description.

Options to transmit messages

  • What options are available for transmitting messages?
  • How do I create a partner card?
  • What is the Transport Type - None?
  • What is the Transport Type - Company?
  • What is the Transport Type - Web Service?
  • What is Basic Auth?
  • What is OAuth?
  • What is the Transport Type - Azure Storage?
  • What is the Transport Type - Custom?
Tip

Summary: The Options to transmit messages chapter of the Partner Card documentation explains the different ways messages can be transmitted after a Mapping is processed, such as None, Company, Web Service, Azure Storage and Custom.

After running a Mapping for one Partner, all related sent messages are mailed according to the Transport Type. The options for transmitting messages are:

  • None – No messages are mailed but the Status is set to Sent after the Mapping is processed.
  • Company – Messages are transported to the received messages box of the company indicated in the Company Name field.
  • Web Service – Messages are transported via SOAP Web Service to another company.
  • Azure Storage – Messages or repositories are stored in a Azure storage account.
  • Custom - Implement the AL interface CCS DIS Partner Transport

Transport Type - None

  • What is the transport type "None"?
  • What is a frequently used scenario for transport type "None"?

The transport type None does not mail the messages after processing. This allows Partners to collect Record Pools without transporting records to any temporary location. A frequently used scenario is Record Pool logging for direct mapping export.

Transport Type - Company

  • What is the transport type 'Company'?
  • What is the status of the received messages when using this transport type?
  • Is it possible to define the own company as the target company when using this transport type?
  • What is the COSMO Data Integration Framework Intercompany extension?
Tip

Summary: The transport type "Company" allows messages to be sent to another Microsoft Dynamics 365 Business Central database. It requires the COSMO Data Integration Framework Intercompany extension and the received messages will be of status Imported in the target company. It is also possible to define the own company as target company.

The transport type Company is set by default and will send the message(s) to another company in the same Microsoft Dynamics 365 Business Central database.

The received message(s) will be of status Imported in the target company. They must be read to identify the Sender Code and the processed Mapping, and processed inside the target company. For more information about the flow, see Partner Mapping.

It is possible to define the own company as target company. This enables, for example, a better logging routine for the processing of records through Mappings.

Caution

This option requires the COSMO Data Integration Framework Intercompany extension.

Transport Type - Web Service

  • How do I set up partners?
  • How do I create a partner card?
  • What are the options to transmit messages?
  • What is the Transport Type - None?
  • What is the Transport Type - Company?
  • What is the Transport Type - Web Service?
  • What is Basic Auth?
  • What is OAuth?
  • What is the Transport Type - Azure Storage?
  • What is the Transport Type - Custom?
Tip

Summary: The transport type Web Service can be used to send messages from one company to another, provided that the target company has the COSMO Data Integration Framework app installed and the COSMO Data Integration Framework Intercompany extension enabled. To authenticate on the target database, COSMO Data Integration Framework offers two types of authentication: Basic and OAuth. The necessary details for these authentication types must be entered in the Partner Card of the sender company.

The transport type Web Service will send the message(s) via SOAP Web Service to another company, which must have COSMO Data Integration Framework app installed as well.

Caution

This option requires the COSMO Data Integration Framework Intercompany extension.

To do this, the Codeunit 5100906 (CCS DIS Partner Comm. Mgt.) must first be published as a web service in the target company. To publish the codeunit, choose the Lightbulb that opens the Tell Me feature icon, enter Web Services, and then choose the related link. Choose the New action to create a new line. Enter the following values:

  • Object Type = Codeunit
  • Object ID = 5100906 (CCS DIS Partner Comm. Mgt.)
  • Service Name = DataIntegrationSuite - The value must be exactly as indicated, because this is part of a fixed namespace.
  • Published = true - This will create the SOAP URL for the sender company.

This SOAP URL must be entered manually in the Web Service URL field on the Partner Card of the sender company. Similar to Transport Type = Company, the received message is created, however not processed on the receiving company. For more information about the flow, see Partner Mapping.

Important

The Service Name must be DataIntegrationSuite, not DataIntegrationFramework or any other value. Double-check if you have issues with sending a message.

For Transport Type = Web Service, the receiving company must enable SOAP in the Microsoft Dynamics 365 Business Central Server administration by selecting SOAP > Enabled = Yes. This feature is activated for SaaS environments by Microsoft.

To authenticate on the target database, COSMO Data Integration Framework offers two types of authentication:

  • Basic - This type is mostly used for OnPrem target environments.
  • OAuth - This type is mostly used for SaaS target environments.

Basic Auth

For basic authentication, choose Web Service Authentication = Basic on the Partner Card in the sender company. Further, set Credential Type = NAVUserPassword on the General tab in the Microsoft Dynamics 365 Business Central Server administration for the target company. This feature is no longer activated for (Production) SaaS environments by Microsoft.

To access the web service with basic authentication, create a Web Service Access Key for the (service) user in the target company in Business Central. On the Users page, select the appropriate user, and then select the Web Service Access Key field in the Web Service Access section. Enter the credentials in the Basic Auth. Username and Basic Auth. Password fields on the Partner Card in the sender company.

Important

This type of authentication is deprecated in Microsoft SaaS environments. It may be used in Sandboxes but is unsupported in Production. For more information, see Microsoft documentation.

OAuth

For SaaS environments use OAuth by OAuth Applications. Choose Web Service Authentication = OAuth on the Partner Card in the sender company and select the OAuth Application Code. For more information about how to create authentication with Business Central, see OAuth Applications.

Transport Type - Azure Storage

  • What is the transport type for Azure Storage?
  • What are the fields needed to connect to an Azure storage?
  • What are the options for the File Repository Type?
  • What is the difference between Message, XML Repository, and JSON Repository?
Tip

Summary: The transport type Azure Storage allows messages to be sent to and received from an Azure storage account. Depending on the Storage Type chosen, the File Share Name or BLOB Container Name must be provided, as well as the Storage Account Name and Storage Account SAS. The File Relative Path indicates where the files will be sent to or received from. Additionally, the File Repository Type can be selected, offering the options of Message, XML Repository, and JSON Repository.

The transport type Azure Storage sends the message(s) to an Azure storage. The types File Share and BLOB Container are supported in the Storage Type field. Accordingly, the File Share Name or BLOB Container Name fields must refer the name of the service. The Storage Account Name and Storage Account SAS fields define the connection information and authorization to the storage account. The File Relative Path indicates the path where the files will be send to or received from. For the Storage Type = File Share the folder must exist in advance.

The File Repository Type field offers the following options:

  • Message - The full message, including a message envelope and all repositories, will be exported or imported.
  • XML Repository - Only the XML repository will be exported. On import a message envelope will be created on runtime for internal processing.
  • JSON Repository - Only the JSON repository will be exported. On import a message envelope will be created on runtime for internal processing.

Use the XML Repository and JSON Repository types to directly send and receive files without any additional message XML envelope surrounding the repositories. However, this means that a separate folder must be set up for each mapping to identify the correct mappings on import.

Transport Type - Custom

Tip

Summary: This chapter covers the customization of the COSMO Data Integration Framework's Partner Card to create custom transport handling. It introduces the AL enumeration CCS DIS Partner Transport Type and the interface CCS DIS Partner Transport, and provides a link to the Extensibility Demos for further information.

The AL enumeration CCS DIS Partner Transport Type can be extended to create custom transport handling. The customization should implement the interface CCS DIS Partner Transport to handle the Send() and Receive() events for a partner transport. For more information, including an example of how to extend the objects, see the Extensibility Demos - Partner Transport Type.

See Also

Export and Import Partners
OAuth Applications

Feedback

Submit feedback for this page .