Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Form Utils Methods

Overview

The SharinPix package provides the Apex class, FormUtils, which contains utility methods for the Form Feature.

The Form Utils methods include:

Form Utils Methods Example

generateToken

global static String generateToken(String recordId , String templateName , Map<String, Object> options)

  • This method generates a SharinPix Form Token with specific abilities. Below is a detailed description of each parameter:

    • recordId (String) The unique identifier of the record associated with the form. This parameter specifies which record the generated token will be linked to. For example, if the form pertains to a specific account or case, you would pass that record's ID here.

    • templateName (String) The Name of the Main Form Template to use for token generation. Do not use the ID of an individual version template.

    • options (Map <String, Object>) A key-value map that provides additional configuration options to customize the form's behavior. This parameter is optional and allows flexibility in defining extra settings. Common examples include:

      • nameFieldApiName: Specifies the API name of the field used to display a recognizable name for the form (e.g., a contact’s name or an opportunity title).

      • formExpiry: Defines the expiration date or duration for the form's validity. The formExpiry takes a number as value indicating the number of days after which the form will expire.

generateUrl / generateOnlineUrl

global static String generateUrl(String recordId , String templateName , Map<String, Object> options)

global static String generateOnlineUrl(String recordId , String templateName , Map<String, Object> options)

These methods generate a SharinPix Form URL (Universal Link) for a Main Form Template (Active Form Template). Both methods work the same way, with only one difference:

generateUrl

Opens the form in the SharinPix Mobile App

generateOnlineUrl

Opens the form in a Web Browser

Below is a detailed description of each parameter:

  • recordId (String) The unique identifier of the record associated with the form. This parameter specifies the record associated with the generated form URL. For example, if the form pertains to a specific account or case, pass that record's ID here.

  • templateName (String) The Name of the Main Form Template to use for URL generation. Do not use the ID of an individual version template.

  • options (Map <String, Object>) A key-value map that provides additional configuration options to customize the form's behavior. This parameter is optional and allows flexibility in defining extra settings. Common examples include:

    • nameFieldApiName: Specifies the API name of the field used to display a recognizable name for the form (e.g., a contact’s name or an opportunity title).

    • formExpiry: Defines the expiration date or duration for the form's validity. The formExpiry takes a number as value indicating the number of days after which the form will expire.

exportFormResponseAsContentDocument

global static void exportFormResponseAsContentDocument(String formResponsePublicId , String recordId)

This method exports a SharinPix Form Response PDF as a Salesforce ContentDocument, attaching it to a specified record.

Parameters:

  • formResponsePublicId (String) The public identifier of the SharinPix Form Response to export.

  • recordId (String) The Salesforce record ID to which the generated ContentDocument will be linked. This is typically the record (e.g., an Account, Case, or Work Order) that the form response pertains to.

exportFormResponseAsContentDocument (with options)

global static void exportFormResponseAsContentDocument(String formResponsePublicId , String recordId, Map<String, Object> options)

This method works like the previous one, but allows additional export configuration options , such as specifying a filename for the exported PDF. It still exports the SharinPix Form Response as a Salesforce ContentDocument and links it to the specified record.

Parameters

  • formResponsePublicId (String) The public identifier of the SharinPix Form Response to export.

  • recordId (String) The Salesforce record ID to which the generated ContentDocument will be linked.

  • options (Map <String, Object>) A key-value map allowing you to customize the export behavior.