This documentation is for WSO2 Governance Registry 5.0.1. View documentation for the latest release.
||
Skip to end of metadata
Go to start of metadata

Users can define service descriptions by using the Metadata sub menu. Users can provide a name for the service and more information about the service which will be useful for SOA Governance. Users can also specify states for the services, for instance Test stage, Deployed stage, Deprecated stage etc.

Adding a service

Users can provide information like transport protocols, message formats, message exchange patterns and so on. 

Follow the instructions below to add a new service to the Governance Registry.

  1. Sign in. Enter your user name and password to log on to the Management Console.
  2. Click the Main button to access the Metadata menu. From the left navigation menu, under Add, in the Metadata menu, select Service.
  3. On the Add Service page, specify the following options:
    • Name - The name of a service.
    • Namespace - The name of a namespace to which the service is related.
    • Version - The service version. Should be in format "1.2.3".
    • Description - A brief description of a service.
  4. You can add a lifecycle to a service from the life cycle panel on the right, and you view it added in the panel after you add. 
  5. Optionally, you can also add contacts. Click on the Add Contact link under Contacts. Select the contact type from the drop-down menu and enter the contact name or organization name.
  6. Specify the following options under Interface:

    1. WSDL URL- If the user provides an actual WSDL URL, the WSDL will be imported as the WSDL for the imported resource which will create an association between the imported service resource and imported WSDL. However, if the user imports a WSDL by clicking Add WSDL, a service resource will be created from the available information, so that the user can go to the service resource and add more service information. See Managing WSDLs.
    2. Transport Protocols - Select the available transport protocols from the drop-down menu. The following options are available:
      1. HTTP
      2. HTTPS
      3. SMTP
      4. TCP
      5. XMPP
      6. JMS
    3. Message Formats - Select the available message formats from the drop-down menu. The following options are available:
      1. SOAP 1.1
      2. SOAP 1.2
      3. XML
      4. JSON
      5. HTTP-REST
      6. CSV
      7. BINARY
    4. Message Exchange Patterns - Select the message exchange patterns from the drop-down menu. 
      1. None
      2. Request Response
      3. One Way 
  7. Manage the security options:

    1. Authentication Platform -Select the authentication platform from the drop-down menu. The available options are:
      1. TAM-WEBSEAL
      2. XTS-WS TRUST
      3. Builtln  
      4. WSO2 Identity Server
    2. Authentication Mechanism-Select the authentication mechanism from the drop-down menu. The available options are:
      1. Open ID
      2. InfoCard
      3. Client Certificates
      4. HTTPS Basic Authentication
      5. IP Address Filtering
      6. WS-SecurtyWS-Trust Token
    3. Authorization Platform-Select the authorization platform from the drop-down menu. The available options are:
      1. TAM-WEBSEAL
      2. XTS-WS TRUST
      3. Builtln  
      4. WSO2 Identity Server
    4. Message Integrity-Select the message integrity from the drop-down menu. The available options are:
      1. SSL
      2. WS-Security
      3. XML Digital Signatures
    5. Message Encryption-Select the message encryption from the drop-down menu. The available options are:
      1. SSL
      2. WS-Security
      3. XML Digital Signatures
    6. Comments - Enter comments on the security if necessary.
  8. Optionally you can add an endpoint to a service. Click on the Add Endpoint link. Select an environment from the drop-down menu and specify the URL of an endpoint.
  9. Add some document links to the service. Specify the following options:

    1. Document Type - The type of a document.
    2. URL - The URL where this document is located.
    3. Comment - Any comment on the document link.

Listing services

  1. All the added services can be viewed under List > Services.
  2. Information such as Service Name, Service Version, Service Namespace, Life Cycle status and Actions are displayed about the services. 
  3. A service can be selected by the version of the service. 

See also Governance Artifact Configurations for more information about service configuration.

When filtering the data using more than one value in the search field, use comma separated values with quotation marks to distinguish the values. E.g., if there are two entries with the words Connector and Resource, the search string would be: "Connector", "Resource".

Filtering service list

The Service List page also supports a basic filter to quickly find a service by name and also an advanced filter, which allows you to find service by attributes.

  1. Click on the Advanced Service Filter link to open the Filter Services page.
  2. Fill in the filtering criteria and click the Filter button to proceed.
  3. You should now see services that match your filter criteria.

    When filtering the data using more than one value in the search field, use comma separated values with quotation marks to distinguish the values. E.g., if there are two entries with the words Connector and Resource, the search string would be: "Connector", "Resource".

Service versioning

Versioning of services is an important aspect of WSO2 Governance Registry's service governance. This achieved through the lifecycle of the service. After opening the service on the Resource Browser, you can add a lifecycle to the service through the Lifecycles section.

  1. To add a lifecycle, click on the Add Lifecycle link.
  2. In the Add Lifecycle panel, define the type of a lifecycle to enable.
  3. Click on the Add button to add a lifecycle.
  4. Once a lifecycle is associated with the resource, the user is allowed to promote once all the checklist items are selected. Select the options.
  5. Click on the Promote button.

For more information on Lifecycle Management of resources (including services), read the section on Managing Lifecycle. To understand how to configure lifecycle operations, checklists etc, read about Configuring Lifecycles.

After clicking on the Promote button, you should see a screen similar to the following appearing on your browser.

After specifying the versions of the dependencies, you need to click on the Proceed button, which will promote the service to the Testing state.

The service list should now display two versions of the same service in two different lifecycle states.

Comparing services

When you have multiple services, it is often required to compare two or more services and understand which one is the best fit for your requirement. To learn how to set up a comparison between two services, see the second alternative of the Custom Report Sample. To compare more than two services at a time, you just need to change the Report Generator and the Reporting Template used. The same can also be done using the Governance APIs of WSO2 Governance Registry.

  • No labels