Chapter 6. Petals Master services management

Version 7 by Olivier Fabre
on Mar 02, 2010 15:44.

<< Changes from 6 to 7

compared with

Version 8 by Olivier Fabre
on Mar 02, 2010 16:14.

Changes from 8 to 9 >>

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (20)

View Page History

...

\\
In this part of the documentation, we will see how to import services into Petals Master's registry, how to search services, add organization's and person's roles on services and endpoints .
\\

h1. {color:#003f80}{*}6.1.*{color} {color:#003f80}{*}How{*}{color} {color:#003f80}{*}to{*}{color} {color:#003f80}{*}import{*}{color} {color:#003f80}{*}a{*}{color} {color:#003f80}{*}service{*}{color}

Importing a service into Petals Master's registry is really simple. Go to the "Import service" page. You will see this : You have two tabs. The first tab "WSDL URL Import" :
\\
\\ !importServiceURL.png|thumbnail!\\

You have only to copy/paste the URL of the service's WSDL into the field, then validate. You could also specify a name for the registered wsdl file. It will be used as file name when you will download it.

!importServiceUrlExample.png|thumbnail!\\

The second tab "WSDL File Import" :

!importServiceFile.png|thumbnail!\\

Here, browse your files and choose the service's WSDL. You could also specify a name for the registered wsdl file. It will be used as file name when you will download it.
\\
You will be forwarded to a new screen, displaying the service(s) described by the uploaded WSDL and then registered into Petals Master.

!viewNewServiceImported.png|thumbnail!
 
\\
To display service's information (like the roles of the actors (provider, consumer, developer, user, etc.), categorization, brief description of the aim of the service, etc.), click on the service's name : you will arrive on the _View/Edit_ _form_ of the service.
\\

{warning}{color:#cc0000}{*}Caution{*}{color}\\
UI import functionalities allows import of WSDL with absolute imports or without imports. Only Petals Master
Web Service API allows to import WSDL with relative imports. See {color:#003f80}Chapter{color} {color:#003f80}8,{color} {color:#003f80}{_}Petals{_}{color} {color:#003f80}{_}Master{_}{color} {color:#003f80}{_}Web{_}{color} {color:#003f80}{_}Services{_}{color} {color:#003f80}{_}APIs{_}{color}{warning}

h1. {color:#003f80}{*}6.2.*{color} {color:#003f80}{*}View{*}{color} {color:#003f80}{*}service's{*}{color} {color:#003f80}{*}information{*}{color} {color:#003f80}*(purpose,*{color} {color:#003f80}{*}endpoints,*{color} {color:#003f80}{*}actors,*{color} {color:#003f80}{*}etc.)*{color}

\\

You have several tabs on this form.

• The first is the *service's ID card*. There, you can fill pieces of information about its purpose and other stuff (select the _Edit button_ to edit/add data). You can rate the service by clicking the stars labeled as "My rating". The stars labeled as "Global rating" provide the average users rating.You could also tag services by clicking "New Tag" and providing a comma separated list of tags. If you want see the service's WSDL (the one you provide to register the current service) click on the link of the download column.

h2. 6.2.1 Service Identity Card tab

There, you can fill pieces of information about its purpose and other stuff (select the _Edit button_ to edit/add data). You can rate the service by clicking the stars labeled as "My rating". The stars labeled as "Global rating" provide the average users rating.You could also tag services by clicking "New Tag" and providing a comma separated list of tags. If you want to see service related WSDLs (automatically linked when you create a service from a wsdl import or added after service manual creation) click on the links of the download column. You could also delete them by clicking on the delete button. Deleted WSDL will only be unlinked from the service (if not linked to other services or endpoints, it is totally removed from the registry).

!viewService.png|thumbnail!

• The second tab is named Other Info . If you click on it, you can see several categories defined for this service. You could add new categories by clicking Add button. To delete categories, just tick them in the list and click Delete button.

h2. 6.2.2 Other Info tab

You can see several categories defined for this service. You could add new categories by clicking Add button. To delete categories, just tick them in the list and click Delete button.

!viewServiceCategories.png|thumbnail!

• The third tab is named *Endpoints*. This tab displays all of the service's endpoints (as defined by the service's WSDL).

h2. 6.2.3 Endpoints tab

This tab displays all of the service's endpoints (registered during WSDL import or manually created).

!viewServiceEndpoint.png|thumbnail!\\

...

• The fourth tab is named *Organization's roles*. This tab displays the roles of the organizations. If the service is newly registered, there is no organization's role at all.

h2. 6.2.4 Organization's roles tab

This tab displays the roles of the organizations. If the service is newly registered, there is no organization's role at all.

!viewServiceOrganization.png|thumbnail!\\

...

!viewServiceOrganizationFilter.png|thumbnail!\\

• The fifth tab is named *Person's* *roles*. This tab displays the roles that persons of an organization have on the current service. If the service is newly registered, there is no person's role at all.

h2. 6.2.5 Person's role tab

This tab displays the roles that persons of an organization have on the current service. If the service is newly registered, there is no person's role at all.

!viewServicePerson.png|thumbnail!\\
To add a person's role, it is very simple. Click on the 'Create person's role' button, then fill in the form : choose an organization, choose a person, then choose a role and validate.

...

\\ !viewServicePersonFilter.png|thumbnail!\\
\\

• The sixth tab is named *Related* *Docs*. Here, you can attach documents relating to the service (authorized formats: .DOC,
.PDF, .XML, .HTML, .XLS, .PPT, .TXT, .RTF, .ODT, .ODS, .ODP).

h2. 6.2.6 Related Docs tab

Here, you can attach documents related to the service (authorized formats: .DOC, .PDF, .XML, .HTML, .XLS, .PPT, .TXT, .RTF, .ODT, .ODS, .ODP).

!viewServiceRelatedDocs.png|thumbnail!\\

...

!viewServiceRelatedDocExample.png|thumbnail!\\

• The seventh and last tab is named *Comments*. Here you can write comments for the service and see other user comments.

h2. 6.2.7 Comments tab

Here you can write comments for the service and see other user comments.

!viewServiceComments.png|thumbnail!

...

h1. {color:#003f80}{*}6.3.*{color} {color:#003f80}{*}View{*}{color} {color:#003f80}{*}service's{*}{color} {color:#003f80}{*}endpoints{*}{color}

\\
To view and edit information about an endpoint (like the roles of the actors (provider, consumer, developer, user, etc.)), click on the endpoint name (reachable via the 'Endpoints' tab of the Service View/Edit screen, as seen previously).
\\

• You will arrive on the endpoint's ID card. There, you can fill pieces of information about its purpose and other stuff. You can rate the endpoint (click the stars) and define tags (click New Tag). If you want to see the service's WSDL (which owns the current endpoint) click on download.
\\
\\ !viewEndpoint.png|thumbnail!\\
\\
• The second tab is named 'Other Info'. Here you can add categories for this endpoint :

!viewEndpointCategories.png|thumbnail!\\
To add categories, click the button "add"

!addOrganizationCategory.png|thumbnail!

\\
You obtain :

!viewServiceCategoriesExample.png|thumbnail!

\\
• The third tab is called 'Operations'. This tab displays all the endpoint's available operations, as you can see below.
\\

\\ !viewEndpointOperations.png|thumbnail!\\

• The fourth tab is named 'Organization's roles'. This tab displays the roles of the organizations. If the service (and so, the endpoint) is newly registered, there is no organization's role at all.

!viewEndpointOrganization.png|thumbnail!

\\
To add an organization's role, it is very simple. Click on the 'Create organization's role' button, then fill in the form :
choose an organization, then choose a role and validate.

!addEndpointOrganization.png|thumbnail!\\

Then, the organization's role appears into the array :

!viewEndpointOrganizationExample.png|thumbnail!

• The fifth is named 'Person's roles'. This tab displays the roles that persons of an organization have on the current endpoint. If the service (and so, the endpoint) is newly registered, there is no person's role at all.

!viewEndpointPerson.png|thumbnail!

To add a person's role, it is very simple. Click on the 'Create person's role' button, then fill in the form : choose an organization, choose a person, then choose a role and validate.

\\ !addEndpointPerson.png|thumbnail!\\

Then, the person's role appears into the array :

!viewEndpointPersonExample.png|thumbnail!

A role (organization role or person role) added to an endpoint is automaticaly added to the parent service.

\\
•  The sixth and last tab is named Comments. Here you can write comments for the endpoint and see other users comments.

!viewEndpointComments.png|thumbnail!

h1. {color:#003f80}{*}6.4.*{color} {color:#003f80}{*}Search{*}{color} {color:#003f80}{*}services{*}{color}

\\
The use of the services search engine is similar to the one for organizations and persons. Enter your keywords and select fields on which the engine will search.

!searchService.png|thumbnail!

!searchServiceSeeAll.png|thumbnail!

\\
To display the list of all Services in Petals Master database push the "See All" button. The results are displayed as following :
\\
\\
\\

Quick access

Petals Master Snapshot

Petals Master 1.1

Petals Master 1.0

Chapter 6. Petals Master services management

Changes (20)