S-Docs Software Development Kit (DocumentSDK)

PDF Document Generation & S-Docs Email SDK

Supported Contexts

The following contexts are supported:

• Apex Invocable Class (that can be called from a Flow)
• Apex Queueable
• Apex Batch
• @future Apex method
• Visualforce Apex Controller (Custom and Controller extensions)
• AuraEnabled Apex method
• Apex class that supports an OmniScript

Use cases

With this SDK method you can generate documents from your own business processes as well as custom UI components. Some of the use cases that we anticipate to leverage this capability is as follows:

• Generate a document in batch from an existing Apex Batch or Apex Queueable class
• Generate a document from an existing UI component: Aura or Lightning Web Component
• Generating a document from a custom Visualforce page
• Generating a document from an OmniScript

Usage

In your apex class (Lightning Web component controller, Apex invocable, Queueable or Apex batch classes) you would invoke the above SDK method like below:

String jsonResp = SDOC.DocumentSDK.generateDocument('<templateId>','recordId');
Map<String,String> respAsObject = JSON.deserialize(jsonResp,
Map<String,String>.class)

Method Signature

generateDocument(templateId, recordId, generationOptions)

Parameters

templateId | (Type: Id): The ID of the template used for generating the document.

recordId | (Type: Id): The ID of the base record object.

Returns

Type: String

Document information associated with the generated PDF in JSON format.

generateDocument(Id templateId, Id recordId, GenerationOptions generationOptions)

templateId | (Type: Id): The ID of the template used for generating the document.

recordId | (Type: Id): The ID of the base record object.

generationOptions | (Type: SDOC.GenerationOptions)

The return JSON will have the following structure:

{
"id": "<ID of SDOC__SDoc__c record created>",
"contentDocumentId": "Id of the corresponding ContentDocument record that was created",
"templateId": "<ID of Template passed in as the parameter>",
"recordId": "<ID of base record passed in as the parameter>",
"createdDate": "<Date of document created>",
"attachmentName":"<Name of file created>",
"allowEdit":"<Boolean>",
"ssignEnabled": "<Boolean>",
}

Limitations:

• Currently only PDF and PDF-UPLOAD formats are supported.
• You can only have 1 invocation of generateDoc per Apex transaction. I.e. if you invoke it multiple times in the same transaction you will get a LimitsException
• If there is an error in generating the document, there is an Exception thrown that needs to be handled to introspect into the error details.
• Runtime prompts based templates aren’t supported in the SDK.

HTML Email Generation

Supported Contexts

The following contexts are supported:

• Apex Invocable Class (that can be called from a Flow)
• Apex Queueable
• Apex Batch
• @future Apex method
• Visualforce Apex Controller (Custom and Controller extensions)
• AuraEnabled Apex method
• Apex class that supports an OmniScript

Use cases

Since S-Docs email templates have the same ability to merge data fields from base objects, you can leverage this SDK to have richer email content that what the standard email templates support.

Usage

in your apex class (Lightning Web component controller, Apex invocable, Queueable or Apex batch classes) you would invoke the above SDK method like below:

String emailBody = SDOC.DocumentSDK.generateEmail('<templateId>','objectId');
Messaging.SingleEmailMessage
theEmail = new Messaging.SingleEmailMessage(); theEmail.setHtmlBody(emailBody);
...
..
Messaging.sendEmail(new Messaging.SingleEmailMessage[] {semail});

Method Signature

generateEmail(Id templateId, Id objectId)

Parameters

templateId | (Type: Id): The ID of the template used for generating the email.

objectId | (Type: Id): The ID of the base record object.

Returns

Type:

String

String containing the email body in HTML format.

Generate Documents in Batch & Combine Documents Handler

Supported Contexts

The following contexts are supported:

• Apex Invocable Class (that can be called from a Flow)
• Apex Queueable
• Apex Batch
• @future Apex method
• Visualforce Apex Controller (Custom and Controller extensions)
• AuraEnabled Apex method
• Apex class that supports an OmniScript

Use cases

Automate document generation across multiple records from multiple templates to streamline workflows that require batch processing.

Usage

In your apex class (Lightning Web component controller, Apex invocable, Queueable or Apex batch classes) you would invoke the above SDK method like below:

Id batchJobId = SDOC.DocumentSDK.generateDocsInBatch(
{List<Id> recordIds},
{Set<Id> templateIds},
{Integer batchSize}
};

Method Signature

generateDocsInBatch(baseRecords, templateIds, n)

Parameters

baseRecordIds | (Type: Id): The list of the records used for generating documents.

templateIds | (Type: Id): The set of IDs of templates to generate.

batchSize | (Type: Integer): The size of each batch in a job. (Default value is 5)

batchActions | (Type: List): List of batch actions to perform on the generated documents.

CombinedDocumentHandler

Returns

Type: ID

The ID of the AsyncApexJob record returned by the system.

Example Code

String generatedDocumentAsString = SDOC.DocumentSDK.generateDocsInBatch(
    new List<Id> { accounts[0].Id, accounts[1].Id },
    new Set<Id> { accountReport.Id }, 
    5,
    new List<SDOC.BatchAction> {
        new SDOC.CombinedDocumentHandler()
    }
);