Attributes

Adding an Attribute

Predefined Computed Attributes and Templates

Copying an Attribute

Configuring and modifying an attribute

Deleting an attribute

Date Format Selection Panel

Attributes describe particular features of a resource entry. An attribute is always associated with a resource. Three types of attributes are managed in COGNITUM:

• Standard attributes that exactly map the physical attributes of the data source.
• Computed attributes, the read and write rules of which are defined by a Java class.
• Attributes of a computed resource, the physical definition of which consists in a Java class.

Adding an Attribute

A wizard is launched to add an attribute for a resource. The wizard sequence is updated automatically according to the attribute type.

• Create Standard Attribute from Schema
• Create Standard Custom Attribute
• Create a Computed Attribute

Create Standard Attribute from Schema

A standard attribute matches exactly a physical attribute from the data source schema (or catalogue).

Adding a standard attribute consists in selecting the physical attribute to map with the logical name to give to the attribute. COGNITUM lists some of the physical attributes of the most commonly used data sources in order to pre-configure them. The format of the logical attributes is pre-configured according to the format of the physical ones. COGNITUM uses the attribute name to identify known attributes and associate specific features. COGNITUM also translates automatically some physical attributes terms.

For example, the jpegPhoto physical attribute is identified in the data source as a binary type attribute and COGNITUM automatically assigns the image format for the corresponding logical attribute.

When COGNITUM retrieves an attribute from the data source schema, it checks whether the format is known or not. If not, the attribute is retrieved with only the data source information and then, a primitive correlation is performed only (for example, when the attribute is mandatory, information is provided by the data source). The correspondence catalogue is stored in the COGNITUM-root/Server/Conf/Attributes.xml file.

All resources—except computed resources—in the COGNITUM Console tree can be assigned standard attributes:

• when created through the New Resource wizard, or
• subsequently from the COGNITUM Console tree through the New Attribute wizard.

After selecting a resource in the tree, a click on the New Attribute toolbar button displays the New Attribute wizard.

In the first wizard screen, the context and type of the new attribute must be specified.

Figure: New attribute type

Application: It is the application including the resource which the new attribute is assigned to. Another application can be selected in the list box, when available.

Resource: It is the resource which the new attribute is assigned to. When available, a click on the list box displays all the resources available in the selected application.

Attribute Type: In this area, the type of attribute must be chosen. The wizard displays the necessary steps to complete the attribute configuration accordingly:

• Create Standard Attributes from Schema: With this option, the logical attribute is mapped over an attribute in the data source.
• Create a Standard Custom Attribute: The attribute type is documented in “From offline schema”.
• Create a Computed Attribute: The attribute type is documented in “Computed attribute”. The wizard sequence for a standard attribute is updated automatically according to the selected option:
• Attributes from online schema
• Attribute from offline schema
• Computed attribute documented in “Computed attributes”

From online schema

In the New Attribute wizard, the Create Standard Attributes from Schema option must be selected. A click on the Next button displays the Select the Attributes to Add screen.

Figure: New attribute from online schema

List of Available Attributes: The area lists all the physical attributes in the accessed data source. Some can be selected and mapped as business attributes for the COGNITUM application.

Show All: Selecting this check box displays list of all the attributes of the data source schema. When the check box is not selected, only the attributes corresponding to the resource objectclasses are displayed.

A click on the Finish button creates the standard attribute(s). The attribute(s) can be further configured from the tree.

Further descriptive information can be entered with the Edit Description command accessible with a right-click on the attribute in the tree.

To add standard attribute(s) from schema

1. In the COGNITUM Console, select a resource and click the New Attribute toolbar button.

2. In the Context area of the first screen of the wizard, potentially select:

3. The application including the resource which the new attribute must be assigned to.

4. The resource for which the attribute must be created.

5. In the Attribute Type area, select the Create Standard Attributes from Schema option.

6. Click Next.
7. In the List of Available Attributes area, select the physical attribute(s) to be defined as the logical attribute(s). Select the Show all check box to display all the physical attributes.
8. Click the Finish button to add the attribute(s) in the tree.

Create a Standard Custom Attribute From offline schema

In the New Attribute wizard, the Create a Standard Custom Attribute option must be selected.

Figure: New attribute from offline schema

Application: It is the application including the resource which the new attribute is assigned to. Another application can be selected in the list box, when available.

Resource: It is the resource which the new attribute is assigned to. When available, a click on the list box displays all the resources available in the selected application.

Attribute Type: In this area, the type of attribute must be chosen. The wizard displays the necessary steps to complete the attribute configuration accordingly:

• Create Standard Attributes from Schema: This option is documented in “From online schema”.
• Create a Standard Custom Attribute: When the data source schema cannot be accessed, the mapped physical attribute can be specified offline. The name of the physical attribute in the data source must be entered in the next screen of the wizard.
• Create a Computed Attribute: This option is documented in “Computed attribute” .

A click on the Next button displays the Define the Attribute to Add screen.

Figure: New attribute definition

Name: This entry is the name of the logical attribute. Blank spaces, accented and non-alphanumerical characters are prohibited.

Attribute: This box must be populated with the exact name of the physical attribute to map with the logical name entered in the box above.

A click on Finish creates the standard custom attribute. The attribute can be further configured from the tree.

Further descriptive information can be entered with the Edit Description command accessible with a right-click on the attribute in the tree.

To add a standard custom attribute

1. In the COGNITUM Console, select a resource and click the New Attribute toolbar button.

2. In the Context area of the first screen of the wizard, potentially select:

3. The application including the resource which the new attribute must be assigned to.

4. The resource for which the attribute must be created.

5. In the Attribute Type area, select the Create a Standard Custom Attribute option.

6. Click Next.

7. In the Attribute Definition area fill in:

8. the Name box with the name you want to give to the attribute,

