Creating an Entry in the CQS File

The framework generation contains two parts, the dynamically generated portion and the custom portion.

The dynamic part of the framework is created by the framework generator based on a user's metadata. The custom portion of the framework is contained in the following files: static-modelquerysubjects*.xml and custom-static-modelquerysubjects*.xml. These files contain user-defined query subjects and the relationships between them.

The out-of-the box static-modelquerysubjects*.xml files are used by IBM OpenPages® to define custom query subjects including auditing, security, user permission, disassociated file, and checked-out files. These files are shipped with each installation and are overwritten during upgrades. Do not make any modifications to these files.

If you want to add your own custom query subjects, create a new file. Use the naming convention: custom-static-modelquerysubjects*.xml. Place the file in the <OP_HOME>/aurora/framework/conf/mqs directory on the application server.

The following list shows the default paths:

Using the framework on a Windows operating system: C:\OpenPages\aurora\framework\conf\mqs
Using the framework on a Linux® operating system: /opt/OpenPages/aurora/framework/conf/mqs

The file containing the CQS is an XML file. The best method to use to add an additional query subject is to copy an existing one and replace all the data. When editing the file you must be careful to create the beginning and end tags properly.

The file uses the following tags:

<MODELQUERYSUBJECTS>: This is the outer most tag of the file. This is a collection of <MODELQUERYSUBECT> definitions.
<MODELQUERYSUBJECT>: This is an individual custom query subject.
<RELATIONSHIPS>: This is the relationship between two query subjects.
<CALCULATIONS>: This is a custom calculation.
<PARAMETERMAPS>: This is a user-defined parameter map.

The following sections describe the proper use of the elements of each section of the XML file.