/ /

Setup - Gainsight

Updated 23 days ago

Prerequisites

  • Gainsight role: A Gainsight Super admin in an active state. Only Super Admins can create API connections in Connectors 2.0.

  • Simpplr role: A Simpplr admin with access to Manage features → Enterprise search in the Admin Panel.

  • Gainsight edition: Gainsight CS (NXT) cloud. Gainsight PX and Customer Communities are not supported.

  • Permissions review: Read Permissions & Security - Gainsight before you start. Gainsight's OAuth credential cannot be limited to read-only, and search results are not trimmed to what each person can open in Gainsight. Confirm this is acceptable for your organisation.

  • Connection limit: Gainsight allows up to 15 OAuth connections per organisation. Make sure one is available.

Step 1: Create an OAuth connection in Gainsight

  1. Sign in to Gainsight as a Super admin.

  2. Go to Administration → Integrations → Connectors 2.0.

    GS.png

  3. Select Create connection.

    GS1.png

  4. For Connector, select Gainsight API.

    GS2.png

  5. Enter a name for the connection, for example Simpplr Enterprise Search. Connection names must be unique in your tenant.

  6. For Authentication Type, select OAuth.

  7. Select Generate OAuth Credentials.

    GS3.png

  8. Copy the OAuth API Key (client ID) and the OAuth API Secret (client secret) and store them securely.

    Note: Gainsight shows the secret only once. If you lose it, open the connection and select Re-Generate Secret. 

  9. Note your instance domain. Open Gainsight in your browser and copy everything before .gainsightcloud.com in the address bar. For example, for https://acme.us2.gainsightcloud.com, the instance domain is acme.us2. If your tenant uses a vanity domain, use the full host instead.

Step 2: Add Gainsight in the admin panel

  1. In Simpplr, go to Manage features → Enterprise search.
    GS4.png

  2. Select Add source and choose Gainsight.
    GS5.png

  3. Enter the connection details:

    • Instance domain: The value from Step 1, for example acme.us2.

    • OAuth client ID: The OAuth API Key from Step 1.

    • OAuth client secret: The OAuth API Secret from Step 1.
      GS6.png

  4. Click on save configuration

Step 3: Configure filters

Filters control what is indexed. You can change them later. Narrowing a filter removes content at the next full sync.

Filter

What it does

Default

Document age

Indexes only records changed within this window, based on the last modified date. Timeline Activities use the activity date instead, unless Activity lookback is set.

2 years

Activity lookback

Timeline Activity only. Indexes only activities that happened within this window, based on the activity date. Use it to keep a shorter history of meeting notes and calls than of other content. When set, it replaces document age for Timeline Activities.

Same as document age

Object types

Choose which of Company, Relationship, Timeline Activity, CTA, Task, and Success Plan to index. At least one must stay selected.

All six

Company

Include only, or exclude, specific companies. Enter a company name, a company ID, or a Customer 360 URL, one per entry. The filter also applies to each company's relationships, activities, CTAs, tasks, and success plans. Use include or exclude, not both.

All companies

Note: Company names must match Gainsight exactly. If a name is not found or matches more than one company, the sync fails with a message listing the entry. Use the company ID or Customer 360 URL to avoid this.

GS7.pngGS8.png

Audience

Optionally restrict which Simpplr users can search Gainsight content. Only users who are both in the Audience and matched to an active internal Gainsight user will see Gainsight results.

Select Save and sync to start the first full sync.

Step 4: Verify the connection

  1. Go to Enterprise search → Gainsight → Status.

    GS9.png

  2. Wait for the first full sync to complete. How long it takes depends on how many records your tenant has, especially Timeline Activities.

  3. Search in Simpplr for a company name you know is in Gainsight and confirm the result opens its Customer 360 page.

  4. Confirm that users who are active internal Gainsight users see results, and users who are not see none.

If the sync fails, see Troubleshooting & FAQs - Gainsight.

Was this article helpful?
Subscribe to receive updates on this article