Resources

Adding a Resource

Adding an LDAP Resource

Adding an RDBMS resource

Adding a computed resource

Configuring an LDAP Resource

Configuring a computed resource

Deleting a Resource

A resource is a COGNITUM logical object that conveys a real concept. A resource is a functional entity generated:

from an LDAP (directory data source),
from an SQL (RDBMS data source) request,
from a custom Java class (any third-party system), or
from an ESS entity (bridge to Enterprise SecurityStation). Resources are categories of information that are available to COGNITUM end-users for browsing and searching data. End-users make queries on resources. They can browse through the directory, database, or other data systems content with business forms associated to the resources. Attributes stand for the main features of a resource:
For LDAP resources, these attributes can be physical attributes automatically retrieved from the directory or computed attributes the behavior of which results from a Java class.
For RDBMS-based resources, attributes match the columns of the table(s) or view(s) returned by an SQL query. An RDBMS resource can also be featured by computed attributes.
For computed resources, the custom Java class makes it possible to define virtual attributes. A computed resource helps connect third-party systems, or aggregate data from existing resources.
For resources based on ESS entities, the Java class generated from a pre-defined ESS form makes it possible to connect Enterprise SecurityStation.

In the COGNITUM Console, a resource is created and configured in a view to determining its foundation properties and its behavior as a logical entity.

Adding a Resource

Adding a resource consists of declaring the data source used, the resource scope within that data source, the forms which present the returned data and the users rights on them.

Adding an LDAP Resource

An LDAP resource can be defined as a set of directory entries that match the criteria specified by the resource, where the criteria is made up of:

filter, that is an LDAP search filter,
Base DN, that is the start node of the query,
scope, that is the depth of the search in the directory tree. The resource creation is performed through the New Resource wizard. The wizard guides the application designer through the three steps necessary for the creation of the resource. It is meant to help:
define the LDAP filter of the resource,
retrieve the attributes to be associated with the resource.

After selecting the Resources tree item, a click on the New Resource toolbar button displays the New Resource wizard.

The first Resource Definition wizard screen is displayed in order to specify the properties of the data source which the resource must rely on.

Figure: New LDAP resource definition

Application: It is the application that contains the resource. A click on the list box displays the applications available.

Name: It is the label of the resource as it appears in the COGNITUM Console. Non-alphanumerical characters and blank spaces are prohibited.

Based on: To add an LDAP resource, the Data Source option must be selected.

Data Source: Several data sources may have been set for the application selected. The list box shows all the data sources available for the selected application. An LDAP data source must be selected in this list box.

Template: This box makes it possible to use a directory entry as a template. A click on the torch button next to the Template box displays the DN chooser box which lists the entries available in the data source. The wizard retrieves all the objectclasses and the physical attributes of the directory entry so as to propose a resource pre¬configuration. This option is meant to quickly draw up the list of logical attributes available for the resource. The selected entry fills in the box below the Template box.

A click on the Next button displays the second screen of the wizard where are specified:

the objectclasses to be used for the resource, and
the three main parameters that define a filter on the resource.

Figure: New LDAP resource Objectclasses definition

Objectclasses: The box lists all the objectclasses used by the wizard to deduce the attributes associated to the resource. It is automatically filled in with the values corresponding to the selected entry.

Insert: The button allows to add objectclasses manually for the resource. A click on the button launches the Object Class Selection dialog box. An objectclass can be selected for the ObjectClasses wizard box.
Remove: The button is meant to remove an objectclass displayed in the Objectclasses box. Once selected, the attribute can be removed by clicking the Remove button.

Base DN: This is the root node of the resource. When the node DN is unknown, the torch button can be clicked to get the list of all available directory suffixes.

Filter: It is the LDAP filter on the resource. The resource definition can be entered manually. COGNITUM can assist you in creating an LDAP request with the LDAP Request Builder dialog box accessible with a click on the torch button. For more information about the LDAP Request Builder, see “Creating an LDAP request”.

Scope: It is the depth of the LDAP request in the directory tree from the context node. The scope options are:

Object: The search is restricted to a single entry, that is the context.
One Level: All objects at one level below the context can be searched, but the object itself.
Sub Tree: The entire tree below the specified context is searched. The object is included.

NOTE
The LDAP filter area in the second screen of the wizard is automatically filled in as follows:

WARNING
Resource based on RDBMS databases must not carry names similar to SQL, LDAP keywords.

WARNING
Naming an resource with the name of a logical object such as View, Resource or Application as well as names such as Portal, DN, Entry, parentEntry, callingDN may create conflicts especially with update and create forms. Also, a resource cannot be created with the name label.

The LDAP filter area in the second screen of the wizard is automatically filled in as follows:

Base DN: DN of the parent entry.
Filter: All the objectclasses of the selected entry.

However, the LDAP Filter box can still be filled in manually with custom values.

A click on the Next button displays the third Attributes Creation screen of the wizard.

Figure: New LDAP resource attributes creation

Attributes: This area identifies all the available attributes to be associated with the resource. Once selected from the Available Attributes list, you must move the attribute in the Attributes Kept list so as to be defined as a resource attribute. The arrow buttons are used to select/deselect attributes from a list to another:

Available Attributes: This is the list of all the attributes available for the resource. They are physical attributes deduced by COGNITUM from the objectclasses defined in the Properties area of the previous wizard screen.
Attributes Kept: This is the list of the attributes used to define the resource. They are used by COGNITUM as logical attributes.

NOTE
Attributes in bold in the Attributes Kept list are mandatory attributes. They cannot be removed from the list.

RDN: In the RDN list box, the attribute to build the RDN of the resource instances must be selected. The RDN must be an attribute of the resource.

A click on Finish validates the properties entered for the resource. In the COGNITUM Console tree, the resource icon is displayed. Below the resource, the required attributes are listed in order to define them as the main features of the resource.

Figure: resource properties

The attributes defined for the resource at the resource creation level are used to pre-configure the resource. In the Presentation property view, the Browse and Search tabs of the resource are pre-filled with some of the attributes previously defined. This pre-configuration aims at running properly the basic functions of the application. Further configuration and subsequent changes can be brought as documentation in “Configuring an LDAP resource”.

TIP
A right-click on the new resource gives access to the Edit Description command which displays a dialog box. A descriptive text about the resource can be entered. This text appears whenever the cursor is left on the resource tree item.

To create an LDAP resource

In the COGNITUM Console, click the New Resource toolbar button.
The New Resource wizard is launched. In the first Resource Location wizard screen, fill in the boxes:
Application with the application for which the resource must be added,
Name with the name you want to give to the resource.
For the Based on option, choose Data Source.
In Data Source, select the LDAP data source of the application to be used for the resource creation.
Facing the Template box, you can click the torch button to select the directory entry to create the resource by retrieving the objectclasses and the LDAP filter parameters from this entry.
Click the Next button to display the second screen of the resource creation wizard.
You can add items in the Objectclasses list: click the Insert button to access the Attribute Selection dialog box.
In the Base DN box, enter the start node of the resource, or, preferably, click the torch button to display the DN Chooser selection box.
In the Filter box, enter the LDAP filter on the resource, or click the torch button to launch the LDAP Request Builder dialog box. For more information, see “Creating an LDAP request”.
Check the Scope option box with the LDAP request depth you want.
Click the Next button to display the third Attributes Creation wizard screen.
In the Available Attributes and Attributes Kept list boxes, select the attributes to associate with the resource. Use the arrow buttons to move attributes from a list to another.
Click the RDN list box to select the RDN attribute of the resource.
Click the Finish button to validate the settings for the new resource.

Adding an RDBMS resource

An RDBMS resource is defined by the information coming from a relational database. An RDBMS resource results from an SQL query on a relational database. The resource maps the result of the query.

Adding an RDBMS resource consists in:

associating it with a relational database,
building the SQL query on the required table(s) or view(s).

When an RDBMS data source is available in the COGNITUM Console for the application, an RDBMS resource can be created. The resource creation is performed through the New Resource wizard. The wizard guides the application designer through the three steps necessary for the creation of RDBMS resource. It is meant to help:

associated the resource with a relational database,
build the SQL query on the required table(s) or view(s).

After selecting the Resources tree item, a click on the New Resource toolbar button displays the New Resource wizard.

The first Resource Location wizard screen is displayed in order to specify the properties of the data source which the resource must rely on.

Figure: New RDBMS resource definition

Application: It is the application that contains the resource. A click on the list box displays the available applications.

Name: It is the label of the resource as it appears in the COGNITUM Console. Non-alphanumerical characters and blank spaces are prohibited.

Base on: To add an RDBMS resource, the Data Source option must be selected.

Data Source: Several data sources may have been set for the application selected. The list box shows all the data sources available for the selected application. An RDBMS data source must be selected in this list box.

Mapping Type: The wizard proposes three options to create an RDBMS resource that are described below:

Mapping the resource to a table
Mapping the resource to a view
Mapping the resource to an SQL query

Mapping the resource to a table

When creating an RDBMS resource, the wizard makes it possible to ease the creation process by mapping the resource to a table.

The new resource can be associated with a table in the connected database. Each column of the selected table stands for the possible attributes of the resource. As a second step, the data to retrieve from the selected table can be filtered using a restriction clause. With this method, the resource can be accessible in write or write/read mode.

