Context-Sensitive Help > Fields > Custom Field Detail (General Tab)

Custom Field Detail (General Tab)

Defines or modifies custom fields. See Custom Fields.

Fields

Name: The name of the custom field (up to 30 characters).

Marked for Delete: If unchecked, the item is active. If checked, marks the item for deletion.

XTRAC deletes the item during the nightly batch cycle after there are no dependencies. Selecting an item and clicking Delete on the summary window also marks the item for deletion. Before the delete occurs, you can uncheck this option if you change your mind.

Note: The Marked for Delete check box is available only after an item is created.

Description: Additional information about the custom field (up to 60 characters).

Note: This description displays as the field label in XTRAC Workbench.

Data Type: The type of data that the custom field can contain. For example, character, numeric, or Boolean. See Custom Field Data Types.

Display Mask: A characteristic that determines how values for a data type display to the operator. For example, for a Boolean custom field, you can set up a display mask that lists Yes and No.

Length: The length for the custom field. You must specify a maximum length if the display mask requires it. You also can specify a shorter maximum length than the default. Some length fields are not editable.

Shared Between Split-Linked Items: Whether the custom field is shared between split-linked items:

Checked: If the value changes in a work item that belongs to a split family, XTRAC updates this value on all of the work items that belong to the same split family. The work item data is shared.
Unchecked: The value is not updated for the other work items in the split family. The work item data is not shared.

Sensitive: Values in this custom field are not sent to systems outside XTRAC. For example, if an external monitoring tool sends feeds from XTRAC, data in this custom field is not sent.

This field is not available when you select the Hyperlink data type.

Note: Fields that are marked as sensitive cannot be used in the action for a hyperlink field. They can be used in the condition.

Monitored: Whether this custom field is monitored by the XTRAC business activity monitoring tool.

This field is not available when you select the Hyperlink data type.

Metadata: Whether this custom field is a metadata field that was created in XTRAC or a system outside of XTRAC. For example, Documentum. You can select this option only for custom fields (not predefined fields).

Note: There is no direct tie between XTRAC and any other system where metadata fields were defined.

External Field: Whether data for this field is obtained from a source outside XTRAC.

This field is not available when you select the Hyperlink data type.

External Service for Retrieve: If the field is defined as an external field, the external service to call to retrieve data for this custom field. See External Services.

External Service for Update: If this field is defined as an external field, the external service to call to pass the value of this field to and update the value. See External Services.

Exception Policy: If this field is defined as an external field, the exception policy to trigger when data for this custom field cannot be retrieved. See Exception Policies.

Help Text: The text that displays in a tooltip when the operator hovers their mouse over the field in the work item (up to 360 characters).

Valid Values: If the data type is Value Group, the list of values for the custom field. See Adding Values to a Custom Field.

The list consists of a name and description for each value and whether the value is marked for delete. You enter a new valid value by clicking in the empty row at the bottom of the list. You can enter up to a 60-character name and a 60-character description.

Change Request ID: The ID of the request to create or modify this XTRAC record (up to 30 characters).

Memo: The reason why this XTRAC record was created or modified (up to 60 characters).

Buttons

History: Displays the history of the component, including the following details:

Admin group of the operator that created or updated the component.
Date and time of the creation or update.
Event that occurred.
ID of the operator.
IP address and machine name of the machine where the change was made.
Change Request ID and Memo explaining why the component was created or updated.

Save: Saves the changes that you made in this window.

Close: Closes this window.

If you made changes in the window and have not yet clicked Save, a warning displays that all of your changes will be lost. Click Yes to close the window and discard any changes. Click No to return to the window so you can save any changes.