|
|
Existing Connected Apps continue to function and can be deployed to new orgs. This change does not affect editing, installation (through packaging or OAuth installation), or deletion of Connected Apps. For more information, see External Client Apps.
|
|
Field
|
Description
|
|---|---|
|
Fields marked with * are mandatory.
|
|
|
External Client App Name*
|
Enter a unique name for the External Client App. This name helps administrators identify the app in App Manager.
|
|
API Name*
|
Enter the API name used to reference the app programmatically. By default, the system derives this value from the app name by replacing spaces with underscores. Ensure that the API name is unique and uses
• only letters, numbers, and underscores
• starts with a letter
• does not include spaces
• does not end with an underscore
• does not contain consecutive underscores
|
|
Contact Email*
|
Enter an email address that Salesforce can use to contact you or your support team if needed. This email address is not shared with Salesforce admins who install the app.
|
|
Distribution State*
|
Select how the external client app is distributed.
• Choose Local to develop the app for use only in the current org.
• Choose Packaged to develop the app for packaging and distribution.
|

|
Field
|
Description
|
|---|---|
|
Fields marked with * are mandatory.
|
|
|
Enable OAuth
|
Select this checkbox to enable OAuth authentication for the external client app. OAuth must be enabled to allow secure, token-based access to Salesforce APIs.
|
|
Callback URL
|
Enter the URL that Salesforce redirects users to after successful authorization. This URL must match the callback URL configured in the client application.
You can enter one of the following URLs
• Sandbox Org: https://test.salesforce.com/services/oauth2/token
• Production Org: https://login.salesforce.com/services/oauth2/token
|
|
OAuth Scopes
|
Select the following scopes from Available OAuth Scopes and move them to Selected OAuth Scopes.
• Access the Salesforce API Platform (sfap_ap¡)
• Access the identity URL service (id. profile, email, address, phone) Full access (full)
• Full access (full)
• Manage user data via APIs (api)
• Perform requests at any time (refresh_token, offline_access)
|
|
Enable JWT Bearer Flow
|
Upload the self-signed digital certificate
|
|
|
To configure more fields, see Enable an OAuth Plugin.
|


|
Setting ID and Name
|
Setting Description and Value
|
|---|---|
|
SET001 - Publish SFA Notifications
|
Description: If this setting is True and Service Flow Automation configuration is enabled, Push notifications are sent from Salesforce. Default Value: False Setting Type: Group Recommendation: This setting must be set to True for the Group Profile of the user who is updating the Salesforce record and triggering a notification.
|
|
Setting ID and Name
|
Setting Description and Value
|
||
|---|---|---|---|
|
SET001 - Enable JWT Token for SFA
|
Description: Use JWT token for API access for SFA.
Default Value: False
Setting Type: Global
Recommendation: Set this to True.
|
||
|
SET002 - JWT Token End Point for SFA
|
Description: Token endpoint for JWT bearer token request for SFA. Default Value: https://login.salesforce.com/services/oauth2/token Setting Type: Global Recommendation: Set this to one of the below values based on the type of your org:
• Production Org - https://login.salesforce.com/services/oauth2/token
• Sandbox Org - https://test.salesforce.com/services/oauth2/token
|
||
|
SET003 - JWT Token Certificate Name for SFA
|
Description: Name of a certificate stored in Certificate and Key management. This will be used for OAuth access in SFA and should be associated with a Connected App configuration.
Default Value: No default value.
Setting Type: Global
Recommendation: Digital Certificate name, Example: JWT_Token
![]() |
||
|
SET004 - Issuer Details for SFA
|
Description: This is the consumer key for your connected app.
Default Value: NA
Setting Type: Global
Recommendation: Copy the consumer key when you created a connected app. Enter that same consumer key in this setting.
After the creation of a connected app, navigate to Salesforce Setup > Create > Apps. From the Apps page, go to the Connected Apps section and open the connected app. Copy the Consumer Key and enter it in ServiceMax Global setting SET004 (Module: Service Flow Automation, and Sub Module: Action Service). Refer to the settings table below to know more details about this setting.
![]() |
||
|
SET005 - Notification URL for SFA
|
Description: The push notification payload generated by SFA is sent to the notification URL defined in this setting. This notification is then sent to appropriate users' mobile devices.
Setting Type: Global
Recommendation: https://ns.servicemax-api.com/ns/v1/messages/platformDataEvents
|
||
|
SET006 - SMS URL for SFA
|
Description: The notification payload generated by SFA is sent to the SMS URL defined in this setting. This notification is then sent to appropriate users' phone numbers.
Default Value: https://ns.servicemax-api.com/ns/v1/sms
Setting Type: Global
Recommendation: https://ns.servicemax-api.com/ns/v1/sms
|
||
|
SET007 - Zinc Endpoint for SFA
|
Description: The message payload generated by SFA is sent to the Zinc endpoint URL defined in this setting. The message is then sent to the appropriate Zinc conversation.
Default Value: https://api.zincit.io
Setting Type: Global
|
||
|
SET008 - Allow Notification service to subscribe to Platform Event
|
Description: When the setting is set to True, SFA publishes the Platform Event to deliver the Push Notification or send SMS without using the Salesforce Future call.
This method of sending push notifications consumes additional Platform Events and also requires additional configurations. Contact ServiceMax Support.
Default Value: False
Setting Type: Boolean
|