Report Viewer Configuration

The Report Viewer Configuration control allows you to configure the report view.

In the Report Viewer properties window, click the Report Configuration option. The Report Configuration page appears and configure the following:

• Report View Option: The following options are available to view the report in forms:

  • Embed

  • Popup

  • Export

    Embed: The report view can be embedded in the form using the following settings:

• Display Options: Displays the following options:

  • Parameter Prompts

  • ToolBar

  • Back Button

  • Page Navigation Controls

  • Refresh Button

  • Find Controls

  • Export Controls

  • Print Button

• Report Template: Select the required report template from the dropdown list to generate the report view.

• Parameters: Allows you to set the values for the selected report template parameters. On selecting the required Report Template, the parameters defined for this particular template will be listed. All the parameters with the * mark are mandatory.

  By default, only the unhidden parameters are displayed. You can check the Include Hidden Parameters option to view all the hidden parameters.

  You can specify a value for these parameters in two ways:

  • Controls: Select Controls from the parameter dropdown and click the button to select a form control. At runtime, the value of the control will be reflected on the parameter, based on which the reports are fetched from the Reports list.

    Note: It is recommended to have controls, which are used as parameters, in the same level as that of the report viewer control.

  • Values: Users can select the Values option in the parameter drop-down and specify the value.  

    Among the parameters displayed here, the Time Zone ID and the TagName parameters have specific icons, Time Zone and Historian Tag, displayed against them respectively. Users should note that it is a prerequisite to have a Historian Connection established before selecting a Time Zone or a Historian Tag. For more information on how to establish a Historian Connection, refer to Creating a Historian Connection under the Report Activities topic in Developer Guide.

Time Zone: If a report parameter name is the Time Zone ID, then the Time Zone icon will be displayed for that particular parameter.

On clicking of this icon, the Time Zone screen pops up. Here, the user can select the required Historian Connection. On selection of the connection, different time zones will be populated in the Time Zone drop-down list. The user can select an appropriate time zone and click Select.

Historian Tag: If a report parameter name is TagName, then the Historian Tag icon is displayed for that particular parameter.

On clicking of this icon, the Historian Tags screen pops up. Here, the user can select the required Historian Connection. On selection of the connection, all the Historian tags will be displayed in the left-hand side list box of Select Tag(s) section.

The user can select the required tags, click the > button to move the tags to the right-hand side of the Select Tag(s) section and click Select. If the user wants remove any tag from the right-hand side list box, then the user has to select the tag(s) and click the < button. The tag will be placed in the left-hand side list box.

A parameter can also be set to a null value, based on the parameter definition in the Report Template. In such cases the parameter would be displayed as shown in the image given below:

This is available only when the Values option is selected in the Parameters drop-down list. As seen in the above image, selecting the null check box would disable the value-specific controls of that parameter.

Note: Embed option is recommended for small reports as large reports would degrade the performance of the form.

Pop-up: This option works very similar to the Embed option. Users can select the Popup radio button to configure a report to be viewed in a pop-up screen. For more details, refer to Embed section.

Export: Select this option to export <>:

Report Source: Specify the source of the report. If the Report radio button is selected, all reports from the  Reports list will be listed in the Report drop-down.

If the Report Generator Activity radio button is selected, then the user has to set the Report Reference Variable. The user can specify a value for these parameters in two ways:

Users can select Controls option in the parameter drop-down and click the button to select a Form control. At runtime, the value of the control would reflect on the parameter, based on which the report view is generated. 

Users can select the Values option in the parameter drop-down and specify the value. The value should be the Title or GUID of the report.  

Report: Select the report from the drop-down list which has all the available Reports.

Appearance

Validation

Advanced

Note: Report View Control does not support scripts.

Scripts

For more information, refer to Using Scripts in the Forms.

Viewing a Report as an embedded report in a form using Report Viewer Control

Given below are the steps to view a Report as an embedded report:

1. Create a new form using the Tools > Manage Forms > New.

2. Drag and drop a Date Time Input control.

3. Enter the Tag name and click in the Mapped XML Node field to populate the value.

4. Click Save.

5. Drag and drop the Report Viewer control to the form designer.

6. Enter the Tag name and click in the Mapped XML Node field to populate the value.

7. Click the Report Configuration icon to open the window.

8. Specify all the required properties in this window. Refer to Embed section for more details.

9. Click Submit in the Report Configuration window.

10. Click Save in the Report Viewer properties window.

11. Click the Preview button in the ribbon bar.

12. In the preview window, enter a value in the Date Time Input field. The report will be generated on the screen.

    To view the report in a full screen mode, click the View Report in full screen link.

Viewing a Report in a Pop-up window using Report Viewer Control

Given below are the steps to view a Report in a pop-up window:

13. Create a new form using the Tools > Manage Forms > New.

14. Drag and drop a Date Time Input control.

15. Enter the Tag name and click in the Mapped XML Node field to populate the value.

16. Click Save.

17. Drag and drop the Report Viewer control to the form designer.

18. Enter the Tag name and click in the Mapped XML Node field to populate the value.

19. Click the Report Configuration icon to open the window.

20. Specify all the required properties in this window. Refer to Pop-up section for more details.

21. Click Submit in the Report Configuration window.

22. Click Save in the Report Viewer properties window.

23. Click the Preview button in the ribbon bar.

    In the preview window, enter a value in the Date Time Input field and click the View Report link.

    The report appears in a pop-up window as shown in the image given below:

Viewing a Report through a Download link in a form using Report Viewer Control

Given below are the steps to view a Report through a download link:

24. Create a new form using the Tools > Manage Forms > New.

25. Drag and drop the Report Viewer control to the form designer.

26. Enter the Tag name and click in the Mapped XML Node field to populate the value.

27. Click the Report Configuration icon to open the window.

28. Specify all the required properties in this window. Refer to Download section for more details.

29. Click Submit in the Report Configuration window.

30. Click Save in the Report Viewer properties window.

31. Click the Preview button in the ribbon bar.

    In the preview window, click the Download Report link.

    By clicking the Download button, you can either save the report to the required location on your computer or open it to view its contents.

Note: The Report Viewer control settings within an embedded form control will be overridden with the settings of the Report Viewer Control present in the same form. This occurs if the Report Viewer Control and the embedded form control having a Report Viewer Control are present in the same form and both the Report Viewer Control in the Form and the Report Viewer controls within the embedded form control have the same Id.

To resolve this, export the main form and change the Report Viewer control Id and ensure it is different from the Id of Report viewer control present in the embedded form control. Import the edited XML back to the forms designer.
Report Viewer Control does not support scripts.