SI.GETATTACHMENTS

Applies to:

Velixo NX
Sage Intacct

The SI.GETATTACHMENTS function retrieves the URL of a document within Sage Intacct and displays that in your report.

During a PDF Distibution process, the specified file will be downloaded from Sage Intacct and included in the resulting PDF file attached to the email created by the Distibution.

^{The function supports the following formats: JPEG, PDF, PNG, GIF.}

The function is only able to retrieve attachments for objects that contain the SUPDOCID field. To check for available fields, use the SI.OBJECTDEFINITION function.

Syntax

^{=SI.GETATTACHMENTS(ConnectionName, Object, RecordNo, NameFilter, Caption)}

Parameters

The SI.GETATTACHMENTS function uses the following parameters:

Parameter	Required/Optional	Description
ConnectionName	Required	The name of the connection as configured in the Connection Manager
Object	Required	The Sage Intacct object containing the file to be downloaded
RecordNo	Required	The record number (within the Object) containing the file to be downloaded
NameFilter	Optional	A filter specifying the specific name of the file to be downloaded
Caption	Optional	A caption that will be displayed at the top of the attached sheet when it appears in the resulting PDF file.

Valid NameFilter special characters

Wildcard Symbol	Description	Example	Matches	Does not match
*	matches any number of any characters including none	Law*	Law, Laws, or Lawyer	GrokLaw, La, or aw
*	matches any number of any characters including none	Law	Law, GrokLaw, or Lawyer	La, or aw
?	matches any single character	?at	Bat, bat, Cat or Cat	at
[abc]	matches one character given in the bracket	[BC]at	Bat or Cat	bat, cat, at, or BCat
[a-z]	matches one character from the (locale-dependent) range given in the bracket	Letter[0-9]	Letter0, Letter1, Letter2 up to Letter9	Letter, Letters, or Letter10

Examples

Example 1

^{=SI.GETATTACHMENTS("Sage","ARINVOICE","3157","3_page_PDF.pdf")}

Description

Will prepare the report to download the specified file (3_page_PDF.pdf) from record #3157 of the ARINVOICE object.

Result

Before the Distibution of the report is performed, the function will return the URL of the file (3_page_PDF.pdf).

e.g.,

After the Distibution, the function will display that the specified file was processed:

Example 2 - including a caption

^{=SI.GETATTACHMENTS("Sage","ARINVOICE",C13,,D13)}

Description

Will prepare the report to download the file specified in cell C13 from the ARINVOICE object. When the file is included in the resulting PDF file, the caption listed in cell D13 will be included at the top.

(cell references were used for all of the parameters in this example)

Output