JNDI properties in server.xml

JNDI properties in server.xml

To configure administration services and operations console for the application server, set JNDI properties in server.xml.

Property Status Description Restrictions
ibm.worklight.admin.jmx.connector Optional The JMX connector type. Possible values are SOAP and RMI. Default SOAP. WAS only.
ibm.worklight.admin.jmx.host Optional Host name for the JMX REST connection. Liberty profile only.
ibm.worklight.admin.jmx.port Optional Port for the JMX REST connection. Liberty profile only.
ibm.worklight.admin.jmx.user Optional User name for the JMX REST connection. Liberty profile only.
ibm.worklight.admin.jmx.pwd Optional User password for the JMX REST connection. Liberty profile only.
ibm.worklight.admin.rmi.registryPort Optional RMI registry port for the JMX connection through a firewall. Tomcat only.
ibm.worklight.admin.rmi.serverPort Optional RMI server port for the JMX connection through a firewall. Tomcat only.
ibm.worklight.admin.jmx.dmgr.host Mandatory dmgr host name. Server Network Deployment only.
ibm.worklight.admin.jmx.dmgr.port Mandatory dmgr RMI or SOAP port. Server Network Deployment only.
ibm.worklight.admin.actions.prepareTimeout Optional Timeout in milliseconds to transfer data from the management service to the runtime during a deployment transaction. If the runtime cannot be reached within this time, an error is raised and the deployment transaction ends. Default is 1800000 ms (30 min)
ibm.worklight.admin.actions.commitRejectTimeout Optional Timeout in milliseconds, when a runtime is contacted, to commit or reject a deployment transaction. If the runtime cannot be reached within this time, an error is raised and the deployment transaction ends.
Default value: 120000 ms (2 min)
ibm.worklight.admin.lockTimeoutInMillis Optional Timeout in milliseconds for obtaining the transaction lock. Because deployment transactions run sequentially, they use a lock. Therefore, a transaction must wait until a previous transaction is finished. This timeout is the maximal time during which a transaction waits.
Default value: 1200000 ms (20 min)
ibm.worklight.admin.maxLockTimeInMillis Optional The maximal time during which a process can take the transaction lock. Because deployment transactions run sequentially, they use a lock. If the application server fails while a lock is taken, it can happen in rare situations that the lock is not released at the next restart of the application server. In this case, the lock is released automatically after the maximum lock time so the server is not blocked forever. Set a time that is longer than a normal transaction.
Default value: 1800000 (30 min)
ibm.worklight.admin.logging.formatjson Optional Set true to enable pretty formatting (extra blank space) of JSON objects in responses and log messages. Setting this property is helpful when you debug the server.
Default value: false.
ibm.worklight.admin.logging.tosystemerror Optional Whether all logging messages are also directed to System.Error. Setting this property is helpful when you debug the server.
ibm.worklight.admin.proxy.port Optional If the MobileFirst Administration server is behind a firewall or reverse proxy, this property specifies the address of the host. Set this property to enable a user outside the firewall to reach the MobileFirst Administration server. Typically, this property is the port of the proxy, for example 443. It is necessary only if the protocol of the external and internal URIs are different.
ibm.worklight.admin.proxy.protocol Optional If the MobileFirst Administration server is behind a firewall or reverse proxy, this property specifies the protocol (HTTP or HTTPS). Set this property to enable a user outside the firewall to reach the MobileFirst Administration server. Typically, this property is set to the protocol of the proxy. For example, wl.net. Necessary only if the protocol of the external and internal URIs are different.
ibm.worklight.admin.proxy.scheme Optional Alternative name for ibm.worklight.admin.proxy.protocol.
ibm.worklight.admin.proxy.host Optional If the MobileFirst Administration server is behind a firewall or reverse proxy, this property specifies the address of the host. Set this property to enable a user outside the firewall to reach the MobileFirst Administration server. Typically, this property is the address of the proxy.
ibm.worklight.admin.audit Optional. Set this property to false to disable the audit feature of the MobileFirst Server Administration console. Default is true.
ibm.worklight.admin.environmentid Optional. Environment identifier for the registration of the MBeans.
Use this identifier when different instances of the MobileFirst Server are installed on the same application server. The identifier determines which administration services, which console, and which runtimes belong to the same installation. The administration services manage only the runtimes that have the same environment identifier.
ibm.worklight.admin.serverid Optional. Server identifier. Must be different for each server in the farm. For server farms only.
ibm.worklight.admin.hsts Optional. Set to true to enable HTTP Strict Transport Security according to RFC 6797.
ibm.worklight.admin.db.jndi.name Optional JNDI name of the database Default is java:comp/env/jdbc/WorklightAdminDS.
ibm.worklight.admin.db.type Optional Database type. Mandatory when database is not specified by the ibm.worklight.admin.db.jndi.name property.
ibm.worklight.admin.db.openjpa.ConnectionDriverName Optional Fully qualified name of the database connection driver class. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.ConnectionURL Optional The URL for the database connection. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.ConnectionUserName Optional The user name for the database connection. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.ConnectionPassword Optional Password for the database connection. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.Log Optional Passed to OpenJPA and enables JPA logging.
ibm.worklight.topology.platform Not strictly mandatory but the application works best if you set this property. Server type. Valid values:

