Download File

Downloads a file from the database.

Component modes: Download file

Component mode: Download file

The file can be downloaded to the user's computer.

File modes: Download

File mode: Download

The user downloads the file.

SQL

SQL Call: Retrieve file (mandatory)

SQL to retrieve the file from the database.

May modify database: No

Resultset: File

Resultset with file to download.
Table count: repeated exactly once
Row count: exactly one row
Columns
xxx mandatory binary
Binary data with the file to download. Mandatory unless TextContent is used instead. You can use any name for this column as the component finds it from its data type.
TextContent optional string
Used to send text from the database and have the web server convert it to binary data. The TextContent column is ignored if there is a binary column in the resultset.
TextEncoding optional string
Used together with the TextContent column to give the encoding to use to convert the text to bytes. For example "utf-8", "latin1" or "iso-8859-1". Mandatory when TextContent is used, ignored otherwise.
ContentType mandatory string
The MIME type of the file, for example "image/jpeg" or "application/json".
xxxContentType optional string
When serving binary data in the xxx column you can use the column name xxxContentType instead of ContentType. The two content type columns are functionally equivalent.
FileName mandatory string
The file name of the file.
xxxFileName optional string
When serving binary data in the xxx column you can use the column name xxxFileName instead of FileName. The two file name columns are functionally equivalent.

SQL Call: Finished

Component wants to know where to forward to, if forwarding is set to "Forward dynamically".

May modify database: No

Parameters

@Forward bit
Set to '1' by Softadmin® when the component is finished.

Resultset: Forwarding definitions (optional)

Table count: repeated zero or more times
Row count: exactly one row
Columns
<passing_field> optional string
Any column with no other specific meaning will pe passed along to the menu item you are forwarding to.
ADMIN_CancelCidStepsBack optional int
Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.
ADMIN_CancelReturnToMenuItem optional string
Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_CancelMenuItem optional string
Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.
ADMIN_CancelMenuItemId optional int

Deprecated. Use ADMIN_CancelMenuItem instead.

Id of the menuitem to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.

ADMIN_CidStepsBack optional int
Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.
ADMIN_ReturnToMenuItem optional string
Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_Force optional string
Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.
ADMIN_Forward optional string
Displays a user friendly message and then forwards to the next menu item.
ADMIN_ForwardLink optional string
Alias of the link to forward to.
ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuGroupId optional int

Deprecated. Use ADMIN_ForwardMenuGroup instead.

Id of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string
Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.
ADMIN_ForwardMenuItemId optional int

Deprecated. Use ADMIN_ForwardMenuItem instead.

Id of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string
Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.
ADMIN_SetFieldValueFromPopup optional string
Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.
ADMIN_ClosePopup optional bit
If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.
Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.
ADMIN_ClearHistory optional any
When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.
ADMIN_RefreshMenu optional bit
Will trigger a reload of the sidebar if the column is anything but NULL.
Cache optional string
Cache key to be cleared. Supports wildcards.
CacheUserId optional string
Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.
CancelButtonText optional string
Changes the text of the Cancel button when used with ADMIN_Force.
OkButtonText optional string
Changes the text of the OK button when used with ADMIN_Message, ADMIN_Force, or ADMIN_Forward.

SQL Call: Validate parameters

Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and Validate parameters is checked.

May modify database: No

Parameters

@Force bit
Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.
@ValidateParams bit
Set to 1 when this call is made.

Resultset: Messages (optional)

Table count: repeated zero or one time
Row count: zero or one row
Columns
ADMIN_Force optional string
Message asking the end user to confirm their parameters.
ADMIN_Message optional string
Message explaining why the parameters are rejected.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.

May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.
Table count: repeated exactly once
Row count: exactly one row
Columns
GrantAccess mandatory bit
1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.

Examples

Download file 

ALTER PROCEDURE Util.Template_Download
	@Id int
AS
BEGIN
	SELECT
		T.Document,
		T.DocumentContentType,
		T.DocumentFilename
	FROM
		Util.Template T
	WHERE
		T.DocumentId = @Id;
END

Exporting text files

Let downloadfile deal with text encodings instead of casting varchar to varbinary in the database.

DECLARE @JsonData nvarchar(MAX) = (
	SELECT
		LogDatetime,
		LoginResult,
		IsSuccessfulLogin,
		Username,
		IpAddress
	FROM
		SoftadminApi.LoginLog
	FOR JSON AUTO);

SELECT
	'LoginReport.json' AS FileName,
	@JsonData AS TextContent,
	'utf-8' AS TextEncoding,
	'application/json' AS ContentType;