1. Introduction

Attachment Locker prevents file conflicts and data loss in Confluence. It allows users to lock attachments before editing them, ensuring no one else can overwrite their work while they are making changes. If someone tries to upload a new version of a locked file, the system automatically reverts it to protect the original work.

2. Installation

1. Log in to your Confluence instance as an Administrator.

2. Navigate to Apps > Find new apps.

3. Search for "Attachment Locker".

4. Click Get app (or Install) to add it to your site.

5. Once installed, the app is immediately active on all pages with attachments.

3. For Users: How to Lock Files

Accessing the Locker

• Navigate to any Confluence page that has attachments.

• Look for the Attachment Locker button in the content byline (near the page title or share/watch buttons).

Open

• Quick View: Click the button once to see a dropdown list of attachments on the current page.

  • Full View: Inside the dropdown, click "Full View" to open a large window with more details, sorting, and search options.

Open

Locking an Attachment

1. Find the file you want to work on.

2. Click the Lock button next to the file name.

3. Status Indicators:

   • 🔵 Blue (LOCKED BY YOU): You have successfully locked the file. It is safe to download and edit.

   • 🔴 Red (LOCKED): Another user has locked this file. You cannot edit it until they unlock it or the timer expires.

   • 🟢 Green (UNLOCKED): The file is free for anyone to lock.

Open

Unlocking

1. When you are finished editing and have uploaded your new version:

2. Open the Attachment Locker.

3. Click the Unlock button next to your file.

4. The file becomes available for others to use.

Locks automatically expire after a set time (default is 24 hours) to prevent files from being stuck forever. You can see the countdown timer next to any locked file.

Protection Mechanism

• If you try to upload a new version of a file that is Locked (Red) by someone else, Attachment Locker will:

•  

  1. Block the change: The file will strictly revert to the previous version.

  2. Notify you: You will see a warning banner or notification explaining that the file is locked.

4. Smart Notifications

Attachment Locker keeps you informed about lock activity through multiple notification channels. You'll always know when someone tries to edit your locked files, when locks are created or removed, and when it's time to take action.

4.1 Overview of Notification Types

Attachment Locker uses four different notification methods to keep you informed:

Each notification type serves a specific purpose, ensuring you're always aware of what's happening with your locked attachments.

4.2 Toast Notifications (Instant Pop-ups)

What They Are

Toast notifications are small, temporary messages that appear in the top-right corner of your Confluence page. They provide instant feedback for your actions and alert you to important events.

When You'll See Them

Success Messages Green

Warning Messages Yellow

Error Messages Red

Info Messages Blue

User Experience

• Automatic: Appear instantly after actions or events

• Self-Dismissing: Disappear after 5-8 seconds

• Manual Dismiss: Click the × button to close immediately

• Non-Blocking: Don't interrupt your work - you can continue while they're visible

• Stacked: Multiple notifications stack vertically if several events happen at once

4.3 Page Banners (Persistent Notifications)

What They Are

Page banners are prominent notification bars that appear at the very top of a Confluence page, below the navigation bar. Unlike toast notifications, they stay visible until you dismiss them or the issue is resolved.

When You'll See Them

Lock Conflict Banner

When This Banner Appears:

• You attempt to upload a new version of a locked file

• Your changes were automatically reverted to protect the original

• Shows which attachment is locked and by whom

• Stays visible to remind you to check with the lock owner

Multiple Violations Banner

User Experience

• Persistent: Stays at the top of the page until dismissed

• Auto-Refresh: Updates every 30 seconds with new information

• Dismissible: Click "Dismiss" to remove the banner

• Page-Specific: Only shows on pages where violations occurred

• Contextual: Provides links to relevant attachments and details

4.4 Violation Alerts (In-App Review)

What They Are

Violation alerts are detailed records of unauthorized edit attempts stored in the Attachment Locker interface. Think of them as a security log showing who tried to edit your locked files and when.

How to Access Them

1. 1 Navigate to any Confluence page

2. 2 Click the Attachment Locker button (in the content byline near the page title)

3. 3 Look for the Alerts tab or badge indicator (e.g., 🔔 3)

4. 4 Click to view the full violation history

What Information They Show

🚨 Lock Violation Detected

Open

When You'll Receive Them

As a Lock Owner:

• Someone tries to upload a new version of your locked attachment

• The system detects the unauthorized change within seconds

• A violation alert is created immediately

• You'll also receive a toast notification and (optionally) an email

As an Editor:

• You attempt to edit a locked attachment

• The system reverts your change automatically

