Export Screen Data to a CSV File Overview
The Screens List can be exported to a CSV file directly from the CMS, allowing users to generate reports containing screen information for their project.
Access to the export functionality is controlled through user permissions. Account Owners have access by default, and administrators can grant export access to custom user roles through the Role Editor.
CSV exports provide an efficient way to review, analyse, and share screen information outside of the CMS.
Permission Requirements
To export the Screens List, a user must have permission to export screen data.
This can be achieved by:
- Being an Account Owner
- Being assigned a custom role with the Export Screens List to CSV permission enabled
Administrators can configure this permission within the User Role Editor.
To enable export permissions for a custom role:
- Open the Customer User Role Editor
2. Create a new custom role
3. Ensure the role has Edit access to Screens
4. Click Control Access
5. Enable Export Screens List to CSV
6. Save the role
Users assigned to that role will then be able to export screen data from the CMS.
How to Export the Screens List
To export screen data:
1. Log in to the CMS
2. Navigate to Screens
3. Open the Screens List
4. Select Export to CSV
5. The CSV file will be generated and downloaded automatically
💡Tip: The exported file can be opened using spreadsheet applications such as Microsoft Excel or Google Sheets.
Important Information About Access Tags
Important: Screen exports are generated at the project level and do not apply Access Tag restrictions.
When a CSV export is generated:
- All screens within the project are included
- Access Tags are not used to filter export results
- Users with export permissions can export screen data for the entire project
This behaviour applies regardless of any access tag visibility restrictions configured for the user within the CMS.
Example
A user may only be able to view screens associated with specific access tags while working within the CMS. However, if that user has permission to export the Screens List, the generated CSV file will contain all screens within the project.
Administrators should consider this behaviour carefully when assigning export permissions to restricted-access roles.
Summary
The Screens List can be exported to CSV by users with the appropriate permissions. Export access can be granted to custom roles through the Role Editor, providing flexibility for operational, support, and installation teams.
Please note that screen exports always include all screens within the project and do not respect Access Tag visibility restrictions.
Further Reading: Custom Roles, Mass Management tool, User Access Tags