Arguments in report queries control how the query runs against the database. They can specify variables that are used in the SQL query and how values are returned to the SQL query, or cause the user to be prompted for input when the query is run.
Each argument has the following components:
type name[count] [instruction]
Predefined argument types
The first column in the result table displays the argument type. The following types are predefined:
| FileID |
DocumentID of selected file |
| UserID |
UserID of selected user |
| ProjectID |
ProjectID of selected folder |
| String |
String |
| GroupID |
GroupID of selected group |
| StatusID |
StatusID of selected workflow state |
Rules for argument definition
-
The name cannot contain spaces.
- The count can be either a hard coded count or the characters N, S, or M.
| N |
Signifies a variable count where the user is prompted to enter values. |
| S |
If the argument type is FileID, the argument is fetched from the selection list. Files are added to the selected files window. If the argument type is UserID, the ID of the currently logged on user is retrieved.
One table is displayed for each file.
|
| M |
If the argument type is FileID, the argument is fetched from the selection list. All files are put in an array, and the result is displayed in one table.
|