When the New Resource wizard is launched, the Table option must be chosen in the first Resource Definition screen.

Figure: Mapping the resource to a table

A click on the Next button displays the second Resource Properties wizard screen. FROM: This is the full name of the table. This includes the name of the catalog and schema if any. A click on the torch button opens up the Table Selection dialog box.

Figure: New RDBMS resource properties

Figure: Table Selection box

Catalog (for SQL-Server databases): The list box displays the catalogs available for the connected database.

Schema: A click in the list box displays the metadata available for the catalog previously selected.

NOTE
he database structure varies according to the database type and the JDBC drivers. Oracle databases are structured with schemata containing tables. SQL-Server databases are structured with catalogs containing schema that contain tables.

Access databases only contain tables.

Table Selection: In this area, the search box makes it possible to look for the required table. The list below automatically highlights the table searched.

Select a table: In this list box, the tables can be scrolled for selection.

A click on OK validates the selection. The Table Selection dialog box is closed back to the Resource Properties wizard screen.

WHERE: This is the WHERE clause of the query. This clause is a filter on the tuples of the selected table. Defining the filter makes it possible to limit the results returned by the query. The box can contain all the query components compatible with the SQL standard 92.

A click on the torch button opens up the SQL Query Builder. This tool helps you create an accurate and consistent SQL request easily. The SQL Query Builder is similar to the LDAP Request Builder described in “Creating an LDAP request”.

A click on the Next button displays the third Attributes Creation screen of the wizard. The third step of the resource creation consists in selecting the attributes and the resource instance identifier.

Figure: New RDBMS resource attributes creation

Available Columns: The box lists the columns of the table matching the conditions previously entered. Each column stands for a possible attribute of the resource. Once selected from this box, the column must be moved into the facing box so as to be defined as a resource attribute.

Attributes to create: The box lists the column(s) defined as the attribute(s) of the resource. They are used by COGNITUM as logical attributes for the resource:

Column Name: The arrow buttons are used to select/deselect attributes from the Available Columns list to the Column Name one.
ID: The ID check box facing each column name in the Attributes to create box must be selected to define the corresponding attribute as an identifier of a resource instance.

The ID is the unique identifier of a resource entry. It can be composed of one or several attributes of the resource. The ID is used to generate the RDBMS DN of an entry.

NOTE
When an available column of the resource is a primary key, a foreign key or a unique key of the table, it is automatically located in the Attributes to create box. Similarly, when an available column is ruled by an integrity constraint such as not null or assigned an autoincrement, it is located in the Attributes to create box.

WARNING
The resource ID must be mapped onto one of the unique keys of the table. Otherwise, any modification performed on an entry of the resource might bring changes on several tuples of the table.

A click on Finish validates the properties entered for the resource. In the COGNITUM Console tree, the resource icon is displayed.

NOTE
A right-click on the new resource gives access to the Edit Description command which displays a dialog box. A descriptive text about the resource can be entered. This text appears whenever mouse is rolled over the resource tree item.

To create a resource by mapping a table

In the COGNITUM Console, select the Resources item and click the New Resource toolbar button.
In the Resource Definition wizard screen, fill in the boxes:
Application with the application for which the resource must be added,
Name with the name you want to give to the resource.
For the Base on option, choose Data Source.
In Data Source, select the RDBMS data source of the application to be used for the resource creation.
In Mapping Type, select the Table option and click Next.
In the second screen of the wizard, in the FROM box, enter the name of the table the resource must be mapped to or click the torch button to open the Table Selection dialog box.
In the WHERE box, enter the restriction constraint to apply to the table selected. Click the torch button to launch the SQL Query Builder. Click the Next button to display the third screen of the wizard.
In the Attributes of the Resource area, select the attributes to associate with the resource from the Available Columns box. Use the arrow buttons to move attributes from a list to another.
In the Attributes to create box, select the check boxes of the attribute(s) to be defined as the ID of the resource.
Click the Finish button to validate the settings for the new resource.

Mapping the resource to an RDBMS view

An RDBMS view is a database object. It gathers data coming from one or several tables of the database.

The New Resource wizard makes it possible to create a resource by mapping it to an existing view in the database. With this type of resource, COGNITUM can handle data retrieved from a database view. The resource creation wizard manages views the same as tables. Each column of the view stands for a potential attribute of the resource. The data to retrieve from the selected view can be filtered using a restriction clause. The resource can be accessible in write/read mode.

When the New Resource wizard is launched, the View option must be chosen in the first Resource Definition screen.

Figure: Mapping the resource to an RDBMS view

A click on the Next button displays the second Resource Properties wizard screen.

Figure: New RDBMS resource properties

FROM: This is the full name of the view. This includes the name of the catalog and schema if any. A click on the torch button opens up the View Selection dialog box.

Figure: View Selection box

Catalog (if supported by the database): The list box displays the catalogs available for the connected database.

Schema (if supported by the database): A click in the list box displays the metadata available for the catalog previously selected.

NOTE
The database structure varies according to the database type. Oracle databases are structured with schemata containing views. SQL-Server databases are structured with catalogs containing schemata that contain views. Access databases only contain tables.

View Selection: In this area, the search box makes it possible to look for the required view. The list below automatically highlights the view searched.

Select a view: In this area, the list can be scrolled to locate the required view.

A click on OK validates the selection. The View Selection dialog box is closed back to the Resource Properties wizard screen.

WHERE: This is the WHERE clause of the query. This clause is a filter on the tuples of the selected view. Defining the filter makes it possible to limit the results returned by the query. The box can contain all the query components compatible with the SQL standard 92. A click on the torch button opens up the SQL Request Builder. This tool helps you create an accurate and consistent SQL request easily. The working of the SQL request builder is based on the LDAP request builder one. For more information, see “Creating an LDAP request”.

A click on the Next button displays the Attributes Creation screen of the wizard. The third step of the resource creation consists in selecting the attributes and the resource instance identifier.

Figure: New RDBMS resource attributes creation

Available Columns: The box lists the columns of the view matching the conditions previously entered. Each column stands for a possible attribute of the resource. Once selected from this box, the column must be moved into the facing box so as to be defined as a resource attribute.

Attributes to create: The box lists the column(s) defined as the attribute(s) of the resource They are used by COGNITUM as logical attributes for the resource.

Column Name: The arrow buttons are used to select/deselect attributes from the Available Columns list to the Column Name one.
ID: The ID check box facing each column name in the Attributes to create box must be selected to define the corresponding attribute as an identifier of a resource instance. The ID is the unique identifier of a resource entry. It can be composed of one or several attributes of the resource. The ID is used to generate the RDBMS DN of an entry.

WARNING
The resource ID must be mapped onto one of the unique keys of the table. Otherwise, any modification performed on an entry of the resource might bring changes on several tuples of the view.

A click on Finish validates the properties entered for the resource. In the COGNITUM Console tree, the resource icon is displayed.

NOTE
To replace the pattern in the SQL requests several resources or dynamic roles., the ctrl or alt key must be pressed down while select the tree elements.

A right-click on the new resource gives access to the Edit Description command which displays a dialog box. A descriptive text about the resource can be entered. This text appears whenever the cursor is left on the resource tree item.

To create an RDBMS resource by mapping a view

In the COGNITUM Console, select the Resources tree item and click the New Resource toolbar button.
In the Resource Definition area, fill in the boxes:
Application with the application for which the resource must be added,
Name with the name you want to give to the resource.
For the Based on option, choose Data Source.
In Data Source, select the RDBMS data source of the application to be used for the resource creation.
In Mapping Type, select the View option and click Next.
In the second screen of the wizard, in the FROM box, enter the name of the view the resource must be mapped to or click the torch button to open the View Selection dialog box.
In the WHERE box, enter the restriction constraint to apply to the view selected. Click the torch button to launch the SQL Query Builder. Click the Next button to display the third screen of the wizard.
In the Attributes of the Resource area, select the attributes to associate with the resource from the Available Columns box. Use the arrow buttons to move attributes from a list to another.
In the Attributes to create box, select the check boxes of the attribute(s) to be defined as the ID of the resource.
Click the Finish button to validate the settings for the new resource.

Mapping the resource to an SQL query

The New Resource wizard makes it possible to create an RDBMS resource with an SQL query on the database. The data necessary for the resource definition are retrieved from the connected database with an appropriate SQL query. The query returns data stored on different tables. The resource is then mapped to the result of the query. The result of the query contains the columns to be used as the attributes of the resource.

When the New Resource wizard is launched, the SQL Query option must be chosen in the first Resource Definition screen.

Figure: Mapping the resource to an SQL query

A click on the Next button displays the second Resource Definition wizard screen.

Figure: New RDBMS resource properties

SQL Query: The box must be populated with an SQL query. The query must specify the required data to retrieve from the database

NOTE
Completion in entry boxes for SQL queries is available with ctrl+space. A pop-up window is displayed with the schemas, tables, or boxes for the current context.

For example:

It is assumed that the database the resource is connected to contains the tables Department and Users. The Department table includes the columns Dep_Name and Dep_ID. The Users table includes the columns Usr_Name and Usr_f_Dep_ID.

