Parameter Field

If you are using Date Time parameters in your reports, check that the DSN that is used to access the ClearSCADA database is configured to use Local Time, rather than UTC.

Use Parameter fields to allow user-input into what data is included when a report is generated. ClearSCADA supports a maximum eight parameters per report, with Range Values counting as two parameters.

When an operator attempts to generate a report that include parameters, a window is displayed, allowing the user to restrict the data that is included in the report (see Allow Users to Specify which Data is Included in a Report).

Note that to incorporate a Parameter field in the report layout, you need to place the Parameter field in the report manually. If placed in a section such as a Footer, the section can optionally be hidden from view.

If you add Parameters to a report, remember to provide the necessary operator instructions on how to use those parameters. You might want to produce the instructions as a printed document, as online Notes that you attach to the report using ClearSCADA’s Notes facility, or as a Help View that displays instructions about using the parameters. See the relevant core documentation for further details.

When you configure a Parameter field using the Crystal Reports application, you are offered a set of configuration options. The options differ, depending on the type of Parameter field that you are configuring (such as Boolean, string, or time). ClearSCADA supports a subset of the configuration options. The tables below indicates which options ClearSCADA supports (‘Yes’) and which options are not available for use (‘No’). When configuring Parameter fields, only specify options that are supported.

Configuration Option

Parameter Type

Boolean

Currency

Date

Date Time

Number

String

Time

List of Values - Static

No

Yes

Yes

Yes

Yes

Yes

Yes

List of Values - Dynamic

No

No

No

No

No

No

No

Value Field

No

Yes

Yes

Yes

Yes

Yes

Yes

Description Field

No

Yes

Yes

Yes

Yes

Yes

Yes

Show on (Viewer) Panel

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Prompt Text

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Prompt with Description Only

No

Yes

Yes

Yes

Yes

Yes

Yes

Optional Prompt

No

No

No

No

No

No

No

Default Value

No

No*

No*

No*

No*

No*

No*

Boolean Group #

Yes

           

Exclusive Group

(See below)

           

Allow Custom Values

 

Yes

Yes

Yes

Yes

Yes

Yes

Allow Multiple Values

 

No

No

No

No

No

No

Allow Discrete Values

 

Yes

Yes

Yes

Yes

Yes

Yes

Allow Range Values

 

Yes

Yes

Yes

Yes

Yes

Yes

Start

   

No

No

   

No

Min Value

 

No

   

No

   

Min Length

         

No

 

End

   

No

No

   

No

Max Value

 

No

   

No

   

Max Length

         

No

 

Edit Mask

         

No

 

* The Default Value have to appear as the first entry in the Static Value list that is displayed above the Options area in the Create New Parameter and Edit Parameter windows. Any entry that is specified as the Default Value in the Options area of the window is ignored.

For information on using the Create New Parameter and Edit Parameter windows, see the documentation supplied with the Crystal Reports application.

For examples that demonstrate the use of Parameter fields in reports, see:

Also see Understand the Crystal Reports Viewer Layout.


Disclaimer

ClearSCADA 2017 R3