ParameterDetails.png)
Type
Each Parameter Type has a different use, as described below:
| Type | Description | Link to next page of wizard |
|---|---|---|
| Boolean | A question requiring a True or False answer. | Boolean Parameter Page |
| Check List | A comma separated list with Check Boxes. | Check List Parameter Page |
| Date | A single Date to enter with no Default Values. | Date Parameter Page |
| Date Range | From & To Dates with ability to set Default range. | Date Range Parameter Page |
| Grouping List | A pipe-separated list of grouping values (not display values). | Grouping List Parameter Page |
| List | A comma separated List of values. | List Parameter Page |
| Number | A number. You can set a default and minimum/maximum values. | Number Parameter Page |
| Number Range | A calculated range of values. | Number Range Page |
| Page Start | Starts a new page if you want the parameters to flow as a Wizard. | Tooltip Page |
| Range | Defines Ranges to use. | Range Parameter Page |
| Section Start | Starts a new Section on the same page. Tick the Visible checkbox to allow Section Headings to be made visible. Section Headings (Section Start Parameters) will not be shown unless there are other visible Parameters within that section. | Tooltip Page |
| Text | Free text entry, with Defaults and Max length defined. | Text Parameter Page |
| Include Standard Parameters | A selection of type of standard parameters to choose from such as Account, Account with Date As At, Account with Date Range, Client,Client with Date As At, Client with Date Range, Security Statement, Security Statement with Date As At and Security Statement with Date Range. | Include Standard Parameters Parameter Page |
Name
Enter a Name of the item. This will be the default caption (where a caption is required) if no Caption is entered.
Caption
Enter a Caption to display wording different to the Name.
Enabled
Tick to allow the User to enter a value. If unticked, the parameter item will be read-only.
Visible
Tick to show the item. If unticked, the User will not be able to see this parameter item.
Mandatory
Tick to make this a Mandatory field, which must be completed before moving to the next page.
Persistable
Tick to make this parameter able to be saved by the User, e.g. when saving Report Settings.
Hide description when displaying a list of parameters?
Tick to prevent this parameter from being displayed when a description of the parameters is generated, e.g. in the parameters section at the bottom of most reports.
Standalone only?
When using a parameter for a Document, this flag means that the Document will only appear if the Document is being run Ad-Hoc, e.g. an Account Statement can be generated from an Account Log, this is NOT Ad-Hoc. It can also be run from the Report Explorer, i.e., in Ad-Hoc mode. Certain parameters should only be shown when running in Ad-Hoc mode, the most obvious being ranges to filter Accounts by, (when run from an Account Log, you already know the Account).
Index
You can map the Parameter to a User Field which can then be used for Report Grouping and Range selection.
The User Defined Index refers to the actual database field, (User0 to User9), that the value will be saved into.