Skip to main content

Salesforce App Installation Instructions

The following installation instructions need to be completed by a Salesforce administrator. For any questions, please reach out to support@smallworld.ai.

Installation Instructions​

Step 1​

Send a list of users with their Salesforce IDs and email addresses to support@smallworld.ai for every Requester you want to have access. You can locate the ID of each user by bringing up their profile in Salesforce and looking at what immediately follows "/User/" in the URL. SmallWorld will confirm receipt of the file and respond back with an account level Authentication Key.

Salesforce User ID in URL

User ID example

Step 2​

Visit the Salesforce AppExchange to begin the app installation process:

Salesforce AppExchange

AppExchange listing

Step 3​

After authenticating with Salesforce, choose the environment in which you would like to install the app:

Choose environment

Step 4​

Accept the terms and conditions, then choose "Confirm and Install":

Terms and conditions

Step 5​

You'll need to enter the installation key "sw1234" (without the quotes) and select "Install for Admins Only".

Installation key

Step 6​

The app will begin installing. After it completes installation click "Done":

Installation complete

Step 7​

Next go to Setup (via the Gear in the top right corner of Salesforce) and search "Named Credentials". Click "Edit" on the Named Credential with the URL of https://app.smallworld.ai:

Named Credentials

Step 8​

Enter the Authentication Key provided by SmallWorld and click "Save":

Authentication Key

Step 9​

Your account is now authenticated but individual permissions need to be set for authorized users. From the Setup menu search for and click "Permission Sets":

Permission Sets

Step 10​

Click into the Permission Set named "SmallWorld Admin" and then click the "Manage Assignments" button. Click "Add Assignments", select all of the users that are Admins in SmallWorld, then press the "Next" button in the lower right corner. Finally, leave the Expiration Option set to "No expiration date" and then click the "Assign" button in the lower right corner.

Repeat the process with the Permission Set named "SmallWorld User" and add each user that is a Requester in SmallWorld.

Manage Assignments

Step 11​

Next, navigate to any page where you'd like to add the SmallWorld component and click the Settings icon in the upper right hand corner. The most common pages to include the component are Lead, Contact, Opportunity and Account Pages.

Settings icon

Step 12​

After clicking "Edit Page" you will be taken to the Lightning App Builder. You can either add this to an existing part of the page or create a dedicated SmallWorld tab. To create a brand new tab, click into the page, then "Add Tab". Select "Custom" under "Tab Label", set a "Custom Label" of SmallWorld and click "Done".

Add Tab

Step 13​

Now search for the SmallWorld component in the left sidebar. Click and drag it into your newly created tab (or an existing part of your layout):

Drag component

Step 14​

Under Set Component Visibility, click "+ Add Filter", then "Advanced":

Add Filter

Step 15​

After clicking "Select" under Field, Choose "Permissions", "Custom Permission", then "SmallWorld.SmallWorld_User" to restrict visibility to the previously authorized users. Click "Done":

SmallWorld User permission

Step 16​

Click "Save" in the upper right and repeat steps 11-15 for any other pages where you want Requesters to see the SmallWorld data.

Step 17​

With SmallWorld provisioned on standard record pages, it's time to add a custom app page for Relationship Leads. From the top of the Lightning App Builder, choose "Pages" then "+ New Page":

New Page

Step 18​

Choose "App Page", then "Next":

App Page

Step 19​

Name the page, choose "One Region", then "Done":

Name and region

Step 20​

On the left, search for and drag the "SmallWorld App Page" Component onto the page, then set the component visibility the same way as you did in steps 14 & 15. When complete, click "Activation" in the upper right:

SmallWorld App Page component

Step 21​

Make sure "Activate for all users" is selected, then click over to "Lightning Experience":

Activate for all users

Step 22​

Click "Add page to app", select where it should appear and click "Save":

Add page to app

Step 23​

Save the SmallWorld page to complete configuration!

note

It is recommended to confirm the version of the app installed with SmallWorld. The AppExchange is updated at regular intervals but may not always have the most current version. If the installed version is outdated, SmallWorld can easily push an update to your Salesforce instance.

For questions and additional support please email support@smallworld.ai.