DocumentService

Initiates the conversion and merging process for the specified list of documents to create combined output files with the specified output file name attached to the specified parent record.

Namespace: LOOP

Package: Nintex DocGen for Salesforce

Syntax

static String ConvertAndMerge(List<Id> docIds, Id parentId, String outputFilename, Map<String, String> params);

Parameters

docIds

Type: List<Id>

The list of Attachment, Document, ContentDocument, and ContentVersion IDs for documents to be either converted and merged into output files, or converted and merged into a ContentDocument, with an associated ContentVersion, and stored in a specified workspace.

parentId

Type: Id

The ID of the record to which the output files and, optionally, task are attached.

outputFilename

Type: String

The file name of the output files created by the process.

params

Type: Map<String, String>

Additional parameters and values to be used by the process. For more information about additional parameters and values, see Additional parameters and values.

Return value

Type: String

If the trackActivity parameter is set to true in params, the task ID; otherwise, null.

Remarks

This method initiates a process that converts and merges the documents specified in docIds into an attachment, attached to the record specified in parentId, with the file name specified in outputFileName. The process can perform additional actions, such as invoking a callback function after completion of the process, depending on the additional parameters and values specified in params.

Additional parameters and values

The params parameter contains any additional parameters and values to be used by the process. In addition to the set of reserved additional parameters and values, you can also include any arbitrary additional parameters and values in params. All included additional parameters and values are returned in the callback method specified in the apexCallback additional parameter, so you can use the params parameter to provide additional information to the callback method.

The following table describes the additional reserved parameters and values that can be specified in params.

Handling callbacks

If the apexCallback parameter is specified in params and the value of the parameter is set to the fully-qualified name of a static method in an Apex class, the process invokes the method after the completion of the conversion and merging process as a callback method, providing information about the process as a string value that represents a JSON-serialized Apex class. The following Apex sample illustrates a minimal callback function, in which the string is deserialized into a private Apex class for later use.

webservice static void myCallback(string responseData)

{

// Deserialize the response data as an

// ConvertAndMergeResponseData instance.

ConvertAndMergeResponseData responseDataObj =

(ConvertAndMergeResponseData)JSON.deserialize(

responseData,

ConvertAndMergeResponseData.class);

}

class ConvertAndMergeResponseData

{

// The Salesforce ID of the Attachment / ContentVersion created as a result of the process

public Id recordId;

// A value, either "success" or "error", indicating the status of the request

public string status;

// Information about an error that occurred as part of the process. Null if status is not "error"

public Error error;

// The version of the package installed

public string requestVersion;

// The original parameters passed to the process

public Map<string, string> requestParameters;

}

class Error

{

// A UUID used to identify the error

public string referenceId;

// A description of the error

public string message;

}

Initiates the conversion and merging process for the specified list of documents, to create a combined document with the specified output file name attached to the specified parent record, optionally replacing specified field tags with corresponding values.

Namespace: LOOP

Package: Nintex DocGen for Salesforce

Syntax

static String ConvertAndMerge(List<Id> docIds, Id parentId, String outputFilename, Map<String, String> params, Map<String, String> fields)

Parameters

docIds

Type: List<Id>

The list of Document, ContentDocument, and ContentVersion IDs for documents to be converted and merged into an attachment.

parentId

Type: Id

The ID of the record to which the attachment and, optionally, task are attached.

outputFilename

Type: String

The file name of the document created by the process.

params

Type: Map<String, String>

Additional parameters and values to be used by the process. For more information about additional parameters and values, see Remarks.

fields

Type: Map<String, String>

Key-value pairs used to assign values to fields on the generated Attachment or ContentVersion record(s). For example, to populate the MyCustomField__c field on a created Attachment or ContentVersion record with the value, “My Custom Value”, ensure that your Map<string, string> fields parameter has a key with the name, “MyCustomField__c” with a corresponding value of “My Custom Value”.

Return value

Type: String

If the trackActivity parameter is set to true in params, the task ID; otherwise, null.

Remarks

This method initiates a process that converts and merges the documents specified in docIds into an attachment, attached to the record specified in parentId, with the file name specified in outputFileName. The process can perform additional actions, such as invoking a callback function after completion of the process, depending on the attributes and values specified in params. Optionally, if key-value pairs are specified in the fields, those fields will be populated on any generated Attachment or ContentVersion record(s).”

