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

AVEVA™ Work Tasks

Card

  • Last UpdatedJun 28, 2024
  • 9 minute read

Use Card control to display data in a card from a Lookup data source in your form.

Properties

Control properties are grouped into three tabs: Basic, Appearance, and Advanced. The Scripts tab is used for properties configuration through scripting.

Basic

Property

Description

Name

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

XML Node

(Required) 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 forward slash ( / ) 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 may affect the mapping between forms, lists, and workflows.

Description

Description for the control.

Lookup Source

Name of the item from the lookup list.

To add a name of the item for the control from the lookup list:

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

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

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

  4. In the Parameters section, select the control properties from the list, which you want to map to each of the given parameters, if applicable.

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

Enable Dynamic Label

Enable use of the value (2-5) label properties for data mapping based on the selected data source lookup.

  • Select Yes to enable mapping to a column name in the data source using the value label properties.

  • Select No to disable column name mapping and use the value label properties for static button name or text for localization.

The default value is No.

HeaderValue Left

A text field associated to a column name in the selected data source lookup.

You need to check for the column name in the data source and manually enter it in the control property page to assign it to this property.

Example column name:

  • entity_name

  • wo_id

The corresponding value for the assigned column name appears on the top left of the control's header bar.

Note: If this property is blank, nothing is shown, but its space is retained in the control.

You have the option to configure the number of displayed characters through HeaderValue Left Display Limit property. The default column value display limit is 12.

Note: If the column value is more than 12 characters, you can adjust the font size to fit in the control through CSS.

HeaderValue Right

A text field associated to a column name in the selected data source lookup.

You need to check for the column name in the data source and manually enter it in the control property page to assign it to this property.

Example column name:

  • state_desc_h (Job state)

  • wo_status_desc (WO status)

The corresponding value for the assigned column name appears on the top right of the control's header bar.

Note: If this property is blank, nothing is shown, but its space is retained in the control.

The maximum number of displayed characters for the column value is 10. If the column value has more than 10 characters to display, an ellipsis is added to indicate that, and the full column value is shown in a tooltip on mouse hover.

Value1

A numeric or text field associated to a column name in the selected data source lookup.

You need to check for the column name in the data source and manually enter it in the control property page to assign to this property.

Example column name:

  • item_id

  • wo_id

    The corresponding value for the assigned column name appears in the middle of the control just below the header bar. If this property is blank, nothing is shown, but its space is retained in the control.

    The maximum number of displayed characters for the column value is 26. If the column value has more than 26 characters to display, an ellipsis is added to indicate that, and the full column value is shown in a tooltip on mouse hover.

Value (2-5)

A text field associated to a column name in the selected data source lookup.

You need to check for the column name in the data source and manually enter it in the control property page to assign to this property.

Example column name:

  • entity_name

  • wo_id

    The assigned column name to the property and its corresponding value appear in the control after the Value1 property.

    The maximum number of displayed characters for the column value in Value 2 is 27 and in Value (3-5) is 30. If the column value has more characters to display than the maximum number, an ellipsis is added to indicate that, and the full column value is shown in a tooltip on mouse hover.

Value (2-5) Label

Description for the Value property, text to support localization, or a value of a lookup column name.

For example:

  • Entity Name

  • @@entity_name@@ (for localization)

If the Enable Dynamic Label property is set to No, you can use each Label property to specify a description for a particular Value property or use each of them for localization text. For localization, ensure that you add the value you specified in the Label property in its corresponding resource file in the Locales folder under the product installation path.

If the Enable Dynamic Label property is set to Yes, you can assign a column name to each Label property from the selected data source lookup, and the value of that column name is shown in the control as the label for a particular Value property.

If the value of the column name is empty, nothing is shown, but its space is retained.

Note: If a particular Label property is not configured or blank, that field is not shown. The other values use its space, and the size of the control is adjusted based on the available data (values) within the control.

The maximum number of displayed characters for the column value in Value2 Label is 34 and in Value (3-5) Label is 36. If the column value has more characters to display than the maximum number of characters, an ellipsis is added to indicate that, and the full column value is shown in a tooltip on mouse hover.

Appearance

Property

Description

Visible

Show or hide the control.

  • Select Yes to show the control.

  • Select No to hide the control.

    The default value is Yes.

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 value.

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 value and is automatically adjusted based on the content within the control.

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 Default.

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.

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.

Image Path

The location of the image that you want to use in the control.

This can be a URL that starts with http or https, or path with <BPMJITemplates>, <ThemePath>, or <ThemeName> tags.

Note: The supported icon size is 45 pixels.

HeaderValue Left Display Limit

Number of characters to show for the HeaderValue Left property before the ellipsis.

This accepts a maximum display limit of 25. If the column value has more characters to display than the specified limit, an ellipsis is added to indicate that, and the full column value is shown in a tooltip on mouse hover.

The default value is 12.

Note: If the column value is more than 12 characters, you can adjust the font size to fit in the control through CSS.

Custom Style Sheet Identifier

Prefix for the CSS class name in the custom style sheet.

Note: The value must start with an alphabet and can contain only alphanumeric characters.

Advanced

Property

Description

On Click

Run a script after the control is clicked.

ID

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

Enable Lookup Color

Enable use of color defined in the selected data source lookup for the control's header bar.

  • Select Yes to enable use of the color from the data source lookup.

  • Select No to enable the color picker in the Color property and select the color to use.

The default value is Yes.

Color

Color for the control's header bar.

If the Enable Lookup Color property is set to Yes, specify the column name from the lookup that contains the color in this property, otherwise use the color picker to assign the color for the control's header bar.

Enable Refresh

Enable or disable control display refresh.

The default value is No.

Refresh Rate

The number of times the control display is refreshed in seconds.

The default value is 30 seconds.

Enable Dynamic Action Buttons Label

Enable use of the action button (1-3) label properties for data mapping based on the selected data source lookup.

  • Select Yes to enable mapping to a column name in the data source using the action button properties.

  • Select No to disable column name mapping and use the action button properties for static button name or text for localization.

The default value is No.

Enable Action (1-3)

Call the script defined in a particular Action Script property in the Scripts tab.

If you select No, the action button is not visible in the control.

The default value is No.

ActionButton (1-3) Label

Name for ActionButton (1-3) or text to support localization.

If the Enable Dynamic Action Buttons Label property is set to No, you can use each Action Button Label property to specify a name for a particular ActionButton or use it for localization text.

For localization, ensure that you add the value you specified here in its corresponding resource file in the Locales folder under the product installation path.

If the Enable Dynamic Action Buttons Label property is set to Yes, you can assign a column name to each Action Button Label property from the selected data source lookup, and the value of that column name is shown in the control as the label for the action button.

Note: If a particular Action Button Label property is not configured or blank, nothing is shown, and the way the other action buttons are shown is adjusted accordingly.

The maximum number of displayed characters for the column value is 10. If the column value has more than 10 characters to display, an ellipsis is added to indicate that, and the full column value is shown in a tooltip on mouse hover.

Scripts

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

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