Overview

Access to system resources is allocated to tenants by entitlement. An entitlement is an Intelligent Risk Platform application that has been licensed by the tenant, e.g. RI-RISKMODELER or RI-UNDERWRITEIQ.

For each licensed application, the tenant is assigned a resource quota that specifies guarantees and limits on access to system resources, and a resource group which enables the tenant to manage and track the allocation of the tenant's quota of platform jobs.

These job quotas specify the number of concurrent primary jobs, the number of concurrent secondary jobs, and the total number of jobs per day. The following sections describe entitlement-based resource quotas, identify the relationship between resource groups and job quotas, and 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 is allocated to the tenant as part of an entitlement, i.e. a licensed Intelligent Risk Platform application.

The Intelligent Risk Platform allocates resource quotas to a tenant for each licensed enitlement, i.e. RI-DATAVAULT RI-EXPOSUREIQ RI-RISKMODELER RI-TREATYIQ or RI-UNDERWRITEIQ.

For each entitlement, the resource quota defines the availability of various system resources to the tenant.

• Primary Job Concurrency Limit
• Secondary Job Concurrency Limit
• Total Daily Jobs Limit
• Total Daily Modeled Locations Limit
• Total Daily Accumulated Risks Limit
• Total Exposure Storage Limit
• Total Other Storage Limit
• Total EDM Database Limit

The Intelligent Risk Platform manages and tracks the tenant's quota of concurrent and daily platform jobs by means of resource groups.

Understand Resource Groups

A resource group is a mechanism for managing and tracking job quotas. A job quota specifies the number of jobs that are allocated to the tenant for a particular entitlement.

For each entitlement, the tenant is "seeded" a resource group, which is identified by a unique ID number. 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.

This resource group ID enables the Intelligent Risk Platform to track the number of jobs submitted by the tenant for each entitlement and ensure that no resource group exceeds its quota of platform jobs.

Job Quotas

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

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.

Job quotas include the number of jobs that can be run concurrently for model and non-model jobs, and the number of jobs that can be run per day.

On success, the job is added to a job queue for processing. In general, jobs are processed in the order submitted according to a best-effort FIFO policy. The Scheduler checks the jobs for a resource group ID and determines whether to allocate resources to that job based on whether the entitlements remaining quota of resource jobs is sufficient to process the job. .

Primary Jobs

A primary job (a.k.a. model job) is a platform job that performs the principal modeling or analysis operation of a particular entitlement. Such jobs generally produce an analysis result.

The resource group governs the tenant's quota of model jobs and non-model jobs.

Secondary jobs

A secondary job (a.k.a. non-model 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.