The steps for setting up Access Filters are:
- Create an Access Filter on the data source
- Assign the Access Filter to a field on a view
- Define a default Access Filter on the view
- Assign an Access Filter to a report
Creating an Access Filter
- Select source filters on the connection details page. This will make the source filter step available in the wizard.
- Click Add to add in a new filter or edit to edit an existing record. If you click add you will be prompted for the type of filter you wish to create.
In each case you will need to enter records consisting of four fields:
The Identifier Type and Identifier are used to identify a Yellowfin user. The Identifier Type can be either
The Identifier field will then be the corresponding user id.
The Filter Type field is used to determine what type of filter this is. This is critical to assist users when creating views or reports. Select a user friendly type name.
The Reference Id field is the corresponding data for the matching user.
Defining a Filter Type
The filter type is used to link the data in your source system with Yellowfin meta-data. It also provides a mechanism to categorise the type of filters that you can make available for your views.
- From the Source entry page you will see the Available filter types on the right hand side of the page. Click Edit to add new filter types.
- From the popup click the add link to add a new filter type. This will open a section at the bottom of the popup. Enter a code and description of the filter type you are creating.
- Once you have created a new type click the add link and then the OK link to save all your changes. This will take you back to the main access filter page and you should see a filter type specified in the available list.
Note: If you wish to delete a filter type then from the edit popup select a type and click the delete link. You will be prompted to click OK to save your changes. If you delete a type which is in use this may impact your reporting filter process.
Note: If records exist you can view these by clicking the view record link located at the bottom of the entry section.
Upload Data File
Scheduled SQL Query
The query will run against the source database, and must return four fields corresponding to the fields described above.
Click on the Test Query link to run the query and report any errors. This will test the SQL syntax, but will not validate the data returned.
Assigning an Access Filter to a View
- Create your view as normal, and then on the Fields page, select a field that corresponds to one of the Reference Types you have created.
- On the Access tab, select the correct type from the Access Filter selection. You will not be able to select Reference Types that don’t have any filter records saved against them.
- Once you have selected the Access Filter, save the field. You can select more than one field to be different Access Filter types if you wish.
- Once you have finished assigning access filter types to the fields on the view, go to the View Security page. You can select a default filter to be applied to reports created against this view here, or choose not to have one. If you select a default filter, any subsequent report created against this view will have the filter applied. Users creating reports that have the appropriate access level can change or remove the filter on a per-report basis.
Assigning an Access Filter to a Report
On the Report Data page, open the Report Data section in the Report Options box on the right hand side. The Access Filter selection box contains any filters that have been attached to the selected view.
If you select a filter, it will be applied to the results for each user when they run the report.
Note: that only users with the appropriate security access level will be able to change the Access Filter on a report.