9. the Attribute box with the name of the physical attribute mapped by the logical one.

10. Click Finish.

Create a Computed Attribute

All COGNITUM resources—but computed resources—can include logical attributes that do not map physical ones. They are computed attributes.

A computed attribute does not exist as a physical entity. It is composed of a computing process that defines its behavior:

• Conceptually, a computed attribute is defined by a Java class. The Java class determines the behavior of the computed attribute in read and write modes. As the Java class code is available to the application designer, a computed attribute can be customized as much as required.
• Practically, whenever the information the attribute must retrieve is not available on the data source, a computed attribute can be defined. Computed attributes widen the range of data available.

Adding a computed attribute consists in labeling the new attribute and associate it with a Java class. COGNITUM provides several types of predefined attributes. Also, Java class templates are available to designers for semi-assisted computed attribute creation and customization.

After selected a resource in the tree, a click on the New Attribute toolbar button displays the New Attribute wizard.

In the first wizard screen, the context and type of the new attribute must be specified.

Figure: New computed attribute creation

Application: It is the application including the resource which the new attribute is assigned to. Another application can be selected in the list box, when available.

Resource: It is the resource which the new attribute is assigned to. When available, a click on the list box displays all the resources available in the selected application.

Attribute Type: In this area, the type of attribute must be chosen. The wizard displays the necessary steps to complete the attribute configuration accordingly:

• Create Standard Attributes from Schema: This option is documented in “From online schema”.
• Create a Standard Custom Attribute: This option is documented in “From offline schema”.
• Create a Computed Attribute: The attribute is defined by a Java class. There is no direct match from the logical attribute to a physical one. The Java class determines the computed attribute behavior.

The wizard sequence for a standard attribute is updated automatically according to the selected Create a Computed Attribute option. A click on the Next button displays the second screen of the wizard.

Figure: New computed attribute type definition

Name: This is the name of the computed attribute. Non-alphanumerical characters and blank spaces are prohibited.

Create the predefined Attribute: When this option is selected, the facing box lists ready to use computed attributes. They are Java class items provided by COGNITUM. As their source code cannot be edited, they must be used as is. They are described in “Predefined computed attributes and templates”.

Create an Attribute from the template: When this option is selected, the facing box lists Java class templates. They can be coded according to the expected attribute behavior. They contain Java code basic frames—that is, a Java class producing, by default, a basic process. They help create computed attribute Java classes. They can be customized as required. They are described in “Predefined computed attributes and templates”.

When the Java class template is selected, a name for the Java class to be created must be entered in this box. A click on the Default Class Name automatically generates a valid class name in the Java Class to Create box.

Create an Attribute from an existing Java class: The computed attribute can be created from an external Java class. Selecting this option enables the Java Class to Use box. This box must be populated with the name of the Java class. The name must comply with the Java class naming convention. A click on the torch button makes it possible to select a Java class. A Java class is a .class in the classpath or a .java in the COGNITUM-root/Server/dev/application/computedAttributes/src folder. For example, if the computed attribute Java class name is MyCompAtt and if it is located in the com.itc Java package, then the Java file must be located in the com/itc folder.

A click on the Next button displays the third screen of the wizard. This step makes it possible to set the computed attribute configuration properties.

Figure: New computed attribute parameters definition

Parameters List: For each type of computed attribute, the table identifies the associated parameters. The Parameters Values column must be populated with the values applicable to the facing parameters. For some specific parameters, predefined values can be selected from a list. Similarly, additional parameters can be entered by the designer for a more accurate configuration by populating an empty Parameters Names cell. For more information, see “Predefined computed attributes and templates”.

A click on Finish creates the attribute. It is listed in the COGNITUM Console tree below the resource it has been created for. The attribute can be configured and modified subsequently through its Definition tab.

Further descriptive information can be entered with the Edit Description command accessible with a right-click on the attribute in the tree.

To add a computed attribute

1. In the COGNITUM Console, select a resource and click the New Attribute toolbar button.

2. In the Context area of the first screen of the wizard, potentially select:

3. The application including the resource which the new attribute must be assigned to.

4. The resource for which the attribute must be created.

5. In the Attribute Type area, select the Create a Computed Attribute option. Click Next.

6. Populate the Name box with the label of the new computed attribute.

7. In the Computed Attribute Type area, select the type of computed attribute to create and fill in their related boxes accordingly:

8. Predefined computed attribute

9. From a template

10. From an existing Java class

11. Click Next.

12. Complete the table of parameters associated with the computed attribute.
13. Click Finish to add the computed attribute under the resource in the tree.

Predefined Computed Attributes and Templates

COGNITUM is shipped with a set of predefined computed attributes. They are ready-to-use computed attributes. These computed attributes are predefined and can be fine-tuned to specify the attribute behavior.

Predefined computed attributes are available in the second screen of the computed attribute creation wizard, as described in “Computed attribute”. They are available for all resources, but computed resources.

Formatted String

This computed attribute is designed for building up a character string containing standard attributes of the resource. Through the computed attribute process, the associated standard attributes are concatenated and formatted for a specific display in the application. The display format of the attributes defined is ruled by a specific format parameters syntax (see table below).

At the end of the computed attribute creation sequence, the format parameters must be entered for each of the standard attributes associated with the computed attribute. For the computed attribute to behave smoothly, two parameters are compulsory:

• StringFormat defines the display structure of the computed attribute. The box can be populated with text followed by the format syntax.
• StandardAttributes identifies the attribute(s) of the resource to be formatted. When several attributes are formatted, they must be separated by commas.

The table below lists the syntax rules for the attribute display format.

Table: Syntax rules

In the parameters table of the last attribute creation wizard screen, the format parameters and the attributes to be formatted are associated as follows. The first syntax operator (%U for example) in the string is applied to the first attribute declared in the Attribute box and so on.

Example

