Salesforce

Please note that we have a brand new Lightning App available which offers a lot more functionality than our installable package detailed below. We will be updating documentation about the Lightning App soon, but if you are seeking to install and integrate it in your environment, please contact our support team to assist! Link to support: https://support.vomevolunteer.com/

A centralized reference for administrators on installing, configuring, and maintaining the two-way Vome ↔ Salesforce integration.

---

1. Installation & First Steps

Q: How do I install the Vome package?

1. In Salesforce Setup, navigate to Apps → Packaging → Installed Packages

2. Click Install a Package

3. Paste the Subscriber Package Version ID (04tgK00000030ptQAA) or the install URL:

   https://login.salesforce.com/packaging/installPackage.apexp?p0=04tgK00000030ptQAA

4. Click Next → Install for All Users → Install

5. Wait 5–10 minutes; you’ll receive an email when installation completes.

Q: How do I verify the install?

• Confirm the Vome Data custom object (VomeData__c) is present.

• Under Setup → Scheduled Jobs, ensure Vome Processor is scheduled.

• Under Setup → Custom Metadata Types, verify FieldmapBundle__mdt and Fieldmap__mdt exist.

---

2. Configuration

Q: Where do I configure the API endpoint and key? All callouts use the Named Credential VomeAPI:

1. Setup → Security → Named Credentials → New

2. Label: VomeAPI | Name: VomeAPI

3. URL: https://api.vomevolunteer.com

4. Identity Type: Anonymous

5. Uncheck “Generate Authorization Header”

6. Under Custom Headers, add:

   • Header Name: API-KEY

   • Header Value: Your Vome API Key

7. Click Save

---

3. Field Mapping

Q: Which Vome fields sync by default?

• First Name, Last Name, Email.

Q: How do I map additional fields?

1. Setup → Custom Metadata Types → Fieldmap__mdt → New

2. Enter:

   • Bundle: Contact_Default_Bundle (or your bundle)

   • Vome Field: JSON path (e.g., logged_hours)

   • Field: the Salesforce field API name (e.g., Logged_Hours__c)

3. Click Save

4. Next batch run will include your new mapping.

---

4. Scheduling & Processing

Q: How does data processing work?

• Vome webhooks create raw VomeData__c records.

• VOME_Processor_SCHED runs hourly, invoking VOME_Processor_BATCH, which:

  1. Queries waiting records

  2. Maps JSON → SObject fields

  3. Inserts/Upserts Contacts or Leads

  4. Marks VomeData__c as Processed or Failed

Q: How can I trigger processing immediately?

• Setup → Apex Classes → Select VOME_Processor_SCHED → Click Run

---

5. Monitoring & Troubleshooting

Q: Where can I view sync status?

• List View: App Launcher → Vome Data → select Vome Sync Status

• Dashboard: App Launcher → Dashboards → Vome Sync Dashboard

• Automatic email alerts are sent on failures.

Common Fixes:

• Records stuck in Waiting → Validate scheduled job is active.

• Field not found errors → Ensure Fieldmap__mdt API names match Salesforce fields.

• Required field errors → Mark non-critical fields as optional in Fieldmap.

---

6. Installing Package Updates

When a new version of the Vome package is released, to apply the update:

1. In Salesforce Setup, go to Apps → Packaging → Installed Packages.

2. Find Vome Integration, click Upgrade.

3. Paste the new Package Version ID (or use the updated install URL) and click Next → Upgrade for All Users → Upgrade.

4. Wait for the upgrade to complete. You’ll receive an email notification.

Once upgraded, the latest mappings, fixes, and enhancements will be active immediately.

7. Testing & Validation Testing & Validation

• Use the provided VomeCalloutMock in Apex tests to simulate API responses.

• Test VOME_Api_SVC.listProfiles(), .getProfileById(), and .searchProfiles().

• Validate that VOME_Processor_SVC.process() correctly upserts SObjects and updates status.

---

8. Support

• Email: [email protected]

• Portal: https://support.vomevolunteer.com