EST. TIME: 10 MINUTES

1. Sign up for a free Spekit account

Head over to our signup page 

Once logged in, follow the prompts to install the Chrome Extension (optional)

EST. TIME: 20 MINUTES

2. Connect to Salesforce

Before you try to connect, make sure you have the following:

System Admin profile or “modify metadata” permissions for your Salesforce user.

We only require access to your metadata, not your data. Read our Security FAQs for more info.

MyDomain is configured

Click the Connect tab from the Spekit web app to perform the initial Salesforce sync

1) Check the box to confirm I have the required Salesforce permissions

This confirms that you are a Salesforce Admin and/or have “modify metadata” permissions 

2) Click the blue Connect a production org button

This will take you to the Salesforce login screen:

On the Salesforce login screen:

3) Click the “Use Custom Domain” link in the bottom right

4) Enter your MyDomain name (ex: companyname)

5) Click Continue

– Keep in mind, in the example below in the screenshot, I used MyDomain that I created as a test

6) Next, enter your Salesforce production credentials

7) Finally, click “Allow” on the next “Allow Access” screen

Once you’re logged in, you’ll be taken back to the Spekit app to import objects

EST. TIME: 10 MINUTES

3. Import an object

From the Connect tab on the Spekit app webpage

Click to import an object from Salesforce

Please keep in mind this is a 1 Spekit instance to 1 Salesforce org relationship

The first sync can take up to 10 minutes depending on the size of the Salesforce org

If possible, please remain on the sync page until you receive confirmation the sync has completed

Once the sync completes, the Spekit app page appears and you can select a Salesforce object to import

To start, we highly recommend only selecting one or two objects

Once selected, click the blue Import Selected Objects button 

Once the import sync completes, from the Spekit app page, click Dictionary.

Click the slider to enable Spek Mode and you will see the object(s) you imported

EST. TIME: 10 MINUTES

4. Install the Spekit Lightning Component

How to install the Spekit Lightning Component

Prerequisites:

Your company already has configured their Salesforce My Domain name

In Salesforce, your profile is System Administrator or you have the Download AppExchange Packages permission on your Salesforce profile

You have already signed up for a free Spekit account  

 1) Click Install for All Users (Please see the link below)

Install a Package – Salesforce guidance

2) Click Install

3) The installation process in Salesforce will inform you that it’s Installing and granting access to all Users…

4) The screen transitions to the example shown below…

5) Salesforce will send you a confirmation email of a successful installation of the managed package

EST. TIME: 5 MINUTES

5. Add the Spekit Lightning Component to the Home page

Prerequisite: In Salesforce, you have the Customize Application permissions on your profile

From the Installed Packages screen (post managed package install)

1) In the top left corner of the screen, click the App Launcher

2) Click the Sales app from the list of options (Please keep in mind, you can enable Search Spekit on Service too)

The previous step will take you to the Home page for the Sales

3) Click the gear icon

4) Click Edit Page

 Lightning App Builder page

Look down the list under the section of the Components list for Custom – Managed (1)

5) Left-click and hold Search_Spekit

6) Drag and drop Search_Spekit on the Home Page Default layout in the location indicated in the screenshot below

7) On the top right of the page, click the blue Save button

Page Saved

8) Click the blue Activate button

Activation: Home Page Default

9) Click the Assign as OrgDefault blue text which is under the heading of ORG DEFAULT

**Please keep in mind that this will depend on the configuration of the org, so the Admin can make the choice that makes the most sense for their Salesforce org**

• Set as Org Default: Home Page Default
  • The screen will then show Review Assignments (1) for what you just selected

10) Click the blue Save button

**When prompted, click to allow pop-ups for the Salesforce custom domain in your web browser**

The Spekit Lightning Component will load on the Sales Home page

EST. TIME: 5 MINUTES

6. Add the Spekit Lightning Component to any object

• Prerequisite:
  • In Salesforce, you have the Customize Application permissions on your profile

