Controller: /nodeworx/branding

Required Permissions

THEMES

Action: add

Added in Version

8.0.26-2935

Description

Add Branding Package

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

name

string

Yes

iw-branding-logo-nw-login-light-mode

string

No

The login logo

iw-branding-logo-nw-menu-light-mode

string

No

The logo for the menu when expanded (large screens)

iw-branding-logo-nw-menu-condensed-light-mode

string

No

The logo for the menu when condensed (small screens)

iw-branding-logo-nw-sidebar-light-mode

string

No

The right-hand sidebar logo on the overview page

iw-branding-logo-sw-login-light-mode

string

No

The login logo

iw-branding-logo-sw-menu-light-mode

string

No

The logo for the menu when expanded (large screens)

iw-branding-logo-sw-menu-condensed-light-mode

string

No

The logo for the menu when condensed (small screens)

iw-branding-logo-sw-sidebar-light-mode

string

No

The right-hand sidebar logo on the overview page

iw-branding-menu-background-color-light-mode

string

No

The background color of the menu (left sidebar)

iw-branding-menu-text-color-light-mode

string

No

Main text color in menu/sidebar

iw-branding-menu-text-color-active-light-mode

string

No

Text color in menu/sidebar when active

iw-branding-menu-text-color-hover-light-mode

string

No

Text color in menu/sidebar when hovering over it

iw-branding-color-primary-light-mode

string

No

The primary color dictates the color of the breadcrumbs and expanded menu items on small screens

iw-branding-button-primary-text-color-light-mode

string

No

Main button text color (examples of buttons that will be impacted: search, save, and actions such as “add”)

iw-branding-button-primary-background-color-light-mode

string

No

Main button background color (examples of buttons that will be impacted: search, save, and actions such as “add”)

iw-branding-button-primary-border-color-light-mode

string

No

Main button border color (examples of buttons that will be impacted: search, save, and actions such as “add”)

iw-branding-logo-nw-login-dark-mode

string

No

The login logo

iw-branding-logo-nw-menu-dark-mode

string

No

The logo for the menu when expanded (large screens)

iw-branding-logo-nw-menu-condensed-dark-mode

string

No

The logo for the menu when condensed (small screens)

iw-branding-logo-nw-sidebar-dark-mode

string

No

The right-hand sidebar logo on the overview page

iw-branding-logo-sw-login-dark-mode

string

No

The login logo

iw-branding-logo-sw-menu-dark-mode

string

No

The logo for the menu when expanded (large screens)

iw-branding-logo-sw-menu-condensed-dark-mode

string

No

The logo for the menu when condensed (small screens)

iw-branding-logo-sw-sidebar-dark-mode

string

No

The right-hand sidebar logo on the overview page

iw-branding-menu-background-color-dark-mode

string

No

The background color of the menu (left sidebar)

iw-branding-menu-text-color-dark-mode

string

No

Main text color in menu/sidebar

iw-branding-menu-text-color-active-dark-mode

string

No

Text color in menu/sidebar when active

iw-branding-menu-text-color-hover-dark-mode

string

No

Text color in menu/sidebar when hovering over it

iw-branding-color-primary-dark-mode

string

No

The primary color dictates the color of the breadcrumbs and expanded menu items on small screens

iw-branding-button-primary-text-color-dark-mode

string

No

Main button text color (examples of buttons that will be impacted: search, save, and actions such as “add”)

iw-branding-button-primary-background-color-dark-mode

string

No

Main button background color (examples of buttons that will be impacted: search, save, and actions such as “add”)

iw-branding-button-primary-border-color-dark-mode

string

No

Main button border color (examples of buttons that will be impacted: search, save, and actions such as “add”)

Action: edit

Added in Version

8.0.26-2935

Description

Edit Branding Package

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

name

string

Yes

Action: fail

Added in Version

8.0.26-2935

Description

Magic function - test for failure mechanism.

Action: listPackages

Added in Version

8.0.26-2935

Description

List the branding packages

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'name' => 'example',
    ),
  ),
  'reply_code' => 205,
)

Action: reroute

Added in Version

8.0.26-2935

Description

Action to re-route from the current controller to a different one.

Action: setDefaultPackage

Added in Version

8.0.26-2935

Description

Set the default branding package

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

BRANDING_DEFAULT_PACKAGE

string

No

global_branding_theme, example

Set a default branding package. This will be used when no explicit assignment has been made.

Action: wait

Added in Version

8.1.3-2998

Description

Magic function - used to simulate a long-running process

Action: win

Added in Version

8.0.26-2935

Description

Magic function - test for testing success mechanism.