The next table presents the properties of the SQL tool.

Property

Description

Optionality

Default value

Obs.

Name

Text that identifies the query. The scope of the query depends on the scope of the action.

Mandatory

 

E.g. Name of the List of records used to feed a List Records widget.

See rules for naming elements.

Description

Free text that describes the query. You can edit the text by directly typing it in the property or in the Description Editor which opens by clicking

Optional

 

Useful for documentation purposes.

The maximum size of this property is 2000 characters.

Cache in Minutes

Indicates how long the query results remain in cache. However, if the cache is invalidated, during this time, they are removed from the cache.

Optional

Empty value; means that the element is never cached.

Learn more About Caching Contents.

Max. Records

Maximum number of records that are fetched from the database.

Optional

 

If you don't know exactly the number of records that the List must have, you should specify a number big enough to handle these situations. For example, when you want to get all the rows of a table or delete a set of rows.

If a value is not specified, the Agile Platform uses the following as Max. Records:

  • In Widgets
StartIndex + LineCount + 1
  • Exporting to Excel
No limit of records

Timeout in seconds

Defines the maximum time Platform waits for this query to be executed, since the database connection was established.

This value is defined in seconds.

Optional

 

If there is no value specified in this property, the query time-out corresponds to the Default query timeout parameter specified in the Platform Server Configuration Tool.

Statement

The SQL statement to execute..

To open the SQL editor double-click on the property name or click on .

Mandatory

 

 

 

Advanced Query

Launches the SQL editor to edit the query.

Mandatory

 

 

Arguments

The arguments correspond to the parameters of the query. The values of the arguments must be of the same type as the parameters.

To specify the arguments you can use the Expression editor.

Mandatory

 

 

See Also

About SQL