You want to create an attribute the value of which is the concatenation of the following attributes in the specified format:

• title with the first letter of each word in capital
• cn with the first letter of each word in capital
• telephoneNumber without format

Therefore, you have to create a Formatted String type computed attribute with the attribute creation wizard. For more information, see “Computed attributes”. In the third screen of the wizard, the parameters defining the display format of the required attributes must be entered with the following syntax.

Figure: Example of a new computed attribute parameters definition

You click on Finish to create the computed attribute. You must then set it as a displayed attribute for the resource.

Attribute from a linked resource (1-1 link)

This computed attribute makes it possible to select an attribute from a linked resource and use it as an attribute of the current resource. This computed attribute is available in read and write modes.

Figure: Attribute from a linked resource (1-1 link)

As a prerequisite, a link must be created between the current resource and the resource the attribute must be retrieved from. In addition, the process can only succeed when the link only returns one entry.

The process consists in selecting the link between the resources to use and identifying the attribute to retrieve. Subsequently, in the third screen of the attribute creation wizard, the following parameters must be configured:

• LinkName is the name of the link between the current and the target resources.
• TargetAttribute is the name of the attribute to retrieve in the target resource.

Example

You want to create an attribute from a linked resource, Where

• UsersToUsersRBDMS is the name of the link between the current and the target resource.
• BirthDate is the name of the attribute to retrieve in the target resource.

Therefore, you have to create an Attribute from a linked resource (1-1 link) type computed attribute with the attribute creation wizard. For more information, see “Computed attributes”. In the third screen of the wizard, choose the Link Name UsersToUsersRDBMS and the Target Attribute BirthDate from the respective drop down list box.

Figure: Example of a new computed Attribute from a linked resource (1-1 link).

You click on Finish to create the computed attribute.

Attribute from a multiple linked resource (1-1 link)

This computed attribute makes it possible to select an attribute from a list of linked resources and use it as an attribute of the current resource. When the attribute of the current resource is modified, the change is updated on each resource linked. This computed attribute is available in read and write modes.

Figure: Attribute from a multiple linked resource (1-1 link)

As a prerequisite, the links used between the current and the target resources must be defined as a prior operation. Moreover, the computed attribute can only run when each link returns one and only one result.

The computed attribute parameters are the following:

• LinkNumber: This identifies the number of linked resources.
• LinkName<N>: This is the name of the link to use to join the current resource with the destination one; “N” stands for the link number. For example, when LinkNumber equals 2, two LinkName parameters are to be configured that are LinkName1 and LinkName2.
• TargetAttribute<N>: This is the attribute to retrieve on the resource associated with the link LinkName<N>.

Example

You want to create an attribute which changed value will update the cn value in resources UsersLDAP and UsersRDBMS. Where

• UsersToUsersLDAP is the name of the link between the current and the target resource (UsersLDAP).
• UsersToUsersRDBMS is the name of the link between the current and the target resource (UsersRDBMS).
• cn is the name of the attribute from target resources (UsersLDAP & UsersRDBMS).

Therefore, you have to create an Attribute from a multiple linked resource (1-1 link) type computed attribute with the attribute creation wizard. For more information, see “Computed attributes”. In the third screen of the wizard, enter the LinkNumber 2 (as there are 2 linked resources). Choose the value for LinkName1 as UsersToUsersLDAP and for TargetAttribute1 as cn from the respective drop down list box. Then add Parameters with name as LinkName2 and TargetAttribute2. Choose the value for LinkName2 as UsersToUsersRDBMS and for TargetAttribute2 as cn from the respective drop down list box.

Figure: Example of a new computed Attribute from a multiple linked resource (1-1 link).

You click on Finish to create the computed attribute.

Attribute from a linked resource (1-N link)

This computed attribute makes it possible to select an attribute from a list of linked resources and use it as an attribute of the current resource. The values of the attribute of the target resource entries become the values of the computed attribute. This computed attribute is only accessible in read mode. As a prerequisite, a link must be created between the current resource and the resource the attributes must be retrieved from (target resource).

Configuring this computed attribute consists in identifying the link between the current and the target resources, and the attributes to retrieve. Subsequently, in the third screen of the attribute creation wizard, the following parameters must be configured:

• LinkName is the name of the link between the current and the target resources.
• TargetAttribute can be assigned three value types:
• The name of the attribute to retrieve in the target resource.
• The box can also be entered with DN so as to retrieve the DN of each entry returned by the link.
• Entering the Count value computes the number of entries returned by the link.
• AllowDoubleValues makes it possible to skip duplicates.

Example

You want to create an attribute where which gives list of users living in the location, where

• LocationToUsers is the name of link between the current and the target resource (Users).
• cn (Full name) is the name of the attribute from target resource.

Therefore, you have to create an Attribute from a linked resource (1-N link) type computed attribute with the attribute creation wizard. For more information, see “Computed attributes”. In the third screen of the wizard, choose the Link Name LocationToUsers and the Target Attribute cn from the respective drop down list box. Choose the value of parameter AllowDoubleValues as false to skip duplicates.

Figure: Example of a new computed Attribute from a linked resource (1-N link).

You click on Finish to create the computed attribute.

Parent Entry

When the data source is of LDAP or DSML type, the parentEntry attribute can be used. It is a pre-configured computed attribute that defines the resource location in the data source. For a given resource instance, the parentEntry value is the DN (that is the entry unique identifier) of its parent entry in the data source.

There is no mandatory attribute for a parentEntry attribute. However the third screen of the attribute creation wizard may be populated on the fly with optional attributes.

For more information, see “ParentEntry attribute”.

Computed Attribute Skeleton

This is a blank template designed for creating a computed attribute from scratch. This template encompasses the code basement for the creation of the computed attribute. It is up to the designer to enter the code according to the behavior he/she expects from the computed attribute. The template can be modified as required.

