- NONE
Report users and groups group_work
Community module allowing the creation of a report of all users and their groups
Dependencies & Dependants
FAQ
How to use?
Basic usage
Commands
report-users-and-groups:execute
Reports the list of users with the specified properties and theirs groups. A CSV file is being generated in the JCR with the path /sites/systemsite/files/report-users-and-groups.
Options:
| Name | alias | Mandatory | Value | Description |
|---|---|---|---|---|
| -p | --csvRootPath | /sites/systemsite/files | Root path where to store the CSV files |
Example:
report-users-and-groups:execute -p /sites/digitall/files j:firstName j:lastName j:email
Background job
The job is named Maintenance.ReportUsersAndGroupsJoband is executed by defaut every day at 1:30 AM by default.
Properties:
| Name | Value | Description |
|---|---|---|
| jahia.reportsusersandgroups.job.csvRootPath | /sites/systemsite/files | Root path where to store the CSV files |
| jahia.reportsusersandgroups.job.userPropertiesToExport | j:firstName,j:lastName | Properties to export, separated by a comma |
| jahia.reportsusersandgroups.job.cronExpression | 0 30 1 * * ? | Crontab expression for the job |
How To Install
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.