Skip to main content

FTP Administration

FTP import lets Platform Admins receive CSV files and route them into CareLaunch. It is an Enterprise feature that CareLaunch sets up for your organization. Once it is set up, Platform Admins see the FTP tab. Organization Admins do not see it. If you expect the tab and do not see it, email support@carelaunch.health. There is no outgoing export.

Open FTP​

Go to Integrations, then the FTP tab. The tab has Users, Groups, and Rules.

Users​

  1. On Users, click New FTP User.
  2. Enter a Name. It can be at most 10 characters and cannot be changed later.
  3. Choose a Group. This is required. The user can upload only to that group's folder. Create a group first if the list is empty.
  4. On the same form, set how the user signs in:
    • Password. You can check Require password change on first login. The password can only be set when you create the user.
    • Public Keys, one OpenSSH key per line. This is the better choice for an automated upload.
  5. Click Create.

The Users tab lists each user with created date, first upload, and last login.

MethodUse it for
PasswordA person uploading files. Admins can issue the password.
SSH public keyAn automated system that uploads on a schedule.

Your CareLaunch contact provides the server address and port with the account. Do not assume a port.

Groups​

A group is a folder. Users in the group upload to that folder and do not see other groups' folders.

On Groups, click New Group. In New FTP group, enter a Name (letters, numbers, dots, underscores, and hyphens) and click Create. The name is the folder name.

Rules​

Rules decide what happens to an uploaded file. Each rule has a regular expression and an action. The expression is matched against the full storage path, not only the file name, and matching ignores case.

ActionWhat happens
ImportStarts a batch import of the file.
Import and AcceptStarts the import and accepts the records.

A rule can also add Overrides. An override sets a column on every row. If the column is already in the file, the override replaces it. If it is not, the column is added. Use this for a default instance id or a tag.

Create a rule​

Patterns and overrides cannot be added on a rule that has not been saved yet.

  1. On Rules, click New Rule.
  2. Enter a Name.
  3. Click Create.
  4. On Patterns, click Add. Enter the expression and choose Import or Import and Accept.
  5. On Overrides, click Add for any column you want to set. Enter the column and the value.
  6. Click Save.

Examples that match the full path:

  • .*\.csv$ matches a path that ends in .csv.
  • patient_import_.*\.csv$ matches a path that contains patient_import_ and ends in .csv.

An expression that starts with ^ has to match from the beginning of the storage path, including the folder, not from the file name.

What happens to a file​

  1. The user uploads a CSV over SFTP into their group folder.
  2. CareLaunch checks the path against every rule for the organization.
  3. When a rule matches, the action runs. Overrides are applied before the import.
  4. After the import is queued, the file is removed from the upload folder.

A file that matches no rule stays in the upload folder and is not imported.

Tell users how to connect​

Send provisioned users to FTP User Instructions.