API samples

The API samples, based on the sample data set, demonstrate portions of the IBM OpenPages GRC Java™ API and IBM OpenPages GRC REST API.

You can download the compressed API samples file to try out the OpenPages® APIs.

Decompressing the .zip file creates a samples folder that contains a folder for each sample and a data folder for the sample data set and schema. The sample data set models a real-word system. The data set is a subset of the ORM standard objects and fields, and includes a FastMap template with sample data that is used in the samples and demos.

. Each sample folder includes the following files:

  • A readme.txt file or a readme.md file that describes what the sample demonstrates.
  • Source files that you use for compiling, deploying, and running the sample code.

    The sample code runs in an OpenPages system with the sample schema and data set loaded.

The object model, schema, and sample data set that are provided in the API samples .zip file are samples to help developers understand the capabilities of the OpenPages. The API samples are not intended to be production-ready applications.

If a custom schema is already loaded into OpenPages, you might encounter incompatibility issues. Consult your IBM OpenPages Services representative before proceeding.

Warning: Loading the schema alters the metadata and configuration of your system. These operations cannot be undone. Create a backup of your system by using OPBackup before proceeding. For more information about running the OPBackup utility, see either The OPBackup utility (Db2®) or The OPBackup utility (Oracle).
The following table shows the API samples by folder. Before you use the API samples, ensure that you do the following steps:
  • Read and follow the instructions in the ReadMe.txt file in the samples folder.
  • Read the readme.txt file or readme.md file for any sample that you intend to use.
Table 1. API sample descriptions
Sample folder Description
AnonLossEventFormREST

This sample shows you how to allow anonymous users to enter financial losses without logging in to the OpenPages system. Users go to a company website or existing web portal infrastructure and complete a form with details of the loss. After a user submits the form, the loss can be created in OpenPages by using the IBM OpenPages GRC Java API.
BusinessEntityHelper This sample shows you how to use the IBM OpenPages GRC Java API to retrieve metadata and profile information for a SOXBusEntity object type, and dynamically create a simple HTML form to create objects of that type.
Classifiers This sample shows you how to use the IBM OpenPages GRC Java API to set up a classifier field and see it in a Creation view.
CustomRESTService This sample shows you how to build and deploy custom REST services under the Public GRC REST API web application. You can use custom REST services to reveal customer-specific business logic to external clients, or to applications that integrate with OpenPages.
IssueHelperJSP This sample shows you how to use the IBM OpenPages GRC Java API to retrieve metadata and profile information for a SOXIssue object type, and dynamically create a simple HTML form to create objects of that type.
QueryTestJSP This sample uses the IBM OpenPages GRC Java API to provide a simple web form to submit a Query Service expression and display the results from running the query on your data. You can use the same form for rapid prototyping and testing your own queries during development. The .jsp code shows how you can retrieve values from the results of the query.
ReactCarbonHelper This sample uses the IBM OpenPages GRC Java API to demonstrate how to build a React application that integrates with OpenPages. The sample uses TypeScript, Sass, and Carbon.

For more information about TypeScript, see https://www.typescriptlang.org/.

For more information about Sass, see https://sass-lang.com/.

For more information about Carbon, see https://carbondesignsystem.com/.
TivoliDirectoryIntegratorConnector IBM Security® Directory Integrator, formerly IBM® Tivoli® Directory Integrator, is an integration framework Graphical Development Environment to build and test web-based Administration and Monitoring Console for management (AMC) solutions. It has connectors for many common protocols and systems, and it has a plug-in architecture for making custom connectors and adapters. It maps data from multiple systems in a defined flow that is called an assembly line.

This sample uses the IBM OpenPages GRC REST API to create a basic assembly line with an OpenPages connector. The sample retrieves LossEvents from OpenPages based on a query that uses the Query Service syntax. The LossEvents are mapped to a Losses database table that represents an external system.
Triggers This sample uses the IBM OpenPages GRC Java API. It contains a set of triggers that use the GRC trigger framework. The triggers include Create and Update triggers on LossEvent, and a Create trigger on SOXBusEntity. The triggers use ContentTypeMatchRule.