Table of contents

Configuring OpenPages

You can configure OpenPages® to meet your business requirements.

About this task

Some configuration tasks require you to do steps before and after making the change. You need to:
  • Scale down to a single replica
  • Make the configuration changes
  • Restart the application server
  • Backup the configuration
  • Scale back up to the number of replicas you need for the application server
Do the steps in this task if you want to make changes to the following items:
  • WebSphere Liberty configuration files
  • Application configuration files
  • JAR files for custom triggers
  • Custom JSPs, along with their images and CSS files

You can make many other configuration changes. For more information, see the OpenPages documentation.


  1. Log in to your Red Hat® OpenShift® cluster as a project administrator:
    oc login OpenShift_URL:port
  2. Change to the project where OpenPages is installed:
    oc project <Project>
  3. If you use multiple replicas for the application server, scale down to a single replica.
    oc scale --replicas=1 sts/openpages-<instance_name>-sts

    To find the name of the instance, run oc get sts and look for a name that starts with openpages-.

    For example: openpages-instance_name-sts

  4. In the application server pod, open a terminal window.
    oc exec -it openpages-<instance_name>-sts-0 -- /bin/bash
  5. Make your changes.

    The following table lists some of the configurations that you can make. For more information, see the OpenPages documentation.

    For this task See
    Setting the session timeout value Setting session inactivity timeout values for application servers
    Changing the password of the application server keystore Changing the password of the WebSphere Liberty keystore
    Adding custom JSP, images, and CSS files to OpenPages Add custom files and then add them to the back up manifest file. See Backing up custom files .
    Creating custom actions to use in GRC Workflow

    A custom action is a Java™ class that can be invoked during a workflow action.

    Creating custom actions for GRC workflows
    Creating custom jobs to use in the Scheduler

    A custom job is a user-defined job that performs a function. It is implemented as a Java™ class that you can run manually or on a schedule.

    Implementing a Java class for custom jobs
    Changing application log settings

    Errors, exceptions, and informational messages are written to the aurora.log. You can adjust the settings for the log.

    Changing the size and number of backups of the aurora log file

    Enabling trace logging

  6. Restart the application server.
    server stop
    server start
  7. Back up your OpenPages configuration.
    cd /opt/ibm/OpenPages/aurora/bin
    ./ /opt/ibm/OpenPages/openpages-backup-restore app-cp4d nosrvrst

    A backup .zip file is created in /opt/ibm/OpenPages/openpages-backup-restore. The filename includes a timestamp.

    The backup is restored automatically when you add more replicas or when the application server pod restarts (planned or unplanned restarts). The application server pod restart process uses the .zip file with the most recent timestamp.

  8. Scale up to the number of replicas you want to use for the application server.
    oc scale --replicas=<number> sts/openpages-<instance_name>-sts