Applications

Creating an Application

Configuring and Modifying an Application

Account Library

Login properties

Managing Applications

Improvements in feature Exporting an Application in COGNITUM 7.8.00

Managing Application Packages

Deleting an Application

A COGNITUM application is the highest-level object in the product hierarchy. Within an application, objects are defined: data sources, resources, documents, services, views, roles, variables, attributes, and so on. The way they are to be viewed by end-users and the rules to access them must be determined too.

Once it is designed, an application can be packed as a Web Archive file (.war) and deployed on the production server, as documented in the “Deploying a COGNITUM Application” part in the COGNITUM Installation Guide. Application logs are described in the COGNITUM Installation Guide too.

Creating an Application

Creating an application consists in defining the conditions when the application is run, that is when concurrent views displays documents with properties and variables, for authorized roles.

New Application

Creating a new application in the COGNITUM Console is easy and secure with the New Application wizard.

Click the New Application button in the toolbar to start the New Application wizard.

Figure: New application wizard (application definition)

Name This box in the Application Definition area must be completed with the application name. The name shall be intuitive enough for the COGNITUM Console user to cope with several applications. Non-alphanumerical characters and blank spaces are prohibited.

Type: A new application can be started from scratch or from a predefined application:

• Default: This option must be selected to create an empty application.
• White Pages: Selecting this option makes it possible to load a predefined set of documents, services, and forms for a standard white pages application. The logical layer is prepared in the White Pages package. The physical layer — that is the application data source and resources — must be defined subsequently.

Authentication Data Source: An authentication data source must be defined for the new COGNITUM application. The authentication data source is meant to identify the users and determine their access rights. The Authentication Data Source area enables to select the origin of the data source to be linked to the application:

• Create a new Data Source: When this option is selected, a click on the Next button displays another wizard screen corresponding to the New Data Source dialog box documented in “Adding a data source”.
• Use a copy of an existing Data Source: When this option is selected, it is necessary to choose an application in the Application list box. When available, a data source must be chosen in the Data Source list box for the selected application beforehand. The Properties box displays the parameters of the selected data source.

A click on the Next button validates the identification parameters set for the new application. The creation process of the J2EE application is launched as shown in the displayed progress box.

Figure: New application progress box

The sequence is represented with flashing blue bullets and green selects.

Unpacking as J2EE Application: The new application is created from a blank .zip file containing the Web and the development content. This default application (for example COGNITUM-root/Server/archives/defaults/web-default-jsp.zip) is unpacked on the disk.

Starting J2EE Application: The application server starts the application.

Checking Integrity: The consistency of the COGNITUM components is checked.

Importing Logical Configuration: The COGNITUM objects for the new application are imported into the COGNITUM Console.

Waiting for Application Binding: The application is being loaded into the COGNITUM Console.

When the sequence is finished, an information message box is displayed to tell that the J2EE conversion is successful.

A click on OK in the information box displays the second wizard screen to specify the data source for the new application.

Figure: New application wizard (Data Source Definition)

Adding a data source consists in identifying the LDAP server, the DSML file, or the RDBMS database used by the application.

A click on Next displays the next wizard screen for further configuration to access the data source. The wizard to add a data source is fully documented in Chapter 3, “Data sources”.

A click on Finish validates the parameters set for the new application and terminates the process. The application icon appears in the COGNITUM Console tree.

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

Figure: Definition of Data Source

The application description appears as a pop-up window when leaving the cursor on the application.

Figure: Contextual descriptive label of an application in the Console tree

To create a new application

1. In the COGNITUM Console, select the Applications tree item and click the New Application toolbar button.
2. The first New Application wizard screen is displayed. In the Name box, enter the label of the application.

3. In Type, select:

4. Default to launch the creation process of an empty application, or

5. White Pages to load the predefined logical layer for a standard white pages application.

6. In the Authentication Data Source area:

7. select the data source to be used as the authentication repository, or

8. create a new data source by selecting the Create a new Data Source option. Additional steps are required to create the new data source, as described in “Adding a data source”.

9. Click Next to start the J2EE application creation process. Once it is finished, click OK in the message box to display the second wizard screen.

10. Click Next to complete the data source screen(s) as described in “Adding a data source”.
11. Click the Finish button to validate the parameters for the new application.
12. In the COGNITUM Console tree, right-click the new application item and choose Edit Description to provide custom information.

Application Duplicate

When the configuration of an existing application meets most of the specifications for a new application, it may be very quick, secure and efficient to duplicate it. Changes in the new application parameters can be performed subsequently.

Duplicating an application consists in archiving the source application and importing the archive into the COGNITUM Console with a different name:

• The existing application must be available as an archive. The process is described in “Archiving an application”.
• Instead of launching the New Application wizard, the application archive must be imported. The only mandatory change brought during the import process is the new application name which must be unique. For more information about the import process, see “Importing an application”.
• The properties of the new application certainly need to be updated as documented in “Configuring and modifying an application”.

To duplicate an application

