Simpplr

Introduction

Simpplr is an employee intranet platform, with software that helps companies engage their workforce by streamlining internal communication and forging employee connections.

Prerequisites

  • Ask your Simpplr administrator to give the Aisera Service User Read/Write access to your data source for the User, Tickets, and Knowledge tables. If you're not going to write data back to Tickets or Generate Knowledge Articles, the Aisera Service User Account only needs Read access to these tables so they can transfer data to the internal Aisera cache where it will be used only for bot answers and Intent fulfillment.

  • Ask your Simpplr administrator for the following Simpplr credentials for your Aisera Service User:

    • Authorization URL

    • Client Id

    • Client Secret code

    • Access Token URL

Access

Simpplr Connected App in Salesforce

NOTE: This section is based on this Simpplr documentation.

In order to enable OAuth authorization with a Simpplr Instance, we need to create a connected app first within the Salesforce environment.

1. Login to your Simpplr Salesforce instance as the Salesforce System Administrator user

NOTE: If you are in Lightning Experience, click your profile and change to 
Salesforce Classic.

2. Click on Setup on the upper right side of the screen.

Setup in Salesforce

3. Search for Apps in the Search field.

4. Under the Build > Create heading, select Apps.

5. Click New in the Connected Apps section, at the bottom of the middle section.

Connected App

6. Enter in a Connected App Name. The API Name will auto-fill.

  1. Type in your email.

  2. In the API section, check the box to enable OAuth Settings.

  3. Enter the Callback URL (the URL the browser will redirect back to after successful authorization).

  4. Select the OAuth Scopes that you need, so they appear on the right side of the window.

  5. Simpplr requires the following:

  • Access and manage your data (api).

  • Access your basic information (id, profile, email, address, phone).

  • Perform requests on your behalf at any time (refresh_token, offline_access).

  • Provide access to custom applications (visualforce).

  • Provide access to your data via the Web (web).

Selecting OAuth Scopes

Configure the Connected App in Aisera sandboxes.

1. Scroll to the bottom of the page and click Save.

Save

NOTE: The system will inject a confirmation step to let you know that this could take up to 10 minutes to complete.

  1. Click the Continue button.

NOTE: When you click Save, the browser redirects to the Connected App's Detail screen. Notice that the Consumer Key and Client Secret are provided. Be sure to take note of these two fields because the values will be used in the next sections.

Integration with Aisera

Integration with Aisera is a 2-step process:

  • Set up the Integration

  • Set up the Data Source

After you have completed these steps, you can add Simpplr as a Data Source for your bot.

Setting up an Integration

To setup the integration with your Aisera platform instance (tenant):

  1. Navigate to Settings > Integration in your Aisera Admin UI.

Choose Integrations
  1. Click on + New Integration.

  1. Search for and then click on Simpplr.

Search for the Simpplr Integration
  1. Click the Next button.

  2. Type in a Name for your Integration.

Name and Endpoint
  1. Add the Endpoint.

    1. If you are using OAuth authentication, the endpoint value should be the Simpplr API endpoint, for example: https://api.ec.simpplr.com

    2. If you are using Basic authentication, the endpoint value should be the Simpplr API endpoint, for example: https://aisera22.my.salesforce.comhttps://api.ec.simpplr.com

  2. Choose the checkbox next to Public. This check box determines whether the integration can be used outside the firewall.

  3. Type in the Description of your Integration.

  4. Enter the credentials for the authentication type you have chosen. OAuth and Basic are the authentication types used most often with Simpplr.

OAuth Credentials for Simpplr

Make sure that the Salesforce connected app is properly set up, with the appropriate redirect URL.

  1. As mentioned above, add the credentials that you received from the Simpplr Admin.

    1. Select OAuth from the drop down in Auth Type.

    2. Type in the Authorization URL, Client Id, Client Secret code, Access Token URL into the respective fields.

    3. Click OK.

    After clicking OK, you will be asked if you want to be redirected to the Salesforce UI. You must accept that the required privileges be granted to Aisera Service User in order for the OAuth authentication to proceed.

  2. Choose OK on the redirect pop-up. After giving the required permissions, you will be redirected back to Aisera’s UI, and you will see a Success message when the integration in complete.

Set Up the Data Source

Now you need to configure how your data will be added to your Aisera tenant cache:

  1. Log into Aisera with the Admin Service User credentials.

  2. Navigate to Settings > Data Source in your Aisera Admin UI.

  3. Choose + New Data Source.

Set Up Simpplr Data Source
  1. Search for and then click on Simpplr.

  2. Click on Next.

  1. Type in a Name for your Simpplr Data Source configuration.

  2. Choose the Aisera Functions that you plan to perform using this Data Source. When you choose a Function from the pull-down list, more options appear for your configuration.

Second Data Source Configuration Screen
  1. Choose your Simpplr Integration (that you created in the previous section) from the drop down.

  2. Data Types are objects of data fields that you have chosen to group together. If you have created Data Types for this Data Source, choose the ones you want to use with this tenant instance.

  3. Select a Schedule for data pulls from the drop down.

  4. Pick the Language you want your bot to use from the drop down.

  5. Choose the Premium checkbox if you want data in this data source to take precedence over other data.

  6. Add the Public Domain, if you are gathering information from public knowledge articles.

  7. Select the Auto Commit checkbox if you want to commit all articles in the knowledge base.

  8. Add a Description of the data in this Data Source.

  9. Click Next.

Third Configuration Step for Adding Data Source
  1. Instance URL: this url is different than the API endpoint that is used in the Integration setup, it usually has the following format: https://instanceName--simpplr.visualforce.com.

  2. Search Term: If the Simpplr Integration was set up with Basic Authentication, then the value of this field will represent the search term that should be present in the fetched documents. Usually a simple letter is used, for example “a”; this will lead to a crawl for all KBs that contain the string “a” in their title. If the Simpplr Integration was set up with OAuth, then this field is not used but the connector and any random value will suffice.

  3. Size: This field represents the size of each batch of documents that will be fetched from the API.

  4. Email Header: Provide the email of the user that own the Simpplr API Access.

  5. Download Files from Sites: Type in the system name for files you want to download as part of the data ingestion.

  6. Provider: If you're using a third-party data provider, enter it here.

  7. File Size: Enter the size of the files you want to download.

  8. Custom Script: Add the content of any scripts you want to run during the data ingestion.

  9. Event Type: Add any event types that you have created to trigger data ingestion.

  10. Bypass Test Connection: Type in the content of any bypass test connection code.

  11. Custom Query: Include the content for any custom queries.

  12. Click on Next.

  13. Choose templates for your knowledge article ingestion in the Templates window.

Template Form

a. Choose + Add Template.

b. Select the template you need from the drop down menu.

c. Click on Next.

  1. The next window allows you to set the configuration for the knowledge articles that you want to ingest.

Configuration for Ingested Articles

a. Select the checkboxes for content input options the Ingestion Configuration page.

b. Click on Next.

  1. Add any Configuration or Transformation scripts that you want the platform to use during data ingestion.

Your new Data Source should be ready to crawl for Knowledge Bases Articles to ingest data.

Last updated