Service Registry 3.1 User's Guide

Publishing Objects

    Publishing objects to the registry is a three-step process:

  1. Create the object.

  2. Add details and other objects, saving them to memory but not publishing them to the Registry.

  3. Publish the object to the Registry.

You can publish objects to the registry if you have created a user account and have logged in. To create a user account, follow the instructions in Creating a User Account.

The first task below describes the steps that you follow to create any new object. The sections that follow describe the additional steps required to publish particular kinds of objects.

You can create and publish any of the objects listed in Table 2–2, with the following exceptions:

This section describes the following tasks:

ProcedureTo Create and Publish a New Registry Object

  1. In the Tasks tab of the left menu area, click Create a New Registry Object.

  2. In the Registry Objects area, choose an object type from the combo box and click Add.

    A Details form for the object appears in the Details area.

  3. Type a name in the Name field.

  4. (Optional) Type a description in the Description field

  5. (Optional) Type a comment in the Version Comment field.

  6. (Optional) Replace the assigned Unique Identifier and Logical Unique Identifier with identifiers of your own choosing.

    Each identifier must be a valid URN and must be unique within your Registry installation.

  7. Enter data in the fields specific to the object type.

  8. Click Save to save the object in memory.


    Note –

    Make sure that you save the changes you make in any of the tab areas for the object before you move to another tab. If you do not save your work, it will be lost.


  9. (Optional) Use the tabs in the Details form to add and save composed objects.

  10. Click Apply to publish the object to the Registry.

    A status message appears, indicating whether the apply was successful.

Next Steps

Either before or after you publish the object, you can edit the object by adding composed objects to it. Table 2–4 lists the objects that you can add. Later sections describe how to add these objects.

ProcedureTo Create and Publish an AdhocQuery Object

An AdhocQuery object represents an ad hoc query expressed in a query syntax. AdhocQuery objects are used for discovery of registry objects. AdhocQuery objects are similar in purpose to the concept of stored procedures in relational databases. For example, the predefined queries in the Search panel are all AdhocQuery objects.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select AdhocQuery.

  2. (Optional) Select a query type from the Query Type combo box.

    The default is SQL Query. Other supported query types are XQuery and ebXML Filter Query.

  3. Type the text of the query in the Query String field.

    For a SQL query, use pairs of single quotes to enclose items that you normally enclose in single quotes. These items are typically parameter placeholders and literals, when they occur in subqueries. For example, specify a parameter placeholder in a subquery as follows:

    (SELECT id FROM ClassificationNode WHERE path LIKE ''$objectTypePath'')

    Specify both a literal and a parameter placeholder as follows:

    ... AND (ro.id = s.parent AND s.name_ = 
    ''urn:oasis:names:tc:ebxml-regrep:profile:ws:wsdl:nameSpacesUsed''
      AND s.value LIKE ''$nameSpacePattern'')
  4. Execute Steps 8–10 in To Create and Publish a New Registry Object.

ProcedureTo Create and Publish a ClassificationNode Object

A ClassificationNode object represents a taxonomy element that has a structural relationship with other elements in an internal classification scheme. You can create a ClassificationNode object and then add it to a classification scheme, but it may be simpler to use the Concepts tab of the ClassificationScheme Details panel to create concepts.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select ClassificationNode.

  2. Type a value for the ClassificationNode object in the Value field.

    The Classification Scheme, Parent Id, and Path fields are grayed out.

  3. Execute Steps 8–10 in To Create and Publish a New Registry Object.

ProcedureTo Create and Publish a ClassificationScheme Object

