Configuring Your Event Broker Service as a Source or Target

You must configure the connection details between your Micro-Integration and event broker service. Most of the connection details are the same for both source and target Micro-Integrations, but you configure them at different points in the stepper. You configure Event broker service connection details in:

  • the Source Connection step for a target Micro-Integration

  • the Target Connection step for a source Micro-Integration

To configure the connection details for your event broker service, see Event Broker Service Connection Parameters

In addition, you must define at least one Micro-Integration Flow that specifies:

Event Broker Service Connection Parameters

The following table describes the parameters for the event broker service connection details for your Micro-Integration:

Field Description
Event Broker Service Select the name of the event broker service.
Host The host URI (<protocol>://<hostname>:<SMF-port>) of the event broker, such as tcps://myhost:55443. You can specify over TCP or SSL over TCP. If you don't specify a protocol, TCP is used by default.
Message VPN The name of the Message VPN to connect to on the event broker service.
Authentication Scheme

The method to use for authenticating with the event broker service. Choose one of:

 
Trust Store Parameters

Trust store settings allow you to configure SSL/TLS certificate validation when:

  • Your event broker service uses a custom hostname with SSL certificates signed by a private or corporate certificate authority (CA)

  • The CA is not included in the standard Java trust store

  • You receive certificate validation errors

  • Your organization requires specific certificate validation policies

You can configure a custom trust store with any authentication method. For more information, see Trust Store Parameters.
Sub Ack Window Size The size of the subscription acknowledgment window (only for an event broker service as a source ).

Trust Store Parameters

The following table describes the parameters for configuring a custom trust store:

Field Description
Trust Store File Upload or drag-and-drop a file that contains the trusted CA certificates or custom root/intermediate certificate of a custom trust chain.
Trust Store File Format The trust store file format. Defaults to Java Key Store (JKS).
Trust Store File Password The trust store file password.
Trusted Common Names A comma-separated list of common names (CNs) to trust.
Validate Certificate (recommended) Select this option to validate the server certificate against the certificates in the trust store.
Validate Certificate Date (recommended) Select this option to validate the server certificate's expiry date.
Validate Certificate Host (recommended) Select this option to validate the hostname against server certificate's common name or subject alternative names (SANs).

Basic Authentication Parameters

The following table describes the parameters for configuring basic authentication:

Field Description
Client Username The username to authenticate with the event broker service to establish a messaging connection.
Client Password The password to authenticate with the event broker service to establish a messaging connection.

Client Certificate Authentication Parameters

The following table describes the parameters for configuring client certificate authentication:

Field Definition
Client Username

(Optional) Enter a username. If a username is not provided, the Micro-Integration will get the username from the client certificate.

This is typically used in conjunction with the client certificate to identify the user. It may be part of the certificate’s subject field or used separately in the application layer for additional authentication.
Key Store File

Upload or drag-and-drop a key store file containing the client certificate and private key.
Key Store Format

The key store format, either JKS (Java KeyStore) or PKCS12.

For information about creating key stores, see the OpenSSL documentation.
Key Store Password

The key store file password.

This password protects the key store itself. It is required to access the contents of the key store, including the private key and certificate.
Client Private Key Alias

Enter the private key alias name used to identify the client certificate in the key store.

This is an identifier used within the key store to reference the specific private key and certificate pair. It allows the client to select the correct key and certificate when multiple pairs are stored in the key store.
Client Private Key Password

Enter the private key password.

This password protects the private key within the key store. It is required to decrypt and use the private key for creating digital signatures during the authentication process.

OAuth2 Authentication Parameters

The following table describes the parameters for configuring OAuth2 authentication:

Field Definition
Token URI The token endpoint  where the Micro-Integration exchanges an authorization code for an access token that grants authenticated access to protected resources.
Client ID A unique alphanumeric string assigned to your application by the OAuth authorization server.
Client Secret The confidential password or key known only to the application and the OAuth authorization server, used to authenticate the application's identity when requesting access tokens.
Client Scopes Enter scopes to limit the resources and actions the Micro-Integration can access on the event broker service.
Client Name The client name is a label used to identify an application registered with your authorization server.

Micro-Integration Flow Parameters

You must configure the endpoint parameters for each Flow. Each Flow can have different settings, but they share the connection details of the parent Micro-Integration.

Event Broker Service Source Parameters

The following table describes the endpoint parameters of the event broker service configured as a source.

Field Description
Endpoint Type

Select TOPIC_ENDPOINT or QUEUE to specify the type of endpoint receive from.

Queue Name

The name of the queue to receive from. Endpoint Type must be QUEUE.
Topic Name

The name of the topic endpoint to consume from. Endpoint Type must be TOPIC_ENDPOINT.
Message Selector For the event broker service as the source, enables message filtering per endpoint.

Event Broker Service Target Parameters

The following table describes the endpoint parameters of the event broker service configured as a target.

Setting a Smart Topic Destination on the Mappings step overrides the target destination field set on the Details step.

Field Description
Destination Type

Select TOPIC or QUEUE to specify the destination to send to.

Create the required queue on your event broker service if you haven't done so already. For more information, see Creating Event Broker Services).

Queue Name

The name of the queue to publish to. Destination Type must be QUEUE. Alternatively, you can set a Smart Topic Destination on the Mapping step, which will override this destination.
Topic Name

The name of the topic to publish to. Destination Type must be TOPIC. Alternatively, you can set a Smart Topic Destination on the Mapping step, which will override this destination.