Computed Resource Attribute

A computed resource can connect any type of data—other than LDAP- or SQL-compliant ones—through a custom Java class that performs all the data access operations.

A computed resource is composed of virtual attributes. A computed resource attribute is mapped to its physical definition through the computed resource Java class. It carries a logical name that matches the physical name, conversely to other attribute types.

After selecting a computed resource in the tree, a click on the New Attribute toolbar button displays the New Attribute wizard.

Figure: Computed resource attribute definition

Application: It it the application including the computed resource which the new attribute(s) is assigned to. Another application can be selected in the list box, when available. The wizard is modified automatically when the selected application does not include a computed resource.

Resource: It is the computed resource which the new attribute is assigned to. When available, a click on the list box displays all the resources available in the selected application. The wizard is modified automatically when the selected resource is not a computed one.

Attributes list: A click in the Attribute Name table displays an empty cell where the name of an attribute can be entered. The attribute must be available in the underlying data system. Its name entered in the table must be its physical name in the data system. Another attribute can be specified in another cell of the Attribute Name table.

A click on Finish creates the computed resource attribute. The attribute should be further configured from the tree.

Further descriptive information can be entered with the Edit Description command accessible with a right-click on the attribute in the tree.

To add a computed resource attribute

1. In the COGNITUM Console, select a computed resource and click the New Attribute toolbar button.

2. In the Context area of the wizard, potentially select:

3. The application including the computed resource which the new attribute must be assigned to.

4. The computed resource for which the attribute must be created.

5. In the Attributes List, click in the Attribute Name to add a cell. Enter the physical name of the attribute.

6. Click Finish.

Copying an Attribute

An attribute created and configured for a resource can be duplicated into the same resource, or into another resource as long as they are of the same type. This feature allows to bypass the complete attribute creation process.

The Copy command is accessible from a selected attribute from its context menu or from the Edit menu.

The target resource must be selected before choosing the Paste command from the context menu or from the Edit menu. When the attribute is duplicated within the same resource, a message box pops up to give another name for the duplicate.

Parameter changes may prove necessary. See “Configuring and modifying an attribute”.

To copy an attribute

1. In the COGNITUM Console tree, select the attribute to copy.
2. Choose the Copy command from the context menu.
3. Select the target resource of the same type.
4. Choose the Paste command from the context menu.
5. Update the parameters of the attribute duplicate as required.

Configuring and modifying an attribute

Configuring an attribute is necessary:

• Once an attribute is added to the tree. Its parameters can still be modified or reset. The attribute parameters can be adjusted to match the application needs.
• To update an existing attribute.

A click on an attribute in the tree opens the Attribute configuration property view. The property view matches the requirements of the selected attribute type:

• Objectclass attribute
• ParentEntry attribute
• Standard attribute
• Computed attribute
• Computed resource attribute

Objectclass attribute

Adding a resource automatically creates the Objectclass and ParentEntry attributes. ObjectClass and ParentEntry are both mandatory attributes necessary for the application to run properly. They cannot be removed.

The objectclass attribute resembles a standard attribute. It is configured from the objectclasses selected in the resource creation wizard. To modify it, it must be selected in the tree under a resource. The Attributes Management tab is displayed.

Figure: Objectclass attribute properties

Context: This area displays the application and resource of the attribute.

Object Classes: This area identifies all the object classes for the resource. A click on an object class updates the facing Attributes of the Resource area with the attributes in relation to it. Some attributes may be emphasized in orange or yellow.

A new object class can be added to the list with the Object Class Selection dialog box available with the Insert button. Conversely, the Remove button must be used to remove a selected attribute from the list.

Missing Attributes: The area identifies the attributes required for the resource definition. The missing attribute(s) can be selected and copied into the Attributes of the Resource area with the arrow button.

Attributes of the Resource: The area lists the attributes for the resource. Some attributes may be emphasized:

• Orange-highlighted attributes are mandatory. They are essential to the resource and cannot be removed.
• Yellow-highlighted attributes are optional. They can be removed without affecting the resource consistency.

When a Mandatory cell is checked, the attribute is compulsory for at least one of the object classes in the Object Classes area. When a Used cell is checked, the attribute is used in one of the resource configuration tab in the COGNITUM Console.

A click on the Select All button allows to select all the attributes of the list. Clicking the Keep Selected/Remove Unselected button preserves the selected attributes for the resource definition, and it removes all the other attributes.

A click on the Apply button validates the parameters.

To configure the objectclass definition

1. In the COGNITUM Console tree, select the objectclass you want to modify. The Attributes Management tab is displayed.
2. In the Object Classes area, add an objectclass with a click on the Insert button. Remove one with a click on the Remove button after selecting it.
3. In the Missing Attributes area, click the arrow button to move a mandatory attribute into the Attributes of the Resource area.
4. In the Attributes of the Resource area, select the attributes you want to keep for the resource and click the Keep Selected/Remove Unselected button to keep/clear them.
5. Click Apply to validate the changes.

ParentEntry attribute

The parentEntry attribute is a pre-configured computed attribute that defines the resource location in the data source. For a given resource instance, the parentEntry value is the DN (that is the entry unique identifier) of its parent entry in the data source.

A click on a parentEntry item under a resource displays the Definition tab of the objectclass in the property view.

Figure: ParentEntry attribute properties

Name: The name of the parentEntry attribute is displayed. It is retrieved right from the data source schema and cannot be modified.

Possible Values: The option selected determines the resource location in the data source. Three locations can be selected:

• The base DN of the Resource: All instances of the resource have the same parent in the data source.
• The DN of a Resource of type: Each instance of the resource is located under an instance of a specific resource. Example: Users are always located under Departments.
• Any DN of the directory.

Java Class: This is the Java class defining the parentEntry attribute behavior. The configuration buttons are dimmed and deactivated: access to the source code is prohibited.

