LightReach Integration Configuration for Existing SiteCapture Customers

Note:  This video is available for reference https://www.loom.com/share/0acb75bd5d93491b9313b8334587c039?sid=c95fae6e-b1e6-447a-aedc-c42368b4d36a

You will need:

  1. Your SiteCapture portal admin credentials (username and password)
  2. Your LightReach org-alias (should be 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 usually “lightreach_jco” entered without the quote marks.

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. Go into your admin panel (the gear at the top right)
  3. Under Data and Integration select “App Integrations”
  4. Click on LightReach Integration 
  5. Click on Configure (or Reconfigure) at the upper right - it is a big green button

Note:  The video link above starts at this point

  1. Follow the prompts to enter your SiteCapture portal admin credentials.The API key and base URL should be pre-populated.  Note:  Don’t worry if your API key has another integration in the name (Zapier for example)
  2. Under “workflow state filters” click the plus button.  Select the status workflow state you want to be the state that triggers the send to LightReach.  It will usually be “in review”.  It is the status workflow state in your template that is associated with the status you want used for signaling that the work is ready to send to LightReach
  3. Enter the template key provided above
  4. Toggle the switch for “enable to use static org alias” and enter your org alias which should have been provided by LightReach
  5. Click finish

You are now ready to create work and have the photos automatically sent to LightReach:

  1. Go into  your main SiteCapture portal interface 
  2. Click the green button with the + sign at the top right of the list view page
  3. Choose the type and template that are applicable to this integration.  (Early stage customers will have a LightReach type and a template called LightReach JCO
  4. Fill out the fields you would normally fill out prior to assigning the work to your field users

Note:  The one field that must be filled out is LightReach Account ID

  1. Assign the work, have the field user complete it and select the status you want selected to trigger the integration (currently set to be “Ready for LightReach”.  Note:  When this status is selected, the work will no longer be visible on the field user’s mobile device.  It will be visible to you in your SiteCapture portal, but will not be editable.
  2. Wait a few minutes and check your LightReach account to see the photos and the PDF report are now attached there

SiteCapture Template Configurations for Existing SiteCapture Customers who wish to make their existing template(s) compatible with this LightReach/SiteCapture integration.

 

You will need to complete the above steps for the configuration. 

Template Configuration

When editing an existing template or creating a new one in your instance of SiteCapture, the section keys have to follow a naming convention to keep the template compatible with the Lightreach integration.

Field for LightReach Account ID

You will need a field where you will enter the “LightReach Account ID”.  This field can be called anything you like, but it must have the following field key:

sc_lightreach_account_id

Section Keys

The following section keys will be used in the integration and will match the sections within Lightreach (see Install Photo Documentation for reference).

  1. Project Site
    • SiteCapture Template Section Key = sc_projectSite
    • Lightreach Section = Project Site
  2. Roof
    • SiteCapture Template Section Key = sc_roof
    • Lightreach Section = Roof/Mounting System
  3. Electrical
    • SiteCapture Template Section Key = sc_electrical
    • Lightreach Section = Electrical
  4. Storage
    • SiteCapture Template Section Key = sc_storage
    • Lightreach Section = Storage
  5. System Commissioning
    • SiteCapture Template Section Key = sc_systemCommissioning
    • Lightreach Section = System Commissioning

Mapping multiple SiteCapture sections to one Lightreach section

The integration supports mapping multiple sections from the template to a single section within Lighreach. To enable this add another underscore and additional discriminator to the section key. 

{sectionKey}_{discriminator}

For example if there are multiple roof sections they could be named sc_roof_1, sc_roof_2, etc. Or for multiple electrical sections they could be named sc_electrical_inside, sc_electrical_outside, etc. The name of the discriminator is not important, only that the section key begins with one of the five valid sections (sc_projectSite, sc_roof, sc_electrical, sc_storage, sc_systemCommissioning).

Mapping one SiteCapture to multiple Lightreach sections

This functionality is not currently supported in the integration.

 

 

 

 

Have more questions? Submit a request

Comments