Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

Data Lookup

  • Last UpdatedOct 17, 2024
  • 8 minute read

Use Data Lookup control to search for data from a data source in your form.

Properties

The properties for the control are grouped under the following tabs:

Basic

Property

Description

Name

Name that identifies the control. This value is also used for the label of the control.

XML Node

XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.

  • Prefix with @ to use the value of the control as an attribute with the immediate parent node. For example, @FirstName.

  • Use / for a parent-child node configuration to uniquely identify a control in a form with multiple containers. For example, Employee/FirstName.

    The default value is the value for the Name property without the spaces.

Note:
- If you use / to denote a parent which is not a container and the parent is at the same level as that of the child, then the XML node for the control is not generated.
- If you edit this value later, then it might affect the mapping between forms, lists, and workflows.

Description

Description for the control.

Tooltip

Message that appears when the pointer hovers over the control.

Lookup Source

Name of the item in the Lookup List.

To add a name of the item in the Lookup List for the control

  1. Click the Lookup Source button. The Lookup Source Configuration page appears.

  2. In the Data Source Type list, click a data source type.

  3. In the Data Source box, click a data source.

  4. In the Parameters list, click and select a control on the form, if applicable.

  5. Click Save & Continue. The selected name is set for the control and the Lookup Source Configuration page is closed.

    Note:
    - For Parameters, the Title of the control on the form is displayed, if set for the control. Otherwise, the XML Node of the control on the form is displayed.
    - For information about Lookup List, see List Lookups.

Appearance

Property

Description

Enable

Enable or disable the control.

  • Select Yes to enable the control.

  • Select No to disable the control.

    The default value is Yes.

Visible

Show or hide the control.

  • Select Yes to show the control.

  • Select No to hide the control.

    The default value is Yes.

Read-Only

Allow or deny a user to enter a value for the control.

  • Select Yes to deny a user to enter a value for the control.

  • Select No to allow a user to enter a value for the control.

    The default value is No.

Label Position

Position of the label for the control.

  • Select Default to allow the system to align the label. The system aligns the label to the left of the control or as specified by the container control.

  • Select Left to align the label to the left of the control.

  • Select Top to align the label to the top of the control.

  • Select Right to align the label to the right of the control.

  • Select Bottom to align the label to the bottom of the control.

  • Select Suppress to hide the label for the control.

    The default value is Suppress.

Note:
- If the value is Default and the control is placed on a container control, then the value of the Label Position property of the container control determines the position of the label for the control.
- For example, if the value is Default and the control is placed on a Base Form with Label Position property set to Top, then the label is aligned to the top of the control.

Label-Control Area

Area occupied by the label and the control in percentage.

  • Select Default to allow the system to set the label and the control areas.

  • Select Custom to specify the label area. The control area is automatically set based on the label area.

    The default value is Default.

Note:
- If the value is Default and the control is placed on a container control, then the value of the Label-Control Area property of the container control determines the area of the label for the control.
- This is applicable only when the Label Position is set to Left or Right.

Watermark

Hint text that appears when no value is entered for the control.

Width

Width in pixels for the control.

The default value is 0.

Note: If the value is 0, then the width of the control is set as per the default values.

Height

Height in pixels for the control.

The default value is 0.

Note: If the value is 0, then the height of the control is set as per the default values.

Retain Space

Reserve or remove space when the control is hidden.

  • Select Yes to keep space when the control is hidden.

  • Select No to remove space when the control is hidden.

    The default value is No.

Show as Drop-Down

Enable or disable the control to show as Drop-Down.

  • Select Yes to enable the control to show as Drop-Down.

  • Select No to disable the control to show as Drop-Down.

    The default value is No.

Note: If you select Yes, then a user will not be able to type in the control at run-time.

Drop-Down Height

Drop-down height in pixels for the control.

The default value is 300.

Note: 
- The minimum value for drop-down height is 300. The value below 300 is not considered at runtime.
- If the value is 0, then the drop-down height of the control is set as per the default values.

Adapt UI

Change the user interface of the control based on the display width.

  • Select Yes to allow the system to change the user interface of the control based on the display width. The Web View is rendered for the control when the screen width is greater than or equal to 800 pixels. Otherwise, the Mobile View is rendered for the control.

  • Select No to deny the system to change the user interface of the control based on the display width. In this case, the Web View is rendered for the control.

    The default value is Yes.