A click on the Apply button in the Definition tab validates the parameters.

To configure the parentEntry attribute type definition

1. In the COGNITUM Console tree, select the parentEntry type attribute under the related resource. The Definition tab is displayed.
2. In the Possible Values area, select the attribute value determining the resource location in the directory.
3. Click Apply to save your changes.

Standard Attributes

Standard attributes are logical attributes which map physical attributes in the data source. Configuring them consists in setting:

• the definition,
• the value rules.

Definition

A click on an attribute under a resource opens the Definition tab in the Attribute property view.

Figure: Standard attribute definition properties

Name: It is the name of the logical attribute. By default, the name of the logical attribute is the physical attribute one. The box can be filled in with a different name for the attribute. Non-alphanumerical characters and blank spaces are prohibited.

Physical Attribute: It is the name of the physical attribute. A click on the torch- like button displays the Attribute Selection dialog box. Another physical attribute can be selected.

Physical Attribute Type: This informative line tells the format of the physical attribute.

When the accessed data source is of RDBMS type, the Definition tab is updated with specific elements.

Figure: Physical attribute type

The following options are RDBMS-specific:

• Physical Attribute Size: This informative line may give the size of the physical attribute.
• Primary Key Part: This option means that the attribute is used as the master attribute in the accessed table.
• Foreign Key Part: This option indicates that the attribute belongs to another table linked to the current one.
• Unique Key Part: This option means that the attribute belongs to a unique key.

Mandatory: This option can be used to make value assignment compulsory. Some attributes require a value: the option is selected and dimmed by default.

Monovalued: When an attribute is monovalued it means it can only have one value. For instance, the Title attribute can only have one value since one person can only declare one title in a company. This option is available when the accessed data source is LDAP-compliant.

Read-only: This option must be checked when the attribute cannot be modified in the portal or through the API. The attribute is displayed but it is frozen. This option secures the data in a resource dedicated to a specific profile whose users should be able to view it only.

The Attribute value must be unique: When the check box is selected the value of the attribute cannot be the same for another entry of the data source. For example the mail attribute has a unique value as it matches only one entry of the data source.

Format: In the Format list box, the display format for the attribute can be selected.

Table: Display formats

Case: The Case list box makes it possible to choose the display preferences on the text attributes.

Table: Display preferences

A click on the Apply button validates the parameters.

To configure the standard attribute definition

1. In the COGNITUM Console tree, select the standard attribute you want to modify. The Definition tab is displayed.
2. In the Name box, change the name of the attribute as you want it to be displayed in the tree.
3. In Physical Attribute, you can select another physical attribute through the Attribute Selection dialog box that opens up with a click on the torch button.

4. When necessary, choose the attribute options:

5. Mandatory when you want the attribute to be strictly valued by end-users.

6. Monovalued when the attribute must get one value only (LDAP-specific).
7. Read-only when the attribute must not be modified in the portal.
8. The Attribute value must be unique

9. Format to set the way the attribute can be read.

10. Click Apply to save your changes.

Default values

A standard attribute can be assigned default values. The values are used by the COGNITUM application server, provided no value has been previously defined for the attribute. When the attribute is called, the values are associated by default.

The default values options are selected in the Default Values tab of the attribute.

Figure: Standard attribute default values

None: No default values are set.

Custom Values: A click in the free box makes it possible to enter a default value. The ENTER key must then be pressed down or another table box must be selected. There can be as many custom values as necessary.

Attributes of resources based on relational databases can be assigned other specific default values.

Figure: Attribute default values at creation time

Automatic Number/Counter: The accessed relational database may number attributes automatically. COGNITUM relies on the database to retrieve the value managed by the database.

Database Sequence Value: This RDBMS-specific option makes it possible to retrieve the sequence number to identify a primary key. Some databases may not support this feature.

Custom Value: This option makes it possible to enter a static default value.

A click on the Apply button validates the parameters.

To configure the default values of a standard attribute

1. In the COGNITUM Console tree, select the attribute you want to modify under the resource to which it belongs.
2. Select the Default Values tab.

3. In Default Values at Creation Time, you can leave the None option box checked or choose to specify values to be used by default for the attribute when an entry of the resource is created:

4. Custom Value

5. Database Sequence Value (RDBMS-specific)

6. Automatic Number/Counter (RDBMS-specific)

7. Click Apply to save your changes. Possible values

A standard attribute can be assigned possible values. The values are used as a rough guide used by the COGNITUM application server to generate the appropriate user interface.

The possible values options are selected in the Possible Values tab of the attribute.

Figure: Standard attribute possible values

No Rule: With this option, the attribute can take any value fitting its type.

The value(s) must belong to a static list: When this option is selected, the facing table can list the values which the attribute must match. The values can be associated with a specific syntax. The attribute value displayed in the application and the value stored in the data source may follow distinct formatting rules. Accordingly, COGNITUM deduces the value to display and the value to store in the data source.

A click on a Possible Values line allows to enter a value expression manually. The cell button can be also selected to display the Choose an Attribute Value dialog box. This dialog box helps specify the possible values of an attribute very quickly, especially with references to variables and dictionary keys. For more information, see “Choosing an attribute value”.

The table below identifies the syntax operators for the value expression and their description. When several values are entered, in the application, the attribute box proposes the possible values in a list box.

Table: Syntax operators for value expressions

For example, when creating a user in the Users resource through the People application, the designer wishes to be proposed the available languages for the user to be created. The proposed languages must be French, English and German. As a prior operation, the dictionary keys corresponding to the different languages must be set in the dictionary. For more information, see “Centralized dictionary”.

Then, the preferredlanguage attribute must be added to the Users resource and configured in the Possible Values tab. When the preferredlanguage attribute is configured properly, in the application, the designer is proposed in a list box, the French, German or English language for the user to be created. The language options are displayed in the language of the logged in user.

