Publish and upload custom pages

To make your custom pages available to users, you need to publish the page to a specified location. Next, you upload it to a Relativity application. You can also use the PushResourceFiles() method on the RSAPIClient to add a custom page programmatically. See Use the Application Deployment System through the Services API.

This page contains the following information:

Publish your custom page project

You need to publish your Visual Studio project that contains your custom page before you can upload the files to Relativity.

  1. Open your custom page project in Visual Studio.
  2. In Solution Explorer, right-click on your project and click Publish.

    Publish menu option

  3. In the drop-down box, select New and enter a name in the New Profile box. Click OK.

    New Profile dialog

  4. Select a Publish Method.
  5. Click ellipsis button to choose a location for your published files.

    Connection options for publishing web applications

  6. Click Next and select Debug from the Configuration drop-down box.
  7. Click Publish.
  8. Navigate to the directory where you want to publish your web application.
  9. Add the contents of the parent directory to a .zip file. (Don't add the parent directory to this file.)

    parent directory for web application

  10. Complete the steps in Upload a custom page to Relativity.

Upload a custom page to Relativity

Use the following steps to add a custom page to a Relativity application:

  1. Select the Custom Pages tab.
  2. Click New Custom Page to display the Custom Page Layout. See Custom page layout fields.
  3. Click Save to view custom page properties. Relativity updates the Custom Page Link field so that it now displays a base URL. You can use this URL when creating tabs. For more information, see Custom page layout fields.

    Note: When you click Save, Relativity verifies that you haven't selected a restricted file type. An error appears if you select a restricted file type, or if you attempt to modify a custom page that is part of a locked application.

  4. To view the custom page, link it to your application. See Basic concepts for custom pages.
  5. Export the application. See Exporting applications on the Relativity Server2021 Documentation site.
  6. Import the application into another workspace to view your custom page. See Installing applications on the Relativity Server2021 Documentation site.

Custom page layout fields

The custom page layout contains the following fields:

dialog for adding a custom page

  • Name – the name for the custom page.
  • File – click Choose File button to select the file containing the source code for your custom page. You must publish your custom page before you can select it here. See Publish your custom page project. Optionally, click Clear button to remove the selected file from the field.
  • Custom Page Link – this field displays a base URL that you can use to link your custom page to a tab after you click Save. When you create a tab, you can copy this URL, and add a folder name or page name to the end of it. Relativity displays this page for users, when they click the tab associated with the path to the custom page that you implemented. For more information, see Use external tabs as links to custom pages.

    Note: If you add a folder name to the path, verify that folder contains the default page that you want displayed for users in the Relativity UI.

View or edit custom pages in an application

After you upload a custom page to an application, details view of the application lists it. You can add new custom pages, and link or unlink them from this view. For more information, see Create an application in Relativity.

Use the following steps to view or edit custom pages in an application:

  1. Open a workspace containing your application.
  2. Click the Relativity Applications tab.
  3. Click the name of the application that you want to view.
  4. Locate the Custom Page section on the details view of the application. It lists custom pages associated with the application.

    Custom Page associative list

  5. Perform one of the following tasks:
    • Click New to display the Custom Page Layout, where you can select a new page.
    • Click Link to associate an existing custom page with the application. On the Select Items dialog, select custom pages, and click Add. Next, select custom pages in the Selected Items section. Click Set to link the custom pages to your application.

      dialog for selecting custom pages

    • Click Unlink button to remove a custom page from the application.