A ClassificationScheme object represents a taxonomy used to classify objects. In an internal ClassificationScheme, all taxonomy elements are defined in the registry as Concept instances. In an external ClassificationScheme, the values are not defined in the registry as Concept instances but instead are referenced by their String representations.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select ClassificationScheme.

    The External Classification Scheme checkbox is selected, to indicate that the scheme has no concepts. If you add concepts to the classification scheme, the checkbox will no longer be selected.

  2. Select a value from the Value Type combo box:

    • Unique. Indicates that each node of the taxonomy has a unique code assigned to it.

    • Embedded Path. Indicates that the unique code assigned to each node of the taxonomy also encodes its path.

    • Non-Unique. Indicates that nodes are not unique and that it is necessary to use the full path (from the ClassificationScheme to the node of interest) to identify the node.

    The default is Unique.

  3. Execute Steps 8–10 in To Create and Publish a New Registry Object.

ProcedureTo Create and Publish an ExternalLink Object

An ExternalLink object provides a URI for content that resides outside the registry.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select ExternalLink.

    The Object Type field contains the value ExternalLink.

  2. (Optional) Click the Select Concept for Object Type button to select an object type for the data referenced by the URI.

    In the Extrinsic Object Classification Node Selector window, expand the nodes until you reach the appropriate concept within the ExtrinsicObject type. After you click OK, the Object Type window contains the type you selected.

  3. Type the URI for the external link in the External URI field.

  4. Execute Steps 8–10 in To Create and Publish a New Registry Object.


    Note –

    If you get an error when you try to save an ExternalLink object, it means that an administrative task needs to be performed. See Unable to Create ExternalLink or ServiceBinding for details.


ProcedureTo Create and Publish an ExtrinsicObject Object

An ExtrinsicObject provides metadata that describes content whose type is not intrinsically known to the registry and that therefore must be described by means of additional attributes, such as MIME type.

Use an ExtrinsicObject to publish files of various kinds. Most commonly, these are Web Services artifacts such as WSDL files.

The ebXML Registry Profile for Web Services is an OASIS standard that defines the ebXML Registry profile for publication, management, governance, discovery, and reuse of Web Services artifacts. By default, Service Registry implements this profile. In practice, this means that when you publish a WSDL file to the Registry as an ExtrinsicObject object, the Registry creates some standard metadata for the document, in effect creating the web service defined by the document. This feature is called WSDL cataloging.

To publish one or more WSDL files that have dependencies on each other or on other files (such as XSD files), create a zip file that contains all the files.

It is possible for an administrator to disable the WSDL cataloging feature. See Disabling the WSDL Cataloger in Service Registry 3.1 Administration Guide for details.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select ExtrinsicObject or one of its subtypes.

    For example, to publish one or more WSDL files, select WSDL.

  2. (Optional) Type the MIME type of the object in the MimeType field. The type should be one of those listed in http://www.iana.org/assignments/media-types.

    If you are uploading a stand-alone WSDL file (a text file containing XML), set the MIME type to text/xml.

    If you are uploading a zip file containing multiple WSDL (and, optionally, XSD) files, set the MIME type to application/zip.

  3. (Optional) Select the Is Opaque checkbox if the content of the object is not readable by the registry (for example, if it is encrypted).

  4. Click the Select Content for Object Type button if you need to select an object type more specific than ExtrinsicObject.

    In the Extrinsic Object Classification Node Selector window, expand the nodes until you reach the appropriate concept within the ExtrinsicObject type. After you click OK, the Object Type window contains the type you selected.

  5. Click the Choose Repository Item File button to locate the repository item for the ExtrinsicObject.

    1. In the File Upload window, type the file path in the text field or click Browse.

    2. If you clicked Browse, use the file chooser window to navigate to the file, then click Open.

    3. In the File Upload window, click Upload File.

    4. Click OK.

    The following additional items appear in the Details panel:

    • A Content Version field (grayed out)

    • A Content Version Comment field, which you can fill in

    • A Remove Repository Item button

    • A View Repository Item Content link

  6. Execute Steps 8–10 in To Create and Publish a New Registry Object.

Next Steps

After you create an ExtrinsicObject object that refers to a WSDL file, you can find it by using the WSDL Discovery Query. Also, if you use Basic Query to search for ExtrinsicObject objects of type WSDL, for Service objects, and for ServiceBinding objects, you will find that the Registry has created all the objects specified by the elements of the WSDL file:

