SuccessPro Embedded Relay Installation ( LEGACY CONNECTED APP )

SuccessPro Embedded Relay Installation ( LEGACY CONNECTED APP )

SuccessPro Embedded Relay Installation (Legacy Connected App)

Create the Connected App

  • Navigate to Setup -> Apps -> App Manager and click "New Connected App".

Setting up SuccessPro Embedded Relay

Fill in the form as follows:
    Connected App Name: SuccessPro Embedded Relay
    API Name (must be exact - matches the component's default): SuccessPro_Embedded_Relay
    Email
    API (Enable OAuth Settings)
  • Enable OAuth Settings: true
  • Callback URL: https://[tenant].actifi.com/api/v3/app/salesforce/consume-signed-request
  • Selected OAuth Scopes:
  • Access unique user identifiers (openid)
  • Perform requests at any time (refresh_token, offline_access)
    Canvas App Settings:
  • Canvas:
  • true / checked
  • Canvas App URL: https://[tenant].actifi.com/api/v3/app/salesforce/consume-signed-request
  • Access Method:
  • Signed Request (POST)
  • Locations:
  • Lightning Component

Provide ActiFi with the Consumer Key and Secret

  • Return to the App Manager, locate the new Connected App, and from the dropdown at the right, select "View". Next, click "Manage Consumer Details".
  • Copy the Consumer Key and Consumer Secret and send both to ActiFi.

Security Setup

  • Navigate to Setup -> Apps -> Connected Apps -> Manage Connected Apps and click "Manage" next to the SuccessPro Embedded Relay app.
  • Under OAuth "Edit Policies", set the following:
  • Permitted Users: Admin-approved users are pre-authorized.
  • Navigate to Setup -> Users -> Profiles, and for each profile that requires access, click "Edit" and select the following:
  • Under Connected App Access, select "SuccessPro Embedded Relay".
  • Under Administrative Permissions, select "API Enabled".

Adding the Component to a Record Layout

If you haven't already, install the SuccessPro_Embedded_Content Lightning Component via the link supplied by ActiFi. When prompted, leave the default "Install for Admins Only" selected.
Note: To install the package, your instance must be utilizing "My Domain".
  • Navigate to the record layout where you want to install the component (any object - Account, Contact, User, or a custom object).
  • Select "Edit Page" from the gear icon at the top right.
  • Add an additional tab to the layout, named "SuccessPro" or other custom name.
  • Select the SuccessPro_Embedded_Content component from the Components menu on the left.
  • Drag the component into the new tab.
  • Configure properties:
  • Relay State (required): the relay state name provided by ActiFi.
  • Connected App Name (required): defaults to SuccessPro_Embedded_Relay - override only if the External Client App above was named differently.
  • Alternate Salesforce Id Field (optional): API name of a field on this record to use instead of the record's own Id.
  • Alternate SuccessPro Id Field (optional, advanced): which SuccessPro column to match the lookup value against. Valid values: userId, sforceContactId, sforceUserId, sforceLeadId, tenantSpecificUserId, username. Work with an ActiFi developer to determine the correct value for your use case.
  • Team Context: Work with an ActiFi Developer to configure
  • Component Height (pixels)
  • Component Top Margin (pixels).
  • Click "Save".

Supported Relay State Types

These reflect a resolved target user (e.g. Contact record); User Dashboard


Error Messages

Title
What it means
Invalid Signed Request
The signed_request could not be verified. Check that the Consumer Key/Secret on the Connected App match what ActiFi has on file.
No Relay State Configured
The component's Relay State property is blank. Set it in the page's Setup properties panel.
User Not Found
No SuccessPro user was found for this Salesforce User Id. Contact your SuccessPro representative.
Unable to Resolve SuccessPro User
Either the Alternate Salesforce/SuccessPro Id Field properties didn't resolve to a SuccessPro user, or the configured Salesforce field is blank on this record. Verify those properties and that the field has a value.
Invalid Relay State
The configured Relay State value doesn't match one ActiFi has set up. Verify the value with your SuccessPro representative.
System Error
An unexpected error occurred. Contact your SuccessPro representative if it continues.