Copyright © Cloud Software Group, Inc. All Rights Reserved

Runtime Properties

This section explains the runtime properties for the Core Engine and the Central Logger component of the gateway. The properties are defined in the asg.properties and asg_cl.properties files respectively.

The runtime properties can be set in one of the following ways: • By using the Config UI. To set the properties on the home page, select the Gateway Engine Properties from the drop-down list next to the icon. • By using a text editor to directly edit the asg.properties and asg_cl.properties files. The files are located in the ASG_CONFIG_HOME directory.

Runtime Properties of Core Engine

The properties for the Core Engine are defined in the asg.properties file located in ASG_CONFIG_HOME directory.

The following properties can be defined:

Table 15 Core Engine Properties

Property Name	Description
tibco.clientVar.ASG/HttpClient/useSynchHttpClient
	A boolean field used to send a request to the target side by running the http client in the same thread as the facade processing. Use the synchronous http client when a high load of short lived requests are expected If the value is set to true, the client sends an synchronous request for HTTP transport. If the value is set to false, an asynchronous request is sent for HTTP transport. The default is false.
tibco.clientVar.ASG/HttpClient/workers
	The number of threads used for HTTP Client. This is relevant only if the value of the useSynchHttpClient is false (that is, when an asynchronous request is sent for HTTP transport). The default is 10.
tibco.clientVar.ASG/modRV/facade_request
	Specifies the Rendezvous subject name which is used by the Core Engine to listen for requests from the Apache module. The default is _LOCAL.asg.north.request.
tibco.clientVar.ASG/modRV/facade_request_binary
	Specifies the Rendezvous subject name which is used by the Core Engine to listen for binary requests from the Apache module. The default is _LOCAL.asg.north.request_binary
tibco.clientVar.ASG/modRV/facade_response
	Specifies the Rendezvous subject to send the response when the Apache module is configured not to use the auto-generated reply subject. If the Apache module is configured to use the reply subject, this is ignored.
tibco.clientVar.ASG/modRV/RvDaemon
	Specifies the value of the Rendezvous daemon for the Core Engine to connect and listen for the requests from the Apache module.
tibco.clientVar.ASG/modRV/RvNetwork
	Specifies the value of the Rendezvous network for the Core Engine to connect and listen for the requests from the Apache module.
tibco.clientVar.ASG/modRV/RvService
	Specifies the value of the Rendezvous service for the Core Engine to connect and listen for the requests from the Apache module.
tibco.clientVar.ASG/GTM/RV/RvDaemon
	Specifies the value of the Rendezvous daemon for the Core Engine to connect to the Global Throttle Manager.
tibco.clientVar.ASG/GTM/RV/RvNetwork
	Specifies the value of the Rendezvous network for the Core Engine to connect to the Global Throttle Manager.
tibco.clientVar.ASG/GTM/RV/RvService
	Specifies the value of the Rendezvous service for the Core Engine to connect to the Global Throttle Manager.
tibco.clientVar.ASG/CL/RV/RvDaemon
	Specifies the value of the Rendezvous daemon for the Core Engine to send messages to the Central Logger.
tibco.clientVar.ASG/CL/RV/RvNetwork
	Specifies the value of the Rendezvous network for the Core Engine to send messages to the Central Logger.
tibco.clientVar.ASG/CL/RV/RvService
	Specifies the value of the Rendezvous service for the Core Engine to send messages to the Central Logger.
tibco.clientVar.Common/Connections/RV/SubjectPrefix
	Specifies the prefix for all Rendezvous subject names used between the Core Engine and the Central Logger, the Core Engine and the Global Throttle Manager components. The default is TIBCO.ASG.INTERNAL.
tibco.clientVar.ASG/Deployments/AllowHotUpdate
	Set this field as true or false to enable or disable hot configuration updates. The default is false.
tibco.clientVar.ASG/ConfigRoot
	• Specifies the root directory for an entire configuration. • If this property is set, the configuration value specified for this property takes precedence over the configuration specified by asg-engine command-line option such as asg-engine.exe -a <Config project name>. For example, the root directory for default configuration is: C:/ProgramData/ASG200/tibco/cfgmgmt/asg/default
tibco.clientVar.EXAMPLES_HOME
	Specifies the home directory for the examples shipped with TIBCO API Exchange Gateway. For example, the home directory for the examples directory is: ASG_HOME/examples
tibco.clientVar.ASG/Response/DefaultContentType
	Specifies the default content-type and format of error response content when the error message is returned from the TIBCO API Exchange Gateway for any incoming request. The possible values are as follows: − application/json − application/xml − text/xml The default value is application/json.
