LightReach Integration Configuration for Existing SiteCapture Customers

Avatar
Stonia Seng
Follow

Reference Video

A video tutorial is available for reference:
LightReach Integration Setup Video

Prerequisites

Before starting, ensure you have the following:

  1. SiteCapture portal admin credentials (username and password)
  2. Your LightReach org-alias (found in the email thread where you authorized LightReach to set up the connection)
  3. The template key for the LightReach-compatible template installed in your SiteCapture instance.
    • This is typically "lightreach_jco" (entered without quotation marks).

 

Integration Setup

Follow these steps to configure the integration:

  1. The LightReach integration has been added to the Solar Partners section and needs to be configured.
  2. Open the Admin Panel (gear icon at the top right).
  3. Under Data and Integration, select App Integrations.
  4. Click on LightReach Integration.
  5. Click Configure (or Reconfigure) at the top right (big green button).
    Note: The reference video starts from this step.
  6. Follow the prompts to enter your SiteCapture portal admin credentials.
  7. Under Workflow State Filters, click the plus (+) button.
    • Select the workflow state that should trigger the send to LightReach.
    • This is typically "In Review", which is the status in your template that signals the work is ready to be sent.
  8. Enter the template key (as specified in the prerequisites).
  9. Toggle the switch for "Enable to use static org alias" and enter your org-alias (provided by LightReach).
  10. Click Finish.

 

Creating Work & Sending Photos to LightReach

Once configured, follow these steps to create work and send photos automatically to LightReach:

  1. Open the SiteCapture portal.
  2. Click the green (+) button at the top right of the list view page.
  3. Select the appropriate type and template for this integration.
    • Early-stage customers will see a LightReach type and a LightReach JCO template.
  4. Fill out the required fields before assigning the work to field users.
    Important: The LightReach Account ID field must be filled out.
  5. Assign the work, have the field user complete it, and set the status that triggers the integration (typically "Ready for LightReach").
    • Note: Once this status is selected, the work will no longer be visible on the field user’s mobile device. It will still be visible in your SiteCapture portal but will not be editable.
  6. Wait a few minutes and check your LightReach account—the photos and PDF report should now be attached.

 

Template Configuration

To make an existing SiteCapture template compatible with the LightReach integration, follow these guidelines.

LightReach Account ID Field

Your template must include a LightReach Account ID field. While the field name can vary, the key must be:

  • Field Key: sc_partner_account_id
  • Field Type: Text

This field is essential for the LightReach integration to function correctly.

 

Automatic Project Creation Functionality

Enabling this feature will automatically create a SiteCapture project when an account reaches the Notice to Proceed milestone in LightReach.

Available Fields

  • Field Key: sc_homeowner_name
    • Field Type: Text
    • Description: Stores the customer/homeowner's name for the worksite.
  • Field Key: address
    • Field Type: Text
    • Description: Stores the worksite’s street address.
  • Field Key: address_line2
    • Field Type: Text
    • Description: Stores the worksite’s city, state, and ZIP code.

Additionally, if enabled, existing accounts that have already reached the Notice to Proceed milestone will be created in SiteCapture after configuration.

 

Finance Partner Field (Optional)

This optional field allows you to specify the finance partner for a project, which is useful when using templates across multiple finance partners.

  • Field Key: sc_finance_partner
  • Field Type: Selection or Text
  • LightReach Value: "lightreach"

Integration Behavior:

  • The integration will only process projects where sc_finance_partner is set to "lightreach".
  • If set to any other value, the integration will be ignored for that project.
  • Note this field will automatically be set to LightReach when Automatic Project Creation is enabled.

 

Section Keys for Integration

The following section keys must match the corresponding LightReach sections to ensure proper integration.

SiteCapture Template Section Key LightReach Section
sc_projectSite Project Site
sc_roof Roof/Mounting System
sc_electrical Electrical
sc_storage Storage
sc_systemCommissioning System Commissioning

Reference: Install Photo Documentation

 

Mapping Multiple SiteCapture Sections to One LightReach Section

The integration allows multiple SiteCapture template sections to map to a single LightReach section.

To enable this, append an underscore and a unique discriminator to the section key. Examples:

  • sc_roof_1, sc_roof_2
  • sc_electrical_inside, sc_electrical_outside

The discriminator can be any value, but the section key must begin with one of the five valid sections:

  • sc_projectSite
  • sc_roof
  • sc_electrical
  • sc_storage
  • sc_systemCommissioning

This setup enables multiple sections in your SiteCapture template to map correctly to LightReach.

 

Mapping One SiteCapture Section to Multiple LightReach Sections

This functionality is currently not supported.

 

 

Have more questions? Submit a request

Comments