Open topic with navigation
A Relativity application consists of objects used alone or in conjunction with each other to store and manage information other than document metadata. You can add these customizable and securable objects to workspaces as you build an application. Using the Application Deployment System (ADS), you can package components added to your custom application. You can now easily deploy it to other workspaces or Relativity instances.
In the Relativity UI, you can create Relativity Dynamic Objects (RDOs), views, layouts, choices, tabs, and fields for inclusion in your application. You can also provide advanced functionality in your application by uploading custom code for event handlers, mass operations, and other features to Relativity. After you complete these steps, you can create an application, and then add these components and your custom code to it.
You can build different types of applications using the ADS. For example, you could build an application to structure evidence for a review. You could also build an application to manage a business workflow. It might reside in a workspace created specifically for system admins, so that they can manage their daily administrative tasks.
This page contains the following information:
You can create Relativity applications to perform specialized functions in a workspace. After you create an application, you can customize it by adding new objects to your application or linking to existing ones. See Add components to an application.
To create an application, you need the following permissions:
For more information, see
Use these steps to create an application:
The new application layout contains the following fields:
Note: If you don't enter a version number, Relativity automatically assigns one to the application when you export it. See Application schema versions.
User-friendly URLs provide you with the option of displaying easy to read and understand URLs. As a suggested use case, you can send an email message to your users that contains a simplified URL. This URL could link to a custom page in an application. For more information, see Basic concepts for custom pages.
If you enter MyCustomApplication in this field, users see custom page URLs that appear as ~/Relativity/apps/MyCustomApplication. However, you can continue to reference custom pages using the user-friendly URL, and the URL that contains the application GUID. For example, you can reference it as ~/Relativity/CustomPages/216ecac1-998b-4b67-980b-ada83b9a0f59.
Use these guidelines when working with user-friendly URLs:
|Ampersand (&)||Dollar sign ($)||Pipe (|)|
|Asterisk (*)||Equal sign (=)||Plus sign (+)|
|At sign (@)||Greater and less signs (< >)||Semi-colon (;)|
|Colon (:)||Question mark (?)||Tab|
|Comma (,)||Quotation marks (")||White space|
To view application details, click the name of an application on the Relativity Applications tab. These details also appear immediately after you create a new application. You can use the buttons at the top of the page to edit, delete, or perform other tasks with the application.
(Click to expand)
You can use the following buttons in the console for completing various administrative tasks. To find additional information about these tasks, click the links listed here to display content in the Relativity
Note: You need the appropriate system admin permissions to lock or unlock an application. You can't unlock system secured applications.
Note: After you add the application to the library, you can upload files to it from the Resource Files tab. See Resource files.
You can use the following buttons in the console for completing these development tasks:
You can customize your application by adding new components to it or by modifying its existing components. Before you start adding or modifying components, review these guidelines:
Use these steps to add components to an application:
Use the following associative lists to add custom functionality to your application:
The Application Event Handler list indicates the order used to execute a series of Pre Install or Post Install event handlers, and the execution type of each event handler. You can designate the order used to execute the event handlers of each type, such as run the first Post Install event handler then the second one.
The execution type determines when the event handler is run in the workspace. Event handlers set to run once are executed when you initially install an application. If the installation fails, these event handlers are re-executed until the application is successfully installed, and then no longer run. Other event handlers run every time the application is installed.
Use the New button to add Pre and Post Install event handlers to an application. The Add Install Event Handler pop-up provides you with the ability to select an event handler and to specify the order in which it is run. For more information, see Develop application event handlers.
Use these guidelines when working with mass operations:
A mass operation may also require a custom page tied to a specific application. In this case, you must also select only mass operations in the domain tied to your application. For custom pages, you need to verify that the URL or page works properly, because you won't see an error if you select a mass operation that isn't tied to the domain. See Develop Mass Operation handlers.
Use these guidelines when working with saved searches:
Note: Minimize the number of indexes that you use when adding saved searches. Ensure that any indexes added to the workspace where you are developing saved searches have unique names. Relativity uses the name of the index when mapping the index to a saved search. As a best practice, consider naming the index based on its type, using dtSearch or Analytics to identify it.
After installing an application in a workspace, you can move the saved searches that it contains to different folders in the saved search browser. The Path column always displays the current location of the saved search.
You may want to provide documentation that describes the optimal set up for the saved searches included in your application. It may include information about the type of indexes needed, and the settings that you want used on these indexes. If your application is installed on a workspace that doesn't contain any indexes, the user needs to set several properties on the created shells. The user may also want to modify the properties of an index mapped to a saved search even when the index already exists on a workspace. Use your application documentation to provide guidelines about these modifications or optimizations to your users. For more information about setting index properties, see
During installation, Relativity creates the folder structure that you use to organize saved searches in your application. It identifies a folder by referencing its GUID, which was assigned when the folder was created by a previous installation. Relativity creates the folder if it doesn’t find one with a matching GUID in the workspace. Otherwise, it adds any new or updated saved searches to the folder as necessary, even if the user has moved the folder to a new location in the saved search browser.
You can export only Relativity applications that contain valid and exportable components, such as fields, scripts, layouts, views, object types, object rules, choices, event handlers, and tabs. When an application contains invalid components, you can't export it. The following table lists the requirements for valid application components. You can use them to determine that the application is exportable, and to troubleshoot application errors. See View application errors.
Note: You can always export agent types, custom pages, and Relativity scripts.
|Application component||Application must include...|
|Mass Operations handler||