Connected App Digital Signature Configuration

Issue Summary

Cuneiform for CRM requires the configuration of a Connected App to perform the API calls it leverages to profile and calculate Data Reliability KPI metrics. As part of the Connected App’s initial configuration, our documentation asks users to use digital signatures and assign a Digital Certificate to the Connected App.

When a Digital Certificate is uploaded via the new Connected App form – the certificate may not be persisted to the Connected App with the app is first created. This will result in the Cuneiform for CRM verification process failing via our Control Panel.

We’ve received reports from multiple customers and have been able to replicate this in our testing. This guide will explain how to identify, verify, and address this issue.

Issue Root Cause

The root cause of this issue is that the Connected App form will automatically populate the Salesforce Connected App’s API Name with a value derived from the label. When Salesforce seeds the API Name, it doesn’t remove : characters – which are invalid for API Names. The user is not notified of this exception until an attempt is made to save the Connected App.

Users can avoid this issue by checking the Connected App API Name field for the invalid : character before clicking on the Save button in the Connected App form.

If the user does not remove the : character from the Connected App API Name before clicking the Save button – an exception will be triggered by the form validation. The exception thrown will invalidate the association to the uploaded Digital Certificate – and require that the Digital Certificate be re-uploaded to the Connected App.

Confirm that the Issue May Exist

Customers can validate that their Connected App is configured properly by launching the Control Panel. Symptoms of a misconfigured Connected App via the Control Panel are:

• The Control Panel verifies that the Connected App exists

• The Control Panel is unable to successfully complete API authentication

Open

Use the Control Panel to verify that the Connected App exists – but may not be configured properly.

Check the Digital Certificate Configuration on the Connected App

Please follow these steps to inspect the Cuneiform for CRM: Connected App’s configuration and verify if a digital certificate is assigned and configured for the Connected App.

• Launch Setup

• In the quick find menu, search for the phrase App

• Under the Apps menu – select the menu option titled App Manager

• Locate the Cuneiform for CRM: Connected App – and view its properties

• Check the Connected App details for a configured digital certificate

Use the screen shots below as guides to validate if the Cuneiform for CRM: Connected App is configured to leverage a digital certificate. The Cuneiform for CRM: Connected App must have a digital certificate configured to support API access.

Open

No Digital Certificate Present

Open

Digital Certificate is Present

Review Our Connected App Digital Signature Setup Guide

Our Connected App Digital Signature Setup Guide contains a detailed walkthrough of the guidance outlined below. Use this guide for step-by-step instructions on configuring your Connected App to support digital signatures using your self-signed certificate.

Retrieve the Cuneiform for CRM: Self-Signed Certificate

If you’ve confirmed that the Connected App is missing a digital certificate, please retrieve the certificate created to support Cuneiform for CRM. After downloading it, you’ll assign this certificate to the Connected App.

• Launch Setup

• In the quick find menu, search for the phrase Cert

• Under the Security menu – select the menu option titled Certificate and Key Management

• Locate the Cuneiform for CRM: Self-Signed Certificate -- and view its properties

• Download the certificate – and save the file, as it will need to be uploaded to the Connected App

If the Cuneiform for CRM: Self-Signed Certificate was not found, please visit Create a Self-Signed Certificate documentation for guidance on creating the Certificate.

Assign the Self-Signed Certificate to the Connected App

Armed with a copy of the self-signed certificate, you can now use it to create the certificate association within the Cuneiform for CRM: Connected app. Please follow these instructions to upload the self-signed certificate to the Connected App.

• Launch Setup

• In the quick find menu, search for the phrase App

• Under the Apps menu – select the menu option titled App Manager

• Locate the Cuneiform for CRM: Connected App instance – and view its properties

• Click the Edit button to edit the configuration properties of the Connected App

• Check the Use Digital Signatures checkbox to assign the self-signed certificate

• Upload the Cuneiform for CRM: Self-Signed Certificate using the Upload button

• Save the Connected App properties – and acknowledge the 10 minute propagation message

• Verify that the Connected App properties now include a digital certificate reference

Open

A property configured Connected App will have a Digital Certificate Present in the OAuth Settings

Verify the Connected App Configuration via the Control Panel

With the Connected App configuration updated, you can use the Control Panel to validate its configuration. Navigating directly to the Control Panel with automatically trigger the validation process. You should see a display similar to the screen-shot below if the Connected App is configured correctly.

Open

The Connected App is configured correctly and able to support Authenticated API Access