tibco.clientVar.ASG/Logging/reportingEnabled
	Specifies if reporting to the Central Logger is enabled or not. By default, the Core Engine does not record the transactions to Central Logger. The default is false. See Enable Reporting to the Central Logger.
tibco.clientVar.ASG/Logging/interval
	Specifies the time interval (in milliseconds) between the Core Engine and the Central Logger to record transactions. The default is 30000.
tibco.clientVar.ASG/Logging/MinLogLevel
	Set this field to enable the detail level logging for the Central Logger component. If the value is 1,the Central Logger records all the details of transaction. If the value is 0, the Central Logger records high level transaction. The default is 0.
tibco.clientVar.ASG/Throttle/UpdateIntervalSec
	Specifies the time interval (in seconds) for sending throttle updates to the Global Throttle Manager. The default is 10.
tibco.clientVar.ASG/anonymous/PartnerName/Authenticated
	Specifies the default partner name for the unauthenticated requests. The default value is anon.
tibco.clientVar.ASG/Endpoint/ESB0/requestQueue
	Specifies the queue name for an Enterprise Service Bus (ESB) channel (one) communication for the target operation request. The default queue name is asg.out.request.
tibco.clientVar.ASG/Endpoint/ESB0/replyQueue
	Specifies the queue name for ESB channel (one) communication for the target operation response. The default queue name is asg.out.request.reply.0.0
tibco.clientVar.ASG/Endpoint/ESB1/requestQueue
	Specifies the queue name for an ESB channel (two) communication for the target operation request. The default queue name is asg.out.request.
tibco.clientVar.ASG/Endpoint/ESB1/replyQueue
	Specifies the queue name for an ESB channel (two) communication for the target operation response. The default queue name is asg.out.request.reply.0.1
tibco.clientVar.ASG/Endpoint/ESB2/requestQueue
	Specifies the queue name for an ESB channel (three) communication for the target operation request. The default queue name is asg.out.request.
tibco.clientVar.ASG/Endpoint/ESB2/replyQueue
	Specifies the queue name for an ESB channel (three) communication for the target operation response. The default queue name is asg.out.request.reply.0.2
tibco.clientVar.ASG/facade/ESB0/requestQueue
	Specifies the queue name to be used for the requests sent by the client at the facade side when the inbound channel is ESB (JMS transport with XML). The default queue name is asg.in.request.
tibco.clientVar.ASG/facade/ESB0/replyQueue
	Specifies the queue name to be used for the facade responses received for the client requests when the inbound channel is ESB (JMS transport with XML). The default queue name is asg.in.request.reply.0
tibco.clientVar.ASG/facade/SOAPJMS/requestQueue
	Specifies the queue name to be used for the facade requests sent by the client when the inbound transport is SOAP JMS. The default queue name is asg.soap.in.request.
tibco.clientVar.ASG/facade/SOAPJMS/replyQueue
	Specifies the queue name to be used for the facade responses received for the client requests when the inbound transport is SOAP JMS. The default queue name is asg.soap.in.request.reply.0
tibco.clientVar.ASG/Endpoint/SOAPJMS/DefaultTargetRequestQueue
	Specifies the queue name to be used for the requests sent to target operations when the inbound transport is SOAP JMS. The default queue name is asg.soap.forward.
tibco.clientVar.ASG/Endpoint/SOAPJMS/TargetResponseQueue
	Specifies the queue name to be used for the target responses received from the target operations when the inbound transport is SOAP JMS. The default queue name is asg.soap.forward.reply.0
EMS Server Connections (Facade ESB Channel)
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/JMSProviderURL
	Specifies the connection URL for the EMS Server used for facade operation requests from ESB communication domain. ESB communication uses JMS transport with XML. The default is tcp://localhost:7222.
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/JNDIContextURL
	Specifies the URL to the JNDI service provider used for facade operation requests with ESB communication domain. The default is tibjmsnaming://localhost:7222.
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the facade side. The default is TopicConnectionFactory.
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the facade side. The default is QueueConnectionFactory.
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/JNDIUsername
	Specifies the user name for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty. The default is admin.
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/JNDIPassword
	Specifies the password for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/JMSUsername
	Specifies the user name for logging into the EMS server in the ESB communication domain at the facade side. The default is admin.
tibco.clientVar.Common/Connections/JMS/FacadeEsbConnection0/JMSPassword
	Specifies the password for logging into the EMS server in the ESB communication domain at the facade side.
