Message fabric properties file

Use the message fabric properties file to set up message connections in AS4 Microservice.

The message fabric properties file is the SystemConfigurationMFLoader.properties file in the install_dir\Members\resources directory.

The message fabric properties file contains information that is used by the message provider. Some of the values in this file must match the information in the data grid properties file and the information that is used to configure the message fabric server adapter.

When you are adding a node to your installation of AS4 Microservice, you can directly import this file as part of the configuration of the new node.

The message fabric properties are generated in one of the following ways when you run the Installation Manager:

  • In production installations, from data that is entered on the Message fabric configuration page of the IBM® Installation Manager. Production installations use WebSphere® MQ as the message provider.
  • In proof of concept installations, in a pre-configured file. Proof of concept installations use WebSphere eXtreme Scale as the message provider.
Property (production installations) Description
messagefabric.configuration.type The message fabric type. In production installations, the default value is webspheremq.
messagefabric.jms.webspheremq.WMQ_CONNECTION_NAME_LIST The host name and port for the WebSphere MQ servers. Use this property to configure the multiple queue managers of a multi-instance queue manager. Multiple servers are entered as a comma-separated list. Use this information when you configure the message fabric adapter and the message fabric server adapter.
messagefabric.jms.webspheremq.XMSC_WMQ_CHANNEL The channel that is used to connect to the WebSphere MQ server. Use this information when you configure the message fabric adapter and message fabric server adapter.
messagefabric.jms.webspheremq.XMSC_WMQ_QUEUE_MANAGER The name of the queue manager on the WebSphere MQ server. Use this information when you configure the message fabric server adapter.
messagefabric.jms.webspheremq.userid The user identifier to use to access WebSphere MQ. Use this information when you configure the message fabric adapter and message fabric server adapter.
messagefabric.jms.webspheremq.password The password for the user identifier that is used to access WebSphere MQ. Use this information when you configure the message fabric adapter and message fabric server adapter.
messagefabric.jms.webspheremq.batchProperties This value is a placeholder for more arguments that might be needed in future. Do not use this value unless directed by IBM Customer Support to use it.
messagefabric.jms.webspheremq.XMSC_WMQ_SSL_CIPHER_SUITE
Important: If you are enabling the Secure Sockets Layer (SSL) protocol for WebSphere MQ, you must manually add this property after you install AS4 Microservice.

The cipher suite on the AS4 Microservice side of the WebSphere MQ channel. When you set this property, the SSL protocol is enabled.

messagefabric.meg.jms.webspheremq.ssl.trustStoreFilename
Important: If you are enabling the SSL protocol for WebSphere MQ, you must manually add this property after you install AS4 Microservice.

The file path to the required JKS truststore in AS4 Microservice that contains the private and public keys for client authentication in AS4 Microservice. The certificate is used in an SSL channel that is used by WebSphere MQ.

The path can have one of the following values:

  • The full path to the truststore file.
  • A file path that is relative to the install_dir\Members directory. Use this value if you have a multiple node installation that does not use the same installation directory path for all nodes.

    For example, you can use the \resources\truststore_file path when the full path is C:\AS4 Microservices\Members\resources\truststore_file.

The aliases for the certificates in this truststore must use the following format: 

ibmwebspheremq <qmname lowercase>
messagefabric.meg.jms.webspheremq.ssl.keyStoreFilename
Important: If you are enabling the SSL protocol for WebSphere MQ, you must manually add this property after you install AS4 Microservice.

The file path to an optional JKS keystore in AS4 Microservice that contains certificate authority (CA) certificates. The certificates are used in an SSL channel that is used by WebSphere MQ.

The path can have one of the following values:

  • The full path to the keystore file.
  • A file path that is relative to the install_dir\Members directory. Use this value if you have a multiple node installation that does not use the same installation directory path for all nodes.

    For example, you can use the \resources\keystore_file path when the full path is C:\AS4 Microservices\Members\resources\keystore_file.

This property can be optionally used for client authentication. The WebSphere MQ channel might require client authentication.

