Post-Installation Tasks
Configuring Secure Sockets Layer (SSL) Certificate
You can troubleshoot trusted certification issues.
Important: Apple's App Transport Security (ATS) mandates HTTPS for all communication and requires the use of TLS v1.2 or higher for all SSL certificates and load balancers.
For Apple apps to work properly and adhere to App Store guidelines, you must enable your Volt MX Foundry on-premises instance with SSL and configure your network infrastructure to use TLS version 1.2 or higher. For more information, please refer to the following: HCL Basecamp article on ATS Compliance.
After installing Volt MX Foundry on HTTPS, import your SSL certificate (for example, domain.subdomain.crt
) into your Volt MX Foundry Installer's JRE trusted certificate authority (CA) certificates file - for example, <INSTALL_DIR>/jre/lib/security/cacerts
If your SSL certificate is not configured, the system displays an error - "peer not authenticated."
To enable communication between Volt MX Foundry Console and other products such as Volt MX Foundry Integration, and Volt MX Foundry Engagement Services, follow these steps:
- import each product's certificate (VoltMX Foundry Integration, and Volt MX Foundry Engagement Services) into the Volt MX Foundry console (for example,
<INSTALL_DIR>/jre/lib/security/cacerts
). - import console cert into the product boxes cacerts such as Volt MX Foundry Integration, Volt MX Foundry Engagement Services, and Volt MX Foundry Management.
How to Add an Installer Generated Self-Signed SSL Certificate to Cacerts
To add an installer generated self-signed SSL certificate to cacerts, follow these steps:
- From your Volt MX Foundry installed system, open the Linux terminal, and run the following command to generate an
intermediate.crt
file from the keystore:<USERINSTALLDIR>/jre/bin/keytool -export -alias "<HOST_URL_SSL_CONF>" -file <USERINSTALLDIR>/intermediate.crt -keystore <USERINSTALLDIR>/keystore.jks -storepass <Passsword_of_keystore>
Based on the hostname and keystore password provided at the SSL Certificate window, the preceding command exports the required certificate from the source keystore with the given name - for example,
intermediate.crt
. - Run the following command to import the
intermediate.crt
certificate file into your Volt MX Foundry Installer’s JRE trusted certificate authority (CA) certificates file:<USERINSTALLDIR>/jre/bin/keytool -import -noprompt -trustcacerts -alias "<HOST_URL_SSL_CONF>" -file <USERINSTALLDIR>/intermediate.crt -keystore <USERINSTALLDIR>/jre/lib/security/cacerts -storepass changeit
How to Add an Existing SSL Certificate to Cacerts
If Java does not identify a certificate issuer by default, you need to import an SSL into your cacerts.
To add an existing SSL certificate to cacerts, follow these steps:
Use the following steps to import your existing certificate to cacerts with the proper value of alias, keystore location and keystore password.
- From your Volt MX Foundry installed system, open the Linux terminal, and run the following command to add an
intermediate.crt
file from the keystore:
<USERINSTALLDIR>/jre/bin/keytool -export -alias "<yourcertificate_domain>" -file <USERINSTALLDIR>/intermediate.crt -keystore <keystore_location>-storepass <Passsword_of_keystore>
- Run the below command to import the
intermediate.crt
certificate file into your Volt MX Foundry Installer's JRE trusted certificate authority (CA) certificates file:
<USERINSTALLDIR>/jre/bin/keytool -import -noprompt -trustcacerts -alias "<yourcertificate_domain>" -file <USERINSTALLDIR>/intermediate.crt -keystore <USERINSTALLDIR>/jre/lib/security/cacerts -storepass changeit
JDK Version Compatibility
In case if you upgrade your JDK version in your middleware server, to enable JDK version compatibility, make the appropriate changes in an app server's middleware.properties
file located in your middleware server installation folder.
For example: When you upgrade JDK V 1.6 to JDK V 1.7 (vice-versa), you can still run your middleware server. Volt MX Foundry's run-time apps cannot be accessed. If you try to access any apps at runtime, the system throws an error message due to JDK version incompatibility.
- In your middleware server installation folder, open the
middleware.properties
file located at the below path:- for JBoss:
<installer folder>\middleware_home\middleware\middleware-bootconfig
- for Tomcat:
<installer folder>\middleware_home\middleware\middleware-bootconfig
- for JBoss:
-
Make the following changes in the
middleware.properties
file.ssl.trustStore=/<java_home>/jre/lib/security/cacerts
ssl.keyStore=/<java_home>/jre/lib/security/cacerts
How to Switch between JDK Versions
Ensure that you make necessary changes in the middleware.properties
file before you switch between Java version such (for example, JDK V 1.6 to JDK V 1.7 or JDK V 1.7 to JDK V 1.6).
To configure JDK version in middleware, follow these steps:
-
In your middleware server installation folder, open the
middleware.properties
file located at the below path:- for JBoss:
<installer folder>\middleware_home\middleware\middleware-bootconfig
- for Tomcat:
<installer folder>\middleware_home\middleware\middleware-bootconfig
- for JBoss:
-
In the
middleware.properties
file, do the following changes:- Java 6
ssl.SocketFactory.provider=sun.security.ssl.SSLSocketFactoryImpl
ssl.ServerSocketFactory.provider=sun.security.ssl.SSLServerSocketFactoryImpl
* **Java 7**
ssl.SocketFactory.provider=com.sun.net.ssl.internal.ssl.SSLSocketFactoryImplssl.ServerSocketFactory.provider=com.sun.net.ssl.internal.ssl.SSLServerSocketFactoryImpl
Configure Deployment of mbaasportal.war File for Multi-Node - JBoss
Once Volt MX Foundry installation succeeds, the Volt MX Foundry Console will not be displayed as the enable-welcome-root value is set to true in thedomain.xml
file.
To configure mbaasportal.war, follow these steps:
- In the master node, open the
domain.xml
file fromJBOSSDIR\domain\configuration
, and search for enable-welcome-root="true." - Replace enable-welcome-root="true" with enable-welcome-root="false."
Log Locations for Volt MX Foundry
-
Log Locations for Single Node Installation: Logs_for_Single Node_Installation
-
Log Locations for Multinode Installation: Logs_for_Multi-Node_Installation
-
Logging Format:
To store more and more information in the logs, Volt MX Foundry uses custom logging format. The format is:
[<service-name>][%5p][%d{dd MMM yyyy HH:mm:ss,SSS}]:%x:[%t]:[%c:%M:%L]:%m%n
Here is what each parameter in the above format means:
<service-name>
- This parameter is the name of the service as mentioned below:- Accounts:
console.accounts
- Console:
console.portal
- Workspace:
console.workspace
- Identity:
auth.service
- Integration:
app.services
- Engagement Service:
engagement.service
%5p
- Priority/level of logging event justified to a length of five characters. The logging level is customizable for both on-premise and Cloud.
%d
- {dd MMM yyyy HH:mm:ss,SSS}- Date and time in the mentioned format.
%x
- Thread context related information like X-VoltMX-RequestId (or id to correlate request across services).
%t
- the name of the thread that generated the logging event.
%c
- the category of logging event.
%M
- the method name where the logging request was issued.
%L
- the line number from where the logging request was issued.
%m
- the application supplied message associated with the logging event.
%n
- the platform dependent line separator character or characters.
For example, a typical logging request could look like this:[app.services][ERROR][09 Feb 2016 18:48:55,863]:[ 016575f0-7342-4c32-9ceb-726569003277]:[http-bio-8080-exec-23]:[com.voltmx.console.service.testtool.ServiceTestController:executeTestService:143]:error occurred while testing service.
java.lang.NullPointerException
at com.hcl.middleware.connectors.dataadapter.DataAdapterConnector .prepareMapDataControllerRequest(DataAdapterConnector.java:259)
at …
- Accounts:
How to Configure Memcache for Integration Services
-
For VoltMXFoundry version 7.3 or above, you can configure the memcache from Admin console.
To configure memcache in Foundry 7.3 or above versions, follow these steps:
- Open Admin console (http/https://<server-host>:<server-port>/admin).
-
In the left pane, go to the Settings tab.
-
Under the Runtime Configuration tab, expand the Memcache Configuration key.
- In the Memcache Cluster field, provide your memcache hostname/IP and port details separated with a colon. For example,
: - Save the changes.
-
For below Foundry 7.3, you can configure the memcache using queries on voltmxadmindb.
To configure memcache in below Foundry 7.3, follow these steps:
Since UI is not available in version below 7.3, you must update the property value in the server_configuration table of VOLTMXADMINDB database.
- Execute the following steps:
UPDATE <VOLTMXADMINDB>.server_configuration set prop_value =
'<memcache_hostname>’:’<memcache_port>’' , created_date = CURRENT_TIMESTAMP , updated_date
= CURRENT_TIMESTAMP WHERE prop_name = 'memcache.cluster';
**Verification:** To verify whether the memcache configuration is successfully done, go to the **Health Check** page and look for **Access to Cache** entry.
> **_Note:_** It may take up to 5 minutes for the healthcheck to reflect the cache status. If you are still unable to find the particular entry in the **Health Check** page, try clearing the healthcheck cache using the following URL:
https://<server-host>:<server-port>/admin/healthcheck?output=json
![](Resources/Images/HC2_499x293.png)
Configuring Datasource for performance improvements for JBoss pre-existing and Domain Mode
While using pre-configured JBoss or JBoss in Domain Mode, add the following snippet to the datasource to improve the performance.
<pool>
<min-pool-size>10</min-pool-size>
<max-pool-size>30</max-pool-size>
<flush-strategy>IdleConnections</flush-strategy>
</pool>
Note: For the bundled version, the installer will add the default size to the datasources.
Steps to enable SAPJCo
The installer provides the following artifacts:
- SapJCoDestinationProvider.jar
- Module.xml (for JBoss)
You can download the other artifacts libsapjco3.so (for Linux) or sapjco3.dll (for Windows), and sapjco3.jar from https://websmp204.sap-ag.de/connectors.
The SapJCoDestinationProvider.jar can be located at:
<USER_INSTALL_DIR>/Integration/sapjco/main
- for JBoss
The Module.xml can be located at:
<USER_INSTALL_DIR>/Integration/sapjco/main
Steps for Tomcat
-
Navigate to
<USER_INSTALL_DIR>/tomcat/lib
, and add the following files:- sapjco3.jar
- libsapjco3.so/sapjco3.dll
Note: The SapJCoDestinationProvider.jar is already placed in the
<USER_INSTALL_DIR>/tomcat/lib
by the installer. -
Restart the server
Steps for JBoss
For Windows: Place the sapjco3.dll in the jboss/bin folder or C:/Users/
For Linux: Place the libsapjco3.so in the /usr/bin folder or any location on the machine and append the path to the $LD_LIBRARY_PATH variable
JBoss - Standalone (Bundled)
- Navigate to
<USER_INSTALL_DIR>/jboss/modules/org/sapjco/main
, and add the following files:- sapjco3.jar
- SapJCoDestinationProvider.jar
- Navigate to
<USER_INSTALL_DIR>/jboss/modules/org/sapjco/main/
- In
module.xml
, under the \<resources> tag add<resource-root path="sapjco3.jar"/>
. - In
standalone-full.xml
, under the \<global-modules> tag add<module name="org.sapjco" slot="main"/>
.
- In
JBoss - Standalone(Pre-configured)/Domain mode
- Navigate to
<JBOSS_DIR>/modules/org/sapjco/main
, and add the following files:- sapjco3.jar
- SapJCoDestinationProvider.jar
- Navigate to
<JBOSS_DIR>/modules/org/sapjco/main
.- In
module.xml
, under the \<resources> tag add<resource-root path="sapjco3.jar"/>
. - In
standalone.xml
ordomain.xml
, in the subsystem add<subsystem xmlns="urn:jboss:domain:ee:4.0">
. Add the following tag:
- In
<global-modules>
<module name="org.sapjco" slot="main"/>
</global-modules>
Setting Custom -D Parameters
- Tomcat: Add custom parameters in
<TOMCAT_FOLDER>/bin/catalina(.sh/.bat) “JAVA_OPTS=$JAVA_OPTS <CUSTOM_PARAMETERS>
. - JBoss: Add custom parameters in
<JBOSS>/bin/standalone(.sh/.bat) “JAVA_OPTS=$JAVA_OPTS <CUSTOM_PARAMETERS>
.
How to change Hostname and Port
In the <USER_INSTALL_DIR>/scripts
a <DB_TYPE>_changeHostDetails_script.sql
file is generated which consists of the SQL queries to be executed when the user wants to change the hostname and port on which Volt MX Foundry is running.
- Execute the query to create procedure.
- Call the procedure with the existing values, as follows:
call DYN_UPDATE3 ( AUTHCONFIGDB, ACCOUNTSDB, WORKSPACESGLOBALDB, ADMINDB, VMSDB, OLD_HOST, NEW_HOST, OLD_PORT, NEW_PORT );