How to update column annotations using a Web Service Operation in TIBCO Data Virtualization?

How to update column annotations using a Web Service Operation in TIBCO Data Virtualization?

book

Article ID: KB0076513

calendar_today

Updated On:

Products Versions
TIBCO Data Virtualization 8.2

Description

This article explains the process of updating the column annotations using the "updateColumnAnnotation" Web Service Operation in TDV.

Issue/Introduction

How to update column annotations using a Web Service Operation in TIBCO Data Virtualization?

Resolution

Follow the below steps to configure the Web Service Operation:

1. Open TDV Studio.

2. Navigate to "Composite Data Services/Web Services/system/admin/resource/operations/updateColumnAnnotation"

3. Click on the execute button and configure the below 'Request Elements'.

Here is an example:
<resource:updateColumnAnnotation xmlns:resource="http://www.compositesw.com/services/system/admin/resource" xmlns:common="http://www.compositesw.com/services/system/util/common">
  <resource:path>/shared/examples/ViewOrder/Discount</resource:path>
  <resource:detail>SIMPLE</resource:detail>
  <resource:annotation>Annotation for discount column</resource:annotation>
</resource:updateColumnAnnotation>
NOTE:
Refer to the Info tab of updateColumnAnnotation for more information on the configuration values.

4. Click on OK.

5. Open the Details of the updateColumnAnnotationResponse parameter in the Result Tab to view the annotation assigned to the column.