1. In the COGNITUM Console tree, right-click the application and choose Export as described in “Archiving an application”.
2. In the COGNITUM Console tree, right-click the Applications item and choose Import. In the Import an Application wizard, select the application archive. Enter the name of the new application in the New Name box. For more information about the Import an Application wizard, see in “Importing an application”.
3. The duplicated application is listed in the tree. Select it to update its properties as documented in “Configuring and modifying an application”.

Configuring and Modifying an Application

As soon as it is created, an application is accessible with a Web browser connected to http://localhost:9090/application. The green activation icon besides an application item in the tree indicates the application is enabled. When the icon is red, the application is deactivated.

Figure: Disabling an application

When the Disabled check box in the Definition tab is selcetd, the application is deactivated.

When an application is added to the COGNITUM Console tree, COGNITUM automatically creates categories of information for the application. When the Applications item is highlighted in the COGNITUM Console tree, the facing view lists the applications available. A click on an application in the tree displays its properties.

The configuration parameters of an application consists of:

• definition
• behavior properties
• assigned portals
• specific login accounts used
• specific connection modes
• additional application packages
• custom Java library and
• custom Java components for the Workflow processes.

Application definition

The default Definition tab of a selected application gives information about the application name and authentication data source.

Figure: Application definition property view

Application Definition: This area recalls the main features of the highlighted application. COGNITUM makes it possible to change some of the basic properties specified when creating the application. For more information, see “Creating an application”.

Disabled: This check box can be selected to disable the application for end-users while it can still be configured in the COGNITUM Console. When an application is deactivated, users can no longer access it.

Data Source: This area identifies the data source used as the authentication data source. Users’ logins are checked against the data source.

A click on the Apply button validates the parameters.

To configure the application definition properties

1. In the COGNITUM Console tree, select the application you want to modify. The Name box entry defined when creating the application can be changed.
2. Select Disabled when you want to configure it further and prevent users from accessing it.
3. In the Data Source area, you can change the data source to be used for authentication.
4. Click Apply.

Application properties

The Properties tab of a selected application displays the functional parameters of the lookup pages. The parameters are recorded in the COGNITUM-root/Server/webapps/application/WEB-INF/conf/application.properties file.

Figure: Application properties property view

Key: This column lists the application features. A click on a feature highlights it and gives access to the facing value.

Value: It is the value assigned to the highlighted property. A click in a cell makes it possible to enter another value. The key-like button makes it possible to encrypt the value of a sensitive property key (for example connectUTF-8ion URL). Once encrypted, the value cannot be visible again for security reasons.

A click on the Apply button validates the parameters.

Properties of Web Applications

Table: Properties of web applications

To configure an application properties

1. In the COGNITUM Console tree, select the application you want to modify. Select the Properties tab.
2. Select the Key and click corresponding Value to change it. Click the key button to encrypt the value.
3. Click Apply to validate the entries.

Portal Properties

A COGNITUM application is browsed and handled on a portal. A portal contains display and behavior properties which are automatically applied to the whole application. It is made of COGNITUM components.

An application can be assigned to another portal. As a portal contains specific properties, switching portals make is possible to choose the way information is organized and displayed to end-users without modifying the application content.

The portal parameters are recorded in the COGNITUM-root/Server/webapps/ application/portals/portal/portal.properties file.

A click on the Portals tab of a selected application lists the portals available and their respective properties.

Figure: Application portal property view

Portal: When the list box is available, a click in the box allows to select the portal applicable to the application. std stands for the standard portal provided by default with COGNITUM. The portals available in the COGNITUM-root/Server/webapps/application/portals folder are also listed.

When a portal is selected, the table displays the contingent properties.

Key: In the column are listed all the properties of the selected portal.

Value: This is the value applied to the facing key. The value can be a relative path to the portal or a numerical value or any other type of value provided forming a consistent Key/Value couple. A click in a cell allows to modify the value or enter a new one.

A click on the Apply button validates the changes.

To configure the portal properties

1. In the COGNITUM Console, select the Portals tab of an application
2. Select the portal applicable to the application from the list box.
3. A grid showing the keys and values of the selected portal is displayed. Select the Key/value to edit. Edit the key and/or the value of a portal property.
4. Click Apply to validate the changes.

Account Library

To log onto an application, a user usually enters his/her account login and password. Every user has specific rights on an application. When the login/ password credentails are entered, COGNITUM checks the rights corresponding to the user profile in the accessed LDAP directory, DSML file, or RDBMS database server. As a result, some operations are enabled and some opeartions / commands are prohibited.

Figure: Application accounts property view

Along with the regular login process, the application developer can declare some aliases. Aliases are accounts with rights that common users do not usually have. They are used when the logged in user has not the right to perform a specific action on the data source. To perform localized actions requiring specific rights, COGNITUM automatically switches from the logged in user account to an alias declared in the accounts library. Once declared in the COGNITUM Console, the alias can be called from the COGNITUM API. For more information, see the Technical Documentation.

Creating an account consists in declaring an alias and the associated connection parameters to the data source—that is a login name and password. The Accounts tab in the selected application property view identifies a list of accounts the application can use to perform actions requiring special rights.

The Connection Accounts area identifies the available accounts for the application and their associated connection parameters on the data sources.

