Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
tutorial:adm:roles_-_import_data_from_csv [2019/06/10 11:22] hanakp [Fill all attributes] |
tutorial:adm:roles_-_import_data_from_csv [2020/06/15 07:21] doischert |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Roles - Import of data from CSV ====== | ====== Roles - Import of data from CSV ====== | ||
- | ==== Prepare CSV file ==== | + | ==== 1. Prepare |
- | Here is an example of CSV file which can be used for import | + | Here is an example of a CSV file which can be used for importing (or updating) |
< | < | ||
- | roles; | + | roles;code; |
- | Manager;Some role description | + | Manager-A;Manager-A; |
- | " | + | LAY-SP;LAY-SP; |
- | PAY-OP | + | "CORE-CLOSE |
- | PAY-SP | + | AB-role";; |
- | PAY-BLL | + | cat3";; |
- | AMT-BLK | + | |
- | ACC-CLOSE"; | + | |
</ | </ | ||
- | As you can see roles column can be single or multivalued. For multivalued roles, | + | In Excel, it looks like this: |
- | CSV file can have optional number of columns, role and description columns | + | {{ : |
+ | |||
+ | As you can see roles column can contain | ||
+ | CSV file can have optional number of columns: column names are specified in setup of LRT. | ||
+ | |||
+ | The result of this LRT used with this CSV file should: | ||
+ | * 4 new roles < | ||
+ | * < | ||
+ | * < | ||
+ | * 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. | ||
+ | |||
+ | <note important> | ||
==== Create new LongRunningTask ==== | ==== Create new LongRunningTask ==== | ||
- | Now we will create the new LongRunningTask(LRT). As shown in the picture, go to Settings → Task scheduler → Scheduled tasks and hit green " | + | Now we will create the new LongRunningTask (LRT). As shown in the picture, go to Settings → Task scheduler → Scheduled tasks and hit green " |
+ | |||
+ | {{ : | ||
==== Fill all attributes ==== | ==== Fill all attributes ==== | ||
Line 27: | Line 38: | ||
Now we need to create new LRT with these attributes: | Now we need to create new LRT with these attributes: | ||
- | - Task type - **ImportRolesFromCSVExecutor** | + | **General:** |
- | - Import csv file - dropzone to select or drop csv file | + | |
- | - Column with roles - Name of the column with roles in csv file | + | - Upload a CSV file - dropzone to select or drop csv file |
- | - Column with description - name of the column with role description, | + | - Column with role names - name of the column with roles in csv file |
- | - Column separator - separator of columns in csv file | + | - Column with role codes - name of the column with role codes in csv file; if left empty, the role code is based on the role name, only spaces are replaced by underscores |
- | - Multi value separator - ( Char, default: new line ) separator of multi valued role names in csv file, new line separator is default export from excel, but for better clarity of csv file, it's recommended to use some symbol instead | + | - Column with description - name of the column with role description, |
- | - System name - name of the system to connect with roles | + | - Column with criticality - name of the column with role criticality, |
- | - MemberOf attribute name - ( default: rights ) - name of multi valued attribute for merge, attribute | + | - Column with catalogue names - name of the column with catalogue names, can be also used to update catalogue names (if your CSV file doesn' |
- | - Can be requested - ( Boolean | + | - Column with subrole codes - name of the column with subordinate roles codes, can be also used to update subordinate roles (if your CSV file doesn' |
+ | - 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 | ||
+ | - Role environment - the name of the environment to which you want to add the role; only supported during creating, not updating 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. | ||
+ | |||
+ | **Role attributes: | ||
+ | |||
+ | - Column with role attributes - name of the column with role attributes, can be also used to update attributes (if your CSV file doesn' | ||
+ | - 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) | ||
+ | |||
+ | **Guarantees: | ||
+ | |||
+ | - 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' | ||
+ | - Column with guarantee types - name of the column with role guarantee by identity [[tutorial: | ||
+ | - Update guarantee types - check if you want to add new guarantee type to an existing guarantee (this will create a new guarantee with the selected type, the original one will still exist) (since Extras 2.2.0) | ||
+ | - 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' | ||
+ | - Column with guarantee role types - name of the column with role guarantee by role [[tutorial: | ||
+ | - Update guarantee role types - check if you want to add new guarantee type to an existing guarantee role (this will create a new guarantee with the selected type, the original one will still exist) (since Extras 2.2.0) | ||
+ | |||
+ | **System: | ||
+ | |||
+ | - 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; (if you do not want to do that, leave this line empty) | ||
+ | - MemberOf attribute value name - name of column where the value which should be used in memberOf | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | < | ||
+ | |||
+ | {{ : | ||
- | {{: | ||
==== Run the task ==== | ==== Run the task ==== | ||
- | Now we just need to hit run. | + | Now we need to hit run. |
{{: | {{: | ||
- | And we also need to process it in all tasks. | + | 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. |
+ | |||
+ | {{ : | ||
+ | |||
+ | 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. | ||
+ | |||
+ | At this point, everything should be set up and when the task ends, roles are imported in IdM with their attributes and other imported values, and placed in the catalogue named by the system name. | ||
+ | |||
+ | {{ : | ||
- | {{: | + | ==== Known issues ==== |
- | You can check status about created roles in "all tasks" panel in task detail. Here you can find information about created, updated | + | If you delete |
- | Everything should be set up so far and when the task ends, roles are imported in IdM, placed in catalogue named by system name. |