Search server Run Engine commands
Use the following Run Engine commands to configure the Search server Docker container.
/SETUP/bin/entrypoint.sh
. If you want
to implement custom logic or override existing configurations, ensure that the
necessary parameters can be resolved by the commands during startup.Description | Command |
---|---|
Set the connection to the Transaction server | run set-transaction-server hostName
securedPort
|
Set the connection to the Store server | run set-store-server hostName
port
|
Set the connection to the Customization server |
run set-xc-server hostName
port
|
Update database user and password credentials that are used to connect to the database. | run update-datasource-cred jndi
db2User
db2Pass
|
Sets the
enableSeamlessFailover property for an
existing DB2 datasource. |
set-db2-enable-seamless-failover
jndi
|
Update database name, database server host name, database server port credentials that are used to connect to the database. | run update-datasource-db jndi
database
db2Host
db2Port
sslConnection
|
The SPI username and password is used for
inter-component server API invocation only. The
spiuser is configured in the Store
server, Search server and Customization server, and used in the API
invocation from those servers to the Transaction server. The images
need to be configured with the spiuser
password, otherwise the component servers cannot connect to the
Transaction server. Sets JVM property: spi.username, spi.password |
run set-spi-user userName
ASCII_encrypted_password
|
Based on cloudAccout name, user name, password, userType, accoutAlias to create JNDI entry for this Cloudant account. | run add-cloudant-account
cloudantAccount
userName
password
accountAlias
|
Update Cloudant account information. | run update-cloudant-account
cloudantAccount
userName
password
accountAlias
|
Add database connection datasource. |
run add-datasource jndi
database
dbtype
dbHost
dbPort
dbUser
dbPass
xa
sslConnect
|
Add JNDI entry. | run add-jndi-entry name
value
|
Create a new user registry. | run add-spi-registry registryId
username
password
|
Update jvm.options to add new JVM properties. | run add-system-property <name
value
|
Update WebSphere Liberty home and server name for Run Engine configuration properties. | run generate-config-properties
LibertyHome
ServerName
|
Retrieve the start state of an application in the Liberty server. If the application is not started within 3 minutes, error code 1 is returned. | run get-status
application_name
|
Remove SPI registry form userregistry.xml. | run remove-spi-registry-user
registryId
username
[group]
|
Copy trace setting file (logging.xml) to WebSphere Liberty server home. Default location is /SETUP/server/root/logging.xml | run reset-trace-specification |
Update initHeapSize and maxHeapSize in jvm.option file. | run set-heap-size initHeapSize
maxHeapSize
|
Update jndi.xml to create or update a JNDI entry. | run set-jndi-entry name
value
|
Configure Kafka. |
Note: The zookeeper
servers are being used for script backward compatibility, hence
this parameter should be ignored.
|
Set the encrypted Session Key. The JNDI entry
|
run set-session-key
sessionKey
|
Set a custom JVM property. | run set-system-property name
value
|
Change trace log directory. | run set-trace-log-directory
directory
|
Change trace level. | run set-trace-specification
spec
Note:
|
Update JNDI entry. | run update-jndi-entry <name> <value>
|
Update isClientSideRedirectSupported attribute. | run update-oidc-client-side-redirect-supported
clientSideRedirectSupported
|
Update context path for OIDC configuration. | run add-oidc-context-root
contextRoot
|
Update OIDC redirect server host name. | run update-oidc-redirect-server-host
serverHost
|
For WebSphere eXtreme Scale integration, enable the eXtreme Scale feature. Tip: For more information about this integration,
see Integrating HCL Commerce
version 9 with WebSphere eXtreme Scale.
|
run enable-xs-feature xsServerName
xsServerPort
|
For WebSphere eXtreme Scale integration, connect a specific cache
instance to the WebSphere eXtreme Scale cache provider. Tip: For more information about this integration,
see Integrating HCL Commerce
version 9 with WebSphere eXtreme Scale.
|
run connect-searchcache-wxs
jndiName
cacheSize
optional:gridName
optional:mapName
|
Merge cachespec.xml cache configuration files. | run merge-cachespec-xml source_file
target_file
|