Generate Documentation
The Generate Documentation feature allows administrators to create structured documentation of groups, including their configuration, assigned users, roles, and permissions. This helps in capturing a clear snapshot of how access is defined within the system at any given time.
The generated documentation can be used for internal reference, knowledge sharing, or compliance purposes, making it easier to understand and review the overall security setup without navigating through multiple screens.
Benefits of Generate Documentation
📄 Centralised Information
Instead of checking multiple screens, you get all group-related details in a single document, which is much easier to read and review.
🔍 Clear Understanding of Access
Helps you quickly see who has access to what and through which group or role, without digging into configurations.
📊 Helpful During Audits
When audits come up, you already have the required information ready, saving time and avoiding last-minute effort.
🤝 Easier to Share with Others
You can simply share the document with managers, auditors, or team members instead of explaining everything manually.
🧠 Better Knowledge Transfer
Useful when onboarding new team members or handing over responsibilities, as it gives a clear picture of the current setup.
🔄 Good for Reviews and Clean-up
Makes it easier to spot unnecessary roles or outdated group setups and take action.
⏱️ Saves Daily Effort
Reduces the need to repeatedly check the system for the same information—just generate and refer to the document when needed.
How to Generate the document
Step 1: Select the groups for which you want to generate the document –> Click on Generate Document
Step 2: You will get a popup dialog box to confirm the information that will be generated –> Click OK once confirmed.
- You can select the output location where the generated document will be stored.
- You can choose the paper size, either A4 or Letter format.
A PDF format will be generated, below is a sample for reference.
When should you use this?
You can use the Generate Documentation feature in the following situations:
- Before audits or compliance reviews
When you need a clear record of group configurations, roles, and permissions. - During access reviews
To quickly analyze who has access to what and validate if it is still required. - For onboarding or handover
When new team members need to understand the existing security setup. - While troubleshooting access issues
To get a complete view of group-level permissions without checking multiple screens. - For documentation and record-keeping
When maintaining internal documentation of your security configuration. - Before making major changes
To keep a snapshot of the current setup for reference or rollback if needed.