EMS Server Connections for ESB Channel1 at Target Side
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/JMSProviderURL
	Specifies the connection URL for the EMS Server used for target operation requests sent to back-end services in ESB communication domain. ESB communication uses JMS transport with XML. The default is tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/JNDIContextURL
	Specifies the URL to the JNDI service provider used for target operation requests sent to back-end services in ESB communication domain. The default value is tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the target operation side. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the target operation side. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/JNDIUsername
	Specifies the user name for logging into the JNDI server in the ESB communication domain at the target operation side. If the JNDI provider does not require access control, this field can be empty. The default value is admin
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/JNDIPassword
	Specifies the password for logging into the JNDI server in the ESB communication domain at the target operation side. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/JMSUsername
	Specifies the user name for logging into the EMS server in the ESB communication domain at the target operation side. The default value is admin
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection0/JMSPassword
	Specifies the password for logging into the EMS server in the ESB communication domain at the target operation side.
EMS Server Connections for ESB Channel2 at Target Side
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/JMSProviderURL
	Specifies the connection URL for the EMS Server used for target operation requests sent to back-end services in ESB communication domain. ESB communication uses JMS transport with XML. The default is tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/JNDIContextURL
	Specifies the URL to the JNDI service provider used for target operation requests sent to back-end services in ESB communication domain. The default value is tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the target operation side. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the target operation side. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/JNDIUsername
	Specifies the user name for logging into the JNDI server in the ESB communication domain at the target operation side. If the JNDI provider does not require access control, this field can be empty. The default value is admin
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/JNDIPassword
	Specifies the password for logging into the JNDI server in the ESB communication domain at the target operation side. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/JMSUsername
	Specifies the user name for logging into the EMS server in the ESB communication domain at the target operation side. The default value is admin
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection1/JMSPassword
	Specifies the password for logging into the EMS server in the ESB communication domain at the target operation side.
EMS Server Connections for ESB Channel3 at Target Side
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/JMSProviderURL
	Specifies the connection URL for the EMS Server used for target operation requests sent to back-end services in ESB communication domain. ESB communication uses JMS transport with XML. default is tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/JNDIContextURL
	Specifies the URL to the JNDI service provider used for target operation requests sent to back end services in ESB communication domain. The default value is tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the target operation side. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the target operation side. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/JNDIUsername
	Specifies the user name for logging into the JNDI server in the ESB communication domain at the target operation side. If the JNDI provider does not require access control, this field can be empty. The default value is admin
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/JNDIPassword
	Specifies the password for logging into the JNDI server in the ESB communication domain at the target operation side. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/JMSUsername
	Specifies the user name for logging into the EMS server in the ESB communication domain at the target operation side. The default value is admin
tibco.clientVar.Common/Connections/JMS/TargetEsbConnection2/JMSPassword
	Specifies the password for logging into the EMS server in the ESB communication domain at the target operation side.
Connection Parameters for SOAP JMS (Facade)
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JMSProviderURL
	Specifies the connection URL for the EMS Server used for client requests when SOAP JMS transport is used at the facade side. The default value is tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JNDIContextURL
	Specifies the URL to the JNDI service provider used for client requests when SOAP JMS transport is used at the facade side. The default value is tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with JMS application at facade side. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with JMS application at facade side. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JNDIUsername
	Specifies the user name for logging into the JNDI server used to send client requests at facade side. If the JNDI provider does not require access control, this field can be empty. The default value is admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JNDIPassword
	Specifies the password for logging into the JNDI server used to send client requests at facade side. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JMSUsername
	Specifies the user name for logging into the EMS server used to send client requests at facade side. The default value is admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JMSPassword
	Specifies the password for logging into the EMS server used to send client requests at facade side.
Connection Parameters for SOAP JMS (Target)
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JMSProviderURL
	Specifies the connection URL for the EMS Server when SOAP JMS transport is used at the target operation side. The default value is tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JNDIContextURL
	Specifies the URL to the JNDI service provider when SOAP JMS transport is used at the target operation side. The default value is tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with JMS application at target operation side. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with JMS application at target operation side. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JNDIUsername
	Specifies the user name for logging into the JNDI server when SOAP JMS transport is used at the target operation side. If the JNDI provider does not require access control, this field can be empty. The default value is admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JNDIPassword
	Specifies the password for logging into the JNDI server when SOAP JMS transport is used at the target operation side. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JMSUsername
	Specifies the user name for logging into the EMS server when SOAP JMS transport is used at the target operation side. The default value is admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JMSPassword
	Specifies the password for logging into the EMS server when SOAP JMS transport is used at the target operation side.
Connection Parameters for HTTP Channel(Facade)
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPConnection/Port
	Specifies the port through which the Core Engine accepts HTTP requests from the client. The default value is 9222
