Installing tools and utilities for OpenPages

Important: IBM Cloud Pak® for Data Version 4.8 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.8 reaches end of support. For more information, see Upgrading from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1.

You can install tools and utilities, such as ObjectManager. You must run these tools and utilities from a remote system.

Before you begin

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

IBM® SDK, Java™ Technology Edition 8, or Java Runtime Environment (JRE) 8 is installed.
JAVA_HOME is defined.
The remote system has access to OpenPages.

About this task

Do this task if you want to use the following tools and utilities:

ObjectManager: See The ObjectManager tool.
chng-sys-password.sh: See Changing the password of the OPSystem user in Cloud Pak for Data.
RpsRpf.sh: A command-line tool for creating the reporting schema and framework. See Generating the reporting schema and framework from a command line

Procedure

Get the installation package.
1. Log in to your Red Hat® OpenShift® 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.zip file to a new directory.
Go to the openpages-tools/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.
The base URL that you use depends on the version of the OpenPages GRC REST API that you use.

In all versions of Cloud Pak for Data, you can use the OpenPages GRC REST API V1. In Cloud Pak for Data version 4.8.3 or later, you can use the OpenPages GRC REST API V2.
Use the following base URL for the GRC REST API V1:
```
https://<cpd_url>/openpages-<instance_name>-grc/api
```
Use the following base URL for the GRC REST API V2:
```
https://<cpd_url>/openpages-<instance_name>-opgrc/api/v2
```
Replace <cpd_url> with the URL of Cloud Pak for Data. 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 Cloud Pak for Data username and API key rather than a username and password.
You generate the API key in Cloud Pak for Data. For more information, see Generating API keys for authentication.
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/bin directory.