> Exchange Utility > Using the ALRR Exchange Utility

Exchange Utility

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Using the ALRR Exchange Utility

This section contains the following topics:

 

Running the ALRR Exchange Utility

The ALRR Exchange Utility is run from a command-prompt, using the following syntax:

> alrrx.bat <options>

Table 3-1 defines the configuration options available when running the ALRR Exchange Utility.

Table 3-1 ALRR Exchange Utility Command-line Options 
Option
Required
What it does...
-mode <mode>
Yes
Configures the utility to run in either publish or receive mode.
  • To publish Services to ALSR from ALER, use:
    alrrx.bat -mode publish
  • To receive Services from ALSR into ALER, use:
    alrrx.bat -mode receive
-config <File Name>
Optional
Passes the alrrx.xml file as a parameter.
Example usage:
alrrx.bat -mode publish -config C:\rm\uddi\alrrx.xml
If this parameter is omitted, the configuration XML file will be loaded from the current directory where the alrrx.bat file is located using the system's Classpath.
-map <Dir Name>
Optional
Generates a UDDIMappings.xml file by connecting to ALER and populating it with the t-models based on the configured Categorizations. Also, this loads the ALRR Exchange Utility configuration using the -config parameter from the default location. You can customize this file if the t-model already exists in ALSR and map an ALER categorization to a t-model.
Example usage: alrrx.bat -map c:/rm/uddi
For more information about the UDDIMappings.xml file, see Configuring ALER Categorizations In the UDDI Mappings File.
-publish_tmodel <File Name>
Optional
Publishes all the t-models configured in the UDDIMappings.xml file to ALSR. If a t-model already exists in ALSR, it will be skipped. You need to manually delete the existing t-models if you want the ALRR Exchange Utility to populate those t-models. Also, this loads the ALRR Exchange Utility configuration using the -config parameter from the default location.
Example usage: alrrx.bat - publish_tmodel c:/rm/UDDIMappings.xml
For more information about the UDDIMappings.xml file, see Configuring ALER Categorizations In the UDDI Mappings File.
-link <asset_id> <service_key>
Optional
Links a Service in ALER to a Service in ALSR together so that the ALRR Exchange Utility can treat them as the same service. This may be required when the Service in ALER and a service in ALSR are the same but was published to ALER and ALSR using different tools. For example, ALSM (AquaLogic SOA Management) could have published a service to ALSR and the SAM plug-in could have published the same service to ALER. After they are linked, they can be synchronized by the utility.
Example usage: alrrx.bat -link 50822 uddi:systinet.com:demo:hr:employeesList

Note: Use this option with caution when linking two services.

 

How the Exchanged Metadata Is Synchronized

This section describes how metadata is synchronized when are assets exchanged between ALER and ALSR.

Synchronizing the Metadata Published from ALER to ALSR

This section describes how metadata is synchronized when publishing assets from ALER to ALSR.

Note: When synchronizing a service to ALSR that was previously synchronized, ALSR does not show the updated values if an ALSR browser instance is already open. Therefore, all the ALSR browser instances need to be restarted to see the updated values. For more information, see the Known Issues.

Business Entities

Check if the Service asset being published has a related (by configured relation) Business Entity asset, as follows:

Endpoint

Check if the Service asset being published has one or more related endpoint assets, as follows:

Categorizations

Check if Categorizations are applied to Service and Endpoint assets, as follows:

WS-Policies

Check if Service asset being published has one or more WS-Policy assets related, as follows:

Registration and Active Status

The Registration and Active Status are added to Category Bags. Figure 3-1 illustrates how Policy references appear in ALSR.

Figure 3-1 ALSR t-model Categories for a WSDL Service

ALSR t-model Categories for a WSDL Service

Figure 3-2 illustrates how two endpoints that are linked to a service in ALER appear in ALSR.

Figure 3-2 WSDL Bindings In ALSR

WSDL Bindings In ALSR

Figure 3-3 illustrates how the different entities and their relationship show up in the ALER Navigator.