Connection Parameters for HTTPS Channel(Facade)
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/Port
	Specifies the port through which the Core Engine accepts SSL enabled HTTP requests from client. The default value is 9233
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/useSSL
	This is a boolean field which indicates if SSL should be enabled for accepting HTTPs requests. If set to true SSL is enabled to accept the requests using HTTPs transport.
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/Identity
	Specifies an identity resource which is used by FacadeHTTPSSLConnection HTTP shared resource to provide SSL properties.
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/IdentityFileType
	• Specifies the type of identity resource. The possible values are as follows: − url − certPlusKeyURL • Set the IdentityFileType property to url for Identity File type. • Set the IdentityFileType property to certPlusKeyURL for Certificate/Private Key type. • If the IdentityFileType property is set to url, set the IdentityType,IdentityURL , and IdentityFilePassword properties. • If the IdentityFileType property is set to certPlusKeyURL, set the CertificateURL, KeyURL and IdentityFilePassword properties.
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/IdentityType
	Specifies the type of the file if the IdentityFileType property is set to url. The supported values are as follows: − JCEKS − JKS − PEM − PKCS12
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/IdentityURL
	Specifies the URL to the identity file if the IdentityFileType property is set to url. For example, C:\keystore.jks
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/IdentityFilePassword
	Specifies the password of the identity file or private key. • if the IdentityFileType property is set to url, this refers the password for the identity file. • if the IdentityFileType property is set to certPlusKeyURL, this refers the password for the private key.
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/CertificateURL
	Specifies the URL to the certificate file if the IdentityFileType property is set to certPlusKeyURL. For example, C:\mydomain.csr
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/KeyURL
	Specifies the URL to the private key in certificate file if the IdentityFileType property is set to certPlusKeyURL. For example, C:\keystore.jks
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/RequiresClientAuthentication
	Indicates a boolean flag to enable or disable mutual SSL authentication for HTTPs transport between the client and the gateway. When this field is set to true, the Trusted Certificates Folder becomes enabled so that you can specify a location containing the list of trusted certificate authorities.
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/TruststorePassword
	Specifies the password to access the certificate stored in the folder defined by TrustedCertificateFolder property.
tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/TrustedCertificateFolder
	Required when the RequiresClientAuthentication property is set to true. Specifies a folder in the project containing one or more certificates from trusted certificate authorities, which is required for mutual SSL authentication.This folder is checked when a client connects to ensure that the client is trusted.
OAuth Properties
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsConnection/Host
	Specifies the host IP address of the TIBCO API Exchange Gateway OAuth Server.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsConnection/Port
	Specifies the non-SSL port number of the TIBCO API Exchange Gateway OAuth Server. The default value is 9322.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsConnection/Webapps
	• Specifies the location of the OAuth web application. • Change this only if you want to add custom login page or access grant page to the OAuth server.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/Port
	Specifies the SSL port number of the TIBCO API Exchange Gateway OAuth Server. The default value 9333.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/useSSL
	A boolean field which indicates if SSL should be enabled for accepting HTTPS requests for OAuth APIs and servlets. If set to true SSL is enabled to accept the requests using HTTPS transport for the OAuth server. The default value is true.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/Identity
	Specifies an identity resource which is used by OAuthWebappsSSLConnection HTTP shared resource to provide SSL properties for OAuth servlets and APIs. The default value is /DefaultImplementation/SharedResources/HTTP/OAuthIdentityResource.id
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/IdentityFileType
	• Specifies the type of identity resource set for OAuth server. The possible values are as follows: − url − certPlusKeyURL • Set the IdentityFileType property to url for Identity File type. • Set the IdentityFileType property to certPlusKeyURL for Certificate/Private Key type. • If the IdentityFileType property is set to url, set the IdentityType,IdentityURL , and IdentityFilePassword properties. • If the IdentityFileType property is set to certPlusKeyURL, set the CertificateURL, KeyURL and IdentityFilePassword properties.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/IdentityType
	Specifies the type of the file if the IdentityFileType property is set to url. The supported values are as follows: − JCEKS − JKS − PEM − PKCS12
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/IdentityURL
	Specifies the URL to the identity file if the Identity file type is of the type Identity File for OAuth server SSL connection. For example, C:\keystore.jks
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/IdentityFilePassword
	Specifies the password of the identity file or private key used for SSL connection to the OAuth server. • if the IdentityFileType property is set to url, this refers the password for the identity file. • if the IdentityFileType property is set to certPlusKeyURL, this refers the password for the private key.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/CertificateURL
	Specifies the URL to the certificate file used for OAuth server SSL connection if the Identity file type is of the type Certificate/Private Key.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/KeyURL
	Specifies the URL to the private key in certificate file used for OAuth server SSL connection if the Identity file type is of the type Certificate/Private Key.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/RequiresClientAuthentication
	Indicates a boolean flag to enable or disable mutual SSL authentication for HTTPs transport used for OAuth server requests from the requestor. When this field is set to true, the Trusted Certificates Folder becomes enabled so that you can specify a location containing the list of trusted certificate authorities.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/TruststorePassword
	Specifies the password to access the certificate stored in the folder defined by the TrustedCertificateFolder property.
tibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/TrustedCertificateFolder
	Required when the RequiresClientAuthentication property is set to true. Specifies a folder in the project containing one or more certificates from trusted certificate authorities, which is required for mutual SSL authentication.This folder is checked when a client connects to ensure that the client is trusted.
Enable JMS Transport for Central Logger
tibco.clientVar.ASG/Logging/transport
	Specifies the transport to be used between the Core Engine and the Central Logger component to log the transactions.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSProviderURL
	Specifies the URL to connect to the Enterprise Message Service (EMS) or a JMS server. Example: tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIContextURL
	Specifies a JNDI connection URL to look up a JMS server. Example: tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with JMS server for the Central Logger. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with JMS server for the Central Logger. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIUsername
	Specifies the user name to use when logging into the JNDI server. If the JNDI provider does not require access control, this field can be empty. Example, admin
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIPassword
	Specifies the password for logging into the JNDI server. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSUsername
	Specifies the user name to use to authenticate to the JMS server.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSPassword
	Specifies the password to use to authenticate to the JMS server.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TransactionReportDestinationName
	Specifies the name of the JMS destination to which the transaction reports are sent to the Central Logger by the Core Engine. For example, asg.cl.transaction.queue
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TransactionReportDestinationType
	Specifies the type of the JMS destination to which the transaction reports are sent to the Central Logger by the Core Engine. The possible values are queue and topic. The default value is queue. The Central Logger always listens on a queue. If the value of destination type set to topic, the JMS administrator must configure a bridge between the topic and the queue.
tibco.clientVar.ConfigApi.ConfigurationBackupProperty
	Specifies the maximum number of latest revisions of the configuration projects to be kept.
SSL JMS Transport Properties for Central Logger
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/useSSL
	Specifies if SSL is enabled for the Central Logger when using the JMS transport. Set this to true to enable SSL for the JMS transport.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TrustedCertificatesFolder
	If you use the SSL enabled JMS transport for Central Logger, this field specifies a location of the trusted certificates on this machine. The trusted certificates are a collection of certificates from servers with which you establish connections. If the server with which the connection is going to be established, presents a certificate that does not match one of your trusted certificates, the connection is refused. This prevents connections to unauthorized servers. Import the trusted certificates into a folder before you select the folder in this field.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/Identity
	Specifies an identity resource used to provide the SSL properties for JMS transport. The default value is: /Common/SharedResources/JMS/CL_JMSConnIdentityResource.id
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TrustStorePassword
	Specifies the password to access the certificate stored in the folder defined by the Trusted Certificate Folder field. The certificate is required for SSL connection.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/trace
	Specifies whether SSL tracing should be enabled during the SSL connection. If the value is set to true, the SSL connection messages are logged and sent to the console.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/debugTrace
	Specifies whether SSL debug tracing should be enabled during the SSL connection. Debug tracing provides more detailed messages than standard tracing.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/verifyHostName
	Specifies whether the host you are connecting to is the expected host. The host name in the digital certificate of the host is compared against the value in the Expected Host Name field. If the host name does not match the expected host name, the connection is refused.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/ExpectedHostName
	Specifies the name of the host you are expecting to connect to. This field is only relevant if the Verify Host Name field is set to true. If the name of the host in the digital certificate of host does not match the value specified in this field, the connection is refused.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/strongCipherSuitesOnly
	When this field is set to true, this specifies the minimum strength of the cipher suites that can be specified with the bw.plugin.security.strongcipher.minstrength custom engine property. See TIBCO ActiveMatrix BusinessWorks Administration for more information about this property. The default value of the property disables cipher suites with an effective key length below 128 bits. When this field is set to false, only cipher suites with an effective key length of up to 128 bits can be used.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityType
	Speicifies the type of identity resource for SSL connection. The possible values are: − certPlusKeyURL − url − usernamePassword
Properties for Identity Type=usernamePassword Use this option if you want to use a username and password for authentication instead of a certificate.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityUsername
	Specifies the name of the user for this identity.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityPassword
	Specifies the password for the user for this identity
