AMQP Connection

The AMQP Connection shared resource contains all the necessary parameters that have to be configured when you use the TIBCO ActiveMatrix BusinessWorks™ Plug-in for AMQP to connect to the AMQP server. The AMQP Connection shared resource is used by all the activities in the AMQP palette.

General

The following table lists the fields in the General panel:

Field Module Property? Description
Package No The name of the package where the shared resource is added.
Name No The name to be displayed as the label for the shared resource in the process.
Description No A short description for the shared resource.

AMQP Connection Resource Configuration

The following table lists the fields in the AMQP Connection Resource Configuration panel:

Field Module Property? Description
BrokerType No Specifies the broker that is used for the connection. The following brokers are available:

  • Qpid-1-0
  • RabbitMQ-0-9
  • ActiveMQ-1-0
  • AzureSB-1-0
  • AMQ-1-0

  • ActiveMQ-Artemis-1-0

The default broker is Qpid-1-0. For information of the latest versions of the available brokers, see the Readme.

HostPort Yes Specifies the host name or IP address.
Note: This field is available only when Qpid-1-0, RabbitMQ-0-9, AMQ-1-0, ActiveMQ-1-0, or ActiveMQ-Artemis-1-0 is selected from the BrokerType list.
VirtualHost Yes Specifies the namespace for entities, such as exchanges and queues.
Note: This field is available only when Qpid-1-0 or RabbitMQ-0-9 is selected from the BrokerType list.
Username Yes Specifies the username that you use to get access to the AMQP server.
Note: This field is available only when Qpid-1-0, RabbitMQ-0-9, AMQ-1-0, ActiveMQ-1-0, or ActiveMQ-Artemis-1-0 is selected from the BrokerType list.
Password Yes Specifies the password that you use to get access to the AMQP server.
Note: This field is available only when Qpid-1-0, RabbitMQ-0-9, AMQ-1-0, ActiveMQ-1-0, or ActiveMQ-Artemis-1-0 is selected from the BrokerType list.
Client ID Yes

Set an explicit Client ID in the AMQP connection resource as a part of the connection details for the following brokers:

  • Qpid-1-0

  • AMQ-1-0

  • ActiveMQ-1-0

  • ActiveMQ-Artemis-1-0
Authentication Type Yes

The following authentication types are supported by the plug-in when AzureSB-1-0 is selected from the BrokerType list:

  • SAS
  • OAuth
  • Managed Identity

Important:
Note:

  • The plug-in supports the OAuth 2.0 authorization protocol for all the palette activities that are supported by AMQP.

  • The plug-in supports only User-Assigned Managed Identities and does not support System-Assigned Managed Identities.
Connection String Yes

Specifies the value used to connect to the Azure Service Bus broker instance.

The syntax is Endpoint=sb://<Namespace>.servicebus.windows.net/

Note: This field is available only when AzureSB-1-0 is selected from the BrokerType list.

Tenant ID Yes The unique ID of your Microsoft Azure Active Directory with which you have registered your application. This field is available only when AzureSB-1-0 is selected from the BrokerType list and the OAuth authentication is selected.

Tip: To know the Tenant ID, in Microsoft Azure, click App registrations and click Endpoints. In the fields that are displayed, the string value after the host name in the OAuth 2.0 TOKEN ENDPOINT field is known as Tenant ID. You can copy the OAuth 2.0 Token Endpoint field value by clicking the icon beside it.

Client ID Yes

The unique ID of the application that you want to connect to the AMQP server. This is application-specific and is unique for each application. This field is available only when AzureSB-1-0 is selected from the BrokerType list and the OAuth authentication is selected.

Tip: To know the Client ID in Microsoft Azure, click App registrations, and in the list of registered applications, select a specific registered application. In the application pane, the value assigned under Application ID is known as Client ID.
Client Secret Yes The password that you want to use to connect to the AMQP server. This field is available only when AzureSB-1-0 is selected from the BrokerType list and the OAuth authentication is selected. To generate a new password in Microsoft Azure, see Microsoft Azure documentation.

Note: An application can have one or more passwords that can be used as a secret key while obtaining OAuth2.0 keys.

Shared Access Key Name Yes

Specifies the name of the shared access policy created for an entity.

Note: This field is available only when AzureSB-1-0 is selected from the BrokerType list and the SAS authentication is selected.

Shared Access Key Yes

Specifies the key for Shared Access Key Name.

Note: This field is available only when AzureSB-1-0 is selected from the BrokerType list and the SAS authentication is selected.

Entity Type No

Specifies the type of the entity created. You can select an entity type from the following:

  • Queue

  • Topic

Note: This field is available only when AzureSB-1-0 is selected from the BrokerType list. The value specified for the Entity Type in the activity takes precedence over the value specified for this field.

Entity Name Yes

Specifies the name of the queue or topic entity that is existing on the server.

Note: This field is available only when AzureSB-1-0 is selected from the BrokerType list.

Entity Subscriber Name Yes Specifies the name of the subscriber that is existing on the server for the topic specified in Entity Name.

Note: This field is available only when AzureSB-1-0 is selected from the BrokerType list and Topic is selected from the Entity Type list. This field is needed only when testing connectivity to the Azure Service Bus broker by using a "Listen only" Shared Access Key.

ConnectionTimeout(msec) Yes Specifies the time period (in milliseconds) the connection remains active if no action is performed.

Note: For failover, increase the connection timeout to allow transition from one server to another server.

Session Count Yes Specifies the number of channels that are created on the server.

The default value is 1.

The minimum value is 1 and maximum value is 20.

Note: Session Count is available when RabbitMQ-0-9 is selected from the Broker Type list.

Session count works with Prefetch count property. For more information about this property, see Setting Prefetch Count for RabbitMQ Broker.

Connection Recovery No If this checkbox is selected, the connection between the plug-in and the server is automatically made if the connection is interrupted.

Note: For the RabbitMQ server, if you have given the details of a single HostPort, you need not select the Connection Recovery checkbox to achieve recovery of the connection.

In the sender activity, when the ActiveMQ server is set up in leader-follower mode, when the master server is down, for master-subordinate transition, ConnectionTimeout(msec) must be configured to a value more than 30 seconds.

Retry Interval (msec) Yes Specifies the time period (in milliseconds) between successive attempts made to establish an interrupted connection again.

The default value is 3000.

Note: This field is available when ActiveMQ-1-0, Qpid-1-0, AMQ-1-0, AzureSB-1-0, or ActiveMQ-Artemis-1-0 is selected from the BrokerType list and the Connection Recovery checkbox is selected.
Retry Attempts Yes Specifies the number of attempts allowed to establish a connection after the connection was interrupted.

The default value is 20.

Note: This field is available only when ActiveMQ-1-0, Qpid-1-0, AMQ-1-0, AzureSB-1-0, or ActiveMQ-Artemis-1-0 is selected from the BrokerType list and the Connection Recovery checkbox is selected.
NetworkRecoveryInterval(msec) Yes Specifies the time period (in milliseconds) between successive attempts made to establish an interrupted connection again.

The default value is 5000.

Note: This field is available only when RabbitMQ-0-9 is selected from the BrokerType list and the Connection Recovery checkbox is selected.
Test Connection No Click this button to validate the connection.

SSL

SSL configuration is applicable for RabbitMQ-0-9, ActiveMQ-1-0, AMQ-1-0, ActiveMQ-Artemis-1-0, and Qpid-1-0 brokers. The following fields are available in the SSL panel:

Field Module Property? Description
Confidentiality No If you want to choose an existing SSL Client shared resource or create one, select this checkbox. This shared resource contains specified SSL information for connection to an AMQP broker.

For more details, see the TIBCO ActiveMatrix BusinessWorks™ documentation.

SSL Client No Select an SSL Client shared resource to establish a connection between the plug-in and the specified AMQP broker.