Lookup Table builder inputs for the XML data type

Portlet Factory, Version 6.1.2

Lookup Table builder inputs for the XML data type

If you select XML Data as the Data Type input, the Lookup Table builder takes the inputs described in this topic.

Table 1. Lookup Table builder inputs for the XML data type
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Note: The name must begin with a letter or an underscore and contain only letters, digits, and underscores. This restriction allows the builder to use the Name input to build additional WebApp artifacts that implement the core of this builder runtime functionality.
Data Type Select the type of data element to query. You can select:

XML Data

Choose this to perform an Xpath search of a WebApp variable containing an XML structure that represents name and value pairs. (This XML structure must contain two sub-elements named Valueand Label.)

XML Data Use an indirect reference to point to a method call or a variable that returns the ResultSet to be used for the lookup table.
The ResultSet must include elements named Value and Label that have child elements representing label and value pairs.
Variable Type This input allows you to use data in a resource bundle.
You can choose:

Value Tag and Label Tag

To use standard model data in this form.

Resource Bundle Style

To use data in the form that the Localized Resource builder produces.

Value Tag Enter the name (or, in the case of an XML variable, the node name) of the column to use to represent the value element.
Note: If your query returns more than two columns, use this input to explicitly name the value column.
Label Tag Enter the name (or, in the case of an XML variable, the node name) of the column to use to represent the label element.
Note: If your query returns more than two columns, use this input to explicitly name the label column.
Refresh Interval (secs) Enter the time in seconds that Lookup Table builder data is to be retained in the cache.
Entering a value here enables caching and improves performance. This is generally a good idea if a large enough value is used to prevent unnecessary cache refreshes. A value of 300 seconds is usually appropriate in most applications.
Additional Data Definition

Get Data From Identifies the source of data. You can choose:

Builder Input

To get data from Additional Pairs table.

XML Data

To get data from an XML type variable. This choice is useful if there is a default set of labels and values that should appear in a number of select lists.

Additional XML Data This input is available when the Get Data From input is XML Data. Specify an indirect reference to the location where the XML data is located.
Additional Pairs Specify any additional label and value pairs to be included in the lookup table results. (You typically do this to allow development to proceed while the database is under construction.)

Label

A label to be included in the ResultSet.

Value

A value to be included in the ResultSet

Collision Resolution

This choice allows you to handle the situation that can occur if a value and label pair that you specify is identical to one already contained in the data. When this occurs, select Use Original Value to use the pair contained in the original data. Select Use this Value to use the pair that you specified in the table.

Table Position Specifies the location of additional pairs that are in the XML output of this builder. The choices are:

In Front

The default. Additional data pairs placed in front of existing pairs in the XML stream.

In Back

Additional data pairs placed in back of existing pairs in the XML stream.

Parent Tag Name of an XML element used to contain additional pairs in the table. Default element name is <UserAddition>.
Filtering

Label/Value Filter Mode Specify how XML nodes are to be filtered. You typically do this if the rows in your XML are not identical in terms of label and value content.
You can choose:

Use elements with both label and value elements

To use elements with sub-elements that match the chosen Label and Value inputs.

None: use all elements

Use all the data.

Parent topic: Lookup Table builder inputs

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list. Note: The name must begin with a letter or an underscore and contain only letters, digits, and underscores. This restriction allows the builder to use the Name input to build additional WebApp artifacts that implement the core of this builder runtime functionality.
Data Type	Select the type of data element to query. You can select: XML Data Choose this to perform an Xpath search of a WebApp variable containing an XML structure that represents name and value pairs. (This XML structure must contain two sub-elements named Valueand Label.)
XML Data	Use an indirect reference to point to a method call or a variable that returns the ResultSet to be used for the lookup table. The ResultSet must include elements named Value and Label that have child elements representing label and value pairs.
Variable Type	This input allows you to use data in a resource bundle. You can choose: Value Tag and Label Tag To use standard model data in this form. Resource Bundle Style To use data in the form that the Localized Resource builder produces.
Value Tag	Enter the name (or, in the case of an XML variable, the node name) of the column to use to represent the value element. Note: If your query returns more than two columns, use this input to explicitly name the value column.
Label Tag	Enter the name (or, in the case of an XML variable, the node name) of the column to use to represent the label element. Note: If your query returns more than two columns, use this input to explicitly name the label column.
Refresh Interval (secs)	Enter the time in seconds that Lookup Table builder data is to be retained in the cache. Entering a value here enables caching and improves performance. This is generally a good idea if a large enough value is used to prevent unnecessary cache refreshes. A value of 300 seconds is usually appropriate in most applications.
Additional Data Definition
Get Data From	Identifies the source of data. You can choose: Builder Input To get data from Additional Pairs table. XML Data To get data from an XML type variable. This choice is useful if there is a default set of labels and values that should appear in a number of select lists.
Additional XML Data	This input is available when the Get Data From input is XML Data. Specify an indirect reference to the location where the XML data is located.
Additional Pairs	Specify any additional label and value pairs to be included in the lookup table results. (You typically do this to allow development to proceed while the database is under construction.) Label A label to be included in the ResultSet. Value A value to be included in the ResultSet Collision Resolution This choice allows you to handle the situation that can occur if a value and label pair that you specify is identical to one already contained in the data. When this occurs, select Use Original Value to use the pair contained in the original data. Select Use this Value to use the pair that you specified in the table.
Table Position	Specifies the location of additional pairs that are in the XML output of this builder. The choices are: In Front The default. Additional data pairs placed in front of existing pairs in the XML stream. In Back Additional data pairs placed in back of existing pairs in the XML stream.
Parent Tag	Name of an XML element used to contain additional pairs in the table. Default element name is <UserAddition>.
Filtering
Label/Value Filter Mode	Specify how XML nodes are to be filtered. You typically do this if the rows in your XML are not identical in terms of label and value content. You can choose: Use elements with both label and value elements To use elements with sub-elements that match the chosen Label and Value inputs. None: use all elements Use all the data.