Properties for Identity Type=url Use this option if the certificate includes the private key information in the same file.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityFileType
	Specifies the type of certificate file if Identity Type is set to url. The accepted values are as follows: − Entrust − JCEKS − JKS − PEM − PKCS12
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityURL
	Specifies the location of the certificate (which includes the private key) if Identity Type is set to url. For example, C:\asgserver.pfx
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/KeyPassword
	Specifies the password for the certificate if Identity Type is of url type.
Properties for Identity Type=certPlusKeyURL Use this option if the private key and the certificate are in two separate files.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/KeyPassword
	Specifies the password for the certificate if Identity Type is of certPlusKeyURL type.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/CertificateURL
	Specifies the URL to the certificate file if Identity Type is of certPlusKeyURL type.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/KeyURL
	Specifies the URL to the private key in the certificate file if Identity Type is of certPlusKeyURL type.
OAuth Server Related Settings
Properties For OAuth Data Space
tibco.clientVar.oauth.dataspace.metaspace.name
	• Specifies the metaspace name used by the OAuth server. • The default value is ASG-OAuth-Tokens
tibco.clientVar.oauth.dataspace.local.discovery
	Specifies the discovery URL for this OAuth instance of the metaspace discovers the current metaspace members. For example, tcp://machine1_IP_Address:6300;machine2_IP_Address:6300
tibco.clientVar.oauth.dataspace.local.listen
	Specifies the listening URL for this OAuth instance of the metaspace. For example, tcp://machine1_IP_Address:6300
tibco.clientVar.oauth.dataspace.remote.discovery
	Specifies the remote discovery URL for this OAuth instance of the metaspace discovers the current metaspace members.
tibco.clientVar.oauth.dataspace.remote.listen
	Specifies the remote listening URL for this OAuth instance of the metaspace.
tibco.clientVar.oauth.dataspace.load.batch.size
	Specifies the maximum number of entries to return when querying data such as access token.
tibco.clientVar.oauth.access.token.retention.period
	Specifies the expiration time (in minutes) for an access token. The default value is 60 minutes. When the access token passes expiration time as specified by this property, it is no longer valid but still remains in the database. The access token is removed from the database based on the value specified by the tibco.clientVar.oauth.access.token.space.ttl property. Note: In a multi-instance TIBCO API Exchange environment, if you change the TTL value on a gateway instance, shut down all instances that connect to that metaspace and then restart the instances.
tibco.clientVar.oauth.access.token.space.ttl
	Specifies the retention period (in minutes) for an access token. The default value is 1440 minutes (1 day) . When the access token passes retention period as specified by this property, the token is removed from the database. By default, the access token is removed from the database after 1 day.
Properties For OAuth Persister
tibco.clientVar.oauth.dataspace.persister.store
	• Defines the type of persistence store. The possible values are: − InMemory − Database If the Database is set, you must define the properties for database server connection.
Properties For OAuth Server Persister Store of Database Type
tibco.clientVar.oauth.dataspace.persister.jdbc.driver
	Specifies the database JDBC driver when the database is used as OAuth persistence store.
tibco.clientVar.oauth.dataspace.persister.jdbc.url
	Specifies the JDBC URL for the database server when the database is used as OAuth persistence store.
tibco.clientVar.oauth.dataspace.persister.jdbc.username
	Specifies the user to connect to the database server when the database is used as OAuth persistence store.
tibco.clientVar.oauth.dataspace.persister.jdbc.password
	Specifies the password of the user to connect to the database server when the database is used as OAuth persistence store.
Properties For OAuth Adapters
tibco.clientVar.oauth.adapter.resource.home
	Specifies the directory from where the custom adapters loads the resources such as properties file used by adapters. This directory location is relative to the ASG_HOME. For example, if the value is specified as /examples/Adapters/resources, the custom adapter looks for the resources such as properties file in the directory ASG_HOME/examples/Adapters/resources.
tibco.clientVar.oauth.owner.adapter.class
	• Specifies the class that provides the Owner Adapter interface. This adapter will be used to authenticate the resource owner and provide the login and access grant pages. For example, for file based owner adapter interface, value specified as: com.tibco.asg.oauth.identity.provider.file.OwnerAdapterService
tibco.clientVar.oauth.client.adapter.class
	Specifies the class that provides the Client Adapter interface.
tibco.clientVar.oauth.scope.adapter.class
	• Specifies the class that provides the Scope Adapter interface. This adapter will be used to retrieve the scope description and the scope form a specific resource for a given owner. For example, for file based scope adapter interface, value specified as: com.tibco.asg.oauth.identity.provider.file.ScopeAdapterService
Advanced Properties
tibco.clientVar.ASG/Headers/SoapAction/RemoveQuotes
	Enables the Core Engine to remove quotes from the incoming SOAPAction header of the facade request. Set this property to true to remove single or double quotes from SOAPAction header of the request. If the property is set to false or has no value, the single or double quotes from SOAPAction header are not removed, which is the default behavior.
