To configure type attributes in the GUI
CLI EQUIVALENT
|
im createtype or im edittype
|
From the Create Type or Edit Type dialog box, selecting the Attributes node in the tree on the left displays attributes in the panel on the right.
Under General, you can permit the following:
• Display History in Item displays the item history for all items of the selected type. When the checkbox is cleared for a type, the item history is always hidden from users when they are viewing or editing items of that type. The setting applies in all Windchill RV&S client interfaces. For example, in the Windchill RV&S client GUI and Web interfaces, when you clear Display History in Item, the History tab is no longer shown for items of the selected type. By default, the item history is shown for newly created types.
|
You can also use the CLI (im edittype --[no]showHistory) to configure visibility of the item history.
|
• Display Workflow in Item displays the Workflow tab to the user in the Create Item, Edit Item, and Item Detail views. The tab also displays when copying an item and when creating a related item. The Workflow tab contains a read-only display of the item type workflow to the user.
|
Users of the Web interface do not have a client-side user preference to override the display of the Workflow tab. Users launching the GUI view from the CLI can override the display of the Workflow tab on a per command basis, if the tab is enabled for the type.
|
To display phases in the Workflow tab, select a phase field from the Phase Field list. Only phase fields that are enabled in the Visible Fields node appear in the Phase Field list.
• Under Type is hidden under menus, you can select Create Item, Create Related Item, or both of these checkboxes for a non-document item type, such as a defect or change request. Neither of these checkboxes is selected by default. You would select one or both of these checkboxes only if you wanted to hide the type from the respective menu and related dialog boxes.
For a document item type, such as a requirement document or test suite, these checkboxes are never enabled. Checkboxes specifically for hiding document item types from menus are available on the
Document Model node when either
Segment or
Node is selected as the role. For more information, see
Creating Document Types.
|
Hiding a type affects only the Windchill RV&S GUI and Web interfaces. It does not prevent creation of these items from the CLI and API.
|
Under Items of this type, you can permit the following:
• Allow Time Tracking allows one or more users to allocate time spent working on items of this type. When enabled, a Time Entries tab displays in the Edit Item and Item Detail views. You can use time entries to develop metrics (in the form of queries, charts, and reports) that measure the amount of effort spent on projects.
|
• To create, edit, and delete time entries on behalf of other users, the TimeTrackingAdmin ACL permission is required.
• The ability to create, edit, and delete time entries is governed by state-based capabilities.
|
• Back Projects enables the type to back a project, allowing you to create a link between an item of this type and a project in the
Project field. Backing a project with an item allows you to link the current project to a specific item that stores project metadata and metrics. For more information, see
Managing Metadata for Workflow and Document Projects.
|
• To make this checkbox available, the Project field must be selected as a visible field for this type.
• If you select Back Projects, creating items of this type and linking them to projects is useful only to certain users. If desired, you can prevent most users from being able to create items of this type. For example, you can allow only users in the ProjectManagers group to create Project items.
|
• May have their tree copied allows items of this type and all related items within the hierarchy to be copied. This checkbox is cleared by default. It is available primarily for the use of solution templates.
When this checkbox is selected, the Copy Tree Rule button is enabled. Clicking it displays the Edit Copy Tree Rule dialog box, which closely resembles the Item Editability dialog box.
• May be branched allows items of this type to be branched by users who have applicable project visibility based on the branching rules that you set up for item types. A branch is an identical copy of the original item and is added to the project history based on a current or historical date.
Branches are created when users want to begin new divergent work off of a current or historical version of an item. Additional information about what is visible to the user in the Windchill RV&S client after an item is branched is available in the user documentation for the client.
The checkbox for branching is cleared by default. It is available primarily for the use of solution templates.
When this checkbox is selected, the Branching Rule and Displayed Branch Fields button are enabled.
◦ Clicking Branching Rule displays the Edit Branch Rule dialog box, which closely resembles the Item Editability dialog box. The Edit Branch Rule dialog box allows you to define the rules for branching specific item types for users and user groups.
◦ Clicking Displayed Branch Fields displays the Columns dialog box. This dialog box provides for configuring the columns that you want to be visible on the Branches tab in the Item Detail view for items of the active type. If you do not configure custom fields for an item type, three default columns are shown:
▪ ID—The branch ID for a document that was branched from the active document.
▪ Branched Date—The date that the document was branched.
▪ Branched By—The user name for the person who branched the document.
In the Columns dialog box, you can select and order the columns that you want to be visible. Because only visible fields on the item type can be added, visibility permission is checked when you add a field. The Branches tab must have at least one visible field.
|
When using the CLI, you can use im createtype or im edittype with the --branchFields=field, field, ... option to configure the column set. You can use the --branchFields option with --visibleFields=field:group,group,...[;...] for each of these commands.
|
• May have labels applied allows items of this type to have labels applied.
Labels allow users to associate a name and comment with a specific point in time in an item's history. For example, you can apply a label to the end of a release, project milestones, or document baselines. This checkbox is cleared by default.
When an item or document contains labels, users can open the item or document historically as of a specific label. For more information about how to view an item or document historically as of a label, or what the user sees in the Windchill RV&S client after an item is labeled, see the user documentation for the client.
|
The label :head is a system-provided label that is applied to an item when the item type is enabled for item revisioning or document versioning. For more information, see the attribute May have revisions or May have versions later in this topic.
|
When you select this checkbox, the
Add Label Rule,
Move Label Rule, and
Delete Label Rule buttons are enabled. Selecting a button displays the corresponding
Edit Add Label Rule,
Edit Move Label Rule, or
Edit Delete Label Rule dialog box. For more information about how to define a rule using one of these dialog boxes, see
To define item editability for a type in the GUI.
• May have revisions allows items of this type to have revisions enabled.
Item revisions mark an unambiguous point in the history of an item. When viewing an item in Windchill RV&S, the revision provides an identifier into its history. Furthermore, if you export the same item to a partner using a report or through ReqIF, and they call you to discuss it, you are assured that any discussion of Item 123, revision 1.2, for example, is done with the exact same item definition and understanding.
This is also true for everyone with direct access to Windchill RV&S. When listing items, you have clear visibility to the item revision. As with the partner scenario, any internal communication through conversations, reports, or e-mail can include a specific revision to ensure all parties are using the same exact definition.
The revision identifier is numbered as a two-part decimal in the format major.minor, where the number to the left of the decimal point is the major revision, and the number to the right of the decimal point is the minor revision. The administrator defines the revision pattern for revision numbers by specifying values in workflow and document properties. For example, the default revision number sequence is 0.1, 0.2, 0.3, ... 1.0, 1.1, 1.2.
Each new revision increments the current revision number by one. For example, if the current revision is 1.2, after incrementing the minor revision, the revision is 1.3. After incrementing the major revision, the revision is 2.0.
|
Additional setup is required to use item revisioning. The administrator must permit field visibility for built-in fields enabled by this attribute, configure the revision number format, and define the rules and events that cause a revision increment. For detailed information, see Item Revisioning.
|
The checkbox for revisions is cleared by default. When you select this checkbox, the Major Revision Rule and Minor Revision Rule buttons are enabled. Selecting either of these buttons displays the Edit Add Revision Rule dialog box, which closely resembles the Item Editability dialog box.
These rules allow you to control when a user can increment the major or minor revision respectively. For example, you can define a rule that allows only a specific user or group to increment revisions.
|
Revision increments set to occur in a trigger script are exempt from these rules. For more information, see Item Revisioning.
|
If May have labels applied is selected for the type, then revisions display on the Labels tab in the GUI and Web. Each label displays the latest revision number as well as the date and time of the revision increment.
|
Revision labels cannot be manually added, moved, or deleted for any type that is enabled for revisioning.
|
• May have versions allows document model items of this type to have versions.
Versions are used to track the evolution of your documents through the project lifecycle. Users can create unique document versions at various stages of the project. Users create the new version by checking in a document or content item. Creating a document or content version provides an exact record of the document as it was at the time the check-in operation was performed and provides the information required for the specific project milestone.
The version identifier has the following format: Live Item ID-Major revision.minor revision. Examples of three subsequent versions follow: 7201-1.0, 7201-1.1, and 7201-2.0. A new version ID is displayed only when an item has been versioned. Live items continue to display their internal IDs with no revision information.
The checkbox for versions is cleared by default. When this checkbox is selected, the Major Revision Rule and Minor Revision Rule buttons are enabled. Selecting either of these buttons displays the Edit Add Version Rule dialog box. These rules allow you to control when a user can increment the major or minor version respectively. For example, you can define a rule that allows only a specific user or group to increment the major version.
|
To make the May have versions checkbox available, the type must first be defined as a document type and fill one of the following roles under the Document Model: Segment or Node.
|
• May be deleted, controlled by rule allows items of this type to be deleted, as defined by a rule. Users or groups defined in the rule require the ModifyDeleteItemRule permission to be able to delete items of this type.
|
The ModifyDeleteItemRule permission differs from the DeleteItem permission. The DeleteItem allows users or groups to delete items of any type without a defined rule. To define strict item deletion rules in your organization, you can define a delete item rule and assign the ModifyDeleteItemRule permission to the appropriate users and groups.
|
When you select this checkbox, the Rule for Delete Item button is enabled. Clicking this button displays the Edit Delete Item Rule dialog box, which closely resembles the Item Editability dialog box. The Edit Delete Item Rule dialog box allows you to define the rules for deleting specific item types for users and user groups.
To associate a custom icon image with the type, under Image select Use Custom Image and click Select to open a window in which you can browse for the image file. When you select an image for the type, it displays with the type. To have no image associated with the type, select No Image.
If you choose to use your own custom icon image, the image must be in GIF or JPEG format. The image can be no larger than 24 by 16 pixels.
In the Description field, you can type a descriptive statement about the type if desired.