Zip Archive

 Show all Hide all

Generates zip archives with files from the database.

File modes: Download | Save | Save and download

File mode: Download

The user downloads the file.

SQL

SQL Call: Get archive data (mandatory)

May modify database: No

Resultset: Archive Info

Repeat mode: repeated exactly once
Row count: exactly one row

Columns:

ArchiveFilename mandatory string
The name of the generated zip file.

Resultset: Files

Repeat mode: repeated exactly once
Row count: zero or more rows

Columns:

Data mandatory binary
File data. Must be the last column in the resultset.
Directory optional string
The directory where the file is placed within the archive.
Examples: 'dir', 'dir/subdir'

Backslashes are converted to slashes.
Trailing directory separator is optional.
Can not begin with a directory separator.
Can not refer to '.' or '..'.
Filename mandatory string
The name of the file within the archive.

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.

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.
Repeat mode: 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.