tibco.clientVar.MessageEncoding
	Specifies the encoding for the payloads in the request sent to TIBCO API Exchange Gateway through the Apache server using the HTTP transport. The default is ISO-8859. Set this property to UTF-8 to enable the Core Engine to handle non-ASCII characters in the request and response payloads of the request sent to TIBCO API Exchange Gateway using the RV channel through the Apache server.
tibco.clientVar.ASG/RV/Headers/RequiresLowerCase
	Enables the Core Engine to convert all the header names in lower case for a request when a HTTP request is sent to TIBCO API Exchange Gateway from the Apache server.
tibco.clientVar.ASG/Request/Headers/KeepPassthroughHeaders
	Enables the core engine to forward the HTTP headers of northbound incoming request to the southbound request the when pass-through mapping is configured. Set this property to true to copy the HTTP headers of northbound request to southbound request when the pass-through mapping is configured for forward mapper of the target operation. Do not configure any values for the Headers To Forward field of target operation when setting this property to true.

Runtime Properties of Central Logger

The properties for the Central Logger are defined in the asg_cl.properties file located in ASG_CONFIG_HOME directory.

The following properties can be defined, if the default values do not serve your purpose:

Table 16 Central Logger Properties

Property Name	Description
tibco.clientVar.CL/Logging/fileFilter
	Lists the name of the facade operation as a pipe ('|') separated string. The logs from these operations are logged to files instead of database. For example: ping|test
tibco.clientVar.CL/Logging/files/directory
	Specifies the directory name for transactions log file used by the Core Engine to record the transactions. The default value is ASG_HOME/bin/logs
tibco.clientVar.CL/Logging/files/transactions
	Specifies the name of the transactions log file used by the Core Engine to record the transactions. This is used only for the records which is filtered by the tibco.clientVar.CL/Logging/fileFilter property. The default value is trans_log.txt
tibco.clientVar.CL/Logging/files/maxcount
	Specifies the maximum number of log files to keep on roll over for the transactions log file. The default value is 3
tibco.clientVar.CL/Logging/files/maxsize
	Specifies the maximum size of the log file, in bytes, at which to roll-over to the next log file. The default value is 1000
tibco.clientVar.ASG/Logging/tsFormat=yyyyMMdd HH:mm:ss.SSSS
	Specifies the format of the log's timestamp value.
tibco.clientVar.Common/Connections/RV/SubjectPrefix
	Specifies the prefix for all Rendezvous subject names used between Core Engine and Central Logger. The default value is TIBCO.ASG.INTERNAL
RV Session Connection Parameters
tibco.clientVar.ASG/CL/RV/RvService
	Specifies the service parameter for Rendezvous used between Core Engine and Central Logger communication. The default value is 7500
tibco.clientVar.ASG/CL/RV/RvDaemon
	Specifies the daemon parameter for Rendezvous used between Core Engine and Central Logger communication. The default value is tcp:7500
tibco.clientVar.ASG/CL/RV/RvNetwork
	Specifies the network parameter for Rendezvous used between Core Engine and Central Logger communication.
Database Connection Parameters
be.dbconcepts.dburi
	/CentralLogger/SharedResources/Logging Database.sharedjdbc
be.dbconcepts.connection.retry.count
	Specifies the number of attempts to be made for the Central Logger to connect to the database server.
be.dbconcepts.connection.check.interval
	Specifies the time interval (in seconds) for the Central Logger to connect to the database server. The default value is 5
tibco.clientVar.CL/Database/Username
	Specifies the username for the Central Logger to connect to the database server. The default value is asguser
tibco.clientVar.CL/Database/Password
	Specifies the password for the Central Logger to connect to the database server.
tibco.clientVar.CL/Database/Driver
	Specifies the database driver for the database server used by the Central Logger. For example: For oracle database, the value is defined as: oracle.jdbc.OracleDriver For MS SQL server, the value is defined as: com.microsoft.sqlserver.jdbc.SQLServerDriver
tibco.clientVar.CL/Database/Url
	Specifies the database server connection URL for the Central Logger. For example: For oracle database, the value is defined as: jdbc:oracle:thin:@localhost:1521:asgstat For MS SQL server, the value is defined as: sqlserver://localhost:1433;databaseName=asgstat
tibco.clientVar.CL/Database/Schema
	Specifies the database schema to be used by the Central Logger on the database server. For example: For oracle database, the value is defined as: asgstat For MS SQL server, the value is defined as: dbo
