ReportSave()
Estimated reading time:
6 minutes
Function Summary
The ReportSave function will use a designated Data Portal to save data in a worksheet to a data source. Typically this is done by setting up a DataPortal to run a procedure to take the designated data in the worksheet and save it to a data source. This function makes it convenient to upload local changes to the data source without having to edit it directly.
For an example of this function, see Develop: Editing Data Save .
Function Arguments
DataPortal The name of the Interject Data Portal that will be used when this function is ran.
Type
String/jDataPortal()
Constraints
Max 255 char
If Blank
Function Error
RowDefRange A single column range that contains the unique row IDs that will be used to save the rows in this range via the data source. A corresponding column name for the unique ID must be included in this column in the row defined in ColDefRange.
Type
Range
Constraints
Must be a single column
If Blank
Function Error
ColDefRange Column definition range: The range designating the names of the columns that will be saved via the data source.
Type
Range
Constraints
If Blank
Will save all columns
ResultsRange The range designating the names of the columns that will be returned via the data source. Typically this is information sent back from the Data Portal to be displayed after a save.
Type
Range
Constraints
If Blank
No return data is displayed
Parameters The cells designating the matching parameters for the Data Portal. The values in these cells will filter the data that is saved via the data source.
Type
Param()
Constraints
The values must match the order of the parameters in the data source (The order can be verified using the [Validation Report](/wTroubleshoot/Reports.html#validation-report-for-pullsave-events) )
If Blank
Data is not filtered
AutoSaveFile True: Will save the workbook after a save action. (Saves at current save location without prompt. If file is not saved already, will save in the last used folder.) False: Will not save the workbook after a save action.
Type
Boolean
Constraints
If Blank
False
CaptureAllRows True: Will override the value in RowDefRange and designate all rows to be saved via the data source. False: Will use the value in RowDefRange to determine which rows are saved.
Type
Boolean
Constraints
If Blank
False
=ReportSave("NorthwindInvoiceSave",B42:B58,12:12,14:14)
Function Composition
Argument Name
Example Mapping
Explanation
Function Name
=ReportSave()
The name of this function.
DataPortal
"NorthwindInvoiceSave"
This function will use the "NorthwindInvoiceSave" Data Portal for the data source.
RowDefRange
B42:B58
The unique row IDs are designated to be in column B and the rows 42:58 will be saved.
Col Def Range
12:12
Row 12 is designated to contain the column names that will be saved via the data source.
ResultRange
14:14
Row 14 is designated to contain the column names that will be displayed when returning from the save.
Parameters
N/A
Data will not be filtered for this save.
Embeddable Helper Functions