Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
devel:documentation:modules_reports [2020/03/11 11:15] 127.0.0.1 external edit |
devel:documentation:modules_reports [2024/05/03 11:44] (current) sourek |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | <- .: | + | <- .: |
{{tag> report}} | {{tag> report}} | ||
Line 5: | Line 5: | ||
====== Modules - Implemented reports [reports] ====== | ====== 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 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 [[.: |
- | {{ : | + | {{ .: |
- | The module is fully dependent on [[devel: | + | The module is fully dependent on the [[.: |
====== Overview of implemented reports ====== | ====== Overview of implemented reports ====== | ||
Line 15: | Line 15: | ||
==== Identities and their roles ==== | ==== Identities and their roles ==== | ||
- | This report allows you to export the list of identities together with their assigned roles. [[devel: | + | This report allows you to export the list of identities together with their assigned roles. [[.: |
+ | |||
+ | ==== Identities, their roles and contract ==== | ||
+ | |||
+ | This report is similar to the one above but contains more information. The generated XLSX file has a clear separation between attributes of identity, contract, and role. [[.: | ||
==== Roles and their identities ==== | ==== Roles and their identities ==== | ||
- | This report allows you to export the list of roles and their holders. [[devel: | + | This report allows you to export the list of roles and their holders. [[.: |
==== Identities, their main contract and their roles ==== | ==== 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 (and values of role attributes). [[devel: | + | This report allows you to export the list of identities (with information about their contracts, incl. one contract EAV) together with their assigned roles (and values of role attributes). [[.: |
- | ===== Developing | + | ==== Identities |
- | 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: | + | This report |
- | - Usecases - which data should the report | + | |
- | - 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 | + | |
- | - Create merge request | + | |
- | - 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: | + | ==== Identities |
- | * 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> | + | This report allows you to export all password changes in end systems. You can filter by system, time period, and success of the change. [[.: |
- | * When developing, use our standard gitflow: | + | ==== Identities and their system account (state) changes ==== |
- | * 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 | + | This report allows you to export |
- | - After merging | + | |
- | - Developer creates pull request | + | ==== Virtual system archived |
- | - 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. | + | This report allows you to export all archived |
- | - Repo admin creates a new release in GitHub interface, version is set to '' | + | |
- | - After release, repo admin makes changes | + | ==== Identity complex report ==== |
+ | |||
+ | This report allows you to export complex information about users, their contract and their identity form values (EAVs). [[.: | ||
+ | |||
+ | ==== Complex report of identities, their roles and contracts attributes ==== | ||
+ | |||
+ | This report allows you to export complex information about users, their contract and their assigned roles. [[.: | ||
+ | |||
+ | ==== SQL Universal report ==== | ||
+ | |||
+ | This report allows you to export complex information based on table/view name or custom SQL query. [[.: | ||
+ | |||
+ | ==== Account attribute | ||
+ | |||
+ | This report displays changes provisioned | ||
====== Read more ====== | ====== Read more ====== | ||
===== Admin tutorials ===== | ===== Admin tutorials ===== | ||
- | | + | |
+ | | ||
===== Devel guide ===== | ===== Devel guide ===== | ||
- | | + | |
- | * [[devel: | + | |
+ | * [[.: | ||
+ | * [[.: | ||
===== Devel tutorials ===== | ===== Devel tutorials ===== | ||
- | | + | |
+ | | ||
+ |