Aliases: A click on a line makes it possible to declare or modify an alias name. For each alias are identified in the facing box the data source the alias is related to and the credentials associated. The Apply button must be clicked to validate the alias. A click on the Insert button allows to add a data source and its connection parameters for the selected alias.

Data Source: A click in a cell makes it possible to select among the data sources defined for the application, the one the alias is associated to.

User: This cell must be filled in with the login of the required user account for the selected alias. When the login is unknown, a click on the Browse DNs button opens up the Search for the DN of a User dialog box for a user to be searched through an LDAP request—available only when the selected data source is of LDAP or DSML type.

Password: It is the password of the alias account. Once both Login and Password boxes are filled in, a click on the Test button makes it possible to check that the login/password couple is correct.

In an alias, there can be several accounts; each account is authorized on a specified data source. A click on Apply validates the account library parameters.

To create an alias of accounts

1. In the COGNITUM Console tree, select the application you want to configure the account library for. Click the Accounts tab.
2. In the Connection Accounts area, click in the coulmn of Aliases and enter the name of the alias to create.
3. Click Apply to add the alias.
4. Click Insert to add account details.
5. Select the data source from the list to be associated to this alias.
6. Enter Login and Password credentials of user account. When the selected data source is of LDAP or DSML type, click the Browse DNs button to select the DN of a user.
7. If required, enter more accounts details for the data sources available.
8. Click Apply to validate the operations.

Login properties

The designer of an application can specify a default user account so that end-users can skip the authentication step. The Login tab of a selected application is used to tell how connections are performed onto the application.

Figure: Application login property view

Connection: This area makes it possible to define the application login display mode:

• Standard: This enables a prompt box requiring a login and password when the application is launched.
• Automatic as User: This option avoids the prompt box: it defines the account used by default by the application on behalf of any other user. Access rights are defined accordingly.

Start with View: This check box activates the default view that is launched when starting the application. All views are defined under the Views item in the tree, as described in Chapter 10, “Views”.

Triggers: The Triggers area makes it possible to specify an action which is automatically launched at the application login. The triggers are Java classes determining the actions to be triggered when the operation is invoked:

BEFORE: the login screen of the application,

AFTER: the user has logged in the application

A click on the Apply button validates the parameters.

To configure the connection properties

1. In the COGNITUM Console, click the Login tab of an application.
2. Select the connection mode from the options,
   • Standard: when you want every user to log in with his/her own login and password, or
   • Automatic as User: Allow user to access the application without any login form. Enter User name and Password as default account.
3. To start the application with a specific default view, select the ‘Start with View’ check box. Select the view from the drop-down list.
4. In the Triggers area, you can add triggers BEFORE and/or AFTER the application login:
   • Enter 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 Edit to edit the Java class code if required. Click Compile to compile the .java file.
5. Click Apply to validate your entries.

Imported Packages Identification

COGNITUM provides facility to import packages into an application. For more information, see “Importing a package”.

The imported packages are displayed in the Packages tab. Each package is uniquley identified giving general information about it. A click on the Packages tab displays the imported packages for the selected application.

Figure: Application packages property view

Name: This is the name of the package.

Version: This is the version number assigned to the package.

Designer: This is the name of the user who created the package.

Installation Date: This is the date and time when the package was imported into the application.

Help: A click on the doc hyperlink, when available, displays the readme file defined at export time. This .html file contains information regarding the package entered by the export designer.

A click on the All References button removes all the packages from the list. A click on the Selected References button removes the package(s) with the facing check box selected. The package(s) and the related components are removed from this list.

A click on Apply validates changes in the package list.

To manage the imported packages

1. In the COGNITUM Console, click the Packages tab of an application.
2. List of references of imported packages is displayed.
3. Select the packages to remove and click Selected References button. All the packages can be removed instantly when All References button is clicked.
4. Click Apply to validate changes.

Java Libraries

Java libraries are Java classes which are used as reusable functions libraries. The Java Library tab helps centralize classes that are instantiated by developers inside triggers, computed attributes, variables. They often meet needs for specific business operations which cannot be standardized because they must match the ins and outs of the data source.

A click on the Java Library tab displays the list of the classes available for the selected application. Java classes can also be created and edited in this tab.

Figure: Application Java library property view

New: To create a new Java class, a click on New opens the New Java Class dialog box described below in “Adding a Java class”.

Edit: A click on this button makes it possible to modify the selected Java class. For more information, see “Editing a Java class”.

Compile: With a click on this button, the code entered in the editor for the selected Java class is checked and the class file is generated. For more information, see “Editing a Java class”.

Compile All: A click on this button compiles all the Java classes in the list.

Refresh Classes List: Java classes are stored in the COGNITUM-root/Server/dev/application/libraries/src folder. Some custom Java classes can be stored directly in the folder. The Refresh Classes List button makes it possible to scan the folder so that the list is comprehensive.

Delete: A click on this button deletes the selected Java class.

A click on the Apply button in the Java Library tab validates the custom Java classes.

Adding A Java Class

In the Java Libraries tab of the selected application, Click New… to add New Java Class

New Java Class dialog box is displayed as below,

Figure: New Java Class

