First-time installation
Requirements
- Important! - Blackout 5.0 supports only Server 2022 and Server 2023
- Relativity Server 2024 support pending final Relativity Server 2024 release.
- All browsers supported by Relativity Server 2022 and Server 2023
- Must be installed from the Relativity system admin application library
What to expect
What you'll see
- Installation should only take a few minutes
- A new tab named "Blackout" has been added to the Relativity admin section
- A new schema will be added to EDDS called Blackout
- Blackout tables will be created using this schema in EDDS
- Several configurations will be added to the Relativity configuration table under the section Milyli.Blackout
SQL version support
Note: Blackout 4.8 and above, requires SQL Server 2016 with compatibility mode set to at least 130. To check the compatibility mode level of your SQL Server, you can run the following query:
SELECT name, compatibility_level FROM sys.databases WHERE [name] = 'EDDS';
To update the compatibility mode level, please follow these steps:
- Connect to your SQL Server using SQL Server Management Studio.
- Right-click on the EDDS database and select Properties.
- In the Select a page pane, click Options.
- In the Compatibility level drop-down list, select the desired compatibility level.
- Click OK to save the changes.
Alternatively, the compatibility mode can be updated using the following SQL script:
ALTER DATABASE [EDDS] SET COMPATIBILITY_LEVEL = 130;
Installing Blackout
Before you begin
- Ensure that you have received the Blackout RAP file shared with you from Milyli’s secure file sharing platform.
- If you have not received the RAP, please contact support@milyli.com.
- The file will be delivered by Milyli’s instance of Citrix ShareFile.
- Blackout must be installed through the admin level Relativity application library.
- Ensure that you have access before beginning
How to install Blackout
- Navigate to the Application & Scripts | Application Library tab in the Relativity Admin section.
- Click Upload Application.
- Click Choose File.
- Select the Blackout RAP and click the Open button.
- After the file uploads, click the Save button.
- Next to Workspaces installed click the Install button.
- Click the ... button next to Workspaces.
- Check any workspaces where Blackout may need to be installed.
- Click Ok.
- Click the Save button.
Submitting a license request
After successfully installing Blackout, a license request must be generated to retrieve a valid license from Milyli.
- Navigate to the Blackout | Configuration tab in the Relativity admin section.
- Click on Generate License Request.
- Click Copy License Request.
- Submit the license request body to support@milyli.com.
- Milyli will supply a license key in response.
- Click on Apply License.
- Paste the license key in the box.
- Click Apply Blackout License.
Pushing Blackout to a workspace
After applying the license Blackout can be installed into any workspace that you require.
Note: It is required to push Blackout to workspaces via the Application Library.
- Navigate to the Application & Scripts | Application Library tab in the Relativity Admin section.
- Filter for the Blackout Application and select it.
- Next to Workspaces installed click the Install button.
- Click the ... button next to Workspaces.
- Check any workspaces that Blackout needs to be installed on.
- Click Ok.
- Click the Save button.
Configuration
What to know
- To begin using Blackout after a fresh installation, Blackout will need to be configured with at least one Blackout Relativity agent that is available for ‘High Resource’ processing, which includes OCR-ing images and redacting Excel documents.
- The following steps will set up a minimally viable configuration that will ensuring Blackout will continue running.
Note: Full details on configuring and setting up your agents for Blackout is covered in separate section, Agent Configuration & Set up.
How to do it
- Navigate to the Blackout | Agent Configuration tab.
- This will display a page that has all of the registered and available agent servers on the instance
- Identify the agent server that you wish to install the Blackout agent to.
- Select the ‘Enabled’ checkbox.
- Ensure that the ‘Is High Resource’ checkbox is enabled.
- Blackout requires at least one agent server to be marked as high resource
- High resource agent servers will, in addition to all other actions, also perform OCR and Native Spreadsheet markups
- Click the ‘Save Configurations’ button.
- The ‘Blackout Agent’ will be deployed to that server and configure it with the default worker threads for that agent.
Verify the agent status
What to know
- The low priority worker count will be calculated as (# of CPU threads * 2) and the high priority worker count will be calculated as (# of CPU threads / 2) with a minimum of 1.
- You can validate the status of the agent, confirm its installation, and view the default worker counts it was installed by:
How to do it
- Navigate to the Server & Agent Management > Agents tab.
- Filter the application column to ‘Blackout’.
- The Enabled column will be set to ‘Yes’ and the Message column will read ‘Running (#:#)'.
- The first number represents the low priority workers and the second number represents the high priority workers.
- After verification, Blackout will be ready to use.