Differences

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

Link to this comparison view

Both sides previous revision Previous revision
tutorial:adm:report_compare_value_idm_to_system [2019/09/12 07:56]
stloukalp corected using overrided script
tutorial:adm:report_compare_value_idm_to_system [2019/11/08 12:41] (current)
doischert
Line 1: Line 1:
 ====== Report - Compare values in IdM to system ====== ====== Report - Compare values in IdM to system ======
  
-This tutorial shows how to create a report for the chosen identities+This tutorial shows how to create a report for the chosen identities ​which compares identity attribute values to the mapped attribute ​values ​in connected system. 
-Report ​compares identity attribute values to mapped attribute in connected system. +This report can be used if you change some attribute or in script where the value is calculated. ​There is no need to set the connected system to read only.
-This report can be usedif you will change some attribute or in scriptwhere value is calculated. ​You do not need set connected system to read only.+
  
 ===== Preparation ===== ===== Preparation =====
  
-  * Report ​is currently in extras module. +  * The report ​is currently in the extras module. 
-  * Connected ​system with some provisioned identities.+  * Have a connected ​system with some provisioned identities.
  
 ===== Report ===== ===== Report =====
Line 16: Line 15:
 {{ :​tutorial:​adm:​comparereport_01.png |}} {{ :​tutorial:​adm:​comparereport_01.png |}}
   * Select report '​Compare values in IdM with values in system'​   * Select report '​Compare values in IdM with values in system'​
-  * And now we need **system** we want compare values with, it is select ​box, so you can select ​right one from list of all connected ​system +  * And now we need to select the **system** we want to compare ​the values with. There is select ​menu so you can select one from list of all connected ​systems. 
-  * **Attributes** - we need identificators of mapped attributes separated by comma. Scripts in transformation are applied too. +  * **Attributes** - we need identificators of mapped attributes separated by comma. Scripts in transformation are applied too. 
-  * **Mapping** - we need ID of mappingwhere theese ​attributes are defined.+  * **Mapping** - we need the ID of the mapping where these attributes are defined.
   * **Treenode** - you will select identities in this organization and identities in child organizations   * **Treenode** - you will select identities in this organization and identities in child organizations
-  * **Identities** - fill identities or Treenode. Treenode will select ​bunch of identities, Identities  ​is select box and it is convinient using a few identities. +  * **Identities** - select identities. There is select box and it is convenient if you want a report for only a few identities. 
-  * These ID'​s ​can be found tables with IdM in development stage or in Audit. But we will show you the easiest way to get that ID's+  * These IDs can be found in tables with IdM in development stage or in Audit. But we will show you the easiest way to get those IDs.
 {{ :​tutorial:​adm:​comparereport_02.png |}} {{ :​tutorial:​adm:​comparereport_02.png |}}
  
-  * Click on tab **Systems** and select system ​with wich you want to compare values, and click on '​magnifying glass' button. It will open detail of that system.+  * Click on tab **Systems** and select ​the system ​whose values ​you want to compare ​the values ​to, and click on the '​magnifying glass' button. It will open detail of that system.
  
 {{ :​tutorial:​adm:​comparereport_03.png |}} {{ :​tutorial:​adm:​comparereport_03.png |}}
  
   * Click on tab **Mapping**   * Click on tab **Mapping**
-  * There are attributes mapping, ​could there be more, specifically for synchronization,​ but rather ​select one for provisoning+  * You will see attributes mapping, there could be more than one, specifically for synchronization,​ but select one for **provisioning**
-  * Click again on '​magnifying glass' button.+  * Click again on the '​magnifying glass' button.
  
 {{ :​tutorial:​adm:​comparereport_04.png |}} {{ :​tutorial:​adm:​comparereport_04.png |}}
  
-  * Now you have open attribute mapping and in URL of your browser ​id ID of your selected mapping. ​On picture bellow ​there is shown where you can find thaht ID and copy it.+  * Now you have to open the attribute mapping and in the URL of your browser ​find the ID of your selected mapping. ​In the picture bellow ​it is shown where you can find that ID and copy it.
  
 {{ :​tutorial:​adm:​comparereport_05.png |}} {{ :​tutorial:​adm:​comparereport_05.png |}}
  
-  * On lower part of this page there are your mapped attributes, select one and click again on '​magnifying glass' button.+  * In the lower part of this page you will see your mapped attributes, select one and click again on '​magnifying glass' button.
  
 {{ :​tutorial:​adm:​comparereport_06.png |}} {{ :​tutorial:​adm:​comparereport_06.png |}}
  
-  * ID of this attribut is again in URL in your browser, copy it somewhere too. +  * ID of this attribut is again in the URL in your browser, copy it somewhere too. 
-  * You can copy more ID'​s ​of attributes from same mapping.+  * You can copy more IDs of attributes from same mapping.
  
 {{ :​tutorial:​adm:​comparereport_07.png |}} {{ :​tutorial:​adm:​comparereport_07.png |}}
  
-  * If you want get ID of tree node, click on **Organization** and on tab **Structure elements** click on '​magnifying glass' button of one of shown tree nodes.+  * If you want get an ID of tree node, click on **Organization** and on the tab **Structure elements** click on the '​magnifying glass' button of one of the shown tree nodes.
  
 {{ :​tutorial:​adm:​comparereport_11.png |}} {{ :​tutorial:​adm:​comparereport_11.png |}}
  
