Document Traces

Intro

Document Traces are records generated once a document is viewed. They are created for audit and traceability purposes.

Fields Reference

API Name	Label	Type	Sample Data	Description
b3d__Data_Version_ID__c	Data Version ID	string (18)	0688d000009Mb1nAAC	The id of the specific version of the Template used to render the document
b3d__Record_ID__c	Salesforce Record ID	string (18)	0038d00000GDmfDAAT	This is populated from the recordId URL parameter
b3d__Contact__c	Contact	Contact	0038d00000GDmfDAAT	Auto-identified Contact based on Salesforce Record ID
b3d__Account__c	Account	Account		Auto-identified Account based on Salesforce Record ID
b3d__Browser__c	Browser	string (255)	Chrome 105.0.0.0	Browser identificator
b3d__Browser_Language__c	Browser Language	string (255)	en-US	User language
b3d__Device_Screen_Details__c	Device Screen Details	string (255)	2560x1440 landscape-primary	User display properties
b3d__Document_Downloaded__c	Document Downloaded	boolean, required	TRUE	Whether or not the document was downloaded
b3d__Document_Signed__c	Document Signed	boolean, required	TRUE	Whether or not the document was signed
b3d__Document_Successfully_Rendered__c	Document Successfully Rendered	boolean, required	TRUE	Whether or not the document was rendered (displayed)
b3d__Completed_Document_Link__c	Completed Document Link	string (1300), html*	Link to completed document	A link to the static HTML recorded after successful download/signature
b3d__Dynamic_Document_Link__c	Dynamic Document Link	string (1300), html*	Link to generated document	A link to the generated document
b3d__Has_Error__c	Has Error	boolean, required	FALSE	Whether or not an error was encountered during generation
b3d__Error_Message__c	Error Message	textarea (131072)		Any error encountered during generation
b3d__Full_User_Agent__c	Full User Agent	textarea (255)	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36	Browser identification
b3d__IP_Address_V4__c	IP Address V4	string (15)	94.155.16.10	User IP address
b3d__Operating_System__c	Operating System	string (255)	Mac OS 10.15.7	User Operating System
b3d__Package_Version__c	Package Version	string (255)	1.7	App version at the time of completing the document
b3d__Template__c	Template	b3d__Template__c	a008d000007reNjAAI	A link to the Template
b3d__URL_Search_Params__c	URL Search Params	textarea (32768)	{"customParam1":"some value"}	Any URL params, standard or custom
b3d__Visitor_ID__c	Visitor ID	string (255)	Upg2bflKfqqhVVNfatt0	Unique visitor fingerprint

Auto-Mapping Lookups

You may have noticed that there are two Lookup Fields "Contact" and "Account" that get auto-populated if the Salesforce Record ID (recordId URL Param) matches a record in Salesforce. This happens automatically at the time of creating a new Document Trace (i.e. when a document is viewed). Relating Document Traces to Contacts/Accounts allows you to expose a related list of Document Traces on the Contact/Account page layout, showing an audit trail of each time when a document template has been interacted with by the specific Contact or Account.

Creating Custom Mappings

You can also create custom Lookup Fields to standard or custom objects, and the app will automatically identify the record and update the Lookup Field accordingly. For an example, if you want a Template to be generated off the back of a custom "Application" object record (or object from a Managed Package), then you just need to create a Lookup field on the Document Trace object that looks up to the Application object. From then on, the application will automatically populate the new Lookup Field with the ID of the merge record used for generation of the document.