Index Page for HTML Documents

When an HTML report is generated, then an additional index page is generated together with it, which allows for automatically jumping to a certain specified position (e.g. a certain plan) when opening the report in a web browser. The part of the report to which to jump may be located in any of the different HTML snippets the report may consist of. For the purpose of identification of the part to jump to the id of the part is used - hence it is not necessary to know at all, in which of the HTML snippets the part is contained.

However, to benefit from this advantage it is important to always use the index page for direct links into the report. Avoid using links to specific HTML snippets, because for such links it is not guaranteed that they remain stable when regenerating the report using different HTML splitting options or when the chapter structure of the project changes.

Here is an example of a direct link URL using the index page of the report:

file:///Y:/CarPart_Report/jump.html?uid=07aefb81007222a8012c2a9e1afffb54

The format of a direct link URL:

• The central index page generated by ARCWAY Cockpit as a part of an HTML report is always put into the root directory of the HTML report with the file name „jump.html“.

• If you store the report on a (Windows) network share, you have to add the prefix „file:///“ to the path of the "jump.html" to get a valid URL:

  • File path of the „jump.html“ file in the example:
    Y:/CarPart_Report/jump.html
  • URL of the index page in the example:
    file:///Y:/CarPart_Report/jump.html

• If you want to construct a URL, which opens the HTML report at a certain position (e.g. to show a certain plan) you have to add to further strings to the index page URL:

  1. The string „?uid=“
  2. The id of the part you want to jump to when opening the report. Such IDs are not predefined by ARCWAY Cockpit, but can be determined (within certain limits) by the author of the ARCWAY Cockpit report template.

• The ARCWAY Cockpit default report template uses the ARCWAY Cockpit internal UID of a Cockpit object as the id of the section containing the information concerning the object.
  An ARCWAY Cockpit internal UID is a string consisting of 32 hexadecimal digits. Example:

  07aefb81007222a8012c2a9e1afffb54

Determining an ARCWAY Cockpit Internal UID

The internal UID of a Cockpit object is usually not displayed in the user interface of ARCWAY Cockpit. To get access to the internal UID of a Cockpit object, nevertheless, a particular function has been added to Cockpit which copies the internal UID of a Cockpit object into the clipboard.

This function can be found in the view menu of the details view. To use it the Cockpit object in question must be selected to have it dislpayed in the details view.

By choosing the entry „Copy UID to Clipboard“ in the view menu of the details view the UID of the displayed Cockpit object is copied into the clipboard.