Skip to main content

Salesforce Integration

David avatar
Written by David
Updated over 2 weeks ago

Knack has a Salesforce integration that synchronizes tutoring Session data automatically into Salesforce for viewing. Knack's integration is an extension on the Education Data Architecture. Knack's integration is installed from AppExchange as a connected application.

Note: To utilize the Salesforce Integration, additional contract requirements are necessary. Please discuss with your Knack Partner Success Manager for more information.

How It Works

Knack's integration implements a nightly process to synchronize data about Tutoring Sessions. It implements 2 custom objects as an extension of the Education Data Architecture (EDA):

  • Knack__Tutoring_Session__c

  • Knack__Student_Tutoring_Session__c

When creating objects, it links existing tutor and student Contact objects and existing EDA Course objects to the tutoring session.

The installation package provides 1 custom Tutoring Sessions tab. Users are able to configure Salesforce to display the custom objects in any context desired.

Requirements

  1. Direct specification in Knack contract to meet Salesforce requirements

  2. Knack must receive a student ID value through SSO and name of attribute on Contact object that contains this ID for lookup

  3. Knack must receive a unique course ID value in course catalog CSV and name of attribute on EDA Course object that contains this ID for lookup

Installation

  1. Install the Knack Tutoring app from AppExchange.

  2. Create an integration user

    1. Go to Setup > Users > Users

    2. Create a new User named Knack Integration with the Minimum Access - API Only Integrations Profile.

    3. Use any email address that you prefer. Salesforce will send an email to the new user’s email address. You must follow the instructions in the email to finish registering your user.

  3. Grant profile access to the Connected App

    1. Go to Setup > Apps > Connected Apps > Manage Connected Apps

    2. Select the Knack app

    3. Under Profiles select Manage Profiles and grant the Minimum Access - API Only Integrations Profile access

  4. Create Permission Set

    1. Go to Setup > Users > Permission Sets

    2. Create a new Permission Set called Knack Integration. Be sure to assign its license as Salesforce API Integration.

    3. Select Manage Assignments and assign the Permission Set to the User created in Step 2 above.

    4. On the Permission Set, go to Object Settings to add the following permissions

      1. Courses

        1. Under Object Permissions, select Read, View All Records, View All Fields

      2. Contacts

        1. Under Object Permissions, select Read

        2. Under Field Permissions, check Read Access for Email and whichever field contains the Student ID value you will tell Knack to use

      3. Tutoring Sessions

        1. Under Object Permissions, select all of checkboxes including Read, Create, Edit, etc.

        2. Under Field Permissions, select the checkboxes at the top for Read Access and `Edit Access` to ensure all fields are turned on

      4. Student Tutoring Sessions

        1. Under Object Permissions, select all of checkboxes including Read, Create, Edit, etc.

        2. Under Field Permissions, select the checkboxes at the top for Read Access and `Edit Access` to ensure all fields are turned on

  5. Test Connectivity

    1. Now Knack can perform a connectivity test. Knack's engineering team will work through this test with you

    2. Provide the following to Knack's engineering team who will perform a test:

      1. Integration User's email address

      2. Field name for Student/External ID field on Contact object containing student ID

      3. Field name for External ID field on Course object containing the unique course ID's Knack should reference

  6. Configure Tabs and objects for use

    1. Enable the Tutoring Sessions tab in EDA

      1. Go to Setup > Apps > App Manager

      2. Select the arrow on the right of EDA to edit

      3. Move the Tutoring Sessions tab from Available Tabs to Selected Tabs and save

      4. This will make the Tutoring Sessions tab available in the EDA view

    2. Configure objects for viewing in any other views desired. Where the objects are displayed is open to the school's desired usage.

Custom Objects

Knack__Tutoring_Session__c

Knack__Student_Tutoring_Session__c

Did this answer your question?