Error pages

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

Platform errors

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

In the above situation an error page is displayed containing the 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 required, 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 action, a system process or an interaction with an external system violates accepted business rules — even though from a technical point of view the operation could have been carried out.

Examples:

• Attempting to withdraw an amount exceeding the available funds.

• Submitting an application with the client's account inactive.

• Accessing an application as an unauthenticated user, even though login is required

How to invoke?

Business error it can be invoked in script services and script validators. It is best 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)

The build() method should not be called on the context object build()

A good practice is to use the .msg method 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 facilitates analysis and identification of errors.

Sample 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 Content artifact 'error_page_default'
            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 the object")
            builder.parameter("type", "info")
            builder.msg("Application unavailable")
            break;
        case "3": // Error screen that shows the Content artifact 'error_page_noAuthorization'
            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 a script error
            throw "Script exception"
 
    }
    context.throwBusinessException(builder); // Throwing the error screen with the prepared builder object
 
 
    return [{ 'output': '' }];
}