Release Notes

Inconsistent error message when cancelling word document generation and Word may crash: Depending on when you interrupt the document generation process, you may receive a COM exception returned from Microsoft Word and Word may crash.

Workaround: Ignore the exception from Microsoft Word, Optimal Trace Enterprise continues as normal. You may additionally need to stop the winword.exe process in Task Manager.

Document generation and form protected style template: When using a Microsoft form document as a style template for a document generation profile, Optimal Trace will not generate the document if the form is protected.

Workaround: Do not protect the style template form before generating.

Links don't work in generated document: If generating a form-based profile (e.g. Default Form), links in the document (e.g. Table of Contents, hyperlinks, etc) do not work.

Workaround: This is a known feature of Word forms. These links will not work if the document is protected. To allow working links, do not protect the form. Deselect the Protect Form toolbar button.

Incorrect macro security settings in Word can lead to application error: If generating a document from Optimal Trace and an exception occurs, ensure that the security settings in Word are set to Low.

Workaround: In Word, ensure that the macro security option is set to Low. For example, in Word 2003, choose the Tools>Macro>Security Settings. The Security Settings dialog box appears. Ensure that the option is set to Low.

Change History changes do not get included as part of a document update: Optimal Trace was designed to not include any Change History additions as part of a document update if that profile has a Change History element.

Workaround: Generate either a standalone Change History document or re-generate your document from scratch to see all the Change History entries.

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, restart Optimal Trace and re-try generating HTML or Save Image once again.

Timestamps on merging a reversed document: When reversing a document, the timestamp of all merge changes are taken from the document, even if the application has changed in the meantime (i.e. if the project in Optimal Trace is newer than the document).

Workaround: There is currently no workaround for this.

System clocks between Enterprise Server and Enterprise Clients need to be manually synchronised: If you notice a big disparity in the timestamps of certain Project objects while using the Merge tool in online/offline scenarios, please ensure the system clock on the machine with the Enterprise Server has the same time as the system clock on the Enterprise Client machines.

Workaround: Currently these system times need to be maintained manually

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 of projects, but may prove an annoyance.

Workaround: You need to open a new window (Window -> New Window) and close the original window and continue as normal.

Cannot add form fields to non-form document profiles: If you attempt to add form fields to a non-form document profile, Optimal Trace may not be able to reverse or update the profile.

Workaround: Avoid using form fields in non-form based profiles. It's perfectly ok to add custom fields to form based profiles, but just don't mix the two.

Table of contents page numbers can be incorrect: Sometime after updating or reversing a document, you may notice that the page numbers in the table of contents to not correlate correctly to the document content.

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.

Document Generation will fail if you use 'xxxxx' as a Requirement name: 'xxxxx' is a reserved word used internally by Optimal Trace document generation, and if you use it as a Requirement name in your Project, document generation will fail.

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.

Cannot update or reverse documents after Repository Save As: when you use the Repository 'Save As' functionality, this creates a new Project in the repository. Hence, you cannot reverse an existing document (or perform an update) using this Project.

Workaround: none.

'Hide Steps' option can cause instability when moving Steps: under certain circumstances, using the 'Hide Steps' Requirement option along with moving Steps can cause Optimal Trace to crash.

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, Optimal Trace also downloads the project's change history and docgen events. For projects with many changes, the change history and docgen events can comprise of data which is a couple of times larger than the project itself. This, obviously, affects the time it takes to download a remote project. If the change history and/or the docgen events are not needed locally, then the user may instruct Optimal Trace not to download these items. Note, when uploading and merging a local project to a remote project, the local change history and the local docgen events are not used - the merge tool generates change history items and docgen events corresponding to the merge result.

Workaround: To disable the download of change history and docgen events, follow the steps below:

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 Enterprise Edition)

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

Using the Change History in a Report: By default, the Project Change History is not passed to the Velocity Report generation engine. This is for performance reasons.

