View source for ClearQuest Dynamic List Editor

<big>'''ClearQuest Dynamic List Editor'''</big>

Created by ClearQuest admin for ClearQuest admins.

= Dynamic List Editor =
It is NOT a solution that is provided and supported by IBM-Rational. 
Dynamic list editor is an add-on to your existing ClearQuest schema, VBScript or Perl based, that provide unified interface to administer Dynamic Lists for Windows, Eclipse, UNIX clients, and (most important) Web client.
The enhancement is distributed as a ClearQuest schema integration, and it can be easily removed from the schema when it is no longer required.

In the Editor, all dynamic lists are represented by correspondent stateless records of the Dynamic_List record type.

[[File:Dynamic_List_Editor.png|center]] 

Dynamic List administrators are working with the stateless records, and when update is completed and records are submitted to the database, correspondent dynamic lists are updated automatically.

== Installation Instruction ==
The package is an add-on to your existing ClearQuest schema. In order to install it, you will need ClearQuest administrative access and administrative tools (ClearQuest designer). When configuration is completed, users with "Dynamic List Admin" privilege or super users can modify content of the Dynamic Lists using editor interface.

=== Installing ClearQuest Schema Update ===
It is highly recommended to test the procedure in your development environment, and backup master and user databases before you start.

==== Download and Unpack Schema Integration ====
Save downloaded archive to your administrative machine hard drive and unpack it. The integration is a text file that can be easily scanned or inspected.

====  Apply Integration to ClearQuest Schema ====
* Verify that ClearQuest schema is checked in, and there are no pending changes that have not been applied to the user database.
* Open command line tool, (Start->Run "cmd") and change directory to the location where integration package was unpacked
* Import integration using "cqload importintegration" command. For example:
 cqload importintegration -dbset <db_connection_name> <admin_user> <admin_password> <ClearQuest_Schema_Name> "" "Dynamic List Editor" 1.0 Dynamic_List_Editor.txt ""
* Verify that schema update was imported and no issues were detected

[[File:cqload_completed.png|center]]

==== Upgrade User Database ====
Now, you can apply changes to the user database using ClearQuest Designer. In the ClearQuest Database Admin section, right click on the user database that you are going to apply changes to. and select "Upgrade Database" from the context menu.

[[File:upgrade_db.png|center]]

Apply the change that you imported on the previous step by clicking "OK" button. Verify that user database was upgraded successfully.

[[File:upgrade_db_completed.png|center]]

==== Import First Dynamic List ====
The rest of the configuration can be done from a ClearQuest client. You can use any client of your choice. In the instructions we will be using ClearQuest Web client, version 8.0.
Login as an administrator, and submit new record of the "Dynamic_List" type

[[File:Submit_Dynamic_List_1.png|center]]

Select one of the list names in the "Name" drop-down list.

[[File:Submit_Dynamic_List_2.png|center]]

Dynamic list will be populated automatically.

[[File:Submit_Dynamic_List_3.png|center]]
click "Save" to commit record to the database

==== Creating Dynamic List Administration Query ====
Now, you need to create a simple query that will be used by the Dynamic Lists administrators. Right click on the folder were you are going to save the query and select "New Query" from the context menu.

[[File:Dynamic_List_Query _1.png|center]] 

Select "Dynamic_Query" as a record type

[[File:Dynamic_List_Query _2.png|center]]

Provide query name, for instance, "Dynamic Lists", add "Name" field to the presentation/display section, and specify "Ascending" (A-Z) sort order. Save the query.
[[File:Dynamic_List_Query _3.png|center]]

==== Importing Dynamic Lists ====
Run "Dynamic Lists" query that we created on the previous step. Verify that the first Dynamic List record is in the result set. Open the record. In the "Utilities" section, select "SyncAllLists" action. By default, the action is opened for ClearQuest administrators only. 

[[File:Dynamic_List_Sync_1.png|center]]

The action syncs ClearQuest records with the correspondent dynamic lists:
* when ClearQuest record already exists, its content is updated from the dynamic list
* when ClearQuest record does not exist, new record is created
* when dynamic list for existing ClearQuest record does not exist, the record is deleted.

[[File:Dynamic_List_Sync_2.png|center]]

If no errors occur, a confirmation is displayed. Otherwise, you would see an error message.
Refresh the query to verify that all dynamic lists with proper content are loaded.

[[File:Dynamic_List_Sync_3.png|center]]


== Support ==
: ClearQuest Dynamic List Editor  is supported by [http://cqadmin.com CQAdmin, inc]. Three levels or support agreement are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.
 

[[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]