SubmitDataQualityAnalysis Method

Contains a SubmitDataQualityAnalysisRequest that identifies the Analysis Options associated with the Data Quality Analysis job that you want to run, along with the associated Business Unit SID and SQL Instance SID.

The Analysis Options property contains a DataQualityAnalysisOptions object that enables you to specify the following options:

Options Category	Description
Scoring Options	A set of options that enable you to specify how Touchstone should choose which peril to use when calculating data scores, as well as to specify the desired peril set if you would like to indicate that Touchstone should use a specific peril set in the Data Quality Analysis. The Data Quality Score measures the completeness of exposure data. It quantifies inaccurate and missing primary risk characteristics in the exposure data that can contribute to inaccuracies in the calculated losses. Scoring data helps you to identify high-risk exposures with large replacement values as well as data quality problems. Touchstone calculates data quality scores for each Location in the analysis target. Scores are peril-specific.
Validation Options	A set of options that enable you to specify the set of Completeness Rules and the set of Reasonability Rules that Touchstone should use when performing data validation during the Data Quality Analysis. Validation means evaluating the completeness and reasonability of property location data within an Exposure View or Contract portfolio. Completeness rules enable you to check Exposure and Contract data for missing values or for values that significantly contribute to the calculated loss. Reasonability rules enable you to compare attributes in order to find mismatched data attributes, such as a construction material that does not make sense for the listed occupancy. Note: You can use data validation in combination with the data scoring to determine the level of data augmentation that you should run on your Exposure data.
Rating Agency Options	A set of options that enable you to generate Exposure data totals to use in response to the A.M. Best Property/Casualty Supplemental Ratings Questionnaire (SRQ) during the Data Quality Analysis.
Industry Comparison (Benchmarking) Options	A set of options that enable you to benchmark your Exposure data against industry data based on Line of Business (LOB), construction material, and occupancy type during the Data Quality Analysis.
Industry Review Options	A set of options that enable you to review industry data based on Line of Business (LOB), construction material, and occupancy type during the Data Quality Analysis.
Data Augmentation Options	A set of options that enable you to configure the way in which Touchstone® augments your data during the Data Quality Analysis. The Augment diagnostic enables you to add property-specific building information to your portfolio when data is missing or when confidence in the data is low. You can augment building location, property value, and primary and secondary risk characteristics using AIR's Property-specific database and/or user-specified values.

Submits a new Touchstone® Data Quality Analysis job.

The Touchstone Data Quality API enables you to integrate Data Quality Analysis results and reports within your applications and workflows. These reports include scoring, validation, benchmarking, and augmentation of your exposure data.

You execute all analysis jobs against an Exposure View, and Touchstone stores the results in a Touchstone result Data Source (Database). To create a new result Data Source, use the SubmitCreateDatabase() method.

Syntax

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

Public Function SubmitDataQualityAnalysis( _
   ByVal request As SubmitDataQualityAnalysisRequest _
) As SubmitDataQualityAnalysisResponse

Dim instance As DataQualityAnalysisServiceClient
Dim request As SubmitDataQualityAnalysisRequest
Dim value As SubmitDataQualityAnalysisResponse
 
value = instance.SubmitDataQualityAnalysis(request)

public SubmitDataQualityAnalysisResponse SubmitDataQualityAnalysis( 
   SubmitDataQualityAnalysisRequest request
)

Parameters

request

The Analysis Options property contains a DataQualityAnalysisOptions object that enables you to specify the following options:

Options Category	Description
Scoring Options	A set of options that enable you to specify how Touchstone should choose which peril to use when calculating data scores, as well as to specify the desired peril set if you would like to indicate that Touchstone should use a specific peril set in the Data Quality Analysis. The Data Quality Score measures the completeness of exposure data. It quantifies inaccurate and missing primary risk characteristics in the exposure data that can contribute to inaccuracies in the calculated losses. Scoring data helps you to identify high-risk exposures with large replacement values as well as data quality problems. Touchstone calculates data quality scores for each Location in the analysis target. Scores are peril-specific.
Validation Options	A set of options that enable you to specify the set of Completeness Rules and the set of Reasonability Rules that Touchstone should use when performing data validation during the Data Quality Analysis. Validation means evaluating the completeness and reasonability of property location data within an Exposure View or Contract portfolio. Completeness rules enable you to check Exposure and Contract data for missing values or for values that significantly contribute to the calculated loss. Reasonability rules enable you to compare attributes in order to find mismatched data attributes, such as a construction material that does not make sense for the listed occupancy. Note: You can use data validation in combination with the data scoring to determine the level of data augmentation that you should run on your Exposure data.
Rating Agency Options	A set of options that enable you to generate Exposure data totals to use in response to the A.M. Best Property/Casualty Supplemental Ratings Questionnaire (SRQ) during the Data Quality Analysis.
Industry Comparison (Benchmarking) Options	A set of options that enable you to benchmark your Exposure data against industry data based on Line of Business (LOB), construction material, and occupancy type during the Data Quality Analysis.
Industry Review Options	A set of options that enable you to review industry data based on Line of Business (LOB), construction material, and occupancy type during the Data Quality Analysis.
Data Augmentation Options	A set of options that enable you to configure the way in which Touchstone® augments your data during the Data Quality Analysis. The Augment diagnostic enables you to add property-specific building information to your portfolio when data is missing or when confidence in the data is low. You can augment building location, property value, and primary and secondary risk characteristics using AIR's Property-specific database and/or user-specified values.