Additional parameters and values

The params parameter contains any additional parameters and values to be used by the process. In addition to the set of reserved additional parameters and values, you can also include any arbitrary additional parameters and values in params. All included additional parameters and values are returned in the callback method specified in the apexCallback additional parameter, so you can use the params parameter to provide additional information to the callback method.

The following table describes the attributes and values that can be specified in params.

Handling callbacks

If the apexCallback attribute is specified in params and the value of the attribute is set to the fully-qualified name of a static method in an Apex class, the process invokes the method after the completion of the conversion and merging process as a callback method, providing information about the process as a string value that represents a JSON-serialized Apex class. The following Apex sample illustrates a minimal callback function, in which the string is deserialized into a private Apex class for later use.

webservice static void myCallback(string responseData)

{

// Deserialize the response data as an

// ConvertAndMergeResponseData instance.

ConvertAndMergeResponseData responseDataObj =

(ConvertAndMergeResponseData)JSON.deserialize(

responseData,

ConvertAndMergeResponseData.class);

}

class ConvertAndMergeResponseData

{

// The Salesforce ID of the Attachment / ContentVersion created as a result of the process

public Id recordId;

// A value, either "success" or "error", indicating the status of the request

public string status;

// Information about an error that occurred as part of the process. Null if status is not "error"

public Error error;

// The version of the package installed

public string requestVersion;

// The original parameters passed to the process

public Map<string, string> requestParameters;

}

class Error

{

// A UUID used to identify the error

public string referenceId;

// A description of the error

public string message;

}

Initiates the conversion and merging process for the specified list of documents, to create a document with the specified output file name attached to the specified parent record, and optionally returns a PageReference.

Namespace: LOOP

Package: Nintex DocGen for Salesforce

Syntax

static System.PageReference GetConvertAndMergeRedirect(List<Id> docIds, Id parentId, String outputFilename, Map<String, String> params)

Parameters

docIds

Type: List<Id>

The list of Document, ContentDocument, and ContentVersion IDs for documents to be converted and merged into an attachment.

parentId

Type: Id

The ID of the record to which the attachment and, optionally, task are attached.

outputFilename

Type: String

The file name of the document created by the process.

params

Type: Map<String, String>

Additional parameters and values to be used by the process. For more information about additional parameters and values, see DocumentService

Return value

Type: PageReference

If the trackActivity parameter is set to true in params, a reference to the page for the task; otherwise, null.

This method initiates a process that converts and merges the documents specified in docIds into an attachment, attached to the record specified in parentId, with the file name specified in outputFileName. The process can perform additional actions, such as invoking a callback function after completion of the process, depending on the attributes and values specified in params.

If the process creates a task to track the process, by setting the trackActivity attribute to true in params, this method returns a PageReference object that redirects the user to the detail page for the newly created task.

Additional parameters and values

The params parameter contains any additional parameters and values to be used by the process. In addition to the set of reserved additional parameters and values, you can also include any arbitrary additional parameters and values in params. All included additional parameters and values are returned in the callback method specified in the apexCallback additional parameter, so you can use the params parameter to provide additional information to the callback method.

The following table describes the attributes and values that can be specified in params.

Handling callbacks

If the apexCallback attribute is specified in params and the value of the attribute is set to the fully-qualified name of a static method in an Apex class, the process invokes the method after the completion of the conversion and merging process as a callback method, providing information about the process as a string value that represents a JSON-serialized Apex class. The following Apex sample illustrates a minimal callback function, in which the string is deserialized into a private Apex class for later use.

webservice static void myCallback(string responseData)

{

// Deserialize the response data as an

// ConvertAndMergeResponseData instance.

ConvertAndMergeResponseData responseDataObj =

(ConvertAndMergeResponseData)JSON.deserialize(

responseData,

ConvertAndMergeResponseData.class);

}

class ConvertAndMergeResponseData

{

// The Salesforce ID of the Attachment / ContentVersion created as a result of the process

public Id recordId;

// A value, either "success" or "error", indicating the status of the request

public string status;

// Information about an error that occurred as part of the process. Null if status is not "error"

public Error error;

// The version of the package installed

public string requestVersion;

// The original parameters passed to the process

public Map<string, string> requestParameters;

}

class Error

{

// A UUID used to identify the error

public string referenceId;

// A description of the error

public string message;

}