-  * Again in URL there is ID of that organization node.+  * Again in URL there is an ID of that organization node.
  
 {{ :​tutorial:​adm:​comparereport_12.png |}} {{ :​tutorial:​adm:​comparereport_12.png |}}
  
-  * Now we have all necessary ​ID's, so we return to creating new '​Compare values in IdM with values in system'​ +  * Now we have all the necessary ​IDs, so we can return to creating new '​Compare values in IdM with values in system' ​report 
-  * Select System (the right onewhich has the mapping we used) +  * Select System (the one which has the mapping we used) 
-  * Write in ID'​s ​of attributes as in picture bellow (seperated by comma)+  * Write in IDs of attributes as in the picture bellow (seperated by comma)
   * Past Mapping ID   * Past Mapping ID
-  * You can past tree node or as in our example select a fet identities.+  * You can pass a tree node or as in our example select a few identities.
   * Click on **Generate report**   * Click on **Generate report**
  
 {{ :​tutorial:​adm:​comparereport_16.png |}} {{ :​tutorial:​adm:​comparereport_16.png |}}
  
-  * Now report is generating, it could take a few minutes, based on how many attributes and how many identities are selected. +  * Now the report is generating, it could take a few minutes, based on how many attributes and how many identities are selected. 
-  * And then there is completed ​report, ​which can be downloaded xlsx or in json. Rather use xlsx version.+  * Once the report ​is generatedit can be downloaded ​in xlsx or in json. Use the xlsx version, the json contains raw data.
  
 {{ :​tutorial:​adm:​comparereport_14.png |}} {{ :​tutorial:​adm:​comparereport_14.png |}}
  
-  * Example of report you can see bellow. +  * You can see an example of the report ​bellow. 
-  * It shows status in first column, ​if identity has different selected attributes and Username ​in second. This is by default and it cannot be changed. +  * It shows status in first column, ​whether the identity has different selected attributes and username ​in the second ​column. This is by default and it cannot be changed. 
-  * Next are attributes we selected.+  * Next are the attributes we selected.
   * For single value attributes:   * For single value attributes:
-   * If value is blue, it means in system and in IdM it is same. +   * If value is blue, **it means the value in the system and in IdM is the same**
-   * Otherwise it will write in green '​IdM:​value'​ and in red '​System:​value'​ (column phone in picture ​bellow)+   * Otherwise it will write in green '​IdM:​value'​ and in red '​System:​value'​ (for example see the column phone in picture ​below)
   * Multivalued attributes are not supported yet, only multivalued attributes with merge strategy (it is often used with Active Directory system for provisioning of membership - ldapGroups)   * Multivalued attributes are not supported yet, only multivalued attributes with merge strategy (it is often used with Active Directory system for provisioning of membership - ldapGroups)
-   * Blue values are same in IdM and in system +   * Blue values are the values which are the same in IdM as in the system 
-   * Red values are missing in IdM and are in System +   * Red values are values ​missing in IdM which are present ​in system 
-   * Green values are in IdM and are missing in System+   * Green values are the values which are present ​in IdM but missing in the system
    
 {{ :​tutorial:​adm:​comparereport_15.png |}} {{ :​tutorial:​adm:​comparereport_15.png |}}
  
 ====Override script==== ====Override script====
-If you write new script ​and want to change the current one, but it is in production. You can use this report, so you can be sure nothing bad happens. You can make report with the attribute and different script. ​Report ​will compare value transformed with this new script and value stored in system and you will have confirmation about changes that would happen.+If you write new script ​or want to change the current one, but you are in the production ​environment,​ you can use this report ​to be sure nothing bad happens. You can make report with the attribute and different script. ​The report ​will compare value transformed with this new script and value stored in system and you will have confirmation about the changes that would happen.
  
   * Click on **Setting** and **Script definitions** and click on **Add**   * Click on **Setting** and **Script definitions** and click on **Add**
Line 89: Line 88:
 {{ :​tutorial:​adm:​comparereport_09.png |}} {{ :​tutorial:​adm:​comparereport_09.png |}}
  
-  * You need here call that new script, which will override the current one. You can generate it in mapped ​attribut ​or copy existing one and and edit it. So write in call of that new script. +  * Here you need to call that new script, which will override the current one. You can generate it in the mapped ​attribute ​or copy existing ​the one and edit it. So write in the call for that new script. 
-  * Let it in Standard category.+  * Leave it in Standard category.
   * Write in description something like 'this script is used in report'​.   * Write in description something like 'this script is used in report'​.
-  * write code and script name.+  * Write the code and the script name.
   * Click on **Save and continue**.   * Click on **Save and continue**.
  
Line 98: Line 97:
  
   * Again fill in System and mapping ID's   * Again fill in System and mapping ID's
-  * Fill in attributes ID'​s, ​but after attribute IDwhich you want override script, write colon and code of script like ID:​newScriptCallScript (look bellow on picture)+  * Fill in attributes ID but after attribute ID which you want to override ​in the script, write colon and code of script like ID:​newScriptCallScript (look below for example)
  
 {{ :​tutorial:​adm:​comparereport_13.png |}} {{ :​tutorial:​adm:​comparereport_13.png |}}
  
-Thank you for reading this tutorial and I hope this tutorial and report is useful ​for you.+Thank you for reading this tutorial and I hope this tutorial and report is useful ​to you.