ProcedureTo Create and Publish a Federation Object

A Federation represents an affiliated group of registries. Its only attributes are the basic RegistryObject attributes. You must be an administrator in order to create a Federation object.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select Federation.

  2. Execute Steps 8–10 in To Create and Publish a New Registry Object.

  3. Add affiliated registries to the federation by following the steps in Creating Relationships Between Objects. The specific steps are as follows:

    1. Search for the federation, select its Pick checkbox, and click Bookmark.

    2. Search for the registry, select its Pick checkbox, and click Relate.

    3. In the Create Relationship area, select the federation as the source object. The registry becomes the target object.

    4. Set the AssociationType to HasFederationMember.

ProcedureTo Create and Publish an Organization Object

An Organization object provides information about an organization. It may have a parent, and may have one or more child organizations. It always has a User object as a primary contact, and may offer services by creating associations between the organization and one or more Service objects.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select Organization.

  2. (Optional) Type values in the PostalAddresses fields.

  3. Execute Steps 8–10 in To Create and Publish a New Registry Object.

    See the following sections for details on adding composed objects to an Organization object:

  4. To add a Service to an Organization, follow the steps in Creating Relationships Between Objects. The specific steps are as follows:

    1. Search for the organization, select its Pick checkbox, and click Bookmark.

    2. Search for the service, select its Pick checkbox, and click Relate.

    3. In the Create Relationship area, select the organization as the source object. The service becomes the target object.

    4. Set the AssociationType to OffersService.

ProcedureTo Create and Publish a Person or User Object

A Person or User object provides information about persons and registered users within the registry. Both kinds of objects have identical attributes. A User object is affiliated with an Organization object as the primary contact. User objects are also used in AuditableEvent objects to identify the requestor that sent the request that generated the AuditableEvent.

The recommended way to create User objects is through the User Registration Wizard. Use the Web Console to create Person objects whenever you want to create metadata about persons who will not themselves be accessing the registry.

If you want to be able to create more than one postal address, email address, or telephone number for the person, create a User object. The Web Console allows you to add postal addresses, email addresses, and telephone numbers as composed objects for a User object, but not for a Person object.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select Person or User.

  2. Type values in the Person Name fields.

    Specify a value for at least one of these fields.

    Do not use the Name field. The Web Console ignores any value you type in the Name field for a Person or User object.

  3. Add composed objects as described in the following sections:

  4. Execute Steps 8–10 in To Create and Publish a New Registry Object.

ProcedureTo Create and Publish a Registry Object

A Registry object represents a registry. Its only attributes are the basic RegistryObject attributes. You must be an administrator in order to create a Registry object.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select Registry.

  2. Execute Steps 8–10 in To Create and Publish a New Registry Object.

Next Steps

See To Create and Publish a Federation Object for information on how to add the registry to a federation.

ProcedureTo Create and Publish a RegistryPackage Object

A RegistryPackage object represents a logical grouping of any number of registry objects.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select RegistryPackage.

  2. Execute Steps 8–10 in To Create and Publish a New Registry Object.

  3. To add objects to the package, follow the instructions in Adding Objects to a Registry Package.

ProcedureTo Create and Publish a Service Object

A Service object provides information on a service. It may contain one or more ServiceBinding objects, which represent technical information on how to access the service.

The most common way to publish a Service object is to publish an ExtrinsicObject object whose content consists of one or more WSDL files. For more information, see To Create and Publish an ExtrinsicObject Object.

  1. Execute Steps 1–6 in To Create and Publish a New Registry Object. In Step 2, select Service.

  2. Execute Steps 8–10 in To Create and Publish a New Registry Object.

  3. To add ServiceBinding objects to the service, follow the instructions in Adding a Service Binding to a Service.

  4. To add SpecificationLink objects to a ServiceBinding, follow the instructions in Adding a Specification Link to a Service Binding.