Lookup settings tab
The following table describes the settings available on the Lookup settings tab. The tab allows you to create, customize, and modify lookup operations for your workflows. The order inside the lookup list is the same as the execution order in runtime (from top to bottom).
Setting |
Description |
---|---|
New |
Click this button to add a new query to the Extender. Clicking the button opens the Lookup editor. |
Edit |
Click this button to edit the properties of the selected query. The Lookup editor is displayed, as with the New option, above. |
Copy |
Click this button to create a copy of the selected query. Using this option is advised if you are planning to use a number of queries, which differ only in minor details. This function also works if you highlight a lookup and then press [CTRL] while clicking on Copy. The copied original lookup is inserted to the copy as evaluation condition with Is not blank setting. |
Remove |
Click this button to remove a selected query. |
Move up |
Moves the selected Lookup result key up in the list. |
Move down |
Moves the selected Lookup result key down in the list. |
The Lookup Editor window has four main sections, allowing you to create and modify queries.
- Naming section
- Lookup result key: Enter the name of the data publishing key you want to use for finding the results. This key will be the output of the lookup operation. If left empty and the rest of the dialog is filled, this field is populated automatically, based on the values of different fields; it can be edited any time if the dialog populates it automatically.
- Display label: Enter a label of the text field that is displayed on the MFP UI for the specific field. If left blank, the field is populated automatically based on the value of the Lookup result key field.
- Lookup type section
- Lookup type: Allows you to select any of three lookup query types to be used; each type features different settings (see step 3 below).
- Lookup evaluation condition:
- When the always evaluated option is selected, the lookup specified is always performed.
- If the Evaluated if condition is fulfilled option is selected, the specified condition is evaluated – a selected data publishing key is checked if it is not blank, equal to a specified value, or matching a regular expression; the lookup operation is performed only when the result is true.
- Lookup section
- Database lookup: Select it to use the simple, user friendly editor to set up the lookup criteria.
- Custom SQL query: You can use complex SQL queries (specified in a text
editor window):
- Custom SQL query – With skeleton You can get a SQL “skeleton” if you first select Database lookup and provide some relevant data for the empty fields and then switch Lookup type to Custom SQL query. Once you switch over, the custom SQL query field is populated with the data you entered previously for the Database lookup. This makes it easier to edit any custom SQL query.
- Expression: Allows you to specify C# expressions, ensuring full
flexibility in comparison and working logic.
- Expression templates: Use the menu to select specific C# expression templates. When selected, you can click the pencil icon to copy the expression into the editor window. Clicking the msdn button opens a browser and displays the expression-specific MSDN article (if you have an active Internet connection).
- Behavior section
-
Lookup behavior: Use this menu to set the number of results the query should
consider. Select
One value only if you are looking for a specific database entry; otherwise,
select
Multiple values or not required.
- When One value only is specified, and the result of the lookup was a single value, the UI interaction is initiated (at the MFP). If the lookup was not successful (value not found), the user has to enter a value into a text box at the MFP. If there are multiple values returned by the lookup, the user is prompted to select from the available values.
- When the Multiple values or not required option is selected and the result of the lookup is a single value or no matching item is found, that single value or an empty value is used. If there are multiple values in the result, all are included in the result data publishing key, separated by a separator character. The separator character can be set on the Settings tab of the Configure Document Service (Lookup Extender).
- Always evaluated: Controls how empty values affect lookup evaluation; checked: lookup is always evaluated even if there are empty variables; unchecked (default): lookup is evaluated only when all variables are set.
- Visible: Controls query visibility.
- User modify: Controls whether users can modify lookup values of the query.
- Preserve value: If checked, selected lookup values are populated for the next query; if unchecked, new values must be provided for the next query.
Test: Click this button to test your query.
In case of barcode input, multiple value contains all elements of result set separated by a given separator. In case of user-entered value, the user must select from a result set (same as One value only behavior ).
If a user needs a list with all results (for example, email addresses) s/he needs to use barcode for input. The user can also create a second Lookup Extender profile with express mode, referring the first Lookup Extender profile's user-entered lookup.
Lookup Test Dialog
Before you can finalize your lookup, you have to test your settings by clicking the Test button. The Lookup test dialog appears.
Enter a string in the Value field and click Execute. The result is displayed and the OK button becomes active.
After a test is executed, the bottom information line displays the query execution details.
After test execution, the Store test values check box appears: select this check box to automatically fill the form on subsequent tests.
Click the OK button to close the Lookup test dialog. Now the OK button on the Lookup editor window is also active, click it to have the new lookup appear in the Lookup result keys list.