ClearQuest Dynamic List Editor - Revision history

Paul at 18:30, 16 June 2013

2013-06-16T18:30:52Z

Paul at 18:25, 16 June 2013

2013-06-16T18:25:20Z

Paul at 14:45, 1 February 2013

2013-02-01T14:45:27Z

Paul at 23:05, 22 January 2013

2013-01-22T23:05:48Z

Paul at 00:37, 23 November 2012

2012-11-23T00:37:35Z

Show changes

Paul at 15:26, 22 November 2012

2012-11-22T15:26:42Z

Paul at 15:00, 22 November 2012

2012-11-22T15:00:44Z

Paul: /* Dynamic List Editor */

2012-11-22T03:26:54Z

‎Dynamic List Editor

Paul: Created page with "'''ClearQuest Dynamic List Editor''' Created by ClearQuest admin for ClearQuest admins. = Dynamic List Editor = It is NOT a solution that is provided and supported b..."

2012-11-21T21:00:07Z

Created page with "<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 b..."

New page

<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.

== 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

== 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]]

@@ Line 19: / Line 19: @@
 === Automatic Install ===
-* Unpack the distribution to your local or network drive (you cannot start the installation from a network share using UNC path)
+* Download the distribution to your local or network drive
-* Launch "install.bat" in the root of the distribution
+* Launch "setup.exe"
 * Accept license agreement
-* Provide administrative user credentials, ClearQuest connection, database name, and click on "Connect"
+* 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.

@@ Line 27: / Line 27: @@
 === Manual Install ===
-If you prefer to install the Editor manually, please follow the steps below
+You can install the Editor manually: [[ClearQuest_Dynamic_List_Editor_ManualSetup | Manual Setup ]].
-====  Apply Integration to ClearQuest Schema ====
+== Administering Dynamic Lists ==
-* Verify that the ClearQuest schema is checked in, and that there are no pending schema changes that have not been applied to the user database.
+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:Dynamic_List_Sync_3.png|center]]
-== Administering Dynamic Lists ==
+Most of the time, the "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration:
 {| class="wikitable"
 ! Action Name

← Older revision		Revision as of 14:45, 1 February 2013
Line 154:		Line 154:


−	[[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]	+
		+	[[Category:Rational]] [[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]

@@ Line 5: / Line 5: @@
 = 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. In addition, it adds basic audit capabilities that can be enhanced using Audit Trail package.
+Dynamic list editor is an add-on to your existing ClearQuest schema, VBScript or Perl based, that provides unified interface to administer Dynamic Lists for Windows, Eclipse, UNIX clients, and (most important) Web client. In addition, it adds basic audit capabilities that can be enhanced using 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.
@@ Line 15: / Line 15: @@
 == 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.
+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 ClearQuest Web or other ClearQuest clients.
 === Installing ClearQuest Schema Update ===
@@ Line 24: / Line 24: @@
 ====  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.
+* Verify that ClearQuest schema is checked in, and there are no pending schema 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
+* Open command line tool, (Start->Run "cmd") and change directory to the location where the integration package was extracted.
 * 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
+* Verify that the 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.
+Now, you can apply changes to the user database using ClearQuest Designer. For Eclipse 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. (In legacy Windows Designer, select "Upgrade Database..." option from the database menu and select your user database).
 [[File:upgrade_db.png|center]]
@@ Line 42: / Line 42: @@
 ==== 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.
+The rest of the configuration can be done from a ClearQuest client. You can use any client of your choice. In the instructions are based on ClearQuest Web client, version 8.0.
-Login as an administrator, and submit new record of the "Dynamic_List" type
+Login as an administrator (super user), 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.
+Select one of the list names from the "Name" drop-down list.
 [[File:Submit_Dynamic_List_2.png|center]]
-Dynamic list will be populated automatically.
+Dynamic list values 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.
+Now, you need to create a simple query that will be used by 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]]
@@ Line 66: / Line 67: @@
 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.
+Run "Dynamic Lists" query that we created on the previous step. You should see one Dynamic List record in the result set. Select the record, and in "Utilities" section, chose "SyncAllLists" action.
 [[File:Dynamic_List_Sync_1.png|center]]
@@ Line 87: / Line 89: @@
 == Administering Dynamic Lists ==
-When all Dynamic_List records are populated, List administrators can start using them to modify content of the correspondent dynamic lists. Most of the time, "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration process:
+When all Dynamic_List records are populated, List administrators can start using the query you created and Dynamic_Lists records to modify content of the linked dynamic lists. Most of the time, "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration:
 {| class="wikitable"
 ! Action Name
@@ Line 97: / Line 99: @@
 | Submit
 | Super User
-| Submit allows to create new records when new Dynamic List added to the schema. Alternatively, you can use "SyncAllLists" utility action to synchronize all records at once.
+| Submit allows to create new records when new Dynamic List added to the ClearQuest schema. Instead, you can use "SyncAllLists" utility action to synchronize all records at once.
 |-
 | Update
@@ Line 134: / Line 136: @@
 == Dynamic Lists Caching ==
-For performance, ClearQuest caches content of dynamic lists. When you update content of the dynamic lists using native tools, the updates are not available to all existing clients and sessions immediately. Your clients might need to re-login to the database in order to see them.
+In order to improve performance, ClearQuest caches content of dynamic lists. When you update content of the dynamic lists using native tools, the updates are 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.
-Dynamic list editor is using actual dynamic list as a primary trusted source of data for the records. When you initiate record update, the record content is loaded from the dynamic list first. In the environment when dynamic lists are actively updated from many clients simultaneously, it might cause changes overwriting, because cached values could be used instead. In so changing environment, it is recommended to re-login to the database before starting dynamic list modification (the same issue exist even when you are using native tools in the legacy ClearQuest Windows Client).
+Similarly, dynamic list editor is using actual dynamic list as a primary trusted source of data for the records. When you initiate record update, the record content is loaded from the dynamic list first. In the environment when dynamic lists are actively updated from many clients simultaneously, it might cause changes overwriting, because cached list values could be used by ClearQuest. In so changing environment, it is recommended to re-login to the database before starting dynamic list modification (the same issue exists when you are using native tools in the legacy ClearQuest Windows Client).
-If you rarely use native tools to update dynamic lists (for instance, when ClearQuest full client is not installed on Dynamic List Admins' machines, and they are using Editor's Web Client capability to modify lists only), you can select ClearQuest records as a trusted source of data for the dynamic lists. In order to do it, you need to remove "Update" action initialization hook of the Dynamic_List record type, and upgrade user database to apply changes.
+If you rarely use native tools to update dynamic lists (for instance, when ClearQuest full client is not installed on Dynamic List Admins' machines, and they are using Editor's Web Client capability to modify lists only), you can select ClearQuest records as a trusted source of data for the dynamic lists. In order to do it, you need to remove "Update" action initialization hook of the Dynamic_List record type, and upgrade user database to apply changes. It would ensure that most accurate data is used for lists modification.
 == Support ==