Liberty

WAS

Tomcat

If we do not set the value, the application tries to guess the server type.
ibm.worklight.topology.clustermode Not strictly mandatory but the application works best if you set this property. In addition to the server type, specify here the server topology. Valid values:

Standalone
Cluster
Farm

The value by default is Standalone.
ibm.worklight.farm.type Optional. For server farms only. Sets the type of the node farm if a node farm is to be used. Only the FILE type is currently supported.
ibm.worklight.farm.definition.location Optional For server farms only. Full path to the XML configuration file for the server farm. The configuration file is checked against the FarmSchema.xsd schema.
ibm.worklight.admin.endpoint Optional Enables the operations console to locate the MobileFirst Server Administration REST services. Specify the external address and context root of the war web application. In a scenario with a firewall or a secured reverse proxy, this URI must be the external URI and not the internal URI inside the local LAN. For example:
https://wl.net:443/worklightadmin

ibm.worklight.admin.global.logout Optional Clears the WebSphere user authentication cache during the console logout. Useful only for WAS V7. Default is false.
ibm.worklight.admin.hsts Optional Set true to enable HTTP Strict Transport Security according to RFC 6797. Default is false.
ibm.worklight.admin.ui.cors Optional Default is true. See the W3C Cross-Origin Resource Sharing page.
ibm.worklight.admin.ui.cors.strictssl Optional Set to false to allow CORS situations where the operations console is secured with SSL (HTTPS protocol) while the MobileFirst Server Administration services are not, or conversely. Takes effect only if the ibm.worklight.admin.ui.cors property is enabled.
ibm.worklight.jndi.configuration Optional If the JNDI configuration is stored as an external file, path to file describing the JNDI configuration. Can also be specified as a system property.
ibm.worklight.jndi.file Optional If the JNDI configuration is stored as an external file, path to file describing the JNDI configuration. Can also be specified as a system property.

Parent topic: Install administration services and the operations console

