Guides

Download Analysis Results

Suggest Edits

Overview

Update

RMS Intelligent Risk Platform saves the analysis results to a cloud-based RDM. This RDM is the data structure that stores loss estimates and other output data generated by RMS catastrophe model analysis.

You may want to download results data from Intelligent Risk Platform to a on-premise RDM or other database for further analysis.

The Export data module supports several different workflows for exporting data modules (EDMs and RDMs) for download. These workflows are managed in three different job types. The ResultsExportInputV2 job type enables you to download analysis results from a cloud-based Results Data Module (RDM) as a database artifact.

The resource offers two options for exporting and downloading results data stored in a cloud-based RDM.

  • Export results data to a BAK or MDF database artifact.
  • Export results data to a CSV or PARQUET flat file.

We'll look at each of these workflows in turn.

Export and download RDM as database artifact

The Export Data Module resource enables you to identify a subset of the analysis results stored in an existing cloud-based RDM and export those analysis results to a new RDM instance, which you can then download as a BAK or MDF database artifact. Once downloaded, the RDM can then be imported into an existing on-premise RDM.

Step 1: Export results data to a temporary RDM

An export job for downloading results data from a temporary database is a ResultsExportInputV2 job.

The resource accepts an optional servername query parameter. All other parameters are specified in the request body.

 curl --location --request POST 'https://{host}/riskmodeler/v2/exports?servername=data-bridge-1\
 --header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXX'

The servername query parameter identifies the server hosting the RDM instance. If unspecified, the tenant’s Unified Data Store (UDS) is used. In this example, we have specified the name of a Data Bridge server and will export results data from an RDM instance hosted on that server. A tenant may have multiple Data Bridge servers.

To export results data to a temporary RDM, the request body should look something like this:

{
    "type": "ResultsExportInputV2",
    "analysisIds": [1424,1433,1438],
    "createnew": true,
    "rdmName": "MultiAnalyses",
    "exportType": "RDM",

    "sqlVersion": 2019
}

The analysisIds body parameter identifies an array of analysis results identified by their ID numbers. The specified analysis IDs will be exported to the temporary RDM. The temporary RDM and the corresponding database artifact will contain these and only these results.

The exportType, createnew, rdmName, and sqlVersion body parameters define the temporary RDM. The required exportType attribute specifies that we are creating an RDM rather than an EDM. The createNew attribute must be set to true otherwise the job will attempt to write the specified analysis results to an existing RDM. The rdmName specifies the name of this new database and the sqlVersion specifies the SQL Server format.

The exportFormat body parameter identifies the format of the database artifact. One of BAK or MDF.

If successful, returns a 202 Accepted HTTP response and initiates a DOWNLOAD_RDM job on the workflow engine. You can use the Get workflow or operation resource to track the progress of the workflow job. When the job is complete and the status is set to FINISHED, you can download the flat file from the cloud.

Step 2: Download database artifact

Download the database artifact from the cloud.

Export and download RDM as flat file

The Export data module resource enables you to identify a subset of the analysis results stored in an existing cloud-based RDM and export to a flat file for download.

Step 1: Export results data to a flat file

An export job for downloading results data to a flat file is a ResultsExportInputV2 job. 

 curl --location --request POST 'https://{host}/riskmodeler/v2/exports?servername=data-bridge-1\
 --header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXX'

The analysisIds body parameter identifies an array of analysis results identified by their ID numbers. The specified analysis IDs will be exported to the flat file. The flat file will contain these and only these results.

The required exportType attribute confirms that we are exporting results data. The exportFormat identifies the file format of the flat file. One or CSV or PARQUET.

If the exportFormat attribute is set to CSV or Parquet, the resource also accepts a Boolean nonWeightedPlt attribute in the request body. If true, HD earthquake EP analysis results are exported as equally-weighted PLTs to CSV or Parquet flat files for download. By default, these results are exported as the weighted PLTs originally generated using the HD Earthquake model. At least one loss table must be specified in the lossDetails array of the request body, or the resource returns an error.

If successful, returns a 202 Accepted HTTP response and initiates a DOWNLOAD_RESULTS job on the workflow engine. You can use the Get workflow or operation resource to track the progress of the workflow job. When the job is complete and the status is set to FINISHED, you can download the flat file from the cloud.

Step 2: Download flat file

Download the flat file from the cloud.

Updated 7 months ago