Locking

In a collaborative environment, many editors may be working simultaneously on the same item, which opens the possibility of one editor overwriting the edits of another editor. To prevent conflicting edits, Brightspot locks content in one of two ways:

  • Content locking locks content at the item level. When the first user (locking user) opens an item in the content edit form, all fields are locked to any other users until the item is released by the locking user.

  • Field-level locking locks only the fields modified by a user, allowing other users to modify other fields in the content edit form. The user who locks a field first is the locking user, preventing other users from accessing the field. For example:

    Action Result
    Andy is modifying the headline Headline field is locked to Alice and Arthur
    Alice is modifying the image Image field is locked to Andy and Arthur
    Arthur is modifying tags Tags field is locked to Andy and Alice

Content Locking

Content locking locks content at the item level. The Status Area informs other users that the item is locked and by whom.

../../../_images/content-lock.png

Lock message with option to unlock

When an item is locked, Save is removed from the Tools Menu and Publish from the Editorial toolbar, preventing all users except the locking one to change the item. If another user belongs to a role with permission to ignore a content lock, then the lock message includes an option to ignore the lock.

Note

You can turn off the role permission for ignoring content locks. If the permission is turned off, then the ignore option is excluded from the lock message. For information about changing a role’s permissions, see Editing Roles.

When the locking user releases the item, the lock message is removed from the Status Area, and the item is editable to other users. (Those users may have to refresh their content edit forms to see that the item has been unlocked.)

Enabling content or field locking

To enable content or field-level locking:

  1. From the Navigation menu, select Admin > Sites & Settings.

  2. In the Sites & Settings widget, click Global. The Edit Global widget appears.

  3. In Main, under UI, scroll to Content Locking.

  4. Toggle on to enable Content Locking, or toggle off to enable Field-level locking.

    ../../../_images/content-lock-enabled.png

    Content locking enabled

    ../../../_images/field-lock-enabled.png

    Field-level locking enabled

  5. Click Save.

Ignoring a content lock

To ignore a content lock:

  1. In the lock message (see Lock message with option to unlock), click Unlock. Brightspot displays a confirmation message.

    ../../../_images/ignore-content-lock.png
  2. Click OK. Brightspot makes the item’s fields editable, and locks the item for other users.

  3. Edit the item as necessary.

  4. Click Save in the Tools Menu or publish the item.

Field-level locking

Field-level locking locks only the fields modified by a user on a first-come, first-served basis. For example, a user named Worf opens an article and makes an edit in the sub-headline field. At this point, Brightspot locks the sub-headline field in favor of Worf. When Alice opens the same article, she sees a highlighted avatar in the editorial toolbar, indicating that another user, Worf, is also working on the same item.

../../../_images/disable-lock-icon.svg

Whoever modifies a field first is the locking user for the field, preventing the other user from modifying it. For example, Alice tabs into the sub-headline field, and sees that the field is locked by Worf.

../../../_images/content-overwrite-icon.png

Field-level locking with the option to unlock

When Worf saves or publishes the item, Brightspot releases the field lock, and Alice can then edit the sub-headline field.

If another user belongs to a role with permission to unlock a field lock, then the lock message includes an option to override the field lock (see previous illustration).

Note

You can turn off the role permission for unlocking field locks. If the permission is turned off, then the unlock option is excluded from the pending-edit message.

Unlocking a field

  1. In the locked field, click Unlock. Brightspot displays a confirmation message.

    ../../../_images/ignore-field-lock.png
  2. Click OK. Brightspot makes the field editable

  3. Edit the field.

  4. Click settings then Save, or click Publish.