Note: The responsiveness of the container depends on the value set for the Desktop View Only property at the Form level.

Validation

Property

Description

Mandatory

Enforce or bypass entering a value for the control.

  • Select Yes to enforce entering a value for the control.

  • Select No to bypass entering a value for the control.

    The default value is No.

Note:If you configure a Data Lookup control as mandatory, then when you select an item from the drop-down, the mandatory message appears. The message disappears after you have selected an item.

Autocomplete Length

Number of characters to start autocomplete.

The default value is 3.

Note: If the value is 0, then the autocomplete length for the control is set as per the default values.

Show Confirmation Message

Show or hide the confirmation message for clearing the value of the control in devices.

  • Select Yes to show the confirmation message for the control.

  • Select No to hide the confirmation message for the control.

    The default value is Yes.

Confirmation Message Text

Confirmation message for clearing the value of the control in devices.

The default value is Are you sure you want to clear the value?

Note: This property is applicable only when the Show Confirmation Message property is set to Yes.

Advanced

Property

Description

On Data Change

Run a script when value of the control changes.

For more information, see scripting guidelines for On Data Change property.

ID

Reference identification code for the control. This value is automatically generated and cannot be changed.

Default Number of Records

Number of records added at run-time for the control.

The default value is 50.

Note: If the value is 0, then the default number  of records for the control is set as per the default values.

Retain Selected Value

Keep or lose the selected value for the control when the current parameter values from the source get changed.

  • Select Yes to keep the selected value for the control.

  • Select No to lose the selected value for the control.

    The default value is No.

Resolve Value in Edit Mode

When the Form is in the edit mode like opening a Form via WorkItem in Inbox, then update or keep the Lookup display value and the extended information (if the property Extended Information is Yes) based on the selection for the control.

  • Select Yes to update the Lookup Display Value and the Extended Information.

  • Select No to keep the existing Lookup Display Value and the Extended Information.

    The default value is No for performance improvement.

Persist Display Value

Keep or lose the display value for the control on submission of the form.

  • Select Yes to keep the display value for the control.

  • Select No to lose the display value for the control.

    The default value is Yes.

Extended Information

Allow or deny a user to access the extended information (that is columns other than the display and value columns of the result set) based on the selection for the control.

  • Select Yes to allow a user to access the extended information based on the selection for the control.

  • Select No to deny a user to access the extended information based on the selection for the control.

    The default value is No.

Include in Summary

Allow or deny a user to view the value in the Summary of a Base Form.

  • Select Yes to allow a user to view the value in the Summary of a Base Form.

  • Select No to deny a user to view the value in the Summary of a Base Form.

    The default value is No.

Note:
- This property is applicable only when the control is used on a Base Form with Repeating property set to True, and the form is viewed on a small form factor mobile device.
- For information about Summary of a Base Form, see Base Form.

Scripts

For information about using scripts, see scripting guidelines for Data Lookup control.

Note:
- The format and culture for date and time value displayed in the control is as per the current server and not as stored in the database.
- The Autocomplete feature uses the Contains filter to complete user input and is applicable to the Display column as defined in the Lookup Source.
- If the data type of the Autocomplete search column is numeric, date, time, etc., it is first converted to a string for comparison before applying the filter.
- When Persist Display Value is set to No, date and date time values are not supported as value fields of the lookup.
- The default data lookup time out is 50 seconds. You can change this value in the web.config file.
<appSettings>
<add key="lookupTimeout" value="50" />
</appSettings>
- When Data Lookup is the first control on a form and the form is viewed on a mobile device, then the lookup with populated data (ready for entry or selection) is shown instead of the complete form with other controls.
- Ensure that you map a Number control to an Integer or Numeric type of Data Grid parameter.

Keyboard-based Navigation

You can use the keyboard to perform the following actions:

  • To open the drop-down list,

    • use the Alt + Down Arrow keys (in case, Yes option is selected for the Show as Drop-Down property)

    • type the search string (in case, No option is selected for the Show as Drop-Down property)

  • To navigate and highlight the listed option, use the Up and Down Arrow keys.

  • To load more options in the list, use the Alt + Page Down keys.

  • To select highlighted option in the list, use the Enter key.

  • To close the list, use the Esc key.

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in