To view or edit a MaxBilling Configuration, navigate to the MaxBilling Configuration tab on admin/instance level.
All existing Configurations are listed in the view.
The Configuration contains the following information:
◼ Name – a read only field, indicating the installed workspace ID.
◼ Installed Workspace ID – the Artifact ID of the workspace referring to the corresponding installation.
◼ Client IDs – each MaxBilling installation can work for all the Clients or for specific Clients, or Client Domains. The scope of the installation is specified by adding the corresponding Client IDs to the MaxBilling Configuration.
The Client or Client Domain installations work restrictively within the specified scope, so the end users can generate reports only for the Workspaces and Matters which belong to the specified Clients or Clients Domains. No billing information regarding Workspaces and Matters, which are out of the scope of the specific installation, is accessible from such MaxBilling workspaces.
A New MaxBilling Configuration entry is automatically created upon the next Post-Install Upgrader Agent run, following a new workspace installation.
Configuration for all Clients
To configure a MaxBilling installation to work for all the Clients in the Relativity instance, edit the MaxBilling Configuration entry and populate Client IDs = -1.
Reports and Invoices for all the Workspaces and Matters can be generated from the MaxBilling workspace that has ClientID = -1 installation.
The first MaxBilling installation ever within the Relativity instance is automatically configured with Client IDs = -1. Any following installations should be configured explicitly by an administrator
You can set up multiple configurations with Client IDs = -1. Thus, each installation will work for all the Clients within the instance.
Configuration for specific Clients/Client Domains
To configure a MaxBilling installation to work for specific Client(s) or Client Domain(s) only, edit the MaxBilling Configuration entry and populate the Clients’ Artifact IDs in Client IDs field, separated by a comma. The Reports and Invoices that can be generated from that MaxBilling workspace will be limited to the specified ClientIDs.
Do NOT remove any Client IDs once they have been added to your MaxBilling configuration. You can only add new Client IDs.
Once installation is configured, please wait until the MaxBilling Admin Object Sync Agent completes its next run before you proceed with working with the application on the newly configured workspace.
◼ MaxBilling Upgraded On – a read only field, indicating when the application was lastly upgraded
◼ MaxBilling Upgraded By – a read only field, indicating the Agent which updated the Configuration entry
◼ MaxBilling Upgraded Version – a read only field, indicating the current MaxBilling version number. When you upgrade the application, when the installation of the new .rap file is completed, some additional time is still needed for the Post-Install Upgrader agent to finish its run following the installation itself. If MaxBilling Upgraded Version is updated with the latest version number of the application, this is a reliable sign that the upgrade is completed.
◼ License Key – this field contains the activation key for the corresponding installation. The applications agents do not work for installations without a valid key.
◼ License Expiration Date – a read only field, indicating till when is the license validity. The date is updated automatically upon applying a valid license key.
◼ MaxBilling Authentication Client – when using the application in RelativiyOne, MaxBilling version 8.0 or higher, utilizes the Relativity Usage Reports API for part of the supported billing items. To enable the corresponding agents and their collection logic, you need to link a designated OAuth2 Client in the MaxBilling Configuration. The quoted OAuth2 Client is solely used by the application’s agents to authenticate to the Relativity Usage Report API.
The OAuth2Client should be configured considering the following requirements:
-
-
-
-
-
- Flow Grant Type – Client Credentials
- Context User – the context user to be granted with “View Instance-wide Usage Reports” permission
- Access Token Lifetime – 60 minutes recommended
-
-
-
-
Once the OAuth2 Client is created, navigate to the MaxBilling Configuration layout and select it in the MaxBilling Authentication Client field.
◼ CaseStatistics Decommission Date – to manage the time when the alternative report generation logic, utilizing the statistics collected from the Usage Report API, will be triggered.
◼ RepoDetails Decommission Date – to manage the time when the alternative logic for repository workspaces hosting size recalculation, utilizing the statistics collected from the Usage Report API, will be triggered (applicable if you have Profiles which are set with “Storage Type Configurations: Repository”).
