# SharinPix Form Launcher

## Overview

The **SharinPix Form Launcher** component provides a simple way to open a SharinPix form directly from Salesforce, whether on **mobile devices via the SharinPix mobile app** or on a **web browser via Online mode**. It bridges your pre-built SharinPix form templates (created using the Form Template Editor) with both the **mobile and desktop experience** , enabling users to quickly access and complete forms in the way that best suits their environment.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-21da367b3c34728d8c6cbbc80c305cf5eab76900%2FUntitled%20design%20\(6\)%20\(1\)%20\(1\).png?alt=media)

{% hint style="info" %}
**Info**

This feature is only available on Lightning. It can be used:

* On Community Builder
* On Page Builder
* On Desktop
* On Mobile
* In your own Lightning Component development
* In Flows (but not in Field Service Mobile Flow)

**Note:** The SharinPix Form Launcher component is not available in Salesforce Field Service (FSL). However, you can still launch the SharinPix mobile app from a Field Service Mobile Flow. To do so, refer to the following articles:

[*Integration of SharinPix App with SFS (FSL) App using App Extension*](https://docs.sharinpix.com/documentation/integrations/salesforce-field-service/integration-of-sharinpix-app-with-sfs-fsl-app-using-app-extension)

[*Integration of SharinPix App with SFS (FSL) App using Flows*](https://docs.sharinpix.com/documentation/integrations/salesforce-field-service/integration-of-sharinpix-app-with-sfs-fsl-app-using-flows)
{% endhint %}

{% hint style="warning" %}
**Prerequisites**

* **Permissions:**\
  Users must have the **SharinPix Forms** **Admin** or **SharinPix Forms User** permission set assigned. For more information on these two permission sets, check [*SharinPix Permission sets*](https://docs.sharinpix.com/documentation/access-and-security/sharinpix-permission-sets).
* **Package Version:**\
  Ensure that SharinPix Package Version 1.331 (or later) is installed.
* **Mobile App:**\
  The SharinPix mobile app must be installed on your mobile device to test and use the form launcher functionality on mobile. For more information on how to install the SharinPix mobile app, click [*here*](https://docs.sharinpix.com/documentation/mobile-app/where-to-find-the-sharinpix-mobile-app).
* **Form Template:**\
  A form template must be created beforehand using the [**SharinPix Form Template Editor**](https://docs.sharinpix.com/documentation/sharinpix-form/sharinpix-form-template-editor).
  {% endhint %}

## Getting Started

To use the SharinPix Form Launcher component, you simply need to drag and drop the component from the Lightning App Builder onto your page layout.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-683ab450a4f4d38f0c8696a61b24b9e5fbc65318%2FUntitled%20design%20\(7\)%20\(1\)%20\(1\).png?alt=media)

### Lightning Component Parameters

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FfIcQyulz5ipqnGfuftTD%2FDOC%20SF%20-%201920%20x%201080.png?alt=media\&token=1458f286-a06e-418e-9e6f-4453ce1f0e52)

| Parameter                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Default/Notes                                        |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| Button Label                       | The text displayed on the launcher button that users will click to open the SharinPix form.                                                                                                                                                                                                                                                                                                                                                                                              | Default value: *Fill SharinPix Form 📝*              |
| SharinPix Form Template Name or ID | Specifies which SharinPix Form Template to launch: Either supply the template’s Name or ID directly, or enclose the API name of a record field in <mark style="color:$danger;">`{}`</mark> (e.g. <mark style="color:$danger;">`{Inspection_Template__c}`</mark>), if that field contains the template’s Name or ID. The template must have been created in the [SharinPix Form Template Editor](https://docs.sharinpix.com/documentation/sharinpix-form/sharinpix-form-template-editor). | Must match an existing template in your system.      |
| Name field API name                | Specifies the Job name when launching the Form in SharinPix Mobile App. You can use any other fields in the record from which the Form is being launched.                                                                                                                                                                                                                                                                                                                                | Default value: *Record name*                         |
| Initial Form Response              | <p>Responses from a previously completed form can be displayed on the new form for reference. This is beneficial in cases such as initial and follow-up inspections or entry and exit checks. You can use answers from the most recent Form Response submitted for the current object by setting the field to <mark style="color:$danger;"><code>Use the lastest for</code></mark><br></p><p><mark style="color:$danger;"><code>response</code></mark>.</p>                              | Default value: *None*                                |
| Custom parameters                  | Used to specify additional user-defined parameters to be appended to the SharinPix Form launcher URL. Example "userId=005Ec00000MAzP2MAI".                                                                                                                                                                                                                                                                                                                                               | Default value: *None*                                |
| Online Mode                        | If checked, launches the form **in the browser** instead of the SharinPix mobile app. Users can **fill in and submit** the [form online](#example-online-mode).                                                                                                                                                                                                                                                                                                                          | Default: *Unchecked*                                 |
| Deeplink format                    | If checked, generates a deeplink instead of a universal link.                                                                                                                                                                                                                                                                                                                                                                                                                            | Default: *Unchecked*                                 |
| **Record ID** \*                   | (**Required in Flow Screens and Community Pages**) The Salesforce record ID of the record page.                                                                                                                                                                                                                                                                                                                                                                                          | Auto-populated in some contexts; required otherwise. |

### Demo and Behavior

#### Example – Mobile Mode

{% hint style="warning" %}
**Prerequisites:**

The SharinPix Form Launcher also works alongside the SharinPix mobile app.

**Kindly ensure that the SharinPix mobile app has been installed on your device before testing the component on mobile.**

For more information on how to install the SharinPix mobile app, click [*here*](https://docs.sharinpix.com/documentation/mobile-app/where-to-find-the-sharinpix-mobile-app).
{% endhint %}

The image below shows the SharinPix Form Launcher component in the Salesforce mobile app. Select the **Fill SharinPix Form** button to launch the Form in the **SharinPix** **Mobile App**.

The image below demonstrates the SharinPix Form when launched and filled in the mobile app:

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-3330c013e95ce4d4974e05d7c1551af7e56a8666%2FClick%20on%20the%20\(1\)%20\(2\).png?alt=media)

#### Example – Online Mode

When the **Online Mode** checkbox is **checked** , clicking the button opens the form **in the user’s mobile or desktop browser** , allowing it to be filled and submitted without requiring the mobile app.

The image below demonstrates the SharinPix Form when launched and filled in via a browser:

Step 1 : Tick the Online Mode Checkbox

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FR6LV0eqRA7hZpjUUMXfg%2FDOC%20SF%20-%201920%20x%20360%20\(1920%20x%20600%20px\)%20\(1920%20x%201200%20px\).png?alt=media\&token=4f73f9d8-2537-4d8d-873c-6766429c770b)

Step 2 : Click on the Form Launcher Button

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fi8TefFNYUIRvJKUXJ0aA%2FB.png?alt=media\&token=3812a78f-597a-4700-91c4-97ce6ef2cfa7)

Step 3 : The form will open in a new browser window

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FgDquAwvvmRQJVDkLaYkG%2FC.png?alt=media\&token=d3f0656a-3a12-4d29-9945-9c1613da31e6)

{% hint style="info" %}
**Info:**

The SharinPix Form Launcher component uses tokens when you capture and upload images. These tokens are valid for 30 days by default. Once a token expires, it can no longer be used to submit or upload any form responses.

If you need a longer token duration, you can change it by overriding the **MobileTokenExpiryDays** custom label in the SharinPix package. Simply set this label to the number of days you want the tokens to remain valid for the Form Launcher component.

**Note:** This option is available starting with package version **1.200**.
{% endhint %}
