View Library View Table Of Contents View Index for This Manual View Previous Chapter in Book View Next Chapter in Book Open PDF to print book Search Cadence Library Email Comments Help Using Documentation Shut Down Cadence Documentation Server

CDSDoc User Guide, Product Version 2.1


7

Troubleshooting Cadence Documents

This chapter helps you answer questions about or problems with CDSDoc. It describes




Sending Comments to Cadence

If you have a comment or question about a Cadence document, or you find an error in a document, you can automatically send an e-mail to Cadence Publications about that document.

  1. Click Feedback in the command bar at the top or bottom of a Cadence document.

  2. In the Feedback form, type your comments.

You can optionally include your name and phone number, if you would like Cadence to contact you later with more information.

  1. When you are finished with your message, click Send to Cadence.

    You should receive an automatic e-mail response showing that a message was sent to Cadence Technical Publications. A representative from Technical Publications will contact you shortly via e-mail to follow up on your problem.




Cadence Customer Support and Training

Cadence customer support is available to all customers who have a software support services agreement. To contact Customer support, go to this site:

http://www.cadence.com/support


SourceLink: Online Technical Support

Discover the fast, effective way to get Cadence technical support online.

http://sourcelink.cadence.com


Cadence Training

To contact Cadence Education Services or see a course catalog, go to this site:

http://www.cadence.com/methodology/education

To send electronic mail to the Education Services group, use this address:

training_enroll@cadence.com



Debugging the Documentation

There are several things you can do to debug problems in your documentation. These steps are covered in detail in "Checking Your Installation" in Chapter 1 of the CDSDoc Configuration Guide:




Error Messages

CDSDoc displays error messages in a separate window. Following is a numerical list of error messages you might see, and their solutions.

Note:  If you cannot resolve these errors, please contact Cadence Technical Publications at cdsdoc_feedback@cadence.com

CDSDoc-001 Error Viewer is not responding

The web browser is already running but can't be contacted by CDSDoc because it is busy running another process, for example loading a large file over a slow network. If the browser does not respond in a reasonable amount of time, consider restarting your web browser.

CDSDoc-003 Warning Tag file is missing

The doc/cdsuser/cdsdoc.tgf file associated with this help call is missing. Read Chapter 3 of the CDSDoc Configuration Guide, "Customizing the Cadence Library," for more information about *.tgf files.

CDSDoc-004 Error Tag file is unreadable

The doc/cdsuser/cdsdoc.tgf file associated with this help call is not readable. The file permissions may be set incorrectly. Read Chapter 3 of the CDSDoc Configuration Guide, Customizing the Cadence Library, for more information about *.tgf files.

CDSDoc-006 Error Tag is missing

The entry for this help call is missing from the doc/cdsuser/cdsdoc.tgf file. Read Chapter 3 of the CDSDoc Configuration Guide, "Customizing the Cadence Library," for more information about *.tgf files.

CDSDoc-007 Error Unknown file type

The doc/cdsuser/cdsdoc.tgf file used to point a help call to a specific document listed a filetype for this help call that CDSDoc does not recognize. The valid filetypes are:

HTML for HTML files
MENU for a link that opens the CDSDoc Library window

In addition to these filetypes, there are filetypes for previous online document systems that may appear in some Cadence tools. These include:

FRAME for FrameMaker files in OpenBook online help
STATUS for system status messages

Read Chapter 3 of the CDSDoc Configuration Guide, "Customizing the Cadence Library," for more information about *.tgf files.

CDSDoc-008 Error Unsupported file type

The doc/cdsuser/cdsdoc.tgf file used to point a help call to a specific document listed a filetype for this help call that CDSDoc does not support. See CDSDoc-007 Error Unknown file type for more details.

CDSDoc-009 Error Unknown message type

The Cadence Silicon Ensemble tools support a special "quick help" message system. The *.tgf file used to point a help call to a specific document listed a message type for this help call that CDSDoc does not recognize. The valid message types are:

ERROR for error messages in Silicon Ensemble quick help
INFO for information messages in Silicon Ensemble quick help
QHELP for Silicon Ensemble quick help messages
QSTATUS for Silicon Ensemble quick help status
WARNING for Silicon Ensemble quick help warnings

Read Chapter 3 of the CDSDoc Configuration Guide, "Customizing the Cadence Library," for more information about *.tgf files.

CDSDoc-010 Error Unsupported message type

The *.tgf file used to point a help call to a specific document listed a message type for this help call that CDSDoc does not support. See CDSDoc-009 Error Unknown message type for more details about the message types.

CDSDoc-011 Error Unknown Token

