Summary

References enclosed in curly (or square) brackets can be added as text to documents, allowing the creation of autolink hyperlinks so that users can select the hyperlink and be taken to the relevant target document or Opus 2 Transcript. 

When running the Autolink tool, a Hyperlink Report would be created, listing all of the references found enclosed in the relevant bracket type, confirming if the hyperlink was successfully created or not. 

The Autolink tool scans the OCR'd data of a document, finds text within the relevant bracket type and then attempts to match the references to metadata assigned to documents. 

We've set out the formatting requirements and best practices for linking to both documents and transcripts, alongside information on our Hyperlink Overlay tool and the wider hyperlinking process. 

We strongly recommend the parties provide an example document which should contain a few hyperlink formatted references. The Solution Operations team can then check the formatting and test the links, before the parties undertake the wider referencing exercise. 

Contents

  1. General Formatting Requirements
  2. Hyperlinking to Documents
  3. Hyperlinking to Transcripts
  4. Important Points to Note
  5. Hyperlink Overlay Feature
  6. Overall Hyperlinking Process

General Formatting Requirements

In order for our Autolink tool to successfully detect and link a hyperlink ready reference, it must be:

  1. OCR'd (text searchable);
  2. enclosed in curly (or square) brackets; and
  3. contain a reference value that matches metadata assigned to the target document or transcript exactly.

If the reference is not OCR'd or is not enclosed in a relevant bracket type, the Autolink tool will not be able to detect the need for a hyperlink and therefore a link will not be created, as well as the reference being omitted from the Hyperlink Report. 

If the reference is OCR'd and is enclosed in a relevant bracket type, but the reference value does not match metadata assigned to the target document or transcript, the link will not be created but will be included in the Hyperlink Report, albeit detailed as 'Not Found'.

Hyperlinking to Documents

Hyperlinks can be made either to the general document or a specified page or page range:

  1. Referencing the General Document - When referencing the general document (rather than specifying a page), the hyperlink will open at page 1 by default and needs to be in one of the following formats:
    1. {Bundle/Tab} Pagination - Bundle A, Tab 1 would be {A/1}.
    2. {Document ID} or {Exhibit ID} - Document ID C-001 would be {C-001}.
    3. {Magnum ID} - Magnum ID M_000123 would be {M_000123}.
  2. Referencing a Specific Page or Page Range- Hyperlinks can be made to a page or page range so that when the link is selected, the specified page opens: 
    1. Referencing a Page - Link to a specific individual page by including a forward slash and page value before the closing bracket. 
      1. For example, Bundle A, Tab 1, Page 5 would be {A/1/5} or Document ID C-001, Page 8 would be {C-001/8}.
    2. Referencing a Page Range - Link to a specific page range by including a forward slash and page range separated by a hyphen (-) before the closing bracket. When selecting the link, the first page in the range would open and the end of the range simply shows the end of the intended range. 
      1. For example, Bundle A, Tab 1, Page 2-10 would be {A/1/2-10} or Document ID C-001, pages 3-5 would be {C-001/3-5}.
When viewing a document on the platform, users can quickly copy the pagination value (and other document stamps) in curly brackets to the clipboard by selecting the Link icon on the right of the purple toolbar and pressing the relevant value.

Hyperlinking to Transcripts

Hyperlinks can be made to either the general transcript or a specified page or page range:

  1. Referencing the General Transcript - When referencing the general transcript, the full reference needs to be populated and in the following format:  
    1. {DayX/Page:Line} - Day 5, Page 1, Line 1 would be {Day5/1:1}.  
      1. Day Value - The Day must include the full value assigned on the platform. 
        1. For example, Day 3CMC3 would be {Day3CMC3/14:7} or Day 1LH1 would be {Day1LH1/120:15}.
      2. No Line Value - Whilst we recommend including a line value for clarity, the line value is not required however the colon character (:)is. 
        1. For example, Day 5, Page 1 would be {Day5/1:} . 
  2. Referencing a Page Range - When referencing a page range, the range must be split out into two separate references, being for the first and last page in the range, being separated by a hyphen and a space on either side of the hyphen:
    1. For example, {Day4/33:15} - {Day4/34:6} for Day 4, page 33, line 15 to page 34, line 6.
  3. Referencing a Line Range - When referencing a line range on the same page, it can be done using one reference with a hyphen between the line range (with no spaces):
    1. For example, {Day4/34:6-20} for Day 4, page 34, lines 16 to 20. 