Application: In this list, the related application is selected by default. Another application can be chosen when necessary.

Java Class: The box is filled in by default with the name of the new Java class: cdm.custom.library.JavaClass_increment. The name can be modified provided it complies with the <package>.<class> naming convention. A click on the Default Class Name button restores the default naming.

Enhanced Features: The area is similar to the second screen of the New Workflow Singleton wizard described in “Workflow singletons”.

A click on OK validates the new Java class. The new Java class probably needs to be edited as documented in “Editing a Java class”.

To add a new Java class

1. In the COGNITUM Console, click the Java Libraries tab of an application.
2. Click New...
3. In the New Java Class dialog box, you can change the application selection provided more than one application is declared in the COGNITUM Console.
4. Default name of the Java class is displayed. You can change the Java class name if required.
5. In Enhanced Features area, select Enable use for workflow checkbox if Workflow is created with singleton as described in “Adding a Workflow singleton”. Enter Singleton Name.
6. Click Ok to save the new Java class definition.
7. The java class name is displayed in the list under Java Library tab.

Editing a Java class

In the Java Libraries tab of the selected application, the Edit button displays the selected Java class in an editor.

To edit a Java class

1. In the COGNITUM Console, click the Java Libraries tab of an application.
2. In the Java Classes list, select the class you want to complete or modify.
3. Click Edit.
4. A text editor window popsup displaying the java code.
5. Edit the Java code.
6. Save it and close the editor.
7. Click Apply to save the new Java class definition.

Workflow Singletons

Singletons are instances of Java classes accessible through aliases. They are used in Workflow process model definitions. Singletons can establish communication with other external applications like the COGNITUM public API, other databases or any applications able to store data which can be used to create a new Workflow process instance.

A click on the Workflow Singletons tab displays the list of the singletons available for Workflow processes applicable to the selected application. Singletons can also be created and edited in this tab.

Figure: Application Workflow singletons property view

Workflow Singletons List: It is the list of the Workflow singletons available. The table columns are:

• Singleton Name: It is the name of the singleton.
• Java Class Name: It is the name of the Java class which the singleton belongs to.
• Activated: By default, this option is checked. It means that the singleton is available for Workflow processes.

Add: A click on this button launches the New Workflow Singleton wizard described below.

Remove: A selected Workflow singleton can be removed with this button.

A click on the Apply button in the Workflow Singletons tab validates the custom singletons.

Adding a Workflow Singleton

In the Workflow Singletons tab of the selected application, the Add button displays the New Workflow Singleton wizard.

The first wizard screen helps select the singleton type.

Figure: New Workflow singleton box (singleton type)

Application: In this list, the related application is selected by default. Another application may be chosen when necessary.

Workflow Singleton Type: A singleton can be created according to the Java class context:

• Create a new Java Class: This default option makes it possible to create a singleton and the Java class it belongs to.
• Add from the Java Library: This option must be selected when the new singleton belongs to a Java library listed in the Java Library tab.
• Add from an existing Java Class: When a custom Java class is available, this option makes it possible to create a singleton for this Java class.

A click on Next displays the second wizard screen to identify the new singleton.

Figure: New Workflow singleton box (new Java Class)

Java Class: 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. This option is only available when the singleton is selected form the Java Library (Add from the Java Library option in the previous screen).

Singleton Name: It is the name of the singleton as it is displayed in the Workflow Singletons tab list. The singleton is called by this name in the COGNITUM Development Studio when configuring a Workflow process too.

Activated: By default, this option is checked. It means that the singleton is available for Workflow processes.

Include COGNITUM access: When the singleton is Workflow-oriented, this option must be checked. In a process, it provides a connection to the application. This option is available only when the singleton is added from scratch (Create a new Java Class option in the previous screen).

A click on Finish validates the new singleton. The new singleton probably needs to be edited as documented in “Editing a Java class”.

To add a Singleton

1. In the COGNITUM Console, click the Workflow Singletons tab of an application.
2. Click Add to start New Workflow Singleton wizard.
3. In the Application list box, you can change the application scope of the singleton if more than one application is defined in the COGNITUM Console.

4. In the Workflow Singleton Type area, select the singleton creation mode:

5. Select Create a new Java Class to create a singleton and its Java class in one go, or

6. Select Add from the Java Library to create a singleton for one of the classes already specified for the application, or

7. Select Add from an existing Java Class to create a singleton for a custom class.

8. Click Next to display the second screen of the wizard.

9. If Add from the Java Library option is selected, enter name of the singleton Java class.
10. In Singleton Name, enter the name of the new singleton.
11. Activated check box should be kept selected to make the new singleton available. Otherwise clear the check box.
12. If Create a new Java class option is selected, Include COGNITUM access check box should be kept selected so that the singleton opens a connection to the application. Otherwise deselect clear the check box.
13. Click Finish to validate the new singleton parameters.
14. Click Apply to save the new singleton.

Generating the Report of an Application Configuration

COGNITUM makes it possible to generate report listing configuration parameters of a selected application.

The Tools => Generate Report command is available from the application context menu. Select the Folder dialog box pops up. Select the folder for the HTML report files.

