GetDataQualityAnalysisReportFilePath Method

Retrieves the path to the PDF file that Touchstone® has generated to contain a Data Quality Analysis summary report for a specific category of results from a Data Quality Analysis.

Syntax

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

Public Function GetDataQualityAnalysisReportFilePath( _
   ByVal request As GetDataQualityAnalysisReportFilePathRequest _
) As GetDataQualityAnalysisReportFilePathResponse

Dim instance As DataQualityAnalysisServiceClient
Dim request As GetDataQualityAnalysisReportFilePathRequest
Dim value As GetDataQualityAnalysisReportFilePathResponse
 
value = instance.GetDataQualityAnalysisReportFilePath(request)

public GetDataQualityAnalysisReportFilePathResponse GetDataQualityAnalysisReportFilePath( 
   GetDataQualityAnalysisReportFilePathRequest request
)

Parameters

request: Contains a GetDataQualityAnalysisReportFilePathRequest that identifies the Touchstone-generated Analysis Report Sequential Identifier (SID) of the Data Quality Analysis summary report PDF file for which you want to retrieve the path, along with the associated Business Unit SID and SQL Instance SID.

Return Value

A GetDataQualityAnalysisReportFilePathResponse containing the path to the requested report file.

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 Analysis Report SID to pass into this method, call the GetDataQualityAnalyses() method. Alternately, you can call the GetActivity() method. The Analysis Report SID is stored in the GetActivityResponse.Activity.AnalysisSid property.

Example

The following example shows how to retrieve the path to the PDF file containing a Touchstone Data Quality Analysis summary results report for a specific category of results using the GetDataQualityAnalysisReportFilePath() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.DataQualityAnalysis.Api;
            
class SnippetGetDataQualityAnalysisReportFilePathRequest
{
    private static void GetAnalysisReportPath(int businessUnitSid, int sqlInstanceSid, int reportSid)
    {
        DataQualityAnalysisServiceClient client = new DataQualityAnalysisServiceClient();
        GetDataQualityAnalysisReportFilePathRequest request = new GetDataQualityAnalysisReportFilePathRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.ReportAnalysisSid = reportSid;
        GetDataQualityAnalysisReportFilePathResponse response = client.GetDataQualityAnalysisReportFilePath(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Report file path: " + response.FilePath);
        }
    }
}

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