Integration Server 10.15 | Microservices Runtime Guide | Configuration Variables Template Assets
 
Configuration Variables Template Assets
A configuration variables template is a properties file that contains configuration data as a series of key-value pairs where the key name reflects the asset and particular asset property for which you can supply a value. A configuration variables template contains key-value pairs for a subset of Microservices Runtime configuration only. That is, a configuration variables template does not include key-value pairs for all of the configuration information for a Microservices Runtime. Only some configuration information is supported for use with configuration variables templates. Assets can be modified and created when Microservices Runtime applies the template at start up.
The following table identifies the assets and property names that correspond to the key names in a template. An asterisk (*) next to an asset indicates that the asset can be created through application of a configuration variables template.
Asset
Property
Key Name
Access Control Lists (ACLs)*
Allowed
acl.aclName.allow
Specify a comma-separated list of groups to add to the Allowed list for this ACL.
Only local groups can be specified. A local group is a group defined on Microservices Runtime as opposed to a group defined in an external directory (LDAP, My webMethods Server, or Common Directory Services). You do not need to include the "local/" prefix with the group name.
Note:
Do not specify a group in both acl.aclName.allow and acl.aclName.deny. If a group appears in both properties, during template processing Microservices Runtime places the group in the Deny list only.
Denied
acl.aclName.deny
Specify a comma-separated list of groups to add to the Denied list for this ACL.
Only local groups can be specified. A local group is a group defined on Microservices Runtime as opposed to a group defined in an external directory (LDAP, My webMethods Server, or Common Directory Services). You do not need to include the "local/" prefix with the group name.
Note:
Do not specify a group in both acl.aclName.allow and acl.aclName.deny. If a group appears in both properties, during template processing Microservices Runtime places the group in the Deny list only.
Execute ACL
acl.aclName.execute
Specify a comma-separated list of folders and/or services to which you want to assign the ACL as the Execute ACL.
Broker connection alias*
Broker Host
messaging.BROKERALIAS.brokerHost
Broker Name
messaging.BROKERALIAS.brokerName
Client Group
messaging.BROKERALIAS.clientGroupName
Keystore
messaging.BROKERALIAS.certfile
Keystore Password
messaging.BROKERALIAS.keystorePassword
Truststore
messaging.BROKERALIAS.truststore
Username
messaging.BROKERALIAS.user
Password
messaging.BROKERALIAS.password
Cache Manager
Terracotta Server Array URLs
cachemanager.cacheManagerName.urls
Consul*
Host Name or IP Address
consul.aliasName.host
Password

consul.aliasName.password
Port Number

consul.aliasName.port
User Name

consul.aliasName.user
Dashboard configuration
Indexer thread count
statisticsdatacollector.monitorConfig.luceneMemorySize
Maximum JDBC pool connections
statisticsdatacollector.monitorConfig.maxJdbcPoolConnections
Maximum number of results
statisticsdatacollector.monitorConfig.maxResults
Memory size (MB)
statisticsdatacollector.monitorConfig.luceneMemorySize
Retention days
statisticsdatacollector.monitorConfig.retentionDay
Searcher thread count
statisticsdatacollector.monitorConfig.searcherThreadCount
Statistics Data Collection
statisticsdatacollector.monitorConfig.enabled
Email Port*
Host Name
email.packageName.aliasName.host
Password

email.packageName.aliasName.password
Port

email.packageName.aliasName.server_port
Type
email.packageName.aliasName.type
User Name
email.packageName.aliasName.user
File Polling Port*
Completion Directory

filepolling.packageName.aliasName. completionDir
Error Directory

filepolling.packageName.aliasName. errorDir
Monitoring Directory

filepolling.packageName.aliasName. monitorDir
Global Variable (Package-Level)*
Value

globalvariable.PackageName.globalVariableName.value
Is Password?
globalvariable.PackageName.globalVariableName.isSecure
Set to true to indicate the global variable is secure or a password.
Global Variable (Server-Level)*
Value

