Access Control Lists (ACLs)*

Specify a comma-separated list of groups to add to the Allowed list for this ACL.

To add groups defined in LDAP or CDS to the allow list for an ACL, add the prefix “ldap/” or “cds/” followed by the group name. For example, the following key=value pair adds the LDAP user myLdapUser and the CDS user myCentralUser to the allow list for the Administrators ACL: acl.Administrators.allow=ldap/myLdapUser, cds/myCentralUser

Local groups can include the “local/” prefix with the group name but do not have to.

Specify a comma-separated list of groups to add to the Denied list for this ACL.

To add groups defined in LDAP or CDS to the deny list for an ACL, add the prefix “ldap/” or “cds/” followed by the group name. For example, the following key=value pair adds the LDAP user myLdapUser and the CDS user myCentralUser to the deny list for the Administrators ACL: acl.Administrators.deny=ldap/myLdapUser, cds/myCentralUser

Local groups can include the “local/” prefix with the group name but do not have to.

Specify a comma-separated list of folders and/or services to which you want to assign the ACL as the Execute ACL.

API Gateway Transaction Logger

Specify lwq as the value for the key name to write messages to the internal light-weight queue. Else, specify um to write messages to Universal Messaging.

For example: IS_UM_CONNECTION

For Example: logger.APIGatewayTransaction.retryWait=5000

Broker connection alias*

Cache Manager

Terracotta Server Array URLs

Dashboard configuration

Document Logger

Specify lwq as the value for the key name to write messages to the internal light-weight queue. Else, specify um to write messages to Universal Messaging.

For example: IS_UM_CONNECTION

For example: logger.Document.retryWait=5000

Email Port*

Error Logger

Specify lwq as the value for the key name to write messages to the internal light-weight queue. Else, specify um to write messages to Universal Messaging.

For example: IS_UM_CONNECTION

For example: logger.Error.retryWait=5000

File Polling Port*

Global Variable (Package-Level)*

Set to true to indicate the global variable is secure or a password.

Global Variable (Server-Level )*

Set to true to indicate the global variable is secure or a password.

Group*

Specifies the users that belong to the group.

Only local users can be specified. A local user defined on Microservices Runtime as opposed to a user defined in an external directory (LDAP, IBM My webMethods Server, or Common Directory Services). You do not need to include the "local/" prefix with the user name.

Specifies the ACLs for which the group belongs to the Allowed list. Members of the group are permitted to use the resources to which the specified ACLs are assigned.

Specifies the ACLs for which the group belongs to the Denied list. Members of the group are prohibited from using the resources to which the specified ACLs are assigned.

Guaranteed Delivery Inbound Logger

Specify lwq as the value for the key name to write messages to the internal light-weight queue. Else, specify um to write messages to Universal Messaging.

For example: IS_UM_CONNECTION

For example: logger.GuaranteedDeliveryInbound.retryWait=5000

Guaranteed Delivery Outbound Logger

Specify lwq as the value for the key name to write messages to the internal light-weight queue. Else, specify um to write messages to Universal Messaging.

For example: IS_UM_CONNECTION

For example: logger.GuaranteedDeliveryOutbound.retryWait=5000

Health Indicators

JDBC Functional Alias

JDBC Pool Alias*

JMS Connection Alias*

Set to true to enable. Set to false to disable.

Set to:

Set to:

The specified JNDI alias must match an existing JNDI provider alias.

Set to true to create a connection factory or destination on the JNDI provider if the object is not found at the time Integration Server looks up the object. Otherwise, set to false.

Set to true to follow the master realm server. Set to false to disable following the master realm server.

Monitor IBM webMethods Connection Factory

Set to:

Set to JKS or PCKS12.

Set to JKS.

Set to:

Set to true to drain in order. Set to false to disable draining in publishing order.

Set to true to create a temporary queue for request-reply operations that do not specify a replyTo destination. Otherwise, set to false.

Set to true to create a single dedicated MessageConsumer for receiving synchronous replies delivered to the temporary queue for this JMS connection alias. Set to false to create a new JMS MessageConsumer for each reply message.

