Component: Image Process

 Show all Hide all

Image processing component. The component reads images of any type that .Net understands (jpeg, gif, png, bmp, tif, and possibly others). It can execute simple commands, like resizing, and convert images to a different type.

File mode: Batch

A variable number of files are generated and saved in the database.
Supported modes: Batch

SQL

SQL Call: Commands (mandatory)

Statement to extract images and commands.
Supports custom errors: No
May modify database: No

Parameters:

@command mandatory bit
Set to 1 when component wants commands.

Resultset: Images and commands

Resultset with commands. Do not send too many large images -- we hold the whole resultset in memory.
Repeat mode: repeated zero or more times
Row count: zero or more rows

Columns:

<xxx> mandatory binary
Image to process
<xxx>filename mandatory string
Name of image
Command optional string
Command to run on image. To run several commands they must be delimited by semicolon.
Possible value Description
size(<width>,<height>) Fit image to requested size, preserving aspect ratio. For example, size(100,100) would convert a 500x400 image to a 100x80 image.
thumb(<width>,<height>) Force image to requested size, preserving aspect ratio, and padding with transparent (for png) or white pixels if necessary. For example, thumb(100,100) would convert a 500x400 image to a 100x80 image, then pad it to become a 100x100 image.
DestinationFormat optional string
Format to convert image to. Supported formats are 'jpg','png','gif','bmp','tif'. If no format is specified then the image's old format will be used. If the old format is not supported for conversion then it will be converted to a jpeg, assuming that the component is even able to read the image data.
Id mandatory string
Unique identifier for this task.

SQL Call: Store image (mandatory)

Statement to save image. This command is repeated once for every image returned in the command resultset.
Supports custom errors: No
May modify database: Yes

Parameters:

@filename mandatory string
Name of the converted image. The extension is changed to the requested image type. For example, if you converted 'flowers.bmp' to a jpeg then the filename will be 'flowers.jpg'.
@id mandatory string
Unique identifier for the task.
@image mandatory binary
Converted image

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.
Supports custom errors: No
May modify database: No

Parameters:

@force optional bit
@validateparams mandatory bit
This parameter is set to 1 by Softadmin® 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'.
Supports custom errors: No
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.