Restrict Exporting for Spaces and Groups
As a System Administrator or Confluence Administrator, you can choose which spaces and/or user groups have the option to export content with Scroll Word Exporter.
To do this, simply navigate to Confluence administration > Scroll Runtime > Advanced Scroll App Settings > select Scroll Word Exporter from the drop-down. You can then edit the specific advanced plugin settings depending on the restrictions that you want to apply.
If you experience system instability with large Word exports you can also try to enable the external process Word conversion. You can find out more about this process here.
Advanced plugin settings
The advanced plugins work together and their values are case-sensitive which means they must match the defined values set in Confluence. Their parameters are described below:
Applying export restrictions for spaces
Key | Value | Description |
|---|---|---|
| * (default) | If the value is set to * all spaces will have the option to export. |
(empty) | If no value is set, every space will be restricted from exporting. | |
SPACEKEY1,SPACEKEY2 | By defining a space key for this value it is possible to allowlist a space so that the option to export is available. Multiple space keys can be entered in this field by using a comma separated list. | |
| (empty) (default) | If the value is left empty, all spaces will have the option to export |
* | If the value is set to * all spaces will not have the option to export | |
SPACEKEY1,SPACEKEY2 | By defining a space key for this value it is possible to blocklist a space so that the option to export is unavailable. Multiple space keys can be entered in this field by using a comma separated list. |
Please note that the blocklist advanced plugin setting export.disallowed.in.spaces will take precedence over the whitelist advanced plugin setting export.restricted.to.spaces.
For example, if you were to define the same value for different plugin settings:
export.restricted.to.spaces= * (all spaces have the option to export)export.disallowed.in.spaces= * (all spaces do not have the option to export)
This would result in all spaces not having the option to export.
Applying export restrictions for user groups
Key | Value | Description |
|---|---|---|
| * (default) | If the value is set to * all users will have the option to export |
(empty) | If no value is set every user group will be restricted from exporting. | |
USER-GROUP1,USER-GROUP2 | By defining a user group for this value it is possible to allowlist a user group so that the associated users can export. Multiple user groups can be entered in this field by using a comma separated list. | |
| (empty) (default) | If the value is left empty, all users will have the option to export |
* | If the value is set to * the option to export will be unavailable for all users | |
USER-GROUP1,USER-GROUP2 | By defining a user group for this value it is possible to blocklist a user group from being able to export. Multiple user groups can be entered in this field by using a comma separated lis |
Please note that the blocklist advanced plugin setting export.disallowed.for.groups.global will take precedence over the allowlist advanced plugin setting export.restricted.to.groups.global.
For example, if you were to define the same value for different plugin settings:
export.restricted.to.groups.global= * (all user groups have the option to export)export.disallowed.for.groups.global= * (all user groups do not have the option to export)
This would result in all user groups not having the option to export.
Restricting Exports for Anonymous Users
Anonymous users do not have a specific user group in Confluence. Therefore, Scroll Word Exporter will block access to export for anonymous users if any other user group is defined in the blocklist (ie. via export.disallowed.for.groups.global).
Further User Group Restriction Example
When only the allowlist setting is configured, the defined ‘allowed’ groups will have access to export. All remaining groups that are not present on the allowlist will be blocked from exporting.
Multiple User-Group Scenario
A Confluence user, Peter, is included in multiple user groups with different allowlist restrictions via the following allowlist setup:
User-Group A - is present on the allowlist via
export.restricted.to.groups.globalUser-Group B - is not present on the allowlist
The following restrictions will be applied to the users;
James is only included in User-Group A and is allowed to export
Marie is only included in User-Group B and is not allowed to export
Peter is included in both User-Group A & User-Group B and is allowed to export