Service Registry 3 2005Q4 User's Guide

Publishing and Managing Registry Objects

The Create a New Registry Object menu item allows you to create objects and to publish the objects to the Registry.

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.

ProcedureTo Create and Publish a New Registry Object

Steps
  1. In the menu area, click Create a New Registry Object.

  2. In the Registry Objects area, choose an object type from the drop-down list and click Add.

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

  3. Type a name and, optionally, a description in the fields of the Details form. Type values for other fields that appear in the Details form.


    Note –

    When you create an AdhocQuery object and type the query string, 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. (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.

  5. (Optional) Click Save to save the object in memory.

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

  7. 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 1–4 lists the objects that you can add. The following sections describe how to add these objects.

Adding a Classification to an Object

To create a classification, you use an internal classification scheme. An internal classification scheme contains a set of concepts whose values are known to the Registry.

ProcedureTo Add a Classification

To add a Classification to an object, search for the appropriate classification scheme, then choose a concept within that classification scheme.

Steps
  1. In the Details area for the object, click the Classifications button.

    The Classifications table, which can be empty, appears.

  2. Click Add.

    A Details Panel window opens.

  3. Type a name and, optionally, a description for the classification.

  4. Click the Select ClassificationScheme or Concept button.

    A ClassificationScheme/Concept Selector window opens.

  5. Expand the ClassificationSchemes node. Then expand concept nodes until you have selected the leaf node that you want to use.

  6. Click OK to close the ClassificationScheme/Concept Selector window.

    The classification scheme and concept appear in the Details Panel window.

  7. Click Add to save the new object and close the Details Panel window.

  8. Click Apply in the Details area for the object.

Adding an External Identifier to an Object

To create an external identifier, you use an external classification scheme. An external classification scheme has values that are not known to the Registry because the classification scheme has no concepts.

ProcedureTo Add an External Identifier

To add an external identifier to an object, search for the appropriate classification scheme, then specify a value.

Steps
  1. In the Details area for the object, click the External Identifiers tab.

    The External Identifiers table, which can be empty, appears.

  2. Click Add.

    A Details Panel window opens.

  3. Type a name and, optionally, a description for the external identifier.

  4. Click the Select ClassificationScheme button.

    A ClassificationScheme/Concept Selector window opens.

  5. Expand the ClassificationSchemes node, then select a classification scheme that has no concepts.

  6. Click OK to close the ClassificationScheme/Concept Selector window.

    The classification scheme appears in the Details Panel window.

  7. Type a value in the Value field.

  8. Click Add to save the new object and close the Details Panel window.

  9. Click Apply in the Details area for the object.

Adding an External Link to an Object

An external link allows you to associate a URI with a registry object.

ProcedureTo Add an External Link

Steps
  1. In the Details area for the object, click the External Links tab.

    The External Links table, which can be empty, appears.

  2. Click Add.

    A Details Panel window opens.

  3. Type a name for the external link.

  4. Type the URL for the external link in the External URI field.

  5. (Optional) Click the Select Concept for Object Type button if you want to specify the type of content to which the URL points.

    Expand the ClassificationSchemes node. Locate the content type by expanding the ObjectType, RegistryObject, and ExtrinsicObject nodes. Select the concept, then click OK. If you do not find a suitable type, click Cancel. You can create a new concept for ExtrinsicObjects if you want.

  6. Click Add to save the new object and close the Details Panel window.

  7. Click Apply in the Details area for the object.

Adding Custom Information to an Object Using Slots

A slot contains extra information that would otherwise not be stored in the Registry. Slots provide a way to add arbitrary attributes to objects.

ProcedureTo Add a Slot

Steps
  1. In the Details area for the object, click the Slots tab.

    The Slots table, which can be empty, appears.

  2. Click Add.

    A Details Panel window opens.

  3. Type a name for the Slot.

  4. (Optional) Type a value in the Slot Type field. You can use this field to specify a data type for the slot or to provide a way to group slots together.

  5. Type a value in the Values field.

  6. Click Add to save the new object and close the Details Panel window.

  7. Click Apply in the Details area for the object.

Adding a Postal Address to an Organization or User

An Organization or User can have one or more postal addresses.

ProcedureTo Add a Postal Address

Steps
  1. In the Details area for the Organization or User, click the Postal Addresses tab.

    The Postal Addresses table, which can be empty, appears.

  2. Click Add.

    A Details Panel window opens.

  3. Type values in the fields. All fields are optional.

    • Street Number

    • Street

    • City

    • State or Province

    • Country

    • Postal Code

  4. Click Add to save the new object and close the Details Panel window.

  5. Click Apply in the Details area for the object.

Adding a Telephone Number to an Organization or User

An Organization or User can have one or more telephone numbers.

ProcedureTo Add a Telephone Number

Steps
  1. In the Details area for the Organization or User, click the Telephone Numbers tab.

    The Telephone Numbers table, which can be empty, appears.

  2. Click Add.

    A Details Panel window opens.

  3. Select a value from the Type combo box.

    The following values are available:

    • Beeper

    • FAX

    • HomePhone

    • MobilePhone

    • OfficePhone

  4. Type values in the fields. All fields are optional.

    • Country Code

    • Area Code

    • Phone Number

    • Extension

  5. Click Add to save the new object and close the Details Panel window.

  6. Click Apply in the Details area for the object.

Adding an Email Address to an Organization or User

An Organization or User can have one or more email addresses.

ProcedureTo Add an Email Address

Steps
  1. In the Details area for the Organization or User, click the Email Addresses tab.

    The Email Addresses table, which can be empty, appears.

  2. Click Add.

    A Details Panel window opens.

  3. Select a value from the Type combo box: HomeEmail or OfficeEmail.

  4. Type a value in the Email Address field.

  5. Click Add to save the new object and close the Details Panel window.

  6. Click Apply in the Details area for the object.

Adding a User to an Organization

An Organization can have one or more users. One user is the primary contact, which is normally the user that created the organization. You can create and add additional users.

ProcedureTo Add a User

Steps
  1. In the Details area for the Organization, click the Users tab.

    The Users table appears.

  2. Click Add.

    A Details Panel window opens.

  3. In the Name field, type the last name of the user to the left of the comma. Optionally, type the first and middle names to the right of the comma.

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

  5. In the First Name, Middle Name, and Last Name fields, type the first name, middle name, and surname of the user. All fields are optional.

  6. Click Add to save the new object and close the Details Panel window.

  7. Click Apply in the Details area for the object.

Adding a Child Organization to an Organization

An Organization can have one or more child organizations. To add a child organization to an Organization, follow these steps:

ProcedureTo Add a Child Organization

Steps
  1. In the Details area for the Organization, click the ChildOrganizations tab.

    The ChildOrganizations table appears.

  2. Click Add.

    A Details Panel window opens.

  3. In the Name field, type a name for the new organization.

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

  5. (Optional) Type values in the address fields.

  6. Click Add to save the new object and close the Details Panel window.

  7. Click Apply in the Details area for the object.

Adding a Service Binding to a Service

A Service normally has one or more service bindings.

ProcedureTo Add a Service Binding

Steps
  1. In the Details area for the Service, click the Service Bindings tab.

    The Service Bindings table appears.

  2. Click Add.

    A Details Panel window opens.

  3. In the Name field, type a name for the service binding.

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

  5. In the Access URL field, type the URL for the service binding.

  6. (Optional) In the Target Binding field, type the unique identifier of another ServiceBinding to which this ServiceBinding refers.

  7. Click Add to save the new object and close the Details Panel window.

  8. Click Apply in the Details area for the object.

Adding a Specification Link to a Service Binding

A ServiceBinding can have a SpecificationLink object.

ProcedureTo Add a Specification Link

Steps
  1. In the Details area for the ServiceBinding, click the Specification Links tab.

    The Specification Links table appears.

  2. Click Add.

    A Details Panel window opens.

  3. In the Name field, type a name for the SpecificationLink.

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

  5. In the Usage Description field, type a usage description for the usage parameters, if the SpecificationLink has usage parameters.

  6. In the Usage Parameters field, type the usage parameters, if if the SpecificationLink has usage parameters.

  7. Click Add to save the new object and close the Details Panel window.

  8. Click Apply in the Details area for the object.

Adding a Child Concept to a Classification Scheme or Concept

A ClassificationScheme normally has numerous child concepts, which can also have child concepts.

ProcedureTo Add a Child Concept

Steps
  1. In the Details area for the ClassificationScheme, click the ChildConcepts tab.

    The ChildConcepts table appears.

  2. Click Add.

    A Details Panel window opens.

  3. In the Name field, type a name for the concept.

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

  5. In the Value field, type a value for the concept.

  6. Click Add to save the new object and close the Details Panel window.

  7. Click Apply in the Details area for the object.

Adding Objects to a Registry Package

A RegistryPackage is an object that contains other registry objects. Typically, you use a RegistryPackage to group logically related objects. The objects can be of different types and can have different owners.

You add objects to a RegistryPackage by specifying their unique identifiers. If you try to type the unique identifiers, you are likely to make errors. Therefore, the following steps describe how to add objects by copying and pasting the identifiers.

ProcedureTo Add Objects to a Registry Package

Steps
  1. Create a RegistryPackage object as described in To Create and Publish a New Registry Object. Specify a name and, optionally, a description, but do not add any RegistryObjects to the RegistryPackage at this time.

  2. After you click Apply to save the RegistryPackage, pin the RegistryPackage as described in To Use the Pin Feature.

  3. Use the Web Console to search for the objects you want to add to the RegistryPackage. Pin each object as you find it.

  4. Click the Details link for an object you want to add to the RegistryPackage.

  5. In the Details panel for the object, copy the Unique Identifier by using your keyboard (Control-C or the Copy key).

  6. In the Search Results area, click the Details link for the RegistryPackage.

  7. In the Details area for the object, click the Registry Objects tab.

  8. Click Add to Package.

  9. In the Unique Identifier field, use your keyboard to paste the identifier you copied (Control-V or the Paste key).

  10. Click Add.

    The object appears in the Registry Objects area.

  11. Click Apply in the Details area to save the RegistryPackage.

  12. Repeat steps 4 through 11 to add each additional object to the RegistryPackage.

Changing the State of Objects

In addition to publishing, editing, and removing objects, you can perform the following actions on them if you are the owner or are otherwise authorized to do so:

These features are useful in a production environment if you want to establish a version control policy for registry objects. For example, you can approve a version of an object for general use, and you can deprecate an obsolete version before you remove it. If you change your mind after deprecating an object, you can undeprecate it.

You perform all these actions in the Search Results area.

Removing Objects

To remove an object that you own from the Registry, select the object in the Search Results area and click the Delete button.


Note –

Do not delete AuditableEvent objects for objects that you own. That is, do not delete any AuditableEvent objects that appear in the Search Results area as a result of a FindAllMyObjects search. If you delete an AuditableEvent object, the audit trail for the object that it belongs to becomes corrupted.


If the object is an extrinsic object, you have two choices:

The Deletion Options menu is meaningful only for extrinsic objects.

Creating Relationships Between Objects

Objects can have two kinds of relationship: references and associations. Both kinds of relationship are both unidirectional. That is, each relationship has a source object and a target object.

The Registry supports references, which are called ObjectRefs, between certain types of objects. For example, if you create a Service and a ServiceBinding, you can create a ServiceBinding reference from the Service to the ServiceBinding. However, you cannot create a reference from the ServiceBinding to the Service. A reference is not a registry object.

An Association is a registry object. You can create an Association from any registry object to any other. The Registry supports an AssociationType classification scheme that includes a number of predefined association types: OffersService, RelatedTo, HasMember, and so on. You can also create new association types. If you own both objects in the Association, the Association is an intramural association. If you do not own both objects, the Association is an extramural association. If you create an Organization and add a Service to it, an Association of type OffersService is automatically created from the Organization to the Service.

If no valid reference exists for the source and target objects, you cannot create a reference.

You use the Relate button in the Registry Objects area to relate two objects. This button becomes active when you select two objects in the search results table.

If the two objects are not both visible in the search results table, select the Pin checkbox to hold one object in the search results table while you find the object to which you want to relate it. For details, see To Use the Pin Feature.

ProcedureTo Create a Reference

Steps
  1. In the Registry Objects area, select two objects and click Relate.

  2. In the Create Relationship area, select the source object if it is not already selected.

    The other object becomes the target object.

    If a valid reference exists for the source and target objects, the Reference option is selected by default, and the valid reference attribute appears. If no valid reference exists for the source and target objects, the Reference radio button is grayed out.

  3. Click Save to save the Reference.

ProcedureTo Create an Association

Steps
  1. In the Registry Objects area, select two objects and click Relate.

  2. In the Create Relationship area, select the source object if it is not already selected.

    The other object becomes the target object.

  3. Select the Association radio button, if it is not already selected.

  4. Type a name and, optionally, a description for the Association in the Details area.

    The source and target object ID values are already filled in.

  5. Choose a type value from the Association Type menu.

  6. Click Apply to save the Association.