Figure 3-3 Entity Relationship in ALER Navigator

Entity Relationship in ALER Navigator

Sample Flow of Metadata from ALER to ALSR

Figure 3-4 illustrates the ALER > ALSR metadata synchronization described in this section.

Figure 3-4 Flow of Metadata Published from ALER to ALSR

Flow of Metadata Published from ALER to ALSR

Synchronizing the Metadata from ALSR to ALER

This section describes how metadata is synchronized when receiving assets into the repository from ALSR.

Performance Metrics

ALRR Exchange Utility updates the endpoint asset with the performance metrics deposited by ALSM. The UDDIMappings.xml file contains the mapping between the performance metrics t-models and the keys to ALER custom fields where these metrics are populated. You can also customize the UDDI Mapping file so that the metrics can appear on any tab mapped to any field in the tabs of any custom asset type.

Figure 3-5 illustrates how the performance metrics deposited by ALSM shows up in ALER after the endpoint is synchronized by the Exchange Utility.

Figure 3-5 ALSR Operational Information

ALSR Operational Information

Figure 3-6 illustrates how the performance metrics deposited by ALSM appear in ALSR.

Figure 3-6 ALSR Performance Metrics for an ALSM WSDL Service

ALSR Performance Metrics for an ALSM WSDL Service

Business Entities

Check if the Service asset being received exists and is related to a Business Entity asset, as follows:

If the Service asset is newly created, get the default Business Entity asset type for UDDI Business from the ALER configuration:

Check if an asset exists with that name and type, as follows:

Endpoint

Check if the Service asset being received has one or more Endpoint assets related, as follows:

Categorizations

Check if Categorizations are present in the Category Bag, as follows:

WS-Policies

Check if the Service asset being received has one or more WS-Policy assets related, as follows:

Sample Flow of Metadata from ALSR to ALER

Figure 3-7 illustrates the ALSR > ALER metadata synchronization described in this section.

Figure 3-7 Flow of Metadata Received from ALSR

Flow of Metadata Received from ALSR

Web Service Endpoint Management

Use the ALER Asset Editor to add the new Endpoint:Web Service asset type so that the endpoint information can be published to ALSR.

  1. From the File menu, select New to create a new Endpoint:Web Service asset type.
  2. Add a description if necessary.
  3. Select the Taxonomy tab to relate the asset to the Service asset by:
    1. Scroll down to the Relationships section and click Add.
    2. On the Add Relationship dialog box, select the Provides Access to Relationship Type.
    3. Click OK.
    4. Click Approve to save the change.
  4. Select the Overview tab, and do the following:
    1. In the Endpoint URI field, click Add to enter the URI for the asset. Then click OK to add the Endpoint URI.
    2. In the File Information field, click Add to enter the effective WSDL that contains the port. Then click OK to add the WSDL.
      3. Note: You can omit this step if the WSDL attached to the Service contains the port information.
    3. Click Approve to save the change.
      4. Figure 3-8 Configure EndPoint:Web Service Asset Type


      Configure EndPoint:Web Service Asset Type

  5. Optionally, you can set the Asset Lifecycle to this asset if the Endpoint needs to be filtered by the Asset Lifecycle.

For more information on using the Asset Editor to manage assets, see the ALER Registrar Guide.

WS-Policy Management

Use the ALER Asset Editor to add a new WS-Policy so that the endpoint information can be published to ALSR.

  1. From the File menu, select New to create a new Artifact:WS-Policy asset type.
  2. Add a description if necessary.
  3. Select the Taxonomy tab to relate the asset to the Service asset or Endpoint:
    1. Scroll down to the Relationships section and click Add.
    2. On the Add Relationship dialog box, select the Attaches to Relationship Type.
    3. Click OK.
    4. Click Approve to save the change.
  4. Set the WS-Policy document that contains the Policy statements.
  5. Select the Overview tab, and do the following:
    1. In the File Information field, click Add to enter the location of the WS-Policy document that contains the Policy statements. Then click OK to add the WS-Policy location.
    2. Click Approve to save the change.
      3. Figure 3-9 Configure Artifact:WS-Policy Asset Type


      Configure Artifact:WS-Policy Asset Type