You want to create a resource that contains the users of the Users table. And for each user, the department they work in must be specified. You want the users to be listed in alphabetical order. Therefore, the query should be the following:

Select Dep_Name, Usr_Name FROM Department, Users WHERE Dept_ID=Usr_f_Dep_ID Order by Usr_Name

Figure: New RDBMS resource attributes creation

Available Columns: The box lists the columns returned by the query previously entered. Each column stands for a possible attribute of the resource. Once selected from this box, the column must be moved into the facing box so as to be defined as a resource attribute.

Attributes to create: The box lists the column(s) defined as the attribute(s) of the resource. They are used by COGNITUM as logical attributes for the resource:

Column Name: The arrow buttons are used to select/deselect attributes from the Available Columns list to the Column Name one.
ID: The ID check box facing each column name in the Attributes to create box must be selected to define the corresponding attribute as an identifier of a resource instance. The ID is the unique identifier of a resource entry. It can be composed of one or several attributes of the resource. The ID is used to generate the DN of an entry.

WARNING
The resource ID must be mapped onto one of the unique keys of the table. Otherwise, any modification performed on an entry of the resource might bring changes on several tuples of the view.

A click on Finish validates the properties entered for the resource. In the COGNITUM Console tree, the resource icon is displayed.

NOTE
A right-click on the new resource gives access to the Edit Description command which displays a dialog box. A descriptive text about the resource can be entered. This text appears whenever the cursor is left on the resource tree item.

To create an RDBMS resource by mapping an SQL query

In the COGNITUM Console, select the Resources tree item and click the New Resource toolbar button.
In the Resource Definition area, fill in the boxes:
Application with the application for which the resource must be added,
Name with the name you want to give to the resource.
For the Based on option, choose Data Source.
In Data Source, select the RDBMS data source of the application to be used for the resource creation.
In Mapping Type, select the SQL query option and click Next.
In the second screen of the wizard, in the SQL Query box, enter the SQL query specifying the required data to retrieve from the database. Click the Next button.
In the Attributes of the Resource area, select the attributes to associate with the resource from the Available Columns box. Use the arrow buttons to move attributes from a list to another.
In the Attributes to create box, select the check boxes of the attribute(s) to be defined as the ID of the resource.
Click the Finish button to validate the settings for the new resource.

Adding a computed resource

A computed resource is defined by information that do not map a physical data source. A computed resource does not exist as a physical entity. It gives the possibility to define virtual attributes and manually code the corresponding basic read, update, create, delete, and search operations.

Specifying a computed resource may prove necessary to connect and provision third-party systems not compliant with LDAP or SQL. It may also provide a flexible way to aggregate and manage data from existing resources and links into a single resource.

A computed resource is the result of a computing process that defines its content:

Conceptually, a computed resource is defined by a Java class. The Java class determines the access tasks to external data. As the Java class mode is available to the application designer, a computed resource can be customized as much as required.
Practically, whenever the data source on which a resource should rely is not available, a computed resource can be defined. Computed resources widen the range of data available.

Adding a computed resource consists in labeling the new resource and associate it with a Java class. The resource creation is performed through the New Resource wizard. The wizard guides the application designer through the two steps necessary for the creation of the resource.

In order to launch the New Resource wizard, the Resources tree item should be selected. A click on the New Resource toolbar button displays the first Resource Definition wizard screen. In this screen, the Java class which defines the computed resource must be specified.

Figure: New computed resource definition

Application: It is the application that contains the resource. A click on the list box displays the applications available.

Name: It is the label of the resource as it appears in the COGNITUM Console. Non-alphanumerical characters and blank spaces are prohibited.

Based on: To add a computed resource, the Java API option must be selected.

Java Class: This box must be completed with the Java class name. The facing torch-like button helps select a .java or .class file available in COGNITUM-root/Server/dev/application/computedResources. When the Java class file need be written afterwards, the Default Class Name button automatically enters a default label for the will-be Java class file.

Generate the Source File: Checking this option creates the framework of a default Java class file used for the computed resource. The file can be edited afterwards as documented in “Configuring a computed resource”. When a fully-developed Java class has been selected for the Java Class box, the default class file cannot be generated.

TIP
COGNITUM is shipped with a set of predefined Java class files available in COGNITUM-root/doc/baggage/javadoc. They are ready-to-use computed resources. They can be fine-tuned in the COGNITUM Console as documented in “Configuring a computed resource”.

A click on the Next button displays the second screen of the wizard where are specified the attributes used in the computed resource.

Figure: New computed resource attributes creation

Attribute Name: To specify an attribute declared in the Java class, a click on the empty table line makes it possible to enter its name. A new line is automatically displayed to specify another attribute.

Mandatory: At least one attribute must set as mandatory to serve as the dn of the resource. Other attributes can be mandatory when the facing box is checked. They are essential to use the computed resource.

A click on Finish validates the properties entered for the computed resource. In the COGNITUM Console tree, the resource icon is displayed. To edit the Java class file used for the computed resource, see “Configuring a computed resource”.

NOTE
A right-click on the new resource gives access to the Edit Description command which displays a dialog box. A descriptive text about the resource can be entered. This text appears whenever the cursor is left on the resource tree item.

To create a computed resource

In the COGNITUM Console, select the Resources tree item and click the New Resource toolbar button.
In the Resource Definition area, fill in the boxes:
Application with the application for which the resource must be added,
Name with the name you want to give to the resource.
For the Based on option, choose Java API.
To fill in the Java Class box:
- click the torch button to select a Java class file made available in COGNITUM-root/Server/dev/application/computedResources, or
- click the Default Class Name to generate a name for the will-be Java class file.
When you have clicked Default Class Name, select Generate the Source File check box to create the Java class file that needs to be developed subsequently.
In the second screen of the wizard, enter the names of the attributes retrieved by the Java class file. Check the Mandatory boxes when necessary.
Click the Finish button to validate the settings for the new computed resource.

Copying a resource

When a new resource is expected to be defined and configured quite similarly to an existing resource, it may be useful, quick and secure to duplicate that resource. The Copy and Paste commands allow to bypass the complete resource creation process.

A resource can be copied:

under the same Resources item, and/or
into another application.

The Copy and Paste commands are available from the context menu, from the Edit menu, or with the ctrl+c/ctrl+v shortcuts, once the source resource or target items are clicked.

WARNING
When a resource copy is pasted, a message box pops up and asks for the data source to be associated with it.

WARNING
When a resource copy is pasted under the same Resources item a message box pops up and asks for another name.

To copy a resource

In the COGNITUM Console tree, select the resource to duplicate under the Resources node.
Choose the Copy command from the context menu of the selected source resource.
In the tree, select the object on which the resource must be pasted.
Choose the Paste command from the context menu of the selected source item.
If the Resource with the same name already exists, user can rename the copying Resource.

Copying a resource with Links

This option copies the Resource with all the links and the resources used by these links.

To copy Resource with links

In the COGNITUM Console tree, select the resource to duplicate under the Resources node.
Choose the Copy with Links command from the context menu of the selected source resource.
In the tree, select the object on which the resource must be pasted.
Choose the Paste command from the context menu of the selected source item.

WARNING
If the Resource with the same name already exists, it is overwritten.

Configuring an LDAP Resource

Configuring a resource is necessary:

Once a resource is created for an HTTP application. Its operating parameters must be entered before it is assigned to a view.
To update an existing resource.

A click on the resource in the COGNITUM Console tree or a double-click on the resource in the property view opens the Resource configuration property view and its two tabs, logical and Presenatation.

Figure: LDAP resource configuration property tabs

Setting the logical configuration of an LDAP resource

The logical configuration of an LDAP resource includes all the functional parameters of the resources: definition and triggers.

Definition

When the Logical tab layer is selected, the Definition tab of the chosen resource lists information about the resource request.

Figure: Logical configuration properties of an LDAP resource

Name: The resource can be renamed as it is displayed in the COGNITUM Console. Non-alphanumerical characters and blank spaces are prohibited.

Data Source: This list box identifies the data sources available for the application resource. A click on the list box displays the data sources previously defined in the COGNITUM Console for the application linked to the current resource.

Read Only: Selecting the check box sets the resource in read only mode. In the application, any modification on the resource is prohibited.

Base: The request start node of the resource can be changed in the DN Chooser selection box accessible with a click on the torch button.

NOTE
The Base DN entry can be a variable. For example, the Filter and Base DN boxes can contain (objectclass=*) and $userDN for the my personal entry resource type. For more information, see “

Using variables in dynamic resources

”. |

WARNING
COGNITUM makes it possible to add resources for an application even though the accessed directory is temporarily unavailable. However the object class and suffix pre-selection lists are not accessible.

Filter: The LDAP filter on the resource can be modified manually. The torch button opens the LDAP Request Builder documented in “Creating an LDAP request”.

Scope: It is the depth of the LDAP request in the directory tree from the context node. The scope options are:

Object: The search is restricted to a single entry, that is the context.
One Level: All objects at one level below the context can be searched, but the object itself.
Sub Tree: The entire tree below the specified context is searched. The object is included.

RDN Attribute: The RDN attribute is used to generate the DN of a given entry. Specifying the RDN attribute allows COGNITUM to manage automatically creation and renaming operations. A click on the RDN Attribute list box displays all the attributes available.

