Use a web service response enrichment rule line to get a field value from another internal or external source, using a web service, and set this value in the target field of the enrichment rule line.

Before you can set up a web service response enrichment rule line:

  • Set up the web service to be used.
  • Define the web service that applies to the enrichment rule. Also define the desired request parameters setup. The enrichment rule web service and related parameters setup is explained in this topic.

Request parameters

For a web service, request parameters can be set up. If so, these request parameters are shown on the Web service setup page, in the Request parameters section. Note: If a Custom request handler is defined for the web service, no Request parameters are available.

You can set up and apply the request parameters in several ways:

  • Use the default parameter values, as defined for the applicable web service. In this case, no specific web service parameter setup is required for the enrichment rule.
  • Override a default parameter value. To do so, you can use one of these Parameter types: Field, Custom, or Fixed value. Each type requires specific setup.

 


Standard procedure

1. Click Data quality management.
2. On the Data quality policies tab, in the list, click the link of the desired data quality policy.
3. Click the Enrichment rules tab.
4. Click Webservice setup.
5. Click Edit.
6. Define the web service that applies to the enrichment rule.
  In the Web service field, enter or select the desired web service.
7. Click Save.
8. Sub-task: Set up a request parameter override of type Field.
  8.1 For request parameters, on the web service, a default value can be defined. You can override this default value with the value of a field.
  In the Request parameters section, in the list, find and select the desired parameter.
 

Note: If no default value is defined for a request parameter, you can also use a field value to define the request parameter value.

  8.2 Select the Override setup check box.
  8.3 In the Parameter type field, select 'Field'.
  8.4 Define which field of the enrichment rule source table is used to set the request parameter value.
  In the Field name field, enter or select a value.
9. Sub-task: Set up a request parameter override of type Custom.
  9.1 For request parameters, on the web service, a default value can be defined. You can override this default value with a value that is defined by a custom method.
  In the Request parameters section, in the list, find and select the desired parameter.
 

Note: If no default value is defined for a request parameter, you can also use a custom method to define the request parameter value.

  9.2 Select the Override setup check box.
  9.3 In the Parameter type field, select 'Custom'.
  9.4 Define the custom class that is used to define the request parameter value.
  In the Class field, enter or select a value.
 

Note: You can only select classes that extend the DQSWebServiceParametersBase base class. This custom class must have a return method that returns a value.

  9.5 Define the custom class return method that is used to define the request parameter value.
  In the Method field, enter or select a value.
10. Sub-task: Set up a request parameter override of type Fixed value.
  10.1 For request parameters, on the web service, a default value can be defined. You can override this default value with a fixed value.
  In the Request parameters section, in the list, find and select the desired parameter.
 

Note: If no default value is defined for a request parameter, you can also use a fixed value to define the request parameter value.

  10.2 Select the Override setup check box.
  10.3 In the Parameter type field, select 'Fixed value'.
  10.4 In the Value field, type a value.
11. Close the page.
12. Close the page.

Provide feedback