Install and Configure the Salesforce App

Introduction

This guide will walk you through configuring your org in a Lightning Experience environment. The first section of this configuration guide for the Lucidworks Salesforce app covers the installation of the package. The other sections will show you how to apply permission sets and complete the Setup Assistant.

Throughout this guide, you will be instructed to navigate through Setup. To do so, you will need to click on the gear to the upper right and select Setup. Once in Setup, you may use the Quick Find box to find and navigate to the appropriate section.

setup icon

Important
Configure a Salesforce domain before proceeding.

Installation

Installing the Lucidworks Package

Copy and paste the package install URL into your browser’s address bar (please contact your administrator for the package link). If you are not already logged into the org where you wish to install the package, Salesforce will prompt you to log in.

Install for Admins Only is recommended - this option allows for controlling access and permissions after the package has been installed.

install for admins only

Please refer to the Salesforce documentation on Package Installations for further information.

Lucidworks Configuration

Remote Site Settings for different URIs

Any URI that will be added during the Setup Wizard also needs added as Remote Sites in Salesforce. Attempting to complete the Setup Wizard without adding in these Remote Sites will result in an error:

setup wizard error

The highlighted portion of the message shows you the exact URL that will need to be added as a remote site.

The following steps detail how to add the endpoint URL as a remote site in Salesforce:

  1. Navigate to Setup > Security > Remote Site Settings

  2. Click New Remote Site

    remote site settings

  3. Enter a Remote Site Name and add your URI, then click Save

    save remote site settings

After the remote sites have been added, then you can go back to the Setup Wizard in order to complete Lucidworks Setup.

Lucidworks Setup (Setup Assistant)

Complete the Lucidworks Setup Assistant to connect your Salesforce org to your Lucidworks account. Connecting Salesforce and Lucidworks allows you to retrieve your list of bots and devices and initiate your bots from Salesforce.

To start System Connections, navigate to App Launcher > Lucidworks Setup

setup assistant

If you do not see the Lucidworks Setup Assistant lightning app, you can search for “Lucidworks” in the search bar or click on View All to see the full list of apps for your Salesforce org.

setup assistant search

Once you have found and clicked on the Lucidworks Setup App, complete setup as follows:

  1. Click Get Started

    setup assistant home

    Note
    If additional help is needed, use the resources in the help section at the bottom for more information or request assistance
  2. Complete the following fields

    • Base URL

    • App Name

    • Username

    • Signing Key

      setup assistant credentials

      Note
      Capitalization does matter when entering these credentials, so be sure to enter them exactly as they appear.
  3. Click Authorize

    Note
    if you run into an error regarding the Remote Site Setting, view the Remote Site Settings for different URIs section above to resolve before continuing.
  4. Once the credentials have been accepted, you will see the status update to a green “Connected” message

    setup assistant connected

  5. Once successfully authorized, click Finish on the right side of the screen to complete the step and return to the landing page

Adding Lightning Components to Record Pages

There is a Lightning Component which is a part of the Lucidworks App - it will simply appear as the Lucidworks component in the Lightning App Builder when creating a new lightning page or editing one. When the component is placed on the lightning record page for the Case object, it will display other cases, knowledge articles, and subject matter experts related to the case being viewed. These will be served by Lucidworks in order to aid the user in resolving the case.

Lucidworks Lightning Component

The Lucidworks Lightning Component needs to be added to the record pages where you want it to be used.

  1. While on a case record page, click on the setup gear and select Edit Page

    lightning component setup

  2. Drag and drop Lucidworks from the Custom - Managed section onto the main panel

    lightning component drag and drop

  3. Click Save to save the edited lightning page.

    • If this is the first time the lightning page for that object has been edited, the edited page may need to be activated.

      lightning component activate

  4. After clicking Activate, set the page as the default for the entire org, just a specific app, or according to profiles as required for that specific record

    lightning component set page

Visibility of the results can depend on a user’s permissions and access controls in an org.

  • Cases: users can only see cases they have permissions to see

  • Knowledge Articles: if there are knowledge articles that originate from their own salesforce org, users will only be able to access them if they have the required permissions

lightning component resources

Using Lightning Components: Configure a custom Domain in Salesforce

Lightning Components can only be used in Salesforce orgs with a custom domain.

For additional help or information on setting up a domain in your Salesforce org to enable lightning components, refer to: Setting up a Custom Salesforce Domain