Executes developer-provided custom components: components without a visible user interface used mostly for integration and data processing.
Custom Components are subclasses of the Softadmin.Api.CustomComponent
class, stored in DLL:s in the bin/Plugins folder
.
To use a custom component you must:
For API documentation, see
https://softadminapi.softadmin.com/
This call is only made if the Custom Component overrides the GetForwardRequest()
method to return a non-null value. For example:
public override IDbRequest GetForwardRequest()
{
var request = this.DbRequestFactory.CreateRequest("Forward");
request.SetParameter("Forward", true);
request.SetParameter("BatchId", this.BatchId);
return request;
}
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.
Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.
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.
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.
Displays a user friendly error message to the user.
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.
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'.