Default Entry Definition: In this box, a DN or LDAP filter can be entered through the torch button to select a specific entry of the resource. Selecting a default entry allows to configure a root resource in a view so as to display an entry form of the specific entry selected. This facility is mainly applicable for a my_entry resource type.

TIP
A default entry can use a variable.

NOTE
When an LDAP filter returns many results, only the first object is displayed as the default entry.

A click on the Apply button validates the parameters.

To configure the resource definition

In the COGNITUM Console tree, select the resource you want to modify under the Resources item. Click the Logical tab layer and the Definition tab.
In the Name box, you can change the label of the resource in the COGNITUM Console.
In the Data Source list box select the data source to be used for the resource.
In the Base box, you can change the value of the request start node with the torch button.
In the Filter box, you can enter another LDAP filter on the resource. You may also click the torch button to launch the LDAP Request Builder.
Check the Scope option box with the LDAP request depth you want.
In the RDN Attribute list box, select the RDN attribute to be used as the RDN of the resource.
In the Default Entry Definition box, you can define a DN or LDAP filter if you want to force the default result to one object for a root resource. Use the torch button to display the Default Entry dialog box and define the query.
Click Apply to save any changes you have made.

Triggers

For each of the resources created in the COGNITUM Console, the Read, Create, Update, Delete, and Rename operations can be configured so that they automatically trigger an action when the operations are invoked.

These operations and the associated triggers are run by the COGNITUM Engine. Triggers are launched on these operations.

When a resource is selected in the COGNITUM Console tree, the Triggers tab below the Logical tab layer allows to configure the READ, CREATE, UPDATE, DELETE, and RENAME tabs:

BEFORE trigger is launched before the operation runs.
AFTER trigger is launched when the operation is completed successfully.
FAILED trigger is launched when the operation did not run correctly.

Figure: Triggers definition properties of an LDAP resource

Before Trigger

The BEFORE area is available in the READ, CREATE, UPDATE, DELETE, and RENAME tabs when the Logical tab layer is selected.

This area identifies the Java class determining the pre-action to be triggered when the operation is invoked.

Figure: Before trigger

Java Class: This is the name of the Java class. The Java class code determines the pre-action to be carried out. A click on the Edit button allows to display the code of the Java class. The piece of code that defines the action to trigger must be inserted on the line named '// insert code here ...'. For more information see the COGNITUM Data Abstraction Layer Javadoc.

NOTE
When the COGNITUM Console is started remotely, the Java code editing function is unavailable, whether is used for a trigger, a computed attribute, a variable, a function, and so on.

A click on the torch button opens up the Choose the Java Class dialog box.

Figure: Choose the Java Class box

To fill in the Java Class box, a click on the torch button allows to select another Java class. A click on the Default Class Name button fills in the Java Class box with its default name.

Selecting the Generate the Source File check box allows to create a pattern program displaying the name of the methods to be used, the specific location of the values to be entered and comments. A click on the OK button validates the selected Java class back into the trigger tab.

Edit: In the Triggers tabs, a click on this button opens up a text editor displaying the Java class code.

TIP
The editor used to open the source file can be selected with the Editor command from the Tools => Preferences menu. Select the type of editor to use in the Editor Preferences dialog box.

Compile: A click on the Compile button compiles the .javafile to turn it into a .class file.

A click on the tab Apply button validates the Before trigger.

After Trigger

The AFTER area is available in the READ, CREATE, UPDATE, DELETE, and RENAME tabs when the Logical tab layer is selected.

The AFTER area identifies the Java class determining the post-action to be triggered once the operation is completed successfully.

Figure: After trigger

Java Class: This is the name of the Java class. The Java class code determines the post-action to execute. A click on the Edit button allows to display the code of the Java class. The piece of code that defines the action to trigger must be inserted on the line named '// insert code here ...'. For more information see the COGNITUM Data Abstraction Layer Javadoc.

A click on the torch button opens up the Choose the Java Class dialog box.

Figure: Choose the Java Class box

To fill in the Java Class box, a click on the torch button allows to select another Java class. A click on the Default Class Name button fills in the Java Class box with its default name. Selecting the Generate the Source File check box allows to create a pattern program displaying the name of the methods to be used, the specific location of the values to be entered and comments.

A click on the OK button validates the selected Java class back into the trigger tab.

Edit: In the Triggers tabs, a click on this button opens up a text editor displaying the Java class code.

Compile: A click on the Compile button compiles the .javafile to turn it into a .class file.

A click on the tab Apply button validates the After trigger.

Failed Trigger

The FAILED area is available in the READ, CREATE, UPDATE, DELETE, and RENAME tabs when the Logical tab layer is selected.

The FAILED area identifies the Java class determining the action to trigger when the operation has failed.

Figure: Failed trigger

Java Class: This is the name of the Java class. The Java class code determines the type of action to be carried out. A click on the Edit button allows to display the code of the Java class. The piece of code that defines the action to perform must be inserted on the line named '// insert code here ...'. For more information see the COGNITUM Data Abstraction Layer Javadoc.

A click on the torch button displays the Choose the Java Class dialog box.

Figure: Choose the Java Class box

To fill in the Java Class box, a click on the torch button allows to select another Java class. A click on the Default Class Name button fills in the Java Class box with its default name. Selecting the Generate the Source File check box allows to create a pattern program displaying the name of the methods to be used, the specific location of the values to be entered and comments.

A click on the OK button validates the selected Java class back into the trigger tab.

Edit: In the Triggers tabs, a click on this button opens up a text editor displaying the Java class code

Compile: A click on the Compile button compiles the .javafile to turn it into a .class file.

A click on the tab Apply button validates the Failed trigger.

Triggers Configuration Procedure

Below is a quick procedure listing the step-by-step instructions to configure the Triggers tab.

To configure triggers for a resource

In the COGNITUM Console tree, select the resource you want to configure under the Resources item.
Select the Logical tab layer and the Triggers tab.
Select the tab representing the operation when the trigger(s) are used: READ, CREATE, UPDATE, DELETE, or RENAME.
In the BEFORE area:
Fill in the Java Class box with the name of the Java class meant to determine the pre-action to trigger before the operation is executed.
Click the torch button to select another Java class. —Click the Edit button to edit the Java class code and modify it. —Click the Compile button to compile the .java file.
In the AFTER area:
Fill in the Java Class box with the name of the Java class used to determine the action to trigger when the operation is completed.
Click the torch button to select another Java class. —Click the Edit button to edit the Java class code and modify it. —Click the Compile button to compile the .java file.
In the FAILED area:
Fill in the Java Class box with the name of the Java class used to determine the action to trigger when the operation has failed.
Click the torch button to select another Java class. —Click the Edit button to edit the Java class code and modify it. —Click the Compile button to compile the .java file.
Click Apply to validate the configuration.

Setting the presentation properties of an LDAP resource

The presentation of an LDAP resource stands for the ways users access data. It includes all the operational parameters of the resources in four tabs available under the Presentation tab layer:

Business Forms
Search
Sort Attributes
Bulk Operations

Business Forms

COGNITUM provides a tab to define a business form. When a resource is selected in the COGNITUM Console tree, the Business Form tab below the Presentation tab layer helps to define the form and assign rights.

Search & Result Properties

COGNITUM provides a tab to specify search/result forms. When a resource is selected in the COGNITUM Console tree, the Search tab below the Presentation tab layer determines how the resource search functions operate.

Figure: LDAP resource search & result properties

Fast Search Attributes: This area allows to configure the fast search request. The attributes entered in the Attribute column stand for the search attributes. When several attributes are selected for the Fast Search function, the OR operator is used. A click on the Insert button makes it possible to add a new attribute through the Attribute Selection dialog box.

Advanced Search Attributes: This area allows to configure the advanced search form defined in the view. The attributes entered in the area are used by COGNITUM to generate the default advanced search form. In the form can be entered a search value for each search attribute. A click on the Insert button makes it possible to add a new attribute through the Attribute Selection dialog box.

When there are several attributes, the AND operator is used.

The result request returns the objects meeting the criterion specified in the Advanced Search Attributes area.

List of Results: This defines how query results are displayed. By default, a form is generated and contains text boxes corresponding to the display attributes defined in the Action box. The Attribute boxes allows to choose which attributes are to be displayed as result of the search request. A click on the Insert button makes it possible to add a new attribute through the Attribute Selection dialog box. Computed attributes can be defined as search result attributes. For more information, see “Computed attributes”.

Results are displayed in a table. Every column in the table stand for an attribute.

In the Action column, the type of display mode is selected from the drop-down list. The Action cells drop-down lists includes all the forms specified when defining the resource. It also lists the following actions:

Text: The result only is displayed, with no hyperlink.
E-mail: The result is displayed as a hyperlink to open an e-mail window.

NOTE
For more information about the forms specified when defining a resource, see “Adding an LDAP resource”.

For each of the three search and result functions, the Insert button opens the Attribute Selection box to add an attribute whereas the Remove button deletes the listed ones. For the Advanced Search Attributes and the List of Results functions, the positioning arrow buttons shift attributes order in the list in the COGNITUM Console, and in the columns in the view.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

In the Operator column for the Fast Search Attributes and Advanced Search Attributes boxes, the type of logical operation is selected from the cell list.

