This article will describe maintaining SFTP accounts for your detamoov account. We have broken this down into three sections. You can read the entire article or quickly jump to a section by using the "Sections of this article" area on the right.
1. Why create SFTP accounts?
SFTP is one of the ways that you can send data/files to detamoov for moov's to be executed. Place a file on your detamoov SFTP, then watch detamoov do its thing.
We built this functionality to handle a few specific use cases:
a. Your payroll platform has the ability to SFTP files - some payroll platforms have native SFTP capabilities (Kronos, isolved, etc...). You setup your detamoov SFTP site to receive data from your payroll platform for moov execution to then commence. For example, your payroll platform generates the standard 401k file extract once payroll processing is complete for a client. Your payroll software then automatically SFTPs that file to your detamoov SFTP site. detamoov then takes over and executes the proper moov to deliver this file to the client's 401k provider.
b. A third-party provider has data that needs to get back into payroll - this is the reverse situation than what we just described. Your client's 401k provider has a file with employee contribution changes which need to result in deduction updates in payroll. You create the third party a set of SFTP credentials to access your detamoov SFTP site. The provider uses these credentials to place the employee change file which then executes a moov to update deductions in your payroll system.
2. How to create an SFTP account?
Now that you know why we developed the ability to create SFTP accounts, let's review how to create them. Before you do, few things to keep in mind:
- Each SFTP account you create only has access to a single directory on your SFTP site (for security reasons). This means they you won't need to provide a folder or directory path to those using your SFTP site. When each SFTP user account authenticates successfully, it defaults to its designated directory.
- You can create any number of SFTP accounts you need to access your SFTP site. Keep in mind though, it's best to only create accounts if you truly need them.
- Only administrator level users on your account have access to create and maintain SFTP accounts.
To create an SFTP account, make sure you are logged in with an administrator level account. Click on your initials in the top right corner and select the Admin Console link.
Within the admin console, select the Settings tab and click on the SFTP row. Once the SFTP area expands, click the Add button to add a new SFTP account.
The side sheet will be where you'll enter information on your new SFTP account. All fields are required. Here's some information on each field:
- Username: required, cannot contain spaces and must be unique across all SFTP accounts.
- Password: required and must adhere to the standard detamoov password requirements.
- Confirmation password: required and must match the password field exactly (case sensitive).
- Description: required and used to describe why you're creating this account.
Once you've entered all the information above, click Save and your account will be created.
3. How to maintain an existing SFTP account?
Maintaining your existing SFTP accounts allows you to view or reset the password or enable/disable the account.
To view the password on an SFTP account, click on the account row.
To reset the password on an SFTP account, click on the key icon on the account row. Remember, the password must adhere to the detamoov password requirements and the confirmation password must match exactly! Once the password has been reset, remember to update the system using these credentials to they can successfully authenticate to your detamoov SFTP site.
To enable or disable an SFTP account, simply click the switch. Disabled accounts will not be able to authenticate to your SFTP site.