Access Work Item properties

The Document Sidebar provides the Work Item Properties sidebar, which enables you to edit data fields and access links of Work Items defined in the Document.

You can specify which Work Item fields appear in the Properties section of the panel. When the Properties panel is showing, click the icon (Pane Settings) icon and choose Select Fields on the menu. In the Select Fields dialog box, select the check boxes of the Work Item fields you want to be able to edit in the Document, and deselect those of fields that should not be shown there. You can also control the order in which the fields display in the panel by rearranging their order in the dialog box.

Some Work Item fields, both default and custom, may be configured as required fields. A value must be supplied in all required fields before a Work Item can be saved. When you mark a new Work Item in a Document, if any required fields are not among those shown in the Work Item Properties panel, then a default value is automatically and silently set for these fields. This default may or may not be what you actually want, so it is usually a good idea to make sure that all required fields appear in Work Item Properties panel of the Sidebar. You can easily see which fields are required by looking at any Work Item in the Table view of the Document. Fields marked with a red asterisk (s) are required fields. Be sure to check the Custom Fields section to see if any custom fields have been configured as required fields.

Tip:

All the fields of any Work Item can be edited in the Table view of the Document, which you can launch from the Document Editor toolbar. Remember also that you need user permissions that enable you to edit Work Items and Work Item fields in order to change Work Item properties in a Document.

  1. To access properties of a Work Item in a Document, click the Work Item's icon next to the left-hand margin of the Document Editor.

  2. On the menu that appears, choose Properties.

The Work Item Properties panel of the sidebar displays properties of the currently selected Work Item in the Document. The data fields of the selected Work Item appear in the Properties section. Changes to these fields do not take effect until you save the Document.

The Links section appears below the Properties section. It shows the items currently linked with the selected Work Item.

Locating referenced Work Items

Not all Work Items appearing in a Document are necessarily contained in it. Some may be contained in another Document and just referenced in the current one. If the currently selected Work Item is referenced from another Document, the Work Item Properties panel of the Sidebar contains the Documents section. That section lists the source Document — the one that actually contains the item, and in which it can be edited — plus all Documents that reference the Work Item. Names of Documents are clickable links that open the respective Documents in the Document Editor. For more information on referenced Work Items, see Branch Documents and Work Item Properties sidebar.

Tip:

If you find you cannot edit a Work Item, it may be referenced from a different Document. Check the Work Item Properties panel. If the item is referenced, you can only modify it in the source Document, and you must have the necessary permissions for editing Work Items and fields in that Document. If Work Item not a referenced one, and you cannot edit it, you most likely lack the necessary permissions for the current Document.