The Attribute is a foreign key with one or several resources: With this option, the value of the attribute corresponds to the value of an attribute of one or several resources or to its DN. A filter can be used for each linked resource too. A click in the facing list box displays all the resources available. Once the resource to be linked to the attribute is selected, one of the two following options can be selected, and the attribute possible values must be specified in the table beneath:

• It matches a DN is an LDAP-specific option which must be chosen when attribute value is the DN of the selected resource.
• It matches an Attribute allows that the value of the attribute is one of the attributes of the selected resource.

In the List size of the possible Attribute values list box, the size of the list displaying the possible values for the attribute must be assessed. This figure makes the most of the COGNITUM Development Studio which can generate a form suited to the list size. For the Small or Normal sizes, the form displays the results in a list box. For the Large size, the form displays a picker. A click on the picker allows to view the results and select one.

In the table of the attribute possible values, a click on the Add button makes it possible to add an attribute of one or more resources which will serve as a possible value. The Resource cells list the resources available, and the Attribute cells help select the one of the related attributes. An attribute can be linked to a number of resources. The picker button in the Filter cells displays the Logical Query Builder dialog box described in “Data sources”—where a filter can be added on the returned entries.

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

To configure the possible values of a standard attribute

1. In the COGNITUM Console tree, select the attribute you want to modify under the resource to which it belongs.
2. Select the Possible Values tab.

3. Select the option for the type of attribute integrity check:

4. No Rule when you want COGNITUM not to provide for any format for the attribute.

5. The value(s) must belong to a static list when you want to define a list of possible values to match with the attribute. Click the Possible Values cell button to specify the attribute possible values quickly.
6. The Attribute is a foreign key with one or several resources to link the attribute with a resource. Click on the facing list box to display all available resources. Check the It matches a DN option box to link the attribute with the DN of the selected resource.

Select the It matches an Attribute option box to link the attribute with the attribute(s) of the selected resource. In the facing list box, select the attribute of the selected resource to link with the attribute.

In the List size of the possible Attribute values list box, select the size to apply to the list displaying the possible values for the attribute.

In the attribute possible values table, click Add to insert an attribute of one or more resources. Click the table cells to specify the resource, attribute and/or filter.

1. Click Apply to validate your changes.

Choosing an attribute value

The Choose an Attribute Value dialog box is used to select easily one or more values an attribute can show from a variable and/or dictionary key. For more information, see “Standard attribute” and “Computed attribute”.

The dialog box is available in the Possible Values tab is displayed for a standard or computed attribute when the option The value(s) must belong to a static list is selected. A click in the Possible Values list box shows a cell button. A click on the button displays the dialog box.

Figure: Choose an Attribute Value box

Value Displayed: This is the value which is displayed in the portal. It can be a variable or a dictionary key. The facing buttons displays the Variable Selection and Choose a Dictionary Key dialog boxes.

Value Stored: This value is stored in the directory. It is returned when the displayed value is selected in the portal. It can be a variable or a dictionary key. The facing buttons displays the Variable Selection and Choose a Dictionary Key dialog boxes as above described.

Preview: When the displayed and stored values are selected in the above box, the Preview box shows the corresponding computed expression.

A click on OK validates the value expression.

• A click on the facing Pick up a variable button helps select a variable quickly in the Variable Selection dialog box.
• A click on the facing Pick up a dictionary key button helps select a variable quickly in the Choose a Dictionary Key dialog box Dictionary: This box lists all the dictionaries available for the application. For more information, see “Centralized dictionary”.

Type in the first letter of the variable you are looking for: In this box, typing a letter automatically updates the Select a variable list with the variables whose label begins with this letter.

Select a variable: A click on a variable label selects it.

A click on OK validates the selection.

Figure: Choose a Dictionary Key box

Search Text: In this box, typing a letter or a label string automatically updates the Dictionary Keys table with the matching keys.

Dictionary Keys: The table lists all the keys of the selected dictionary. The Search Text filter can restrict the number of keys listed in the table. Clicking the language column heading displays the languages list applicable in the dictionary. Choosing a language updates the column entries to help select the dictionary key used as the attribute possible value

A click on OK validates the dictionary key selection.

Computed attributes

Computed attributes are virtual attributes with read and write rules defined by a Java class. Configuring them consists in setting:

• the definition,
• the value rules.

Definition

A click on a computed attribute under a resource opens the Definition tab in the Attribute property view.

Figure: Computed attribute definition properties

Name: It is the name of the computed attribute. The box can be filled in with a different name for the attribute. Non-alphanumerical characters and blank spaces are prohibited.

Mandatory: This option can be used to make value assignment compulsory. Some attributes require a value: the option is selected and dimmed by default.

Monovalued: When an attribute is monovalued it means it can only have one value. For instance, the Title attribute can only have one value since one person can only declare one title in a company.

Read-only: This option must be checked when the attribute cannot be modified in the portal or through the API. The attribute is displayed but it is frozen. This option secures the data in a resource dedicated to a specific profile whose users should be able to view it only.

Format: In the Format list box, you can select the display format for the attribute.

Table: Display formats for attributes

Java Class: This box is available for computed attributes created from a Java class. The Java Class box shows the Java class defining the attribute behavior. A click on the torch button makes it possible to change it in the Choose the Java Class dialog box.

Figure: Choose the Java Class box

In the dialog box, a click on the torch button allows to select another Java class. A click on the Default Name button fills in the Java Class box with its default name. When it has not been done at the attribute creation, the Generate the Source File check box is available to create a Java class template defining the name of the methods to be used, the specific location of the values to be entered and comments.

In the property view of the attribute, the Associated Java Class area shows a number of buttons to configure a custom Java class. The configuration buttons are dimmed and deactivated when the Java class is provided by COGNITUM, access to the source code is prohibited