Table: Operators

Operator	Meaning
contains	The search string must be a subset of the result string, for example John Robertson contains Robert
does not contain	The search string must not be a subset of the result string.
is	The search string must exactly match the result string, for example John Robertson is John Robertson matches.
is not	The search string must not match the result string.
like	The search string must be similar to the result string.
greater than	The search string must be greater that the result string.
less than	The search string must be less that the result string.
begins with	The search string must be at the beginning of the result string, for example begins with Jo matches John Robertson.
ends with	The search string must end the result string, for example ends with son matches John Robertson.

WARNING
Hyperlinked results are subject to access rights. For more information, see “

Roles

”. |

NOTE
According to the accessed directory, the search functions may be case-sensitive.

A click on the Apply button validates the parameters entered in the Search tab.

To set the search properties on a resource

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Search tab.
In the Fast Search Attributes area, select the attributes that the general search function will query. To do so, use the Insert and Remove buttons. For each attribute, select an operator from the column list.
In the Advanced Search Attributes area, select the attributes that appears as search boxes in the view. To do so, use the Insert and Remove buttons. Classify the attributes in order with the arrow buttons. For each attribute, select an operator from the column list.
In List of Results, select the attributes that query results are displayed. To do so, use the Insert and Remove buttons. Classify the attributes in order with the arrow buttons. For each attribute, select a display mode from the column list.
Click Apply to save the parameters you have entered.

Sort attributes

In the search and navigation modes, query results and navigation items can be displayed in sorted lists.

When a resource is selected in the COGNITUM Console tree, the Sort Attributes tab below the Presentation tab layer makes it possible to define the type and behavior of the sort operator(s).

NOTE
The Sort Attributes facility can be used independently from the Displayed Attributes set in the DHTML tab. For example, results can be displayed according to the cn attribute and ordered according to the sn sort attribute.

Figure: LDAP resource sort properties

Attribute: This column lists the selected sort attributes.

Type: A click in the column makes it possible to define whether the attribute results must be considered as strings or integers.

Order: A click in the column makes it possible to choose whether the returned results is classified in ascending or descending order.

Case: This column offers the case-sensitivity option.

When there are several sort attributes, the up and down arrows can help set the sort criteria hierarchy.

Insert: This button displays the Attribute Selection box to define a sort attribute.

Remove: A sort attribute selected in the Sort Attributes tab is removed with the Remove button.

A click on the Apply button validates the definition of sort attributes for the resource.

To set the resource sort attributes

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Sort Attributes tab.
Click Insert to select a sort attribute in the Attribute Selection list box.
For a selected sort attribute, click the Type, Order and/or Case column to define its nature, behavior and sensitivity.
Organize your sort attributes with the Up and Down arrows.
Click Apply to save the parameters you have entered.

Bulk operations properties

COGNITUM makes it possible to work on a set of LDAP query result items known as the Basket.

When a resource is selected in the COGNITUM Console tree, the Bulk Operations tab below the Presentation tab layer determines which attributes of the resource can be exported and modified as a bulk selection.

NOTE
Bulk operations in COGNITUM also include deletion and e-mailing, but those do not require specific configuration.

Figure: LDAP resource bulk operations properties

Export Attributes: This area lists the attributes that can be exported as a complete selection into HTML, ZIP, TXT, or CSV format. A CSV directory extract can be imported into an Excel file. The Insert button opens the Attribute Selection box to add an attribute that can be exported; whereas the Remove button deletes the listed ones. The positioning arrow buttons shift attributes order in the list in the COGNITUM Console, and in the columns in the view.

Update Attributes: It lists the attributes that can be modified in one go. The Insert button opens the Attribute Selection box to add an attribute that can be updated; whereas the Remove button deletes the listed ones. The positioning arrow buttons shift attributes order in the list in the COGNITUM Console, and in the update boxes in the view.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

A click on the Apply button validates the parameters selected in the Bulk Operations tab.

WARNING
Bulk operations are subject to access rights. For more information, see “

Roles

”. |

To configure the resource bulk operations properties

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Bulk Operations tab.
In the Export Attributes area, select the attributes that you want authorized users to export in HTML, CSV or TXT files as a whole selection. To do so, use the Insert and Remove buttons. With the arrow buttons, classify the attributes as you want the columns to be displayed in the export page.
In the Update Attributes area, select the attributes that you want authorized users to modify as a whole selection. To do so, use the Insert and Remove buttons. With the arrow buttons, classify the attributes as you want the entry boxes to appear in the update page.
Click Apply to save the parameters you have selected.

Navigation Properties

When a resource is selected in the COGNITUM Console tree, the Browse and DHTML tabs below the Presentation tab layer determines how the resource is displayed while browsing the content of the directory.

NOTE
The DHTML tab is available for compatibility reasons with previous COGNITUM versions viz. COGNITUM 4.5, 5.0, 5.1 only.

Figure: LDAP resource navigation properties

Displayed Attributes: This area lists the attributes used for browsing the directory. The Insert button opens the Attribute Selection box to add an attribute whereas the Remove button deletes the listed ones. The positioning arrow buttons shift the attributes order in the list.

Separator: This list box is used when there are several attributes in the navigation list that should be separated with signs/characters to be legible.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

Extra Filter: The extra filter is an additional LDAP filter concatenated with the resource definition filter so as to retrieve a specific selection of entries matching both filters. It is applicable when the resource is set as a root resource in a view. Example: The resource users has an extra filter defined as (sn=B*) then, only users having a name starting by a B are retrieved.

The definition is entered manually and/or with the help of the torch button that opens up the LDAP Request Builder.

When the resource has already been assigned to a view, the navigation parameters can be checked in the end-users interface.

A click on the Apply button validates the parameters.

To set the LDAP resource navigation properties of a resource

In the COGNITUM Console tree, select a resource.
Select the Presentation tab layer and the Browse tab.
Select attributes into the Displayed Attributes area with the Insert and Remove buttons. Arrange their order with the arrow buttons.
When you have selected several attributes, you can have them displayed with separators entered or chosen in the Separator list box.
In the Extra Filter box, you can define an additional LDAP filter to be concatenated with the resource definition filter.
Click Apply to save any parameters you have entered.

Figure: LDAP resource DHTML mode properties

Icons: The Icons area makes it possible to assign icons to the navigation attributes. They can be checked in the Preview panel. The torch buttons give access to icons selection boxes.

Closed node: It is the path to the icon representing the leaf as closed in the tree, that is the entries below the resource are not expanded.
Open node: It is the path to the icon representing the leaf as opened, that is the entries below the resources are expanded. This icon is only viewable in the JSP page.
Leaf: It is the path to the icon representing the leaf, that is the main object in the tree.

NOTE
To add images to the COGNITUM gallery, copy any Web-browser compatible graphic files into the COGNITUM-root/Server/webapps/application/images/icons folder.

Display Bounds: The option in the Display Bounds area should be checked when the resource is likely to return a large number of results from searches. Then the attribute values need to be split into chunks, for example [A-C], [D-E], and so on. The chunks are defined in the DHTML Mode box.

A click on the Apply button validates the parameters.

To set the navigation properties of a resource

In the COGNITUM Console tree, select a resource.
Select the Presentation tab layer and the DHTML tab.
Change the attributes icons in the Closed node, Open node and Leaf boxes with the torch button.
In the Display Bounds area, select the option check box when you want to chunk results. Enter the chunk definitions in the DHTML Mode.
Click Apply to save any parameters you have entered.

Setting the rights on an LDAP resource

Configuring the rights on an LDAP resource includes all the roles authorizations on the data. For a resource, rights can be assigned or restricted on actions on the data source.

Figure: LDAP resource rights properties

Roles: This tree can be expanded by double-clicking the application the resource runs on, and a role name. The facing actions boxes can be selected/unselected for each selected role.

Vertically are listed all the types of actions to be performed on a resource data. They are the READ, CREATE, UPDATE, and DELETE columns. Rights can be assigned for a given role by selecting the facing action check box(es).

Physical rights are checked by the COGNITUM Engine when accessing the data source. This facility reinforces the security already set on forms. For instance, when reading an entry of a resource, the engine checks that the connected user is allowed to read the entries of the resource.

For a given action, selecting the check box facing the application name amounts to granting rights to all the roles.

A click on Apply validates the operation(s).

To assign rights on a resource

In the COGNITUM Console tree, select the resource you want to assign rights on.
Choose the Rights tab layer and the Physical Rights tab.
In the Roles tree, expand the tree to a role. Click a role.
To authorize actions on the resource data, select the facing check boxes.
Click Apply to validate the rights assignment.

Configuring an RDBMS resource

Once created, a resource is somewhat pre-configured for properly running the basic functions of the application. Still, the parameters of the resource are available for modification in the tabs of the property view.

A click on the resource in the COGNITUM Console tree or a double-click on the resource in the property view opens the Resource configuration property view and its three tab layers.

Figure: RDBMS resource configuration tabs

Setting the logical properties of an RDBMS resource

The logical configuration of an RDBMS resource includes all the functional parameters of the resources: definition and triggers.

Definition

When the Logical tab layer is selected, the Definition tab of the chosen resource lists information about the resource request.

Figure: RDBMS resource logical properties

