Smartforms Apex API

For advanced business users and organizations, Centerpoint for Salesforce makes the Smartforms Apex API available. It lets your own Apex code and Flows create Smartforms, read the answers of completed forms, fetch their files, and remove forms.

All calls are global methods of the class MFAPI_SmartForms, in the package namespace mfwe. Each call has two forms:

• A static method, for example mfwe.MFAPI_SmartForms.createSmartForm(params).
• An instance method with the suffix Dyn, for example createSmartFormDyn(params), called on the object that mfwe.MFAPI_SmartForms.getInstance() returns. Use it where your code must call the package dynamically.

Every call takes one parameter object of the type named in the table below.

The read calls work on the Smartform webhook records in Salesforce. They return what Doc Gen has already reported, so a form must have sent its webhook before you can read it.

Create a Smartform

createSmartForm creates a Smartform for a record and returns its address.

The call does not send an SMS or an e-mail, and the form has no participants. Use the returned address to give someone the form.

mfwe.MFAPI_SmartForms.CreateSmartformParams params =
    new mfwe.MFAPI_SmartForms.CreateSmartformParams();
 
params.recordId = '0010Y00000A1b2cQAB';
params.dialogDefinitionId = '66f1a2b3c4d5e6f708192a3b';
params.smartformName = 'Customer questionnaire';
params.additionalValues = new Map<String, Object>{ 'Campaign' => 'Spring' };
 
String result = mfwe.MFAPI_SmartForms.createSmartForm(params);
 
if (result.startsWith('ERROR')) {
    System.debug('Could not create the form: ' + result);
} else {
    System.debug('Form address: ' + result);
}

Read a completed form

dialogFormId is the id of the form, which you find in the Dialog_Form_Id__c field of the Smartform webhook record.

mfwe.MFAPI_SmartForms.GetDialogValuesCompleteParams params =
    new mfwe.MFAPI_SmartForms.GetDialogValuesCompleteParams();
params.dialogFormId = '69b2930a53527bdd323bff10';
 
mfwe.MFSMF_ApiTypes.DialogValuesComplete form =
    mfwe.MFAPI_SmartForms.getDialogValuesComplete(params);
 
for (mfwe.MFSMF_ApiTypes.Values answer : form.Values) {
    System.debug(answer.property + ' = ' + answer.value);
}

getSmartObjectValues returns the smart tables of the form, with each table’s rows decoded into maps. getDialogExternalMetaData returns the external metadata that the form carried, such as the record id, the object name, the data template and the org id.

Read files

mfwe.MFAPI_SmartForms.GetAllSmartformFilesParams listParams =
    new mfwe.MFAPI_SmartForms.GetAllSmartformFilesParams();
listParams.dialogFormId = '69b2930a53527bdd323bff10';
 
mfwe.MFSMF_ApiTypes.DialogFiles files = mfwe.MFAPI_SmartForms.getAllSmartformFiles(listParams);
 
mfwe.MFAPI_SmartForms.GetSmartformFileContentParams fileParams =
    new mfwe.MFAPI_SmartForms.GetSmartformFileContentParams();
fileParams.dialogFormId = listParams.dialogFormId;
fileParams.property = files.Files[0].Property;
fileParams.fileId = files.Files[0].Id;
 
String base64 = mfwe.MFAPI_SmartForms.getSmartformFileContent(fileParams);

getAllSmartformFiles takes either dialogFormId or recordId, where recordId is the id of the Smartform webhook record. getSmartformFileContent fetches the file from Doc Gen as a Base64 string.

Delete forms

mfwe.MFAPI_SmartForms.DeleteDialogValuesParams params =
    new mfwe.MFAPI_SmartForms.DeleteDialogValuesParams();
params.dialogValuesId = '69b2930a53527bdd323bff10';
 
Integer statusCode = mfwe.MFAPI_SmartForms.deleteDialogValues(params);
System.debug('HTTP status: ' + statusCode);

The call returns the HTTP status of the delete in Doc Gen, for example 200 on success or 404 if the form is not found. deleteDialogValuesBulk deletes several forms at once. Put their ids in the list dialogValuesIds.

Webhook endpoints

The package publishes four endpoints on the public site named webhook, see Install and connect. Each is reached at the site address followed by /services/apexrest/mfwe/ and the name below. The Smartforms Webhook URL tab shows the full address of the first one.

Platform events

When a Smartform is complete or signed, Salesforce publishes the platform event Smartform Webhook Response. Flows and Apex triggers can react to it, for example to run a field mapping when a form is complete.

The package also uses a second event, Smartform Processing, for its own work.

Related

• Smartforms
• Smartform field mapping
• Workflow Apex API