Adding a Security File

Introduction to Security (XML) Files

XML Files can be attached to data sources to provide users with a specific view of the data in any future Ad Hoc views created from it. 

Security files can act as a preliminary form of filtering. By attaching a security file, users can only see data specific to them or specific to the context that they are viewing the report.

There are a variety of XML files that you can choose from in the Repository to use for your data sources. These include user.xml, or cohort.xml.

For example, if a user were to view a report that was created from a data source with the cohort.xml security file, then they would only be able to see data from their specific cohort or audience. 

Many of the Out-of-the-Box data sources come pre-installed with a security file. 

Adding a Security File to a Data Source

To include a security file into a pre-existing data source:

1.  From the Lambda Analytics homepage, click View Existing under the Data Sources link on the top navigation bar. 

2.  Locate your desired data source within the Repository, right-click on its corresponding title, and click Edit from the context menu.

3.  In the Data Source Designer, navigate to the Options tab. 

4.  Under the Security File section, click Add Security File.

5.  Under the Repository tab, select your desired security file and click Add. Your security file will now be listed within the Security File section.

6.  If you would like to choose a different security file, click Replace Security File.  If you would like to remove your security file from the data source, click the Delete icon.

7.  Once you are complete, hover over the Save icon and click 'Save Data Source As...'

8.  Enter a new name for your data source that reflects the security file restrictions that you have added, and click Save.

Available Security Files

Cohorts/Audiences (cohorts.xml): Restricts access to Ad Hoc view and report data by cohort or audience enrolment. Users can only see information associated with the cohorts or audiences that they are enrolled in.  Site administrators can see all report information.

Course Managers (course_managers.xml): Allows for course users, such as teachers/trainers, editing teachers/trainers, managers, and assessors to see information associated with the courses that they manage and are enrolled in. Learners are  excluded from this. Site administrators can see all report information.

Current Course (current_course.xml): Restricts access to Ad Hoc view and report data by the user's current course location. This is applied to all LMS users, include site administrators.

Departments (departments.xml): Restricts access to Ad Hoc view and report data by the user's department information, located within their user profile. Site administrators can see all report information.

Groups (groups.xml): Restricts access to Ad Hoc view and report data by a user's group assignment. Users in multiple groups will be able to see information associated with each of their groups. Site administrators can see all report information.

Institutions: (institutions.xml): Restricts access to Ad Hoc view and report data by the user's institution information, located within their user profile. Site administrators can see all report information.

Managers (managers.xml): Allows for managers assigned to a user to see information associated with their team members. Site administrators can see all report information. Only users who have been assign as managers will be able to see any information.

Organizations (Totara) [organizations.xml]: Restricts access to Ad Hoc view and report data by the user's organizational hierarchy assignment. Users with more than one organization assigned through their job assignment will see all information associated with their organization. Site administrators can see all report information. 

Positions (Totara) [positions.xml]: Restricts access to Ad Hoc view and report data by the user's position hierarchy assignment. Users with more than one position assigned through their job assignment will see all information associated with their positions. Site administrators can see all report information.

Positions and Organizations (Totara) [positions_and_organizations.xml]: Restricts access to Ad Hoc view and report data by the user's position and organizational hierarchy assignment. Users with more than one position or organization assigned through their job assignment will see all associated information. Site administrators can see all report information.

Users (users.xml): Restricts access to Ad Hoc view and report data by the user, so they are only able to see their own information. Site administrators can see all report information.