The checklist_order parameter can be used to preserve the checklist order. This parameter takes two values:

• auto: Applying this value does not preserve the checklist's order. In this case, when a tag is applied from the checklist, the corresponding row is sent to the bottom of the list on the SharinPix app. 

• preserve: This value is used to preserve the checklist order. Here, when a tag is applied from the checklist, the tag entry in the checklist remains in place, it is not sent to the bottom of the list.

The following code snippet shows how to configure the checklist_order parameter to preserve or auto in the Mobile app config section:

• preserve: "checklist_order": "preserve"
• auto: "checklist_order": "auto"

Here's an example of how the checklist_order parameter should look in the Mobile app config section:

This parameter can be used when using a checklist with form features if checklist_order is not set to preserve. When filling form fields in a checklist with form features, the checklist is not automatically reordered when an item changes from incomplete to complete or from complete to incomplete. To reorder the checklist, the user needs to click a reorder button. To reorder the checklist automatically, set the checklist_reload parameter to auto. When set to auto the reload button is not displayed anymore.

Example:

"checklist_reload": "auto"

The auto_destroy_after parameter automatically deletes your images and form checklist data from the mobile app once they are marked as processed after a pre-defined amount of time. The Job record, which groups all media to upload to a specific Salesforce record, will still be available for an additional eight hours; however, it will be empty. New images can still be uploaded using the same job until it expires. Adding new media will extend the lifespan of the job record.

The value used for this parameter should be equal to the number of seconds before the images and form checklist data are removed. For example, if you want your images and form checklist data removed after 5 minutes, the auto_destroy parameter should be configured as follows: "auto_destroy_after": 300.

The auto_destroy_after parameter also accepts the following special values:

• 0: When using 0 as the value, the images and form checklist data are removed once they are marked as processed. Here, no lapse of time is given for the deletion. The syntax is as follows:

"auto_destroy_after": 0

• -1: A value of -1 means that the images and form checklist data will not be deleted. Here is the syntax is:

"auto_destroy_after": -1

Here's an example of how the auto_destroy_after parameter should look in the Mobile app config section:

The incomplete_checklist_alert_text parameter can be used to add a personalized alert in cases where users attempt to submit images without completing a checklist.

The following code snippet shows how to configure the incomplete_checklist_alert_text parameter with your own personalized text:

"incomplete_checklist_alert_text": "Please fill the missing task(s) before submission"

The following placeholders can also be used with the incomplete_checklist_alert_text parameter:

• <COUNT>: The <COUNT> will be replaced by the number of tags with less images than the minimum count specified for the tag.

     Example:

"incomplete_checklist_alert_text": "Missing <COUNT> tasks. Please fill the task(s)."

will be displayed as follows on the SharinPix mobile app:

• <LIST_INCOMPLETE>: This value will be replaced by a list of tags which has either less images than the minimum count specified for the tag or an unfilled required field for the tag.

  Example:

"incomplete_checklist_alert_text": "Missing <COUNT> tasks. Please fill the following task(s). <LIST_INCOMPLETE>"

• An empty string: Inserting an empty string will omit the alert message when attempting to submit an incomplete checklist. For example, configuring the incomplete_checklist_alert_text parameter as follows: "incomplete_checklist_alert_text": "" will not display any alert message when submitting an incomplete checklist.

The incomplete_form_alert_text parameter can be used to add a personalized alert in cases where users attempt to submit a checklist with form features without filling any required form-field for any tag.

Example:

"incomplete_form_alert_text": "Please fill all form fields before submitting."

will be displayed as follows on the SharinPix mobile app:

The following placeholders can also be used for  the incomplete_form_alert_text parameter:

• <LIST_INCOMPLETE>: This value will be replaced by a list of tags which has either less images than the minimum count specified for the tag or an unfilled required field for the tag.

  Example:

  "incomplete_form_alert_text": "<COUNT> fields are unfilled. Please fill the following before submitting. <LIST_INCOMPLETE>"

• <COUNT>: The <COUNT> value refers to the number tags with an unfilled required form-field in the checklist. For example, the following configuration

  Example:

  "incomplete_form_alert_text": "<COUNT> fields are unfilled. Please fill to submit."

The team parameter allows the user to view images already uploaded to the album the checklist relates to. This includes images uploaded live to the same record and checklists by other users.

The following code snippet shows how to configure the team parameter:

"team": true

This parameter takes two values:

• true: Used to show the user to see the online images on the checklist page

"team": true

• false: Default behaviour - will only show the images present locally on the device.

"team": false

The exit_page_text_ios parameter can be used to personalize and associate a text to the SharinPix mobile app's back button on iOS devices. Since iOS does not allow us to close the app automatically, this text can guide the user on the way to proceed.

The following code snippet shows how to configure the exit_page_text_ios parameter with your own personalized text:

