Skip to end of banner
Go to start of banner

How to set the maximum number of attachments to process for the Attachment Table macro?

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This page demonstrates how administrators and users can specify the number of attachments to process in the Attachment Table macro.

Global Configuration includes a new configuration parameter named Maximum attachments to process

To improve the performance of the Attachment Table macro, Administrators can control the maximum number of attachments to process in Global Configuration for the Attachment Table macro. Setting the limit enables administrators to reduce the load and avoid Confluence performance issues crashing. (Available since app version 8.7.0).

<Screenshot>

  1. Log in as a user with the Confluence administrator's Global Permission.

  2. Navigate to Manage apps > Advanced Tables for Confluence Configuration > Global Configuration

  3. The page displays the configuration options available. For more information, refer to Configuration - 8.x.

  4. Maximum attachments to process: Select the limit for processing the maximum number of attachments from the Maximum attachments to process drop-down. The default limit is 1000. The configuration also shows the approximate number of attachments available in the Confluence instance.

Administrators should be cautious when increasing the parameter limit. Generating long queries and fetching large attachments compromise Confluence's performance. It brings down Confluence with extreme CPU load and consumes massive amounts of Java heap memory.

Administrators should be cautious when increasing the configuration limit, as this may lead to heavy Confluence usage and potentially result in degrading the performance of Confluence.

Limit the processing of the number of attachments in the Attachment Table macro

Users can specify the number of attachments that the macro must retrieve. The default value is the admin-configured limit for the parameter Maximum attachments to process in Global Configuration.

  1. Select the Attachment Table macro editor.

  2. The Page filtering tab displays the admin-configured value for the parameter Global Configuration > Maximum attachments to process and the approximate number of attachments in the instance.

<Screenshot>

3. Click the Data Settings tab. The macro parameter Limit number of attachments displays the default admin-configured limit for the Global Configuration parameter Maximum attachments to process in Global Configuration.

The field description displays the admin-configured value in the Global Configuration.

4. Enter the limit for the number of attachments to retrieve in the macro parameter field Limit number of attachments to retrieve. For more information, hover over the (info) icon for the help text.

<screen>

The macro considers the least of the value configured between the parameters Limit number of attachments to retrieve, and Global Configuration > Maximum attachments to process to process the attachments.

The various scenarios and setting the limit for processing the number of attachments

Scenario 1: The administrator and the user does not change the default value

Global Configuration: The administrator does not change the default value configured for the Global Configuration parameter Maximum attachments to process.

Macro browser input: The user does not change the default value for the macro parameter Limit number of attachments to retrieve.

Scenario 1 result: The Global Configuration parameter Maximum attachments to process and the macro parameter Limit number of attachments have the same default value configured as 1000. have the same default value configured. In that case, the macro considers the default value while processing the attachments. The macro stops processing after the number of attachments found matching the selection criteria reaches the default value of 1000.

The Confluence page shows the processed attachments and their metadata as a table.

Scenario 2: The administrator changes the value for the Global Configuration parameter Maximum attachments to process (This is for my reference: the value can be lower or higher than 1000)

Global Configuration: The administrator changes the value configured for the Global Configuration parameter Maximum attachments to process.

<Screenshot>

Macro browser input: The user does not change the value for the macro parameter Limit number of attachments to retrieve.

<Screenshot>

Scenario 2 result: In this case, the macro considers the least of the value configured between the parameters, Limit number of attachments to retrieve, and Maximum attachments to process. The macro stops processing after the number of attachments found matching the selection criteria reaches the value.

The Confluence page shows the processed attachments and their metadata as a table.

Scenario 3: The user provides a higher value than the admin-configured limit

Global Configuration: The administrator has configured a limit for the parameter Maximum attachments to process.

<Screenshot>

Macro browser input: The user enters a higher value for the parameter Limit number of attachments to retrieve than the admin-configured limit.

Scenario 3 result: In this case, the macro considers the least of the value configured between the parameters, Limit number of attachments to retrieve, and Maximum attachments to process. For example, here, the macro considers the admin-configured value for the Global Configuration parameter Maximum attachments to process that is <value>. The macro stops processing after the number of attachments found matching the selection criteria reaches the least of the value configured.

The Confluence page shows the processed attachments, their metadata as a table, and a warning message.

Scenario 4: The user provides a lower value than the admin-configured limit

Global Configuration: The administrator has configured a limit for the parameter Maximum attachments to process.

<Screenshot>

Macro browser input: The user enters a lower value for the macro parameter Limit number of attachments to retrieve than the admin-configured limit.

<Screenshot>

Scenario 4 result: In this case, the macro considers the least of the value configured between the parameters, Limit number of attachments to retrieve, and Maximum attachments to process. For example, here, the macro considers the user-configured value for the macro parameter Limit number of attachments to retrieve that is <value>. The macro stops processing after the number of attachments found matching the selection criteria reaches the value <number>.

The Confluence page shows the processed attachments and their metadata as a table without any warning message.

  • No labels