Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
tutorial:adm:roles_-_import_data_from_csv [2019/08/15 14:53] doischert |
tutorial:adm:roles_-_import_data_from_csv [2020/08/11 12:25] 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, | + | 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, |
< | < | ||
- | roles; | + | roles;code; |
- | Manager-A;Leader;;;;;;role_code | + | testimportrolename;testimportrolecode;desc; |
- | LAY-SP; | + | |
- | " | + | |
- | AB-role" | + | |
- | cat3"; | + | |
</ | </ | ||
In Excel, it looks like this: | In Excel, it looks like this: | ||
- | {{ : | + | {{ : |
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. | ||
CSV file can have optional number of columns: column names are specified in setup of LRT. | 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: | + | The result of this LRT used with this CSV file should |
- | * 4 new roles < | + | * description: ' |
- | * < | + | * attribute: 'attr1' |
- | * < | + | * guarantee: user with username 'user-login' |
- | * Roles CORE-CLOSE and AB-role | + | * guarantee by role: role with the code 'role_code' |
+ | * criticality: | ||
+ | * catalogue: it will be in ' | ||
+ | * it will have EAV with code ' | ||
+ | * it will create | ||
+ | |||
+ | <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 " |
{{ : | {{ : | ||
Line 36: | 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 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 | + | - Column with role names - name of the column with roles 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 | ||
- Column with description - name of the column with role description, | - Column with description - name of the column with role description, | ||
- | - Column with role attributes - name of the column with role attributes, can be also used to update attributes (if your CSV file doesn' | ||
- Column with criticality - name of the column with role criticality, | - Column with criticality - name of the column with role criticality, | ||
- | - 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 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 catalogue names - name of the column with catalogue names, can be also used to update catalogue names (if your CSV file doesn' | - Column with catalogue names - name of the column with catalogue names, can be also used to update catalogue names (if your CSV file doesn' | ||
- | - Column with subroles to be assigned | + | - 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' |
- | - 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: | + | - Multi value separator - (Char, default: |
- | - System name - name of the system | + | - Role environment |
- | - 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. When creating roles, either Yes or No must be selected. | - 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> | + | **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) | ||
+ | |||
+ | **Role EAVs:** | ||
+ | |||
+ | You can set value to multiple role EAVs. The mechanism used for this is prefixes which are followed by the order number of the column (e. g., ' | ||
+ | - Prefix of column with name of EAV attribute: Only attributes from the main role definition can be imported and they must of type SHORTTEXT. Supports update (the current value of the attribute will be overwritten if imported). | ||
+ | - Prefix of column with value of EAV attribute | ||
+ | |||
+ | **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: | ||
+ | You can set attributes at multiple systems or set multiple attributes in one system. The mechanism used for this is prefixes which are followed by the order number of the column (e. g., ' | ||
+ | - Prefix of column with system name | ||
+ | - Prefix of column with system attribute codes | ||
+ | - Prefix of column with system attribute values: The attribute has to a multivalued attribute with merge strategy set. | ||
+ | |||
+ | <note important> | ||
- | < | + | < |
- | {{ : | + | {{ : |
- | {{ : | + | |
==== Run the task ==== | ==== Run the task ==== |