AX1594
Filter Wizard command
Use the Filter Wizard command to create a filter criteria statement using the Filter Wizard.
Can be used in
- Axiom forms
When the Filter Wizard command is selected from the Command Library as the shortcut target, it displays as command://FilterWizard (or using the legacy syntax of command://WizardFilterCommandAdapter).
Shortcut parameters
This command uses the following shortcut parameters:
Item | Description |
---|---|
Target Cell |
The target cell in the source file to place the filter after it has been created. If you are configuring the command on a Button component, enter the target cell using normal cell reference syntax (such as If you are configuring the command on a Button tag for a Formatted Grid component, then you can specify the target cell using normal cell reference syntax or by using just a column letter. If using a column letter, such as J, then the target cell will be in the specified column on the current row of the grid. |
Type |
Select one of the following to determine how users can create the filter:
|
Tables / Hierarchies |
Optional. Specify one or more tables or hierarchies to limit the options shown in the Filter Wizard. Valid entries depend on the specified filter type:
If left blank, then the Filter Wizard shows all available options for the specified filter type. For Advanced Filter this means all tables, and for Hierarchy Filter this means all hierarchies. NOTE: If desired, you can read the list of tables or hierarchies from a designated cell in the source file instead of entering the list into the shortcut parameters. To do this, use a cell reference enclosed in brackets, such as |
Limit Filter Column |
Optional. Specify a limit column to allow the user to create a limit query statement using this column. You can use a full Table.Column name or just a column name.
This option should only be used when you want to generate a limit query statement for use in the Limit query data based on another table option of an Axiom query. This is the only valid use case for the limit query statement. If Limit Filter Column is populated with a column name, this changes the Advanced Filter dialog from the regular dialog to a two-step wizard that is used to create the limit query statement. This is the same user experience as when using the ShowFilterWizardDialog function or the AdvancedFilter refresh variable to create a limit query statement. For more information on limit queries, see Limit the data in an Axiom query based on another query. NOTE: If you define a limit column, the Type must be set to Advanced Filter. Hierarchy filter view cannot be used to create a limit query statement. |
Processing Step |
Specifies when the command will be executed during the Axiom form update process. This option is set to Form - After Updating Values and cannot be changed. For more information, see Timing of command execution. NOTE: This command has special behavior and does not follow the normal form update process. For more information, see Using the Filter Wizard in an Axiom form. |
Options to specify hierarchies
When using the Hierarchy Filter option, the following entries are valid in the Tables / Hierarchies parameter.
-
Enter a table name to display all hierarchies defined for that table. For example, enter DEPT to display all hierarchies defined on the DEPT table.
You can also enter multiple table names, separated by commas. The dialog will display all hierarchies defined for all listed tables.
-
Enter
Table:HierarchyName
to only show the specified hierarchy. For example,DEPT:Geography
to only show the Geography hierarchy on the DEPT table.You can also enter multiple table:hierarchy pairs, separated by commas. The dialog will display all specified hierarchies.
- Enter
Table.Column:HierarchyName
to only show the specified hierarchy and also use the specified Table.Column in the resulting filter criteria statement. For example,DEPT.Region:Region
to show the Region hierarchy on the Region table, whereDEPT.Region
looks up to the Region table. The resulting filter criteria statement will be written such asDept.Region.RegionType=1
instead ofRegion.RegionType=1
, thereby allowing the filter to be applied to tables with a lookup to DEPT.
Visibility
In Axiom forms, the command used does not impact whether the button is visible or enabled.
Remarks
-
For more information on using this command in a form, see Using the Filter Wizard in an Axiom form.
-
Use of this command requires the Web Client Container to be enabled for the form. If it is not enabled, an error will occur when the command is executed.