Generate: This button refreshes the source code of the chosen Java class.

Edit: This button launches a text editor displaying the Java class code. The editor used to open the source file can be selected with the Editor command from the Tools => Preferences menu.

Compile: This button compiles the .java file to turn it into a .class file.

Delete: This button removes the Java class.

Parameters Names / Values: The parameters table recall the parameters associated to the computed attribute. The parameters defined during the attribute creation can be changed or modified at that level. For more information, see “Predefined computed attributes and templates”.

A click on the Apply button validates the parameters.

To configure the computed attribute definition

1. In the COGNITUM Console tree, select the computed attribute you want to modify. The Definition tab is displayed.
2. In the Name box, change the name of the attribute as you want it to be displayed in the tree.
3. Select the Mandatory check box when you want end-users to be requested for the selected attribute.
4. Select the Monovalued check box when you want the attribute to carry a single value.
5. Select the Read-only check box when the attribute must not be modified in the portal.
6. In the Format list box, select the attribute display format.

7. In the Java Class box, enter the name of the Java class to apply to the computed attribute or click the torch button to select another one. When necessary, you can click:

8. Generate to regenerate the Java class template code.

9. Edit to edit the Java class code and modify it.

10. Compile to compile the .java file.

11. Click Apply to save your changes.

Default values

A computed attribute can be assigned default values. The values are used by the COGNITUM application server, provided no value has been previously defined for the attribute. When the attribute is called, the values are associated by default.

The default values options are selected in the Default Values tab of the attribute.

Figure: Computed attribute default values

None: No default values are set.

Custom Values: A click in the free box makes it possible to enter a default value. The ENTER key must then be pressed down or another table box must be selected. There can be as many custom values as necessary.

A click on the Apply button validates the parameters.

To configure the default values of a computed attribute

1. In the COGNITUM Console tree, select the computed attribute you want to modify under the resource to which it belongs.
2. Select the Default Values tab.
3. In Default Values at Creation Time, you can leave the None option box checked. Otherwise choose Custom Values and enter the values to be used by default for the attribute when an entry of the resource is created.
4. Click Apply to save your changes.

Possible values

A computed attribute can be assigned possible values. The values are used as a rough guide used by the COGNITUM application server to generate the appropriate user interface.

The possible values options are selected in the Possible Values tab of the attribute.

Figure: Computed attribute possible values

No Rule: With this option, the attribute can take any value fitting its type.

The value(s) must belong to a static list: When this options is selected, the facing table can list the values which the attribute must match with. The values can be associated with a specific syntax. The attribute value displayed in the application and the value stored in the data source may follow distinct formatting rules. Accordingly, COGNITUM deduces the value to display and the value to store in the data source.

A click on a Possible Values line allows to enter a value expression manually. The cell button can be also selected to display the Choose an Attribute Value dialog box. This dialog box helps specify the possible values of an attribute very quickly, especially with references to variables and dictionary keys. For more information, see “Choosing an attribute value”.

The table below identifies the syntax operators for the value expression and their description. When several values are entered, in the application, the attribute box proposes the possible values in a list box.

Table: Syntax operators for value expressions

The Attribute is a foreign key with one or several resources: With this option, the attribute is linked to the DN of a resource or with one of the attributes of another resource. A click in the facing list box displays all available resources. Once the resource to be linked to the attribute is selected, one of the two following options can be selected, and the attribute possible values must be specified in the table beneath:

• It matches a DN: This LDAP-specific option must be chosen when attribute value is the DN of the selected resource.
• It matches an Attribute: The value of the attribute can be one of the attributes of the selected resource. When this option is chosen, the facing list box must be populated with the attribute required.

List size of the possible Attribute values: In this list box, the size of the list displaying the possible values for the attribute must be assessed. This figure makes the most of the COGNITUM Development Studio which can generate a form suited to the list size. For the Small or Normal sizes, the form displays the results in a list box. For the Large size, the form displays a picker. A click on the picker allows to view the results and select one.

In the table of the attribute possible values, a click on the Add button makes it possible to add an attribute of one or several resources which will serve as a possible value. The Resource cells list the resources available, and the Attribute cells help select the one of the related attributes. An attribute can be linked to a number of resources. The picker button in the Filter cells makes it possible to add a filter on the returned entries.

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

To configure the possible values of a computed attribute

1. In the COGNITUM Console tree, select the computed attribute you want to modify under the resource to which it belongs.
2. Select the Possible Values tab.

3. Select the option for the type of attribute integrity check:

4. No Rule when you want COGNITUM not to provide for any format for the attribute.

5. The value(s) must belong to a static list when you want to define a list of possible values to match with the attribute.
6. The Attribute is a foreign key with one or several resources to link the attribute with a resource. Click on the facing list box to display all available resources.

Check the It matches a DN option box to link the attribute with the DN of the selected resource. Check the It matches an Attribute option box to link the attribute with the attribute(s) of the selected resource. In the facing list box, select the attribute of the selected resource to link with the attribute.

In the List size of the possible Attribute values list box, select the size to apply to the list displaying the possible values for the attribute.

In the attribute possible values table, click Add to insert an attribute of one or more resources. Click the table cells to specify the resource, attribute and/or filter.

1. Click Apply to validate your changes.

Computed resource attribute

Computed resource attributes are virtual attributes mapped on the physical attributes of any data system through a Java class. Configuring them consists in setting:

• the definition,
• the value rules.

Definition

A click on an attribute under a computed resource opens the Definition tab in the Attribute property view.

Figure: Computed resource attribute definition properties

Name: It is the name of the logical attribute. The name of the logical attribute must the physical attribute one.

Mandatory: This option can be used to make value assignment compulsory

Monovalued: When an attribute is monovalued it means it can only have one value