Figure: Application configuration report

A click on Open launches the report creation. A message box pops up when the report is generated. The report may be displayed as soon as it is generated. It may also be accessed later in the chosen folder from the generated index.html page.

The report is very comprehensive and lists most of the parameters entered in the COGNITUM Console for the application. The report may be displayed either in navigation mode or as a single report file. It can be printed either as a whole or per section.

To generate a report for an application

1. In the COGNITUM Console tree, select the application for which the report must be generated.
2. From the context menu, choose the Tools => Generate Report command.
3. In the Select the Folder dialog box, select the folder the report must be saved in and click Open.
4. In the message box, click Yes to open the HTML page displaying the report.

Recompiling all the application Java classes

Java classes may well be entered throughout the application design (variables, triggers, and so on) A right-click on an application in the COGNITUM Console tree gives access to the Tools => Compile All Java Classes command.

When the Java code used in the application is recompiled, a confirmation box is displayed.

Managing Applications

COGNITUM makes it possible to export/import applications. Exports/imports are compressed files composed of the application structure and parameter files. They are particularly useful to:

• deploy an application on a production server,
• back up/restore application data,
• transfer an application between COGNITUM servers, that is for production or migration issues.

Exporting an Application for Deployment

When an application has been designed in the COGNITUM Console, it can be deployed on a production server. Beforehand, it must be packaged in a Web application archive (WAR).

A WAR file is similar to JAR files used for Java class libraries. It contains all the necessary files to make the application autonomous on the production server:

• Web components or Web resources
• static Web presentation content
• server-side utility classes
• client-side classes

When a WAR file is deployed on the application server, it is automatically unpacked.

A click on the Export as WAR button in the toolbar displays the first screen of the Export as WAR wizard.

Figure: Export as WAR box (WAR file location)

Application: It is the name of the selected application. When available, a click on the list box button allows to select another application.

Filename: By default, the name of the destination WAR file takes the name of the application. The torch button makes it possible to save the file under a different name in the exports folder COGNITUM-root/Server/archives/

User properties from the last export: When the application has been exported previously, the parameters set in the wizard second screen are preserved. Still the second screen is accessible for modifications. The application export parameters are recorded in the application and can be reused subsequently and on another development server.

Generate Simple WAR file: If you want to generate simple WAR file without any production server specific changes, then select Generate Simple WAR file checkbox.

A click on Next displays the second WAR File Parameters wizard screen.

Figure: Export as WAR box (Screen 2)

Figure: Export as WAR box (WAR file parameters)

WAR Parameters: This table lists all the properties of the export file:

• Key: This column lists all the properties of the WAR file.
• Value: For each key, a click in the facing Value cell makes it possible to change the property value:
• manually or
• with scrollable lists or
• in an Identification dialog box accessible with a click on the icon in the cell
• Add: A click on this button opens the New WAR Parameter dialog box to add a line in the table.
• Remove: A selected custom property can be removed with a click on this button.
• Reset: A click on this button resets the property to its default value.

WAR Parameter: This area lists the information of the key selected in the above table:

• Key: This is the name of the property.
• Value: This is the value of the property.
• Value in dev mode: This is the value of the property as set in the COGNITUM Console when designing the application.
• Description: This is the description text of the property available for a mandatory property or entered when a custom property is added.

A click on Finish validates the WAR parameters and launches the export process. Once complete, a confirmation box pops up.

The WAR file is created in the COGNITUM-root/Server/archives/ folder. The exported file contains all the necessary components which makes the application autonomous once deployed on the production server.

WAR File Parameters

The WAR export includes a web.xml file which lists all the WAR file parameters.

To export an application as a WAR file

1. In the COGNITUM Console, select the application you want to export in WAR.
2. Choose the Export as WAR button in the toolbar to display the Export as WAR wizard.
3. In the first WAR File Location screen, you can change the application selection in the Application list box if more than one application are defined in the COGNITUM Console.toolbar
4. In the Filename box, you can change the default WAR filename with the torch button.
5. When the application has been exported already, you can selected the Use properties from the last export option so that the application is exported with the same properties displayed in the next wizard screen as before.
6. Click Next to display the WAR File Parameters screen.
7. To set a property in the WAR Parameters table, click its facing Value cell. You can also add/remove a custom property. To set a mandatory property to its default value, click Reset.
8. Click Finish to launch the export process. Once terminated, a confirmation box pops up. The .war application package is created in the COGNITUM-root/Server/archives/ folder.

Improvements in feature Exporting an Application in COGNITUM 7.8.00

COGNITUM 7.8.00 brings a following set of improvements over previous Calendra, CDM and COGNITUM versions in exporting an application.

Simplified WAR Export Process is explained in the document Application with new Features and Improvements in COGNITUM 7.8.

Reconfiguring application WAR Parameters before deployment is explained in the document Application with new Features and Improvements in COGNITUM 7.8.

Archiving an Application

Exporting an application makes it possible to transfer an application,

• The application designer is responsible for safeguarding all COGNITUM configuration data. It is recommended to perform backups regularly.
• The application designer may need to export the developed applications so that they can be imported onto the upgraded COGNITUM system.

