Versions Compared

Version Old Version 20 New Version Current
Changes made by

Robin Mulloy

Justin G

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
iconfalse

For clients that cannot take advantage of our User Import APIs, our FTPS SFTP Managed User Import allows you to import users into our system through an SSL enxcrypted FTP encrypted SFTP client. Any users that have failed to be imported will be put into a .csv file and sent to you by email. This file will include important user information as well as the reason for failure. 


Table of Contents

Required System Settings

Before you can use the FTPS Managed User Import you will need to have it set up on your system. However,

OPS-COM requires that our clients provide a couple of settings for the Import to work properly.

The first setting that is required for the import to work is found under under System Config followed by -> Classic System Settings. 
Image RemovedImage Added

From this window make sure that you have supplied a Reply-to Admin Email Address.

This is the system default email that receives all alerts and emails across the system. 
Image Removedaddress that appears as the sender of system-level and task-automation email messages.  
Image Added

The second setting is found under System Config , System -> System Settings followed by Third Party.
Image RemovedImage Added

From there you want to make sure that you have supplied a Failed import Import Email under the CSV User Import options.

This is the email that will be sent a file of all users that have receive the failed to be importedimport message. 

Warning

This The error message file will include information about the user as well as why the user failed to be imported.

This will allow you to correct any failures and attempt the import again. 


Image RemovedImage Added

Importing Users

OPS-COM will supply you with your FTP credentials which points directly credentials.  These credentials will connect your SFTP client to the folder where you drop you files to be imported.After you have connected using FTP the import file will be stored on the server.

If you connect with a standard client, you will see an empty directory where you will can drag and drop your import files. 

Note

OperationsCommander supports both FTPS (FTP) and SFTP (Secure Shell).

FTP Example

SFTP Manual Process

Warning

The bak folder will not exist the first time you go to upload your files. This folder is automatically generated once the import has been completed and contains all of the previously imported files. 

To begin drop a .csv

A system task is set to run at 5 minute intervals.  There may be a pause of up to 5 minutes for the import process to complete.

Once completed the file will be automatically moved to the bak folder.  This folder is created as part of the import process if the folder does not exist.


To begin drop a comma separated (CSV) file from your computer to the server. The system task can be set to run in intervals of minutes.

This can be set to 1 minute or 5 minutes for example. so you will need to wait for the import to complete.

Image Removed

Note
Please note that the your CSV file must follow the required format to be processed correctly.

Image Added

Once the import has been completed the file will be moved to the the bak folder.

An email will also be generated containing users that failed to be imported in a .csv file. This the import, and it will be sent to the email that we have set up in our System Settings. 
Image Removed

You should be able to download the generated .csv file and review why these users failed to be imported into the system. 

Example

System Settings. 

The email will describe the reasons that users failed the import.


FieldNote
unique_idRequired. Defines each unique user.
login_sourceRequired. Used in conjunction with Login Sources (SSO) for Single Sign On.
first_name
last_name
user_name
email
street
city
province
postal_code
street2
city2
state2
zip2
phone_cell
user_type_id
employ_no
employee_phone
student_no
student_phone
drivers_license_num
drivers_license_prov
data_of_birth
active

Optional. Possible values "0" (inactive) and "1" (active).

This field can be used in conjunction with a new system setting:
Image Added

When the above system setting is enabled and when a user is imported with an active column value of "0" the system will automatically archive said user and release any active permits said user may have. 

If a user is imported with an active value of 1 the user will remain active in the system and no permits they may have will be affected.

Expand
titleExample.

Before:
Image Added

After:
Image Added

Permit:

Image Added

Payment:

Image Added


Info

If a user not already existing in the system is imported with an active value of 0 the user will not be imported and an error report email (subject line "CSV Import Failed Records") will be sent to the administrator email address specified under System Settings → Third Party → CSV User Import. Said email will contain an attached CSV file that lists the users who weren't imported and the reason:

Image Added





Example User Import File

View file
nameUser Import Example.csv
height250

Related Pages

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
sorttitle
cqllabel in ( "ftp" , "ftps" , "sftp" , "import" , "importing" ) and space = currentSpace ( )


Show if
special@authenticated


Support Agent Notes
  • We would need to set this up on the clients system to work before creating an FTP SFTP account. 
  • FTP SFTP accounts must be created in order to upload the .CSV files. 
  • The user import takes about a minute to work 
  • There are some system settings required for this to work (See article). This is only set up for Palm Beach and JCU currently and we would need to set it up for anyone who wants this. 
  • If the System Setting for Failed Import Emails is not set or the email template for Failed Import Notification CSV Import Failed Records is missing, then any errors on imports will not notify the admin.