Error pages

Error pages can be divided into business errors and platform errors.

Platform errors

Platform errors are errors that occur when an error appears in the application that is handled by default in the platform, e.g. a session expiration error.

In the above situation, an error page is displayed containing textContent set in the platform configuration errorPagesConfiguration

The configuration is set centrally in the platform. We do not have the ability to update it low-code in the designer. If changes are needed, contact the administrators.

Example configuration:

<code_default>
    <content>error_page_default-*</content>
</code_default>
<code_serverSessionExpired>
    <content>error_page_serverSessionExpired-*</content>
    <retryButtonAvailable>true</retryButtonAvailable>
    <styleName>spider-night</styleName>
</code_serverSessionExpired>
<code_formLimitExceeded>
    <content>error_page_formLimitExceeded-*</content>
</code_formLimitExceeded>

Business errors

Business error is a situation in which a user's action, a system process, or interaction with an external system violates the adopted business rules - even though, from a technical point of view, the operation could be performed.

Examples:

• Attempt to withdraw an amount exceeding available funds.
• Submitting an application with an inactive customer account.
• Entering the application as a not logged in user, even though login is required

How to invoke?

Business error can be invoked in script services and script validators. The best way to do this is to use the method throwBusinessException and getErrorPageDefinitionBuilder.

Methods that can be called on the context object:

context.getErrorPageDefinitionBuilder()
.body(string)
.styleName(string);
.msg(string)
.pageTitle(string)
.pageTitleKey(string)
.sidebarSlot2TextContent(string);
.sidebarSlot2(string);
.sidebarSlot1TextContent(string);
.sidebarSlot1(string);
.retryButtonAvailable(string)
.retryButtonAvailable(boolean);
.logobarTitle(string);
.logobarTitleKey(string)
.logobarDescription(string);
.bodyTextContent(string);
.parameter(String key, String value)
.cause(Throwable cause)
.redirectUrl(string)
.redirectDelayInMillis(string)
.businessFormIdentifier(string)

In the context object, do not call the method build()

A good practice is to use the method .msg when invoking a business error. A clear business message should be passed in it - e.g. .msg("Application unavailable"). The defined message will be written to the logs, which makes analysis and identification of errors easier.

Example script with descriptions:

function callService(context) {
    let option = context.getFirstParameter('option');
 
    if (!option) {
        return []
    }
 
    let builder = context.getErrorPageDefinitionBuilder() // The method prepares the error screen to be displayed
 
    switch (option) {
        case "1": // Error screen that shows the 'error_page_default' Content artifact
            builder.bodyTextContent("error_page_default-*")
            builder.msg("Application unavailable") // Error message that will be written to the logs
            break;
        case "2": // Error screen added using the content provided in body
            builder.body("Default body in object")
            builder.parameter("type", "info")
            builder.msg("Application unavailable")
            break;
        case "3": // Error screen that shows the 'error_page_noAuthorization' Content artifact
            builder.bodyTextContent("error_page_noAuthorization-*")
            builder.pageTitle("Page title")
            builder.logobarTitle("Logo title")
            builder.retryButtonAvailable(true);
            builder.msg("Application unavailable")
            break;
        default: // Default error screen displayed as a result of an error in the script
            throw "Script exception"
 
    }
    context.throwBusinessException(builder); // Throwing the error screen with the prepared builder object
 
 
    return [{ 'output': '' }];
}