Optimal TraceTM Enterprise Version 5.0
System Requirements for Optimal TraceTM Enterprise:
- Pentium 3-class processor or equivalent
- 256 MB of RAM
- 175 MB of available hard disk space
- Microsoft Windows 2000/2003/XP
- Microsoft Word 2000/2002/2003/2007
- Adobe Acrobat Reader for Optimal TraceTM Enterprise Help Files
Optimal TraceTM Enterprise has not been tested to
run on Windows 95/98
- Ensure you have at least 150 MB of available disk space
- Ensure you have uninstalled any previous releases of Optimal TraceTM Enterprise (See next section for details)
- Run the Optimal_Trace_Enterprise_Install.exe file to install.
- Ensure you have at least 150 MB of available disk space
- Ensure you have uninstalled any previous releases of Optimal TraceTM Enterprise (See next section for details)
- Run the Optimal_Trace_Enterprise_Install.exe /S /D=[Optimal Trace installation folder] file to install.
- On the Start menu select Settings, Control Panel, Add/Remove Programs
- Select Optimal TraceTM Enterprise and press the Add/Remove... button.
Never uninstall by just deleting files. This may prevent future installations of Optimal TraceTM Enterprise from working.
Enterprise will leave project files
Version 5.0 is the latest release of Optimal Trace Enterprise, the market leading Business Requirements Management solution.
The core themes of 5.0 are:
- Supporting deployments where a large body of existing documentation exists in MS Word and spreadsheets etc. This is catered for by provision of a comprehensive embedded mark-up utility in word and structured text file (CSV etc.) import.
- Supporting Hybrid Project approaches - Combining the benefits of ‘Structured’ Requirements with ‘Simple' Requirements. These are designed to accommodate more assertion or flat requirements styles.
- Supporting infinite levels of structural customization on projects & project templates. This is facilitated by extending custom property definition from the project level down to the package (group) level.
- A number of key usage and currency enhancements that ensure that Optimal Trace is best of breed for requirements capture and management.
OT 5.0 offers complete structural freedom to link all forms of requirements (simple/flat/assertion based) to 'goal-directed' requirements that reflect business intent.
OT 5.0 carries on in the OT tradition of emphasizing ease of use (& ease of deployment) while at the same time offering the most flexible approach to creating projects that meet your unique needs.
Providing an effective import facility from Word documents and other external formats allows fast deployment of Optimal Trace in environments where a significant body of materials already exists. This helps kick-start Optimal Trace deployment with minimal impact.
The new Optimal Trace Word import feature provides the following capability:
- An embedded wizard within your word docs for explicit mark up and selection of areas for import
- Ability to import into any project element, e.g.: Import to Glossary, Structured Requirement etc.
- Ability to dynamically find similar areas based on selected area. This is particularly useful when dealing with tables and repeated areas of a similar format and/or style etc. where consistency of format in the word document is not guaranteed
- Ability to preview and merge into an active project such that additions/modifications can be reviewed prior to merging into the loaded project.
5.0 also delivers a second facility for importing data from a text file into a selected project.
Text files to import should have data arranged in fields or columns, with each field delimited by a special character such as a comma. Microsoft Excel CSV (comma separated value) files are saved in this format, and so this feature is ideal for importing spreadsheet data.
Each row in the file is imported as a new project element. Similar to word import this facility allows any element types to be populated.
Finally, 'Maps' may be created for repeated import. These hold information regarding what columns are mapped to what Optimal Trace fields.
Optimal Trace already emphasizes the importance of Requirements Structure fostering a Requirements Driven approach to Testing and all aspects of the software lifecycle.
Extending this, 5.0 now introduces a new construct called 'Simple Requirements'.
Simple Requirements can be used to capture a more 'flat/assertion' style of requirement augmenting the structured flow requirement style. Simple Requirements comprise lists of Requirement Items, consider these as sub-requirements. These Items can be associated through Refinement with more detailed Structured Requirements.
Some examples of usage scenarios for Simple Requirements/Items are:
- High level marketing, product management and other 'flat' feature style requirements types where flow structure is not necessary and where a tabular structure is more suited
- Business Rules where certain system wide rules apply to many structured requirements
- Data oriented requirements where the need exists to specific format & validation information in a tabular fashion
Optimal Trace has always provided an extensive capability to customize project structure. This has meant that unlimited sets of additional fields were definable at project level and shared across the project.
5.0 now provides complete flexibility in project structure by extending custom property definition down to the package level. This means that Structured Requirements and Simple Requirements now can 'own' their own custom fields in the context of the current package.
For example now 'flat' style requirements categories such as performance etc. may have custom fields such as; 'Average Throughput', 'Peak Throughput', 'Concurrent Users' etc. defined, whereas other 'flat' style requirements in the same project may have different properties.
Key capabilities include:
- An ability to apply different definitions to different packages
- An ability to 'inherit' Custom Property definitions from the parent package
- An ability to lock down package level definitions (for secure projects) in the administration tool.
Other key highlights of this release include:
- Provision of Spell Check
- Extensions to Test Generation covering inclusion of refinement relationships and carry over of custom property values
- Option to Generate Clean Word Docs without hidden mark-up (non-reversible)
- Ability to run Silent Install
- Ability to delete log files by project (doc gen. and history files) from the admin tool
- Ability to set permissions on Custom Property creation and structural modification from the admin tool
- Certified Citrix Support
- Support for Oracle 10g
- Support for MySQL 5.0 Community Edition
- Support for MS Word 2007
The following are known issues:
Issue No 1686
Inconsistent error message when cancelling word
document generation and Word may crash: Depending on when you interrupt the document
Workaround: Ignore the
exception from MS Word
Issue No 2147
Document Generation and Form protected Style template: When using a MS Form document as a Style template for
a document generation Profile
Workaround: 'Unprotect' the Style template Form before generating.
Issue No 2172
Links don't work in generated document: If you generate a Form based profile (e.g. Default
Form) you will notice that clicking on any link in the document (e.g. Table of
Workaround: This is a know feature of Word Forms
Issue No 2267
Incorrect Macro security settings in Word can lead to
Application Error: If you generate
a document from Optimal Trace and an Exception occurs
Workaround: In Word
Issue No 2354
Change History changes do not get included as part of
a document update: This is by
Workaround: You can generate either a standalone Change History document or re-generate your document from scratch to see all the Change History entries.
Issue No 2364
Non-ASCII control characters in a Project produces
errors generating Word documents: If you have non-ASCII characters in an Optimal Trace Project (this
usually happens when copy/pasting from an external format such as PDF files)
and you generate a Word document
Workaround: Ensure there are no non-ASCII char
Issue No 2501
Out of Memory Errors while generating HTML or Image Maps from large Projects: Generating Image Maps from large Projects is very memory intensive. If you repeatedly generate the 'Full Project' HTML Report with a large Project you will eventually get an Out of Memory Error. The same can happen if you repeatedly 'Save Image' for a very large Project.
Workaround: Try and limit generating HTML for large Projects or Image Saving to
once per Optimal Trace session. If you do get an Out of Memory error
Issue No 3301
Timestamps on merging a reversed document: When reversing a document
Workaround: There is currently no workaround for this.
Issue No 3558
System clocks between
Workaround: Currently these system times need to be maintained manually
Issue No 4031
Orphaned Branch or Refinement in the Requirements Map:
In certain rare situations
a line representing a Branch or Refinement may get duplicated resulting in an
orphaned line remaining on the graph. This line has no connection to any
Requirements or Steps and as such will not result in any errors or corruption
Workaround: You need to open a new window (Window -> New Window) and close the original window and continue as normal.
Issue No 4241
Cannot add form fields to non-form document profiles: If you attempt to add form fields to a non-form
Workaround: Avoid using form fields in non-form based profiles.
It's perfectly ok to add custom fields to form based profiles
Issue No 4287
Table of contents page numbers can be incorrect: Sometime after updating or reversing a document
Workaround: This behaviour seems to be related to the large amount of hidden text that Optimal Trace documents contain. Removing all the hidden text can help here (but you will no longer be able to update or reverse the document). See the Document Generation: General Tips section below for details on how to remove all the hidden text in a document.
Issue No 4427
Document Generation will fail if you use 'xxxxx' as a Requirement name: 'xxxxx' is a reserved word
used internally by Optimal Trace document generation
Workaround: Avoid using 'xxxxx' as a Requirement name.
Type of images generated during Report generation: It should be noted that the style of images generated during Report generation (using the 'Default HTML' report for example) all depend on what 'graph display option' is selected in the application.
Workaround: You can vary the images by right clicking on the Requirement Map and changing the Package display style.
update or reverse documents after Repository Save As: when you
use the Repository 'Save As' functionality
Steps' option can cause instability when moving Steps: under
Workaround: try and avoid using the 'Hide Step' Requirement options.
Saving Change History and DocGen logs locally: When downloading a remote project to a local project
Workaround: To disable the download of change history and docgen events
1. Exit Optimal Trace
2. Open the file 'default.properties' in a text editor (e.g. Notepad). The file is located in the Optimal Trace directory (e.g. C:\Program Files\Optimal Trace\Optimal Trace 2.x)
3. Disable download of the change history by changing the line 'downLoadProjectChangeLogWhenTakingOffline = Yes' to 'downLoadProjectChangeLogWhenTakingOffline = No'
4. Disable download of the docgen events by changing the line 'downLoadDocGenEvensWhenTakingOffline = Yes' to
5. 'downLoadDocGenEvensWhenTakingOffline = No'
6. Save the 'default.properties' file
7. Start Optimal Trace
Change History in a Report: By default
Workaround: to use the
Change History from a new Report
with 'Create Reserved Area' menu option in Word: To begin
Workaround: In any event
The best approach is the following:
1. Turn on hidden text
Insert your new content as-is
3. Save and close the document
Try reversing the document into the corresponding
Optimal Trace project. If any XML parse errors are flagged
If no errors were reported by the import process
with 'Replace IDs and
Names' menu option in Word: Indiscriminate
use of this feature can cause problems and leave the document in an invalid
Workaround: The following is recommended:
1. Make a backup of the document before doing any advanced editing along these lines.
2. Turn on hidden text.
3. Carefully select the area that needs updating. Make sure that any ID strings (usually at the start of a section) that you wish to update are included in the selection.
It will help to clarify ex
5. Replace IDs and Names also corrects the Step Position numbers on any Step tables it finds. This is a convenience for the user as manually fixing Step Position numbers can be time-consuming.
with 'Duplicate current row' menu option in Word: This menu item will duplicate the current row the caret is
positioned on (e.g. a Step in a Scenario Table). You cannot use this feature to
add a new step to an empty table
1. Turn on hidden text and navigate to a branch table (which is hidden by default).
2. Place the caret on a particular branch and select 'Duplicate Current Row'
3. Select 'Toggle Hidden Tags' again as this macro turns off hidden text.
The new branch will have a new name and ID
5. The new branch will have to manually edited to correctly contain whatever sourceID and DestinationID are required.
with manually setting tags to hidden in Word: Sometimes
The reverse problem can also happen
Workaround: - firstly
To get rid of the immediate bad formatting
Now click Format->Style (or Format->Styles and Formatting depending on your version of Word)-
Now select the Style type of the text you were
editing. Usually 'Body Text'
When the correct style type has been selected
Now it should be possible to change the text from
hidden to non-hidden in safety. This problem typically occurs when some of the
hidden XML tags in a generated document have been accidentally damaged
with validating a Skeleton Document that is already open: If your
editing a Skeleton Document in Word
Workaround: avoid validating a Skeleton Document and editing it at the same time.
Elements appear in different order in Merge: under
Workaround: there is no workaround; the appearance order does not effect the underlying functionality.
Print Preview for Optimal Trace Documents shows hidden text.
Workaround: In Word
Workaround: save your project to release the locks.
Document Generation Custom Property restrictions:
1. Custom Properties have to be contained in a table
,they are bound to tables.
2. Custom Properties are either row-or column based and again this is statically bound. You can't change your Step Custom Properties from column type to row type by editing the skeleton doc
3. Custom Property Template details (name
,Id etc) have to appear before the corresponding Custom Properties in the skeleton doc. So you can't put your Custom Property name on the right of a row (if it's row-based) ,it has to appear to the left.
4. Column-type Custom Properties can't appear in the leftmost column. There are no restrictions on row type Custom Properties.
Document Generation Profiles cannot contain the same Element data twice:
E.g. in a Document Profile
,you cannot have a Requirement 'Description' repeated twice anywhere in the profile.
Workaround: there is no workaround for this.
Document Generation cannot reverse '...' values: '...' is a reserved word of sorts in reversing a document, any valid values of '...' will cause invalid conflicts in the Merge Tool.
Workaround: try avoiding using the value '...' in your data.
Can't Auto-Generate a document if any Project Element has more than 13 Custom Properties: if you attempt to generate a document
,where a Project Element has more than 13 Custom Properties ,you will receive the following error message from Word:
"Internal error: Error code: 0x800403e8
Error description: Unable to automatically add and format Custom Property..."
Workaround: This is a Word restriction
,however it is possible to create a Custom Profile with more than 13 fields ok.
No locally locked icons when
pasting/redoing: no locally locked icons appear in Optimal Trace in certain situations
Workaround: there is no workaround.
Searching for individual characters across all projects can result
in a 'Connection Exception': Searching the whole database for a single char
acter (or small word) may result in too much search information being returned from the database to Optimal Trace ,and cause a 'Connection Exception' in the Optimal Trace Client.
Workaround: Try avoid using single character searches, try and use whole words instead.
Optimal Trace will not work with a Firewall running: Optimal Trace will not work with a firewall running on
either client or server machine
Workaround: there is no workaround, apart from turning off your firewall.
Optimal Trace/Word 2003 update problem: When updating a Word 2003 document from Optimal Trace
Workaround: This is because of a bug in Word 2003
,which is detailed here: http://support.microsoft.com/default.aspx?scid=kb;en-us;163192. The workaround if to regenerate your document fully from Optimal Trace when this error happens ,instead of using the Update feature.
When reversing a document
Workaround: there is no workaround, it is not possible to change Package Tag values in a Word document and reverse them back into Optimal Trace..
Memory usage in Optimal Trace: If you find that Optimal Trace is using a large
amount of memory
Hiding paragraph ends in MS Word Templates: Paragraph ends must be hidden in Optimal Trace MS
Word document templates. For example
Workaround: This appears to be a bug in Word
'Normal.dot read only'
generating a word document from Optimal Trace
Workaround: This is a problem with Word
Notification emails do not contain hyperlinks: When I receive an email from Optimal Trace
Workaround: This is most likely because your virus checker is stripping out the URI
links in the email as it thinks they might be malicious. To fix this
Only 500 search results are returned from Optimal
Workaround: this is configurable
Merge problem creating the same Custom Property in
both on-line and off-line projects: If you create a customer property 'A' in both an on-line and off-line
Workaround: Although both Custom Properties have the same name, internally they are different objects as they were created in two different versions of the project. Try to avoid creating Custom Properties with the same name in on-line and off-line projects.
Uninstall fully removes URI registry keys: If you uninstall Optimal Trace
Workaround: To re-register the 'Optimal Trace' URI setting in the registry
Optimal Trace won't start if you have a shortcut to
Desktop on your desktop: If you have a
shortcut 'Desktop' on your desktop
Workaround: This is a bug in the underlying java JDK version used in Optimal Trace
(see http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5065874). To get Optimal
Trace to start correctly
Cannot split Custom Properties in Document Generation: Note that you cannot split up Custom Properties in a generated document, i.e. you can't have property values spread across different tables.
Workaround: There is no workaround for this, it is by design.
Top of Doc Import Dialog Box hidden under word menu: Sometimes in Document Import, the Import Dialog goes "under" the Word menu bar.
1) click on the document in word
2) click on the import tool
3) Try to keep the import tool away from the Word menu bar, where it can get 'overlapped'
Word changing views in Document Import: Sometimes Word automatically changes a document's display mode to Normal View, and turns on the Reviewing Pane. This will appear to the User as though all the Comments have disappeared from the right hand side of the window, and reappeared in a new Pane on the bottom.
As Word makes this change silently & automatically, based on the current state of a particular document, it is difficult to intercept and filter out. It does not seem to happen very often.
Workaround: To change the display back to the previous settings, the user will need to:
1) Select View->Print View
2) Select View->Toolbars->Reviewing to display the Reviewing Toolbar. On that toolbar, click 'Show' and toggle the 'Reviewing Pane' switch.
Cannot invoke Doc Import wizard with restricted permissions: If the user is importing into a remote, secure project, then they will need
full Permissions (modify) for the whole project.
Workaround: try the following:
1. Take the project offline (this gives full permissions)
2. Do the import
3. Merge the project back to the repository. The merge window will take care of any changes to which you do not have remote Permissions.
Importing into remote Project: If the user is importing into a remote project, it is possible for another user to interfere with their import. If the second user locks and edits something, the first user will be locked out from their Doc Import Merges. A "project locked" message will be displayed every time, even if the second user hits Save.
Workaround: There are 2 workarounds:
1) Save your Word doc, hit Close in the OptimalTrace import dialog, then restart the import.
2) Take the project offline, so you have a local snapshot with no multi-user locking issues. Import as normal. Then, merge the local project back to the Repository one.
Upgrading MySQL from MySQL 4.1 -> MySQL5.0: If your Optimal Trace repository uses MySQL 4.1 and you wish to upgrade to MySQL5.0, you cannot do so directly by just upgrading MySQL alone, as the Optimal Trace schema will not migrate ok.
Workaround: Do the following:
- Take all your Optimal Trace Repository projects off-line while the Optimal Trace Repository is using MySQL 4.1.
- Stop the Optimal Trace Server
- Install MySQL5.0
- Install a new Optimal Trace database in MySQL5.0 using the MySQL install scripts provided (see Server Help file for more details)
- Change your Optimal Trace Server settings to point to the new database (and restart the Optimal Trace Server)
- Upload your off-line projects back into the repository.
Document Import on Citrix/Terminal Server: When Optimal Trace 5.0 is installed onto a Citrix Server, the doc import component will only work for the User who performed the installation.
This is because the install process can only register the Doc Import dll for the current user. It has no way of knowing about all the other users, who will connect to the Citrix machine in future.
Workaround: Each of these users must log onto the Citrix Server as themselves. Then they must follow the instructions provided in Optimal Trace Help section 3.2, to manually register the dll. The next time they connect to Citrix (logged in as themselves) and run OT, the Doc Import component should be working OK.
Spell Check does not check Custom Property Templates: Spell Check will only check Custom Property Templates (i.e. the Custom Property Names, Definition, Default Value, etc) of a Package if that Package is not shared and there exists an element in that Package that has contains those custom properties.
Workaround: If you find this happening, create an element in the parent Package which is not being shared, and run Spell Check again. This will correct all sub Packages which are sharing with the parent Package.
Document Import: problems importing Project 'Owner' and Package 'Tag' fields: While importing a document, if you mark up the Project 'Owner' or Package 'Tag' field and that field contains a carriage return, newline, or tab, your imported Project may become corrupt.
Workaround: try to ensure that your imported 'Owner' field and Package 'Tag' does not contain these characters.
4.1 Plug-ins not migrated automatically: when you upgrade from Optimal Trace 4.1 to 5.0, any 4.1 plug-ins you may have installed are not automatically copied over to your 5.0 installation.
Workaround: You can copy over your existing plug-ins manually. To do this, copy the contents of your 'c:\Program Files\Compuware\Optimal Trace 4.1\plugins' directory to your new 5.0 'plugins' directory, e.g. ' c:\Program Files\Compuware\Optimal Trace 5.0\plugins'.
Document Generation: Performance Tips
documentation for very large projects
To do this
the priorities to high will prevent other running applications from getting CPU
time and you are effectively prevented from inter
Document Generation: General Tips
The following settings can be set that can solve issues appearing when dealing with Word document generation.
settings. The Word generation in
2. Spurious WinWord
processes. In many cases where issues are encountered
3. In cases where updates to word documents are
One way to decrease the size of a document is to
remove all the hidden Optimal Trace text. Note that when you do this
Navigate to the top of the document
- Make sure that both the 'Find' and 'Replace' fields are empty
- Select the 'More' button
- Select 'Format/Font' button to bring up the 'Find Font' dialog box
Click on 'Hidden' once
For all technical problems and support queries
Optimal Trace tm is a trademark of Compuware. All other trademarks are the property of their respective owners. Optimal Trace Support can be contacted on 1-800-538-7822.
Copyright© Compuware 2007. All Rights Reserved.