To display the Export an Application dialog box, the Export command is accessible through the COGNITUM Console toolbar.

Figure: Export an application box

Filename: By default the name of the destination export file takes the name of the application. The torch button make it possible to save the export file under a different name in the exports folder.

A click on the OK button launches the application export.

Once completed, the .zipfile is created in the default COGNITUM-root/Server/archives/ folder on the COGNITUM Application Server machine. The exported application file contains the following components:

• Description.conf used as a configuration file by the export process.
• application.html.zip containing all the generated HTML files that make up the application user interface.
• application.dev.zip used for the development of the application components and functions.
• application.xml containing all the configuration data of the application.

Exporting an Application

1. In the COGNITUM Console, select the application you want to export.
2. Click the Export button in the toolbar.
3. In the Export an Application dialog box, specify the application in the Application box with the help of the torch button.
4. In the Filename box, enter the name of the destination .zip file. You can use the torch button to specify its path.
5. Click OK. A message box tells you when the export process is successful. Your exported .zipfile is created in the default COGNITUM-root/Server/archives/ folder.

Importing an application

COGNITUM makes it possible to import applications. Importing an application provides a reliable method for:

• Restoring an application data from permanent storage,
• Transferring an application between COGNITUM Servers, that is for migration issues.

Importing an application archive

A click on the Import button in the COGNITUM Console toolbar displays the Import an Application wizard. The wizard guides you through the steps necessary to import an application.

Figure: Application import wizard (archive file selection)

Filename: It is the full name of the application file available under the COGNITUM-root/Server/archives/ folder on the COGNITUM Server machine. The torch button can help find the file.

Name: It is the name of the application available. When a .zip file is made of several applications, the torch button facing the Name box displays the Available applications list box.

New Name: It is the name of the application in the COGNITUM Console once imported. Non-alphanumerical characters and blank spaces are prohibited.

A click on the Next button validates the identification parameters set for the imported application. The import process of the J2EE application is launched as shown in the displayed progress box.

Figure: Application import progress box

The sequence is represented with flashing blue bullets and green selects:

Unpacking as J2EE Application: The imported application is created from the.zip file called. It contains the Web and the development content.

Starting J2EE Application: The application server starts the application.

Checking Integrity: The consistency of the COGNITUM components is checked. Importing Logical Configuration: The COGNITUM objects for the application are imported into the COGNITUM Console. Waiting for Application Binding: The application is being loaded into the COGNITUM Console.

When the sequence is finished, an information message box is displayed to tell that the J2EE conversion is successful.

A click on OK in the information box displays the second wizard screen to specify the data source for the new application.

Figure: Application import wizard (authentication data sources selection)

Name: This box displays the imported application name.

Authentication Data Source: The authentication data source is used as a repository to identify and optionally authenticate users that connect on the COGNITUM application. An authentication data source must be defined for the imported application:

• With the Use the Data Source defined in the archive file option, COGNITUM uses the data source defined in the imported application. A click on the Finish button validates the import of the application.
• With Create a new Data Source, another authentication data source can be defined. A click on the Next button displays another wizard screen corresponding to the New Data Source dialog box documented in Chapter 3, “Data sources”.
• With the Use a copy of an existing Data Source option, the data source of another application can be selected in the Application and Data Source list boxes. The Properties box displays the parameters of the selected data source.

A click on Finish validates the imported application.

To import an application

1. In the COGNITUM Console, click the Import toolbar button.
2. In the Import an Application first wizard screen, click the Filename torch button to select the application file to import.
3. In the Name box, leave the default application name, or click the torch button to display the Available applications list box and select another application.
4. In the New name box, enter the name of the application as you want to see it in the tree once imported.
5. Click Next.
6. Watch the progress screen until you can click OK in the message box confirming the import process. The second wizard screen is displayed.

7. In the Authentication Data Source area, select the data source required to authenticate connecting users:

8. Use the Data Source defined in the archive file to keep the source defined in the import.

9. Create a new Data Source to define a new authentication source. Additional wizard steps are necessary. See “Data sources”.

10. Use a copy of an existing Data Source to specify a source already available in the COGNITUM Console.

11. Click Finish.

Cleaning an imported application

Cleaning an application consists in checking the consistency between the attributes of a resource and the related objectclasses for all the resources of the COGNITUM Console.

For compatibility with earlier application versions, COGNITUM can check and clean imported applications for attributes and objectclasses consistency.

Checking attributes consistency for an application may also be useful after developing an application offline. The facility checks the consistency between attributes created offline and the directory attributes.

The cleaning process is launched on a selected application with the Tools => Clean command from the context menu.

The cleaning facility checks whether the resources attributes need to be upgraded. If not, a message box is displayed to tell the process is terminated.

Otherwise the Attributes Management dialog box pops up to give an overview of the scanning process. Some enhancements may be required.

Figure: Attributes Management box

Context: This area displays the application and resource processed.

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 Next launches the attributes analysis on the next resource. A message box pops up when all the operations are finished. For more information about objectclass attributes management, see “Objectclass attribute”.

To clean an application

