SubmitZoneExposureConcentrationAnalysis Method

Submits a new Touchstone® Zone Geospatial Analysis job.

The Geospatial Analysis API enables you to perform a deterministic risk analysis on your Exposure View data to find out where your risks concentrate due to one or more specified perils, such as earthquakes, floods, and tropical cyclones. A Zone Geospatial Analysis accumulates exposures to risk and analysis results by geographic zones that you can define. It accumulates the values for all properties in the target Exposure View that match the filter criteria that you specify and then calculates your potential loss.

Note: This is the most common way of managing accumulations for a Geospatial Analysis.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function SubmitZoneExposureConcentrationAnalysis( _
   ByVal request As SubmitZoneExposureConcentrationAnalysisRequest _
) As SubmitZoneExposureConcentrationAnalysisResponse

Dim instance As ExposureConcentrationAnalysisServiceClient
Dim request As SubmitZoneExposureConcentrationAnalysisRequest
Dim value As SubmitZoneExposureConcentrationAnalysisResponse
 
value = instance.SubmitZoneExposureConcentrationAnalysis(request)

public SubmitZoneExposureConcentrationAnalysisResponse SubmitZoneExposureConcentrationAnalysis( 
   SubmitZoneExposureConcentrationAnalysisRequest request
)

Parameters

request: Contains a SubmitZoneExposureConcentrationAnalysisRequest that identifies the Options associated with the Zone Geospatial Analysis job that you want to run, along with the associated Business Unit SID and SQL Instance SID.
The Options property contains a ZoneAnalysisOptions object that enables you to specify a list of Touchstone®-generated Sequential Identifiers (SIDs) that identify the Zone Sets that you want to use as accumulators in the Zone Geospatial Analysis job that you are requesting.

Return Value

A SubmitZoneExposureConcentrationAnalysisResponse containing the Activity SID that uniquely identifies the asynchronous web service call that you made to submit the specified Zone Geospatial Analysis job.

Remarks

To find the Business Unit SID to pass into this method, call the GetBusinessUnits() method.

To find the SQL Instance SID to pass into this method, call the GetSqlInstances() method.

For information about retrieving the results of a Touchstone Zone Geospatial Analysis, see the GetZoneExposureConcentrationAnalysisResults() method.

The results of a Zone Geospatial Analysis are stored in a ZoneResult object.

Example

The following example shows how to submit a Touchstone Zone Geospatial Analysis job using the SubmitZoneExposureConcentrationAnalysis() method:

using System;
using System.Collections.Generic;
using AIR.Services.Common.Data;
using AIR.Services.ExposureConcentrationAnalysis.Api;
using AIR.Services.ExposureConcentrationAnalysis.Data;
using AIR.Services.ExposureConcentrationAnalysis.ZoneManagement.Api;
using AIR.Services.LossAnalysis.Data;
            
class SnippetSubmitZoneExposureConcentrationAnalysisRequest
{
    private static void SubmitZoneExposureConcentrationAnalysis(int businessUnitSid, int sqlInstanceSid, int projectSid, int exposureViewSid,
                                                                List<int> zoneSets, int resultDSSid, string currency, int currencyExchangeRateSid, 
                                                                string analysisName, string analysisDesc)
    {
        ExposureConcentrationAnalysisServiceClient ecaClient = new ExposureConcentrationAnalysisServiceClient();
        SubmitZoneExposureConcentrationAnalysisRequest ecaZoneRequest = new SubmitZoneExposureConcentrationAnalysisRequest();
        ecaZoneRequest.BusinessUnitSid = businessUnitSid;
        ecaZoneRequest.SqlInstanceSid = sqlInstanceSid;
       
        ZoneAnalysisOptions zoneOptions = new ZoneAnalysisOptions();
            
        zoneOptions.ProjectSid = projectSid;
        zoneOptions.ExposureTarget = new AIR.Services.AnalysisCommon.Data.ExposureTarget
        {
            Sid = exposureViewSid,
            Type = AIR.Services.AnalysisCommon.Data.ExposureTargetType.ExposureView
        };
            
        zoneOptions.ExposedLimits = ExposedLimits.None;
    
        zoneOptions.ZoneSetSids = zoneSets;
            
        zoneOptions.ApplyDisaggregation = false;
            
        zoneOptions.ResultsSaveBy = ResultsSaveBy.SaveReplacementValues | ResultsSaveBy.SaveNumberofLocations | ResultsSaveBy.SaveNumberofRisks
                                    | ResultsSaveBy.SaveContract | ResultsSaveBy.SaveLayer | ResultsSaveBy.SaveLocation;
            
        zoneOptions.ReinsuranceProgramSid = 0;
        zoneOptions.FacultativeReinsuranceOptions = FacultativeReinsuranceOptions.DoNotApply;
            
        zoneOptions.Name = analysisName;
        zoneOptions.Description = analysisDesc;
        zoneOptions.ResultDataSourceSid = resultDSSid;
            
        zoneOptions.Currency = currency;
        zoneOptions.CurrencyExchangeRateSid = currencyExchangeRateSid;
            
        ecaZoneRequest.Options = zoneOptions;
            
        SubmitZoneExposureConcentrationAnalysisResponse ecaZoneResponse = ecaClient.SubmitZoneExposureConcentrationAnalysis(ecaZoneRequest);
       
        if (ecaZoneResponse.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Zone Geospatial Analysis submitted with Activity SID: " + ecaZoneResponse.ActivitySid);
        }
    }
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ExposureConcentrationAnalysisServiceClient Class
ExposureConcentrationAnalysisServiceClient Members