globalvariable.globalVariableName.value
Is Password?
globalvariable.globalVariableName.isSecure
Set to true to indicate the global variable is secure or a password.
Group*
Users in this Group
group.groupName.users
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, My webMethods Server, or Common Directory Services). You do not need to include the "local/" prefix with the user name.
Allowed
group.groupName.allowACLs
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.
Note:
Do not specify an ACL in both group.groupName.allowACLs and group.groupName.denyACLs. If an ACL appears in both properties, during template processing, Microservices Runtime places the group in the Denied list only.
Note:
The group.groupName.allowACLs and acl.aclName.allow keys can both assign a group to the allow list for an ACL. Make sure that the key values do not overlap or conflict.
Denied
group.groupName.denyACLs
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.
Note:
Do not specify an ACL in both group.groupName.allowACLs and group.groupName.denyACLs. If an ACL appears in both properties, during template processing, Microservices Runtime places the group in the Denied list only.
Note:
The group.groupName.denyACLs and acl.aclName.deny keys can both assign a group to the allow list for an ACL. Make sure that the key values do not overlap or conflict.
Health Indicators
Enabled
healthindicators.Diskspace.enabled
Free disk space threshold

healthindicators.Diskspace.properties.threshold.value
Enabled
healthindicators.JDBC.enabled
Enabled
healthindicators.JMS.enabled
Enabled
healthindicators.JNDIAliases.enabled
Enabled

healthindicators.Memory.enabled
Free memory threshold

healthindicators.Memory.properties.threshold.value
Enabled

healthindicators.RemoteServers.enabled
Enabled

healthindicators.SFTPServers.enabled
Enabled

healthindicators.ServiceThread.enabled
Available threads threshold

healthindicators.ServiceThread.properties.threshold.value
Enabled

healthindicators.Sessions.enabled
Used licenses threshold

healthindicators.Sessions.properties.threshold.value
Enabled

