Plans for Data Quality Metrics

In this section:

The iWay Data Profiler - Plan application allows you to automate the process of uploading data quality metrics to iWay Data Profiler (iDP) by executing the corresponding .bat or .sh files. These scripts generate the input documents in .txt format that are required by iDP to process the output.


Top of page

x
Displaying Plans for Data Quality Metrics

This section describes how to display plans for data quality metrics in iWay Data Profiler.



x
Procedure: How to Display Plans for Data Quality Metrics

To display plans for data quality metrics:

  1. Click Data Quality Metric, located under PROJECT, in the iWay Data Profiler Home page.

    Notes: The DQ folder should not be deleted from the Data folder, since it contains a Demo plan for data quality metrics.

    The Plan for Data Quality Metric page opens and displays a list of folders containing the plans, as shown in the following image.

    The folders are categorized as follows:

    • Private
    • Public
    • Custom

    Note: Custom folders include My Group and other folders created by the user or shared to the user. For more information and detailed functionality of these folders, see Managing the Security Center.

  2. Click the Add (+) icon to view the list of uploaded projects in a particular folder.

    The Plan for Data Quality Metric section includes the following:

    • Metric group name and description.
    • Source name (DQS .plan) used to create the plan.
    • Date and time the plan for data quality metric was created.
    • A Status icon to show the current status of the plan.
    • An Action icon to provide input and execute the plan.
    • An Edit icon to edit the plan for data quality metric.
    • A Delete icon to delete the plan for data quality metric.
    • A Create button to create a new plan for data quality metric.
  3. For navigation, click on the Previous, Next, First, Last, or the corresponding page numbers icon located on the bottom-right corner of the section.

    Note: The Page navigation button will be displayed for more than fifteen folders.


Top of page

x
Creating Plans for Data Quality Metrics

This section describes how to create plans for data quality metrics in iWay Data Profiler.



x
Procedure: How to Create Plans for Data Quality Metrics

To create plans for data quality metric:

  1. In the Plan for Data Quality Metric page, click the Create button.

    The New Plan pane opens, as shown in the following image.

  2. Enter or select values for the following fields:
    • Name. The plan name value is required and must not exceed 50 characters. Only alphanumeric characters, spaces, and underscores (_) are allowed.

      Note: Do not use the same project name for two or more plans for the same user.

    • Description. The description is optional and must not exceed 200 characters.
    • Path file. Provide the path to the plan file (.plan) generated by DQS. It should be only .plan file.
    • Plan Access. Select one of the available plan access options (Private, Public, or Custom). If Custom is selected, you must select one of the custom folders from the drop down list.

      Note:

      • If you select Private, only you can view the plan for Data Quality Metric.
      • If you select Public, everyone can view the plan for Data Quality Metric.
      • If you select Custom, only by the users who have access to the selected folder can view the plan.

      For more information on the functionality of these folders, see Managing the Security Center.

  3. Click Save to save the plan. You can also click Cancel to cancel the plan creation process.

    You return to the Plan for Data Quality Metric page.

    Note: A message indicating that the plan was created successfully is displayed in the Plan for Data Quality Metric page.


Top of page

x
Editing Plans for Metrics

This section describes how to edit plans for data quality metrics in iWay Data Profiler.



x
Procedure: How to Edit Plans for Data Quality Metrics

To edit plans for Data Quality Metric:

  1. In the Plan for Data Quality Metric page, click the Edit icon.

    The Edit Plan pane opens, as shown in the following image.

  2. Modify the plan values according to your specifications, and click Update. You can also click Cancel to cancel the plan update process.

    You return to the Plan for Data Quality Metric page. A message appears indicating that the DQ project information has been updated successfully.


Top of page

x
Running Data Quality Metrics for Plans

This section describes how to run data quality metrics for plans in iWay Data Profiler.



x
Procedure: How to Run Data Quality Metric for Plans

To run data quality metric for plans:

  1. Click the Action icon that corresponds to the plan you want to execute or run.

    The Run Data Quality Metric pane opens, as shown in the following image.

  2. Enter or select the values for the following parameters in the Input File section:
    • Input File. Specify the path to an input file that you want to create a Data Quality Metric for directly in this field or click Browse to select the file from your file system.
    • Input File Settings. Select either Yes or No.

    If the input file is a .txt or .csv file, the following parameters are provided for configuration:

    • Number Of Lines In Header. Specifies the number of lines from the beginning of the file that will be excluded from processing (header lines, comments, and so on).
    • Field Separator. Contains the character that is used as a separator between individual fields on the same line that is of the same record (for example, ";").
    • Line Separator. Contains the character that is used as a separator between the lines (for example, "\n").
    • String Qualifier. A character that is used to enclose text fields. Contains the character that is used to define string data.
    • Encoding. The encoding that is used for the CSV formatted input and output. The default value is UTF-8.

    As an example, the following image shows the parameters in the Input File section when a .txt or .csv file is specified.

    If the input file is a .xls or .xlsx file, the following parameters are provided for configuration:

    • Sheet Name. Name of the sheet in the input file from which data will be read.

      Note: If the input Excel file contains multiple sheets, then by default, the sheet that has been selected while creating the plan is used.

    • Skip Empty Rows. Indicates whether rows that contain no data should be ignored.
    • Start Cell. The starting cell (first row and column) of the area of the sheet to be written (for example, A1).

    As an example, the following image shows the parameters in the Input File section when a .xls or .xlsx file is specified.

  3. Enter or select the values for the following parameters in the Data Quality Metric Settings section.
    • Name. The metric name value is required and must not exceed 50 characters. Only alphanumeric characters, spaces, and underscores (_) are allowed.

      Note: Do not use the same Data Quality Metric name for two or more Data Quality Metrics for the same user.

    • Description. The description is optional and must not exceed 200 characters.
    • Folder Location. Select one of the available folder options (Private, Public, or Custom). This setting is required. If Custom is selected, you must select one of the custom folders from the drop-down list.

      Note:

      • If you select Private, only you can view the Data Quality Metric.
      • If you select Public, everyone can view the Data Quality Metric.
      • If you select Custom, only by the users who have access to the selected folder can view the Data Quality Metric.

      For more information on the functionality of these folders, see Managing the Security Center.

  4. Click Run to execute the plan.

    You are navigated to the home page.


Top of page

x
Deleting Plans for Data Quality Metrics

This section describes how to delete plans for data quality metrics in iWay Data Profiler.



x
Procedure: How to Delete Plans for Data Quality Metrics

To delete plans for data quality metrics:

  1. Click Data Quality Metric, located under PROJECT, in the iWay Data Profiler home page.

    The Plan for Data Quality Metric page opens and displays a list of uploaded projects, as shown in the following image.

  2. Click the Delete icon on the right side of the page that corresponds to the plan you want to delete.

    A confirmation message is displayed.

  3. Click OK to delete the plan for data quality metric.

    A message appears indicating that the plan information has been deleted successfully. The deleted Data Duality Metric is removed from the Plan for Data Quality Metric page.

  4. Click Cancel to cancel the delete operation.

iWay Software