Description

A data source can have selection parameters for its setting. A settings document of parameter can be used for additional selection of documents in a database for a report. Each parameter has a name and values. Values will be chosen from list of possible by a user while he is setting up a data source in a report.


Adding

To create a selection parameter for a data source, do the next:

Open the view Data Sources;
Open the settings document of data source which you want to create selection parameter for;
In the section Selection Parameters press Add.

The created settings documents are displayed both in the embedded view inside of data source and in the view Data Sources in the category with name of the data source.


Settings

Field Name;
Type a name of parameter that is understandable for a user. For example: Customer Types, Contract Statuses, etc.
Option Type;
Defines how the parameter will select documents in a database.
Choice Documents Selection;
Means that resulting expression of the parameter will be added to condition of documents selection for data source as its part. Resulting expression of a parameter is its values list chosen by a user and placed in text of the list processing.
Choice Condition for Selected Documents.
Means that resulting expression of the parameter will be computed for each of already selected documents: the result of computing @True (1) for a document means it selecting. The type can be useful if you want to use @-functions unavailable for the method NotesDatabase.Search>, for example, the function @DBLookup. Keep in mind that using such functions can much increase the time of reporting.
Section List of Possible Values;
The list will be computed and available for a user when he is setting up a data source in a report structure.
Option Get From;
Sets the method of getting the list.
Choice Documents of Data Source;
Means the typing an expression below, that will be computed for each of documents selected by other parameters of data source. Values in the list will be made unique and sorted alphabetically. In most cases the expression could be just a field name.
Choice Other;
Means the typing an expression below, the result of which will be the list of possible values for the parameter.
Field @ Expression.;
Type an expression in Formula Language for computing the list of possible values for the parameter. You can compute visible and applicable parts of a value. The output format of such value is:
visible part | applicable part
In an expression you can use the keywords KeyServer and KeyFile.
Section List Processing.
The values of the fields will be applied to the parameter values chosen by a user to form the resulting expression of the selection parameter. Fill the fields: Part Before List, Values Separator in List, Part After List. The result of applying the list processing should be a valid expression in Formula Language.


Topic links:

Keywords

See also:

Data Source ( Initial documents selection )