Options
All
  • Public
  • Public/Protected
  • All
Menu

Changes To Integration Development

Changes to Integration Development

Use the information on this page to learn about changes to the development process for viewer integrations.

This page contains the following information:

Legacy versus new review integrations

The legacy and new review interfaces differ in the following ways:

  • Legacy review interface - In this interface, you could use the Page Interaction event handlers on the Document object to run custom code in the document layout, also called the coding pane. Additionally, you could use them to write advanced integrations with the document viewer application.

  • New Relativity Review Interface - In this interface, Relativity Forms renders the coding pane instead of the legacy forms engine. The legacy Page Interaction event handlers on Document object won't run when the new Relativity Review Interface is loaded. However, they continue to run when the legacy review interface is loaded.

    In the Relativity Review Interface, legacy Page Interaction event handlers on the Document object are replaced by the following extensibility points:

Relativity Forms Page Interaction event handlers

In the Relativity Review Interface, Relativity Forms renders a coding card. In Relativity Forms, the Page Interaction event handlers have a different API than that used for the legacy forms engine.

You can still use the legacy Page Interaction event handlers to modify the document layout, but don't use them to deliver review integrations.

Note: The Relativity Forms Page Interaction event handlers on the Document object won't run when the legacy HTML5 document viewer is loaded.

For more information, see Relativity Forms API on the RelativityOne Developers site.

Relativity Review Extensions

Relativity Review Extensions are a new extensibility point delivered as a part of the Review Interface application. They leverage application resource files. If you have used Forms Page Interaction event handlers, you will be familiar with process for implementing Review Extensions.

Use the Review Extensions as a way to deliver your Review Interface integrations. For more information, see Extensions.

Next steps for migration

To begin migrating your legacy HTML5 document viewer integration, see Migration Guide.