Generating the reporting schema and framework from a command line

You can generate the reporting schema and the reporting framework by using the RpsRpf.sh|.cmd tool from a command line.

Before you begin

JAVA_HOME must be set.
The client tools must be installed. For more information, see Installing tools and utilities (IBM OpenPages with Watson) or Installing tools and utilities in Cloud Pak for Data.
If you are creating or re-creating the reporting schema, ensure that no reports, backups, or other jobs are running. Do not run any reports, backups, or other jobs during the schema creation process.

About this task

You can use the RpsRpf.sh|.cmd tool to create the reporting schema, the reporting framework, or both. When you generate the reporting framework, all framework models are generated.

You must have the following application permissions:

API > Administration > Background Process > Get Process Info
To create or re-create the reporting schema, you must be a super administrator. Or, you must have these permissions:
- Administration > System Administration Mode
- SOX > Administration > Reporting Schema
To generate the reporting framework, you must be a super administrator. Or, you must have this permission:
- SOX > Administration > Reporting Framework

Procedure

Go to the directory where client tools are installed:

IBM OpenPages® with Watson™

Go to the <OP_HOME>/bin directory on the application server.
Or, if you installed the client tools on a remote system, go to the openpages-tools-client/bin directory. The computer must be able to communicate with the OpenPages application server.

IBM OpenPages for IBM Cloud Pak for Data

Go to the openpages-tools/bin directory on the remote system where you installed the client tools package. The remote system must have access to IBM OpenPages for IBM Cloud Pak for Data.
Verify the properties in the openpages-tools-client.properties file.
IBM OpenPages with Watson

Verify that rest.url.path is set to the base URL of the public REST API on the application server, for example: https\://<host>\:<port>/grc/api

IBM OpenPages for IBM Cloud Pak for Data
Verify that rest.url.path is set to the base URL of the public REST API, for example https\://<cpd_url>/openpages-<instance_name>-grc/api
Replace <cpd_url> with the URL of IBM Cloud Pak® for Data. Replace <instance_name> with the name of the OpenPages instance.

Verify that platform.cloudpak.jwt.auth is set to true.
Open the RpsRpf.properties file.

Set credentials in the properties file

IBM OpenPages with Watson

OPENPAGES_ADMIN_USERNAME=
OPENPAGES_ADMIN_PASSWORD=

IBM OpenPages for IBM Cloud Pak for Data

OPENPAGES_JWT_USER= 
OPENPAGES_JWT_TOKEN_OR_API_KEY=

Set the following parameters:

RPSRPF_ACTION_TYPE

RPS: Create the reporting schema.
RPF: Generate the reporting framework.
BOTH: Create the reporting schema, and then generate the reporting framework.

DROP_REPORTING_SCHEMA

Optional. If you want to drop the reporting schema and re-create it, change DROP_REPORTING_SCHEMA to true.

Note: Do not modify RPF_PARAMS.

The following example shows a properties file for IBM OpenPages with Watson. With this configuration, the tool creates the reporting schema and then generates the reporting framework.

# OpenPages Administrator account
OPENPAGES_ADMIN_USERNAME=OpenPagesAdministrator
OPENPAGES_ADMIN_PASSWORD=
#JWT Auth
OPENPAGES_JWT_USER=
OPENPAGES_JWT_TOKEN_OR_API_KEY=
# Action type
#  RPS  - Reporting Schema Creation
#  RPF  - Reporting Framework Generation
#  BOTH - Both RPS and RPF ( default )
RPSRPF_ACTION_TYPE=both

# Comma-separated reporting Framework options. Default is all options for v6 schema
RPF_PARAMS=dimensionFacts,customQuerySubjects,genType_6,i18NTranslationType_6
# Uncomment the next line for V5 Reporting Framework
#RPF_PARAMS=dimensionFacts,customQuerySubjects,genType_552,i18NTranslationType_552

# Drop reporting schema when it creates one
DROP_REPORTING_SCHEMA=false

Note: The V5 Reporting Framework is no longer supported. Do not uncomment the V5 Reporting Framework line.

Run the RpsRpf.sh|.cmd tool:
Windows
Open a command prompt as an administrator, and then run the following command:
```
RpsRpf.cmd
```
Linux®
Run the following command:
```
./RpsRpf.sh
```
Note: If a framework generation process is already in progress, the script returns information about the process.
Check the log file for errors and warnings: <client_tools>/logs/openpages-tools-client.log
Where <client_tools> is the directory that you used in step 1.