Differences

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

--- devel:documentation:modules_reports [2019/03/01 14:35] – [Admin guide (to be completed)] no need for this section here kotisovam
+++ devel:documentation:modules_reports [2025/08/07 09:53] (current) – [Modules - Implemented reports [reports]] dudaj
@@ Line 1: / Line 1: @@
-<- .:modules_rpt |  ^ .:start | Documentation ^ .:modules_crt |   ->
+<- .:modules_rpt | ^ .:start | Documentation ^ .:modules_crt | →
 {{tag> report}}
@@ 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 [[.: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}}
+{{  .:rpt.png  | [reports] and [rpt] modules}}
-The module contains a bulk of reports:
+The module is fully dependent on the [[.: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.
+**Before adding the reports module a new db user needs to be created and configured**. The exact steps are described [[https://wiki.czechidm.com/devel/documentation/modules_reports/reports/sql_universal_report?s[]=*report*#config_for_installation_on_iam_appliance|here]].
+====== Overview of implemented reports ======
+==== Identities and their roles ====
+This report allows you to export the list of identities together with their assigned roles. [[.:modules_reports:reports:identities_and_their_roles|Learn more]]
+==== 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. [[.:modules_reports:reports:identity_role_complex_report|Learn more]]
+==== Roles and their identities ====
+This report allows you to export the list of roles and their holders. [[.:modules_reports:reports:roles_and_their_identities|Learn more]]
+==== 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). [[.:modules_reports:reports:identities_their_main_contract_and_their_roles|Learn more]]
+==== Identities and their assigned roles changes ====
+This report allows you to export all changes in assigned roles for users in a given time period. You can use filter to only show changes caused by automatic roles (both by position and attribute). [[.:modules_reports:reports:identities_and_their_automatically_assigned_roles_changes|Learn more]]
+==== Identities and their password changes on a system ====
+This report allows you to export all password changes in end systems. You can filter by system, time period, and success of the change. [[.:modules_reports:reports:identities_and_their_password_changes_on_a_system|Learn more]]
+==== Identities and their system account (state) changes ====
+This report allows you to export all account changes in end systems of the type CREATE, DELETE and ENABLE. You can filter by system, time period, type of operation,and success of the change. [[.:modules_reports:reports:identities_and_their_system_account_changes|Learn more]]
+==== Virtual system archived request report ====
+This report allows you to export all archived (realized or rejected) requests on virtual systems. You can filter by time period. [[.:modules_reports:reports:vs_archived_requests|Learn more]]
+==== Identity complex report ====
+This report allows you to export complex information about users, their contract and their identity form values (EAVs). [[.:modules_reports:reports:identities_complex|Learn more]]
+==== 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. [[.:modules_reports:reports:identity_role_complex_report|Learn more]]
+==== SQL Universal report ====
+This report allows you to export complex information based on table/view name or custom SQL query. [[.:modules_reports:reports:sql_universal_report|Learn more]]
+==== Account attribute changes report ====
+This report displays changes provisioned to specified systems [[.:modules_reports:reports:account_attribute_changes_report|Learn more]]
 ====== Read more ======
 ===== Admin tutorials =====
-  * [[tutorial:adm:modules_reports| Reports module [rpt] - How to prepare a report]]
+  * [[:tutorial:adm:modules_reports|Reports module [rpt] - How to create a report]]
 ===== Devel guide =====
-  * [[.modules_rpt:dev:report_manager]]
-  * [[.modules_rpt:dev:attachment_manager]]
+  * [[.:modules_reports:developing_and_releasing|Developing and releasing in the module reports]]
+  * [[.:modules_rpt:dev:report_manager|How reports work]]
+  * [[.:modules_rpt:dev:attachment_manager|]]
 ===== Devel tutorials =====
-  * [[ tutorial:dev:create_report | Create a report ]]
+  * [[:tutorial:dev:create_report|Create a report ]]