Enable JMS Transport for Central Logger Properties
tibco.clientVar.ASG/Logging/transport
	Specifies the transport to be used between the Core Engine and Central Logger component to log the transactions. Valid values are RV or JMS.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSProviderURL
	Specifies the URL to connect to the Enterprise Message Service (EMS) or a JMS server. Example: tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIContextURL
	Specifies a JNDI connection URL to look up a JMS server. Example: tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TopicConnectionFactoryName
	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with JMS server for the Central Logger. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/QueueConnectionFactoryName
	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with JMS server for the Central Logger. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIUsername
	Specifies the user name to use when logging into the JNDI server. If the JNDI provider does not require access control, this field can be empty. Example, admin
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIPassword
	Specifies the password for logging into the JNDI server. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSUsername
	Specifies the user name to use to authenticate to the JMS server.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSPassword
	Specifies the password to use to authenticate to the JMS server.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TransactionReportDestinationName
	Specifies the name of the JMS destination where the transaction reports are sent to the Central Logger by the Core Engine. For example, asg.cl.transaction.queue
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TransactionReportDestinationType
	Specifies the type of the JMS destination where the transaction reports are sent to the Central Logger by the Core Engine. Possible values are queue or topic. The default value is queue The Central Logger always listens on a queue. If the value of destination type is set to topic, the JMS administrator must configure a bridge between the topic and the queue.
SSL JMS Transport Properties for Central Logger
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/useSSL
	Specifies if SSL is enabled for the Central Logger when using the JMS transport. Set this to true to enable SSL for the JMS transport.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TrustedCertificatesFolder
	If you use the SSL enabled JMS transport for Central Logger, this field specifies a location of the trusted certificates on this machine. The trusted certificates are a collection of certificates from servers with which you establish connections. If the server with which the connection is going to be established, presents a certificate that does not match one of your trusted certificates, the connection is refused. This prevents connections to unauthorized servers. Import the trusted certificates into a folder before you select the folder in this field.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/Identity
	Specifies an identity resource used to provide the SSL properties for JMS transport. The default value is: /Common/SharedResources/JMS/CL_JMSConnIdentityResource.id
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TrustStorePassword
	Specifies the password to access the certificate stored in the folder defined by the Trusted Certificate Folder field. The certificate is required for SSL connection.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/trace
	Specifies whether SSL tracing should be enabled during the SSL connection. If the value is set to true, the SSL connection messages are logged and sent to the console.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/debugTrace
	Specifies whether SSL debug tracing should be enabled during the SSL connection. Debug tracing provides more detailed messages than standard tracing.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/verifyHostName
	Specifies whether the host you are connecting to is the expected host. The host name in the digital certificate of the host is compared against the value in the Expected Host Name field. If the host name does not match the expected host name, the connection is refused.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/ExpectedHostName
	Specifies the name of the host you are expecting to connect to. This field is only relevant if the Verify Host Name field is set to true. If the name of the host in the digital certificate of host does not match the value specified in this field, the connection is refused.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/strongCipherSuitesOnly
	When this field is set to true, this specifies the minimum strength of the cipher suites that can be specified with the bw.plugin.security.strongcipher.minstrength custom engine property. See TIBCO ActiveMatrix BusinessWorks Administration for more information about this property. The default value of the property disables cipher suites with an effective key length below 128 bits. When this field is set to false, only cipher suites with an effective key length of up to 128 bits can be used.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityType
	Speicifies the type of identity resource for SSL connection. The possible values are: − certPlusKeyURL − url − usernamePassword
Properties for Identity Type=usernamePassword Use this option if you want to use a username and password for authentication instead of a certificate.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityUsername
	Specifies the name of the user for this identity.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityPassword
	Specifies the password for the user for this identity
Properties for Identity Type=url Use this option if the certificate includes the private key information in the same file.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityFileType
	Specifies the type of certificate file if Identity Type is set to url. The accepted values are as follows: − Entrust − JCEKS − JKS − PEM − PKCS12
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/IdentityURL
	Specifies the location of the certificate (which includes the private key) if Identity Type is set to url. For example, C:\asgserver.pfx
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/KeyPassword
	Specifies the password for the certificate if Identity Type is of url type.
Properties for Identity Type=certPlusKeyURL Use this option if the private key and the certificate are in two separate files.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/KeyPassword
	Specifies the password for the certificate if Identity Type is of certPlusKeyURL type.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/CertificateURL
	Specifies the URL to the certificate file if Identity Type is of certPlusKeyURL type.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/KeyURL
	Specifies the URL to the private key in the certificate file if Identity Type is of certPlusKeyURL type.

Copyright © Cloud Software Group, Inc. All Rights Reserved