1. In the COGNITUM Console tree, select the application you want to clean.
2. From the context menu, choose the Tools => Clean command.
3. When the application does need to be cleaned, the Attributes Management dialog box is displayed.

4. In the Object Classes area:

5. select the object class to check

6. click Insert to add one or

7. click Remove to clear a selected object class

8. In the Missing Attributes area, click the arrow button to move a mandatory attribute into the Attributes of the Resource area.

9. In the Attributes Management area, select the attributes you want to keep for the resource and click the Keep selected/Remove unselected button to keep/clear them.
10. Click Next to analyze the next resource when any.
11. In the confirmation box, click OK.

Managing Application Packages

Exporting an Application as a Package

Logical objects created and configured in the COGNITUM Console can be exported as a package. A package is an entity containing COGNITUM logical objects ready-to-use and pre-configured for a specific application purpose. The logical objects can be imported into another application.

Exporting a package consists in selecting logical objects of an application and their associated files to encompass them in a .zip file. The Export as Package command is available from a selected application from its context menu. The first screen of the Export as Package wizard is displayed.

Figure: Application package export wizard (file location)

Application: This is the name of the application containing the objects to be exported. When available, a click on the list box allows to choose this application.

Filename: This box must be populated with the name of the package .zip file. A click on the torch button makes it possible to select an existing package to update it.

Name: This box must be populated with the complete name of the package.

Version: This box can be populated with the version number to assign to the package. It is optional and can be left empty.

Designer: This is the name of the user creating the package to export. This box is optional. A click on Next displays the second wizard screen.

Figure: Application package export wizard (options)

Object Management: The area identifies the selected application logical objects available for export. A click on a plus sign beside an object item displays the associated objects available below:

• Export: Selecting the check box makes the facing object available for export. Selecting the check box for an object automatically selects the check box of the object it is associated with, for example a resource and a data source.
• Map: Selecting this check box defines the facing object as to be exported but mapped onto an existing object of the target application when importing the package. For more information, see “Importing a package”.

Files Selection: The area lists the files associated with the objects selected for export in the Object Management area. The files associated with the object(s) to export are automatically exported. For example, when exporting a resource containing triggers, the triggers development files are also exported. This area identifies:

• Web files that collect all the files necessary for the application working in the portal.
• Development files that are the source files for the application components such as the triggers, the computed attributes, the variables, and the Web services.

A click on the torch button opens the File Selection dialog box in which additional files can be selected in the export.

Figure: File selection for the application package export

In the File Selection selection box, the Folders list box displays the development and web folders of the application containing the object(s) to export. A click on a folder displays the files it includes in the facing Files list box. A file is made available for export when it has its check box selected. A click on OK validates the selection and closes the File Selection dialog box back to the wizard screen.

Readme Before Import: When this package is imported, an .html or .txt file can be displayed just before the actual import process is launched. The custom document may list descriptions, warnings, and so on. A click on the torch button makes it possible to select the .html or .txt file from the COGNITUM-root/Server/webapps/application/ folder.

Readme After Import: When the current package is imported, an .html or .txt file can be displayed once the import process is completed. The custom document may contain instructions, configuration information, and so on. A click on the torch button makes it possible to select the .html or .txt file from the COGNITUM-root/Server/webapps/application/ folder.

A click on Next displays the third wizard screen.

Figure: Application package export wizard (properties)

The Web Properties Files to Export area makes it possible to define the policy to apply for the .properties files to be exported. The .properties files available in this list stem from the Web files selection performed in the previous step:

File Name: This is the path to the file onto the web application folder.

Policy: A click in the box makes it possible to select the policy to apply to the facing file:

• Overwrite Target: Selecting this option exports the facing file or overwrites the target file when already existing.
• Merge All Keys: Selecting this option exports the keys included in the facing package .properties file or merges them when the file already exists in the target application. Keys already existing in the target file are not overwritten.
• Merge Selected Keys: This option makes it possible to select the keys to export in the target file. When the target file already exists, the option allows to select the keys that overwrite the existing ones. Selecting this option enables the facing Keys button. A click on the Keys button opens up the Keys Properties Selection dialog box.

Figure: Keys properties selection for the application package export

Key: This column lists the keys included in the .properties file. A click on the column header sorts the keys alternately in ascendant or descendant order.

Value: This is the value of the selected key.

Export: The check box must be selected when the corresponding key must be exported.

Overwrite: When the check box is selected, the value of the corresponding key overwrites the value of the same key in the target file.

A click on OK validates the selection and closes the Keys Properties Selection dialog box back to the wizard.

In the wizard, the Next button displays the fourth screen.

Figure: Application package export wizard (export policy)

The Reference to Display Layer area makes it possible to select the strategy to adopt regarding resources configuration when the target application contains an identical resource and when it is going to be overwritten.

Use references to icons and forms as defined in the package: Selecting this option overwrites the references to the icons and forms of the resource and view with those included in the package.

Keep user references to icons and forms of the target application: With this option, when overwriting an existing view or resource, the references to the icons and forms of the target application are kept.

The Dictionary area makes it possible to select the strategy to apply for objects translations when the package imported includes objects already existing in the target application.

