Report users and groups group_work
Versions
Community module allowing the creation of a report of all users and their groups
Dependencies & Dependants
FAQ
Administration UI
Navigate to Administration → Server → Users and Roles → Report Users & Groups.
| Field | Description |
|---|---|
| JCR root path | JCR path where report files are stored. Use the Browse… button to navigate the repository tree. Default: /sites/systemsite/files |
| User properties to export | Checkbox list of all jnt:user properties. Select the ones to include as extra columns. j:firstName and j:lastName are pre-selected. |
Click Generate report (or press Ctrl+Enter) to start generation. The page polls every 2 seconds while the report is being generated and shows the result in the Generated reports table once complete.
Each report row provides:
- The creation date and time
- A direct download link (
report-users-and-groups-YYYYMMDD-HHmm.csv) - A Delete button to remove the file from the JCR
Karaf shell command
report-users-and-groups:execute [options] [userPropertiesToExport]...
Options:
| Name | Alias | Default | Description |
|---|---|---|---|
-p |
--csvRootPath |
/sites/systemsite/files |
JCR root path where the CSV file is stored |
Arguments:
| Name | Description |
|---|---|
userPropertiesToExport |
Space-separated list of jnt:user property names to include as columns |
Example:
report-users-and-groups:execute -p /sites/digitall/files j:firstName j:lastName j:email
Background job
The job Maintenance.ReportUsersAndGroupsJob runs automatically every day at 01:30 AM by default.
Configure it via Jahia system properties (e.g. in jahia.properties or environment variables):
| Property | Default | Description |
|---|---|---|
jahia.reportsusersandgroups.job.csvRootPath |
/sites/systemsite/files |
JCR root path where the CSV file is stored |
jahia.reportsusersandgroups.job.userPropertiesToExport |
j:firstName,j:lastName |
Comma-separated list of jnt:user property names to export |
jahia.reportsusersandgroups.job.cronExpression |
0 30 1 * * ? |
Quartz cron expression |
CSV format
The generated file is named report-users-and-groups-YYYYMMDD-HHmm.csv and stored under:
<csvRootPath>/report-users-and-groups/<yyyy>/<MM>/<dd>/<HH>/<mm>/<ss>/
Columns:
| Column | Description |
|---|---|
site |
Site name (global for /users, site name for /sites/<name>/users) |
user name |
The JCR node name of the user |
| (selected properties) | One column per selected jnt:user property (e.g. j:firstName, j:email) |
groups |
Comma-separated list of group memberships (system groups excluded) |
How To Install
Requirements
- Jahia 8.2.1.0 or later
- Modules:
default,graphql-dxm-provider,serverSettings
Installation
- In Jahia, go to "Administration --> Server settings --> System components --> Modules"
- Upload the JAR report-users-and-groups-X.X.X.jar
- Check that the module is started
License
MIT License
Copyright (c) 2023 - present Jahia
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.