Installing tools and utilities

Tools and utilities, such as ObjectManager, are available on the application servers. But you can also install them on remote systems, such as your laptop, and run them remotely.

Do this task if you want to run any of the following tools from a remote system:

ObjectManager: For more information, see Load data into OpenPages with ObjectManager.
chng-sys-password.sh|.cmd: For more information, see Changing the OPSystem password.
RpsRpf.sh|.cmd: A command line tool for creating the reporting schema and generating the reporting framework. For more information, see Generating the reporting schema and framework from a command line.
Update Password Encryption Algorithm (UPEA): For more information, see Updating the password encryption algorithm.
Notification Manager: For more information, see The Notification Manager.

Before you begin

The computer where you install the tools and utilities must meet the following requirements:

IBM® Semeru Runtimes is installed.
JAVA_HOME is defined.
The computer must be able to communicate with the OpenPages application server.

Procedure

Get the installation package.
- Go to the /OP_<version>_Main/OP_<version>_Tools directory on the installation media. Download the openpages-tools-client.zip file.
- 1. Log in to your cluster as an instance administrator:
```
oc login OpenShift_URL:port
```
  2. Download the installation package:
```
oc cp openpages-<instance_name>-sts-0:/opt/ibm/OpenPages/openpages-tools.zip ./openpages-tools.zip
```
    Replace <instance_name> with the name of the OpenPages instance.
Extract the openpages-tools-client.zip file to a new directory.
Go to the openpages-tools-client/bin directory.
Open the openpages-tools-client.properties file in a text editor.
Update the value of the rest.url.path property.
- Type the base URL of the public REST API on the application server.
```
https\://<host>\:<port>/grc/api
```
  Replace <host> and <port> with the hostname and port of the OpenPages application server.
- Type the base URL of the public REST API.
  The base URL that you use depends on the version of the OpenPages GRC REST API that you use.
  - If you're using the GRC REST API V2, use the following base URL:
```
https://<cpd_url>/openpages-<instance_name>-opgrc/api/v2
```
  - If you're using the GRC REST API V1, use the following base URL:
```
https://<cpd_url>/openpages-<instance_name>-grc/api
```
  Replace <cpd_url> with the URL of IBM Software Hub. Replace <instance_name> with the name of the OpenPages instance.
Set the value of the platform.cloudpak.auth and the platform.cloudpak.useZenApiKey property to true.
You can use this setting to authenticate with your username and API key rather than a username and password.
You generate the API key in IBM Software Hub.
By default, the application server's TLS (SSL) certificate is checked for validity when you run tools such as ObjectManager. To change this behavior, update the insecure.skip.tls.verify property.
For more information, see Tools properties and parameters.
Save and close the file.

Results

You can now run the tools by using the scripts and properties files in the openpages-tools-client/bin directory.