Endpoint Names

An Endpoint, in general, represents one end of a communication channel. In Connect, an Endpoint type indicates the type of communication such as queue, webhook, directory, and so forth. An Endpoint name always has only one Endpoint type. An Endpoint name belongs to only one tenant.

The Endpoint Names (CENDPNT) page displays a list of Endpoint Names for the current Tenant ID. This page also allows the user to create, edit, and view an Endpoint Name for the current Tenant ID.

Connect supports the following Endpoint types:

  • queue-jms: This Endpoint type represents JMS queues hosted in Connect internal Artemis queue server.

  • queue-broker: This Endpoint type represents JMS queues hosted in an external queue broker that supports AMQP based connections.

  • directory: This Endpoint type represents directories that are directly accessible to Connect.

  • sftp: This Endpoint type represents a SFTP Server and its associated polling directory.

  • webhook: This Endpoint type represents Webhook, which supports HTTP POST.

  • adv-event-table: This Endpoint represents Advantage Event table.

Every Endpoint type has one or more properties that serve as a template of properties. When an Endpoint name is created, endpoint properties are also created based on its endpoint type properties. Once an endpoint name has been created, its Endpoint type cannot be changed. An Endpoint Name’s property values provides details such as queue name, webhook URL, queue broker host name, and credentials, depending on the type of endpoint.

Connect uses Endpoint names for two purposes:

  • External Listeners – External Listeners are technical connectors that are used by Gateway IN to receive messages, events, or files. Each External Listener has an associated endpoint name.

  • ER Delivery Subscription – Event/Response Delivery subscription is used by Gateway OUT to send service responses and event notifications to endpoints. Each ER Delivery Subscription may have one or more endpoint names.

Note that Endpoint configuration is not required for using Rest APIs hosted in Connect.

Please refer to the CGI Advantage Connect - Configuration & Management Guide for more information on this page.