External Client Apps

Several Revenova-supported integrations require a Salesforce External Client App to communicate data between the TMS and the integration partner. Create an External Client App for each third-party integration the customer uses. Run the app as the API User.

For more information, see Salesforce documentation for External Client Apps.

Integration Partners

The following partner integrations require an External Client App to send and receive information with a customer org:

• Blue Yonder

• Border Connect

• Comdata Fuel Cards

• Highway Carrier Onboarding

• Pub/Sub Accounting

• Trimble Maps

• RevenovaWebService

Follow the steps in the Set up External Client App Access heading to create a new External Client App. Some integrations require additional setup before they can be used.

Note: If these integration partners were initially created as a Connected App, you can easily migrate the same setup into an External Client App. Follow these Salesfoce instructions for migrating a Connected App to an External Client App.

EDI Partner VANs

The Revenova TMS uses REST endpoints to allow for EDI Partner VANs to send EDI transactions to each customer org. To successfully receive these EDI transactions, each Partner VAN must have an External Client App created.

The TMS supports transactions from Kleinschmidt, Cleo, and a single Custom EDI or other Partner VAN. Multiple connections are supported for a single org, but only with a single Custom EDI Partner.

Refer to the REST API Settings for more information on getting started with EDI transactions.

Time Zone Note: The time zone used by the REST API process is the Automated Process User’s time zone. Time zones are first determined based on the time zone specified in the EDI Transaction record.

When a time zone is not specified or a location update does not contain a time zone, the time zone of the API User or other context user set for the VAN on the Load is used to determine the time zone.

Best Practices

• Create an External Client App for each required integration used in the customer org.

• Create one API User and apply the appropriate packaged Permission Sets to that user for each required integration.

  • The RevenovaWebService integration does not include a packaged permission set. Create or add a permission set with the required permissions.

• The API User requires a TMS and Salesforce integration license.

API User

Create an API User or Users to run the External Client Apps for a customer org. Add only the necessary permission sets for the integrations a customer is using.

Note: Each EDI Partner VAN requires a unique API User or context user to properly sort and process EDI transactions. Create an API User for each External Client App for a Partner VAN integration.

Create the API User

1. Go to Setup → Users, select the New User button and create a User with the following values:

   • First Name: API

   • Last Name: User

   • Email: Set to the System Administrator’s email address

   • Username: Automatically generated, change if necessary

   • User License: Salesforce Integration

   • Profile: Minimum Access - API Only Integrations

   • Active: Checked

2. Set the remaining required User fields as desired.

3. Select Save.

4. Go to Setup → Users, select the API User.

5. In the Permission Set Assignments section, select the Edit Assignments button.

6. Select each permission set for all integrations the customer uses. Click the Add button to add the permission sets to the Enabled Permission Sets column. The following table of permission sets are packaged in the TMS and intended for use with the associated integration.

7. Select Save.

   Integration	Permission Set
   Border Connect	Border Connect API User
   Comdata Fuel Cards	Comdata API User
   Highway Carrier Onboarding	Highway API User
   Pub/Sub Accounting	TMS Accounting Integration
   Blue Yonder	TMS Blue Yonder API
   Kleinschmidt, Cleo, and Custom EDI	TMS EDI API
   Trimble Maps	Trimble API User

Set up External Client App Access

External Client Apps allow third-party applications to integrate with Salesforce via APIs that use standard protocols to authenticate and authorize them. Create an External Client App for each partner integration that requires one.

While the API User is used by multiple External Client Apps, a single app does not work for multiple partner integrations. Refer to the Salesforce documentation about External Client Apps to learn more.

Create all required External Client Apps by following these steps.

Step 1: Allow Authorization Code and Credential Flows

1. Got to Setup → OAuth and OpenID Connect Settings.

2. Set Allow Authorization Code and Credentials Flows to On.

Step 2: Create a New External Client App

This example uses the Border Connect integration to demonstrate how to create an External Client App.

1. Go to Setup → App Manager, and select the New External Client App button.

   Note: If there is already an existing External Client App, you can also go to Setup → External Client App Manager to create a new app.

2. Enter the following information for the integration:

   1. External Client App Name: Border Connect

   2. Contact Email: Set to the System Administrator’s email address

   3. Enable OAuth: Checked

   4. Callback URL: https://login.salesforce.com

   5. Selected OAuth Scopes: Manage user data via APIs (api)

   6. Enable Client Credentials Flow: Checked

3. Click Create.

Step 3: Access the Consumer Key and Consumer Secret

Several integrations require the Consumer Key and Consumer Secret to complete setup. Typically, the Consumer Key and Consumer Secret must be sent to Revenova along with the 18-character Organization ID to complete the setup. Refer to the specific integration articles to determine if this information is required before completing the following steps.

To get the 18-character Organization ID, follow these steps:

1. Select the Setup Menu (Gear) button → Developer Console.

2. Select the Query Editor tab.

3. Enter SELECT Id FROM Organization into the SOQL query field.

4. Click the Execute button.

5. Copy the 18-character Organization ID for later use.

To get the Consumer Key and Consumer Secret, follow these steps:

1. Go to Setup → External Client App Manager.

2. Select the External Client App to view the details of the app.

3. Select the Settings tab and open the OAuth Settings expander.

4. Click the Consumer Key and Secret button.

   

5. Salesforce sends a verification email to the System Admin’s email address. Enter this code in the Verify Your Identity page.

6. Copy the Consumer Key and Consumer Secret for later use.

7. Select the Switch to Lightning Experience.

   

Step 4: Set Client Credentials Flow Run As User

1. Go to Setup → External Client App Manager.

2. Select the External Client App to view the details of the app.

3. Select the Settings tab and select Edit.

4. Open the OAuth Policies expander and check Enable Client Credentials Flow.

5. Enter the Username of the API User to set the Run As user.

6. Click Save.

Blue Yonder Additional Setup

Complete the following additional steps to finish the Blue Yonder integration setup.

Add Trusted IP Range for OAuth Web Server Flow

1. Go to Setup → External Client App Manager.

2. Select the Blue Yonder app.

3. Select the Settings tab and select Edit.

4. Open the OAuth Policies expander.

5. In the Trusted IP Ranges for OAuth Web Server Flow section, select the Add button and add the following IP ranges:

   • Start IP Address, End IP Address: 20.122.40.48.

   • Start IP Address, End IP Address: 52.177.14.131.

   • Start IP Address, End IP Address: 52.247.78.106.

6. Click Save.

Domain URL

The following endpoints are sent to Blue Yonder for setup within their system:

• OAuth authorization endpoint: https://{domain}/services/oauth2/token

• Quote request endpoint: https://{domain}/services/apexrest/rtms/blueyonderloadservice

• Tender request endpoint: https://{domain}/services/apexrest/rtms/blueyondertenderservice

Each org must send these endpoints to Blue Yonder to complete setup.

Note: {domain} can be found under Setup → My Domain → Current My Domain URL.

Pub/Sub Accounting Additional Setup

The accounting partner requires the domain for setup within their system. Each org must send its domain to the accounting partner to complete the setup.

Note: {domain} can be found under Setup → My Domain → Current My Domain URL.