Property	Status	Description	Restrictions
ibm.worklight.admin.jmx.connector	Optional	The JMX connector type. Possible values are SOAP and RMI. Default SOAP.	WAS only.
ibm.worklight.admin.jmx.host	Optional	Host name for the JMX REST connection.	Liberty profile only.
ibm.worklight.admin.jmx.port	Optional	Port for the JMX REST connection.	Liberty profile only.
ibm.worklight.admin.jmx.user	Optional	User name for the JMX REST connection.	Liberty profile only.
ibm.worklight.admin.jmx.pwd	Optional	User password for the JMX REST connection.	Liberty profile only.
ibm.worklight.admin.rmi.registryPort	Optional	RMI registry port for the JMX connection through a firewall.	Tomcat only.
ibm.worklight.admin.rmi.serverPort	Optional	RMI server port for the JMX connection through a firewall.	Tomcat only.
ibm.worklight.admin.jmx.dmgr.host	Mandatory	dmgr host name.	Server Network Deployment only.
ibm.worklight.admin.jmx.dmgr.port	Mandatory	dmgr RMI or SOAP port.	Server Network Deployment only.
ibm.worklight.admin.actions.prepareTimeout	Optional	Timeout in milliseconds to transfer data from the management service to the runtime during a deployment transaction. If the runtime cannot be reached within this time, an error is raised and the deployment transaction ends. Default is 1800000 ms (30 min)
ibm.worklight.admin.actions.commitRejectTimeout	Optional	Timeout in milliseconds, when a runtime is contacted, to commit or reject a deployment transaction. If the runtime cannot be reached within this time, an error is raised and the deployment transaction ends. Default value: 120000 ms (2 min)
ibm.worklight.admin.lockTimeoutInMillis	Optional	Timeout in milliseconds for obtaining the transaction lock. Because deployment transactions run sequentially, they use a lock. Therefore, a transaction must wait until a previous transaction is finished. This timeout is the maximal time during which a transaction waits. Default value: 1200000 ms (20 min)
ibm.worklight.admin.maxLockTimeInMillis	Optional	The maximal time during which a process can take the transaction lock. Because deployment transactions run sequentially, they use a lock. If the application server fails while a lock is taken, it can happen in rare situations that the lock is not released at the next restart of the application server. In this case, the lock is released automatically after the maximum lock time so the server is not blocked forever. Set a time that is longer than a normal transaction. Default value: 1800000 (30 min)
ibm.worklight.admin.logging.formatjson	Optional	Set true to enable pretty formatting (extra blank space) of JSON objects in responses and log messages. Setting this property is helpful when you debug the server. Default value: false.
ibm.worklight.admin.logging.tosystemerror	Optional	Whether all logging messages are also directed to System.Error. Setting this property is helpful when you debug the server.
ibm.worklight.admin.proxy.port	Optional	If the MobileFirst Administration server is behind a firewall or reverse proxy, this property specifies the address of the host. Set this property to enable a user outside the firewall to reach the MobileFirst Administration server. Typically, this property is the port of the proxy, for example 443. It is necessary only if the protocol of the external and internal URIs are different.
ibm.worklight.admin.proxy.protocol	Optional	If the MobileFirst Administration server is behind a firewall or reverse proxy, this property specifies the protocol (HTTP or HTTPS). Set this property to enable a user outside the firewall to reach the MobileFirst Administration server. Typically, this property is set to the protocol of the proxy. For example, wl.net. Necessary only if the protocol of the external and internal URIs are different.
ibm.worklight.admin.proxy.scheme	Optional	Alternative name for ibm.worklight.admin.proxy.protocol.
ibm.worklight.admin.proxy.host	Optional	If the MobileFirst Administration server is behind a firewall or reverse proxy, this property specifies the address of the host. Set this property to enable a user outside the firewall to reach the MobileFirst Administration server. Typically, this property is the address of the proxy.
ibm.worklight.admin.audit	Optional.	Set this property to false to disable the audit feature of the MobileFirst Server Administration console. Default is true.
ibm.worklight.admin.environmentid	Optional.	Environment identifier for the registration of the MBeans. Use this identifier when different instances of the MobileFirst Server are installed on the same application server. The identifier determines which administration services, which console, and which runtimes belong to the same installation. The administration services manage only the runtimes that have the same environment identifier.
ibm.worklight.admin.serverid	Optional.	Server identifier. Must be different for each server in the farm. For server farms only.
ibm.worklight.admin.hsts	Optional.	Set to true to enable HTTP Strict Transport Security according to RFC 6797.
ibm.worklight.admin.db.jndi.name	Optional	JNDI name of the database Default is java:comp/env/jdbc/WorklightAdminDS.
ibm.worklight.admin.db.type	Optional	Database type. Mandatory when database is not specified by the ibm.worklight.admin.db.jndi.name property.
ibm.worklight.admin.db.openjpa.ConnectionDriverName	Optional	Fully qualified name of the database connection driver class. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.ConnectionURL	Optional	The URL for the database connection. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.ConnectionUserName	Optional	The user name for the database connection. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.ConnectionPassword	Optional	Password for the database connection. Mandatory only when the data source specified by the ibm.worklight.admin.db.jndi.name property is not defined in the application server configuration.
ibm.worklight.admin.db.openjpa.Log	Optional	Passed to OpenJPA and enables JPA logging.
ibm.worklight.topology.platform	Not strictly mandatory but the application works best if you set this property.	Server type. Valid values: Liberty WAS Tomcat If we do not set the value, the application tries to guess the server type.
ibm.worklight.topology.clustermode	Not strictly mandatory but the application works best if you set this property.	In addition to the server type, specify here the server topology. Valid values: Standalone Cluster Farm The value by default is Standalone.
ibm.worklight.farm.type	Optional.	For server farms only. Sets the type of the node farm if a node farm is to be used. Only the FILE type is currently supported.
ibm.worklight.farm.definition.location	Optional	For server farms only. Full path to the XML configuration file for the server farm. The configuration file is checked against the FarmSchema.xsd schema.
ibm.worklight.admin.endpoint	Optional	Enables the operations console to locate the MobileFirst Server Administration REST services. Specify the external address and context root of the war web application. In a scenario with a firewall or a secured reverse proxy, this URI must be the external URI and not the internal URI inside the local LAN. For example: https://wl.net:443/worklightadmin
ibm.worklight.admin.global.logout	Optional	Clears the WebSphere user authentication cache during the console logout. Useful only for WAS V7. Default is false.
ibm.worklight.admin.hsts	Optional	Set true to enable HTTP Strict Transport Security according to RFC 6797. Default is false.
ibm.worklight.admin.ui.cors	Optional	Default is true. See the W3C Cross-Origin Resource Sharing page.
ibm.worklight.admin.ui.cors.strictssl	Optional	Set to false to allow CORS situations where the operations console is secured with SSL (HTTPS protocol) while the MobileFirst Server Administration services are not, or conversely. Takes effect only if the ibm.worklight.admin.ui.cors property is enabled.
ibm.worklight.jndi.configuration	Optional	If the JNDI configuration is stored as an external file, path to file describing the JNDI configuration. Can also be specified as a system property.
ibm.worklight.jndi.file	Optional	If the JNDI configuration is stored as an external file, path to file describing the JNDI configuration. Can also be specified as a system property.