...
IsTestMode: Itdefines whether the user Importer is in a test mode or not.
CsvDelimiter: This attribute is optional and if not set the default delimiter (,) is used. (i.e. '|' for CCL)
ImportFilePath: This path links to the file path that the customer will drop the new user files to be uploaded and processed.
ImportFileBackupPath: Location where CSVs will be moved after processing is completed.
SchedulePeriod: Schedule period in seconds.
PollingInterval: This defines an interval an Integrator will poll to check if it should do work. If unset, it will default to 5 minutes.
CsvTranslations: To Get translations from csv column to user property (used for collecting data).
ExternalId: This is used to uniquely identify Integrators externally (i.e. while calling through API), This must be unique across integrators of an organization.
Followings are the available user scaler properties:
Deactivate (X): If the column DeactivateX (aka ‘Deactivate (X)’) exists, leaving the value empty (‘’) would reactivate a user. Use ANY value for DeactivateX to deactivate a user.
OrgLoginId: is optional, Don't update if empty. This is unique within an Organization.
Password: if the user already exists and left empty - the password is not updated
FirstName: will not be updated if empty
LastName: will not be updated if empty
EmailAddress: will not be updated if emptyContactEmail: will not be updated if empty
ForcePasswordChange: 'True' or 'False'. Anything not 'True' (e.g. empty) for new users will be interpreted as 'False'. For updates, will not be updated if not 'True' or 'False'.
CanViewReports: 'True' or 'False'. Anything not 'True' (e.g. empty) for new users will be interpreted as 'False'. For updates, will not be updated if not 'True' or 'False'.
*Along with these scaler properties all active OPF fields can be used in translation.
Sample CsvTranslations:
"OrgLoginId=UniqueUserID,FirstName=FirstName,LastName=LastName,Password=DateOfBirth,ContactEmail=PersonalEmailAddress,Deactivate (X)=Deactivate (X)"
Here Left side of '=' sign is the MLS user property and right side is the csv column name.
[MLS user property]=[csv column name]
...
| Code Block |
|---|
AddNavPageAttribute /Root/NI System.Customer.NIUserCsvIntegrator.IsTestMode True
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.CsvDelimiter ","
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.ImportFilePath "E:UserImporter\incomingFile\incomingFile"
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.ImportFileBackupPath "E:UserImporter\incomingFile\backupFile"
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.SchedulePeriod "1"
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.PollingInterval "1"
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.CsvTranslations "OrgLoginId=UniqueUserID,FirstName=FirstName,LastName=LastName,Password=DateOfBirth,ContactEmail=PersonalEmailAddress"
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.UserImportMode "Partial"
AddNavPageAttribute /Root/NI System.Customer.Integrator.NIUserCsvIntegrator.ExternalId "ExternalId1" |
User Integrator Config
User importer is configured using a JSON file (i.e UserIntegratorConfigFile.json). It has multiple sections which are called activities. Every configured activity is being executed in order (can’t be changed via configuration). The order the activities are executed is the order this document describes the activity configurations.. Every section is described below, also a sample configuration file is attached.
...