This checklist covers every step required to onboard a new customer onto the Viewpoint Vista integration. Steps are split between the Billy team (Internal) and the partner/customer (Partner). Work through each phase in order.
💡 Tip: Use the App Xchange customer deployments page and the Trimble installation guide as reference throughout this process.
Phase 1: Provisioning
1. Create a new customer deployment in App Xchange Internal
Set up the customer's dedicated deployment in the Trimble App Xchange platform to establish the integration environment.
2. Accept the deployment invite Partner
The partner receives an invitation email to join the new App Xchange deployment. They must accept it before any further configuration can happen.
3. Install the App Xchange Agent and Vista connector Partner
Follow the Trimble installation guide to install the App Xchange Agent on the partner's server and connect it to their Vista instance.
⚠️ Permissions required: The Vista service account must be a member of Security Groups 1001 and 1002, and must have read access to the SLHD and SLIT database tables. Confirm this before proceeding.
Phase 2: Configuration
4. Configure the Vista connector with database credentials Partner
Enter the Vista database connection details (server, database name, username, and password) into the App Xchange connector settings to enable data sync.
5. Create Billy API credentials and configure the HTTP connector Internal
Generate API credentials in Billy for this partner account, then enter them into the HTTP connector in App Xchange to authorize data flow between the two systems.
6. Import contract (SL) numbers into the External ID field in Billy Internal
Perform a bulk import of the partner's Subcontract Letter (SL) numbers into the External ID field in Billy so contracts can be correctly matched across both platforms.
7. Set up a BILLY compliance code in Vista Partner
In Vista, create a new compliance code named BILLY. This code is used to tag compliance records so they can be identified, synced, and updated from Billy automatically.
Phase 3: Go-Live
8. Confirm sync cadence with the partner Internal
Agree with the partner on how frequently compliance data should sync. Common options are hourly or twice daily. Configure the schedule in App Xchange once confirmed.
9. Run a backfill of existing compliance data to Vista Internal
Trigger a one-time historical backfill to push all compliance records already in Billy into Vista, ensuring the partner's data is current and complete from day one.
10. Disable the "Backfill All Contract Compliance?" option Internal
After confirming the backfill completed successfully, toggle this option off to prevent it from re-running. Future syncs should only push new or changed compliance records (delta sync).
11. Verify cache writers and schedules are configured Internal
Confirm that the partner's cache writers and associated sync schedules are correctly set up in App Xchange so ongoing compliance updates will flow automatically going forward.
If you run into any issues during onboarding, use the in-app chat to reach the Billy team.