Use logical configuration dictionary as defined in the package: Selecting this option overwrites the translations of the objects existing in the target application with the translations included in the package.

Keep logical configuration dictionary of the target application: Selecting this option keeps the translations of the existing objects in the target application. The existing objects are overwritten with the package objects but the translations remain the same.

A click on Finish validates the parameters and exports the package. When the export is done, a confirmation box pops up.

Exporting a package

1. In the COGNITUM Console tree, right-click the application from which you want to export a package. Select Export as Package command.
2. In the first wizard screen, select the source application if more than one application are defined in the COGNITUM Console and enter the name of the package. Enter the name, version number and designer name of the package. Click Next.
3. In the second wizard screen, select the objects to export or map in the Object Management area. In the Files Selection area add or remove the Web and development files to be exported with a click on the torch button. Select the .html or .txt file to be displayed after the import with a click on the facing torch button. Click Next.
4. In the third wizard screen, select the management policy for the .properties files associated with the objects to export. Click Next.
5. In the fourth wizard screen select the overwriting strategy for the forms and dictionary keys. Click Finish.

Importing a package

COGNITUM makes it possible to import into an application a number of logical objects contained in a package. A package contains specific files and logical objects related to the package imported. The objects imported are pre¬configured to run the package facility easily and quickly. The imported logical objects are added to the application configuration.

Importing a package consists in selecting a .zip file containing logical objects previously exported. The Import Package command is available from a selected application from its context menu.

Figure: Application package import selection

As soon as a package is selected, a message box pops up to confirm the import operation. In the box, when Backup the Application Automatically before import check box is selected, the current application is saved automatically. The application is stored in COGNITUM-root/Server/archives. The file name pattern is application_savedate.zip. Clicking Yes launches the package import process.

For some packages, a wizard window pops up during the package import. The first screen of the Import Package wizard displays instructions and details to read before processing further. A click on Next displays the last wizard screen.

Figure: Application package import wizard (import strategy)

Conflicts Management: The area lists the objects to be imported already existing in the target application in the Logical Object column. The facing Strategy box makes it possible to select the policy to apply in case of conflict between two objects.

• Overwrite: Selecting this option replaces the existing object with the one included in the package.
• Map with existing: Selecting this option adds the content and properties of the package object into the existing object of the application. The existing object is assigned additional properties from the package object.
• Rename: Selecting this option imports the object under another name. Selecting this option allows to enter a new name for the object imported. By default, when the renaming box is left empty, the name assigned to the package object is objectname_1.

Mapping Management: The area identifies the package objects to be mapped. It makes it possible to select the object the package object must be mapped to. Mapping an object to another one merges the content of both objects:

• Logical Object: Under this column are listed the objects defined as to be mapped at export time.
• Mapping Type: A click in a cell of this column allows to choose whether associated files are overwritten when mapping objects or not.
• Map With: The facing column cells make it possible to select the target application objects the package objects must match with. A click on a Map With cell displays the list of the application objects available. The mapped object is assigned additional properties from the package object. These properties are only added when not already existing in the mapped object. The table below identifies the properties added for each type of object.

Table: Logical Object Properties

A click on Finish imports the package.

To import a package

1. In the COGNITUM Console tree, select the application for which you want to import a package and choose the Import Package command from the context menu.
2. In the message box, click OK to confirm the import operation.
3. When the package includes a readme file, the first wizard screen displays it. Otherwise the wizard automatically switches to the last wizard screen.
4. In the Conflicts Management area, for each object under the Logical Object column, select the strategy to apply with a click on the facing list box.
5. In the Mapping Management area, for each object listed under the Logical Object column, select the mapping type in the Mapping Type column and the application object to map the package object with in the Map With column.
6. Click Finish to import the package into the application.

Managing the Packages Display

Objects included in a package imported into a COGNITUM application can be viewed or hidden in the COGNITUM Console according to the selected option.

Displaying the COGNITUM Console objects resulting from a package import gives a useful information about the objects origin and makes their handling safer.

When an application is selected in the COGNITUM Console tree, the Display menu command is available from the context menu.

Figure: Application packages display option

The Display menu command lists a number of display selection.

• All Packages: Selecting this option displays, in the COGNITUM Console tree, all the objects belonging to imported packages.
• No Package: Selecting this option hides the logical objects coming from imported packages.
• The Display menu also lists, in the bottom part, the packages imported. Selecting/deselecting the package name from the menu displays/hides the objects of all the imported packages. The packages identified from this menu are those displayed in the Packages tab of the application.

To display/hide the objects of a package

1. In the COGNITUM Console tree, select the application for which you want to import a package and choose the Display command from the context menu.

2. From the Display menu, select:

3. All Packages to display the objects of imported packages, or

4. No Package to hide all the packages logical objects.
5. a package in the list to display/hide its logical objects.

Deleting an Application

In COGNITUM, applications can be deleted safely.

In the COGNITUM Console, the Remove command is available with a right-click on application.

To delete an application

1. In the COGNITUM Console tree, select the application to be deleted.
2. Select Remove command from the application context menu.
3. Select Yes in the Remove an application confirmation box.