FireRecordScriptAlias
Description
Calls the action that calls the hook script.
You can use this method to programmatically simulate a user choosing an action that launches a hook. The method wraps a named hook script in an action.
HCL Compass has an action type of _RECORD_SCRIPT_ALIAS and if an action is of this type, you can call this method, instead of calling EditEntity, Validate and Commit.
Syntax
VBScript
session.FireRecordScriptAlias entity, editActionName
Perl
$session->FireRecordScriptAlias(entity, editActionName);
- Identifier
- Description
- session
- The Session object that represents the current database-access session.
- entity
- The entity must be an entity object previously returned by BuildEntity, GetEntityByDbId, or GetEntity.
- editActionName
- The edit action name must be the name of a valid action as defined in the metadata.The action type must be RECORD_SCRIPT_ALIAS or this method fails.
- Return value
- A String containing the script return value determined by the hook.