healthindicators.UMAliases.enabled
JDBC Functional Alias
Associated Pool Alias
jdbcfunc.functionName.connPoolAlias
Note:
The specified JDBC connection pool alias must exist before the JDBC functional alias is updated.
JDBC Pool Alias*
Database URL
jdbc.aliasName.dbURL
Associated Driver Alias
jdbc.aliasName.driverAlias
User ID
jdbc.aliasName.userid
Password
jdbc.aliasName.password
JMS Connection Alias*
Enabled
jms.aliasName.enabled
Set to true to enable. Set to false to disable.
Description
jms.aliasName.description
Transaction Type
jms.aliasName.transactionType
Set to:
*0 for NO_TRANSACTION.
*1 for LOCAL_TRANSACTION.
*2 for XA_TRANSACTION.
Connection Client ID
jms.aliasName.clientID
User
jms.aliasName.user
Password
jms.aliasName.password
Create Connection Using
jms.aliasName.associationType
Set to:
*0 for JNDI LOOKUP.
*1 for NATIVE WEBMETHODS API.
JNDI Provider Alias Name
jms.aliasName.jndi_jndiAliasName
The specified JNDI alias must match an existing JNDI provider alias.
Connection Factory Lookup Name
jms.aliasName.jndi_connectionFactoryLookupName
Create Administered Objects On Demand (Universal Messaging)
jms.aliasName.jndi_automaticallyCreateUMAdminObjects
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.
Enable Follow the Master (Universal Messaging)
jms.aliasName.jndi_enableFollowTheMaster
Set to true to follow the master realm server. Set to false to disable following the master realm server.
Monitor webMethods Connection Factory
jms.aliasName.jndi_connectionFactoryUpdateType
Set to:
*NO - Do not monitor the webMethods Connection Factory.
*CLIENT_POLL - Poll for changes at a specified interval.
*JNDI_POLL - Poll for changes at the interval defined by webMethods Connection Factory object.
*NOTIFICATION - Monitor the connection factory by registering an event listener.
Polling Interval (minutes)
jms.aliasName.jndi_connectionFactoryPollingInterval
Broker Host
jms.aliasName.nwm_brokerHost
Broker Name
jms.aliasName.nwm_brokerName
Client Group
jms.aliasName.nwm_clientGroup
Broker List (optional)
jms.aliasName.jms.jmsAliasName.nwm_brokerList
Keystore (optional)
jms.aliasName.nwm_keystore
Keystore Type (optional)
jms.aliasName.nwm_keystoreType
Set to JKS or PCKS12.
Truststore (optional)
jms.aliasName.nwm_truststore
Truststore Type (optional)
jms.aliasName.nwm_truststoreType
Set to JKS.
Class Loader
jms.aliasName.classLoader
Set to:
*INTEGRATION_SERVER
*PACKAGE: PackageName where PackageName is the name of the package class loader.
Maximum CSQ Size
jms.aliasName.csqSize
Drain CSQ in Order
jms.aliasName.csqDrainInOrder
Set to true to drain in order. Set to false to disable draining in publishing order.
Create Temporary Queue
jms.aliasName.optTempQueueCreate
Set to true to create a temporary queue for request-reply operations that do not specify a replyTo destination. Otherwise, set to false.
Enable Request-Reply Listener for Temporary Queue
jms.aliasName.allowReplyToConsumer
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)
jms.aliasName.manageDestinations
Set to true to allow creating destinations on the messaging provider using Designer. Otherwise, set to false.
Create New Connection per Trigger
jms.aliasName.allowNewConnectionPerTrigger
Set to true to create a separate connection per concurrent JMS trigger. Otherwise, set to false.
Caching Mode
jms.aliasName.producerCachingMode
Set to:
*0 to disable.
*2 to enable per destination.
Minimum Pool Size (unspecified destinations)
jms.aliasName.producerSessionPoolMinSize
Maximum Pool Size (unspecified destinations)
jms.aliasName.producerSessionPoolSize
Minimum Pool Size Per Destination
jms.aliasName.cacheProducersPoolMinSize
Maximum Pool Size Per Destination
jms.aliasName.cacheProducersPoolSize
Destination Lookup Names (semicolon delimited)
jms.aliasName.cacheProducersQueueList
Topic List (semicolon delimited)
jms.aliasName.cacheProducersTopicList
Idle Timeout (milliseconds)
jms.aliasName.poolTimeout
Max Retry Attempts
jms.aliasName.producerMaxRetryAttempts
Retry Interval (milliseconds)
jms.aliasName.producerRetryInterval
Logging Type
jms.aliasName.um_loggingOutput
Set to:
*0 for SERVER LOG.
*1 for MESSAGING AUDIT LOG.
Enable Producer Message ID Tracking
jms.aliasName.um_producerMessageTracking
Set to true to enable, false to disable.
Producer Message ID Tracking: Include Destinations (semicolon delimited)
jms.aliasName.um_producerIncludedStrings
Enable Consumer Message ID Tracking
jms.aliasName.um_consumerMessageTracking
Set to true to enable, false to disable.
Consumer Message ID Tracking: Include Triggers (semicolon delimited)
jms.aliasName.um_consumerIncludedStrings
JNDI Provider Alias*
Initial Context Factory
jndi.aliasName.initialContextFactory
Provider URL
jndi.aliasName.providerURL
Provider URL Failover List
jndi.aliasName.providerURLFailoverList
Security Principal
jndi.aliasName.securityPrincipal
Security Credentials
jndi.aliasName.securityCredentials
Kerberos
Realm
kerberos.KerberosConfig.kerberosConfig
Key Distribution Center Host
kerberos.KerberosConfig.kerberosKDC
Kerberos Configuration File
kerberos.KerberosConfig.kerberosRealm
Use Subject Credentials Only
kerberos.KerberosConfig.useSubjectCreds
Keystore Alias*
Location
keystore.aliasName.ksLocation
Password
keystore.aliasName.ksPassword
Key Alias Password

