Step 4: Add AccuWork Fields to Your ITS Schema

Once you have modified AccuWork as described in the preceding steps, you need to:

•	Add the AccuWork fields in the following table to your ITS schema

•	Ensure that these fields are not editable by your ITS users wherever they are displayed

Specific procedures vary from one ITS to another, but they typically involve adding a custom field to the ITS schema and then making that field read-only or hidden in views that allow users to modify other fields (like Description or Comment, for example). Custom fields added to your ITS schema must use the field name and type shown here:

Field Name	Label	Type	Description
AccuWorkKey		Text	Stores the unique alphanumeric key for each AccuWork issue record.
AccuWorkIssueLink		Attachment	Stores the URL that your ITS users can use to open a web browser and display the artifact in the AccuRev Web UI.
AccuWorkChangePackage		Text	Stores summary AccuWork issue change package information.
AccuWorkChangePackageHistory		Text	Stores detailed AccuWork issue change package information.

Tip: The Label column has been left empty. Consider using this column to record the name you plan to use for the field’s label when displaying issue record data in your ITS.

The following sections describe considerations for each ITS supported by AccuSync.

All ITSs: Refresh the AccuSync™ Configuration

If you update your ITS schema or forms after you have created an AccuSync Configuration, you must refresh the AccuSync Configuration. You do this by clicking the Reload Configuration Cache button () on the AccuSync Management Console main page. See Making Changes to AccuSync™ Configurations for more information.

BMC Remedy Users

You must add the fields in the preceding table to the “create” and “read” forms for whatever Remedy applications you plan to synchronize with AccuWork. For example, if you are synchronizing the Incident Management application, you need to add these fields to the HPD:IncidentInterface_Create and HPD:IncidentInterface forms. Note that the value of the Entry Mode property for the AccuWorkKey field must not be Display on either form.

BMC Remedy users must use BMC Remedy Developer Studio to add required fields to the Remedy schema. Refer to your BMC Remedy Developer Studio documentation for more information.

ClearQuest Users

You must add the fields in the preceding table to the ClearQuest schema to enable synchronization between AccuWork and ClearQuest. The basic procedure is outlined here. Refer to your Rational ClearQuest documentation for more information.

1.	Using the ClearQuest Designer, log in to your schema repository.

2.	Check out the ALM schema.

3.	Add the fields to the required type (ALMRequest and ALMTask) as needed.

4.	Add the fields to the ClearQuest forms as needed.

5.	Save your changes, and then validate and check in the schema.

6.	Update the ClearQuest database with the new schema.

7.	Stop and start these ClearQuest services. For example:

•	IBM HTTP Administration for WebSphere ApplicationServerV8.5

•	IBM HTTP ServerV8.5

•	IBM WAS85 Service

Synchronizing Custom Fields

The fields described in the preceding table are required for AccuSync to successfully synchronize AccuWork issues with ClearQuest requests and tasks. See Appendix E: IBM Rational ClearQuest Configuration Reference to learn about the fields that are synchronized by the default ClearQuest configuration (Owner, Description, and so on).

In addition to the required and default configuration fields, AccuSync allows you to create and synchronize up to 30 additional fields, called custom fields. You follow the same basic process for adding custom fields that you use for adding required fields, with these exceptions:

•

Custom fields have required names. Due to limitations in the ClearQuest API, custom fields must adhere to a strict naming convention in order to be recognized by the synchronization engine. You can name these fields however you like in the AccuWork schema, but in ClearQuest they must be created as “customField1”, “customField2”, “customField3” and so on, and cannot exceed “customField30”. Note that these names are case-sensitive.

•

Custom fields must be added to the AccuWork schema. Once you create a custom field in ClearQuest, you need to add the corresponding field to the AccuWork schema and the issue form as described in Modifying an Existing AccuWork™ Schema. For example, if you add “customField1” to ClearQuest to store a customer name, you might add an “Interested Customer” field to the AccuWork schema to allow this value to be synchronized.

•	Custom fields must be added to AccuSync field mappings. The custom fields you create in ClearQuest must be added to an AccySync field mapping, to associate the custom field with a corresponding field in AccuWork. See Editing Field Mappings for more information.

Rally Users

In order to support issue synchronization with Rally, you must add the fields in the preceding table as custom fields. Once you have defined these custom fields, you can choose to display them in the Rally work product as desired, but they should be read-only. You must add these AccuWork fields for each Rally artifact -- defect, task, and story -- you are synchronizing with an AccuWork issue type.

You use the Work Products & Fields Summary View to modify the Rally work product:

See your Rally documentation for more information on modifying the Rally work product.

JIRA Users

AccuWork fields are automatically added to JIRA when you install the JIRA plugin. They appear on the JIRA View Custom Fields page only after AccuSync has performed a synchronization task. You need to ensure that these fields are not editable. There are a number of ways to accomplish this, including making the fields read-only, hiding the fields, or creating an edit screen that does not display them. This last approach is described here. Refer to your JIRA documentation for more information.

To remove AccuWork fields from the edit screen in JIRA, you need to:

•	Create a custom screen that does not include AccuWork fields

•	Associate that screen with the JIRA Edit operation

To create a custom screen in JIRA:

1.	Log in to JIRA as the JIRA administrator.

2.	Click the Administration tab in the top navigation bar, then choose Issue Fields > Screens from the left navigation bar.

The View Screens page appears.

3.	Make a copy of the Default Screen:

a.	Locate the Default Screen and click Copy in the Operations column.

b.	On the Copy Screen page, enter a name for the new screen. (Edit Issue Screen, for example.) You can enter an optional description.

c.	Click Copy to create the new screen.

4.	Locate the new Edit Issue Screen and click Configure in the Operations column.

The Configure Screen page appears.

5.	Locate the AccuWork fields, select the Remove check box for those fields, and click the Remove button at the bottom of the form.

Now you are ready to associate the new Edit Issue Screen with the JIRA Edit operation

1.	Click the Administration tab in the top navigation bar, then choose Issue Fields > Screen Schemes from the left navigation bar.

The View Screen Schemes page appears.

2.	Locate the Default Screen Scheme and click Configure in the Operations column.

The Configure Screen Scheme page appears.

3.	Complete the fields in the Add Issue Operation To Screen Association section as follows:

•	For the Issue Operation field, choose Edit Issue.

•	For the Screen field, choose the edit issue screen you created in the previous procedure.

4.	Click Add.

The new screen appears in the Configure Screen Scheme table:

HP QC Users

You must add the AccuWork fields to your ALM projects as user-defined fields. You can do this using the Quality Center Project Customization.

1.	Log in to HP QC as the administrator.

2.	Choose Tools > Customize from the Quality Center menu.

3.	Choose Project Entities from the navigation bar.

The Project Entities page appears.

4.	Expand the Defect folder and then select the User Fields folder.

5.	Click the New Field button.

6.	In the Settings tab, specify the values for the field you are adding.