Windchill RV&S 12.3.1.0 Help Center
What's New in Windchill RV&S 12.3.1.0
Release Highlights: Windchill RV&S 12.3.1.0
Getting Started
Client Installation
Installing Windchill RV&S Client
Before Installing the Windchill RV&S Client
Installing With Previous Windchill RV&S Client Installation
Installing Windchill RV&S Client From DVD
Making the Windchill RV&S Client Available to Users for Installation
To set up the Windchill RV&S client so users can install it from a shared network location
Installing Windchill RV&S Client From Shared Network Location
To install the Windchill RV&S client from a shared network location
Improving Windchill RV&S Client Performance Over Network
Windchill RV&S Client Installation Wizard
Installing Windchill RV&S Client Using Silent Install
Configuring the Windchill RV&S Client Properties File
Installing Multiple Windchill RV&S Clients on a Single Machine
To install multiple Windchill RV&S clients on a single machine
Windchill RV&S Client Post-installation Considerations
Configuring Environment Variables for Linux
Uninstalling the Windchill RV&S Client
To uninstall the Windchill RV&S client on Windows
To uninstall the Windchill RV&S client on Linux
Updating the Windchill RV&S Client
Starting the Windchill RV&S Client
Before You Start the Windchill RV&S Client
Windchill RV&S Client System Tray Icon
Quitting a Windchill RV&S Client Session
Logging Out of the Windchill RV&S Client
To log out using the GUI
To log out using the Web interface
Closing the Client
Shutting Down the Client
To shut down the Windchill RV&S client in the GUI
Logging In to the Windchill RV&S Client
To log in using the GUI
To log in using the Web interface
Changing Your MKS Domain Password
To change your MKS Domain password
Understanding Access Permissions
Workflow and Document Management Access Permissions
Configuration Management Access Permissions
To view ACLs in the GUI
To create ACLs in the GUI
To delete ACLs in the GUI
Viewing Resolved Member Permissions
Viewing Resolved Project Permissions
Managing ACL Permissions in the GUI
Adding Principals in the GUI
Changing Permissions in the GUI
Deleting Principals in the GUI
Copy Project Permissions
To Copy Project Permissions
Copy Project Permissions Scenarios
Manage Project Restrictions
To Manage Restricted Projects
Enabling / Disabling Integrations
Setting Up Windchill RV&S Help
To set up a default server connection for the Windchill RV&S server and online help
Finding Your Windchill RV&S Customer Number
Choosing Your Work Environment
Windchill RV&S Client Graphical User Interface
Managing Views
To print views in the GUI
Quick Access Keys
Customizing Shortcut Menus
To customize a shortcut menu in the GUI
Configuring Toolbars
Windchill RV&S Client URL Links
Defining Custom Actions
To define a custom action for a ViewSet in the GUI
Environment Variables (GUI)
Workflows and Documents Web Interface
Bookmarking Views
Optimal Browser Settings
Configuration Management Web Interface
Optimal Browser Settings
Visual Difference/Visual Merge Interfaces
Visual Difference Modes
Hiding Unchanged Text in Visual Difference
Displaying a Specific Line of Code
Finding Text
To find text in the Visual Merge interface
Printing Views
Setting Preferences
To set general preferences in the Visual Difference/ Visual Merge interface
To set font and color preferences in the Visual Difference /Visual Merge interface
Command Line Interface
Viewing User Interface in Your Locale
Setting Client Preferences
Command Preferences
To set command preferences in the GUI
Connection Preferences
To set connection preferences in the GUI
To configure proxy preferences in the GUI
To configure proxy preferences in the CLI
Difference and Merge Tool Preferences
To set difference and merge tool preferences in the GUI
Editor Preferences
To set editor preferences in the GUI
General Preferences
To set general preferences in the GUI
To set general workflow and document preferences in the GUI
Shutdown Preferences
View Preferences
To set view preferences in the GUI
Non-Member Files Filter Preferences
Grouping Tasks by Role in ViewSets
Understanding ViewSets (GUI)
Creating a ViewSet
To create a ViewSet in the GUI
Customizing a ViewSet
To customize a ViewSet in the GUI
ViewSet Actions (Menus)
To customize ViewSet actions in the GUI
ViewSet Toolbars
To customize ViewSet toolbars in the GUI
ViewSet Views (Docking Location)
To configure the docking location of a ViewSet view
ViewSet Attributes
To configure attributes of a ViewSet
Importing a ViewSet
To import a ViewSet in the GUI
Opening a ViewSet
To open a ViewSet in the GUI
Navigating Views in a ViewSet
To navigate views in a ViewSet
Closing a ViewSet
To close a ViewSet in the GUI
Deleting a ViewSet
To delete a ViewSet in the GUI
Switching to a ViewSet
To switch to a ViewSet in the GUI
Restoring a ViewSet
To restore a ViewSet in the GUI
Backing Up a ViewSet
To back up a ViewSet in the GUI
Common Windchill RV&S Operations
Filtering Data
Data Filter: User Interface Components
To filter data
Working With Favorites
To configure an object as a favorite or non-favorite
Viewing Windchill RV&S Server Alert Messages
Operator Fields
Filtering Members
Error Codes
Entering Project Paths
Display Patterns
To specify a display pattern
Defining Rules
Rule Format
Working With Conditions
To create a condition involving field values
To create a condition involving user groups
To create a condition involving type properties
To create a pre-condition associated with a document
To replace an existing condition with a new one
Selecting Rules
To select a rule in the GUI
Customizing Columns
Sorting Columns
Viewing Active Commands
For Your Reference
Windchill RV&S Icons
Common Icons
Windchill RV&S Server Icons
Windchill RV&S Administration Client Icons
Workflow and Document Icons
Configuration Management Project Icons
Sandbox Icons
Sandbox Member Icons
Test Management Icons
Document Versioning Icons
Document Locking Icons
User Help
Tracking Changes With Windchill RV&S Items
What Are Items?
What Are Item Relationships?
Relationship Field Behavior
Cycle Detection
Items View: Managing Items
Displaying the Items View
Configuring the Items View (GUI)
Viewing Item Details
To view item details
Drag-and-Drop Operations for Items (GUI)
Searching for Items
Enhancing a Text Search for Items Using Operators
To search for text using a project filter (GUI only)
Finding Duplicate Items
Finding Potential Duplicates When Creating an Item
To search for potential duplicates when creating a new item
Identifying Existing Duplicates in the Windchill RV&S Database
To identify existing duplicates
Using Project Filters in the Items View (GUI)
To use project filtering in the GUI
Filtering Items
User Interface Components
Quick Reference
Creating an Item
To create an item
Working With Field Types
Working With Rich Content Fields
To insert rich content in a long text field
Working With Related Item Fields
Working With Attachment Fields
Working With Source Link Fields
Providing an Electronic Signature for an Item
Working With Rich Content
Formatting and Editing Text
Inserting Lists
Inserting Images
Inserting Links
Inserting Tables
Inserting Special Characters (GUI and DocStudio Only)
Inserting OLE Objects (GUI Only)
Insert <Rich Content Object>/Link Properties Window (GUI)
Copying and Pasting Rich Content
Supported HTML in Rich Content Fields
Editing Items Inline (GUI Only)
Editing an Item
To edit an item
Configuring the Edit Item View
Editing Items in Microsoft Word
Word Editor Prerequisites
Starting the Word Editor
To edit items in Word
Using the Word Editor
Batch Editing Items
To batch edit multiple items
Resolving Conflicts When Editing an Item
To resolve conflicts when editing an item
Working With Item Change Packages
Working With Item Labels
Revisioning an Item
To increment the revision for an item (GUI only)
Copying an Item
To copy an item
Viewing a Historical Item
Relationships View: Viewing Item Relationships
To display the Relationships view in the GUI
To display the Relationships view in the Web interface
Working With Items in the Relationships View
Configuring the Relationships View
To configure the view components and item information in the GUI
To configure the Relationships view in the GUI
To configure the Relationships view in the Web interface
Printing an Item
Receiving E-mail Notifications About Items
To set e-mail notification in the GUI
To set e-mail notification in the Web interface
Recording Effort With Time Entries
Time Entries View: Managing Time Entries
Creating a Time Entry
To create a time entry
Select User Dialog Box
Editing Time Entries
Viewing Time Entries
Creating Custom Fields and Specifying Custom Field Values
What are Custom Fields?
Custom Fields Pre-Requisites
Creating Project Backing Items
Defining Project-Specific Custom Fields
What are Custom Field Values?
Specifying Custom Field Values
Known Limitations of Custom Fields and Custom Field Values
Linking and Tracing Between Members and Items
Source Link Fields: Overview
Difference Between Source Links and Source Traces
Prerequisites
Using Source Traces for Safety Compliance
Source Traces Data Model
Source Link Fields: User Interface Components
Source Link Fields: Quick Reference
Source Traces: Use Cases
Source Traces: Best Practices
Tracing to the Current Member Revision
Operations That Do Not Update Source Traces
Procedure for Performing Operations That Do Not Update Source Traces
Tracing to Variant or Build Projects
Displaying Items Meeting Specific Conditions
What Is a Query?
Queries View: Managing Your Queries
To display the Queries view
Query Definition View
Query Builder
Query Filters
Grouping Query Filters
Creating a Query
To create a query in the GUI
To create a query in the Web interface
Query Properties
Query Filters: Key Considerations
Query Filter Options
Editing a Query
To edit a query
Running a Query
To run a query
Copying a Query
To copy a query
Deleting a Query
To delete a query
Exporting Query Results to Microsoft Excel
Displaying Item Data Graphically
What Is a Chart?
Charts View: Managing Charts
Chart Definition View
Creating a Chart
To create a distribution chart
To create an item fields chart
To create a trend chart
To create an item fields trend chart
To specify a graph for a chart
To specify table graph style options
Detailed Chart Examples
Chart Dialog Box: General, Sharing, Query, and Project Filter Tabs
Chart Dialog Box: Graph Tab
Chart Dialog Box: Axes Tab
Chart Dialog Box: Legend Tab
Distribution Chart: Add Expression or Edit Expression Dialog Box
Item Fields Chart: Add Expression or Edit Expression Dialog Box
Item Fields Trend Chart: Add Expression or Edit Expression Dialog Box
Select Color Dialog Box
Editing a Chart
Running a Chart
To run a chart in the GUI
To run a chart in the Web interface
Copying a Chart
Saving and Printing a Chart
Deleting a Chart
Viewing Item Data in Reports
What Is a Report?
Reports View: Managing Reports
Report Definition View
Creating a Report
To create a report
Report Wizard: Segment Attributes Panel
Report Wizard: Group By Panel
Report Wizard: Sort By Panel
Report Wizard: Field Computations Panel
Report Wizard: Change Package Type Panel
Report Wizard: Change Package Attributes Panel
Report Wizard: Change Package Entry Attributes Panel
Report Wizard: Attachment Fields Panel
Report Wizard: Attachment Attributes Panel
Report Wizard: Test Result Fields Panel
Report Wizard: Test Step Results Panel
Report Wizard: Test Result Attachment Attributes Panel
Report Wizard: Test Result Related Items Panel
Report Wizard: Time Entry Fields Panel
Report Wizard: Relationship Fields Panel
Report Wizard: Relationship Filter Panel
Report Wizard: References Panel
Report Wizard: History Panel
Add Expression or Edit Expression Dialog Box
Format Layout for field name Dialog Box
Report Wizard
Editing a Report
Copying a Report
Running a Report
Saving and Printing a Report
Deleting a Report
Reporting on Items Using Item Reports
Running a Report on Selected Items
Running a Historical or Differences Report
To run a historical report
To run an item differences report
Viewing Project Data in Dashboards
What is a Dashboard?
Designing a Dashboard
Dashboard Definition View
Dashboard Layout Designer: User Interface Components
Dashboards View: Managing Dashboards
Creating a Dashboard
To create a dashboard
Dashboard Properties
Dashboard Chart Properties
Dashboard Label Properties
Dashboard Image Properties
Dashboard Layout Properties: General Tab Fields
Dashboard Layout Properties: Default Text Styles Tab Fields
Dashboard Layout Properties: Default Grid Table Fields
Dashboard Layout Properties: Default Cell Tab Fields
Dashboard Query Link Properties
Dashboard Report Properties
Dashboard URL Properties
Dashboard Layout Properties: Text Styles Tab Fields
Editing a Dashboard
Running a Dashboard
Copying a Dashboard
Deleting a Dashboard
Creating a Dashboard in XML
Performing Calculations Between Fields
Working With Documents
What Is a Document?
Understanding Document Structure
Relationships in the Document Model
Document View
Specifying Column Context
Configuring the Document View
Configuring General Options for the Document View
Configuring Editing Options for the Document View
Configuring Message Options for the Document View
Configuring Title Options for the Document View
Configuring Color Options for the Document View
Select View
Searching a Document
Document Finder
Working in the Document View
Creating a Document
To create a document in the GUI
Creating a Document From a Template
To create a new document using an existing document as a template from the GUI:
Modifying a Document
Using Single-Row Editing
Using Multiple-Row Editing
Turning Multiple-Row Editing On and Off
Making Edits During Multiple-Row Editing
Showing and Understanding Pending Deletes During Multiple-Row Editing
Undoing and Redoing Edits During Multiple-Row Editing
Restoring All Field Edits on an Item During Multiple-Row Editing
Saving Changes During Multiple-Row Editing
Discarding Unsaved Changes During Multiple-Row Editing
Recovering Unsaved Changes Made During Multiple-Row Editing
Resynchronizing Documents During Multiple-Row Editing
Resolving Edit Conflicts After Resynchronizing
Resolving Delete Conflicts After Resynchronizing
Reading Information Messages After Resynchronizing
Deleting a Node that Has an Edit Conflict After Resynchronizing
Restoring Field Edits on an Item After Resynchronizing
Restoring a Deleted Item After Resynchronizing
Summarizing Assumptions and Rules for Resynchronizing
Assumptions and Rules for Resynchronizing for Client-Side Insert Operations
Assumptions and Rules for Resynchronizing Client-Side Move Operations
Assumptions and Rules for Resynchronizing Client-Side Delete Operations
Assumptions and Rules for Conflict Manipulation After Resynchronizing
Troubleshooting During Multiple-Row Editing
Opening a Pending Import for Multiple-Row Editing
Adding Content to a Document
To insert a row or content item
To insert a new or existing segment into a document from the GUI
To insert an open segment into a target document as a reference from the GUI
To insert an existing node in another document into an open document from the GUI
To include a new or existing segment into a document from the GUI
To include an open segment into a target document from the GUI
Viewing and Editing Document and Content Items
Modifying Content
Copying Content
To copy content in the GUI
To copy multiple content items in the GUI
To copy content within and between documents for the purposes of reuse
To copy historical content in the GUI
Restructuring Content in a Document
To move content in the Document view
To delete a row or section
Changing the Reference Mode
Toggling a Subsegment Reference
Editing Content in Microsoft Word
To edit content in Word
Windchill RV&S Document Functionality in the Word Editor
Resolving Edit in Word Structure Conflicts
Document Conflict Options
Operations That May Cause Conflicts
Possible Conflicts and Their Resolution
Bookmarking and Cross-Referencing Documents
To add a bookmark (GUI only)
To add a cross-reference (GUI only)
To edit a bookmark (GUI only)
To edit a cross-reference (GUI only)
To delete a bookmark in the GUI
To delete a bookmark in the Web interface
To delete a cross-reference in the GUI
To delete a cross-reference in the Web interface
To view a cross-reference/go to a bookmark
Finding and Viewing Documents
Filtering in the Document View
Using Perspectives
Printing Documents
Viewing and Editing Document or Content Properties
Viewing Document Model Relationships
Changing the Document Project
Creating a Document Version
To check in a document version
Creating a Content Version
To check in a content version
Baselining Documents
To baseline a document
To baseline multiple documents
Move Baseline Dialog Box
Removing Baselines From Documents
To remove a baseline from a document
To remove a baseline from multiple documents
Branching Documents
To branch an individual document from the Document menu
To branch multiple documents from the Document menu in the Items view
Viewing Branch Details
Viewing Differences
Comparing Unrelated Documents
Document Locking
Locking a Document
Working with Locked Documents
Document Lock Information
Unlocking a Document
Managing Trace Relationships
To create a trace from the Content menu in the GUI
To create a trace using drag-and-drop
Viewing Trace Relationships
Managing Suspect Trace Relationships
To clear a suspect trace using the Content menu in the GUI
To clear all suspect traces using the Content menu in the GUI
Trace Relationships in Content Versions
Propagating Traces to Branched Documents
To propagate trace relationships to branched documents
Importing and Exporting Documents
Running Current and Historical Reports on Documents
Executing Tests With Windchill RV&S
Using Windchill RV&S to Support Your Testing Process
What is Test Management?
Test Management as an Integrated Approach
Test Management at a Glance
Testing Process Task Overview
Test Planning
Create Test Objectives
Adding a Planned Test
Review Test Status
Test Planning Reports and Charts
Test Case Development
Creating a Test Suite
Adding a Test Case
Adding Test Steps
To create a new Test Step
To copy and paste a Test Step
To cut and paste a Test Step
To revert or save a Test Step edit
Establish Trace Relationships
Publish Test Suites
Test Execution
Create Test Session
Entering Manual Test Results
Test Result Editor
Reviewing Results with the Test Results View
Queries
Batch Editing Test Results
To batch edit test results from the Test Results Editor in the GUI or the Web
Collecting Performance Statistics
Collecting Contextual Information for Functional Testing Scenarios
Reporting on Test Results
Mark Test Session Complete
Creating a Test Session from Test Items
Viewing Test Result Details
Entering Test Results
To enter a test result
Working With Item Test Results
Test Result Operations
Test Results View: Analyzing Test Results
Working With the Test Result Editor
Test Result Editor: User Interface Components
Configuring the Test Result Editor
To configure the Test Result Editor in the GUI
To configure the Test Result Editor in the Web interface
Editing Test Results
Purging Test Results
Best Practices For Working With Versioned Test Documents
Limitations For Versioned Test Documents
Grouping Files Under Version Control
Configuration Management Projects View
Configuration Management Project Information View
Set Project Description Dialog Box
Working With Date-Based Project Configurations
Creating a Configuration Management Project
Dropping a Configuration Management Project
Adding a Configuration Management Project
Opening a Configuration Management Project
Configuration Management Project View
Creating a Configuration Management Subproject
Create Subproject Options
Adding a Configuration Management Subproject
Adding a Shared Configuration Management Subproject
Configuring a Configuration Management Subproject
Dropping a Configuration Management Subproject
Moving a Configuration Management Subproject
Move Subprojects Options
Viewing a Configuration Management Project History
Restoring a Configuration Management Project
Adding Configuration Management Project Labels
Deleting Configuration Management Project Labels
Checkpointing a Configuration Management Project
Comparing Configuration Management Project Checkpoints
Configuration Management Project Differences View
Viewing Project Differences Using Change Packages
Project Change Package Differences View
Viewing the Net Effect of Change Package Entries
Change Package Entries View
Viewing Configuration Management Project Metrics
Branching Configuration Management Projects Overview
Creating a Development Path
Extending an Extendable Development Path
Removing a Development Path
Merging a Child Development Path
Merge Checklist
Merging a Development Path Overview
Merging a Development Path Procedure
When Should I Not Merge Development Paths?
Working with Manual Merge Lines
Adding Manual Merge Lines
Deleting Manual Merge Lines
Activating a Development Path
Deactivating a Development Path
Locating Where a Configuration Management Object Is Used
Locate Options
Locate View
Promoting and Demoting Configuration Management Projects
Managing Your Personal Workspace in a Sandbox
Sandboxes Overview
My Sandboxes View: Managing Sandboxes
Viewing Sandbox Details
Creating a Sandbox
Configuring a Sandbox
Opening a Sandbox
Sandbox View
Exporting a Sandbox
Importing a Sandbox
Dropping a Sandbox
Retargeting a Sandbox
Taking Sandbox Snapshots
Managing Source Files as Members
Adding Members to a Project
Re-adding Dropped Members
Create Archive Options (GUI)
Create Archive Options (Web)
Adding Dropped Members to a Project
To add members from archive in the GUI
Add Member(s) From Archive Options
Character Encoding
Dropping Members From a Project
To drop a member in the GUI
To drop a member in the Web interface
Drop Member Options (GUI)
Drop Member Options (Web)
Filtering Members
Viewing Member / Revision Information
Working File Changes View
Selecting Members
Moving Members Between Projects
To move a member in the GUI
To move a member by dragging in the GUI
Move Members Options
Identifying Members to Add to Projects
Non-Members View Information
Viewing and Editing Member Content
Checking Out a Member
To check out a member in the GUI
To check out a member in the Web interface
Check Out Options
Checking In a Member
Check In Options
Renaming a Member
Rename Member Options
Discarding Changes to a Member
To discard changes to a member’s working file in the GUI
Resyncing Members
To resynchronize a member in the GUI
Locking a Member
Viewing Member Locks
Locks View
Removing or Downgrading Locks on Members
Release Lock By Archive Dialog Box
Finding All Locks on Members of a Sandbox or Project
Making a Member’s Working File Writable
Using Keywords in Working Files
To turn off keyword expansion from the GUI
To turn off keyword expansion from the CLI
Table of Keywords
Adding Labels to Members
Deleting Member Labels
Freezing Members
Thawing Members
Submitting Deferred Operations
Resyncing Members With Deferred Operations
Canceling Deferred Operations
Viewing a Member History
Working With the Member History View
Member History View Default Columns
Filtering a Member or Project History in the GUI
Viewing Member Archive Information
Setting the Default Member Revision
Set Member Revision/Rule Dialog Box (GUI)
Set Member Revision/Rule Options (GUI)
Setting a Revision Rule for Members
Set Member Revision/Rule Dialog Box (GUI)
Set Member Revision/Rule Options (GUI)
Deleting a Revision
Viewing Member Changes By Revision
Annotated Revision View
Working With Pending Revisions
Comparing Revisions
To compare two members in the GUI
To compare two revisions in the Web interface
To compare two text files in the GUI
Branching Members
Merging Members
To merge branched members in the GUI
Merge Branch Options
Merging Modified Working Files
Resolving Merges
To resolve a merge in the GUI
Working With Visual Difference
Merging Two Revisions
To merge two revisions in the GUI
Merging Blocks
Editing Merge Results
Reverting Merge Results
Saving Merge Results
Working With Visual Merge
Viewing Conflicts
Merging Nonconflicting Blocks
Merging Individual Blocks
Editing Merge Results
Reverting Merge Results
Saving Merge Results
Suspending Merges
Deferring Member Operations
Promoting and Demoting Members
Promoting Members
Demoting Members
Windchill RV&S Client Verification of Checksums
Resolve Differences Between Working File Revision and Member Revision Dialog Box
Grouping Units of Work in Change Packages
Change Package Overview
My Change Packages View: Managing Change Packages
Creating a Change Package
Discarding Change Package Entries
Viewing Change Package Entry Member Differences
Finding Change Packages
Find Change Packages Options
Viewing Change Package Details and Entries
Change Package View
Editing a Change Package
Moving Change Package Entries
To move change package entries in the GUI
To move change package entries in the Web interface
Viewing a Generic Change Package
Generic Change Package Attributes Panel
Generic Change Package Entries Panel
Submitting Change Packages
Closing a Change Package
Discarding Change Packages
Change Package Reviews Overview
Reviewing Change Packages
Accepting a Change Package
To accept a change package in the GUI and Web interface
Rejecting a Change Package
To reject a change package in the GUI and Web interface
Accept / Reject Change Package Dialog Box
Reopening a Change Package
Apply CP Overview
Using Apply CP in Your Development Environment
Using Subprojects
Applying a Change Package With No Dependencies
Using the Apply CP Backfill List
Using a Propagation Change Package With Apply CP
Resolving Conflicts
Apply CP Procedure
To apply a change package in the GUI
Select Change Package(s) Dialog Box
Apply Change Packages Options
Apply Change Package Options: Advanced
Resync CP Overview
Using Resync CP in Your Development Environment
Using the Resync CP Backfill List
Applying Changes From a Variant
Applying Change Packages From Two Variants
Using a Propagation Change Package with Resync CP
Resolving Binary Conflicts
Resync CP Procedure
To resynchronize a change package in the GUI
Resynchronize Change Packages Options: General
Resync CP Options: Advanced
Apply CP and Resync CP Overview
Advanced Apply CP and Resync CP Concepts
Understanding Net Changes
Operations Propagated
How Net Changes Are Calculated
Problems Associated With Propagating Changes
Making Propagations More Successful
Resync By CP Overview
Revert CP Overview
Revert CP Procedure
Integrating With Implementer
Document Versioning
Overview of Document Versioning
Configuring Windchill RV&S for Document Versioning
Working With Document Versioning
Best Practices For Document Versioning
Limitations For Document Versioning
Server Administration
Administration Client
Opening the Windchill RV&S Interface
To open the Windchill RV&S administration client
Administration Client Preferences
Option Prompts
Windchill RV&S Client Preferences
To set Windchill RV&S client preferences from the GUI
To set Windchill RV&S client command preferences from the GUI
Server Preferences
To set proxy preferences from the GUI
Windchill RV&S administration client Preferences
To set Windchill RV&S administration client desktop preferences from the GUI
To set Windchill RV&S administration client toolbar preferences from the GUI
To set Windchill RV&S administration client connection preferences from the GUI
Setting Windchill RV&S View Preferences
To set view preferences in the Windchill RV&S Client
Authorization Administration Preferences
To configure Authorization Administration preferences from the GUI
Server Connections
To connect to a Windchill RV&S server
To disconnect from a Windchill RV&S Server
Using the Windchill RV&S administration client
Windchill RV&S administration client Interface Components
Administration Command Line Interface
Viewing Administration History
Windchill RV&S Server Alert Messages
To create an alert message in the GUI
To view an alert message in the GUI
To clear an alert message in the GUI
Print Functions
To print view information from the GUI
Quitting a Windchill RV&S administration client Session
Logging Out
To log out of the Windchill RV&S administration client
Closing Client
To quit a Windchill RV&S administration client session
Shutting Down
To shut down the Windchill RV&S administration client
Role-Based Views for Users
Understanding ViewSets
ViewSets FAQ
ViewSet Permissions
Permission to Publish ViewSets
Published ViewSet Permissions
Creating ViewSets
To create a ViewSet using the Windchill RV&S administration client interface
Copying ViewSets
To copy a ViewSet using the Windchill RV&S administration client
Editing ViewSets
To edit a ViewSet using the Windchill RV&S administration client
Viewing ViewSets
ViewSet Types and Locations
Default ViewSets
Deleting ViewSets
To delete a ViewSet using the Windchill RV&S administration client
Making ViewSets Available to Users
Scenario 1: New Windchill RV&S client Installation
Scenario 2: New Specialized Role
Scenario 3: Process Changes to Existing Role
Process Overview
Converting Personal ViewSet to Unpublished ViewSet
Publishing ViewSets
To publish a ViewSet using the Windchill RV&S administration client
Testing ViewSets
Mandatory ViewSets
Administering Published ViewSets
Published ViewSet Properties
Viewing ViewSet Properties
Editing ViewSet Attributes
Fetching Published ViewSets
To fetch a published ViewSet using the Windchill RV&S administration client
Updating Published ViewSets
Filtering Data
Data Filter: User Interface Components
To filter data
Workflow and SCM Projects
Configuration Management Projects Overview
Configuration Management Interfaces
Organizing Your Projects
Creating a Configuration Management Project
Dropping a Configuration Management Project
Deleting Projects and Archives From Database
Delete Session Phases
Viewing Repository Post-Delete
To delete projects from the database using the CLI
To delete archives from the database using the CLI
Restoring Deleted Projects
Using Configuration Management Project Metrics
Creating a Configuration Management Subproject
Create Subproject Options
Adding a Configuration Management Subproject
Adding a Shared Configuration Management Subproject
Configuring a Configuration Management Subproject
Sharing Archives With Other Projects
Shared Subprojects
Common Projects
Workflows and Documents Projects View
Assigning Workflow and Document Project Administrators
To assign a Windchill RV&S project administrator
Setting Workflow and Document Project Visibility
Managing Metadata for Workflow and Document Projects
To back a workflow and document project with an Item
Creating Workflow and Document Projects
To create a workflow and document project in the GUI
To create a workflow and document subproject in the GUI
Editing Workflow and Document Projects
Deleting Workflow and Document Projects
To delete a workflow and document project in the GUI
Deactivating Workflow and Document Projects
To deactivate a workflow and document project in the GUI
Viewing Workflow and Document Project Details
Reparenting Workflow and Document Projects
To reparent a workflow and document project in the GUI
Workflow to Manage Process and Change
Workflow View
To open the Workflow view in the GUI
Viewing Workflow
To view a workflow in the GUI
Assigning Administrators for Windchill RV&S
Windchill RV&S administration client Permissions
Testing Workflow With Admin Migration Wizard
Two Stage Server Configuration
Installing and Starting the Production Server
Installing and Configuring the Staging Server
Performing a Cold Restart of the Staging Server
Starting the Staging Server
Testing Workflow and Document Configuration
Managing Administrative Locks
To work with administrative locks in Windchill RV&S
Using the Admin Migration Wizard
To migrate workflow and document admin provided objects to the production server
Columns for Admin Provided Objects
Printing Admin Migration Summary Information
Migrating a Shared Field or State Override
Creating Workflow
To create a workflow in the GUI
Workflows and Documents View Options
Editing Workflow
To edit a workflow in the GUI
To create multiple state transitions to a single state in the GUI
To multi-edit state transitions in the GUI
To multi-edit states in the GUI
Saving Workflow as Image
To save a workflow as an image in the GUI
Configuring Self Transitions
Admin Provided Objects
Converting User Objects to Admin Provided Objects
To manage admin provided objects in the Windchill RV&S administration client
Deleting Admin Provided Objects and Items
Deleting Items
To delete an item in the GUI
Assessing Your Current Product Development Process
To assess your workflow and project state transitions, consider the following questions
To assess your current tracking mechanism, consider the following questions
To assess the scope of implementation, consider the following questions
To assess your teams and user groups, consider the following questions
Setting Up E-mail Notifications
Permissions for E-mail Notification
To set e-mail notification in the GUI
To set e-mail notification in the Web interface
Troubleshooting E-mail Notification
Moving States, Types, Fields, and Triggers
Item Type Attributes
Working in Types View
Assigning Type Administrators
To assign a Windchill RV&S type administrator
Types
Configuring Type Attributes
To configure type attributes in the GUI
Setting Type Visibility
Setting Item Editability for Types
To define item editability for a type in the GUI
Setting Field Visibility for Types
Setting the Test Management Role for Types
To set test management roles for types in the GUI
Creating Types
To create a type in the GUI
Viewing Types
To view a type in the GUI
Editing Types
To edit a type in the GUI
Copying Types
To copy a type in the GUI
Setting Up Documents
Key Terms and Concepts in Documents
Exposing Segments and/or Nodes to Users
Document Relationships
Customizing Document Content
Creating a Document Domain
Creating Document Types
Adding Additional Fields to an Existing Document Domain
To create additional shared content fields in the Windchill RV&S administration client
Document Versions
Item Revisioning
Document Locking
Change Control and Document Locking
Defining the Format of Printed Documents
To define a print report format for a Segment type in the GUI
Moving Types
To change the order of the types in the GUI
Deleting Types
To delete a type in the GUI
Using Type Properties
Viewing Type Properties
Defining Type Properties
Type Property Fields
Setting Type Overrides
Overrides for Fields
To set a type override for fields
Overrides for States
To set a type override for states
Managing Constraints
Creating Constraints
To create a constraint in the GUI
Working With Basic Constraints
Working With Field Relationship Constraints
Working With Rule Constraints
Working With IBPL Constraints
Editing Constraints
To edit a constraint in the GUI
Copying Constraints
To copy a constraint in the GUI
Customizing Error Messages for Constraints
Default Constraint Error Messages
Customizing Constraint Error Messages
To customize a constraint error message in the GUI
Deleting Constraints
To delete a constraint in the GUI
Configuring Duplicate Detection
To configure duplicate detection in the GUI
Defining Rules
Rule Format
Working With Conditions
To create a condition involving field values
To create a condition involving user groups
To create a condition involving type properties
To create a pre-condition associated with a document
To replace an existing condition with a new one
Selecting Rules
To select a rule in the GUI
Administering Microsoft Word Templates
Word Template Operations
Word Template Properties
Word Template Elements
Valid Field Attributes For DOTX Templates
Sample Word Templates
Item Fields
Understanding Fields
Creating Fields
Relationship Fields
Item Backed Picklist Fields (IBPL)
Field Value Attribute Fields (FVA)
Phase Fields
Range Fields
SI Project Fields
To create a field in the GUI
Incoming External Reference (IER) Fields
Additional Field Options
Specifying Default Columns
Setting Field Relevance
To define field relevance in the GUI
Setting Field Editability
Key Considerations
To define field editability in the GUI
Setting Field Rules
To define a field rule in the GUI
Setting Field Description
To specify a field description in the GUI
Using Parameters and Parameter Values Fields
Using Custom Fields and Custom Field Values
Viewing Fields
To view a field in the GUI
Working in Fields View
Moving Fields
To change the order of the fields in the GUI
Editing Fields
To edit a field in the GUI
Deleting Fields
To delete a field in the GUI
Deactivating Picklist Values
To deactivate a picklist value in the GUI
Customizing Rich Content Fields
HTML Elements and Attributes
CSS Definitions
Location of CSS Files
Removing and Transforming Style Definitions and Elements
Key Considerations
Using Display Names For Fields
Setting Up and Customizing Electronic Signatures
Customizing Electronic Signature Trigger
Calculations in Fields, Charts, and Reports
What Are Computed Expressions?
Computed Expression Types
Best Practices and Key Considerations for Computed Expressions
Creating a Computed Field
To create a computed field
Computed Expression Rules
Computed Expression Function Classes
Calculating Static Computed Fields
To calculate a static computed field in the GUI
Creating a Computed Expression in a Report
Creating a Computed Expression in a Chart
Using Computed Fields to Chart Historical Trends
Example: Using Computed Fields to Chart Historical Trends
To calculate a computed field within a specific time frame
Using Computed Fields to Calculate State Metrics
Calculating a Recently Converted Static Computed Field
Scheduling Computation Times
State Workflow Definitions
States
Working in States View
Available Menu Commands for States
Viewing States
To view a state in the GUI
Creating States
To create a state in the GUI
Moving States
To change the order of the states in the GUI
Editing States
To edit a state in the GUI
Deleting States
To delete a state in the GUI
State Metrics
Change Packages for SCM
Change Package Types Overview
Viewing Change Package Types
To view change package types in the CLI
Changing Change Package Type Order
To change the position order of a change package type
Editing Change Package Types
To edit a change package type in the GUI
To edit a change package type in the CLI
To assign administrators to change package types
Viewing Change Package Type Details
To view information for a change package type in the GUI
To view information for a change package type in the CLI
Creating Change Package Types
To create a change package type in the CLI
Deleting Change Package Types
To delete a change package type in the CLI
Modifying Change Package Entry Attributes
To view change package entry attributes in the CLI
To view change package entry attribute details in the CLI
To create a change package entry attribute in the CLI
To edit a change package entry attribute in the CLI
To delete a change package entry attribute in the CLI
Modifying Custom Change Package Attributes
To view change package attributes in the CLI
To view change package attribute details in the CLI
To create a change package attribute in the CLI
To edit a change package attribute in the CLI
To delete a change package attribute in the CLI
User Operations for Custom Change Package Types
To create a change package in the CLI
To edit a change package in the CLI
To delete a change package in the CLI
Change Package Overview
Change Package Reviews Overview
How Change Package Review Works
Change Package Review Benefits
Change Package Review Workflow
Intermediate States of a Change Package
Details of change packages that fail to commit
Change Package Entry Categories
Pending Operations in Change Packages
Setting Policies for Change Package Reviews
Change Package Reviewer and Watcher Rules
Writing Logical Expressions
Case of a Single Condition
Condition Structure and Elements
Parsing Rules
Change Package Review E-mail Notification
Automate Tasks and Calculate Data Using Event Triggers
What Is an Event Trigger?
About Trigger Scripts
JavaScript Language Elements
Variables
Operators
Control Structures
Control Structures and Functions
Arrays
Exception Handling
JavaBeans
Tips and Best Practices for Event Triggers
Overview of Workflow and Document Triggers
Workflow and Document Event Categories
Key Considerations
Transactionality of Workflow and Document Event Triggers
Event Triggers View: Managing Event Triggers
Planning Workflow and Document Triggers
Creating Workflow and Document Event Triggers
Creating Rule Based Change Triggers
To create a rule-based change trigger in the GUI
Creating Scheduled Triggers
To create a scheduled event trigger in the GUI
Creating Other Triggers
To create an other trigger
Localizing Event Triggers
Coding Workflow and Document Triggers
Script Description
Script Parameters
Field Parameters
Viewing Workflow and Document Event Triggers
To view an event trigger in the GUI
Editing Workflow and Document Event Triggers
To edit an event trigger in the GUI
Copying Workflow and Document Event Triggers
To copy an event trigger in the GUI
Deleting Workflow and Document Event Triggers
To delete an event trigger in the GUI
Resolving Workflow and Document Event Triggers
To change the resolution order of event triggers in the GUI
Running Scheduled Workflow and Document Triggers
To run a scheduled trigger in the GUI
Using the Windchill RV&S API in Event Triggers
API Beans and Methods
API Trigger Code
Script Library for Workflow and Document Triggers
Script Library for Configuration Management Triggers
Using Event Triggers to Run Custom Java Code
Using Java Classes
Planning Configuration Management Triggers
Overview of Configuration Management Server-Side Triggers
Configuration Management Event Categories
Transactionality of Configuration Management Event Triggers
Event Trigger Contexts
Subproject Event Triggers
To configure event triggers to run on a subproject
Trigger Resolution
Components of Configuration Management Event Triggers
Updating Events Definition File
To update the global events definition template
To update the project events definition template
Overview of Configuration Management Client-Side Triggers
Pre and Post Processing in Client Sandbox
Trigger Syntax
Target Commands
To add client-side trigger information to the Windchill RV&S server
Environment Variables
Debugging Configuration Management Client-Side Environment Variables
Error Handling Beans and Methods
abortScript() Method
DEBUG Logging
To enable DEBUG logging:
Logging Trigger Scripts
Logging Commands
Coding Configuration Management Triggers
Referencing Configuration Management Beans in Trigger Scripts
Presentations
Presentation Templates
Understanding Template Designer Interface
Best Practices for Working With Template Designer
Creating New Presentation Template
To create a new presentation template
To set the new presentation template for the target type
Working With Grids
To set up a grid
Working With Cells
To format template cells
Working With Labels
To modify text labels
To modify field labels
To modify field values
Working With Tabs
Filtering Fields
Adding Fields
To add a field to the template grid
Working With Images
To add a new image
Localizing Presentation Templates
Previewing Presentation Template
To preview a presentation template
Viewing Presentation Templates
To view the presentation template settings for a type
Customizing Item Presentation
Templates for Viewing, Submitting, and Printing Items
Modifying Template Properties
General Properties
Text Styles
Editing Presentation Template
To edit a presentation template
To edit grids in a presentation template
Deleting Presentation Template
To delete a presentation template
Copying Presentation Template
To copy a presentation template
DocStudio
Reports
What Are Report Recipes?
Creating and Managing Reports
Report Wizard Components
Best Practices for Creating Report Recipes
Creating a Report Recipe
To create a custom report recipe
Creating a Simple Report Recipe Using Basic Windchill RV&S Report Tags
Localizing Report Recipes
Grouping and Group Counts in a Report Recipe
Adding Group Field Computations to a Report Recipe
Adding Group Computations to a Report Recipe
Displaying Time Entry Information in a Report Recipe
Displaying Relationship Time Entries in a Report Recipe
Displaying Change Package Information in a Report Recipe
Displaying Live and Ambiguous Fields in a Report Recipe
Advanced Report Recipe Writing
Argument Tag
Branches Tag
Parent Tag
Query and Walk Functions
Using JavaScript in a Report Recipe
Creating Common Page Elements for Reports
Exporting and Importing a Report Template
Report Tags
Report Formats for Custom Fields and Custom Field Values
Test Management
What Are Test Verdicts?
Creating and Managing Test Result Fields
Test Management Types and Relationships
Before You Start: Need-to-Know Information
System Requirements and Configuration
Windchill RV&S Process and Workflow Enhancements for Windchill RV&S Test
Creating Test Result Fields
To create a test result field in the GUI
Viewing and Managing Test Result Fields
CLI Commands for Test Management
Working in the Test Verdicts View
Creating a Test Verdict
To create a test verdict in the GUI
Editing a Test Verdict
To edit a test verdict in the GUI
Deactivating Test Verdicts
Configuration Localization Overview
Configuration Localization Overview
Configuring Localization
Setting a Locale for Administrative Object Localization
Adding Multi-Locale Support to Administrative Objects
Fallback for Display Name and Description
Exporting and Importing Translations
Fields
Translating Fields
States
Translating States
Types
Translating Types
Setting a Field Override for a Type
State Override for Type
Fallback for Field Override and State Override
Using the Admin Migration Wizard
Server Configuration
Post Install Planning
Supported Databases
Backing Up and Restoring Derby Database
Automated Backup of Derby Database
Restoring Embedded Derby Database
Supported Integrations
Integrating With Implementer
Post Install Server Licensing Considerations
Logging Licensing Information
Logging License Expiry Warnings
FlexNet License Reporting
Post Install Server Security
Security Schemes
Choosing Your Security Policy
Additional Configuration for MKS Domain Security Scheme
Using Multiple Security Schemes
Specifying Security Policies by Client IP Address
Specifying Scheme Order
Specifying Which Security Realm to Use for Group Enumeration
Setting Limits for Fetching Information From External Domains
Special Considerations for Kerberos and Kerberos Single Sign On
Connection Preferences Are Ignored
SSO Not Supported for Federated Server Architecture
Electronic Signatures Not Supported
Setup for Web Interface
Specifying Keytab for Kerberos SSO
To create a keytab file
Kerberos SSO for Windows Clients
Manually Adding the Registry Key
Additional Realm Settings
Troubleshooting Kerberos and Kerberos SSO
Managing MKS Domain Users
To create an MKS Domain user in the GUI
To view an MKS Domain user in the GUI
To edit an MKS Domain user in the GUI
To delete an MKS Domain user in the GUI
Managing MKS Domain Groups
To create an MKS Domain group in the GUI
To view an MKS Domain group in the GUI
To edit an MKS Domain group in the GUI
To delete an MKS Domain group in the GUI
Secure Sockets Layer
Connections for which SSL Is Supported
Enabling SSL
Creating Signed Server Certificates
To create a signed server certificate
Renewing Signed Server Certificates
Enabling Unlimited Strength Cryptography
FIPS Support
FIPS Support
Oracle SQL*Net Encryption
Configuring Oracle SQL*Net Encryption
Migrating to Encrypted Server-side Passwords
To migrate encrypted passwords on the Windchill RV&S server
Encrypting Server-side Passwords
Changing Encrypted Passwords
Changing Encrypted Passwords on Windchill RV&S server
To change encrypted passwords on the Windchill RV&S server
Changing Encrypted Passwords on Proxy
To change encrypted passwords on the proxy
Reverting to Plain Text Server-side Passwords
To revert to plain text server-side passwords
Access Control List System
Full User Name Support
File Level Security
E-mail Address Support
Post Server Installation
Database Creation Options
Finding Your Windchill RV&S Customer Number
Post Server Configuration
Configuring Windchill RV&S Server Home Page
Displaying Links
List of Client Installs
Modifying Default Home Page
Replacing the Home Page
List of Documentation
Configuring the Location for Temporary Windchill RV&S Files
Global Development Using a Proxy
Understanding Federated Server Architecture
What Is FSA?
Real Time Remote Access
Benefits During Operation
Applications for FSA
Security Considerations for FSA
Defining Administrative User
Proxy Security
Password Encryption for Proxy
Authentication
Access Control Lists for FSA
Minimum Configuration Requirements
Backward Compatibility
Limitations for Mixing Operating Systems
Priming the Proxy
The Proxy Cache
Priming the Cache
Methods of Priming the Cache
To prime the proxy
Installing FSA
Configuring FSA
Properties Files
Aliases
Automatic Download for New Revisions
Storing Your Windchill RV&S Source Code Projects
Directing Users
Solution Templates
Windchill RV&S Solution Installation
To install a Windchill RV&S solution template
Customizing Solutions
Access Control List Permissions
Understanding ACL Access Permissions
Workflow and Document Management Access Permissions
Configuration Management Access Permissions
Using the MKS ACL to Set Administrative Permissions
Service Pack ACL
Creating ACLs
Copying ACLs
To copy an ACL using the Windchill RV&S administration client
Setting Your Permission Strategy
Assessing Your Needs
Roles for Typical Projects
Permission Strategies
Cooperative Development
Sample ACL Implementation
Managing ACL Permissions
Adding a New Principal and ACL Entry
Changing Permissions
Available Permissions
Workflow and Document Permissions
Configuration Management Permissions
Server Related Permissions
Project-Related Permissions
Member Related Permissions
Change Package Related Permissions
ViewSet Permissions
Required Permissions
Creating a Configuration Management ACL Control
Configuration Management ACLs
Project ACLs
Subproject ACLs
Development Path ACLs
Member ACLs
Archive ACLs
Problems With Co-located Projects
Changing ACL Inheritance
ACL Configuration
Controlling Access to ACLs
Controlling Login Access
Controlling Login for Workflow and Document Users
Controlling Login for Configuration Management Users
Controlling Read/Update Access
Revising Existing ACLs
User and Group Permissions: Access Control Lists
Principals
Permissions
ACL Syntax
ACL Subtrees
Workflow and Document ACLs
Controlling Project Creation for Workflows and Documents
Controlling Type Creation and Deletion
Limiting Queries
Controlling E-mail Notification
Server Policies for SCM
Viewing Policies
To view configuration management policies
States Policies
To set the policy for states
Promotion Options
Promotion and Sample Implementation
Setting Global and Project Policies
Setting Policies for Development Path
Server Policies Resolution
Project Files
Other Policies
To set other policies
Locks Policies
Optimistic Locking Model
Advisory Locking Model
Strict Locking Model
Locking Revisions in Multiple Development Paths
Setting Locking Policy for Text
Line Terminator Policy
To set the policy for line terminators
Setting Member Attribute for Line Terminators
To set a member attribute for line terminators using the GUI
Keyword Policies
Keyword Policy Options
General Policies
To set general policies
General Policy Options
Formatting Configuration Management Policy Options
Entering Project Paths
Rules for Jumps
Example: Jumping to Variants
Enabling and Locking Configuration Management Policies
To edit configuration management policies
Editing Policies
Deleting Policies
To delete configuration management policies
Defining Promotion States
Creating Promotion Policy
Promotion to Testing State
Creating Policies
To create configuration management policies
Change Package Policies
Additional Requirements
To set the policies for change packages
Change Package Policy Dependencies
Change Package Policy Options
Copying Policies
To copy configuration management policies
Configuration Management Policy Options
Configuration File Locations
Windchill RV&S client Defaults
To set client default preference options
To set the pattern matching preference for filtering client history views
To specify a preference for the tool used when differencing files
Default Client Commands and Views
Server Properties for Workflow
Windchill RV&S Server Configuration Properties
Server Configuration Properties in the Database
Windchill RV&S server Properties in is.properties
Configuration Properties for Workflows and Documents
Workflow and Document Configuration Properties in the Database
Workflow and Document Properties in im.properties
Source Configuration Management Properties
Source Configuration Properties in the Database
Configuration Management Properties in si.properties
Using Properties
To configure properties in the Windchill RV&S administration client
File Vaulting for Configuration Management
Overview of File Vaulting
Key Considerations for File Vaulting
Configuring the File Vault
Migrating Existing Revisions to the File Vault
File Vault Migration Logging
Managing the File Vault
Changing the File Vault Location
Backing Up and Restoring File Vaults
Disabling the File Vault
Getting Notified When the File Vault is Unavailable
User and Group Permissions
Groups
Group Creation Example
Filtering Users
To filter users in large realms
Editing Users
Editing Groups
Editing Dynamic Groups
Dynamic Groups
Dynamic Groups Creation Example
Deleting Users
Deleting Groups
Deleting Dynamic Groups
Deactivating Users
Deactivating Groups
Creating Users
Creating Groups
Creating Dynamic Groups
Working in Users View
Working in Groups View
Working in Dynamic Groups View
Viewing Users
Viewing Groups
Viewing Dynamic Groups
Defining a User in your Realm
User Creation Example
Key Considerations
Refreshing User Cache
Refreshing Group Cache
Importing Users
Importing Groups
Service Packs and HotFixes
Service Packs and HotFixes
Applying Server-side Service Packs
Service Pack Policies
Service Pack Permissions
Applying Client-side Service Packs
Distributing Client-side Service Packs
To distribute service packs to the Windchill RV&S client
Manually Applying Client-side Service Packs
To manually apply a client-side service pack
Applying and Distributing HotFixes
Server HotFixes
Server-side HotFixes in a Failover Configuration
Multi-server Environments
Client HotFixes
HotFix Permissions
HotFix ID Numbers and Install Information
Rolling Back Server-side Service Packs
What You Need
Rollback Process
To roll back a server-side service pack
Rolling Back Client-side Service Packs
Rolling Back HotFixes
Rolling Back Server-side HotFixes
To roll back a server-side HotFix
Rolling Back Client-side HotFix
To roll back a client-side HotFix
Service Pack and HotFix Logging
Deleting the Service Pack ZIP File
Server Logging
Setting Up Audit Logging on Windchill RV&S Server
Formatting Properties
Format of Results
Viewing Audit Log
To view the audit log using the Windchill RV&S administration client
Audit Log Filter Options
Audit Log Column Descriptions
Windchill RV&S Server Operations
Workflow and Document Operations
Configuration Management Operations
Purging the Audit Log
Agent Installation and Configuration
Windchill RV&S Agent Overview
Before Installing Windchill RV&S Agent
Assumptions
Windchill RV&S Agent Installation and Configuration Checklist
System Requirements
Installing Windchill RV&S Agent
To begin the installation process from the DVD browser
GUI Install
Silent Install
To run the silent install
Uninstalling the Windchill RV&S Agent
To uninstall the Windchill RV&S Agent on Windows
To uninstall the Windchill RV&S Agent on Linux
Windchill RV&S Agent Security
To set up security
Choosing Your Security Policy
Special Considerations for Kerberos
Setting Up Users and Groups for the Flat File Security Realm
Setting Up LDAP-compliant Security Realm
Performance Tuning
Using SSL
Failover of Directory Servers
Setting Up UNIX Security Realm
To install the UNIX security realm
Encrypting Windchill RV&S Agent Passwords
To migrate to encrypted passwords on the Windchill RV&S Agent
To change encrypted passwords on Windchill RV&S Agent
Reverting to Plain Text Windchill RV&S Agent Passwords
To revert to plain text Windchill RV&S Agent-side passwords
Secure Sockets Layer (SSL)
Creating Signed Windchill RV&S Agent Certificates
To create a signed certificate
Windchill RV&S Agent Configuration
Configuration Information
Windchill RV&S Agent Configuration Properties
Logging for Windchill RV&S Agent
Running Windchill RV&S Agent from the CLI
To run Windchill RV&S Agent from Windows
To run the Windchill RV&S Agent on Linux
To restart or stop the Windchill RV&S Agent
To set up the Windchill RV&S server as a Linux service
Configuring Windchill RV&S Agent for Your Windchill RV&S server
How Windchill RV&S Agent Works
Upgrading and Service Packs for Windchill RV&S Agent
Server Service Pack Logging
Applying Windchill RV&S Agent Service Packs
To apply a service pack
Rolling Back Windchill RV&S Agent Service Packs
To roll back a Windchill RV&S Agent service pack
Troubleshooting Windchill RV&S Agent
CLI Reference
CLI Usage Overview
Windchill RV&S CLI Reference
intro
options
man
diagnostics
ACL (Access Control List)
preferences
rcsedit
cc
envvar
makefile
nm
Workflows and Documents Commands
im intro
im about
im acv
im addlabel
im baseline
im branchsegment
im changesegmentproject
im charts
im ci
im connect
im copychart
im copycontent
im copydashboard
im copyissue
im copyquery
im copyreport
im cps
im createchart
im createcontent
im createdashboard
im createissue
im createquery
im createreport
im createsegment
im dashboards
im deletechart
im deletedashboard
im deletelabel
im deletequery
im deletereport
im diffsegments
im disconnect
im editchart
im editdashboard
im editissue
im editquery
im editreport
im exit
im exportissues
im extractattachments
im gui
im importcontent
im importsegment
im incrementrevision
im insertsegment
im issues
im loadrc
im lock
im movecontent
im printissue
im propagatetraces
im queries
im refmode
im relationships
im removebaseline
im removecontent
im reports
im runchart
im rundashboard
im runreport
im serveralerts
im servers
im setprefs
im settimeentries
im timeentries
im toggleinclude
im unlock
im updateclient
im viewchart
im viewcp
im viewdashboard
im viewduplicates
im viewissue
im viewpendingimports
im viewprefs
im viewquery
im viewreport
im viewsegment
im viewserveralert
im viewsourcetraces
tm createresult
tm deleteresult
tm editresult
tm extractattachments
tm resulteditor
tm results
tm setprefs
tm setresults
tm stepresults
tm testcases
tm viewprefs
tm viewresult
tm viewuntested
Configuration Management Commands
si intro
si about
si acceptcp
si activatedevpath
si acv
si add
si addlabel
si addmemberattr
si addmemberfromarchive
si addproject
si addprojectattr
si addprojectlabel
si addprojectmergeline
si addprojectmetric
si addsandboxattr
si addsubproject
si annotate
si appendcheckpointdesc
si appendrevdesc
si applycp
si archiveinfo
si calculateprojectmetrics
si checkpoint
si ci
si closecp
si co
si configuresandbox
si configuresubproject
si connect
si cpissues
si createcp
si createdevpath
si createmetricinfo
si createproject
si createsandbox
si createsubproject
si deactivatedevpath
si deletelabel
si deleteprojectlabel
si deleteprojectmergeline
si deleterevision
si demote
si demoteproject
si diff
si difffiles
si discardcp
si disconnect
si drop
si dropdevpath
si dropmemberattr
si dropproject
si dropprojectattr
si dropsandbox
si dropsandboxattr
si edit
si editcp
si exit
si exportsandbox
si extenddevpath
si freeze
si gui
si importsandbox
si integrations
si loadrc
si locate
si lock
si locks
si makewritable
si memberinfo
si merge
si memberpermissions
si mergebranch
si mergechilddevpath
si mods
si move
si movesandbox
si movesubproject
si opencp
si print
si projectadd
si projectci
si projectco
si projectcpdiff
si projectinfo
si projectlocks
si projectpermissions
si projects
si promote
si promoteproject
si rejectcp
si rename
si report
si restoreproject
si restrictproject
si resync
si resynccp
si retargetsandbox
si revert
si revertcp
si revisioninfo
si rlog
si sandboxes
si sandboxinfo
si serveralerts
si servers
si setmemberrule
si setprefs
si setprojectdescription
si sharesubproject
si snapshot
si submit
si submitcp
si thaw
si unlock
si unlockarchive
si unrestrictproject
si updatearchive
si updateclient
si updaterevision
si viewcp
si viewcpentries
si viewcps
si viewdroppedmembers
si viewhistory
si viewlabels
si viewlocks
si viewmetricsinfo
si viewnonmembers
si viewprefs
si viewproject
si viewprojecthistory
si viewprojectmetrics
si viewrevision
si viewsandbox
si viewserveralert
Server Administration Commands
aa about
aa acls
aa acv
aa addaclentry
aa admingui
aa availablepermissions
aa connect
aa copyacl
aa deleteacl
aa deleteaclentry
aa deleteaclsubtree
aa disconnect
aa echo
aa editacl
aa exit
aa getdbfile
aa groups
aa loadrc
aa putdbfile
aa serveralerts
aa servers
aa setprefs
aa setproperty
aa updateclient
aa users
aa viewacl
aa viewprefs
aa viewserveralert
im admingui
im analytics
im checksourcetraces
im copytrigger
im copytype
im createdynamicgroup
im createfield
im creategroup
im createproject
im createstate
im createtrigger
im createtype
im createuser
im deletedynamicgroup
im deletefield
im deletegroup
im deleteissue
im deleteproject
im deletestate
im deletetrigger
im deletetype
im deleteuser
im dynamicgroups
im echo
im editdynamicgroup
im editfield
im editgroup
im editproject
im editstate
im edittrigger
im edittype
im edituser
im exporttranslations
im extractwordtemplates
im fields
im getdbfile
im groups
im importgroup
im importissue
im importtranslations
im importuser
im installsolution
im logging
im obtainadminlock
im projects
im purgeauditlog
im putdbfile
im releaseadminlock
im runtrigger
im setnotification
im setproperty
im states
im triggers
im types
im users
im viewadminlock
im viewauditlog
im viewdynamicgroup
im viewfield
im viewgroup
im viewproject
im viewstate
im viewtrigger
im viewtype
im viewuser
integrity about
integrity acv
integrity admin
integrity admingui
integrity changemksdomainuserpassword
integrity createmksdomaingroup
integrity createmksdomainuser
integrity deletemksdomaingroup
integrity deletemksdomainuser
integrity disconnect
integrity echo
integrity editmksdomaingroup
integrity editmksdomainuser
integrity exit
integrity fetchviewset
integrity getdbfile
integrity gui
integrity licenses
integrity loadrc
integrity logging
integrity mksdomaingroups
integrity mksdomainusers
integrity publishviewset
integrity putdbfile
integrity serveralerts
integrity servers
integrity setprefs
integrity setproperty
integrity setserveralert
integrity stats
integrity updateclient
integrity viewmksdomaingroup
integrity viewmksdomainuser
integrity viewprefs
integrity viewserveralert
integrity viewsets
si admingui
si copypolicysection
si deletearchive
si deletepolicysection
si deleteproject
si echo
si getdbfile
si logging
si migrate
si primeproject
si purgeauditlog
si putdbfile
si setpolicysection
si setproperty
si viewauditlog
si viewpolicysection
si viewpolicysections
tm createverdict
tm deleteverdict
tm editverdict
tm purgeresults
tm resultfields
tm verdicts
tm viewverdict
Accessibility Reference
Overview of Accessibility in Windchill RV&S
Navigating the Windchill RV&S Client GUI Using the Keyboard
Navigating ViewSets
Navigating Item Details
Navigating Data Filter Panels
Navigating Date Fields
Navigating Relationship Fields
Navigating Rich Content Fields
Navigating Query Builder in the Items View
Navigating Documents
Navigating Menus
Performing Windchill RV&S Client GUI Commands Using the Keyboard
Change Package Commands
Chart Commands
Custom Commands
Dashboard Commands
Document Commands
Item Commands
Project and Member Commands
Query Commands
Report Commands
Rich Content Commands
Test Management Commands
ViewSet Commands
Getting Started with the Windchill RV&S Client GUI Using the Keyboard
Importing a ViewSet
Navigating to a View in a ViewSet with Multiple Tabbed Views
Creating a Query
Running a Query
Selecting and Editing an Item
Refreshed Web Interface
About Refreshed Web Interface
About the Home Page
Accessing the Home Page
Creating a Custom Table
Deleting a Custom Table
Sorting, Searching and Filtering the Data
Key Considerations for Home Page
About DocStudio
Accessing DocStudio
Working in DocStudio
Finding the content in DocStudio
DocStudio Behavior
Editing in DocStudio
Editing Content
Fields Supported for Editing in DocStudio
Editing Relationships
Adding a Related Item
Editing the Document Structure
Editing Considerations in DocStudio
Resolving Conflicts
About the Item View
Accessing the Item View
The Item View User Interface
Header
Tooltips
Tabs
Section
Fields
Extra Section
Configuring the Presentation Template
Creating a PTCWCRVS-based Text Style
Updating the Text Override Property Value for Displaying Field Names
Using the Custom Display Property for Freezing a Row in a Grid
Using the Custom Display Property for Matrices
Key Considerations for Grid Cells in the Item Presentation Template
Splitting or Merging Grids in the Presentation Template
Key Considerations for Item View
Creating an Item
Creating a New Item
Editing in the Item View
To Edit an Item in the Item View
Updating User, Group, IBPL, and Multiple Pick Fields
Working with Relationships
Adding a Related Item
Creating a Related Item
Fields Supported for Editing in Refreshed Item View
Global Undo and Redo Operations
Editing and Formatting Rich Content
Supported Fonts
Constraints in the Refreshed Web Interface
About Document Review
Enabling Document Review
Configuring E-mail Notification
Managing Document Review
Disabling Document Review
Simplified User Management
Launching the My 360-degree View
The My 360-degree View for All Users
The My 360-degree View for Administrators
My 360-degree View Tab
Users Tab
User Details View
Groups Tab
Group Details View
Projects Tab
Project Details View
Simplified User Management Administrator Permissions
Overview of Accessibility in the Refreshed Web Interface
Navigating the Item View
Navigating the Item Edit View
Keyboard Shortcuts for Rich Text Editor (RTE) Field
Key Considerations for More Tabs
Appendices
Display of Fields in DocStudio
Minimum Column Width in DocStudio
Help Center Help
Windchill RV&S Online Help Overview
About Searching from the Help Center
About Home and Topic Pages
To Use the F1 Key for Context-Sensitive Help
About Windchill RV&S Help Center
Windchill RV&S 12.3.1.0 Help Center
About Windchill RV&S Help Center
install_multiple_clients
updating_the_mks_integrity_client
starting_the_mks_integrity_client
before_you_start_the_mks_integrity_client
quitting_an_mks_integrity_client_session
logging_out_of_the_mks_integrity_client
closing_the_client
shutting_down_the_client
logging_in_to_the_mks_integrity_client
changing_your_mks_domain_password
understanding_access_permissions
mks_integrity_access_permissions
mks_source_access_permissions
enabling_disabling_integrations
finding_your_mks_integrity_serial_number
mks_integrity_client_gui
workflows_web_interface
optimal_browser_settings
application_window_web
optimal_browser_settings_2
mks_visual_difference_interface
command_line_interface
command_preferences
connection_preferences
difference_and_merge_tool_preferences
editor_preferences
general_preferences
shutdown_preferences
view_preferences
managing_viewsets_gui
creating_a_viewset
customizing_a_viewset
importing_a_viewset
opening_a_viewset
navigating_views_in_a_viewset
closing_a_viewset
deleting_a_viewset
switching_to_a_viewset
restoring_a_viewset
backing_up_a_viewset
filtering_data
working_with_favorites
operator_fields
filtering_members_gui
entering_project_paths_gui
display_patterns
defining_logical_conditions
rule_format
nodes
operators
selecting_rules
customizing_columns_gui
issue_relationships
issues_view
issue_detail_view
using_project_filters
filtering_items
creating_an_issue
working_with_rich_content
viewing_and_editing_an_item
editing_items_in_word
launching_word_editor
using_word_editor
batch_editing_issues
resolving_conflicts_when_editing_an_item
working_with_item_cps
working_with_labels
revisioning_an_item
copying_an_issue
viewing_an_historical_item
viewing_issue_relationships
printing_an_issue
receiving_email_notifications_about_issues
time_entries_view
editing_a_time_entry
viewing_time_entries
using_source_traces
source_traces_user_interface
source_traces_reference
source_traces_use_cases
source_traces_follow_member_revision
manage_queries_view
query_definition_view
query_filter_types
grouping_filters
creating_a_query
editing_a_query
running_a_query
copying_a_query
deleting_a_query
manage_charts_view
chart_definition_view
creating_chart
editing_a_chart
running_a_chart
copying_a_chart
saving_and_printing_a_chart
deleting_a_chart
manage_reports_view
report_definition_view
creating_a_report
editing_a_report
copying_a_report
running_a_report
saving_and_printing_a_report
deleting_a_report
reporting_on_items
running_a_report_on_selected_items
running_a_historical_or_comparison_report
designing_a_dashboard
dashboard_definition_view
dashboard_layout_designer_interface
manage_dashboards_view
creating_a_dashboard
editing_a_dashboard
running_a_dashboard
copying_a_dashboard
deleting_a_dashboard
dashboard_layout_document_type_definition
understanding_document_structure
reference_modes
relationships_in_the_document_model
document_view
document_finder
using_the_document_view
indicators_and_icons
common_operations
rich_text
document
content
creating_a_document
creating_a_document_from_a_template
adding_content_to_a_document
viewing_and_editing_document_and_content_items
modifying_content
editing_content_in_word
document_funct_word_editor
word_conflicts
operation_types
conflict_types
bookmarking_documents
finding_and_viewing_documents
filtering_document_view
printing_documents
viewing_and_editing_document_or_content_properties
viewing_document_model_relationships
changing_the_document_properties
baselining_documents
branching_documents
viewing_branch_details
managing_trace_relationships
viewing_trace_relationships
propagating_traces_to_branched_documents
import_export_doc
running_current_and_historical_reports_on_documents_or_items
filtering_test_results
test_result_view
editing_test_results
working_with_test_results_for_an_item
test_results_view
test_result_editor
editing_a_test_result
purging_test_results
projects_view
project_information_view
creating_a_project
dropping_a_project
adding_a_project
opening_a_project
creating_a_subproject
adding_a_subproject
adding_a_shared_subproject
configuring_a_subproject
dropping_a_subproject
moving_a_subproject
project_history_view
restoring_a_project
adding_project_labels
deleting_project_labels
checkpointing_a_project
viewing_project_differences
project_metrics
branching_projects
creating_a_development_path
removing_a_development_path
locating_where_an_mks_source_object_is_used
promoting_and_demoting_projects
my_sandboxes_view
sandbox_information_view
creating_a_sandbox
configuring_a_sandbox
opening_a_sandbox
importing_a_sandbox
dropping_a_sandbox
retargeting_a_sandbox
taking_sandbox_snapshots
adding_members_to_a_project
create_archive_options_gui
adding_members_from_archive_to_a_project
character_encoding
dropping_members_from_a_project
filtering_members
member_information_view
selecting_members
moving_members
displaying_non_members
viewing_and_editing_member_content
checking_out_a_member
checking_in_a_member
renaming_a_member
discarding_changes_to_a_member
resynching_members
locking_a_member
viewing_member_locks
removing_or_downgrading_locks
making_the_working_file_writable
using_keywords
adding_labels_to_members
deleting_member_labels
freezing_members
thawing_members
submitting_deferred_operations
resynching_members_with_deferred_operations
canceling_deferred_operations
viewing_a_member_history
filtering_a_member_or_project_history_in_the_gui
archive_information_view
updating_a_member_revision
setting_a_member_rule
deleting_a_revision
working_with_pending_revisions
comparing_differences
branching_members
branching_and_merging_members_overview
merging_modified_working_files
resolving_merges
working_with_mks_visual_difference
working_with_mks_visual_merge
deferring_member_operations
promoting_and_demoting_members
change_package_overview
my_change_packages_view
creating_a_change_package
discarding_change_package_entries
viewing_change_package_entry_member_differences
finding_change_packages
viewing_change_package_details_and_entries
editing_a_change_package
moving_change_package_entries
viewing_a_generic_change_package
submitting_change_packages
closing_a_change_package
discarding_change_packages
change_package_reviews_overview
reviewing_change_packages
reopening_a_change_package
apply_cp_overview
apply_cp_procedure
resync_cp_overview
resync_cp_procedure
apply_cp_and_resync_cp_overview
resync_by_cp_overview
integrating_with_implementer
backing_up_and_restoring_derby_database
logging_licensing_information
flexnet_license_reporting
security_schemes
choosing_security_policy
choosing_security_policy1
using_multiple_security_schemes
specifying_security_policies_clientip
specifying_scheme_order
specifying_security_realm_use_group
special_considerations_kerberos
secure_sockets_layer
supported_ssl_connections
enabling_ssl
creating_signed_server_certif
renewing_signed_server_certif
enabling_unlimted_strength_crypt
ldap
migrating_encrypted_serverside_passwords
encrypting_server_side_passwords
changing_encrypted_passwords
changing_encrypted_passwords_server
changing_encrypted_passwords_proxy
reverting_plain_text_server_passwords
access_controll_list_system
full_user_name_support
file_level_security
email_address_support
finding_your_mks_integrity_serial_number1
configuring_server_homepage
configuring_the_location_for_temporary_MKS_integrity_files
understanding_fsa
real_time_remote_access
benefits_during_operation
improved_network_perform
connection_to_host
admin_ease_use
applications_for_fsa
geo_dispersed_config
internal_load_distr_config
security_considerations_fsa
proxy_security
password_encryption_proxy
authentication
acl_fsa
min_config_requ
priming_proxy
installing_fsa
configuring_fsa
storing_mks_source_project
directing_users
installing_a_solution
customzing_solution
understanding_access_permissions1
managing_a_service_pack_acl
creating_acls
copying_acls
setting_your_permission_strategy
roles_for_a_typical_project
setting_site_wide_read_only_permissions
permission_strategies
a_sample_acl_implementation
adding_a_new_principal_and_acl_entry
mks_source_acls_and_acl_entries
configuration_management_acls
acls_configuration
how_acls_work
principals
mks_integrity_acls
viewing_policies
states_policies
promotion_and_sample_implementation
project_files
other_policies
locks_policies
line_terminator_policy
keyword_policies
general_policies
format_config_policy_options
entering_project_paths
enabling_and_locking_mks_source_policies
editing_policies
deleting_policies
defining_promotion_states
creating_policies
change_package_policies
copying_policies
mks_source_policy_options
configuration_information
mks_integrity_client_default_policies
server_config_properties
configuration_properties_for_workflows_and_documents
source_configuration_management_and_deploy_properties
using_properties
managing_groups
filtering_users
editing_users
editing_groups
editing_dynamic_groups
managing_dynamic_groups
deleting_users
deleting_groups
deleting_dynamic_groups
deactivating_users
deactivating_groups
creating_users
creating_groups
creating_dynamic_groups
working_in_users_view
working_in_groups_view
working_in_dynamic_groups_views
viewing_users
viewing_groups
viewing_dynamic_groups
refreshing_user_cache
refreshing_group_cache
importing_users
importing_groups
setting_up_logging_on_mks_integrity_server
viewing_audit_log
mks_integrity_server_operations
mks_integrity_operations
mks_source_operations
purging_audit_log
before_installing_mks_agent
assumptions
installing_mks_integrity_agent
uninstalling_mks_agent
mks_agent_security
migrating_to_encrypted_mks_agent_passwords
secure_sockets_layer1
enabling_ssl1
mks_agent_configuration
running_mks_agent
configuring_MKS_Integrity_Agent_for_your_MKS_Integrity_Server
Upgrading_Service_Packs_MKS_Integrity_Agent
troubleshooting_mks_agent