Workaround: to use the Change History from a new Report, change the 'passChangeHistoryToReportGenTemplates=No' setting in 'Default.properties' (located in the Optimal Trace installation directory) to 'passChangeHistoryToReportGenTemplates=Yes'.

Problems with 'Create Reserved Area' menu option in Word: To begin with, it's recommended to display hidden text before using this feature (Optimal Trace->Toggle Hidden Tags). This is because the caret may not be at the correct position, even though it looks fine without the hidden text on screen. What can happen, for instance, is that the Reserved Area gets inserted into the middle of another XML tag, which destroys the document's structure.

Workaround: In any event, most of the time Reserved Areas are unnecessary, as it is possible to insert text as-is into almost all areas of the document without needing any "wrapping". Reserved areas are mainly needed for the characters '<' ,'&', or similar input that would interfere with the document's XML structure.

The best approach is the following:

1.      Turn on hidden text

2.      Insert your new content as-is, at the correct caret position

3.      Save and close the document

4.      Try reversing the document into the corresponding Optimal Trace project. If any XML parse errors are flagged, click on the error location '...' button and wrap the offending text in a Reserved section.  This will presumably be the new content you have just entered. 

5.      If no errors were reported by the import process, then everything should be fine. You can either cancel or continue the merge process, as you like.

Problems with 'Replace IDs and Names' menu option in Word: Indiscriminate use of this feature can cause problems and leave the document in an invalid state, so use it with caution.

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.

4.      It will help to clarify exactly what 'Replace IDs and Names' does. It updates the IDs and names of any objects it detects in it's selection.  However it does not update the IDs of other objects that these objects refer to. So for instance, if you copy and paste a refinement, then selected the newly pasted area and click 'Replace IDs and Names', this new refinement will receive a fresh name and ID. However, it's source StepId and destination Requirement ID will not be updated. Therefore there will be 2 refinements starting from the same step and refining to the same Requirement, which is illegal.  This will show up as an error when this document is reversed into Optimal Trace. In this and similar situations, further manual editing of the document is necessary after 'Replace IDs and Names' has been run.

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.

Problems 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, there must be one already there for it to copy. The duplicated item will get a fresh name and ID, and if it's a Step, any affected Step position numbers will be updated. However it will not update any other properties of the duplicated object, so sometimes further manual editing is necessary.

Workaround:

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.

4.      The new branch will have a new name and ID, but the IDs of it's source and destination Steps will remain the same.   Therefore you now have 2 branches coming from the same Step and branching to the same Step, which is illegal. This will show up as an error when the document is reversed.

5.      The new branch will have to manually edited to correctly contain whatever sourceID and DestinationID are required.

Problems with manually setting tags to hidden in Word: Sometimes, if a document is being manually edited and the editing involves changing hidden text to visible text, or vice-versa, problems can occur. A typical problem is that even though only one word was changed from non-hidden to hidden, a large amount of the document surrounding that word automatically gets changed to hidden text as well. Including important Optimal Trace data such as the ActorList, for instance. Then, when the editing is finished and 'Optimal Trace->Toggle Hidden Tags' is selected, the ActorList will appear to have disappeared, as it is now rendered in hidden text.

The reverse problem can also happen, where a quantity of previously invisible content suddenly appears. Word is trying to automatically update the underlying style in that paragraph, rather than just update the selected text.

Workaround: - firstly, the document should always be backed up before commencing manual edits, as there are many traps like this.

To get rid of the immediate bad formatting, click undo until the document has reverted to it's state before the hidden-text edit had started.

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', 'Hidden', or 'Normal' but it could be any of the other types as well.  The style type of the selected text appears in the Formatting toolbar, which can be turned on under Tools->Customize->Toolbars.-

When the correct style type has been selected, click 'Modify...' and deselect the 'Automatically Update' checkbox.

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, and the user is fixing the errors manually.

Problem with validating a Skeleton Document that is already open: If your editing a Skeleton Document in Word, and you validate it in Optimal Trace (from the Document Settings screen), you risk loosing work as Word does not let you save and continue properly.