• You'll see a page banner and toast notification

• A violation alert is logged for the lock owner

User Experience

• Historical Record: Review all past violation attempts

• Searchable: Filter by attachment, user, or date

• Dismissible: Clear individual alerts or all at once

• Badge Counter: See number of unread alerts at a glance

• Direct Actions: Jump directly to the attachment or page from the alert

4.5 Email Notifications (Overview)

In addition to in-app notifications, Attachment Locker can send detailed email notifications to your inbox. Email notifications are ideal for:

• 📧 Staying informed when you're away from Confluence

• 📧 Getting detailed context about lock events

• 📧 Having a permanent record of lock activity

• 📧 Receiving periodic reminders about long-running locks

4.6 Notification Preferences

How Notifications Work Together

All four notification types work in harmony to provide comprehensive coverage:

Open

Notification Timing

4.7 Common Notification Scenarios

Scenario 1: You Lock an Attachment

What Happens:

1. ✅ Green toast "Attachment successfully locked"

2. 📧 Email Lock confirmation with expiry date (within 2 minutes)

3. 🔵 Status change LOCKED BY YOU (blue badge) in the interface

What You'll Know:

• ✓ Lock was successful

• ✓ When the lock will automatically expire

• ✓ How to unlock when you're done

Scenario 2: Someone Tries to Edit Your Locked File

What Happens:

1. ℹ️ Toast notification "Someone attempted to edit your locked attachment"

2. ⚠️ Page banner Appears on their screen: "This file is locked - changes reverted"

3. 🚨 Violation alert Logged in your Attachment Locker interface (with badge counter)

4. 📧 Email Detailed violation alert with who, when, and which file

What You'll Know:

• ✓ Who tried to edit

• ✓ Which attachment they targeted

• ✓ When the attempt occurred

• ✓ That their changes were automatically prevented

Recommended Action:

• Contact them to let them know when the lock will be released

• Or unlock the file if you're finished editing

Scenario 3: Your Lock Expires and Is Auto-Unlocked

What Happens:

1. 🔓 System action The hourly cleanup task removes your expired lock

2. 📧 Email "Your attachment has been automatically unlocked"

3. 🟢 Status change UNLOCKED (green badge) in the interface

What You'll Know:

• ✓ Your lock was automatically removed

• ✓ The attachment is now available for others to lock and edit

• ✓ When the unlock occurred

Recommended Action:

• If you still need to work on the file, lock it again

• If you're finished, no action needed

Scenario 4: Long-Running Lock (Auto-Unlock Disabled)

What Happens:

1. Day 1 You lock an attachment

2. Day 7 Email: "Reminder: Your attachment has been locked for 7 days"

3. Day 14 Email: "Reminder: Your attachment has been locked for 14 days"

4. Continues until you unlock the file

What You'll Know:

• ✓ How long the attachment has been locked

• ✓ That you should unlock it if you're finished

• ✓ That teammates may be waiting for access

Recommended Action:

• Review if you still need the lock

• Unlock if you're finished editing

• Contact your admin if you need to keep it locked

4.8 Notification Best Practices

4.9 Troubleshooting Notifications

"I'm not receiving notifications"

Toast Notifications:

• Check if your browser is blocking pop-ups from Confluence

• Refresh the page and try again

• Check browser console for JavaScript errors (press F12)

Page Banners:

• Ensure you're on the correct page (banner shows where violation occurred)

• Refresh the page - banners appear after page load

• Check if you previously dismissed the banner

Violation Alerts:

• Alerts only appear for YOUR locked files (when others try to edit them)

• Check the Alerts badge in the Attachment Locker interface

• Refresh to see newly created alerts

Email Notifications:

• Check your spam/junk folder

• Verify your Confluence account has a valid email address

• Contact your administrator - email notifications may be disabled

• See Section 5.7 for detailed email troubleshooting

"I'm receiving too many notifications"

Reduce Email Frequency:

• Ask your administrator to increase the periodic reminder interval

• Unlock files when you're finished to stop reminders

• Check if you have multiple locked files triggering separate reminders

Reduce In-App Notifications:

• Dismiss page banners to clear them from your view

• Clear violation alerts after reviewing them

• Toast notifications are brief and cannot be disabled (they provide essential feedback)

"Notifications show incorrect information"

• Refresh the page to get the latest data

• Check that your clock/timezone is set correctly

• Verify you're looking at the correct attachment

• Contact your administrator if the issue persists

4.10 Administrator Controls

Administrators can control which notification types are enabled for the entire site: