Component: Linear Process

 Show all Hide all

Visualizes processes consisting of sequential steps.

Component settings

Step height
The height of each step.
Step width
The width of each step.

SQL

SQL Call: Get steps (mandatory)

Supports custom errors: No
May modify database: No

Resultset: Steps

One row per step in the process.
Repeat mode: repeated exactly once
Row count: one or more rows

Columns:

<xxx> optional string
All other columns are used as passing fields to the link specified.
BackgroundColor optional string
Background color on the hex format "#RRGGBB".
Body optional string
The step body.
Caption optional string
The caption shown below the step.
HasArrow optional bit
If there is an arrow to the right of the step.
LinkId optional int
Link ID to use. The link must exist and be of the type "Process step link".
Title mandatory string
The step title.

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.

URL

Querystring parameters

menuitemheading optional text
String that replaces the menu item name when the menu item is loaded. It does not replace the name before that (like for example in the navigator). It is ignored if the menu item is displayed as a part in a multipart in which case the name can be set from the multipart procedure.