Configuring the ALRR Exchange Utility

Before you can use the ALRR Exchange Utility to publish and receive ALER metadata to and from ALSR, you must complete the following configuration steps.

Install the ALRR Exchange Utility

The AlrrExchangeUtility.zip is packaged in the ALER3.0.1SupInteg.Doc_Data.zip file, which is available via a hidden file when you purchase the ALER Advanced Edition. This file includes the necessary Exchange Utility files for the ALER and ALSR integration, the ALRR datapack, and the documentation.

You can unzip the AlrrExchangeUtility.zip into the directory on your file system where ALER is installed, typically BEA_HOME\repository30. When the zip file containing the ALRR Exchange Utility is unzipped to your file system, it creates the following structure.

  alrrx  <ExchangeUtility Tool Home>
    |
      datapack
      docs
      lib

Within the <ExchangeUtility Tool Home> directory, you will find the Exchange Utility files, such as the alrrx.xml, UDDIMappings.xml, alrrx.properties, alrrx.bat, and encrypt.bat files.

Import the ALRR Datapack Into ALER

The required ALRR datapack is bundled with the AlrrExchangeUtility.zip. Follow these steps to import the ALRR datapack (EndpointWS.zip) into ALER.

Unzip the AlrrExchangeUtility.zip file onto your file system.
Start the ALER Import/Export tool, as described in the ALER Import/Export Guide.
Select the Import tab.
Navigate to the <ExchangeUtility Tool Home>\datapack directory.
Select the EndpointWS.zip as the target file to import into ALER.
Click Next, and then click Next again to start the import process.
Click Finish to complete the process.

Verify the ALER UDDI System Settings

Open the ALER Admin page.
Click the System Settings option in the left pane.
Navigate to the External Integration > UDDI section.

Note:

You can also search for UDDI.

Verify the following UDDI property values:

UDDI/cmee.uddi.enabled is set to True to enable the UDDI Web service plug-in.
UDDI/cmee.uddi.server enabled is set to True to enable the repository to act as a UDDI registry for certain applications.
cmee.uddi.business.service.relationship is set to BusinessService — the relationship between Service and Business Entity asset types.
cmee.import.uddi.service.assettype is set to Service — the Service asset type.
cmee.uddi.default.business is set to a UDDI Node — only when publishing services to ALSR, when the asset is not linked to a Business Entity.

If necessary, click Save.

Configure the Service and SOA Business Entity Asset Types

Use the ALER Type Manager, enable the UDDI options for the Service and SOA Business Entity asset types, as follows:

Launch the Asset Editor by clicking Edit/Manage Assets on the Assets page.
Launch the Type Manager by selecting Manage Types on the Actions menu.
Under the Asset Types folder, select the Service asset type to edit its default configuration, as follows:

Change the UDDI setting to UDDI Business Service Entity.
Save the change by selecting Save on the File menu.

Under the Asset Types folder, select the SOA Business Entity asset type to edit its default configuration, as follows:

Change the UDDI setting to UDDI Business Entity.
Save the change by selecting Save on the File menu.

Exit the Type Manager, and then exit the Asset Editor.

Configuring the Exchange Utility Configuration File

This section describes how to configure the Exchange Utility configuration file for your environment.

Setting the Repository Connection Information

Open the alrrx.xml file located at <ExchangeUtility Tool Home> and modify the following XML section so that it points to your ALER instance with the appropriate credentials.

where URI = ALER URI, using the following format:
http://<host>:<port>/<aler web app name>/services/FlashlineRegistry

Setting the Registry Connection Information

