Overview
Welcome to Propper for Salesforce Beta! This guide will walk you through the complete setup process for integrating Propper Sign signature capabilities into your Salesforce environment. Propper currently includes the Propper Sign product, with Propper Docs coming in future releases to handle Document Generation.
Prerequisites
Before beginning the setup process, ensure you have:
System Requirements
- Salesforce Edition: Development, Sandbox
- API Version: 62.0 or higher
- User Permissions: System Administrator access
- Browser: Chrome, Firefox, Safari, or Edge (latest versions)
Account Requirements
- Propper Sign Account: Active subscription with API access
- API Credentials: Client ID and Secret from your Propper Sign account
Technical Requirements
- Remote Site Settings: Configured for Propper Sign API endpoints
- Permission Sets: Ability to assign user permissions
Installation
Step 1: Install the Propper Beta Package
For Sandbox Orgs
- Navigate to the installation URL:
https://login.salesforce.com/packaging/installPackage.apexp?p0=04tao0000017aJ7AAI
For Scratch Orgs
-
Get Instance URL: Use
sf org display --target-org [your-scratch-org-alias]
to get the Instance URL -
Navigate to the installation URL: Replace
login.salesforce.com
with your scratch org's instance URL:
https://[your-instance-url]/packaging/installPackage.apexp?p0=04tao0000017aJ7AAI
Note: The package ID 04tao0000017aJ7AAI
remains the same for
all org types - only the domain changes for scratch orgs.
Installation Options
-
Choose Installation Options:
- Install for Admins Only: Recommended for initial setup
- Install for All Users: Choose after completing setup
- Install for Specific Profiles: Advanced option for controlled rollout
-
Grant API Access:
- Check "Yes, grant access to these third-party web sites"
- Review and accept the terms
-
Complete Installation:
- Click "Install" and wait for completion
- You'll receive an email confirmation when installation is complete
Step 2: Verify Installation
-
Check Installed Packages:
- Navigate to Setup > Installed Packages
- Verify "Propper Sign" is listed and active
-
Verify Components:
-
Custom Objects:
propperSign_Settings__c
,propperSign_Workflow__c
, etc. -
Permission Sets:
propper_Admin
(all Propper products),propperSign_User
(Sign product only) -
Apex Classes:
PropperSignAdminController
,PropperSignWorkflowController
-
Lightning Components:
propperSignAdmin
,propperSignWorkflows
-
Custom Objects:
Setup Wizard
Accessing the Setup Wizard
After installation, use the automated setup wizard for guided configuration:
-
Navigate to Setup Wizard:
- Go to App Launcher > Search for "Propper Setup"
- Click on the "Propper Setup" tab
- The setup wizard will launch automatically
-
Follow the Setup Steps:
The wizard will guide you through 5 main steps:
Step 1: Permission Sets
- Purpose: Assign appropriate permissions to users
-
Actions:
-
Select admin users for
propper_Admin
permission set (manages all Propper products) -
Select end users for
propperSign_User
permission set (Sign product only)
-
Select admin users for
-
Tips:
- Admin users can configure settings and manage all Propper product workflows
- Standard users can create and send signature requests for their assigned products
Step 2: API Configuration
- Purpose: Configure API credentials and authentication
-
Required Information:
- Environment: Demo or Production
- API Client ID: From your Propper Sign account
- API Secret: From your Propper Sign account
- Security: Credentials are stored in Salesforce custom settings
- Note: This step handles both API credentials and the necessary named credential configuration automatically
Step 3: Admin Page Configuration
- Purpose: Verify admin page access
- Automatic: Admin page is automatically available after permission assignment
- Access: Available through the "propperSign Admin" tab
Step 4: LWC Actions Configuration
- Purpose: Configure Lightning Web Component actions and record page components
- Automatic: Actions are configured when workflows are created
- Supported Objects: Account, Contact, Lead, Opportunity, Case
-
Record Page Configuration:
- Use the "Configure Record Pages" button to access Lightning App Builder
- Add the "Packet Info" component to your desired record pages
- This component displays signature request status and packet information on records
Step 5: Workflow Configuration (Optional)
- Purpose: Create sample workflow for testing
-
Options:
- Create a sample workflow with a selected template
- Skip and create workflows later
-
Configuration:
- Select object type (Account, Contact, Lead, Opportunity, Case)
- Choose template from your Propper Sign account
- Define workflow name and settings
Manual Setup Instructions
If you prefer manual setup or need to configure specific settings:
1. Configure API Settings
-
Navigate to Custom Settings:
- Setup > Custom Settings
- Click "Manage" next to "propperSign Settings"
-
Create Organization Setting:
- Click "New"
-
Enter your API credentials:
- API Client ID: From Propper Sign account
- API Secret: From Propper Sign account
- Environment: Demo or Production
- Click "Save"
2. Assign Permission Sets
-
Navigate to Permission Sets:
- Setup > Permission Sets
- Select "propper_Admin" or "propperSign_User"
-
Assign to Users:
- Click "Manage Assignments"
- Click "Add Assignments"
- Select appropriate users
- Click "Assign"
3. Configure Remote Site Settings
-
Navigate to Remote Site Settings:
- Setup > Remote Site Settings
-
Verify these remote sites exist:
https://api.propperdocs.ai
https://api.demo.propperdocs.ai
-
Add If Missing:
- Click "New Remote Site"
- Enter the URL and mark as "Active"
4. Configure Record Pages (Manual)
-
Navigate to Lightning App Builder:
- Setup > User Interface > Lightning App Builder
- Edit the record pages where you want to display packet information
-
Add Packet Info Component:
- Drag the "Packet Info" component to your record page
- Configure component settings as needed
- Activate the updated page
Post-Setup Configuration
1. Create Workflows
-
Navigate to Workflows:
- App Launcher > Propper Sign Workflows
- Click "New Workflow"
-
Configure Workflow:
- Name: Descriptive name for the workflow
- Template: Select from your Propper Sign templates
- Delivery Method: Email (recommended)
- Email Subject: Subject line for signature requests
- Email Message: Custom message for recipients
-
Set Participant Mappings:
- Define how Salesforce fields map to signature participants
- Configure email and name field mappings
2. Configure Object Actions
-
Navigate to Workflow Metadata:
- App Launcher > propperSign Admin
- Go to "Workflow Configuration" section
-
Create Action Configuration:
- Select object type (Account, Contact, Lead, Opportunity, Case)
- Choose which workflows apply to this object
- Optionally configure phase-specific workflows
3. Test Integration
-
Create Test Record:
- Create a test Account, Contact, or Opportunity
- Add relevant contact information
-
Send Test Signature Request:
- Open the test record
- Click "Send for Signature" action
- Select workflow and verify configuration
- Send test packet
-
Verify Functionality:
- Check email delivery
- Verify signature process
- Confirm status updates in Salesforce
- Verify packet information displays on record page
Testing Your Setup
Test Checklist
- Permission Assignment: Verify users can access appropriate components
- API Connection: Test API connectivity in admin page
- Template Loading: Verify templates load from Propper Sign
- Workflow Creation: Create and save a test workflow
- Action Configuration: Configure actions for at least one object type
- Record Page Configuration: Add Packet Info component to record pages
- Signature Request: Send a test signature request
- Status Tracking: Verify packet status updates in Salesforce and on record pages
Common Test Scenarios
-
Basic Signature Request:
- Create Opportunity with Contact
- Send for signature using configured workflow
- Verify email delivery and signature process
- Check packet status on record page
-
Multi-Participant Workflow:
- Configure workflow with multiple participants
- Test participant sequencing
- Verify all participants receive requests
-
Phase-Specific Workflows:
- Configure different workflows for different opportunity stages
- Test phase transitions
- Verify correct workflow selection
Troubleshooting
Common Issues
1. API Connection Problems
Symptoms: Cannot load templates, API errors
Solutions:
- Verify API credentials in custom settings
- Check API Client ID and Secret
- Ensure remote site settings are active
- Verify Propper Sign account has API access
2. Permission Issues
Symptoms: Users cannot access components
Solutions:
- Verify permission sets are assigned correctly
- Check object and field permissions
- Ensure tab visibility is configured
- Verify profile permissions if needed
3. Workflow Configuration Issues
Symptoms: Workflows don't appear in actions
Solutions:
- Verify workflow metadata is configured
- Check object type mapping
- Ensure workflows are not in preview mode
- Verify action configuration for the object
4. Email Delivery Problems
Symptoms: Recipients don't receive signature requests
Solutions:
- Check email configuration in workflow
- Verify participant field mappings
- Ensure email addresses are valid
- Check Propper Sign account email settings
5. Record Page Component Issues
Symptoms: Packet Info component not displaying
Solutions:
- Verify component is added to record page
- Check component permissions
- Ensure record page is activated
- Verify component placement and settings
Error Messages
Error | Cause | Solution |
---|---|---|
"Invalid API credentials" | Incorrect Client ID/Secret | Verify credentials in custom settings |
"Permission denied" | Missing permission sets | Assign appropriate permission sets |
"Template not found" | Template ID mismatch | Verify template exists in Propper Sign |
"Workflow not configured" | Missing workflow metadata | Configure workflow metadata for object |
Log Files and Debugging
-
Enable Debug Logs:
- Setup > Debug Logs
- Create log for affected user
- Set log level to "Debug"
-
Check System Logs:
- Monitor logs during API calls
- Look for authentication errors
- Check for permission issues
-
Use Developer Console:
- Open Developer Console
- Run anonymous Apex for testing
- Check for compilation errors
Support
Getting Help
- Documentation: Refer to this guide and in-app help
- Setup Wizard: Use the automated setup wizard for guided configuration
- Admin Page: Check system status and configuration in admin page
- Support Portal: Access support through your Propper Sign account
Contact Information
- Technical Support: [Support Portal URL]
- Sales Questions: [Sales Contact]
- Documentation: [Documentation URL]
Preparing for Support
When contacting support, have ready:
- Salesforce org ID
- Propper Sign account information
- Error messages or screenshots
- Steps to reproduce the issue
- User permission details
Appendix
A. API Endpoints
- Production:
https://api.propperdocs.ai
- Demo:
https://api.demo.propperdocs.ai
B. Required Fields
propperSign_Settings__c
API_Client_Id__c
(Text, 255)API_Secret__c
(Text, 255)Environment__c
(Text, 50)
propperSign_Workflow__c
Name
(Text, 80)Template_Id__c
(Text, 18)Delivery_Method__c
(Text, 50)Email_Subject__c
(Text, 255)Email_Message__c
(Long Text Area, 32768)
C. Object Relationships
propperSign_Workflow__c
├── propperSign_Template_Participant__c (Master-Detail)
└── propperSign_Packet_Mapping__c (Lookup)
propperSign_Packet_Change__c
└── Opportunity__c (Lookup)
D. Future Enhancements
- Propper Docs: Document generation capabilities
- Advanced Workflows: Conditional logic and branching
- Integration APIs: Additional third-party integrations