Skip to main content

BambooHR

CatalogScorecardsTeams

Overview​

BambooHR is a Human Resources Information System (HRIS) solution that allows you to define organizational membership. Integrate Cortex with BambooHR to automatically sync team memberships, giving you insight into entity ownership.

How to configure BambooHR with Cortex​

Prerequisite​

Before getting started, create a BambooHR API key.

Configure the integration in Cortex​

  1. In Cortex, navigate to the BambooHR settings page:
    1. In Cortex, click your avatar in the lower left corner, then click Settings.
    2. Under "Integrations", click BambooHR.
  2. Configure the BambooHR integration form:
    • Subdomain: Enter your BambooHR subdomain.
      • This can be found in your app URL, e.g., subdomain.bamboohr.com.
    • API token: Enter your BambooHR API token.
    • Report ID: Optionally, enter a Report ID to filter the list of employees.
      • We recommend entering a Report ID if you have a custom BambooHR Report that has the authoritative list of active employees.
      • This value can be found in the app URL, e.g., subdomain.bamboohr.comreports/custom/New+Hires/REPORTID
    • Employee ownership field: Optionally, enter the ownership field name.
      • If left blank, Cortex defaults to finding the list of employees using their division followed by their department.
  3. Click Save.
caution

If you do not see the settings page you're looking for, you may not have permission to access that page. Please contact your admin for assistance.

How to connect Cortex entities to BambooHR​

Import entities from BambooHR​

You can manually import teams from BambooHR:

  1. In the main nav of Cortex, click Catalogs > Teams.
  2. On the right side of the Teams page, click Create team.
  3. On the "Import entities" page, select BambooHR.
  4. A list of discovered entities will appear at the bottom of the page. Click the team you want to add.
    • If your expected teams do not appear, click Sync teams in the upper left corner of the "Import teams" page.
  5. When you click a team, you will be redirected to the "Team details" page where you can configure basic details, Slack channels, parent and children teams, on-call, and links. When you are finished, click Save team at the bottom of the page.

Editing the entity descriptor​

Ownership of each catalog entity through BambooHR is defined through an owner of type group.

x-cortex-owners:
  - type: group
    name: My Bamboo HR Team
    provider: BAMBOO_HR
    description: This is a description for this owner # optional

The name should be exactly equal to the value in the Team field.

Background sync​

Cortex conducts an ownership sync for BambooHR teams every day at 6 a.m. UTC.

Scorecards and CQL​

With the BambooHR integration, you can create Scorecard rules and write CQL queries based on BambooHR teams.

See more examples in the CQL Explorer in Cortex.

All ownership details

A special built-in type that supports a null check or a count check, used to enforce ownership of entities.

Definition: ownership: Ownership | Null

Example

In a Scorecard, you can write a rule to make sure an entity has owners:

ownership != null
Team details

List of teams for each entity.

Definition: ownership.teams(): List<Team>

Example

In a Scorecard, you can write a rule to make sure an entity has at least one team owner:

ownership.teams().length > 0

Still need help?​

The following are all the ways to get assistance from our customer engineering team. Please use the option that is best for your users:

  • Email: help@cortex.io, or open a support ticket in the in app Resource Center
  • Chat: Available in the Resource Center
  • Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your customer success manager.