Introduction

A Channel Partner works under a reseller business model, and can manage the Eligibility and Flexible Benefits of the clients/tax ids under the structure.

Through Wellhub's SFTP Server, you can perform operations for all the companies within a channel partner structure in one go. The interaction with the SFTP Server is simple - it's a file system where you can navigate between directories, list, upload, and download files.

These are the operations supported on the SFTP Server for Channel Partners:

• Encrypt the content of files you upload and/or download. See Encryption.
• To manage multiple companies under the channel partners structure, you must select the 'Channel partners’ view when generating the SFTP keys. See Getting Started

The following sections provide more details on each operation.

Overview of the directory structure

Directory Structure
1/
2├── channelpartner/
3│   └── employees/
4│       └── upload/
5│           ├── all/
6│           ├── error-details/
7│           │   ├── {Timestamp}-{Uploaded-Filename}.csv
8│           │   └── ...
9│           └── status.csv
10│   └── flexben/
11│       └── upload/
12│           ├── add-or-update/
13│           ├── removal/
14│       └── download/
15│           ├── upload_history.csv/
16│           ├── errors/
17│           │   ├── {Timestamp}-{Uploaded-Filename}.csv
18│           │   └── ...
19│           └── beneficiaries-list.csv

Employees

Through the SFTP Server, you can manage the employees of multiple companies at the same time. Some supported operations are:

• Update the entire employee base (we call this "Fullfile").
• Download the status of uploads.
• Download the error details of a failed upload.

Overview of the employees file structure

Directory Structure
1/
2├── channelpartner/
3│   └── employees/
4│       └── upload/
5│           ├── all/
6│           ├── error-details/
7│           │   ├── {Timestamp}-{Uploaded-Filename}.csv
8│           │   └── ...
9│           └── status.csv

• The initial directory is the root /.
• /channelpartner is the directory representing all companies under the channel partner's structure.
• /channelpartner/employees/upload/all is the directory to use if you need to update the employee database by uploading a "Fullfile" file.
• /channelpartner/employees/upload/error-details is the directory containing a failed upload error report.
• /channelpartner/employees/upload/error-details/{Timestamp}-{Uploaded-Filename}.csv is the error report referring to a specific upload.
• /channelpartner/employees/upload/status.csv is the file containing the status of the latest uploads.

Upload a "Fullfile" file

Once connected to the SFTP server, you'll be able to manage all of the employees' data. This includes adding, removing, and editing employee records within the file. In case an error occurs, the full file will be rejected. Therefore, it needs to be corrected and reuploaded.

Every time a rejection happens, the channel partner admins will be notified via email.

Attention!

Since Fullfile is a replace operation, it requires extra attention.

The SFTP Server expects the Fullfile to contain all the employees already created for the companies (if there is a company/tax id that doesn't have changes, you don't need to include it in the file).

For the companies/tax ids in the file, a given employee who was part of the database and isn't now part of the file, will be removed. The employees that are new entries, will be added accordingly. For employees found in both the file and the database, will be edited if any of their fields were changed.

Note:Even though it is possible to remove employees by uploading a Fullfile, it's not possible to remove all employees (as there's a safety threshold; if this is surpassed we will throw the 'Database wipe' error and reject the upload).

1. Navigate to the "/channelpartner/employees/upload/all".

Terminal
1cd /channelpartner/employees/upload/all

2. The command below uploads the all-employees.csv file and replaces the existing one with your file, containing the full list of employees for the companies enclosed.

Terminal
1put all-employees.csv

File Organization

Download the status file

Once connected to the SFTP Server, we can download the status of the most recent uploads. This is very useful for checking if a specific upload was successful or failed.

1. Navigate to the "/channelpartner/employees/upload" directory.

Terminal
1cd /channelpartner/employees/upload

2. The command below downloads the status.csv file.

Terminal
1get status.csv

File Organization

Download the error details

Once connected to the SFTP Server, you can download the error details of a failed upload. For example, you uploaded a Fullfile, checked the status.csv and saw that this upload failed. Through the error details, you can check the reason for the failure.

