Summary of Web Services¶

The Summary tab contains all the basic information about the current web service.

The Summary tab shows the basic information about the web service¶

This information consists of:

• The type of the web service: SOAP or REST.

• The database where you can find the web service in Virtual DataPort.

• A description about the web service. At first, it is obtained from Virtual DataPort. However, if you have the proper permissions, you will see a icon next to the description. Click it and define a new description, which will be specific to the Data Catalog.

  

  The Data Catalog can have its own description for a web service, in plain text or HTML¶

• The categories the web service belong to. If you are allowed to assign catagories you will see the Add Category button in the toolbar. Click it to edit the categories.

  

  In the dialog to edit the categories the current list is highlighted in blue¶

• The tags that describe the web service. If you are allowed to assign tags you will see the Add Tag button in the toolbar. Click it to edit the tags.

  

  In the dialog to edit the tags the current list is highlighted in blue¶

• The people who endorsed this web service. Since Data Catalog 8.0, users can write comments on web services to show their support. Next to the Endorsed by label you have the number of endorsements on this web service and their authors. Move the mouse over an author to see her comment. Click the number of endorsements and check all the comments at once.

  

  In the dialog with all the endorsements you can edit your own comment. Depending on your permissions, you may also be able to edit other people’s comments.¶

  If you are allowed to create endorsements, you will see the option Collaboration > Endorse in the toolbar. Click it and write your comment. Take into account that you can only endorse a web service once. If you write a new comment, the previous endorsement will be replaced.

• The people who warned against this web service. In the same way that users can support web services writing endorsements, they can advise against them writing warnings. Next to the Warnings by label you have the number of warnings on this web service and their authors. If you are allowed to write warnings, you will see the option Collaboration > Warn. Remember that you can only write one warning against a web service.

• A sign of deprecation. Besides endorsements or warnings, users can write deprecation notes, where they inform that a web service is obsolete and should not be used anymore. If the web service is deprecated you will see the icon in the toolbar and a notification will appear every time you access the web service.

  

  The notification with the deprecation messages has a Show details button. Click it to check all deprecations or edit them if you are allowed to.¶

  If you are allowed to write deprecations, you will see the option Collaboration > Deprecate. Remember that you can only write one deprecation about a web service.

• The connection URL to access this web service. In the toolbar you will find the Connection URLs button. Click it and obtain the URL to connect to this web service. In case the web service has not been deployed yet, the button will be disabled.

  

  Click the icon next to the URL to copy it to the clipboard¶

  Note

  The Connection URLs button may have been disabled by the administrator of the Data Catalog.

In addition, an administrator of the Data Catalog can add custom properties to the web service to improve the information you have about it. If they are configured to appear in the Summary tab, you will see a collapsible section for each group of custom properties. With the proper permissions, you will find a icon next to each custom property to edit it.

If the web service is synchronized and the user has permissions to create requests, the corresponding buttons for creating requests will be displayed.

Workflow requests available for a web service¶

• Access request: request type intended to request permissions to access a web service.

• Change: request type intended for requesting metadata changes.

• Data quality: request type intended for reporting a problem in the data of the web service that needs to be fixed.

• Question: request type intended for asking something about the web service.

To create a request just click on the desired option and fill the fields:

Workflow data quality request creation¶

• Summary: a title for the request.

• Description: a description for the request. It can be changed later unless the request becomes canceled.

• Priority: a value for the priority: Low, Medium, High or Critical.

When the web service has requests created by the current user, a new tab Requests is shown. Furthermore, requests created can be listed on in my requests page.