Name: The resource can be renamed as it is displayed in the COGNITUM Console. Non-alphanumerical characters and blank spaces are prohibited.

Read Only Resource: Selecting the check box sets the resource in read only mode. In the application, any modification on the resource is prohibited.

NOTE
By default, a resource mapped to an SQL query is set in read only mode.

RDBMS Definition: The area recalls the resource RDBMS definition parameters. Selecting a different option makes it possible to redefine the resource and map it to a:

Table as described in “Mapping the resource to a table”, or
View as described in “Mapping the resource to an RDBMS view”, or
SQL Query as described in “Mapping the resource to an SQL query”.

Identifier: The ID column lists the ID defined for the resource. A click in a line of the list activates a list box displaying the attributes available. Each attribute can be selected as an ID of the resource. Selecting the blank line in the list box removes the attribute from the list.

WARNING
Binary type attributes cannot be defined as ID of the resource.

Default Entry Definition: In the area, a default entry can be defined for the resource. The instance of the resource selected here is used to configure a root resource in a view so as to display an entry form of the specific entry selected. A click on the torch button opens up the Default Entry dialog box.

Figure: Default Entry box

SQL DN: Selecting this option makes it possible to enter an entry of the resource. The entry is then used as the default entry of the resource. The SQL DN is a string identifying the unique entry (tuple) of an RDBMS resource. The format of the SQL DN matches the following pattern:

RDBMS column name = Value [type format]

WARNING
The format value is only necessary when the date type is used.

The table below identifies the letters standing for the types available in the SQL DN

Letter	Description
I	Integer
R	Decimal
S	String (default value)
D	Date
B	Big decimal
G	Big integer

Logical Query: This option makes it possible to make an SQL query to retrieve the entry to be defined as the default entry. The box must be populated with a valid WHERE clause. The query can be combined with variables. A click on the torch button opens up the SQL Request Builder.

A click on OK validates the selection and closes the dialog box.

Back in the Definition tab, a click on Apply validates the definition parameters for the selected RDBMS resource.

To configure the resource definition

In the COGNITUM Console tree, select the RDBMS resource you want to modify under the Resources item. Click the Logical tab layer and the Definition tab.
In the Name box, you can change the label of the resource in the COGNITUM Console.
In the Data Source list box select the data source to be used for the resource.
Select the Read Only Resource box to prevent resource changes from the application, unless the resource is an SQL base.
In RDBMS Definition, you can change the resource mapping option:
Table as described in “Mapping the resource to a table”, or
View as described in “Mapping the resource to an RDBMS view”, or
SQL Query as described in “Mapping the resource to an SQL query”.
In Identifier, click a line to select/deselect the attribute(s) used as ID of the resource.
In Default Entry Definition, you can set a default entry for the root resource. Click the torch button to open the Default Entry dialog box and choose the following option:
SQL DN to enter an entry of the resource, or
Logical Query to write an SQL query which will retrieve the default entry.
Back into the Definition tab, click Apply to save any changes you have made.

Triggers

These operations and the associated triggers are run by the COGNITUM Engine. Triggers are launched on these operations.

When a resource is selected in the COGNITUM Console tree, the Triggers tab below the Logical tab layer allows to configure the READ, CREATE, UPDATE, DELETE, and RENAME tabs:

The BEFORE trigger is launched before the operation runs.
The AFTER trigger is launched when the operation is completed successfully.
The FAILED trigger is launched when the operation did not run correctly.

Figure: Triggers definition properties of an RDBMS resource

Before Trigger

The BEFORE area is available in the READ, CREATE, UPDATE, DELETE, and RENAME tabs when the Logical tab layer is selected.

This area identifies the Java class determining the pre-action to be triggered when the operation is invoked.

Figure: Before trigger

Java Class: This is the name of the Java class. The Java class code determines the pre-action to be carried out. A click on the Edit button allows to display the code of the Java class. The piece of code that defines the action to trigger must be inserted on the line named “// insert code here ...”. For more information see the COGNITUM Data Abstraction Layer Javadoc.

A click on the torch button opens up the Choose the Java Class dialog box.

Figure: Choose the Java Class box

Edit: In the Triggers tabs, a click on this button opens up a text editor displaying the Java class code.

TIP
The editor used to open the source file can be selected with the Editor command from the Tools => Preferences menu. Select the type of editor to use in the Editor Preferences dialog box.

Compile: A click on the Compile button compiles the .javafile to turn it into a .class file.

A click on the tab Apply button validates the Before trigger.

After trigger

The AFTER area is available in the READ, CREATE, UPDATE, DELETE, and RENAME tabs when the Logical tab layer is selected.

The AFTER area identifies the Java class determining the post-action to be triggered once the operation is completed successfully.

Figure: After trigger

Java Class: This is the name of the Java class. The Java class code determines the post-action to execute. A click on the Edit button allows to display the code of the Java class. The piece of code that defines the action to trigger must be inserted on the line named “// insert code here ...”. For more information see the COGNITUM Data Abstraction Layer Javadoc.

A click on the torch button opens up the Choose the Java Class dialog box.

Figure: Choose the Java Class box

A click on the OK button validates the selected Java class back into the trigger tab.

Edit: In the Triggers tabs, a click on this button opens up a text editor displaying the Java class code.

Compile: A click on the Compile button compiles the .javafile to turn it into a .class file.

A click on the tab Apply button validates the After trigger.

Failed trigger

The FAILED area is available in the READ, CREATE, UPDATE, DELETE, and RENAME tabs when the Logical tab layer is selected.

The FAILED area identifies the Java class determining the action to trigger when the operation has failed.

Figure: Failed trigger

Java Class: This is the name of the Java class. The Java class code determines the type of action to be carried out. A click on the Edit button allows to display the code of the Java class. The piece of code that defines the action to perform must be inserted on the line named ’// insert code here ...’. For more information see the COGNITUM Data Abstraction Layer Javadoc.

A click on the torch button displays the Choose the Java Class dialog box.

Figure: Choose the Java Class box

A click on the OK button validates the selected Java class back into the trigger tab.

Edit: In the Triggers tabs, a click on this button opens up a text editor displaying the Java class code

Compile: A click on the Compile button compiles the .javafile to turn it into a .class file.

A click on the tab Aply button validates the Failed trigger.

Configuring triggers

Below is a quick procedure listing the step-by-step instructions to configure the Triggers tab.

To configure triggers for a resource

In the COGNITUM Console tree, select the resource you want to configure under the Resources item.
Select the Logical tab layer and the Triggers tab.
Select the tab representing the operation when the trigger(s) are used: READ, CREATE, UPDATE, DELETE, or RENAME.
In the BEFORE area:
Fill in the Java Class box with the name of the Java class meant to determine the pre-action to trigger before the operation is executed.
Click the torch button to select another Java class. —Click the Edit button to edit the Java class code and modify it. —Click the Compile button to compile the .java file.
In the AFTER area:
Fill in the Java Class box with the name of the Java class used to determine the action to trigger when the operation is completed.
Click the torch button to select another Java class. —Click the Edit button to edit the Java class code and modify it. —Click the Compile button to compile the .java file.
In the FAILED area:
Fill in the Java Class box with the name of the Java class used to determine the action to trigger when the operation has failed.
Click the torch button to select another Java class. —Click the Edit button to edit the Java class code and modify it. —Click the Compile button to compile the .java file.
Click Apply to validate the configuration.

Setting the presentation properties of an RDBMS resource

The presentation of an RDBMS resource stands for the ways users access data. It includes all the operational parameters of the resources in four tabs available under the Presentation tab layer:

Busines Forms
Search
Sort Attributes
Bulk Operations

Busines Forms

COGNITUM provides a tab to specify Business forms. When a resource is selected in the COGNITUM Console tree, the Busines Forms

The tab below the Presentation tab layer determines how to define the business form.

Search and result properties

Figure: RDBMS resource search and result properties

Fast Search Attributes: This area allows to configure the fast search request. The attributes entered in the Attribute column stand for the search attributes. When several attributes are selected for the Fast Search function, the OR operator is used. A click on the Insert button makes it possible to add a new attribute through the Attribute Selection dialog box.

Advanced Search Attributes: This area allows to configure the advanced search form defined in the view. The attributes entered in the area are used by COGNITUM to generate the default advanced search form. In the form can be entered a search value for each search attribute. A click on the Insert button makes it possible to add a new attribute through the Attribute Selection dialog box.

When there are several attributes, the AND operator is used.

The result request returns the objects meeting the criterion specified in the Advanced Search Attributes area.

List of Results: This defines how query results are displayed. By default, a form is generated and contains text boxes corresponding to the display attributes defined in the Action box. The Attribute boxes allows to choose which attributes are to be displayed as result of the search request. A click on the Insert button makes it possible to add a new attribute through the Attribute Selection dialog box. Computed attributes can be defined as search result attributes. For more information, see “Computed attributes”.

Results are displayed in a table. Every column in the table stand for an attribute.

In the Action column, the type of display mode is selected from the drop-down list. Besides the three following actions, the Action cells drop-down lists includes all the forms specified when defining the resource.

Table Form actions

Action	Meaning
Text	The result only is displayed, with no hyperlink.
E-mail	The result is displayed as a hyperlink to open an e-mail window.

