Configuration Manager - Import
The "Import" is where the global business rule xml file is uploaded. The file contains rules that are processed each time a user is created or saved when editing. The file is in xml format and a validation against XSD file set on saving determines if the uploaded file is valid. Rules conditions are based on user profile attribute values with command rules for group assignments, job profile assignments, client assignments, granting clearance to users, and setting attribute values. These rules can be quite advanced and are normally managed by imc consultants or support agents. Business rules can also be uploaded in the "Clients > Setting tab" and if so will override the global rules for that client. An important note is that if a SCIM interface is used the global rule files will be read as SCIM is not client-specific. Settings here are used to configure the user/group import.
Description
Setting | What does the setting do? |
|---|---|
Registration rules | A rules file is an XML file that contains rules used when processing user profiles. If a rules file is uploaded, these rules are read every time a user is imported and/or updated. If a rules file is uploaded for the client, the rules from the client are used. |
Show external IDs | |
Delete import folder content | This field when ticked/true will delete old group import files from the content server data folder. |
Logfile directory path | Path designation for the directory in which log files are logged when there are changes to target group properties. If the value is not available, audiencesnapshotlog is used. |
CSV import | |
Enable Import Wizard | Determines whether the user can import people from the profile data source specified via the import wizard in the LMS. Ticked/True: The profile data source specified is listed in the selection box for the possible import sources of the import wizard. Unticked/False: The profile data source specified cannot be selected as an import source in the import wizard. |
Scheduled import | Determines whether the specified data source can be used for the automatically scheduled user import. |
Implement as user | Determines under which LMS user account the scheduled user import is executed. |
CSV Identifier Attribute | People profile attribute as a field of the PERSON table, which will be used in the specified profile data source to identify a person. |
CSV Import log | |
Log file name prefix | |
Relative upload path | |
Save as ZIP file | |
Field separator | Indicates the character string for the field separation in the rows of a CSV file. The character string TAB indentifies the tab character. |
CSV encoding | Determines the character set coding that LMS uses when creating CSV files for the export of reportsISO-8859-1: The import files are coded ISO-8859-1.UTF-8: The import files are coded UTF-8. |
Person Import | |
Default data source reference | Determines the default people profile data source for the registration of people. |
Check identifier uniqueness | Defines if system wide uniqueness of the source specific person identifiers will be checked of not when registering or updating. Ticked/True: When registering via a profile data source, no personal id will be permitted if it has already been assigned to other users in LMS. Unticked/False: Personal identifier does not need to be unique over multiple profile data sources. |
Delete folder content | This setting when ticked will delete all user import source files when a user is deleted. |
Max number of errors | Number of errors that will terminate the import process as defined in the parameter Break Error Level. |
Break error level | Defines how severe errors have to be for them to affect the cancellation of the import process. |
CSV User Import
Setting | What does the setting do? |
|---|---|
Import ID | To define different user import for the same import source. |
Separator for import data | Indicates the character string for the field separation in the rows of a CSV file. The character string TAB indentifies the tab character. |
Relative upload path | Relative path to the source file. Referenced is the current data directory of the LMS server. The default path for file delivery and pick up on the content server will be “/person/personimport/csv”. |
Synchronisation of the import | Determines whether all people not imported in the LMS will be switched to passive after importing people from the specified source. true: All users not included in the current import process will automatically be switched to passive.false: The profiles of users not included in the import process will remain unchanged. |
Deactivate unclear users | Defines if a person to be imported will be set to passive when their external identifier in the third-party source is ambiguous. |
Delete folder content | If ticked (true), when a user is deleted the import file located in the path configured "Relative upload path" will be deleted. This prevents re-importing the deleted user with the same current file, but if a source system sends another file with the same record it will be re-created. |
Ignore unmapped fields | Determines whether all source fields specified by mapping elements will be expected and imported in the imported file. true: The attributes transferred in the import source for which no mapping is defined will be ignored. false: If an attribute which is transferred with the imported data does not have any mapping defined, an exception will be generated. |
Is Reference | Determines whether all source fields specified by mapping elements will be expected and imported in the imported file. Ticked/true: The mapping elements determine which fields will be imported. Additional columns found in the import file will be ignored, if the “Ignore unmapped fields” is set to "true". Unticked/false: Only the columns found in the import file will be imported. Additional attributes specified by mapping elements will be ignored. |
Import data | Specify the CSV file to be imported here. |
File name | Name of the file which should be imported |
Absolute | The attribute “Absolute” defines if the csv import file path is absolute or relative in the data folder. If the import file is to be located in the data folder of the system, this value is to unticked (false) meaning a relative path is used. |
Encoding | Determines the character coding of the import files. |
XML Group Import
Settings
Setting | What does the setting do? |
|---|---|
Import Settings | Configuration of the Business Unit (BU) group import for an XML file interface. |
Base Group | Determines the group under which the imported group structure will be saved. Hint: One group can only be configured one time. If one group has been set multiple times import is not possible.I |
Import Folder | Indication of the directory in which the files are saved during the import process. A complete network path specification must be executed. |
FIle name | Determines the name of the XML file to be uploaded to the LMS server. The BU XML interface job will look for and process with the matching name. |
Scheduler integration | Configures the automatically scheduled import via the data source specified. |
Execution Person | Determines under which LMS user account the scheduled import is executed. |
Delete folder content | This setting when ticked will delete all user import source files when a user is deleted. |
Logfile settings | Specify the CSV file to be imported here. |
CSV encoding | Prefix for log file names. |
Relative upload path | Relative path to the source file. Referenced is the current data directory of the LMS server. |
Save as ZIP file | Indicates if the log file is saved as a zip file. |
Field separator | Indicates the character string for the field separation in the rows of a CSV file. The character string TAB indentifies the tab character. |
Log File Attributes | |
Action | Action that has taken place with the import for each group. |
Name | Name of the group in the import file that is being created, updated or deleted. |
Status | Status of the group in terms of being Active or Inactive. |
ExtID | Unique ID of the group as per the source system. |
Import Attributes
Setting | What does the setting do? |
|---|---|
Name | The Name of the group must always be provided in an import file. |
External ID | The External ID is always required in an import file for each group entry. |
Type of role | The role refers to whether the imported groups will be created as “Standard” or “Content administration” groups. |
Active | The role refers to whether the imported groups will be created as “Standard” or “Content administration” groups. |
Default value | Possible values are STANDARD and CONTENTADMIN |
Group code | Enables populating the “Group code” field of a BU group. This is an optional field and can be used as an import attribute. |
Description | The Description of the groups is optional and is therefore optional to add the attribute to the import file. |
Status | The Status is used to determine if the imported groups are Active or Inactive. As a Default value can be populated the inclusion of the attribute in the import file is optional. |
Active | Will only be considered when the checkbox is marked |
Default value | Possible values are ACTIVE and INACTIVEPossible values |
Functions | The Functions attribute can be added to the import file to provide the created groups privileges in the LMS; E.g. HR, TUTOR, CORRECTOR, MODERATOR, ADMIN, SUPERUSER, TRANSLATIONADMIN. |
Active | Will only be considered when the checkbox is marked |
Substitution mode | Possible values are DEFAULT and EMPTY |
Expiration | The Expiration allows adding an optional attribute for an End Date in the import file to automatically deactivate groups. |
Active | Will only be considered when the checkbox is marked |
Default value | e.g 2010-10-10 |
Substitution mode | Possible values are DEFAULT and EMPTY |
Start | The Start allows adding an optional attribute for a Start Date in the import file to automatically activate groups or indicate when formed. |
Active | Will only be considered when the checkbox is marked |
Default value | e.g 2010-10-10 |
Substitution mode | Possible values are DEFAULT and EMPTY |
Users | The Users setting allows adding an optional attribute to directly assign users to groups via the XML group import file. When enabled the attribute used for user assignment is defined the XML file from LOGIN, PERSON_ID, EXT_ID_CSV, EXT_ID_LDAP, EXTERNAL_ID, EXTERNAL_SYSTEM_ID and EMAIL. |
Active | Will only be considered when the checkbox is marked |
Substitution mode | Possible values are DEFAULT and EMPTY |
Supervisors | The Supervisors setting allows adding an optional attribute to directly assign users to groups as Supervisors via the XML group import file. When enabled the attribute used for user assignment is defined the XML file from LOGIN, PERSON_ID, EXT_ID_CSV, EXT_ID_LDAP, EXTERNAL_ID, EXTERNAL_SYSTEM_ID and EMAIL. |
Active | Will only be considered when the checkbox is marked |
Substitution mode | Possible values are DEFAULT and EMPTY |
Deputies with access | The Deputies with access setting allows adding an optional attribute to directly assign users to groups as Deputies of the Supervisors via the XML group import file. When enabled the attribute used for user assignment is defined the XML file from LOGIN, PERSON_ID, EXT_ID_CSV, EXT_ID_LDAP, EXTERNAL_ID, EXTERNAL_SYSTEM_ID and EMAIL. |
Active | Will only be considered when the checkbox is marked |
Substitution mode | Possible values are DEFAULT and EMPTY |