Enable Destination Management with Designer (Broker and Universal Messaging)

Set to true to allow creating destinations on the messaging provider using Designer. Otherwise, set to false.

Set to true to create a separate connection per concurrent JMS trigger. Otherwise, set to false.

Set to:

Set to:

Set to true to enable, false to disable.

Set to true to enable, false to disable.

JNDI Provider Alias*

Kerberos

Keystore Alias*

Default supported values are: JKS and PKCS12. Other keystore types may be available by loading additional security providers, or by setting the watt.security.keyStoreTypes server configuration property.

Default supported values are as follows:

Set to true to specify that the keystore is stored on a Hardware Security Module (HSM) device. If set to true, the value of the keystore.aliasName.ksLocation is ignored.

LDAP Configuration*

ldap.settings.CacheTimeToLive is measured in milliseconds unlike the Credential Time-to-Live field which is measured in minutes.

Synthesize DN and Query DN

Set to true to specify that Microservices Runtime builds a distinguished name by adding a prefix and suffix to the username. A value of true is equivalent to selecting the Synthesize DN option on the Security > User Management > LDAP configuration page.

Set to false to specify that Microservices Runtime builds a query that searches a specified root directory for the user. A value of false is equivalent to selecting the Query DN option on the Security > User Management > LDAP configuration page.

The default is true.

The uuid is a unique identifier for the LDAP directory. When an application.properties file is generated by Microservices Runtime, the UUID is automatically generated by Microservices Runtime. When using an application.properties file to create an LDAP configuration, make sure to specify a unique value in the UUID portion of the key name.

LDAP Group*

Group Name

Adds LDAP groups directly to the LDAP configuration file. The key ldapgroup.groupName.dn sets the distinguished name of the group. The groupName is the alias that Integration Server uses to store information about the LDAP group once it is created by applying the template. For example:

The above example includes backslashes (\) to escape equal signs.

Messaging Logger

Proxy Server Alias*

Set to:

Set to one of the following:

Set to:

Set to:

Set to:

Proxy Server Bypass

Remote Server Alias*

Restricted Services

Specify a comma-separated list of restricted services that can be executed from a custom package.

When a custom package directly invokes any services that are listed in the restrictedServices.cnf configuration file, Integration Server blocks the invocation of such services. If any restricted services are required for a custom package, you can list them in a comma-separated format. For example,

restrictedServices.allow=​wm.server.access:addUsers​,wm.server.access:removeACLs

For more information on restricted services, see About Restricted Services IBM webMethods Integration Server Administrator’s Guide.

Security Logger

Set to:

For example: IS_UM_CONNECTION

For example: logger.Security.retryWait=5000

Server configuration parameters (server.cnf)

Any

When staring a Docker container, the docker run command can specify environment variables for setting the primary port, secure port, and diagnostic port. Specifically, the SAG_IS_HTTP_PORT, SAG_IS_HTTPS_PORT, and SAG_IS_DIAGNOSTIC_PORT can set the primary, secure, and diagnostic ports, respectively, for the container. Each of these port settings corresponds to a server configuration parameter. It is possible for a configuration variables template to specify the primary, secure, and/or diagnostic ports through the watt.server.port, watt.server.securePort, and watt.server.diagnostic.port parameters. However, the environment variable in the docker run command takes precedence over the port values set in the server configuration parameters.

Server Logger

logger.Server.IS=Off|Fatal|Error|Warn|Info|Debug|Trace​logger.Server.WmJSONAPI=Off|Fatal|Error|Warn|Info|Debug|Trace​logger.Server.WmParquet=Off|Fatal|Error|Warn|Info|Debug|Trace​logger.Server.WmXSLT=Off|Fatal|Error|Warn|Info|Debug|Trace​logger.Server.FlatFile=Off|Fatal|Error|Warn|Info|Debug|Trace

Specify the logging level for each facility in the following format.

​For example: logger.Server.WmXSLTPackage.SAX.0001 =​ Off|Fatal|Error|Warn|Info|Debug|Trace