keystore.aliasName.keyAlias.keyAliasName. keyAliasPassword
LDAP Configuration*
Directory URL
ldap.uuid.url
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.
Principal
ldap.uuid.prin
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.
Credentials
ldap.uuid.password
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.
Synthesize DN and Query DN
ldap.uuid.useaf
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.
UID Property
ldap.uuid.uidprop
Group Member Attribute
ldap.uuid.mattr
User Root DN
ldap.uuid.userrootdn
Group ID Property
ldap.uuid.gidprop
Group Root ID
ldap.uuid.grouprootdn
Connection Timeout
ldap.uuid.timeout
Minimum Connection Pool Size
ldap.uuid.poolmin
Maximum Connection Pool Size
ldap.uuid.poolmax
DN Prefix
ldap.uuid.dnprefix
DN Suffix
ldap.uuid.dnsuffix
User Email
ldap.uuid.useremail
Default Group
ldap.uuid.group
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.
Proxy Server Alias*
Host Name or IP Address
proxyserver.aliasName.host
Port Number
proxyserver.aliasName.port
User Name
proxyserver.aliasName.username
Password
proxyserver.aliasName.password
Proxy Server Bypass
Addresses

settings.watt.net.proxySkipList
Remote Server Alias*
Host Name or IP Address
remoteserver.aliasName.host
Port Number
remoteserver.aliasName.port
User Name
remoteserver.aliasName.user
Password
remoteserver.aliasName.password
Retry Server
remoteserver.aliasName.retryServer
Server configuration parameters (server.cnf)
Any

settings.serverConfigurationParameterName

Services
Enabled for top-level service
service.servicename.concurrentRequestLimitEnabled
Max concurrent requests
service.servicename.maxConcurrentRequests
SFTP Server Alias*
SFTP Client Version
sftpserver.aliasName.version
The SFTP client to use. Set to v1 or v2 .
Host Name or IP Address
sftpserver.aliasName.hostName
The hostname or IP address of the SFTP server.
Port Number
sftpserver.aliasName.port
The port number of the SFTP server.
Proxy Alias
sftpserver.aliasName.proxyAlias
The proxy alias through which requests are routed.
Host Key Location
sftpserver.aliasName.hostKey
The location of the public key of the SFTP server.
Min DH Key Size
sftpserver.aliasName.minDHKeySize
The minimum DH key size. Not applicable to SFTP Client Version 1.
Max DH Key Size
sftpserver.aliasName.maxDHKeySize
The maximum DH key size. Not applicable to SFTP Client Version 1.
Preferred Key Exchange Algorithms
sftpserver.aliasName.preferredKeyExchangeAlgorithm
Preferred key exchange algorithms separated by a comma.
Preferred MAC Algorithms S2C
sftpserver.aliasName.preferredMACS2C
Message Authentication Code (MAC) Server to Client algorithms separated by a comma.
Preferred MAC Algorithms C2S
sftpserver.aliasName.preferredMACC2S
Message Authentication Code (MAC) Client to Server algorithms separated by a comma.
Preferred Ciphers S2C
sftpserver.aliasName.preferredCiphersS2C
Preferred Server to Client Ciphers separated by a comma.
Preferred Ciphers C2S
sftpserver.aliasName.preferredCiphersC2S
Preferred Client to Server Ciphers separated by a comma.
SFTP User Alias*
User Name
sftpuser.aliasName.userName
The user name for the SFTP user account.
Authentication Type
sftpuser.aliasName.authenticationType
The type of authentication that Integration Server uses to authenticate itself to the SFTP server. The value can be password or publicKey.
Private Key Location
sftpuser.aliasName.privateKeyFileLocation
The location of the private key for the specified SFTP user if the authentication type is publicKey.
Note:
The path of the private key must be relative to the installation directory.
Password
sftpuser.aliasName.password
The password for the SFTP user account.
PassPhrase
sftpuser.aliasName.passPhrase
The passphrase generated while creating the private key.
SFTP Server Alias
sftpuser.aliasName.sftpServerAlias
The alias of the SFTP server to which you want the SFTP user account to connect.
Strict Host Key Checking
sftpuser.aliasName.strictHostKeyChecking
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*
Location
truststore.aliasName.ksLocation
Password
truststore.aliasName.ksPassword
Universal Messaging Connection Alias* (webMethods messaging)
Description
messaging.connectionAliasName.description
Client Prefix
messaging.connectionAliasName.CLIENTPREFIX
Client Prefix Is Shared
messaging.connectionAliasName.isClientPrefixShared
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.
Realm URL
messaging.connectionAliasName.url
Maximum Reconnection Attempts
messaging.connectionAliasName.um_tryAgainMaxAttempts
Enable CSQ
messaging.connectionAliasName.useCSQ
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.
Maximum CSQ Size
messaging.connectionAliasName.csqSize
Drain CSQ in Order
messaging.connectionAliasName.csqDrainInOrder
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.
Publish Wait Time while Reconnecting
messaging.connectionAliasName.um_publishWaitTime
Enable Follow the Master for Producers
messaging.connectionAliasName.um_followTheMasterForPublish
Set to true to follow the master realm server when publishing. Set to false to disable follow the master realm behavior for publishing.
Enable Request-Reply Channel and Listener
messaging.connectionAliasName.enableRequestReply
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.
Enable Follow the Master for Consumers
messaging.connectionAliasName.um_followTheMasterForSubscribe
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.
Username
messaging.connectionAliasName.user
Password
messaging.connectionAliasName.password
Truststore Alias
messaging.connectionAliasName.trustStoreAlias
Keystore Alias
messaging.connectionAliasName.keyStoreAlias
Key Alias
messaging.connectionAliasName.keyAlias
Logging Type
messaging.connectionAliasName.um_loggingOutput
Set to 0 for SERVER LOG. Set to 1 for MESSAGING AUDIT LOG
Enable Producer Message ID Tracking
messaging.connectionAliasName.um_producerMessageTracking
Set to true to enable additional logging for message producers that use this connection alias. Set to false to disable the additional logging.
Producer Message ID Tracking: Include Channels
messaging.connectionAliasName.um_producerIncludedStrings
Enable Consumer Message ID Tracking
messaging.connectionAliasName.um_consumerMessageTracking
Set to true to enable additional logging for message consumers (triggers) that use this connection alias. Set to false to disable the additional logging.
Consumer Message ID Tracking: Include Triggers
messaging.connectionAliasName.um_consumerIncludedStrings
Default Connection Alias
messaging.connectionAliasName.default=true
Type
messaging.connectionAliasName.type
Specifies whether the alias connects to Broker or Universal Messaging. Set to UM or Broker. The default is UM.
User account*
Password
user.userName.password
webMethods Cloud Account
Stage

