...
The Rename action scopes to be decided are Transfer permissions, Cleanup Space permissions and Cleanup Page permissions. Read more on these Rename action scopes here:
Once you are sure you are ready to perform the Group Rename, press the Rename button to rename the Group. The pop-up window will close once the renaming process has completed, the newly renamed Group will then be shown in the list of Space Groups within CSUM.
...
When this is set to Off for a rename, then we will not search through any Pages in your instance to remove the Page permissions for the original group. This will be a LOW Potential performance impact but will lead to all Page permissions to remian for the original group in Pages where it was present prior to the rename. They will appear with the Group not found text as the Group no longer exists, similar to as shown in the prior screenshot above.
When this is set to Local for a rename then we will only search through the current Spaces Pages to remove the Page permissions for the original group if they exist. This will be a MEDIUM Potential performance impact but will lead to all Page permissions to remian for the original group in all Pages in Spaces where it was present prior to the rename, other than the current Spaces Pages.
When this is set to Global for a rename then we will search through every Page in every Space in your instance to remove the Page permissions for the original group if they exist. This will be a HIGH Potential performance impact but will lead to no Page permissions to remian for the original group in all Pages for every Space where it was present prior to the rename.
Potential performance impact
...
The reason this will appear as HIGH is due to the need for us to search through every single Page in your instance and remove any permissions for the original group, if they exist. The more Pages that you have in your instances, the more of a performance impact this could have on your rename, leading it to take a larger amount of time to complete.
Rename actions to scope summary table
Rename action to scope | Scope | Potential performance impact | Action that will occur |
|---|---|---|---|
Transfer permissions | Local | LOW | Transfer Space and Page permissions from the original Group to the new Group for only the current Space |
Transfer permissions | Global | HIGH | Transfer Space and Page permissions from the original Group to the new Group for all the current Space |
Cleanup Space permissions | Off | LOW | Remove Space permissions for the original Group for no Spaces |
Cleanup Space permissions | Local | LOW | Remove Space permissions for the original Group for only the current Space |
Cleanup Space permissions | Global | MEDIUM | Remove Space permissions for the original Group for all Spaces |
Cleanup Page permissions | Off | LOW | Remove Page permissions for the original Group for no Pages in any Spaces |
Cleanup Page permissions | Local | MEDIUM | Remove Page permissions for the original Group for only the current Spaces Pages |
Cleanup Page permissions | Global | HIGH | Remove Page permissions for the original Group for all Pages in all Spaces |
Renaming a Group to an existing Group
...
If you attempt to rename a Space Group to the name of another existing Space Group then a warning prompt will appear informing you that you can continue or cancel the Space Group rename.
...
If you continue, the Space Group to be renamed will be merged with its permissions transferred into the existing Space Group which already has the entered new name and the Space Group with has been renamed will then be removed on completion. However, if you press cancel then the Space Group rename will not take place.
Rename tasks activity
...
You can now also see the initial Group name and , the new Group name as well as the Rename action scopes for which an existing Group rename task has had been given from the above mentioned Tasks tab, within a Group renames tasks individual information. As shown below:
...
| Note |
|---|
While a Space Group has a rename task in the queue or currently running, you can not modify this Group until the rename has finished, whether successfully or not. |
Why does my Group Rename take a long time?
As explained, Confluence does not currently have a built in way to rename a Group, meaning that if chosen to, all Group Permissions and Content Permissions must be copied over from the existing Groups settings. In order to retrieve this information, we must loop through all Spaces, along with checking (and transferring) Content Permissions on a per-page basis. For large instances, this may cause a delay when renaming a Group (Even if the Group does not have Permissions outside of its Space). See Tasks for further information on how Group rename tasks are scheduled to run in the background.
Group rename scopes have been brought in to try and decrease the amount of time that is required to perform a Group rename, read below for more information on this and its risks.
Group Rename Recovery steps
Potential problems Potential and their solutions
| Warning |
|---|
If none of these work or you think you have encountered a bug. Please contact support. |
Local v Global scope renames
| Info |
|---|
Since CSUM version 4.0.2 |
There are 2 different scopes of Group renames, Local (default) and Global.
Local (default)
Group renames are default scoped to Local, this means that when a Group is renamed, Space permissions and Page permissions for the current Space are transferred to the new Group that the original Group has been renamed to.
However, this means that if the Group being renamed has permissions for other Spaces or Pages within other Spaces, these permissions will be lost.
Global
In order to rename a Space Group, your system administrator will need to enable the setting shown below in the CSUM app configuration:
Once this is enabled, when attempting to rename a Group, the user will be provided with a checkbox that will allow them to Globally scope the Group rename, as shown below:
When the checkbox is selected as shown, the rename will be Globally scoped which means that all permissions, for every Space and Page for the original Group, will be transferred to the new Group during the rename processIf a rename has not completed successfully or is taking a very long time and you have not cleaned up any of the original Groups Space or Page permissions. If the rename is still currently running, go to the Tasks tab and cancel the rename in progress before renaming the new group back to the original group. This should revert back everything back to the original state.
However, if you cleaned up any of the Space for Page permissions of the original group during the rename, then these may be lost even when reverting the new group back to the original group and will need to be added again.
| Warning |
|---|
If none of these work or you think you have encountered a bug. Please contact support. |
Why scope Group renames?
When a Group rename takes place Transfers permissions Globally, we have to check every Space and Page within your instance in order to correctly transfer Original Group permissions to the new Group, if they exist. This can take a very long time and could significantly negatively impact performance.
The Locally scoped Group rename will only check permissions for the original Group within the Space in which the original Group is based within as well as the Pages within this Space, assigning these to the new Group. This significantly reduces the negative impact on performance.
Therefore if the group being renamed only has Space and Page permissions related to the current Space, a Local rename should be sufficient and therefore decrease the potential performance that the Group rename could have. But BEWARE of the risks, which will be mentioned in the section below.
Warnings
| Note |
|---|
When performing a Group rename, ensure that you understand what the outcome will be from the scopes that you choose to perform during the rename. |
Specific warnings
Transferring permissions Locally may decrease the Potential performance impact of the Group rename, however, the new Group will not keep any Space or Page permissions for any Spaces or Pages other than for the current Space. If these are required, they will need to be added again in the future.
If Cleanup Space or Page permissions is set to off, then beware there will be remaining Space or Page permissions for the original Group that will need to be removed manually, if desired in the future.
If you Cleanup Space or Page permissions Globally, then beware that if the rename does not manage to complete successfully, if you attempt to revert the new Group back to the original Group that Permissions may have been lost on the way and need to be added again if required.