For the facility name and number, see Server Log Facilities in IBM webMethods Integration Server Administrator’s Guide

Services

Service Logger

For example: IS_UM_CONNECTION

For example: logger.Service.retryWait=5000

Session Logger

Specify lwq as the value for the key name to write messages to the internal light-weight queue. Else, specify um to write messages to Universal Messaging.

For example: IS_UM_CONNECTION

SFTP Server Alias*

The SFTP client to use. Set to v1 or v2 .

The hostname or IP address of the SFTP server.

The port number of the SFTP server.

The proxy alias through which requests are routed.

The public key of the SFTP server.

The minimum DH key size. Not applicable to SFTP Client Version 1.

The maximum DH key size. Not applicable to SFTP Client Version 1.

Preferred key exchange algorithms separated by a comma.

Message Authentication Code (MAC) Server to Client algorithms separated by a comma.

Message Authentication Code (MAC) Client to Server algorithms separated by a comma.

Preferred Server to Client Ciphers separated by a comma.

Preferred Client to Server Ciphers separated by a comma.

SFTP User Alias*

The user name for the SFTP user account.

The type of authentication that Integration Server uses to authenticate itself to the SFTP server. The value can be password or publicKey.

The location of the private key for the specified SFTP user if the authentication type is publickey.

The password for the SFTP user account.

The passphrase generated while creating the private key.

The alias of the SFTP server to which you want the SFTP user account to connect.

Whether Integration Server verifies the host key of the SFTP server before establishing a connection to the SFTP server. Set to yes or no.

Truststore Alias*

Default supported values are: JKS and PKCS12. Other truststore types can be made available by loading additional security providers, or by setting the watt.security.TrustStoreTypes server configuration property.

Default supported values are as follows:

UM Client Logger

settings.watt.um.clientTraceLog.folderLogSize=<<Size in MB>>.

The default is 1024.

The default is 10.

Universal Messaging Connection Alias* (IBM webMethods messaging)

Whether the client prefix is shared with other Integration Servers. Set to true to indicate client prefix is shared. Set to false to indicate client prefix is not shared.

Whether to use a client side queue for the connection alias. Set to true to use a client side queue. Set to false if you do not want the connection alias to use a client side queue.

Set to true to drain the client side queue in the same order in which messages were placed in the queue. Set to false if you do not want the client side queue to drain in order.

Set to true to follow the master realm server when publishing. Set to false to disable follow the master realm behavior for publishing.

Set to true to use a request/reply channel for the alias. Set to false to disable use of a request/reply channel for the alias.

Set to true to follow the master realm server when retrieving messages. Set to false to disable follow the master realm behavior for message retrieval.

Set to 0 for SERVER LOG. Set to 1 for MESSAGING AUDIT LOG

Set to true to enable additional logging for message producers that use this connection alias. Set to false to disable the additional logging.

Set to true to enable additional logging for message consumers (triggers) that use this connection alias. Set to false to disable the additional logging.

Specifies whether the alias connects to Broker or Universal Messaging. Set to UM or Broker. The default is UM.

User account*

When staring a Docker container, the docker run command can specify the SAG_IS_ADMIN_PASSWORD environment variable which sets the Administrator password. The SAG_IS_ADMIN_PASSWORD value overrides the Administrator password set in a configuration variables template and in the Microservices Runtime for which the image was built.

IBM webMethods Cloud Account

IBM webMethods Cloud Settings

webMethods Cloud URL

Web Service Endpoint Alias

Host Name or IP Address(HTTP/S Transport Properties)

Port Number (HTTP/S Transport Properties)

User Name (HTTPS Transport Properties)

Password (HTTPS Transport Properties)

User Name (WS Security Properties)

Password (WS Security Properties)

To (Message Addressing Properties)

From (Message Addressing Properties)

Reply To (Message Addressing Properties)

Fault To (Message Addressing Properties)

Where type can be consumer, provider, or messageaddressing and protocol can be HTTP, HTTPS, or JMS.