Create and Configure Endpoints

You can create new endpoints from the Partners or *Host page, or by using the Message Flow wizard.

Create Endpoints from the Partners Page

Use the Partners page to create new send and receive endpoints owned by partners or 3rd party connections:

  1. In the navigation menu, select Partners.

  2. Select the partner or 3rd party connection for which to create the endpoint.

  3. In the Endpoints section, click New.

  4. In the New Endpoint window Usage field, select Receive from partners or Send to partners.

  5. In the Protocol field, select the protocol to use for the endpoint.

  6. Configure the endpoint according to the endpoint type and protocol.

  7. Click Save.

Ownership of endpoints is automatically assigned based on the partner or 3rd party connection from which you are creating the endpoint.

Create Endpoints from the Host Page

Use the Host page to create new send and receive endpoints owned by the host:

  1. In the navigation menu, select the host.

  2. In the Endpoints section, click New.

  3. In the New Endpoint window Usage field, select the endpoint type:

  4. In the Protocol field, select the protocol to use for the endpoint.

  5. Configure the endpoint according to the endpoint type and protocol.

  6. Click Save.

Create Endpoints Using the Message Flow Wizard

You can use the Message Flow Wizard to create send and receive endpoints owned by hosts, partners, or 3rd party connections.

For information about using the Message Flow wizard to create new endpoints, see Create and Configure an Inbound Message Flow and Create and Configure an Outbound Message Flow.

Supported Endpoint Protocols

The configuration of Partner Manager endpoints depends on endpoint type and protocol. The following table describes the endpoint types, along with their supported protocols and owners:

Endpoint Type Protocol Can be owned by

Source at host

FTP, HTTP, HTTPS, SFTP

Host

Target at host

Receive from partners

AS2

Host

FTP, SFTP

Host, partner, 3rd party connection

Send to partners

AS2

Partner, 3rd party connection

FTP, HTTP, HTTPS, SFTP

Host, partner, 3rd party connection

Endpoint Runtime Services

Using dynamic configurations, Partner Manager deploys generic endpoint services that can receive data from or send data to different endpoint configurations. Endpoint configurations of all supported protocols can be reused across various message flows and trading partners.

Partner Managerโ€™s deployment orchestration service inspects the message flow and associated configuration objects and determines which endpoint services to deploy or update based on whether or not any new endpoint configurations are added, updated, or removed.

The number and type of endpoint services deployed to your runtime depends on the transport protocols used to exchange data with your trading partners and backend systems.

Each unique AS2 and HTTP and HTTPS receive endpoint configurations result in the deployment of their own runtime applications. You can view the Runtime application name corresponding to a given configuration in Partner Manager, from the endpoint detail page.

The endpoints for the transport protocols are always managed within a single generic endpoint service for the protocol and direction:

Endpoint Services

Protocol Direction Application Name Prefix

AS2

Receive

b2b-inbound-as2-

AS2

Send

b2b-outbound-as2-

FTP

Receive

b2b-inbound-ftp-

FTP

Send

b2b-outbound-ftp-

HTTP or HTTPS

Receive

b2b-inbound-http-

HTTP or HTTPS

Send

b2b-outbound-http-

SFTP

Receive

b2b-inbound-sftp-

SFTP

Send

b2b-outbound-sftp-

If your deployment target is CloudHub, you can assign static IP addresses to your endpoint applications connecting to external systems from Runtime Manager, if your organization or your trading partners require allowlisting IP addresses. You can share the static IP address assigned to your endpoint application with your trading partners for them to allowlist the IP address, allowing the application to connect with their server.

See Also

Was this article helpful?

๐Ÿ’™ Thanks for your feedback!

Edit on GitHub