wmcloudaccount.webMethodsCloudAccountAlias. stage
Allowed On-Premise Hosts

wmcloudaccount.webMethodsCloudAccountAlias. onPremiseHosts
webMethods Cloud Settings
User Name
wmcloudsettings.default.username
Password
wmcloudsettings.default.password
webMethods Cloud URL
wmcloudsettings.default.iLiveURL
Web Service Endpoint Alias
Host Name or IP Address(HTTP/S Transport Properties)

webserviceendpoint.type.protocol. aliasName.transportInfo.host
Port Number (HTTP/S Transport Properties)

webserviceendpoint.type.protocol. aliasName.transportInfo.port
User Name (HTTPS Transport Properties)

webserviceendpoint.type.protocol. aliasName.transportInfo.user
Password (HTTPS Transport Properties)

webserviceendpoint.consumer.protocol. aliasName.transportInfo.transportPassword
User Name (WS Security Properties)

webserviceendpoint.type.protocol. aliasName.messageInfo.user
Password (WS Security Properties)

webserviceendpoint.type.protocol. aliasName.messageInfo.messagePassword
To (Message Addressing Properties)

webserviceendpoint.type.protocol. aliasName.messageaddressingproperties. toMsgAddr
From (Message Addressing Properties)

webserviceendpoint.type.protocol. aliasName.messageaddressingproperties. fromMsgAddr
Reply To (Message Addressing Properties)

webserviceendpoint.type.protocol. aliasName.messageaddressingproperties. replyToMsgAddr
Fault To (Message Addressing Properties)

webserviceendpoint.type.protocol.aliasName. messageaddressingproperties.faultToMsgAddr
Where type can be consumer, provider, or messageaddressing and protocol can be HTTP, HTTPS, or JMS.