Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
tutorial:adm:roles_-_import_data_from_csv [2019/07/17 06:26]
doischert 		tutorial:adm:roles_-_import_data_from_csv [2019/08/05 11:17]
doischert
Line 3: Line 3:
 ==== 1. Prepare the CSV file ==== ==== 1. Prepare the CSV file ====
  
-Here is an example of a CSV file which can be used for importing (or updating) roles, setting their role attributes, guarantees (by user, or by role) and criticality and for saving them in a created catalogue. To use this CSV file, create a new identity with user name "user_login", and a new role with code "role_code".+Here is an example of a CSV file which can be used for importing (or updating) roles, setting their role attributes, guarantees (by user, or by role) and criticality, for saving them in a created catalogue and for assigning their subordinate role. To use this CSV file, create a new identity with user name "user_login", and a new role with code "role_code".
  
 <code> <code>
-roles;description;attribute;guarantees;guarantee role;criticality;catalogue +roles;description;attribute;guarantees;guarantee role;criticality;catalogue;subroles 
-Manager-A;Leader;;;;; +Manager-A;Leader;;;;;;role_code 
-LAY-SP;Manager;attr1;user-login;role_code;3;cat4+LAY-SP;Manager;attr1;user-login;role_code;3;cat4;
 "CORE-CLOSE "CORE-CLOSE
 AB-role";desc;attr1;;;2;"cat1 AB-role";desc;attr1;;;2;"cat1
-cat3"+cat3";
 </code> </code>
 +
 +In Excel, it looks like this:
 +{{ :tutorial:adm:00_csv.png?direct&600 |}}
  
 As you can see roles column can contain single or multiple values (separated by a line; the separator can be specified in the settings of the LRT). For multivalued roles, values from the same row will be added to every role. The only exception here is role criticality which cannot be multivalued. As you can see roles column can contain single or multiple values (separated by a line; the separator can be specified in the settings of the LRT). For multivalued roles, values from the same row will be added to every role. The only exception here is role criticality which cannot be multivalued.
Line 18: Line 21:
  
 The result of this LRT used with this CSV file should: The result of this LRT used with this CSV file should:
-  * 4 new roles (Manager-A, LAY-SP, CORE-CLOSE, AB-role) +  * 4 new roles (Manager-A, LAY-SP, CORE-CLOSE, AB-role). 
-  * Manager-A will only have a description set (Leader)+  * Manager-A will have a description set (Leader) and a subrole set (role_code). 
 +  * 
   * LAY-SP will have a description (Manager), attribute (attr1), criticality (3), guarantee by identity (with user-name "user-login"), and guarantee by role (with role-code "role_code") set. It will be saved in catalogue cat4.   * LAY-SP will have a description (Manager), attribute (attr1), criticality (3), guarantee by identity (with user-name "user-login"), and guarantee by role (with role-code "role_code") set. It will be saved in catalogue cat4.
   * Roles CORE-CLOSE and AB-role will have a description (desc), an attribute (attr1), and criticality (2) set. They will be in catalogues cat1 and cat3.   * Roles CORE-CLOSE and AB-role will have a description (desc), an attribute (attr1), and criticality (2) set. They will be in catalogues cat1 and cat3.
Line 41: Line 45:
 - Column with guarantee - name of the column with role guarantee by identity login, can be also used to update guarantee (if your CSV file doesn't contain guarantees, i.e., you are not setting guarantees for any of your roles, leave this line empty) - Column with guarantee - name of the column with role guarantee by identity login, can be also used to update guarantee (if your CSV file doesn't contain guarantees, i.e., you are not setting guarantees for any of your roles, leave this line empty)
 - Column with guarantee role - name of the column with role guarantee by role code, can be also used to update role guarantee (if your CSV file doesn't contain role guarantees, i.e., you are not setting role guarantees for any of your roles, leave this line empty) - Column with guarantee role - name of the column with role guarantee by role code, can be also used to update role guarantee (if your CSV file doesn't contain role guarantees, i.e., you are not setting role guarantees for any of your roles, leave this line empty)
-- Column with catalogue names - name of the column with catalogue names, can be also used to update role guarantee (if your CSV file doesn't contain role guarantees, i.e., you are not setting role guarantees for any of your roles, leave this line empty)+- Column with catalogue names - name of the column with catalogue names, can be also used to update catalogue names (if your CSV file doesn't contain catalogue names, i.e., you are not setting catalogues for any of your roles, leave this line empty) 
 +- Column with subroles to be assigned - name of the column with subordinate roles codes, can be also used to update subordinate roles (if your CSV file doesn't contain subordinate roles codes, i.e., you are not setting subordinate roles for any of your roles, leave this line empty)
 - Form definition code - the code for the definition which will contain the added attributes (you only have to fill this if you are setting attributes) - Form definition code - the code for the definition which will contain the added attributes (you only have to fill this if you are setting attributes)
 - Column separator - separator of columns in csv file (default ; ) - Column separator - separator of columns in csv file (default ; )
 - Multi value separator - (Char, default: new line) separator of multi valued role names in the csv file, new line separator is default export from excel, but for better clarity of the csv file, it's recommended to use some symbol instead - Multi value separator - (Char, default: new line) separator of multi valued role names in the csv file, new line separator is default export from excel, but for better clarity of the csv file, it's recommended to use some symbol instead
-- System name - name of the system to connect with roles; optional +- System name - name of the system to connect with roles (if you do not want to connect your roles to any system, leave this line empty) 
-- MemberOf attribute name - name of multi valued attribute for merge; optional +- MemberOf attribute name - name of multi valued attribute for merge; (if you do not want to do that, leave this line empty) 
-- Can be requested - (Boolean) - Roles can be requested, can be also used to update already imported settings; it allows not selecting value when updating (not when creating!) roles which will not change the can be requested property of roles.+- Can be requested - (Boolean) - Roles can be requested, can be also used to update already imported settings; it allows not selecting value when updating (not when creating!) roles which will not change the Can be requested property of roles. When creating roles, either Yes or No must be selected.
  
 <note important>If you are updating the roles, make sure to set the same form definition the role already have (if they have any). Also, each role can only have one definition, so if you by mistake set a different definition in the LRT configuration, you will likely get an error. Generally, DO NOT use this LRT to change the definition of a role. You can only change the definition if the role has no attributes set yet.</note> <note important>If you are updating the roles, make sure to set the same form definition the role already have (if they have any). Also, each role can only have one definition, so if you by mistake set a different definition in the LRT configuration, you will likely get an error. Generally, DO NOT use this LRT to change the definition of a role. You can only change the definition if the role has no attributes set yet.</note>
Line 58: Line 63:
 ==== Run the task ==== ==== Run the task ====
  
-Now we just need to hit run.+Now we need to hit run.
  
 {{:tutorial:adm:aaaaaaaa6.png?100|}} {{:tutorial:adm:aaaaaaaa6.png?100|}}
  
 Now we must go to the "all tasks" panel, select the newly created LRT (check the checkbox), click Operation with selected record and Run selected task. Now we must go to the "all tasks" panel, select the newly created LRT (check the checkbox), click Operation with selected record and Run selected task.
 +
 +{{ :tutorial:adm:05_start.png?direct&1200 |}}
  
 You can also check the status of the created roles there in the task detail. Here you can find information about roles created, updated, or already existing. You can also check the status of the created roles there in the task detail. Here you can find information about roles created, updated, or already existing.
  • by apeterova