- Important! - Blackout 4.0 requires Relativity 10.0 or newer
- All browsers supported by Relativity 10.0 and newer are supported
- All existing Blackout jobs must be completed, reverted, or stopped prior to beginning the upgrade
- Updates must be performed from the Relativity Application Library
Upgrading from 1.9 or lower
If upgrading to Blackout 4+ from Blackout 1.9 or lower, please contact firstname.lastname@example.org.
Upgrading from 3.3 or earlier
Blackout 4 will be a major upgrade for Blackout and will introduce system changes upon upgrade. In addition to introducing new functionality, the upgrade will make changes to your existing installation and additional steps may need to be taken immediately after the upgrade.
To learn more about specific changes, please refer to previous versions of this documentation and our release notes.
Upgrading from 3.4
If upgrading from Blackout 3.4, Blackout 4 introduces minimal changes to your system. There are no data migrations or schema changes between Blackout 3.4 and 4.
Before you begin
- Ensure that you have received the Blackout 4 RAP file
- If you have not received the RAP, please contact email@example.com
- The file will be delivered via secure file share
- Blackout must already be installed.
- If this is a fresh installation, please see our First time installation guide
- Blackout must be installed through the Relativity application library.
- Ensure that you have access before beginning
- Additionally, all workspaces must be upgraded at once using the prompt Relativity will display
- 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 4 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. 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 each workspace has been successfully upgraded, Blackout will still need to be configured to work with at least one Blackout Relativity agent.
Full details on configuring and setting up your agents for Blackout is covered in separate article, Basic & Advanced Agent Configuration & Set-up.
This section will guide you in setting up a single agent server to get started.
- 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.
System change log
There are no agent changes in Blackout 4.
Relativity configuration changes
There are no Relativity configuration changes in Blackout 4.
Blackout 4 introduces the tables required for the PDF domain.
There are no changes to existing schema.