Tip:
Highlight text to annotate it
X
This is a demonstration of configuring IBM Rational ClearQuest to prefill OSLC V2.0 linked records.
The ClearQuest OSLC prefill feature enables automatic propagation of field data when creating
new linked records in OSLC V2.0 provider systems.
You can configure ClearQuest to prefill field values when opening the creation dialogs for associated OSLC V2.0 projects.
When a creation dialog displays, values for designated fields in the new record are
initialized using content from configured fields of the initiating ClearQuest record.
In this example, IP addresses are being used for illustrative purposes.
Normally, you use host names.
This configuration example consists of ClearQuest V8.0.0.4 with the "OSLC_Links" V1.2 package already installed.
Rational Team Concert (RTC) is at V4.0.1. Any other provider that supports prefill can be used.
An OSLC project relationship has already been defined between the ClearQuest V8.0
"SAMPL" database, and the RTC "testProj" project area.
The goal is for the defined fields such as Headline and Description to prefill into the RTC work items with a prefix so that these
records can be easily identified in a uniform manner on the RTC side when searching.
Log into ClearQuest Web using a web browser.
Go to "Site Administration", and then "Cross Server Communication".
This example illustrates that the Cross Server Communication trust relationship has already been established.
Now the equivalent example on the RTC side.
Under the "Communications" section go to "Consumers Inbound", and click it.
The first row on RTC side shows that the consumer key matches what is also seen on the ClearQuest side.
Go to the "Site administration", "Project Relationships" dialog.
Project relationships must be established to RTC. Only projects that are linked to it will be
available for the prefill capability. Another project relationship could be added at this time.
Before enabling the OSLC prefill capability, here are the default steps for creating
a new linked record. To create a new defect, select "New Defect".
Note the values for the headline description fields.
Save the Defect.
Then re-open the Defect. Modify it by going to: Add Link and Related Change Request.
Select Create New and then click OK.
The summary and descriptions fields has are not filled in. These fields have not been prefilled, so in this case they will be filled in manually.
Click OK.
Here is an example of being able to see the Rich Hover Dialog, and the ability to open the RTC client.
The entries made in the Summary and Description fields are the ones that where
manually entered earlier and are not prefilled.
Here is the "oslc-mappings.xml" file that controls the prefill capabilities.
Here are the two sections of the file to modify.
You must copy these two commented sections and modify them as required. This step is already performed for this example.
The changes have been commented out. Now the comments are removed and specific points reviewed.
Typically, the procedure is to copy the contents of the uncommented sections and paste them below, performing further modifications
as required. Review the key points of the key fill capability. Looking at the "oslcRecordConfig" section of the file,
this determines the record type and the "dbset" database properties of the prefill enabled record type. The mappings defined
in the "oslcRecordConfig" section have usage beyond the prefill capability.
These mappings are also applied for other OSLC operations such as OSLC query processing.
In this example, the configuration has enabled the defect record type, the "8.0.0" dbset, and the "SAMPL" user database.
Each "oslcRecordPrefill" section can contain up to two "oslcPrefillProperty" lines. Only "dcterms:title"
and "dcterms:description" are supported for pre- fill. Each field that will be prefilled must have an OSLC field mapping.
Note that "dcterms:title" and "dcterms:descripton"
are generic OSLC field names that are not specific to any OSLC provider.
OSLC providers map these generic terms
to actual field names in their systems. For example, RTC does not have an actual field named "dcterms:description".
In this example, the OSLC "dcterms:title" is mapped from RTC
to the Headline field in ClearQuest. The "dcterms:description" in RTC is mapped to the Description field in ClearQuest.
For each project relationship defined between ClearQuest and RTC, it is necessary
to identify which ClearQuest record types are enabled for this project. This is the purpose of the OSLC project prefill config section.
The key points of the information are the project name; in this case "testProj" which matches the name used in the RTC.
It supports prefillMarkup="true", indicating that the integration between these two products supports the Rich Text
editing capability. The OSLC provider application, in this case is RTC.
If setting up prefill between two ClearQuest repositories, set this to "false" as ClearQuest does not support the rich text as a provider.
As indicated previously, it is necessary to re- identify each record type that is enabled for this project.
You can also config the prefill properties as to whether or not there is a prefix.
This example shows the OSLC prefill for the Defect record type of the "8.0.0" SAMPL database.
For each field you must mention that it is "init eligible" for pre-fill within this project and whether or not there is a prefix.
In this example, there is the OSLC pre-fill property for the "dcterms:title" in RTC
and specification of a prefix with the ClearQuest headline prior to the content that will appear in the headline field.
Similarly, there is an OSLC pre-fill property for the "dcterms:description" in RTC which is
an example of a prefix that uses XHTML encoded rich text.
In this example, the ClearQuest description appears in bold and italic. You must save the file.
You must also restart the CM server for the changes to take effect. Go back to the defect previously created.
Make sure to save the record so the backlink is saved in the RTC record.
Then perform a modify action. This is to demonstrate the new pre-fill capability on the
prefill capability on the new RTC record creation.
Here the headline and descriptions are modified.
Go to the OSLC links tab and click to create a new related change request. The pre-fill capability has placed the
prefix of the ClearQuest headline prior to the ClearQuest headline field and placed this text into the RTC summary field as well.
The prefix of the ClearQuest description is in rich text bold and italic formatting, followed by the actual ClearQuest
description field content. The update is placed into the RTC description field.
All of this activity is part of the prefill configurations in the previous steps.
Use the open record link of the rich dialog to generate a RTC client.
Here you can make any changes that you need to.
Then you save the RTC record.
The other benefit of prefill is that you can uniformly encourage the use of keywords such as "ClearQuest".
You can search for the unique keyword in the RTC search to locate similar records.
At the top right where it says search work items, type in ClearQuest and press enter.
You will see the prefill records now, so consider using a unique keyword in your prefill.
Searching is one of the main reasons for defining a prefix for prefill operations.