Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
devel:documentation:modules_reports [2018/07/17 07:29] tomiskar |
devel:documentation:modules_reports [2020/03/11 11:14] doischert |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | <- .: | ||
+ | {{tag> report}} | ||
+ | |||
+ | ====== Modules - Implemented reports [reports] ====== | ||
+ | |||
+ | The main purpose of reports is to create a snapshot of current data in IdM which can then be downloaded as a CSV or XLSX file. This is often useful for audits or other cases when an overview of a large amount of data in IdM is needed. The reports module gives the basic [[devel: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The module is fully dependent on [[devel: | ||
+ | |||
+ | ====== Overview of implemented reports ====== | ||
+ | |||
+ | ==== Identities and their roles ==== | ||
+ | |||
+ | This report allows you to export the list of identities together with their assigned roles. [[devel: | ||
+ | |||
+ | ==== Roles and their identities ==== | ||
+ | |||
+ | This report allows you to export the list of roles and their holders. [[devel: | ||
+ | |||
+ | ==== Identities, their main contract and their roles ==== | ||
+ | |||
+ | This report allows you to export the list of identities (with information about their contracts, incl. one contract EAV) together with their assigned roles. [[devel: | ||
+ | |||
+ | ===== Developing and releasing ===== | ||
+ | How to develop a new feature in reports: | ||
+ | |||
+ | - Create a specification page in private section and consult it with module owner and other colleagues (on Slack). Specification page should contain: | ||
+ | - Usecases - which data should the report contain, what problem does it solve, which client needs it? | ||
+ | - Functional specification - how should it work, edge cases | ||
+ | - Ask a module owner, if this feature can be a part of the module and in which version it will be published | ||
+ | - Create ticket in product Redmine with final requirements and with correct target version | ||
+ | - Implement the feature in a separate GIT branch | ||
+ | - Create merge request to develop | ||
+ | - Get someone from the product team, or the module owner to review your changes | ||
+ | - After successful review, ask module owner to merge you code | ||
+ | |||
+ | Rules for code review: | ||
+ | * There are [[tutorial: | ||
+ | * All features are documented - the report is mentioned above and has a dedicated page describing its use and configuration | ||
+ | * Changelog is updated | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | * When developing, use our standard gitflow: | ||
+ | * Branch per feature. Branch naming as usual. | ||
+ | * Develop on top of the '' | ||
+ | * Master branch contains tagged releases. | ||
+ | * The **only** way for code to get into master is by pull request '' | ||
+ | |||
+ | * Release process | ||
+ | - After merging all features wanted for the release, one (selected) developer builds the develop. If it builds fine and tests are also OK, the developer edits module version in the '' | ||
+ | - Developer creates pull request on GitHub to merge '' | ||
+ | - Repo admin (or any other authorized user) reviews the pull request, can request changes if necessary. Unresolved TODOs, missing comments, bad codestyle or documentation, | ||
+ | - If the pull request is OK, repo admin merges it. | ||
+ | - Repo admin creates a new release in GitHub interface, version is set to '' | ||
+ | - After release, repo admin makes changes on the '' | ||
+ | |||
+ | ====== Read more ====== | ||
+ | |||
+ | ===== Admin tutorials ===== | ||
+ | * [[tutorial: | ||
+ | ===== Devel guide ===== | ||
+ | * [[devel: | ||
+ | * [[devel: | ||
+ | ===== Devel tutorials ===== | ||
+ | * [[ tutorial: |