Skip to main content

Agency Admin Side Panel

The business purpose of Agency Admin Side Panel is to aggregate the "Agency Admin" type workflows.

agency admin
Note
The Agency Admin Side Panel icon in the right toolbar is visible only if the user has at least one Agency Admin Side Panel workflow defined.

Contributing

Red Apps can contribute to Agency Admin Side Panel via ExtensionPointService. The first step is to add all required imports:

import {AdminSidePanelConfig} from 'sabre-ngv-adminSidePanel/configs/AdminSidePanelConfig';
import {AdminSidePanelButton} from 'sabre-ngv-adminSidePanel/configs/AdminSidePanelButton';
import {ExtensionPointService} from 'sabre-ngv-xp/services/ExtensionPointService';

Then Red Apps can contribute under adminSidePanel key as follows:

// Creating Config
const config = new AdminSidePanelConfig([
    new AdminSidePanelButton({
        // Label
        label: 'Red App Workflow',
        // Class Names
        className: 'btn btn-secondary',
        // Callback Function
        onClick: onClick,
        // Button Icon
        icon: 'fa-shopping-cart'
    })
]);

// Adding Config
getService(ExtensionPointService).addConfig('adminSidePanel', config);

Config Properties

The following properties can be defined for config:

Property Description

buttons

List of buttons that will be added with this config.

Button Properties

The following properties can be defined for button:

Property Description

label

Label of the button visible in the side panel that triggers defined onClick action.

className

String containing class names that will be added to button in the side panel.

onClick

Action that will be triggered once button in the side panel is clicked. This is a function that takes no arguments and returns void. It can be async.

icon (optional)

Optional icon rendered next to side panel button label. Expects Font Awesome font class (e.g. "fa-shopping-cart").