Difference between revisions of "ClearQuest Dynamic List Editor"

From cqwiki
Jump to navigationJump to search
(→‎Dynamic List Editor)
 
(6 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
= Dynamic List Editor =
 
= Dynamic List Editor =
−
It is NOT a solution that is provided and supported by IBM-Rational.  
+
This 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 Dynamic List Editor is an add-on to your existing ClearQuest schema, VBScript or Perl based, that provides a unified interface to administer Dynamic Lists for Windows, Eclipse, UNIX clients, and (most importantly) the Web client. Additionally, it adds basic audit capabilities that can be enhanced using the Audit Trail package.
 
The enhancement is distributed as a ClearQuest schema integration, and it can be easily removed from the schema when it is no longer required.
 
The enhancement is distributed as a ClearQuest schema integration, and it can be easily removed from the schema when it is no longer required.
  
Line 12: Line 12:
 
[[File:Dynamic_List_Editor.png|center]]  
 
[[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.
+
Dynamic List administrators work with the stateless records, and when the update is completed and records are submitted to the database, the correspondent dynamic lists are updated automatically.
  
 
== Installation Instruction ==
 
== 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.
+
'''Please create a backup of schema and user databases before the installation.'''<br />
 +
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 the configuration is completed, users with the "Dynamic List Admin" privilege or super users can modify the content of the Dynamic Lists using ClearQuest Web or other ClearQuest clients.
  
−
=== Installing ClearQuest Schema Update ===
+
=== Automatic Install ===
−
It is highly recommended to test the procedure in your development environment, and backup master and user databases before you start.
+
* Download the distribution to your local or network drive
 +
* Launch "setup.exe"
 +
* Accept license agreement
 +
* When configuration wizard is launched, provide administrative user credentials, ClearQuest connection, database name, and click on "Connect" (or, you can cancel ClearQuest schema configuration wizard and configure selected database later).
  
−
==== Download and Unpack Schema Integration ====
+
When installation is completed, login to the user database and run "Public Queries/Administration/Dynamic_Lists" query to verify Dynamic list data. You can start using the tool immediately.
−
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 ====
+
=== Manual Install ===
−
* Verify that ClearQuest schema is checked in, and there are no pending changes that have not been applied to the user database.
+
You can install the Editor manually: [[ClearQuest_Dynamic_List_Editor_ManualSetup | Manual Setup ]].
−
* 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 ====
+
== Administering Dynamic Lists ==
−
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.
+
When installation is completed, ClearQuest administrators can start using ClearQuest client to query Dynamic_Lists records to modify the content of the linked dynamic lists. If you used installation wizard, "Dynamic Lists" query is located in the "Administration" folder of the "Public Queries" workspace:
  
−
[[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:Dynamic_List_Sync_3.png|center]]
−
 
 
−
[[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]]
+
Most of the time, the "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration:
−
click "Save" to commit record to the database
+
{| class="wikitable"
−
 
+
! Action Name
−
==== Creating Dynamic List Administration Query ====
+
! Action Type
−
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.
+
! Access Control
−
 
+
! Description
−
[[File:Dynamic_List_Query _1.png|center]]
+
|-
−
 
+
| Submit
−
Select "Dynamic_Query" as a record type
+
| Submit
−
 
+
| Super User
−
[[File:Dynamic_List_Query _2.png|center]]
+
| Submit allows the creation of new records when a new Dynamic List added to the ClearQuest schema. You can also use the "SyncAllLists" utility action to synchronize all the records at once.
−
 
+
|-
−
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.
+
| Update
−
[[File:Dynamic_List_Query _3.png|center]]
+
| Modify
−
 
+
| Super User, Dynamic List Admins
−
==== Importing Dynamic Lists ====
+
| Update is the primary action for administering Dynamic Lists content. When an action is initialized, the record is refreshed with the latest content of the dynamic list (please check "Dynamic List Caching" section). When the updated record is saved, its content is saved in the correspondent dynamic list as well.
−
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.  
+
|-
−
 
+
| Delete
−
[[File:Dynamic_List_Sync_1.png|center]]
+
| Utilities / Delete
−
 
+
| Super User
−
The action syncs ClearQuest records with the correspondent dynamic lists:
+
| This action allows you to delete existing Dynamic_List records, such as when a correspondent dynamic list is removed from the schema. Alternatively, you can use the "SyncAllLists" utility action to synchronize all records at once after a database upgrade.
−
* when ClearQuest record already exists, its content is updated from the dynamic list
+
|-
−
* when ClearQuest record does not exist, new record is created
+
| LoadList
−
* when dynamic list for existing ClearQuest record does not exist, the record is deleted.
+
| Utilities / Script
−
 
+
| Super User, Dynamic List Admins
−
[[File:Dynamic_List_Sync_2.png|center]]
+
| Load List action updates the current ClearQuest record with the content of the correspondent dynamic list. Please be aware that in order to see the update you might need to refresh the ClearQuest query or even to close and re-run it.
−
 
+
|-
−
If no errors occur, a confirmation is displayed. Otherwise, you would see an error message.
+
| SaveList
−
Refresh the query to verify that all dynamic lists with proper content are loaded.
+
| Utilities / Script
−
 
+
| Super User, Dynamic List Admins
−
[[File:Dynamic_List_Sync_3.png|center]]
+
| Save List action saves the content of the current ClearQuest records into a correspondent dynamic list.
 +
|-
 +
| SaveAllLists
 +
| Utilities / Script
 +
| Super User, Dynamic List Admins
 +
| Save all lists saves the content of all ClearQuest Dynamic List records into correspondent dynamic lists. It might be useful when records are imported from an external source.
 +
|-
 +
| SyncAllLists
 +
| Utilities / Script
 +
| Super User
 +
| This action syncs ClearQuest records with their correspondent dynamic lists:
 +
* when the ClearQuest record already exists, its content is updated from the dynamic list
 +
* when the ClearQuest record does not exist, a new record is created
 +
* when a dynamic list for the existing ClearQuest record does not exist, the record is deleted.
 +
|}
  
 +
== Dynamic Lists Caching ==
 +
In order to improve performance, ClearQuest caches the content of dynamic lists. When you update the content of dynamic lists using native tools, the update is not available to all existing clients and sessions immediately. Your clients might need to re-login to the database in order to see the changes.
 +
Similarly, the dynamic list editor is using an actual dynamic list as a primary trusted source of data for the records. When you initiate a record update, the record content is loaded from the dynamic list first. In an environment where dynamic lists are actively updated from many clients simultaneously, it might cause overwriting, because the cached list values could be used by ClearQuest. In a so changing environment, it is recommended to re-login to the database before starting a dynamic list modification (the same issue exists when you use native tools in the legacy ClearQuest Windows Client).
 +
If you rarely use native tools to update dynamic lists (for instance, when a ClearQuest full client is not installed on the Dynamic List Admins' machines, and they use the Editor's Web Client capability to modify lists only), you can select the ClearQuest records as a trusted source of data for the dynamic lists. In order to do so, you need to remove the "Update" action initialization hook from the Dynamic_List record type, and upgrade the user database to apply changes. This would ensure that the most accurate data is used for list modification.
  
 
== Support ==
 
== Support ==
Line 90: Line 92:
 
   
 
   
  
−
[[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]
+
 
 +
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]

Latest revision as of 18:30, 16 June 2013

ClearQuest Dynamic List Editor

Created by ClearQuest admin for ClearQuest admins.

Dynamic List Editor

This is NOT a solution that is provided and supported by IBM-Rational. The Dynamic List Editor is an add-on to your existing ClearQuest schema, VBScript or Perl based, that provides a unified interface to administer Dynamic Lists for Windows, Eclipse, UNIX clients, and (most importantly) the Web client. Additionally, it adds basic audit capabilities that can be enhanced using the Audit Trail package. 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.

Dynamic List Editor.png

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

Installation Instruction

Please create a backup of schema and user databases before the installation.
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 the configuration is completed, users with the "Dynamic List Admin" privilege or super users can modify the content of the Dynamic Lists using ClearQuest Web or other ClearQuest clients.

Automatic Install

  • Download the distribution to your local or network drive
  • Launch "setup.exe"
  • Accept license agreement
  • When configuration wizard is launched, provide administrative user credentials, ClearQuest connection, database name, and click on "Connect" (or, you can cancel ClearQuest schema configuration wizard and configure selected database later).

When installation is completed, login to the user database and run "Public Queries/Administration/Dynamic_Lists" query to verify Dynamic list data. You can start using the tool immediately.

Manual Install

You can install the Editor manually: Manual Setup .


Administering Dynamic Lists

When installation is completed, ClearQuest administrators can start using ClearQuest client to query Dynamic_Lists records to modify the content of the linked dynamic lists. If you used installation wizard, "Dynamic Lists" query is located in the "Administration" folder of the "Public Queries" workspace:


Dynamic List Sync 3.png


Most of the time, the "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration:

Action Name Action Type Access Control Description
Submit Submit Super User Submit allows the creation of new records when a new Dynamic List added to the ClearQuest schema. You can also use the "SyncAllLists" utility action to synchronize all the records at once.
Update Modify Super User, Dynamic List Admins Update is the primary action for administering Dynamic Lists content. When an action is initialized, the record is refreshed with the latest content of the dynamic list (please check "Dynamic List Caching" section). When the updated record is saved, its content is saved in the correspondent dynamic list as well.
Delete Utilities / Delete Super User This action allows you to delete existing Dynamic_List records, such as when a correspondent dynamic list is removed from the schema. Alternatively, you can use the "SyncAllLists" utility action to synchronize all records at once after a database upgrade.
LoadList Utilities / Script Super User, Dynamic List Admins Load List action updates the current ClearQuest record with the content of the correspondent dynamic list. Please be aware that in order to see the update you might need to refresh the ClearQuest query or even to close and re-run it.
SaveList Utilities / Script Super User, Dynamic List Admins Save List action saves the content of the current ClearQuest records into a correspondent dynamic list.
SaveAllLists Utilities / Script Super User, Dynamic List Admins Save all lists saves the content of all ClearQuest Dynamic List records into correspondent dynamic lists. It might be useful when records are imported from an external source.
SyncAllLists Utilities / Script Super User This action syncs ClearQuest records with their correspondent dynamic lists:
  • when the ClearQuest record already exists, its content is updated from the dynamic list
  • when the ClearQuest record does not exist, a new record is created
  • when a dynamic list for the existing ClearQuest record does not exist, the record is deleted.

Dynamic Lists Caching

In order to improve performance, ClearQuest caches the content of dynamic lists. When you update the content of dynamic lists using native tools, the update is not available to all existing clients and sessions immediately. Your clients might need to re-login to the database in order to see the changes. Similarly, the dynamic list editor is using an actual dynamic list as a primary trusted source of data for the records. When you initiate a record update, the record content is loaded from the dynamic list first. In an environment where dynamic lists are actively updated from many clients simultaneously, it might cause overwriting, because the cached list values could be used by ClearQuest. In a so changing environment, it is recommended to re-login to the database before starting a dynamic list modification (the same issue exists when you use native tools in the legacy ClearQuest Windows Client). If you rarely use native tools to update dynamic lists (for instance, when a ClearQuest full client is not installed on the Dynamic List Admins' machines, and they use the Editor's Web Client capability to modify lists only), you can select the ClearQuest records as a trusted source of data for the dynamic lists. In order to do so, you need to remove the "Update" action initialization hook from the Dynamic_List record type, and upgrade the user database to apply changes. This would ensure that the most accurate data is used for list modification.

Support

ClearQuest Dynamic List Editor is supported by CQAdmin, inc. Three levels or support agreement are currently offered, starting with free community support at http://forum.cqadmin.org. Consulting services are also available.
Retrieved from "http://cqadmin.org/w/index.php?title=ClearQuest_Dynamic_List_Editor&oldid=270"