Registering, modifying, and de-registering web services

The procedures in this topic describe how to use the AR System Web Services Registry form and the AR System Web Services Category form to register, modify, and de-register web services. To use these procedures, the web service must already be defined. (See Publishing a web service.)

To register a web service

1. Open the AR System Web Services Registry form in New mode in a browser.
   
   AR System Web Services Registry form
   (Click the image to expand it.)
   
2. Supply the required information in the following fields:
   • Business Name — Use a consistent name to identify your organization.
   • Application Name — Use a name that identifies the application that provides the web service.
     The web service is registered in the BMC Atrium Web Services Registry in the <businessEntity> named businessName: applicationName. The values are taken from the Business Name and Application Name fields in the form. The form workflow creates the <businessEntity> entry in the registry if necessary.
   • Description — Your description of the web service.
   • Web Service — The web service to register. Select a BMC Remedy AR System web service from the drop-down list, or type the name of another web service.
   • Application Version — The version of the application for which the web service exists.
   • Interface Version — The version of the web service client API that defines the methods used in the web service.
   • WSDL URL — The URL used to retrieve the WSDL for the web service.
     If this registry entry is for an AR System web service, Developer Studio can build the WSDL URL. Select Yes for Build WSDL URL and type the components of the URL in the fields provided:
     • Web Server Address — The URL of the web server that provides the WSDL. Include the port number if required.
     • Mid Tier Root — The root name of the BMC Remedy Mid Tier.
     • AR Server — The name of the AR System server that hosts the web service.
       If this registry entry is for an external web service, select No for Build WSDL URL, and type the URL in the WSDL URL field.
   • End Point URL — The URL used to call the web service.
     If this registry entry is for an AR System web service, Developer Studio can build the End Point URL. Select Yes for Build End Point URL and type the components of the URL in the fields provided.
     If this registry entry is for an external web service, select No for Build End Point URL and type the URL in the End Point URL field.
   • Publish To Registry? — Controls whether the information in the request is sent to the BMC Atrium Web Services Registry.
     • Select Yes to have the form workflow make the entry in the registry consistent with the information in the request.
     • Select No to be able to create the request without updating the registry.
   • Recommended Value — Specifies whether the default setting for Publish to Registry was Yes or No when the application was developed. An application author sets this value to recommend whether this web service should be registered, and the customer should not change this value.
   • Category — A table field in the Registry form that lists any categories assigned to the web service definition. This field is supported by the AR System Web Services Category form, which opens when you take any action in the table field.
     • To add a new category to the registry entry, click Add.
       The Category form opens and is populated with information from the current Registry form. Enter the appropriate values in the Category Name and Category Value fields. You can use any format in the Category Name and Category Value fields, except semicolons.
       To select from a list of existing entries, click the field menu button on the Category Name field.

       Important

       Do not use a semicolon (;) as part of a category name or category value. The semicolon is used to separate category name and value pairs when the registry is queried.

       
       The AR System Web Services Category form
       (Click the image to expand it.)
       
     • To modify a category already associated with the registry entry, select the category in the table and click Modify. Then, make the appropriate changes in the Category form.

       Tip

       If you do not see a recently added category in the field menu for the Category Name field, close and reopen the AR System Web Services Category form. This forces the list to refresh.

3. Save the Category form entry, if any, and the Registry form entry.
   When you save the entries, workflow sends the changes to the registry plug-in, which, in turn, sends the updates to the registry. After the registry updates have been made, workflow updates the Registration Status field to "Registered."

To remove an entry for a web service from the registry

1. Open the AR System Web Services Registry form in Search mode in a browser.
2. Select the BMC Remedy AR System web service from the Web Service list or type search values in other fields.
3. Click Search.
4. Select the correct request from the search results.
5. For Publish To Registry, select No.
6. Save the request.
   The form workflow removes the entry from the BMC Atrium Web Services Registry. After the entry is removed, workflow updates the Registration Status field to Not Registered.
   You can also remove an entry from the registry by deleting the corresponding request from the AR System Web Services Registry form.

   Note

   If an entry in the AR System Web Services Registry form is de-registered, the related entries in the AR System Web Services Category form remain. If an entry in the Registry form is re-registered, it is created in the Registry along with the corresponding entries in the Category form. If an entry in the Registry form is deleted, then the corresponding entries in the Category form are also deleted.

To modify an existing registry entry for a web service

1. Open the AR System Web Services Registry form in Search mode and find the correct request in the form.
2. Change the appropriate fields in the request.
3. Save the request.