1. Navigate to the "/channelpartner/employees/upload/error-details" directory. And display the list of error details.

Terminal
1cd /channelpartner/employees/upload/error-details
2ls

2. The command below downloads the 1736255395-all-employees-02.csv file.

Terminal
1get 1736255395-all-employees-02.csv

File Organization

This file is a little more self-explanatory. It contains information about the type of error and where the error is.

Flexible Benefits

Flexible Benefits allow channel partners to upload credits for their clients, allowing a company's employees to allocate the credits to those that best suit their individual needs. For an employee to be eligible for credits, they need to be created in the eligibility flow.

Contrary to the Eligibility flow, partial uploads are accepted. This means that, by default, the correct lines will be created; and the ones with errors will be rejected. Every time a full or partial rejection happens, the channel partner admins will be notified via email.

Overview of the employees file structure

Directory Structure
1/
2├── channelpartner/
3│   └── flexben/
4│       └── upload/
5│           ├── add-or-update/
6│           ├── removal/
7│       └── download/
8│           ├── upload_history.csv/
9│           ├── errors/
10│           │   ├── {Timestamp}-{Uploaded-Filename}.csv
11│           │   └── ...
12│           └── beneficiaries-list.csv

• The initial directory is the root /.
• /channelpartner is the directory representing all companies under the channel partner's structure.
• /channelpartner/flexben/upload/add-or-update is the directory to use if you need to create new credits and/or update existing ones.
• /channelpartner/flexben/upload/removal should be used to delete credits.
• /channelpartner/flexben/download/upload_history.csv is the file containing the status of the latest uploads.
• /channelpartner/flexben/download/errors/ is the directory containing the failed upload error report.
• /channelpartner/flexben/download/errors/{Timestamp}-{Uploaded-Filename}.csv is the error report referring to a specific upload.
• /channelpartner/flexben/download/beneficiaries-list.csv/ will download the snapshot of credited employees.

Manage the credits

There are two types of uploads available:

• Add or update - a file that will create new credits or edit existing ones
• Removal - a file that will delete existing credits

Upload an Add/Update credits file

1. Navigate to the "/channelpartner/flexben/upload/add-or-update/".

Terminal
1cd /channelpartner/flexben/upload/add-or-update/

2. The command below uploads the .csv file, creating the new credit entries and updating the existing ones.

Terminal
1put credit-employees.csv

File Organization

Upload a Credits removal file

1. Navigate to the "/channelpartner/flexben/upload/removal/".

Terminal
1cd /channelpartner/flexben/upload/removal/

2. The command below uploads the .csv file, deleting the credits.

Terminal
1put credits-removal.csv

File Organization

Download the status file

You can download the status of the most recent uploads. This is very useful for checking if a specific upload was successful or failed. This file will contain the last 40 uploads (regardless of the method - W4C or SFTP), sorted by date.

1. Navigate to the "/channelpartner/flexben/download/upload_history.csv" directory.

Terminal
1cd /channelpartner/flexben/download/upload_history.csv

2. The command below downloads the upload_history.csv file.

Terminal
1get upload_history.csv

File Organization

Download the error details

You can download the error details of a failed upload. For example, you uploaded a credits file, checked the upload_history.csv and saw that this upload was rejected. Through the error details, you can check the reason for the failure.

1. Navigate to the "/channelpartner/flexben/download/errors/" directory. And display the list of error details.

Terminal
1cd /channelpartner/flexben/download/errors/
2ls

2. The command below downloads the credit-employees.csv file.

Terminal
1get 1736255395-credit-employees.csv

File Organization

Download the beneficiaries list

You can download a snapshot of the credited employees from a given channel partner.

1. Navigate to the "/channelpartner/flexben/download/beneficiaries-list.csv" directory.

Terminal
1cd /channelpartner/flexben/download/beneficiaries-list.csv
2ls

2. The command below downloads the beneficiaries-list.csv file.

Terminal
1get beneficiaries-list.csv

File Organization