Using the scheduled contact importer

This is an additional feature that needs to be enabled

If you don't have it, please contact us to discuss your requirements.

Overview

Whereas you can upload contacts using our manual import process, it has its limitations - for example, a maximum file size of 10MB. Alternatively, you can use the scheduled contact importer with which to upload your contacts. 

It allows you make use of our hosted and secure SFTP server to upload your data to, automate file importing via a set schedule of your choice, and in turn allows for larger file sizes to be uploaded. It's the tool to use if you're looking to upload large amounts of data.

SFTP (SSH File Transfer Protocol, also know as Secure File Transfer Protocol) is an established network protocol that enables secure file transfer capabilities across a data stream, using secure shell.

Download an SFTP client

To use the scheduled contact importer, you'll need to download an SFTP client in order to connect to our SFTP server.

There are a few options we can suggest, but there are more should you wish to explore other options:

• Cyberduck
• Filezilla
• WinSCP - please ensure that the temporary filename transfer option is disabled when using the WinSCP client

Create an SFTP user

You'll next need to create an SFTP user with which to authenticate your connection to our SFTP server. In the settings menu, go to Access > SFTP users and click on New user.

The email address is generated for you as it must be unique to ensure results generated are correct.

You can add a description, in order to distinguish multiple users should you need to.

You'll need to enter a password and confirm it.

Check the user is enabled and then click Save to create it.

Your SFTP users are listed under 'SFTP users', where they can be edited and deleted. Above your SFTP endpoint is confirmed, which is region-specific.

Steps to schedule an import task

1. Go to Contacts > Scheduled tasks to access the 'Scheduled tasks' page.
   
   Click on Add new to add a scheduled task. 
   
2. Select an address book to import your contacts into and then click Next. 
   
   
3. The next screen prompts you to upload a file to our SFTP server via your SFTP client. You'll note that a folder path will have been created on the server for you. 
   
   
   
   Connect to your chosen SFTP client using the SFTP user credentials that you created.
4. In making a connection, you'll be asked for our SFTP server name and the port, which is 22.
5. Once connected, upload a file into the folder that's been created for you.
6. Once your SFTP client confirms the successful upload of the file, return to the 'File' screen again in the app.
   
   Accepted file formats are Excel, CSV, TXT and ZIP.4.
7. On the 'File' screen, open the 'SFTP file' drop-down menu and select the uploaded file on the SFTP server. If it's not showing yet, try clicking the Refresh icon. 
   
   
   
   Select the appropriate encoding type depending upon which foreign language character sets you're looking to support. Unicode (UTF-8) will support most languages. 
   
   You have the option to add an email address to notify when your import is finished.
   
   You'll need to enter a name to associate with the scheduled task.
   
8. Once happy, click Next.
9. Next, you'll need to map the file columns to the appropriate contact data fields. This is the same mapping process as when manually importing a file.
   
   For more on mapping file columns to contact data fields, read Importing contacts into an address book.
   
   Once happy with the mapping, click Next.
10. Finally, choose the frequency with which you'd like to schedule the importing of your contact files. Any files that are present in the SFTP folder path will be included each time the import runs.
    
    
    
    You can choose:
    
• Hourly - and set the minutes past the hour that the import runs
• Daily - and set the time of day the import runs
• Weekly - and select a day or number of days of the week, along with setting the time of day, the import runs

Once happy, click Save schedule.

You'll be taken back to the 'Scheduled tasks' page where confirmation is given that your schedule has been saved, along with when it will run. 

All scheduled tasks are listed on this page.

Information

After contacts have been imported, files are deleted from our SFTP server.

Managing scheduled tasks

You can manage your scheduled tasks on the 'Scheduled tasks' page.

It provides the following details on any scheduled task that has been set up:

• The name of the scheduler
• The folder path of the scheduled task (the source)
• The source type 
• The destination type
• The scheduled task's status, which can be 'Active', 'Draft' or 'Running'
• The date the scheduled task was last modified
• The date the scheduled task was created

You can delete scheduled tasks by ticking them and clicking Delete.

You can edit a scheduled task by clicking on the Edit icon next to it. This enables you to change elements such as the address book to upload to, the encoding type, the email address to notify, the scheduler's name, the mappings and the schedule settings.

Reporting

To view reporting on your scheduled task, click on the Reporting icon. 

Reporting provides details on the number of contacts imported and the status of the import (e.g. whether it's failed, pending or running).

Information

Your completed scheduled imports are stored in Contacts > Advanced features > Import history for 30 days, just as manual imports are.