| |
| Below is a description of the process
for creating
a Filter. |
| |
| Specify the inputs to the
Filter: |
| |
 |
Give
the filter a name related to the manner in which it will
be applied in your UDMs. The name is case-sensitive and cannot
include embedded spaces or special characters. |
| |
|
Put
in a description and comment on the Filter in the respective
textboxes. This information is not mandatory, but it goes a
long way in making the design of your site more easily understood
and extensible. For example, be sure to include, in your description,
any parameters that the Filter can take. |
| |
|
If
you would like to filter data relevant to specific users in
your application, choose the session variable parameter login
Id as an input. If your site includes other session variables,
they will appear along with the login ID - choose the ones you
need for this Filter. |
| |
|
The
rest of the page lists all the database tables (their primary
keys) in the site's schema. Select the table on which you would
like to apply your Filter. Click "Next" to continue. |
| |
| Edit Filter |
| |
| The parameters you have chosen on
the previous page will be listed in this Edit
Filter page. You can add specific terms to this
Filter on this page by clicking on the Add button. Click
on the Add button to see the Add terms page. |
| |
| Add terms |
| |
| The Current And terms section of the
page
lists the AND terms in the Filter that you have built. This
will not hold any values initially, since you have not added
any terms of begin with. In the Add selection terms section,
you will see listed all the columns of the table you chose,
along with the parameters you chose for input and the foreign
keys in the table. You can select as many columns as you'd like
for building the Filter. Put in relationships, strings or
input parameters for the columns that you want to use in the
Filter. Be sure to check the boxes next to the columns that
you want to use in your Filter before you save it. Clicking
on the Save button will bring you back to the Edit
Filter page. You will see the term you just added
show up on the page. |
| |
| You may choose to delete any of these
terms by checking the box next to a term and then clicking the
Delete button. You can add new terms that are applied in an
OR condition by clicking on the Add button. |
| |
| You also can extend the current term
by clicking on the "Extend" button to add more terms. You will
be taken to the Add
terms page again, but this time, in addition to
the columns of the table that you added, you will see columns
from any foreign-key-references that you included in the earlier
term. Choose additional terms, apply the appropriate operands
(the with, contains, <, <=, >, >=, !=, etc.) and save the term
to return to the Edit Filter page. |
| |
| Note that parameters from UDMs or passed
parameters should be enclosed by question marks. For example,
if you want to pass the login ID of the session (session.loginid)
as a parameter, use the syntax ?session:loginId?. You
can choose to include node IDs from specific UDMs, too, with
a similar construct (?nodeId?), but this will make the
Filter unusable on any UDMs that are not structured in an
identical manner.
On clicking on the Extend button, you will also see a section
to Add aggregation terms. This section shows maximum,
minimum and count values that you can retrieve using this
Filter. These functions are applicable to nodes in a UDM
where you have specifically asked for an aggregation of data. Once you are done editing the Filter, click the Finished
button to save it.
|
