Step 2: Set Up the AccuWork™ Schema

The field mappings in an AccuSync Configuration rely on fields defined in both the AccuWork schema and your ITS schema: if you want to synchronize the Status field in your ITS, there must be an equivalent and compatible field in AccuWork, regardless of its name (the equivalent field might be called State in AccuWork, for example). Further, the values for fields with a type of Choose must be defined in the respective schemas as well. For example, when you define a Project field with a type of Choose, you must also define the values that can be specified for that field (Acme, Windfall, and Gimble, for example). In AccuWork, the schema also controls which fields are displayed for an issue record.

In order to set up the AccuWork schema for use with AccuSync, you can either:

Description	When to Use	Go To
Use the default AccuWork schema for your ITS that was installed with AccuSync.	AccuRev recommends using the default AccuWork schema for your ITS if you are using AccuSync with a new AccuWork installation, that is, one without a pre-existing AccuWork schema.	Using the Default AccuWork™ Schema
Modify your existing AccuWork schema to incorporate fields required for synchronization.	Modify your existing AccuWork schema if you are upgrading from AccuBridge.	Modifying an Existing AccuWork™ Schema

Note: Regardless of whether you use the default AccuWork schema for your ITS or modify your current AccuWork schema, you must define values for your ITS projects and applications in your AccuWork schema. See Using Choose Type Fields for more information.

ClearQuest, HP QC, Rally, and Remedy users only: When you have finished setting up the AccuWork schema, you must add custom fields to your ITS schema for the AccuWork data you want to store and display in your ITS. See Step 4: Add AccuWork Fields to Your ITS Schema for more information.

Using the Default AccuWork™ Schema

The AccuSync installation includes a default AccuWork schema for your ITS located in \defaultAccuWorkSchema\its where you installed AccuSync (c:\Program Files (x86)\
AccuSync\defaultAccuWorkSchema\rally, for example). This AccuWork schema includes all the fields needed to synchronize AccuWork and ITS issues, as well as many fields that, while not required to support issue synchronization, are considered useful in most installations, like the Status field, for example.

To use the default AccuWork schema, simply copy the defaultAccuWorkSchema\its\dispatch directory to the \dispatch directory for any depot you plan to synchronize with your ITS:

•

Windows

xcopy <install>\defaultAccuWorkSchema\<its>\dispatch\* <storage>\depots\<depot_name>\dispatch /E

•

Linux

cp -r <install>/defaultAccuWorkSchema/<its>/dispatch
<storage>/depots/<depot_name>

Where:

•	<install> is the AccuSync installation root; c:\Program Files (x86)\AccuSync\, for example

•	<its> is the name of your ITS; rally, for example

•	<storage> is the AccuRev installation \storage directory; c:\Program Files (x86)\ AccuRev\storage, for example

•	<depot_name> is the AccuRev depot name; fiesta, for example

Note: Each AccuRev depot has its own AccuWork schema. You must copy the default AccuWork schema to every depot whose issues you plan to synchronize with your ITS.

What to Do Next

After you have copied the default AccuWork schema to each of the depots whose issues you want to synchronize with those in your ITS, you must create values for your project (or, in the case of Remedy, application) mapping group. Go to Using Choose Type Fields for more information.

Modifying an Existing AccuWork™ Schema

AccuRev recommends that you use the default AccuWork schema for your ITS that is included in your AccuSync installation, as described in Step 2: Set Up the AccuWork™ Schema. However, users upgrading from AccuBridge might prefer to make changes to their existing AccuWork schema, as described in this section.

Required Changes

If you modify an existing AccuWork schema to support synchronization with your ITS, you need to:

1.	Create fields in the AccuWork schema to store ITS data. You create new fields using the Schema tab of the AccuWork Schema Editor. See Create Fields in the AccuWork™ Schema for more information.

2.	Add fields to the AccuWork Issue Edit form to display ITS data. You add display fields using the Layout tab of the AccuWork Schema Editor. See Add Fields to the AccuWork™ Issue Edit Form for more information.

For more information on working with the AccuWork schema, including detailed procedures for using the AccuRev Schema Editor, refer to your AccuRev user documentation.

Create Fields in the AccuWork™ Schema

You use the Schema tab in the AccuWork Schema Editor to create new fields in the AccuWork issue database:

Refer to your AccuRev user documentation for more information on using the AccuWork Schema Editor.

The following tables summarize the fields you must create in the AccuWork schema for supported ITSs. These are the minimum fields required for AccuSync to synchronize issues with your ITS. Consider creating other fields in the AccuWork schema as needed. For example, you might want to create a state field with a type of Choose whose values are Defined, In-Progress, Completed, and Accepted, for example.

Tip: The Label column has been left empty; consider using it to record the name you plan to use for the field’s label in the AccuWork Issue Edit Form, as described in Add Fields to the AccuWork™ Issue Edit Form. When defining the field Label, consider using the system name with which you are synchronizing as part of the name to remove any ambiguity -- JIRA Issue ID, for example.

ClearQuest

The following table identifies the Rational ClearQuest (ClearQuest) field types and describes how each field is used by AccuSync. New fields must use the name and type shown here.

