Page Builder Background Jobs icon
Module Id
pagebuilder-background-jobs
Group Id
org.jahia.community
Updated
Requires Jahia
8.2.2.0
Author
dgigon@jahia.com
Category
Tools and Utilities
Status
COMMUNITY info

Page Builder Background Jobs group_work

pagebuilder publication jobs

Page Builder Background Jobs

Overview

Page Builder Background Jobs adds a jobs panel to the JContent Page Builder header. It allows authorized users to monitor publication-related background jobs directly from Page Builder, without leaving the current editing context.

Depending on its OSGi configuration, the module can either display only publication jobs or expose the full list of background jobs.

Main Features

  • Adds a dedicated action in the JContent Page Builder header.
  • Displays background job information in a dedicated dialog.
  • Supports auto-refresh and pagination.
  • Can be configured to show only publication jobs or all background jobs.
  • Can be restricted to authorized users through Jahia permissions.

User Interface Modes

The module supports two display modes.

Publication jobs mode

  • Default mode.
  • Only jobs whose group contains PublicationJob are returned.
  • The header button label is Publication jobs.

Background jobs mode

  • Optional full mode.
  • All background jobs are returned.
  • The header button label is Background jobs.
  • Job group filters are displayed in the dialog.

OSGi Configuration

The module behavior is controlled through the following OSGi configuration:

PID: org.jahia.support.modules.pagebuilder.backgroundjobs

Property: showAllJobs

Default value:

showAllJobs=false

Behavior:

  • showAllJobs=false: only publication jobs are displayed.
  • showAllJobs=true: all background jobs are displayed.

Permissions

The module provides a dedicated Jahia permission:

canAccessJobsInformation

Access is granted under the following rules:

  • guest users are denied.
  • root is allowed.
  • Users with the Jahia admin permission are allowed.
  • Users with canAccessJobsInformation are allowed.

If a user does not have access, the action button is hidden in the Page Builder interface.

Displayed Information

The dialog can display the following information for each job:

  • Job name
  • Job group or type
  • Status
  • Description
  • Creation time
  • Duration
  • User

In full mode, the dialog also provides job group filters to help users narrow down the list.

Dependencies & Dependants

Dependencies
  • NONE
Dependants
  • NONE

How To Install

How to Grant Access

  1. Install the module from the Jahia Store.
  2. Open Jahia role and permission management.
  3. Add the canAccessJobsInformation permission to the role that should access the jobs panel.
  4. Assign this role to the appropriate users or groups.
  5. Reload JContent Page Builder and verify the button visibility.

Images

License

MIT License

Copyright (c) 2026 Dominique Gigon

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.