Return Value

A SubmitDataQualityAnalysisResponse containing the Activity SID that uniquely identifies the asynchronous web service call that you made to submit the specified Data Quality 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 generating a summary PDF containing the results of a Data Quality Analysis, see the SubmitDataQualityAnalysisReport() method and the GetDataQualityAnalysisReportFilePath() method.

For information about retrieving the results of a Touchstone Data Quality Analysis, see the following methods:

Example

The following example shows how to submit a Touchstone Data Quality Analysis job using the SubmitDataQualityAnalysis() method:

using System;
using System.Collections.Generic;
using AIR.Services.Common.Data;
using AIR.Services.DataQualityAnalysis.Api;
using AIR.Services.DataQualityAnalysis.Data;
            
class SnippetSubmitDataQualityAnalysisRequest
{
    private static void RunDataQualityAnalysis(int businessUnitSid, int sqlInstanceSid, int projectSid, string exposureViewName, int exposureViewSid,
                        int resultDsSid, int completenessRsSid, int reasonabilityRsSid, int propertyRsSid, int locationUpdateRsSid, 
                        string analysisName, string currency, int currencyExchangeRateSid)
    {
        DataQualityAnalysisServiceClient client = new DataQualityAnalysisServiceClient();
        SubmitDataQualityAnalysisRequest request = new SubmitDataQualityAnalysisRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.AnalysisOptions = new AIR.Services.DataQualityAnalysis.Data.DataQualityAnalysisOptions()
        {
            Name = analysisName,
            ProjectSid = projectSid,
            Currency = currency,
            CurrencyExchangeRateSid = currencyExchangeRateSid,
            ResultDataSourceSid = resultDsSid,
            ExposureTarget = new AIR.Services.AnalysisCommon.Data.ExposureTarget()
            {
                Type = AIR.Services.AnalysisCommon.Data.ExposureTargetType.ExposureView,
                Name = exposureViewName,
                Sid = exposureViewSid
            },
            ScoringOptions = new AIR.Services.DataQualityAnalysis.Data.ScoringOptions()
            {
                PerilType = PerilType.MaximumLossCostPeril
            },
            ValidationOptions = new AIR.Services.DataQualityAnalysis.Data.ValidationOptions()
            {
                CompletenessRuleSetSid = completenessRsSid,
                ReasonabilityRuleSetSid = reasonabilityRsSid
            },
            RatingAgencyOptions = new RatingAgencyOptions()
            {
                AMBest = true
            },
            IndustryReviewOptions = new IndustryDataOptions()
            {
                LinesOfBusiness = new List<AIR.Services.Common.Data.IndustryLineOfBusiness>(),
                Constructions = new Listlt;AIR.Services.Common.Data.IndustryConstruction>(),
                Occupancies = new Listlt;AIR.Services.Common.Data.IndustryOccupancy>()
            },
            IndustryComparisonOptions = new IndustryDataOptions()
            {
                LinesOfBusiness = new Listlt;AIR.Services.Common.Data.IndustryLineOfBusiness>(),
                Constructions = new Listlt;AIR.Services.Common.Data.IndustryConstruction>(),
                Occupancies = new Listlt;AIR.Services.Common.Data.IndustryOccupancy>()
            },
            AugmentationOptions = new AugmentationOptions()
            {
                CreateNewExposure = false,
                PropertySpecificRuleSetSid = propertyRsSid,
                UserSpecificRuleSetSid = locationUpdateRsSid
            }
        };
            
        SubmitDataQualityAnalysisResponse response = client.SubmitDataQualityAnalysis(request);
        if (response.Status.Code == StatusCode.Success)
            Console.WriteLine("Submitted successfully to HPC with Activity SID: " + response.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

DataQualityAnalysisServiceClient Class
DataQualityAnalysisServiceClient Members