For more information on using the Asset Editor to manage assets, see the ALER Registrar Guide.

 

Searching for ALSR Exchanged Metadata in ALER

The ALRR Exchange Utility tags each published and received Service with information that can be used for querying, as follows:

To query published/received Service information, use the ALER More Search Options feature, as follows:

  1. In the ALER Web console, open the Assets page.
  2. In the Search box in the sidebar, click the More Search Options link.

    3. The More Search Options dialog box opens.

  3. Select the Filter by Additional Criteria check box to reveal the additional filtering criteria options.
  4. On the Select a Field drop-down, select the internal.alrr.exchange.store option.
  5. In the field next to the Add button, enter the date the metadata was exchanged.
    6. Figure 3-10



  6. Click the Search button at the bottom of the dialog box.

For more information on using the ALER search options, see the ALER User Guide.

 

Checking the ALRR Exchange Utility Log File

The ALRR Exchange Utility uses log4j for logging the detailed tasks performed. The log file is stored in the <ExhangeUtility Tool Home> directory. The logging options can be changed by updating the file log4fl.properties file located in the <ExhangeUtility Tool Home> directory.

 

Known Issues

This section describes the known issues when using the ALRR Exchange Utility.

Resynchronizing ALSR Services

When synchronizing a Service to ALSR that was previously synchronized, there is known issue where ALSR does not show the updated values if an ALSR browser instance is already open. Therefore, all the ALSR browser instances need to be closed to see the updated values.

Import of ALSB WSDLs

ALER WSDL import is not currently capable of supporting the import of an XSD into a WSDL document using the WSDL import mechanism. This is considered improper use of the WSDL import element by the industry. An example of the improper usage of the WSDL import element to import an XSD, along with an example of the correct way to import XSD into a WSDL is included. Note that ALER WSDL import does support the importing of WSDL into a WSDL document using the WSDL import element.

ALSB (AquaLogic Service Bus) currently generates WSDLs that incorrectly import XSD using the WSDL import element. This causes a problem in the AL suite due to the fact that these ALSB WSDLs can be parsed and submitted to ALER properly by the AL common Eclipse tooling; however, the ALRR Exchange Utility is not capable of parsing the WSDLs when migrating them back to ALSR (AquaLogic Service Registry).

Workaround or Solution:

Example of improper usage of the WSDL import element to import XSD:

<?xml version='1.0' encoding='UTF-8'?>

<definitions name='OrderProcessing'
targetNamespace='http://avitek.com/orderprocessing/definitions'
xmlns:tns='http://avitek.com/orderprocessing/definitions'
xmlns:po='urn:iwaysoftware:ibse:jul2003:createPO'
xmlns:por='urn:iwaysoftware:ibse:jul2003:createPO:response'
xmlns:pos='urn:iwaysoftware:ibse:jul2003:POStatus'
xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/'
xmlns='http://schemas.xmlsoap.org/wsdl/'>

<import namespace='urn:iwaysoftware:ibse:jul2003:createPO' location='bapipo.xsd'/>
<import namespace='urn:iwaysoftware:ibse:jul2003:createPO:response' location='bapipor.xsd'/>
<import namespace='urn:iwaysoftware:ibse:jul2003:POStatus' location='POStatus.xsd'/> .

Example of proper usage of the XSD import element to import XSD:

<?xml version='1.0' ?>
<wsdl:definitions targetNamespace='urn:listing2'
xmlns:tns='urn:listing2'
xmlns:listing3='urn:listing3'
xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/'>
<wsdl:types>
<xsd:schema targetNamespace='urn:listing2'
xmlns:listing3='urn:listing3'
xmlns:xsd='http://www.w3.org/2001/XMLSchema'>
<xsd:import namespace='urn:listing3'
schemaLocation='listing3.xsd' />


  Back to Top       Previous  Next