Overview

A resource group is a mechanism for managing and tracking the Intelligent Risk Platform system resources licensed by a tenant, specifically the number of platform jobs that can be run concurrently by a tenant's principals.

Every resource group is identified by a unique resource group ID and tied to a specific entitlement. Whenever a client application makes a request that initiates a platform job, the client application must specify a valid resource group ID in the x-rms-resource-group-id header parameter of the request. The resource group ID enables the Intelligent Risk Platform to identify which resource group is running the job and ensure that the tenant's quota of jobs is correctly allocated across all licensed entitlements.

A tenant may license multiple Intelligent Risk Platform applications and have multiple entitlements. Resource groups play an important role allocating tenant resource quotas across entitlements and teams.

The following sections describe entitlement-based resource quotas, the relationship between resource groups and job quotas, and describes strategies for using resource groups effectively on the Intelligent Risk Platform.

Understand resource quotas

A resource quota is a fixed share of Intelligent Risk Platform system resources that are allocated to the tenant as part of an entitlement.

A tenant's resource quota governs access to Intelligent Risk Platform system resources. Resource quotas specify:

• Number of locations modelled per day
• Maximum number of concurrent model jobs
• Maximum number of concurrent non-model jobs
• Total number of jobs that can be run per day
• Requests per second
• Throughput (model jobs per hour)
• Exposure storage
• Result storage
• Number of EDMs
• Number of users

These resources are governed by the tenant’s resource quota. Access to platform resources is granted to to a tenant as part of a licensed entitlement.

A tenant is assigned one resource group for every application licensed. Each resource group is tied to an entitlement. A tenant is allocated distinct resource quotas for each licensed application. In the Platform APIs, these applications are identified as entitlements: RI-DATAVAULT RI-EXPOSUREIQ RI-RISKMODELER RI-TREATYIQ or RI-UNDERWRITEIQ. To learn more, see Entitlements.

Resource groups are a mechanism that only apply to a subset of the tenant's resource quota: job quotas.

Job quotas

A resource group is an entity that "governs" a tenant's quota of platform jobs for a particular entitlement.

For each entitlement, the tenant is "seeded" a resource group, which is identified by a unique ID number. The resource group enables the Intelligent Risk Platform to track the number of jobs submitted by the tenant for each entitlement and ensure that the does not exceed their quotas of platform jobs.

A platform job is a process that requires platform resources (e.g. geocoding, analysis, data migration). Such requests utilize compute resources and count against the compute capacity of a tenant's resource quota. These operations generally use the POST method, but some jobs can be initiated by resources that use the PATCH, PUT or DELETE methods. For more information on workflows and a list of resources that initiate workflow jobs, see Platform Jobs.

As part of the entitlement's resource quota, the tenant is allocated a quota of platform jobs. Job quotas include the maximum number concurrent of model jobs, the maximum number of concurrent non-model jobs, and the total number of jobs that the tenant may run during the day.

Model jobs

A model job (a.k.a. primary job) is a job (a long-running process that consumes significant system resources) that performs the principal modeling or analysis operation of a particular entitlement and produces an analysis result.

• For the RI-RISKMODLER and RI-UNDERWRITEIQ entitlements, a primary job is any job created using the Model API.
• For the RI-TREATYIQ entitlement, a primary job is any job created using the Rollup API.
• For the RI-EXPOSUREIQ entitlement, a primary job is any job created using the Accumulation API.

Non-model jobs

A non-model job (a.k.a. secondary job) is any job that is not a primary job (e.g. a model job, accumulation job, or rollover job) and does not produce an analysis result. Examples of secondary jobs include import job, export jobs, and geohaz jobs.

📷

Note

A tenant licenses a resource quota for every entitlement.

This same resource quota is shared between client applications with the entitlement (e.g. RI-RISKMODELER) to use the Platform APIs and end users using an Intelligent Risk Platform application (e.g. Risk Modeler).

Tracking job quotas

Resource group IDs

All Intelligent Risk Platform endpoints that create a job now require that the client application pass a resource group ID in the x-rms-resource-group-id header.

The x-rms-resource-group-id header parameter passes a resource group ID. The resource group ID identifies the entitlement and resource group. A single entitlement may be allocated multiple resource groups,` each of which has been allocated a percentage of the tenant's work load for that application.

The resource group enables the Intelligent Risk Platform to ensure that the client application has the correct entitlement to make the request and the specified resource group has sufficient resource quota.

As an operation that initiates a job, this operation requires the client pass a valid resource group ID in a header parameter:

curl --request POST \
     --url https://api-euw1.rms.com/platform/batch/v1/jobs/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-rms-resource-group-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
     --data '{exposure_data}'

If no resource group ID is specified in the request, the Intelligent Risk Platform returns an error.

Search resource group IDs

The Search Resource Group operation supports querying resource group IDs by entitlement.

The entitlement path parameter specifies the licensed Intelligent Risk Intelligence application. One of RI-DATAVAULT RI-EXPOSUREIQ RI-RISKMODELER RI-TREATYIQ or RI-UNDERWRITEIQ.

For each resource group ID, the response lists the name of the resource group, the entitlement to which it applies, and information about the user and date that the resource group was created and updated.

This response also returns information about the scope of the resource group including whether it is the default resource group for the entitlement and whether it is applicable to all tenant principals.

Resource group administration

All resource group management tasks must be performed in Admin Center. The Tenant Data API does not support operations for managing resource groups.

Using controls Admin Center, tenant administrators can create, update, and delete resource groups. To learn more, see Resource Group and Application Management in Help Center.