NOTE
For more information about the forms specified when defining a resource, see “Adding an RDBMS resource”.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

In the Operator column for the Fast Search Attributes and Advanced Search Attributes boxes, the type of logical operation is selected from the cell list.

Table: Operators

Operator	Meaning
begins with	The search string must be at the beginning of the result string, for example begins with Jo matches John Robertson.
ends with	The search string must end the result string, for example ends with son matches John Robertson.
contains	The search string must be a subset of the result string, for example John Robertson contains Robert
does not contain	The search string must not be a subset of the result string.
is	The search string must exactly match the result string, for example John Robertson is John Robertson matches.
is not	The search string must not match the result string.
like	The search string must be similar to the result string.
greater than	The search string must be greater that the result string.
less than	The search string must be less that the result string.

WARNING
Hyperlinked results are subject to access rights. For more information, see “

Roles

”. |

NOTE
According to the accessed data source, the search functions may be case-sensitive.

A click on the Apply button validates the parameters entered in the Search tab.

To set the search properties on an RDBMS resource

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Search tab.
In the Fast Search Attributes area, select the attributes that the general search function will query. To do so, use the Insert and Remove buttons. For each attribute, select an operator from the column list.
In the Advanced Search Attributes area, select the attributes that appears as search boxes in the view. To do so, use the Insert and Remove buttons. Classify the attributes in order with the arrow buttons. For each attribute, select an operator from the column list.
In List of Results, select the attributes that query results is displayed. To do so, use the Insert and Remove buttons. Classify the attributes in order with the arrow buttons. For each attribute, select a display mode from the column list.
Click Apply to save the parameters you have entered.

Sort attributes

In the search and navigation modes, query results and navigation items can be displayed in sorted lists.

When a resource is selected in the COGNITUM Console tree, the Sort Attributes tab below the Presentation tab layer makes it possible to define the type and behavior of the sort operator(s).

Figure: RDBMS resource sort attributes

Attribute: This column lists the selected sort attributes.

Type: A click in the column makes it possible to define whether the attribute results must be considered as strings or integers.

Order: A click in the column makes it possible to choose whether the returned results is classified in ascending or descending order.

Case: This column offers the case-sensitivity option.

When there are several sort attributes, the up and down arrows can help set the sort criteria hierarchy.

Insert: This button displays the Attribute Selection box to define a sort attribute.

Remove: A selected sort attribute is removed with the Remove button.

A click on the Apply button validates the definition of sort attributes for the resource.

To set the resource sort attributes

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Sort Attributes tab.
Click Insert to select a sort attribute in the Attribute Selection list box.
For a selected sort attribute, click the Type, Order and/or Case column to define its nature, behavior and sensitivity.
Organize your sort attributes with the Up and Down arrows.
Click Apply to save the parameters you have entered.

Bulk operations properties

COGNITUM makes it possible to work on a set of SQL query result items known as the Basket.

NOTE
Bulk operations in COGNITUM also include deletion and e-mailing, but those do not require specific configuration.

Figure: RDBMS resource bulk operations properties

Update Attributes: It lists the attributes that can be modified in one go. The Insert button opens the Attribute Selection box to add an attribute that can be updated; whereas the Remove button deletes the listed ones. The positioning arrow buttons shift ttributes order in the list in the COGNITUM Console, and in the update boxes in the view.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

WARNING
Attributes defined as IDs of the resource cannot be defined as update attributes.

A click on the Apply button validates the parameters selected in the Bulk Operations tab.

WARNING
Bulk operations are subject to access rights. For more information, see “

Roles

”. |

To configure the resource bulk operations properties

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Bulk Operations tab.
In the Export Attributes area, select the attributes that you want authorized sers to export in HTML, CSV or TXT files as a whole selection. To do so, use the Insert and Remove buttons. With the arrow buttons, classify the attributes as you want the columns to be displayed in the export page.
In the Update Attributes area, select the attributes that you want authorized users to modify as a whole selection. To do so, use the Insert and Remove buttons. With the arrow buttons, classify the attributes as you want the entry boxes to appear in the update page.
Click Apply to save the parameters you have selected.

Navigation properties

When a resource is selected in the COGNITUM Console tree, the DHTML and Browse tab tab below the Presentation tab layer determines how the resource is displayed to users when browsing the content of the directory.

NOTE
The DHTML tab is available for compatibility reasons with previous COGNITUM versions viz. COGNITUM 4.5, 5.0, 5.1 only.

Figure: RDBMS resource navigation properties

Separator: This list box is used when there are several attributes in the navigation list that should be separated with signs/characters to be legible.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

Extra Query: The extra query is an additional logical query filter concatenated with the resource definition filter so as to retrieve a specific selection of entries matching both filters. It is applicable when the resource is set as a root resource in a view.

Example: The resource users has an extra filter defined as (sn=B*) then, only users having a name starting by a B are retrieved.

The definition is entered manually and/or with the help of the torch button that opens up the Logical Query Builder. When the resource has already been assigned to a view, the navigation parameters can be checked in the end-users interface.

A click on the Apply button validates the parameters.

To set the navigation properties of an RDBMS resource

In the COGNITUM Console tree, select a resource.
Select the Presentation tab layer and the Browse tab.
Select attributes into the Displayed Attributes area with the Insert and Remove buttons. Arrange their order with the arrow buttons.
When you have selected several attributes, you can have them displayed with separators entered or chosen in the Separator list box.
In the Extra Query box, you can define an additional Logical Query filter to be concatenated with the resource definition filter.
Click Apply to save any parameters you have entered.

Figure: RDBMS resource DHTML Mode properties

Icons: The Icons area makes it possible to assign icons to the navigation attributes. They can be checked in the Preview panel. The torch buttons give access to icons selection boxes.

Closed node: It is the path to the icon representing the leaf as closed in the tree, that is the entries below the resource are not expanded.
Open node: It is the path to the icon representing the leaf as opened, that is the entries below the resources are expanded. This icon is only viewable in the JSP page.
Leaf: It is the path to the icon representing the leaf, that is the main object in the tree.

NOTE
To add images to the COGNITUM gallery, copy any Web-browser compatible graphic files into the COGNITUM-root/Server/webapps/application/images/icons folder.

A click on the Apply button validates the parameters.

To set the navigation properties of an RDBMS resource

In the COGNITUM Console tree, select a resource.
Select the Presentation tab layer and the DHTML tab.
Change the attributes icons in the Closed node, Open node and Leaf boxes with the torch button.
In the Display Bounds area, select the option box when you want to chunk results. Enter the chunk definitions in the DHTML Mode.
Click Apply to save any parameters you have entered.

Setting the rights on an RDBMS resource

Configuring the rights on an RDBMS resource includes all the roles authorizations on the data. For a resource, rights can be assigned or restricted on actions on the data source.

When a resource is selected in the COGNITUM Console tree, the Presenattion tab below displays the data rights assignment.

Figure: RDBMS resource rights

Roles: This tree can be expanded by double-clicking the application the resource runs on, and a role name. The facing actions boxes can be selected/unselected for each selected role.

For a given action, selecting the check box facing the application name amounts to granting rights to all the roles.

A click on Apply validates the operation(s).

To assign rights on an RDBMS resource

In the COGNITUM Console tree, select the RDBMS resource you want to assign rights on.
Choose the Rights tab layer and the Physical Rights tab.
In the Roles tree, expand the tree to a role. Click a role.
To authorize actions on the resource data, select the facing check boxes.
Click Apply to validate the rights assignment.

Configuring a computed resource

Once created, a computed resource is described in the tabs of the property view. When necessary, its parameters can be modified or updated.

A click on a computed resource in the COGNITUM Console tree or a double-click on the resource in the property view opens the Resource configuration property view and its two tabs, Logical and Presenation.

Figure: Computed resource configuration tabs

Setting the logical configuration of a computed resource

The logical configuration of a computed resource is composed of the Java class which defines the computed resource.

When the Logical tab is selected, the Definition tab of the chosen resource lists information about the resource Java class.

Figure: Computed resource logical configuration

Name: The resource can be renamed as it is displayed in the COGNITUM Console. Non-alphanumerical characters and blank spaces are prohibited.

Java Class: This box displays the Java class name. The facing torch button helps select a .javaor .class file available in COGNITUM-root/Server/dev/application/computedResources. The Java class can be modified in the text editor which is displayed with a click on the Edit button. Each time the Java class is edited, it should be compiled with a click on the Compile button. The other configuration buttons are dimmed and deactivated: access to the source code is prohibited.

TIP
COGNITUM is shipped with a set of predefined Java class files available in COGNITUM-root/doc/baggage/javadoc. When a computed resource has been created with one of the ready-to-use Java class, it should be edited and fine-tuned.

A click on the Apply button validates the parameters.

To configure the resource definition

In the COGNITUM Console tree, select the resource you want to modify under the Resources item. Click the Logical tab layer and the Definition tab.
In the Name box, you can change the label of the resource in the COGNITUM Console.
In the Java Class box, you can change the selected Java class with a click on the torch button.
Click Edit to modify the Java class file and click Compile.
Click Apply to save any changes you have made.

Setting the presentation properties of a computed resource

The presentation of a computed resource stands for the ways users access data. It includes all the operational parameters of the resources in four tabs available under the Presentation tab layer:

