DC Entry - URL Addressable

Last published at: November 18th, 2024
Delete

The DC Entry Lightning Component can be accessed via a URL that can be built up with several parameters to configure the form. Create a link that opens a DC Entry page for a specific object and record type, and with pre-populated values. In addition, a success or cancel URL can be set.

Base Path 

To open the DC Entry page via a link, the URL should contain the base path, which is placed after the Salesforce domain.
In addition, configure the form by adding one or more parameters. The c__objectApiName parameter is required, to indicate the object. Other parameters are optional.

From DC version 3.362 onward, the base path for opening the DC Entry component is:

    /lightning/cmp/dupcheck__dc3EntryRecordForm?
Delete

In older versions of DC, the base path used to be /lightning/cmp/dupcheck__dc3RecordFormByUrl? This base path will still work for now, but will be deprecated in the future.

Parameters

Build your link by placing the required c__objectApiName parameter after the base path's question mark. If you want to add additional parameters, separate the parameters with the "&" character. 

For example: c__objectApiName=Account&c__recordId=00Q090000011OGpEAM

When using IDs, make sure to use 18-character IDs.

Parameter

 Description Example
c__objectApiName The Object API Name. This parameter is required.  c__objectApiName=Account
c__recordId A Record ID. Use this parameter to open and edit a specific record. Use an 18-character ID, or add the CASESAFEID() method to guarantee an 18-character ID. c__recordId=00Q090000011OGpEAM
c__recordTypeId A Record Type ID. Use this parameter to create a record with a certain record type. Use an 18-character ID, or add the CASESAFEID() method to guarantee an 18-character ID. c__recordTypeID=012090000008VO0AAM
c__defaultValues To pre-populate field values in the form, use a URL encoded JSON string as value.  For an example, see the Setting Default Values section below. 
c__successUrl Use this parameter to override the URL target after a record is successfully saved.  c__successUrl=https://www.duplicatecheck.com
c__cancelUrl Use this parameter to override the URL target if the user clicks the cancel button.  c__cancelUrl=https://www.duplicatecheck.com

Example

Using some example parameters as explained above, an example URL for opening a DC Entry form with certain predefined characteristics could look as follows:

https://yourSFORGname.lightning.force.com/lightning/cmp/dupcheck__dc3EntryRecordForm?c__objectApiName=Account&c__recordId=00Q090000011OGpEAM

Setting default values

To pre-populate values in the DC Entry form, use the c__defaultValues parameter. The value for this parameter should be a URL encoded JSON string. There are many free online tools that can help you with encoding JSON.

Input:

 {
 "Field_API_Name" : "Value",                        // For example - "Email" : "ruben@plauti.com" //
 "Field_API_Name2" : "Value"
}

Output:

%20%7B%0A%20%22Field_API_Name%22%20%3A%20%22Value%22%2C%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%0A%20%22Field_API_Name2%22%20%3A%20%22Value%22%0A%7D
/lightning/cmp/dupcheck__dc3EntryRecordForm?c__objectApiName=Lead&c__defaultValues=%20%7B%0A%20%22Field_API_Name%22%20%3A%20%22Value%22%2C%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%0A%20%22Field_API_Name2%22%20%3A%20%22Value%22%0A%7D