The custom component options enable you to specify the criteria that the application uses to determine whether a component
has been read. You can also indicate how often the application should search for new components and how component locking
issues should be handled.
- Mark as read
-
- When <custom component> is selected
- Marks a <custom component> read as soon as you select it. An unread <custom component> is displayed with bold font. A read
custom item is displayed with regular font.
- When selected for ___ seconds
- Marks a <custom component> read after it has been selected for the specified number of seconds. The range is from 15 to 9999
seconds.
- Only when manually marked as read
-
Marks a selected <custom component> read when you choose
.
Note: Custom items are always marked as read when you display their properties.
- System tray notifications
-
- Check for new or modified custom items
- Checks for new or modified <custom component> at regular intervals and lets you know that you have become responsible for
new <custom component>. If this option is checked, you must also specify the number of minutes between checks in the Interval
option below. When unchecked, the application does not place an icon in the system tray for a new custom item.
- Interval (in minutes)
- Specifies the number of minutes between automatic checks for new or modified <custom component>. The default is 10 minutes.
- Locking
-
- Exclusively lock <custom component> during edit
- Locks a <custom component> when you open its
Properties dialog box for editing. If unchecked, the application does not lock <custom component> when you open its
Properties dialog box.
- Clear manually locked <custom component> after edit
- Unlocks a locked <custom component> after you have edited its properties, and clicked
OK to create a new revision. If unchecked, the application does not remove the locks.
- URL Options
-
- Display template
- Specifies a special template used to generate an HTML representation of an item when the item’s URL is copied to the Clipboard.
With no format, there is a default HTML representation that specifies the type of item and identifies it by name and number,
for example,
Custom Item #39,849. When the text is generated from the template, the specified property values are substituted for the variables in
~~*~~. The variables may be referenced by the same names used in report templates, as well as by the display name of the property.
When using the display name, you can omit spaces, and case will be ignored. For example, if you use the following sample template
for a file:
Custom Item:~~CI Number~~:~~CreatedBy~~, the HTML representation will be the
Custom Item:38,849:Tom Smith. This template is a superset of that used by the Report feature of the client.
- Generate ID-based URLs
-
Specifies the URL by ID rather than by name. For example, an ID-based URL would be
starteam://hostname:49201/12;ns=Project;scheme=id, while a namebased URL would be
starteam://hostname:49201/myproject.
Note: Folders always use an ID-based URL.
If you do not select either of the locking options, opening a custom item will not lock it; you must manually lock and unlock
it. If you select the
Exclusively Lock option only, custom items that are not already locked become locked when you open them and unlocked when you click
Cancel or
OK. If you select the
Clear <custom component> Locks option only, any custom component that you have locked manually becomes unlocked when you click
OK to create a new revision. If you select both options, you can lock custom components manually or by opening them. These custom
components become unlocked when you click
OK to create new revisions or (if they were not locked prior to being opened) when you click
Cancel.