Business Forms
Search
Sort Attributes
Bulk Operations

Business Forms

COGNITUM provides a tab to specify search/result forms. When a resource is selected in the COGNITUM Console tree, the Busines Form tab below the Presentation tab layer determines how to define business form.

Search & result properties

Figure: Computed resource search & result properties

When there are several attributes, the AND operator is used.

The result request returns the objects meeting the criterion specified in the Advanced Search Attributes area.

Text: The result only is displayed, with no hyperlink.
E-mail: The result is displayed as a hyperlink to open an e-mail window.

NOTE
For more information about the forms specified when defining a resource, see “Adding a computed resource”.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

In the Operator column for the Fast Search Attributes and Advanced Search Attributes boxes, the type of logical operation is selected from the cell list

Table: Operators

Operator	Meaning
contains	The search string must be a subset of the result string, for example John Robertson contains Robert
does not contain	The search string must not be a subset of the result string.
is	The search string must exactly match the result string, for example John Robertson is John Robertson matches.
is not	The search string must not match the result string.
like	The search string must be similar to the result string.
greater than	The search string must be greater that the result string.
less than	The search string must be less that the result string.
begins with	The search string must be at the beginning of the result string, for example begins with Jo matches John Robertson.
ends with	The search string must end the result string, for example ends with son matches John Robertson

Table: Operators

WARNING
Hyperlinked results are subject to access rights. For more information, see “

Roles

”. |

NOTE
According to the accessed data model (LDAP, data source, and so on), the search functions may be case-sensitive.

A click on the Apply button validates the parameters entered in the Search tab.

To set the search properties on a resource

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Search tab.
In the Fast Search Attributes area, select the attributes that the general search function will query. To do so, use the Insert and Remove buttons. For each attribute, select an operator from the column list.
In the Advanced Search Attributes area, select the attributes that appears as search boxes in the view. To do so, use the Insert and Remove buttons. Classify the attributes in order with the arrow buttons. For each attribute, select an operator from the column list.
In List of Results, select the attributes that query results is displayed. To do so, use the Insert and Remove buttons. Classify the attributes in order with the arrow buttons. For each attribute, select a display mode from the column list.
Click Apply to save the parameters you have entered.

Sort Attributes

In the search and navigation modes, query results and navigation items can be displayed in sorted lists.

When a resource is selected in the COGNITUM Console tree, the Sort Attributes tab below the Presentation tab layer makes it possible to define the type and behavior of the sort operator(s).

NOTE
The Sort Attributes facility can be used independently from the Displayed Attributes set in the DHTML tab. For example, results can be displayed according to the cn attribute and ordered according to the sn sort attribute.

Figure: Computed resource sort attributes

Attribute: This column lists the selected sort attributes.

Type: A click in the column makes it possible to define whether the attribute results must be considered as strings or integers.

Order: A click in the column makes it possible to choose whether the returned results is classified in ascending or descending order.

Case: This column offers the case-sensitivity option.

When there are several sort attributes, the up and down arrows can help set the sort criteria hierarchy.

Insert: This button displays the Attribute Selection box to define a sort attribute.

Remove: A sort attribute selected in the Sort Attributes tab is removed with the Remove button.

A click on the Apply button validates the definition of sort attributes for the resource.

To set the resource sort attributes

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Sort Attributes tab.
Click Insert to select a sort attribute in the Attribute Selection list box.
For a selected sort attribute, click the Type, Order and/or Case column to define its nature, behavior and sensitivity.
Organize your sort attributes with the Up and Down arrows.
Click Apply to save the parameters you have entered.

Bulk operations properties

COGNITUM makes it possible to work on a set of LDAP query result items known as the Basket.

NOTE
Bulk operations in COGNITUM also include deletion and e-mailing, but those do not require specific configuration.

Figure: Computed resource bulk operations properties

Update Attributes: It lists the attributes that can be modified in one go. The Insert button opens the Attribute Selection box to add an attribute that can be updated; whereas the Remove button deletes the listed ones. The positioning arrow buttons shift attributes order in the list in the COGNITUM Console, and in the update boxes in the view.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

A click on the Apply button validates the parameters selected in the Bulk Operations tab.

WARNING
Bulk operations are subject to access rights. For more information, see “

Roles

”. |

To configure the resource bulk operations properties

In the COGNITUM Console tree, select the resource you want to modify under the Resources item.
Select the Presentation tab layer and the Bulk Operations tab.
In the Export Attributes area, select the attributes that you want authorized users to export in HTML, CSV or TXT files as a whole selection. To do so, use the Insert and Remove buttons. With the arrow buttons, classify the attributes as you want the columns to be displayed in the export page.
In the Update Attributes area, select the attributes that you want authorized users to modify as a whole selection. To do so, use the Insert and Remove buttons. With the arrow buttons, classify the attributes as you want the entry boxes to appear in the update page.
Click Apply to save the parameters you have selected.

Navigation properties

When a resource is selected in the COGNITUM Console tree, the DHTML and Browse tab below the Presentation tab layer determines how the computed resource is displayed to users when browsing the data returned by the Java class.

NOTE
The DHTML tab is available for compatibility reasons with previous COGNITUM versions viz. COGNITUM 4.5, 5.0, 5.1 only.

Figure: Computed resource navigation properties

Displayed Attributes: This area lists the attributes used for browsing the computed resource data. The Insert button opens the Attribute Selection box to add an attribute whereas the Remove button deletes the listed ones. The positioning arrow buttons shift the attributes order in the list.

Separator: This list box is used when there are several attributes in the navigation list that should be separated with signs/characters to be legible.

TIP
To get a range of attributes from the Attribute Selection box, press the shift key when selecting them. To get multiple attributes, press the ctrl key when selecting them.

A click on the Apply button validates the parameters.

To set the navigation properties of a resource

In the COGNITUM Console tree, select a resource.
Select the Presentation tab layer and the Browse tab.
Select attributes into the Displayed Attributes area with the Insert and Remove buttons. Arrange their order with the arrow buttons.
When you have selected several attributes, you can have them displayed with separators entered or chosen in the Separator list box.
Click Apply to save any parameters you have entered.

Figure: Computed resource DHTML Mode Properties

Icons: The Icons area makes it possible to assign icons to the navigation attributes. They can be checked in the Preview panel. The torch buttons give access to icons selection boxes.

Closed node: It is the path to the icon representing the leaf as closed in the tree, that is the entries below the resource are not expanded.
Open node: It is the path to the icon representing the leaf as opened, that is the entries below the resources are expanded. This icon is only viewable in the JSP page.
Leaf: It is the path to the icon representing the leaf, that is the main object in the tree.

NOTE
To add images to the COGNITUM gallery, copy any Web-browser compatible graphic files into the COGNITUM-root/Server/webapps/application/images/icons folder.

When the resource has already been assigned to a view, the navigation parameters can be checked in the end-users interface.

A click on the Apply button validates the parameters.

To set the navigation properties of a resource

In the COGNITUM Console tree, select a resource.
Select the Presentation tab layer and the DHTML tab.
Change the attributes icons in the Closed node, Open node and Leaf boxes with the torch button.
In the Display Bounds area, select the option check box when you want to chunk results. Enter the chunk definitions in the DHTML Mode.
Click Apply to save any parameters you have entered.

Setting the rights on a computed resource

Configuring the rights on a computed resource includes all the roles authorizations on the data. For a resource, rights can be assigned or restricted on actions on the resource data source(s).

When a resource is selected in the COGNITUM Console tree, the Physical Rights tab below the Rights tab layer displays the data rights assignment table.

Figure: Computed resource rights

Roles: This tree can be expanded by double-clicking the application the resource runs on, and a role name. The facing actions boxes can be selected/unselected for each selected role.

Vertically are listed all the types of actions to be performed on a resource data. They are the READ, CREATE, UPDATE, and DELETE columns. Rights can be assigned for a given role by selecting the facing action check box(es).

Physical rights are checked by the COGNITUM Engine when accessing the data model. This facility reinforces the security already set on forms. For instance, when reading an entry of a resource, the engine checks that the connected user is allowed to read the entries of the resource.

For a given action, selecting the check box facing the application name amounts to granting rights to all the roles.

A click on Apply validates the operation(s).

To assign rights on a resource

In the COGNITUM Console tree, select the resource you want to assign rights on.
Select the Rights tab layer and the Physical Rights tab.
In the Roles tree, expand the tree to a role. Click a role.
To authorize actions on the resource data, select the facing check boxes.
Click Apply to validate the rights assignment.

Deleting a Resource

COGNITUM makes it possible to delete a resource easily and safely.

Once a resource is selected in the COGNITUM Console tree — or in the property view — the Delete command can be chosen from the context menu.

The Delete Resource message box pops up to warn the COGNITUM Console user about the consequences on view(s) which may include the resource.

COGNITUM automatically updates the resources list when the resource is deleted.

WARNING
When a resource is deleted, all the links and views containing the resource are also deleted.

To delete a resource

In the COGNITUM Console tree or property view, select the resource you want to delete.
Choose Delete:
from the Edit menu,
from the context menu, or
with the del key.
Validate the deletion in the warning box.

Resources

Resources

results matching ""

No results matching ""