The ALRR Exchange Utility can publish to one or more registry and can read from one registry. The first step is to create one more <registry> node with the connection info, as shown here.

  <registries>
    <registry name="alsr">
      <inquiryURI>http://localhost:7001/registry/uddi/inquiry</inquiryURI>
      <publishURI>http://localhost:7001/registry/uddi/publishing</publishURI>
      <securityURI>http://localhost:7001/registry/uddi/security</securityURI>
      <credentials>
        <user>admin</user> 
        <password>admin</password> 
    </credentials>
    </registry>
    <registry name="alsr2">
      <inquiryURI>http://localhost:7201/registry/uddi/inquiry</inquiryURI>
      <publishURI>http://localhost:7201/registry/uddi/publishing</publishURI>
      <securityURI>http://localhost:7201/registry/uddi/security</securityURI>
      <credentials>
        <user>admin</user> 
        <password>admin</password> 
      </credentials>
    </registry>
  </registries>

Setting the Repository Query

The following configuration snippets demonstrate how to build a query to run against ALER and receive the list of Services that should be published to ALSR. There are a number of ways that services can be queried and you can create one or more queries.

Query by Name

When the <services> element is configured, the service name specified is published to ALSR. However, due to a limitation in the ALER REX API, only one <services> element can be added.

  <query>
    <repositoryQuery>
      <services>
        <service name="HelloWorld" /> 
      </services>
      <registrationStatus></registrationStatus>
      <serviceCategorizations type="AssetLifecycleStage" value=""/> 
      <endpointAssetLifecycleStatus></endpointAssetLifecycleStatus>

Query by Registration Status

When the <registrationStatus> element is configured, only the services with the specified Registration Status are published. For example, if this field is set to Registered, then only registered services will be published to ALSR, while ignoring all other matched services that are not in this state.

Query by Categorizations

When the <serviceCategorizations> element is configured, only the services with the specified categorization will be published. For example, when using the following categorization, only the Recommended services will be published to ALSR.

Query by Endpoint Lifecycle Stage

When the <endpointAssetLifecycleStatus> element is configured, the endpoints of matched services can be filtered based on the specified Asset Lifecycle of the endpoints, and only the matched endpoints will be published to ALSR. For example, if there are two endpoints attached to a service, one with the Asset Lifecycle Stage of Stage 3 - Build and one with Stage 4 - Release, only the endpoint with the Stage 3 - Build Asset Lifecycle is published.

This query is useful when there are separate registries: one that lists the staged endpoints and another that lists the production endpoints.

Setting the Destination Registries

The following configuration snippet demonstrates how to use the <destinationRegistries> element to configure one or more destination registry where the matched ALER Services will go. These registries are used when Services are picked from ALER and are moved to ALSR (i.e., ALER > ALSR).

Setting the Registry Query

The following configuration snippet demonstrates how to use the <registryQuery> element to build a query to run against ALSR and receive the list of services that need to be fetched from ALSR and placed in ALER.

  <registryQuery>
    <businessEntities> 
      <businessEntity name="Account Services"/>
      <businessEntity/>
    </businessEntities> 
    <services>
      <service name="AddCustomerService%" /> 
    </services>
    <qualifiers>
      <qualifier>approximateMatch</qualifier> 
    </qualifiers>
  <sourceRegistry>alsr</sourceRegistry> 
  </registryQuery>

Make sure that the businessEntities name or service name value is not empty.
For the businessEntities name, the exact name must be specified.
For the service name, at least one wildcard character should be used. For example, to get all services specify "%".
Search criteria for an ALSR query is case-sensitive.

Search by one or more Service names. The Service names can be a wildcard if the qualifier is approximate. For example, if the service name is "Google", any service that starts with "Google" will be fetched and placed in ALER.
Select one or more Business Entity and all the services in those Business Entities will be fetched and placed in ALER. The Business Entity name has to be exact; the wild card is supported only for Services and not for Business Entities.

WARNING:

If both Business Entity query and Service query are specified, the Business Entity query will override the Service query.

Setting the Source Registry

The <sourceRegistry> element tells the registry where the Services will be picked and placed in ALER. This registry is used when Services are picked from ALSR and they move to ALER (i.e., ALSR > ALER).

