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

AVEVA™ Work Tasks

Pop-Up

  • Last UpdatedJun 22, 2023
  • 7 minute read

Use Pop-Up control to open a form as a pop-up window in your form. You can reuse your existing form using this control.

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.

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

Note: 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.

Button Text

Text for the control.

Persist Form Definition

Allow or deny a user to persist the form definition.

The definition of the source form is fetched and used for the pop-up form. The source form is no longer referenced after the properties of the control are saved. Therefore, the source form does not have to be available in the repository after the properties are configured.

  • Select Yes to allow a user to persist the form definition.

  • Select No to deny a user to persist the form definition.

    The default value is No.

    The pop-up form pointing to a form with Persist Form Definition set to No shows the draft version of the form in the Preview only rather than the published version.

    The pop-up form pointing to a form with Persist Form Definition set to Yes is the draft version of the form.

Form Details

Details of the form that is to be linked.

To add Form Details for the control

  1. Click the Form Details button. The Form Details Configuration page appears.

  2. In the Form Name box, click a form name.

  3. In the Form Version box, click a form version.

  4. In the Parameters list, click and select a control on the form, if applicable. This maps a pop-up form parameter to a parent form control. The Parameters list appears only if the version of the selected form contains Forms Parameters.

  5. Click Save & Continue. The selected  form details is set for the control, and the Form Details Configuration page  is closed.

    Note:
    - Ensure the selected form has a Button control with the Button Type set to Cancel, otherwise you will not be able to close the form.
    - If you click Finish, then the form will be submitted and closed. However, an empty instance XML will be generated.
    - 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 using Forms Parameters, see Forms Parameters.

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.

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.

Alignment

Alignment of the control with respect to the form.

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

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

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

  • Select Center to align the control to the center of the form.

Dimension

Dimension in percentage for the pop-up window of the control.

The default value is 0.

Note: If the value is 0, then the dimension for the pop-up window 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.

Display Mode

Show text and/or image for the control.

  • Select Text Only to show only text for the control.

  • Select Image Only to show only image for the control.

  • Select Text and Image to show both text and image for the control.

    The default value is Text Only.

Button Size

Size of the button for the control.

  • Select Standard to set the size of the control to 120 x 32 pixels.

  • Select Small to set the size of the control to 30 x 30 pixels.

  • Select Medium to set the size of the control to 180 x 86 pixels.

  • Select Large to set the size of the control to 280 x 130 pixels.

    The default value is Standard.

Image Path

Path to the image for the control.

The image path is specified as:

  • A URL starting with http:// or https://.

  • An image path tag. For information about using image path tags, see Image Path Tags in Image.

  • A path to the BPMUITemplates folder as BPMUITemplates\Default\Images\.

Note:
You can use relative paths as follows:
- Use . for the current folder where the html page resides.
- Use .. for the folder above the current folder where the html page resides.

We recommend the following image sizes when the Display Mode property is set to Image.

  • Small – 30 x 30 pixels.

  • Medium – 180 x 86 pixels.

  • Large – 280 x 130 pixels.

    We recommend the following image sizes when the Display Mode property is set to Text and Image.

  • Small – 30 x 30 pixels.

  • Medium – 40 x 40 pixels.

  • Large – 50 x 50 pixels.

    Note:
    - This property is applicable only when the Display Mode property is set to Image or Text and Image, and the Button Size property is set to SmallMedium or Large.
    - If the Display Mode property is set to Text and Image and the Button Size property is set to Small, then only the image is displayed.

Image Position

Position of the image with respect to the text for the control.

  • Select Left to align the image to the left of the text for the control.

  • Select Right to align the image to the right of the text for the control.

  • Select Top to align the image to the top of the text for the control.

  • Select Bottom to align the image to the bottom of the text for the control.

    The default value is Left.

Note: This property is applicable only when the Display Mode property is set to Text and Image.

Show as Link

Enable or disable the control to show as link.

  • Select Yes to enable the control to show as link.

  • Select No to disable the control to show as link.

    The default value is No.

Custom Style Sheet Identifier

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

For information about using custom style sheets, see Custom Styles.

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

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.

Open New Window

Allow or deny a user to open form in a new browser window.

  • Select Yes to allow a user to open form in a new browser window.

  • Select No to deny a user to open form in a new browser window. However, the system allows the user to open form in the same browser window.

    The default value is No.

Note: Opening the form in a new browser window improves form performance, but the values for the controls on submission of the form will not be persisted.

Persist Value

Keep or lose the value for the control on submission of the form opened as a pop-up window.

  • Select Yes to keep the value for the control on submission of the form opened as a pop-up window.

  • Select No to lose the value for the control on submission of the form opened as a pop-up window.

    The default value is Yes.

Form Button

Enable or disable the control to act as form button. When this property is enabled, the control is displayed at the bottom-right corner of the form.

  • Select Yes to enable the control to act as form button.

  • Select No to disable the control to act as form button.

    The default value is No.

Note: If the value is Yes, and the form is viewed on a mobile device, then the control appears in the Action Bar of the mobile device.

Scripts

For information about using scripts, see scripting guidelines for Pop-Up control.

Note:
- Pop-Up control does not support forms with Pop-Up controls.
- Pop-Up control does not support Chart, Slider, Card, and Hierarchical List controls when the Persist Form Definition property is set to Yes.

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