Publish to Relativity tool

The Publish to Relativity tool simplifies application development by storing a reusable configuration. You can use this configuration to upload custom pages and resource files to Relativity. It eliminates the need to export and reimport applications in order to deploy modifications to your applications. Instead, you can define application and connection settings, which are stored in the app.config file. The tool automatically uses this configuration to upload new or updated files to a Relativity application. You can use the Publish to Relativity tool to perform the following tasks:

  • Update an existing custom page in an application.
  • Add a new resource file or update an existing one.

This page contains the following information:

Before you begin

Before you can store a configuration for an application, complete these tasks:

  • Obtain the GUIDs for the following components:
    • Application GUID - Export your application from Relativity or publish it to the Application Library. You can use either of these processes to create a GUID for your application, which you need to specify configuration settings.

      Note: To obtain the GUID, use the ArtifactID of the application to query the ArtifactGUID table in the database associated with the workspace where you are developing the application. The ArtifactID is available in the query string that appears when you view or edit an application, or in the Artifact ID column when you add it to the Relativity Applications tab. In Developer mode, you can also obtain the GUID by clicking the Show Component GUIDs link on the application detail view.

    • Target workspace GUID - Deploy your application in a workspace. You need to complete this task so that the Publish to Relativity tool can add your custom pages or resource files to it. To obtain the GUID, use the ArtifactID of the workspace to query the ArtifactGUID table in the EDDS database. You can find the ArtifactID of the workspace in the URL bar of your browser after successfully navigating to a workspace. The URL lists the ArtifactID as the AppID. For example, the following URL contains the a workspace artifactID of 1018089: http://Example/Relativity/Case/Mask/EditField.aspx?AppID=1018089.
    • Custom pages - To obtain the GUID, use the ArtifactID of the custom page to query the ArtifactGUID table in the workspace database. The ArtifactID is available in the query string that appears when you view or edit a custom page. In Developer mode, you can also obtain the GUID by clicking the Show Component GUIDs link on the application detail view.

Add a new configuration

Use the following steps to add a new configuration:

  1. Double-click the PublishToRelativity.exe to launch the tool. See Before you begin.
  2. Complete the fields in the Application Settings section. See Application settings fields.
  3. Complete the fields in the Connection Settings section. See Connection settings fields.

    (Click to expand)

    Uploading resource files to Relativity

  4. Click Test Connection to verify that the application and connection settings are working properly. See Test application and connection settings.
  5. Add custom pages or resource files references to the configuration. See Add a custom page or Add a resource file.
  6. Click Save Configuration. This action saves all the settings currently defined in the Publish to Relativity file tool dialog, including references to any custom pages or resource files that you added.

Application settings fields

  • Configuration Name – the name used for identifying the configuration.
  • Application GUID – the identifier assigned to an application when you export it from Relativity or push it to the Application Library. For more information, see Build Relativity applications.
  • Workspace GUID – the identifier assigned to the target workspace where you want to add or update custom pages and resource files. You must have already deployed the application in this workspace.
  • Export Location – the directory to where you want to download the application. You can enter the folder path and the file name with the appropriate extension, such as a RAP file. You export applications containing custom pages as .rap files. For example, if you wanted to export any application with custom pages to your local hard drive, you enter c:\myapplication.rap.

    Note: You must specify an Export Location. The Publish to Relativity tool only exports an application when you specify a location.

Connection settings fields

  • Database Username and Database Password – the username and password combination used for logging in to the Relativity database server.
  • Database URL – the name or domain\name of the Relativity database server. For example, you might enter MyDatabaseServer or Relativity\ MyDatabaseServer.
  • Relativity Username and Relativity Password – the username and password combination used for logging in to the Services API.
  • Relativity URL – the URL for the REST API URL in your environment. For example, the URL uses this general format for RelativityOne:
    https://<mycompany>.relativity.one/Relativity.REST

Test application and connection settings

You can test the application and connection settings for a specific configuration. The Publish to Relativity tool includes a text box that displays a confirmation message when the tool successfully connects to the database and Services API. It also displays troubleshooting information when a database connection fails. General error messages may indicate that the connection to the Services API failed. Confirm that you have the correct username, password, and URL for this service. For example, see the error message that appears in the text box under the Connection Settings section:

(Click to expand)

Error message for failed Services API connection

Click Test Connection buttons in the Application Settings and Connection Settings sections. The appears next to the Test Connection button when the connection succeeds, while Failure icon appears when the connection fails.

Add a custom page

You can use the Publish to Relativity tool to update existing custom pages in your application. Follow these steps to add custom pages references to a configuration or remove them as necessary.

  1. In the Custom Pages section, click Add.
  2. Complete the fields in the Add Custom Page pop-up. See Custom Page fields.

    Note: You don't need to add your custom pages to a zipped file before deployment. Instead, choose the publish folder containing your custom pages.

  3. Click Add to include the custom page in the list box.
  4. (Optional) To delete a file from the list, highlight it and click Remove.
  5. Click Save Configuration to update the configuration with your changes.

Custom Page fields

  • Custom Page GUID – the unique ID that Relativity assigned to the custom page. You can use the Publish to Relativity tool to update existing custom pages in your application. See Before you begin.
  • Custom Page Folder – the folder path for the custom page that you want to upload. Click Browse to select the file.

Add a resource file

You can use the Publish to Relativity tool to add new resource files to your application or update existing ones. While you can upload most file types, certain types are restricted, such as .exe files. For a list of restricted types, see Resource files.

Follow these steps to add a resource file:

  1. In the Resource Files section, click Add. The Resource File pop-up appears.
  2. To select a file for the File Path field, click Browse. The File Path field displays the location of resource file that you selected.
  3. Click Add to include the file in the list box.
  4. (Optional) To delete a file from the list, highlight it and click Remove.
  5. Click Save Configuration to update the configuration with your changes.

Publish custom pages and resource files

You can publish custom pages and resource files using the configuration that you have created with the Publish to Relativity tool. When you select a configuration, the tool automatically populates all the setting and file fields with its current values.

If your configuration references custom pages, this tool uploads them to the web server hosting the Relativity instance. The value in the Relativity URL field indicates the location of this instance. See Connection settings fields.

Follow these steps to publish custom pages and resource files:

  1. Select a configuration from the Configuration drop-down list.

    Note: You won’t see any configurations listed in this drop-down when you use this tool for the first time. You must save a configuration through the tool in order to see it to the drop-down list.

  2. If you have added new custom pages or resource files to the configuration, click Save Config File to ensure your updates are included.

    Note: You don't need to add your custom pages to a zipped file before deployment. Instead, choose the publish folder containing your custom pages.

  3. Click Publish to upload your files to Relativity. Your application now contains the custom pages and resource files that you published.

Additional Resources

DevHelp Community GitHub Release Notes NuGet

Share knowledge with the Relativity developer community.

Access tools and resources to build an application.

Review the most recent product release notes.

Create .NET Apps faster with NuGet.