Workaround: avoid validating a Skeleton Document and editing it at the same time.

Project Elements appear in different order in Merge: under certain conditions, the Project child elements will appear in a different order in the From and To Merge Projects.

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, ensure that Hidden Text is unchecked. For example, in Word 2003 go to Tools>Options>Print to view the setting. For other versions of Word, refer to the Word help within the Microsoft product.

Canceling some actions in Optimal Trace does not release locks: if you do something in a dialog in Optimal Trace (e.g. move a Requirement) and then cancel the action, the objects in question will still remain locked by Optimal Trace.

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, for instance.

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, e.g. if you undo a Requirement delete, or if you paste a Requirement.

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 character (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/Word 2003 update problem: When updating a Word 2003 or Word 2007 document from Optimal Trace, I get a 'String too long' exception from Word.

Workaround: This is because of a bug in Word 2003 and Word 2007, which is detailed here: http://support.microsoft.com/default.aspx?scid=kb;en-us;163192. The workaround is to regenerate your document fully from Optimal Trace when this error happens, instead of using the Update feature.

When reversing a document, Package 'Tags' values do not get reversed: This is deliberate behaviour.

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.

Hiding paragraph ends in MS Word Templates: Paragraph ends must be hidden in Optimal Trace MS Word document templates. For example, the section in the skeleton docs between 'MainSuccessScenario_Template_Start' and  MainSuccessScenario_Template_End' currently ends with </MainSuccessScenario>¶  which is all hidden.  Note the paragraph symbol at the end. This paragraph character must be made un-hidden in the skeleton, otherwise Word gets confused when pasting this section into the generated doc.

Workaround: This appears to be a bug in Word, there is no workaround, you must keep the paragraph ends unhidden.

'Normal.dot read only' message: After generating a word document from Optimal Trace, I receive a 'Normal.dot is read only' message when I shutdown MS Word.

Workaround: This is a problem with Word, to fix it, run 'Help/Detect and Repair'

Notification emails do not contain hyperlinks: When I receive an email from Optimal Trace, there are no hyperlinks to Optimal Trace elements in the email.

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, consult your email Administrator and modify your virus checker settings.

Only 500 search results are returned from Optimal Trace Server, and I was expecting more.

Workaround: this is configurable, to return more results, edit 'default.properties' in your Optimal Trace Enterprise installation directory, and set 'reposSearchMaxReturn' to whatever number you want.

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 project, when you merge those projects Optimal Trace merge does not merge correctly.

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, it fully cleans up the windows registry. However, if you have a previous installation of Optimal Trace (or an installation of Optimal Trace Professional), the URI's will stop working. This is because the newer uninstall would of removed the 'Optimal Trace' URI setting.

Workaround: To re-register the 'Optimal Trace' URI setting in the registry, it is necessary to re-install the older version of Optimal Trace.

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.

Workaround:

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.

5.0 Plug-ins not migrated automatically: when you upgrade from Optimal Trace 5.0 to 5.1, any 5.0 plug-ins you may have installed are not automatically copied over to your 5.1 installation.

Workaround: You can copy your existing plug-ins manually. To do this, copy the contents of your 'c:\Program Files\Compuware\Optimal Trace 5.0\plugins' directory to your new 5.1 'plugins' directory, e.g. ' c:\Program Files\Compuware\Optimal Trace Enterprise Edition\EN\plugins'.

Workaround: Elevate user privileges to Administrator. Right-click either the cmd.exe when running via the command prompt or the setup.exe of the media browser to change privileges.

Workaround: Use the appropriate command line name of Optimal Trace Command Line Report.exe when invoking a report. 

Additionally,  

• The utility is designed to generate reports in projects that are in an Optimal Trace repository (database).  Do not use the utility on Optimal Trace local projects. 
• The username and password parameters used by the utility are the Optimal Trace application username and password, not the Optimal Trace database username and password.