CDSDoc identifies links between different manuals using a combination of a token and a directory name: $manualname. It substitutes the path to your installed doc directory for $, then searches for a directory named manualname. CDSDoc could not resolve the $manualname token for this link, possibly because the manual is missing from the /doc directory. The manual may be missing because it was not considered part of the documentation for your tool(s). Only those documents associated with a particular tool are installed.

CDSDoc-012 Error Document is Unreadable

The HTML document is damaged or unreadable. If the HTML file appears correct, check for permission problems.

CDSDoc-013 Error Document is Missing

The HTML file is not present in your doc hierarchy. The manual may be missing because it was not considered part of the documentation for your tool(s). Only those documents associated with a particular tool are installed.

CDSDoc-014 Error Message is Missing

CDSDoc reported an error but the error message is missing for that error. If you receive this message, please report it to Cadence Technical Publications at cdsdoc_feedback@cadence.com.

CDSDoc-015 Error Document has bad Syntax

Some Cadence applications, such as Silicon Ensemble, support a special "quick help" error message system. This message appears if the syntax in the source message document is incorrect. If you see this error, report it to Cadence Technical Publications at cdsdoc_feedback@cadence.com.

CDSDoc-016 Error Memory Error

The machine running CDSDoc had a memory error. Close some applications and try again. If this does not work, exit (if possible) and restart CDSDoc.

CDSDoc-017 Error Bad install directory

The directory containing the documents is damaged or can't be found. The directory should be named doc in your Cadence installation hierarchy. So, for example, if you execute CDSDoc from install_dir/tools/bin/, the corresponding doc directory is install_dir/doc. If the hierarchy is missing, you may need to reinstall CDSDoc for this release.

CDSDoc-018 Error Bad Handle

If you receive this message, there is a problem with the help call from the Cadence application to CDSDoc. Please report the problem to Cadence Technical Publications at cdsdoc_feedback@cadence.com.

CDSDoc-019 Error Server is not responding

The obServer program that supports CDSDoc can't be contacted; it is processing another request and is not responding back to the Library window. Wait for a moment and try again.

CDSDoc-020 Error Server can't start

The CDSDoc server program (obServer) can't be started. This program is used when Cadence applications make help calls to CDSDoc. Check the path to the program; it should be located at install_dir/tools/bin/obServer.

If the file is present, check the file permissions. It should be executable.

If the file is present and executable, you may be missing required operating system patches. Go to SourceLink at sourcelink.cadence.com and click on the "Recommended OS Patches" link in the Installation section.

If you have all required patches, please report this error to Cadence Technical Publications at cdsdoc_feedback@cadence.com.

CDSDoc-100 Error Invalid location

You used the CDSDoc Edit - Preferences command to set a default location for the Library window, but the location coordinates contain spaces, characters, or the fields are empty. Choose Edit - Preferences from the Library window and remove any blanks or special characters from the set of coordinates for the upper left corner of the Library window.

CDSDoc-101 Error Invalid size

You used the CDSDoc Edit - Preferences command to set a default size for the Library window in pixels, but the size values contain spaces, characters, or are empty. Choose Edit - Preferences from the Library window and remove any blanks or special characters from the settings for the width and height of the Library window.

CDSDoc-102 Error Invalid port

You used the CDSDoc Edit - Preferences command to set a default port value for the URL used when opening Cadence documents, but the value contains spaces, special characters, or is empty. Choose Edit - Preferences from the Library window and set the Advanced - Port setting to a number greater than 1024, with no special characters or spaces.

CDSDoc-103 Error Port ID less than 1024

You used the CDSDoc Edit - Preferences command to set a default port value for the URL used when opening Cadence documents, but the value is lower than 1024. Choose Edit - Preferences from the Library window and set the Advanced - Port setting to a number greater than or equal to 1024.




Solving Problems

The next sections answer questions about the following topics:

The questions listed here cover a properly configured version of CDSDoc. Errors due to problems in installation or configuration are describe in "Solving Installation Problems" in Chapter 4 of the CDSDoc Configuration Guide.

For bugs and their workarounds, see the CDSDoc Known Problems and Solutions.



Questions About Starting CDSDoc

I have Internet Explorer on my UNIX system, but CDSDoc won't use it.

The full-text Search engine used by CDSDoc does not support Internet Explorer on UNIX machines. The required browsers are listed in Chapter 2, "Setting Up Browsers and Helper Applications" in the CDSDoc Configuration Guide.

Whenever I start CDSDoc, the first screen I see in Netscape or Internet Explorer is blank

The CDSDoc Library window loads a blank html file into your browser as it starts. If you see this blank file when you first click on a document title, click on the document title again. The document will load in your browser.

