IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

RegistryLookup node

Use the RegistryLookup node to retrieve any type of entity held in the WebSphere® Service Registry and Repository (WSRR). The entities that match the specified search criteria are stored in the local environment. The input message is not modified.

This topic contains the following sections:

Purpose
Local environment overrides
Terminals and properties

Purpose

The RegistryLookup node retrieves any type of entity held in WSRR.

Data is retrieved according to search criteria defined by node properties, possibly supplemented or overridden by local environment definitions at run time; see Local environment overrides for more details.

The retrieved data is placed in the local environment tree, making it available to subsequent nodes. The input message received by the node is propagated to the output terminal unchanged.

RegistryLookup node processing

The RegistryLookup node is contained in the Web services drawer of the message flow node palette, and is represented in the IBM® Integration Toolkit by the following icon:

When the RegistryLookup node receives a message the following steps occur in sequence.

The RegistryLookup node retrieves the data from WSRR using the specified search criteria.
If one or more matches are found, the RegistryLookup node adds a representation of those entities to the local environment tree.
- If Match Policy is set to One, a single entity is returned by WSRR and added to the local environment tree. If the registry contains more than one entity that matches the specified search criteria it is not possible to determine which one is returned by WSRR. A different one can be returned each time the query is issued.
- If Match Policy is set to All, all matching entities are added to the local environment tree. The order of the entities is determined by WSRR and might vary between queries.
The input message is propagated unchanged to the Output terminal. The local environment tree is propagated to the Out terminal, where it is available for further processing by transformation nodes. The exact representation of an entity in the local environment tree depends on the Depth Policy property. See RegistryLookup node output for details of the local environment output tree.

Add a compute node to your message flow to interpret and act on the returned data. For instance, if the local environment tree contains multiple endpoint addresses for use by subsequent request nodes the Compute node should select the required address and set up any transport headers or local environment settings required by those request nodes.
If no matches are found, the RegistryLookup node propagates the input message to the NoMatch terminal.
If a processing error occurs, for example if the WSRR server configured on the DefaultWSRR configurable service object cannot be connected to, or the connection times out, the RegistryLookup node propagates the input message unchanged to the Failure terminal. The ExceptionList is populated with details of the error.

Local environment overrides

You can override the RegistryLookup node properties by using local environment settings. See Dynamically defining the search criteria.

Terminals and properties

When you have put an instance of the RegistryLookup node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view.

The RegistryLookup node terminals are described in the following table.

Terminal	Description
In	The input terminal that accepts a message for processing by the node.
Failure	The output terminal to which the message is routed if an error occurs within the node's processing.
Out	The output terminal to which the unmodified input message and updated local environment containing the matched registry data is sent.
NoMatch	The terminal to which the input message is sent if no matching entity is found based on the specified search criteria.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).

The RegistryLookup node Description properties are described in the following table.

Property	M	C	Default	Description
Node name	No	No	The node type (RegistryLookup)	The name of the node
Short description	No	No	None	A brief description of the node
Long description	No	No	None	Text that describes the purpose of the node in the message flow

The RegistryLookup node Basic properties are described in the following table.

Property	M	C	Default	Description	mqsiapplybaroverride command property
Name	No	Yes	None	Enter the string values for one or more of Name, Namespace, and Version for the entities or artifacts that you want to retrieve from WSRR. At least one of the properties is required. If you leave all three property values blank, you will get an error message when you try to save.	name
Namespace	No	Yes	None		namespace
Version	No	Yes	None		serviceVersion
User Properties	No	No	None	Allows a query to specify user-defined properties. Add User Properties by clicking Add. User Properties refer to the Additional Properties that are used to catalog the entities in WSRR. Enter values for Property Name, which is the case sensitive match of the additional property in WSRR, Property Type, and Property Value. The Property Type can be: a String (the default), in which case the Property Value is a character string to be matched with the additional property value present in WSRR XPATH, or ESQL, in which case the Property Value is a XPath or ESQL expression which locates a field in the message tree that contains the character string to be matched with the property value present in WSRR. When more then one user property is defined on the node, each property is treated as an AND, for for example: If there are 2 User Properties `property1` and `property2`, the query generated would be: `property1 AND property2`.
Classification	No	No	None	The Web Ontology Language (OWL) classification system property. Each classifier is a class in OWL, and has a Uniform Resource Identifier (URI). Using classifications in the registry can help to make objects easier to find and can also add meaning to custom objects that are unique to a particular system. Add a Classification by clicking Add and typing the complete fully qualified OWL URI for the OWL classification. For example, it can define a particular service endpoint's lifecycle state.
Match Policy	Yes	No	One	WSRR can contain multiple entities that match the search criteria specified by the properties above. If Match Policy is set to One, at most one matching entity is returned. If Match Policy is set to All, all matching entities are returned. See RegistryLookup node output

The RegistryLookup node Advanced properties are described in the following table.

Property	M	C	Default	Description
Depth Policy	Yes	No	Return matched only (Depth = 0)	Specify the depth of the WSRR query and the contents of the entity data to be returned. The returned entities are stored in the ServiceRegistry message tree in the LocalEnvironment. Select Return matched only (Depth = 0) to use a WSRR query depth of 0, and to return only the matched entities. Select Return matched showing immediate relationships (For compatibility only) to use a WSRR query depth of 1, and to return only the matched entities. Returned entities include elements listing the bsrURIs of related child entities. This option provides compatibility with versions of IBM Integration Bus before Version 6.1.0.4, using the output format that was used in those prior versions. This option is deprecated, use one of the other options. Select Return matched plus immediate related entities (Depth = 1) to use a WSRR query depth of 1, and to return the matched entities and the immediate related child entities. Select Return matched plus all related entities (Depth = -1) to use a WSRR query depth of -1, and to return the matched entities and all the related child entities.

Property

Default

Description

Depth Policy

Yes

Return matched only (Depth = 0)

Specify the depth of the WSRR query and the contents of the entity data to be returned. The returned entities are stored in the ServiceRegistry message tree in the LocalEnvironment.

Select Return matched only (Depth = 0) to use a WSRR query depth of 0, and to return only the matched entities.

Select Return matched showing immediate relationships (For compatibility only) to use a WSRR query depth of 1, and to return only the matched entities. Returned entities include elements listing the bsrURIs of related child entities. This option provides compatibility with versions of IBM Integration Bus before Version 6.1.0.4, using the output format that was used in those prior versions. This option is deprecated, use one of the other options.

Select Return matched plus immediate related entities (Depth = 1) to use a WSRR query depth of 1, and to return the matched entities and the immediate related child entities.

Select Return matched plus all related entities (Depth = -1) to use a WSRR query depth of -1, and to return the matched entities and all the related child entities.

The Monitoring properties of the node are described in the following table.

Property	M	C	Default	Description
Events	No	No	None	Events that you have defined for the node are displayed on this tab. By default, no monitoring events are defined on any node in a message flow. Use Add, Edit, and Delete to create, change or delete monitoring events for the node; see Configuring monitoring event sources using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box.

ac55900_.htm |

Last updated Friday, 21 July 2017