SubmitDataQualityAnalysisReport Method

Submits a request for a Touchstone® Data Quality Analysis summary report PDF for a specific category of results from a Data Quality Analysis.

The Touchstone Data Quality Analysis API can generate a PDF file that contains a summary of the results of any of the following types of Data Quality Analyses:

A.M. Best Rating Company
Augmentation
Industry Comparison
Scoring
Validation

Syntax

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

Public Function SubmitDataQualityAnalysisReport( _
   ByVal request As SubmitDataQualityAnalysisReportRequest _
) As SubmitDataQualityAnalysisReportResponse

Dim instance As DataQualityAnalysisServiceClient
Dim request As SubmitDataQualityAnalysisReportRequest
Dim value As SubmitDataQualityAnalysisReportResponse
 
value = instance.SubmitDataQualityAnalysisReport(request)

public SubmitDataQualityAnalysisReportResponse SubmitDataQualityAnalysisReport( 
   SubmitDataQualityAnalysisReportRequest request
)

Parameters

request: Contains a SubmitDataQualityAnalysisReportRequest that identifies the options associated with the Data Quality Analysis results summary that you want to generate, along with the associated Business Unit SID and SQL Instance SID.

Return Value

A SubmitDataQualityAnalysisReportResponse containing the Activity SID that uniquely identifies the asynchronous web service call that you made to request the specified Data Quality Analysis results summary report generation.

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.

To find the path to the PDF file containing the Data Quality Analysis results summary report that the SubmitDataQualityAnalysisReport() method generates, use the GetDataQualityAnalysisReportFilePath() method.

For information about submitting a new Data Quality Analysis job, see the SubmitDataQualityAnalysis() method.

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

Example

The following example shows how to submit requests for Touchstone Data Quality Analysis summary reports using the SubmitDataQualityAnalysisReport() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.DataQualityAnalysis.Api;
using AIR.Services.DataQualityAnalysis.Data;
            
class SnippetSubmitDataQualityAnalysisReportRequest
{
    private static void ExportAnalysisReport(int businessUnitSid, int sqlInstanceSid, int analysisSid,
                                            string portfolioName, string preparerName, string targetFileNamePrefix)
    {
        DataQualityAnalysisServiceClient client = new DataQualityAnalysisServiceClient();
        SubmitDataQualityAnalysisReportRequest request = new SubmitDataQualityAnalysisReportRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.AnalysisSid = analysisSid;
        request.Options = new AMBestExportOptions()
        {
            PortfolioName = portfolioName,
            PreparerName = preparerName,
            TargetFileName = targetFileNamePrefix + " AM Best"
        };
        SubmitDataQualityAnalysisReportResponse response = client.SubmitDataQualityAnalysisReport(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Successfully submitted AM Best report request to HPC with Activity SID: " + response.ActivitySid);
        }
            
        request.Options = new ValidationExportOptions()
        {
            PortfolioName = portfolioName,
            PreparerName = preparerName,
            TargetFileName = targetFileNamePrefix + " Validation",
            IncludeValidationRulesFlaggedByAreaAndCurrency = true
        };
        response = client.SubmitDataQualityAnalysisReport(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Successfully submitted Validation report request to HPC with Activity SID: " + response.ActivitySid);
        }
            
        request.Options = new IndustryComparisonExportOptions()
        {
            PortfolioName = portfolioName,
            PreparerName = preparerName,
            TargetFileName = targetFileNamePrefix + " Benchmark",
            IncludeAverageReplacementValueByLOBByArea = true,
            IncludeTRVComparisonByConstructionByArea = true,
            IncludeTRVComparisonByOccupancyByArea = true
        };
        response = client.SubmitDataQualityAnalysisReport(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Successfully submitted Benchmark report request to HPC with Activity SID: " + response.ActivitySid);
        }
            
        request.Options = new AugmentationExportOptions()
        {
            PortfolioName = portfolioName,
            PreparerName = preparerName,
            TargetFileName = targetFileNamePrefix + " Augmentation",
            IncludeAugmentedAttributes = true
        };
        response = client.SubmitDataQualityAnalysisReport(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Successfully submitted Augmentation report request to HPC with Activity SID: " + response.ActivitySid);
        }
            
        request.Options = new ScoringExportOptions()
        {
            PortfolioName = portfolioName,
            PreparerName = preparerName,
            TargetFileName = targetFileNamePrefix + " Scoring",
            IncludeDataQualityCompletenessSummary = true,
            IncludeOverallRiskCategoryByGeography = true
        };
        response = client.SubmitDataQualityAnalysisReport(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Successfully submitted Score report request 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