Build your first application

This tutorial familiarizes you with functionality in the Relativity UI that supports packaging multiple components in a custom application. It illustrates how to create a simple application that includes two Relativity Dynamic Objects (RDOs). These RDOs share a many-to-many relationship between them. It also shows you how to export the application as a RAP file that you can use to install the application in another workspace.

This page contains the following information:

Before you begin

Complete the following tasks depending on your development goals:

  • Obtain access to an instance of Relativity used for development purposes. In Relativity, obtain the appropriate system admin permissions to install an application. For more information, see Security and permissions on the Relativity Documentation site.
  • Familiarize yourself with the Relativity UI. If you want to enhance your basic application, you can create components through the Relativity UI and add them to your application.You can find additional information about the following components on the Relativity Documentation site:
  • Learn about adding custom code to your application. See these tutorials for information about adding agents, event handlers, and custom pages to your applications:

Build an application

  1. Open the Relativity instance used for development.
  2. Create a new workspace. You can also use an existing workspace to deploy your application. For more information, see Workspaces on the Relativity Relativity Documentation site.
  3. Click the Relativity Applications tab.
  4. Click New Relativity Application.

    dialog for creating an application

  5. In Application Type field, click Create new Application.
  6. In New Application Name field, enter My Sample Application.
  7. Click Save to display the details view of the application. After creating an application, you can add new Object Types and their related schema objects, such as views, layouts, and tabs.

    New button on Object Type associative list

  8. In the Object Type associative list, click New.

    dialog for creating an RDO

  9. In the Name field, enter Primary RDO, and click Save and Back. In addition to the Primary RDO object type, the details view displays the following components:
    • Name field
    • All Primary RDOs view
    • Primary RDO Layout
    • Primary RDO Tab

    (Click to expand)

    details view of the sample application

  10. Repeat steps 7 and 8 to add another RDO called Secondary RDO. You should see both the Primary RDO and Secondary RDO listed under the Object Type associative list.
  11. To create a relationship between the Primary and Secondary RDOs, click New on the Field associative list.

    dialog for creating a relationship between RDOs

  12. Enter or select the following information for the field:
    • In the Object Type field, select Primary RDO.
    • In the Name field, enter Primary RDO to Secondary RDO.
    • In the Field Type, select Mulitple Object. Relativity now displays the Associate Object Type field.
    • In the Associate Object Type field, select Secondary RDO.
  13. Click Save and Back to display the application details view. The Field associative list now includes two new objects with a many-to-many relationship between the Primary and Secondary RDOs. You can export your simple application from this workspace for installation in other workspaces.

    list of RDOs in the Field associative list

  14. To create an application file, click Export Application in the console.
  15. Click Export in the conformation message.
  16. Use the browser prompts to select the location where you want to save your application file. You can use this file to install or import your application to another workspace.
  17. Create a new workspace where you want to install your application. For more information, see Workspaces on the Relativity Documentation site.
  18. Click the Relativity Applications tab.
  19. Click New Relativity Application.
  20. In Application Type field, click Import from File.
  21. In File field, click Browse and select your new application file. After you select the file, Relativity displays the metadata for the application that you want to import.

    list of application metadata for import

  22. Click Import. Relativity imports the application and displays the components that it successfully updated or created.

    list of components updated or created during import

  23. Click View Application Details. The details view includes all the application components that were exported from the previous workspace. In addition, Relativity added a new tab called My Sample Application. This tab includes sub-tabs for the Primary and Secondary RDOs imported to the workspace.

    detail view of sample application with RDO sub-tabs