Read-only: This option must be checked when the attribute cannot be modified in the portal or through the API. The attribute is displayed but it is frozen. This option secures the data in a resource dedicated to a specific profile whose users should be able to view it only.

Format: In the Format list box, the display format for the attribute can be selected.

Table: Display formats for attributes (part 1 of 2)

Table: Display formats for attributes (part 2 of 2)

To configure the definition of a computed resource attribute

1. In the COGNITUM Console tree, under a computed resource, select the attribute you want to modify. The Definition tab is displayed.
2. In the Name box, you can change the name of the attribute as long as it matches its physical name.

3. When necessary, choose the attribute options:

4. Mandatory when you want the attribute to be strictly valued by end-users.

5. Monovalued when the attribute must get one value only (LDAP-specific).
6. Read-only when the attribute must not be modified in the portal.
7. Format to set the way the attribute can be read. 4 Click Apply to save your changes.

Default values

A computed resource attribute can be assigned default values. The values are used by the COGNITUM application server, provided no value has been previously defined for the attribute. When the attribute is called, the values are associated by default.

The default values options are selected in the Default Values tab of the attribute.

Figure: Computed resource attribute default values

None: No default values are set.

Custom Values: A click in the free box makes it possible to enter default values. The ENTER key must then be pressed down or another table box must be selected. A click on the Apply button validates the parameters.

To configure the default values of a computed resource attribute

1. In the COGNITUM Console tree, select the attribute you want to modify under the computed resource to which it belongs.
2. Select the Default Values tab.

3. In Default Values at Creation Time, you can

4. leave the None option box checked, or

5. choose the Custom Values option to specify values to be used by default for the attribute when an entry of the resource is created.

6. Click Apply to save your changes.

Possible values

A computed resource attribute can be assigned possible values. The values are used as a rough guide used by the COGNITUM application server to generate the appropriate user interface.

The possible values options are selected in the Possible Values tab of the attribute.

Figure: Computed resource attribute possible values

No Rule: With this option, the attribute can take any value fitting its type.

The value(s) must belong to a static list: When this option is selected, the facing table can list the values which the attribute must match. The values can be associated with a specific syntax. The attribute value displayed in the application and the value stored in the data system may follow distinct formatting rules. Accordingly, COGNITUM deduces the value to display and the value to store in the data system.

A click on a Possible Values line allows to enter a value expression manually. The cell button can be also selected to display the Choose an Attribute Value dialog box. This dialog box helps specify the possible values of an attribute very quickly, especially with references to variables and dictionary keys. For more information, see “Choosing an attribute value”.

The table below identifies the syntax operators for the value expression and their description.

When several values are entered, in the application, the attribute box proposes the possible values in a list box.

Table: Syntax operators for value expressions

The Attribute is a foreign key with one or several resources: With this option, the value of the attribute corresponds to the value of an attribute of one or several resources or to its DN. A filter can be used for each linked resource too.

A click in the facing list box displays all the resources available. Once the resource to be linked to the attribute is selected, one of the two following options can be selected, and the attribute possible values must be specified in the table beneath:

• It matches a DN is an LDAP-specific option which must be chosen when attribute value is the DN of the selected resource.
• It matches an Attribute allows that the value of the attribute is one of the attributes of the selected resource.

In the List size of the possible Attribute values list box, the size of the list displaying the possible values for the attribute must be assessed. This figure makes the most of the COGNITUM Development Studio which can generate a form suited to the list size. For the Small or Normal sizes, the form displays the results in a list box. For the Large size, the form displays a picker. A click on the picker allows to view the results and select one.

In the table of the attribute possible values, a click on the Add button makes it possible to add an attribute of one or several resources which will serve as a possible value. The Resource cells list the resources available, and the Attribute cells help select the one of the related attributes. An attribute can be linked to a number of resources. The picker button in the Filter cells displays the Logical Query Builder dialog box, described in “Data sources”—where a filter can be added on the returned entries.

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

To configure the possible values of a computed resource attribute

1. In the COGNITUM Console tree, select the attribute you want to modify under the computed resource to which it belongs.
2. Select the Possible Values tab.

3. Select the option for the type of attribute integrity check:

4. No Rule when you want COGNITUM not to provide for any format for the attribute.

5. The value(s) must belong to a static list when you want to define a list of possible values to match with the attribute. Click the Possible Values cell button to specify the attribute possible values quickly.
6. The Attribute is a foreign key with one or several resources to link the attribute with a resource. Click on the facing list box to display all available resources.

Select the It matches a DN option box to link the attribute with the DN of the selected resource.

Select the It matches an Attribute option box to link the attribute with the attribute(s) of the selected resource. In the facing list box, select the attribute of the selected resource to link with the attribute.

In the List size of the possible Attribute values list box, select the size to apply to the list displaying the possible values for the attribute.

In the attribute possible values table, click Add to insert an attribute of one or more resources. Click the table cells to specify the resource, attribute and/or filter.

4 Click Apply to validate your changes.

Deleting an attribute

COGNITUM makes it possible to delete an attribute easily and safely. The Delete command is accessible from the context menu from any type of attribute — except objectclass and parentEntry.

The Delete Attribute message box pops up. Choosing Yes validates the deletion. COGNITUM automatically updates the resource(s) and the view(s) when the attribute is deleted.

To delete an attribute

1. In the COGNITUM Console tree or property view, select the attribute you want to delete.
2. Choose Delete from the context menu.
3. Validate the removal in the warning box.

Date Format Selection Panel

When configuring the definition of an attribute of Date type, it may be necessary to specify the application date format. The format is defined in the Date Format Selection Panel displayed.

Figure: Attribute date format selection

Table: Time and date patterns

• The key in the data and time patterns are the following.

Table: Time and data patterns

• Localized formats

The formats are automatically localized according to the language of the connected user. Only dates for the portal can be configured with localized formats.

Table: Localized formats