The keystore and truststore might be the same file. However, this situation requires that the truststore password be set (messagefabric.meg.jms.webspheremq.ssl.trustStorePassword).
messagefabric.meg.jms.webspheremq.ssl.keyStorePassword
Important: If you are enabling the SSL protocol for WebSphere MQ, you must manually add this property after you install AS4 Microservice.

The password for the keystore that is specified in the messagefabric.meg.jms.webspheremq.ssl.keyStoreFilename property.

This password is required only if client authentication is enabled.

You can encode this password with the Liberty securityUtility tool.
messagefabric.meg.jms.webspheremq.ssl.trustStorePassword
Important: If you are enabling the SSL protocol for WebSphere MQ, you must manually add this property after you install AS4 Microservice.

The password for the keystore that is specified in the messagefabric.meg.jms.webspheremq.ssl.keyStoreFilename property.

This password is required only if the keystore and truststore are the same file.

You can encode this password with the Liberty securityUtility tool.
messagefabric.meg.jms.webspheremq.ssl.protocol The security protocol that is used by WebSphere MQ. Valid values:
  • SSL - Secure Sockets Layer
  • TLS (default) - Transport Layer Security
messagefabric.jms.domain.cachedSessionsPerConnection The number of cached sessions per connection to the message fabric.
messagefabric.jms.domain.cachedMessageProducersPerSession The number of message producers per session.
messagefabric.meg.configuration.webspheremq.automaticDestinationCreation Indicates whether to dynamically create destination queues for WebSphere MQ. Valid values:
  • True (default) - Create queues dynamically
  • False - Do not create queues dynamically
Property (proof of concept installations) Description
messagefabric.configuration.type The message fabric type. In production installations, the default value is extremescale.
messagefabric.extremescale.catalogServers The host and port of the catalog server that is used in a proof of concept installation.
messagefabric.extremescale.userid The user identifier to use to access the message provider. Use this information when you configure the message fabric adapter and message fabric server adapter.
messagefabric.extremescale.password The password for the user identifier that is used to access the message provider. Use this information when you configure the message fabric adapter and message fabric server adapter.
messagefabric.jms.domain.cachedMessageProducersPerSession The number of message producers per session.
messagefabric.meg.configuration.webspheremq.automaticDestinationCreation Indicates whether to dynamically create destination queues for WebSphere MQ. Valid values:
  • True (default) - Create queues dynamically
  • False - Do not create queues dynamically

Examples of the message fabric properties file

This code is an example of a message fabric properties file for a production installation that uses WebSphere MQ as the message provider:

messagefabric.configuration.type=webspheremq
# Update to point to the (or list of) MQ servers host and ports to connect to.  format of value is: host1(port) [,host2(port2)...]
messagefabric.jms.webspheremq.XMSC_WMQ_CONNECTION_NAME_LIST=localhost(1414)
# Update to point to the channel that was used when creating the queues for the fabric to use
messagefabric.jms.webspheremq.XMSC_WMQ_CHANNEL=MEG_CHANNEL
# Update to point to the queue manager that was used when creating the queues for the fabric to use
messagefabric.jms.webspheremq.XMSC_WMQ_QUEUE_MANAGER=QMA
# Update to provide the user name to connect to the MQ server(s) with
messagefabric.jms.webspheremq.userid=mquser
# Update to provide the password for the abover user to connect to the MQ server(s) with
messagefabric.jms.webspheremq.password=P@$$w0rd
messagefabric.jms.webspheremq.batchProperties= 
messagefabric.jms.domain.cachedSessionsPerConnection=100
messagefabric.jms.domain.cachedMessageProducersPerSession=100
messagefabric.meg.configuration.webspheremq.automaticDestinationCreation=true

This code is an example of a message fabric properties file for a proof of concept installation that uses WebSphere eXtreme Scale as the message provider:

messagefabric.configuration.type=extremescale
messagefabric.extremescale.catalogServers=localhost:2809

messagefabric.extremescale.userid=wxsUser
messagefabric.extremescale.password=P@$$w0rd

messagefabric.jms.domain.cachedSessionsPerConnection=100
messagefabric.jms.domain.cachedMessageProducersPerSession=100