Installation and Configuration

Install the application from the supplied installer. This applications relies on Java 11 (or later) being already installed on the server.

The server needs a REST service to be installed on the MarkLogic database server. The easiest way to do is this to configure the file conf/marklogic.properties and letting the Side Panel Server create it.

You will need to tell the server the host on which MarkLogic DB is running and the port that will be used for interacting with the database once it is created.

is to use for the server and the administration port - the port used to tell MarkLogic to create the REST service.

marklogic.host=<ML host>
marklogic.port=<Port for service (e.g. 8060)>

A user with read/write permission on this database is required so that the service can access the REST service and the data. The details of this user are provided as

marklogic.user=<User name>
marklogic.password=<User password>

To create the service initially, the service needs the credentials of a user capable of creating rest endpoints, databases and forests via the properties as well as the post of the rest endpoint that will be used to do this creation

marklogic.admin.port=<ML rest endpoint port - usually 8002>
marklogic.admin.user=<User Name>
marklogic.admin.password=<Elevated users's password>

The name of the REST service to be created as well as the database and forest are also required. Finally, we need parameters to tune queries. These are unlikely to be changed.

marklogic.server.name=8060-text-mining-server
marklogic.database=text-mining
marklogic.forest=text-mining-1

marklogic.background.mincount=5
marklogic.searchasyoutype.count=10

If all this data is supplied then the REST service will be created as the service starts.

Note, before creating the REST service database and forests, the application looks to see if the specified forest exists. If it does, then it assumes that all the others are present and will not attempt to create them.

Once these parameters have been set, the service can be started.

Any issues will be reported in the log directory <Install>/logs

Note a more secure way to store the password is to replace the value in this file with a parameterized form

marklogic.admin.password=${marklogic-password}

You can then use a keystore to store the actual value, add to a properties file (keystore.properties is provided)

quarkus.file.vault-config-source.keystore-path=<<Location for cache file>>
quarkus.file.vault-config-source.keystore-secret=<<KEY_STORE_PASSWORD>>

You can then run the command

keytool -importpass -alias marklogic-password -keystore <<Location for cache file>> -storepass <<KEY_STORE_PASSWORD>> -storetype PKCS12

Ensure that the cache file is locked down so that only the Concept Server account can read it.