Backing up custom files in IBM OpenPages for IBM Cloud Pak for Data

You can include custom files, such as custom JSPs or other files that are specific to your environment, in backups by using a manifest file. A manifest file is a text file that contains the full path name to any directory or file that needs to be included in the backup.

For example, if you want to back up openpages-ext.jar, add its full path to the manifest file:

/opt/ibm/OpenPages/aurora/lib/openpages-ext.jar

Do not include pod-specific configuration files in the manifest file. For example, the op-apps.xml configuration file is pod-specific. Do not include it in the manifest file.

Before you begin

You must list all of your custom directories and files in a manifest. If you have any questions about the location of your custom data, contact IBM® OpenPages® Support.

Procedure

Log in to your Red Hat® OpenShift® cluster as a project administrator:
```
oc login OpenShift_URL:port
```
Change to the project where OpenPages is installed:
```
oc project <Project>
```
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 StatefulSet (sts), run oc get sts and look for a name that starts with openpages-.

For example: openpages-opinst-sts
Log in to the application server pod.
1. Log in to your Red Hat OpenShift cluster as a project administrator:
```
oc login OpenShift_URL:port
```
2. Change to the project where the Cloud Pak for Data control plane is installed:
```
oc project <Project>
```
3. Log in to the application server pod and open a terminal:
```
oc exec -it openpages-<instance_name>-sts-0 -- /bin/bash
```
  To find the pod name, run oc get sts and look for a name that starts with openpages-.
If you have custom JSPs, do the following steps:
1. Create a zip file called solutions-sosa-files.zip that contains your custom JSPs and related files.
  
  Tip: You can use a different name, but it must follow the convention *-sosa-files.zip. Also, you must add it to the <OP_HOME>/aurora/bin/op-backup.manifest file. Only solutions-sosa-files.zip is backed up and restored by default.
2. Put the solutions-sosa-files.zip file in the <OP_HOME>/applications directory.
  - When you run OPBackup, the zip file is included in the backup.
  - When you run OPRestore, the zip file is restored to <OP_HOME>/applications and is also extracted to /opt/ibm/wlp/usr/servers/defaultServer/apps/expanded/op-apps.ear/taskui.war/
Open the <OP_HOME>/aurora/bin/op-backup.manifest file in a text editor.
Add custom files or directories, other than JSPs, to the op_backup.manifest file.
You can specify directories or individual files. For each file or directory, create a new line and type its full path..
Save the manifest file using the current location and name.
Back up your IBM OpenPages for IBM Cloud Pak for Data configuration and restart the application server.
For more information, see Configuring OpenPages.