This error can occur the first time you start the CDSDoc Library window if you are running the documents from a remote machine over a slow network. The long-term solution is to avoid running the documents from a machine that is physically remote (for example, in another city) from your own.

I clicked Back to go back to a Cadence document and I get an error message

The Cadence documents are "served" to you from the Verity search engine included in the system. When you exit the Cadence system by clicking Exit in the documentation window or at the top of a document, you shut down the Verity search engine.

Therefore, after you have clicked Exit, if you try to use Back to reopen that document, you will see a message similar to one of the following:

Netscape's network connection was refused by the server machinename.yourcompany.com:9000.
The server may not be accepting connections or may be busy.
Try connecting again later.

You must restart CDSDoc as described in Opening a Library.

Why don't my Bookmarks to Cadence documents work?

Cadence documents are "served" to you from the Verity search engine, which prepends a machine name and port ID number to all document URLs. The Bookmark includes this port ID. If you exit CDSDoc, the server is halted and the port ID addresses no longer work.

Restart CDSDoc and your bookmarks should work. If they do not, your system rotates the port ID each time CDSDoc is started. In this case:

  1. Set a fixed port ID for your documents using the Edit - Preferences command, as described in Setting the Port ID for CDSDoc URLs.

  2. Exit and restart CDSDoc.

  3. Reset your bookmarks using the new fixed port ID.

    The next time you exit and restart CDSDoc, it will use the fixed port ID and your bookmarks will work.



Questions About Opening Documents and Libraries

I opened a book by clicking Help. How do I display other Cadence documents?

The CDSDoc Library window lets you choose books to open. If the Library window is not displayed, click the button at the top of any document window.

See Chapter 3, "Opening Libraries and Documents," for details on how to open documents from the Library window.

By default, CDSDoc 2.1 does not display the Library window when you open a document with Help. See Displaying the Library window by default or suppressing display to set your preferences to display the Library by default.

I can't find a book I know I saw in the CDSDoc Library window before

There are two possibilities:

The list of documentation releases includes some that I don't use any more; I don't want to see them in my CDSDoc Library window

The list shown in the Active Library pull-down includes all Cadence documentation from releases you have previously viewed.

The list comes from either:

The file or registry entry is updated each time you start CDSDoc from a particular release hierarchy to include the paths of each installed Cadence release.

If the list includes a release you no longer want to use, you may remove that release name as follows:

      Open cdsdoc.ini in your text editor, and delete only the line containing the release you don't want to see. For example, you might delete: 
DocDir1=/net/myserver/usr1/cadence_install/ic4.4.6

I get a message "HTTP access denied"

If you see a web page with a message titled "Access Denied - The HTTP server has restricted your access to this document," there are several possible problems.

The most frequently-encountered problem is that you are running an older version of the Cadence documentation system in the background, and the https server is not able to determine which version of CDSDoc you want to use to open a document.

  1. Exit CDSDoc by clicking Exit in the Library window.

  2. Determine what processes are currently running and stop any CDSDoc processes running the in the background.

    UNIX

    Make sure there are not any processes named obServer or https running on your machine. If there are, stop them with the kill -9 command.

    ps -a
    PID TTY      TIME CMD
    4797 pts/2    0:00 obServer
    4823 pts/2    0:00 https
    ... [other processes omitted]
    kill -9 4797
    kill -9 4823

    Windows

    1. Press Ctrl-Alt-Del and open the Task Manager window.

    2. Check that there is no CDSDoc: Library or browser with a Cadence document or Cadence search process running. If there is, select each process and click End Task.

  3. Now you can restart CDSDoc, and the HTTP access message should no longer appear.

If you perform these steps and the HTTP access message still appears, then one of the other scenarios listed on the page may be true.

When I click Help, my iconified Netscape window doesn't "pop up" to display the document

If you display a help page in Netscape, then iconify Netscape, then attempt to reopen that help page by clicking Help again, the page remains iconified. This can sometimes happen inadvertently if two different Help buttons open the same Help page, and you have iconified the information after clicking the first Help button.

Since Netscape considers that it has already opened the page once, it will not pop the iconified page open again. To see that help page, you must re-open the Netscape window. Or, if you click on a Help button to display a different Help window, the page will pop open again.



Questions About Searching Documents

When I click Search from my document, I get an error message

If you see the following message:

Netscape is unable to locate the server machineName:9000
Please check the server name and try again.

The Verity Search engine has been shut down since you opened this document. For example, the Search engine is shut down when you click Exit in the CDSDoc Library window or at the top of a document.

You must restart CDSDoc to restart the Search engine. Start cdsdoc from your Cadence installation hierarchy as described in Opening a Library.

