Using Secure File Transfer Protocol (SFTP)
The 911Cellular system allows you to upload files to the platform in several ways, this article details each method
Prerequisites
- Generate an SSH key pair on the system you will SFTP from by running the following command:
ssh-keygen -t rsa -b 4096Press Enter at each prompt to accept the default values. If the command is not found, install OpenSSH, ensure it is added to your system PATH, then run the command again.
- Locate your public key file:
- Linux/macOS:
~/.ssh/id_rsa.pub - Windows:
C:\Users\<current user>\.ssh\id_rsa.pub
- Linux/macOS:
- Email the contents of
id_rsa.puband your public IPv4 address to support@911cellular.com with the subject lineSFTP Key. Your public key is safe to share over email or chat. Never share your private key file (id_rsa). - Support will respond with your SFTP username. Contact the support team for current response time estimates.
- If your organization restricts outbound traffic, ask your IT department to allow outbound traffic to
3.137.199.120on port22.
ssh-keygen -t rsa -b 4096Click enter to utilize the default values until complete.If you the above command is not found then you will need to install OpenSSH (ensure that it is in the path after install and the above statement should work)
- If your organization has OUTBOUND restrictions on your firewall the following entry will need to be made by your IT department
- Allow OUTBOUND traffic to 3.137.199.120 on PORT 22
Instructions
- Connect to the 911Cellular SFTP server at
3.137.199.120using your supplied username and private key (port22).- Example: "SftpUser@3.137.199.120"
- The IP Address used to connect to 911Cellular’s SFTP server must be whitelisted on our firewall. This IP address can be supplied to us through our Support Team. If you are unable to connect, see the Common Issues section below.
- Once connected, you will see multiple directories.
- The alertrecipients directory is where you should place Alert Recipient .csv files to be processed.
- The accesspoints directory is where you should place Access Point .csv files to be processed.
- The processing directory is where files that are currently being processed will be moved to. If this directory is not empty, then you know a file is being processed currently.
- The processed directory is where files that have successfully been processed will be moved to. If a file is in this directory, you can be confident that the file was processed correctly and was uploaded into the system.
- The failed directory is where files that have not been successfully processed will be moved to. If a file is in this directory, there was an issue with validation of either the file name or the contents of the file.
- There should be an accompanying -errors.txt file that will give a reason for the failure.
- There will possibly be a -warnings.txt file that will include items that should be corrected on the next attempt to ensure proper processing.
- Our system scans for files to be processed every 60 seconds. Please allow up to two minutes for your file to move into the processing directory before assuming there has been an error.
Uploading Alert Recipient Lists
Naming your file
- The name of the file specifies which group the recipients will be uploaded into.
- If the group does not exist yet, it will be created as a Private Group.
- If the group name matches a Public Group, the list will not be uploaded. Lists may only be uploaded into a Private Group.
- By default, matching of recipients in the file to existing recipients in the system is done using the Email field. If you would instead like to match recipients using the supplied Unique Identifier, append _unique to the end of your file name.
- If a recipient is matched, the recipient is updated. Otherwise the recipient will be newly created.
- Example file name to match on unique id: “Private Recipient Group Name_unique.csv”
Automatic purging of recipients
- By default, uploading a recipient list to a group will add members to the group. If existing recipients are not included in the new file, they will remain in the group.
- By appending the filename with _empty the system will first empty the recipient group before uploading. This is a convenient way of keeping your recipient groups up-to-date, without any need for manual deletion.
- Example file name to use the purge feature: “Private Recipient Group Name_empty.csv”
Uploading Access Point Lists
Naming your file
- The name of the access point csv does not matter. Access points will be uploaded to the Root Zone of the institution.
- Matching of existing access points is done using the supplied BSSID. If there is a match, the existing access point will be updated.
Setup Notifications for Failed Uploads
When an SFTP upload fails, email notification can be sent to designated recipients. To set it up:
1.Create a notifications.txt file and add the email of your recipients, separated by comma or new line.
*No space required before or after the separators. Text file should be named "notifications"
2. Move notifications.txt into the configuration folder and it's ready to be utilized whenever an unsuccessful SFTP upload occurs.
Common Issues
Unable to access the SFTP server
- Verify that the public IP address you are connecting from has been whitelisted on the 911Cellular firewall. Contact 911Cellular support and provide your IP address to have it added.
- Confirm you are connecting to the correct server:
<Your Given Username>@3.137.199.120 - Confirm you are using the correct private key associated with the public key you submitted to support.
My .csv files are failing to upload
- Check the failed folder in your SFTP directory for a file ending in
-errors.txt, which will contain the reasons for the failure. - If the file fails to upload but no
-errors.txtfile is generated, contact 911Cellular support.
My .csv files are not moving to the processing directory
- Contact 911Cellular support to report that files are not being scanned or processed.
FAQs
Can lists other than Alert Recipients and Access Points be uploaded using SFTP?
No. Currently, only Alert Recipient and Access Point lists are supported for SFTP batch upload. If you need batch upload support for other list types — such as Portal Users, Computer Panic Button Machines, Watch Groups, or Mobile Access Lists — please submit a feature request to 911Cellular support. In the meantime, you can manually upload these lists through the Portal.
What file types are supported for SFTP batch upload?
The only file type supported for SFTP batch upload processing is .csv files.
Does it matter which network I am on when uploading a file via SFTP?
Yes. The IP address you use to connect to the server must be whitelisted on 911Cellular's firewall. Contact 911Cellular support and provide your IP address to have it added to the whitelist.