Link Inspector Query
The Link Inspector query enables you to view the status of all hyperlinks and cross references, and make any necessary changes prior to publishing.
The query shows the link status for links created with Linking plug-in (PDF) , Linking add-in (Word), native Word cross references, and internal (intra-document) native Adobe links.
You can run the Link Inspector query at the assembly, folder, leaf, volume, or document level. However, Link Inspector shows only the links within the selected element.
When a document has been modified, it must be saved as a different version in order for the changes to appear in the Link Inspector query.
Hyperlinks or cross references targeted to documents that do not exist in the current assembly, or that are targeted to versions of documents that do not exist in the current assembly, show as invalid links in the Link Inspector. They may be easily corrected by bulk retargeting them to the same destination document. This resets the target document to the current version assigned in the assembly.
To minimize confusion, unresolved links where the link source exists outside the current assembly do not appear in the Link Inspector query. The current assembly is based on how you last refreshed the query from Prepare for Publish:
— If you refreshed the current sequence view only, the query shows only links in the current sequence.
— If you refreshed the entire working assembly, stale links that target documents in the current assembly are also displayed.
In some cases, the link text does not come through from the PDF. This can occur when:
— The text under the link is an image that cannot be interpreted by the OCR. — The text is not completely under the link.
— The text is Japanese or Eastern characters.
Refresh the Link Inspector Query
You can use the Link Inspector query to view updated links in the current sequence or the entire assembly.
When refreshing the Link Inspector query from Prepare for Publish, there are two options:
— Current Sequence View Only is recommended for life cycle sequence assemblies. This refreshes only links in the current sequence/publishing view and not the entire working view. For standalone or non-life cycle assemblies, this option does not refresh anything.
— Entire Working Assembly is recommended for standalone and non-life cycle sequence assemblies. This refreshes the entire assembly for link changes. For life cycle sequence assemblies, this is useful to allow an impact analysis to be made against older documents that link to current documents for possible inclusion of these documents in the latest sequence. However, this should be used sparingly within life cycle sequence assemblies because it may take much longer to refresh this linking information during the Prepare for Publish process.
Note: You must refresh link information using Prepare for Publish at least once before running the Link Inspector on an assembly.
Run the Link Inspector Query
You can use the filters in the Link Inspector to view specific links, or specific types of links.
Warning: Always run a DMS synchronization before refreshing the Publishing Readiness query, Link Inspector query, and other queries. Ennov InSight uses the data available in the Ennov InSight database and relies on DMS synchronization to ensure this information matches what is in the DMS for each document.
To run a Link Inspector query:
- Right-click a folder, leaf or document and select Run Link Inspector.
- Select the filtering options.
- Click Search. All the links that meet the search criteria are displayed.
Link Inspector Action Buttons
You can use the Link Inspector to edit or delete links in your assembly.
| Button | Name | Description |
|
Retarget Links | You may change the location of the target document to a leaf or bookmark. To find an assembly, click the Search tab and use the Search Assembly wizard. See Searching for an Assembly. |
|
Edit Link Applicability |
You may change where the link is applicable (for example, globally to each occurrence of the link pair in any assembly or for this application only). |
|
Edit Link Profile | You may modify the link properties to change the profile to change settings for each link either individually or through the multi-select checkbox. |
|
Edit Link Output Channel | You may modify the link properties to activate or deactivate output channels for each link either individually, or through the multi-select checkbox. |
.jpg)
|
Delete Link | Existing information about this link will be deleted. |
Link Statuses
Ennov InSight uses flags in the results of the Link Inspector query to show the status of links.
| Status Flag | Description | Details | Examples |
| OK | Link Targeted and Current | Link is targeted to resolvable location in the current or working assembly. Link is current with latest document rendition and the target document has not been updated since the link was established. |
— Both documents exist in DMS. — Link points to valid page, leaf or bookmark in the target. — Source and target are both assigned in the same sequence. |
| OK | Link Suppressed | Link has output channel set to None. | Same as Link Targeted and Current but output channel set to none. |
| Status Flag | Description | Details | Examples |
| Warning |
Link Life cycle AutoUpdate (Historical Link Scenario) |
The link targets a document in an Ennov InSight assembly in the current Application, but not in the current sequence. In this scenario the target is linked to by a source that's been included in a prior sequence in the same Application. Ennov InSight life cycle auto-updates this link to resolve correctly to the already-submitted document. |
— Both documents exists in DMS. — Source document assigned in original sequence. — Target document not assigned in original sequence. — Target document assigned in current sequence. — Source document not included in current sequence. — Prepare for publish is run on the working or sequence view of the current sequence. |
| Warning |
Link Life cycle Auto- Update (Stale Link Scenario) |
The source link (bound to current) targets a document in an Ennov InSight assembly, and the target document is bound to current and replaced in the second sequence with a new version of the target which is now bound to current. Ennov InSight will life cycle auto-update this stale link because it considers this link to be following the latest replaced version of the document. |
— Both documents exists in DMS. — Source and target document assigned in original sequence. — In current sequence an updated version of the target document is replaced with the "current" (label) document. — Source document not assigned in current sequence. — Prepare for publish is run on the working view of the current sequence. |
| Status Flag | Description | Details | Examples |
|
Note: When two or more sequences exist in a working assembly, and an authoring link in two different source documents point to the same target document, adding a new leaf with an updated version of the target document will cause the Lifecycle Auto Update status to display "auto updated" in the inspector report when Prepare to Publish is run. This is expected behavior, because: * Both documents exist in the DMS. - The target document was assigned in the original sequence. * In the current sequence, an updated version of the target document is replaced with the "current" (label) document. * The source document is assigned in the current sequence. (Even though this document has just been added to the sequence, it will still be auto-updated because the target has been replaced. It is updated to link to the new version that is in the sequence.) * Prepare to publish is run on the working view of the current sequence |
|||
| Warning | Stale Link |
The source link targets a document in an Ennov InSight assembly, but the target document is bound to a specific version in the first sequence and replaced in the second sequence with a new version of the target which is now bound to current. InSight cannot life cycle auto-update this link because it considers this link to be bound to the old version. |
— Both documents exists in DMS. — Source and target document assigned in original sequence. — In current sequence an updated version of the target document is replaced with the "current" (label) document. — Source document not assigned in current sequence. — Prepare for Publish is run on the working view of the current sequence. |
| Error | Incomplete Link | The link is of comment type, not a document. | Comment link type |
| Error | Incomplete Link | Target document cannot be found in the DMS. | Target document does not exist in DMS. |
| Error | Incomplete Link | The link targets a document that is not resolvable when published (not contained in any known assembly). | Target document does not exist in the application. |
| Status Flag | Description | Details | Examples |
| Error | Target Missing | The link must be retargeted because either (1) the targeted bookmark was deleted from the document or (2) the targeted page (last page in the document) was removed from the revised document. | Specific destination in document does not exist. |
| Unknown | Link Modified |
The link has been modified in the Link Inspector since Prepare for Publish was run. |
— Change of link from the Link Inspector query screen without prior to running a prepare for publish. — Link Modified status will be updated once prepare for publish is run. |
| Unknown | Undetermined Link | Gives a status to links we cannot determine. | Scenario where none of the other descriptions applies. |
View the Link Inspector Query
When viewing the Link Inspector query, you can modify one or multiple links using the action buttons.
You can sort columns using standard Ennov InSight query functions. Please note that all columns do not appear by default.
| Column Name | Description |
| Character Encoding Status |
Indicates the status for each source or target link component: — Green - Character encoding appears to be correct. — Red - Character encoding update may be required. — White - Character encoding is not applicable. Either, the link is not an external link or the document contains no links. |
| Internal | Indicates if link source and destination documents are the same (intradocument link) or different (inter-document link). |
| Link Applicability | Displays whether the link pair and any modifications made through the Link Inspector are applicable globally to each occurrence of the link pair in any assembly or for this assembly only. |
| Link Code | A system-generated sequential number or alphanumeric equivalent unique to the link. |
| Column Name | Description |
| Output Channel | The output channels (paper/electronic) for each link. The user may modify the link properties to activate or deactivate output channels for each link either individually, or through the multi-select check box. |
| Source Assembly Name(s) | A system-interpreted, read-only field that displays the assembly names for the link source's assembly. |
| Source Description | A text message describing the link results based on the source flag and status. |
| Source File Path, Name and Version | The path, name and version of the bound document. |
| Note: If the source file name is too long to fit properly in the source column in the link inspector, go to the filter page and include Source Path and File name and Version as one of the selected columns for the query results. | |
| Source Filename | The name of the original document. |
| Source Flag |
Displays a color indicating the link status of each link source: — Green = OK — Yellow = Warning — Red = Error |
| Source Link Status | System-generated text based on the source flag. |
| Source Link Text | The underlying text of the link in the document. |
| Source Page Number | A system-generated, read only numeric field that displays the source page number of the link. |
| Source Sequence Number(s) | A system-interpreted, read-only field that displays the sequence number(s) for the link source's assembly. |
| Target Assembly Name(s) | A system-interpreted, read-only field that displays the assembly name(s) for the link target's assembly. |
| Target Bookmark | The target bookmark, if applicable. |
| Target Comment | This is available if a planned destination or comment exists. |
| Target Description | A text message describing the link results based on the target flag and time stamp when the query was generated. |
| Target File Path, Name and Version | If the target is a document element, this column contains the path, name and version of the bound document. If the target is a leaf element, this column contains the file name attribute on the leaf (if defined). |
| Target Filename | Name of the file that contains the link target. |
| Column Name | Description |
| Target Flag |
Displays a color indicating the link status of each link target: — Green = OK — Yellow = Warning — Red = Error |
| Target Link Status | System-generated text based on the target flag. |
| Target Page Number | The target page number (whether explicit or through a bookmark). |
| Target Sequence Number(s) | A system-interpreted, read-only field that displays the sequence numbers for the link target's assembly. |
| Time Stamp | The creation date of the record. This is displayed only once in the header of the query results. |
Character Encoding Status
You need to verify and update external links in documents created with earlier versions of Acrobat 8.
For external links in PDF renditions that were created with Acrobat prior to Acrobat version 8, non-Unicode encoding of the links may not be correct in Ennov InSight . When assigning a document to an Ennov InSight assembly, Ennov InSight extracts linking information from the PDF. During the extraction, Ennov InSight applies the default character encoding of the Windows operating system that is used on the Ennov InSight Rendering server that processes the job. As a result, the character encoding that was used when creating the links in the existing PDF rendition of the document may be different than the character encoding applied by Ennov InSight when performing extractions.
The purpose of the Character Encoding Status column of the Link Inspector query is to identify external links affected by this scenario. When the encoding of the external links is flagged by this column, the following actions can be taken:
— You can re-render the source document.
— You can re-target the links using the re-targeting functionality built into the Link inspector query.
— For source PDF files, you can update the character encoding using Linking plug-in (PDF), and then perform a DMS Synchronization to re-extract the links.