Configuring ALER Categorizations In the UDDI Mappings File

Prior to publishing assets to ALSR, ALER Categorizations are mapped in the UDDI Mappings file (UDDIMappings.xml) that is stored in the <ExchangeUtility Tool Home> directory, as shown in the following XML snippet:

<uddi:uddiSettings xmlns:uddi="http://www.bea.com/aler/integration/config/uddi">
  <categorizationMappings>
    <categorizationType alerCategorizationTypeName="AssetLifecycleStage" alerCategorizationTypeId="112" uddiCategoryTModelKey="uddi:bea.com:aler:categorization:AssetLifecycleStage">
      <categorization alerCategorization="Stage 1 - Propose" uddiKeyName="Stage 1 - Propose" uddiKeyValue="Stage 1 - Propose" /> 
      <categorization alerCategorization="Stage 2 - Plan" uddiKeyName="Stage 2 - Plan" uddiKeyValue="Stage 2 - Plan" /> 
      <categorization alerCategorization="Stage 3 - Build" uddiKeyName="Stage 3 - Build" uddiKeyValue="Stage 3 - Build" /> 
      <categorization alerCategorization="Stage 4 - Release" uddiKeyName="Stage 4 - Release" uddiKeyValue="Stage 4 - Release" /> 
      <categorization alerCategorization="Stage 5 - Target For Retirement" uddiKeyName="Stage 5 - Target For Retirement" uddiKeyValue="Stage 5 - Target For Retirement" /> 
      <categorization alerCategorization="Stage 6 - Retirement" uddiKeyName="Stage 6 - Retirement" uddiKeyValue="Stage 6 - Retirement" />

An ALER Categorization will be honored in ALSR only if a corresponding mapping is present in the UDDI Mappings file; otherwise, the Categorization will simply be ignored. Therefore, if a new asset Categorization is created ALER, you must regenerate the UDDI Mappings file for that Categorization to be honored in ALSR.

Understanding the Exchange Utility's Property File

This section describes the properties in the Property file (alrrx.properties) file that is stored in the <ExchangeUtility Tool Home> directory. Some properties already exist in the ALER System Settings and some of the properties are new for the ALRR Exchange Utility.

cmee.uddi.service.endpoint.relationship=Access — relationship between Service and Endpoint.
cmee.uddi.service.wspolicy.relationship=Attached — relationship between Service and WS-Policy and relationship between Endpoint and WS-Policy.
cmee.import.uddi.business.assettype=SOA - Business Entity — Business Entity asset type.
cmee.import.uddi.accesspoint.assettype=Endpoint: Web Service — Endpoint asset type.
cmee.import.uddi.wspolicy.assettype=Artifact: WS-Policy — WS-Policy asset type.
cmee.import.uddi.publish.ifendpointmissing=true — If the Endpoint information is missing, this setting determines whether to publish the service or not.
cmee.import.uddi.artifactwsdl.relationship=Implements — relationship between Service and WSDL artifact.
cmee.import.uddi.receiver.batch.size=100 — Only when receiving from ALSR, this determines the batch size.

cmee.uddi.business.service.relationship=BusinessService — relationship between Service and Business Entity asset types.
cmee.import.uddi.service.assettype=Service — Service asset type.
cmee.uddi.default.business=A UDDI Node — only when publishing services to ALSR, when the asset is not linked to a Business Entity.

Encrypting the Configuration File Passwords

For enhanced security, the password encryption tool (encrypt.bat) allows you to encrypt the passwords that are stored in the Exchange Utility configuration (alrrx.xml) file.

Navigate to the <ExchangeUtility Tool Home> directory.
From a command prompt, run the password encryption tool as follows:

> encrypt.bat alrrx.xml alrrx.xml

where:

alrrx.xml = the ALRR Exchange Utility configuration file

Figure 2-1 Encrypt Password Tool

Encrypt Password Tool

Exchange Utility