Configuring Rivet Integration

Posted byTaylor Thorn

Overview:

  • Runs Hourly
  • “Pull”/”Get” Employees from partner system and add them to Flex.
  • “Pull”/”Get” Projects from partner system and add them to Flex.
  • The employee and project integrations can be turned on/off individually in the case that you want to pull data for employees but not projects and vice versa.
  • Authentication requires Client ID and Token (both from Rivet) to be input by client into Flex integration admin panel.

About Employee (called Worker in Rivet) Integration:

  • The following fields are required to pull employees (workers) from Rivet: Employee Number (ID), First Name, Last Name. If the Employee ID is not present in Rivet, then that employee will not be added to Flex. A username is also required but since this field is not in Rivet, the integration will set employee email as the username in Flex. If employee email is not present for an employee (worker) in Rivet, then the integration will set employee number (ID) as the username in Flex.

    Employees that already exist in Flex but do not exist in Rivet will remain active in Flex.
  • Employee Integration field mapping:
    • employeeNumber (Rivet) > employeeNumber (Flex)
    • firstName (Rivet) > firstName (Flex)
    • lastName (Rivet) > lastName (Flex)
    • email_address (Rivet) > username (Flex)
    • if no email address, then employeeID (Rivet) > username (Flex)
    • email_address (Rivet) > email (Flex)
    • terminationDate (Rivet) > termiantionDate (Flex)

About Project (called Jobs in Rivet) Integration:

  • All Rivet projects (jobs) will be added to Flex and updated hourly, mirroring Rivet’s data. We are adding inactive projects so that we can “reactivate” a project if an inactive projects becomes active in Rivet.
  • Project Integration field mapping:
    • jobName (Rivet) > name (Flex)
    • jobNumber (Rivet) > number (Flex)
    • jobStatus = InProgress (Rivet) > isActive (Flex)
    • city (Rivet) > city (Flex)
    • state (Rivet) > state (Flex)
    • zip (Rivet) > zip (Flex)
    • address (Rivet) > address (Flex)

To Authenticate/Set Up Integration:

  1. Navigate to Control Panel > Integrations > Rivet
  2. Turn the switch ON to enable integration
  3. In Authentication Details section, enter Client ID and Token
  4. For Employee Configuration
    • Enabled or disable the employee integration
    • Select a default role. This will be the role in Flex that is applied to all new employees added by the integration
    • Update existing employees – when enabled, the integration will check for changes in the employee data between Rivet and Flex and if changes exist it will update in Flex to “match” Rivet data
    • Force password reset – when enabled, new employees added via the integration will be required to change their password upon first login to Flex
    • Send welcome email – when enabled, new employees added via the integration will be sent the standard welcome email from Flex.
  5. For Project Configuration
    • Enable or disable the project integration.