References to Opus 2 transcripts on the platform should only be added to documents when all outstanding transcript amendments, if any, have been finalised as the references will be subject to change until all amendments have been actioned.

Important Points for Referencing

For all references being inserted, the below points need to be followed: 

  1. Spaces in References - Ensure no spaces are included within a reference.
  2. Hyphens in References - Ensure hyphen (-) characters are used when referring to page ranges or separating two references.
    1. En dashes (–) and em dashes (—) will not be identified by our tool and the hyperlink will not be created. 
  3. Multiple References - When including multiple separate references, with or without punctuation, ensure there is a space between references so that each individual reference can be detected. 
    1. For example, {Day4/33:15} {B/2/22} {C/3/33} or {Day4/33:15}, {B/2/22}, {C/3/33}.
  4. Website Links - Links to websites will be lost upon upload and Opus will need to be instructed to create a manual link on the document if required on the platform.
Parties will need to instruct the Solution Operations team via an instructional email to activate the web links. The instruction should include the Bundle/Tab/Page location of the text to be linked as well as the relevant link to be activated.

If your references do not include the Bundle/Tab pagination value, i.e. instead being Document ID, Exhibit ID or Magnum ID etc, the Hyperlink Overlay tool can be enabled to automatically include the Bundle/Tab/Page value of any link in the right margin. 

The activation of Hyperlink Overlay is free of charge and the parties need to send a joint instructional email to the Solution Operations team so the tool can be enabled across the workspaces. 

The overlay does not change the content of the underlying document itself and if it needs to be included in an export, it must be toggled on within the Export settings window per export.

More information on Export settings can be found here.

Overall Hyperlinking Process 

  1. Upload Documents - The parties would need to prepare and provide PDF documents containing hyperlink ready references for upload, i.e. update the Word version (to be provided as a PDF) or insert text boxes into the margin of a  PDF. Within the instructional email, confirm which documents need hyperlinking as we do not automatically run the linking process on upload. 
    1. We are happy to initially receive documents that do not contain hyperlink ready references as these can then be replaced with the referenced versions at a later date. 
    2. Upon replacement, any user annotations made on the original document should be automatically transferred to the updated version during the replacement exercise, on the basis that the content and OCR data of the new file is not substantially different from the existing file on the platform.
  2. Run Autolink Tool - Once uploaded / replaced, Opus will run the Autolink tool across the relevant documents to detect and attempt to link any hyperlink ready references, listing the results in a Hyperlink Report. 
    1. Hyperlink Report - The report will contain a Summary page for the processed documents (detailing the number of Total References, Broken Links and Created Links) alongside individual reports (detailing any references detected and an Opus 2 Comment confirming the status of each link): 
      1. Created Links - Any references that are correctly formatted will be hyperlinked and listed as Linked in the report. 
      2. Broken Links - Any references that are incorrectly formatted will not be hyperlinked and will be listed as Not Linked in the report. 
  3. Fixing Incorrectly Formatted References - Any references that are incorrectly formatted can be addressed in one of two ways:
    1. Fix the References - The parties can amend the incorrectly formatted references in the offline PDF which is a more robust way to resolve any issues and allows for functionality on the platform, therefore being the recommended resolution.
      1. PDF Version - Ensure the PDF being updated does not have the Opus 2 pagination already applied.
      2. Provide for Replacement - Once amended, provide to Opus for replacement and include instructions to re-run the hyperlinking process. This will create any new hyperlinks and only the new links will be billable, you will not be charged again for any hyperlinks already created.  
      3. Amending References with Created Links - For any existing created hyperlinks that have been subsequently amended, the Autolink tool will not identify them as needing to be re-created. As such, the parties will need to flag any instances where this occurs in order for the outdated hyperlink to be removed and the newly updated hyperlink to be created.
    2. Manual Hyperlink - The parties can provide the correct reference and instruct us to create the hyperlink(s) manually. Although the hyperlink will direct the user to the correct document, the reference will not change on the face of the document. Also manual links are unstable so if the document needs to be replaced in the future, the parties will need to instruct us to create the manual links again.

More information on replacing documents can be found under the Replacements section here.