"exit_page_text_ios": "Use <Salesforce above to return to Account."

It will be displayed as follows on the SharinPix mobile app:

Here's an example of how it looks like in the Mobile app config section:

The compression parameter can be used to dictate the SharinPix mobile app to compress the captured images or not. Compressing the images taken by the SharinPix mobile app accelerates the upload and does not impact on the image quality.

The following code snippet shows how to configure the compression parameter:

"compression": false

This parameter accepts two values:

• true: When set to true, the SharinPix mobile app will perform the compression of images. (Note: The compression is set to true by default. Therefore, if not specified, image compression will take place.)

"compression": true

• false: When set to false, the mobile app will not compress the captured images.

"compression": false

The await_upload parameter can be used to show the upload progress after submitting images captured using the SharinPix mobile app or after submitting a checklist with form features.

This values that this parameter can take are as follows:

• checklist: Used to show the image upload progress and wait for completion before exiting when submitting a checklist with form features

      "await_upload: "checklist"

• batch: Used to show the image upload progress and wait for completion before exiting when submitting a batch

"await_upload": "batch"

• none: Default behaviour - uploads will be done in the background

"await_upload": "none"

The confirm parameter is used to request confirmation from the user before the actual submission. A screen is shown with details of media to be submitted and the user can modify his input before finalizing the submission. The value for this parameter can be:

"confirm": "batch"

for showing the confirmation screen before batch submission.

The watermark parameter is used to set up and display watermarks on images captured from the SharinPix mobile app.

The following code snippet shows how to configure the watermark parameter:

"watermark": "Hello World"

The watermark is also available on the image when uploaded to the SharinPix album as depicted below:

The target_size parameter can be used to dictate the SharinPix mobile app to capture images with a specific image resolution. Capturing images with low resolution does affect the image quality but can reduce the storage size and accelerate the upload of images.

The following code snippet shows how to configure the target_size parameter:

"target_size": 1920

Using this parameter does not mean that the resolution of the images will be exactly what you have specified when configuring. It is up to the mobile operating system to choose the closest supported resolution. 

iOS will choose the highest resolution from the following ordered list that is lower or equal to the target_size specified:

• 3840 x 2160 (>= 3840)
• 1920 x 1080 (>= 1920) Example target_size to use this 1920 x 1080: 2000
• 1280 x 720 (>= 1280) Example target_size to use 1280 x 720: 1500
• 640 x 480 (>= 640)
• 352 x 288 (>= 352)

Unlike iOS, different Android phones have different possible resolutions that can be used to capture images. It is up to the system to choose the resolution closest to the target_size specified. In some cases, it may be higher than the target_size specified.

The scan_as parameter can be used to save the output for the scan files as images or pdf. As the default behaviour, one scan will be saved as an image and multiple scans will be saved as a pdf.

The following code snippet shows how to configure the scan_as parameter:

"scan_as": "image"

The parameter scan_as takes two values:

• image - Setting the value to image will save the scan files as images on the SharinPix mobile app.

"scan_as": "image"

• pdf - Setting the value to pdf will save the scan files as images on the SharinPix mobile app.

"scan_as": "pdf"

The units parameter is used to configure the measurement units that are available when annotating images with numerical values. This is available on arrows and double arrows. They can be used to automatically add SI units (e.g. ft and in) to the numbers users type. If the units parameter is not configured in the Global Settings, the default units will be as shown in the screen capture below.

The following code snippet shows an example of how to configure the units parameter:

"units": ["m","mm","cm"] 

The parameter units take the measurement units as an array of values.

The roll_limit parameter is used to configure the maximum number of images that can be chosen from the roll. The value of the roll_limit parameter cannot exceed 100, which is the maximum possible number of images per batch or capture session.

If the roll_limit parameter is not configured, the maximum number of images that can be chosen from the roll is 30 by default. 

The following code snippet shows an example of how to configure the roll_limit parameter:

"roll_limit": 50

The allow_file_export parameter allows the export of images or media files from the SharinPix app to the device's storage. For more information on different export options, refer to the following article: Export media to internal storage.

This parameter accepts two values:

• true: When set to true, the export functionality becomes accessible.

"allow_file_export": true

• false: When set to false, the export functionality is unavailable. (If no value is specified, the flag defaults to false.)

"allow_file_export": false

The allow_auto_file_export parameter is used to export all images or media files from the SharinPix app including those selected from the roll to the device's storage. For more information on allow_auto_file_export, refer to the following article: Automatic file export

This parameter accepts two values:

• true: When set to true, all images or media files will be automatically exported to the device's storage.

"allow_auto_file_export": true

• false: When set to false, no images or media files will be exported. (If no value is specified, the flag defaults to false.)

"allow_auto_file_export": false