Field Name	Label	Type	Description
cqKey		Text	Stores the ClearQuest issue key (SAMPLE00000048, for example) of the request or task associated with the AccuWork issue. Note: If you are currently using AccuBridge, note that the name of the ClearQuest key field has changed.
cqLink		Attachments	Stores the URL that AccuWork users can use to launch a web browser and access the issue in ClearQuest. Note: If you are currently using AccuBridge, note that the name of the ClearQuest issue link field has changed.
securityPolicy		Text	Stores the security policy associated with the change request (Everyone, OpenUP Security, and so on).

BMC Remedy

The following table identifies the minimum fields required to create incident records in BMC Remedy.

Field Name	Label	Type	Description
remedyKey		Text	Stores the incident issue key (INC_CAL_1000004, for example) of the issue associated with the AccuWork issue.
remedyLink		Attachment	Stores the URL that AccuWork users can use to launch a web browser and access the issue in BMC Remedy.

Note that required fields can be customized and will vary based on application type. Consult your BMC Remedy administrator for the fields required for your implementation, and then create at least those mappings in your BMC Remedy configuration.

Rally

The following table identifies the Rally field types and describes how each field is used by AccuSync. New fields must use the name and type shown here.

Field Name	Label	Type	Description
rallyID		Text	Stores the Rally Formatted ID (DE239 or US481, for example) of the artifact associated with the AccuWork issue.
rallyObjectID		Text	Stores the unique Rally alphanumeric key for each issue record. Do not confuse this field with issueNum, which uniquely identifies the issue record at the AccuWork level.
rallyIssueLink		Attachments	Stores the URL that AccuWork users can use to launch a Web browser and access the artifact in Rally.
Workspace		Choose	Stores the name of the Rally workspace the issue is associated with.
Project		Choose	Stores the name of the Rally project associated with the Rally workspace.   Note: In Rally, multiple nested projects may have the same name. For example, Project_1 may contain child project Project_ABC and Project_2 may also contain a child project named Project_ABC. For nested projects having the same name as other nested projects, specify the full pathname for the project, using the pipe character.   For example: Project_1|Project_AB C Project_2|Project_AB C

JIRA

The following table identifies the JIRA field types and describes how each field is used by AccuSync. New fields must use the name and type shown here.

Field Name	Label	Type	Description
jiraKey		Text	Stores the JIRA issue key (WEB-01, for example) of the issue associated with the AccuWork issue. Note: If you are currently using AccuBridge, note that the name of the JIRA key field has changed.
jiraIssueLink		Attachments	Stores the URL that AccuWork users can use to launch a web browser and access the issue in JIRA. Note: If you are currently using AccuBridge, note that the name of the JIRA issue link field has changed.
jiraProject		Choose	Stores the name of the JIRA project associated with the AccuRev depot. Note: Make sure to specify values for your JIRA projects. See Using Choose Type Fields for more information.
type		Choose	Stores the values of JIRA issue types: Bug, New Feature, Task, and Improvement, for example. Note: If the type field is already defined in your AccuWork Schema, make sure it is of the type Choose and that values for the field have been specified.

HP Quality Center

The following table identifies the HP Quality Center (HP QC) field types and describes how each field is used by AccuSync. New fields must use the name and type shown here.

Field Name	Label	Type	Description
hpKey		Text	Stores the HP QC issue key (214, for example) of the issue associated with the AccuWork issue. Note: If you are currently using AccuBridge, note that the name of the HP QC key field has changed.
hpLink		Attachments	Stores the URL that AccuWork users can use to launch a web browser and access the issue in HP QC. Note: If you are currently using AccuBridge, note that the name of the HP QC issue link field has changed.

Using Choose Type Fields

Generally speaking, it is best to use the Choose type for fields that have pre-defined values, even if those values change from time to time. For example, you might have a Project field whose values change every release cycle -- Acme_2.5, Acme_2.6, Acme_3.0, for example. While you might be inclined to create the Project field using the Text type to avoid periodically updating the AccuWork schema, you should consider using the Choose type to eliminate the opportunity for user error -- acme_2.5 and Acme_2.5 are considered different values because AccuSync is case-sensitive, for example. This recommendation is especially true in environments that take advantage of AccuSync’s two-way synchronization.

When creating a Choose type field -- for Project or Status, for example -- remember to also create the values for those fields.

Refer to your AccuRev user documentation for more information on using the AccuWork Schema Editor.

Add Fields to the AccuWork™ Issue Edit Form

After you have created fields in the AccuWork schema for your ITS, decide which of these fields you want to display on the AccuWork Issue Edit form. Then, use the Layout tab of the AccuWork Schema Editor to add those fields to the AccuWork Issue Edit Form, as shown in the following illustration:

Refer to your AccuRev user documentation for more information on using the AccuWork Schema Editor.

What to Do Next

After you have modified your existing AccuWork schema to support synchronization, you should refresh the AccuSync Configuration to ensure that it is using your changes

Refreshing the AccuSync Configuration

If you update the AccuWork schema after you have created an AccuSync Configuration for a depot that uses that schema, you must refresh the AccuSync Configuration to make it aware of those changes. 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.