Portlet Factory, Version 6.1.2
Domino Keyword Lookup builder inputs
This topic describes the inputs for the Domino Keyword Lookup builder.
- General Inputs
- Additional Data Definition
- Inputs specific to a profile document data provider
- Inputs specific to a formula data provider
- Inputs for creating a Domino view
General Inputs
Table 1. General Inputs Input name Description Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list. Data Provider Select the Domino entity used to provide value and label data. You can choose:
- View
- To extract data from an existing Domino view or a view you will create. If you select this option, more inputs are available; see Inputs for creating a Domino view.
- Domino Profile Document
- To extract data from a Domino document. If you select this option, more inputs are available; see Inputs specific to a profile document data provider.
- Formula
- To extract data from a Domino formula. If you select this option, more inputs are available; see Inputs specific to a formula data provider.
Use Existing View Enable to use an existing Domino Data Access builder or Domino View & Form builder to access the Domino system. The Domino entity selected in the Data Provider input accesses Domino through the WebApp artifact generated by this builder. Disable to create a Domino view specifically for use by this builder. More inputs become available; see Inputs for creating a Domino view.
Domino Connection Helper Select a Domino Data Access builder to use for communication with the Domino system. Value Tag Select the Domino column that represents value entities. Label Tag Select the Domino column that represents label entities that correspond with the value entities that you selected in the Value Tag input.
Additional Data Definition
Table 2. Additional Data Definition inputs Input name Description Get Data From Identify the source of data.
- Builder Input
- Gets data from Additional Pairs table.
- XML Data
- Gets 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.
Add a blank selection Provide a blank selection for optional fields in a form where the user does not need to provide a specific value provided by the data set. 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 might want to do this to allow development to proceed while the database is under construction.)
- Label
- A label to be included in the result set.
- Value
- A value to be included in the result set.
- Collision Resolution
- Lets you handle the situation that can occur if a value and label pair you specify is identical to one already contained in the data. Select one of the following choices:
- Use Original Value
- Uses the pair contained in the original data.
- Use this Value
- Uses the pair you specified in the table.
Table Position Specifies where additional pairs are placed in the XML output of this builder. The choices are:
- In Front
- The default. Additional data pairs are placed to precede existing pairs in the XML stream.
- In Back
- Additional data pairs placed to follow 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>
Inputs specific to a profile document data provider
These inputs are available if you select Domino Profile Document for the Data Provider input described in General Inputs.
Table 3. Profile document data provider inputs Input name Description Domino Profile Document Enter the name of the Domino profile document that is to be used as the source of the data. Field Name Enter the name of the field in the document specified above that contains the value and label data. Key (Optional) Enter the unique key, if any, used to identify the profile document.
Inputs specific to a formula data provider
These inputs are available if you select Formula for the Data Provider input described in General Inputs.
Table 4. Formula data provider inputs Input name Description Formula Enter the syntax of the Domino formula used to calculate data Separator Enter the string used to separate values and labels in the formula result strings. For example: | ( a pipe character)
Inputs for creating a Domino view
These inputs are available if you select View for the Data Provider input described in General Inputs.
Most of the inputs in this table duplicate those available in either the Domino Data Access builder or the Domino View & Form builder.
Table 5. Domino view creation inputs Input name Description Host Server Enter the host name (and port number if not port 80) of the Domino server. For example: domino_server.acme.com:8080 User name for generation Provide a Domino® server user name. This name is used for all requests to the Domino server.
The generation credentials are used to access the Domino server from IBM® WebSphere Portlet Factory Designer. They are used for regenerating the model on the server, and such requests can be made at both design time and at regeneration time.
Password for generation Provide a Domino server password associated with the user name above. This password is used for all requests to the Domino server. The generation credentials are used to access the Domino server from IBM WebSphere Portlet Factory Designer. They are used for regenerating the model on the server, and such requests can be made at both design time and at regeneration time.
Runtime Credentials Select Domino security credentials for use during execution. These credentials are used when the portlet or widget containing the Domino view is run. You can select:
- Use regen credentials specified above
- At runtime, use the same credentials specified for regeneration.
- Specify credentials
- Specify a user name and password for use at runtime.
Note: When this selection is enabled, two additional builder inputs are displayed.
- Use LTPA Token
- Use WebSphere Domino LTPA-based SSO (servers must be configured appropriately). A link is added to the page for editing user-specific credentials.
Runtime user name This input is available if Specify credentials is selected in the Runtime Credentials input. Provide a Domino user name.
The name entered here is used for all requests to the Domino server made at runtime.
Runtime password This input is available if Specify credentials is selected in the Runtime Credentials input. Provide a Domino password associated with the user name above.
The password entered here is used for all requests to the Domino server made at runtime.
Get Databases and Views Click this button to access the Domino server and return an alphabetically sorted list of available databases on the server. Database name Open this list and select the Domino database containing the views and information to display in your portlet or widget. This list contains the relative file names of the available databases. For example: catalog.nsf or help\readme.nsf The views associated with the selected database are displayed in the View Name input.
View name Open this list and select the Domino view to display in your portlet or widget. This input is available if the Enable View Support input is checked. Note: Hidden views are not included in the list of available views. To access a hidden view, enter the name of the view.
Rows to include Specify which rows in the view are included on the page. You can select:
- Document rows only
- All rows
- Category rows only
Parent topic: Domino Keyword Lookup builder
Library | Support |