- Critical Requirement - Relativity 126.96.36.199 and newer
- Blackout 3+ takes advantage of several new API’s introduced in this version of Relativity.
- All browsers support by Relativity 188.8.131.52 and newer are supported
What to Expect
Blackout 3 introduces several new artifacts, components, agents, tables, and more upon installation. A comprehensive list of system changes is included at the end of the document.
- Installation should take just a few minutes
- A new tab named ‘Blackout’ will be 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’
Before you begin
- Ensure that you have received the Blackout 3.x RAP file shared with you from Milyli’s secure file sharing platform
- If you have not received the RAP, please contact firstname.lastname@example.org
- The file will be delivered by Milyli’s instance of Citrix ShareFile
- Blackout must be installed through the Relativity application library
- Ensure that you have access before beginning
- Navigate to the Application & Scripts | Application Library tab in the Relativity Admin section
- Filter on application name for “Blackout”
- Click on the application name
- Click the “Edit” button
- Click the “Clear” button
- Click the “Choose File” button
- Select the Blackout 3.x RAP and click the “Open” button
- After the file uploads, click the “Save” button
- You will be prompted to upgrade existing installations
- This action is required so click yes to begin the upgrade
- After Relativity has finished updating each workspace verify that the install status is “Installed” on each case before proceeding to the configuration section of this document
After successfully installing Blackout, a license request will need to 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 email@example.com
- Milyli will supply a license key in response
- Click on "Apply License"
- Paste the license key in the box
- Click "Apply Blackout License"
After applying the license Blackout can be installed into any workspace that you require. It is strongly advised to push Blackout into workspaces via the Application Library.
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. Full details on configuring and setting up your agents for Blackout is covered in separate documentation, ‘Basic & Advanced Agent Configuration & Set-up’. These steps will help you get a minimally viable set-up for ensuring Blackout will continue running.
- 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
This will then deploy the ‘Blackout Agent’ to that server and configure it with the default worker threads for that agent. 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:
- 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 (#:#) where 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.