Before beginning the installation and configuration process, gather the following items and make key decisions about your implementation. Having these ready will streamline the setup process.
Required for OAuth authentication. To obtain your Client ID:
- Log into your Onboarded account
- Navigate to Settings > Account using the left panel
- Click Edit Account
- Your Client ID is displayed at the top right of Account Settings
- Identify or create a dedicated Salesforce user for the integration
- This user will make API calls to Onboarded™
- Ensure this user has access to all objects and fields needed for synchronization
- This user should have the Onboarded™ Admin permission set assigned
- Identify the user who will schedule automated sync jobs
- Batch jobs run as the user who schedules them
- This user must have access to all objects, fields, and Apex classes required for sync operations
- Decide whether to use the package's custom objects or your existing Salesforce objects
- If using existing objects, identify which objects will store each Onboarded™ entity type:
- Employees (e.g., Contact, Lead, Person Account, or custom object)
- Employers (e.g., Account or custom object)
- Clients (e.g., Account or custom object)
- Jobs (e.g., custom object)
- Placements (e.g., custom object or junction object)
- If using your own objects, ensure they have fields for:
- Onboarded™ ID (unique external identifier)
- Last Sync timestamp (Employee object only)
- Review the Onboarded™ API documentation to understand available fields
- Map Onboarded™ fields to your target Salesforce fields
- Determine which fields require custom data transformations
- Decide on data authority rules for each field (who wins in a conflict?)
- Which entity types do you want to sync? (Employees, Employers, Tasks, etc.)
- Should the application create new records, or only update existing ones?
- What sync frequency do you need? (Hourly, daily, weekly)
- Do you need to store signed PDF documents in Salesforce?
Tip: Create a configuration worksheet documenting all these decisions before you begin. This will serve as a reference during setup and help ensure consistency.