From Setup

1. Click on Object Manager

2. In the search on the right, type Account

– Keep in mind this search can be whatever object you’re adding Spekit Search to

3. Click on the object name – my example below is Account

– From the object you clicked on in the search result – my example below is Account

4. Click Lightning Record Pages

5. Click on the object record page you want to add Spekit Search to

6. Click Edit

Lightning App Builder

7) Left-click and hold Search_Spekit, drag and drop Search_Spekit on the Account Record Page

8) On the top right of the page, click the blue Save button

9) Click the blue Activation button

• Activation: Account Record Page

– Look under the APP DEFAULT header

10) Click the white Assign as App Default button

Select Apps

Look under the column showing Lightning Apps (#)

Locate the empty checkbox to the left of Sales

11) Add a checkmark in the checkbox

12) Click Next

Select Form Factor

Under the FORM FACTOR header

13) Click to select one of the three options (For the example below I selected Desktop and phone)

Desktop and phone

Desktop

Phone

14) Click Next

• Review Assignments (#)
  • What shows under Review Assignments depends on what you selected in the previous step
  • (In my example, you can see (2) form factors, Phone & Desktop)

15) Click Save

The Spekit Lightning Component will now appear on all Account records

EST. TIME: 5 MINUTES

7. Add the Spekit Lightning Component to the Utility Bar on the Home page

• Prerequisite: In Salesforce, you have the Customize Application permissions on your profile

From Setup

1) Type app manager in the Quick Search

2) Click App Manager

• Look for the row that shows the following…
• App Name: Sales
• Developer Name: Lightning Sales
• App Type: Lightning

3) At the end of the row, click the ▼ to show the drop-down

4) Click Edit

• Lightning App Builder

5) Click Utility Items (Desktop Only)

6) Click Add Utility Item

7) Click in the search box

8) Type the word search

9) Click to select Search_Spekit under the Custom – Managed (1) header

• Search Spekit

Label – remove the underscore _ between Search and Spekit

11) Icon – click the x and locate the Search icon

12) Panel Width – set it to 440

13) Panel Height – set it to 540

14) Click Save

15) Click Back

The screenshot below shows what your screen should look like

• Click Back in the previous step returns you to the Lightning Experience App Manager page

16) Click the App Launcher

17) Click Sales

• Sales – Home

18) Click Search Spekit to open the Utility Bar view

19) Click the highlighted icon to minimize Search Spekit

20) Click the highlighted icon to pop Search Spekit out on the side

21) Click the highlighted icon to pop Search Spekit back into the page

EST. TIME: 5 MINUTES

8. Create the Spekit Lightning Component tab

From Setup

In the Quick Search

1) Type tabs

2) Click Tabs

Look for the Lightning Component Tabs header

3) Click New

New Lightning Component Tab

4) Lightning Component: click to select Spekit: Search_Spekit

5) Tab Label: Search Spekit

– Hit the tab key on your keyboard which will automatically populate the Tab Name field

6) Tab Name: Search_Spekit

7) Tab Style: click the search magnifying glass and click to select the Jewel

8) Click Next

9) If necessary, click to select the Salesforce profiles you want to be able to access the newly created tab

10) If no changes are needed, click Save

• Edit Sales App Navigation Items

11) Click the pencil icon in the top right-hand corner of the screen

12) Click the Add More Items button

• Add Items

13) Click in the search box

14) Type: Spekit

15) Locate – Search Spekit

16) Click the square with the + in it to the left of Search Spekit

17) The square will now appear green with a white checkmark

18) Click the blue Add 1 New Item button

• Edit Sales App Navigation Items

18) To the left of Search Spekit, left-click on the ☰  icon

19) Hold and drag and drop in the list where you wish to place Search Spekit

20) Click the blue Save button

Open the Salesforce mobile app on your mobile device

(My example is shown in the iOS Salesforce app on an iPhone)