Analytics Report Part form control

A form control that shows a report part from Analytics Center on an eForm.


Analytics Report Part form control

Configure the Analytics Report Part form control

To configure the Analytics Report Part control, do the procedure in this topic.

Video: Common Configuration Settings in eForm Controls

Prerequisites

How to Start

  1. Open eForm Builder.

    For information about how to open this screen, refer to eForm Builder screen.


    Eform Builder screen
  2. On the eForm Builder screen, in the Toolbox, open the Advanced Controls tab.

    Advanced Controls tab
  3. On the Advanced Controls tab, drag an Analytics Report Part form control onto your eForm.

    Analytics Report Part Form Control

Procedure

  1. Complete the settings on the configuration screens.

    You can use the App Data screen to specify a variable.

General

Specifies the basic configuration for the Analytics Report Part form control.

Figure: General tab

General tab

Fields

Field NameDefinition

Label

Function:
Specifies the text label that shows on your form for the control.
Accepted Values:
One line of text that can have spaces.
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Internal Name

Function:
Specifies a unique, technical name for your control.
Accepted Values:
One line of text with no spaces.
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Help Text

Function:
Specifies the text to shows when a runtime app user hovers their cursor over the form control.
Accepted Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Help Text Display

Function:
Specifies if the field shows the text in Help Text field when the form user puts the mouse on the label or field.
Accepted Values:
  • None - Does not show the help text.
  • Hover On Label - Shows the help text when you put your mouse on the label.
  • Hover On Field - Shows the help text when you put your mouse on the field.
  • Hover On Both - Shows the help text when you put your mouse on the label and Field.
Default Value:
None
Example:
Refer to:

Configure

Configures advanced settings for your form control.

Figure: Configure tab

Configure tab

Fields

Field NameDefinition

Category

Function:
Specifies a category for the report part.

This field shows a list of categories that are created in Analytics Center.

Accepted Values:
A category from the list.
Default Value:
None

Sub Category

Function:
Specifies a subcategory for the report part.

When you select a category from the Category field, this field shows a list of subcategories associated with the category.

Accepted Values:
A subcategory from the list.
Default Value:
None

Report

Function:
Specifies a report from which to show the report part.

When you select a subcategory from the Subcategory field, this field shows a list of reports associated with the subcategory.

Accepted Values:
A report from the list.
Default Value:
None

Report Part

Function:
Specifies a report part to show on your form.

When you select a report from the Report field, this field shows a list of report parts associated with the report.

Accepted Values:
A report part from the list.
Default Value:
None

Filter

Function:
Shows the name of the filters that are configured in the specified report.
To Open this Field:
  1. In the Report field, select a report.
Accepted Values:
Read only.

Operator

Function:
Shows the operator to use in the filter.
To Open this Field:
  1. In the Report field, select a report.
Accepted Values:
Read only.

Value

Function:
Specifies the value to use for the filter.
To Open this Field:
  1. In the Report field, select a report.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
Yes

Appearance

Specifies the look and feel for your form control.

Figure: Appearance tab

Appearance tab

Fields

Field NameDefinition

Font Family

Function:
Specifies the font family of the input text and label.
Accepted Values:
A font name from the list.
Default Value:
None
Example:
Refer to:

Font Size (px)

Function:
Specifies the size of the input text and label for your form control.
Accepted Values:
A positive integer.
Default Value:
None
Example:
Refer to:

Font Style

Function:
Specifies the style of the font for the input text and label.
Accepted Values:
  • Bold - Shows the input text and label in bold.
  • Underline - Shows the label underlined.
  • Italic - Shows the label in italic.
Default Value:
None
Example:
Refer to:

Foreground Color

Function:
Specifies the foreground color for your control.
Accepted Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#ff0000
Example:
Refer to:

Label CSS Class

Function:
Specifies a CSS class for the label of your control.
Accepted Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Container CSS Class

Function:
Specifies a CSS class for the container of your control.
Accepted Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Behavior

Specifies how the control shows on your form.

Figure: Behavior tab

Behavior tab

Fields

Field NameDefinition

Visible

Function:
Specifies if the form user sees the field.
Accepted Values:
  • Selected - The form user sees the field.
  • Deselected - The form user does not see the field.
Default Value:
Selected
Example:
Refer to:

Label Position

Function:
Specifies the position of the text label that shows on your form for the control.
Accepted Values:
  • Inherit - The position of the label is as specified in the form settings.
  • Left - Specifies that the position of the label is to the left of the container.
  • Top - Specifies that the position of the label is to the top of the container.
Default Value:
Inherit
Example:
Refer to:

Advanced

Specifies advanced settings for your form control.

Figure: Advanced tab

Advanced tab

Fields

Field NameDefinition

Field ID

Function:
Shows an ID of the control.
Accepted Values:
Read only.
Default Value:
Different for different controls.
Example:
Refer to:

Height (px)

Function:
Specifies the height for your control.
Accepted Values:
An integer.
Default Value:
400

Show On Tablet Devices

Function:
Specifies if the form field shows on a tablet.
Accepted Values:
  • Selected - The form field shows on a tablet.
  • Deselected - The form field does not show on a tablet.
Default Value:
Selected
Example:
Refer to:

Show On Mobile Phone Devices

Function:
Specifies if the form field shows on a mobile device.
Accepted Values:
  • Selected - The form field shows on a mobile device.
  • Deselected - The form field does not show on a mobile device.
Default Value:
Selected
Example:
Refer to: