Online Help > Entry Types > Sessions > Others

Data Report

Description

 

This entry is used to define and configure a Data Report session. A Data Report is composed of a database connection string and a database query to be executed. The result is displayed in a read only grid with export capabilities. It is useful to quickly integrate data into the application.

 

Auto Login

Copy Password

Credential Repository

 

Embedded Mode

Show Opened Session

Support Logging

 

Workflow

 

You must configure your connection string and your SQL query. You will also need to know how to write an SQL statement as this is database dependent.

 

Settings

 

General

Data Report - General tab

Data Report - General tab

 

OPTION

DESCRIPTION

Source

Select your source between:

Default: The connection string is defined directly within the session.

Credential Entry: Use a linked Connection String credential entry as the connection string.

Inherited: Navigate down the inheritance graph of the object to find the connection string.

Prompt: At open connection time, the system will prompt the user to select the desired Connection String from credential entry list.

Data source

Contains the data source type like ODBC, OLEDB or native. This value is read only and is automatically extracted from the connection string.

Data provider

Specify the provider used for the database access. This value is read only and is automatically extracted from the connection string.

Connection string

This value contains the database connection string and can be hidden/encrypted for a better security.

Host

Contains the connection server name. This value is read only and is automatically extracted from the connection string.

User name

Contains the username used to access the database. This value is read only and is automatically extracted from the connection string. If using Windows Authentication the field will be empty.

Password

Contains the username used to access the database. This value is read only and is automatically extracted from the connection string. If using Windows Authentication the field will be empty.

 

When the source is set to Prompt you will see a dialog box prior to opening the connection.

Only the Connection String credential entries from your data source are listed. Select the entry to use and the report will be executed.

 

Parameters

Using parameters is quite simple. Write your query with parameter place holders (@Param1 or ? depending of the data provider you use). On the Parameters tab define the parameter type and default value. When opening the session, you will be prompted for the parameter values.

 

Data Report - Parameters

Data Report - Parameters

 

Parameter placeholders syntax depends on the chosen data provider:

.NET Framework Data Provider for SQL Server: Uses named parameters in the format @parametername

.NET Framework Data Provider for OLE DB: Uses positional parameter markers indicated by a question mark (?).

.NET Framework Data Provider for ODBC: Uses positional parameter markers indicated by a question mark (?)

.NET Framework Data Provider for Oracle: Uses named parameters in the format: parmname

 

OPTION

DESCRIPTION

Type

Select between 3 types:

Unused

Text

Secured

Integer

Numeric

Date

DateTime

Default value

Enter the default value.

Exec Query

Once your have set the default value of your parameter you can execute your query fields.

Show parameters in report header

Show the parameter name in the report header. You can change the parameter name by clicking on Parameter.

 

Query

Data Report - Query tab

Data Report - Query tab

 

Enter the query in the Query tab, which features an SQL syntax-highlighted text box with line numbers which must be compatible with the data provider.

 

This supports multiple queries in the statement and will display the results in different tab pages.  Most native drivers support it.  For ODBC, you must locate an advanced setting named MultipleActiveResultSets or MARS_Connection and turn it on.  If you do not see such a property, then it is not supported by your driver.

 

Troubleshooting

 

While setting up the connection use the Test Connection button of the Connection Properties Window to ensure the connection is configured properly.

 

Use the Exec Query button on the Parameters tab to preview the query result.

 

More information is available in the Tips and Tricks Data Report topic.