Exporting OpenPages data to be used by other applications

1. Log in to OpenPages.
2. Click Open Administration menu > Integrations > Data Export.
3. Click New configuration.
4. On the General page, do the following steps:
   1. Enter the Name of the data export.
   2. Optional: Enter a Description of the data export.
   3. Click Next.
5. On the Selection details page, do the following steps:
   1. Select from 1 to 15 objects types that you want to export.
      • When you select an object type, the objects of that type and their relationships are exported into .csv files. For each object type that you select, a .csv file is created with a name in the format <reporting_schema_name>.csv where <reporting_schema_name> is the name used in the Reporting Schema for the object type. For example, if you select the Business Entity object type, the name of the .csv file is rt_entity.csv or, if you select the Risk object type, the name of the .csv file is rt_risk.csv.
      • If the object type contains tags, then when the data export job is completed, a second .csv file is created for each object type with a name in the format <reporting_scheme_name_tags1>.csv. The file name, <reporting_schema_name_tags1>, is the name used in the Reporting Schema for the object type and tags1 is appended to end of the name. This .csv file contains a table with all the tags associated with the object type. The object type ID, tag ID, tag name, and reporting period ID are displayed in the table for each tag. For example, if you select the Business Entity object type, and it contains a few tags, then the exported files are rt_entity.csv and rt_entity_tags1.csv.
   2. Optional: If you want to include user data in your export, select Include users and their security domains.
   3. Optional: If you want to include field level security in your export, select Include field level security.
   4. Select a Locale.
      For each export, you can select only one locale.
   5. Use Select folders to limit the exported objects to the folders you select.
   6. Click Next.
6. On the Set destination page, select a destination type.
   Restriction: The Secure File Transfer Protocol (SFTP) option is not available in watsonx.governance as a Service, watsonx.governance as a Service on AWS, and IBM OpenPages as a Service.
7. If you chose Secure File Transfer Protocol (SFTP) to send your data to another server, enter the following information:
   1. Host server is the name and port of the server that you are transferring the data to.
      For example, example.sftp.com:22
   2. Username and Password are the credentials to access the server and to read and write to the directory where the .csv file will be stored.
   3. Path is the path to the directory on the server where the .csv file will be stored.
8. If you chose IBM Cloud Object Storage to send your data to the IBM Cloud® Object Storage service instance, enter the following information:
   1. Access key ID is the IBM Cloud API key. The key serves as a public identifier, similar to a username, when making API calls. It’s included in the request so that the service knows which account or bucket is being accessed. and Secret key is the private key, similar to a password, that is used to sign the API requests. These are the credentials to access the IBM Cloud Object Storage service instance.
   2. Cloud object storage endpoint is the endpoint to communicate with your IBM Cloud Object Storage bucket.
   3. Bucket name is the name of the bucket to upload the data to.
      The bucket name must start and end with a letter or a number. The name can contain only lowercase letters, numbers, and nonconsecutive dots and hyphens.
   4. Bucket region is the location of the bucket.
   For more information about accessing an IBM Cloud Object Store service instance, see Getting started with IBM Cloud Object Storage.
9. If you chose AWS S3 to send your data to the Amazon S3 object storage service, enter the following information:

   watsonx.governance as a Service, watsonx.governance as a Service on AWS, and IBM OpenPages as a Service

   • Role Amazon resource name (ARN) is the ARN that you use to uniquely identify the AWS resource.
   • Bucket name is the name of the bucket to upload the data to.
   • Region is the region where you created the AWS S3 bucket.

   IBM OpenPages on premises, IBM OpenPages on Cloud, IBM OpenPages for IBM Cloud Pak for Data, and watsonx.governance on Cloud Pak for Data

   • Access key is the AWS access key to identify the user.
   • Secret key is the AWS secret key for authentication.
   • Bucket name is the name of the bucket to upload the data to.
   • Region is the region where you created the AWS S3 bucket.

   For more information about accessing an Amazon S3 object storage service instance, see AWS Identity and Access Management Documentation.
10. Click Test Connection to verify that OpenPages can connect with your server or service.
    To test the connection, OpenPages tries to connect to the destination and write a binary temporary file to the specified location. The temporary file is deleted by the test. You can continue to configure the data export and save the configuration even if the connection test fails.
11. Click Next.
12. On the Set schedule page, define a schedule so that the data export job runs, for example, every night at midnight.
    You can also start a data export job manually at any time. For more information, see Running a data export job manually.
    1. Enter a Name.

       The Name displays in the Scheduler as the Schedule Name. Allowed characters are A-Z, a-z, 0-9, underscore, hyphen, and spaces. Special characters are not allowed.

    2. Optional: Enter a Description.
    3. Select a schedule type in Define Schedule.
    4. If you chose Recurring:
       • Select a value in Repeat (Daily, Weekly, Monthly, Quarterly) and add details such as day, month, or quarter.
       • Enter a Time of Day.
       • Select an End Date (optional).
    5. If you chose Specified Date/Time:
       • Select a Date.
       • Enter a Time of Day.
    6. If you chose Cron Expression:
       • Enter a Cron Expression.
       • Select an End Date.

       Advanced users can choose a cron expression if a Recurring or Specified Date/Time schedule does not meet your needs. Use the syntax for cron expressions, not crontab expressions.

    7. Click Save.

You can run a data export job manually.

1. Click Open Administration menu > Integrations > Data Export.
2. For the data export that you want to run, click Open list of options > Run Data Export.
3. To see the progress of the data export job, click the name of the data export that you want.
4. Click the Execution tab and click the ID of the job.
   The job log displays a record of the execution details of the job including the date and time of the events and the status of each event.

You can edit an existing data export.

1. Click Open Administration menu > Integrations > Data Export.
2. Click the name of the data export that you want to edit or click Open list of options > Edit.
3. Go to Configuring your data export and follow steps 4 to 12 to edit the data export configuration.

1. Click Open Administration menu > Integrations > Data Export.
2. For the data export that you want to enable or disable, click Open list of options .
3. Choose one of the following options:
   • Select Enable to enable a disabled data export.
   • Select Disable to disable an enabled data export.

You can remove an existing data export.

1. Click Open Administration menu > Integrations > Data Export.
2. Click Open list of options > Remove.