OnActionInvokerResult Global Function

Format

function string OnActionInvokerResult(string action, string result, string resultType)

Description

OnActionInvokerResult is a special global function. It is called when processing a result from the Action Invoker when called from CSPro logic. As with other user-defined functions, it must be defined in the PROC GLOBAL section.

The function must return a string value and have three string parameters. When the Action Invoker finishes processing an action, or the action ends in an exception, OnActionInvokerResult is called with the following arguments:

action: The name of the executed action.
result: The result of the action in JSON, or the exception message as a string.
resultType: The result type: undefined, null, string, number, boolean, array, object, or exception.

Return Value

If the function returns a blank string, "", the result of the action, or the exception, is processed as it normally would be. However, if a non-blank string is returned, that string is returned as the action result. When an exception is processed, if a non-blank string is returned, CSPro will not display the runtime error message.

Example

PROC GLOBAL

numeric aiSuccess;
string aiErrorMessage;

function string OnActionInvokerResult(string action, string result, string resultType)

// instead of displaying exception messages, set aiSuccess to true on success,
// and on failure, store the error message in aiErrorMessage
if resultType = "exception" then
aiSuccess = false;
aiErrorMessage = result;

// returning non-blank prevents CSPro from displaying the exception message
exit " ";

else
aiSuccess = true;
aiErrorMessage = "";

// returning blank maintains the original result
exit "";

endif;

end;

PROC EXAMPLE

CS.File.copy(source := "Rusty Blackbird.jpg", destination := "Vulnerable Birds/");

if aiSuccess then
errmsg("File copied successfully.");
else
errmsg("File copy error: %s", aiErrorMessage);
endif;