Connected App Digital Signature Setup Guide
This documentation provides a walkthrough demonstrating how to enable digital signatures in the Cuneiform for CRM: Connected App. It provdes step-by-step guidance on how to associate the Cuneiform for CRM: Self-Signed Certificate to the Cuneiform for CRM: Connected App.
APPLIES TO | CUNEIFORM FOR CRM FIELD AND DATA MANAGEMENT
The final steps in our accelerated Apex Script-Driven Configuration are:
Confirm that the Apex Scripts updated the Active Configuration Profile in your Salesforce Org.
Manually configure the Connected App to use digital signatures with your self-signed certificate.
The first section of this guide will describe how to view the details of the Active Configuration Profile – and confirm that our Apex Scripts updated it. The second will explain how to apply the self-signed certificate to the Connected App – and enable digital signatures.
Confirm Your Configuration Updates
The last Apex Script in our configuration guidance is responsible for 1) creating the Connected App used by Cuneiform for CRM to securely access Salesforce's Query, Metadata, and Tooling APIs and 2) updating Cuneiform for CRM's Active Configuration Profile with the configuration details for your Salesforce Org.
We’ll open the Active Configuration Profile custom metadata and verify that the Apex Scripts have correctly updated it with the configuration details of your Salesforce org.
Please note that this guidance should only be followed if you’ve decided to configure your Cuneiform for CRM installation with our Apex Scripts – and have completed their execution. This walkthrough requires that you complete the steps in our Apex Script-Driven Configuration guidance first.
Locate and Inspect the Cuneiform for CRM Active Configuration Profile
The Cuneiform for CRM: Active Configuration Profile is managed via Salesforce’s Custom Metadata Types. You can access the profile by searching for custom meta
in the Setup quick find menu – and selecting Custom Metadata Types from the navigation menu.
Locate the metadata type named Cuneiform: Configuration Profile
from the All Custom Metadata Types display. Click the Manage Records link to open the metadata type and inspect its records.
The
Active Configuration Profile
will be one of the records visible after clicking on the Manage Records Link. We'll open the Production record and inspect its configuration details.
Please locate the Production configuration profile from the Configuration Profiles display. This profile manages the configuration Cuneiform for CRM uses during its operation within your Salesforce Org.
Open the
Production
configuration profile by clicking on the Production record name link. This will open the record detail display – allowing you to inspect the details of the record.
Please navigate to the Connected App section of the Active Configuration Profile’s record detail page and verify that our Apex Scripts have filled in the Connected App properties.
Property Name | Expected Value |
---|---|
Certificate Unique Name |
|
Connected App Label |
|
Connected App Consumer Key | Your Connected App’s Consumer Key. |
Please note that the Connected App Consumer Key is a unique value across all Salesforce orgs and Connected App instances. We generate this a value for this key from within our Apex Script – and apply it to the Cuneiform for CRM Active Configuration Profile.
Confirm that the three Connected App properties were successfully updated. Verify that these updates are accompanied by a Last Modified By entry referencing your Salesforce user and the time that the last Apex Script was executed.
Once you’ve confirmed the Connected App configuration properties were successfully updated – you can now proceeed to the final configuration task: completing the configuration of your Connected App and enabling Cuneiform for CRM to securely access Salesforce REST APIs.
Configure Your Connected App to Use Digital Signatures
Using the quick field menu in Salesforce Setup, please find the App Manager
in the navigation menu -- and open it. The App Manager displays both Lightning and Connected Apps in your Salesforce org.
From the App Manager display, locate the Cuneiform for CRM: Connected App in the listing. Applications are listed in alphabetical order. Use the App Type column to differentiate between Connected, Lightning, and Classic applications.
Once the Cuneiform for CRM: Connected App
has been found, use the pull-down menu and select the Edit option to edit the Connected App details.
You’ll need to edit the Connected App to enable digital signatures – and upload the self-signed certificate to the Connected App. We’ll walk through those steps next.
Please scroll down to the API (Enable OAuth Settings) section in the Connected App edit form and find the Use digital signatures
checkbox.
We’ll use this checkbox to enable digital signatures for the Connected App – and upload the self-signed certificate to the Connected App.
Check the checkbox to configure the Connected App to use digital signatures. Clicking the checkbox will expose the Choose File button. We’ll use this button to upload the self-signed certificate.
Click on the Choose File button to launch the file selection modal – and use the modal to find self-signed certificate on your local file system. You’ll need the certificate for the next step in this guide.
Find the Cuneiform for CRM: Self-Signed Certificate from your local file system and upload it to the Connected App form. The self-signed certificate will have the certificate’s API name as a file name with a .crt
extension.
Verify that the self-signed certificate was successfully uploaded to the Connected App. The Connected App form should update to display a truncated version of the self-signed certificate’s file name.
Scroll to the top (or bottom) of the Connected App form and click on the Save button to persist the updates. Saving will enable digital signatures for the Connected App using your self-signed certificate.
When the Connected App record detail page reloads – scroll down to the API (Enable OAuth Settings) and find the Digital Certificate
property. Verify that a digital certificate is visible, and confirm that the CN
property references the self-signed certificate’s API Name.
The API Name for the certificate should be
Cuneiform_for_CRM_Self_Signed_Certificate
.
Congratulations! You’ve just completed your configuration – and are now ready to use our Cuneiform for CRM: Control Panel to test it and confirm you’re ready to profile.
Verify Your Configuration
To quickly verify your configuration, please search for Cuneiform in the App Launcher – and confirm that the Cuneiform for CRM: Control Panel item appears in the search results.
Open the Control Panel to test your configuration – and verify that you’re ready to profile.
Opening the Cuneiform for CRM: Control Panel will automatically test your configuration. If your configuration passes the configuration tests, a green banner will congratulate you on successfully configuring Cuneiform for CRM.
The green banner indicates that you’re now ready to profile objects in your Salesforce Org. A red banner, however, indicates that a configuration issue exists. Use our Control Panel Troubleshooting Guide to address configuration issues.
Congratulations! You’ve completed and verified your Cuneiform for CRM configuration (excellent work). Use our data profiling guide to learn how to profile the Salesforce Objects in your org.