Connecting your HCM data with BetterUp unlocks value in three ways: simpler program management for admins, personalized experiences for members, and org-wide insights for leaders.
This article explains how to connect your HCM to BetterUp by SFTP. It works for any HCM, including SAP SuccessFactors. A few prerequisites are part of the setup, and each one is covered below. Your BetterUp technical team or deployment manager will help you through it. This is a one-time setup that takes less than an hour.
Jump to: What the SFTP connector does | How it works | Data attributes | File requirements | Setup overview | Technical details
What the SFTP connector does
The BetterUp SFTP connector brings your organizational data into BetterUp. That unlocks:
Simple program management for admins. Automatic provisioning and deprovisioning keep licenses in use without extra admin work.
Personalized experiences for members. HCM data tells BetterUp about moments that matter, such as periods of change and transition, when support may be needed most. For example, BetterUp can offer personalized support when a member is promoted, changes teams, or is working through engagement survey results.
Org-wide insights for leaders. Combining BetterUp data with HCM data adds a layer of insight and answers questions such as which mindsets set your top-performing managers apart.
How it works
How does automatic provisioning work?
The integration creates a BetterUp account for each new email in the file, for the eligible employees you include. For existing members, it updates their attributes so their BetterUp experience stays correct. If you don't need automatic provisioning, BetterUp can turn it off for you.
How does automatic deactivation work?
The integration deactivates a member's account when they are terminated in your HCM, so you can move the license to another employee promptly. To deactivate accounts, include a termination date in the file. The integration does not deactivate employees who are removed from the file. See File requirements for details.
How does it work technically?
You set up a report in your HCM with data about the employees eligible for BetterUp, and schedule it to export as a CSV daily or weekly. The exported file is posted securely to BetterUp's SFTP server. BetterUp checks for new files daily and processes them automatically. The connector is one-way, from your HCM to BetterUp. See Technical details for the data flow.
What data is shared with BetterUp?
You can include any employee data in the CSV file. BetterUp requires a few attributes, which it uses to create, update, and deactivate accounts. See Data attributes for the full list.
How long does setup take?
About 60 minutes. The steps are in Setup overview.
How often should the file be sent?
Most partners send updates daily or weekly. Send the full file each time. BetterUp accepts and processes a full file, so there is no need to send only changes.
Who is typically involved?
- Talent team: decides which data attributes are worth sharing.
- HCM administrator or HRIT: represents your organization in the integration process and requirements.
- Security team: reviews the setup, if your organization requires an additional security review.
Data attributes
Your talent and technical teams can share any data attributes you want to associate with member profiles in BetterUp and use as People Analytics Dashboard filters. A few fields are required, and BetterUp recommends some additional attributes.
| CSV column name | Description | Example | Required? |
|---|---|---|---|
| UserID | Employee's unique ID in your HCM | 002589 | Required |
| First Name | Employee's first name | Pat | Required |
| Last Name | Employee's last name. Can be blank for employees who don't have one. | Doe | Required |
| Employee's work email | pat.doe@company.com | Required | |
| Hire Date | Used for engagement communication and analytics | 2020-07-25 | Required |
| Termination Date | Blank if none. Used to deactivate accounts. | 2023-08-29 | Required |
| Manager ID | Unique ID in your HCM of the employee's manager | 002590 | Required |
| Is Manager | Whether the employee manages people: yes or no | yes | Required |
| Number of direct reports | Includes employees and contingent workers | 5 | Required |
| Job Title | Employee's job title | Director of Delivery Management | Required |
| eligible_product_codes | BetterUp products the employee is eligible for | LEAD | For eligibility |
| ineligible_product_codes | BetterUp products the employee isn't eligible for | LEAD-EXEC | For eligibility |
| Time in role | Time in current role, in months | 24 | Recommended |
| Country | Country of residence | United States | Recommended |
| State | State of residence | California | Recommended |
| Management Level | Employee's management level | Manager of Managers | Recommended |
| Department | Employee's department | Engineering | Recommended |
| Job Family | Employee's job family | Delivery Management | Recommended |
| Tenure | Tenure, in months | 24 | Recommended |
| On Leave | Whether the employee is on leave. Used to support people returning from leave. | True | Recommended |
| First Day of Leave | First day of the current leave | 2023-08-29 | Recommended |
| Alternate Email | Another email the employee uses, for example after an acquisition | pat.doe@acquired.com | Recommended |
| Last Promotion Date | Date of the employee's last promotion | 2023-08-29 | Performance |
| Most Recent Performance Score | Most recent performance score | Meets Expectations | Performance |
| Most Recent Performance Date | Date of the most recent performance score | 2023-08-29 | Performance |
| Performance Reviews in Progress | Whether a performance review is in progress | True | Performance |
| Primary Termination Reason | Main reason the employee left | Voluntary Resignation | Performance |
File requirements
- Format: comma-delimited CSV, UTF-8 encoded.
- Size: up to 100,000 rows per file.
- Full file: BetterUp accepts a full file, so there is no need to send only changes. Most partners send files daily or weekly.
- Deactivation: the integration deactivates accounts when an employee is terminated in your HCM. Include a termination date in the file to deactivate an account. Removing an employee from the file does not deactivate them. The integration acts on the file line by line, so keep terminated employees in the file for a while: 2 days if you send daily, or 2 weeks if you send weekly.
- File name: each file name must be unique. For example, use workers_[seq]_[M][d][yy].csv, where seq is a unique sequence number, such as workers_3_082222.csv, workers_2_8122.csv, or workers_1_81622.csv.pgp. PGP-encrypted files must include the .pgp extension.
- Column names: you can add any other columns and name them yourself. We recommend title case without underscores, such as Job Title.
- Dates: use YYYY/MM/DD, YYYY.MM.DD, or YYYY-MM-DD.
Setup overview
The configuration can be completed within 60 minutes. Here are the steps:
Step 1: Create SSH keys and send the public key to BetterUp
- Generate SSH keys in your HCM.
- Email the RSA SSH formatted portion of the public key to your BetterUp technical team or deployment manager.
- BetterUp adds the key to its SFTP server and sends you the SFTP host and username.
Step 2: Create a custom report in your HCM
Create a custom report with the data you want to send to BetterUp. Each employee's details are associated with their BetterUp member account.
Step 3 (optional): Set up PGP encryption
BetterUp lets you PGP-encrypt the eligibility files sent from your HCM. To do this, encrypt the files you send with BetterUp's public key.
Step 4: Send a test file
To check that the SFTP connection is set up correctly, send BetterUp a test file. Create a CSV file named TEST that contains the word TEST as a record. Don't include any employee information in the test file. Once you send it through the new SFTP connection, a BetterUp team member will confirm it was delivered.
Step 5: Schedule the export for production
Use your HCM's standard scheduling to export the file and post it to the BetterUp SFTP server.
Technical details
The diagram below shows the data flow from your system to BetterUp's infrastructure. When you upload a file over SFTP, it goes to an encrypted Amazon S3 bucket. An AWS S3 API then moves it from the S3 bucket to Heroku, where it is stored long term in a Postgres database.
Questions? Contact tech-ipm@betterup.co or your BetterUp implementation contact.
Jump to: What the SFTP connector does | How it works | Data attributes | File requirements | Setup overview | Technical details