Configuring the limit for User Options results

Overview

From version 8.24.0 onwards, Scaffolding provides an administrator setting that allows Confluence administrators to set the default limit for User Options results. When this limit is exceeded, the processing stops and an error message is displayed.

Why there is a limit for User Options

The User Options macro is useful for retrieving users with specific permissions from a variety of user directories. However, processing a huge number of users with their permissions, when used with the check or select list type, may cause performance issues for Confluence.

It is also a bad experience for users to have to select an option from a huge list of radio buttons, checkboxes, or dropdown menus if there are a huge number of user results. Setting List Data with the auto complete type is more appropriate in that use case.

This limit is different from the List Data items limit in the sense that it only targets accidental misuse of the powerful User Options macro at an upstream stage when very large user directories are being queried. On the other hand, the List Data items limit activates downstream just before rendering and it targets all List Data submacros.

Enabling or disabling the User Options limit

This query limit is enabled by default when upgrading to Scaffolding 8.24.0. The default limit value is 250.

Refer to the Accessing Scaffolding's Administrator Settings guide to get access to the settings page.

  • go to the User Options query limit settings header

  • choose the Edit button

On this page, you can enable or disable the User Options limit by

  • toggling the Enabled toggle on or off

In the User Options query limit input field (defaults to 250).

  • update the value to set a new limit (if required)

  • choose Save

From version 8.24.0 onwards, when this limit is exceeded, the processing stops and an error message is displayed.

Why there is a limit for User Options

The User Options macro is useful for retrieving users with specific permissions from a variety of user directories. However, processing a huge number of users with their permissions, when used with the check or select list type, may cause performance issues for Confluence.

It is also a bad experience for users to have to select an option from a huge list of radio buttons, checkboxes, or dropdown menus if there are a huge number of user results. Setting List Data with the auto complete type is more appropriate in that use case.

This limit targets accidental misuse of the powerful User Options macro at an upstream stage when very large user directories are being queried.

This limit is different from the List Data items limit. The List Data items limit activates downstream just before rendering and it targets all List Data submacros.

Enabling or disabling the User Options limit

Refer to the Accessing Scaffolding's Administrator Settings guide to get access to the settings page.

  • go to the User Options query limit settings header

  • choose the Edit button

On this page, you can enable or disable the User Options limit

  • by toggling the Enabled toggle on or off

In the User Options query limit input field (defaults to 250)

  • add a value to set a new limit (if required0

  • choose Save