Search did not highlight or let me jump to the text it found

In some instances, you may see any of the following:

The full-text index used by Search includes all documents for all possible products in a Cadence release. When you install products, only the books for those products are installed. The query string sent to the search engine includes additional parameters limiting the search to just the books installed, or to just those books that you chose to search using the Search form, so that you do not get results for books you do not have or did not choose to search.

Depending on the number of books searched versus the number of available books in the index, the underlying query string sent to the search engine can sometimes exceed the number of characters that the engine can handle and still return the "first match" link, the highlighted words, or the blue arrows in the results file.

If this happens, do any of the following:

When Search starts, one or more products and one or more books are already selected; why doesn't it default to searching all books?

If you previously clicked on product and/or book names in the Search form to do a search on specific documents, then the next time you open the Search form it will still be set to search only those books or products you previously selected.

Click the All of the above buttons under the Families, Products, and Books fields to search all Cadence documents in this release.

The Search page and the Search results page don't show my last query.

The Search page and Search results pages both show the last query you entered by using JavaScript and "cookies." If your browser is set to prevent acceptance of cookies or prevent use of JavaScript, this information will not appear in the pages.

Other possible problems that may also be seen: The Search page is blank, or displays JavaScript code at the top of the page.

To see your previous query in the Search page, set acceptance of cookies on as described Setting Up Browsers and Helper Applications in Chapter 2 of the CDSDoc Configuration Guide.

After I used Search, I clicked my browser's Back button but the page won't go Back.

If you are viewing the Search page and click Back, the page will not return to the document page you were previously viewing. This is because each time you go Back, you reload the Javascript commands that load the Search page. Click and hold the Back button to see a list of the previous documents you have opened, then choose the document you want.

I don't see books in the Search window that I know I've seen before.

There are two possibilities:

I started Search from a book in my $HOME/doc or %userprofile%/doc, and I can't see any other books.

If the first book you open from the Library window is from your custom $HOME/doc (UNIX) or %userprofile%/doc library, then click Search from the navigation bar in that document, the Search window only lists the documents in your custom library. To include other documents from your full library in the search, click search in the Library window.

I opened a document from Search, clicked a link, and now I don't see my highlighted Search matches.

When you open a page from the Search results window, Search creates a temporary copy of the page that includes highlighting on all the words that match your query, and hyperlink buttons that jump between the previous and next matches. If, however, you click a link in the page to another document, or to another point inside this page, your web browser will jump to the original version of the page, without the Search highlights.

To see the highlights again, click your browser's Back button.



Questions About Document Appearance

The font size in my Cadence documents is too small / too large. How can I change it?

You control the font size displayed in Cadence documents using your web browser's defaults.

See Setting Up Browsers and Helper Applications in Chapter 2 of the CDSDoc Configuration Guide for more details.

I don't like the fonts displayed for Cadence documents. How can I specify my own?

Cadence documents use your Netscape or Internet Explorer defaults for variable-width fonts (for body text and headings) and fixed-width fonts (for text used in programming code examples).

See Setting Up Browsers and Helper Applications in Chapter 2 of the CDSDoc Configuration Guide for more details.

Whenever I start Netscape, the colors in my Cadence application look bad.

Cadence applications and Netscape share your system's colormap, that assigns colors to interface objects. If the colors in Cadence windows are difficult to view, you may want to set Netscape to use its own separate colormap. The trade-off is that a separate colormap can cause the screen to "flash" when you move the mouse between Netscape and Cadence applications.

To set the colormap default, see Controlling the Netscape colormap (UNIX only).



Questions About Printing Documents

Clicking View/Print PDF displays a dialog box asking about downloading or displaying. How do I suppress this box?

Your browser must be set to use Adobe Acrobat® Reader as its "helper" application whenever you click on a link to a PDF file. See Setting Up Browsers and Helper Applications in Chapter 2 of the CDSDoc Configuration Guide for more details.

Clicking View/Print PDF starts Acrobat Reader, but then an error message displays. Why won't the PDF file load?

You must use version 3.0 or higher of Acrobat Reader to display Cadence PDF files. Go to Adobe's website at www.adobe.com for instructions about how to download and install Acrobat Reader.


Return to top of page

View Library View Table Of Contents View Index for This Manual View Previous Chapter in Book View Next Chapter in Book Open PDF to print book Search Cadence Library Email Comments Help Using Documentation Shut Down Cadence Documentation Server


For support, see http://www.cadence.com/support or try Cadence's SourceLink service.

Copyright © 2003, Cadence Design Systems, Inc.
All rights reserved.
Legal notices and trademark attributions