Tools properties and parameters

Depending on the configuration tasks that you perform in IBM OpenPages®, you might need to edit the properties in the openpages-tools-client.properties file.

The openpages-tools-client.properties file is used by OpenPages tools such as ObjectManager, Notification Manager, and command-line utilities.

The file is on each application server in the <OP_HOME>/bin directory.

rest.url.path
The base URL you use depends on the version of the OpenPages GRC REST API that you use. In all versions of OpenPages, you can use the OpenPages GRC REST API V1. In OpenPages version 9.0.0 or later, you can use the OpenPages GRC REST API V2.
On premises
Use the following base URL for the GRC REST API V1:
https://<host>:<port>/grc/api
Use the following base URL for the GRC REST API V2:
http://<host>:<port>/opgrc/api/v2

Replace <host> with localhost or with the hostname of the OpenPages application server. You can use localhost if the tools and utilities are run on the application server.

Replace <port> with the OpenPages application server's port number.

If you're using GRC REST API V1, the following URL is an example of a call to the API:

https://localhost:10111/grc/api

If you're using GRC REST API V2, the following URL is an example of a call to the API:

https://localhost:10111/opgrc/api/v2

Cloud Pak for Data
See Installing the ObjectManager client.
insecure.skip.tls.verify
If set to true, the application server's TLS (SSL) certificate is not checked for validity when you run tools such as ObjectManager.
If set to false or if the insecure.skip.tls.verify is not specified in the openpages-tools-client.properties, the application server's certificate is checked for validity. The TLS check occurs when a tool (such as ObjectManager) communicates with the REST API on the application server. The check passes if either of the following conditions is true:
  • The server's certificate is valid (it is not self-signed).
  • The server's certificate is self-signed but exists in the client's truststore.

Allowed values: true or false

Default value: false

If the URL in rest.url.path uses HTTP, the insecure.skip.tls.verify property is ignored.

max.req.body.size.mb
The maximum request size (in MB) of requests that are sent from client tools, such as ObjectManager, to the server's REST API. A request that is larger than this threshold is automatically divided into chunks, which are then sent separately.

For example, suppose that your web server sets an upload limit of 50 MB. This upload limit means that any requests from client tools must be smaller than 50 MB. To meet this requirement, you can set max.req.body.size.mb=50. Now, suppose that you use ObjectManager to load 100 MB of data. Your upload is automatically broken down into two 50 MB chunks so that the upload does not exceed the 50 MB threshold.

platform.cloudpak.auth
Applies to: Cloud Pak for Data.

Must be set to true.

platform.cloudpak.useZenApiKey
Applies to: Cloud Pak for Data.

If you use tools and utilities such as ObjectManager, this setting must be set to true.

retry_count_on_http_429
The number of times that client tools should retry the connection if the OpenPages application server is busy (returns an http 429 error).
Cloud Pak for Data: You can use this property in version 4.8.3 or later.
retry_interval_sec_on_http_429
The interval in seconds between the retries.
Related to retry_count_on_http_429.
Cloud Pak for Data: You can use this property in version 4.8.3 or later.