Differences

This shows you the differences between two versions of the page.

--- devel:documentation:modules_reports [2019/03/01 14:35]
kotisovam [Admin guide (to be completed)] no need for this section here
+++ devel:documentation:modules_reports [2020/03/12 07:35]
doischert
@@ Line 5: / Line 5: @@
 ====== Modules - Implemented reports [reports] ======
-[reports] gives the basic [rpt] module true power by enabling real reports based on real use cases. The module evolves often since new reports are added on a regular basis.
+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:documentation:modules_rpt|rpt module]] true power because it contains implemented reports for many use-cases. The module evolves often since new reports are added on a regular basis.
 {{ :devel:documentation:rpt.png | [reports] and [rpt] modules}}
-The module contains a bulk of reports:
+The module is fully dependent on the [[devel:documentation:modules_rpt|reports [rpt]]] module and only contains implemented reports, not the logic of creating reports in general.
-  * Identities and their roles - supported formats: CSV, XLSX, JSON
-  * Roles and their identities - supported formats: CSV, XLSX, JSON
-The module is fully dependent on [[devel:documentation:modules_rpt|reports [rpt]]] module.
+====== Overview of implemented reports ======
-====== Read more ======
+==== Identities and their roles ====
-===== Admin tutorials =====
+This report allows you to export the list of identities together with their assigned roles. [[devel:documentation:modules_reports:reports:identities_and_their_roles|Learn more]]
-  * [[tutorial:adm:modules_reports| Reports module [rpt] - How to prepare a report]]
+==== Roles and their identities ====
-===== Devel guide =====
+This report allows you to export the list of roles and their holders. [[devel:documentation:modules_reports:reports:roles_and_their_identities|Learn more]]
-  * [[.modules_rpt:dev:report_manager]]
-  * [[.modules_rpt:dev:attachment_manager]]
+==== 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:documentation:modules_reports:reports:identities_their_main_contract_and_their_roles|Learn more]]
+====== Read more ======
+===== Admin tutorials =====
+  * [[tutorial:adm:modules_reports| Reports module [rpt] - How to create a report]]
+===== Devel guide =====
+  * [[devel:documentation:modules_reports:developing_and_releasing|Developing and releasing in the module reports]]
+  * [[devel:documentation:modules_rpt:dev:report_manager|How reports work]]
+  * [[devel:documentation:modules_rpt:dev:attachment_manager|Attachment manager]]
 ===== Devel tutorials =====
   * [[ tutorial:dev:create_report | Create a report ]]