The content is currently unavailable in French. You are viewing the default English version.
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
The userfileExecute command performs user import file–related administrative operations. User import files are comma-separated text file (.csv) that are used to import user accounts in bulk to the database.
Table: userfileExecute commands
Command
Description
USERFILECMD_IMPORT_FILE
Processes user import data previously uploaded from a user import file (see USERFILECMD_IMPORT_FILE).
The user import file must be uploaded first using one of the supported upload commands:
userfileuploaddime
userfileuploadmime
userfileuploadmtom
USERFILECMD_QUERY_STATUS
Returns the status of a server task that has been previously started via the USERFILECMD_IMPORT_FILE operation(see USERFILECMD_QUERY_STATUS).
USERFILECMD_STOP_IMPORT
Stops a server task that has been previously started via the USERFILECMD_IMPORT_FILE operation (see USERFILECMD_STOP_IMPORT).
The following field attributes are available for the operations of this command:
Table: userfileExecute field attributes
Attribute name
Data type
Description
USERFILEFLD_ASSIGN_DP
Boolean
Determines whether to assign authenticators after a user account has been created.
Default value: false
USERFILEFLD_CACHE_ID
String
The unique identifier of the uploaded user import file generated by the respective upload operations.
Up to 255 characters.
USERFILEFLD_CREATE_NEW_ACCOUNT
Boolean
Determines whether to create new user accounts when they are imported.
Default value: true
USERFILEFLD_ENABLE_NEW_ACCOUNT
Boolean
Determines whether to enable new user accounts when they are created.
Default value: true
USERFILEFLD_ERROR_LIST
attributes
Errors returned
USERFILEFLD_GRACE_PERIOD_DAYS
Integer
The grace period in days for the user accounts created from the user import file.
Default value: 7
USERFILEFLD_NOTIFY
String
The notification delivery method to notify the user on completion of the task. The required contact information must be defined in the respective user account.
Email
SMS
USERFILEFLD_RETURN_ERROR
Boolean
Indicates whether to return errors or not.
Default value: false
USERFILEFLD_SCHEDULE_DATE
String
The scheduled date if scheduled with USERFILEFLD_SCHEDULED.
Format: DD/MM/YYYY
Example: 20/07/2013
USERFILEFLD_SCHEDULE_TIME
String
The scheduled time of the day to execute the task if scheduled with USERFILEFLD_SCHEDULED.
Format: hh:mm
Use 24-hour time. For example: 21:00
USERFILEFLD_SCHEDULED
Boolean
Determines whether the respective task is scheduled.
Default value: false
USERFILEFLD_SHOW_ASSIGN_DP
Boolean
Show assign authenticator options after the file has been uploaded. Used by Web Administration Service.
USERFILEFLD_SHOW_PASSWORD_OPTION
Boolean
Used by Web Administration Service.
USERFILEFLD_TASK_DESCRIPTION
String
USERFILEFLD_UPDATE_ACCOUNT
Boolean
Determines whether existing user account should be updated with the import data.
Default value: false
USERFILEFLD_UPDATE_STATIC_PASSWORD
Boolean
Determines whether to update the static password if the user account already exists.
Default value: false
USERFILEFLD_USER_FILE_NAME
String
The name of the uploaded user file.
Up to 255 characters.
USERFILEFLD_USERS_FAILED
Integer
The total number of user import failures.
USERFILEFLD_USERS_IMPORTED
Integer
The total number of user already imported.
USERFILEFLD_USERS_READ
Integer
The total number of users already read and processed.
USERFILEFLD_USERS_TOTAL
Integer
The total numbers of users found in the user import file.
USERFILECMD_IMPORT_FILE
Processes user import data previously uploaded from a user import file referred by the USERFILEFLD_CACHE_ID attribute.
The following attributes can be specified in the attributeSet input parameter of this command:
