Business user guide
Before diving into the integration process, it’s essential to have a basic understanding of Coherent Spark. We recommend starting with the Get started in 5 minutes guide for a quick overview.
Additionally, ensure your Salesforce developers have already built the necessary Spark-related components for the integration. This will allow you to focus on the administrative setup without interruptions.
This guide is intended for Salesforce Admins responsible for the integration in their Salesforce DevHub or Scratch org. It also assumes that you have some basic understanding of Salesforce and its terminologies.
Prerequisites
To get started, you will need the following:
Access to your Salesforce DevHub/Scratch org.
Access to your Coherent Spark account (with at least one Spark service).
As you know by now, your Spark service is a representation of your Excel-based business operations available as a RESTful API accessible via HTTP requests in a secure manner.
Always confirm that your Excel model is working as expected before uploading it to Spark. Once uploaded, refer to the Execute API resource or API Tester for more details on your Spark settings.
Locate your Spark settings
After setting up the Spark service, gather the following information to configure Spark settings in your DevHub org. This is crucial for the initial step of the integration process. The necessary fields include:
Base URL: The Spark engine URL (e.g.,
https://excel.{environment}.coherent.global).Tenant Name: The name of your Spark tenant.
Synthetic Key: Synthetic keys a.k.a Authorization - API keys are used for authentication and authorization. Contact your Spark admin if needed to obtain the synthetic key. Keep in mind that Spark offers other security schemes such as Client Credentials.
Service URI: an identifier to locate your service, usually folder and service names. Visit the Execute API to learn more about it.
Set up Spark Settings as Custom Metadata
Now that you have the Spark settings, you can set them up as Custom Metadata in your DevHub org.
Start by adding the following details to the Spark Settings custom metadata, which should be editable by subscribers org. This custom metadata type is shipped with the Connector. Read more about how to handle Custom Metadata Types if needed.
Here's an example of what the Spark settings may look like:
Setting name
my-setting
Base URL
https://excel.myenvironment.coherent.global
Tenant name
my-tenant
API key
599*****69a9
The Setting name should be a unique name used just for traceability purposes.
Build Flow or LWC components
Ideally, Salesforce developers on your team should help you build Flow or LWC components to calls existing Apex stubs to interact with the Spark service. Of course, if you have web development experience, you may follow these guides and examples from Lightning Design System and LWC Component Library.
Otherwise, use the Developer guide that includes instructions on how to customize components using HTML, JavaScript, and CSS, to build your desired app.
Last updated