PageAck: user guide
The full name of the app is "PageAck: Page Acknowledgements for Confluence". Inside Confluence it appears as Page Acknowledgements.
What the app does
PageAck lets you ask named people or Confluence groups to confirm they have read and understood a Confluence page, such as a policy or a procedure.
- You choose a page and an audience. This is called a requirement.
- Each person sees a banner on the page and confirms with Read and Understood.
- The app records who confirmed, which page version they confirmed, and when.
- You see who is Completed, Outstanding or Overdue, and you can export the records as CSV.
Everything runs inside Atlassian. The app sends nothing to any service outside Atlassian. It does not send email or reminders.
Words used in this guide
| Word | Meaning |
|---|---|
| Require acknowledgement | What a page owner does to a page. Also the name of the main button. |
| Requirement | What that creates: one page, an audience and rules. A page has one active requirement at a time. |
| Audience | The groups and people who are asked. |
| Acknowledge | What a reader does, with the Read and Understood button. |
| Completed | The person has an acknowledgement that currently counts. |
| Outstanding | The person still has to acknowledge and is not past the due date. |
| Overdue | The person still has to acknowledge and is past the due date. |
A person has exactly one of the three statuses. An overdue person is counted under Overdue only.
Where to find the app
| Place | How to open it | Who sees it |
|---|---|---|
| App page | Confluence Apps menu, then Page Acknowledgements | Every signed-in user |
| Page menu | On a page, open the page menu (•••) and choose Acknowledgement requirement | People who can edit that page |
| Banner | Top of a page that has an active requirement | The audience, and people who can manage the requirement |
| Site settings | The Settings tab on the app page, or Page Acknowledgements in Confluence administration | Confluence administrators |
The app page has these tabs: Overview, Pages, Assigned to me, and Settings for Confluence administrators.
Install and first steps (administrators)
- A Confluence administrator installs the app from the Atlassian Marketplace and approves the permissions listed at the end of this guide.
- Open Apps, then Page Acknowledgements, and go to the Settings tab.
- Check Who can require acknowledgement and Defaults for new requirements. Choose Save settings if you change anything. See "Site settings".
- Choose Require acknowledgement to set up your first page.
The Page Acknowledgements page in Confluence administration shows the same settings, with a short Get started guide above them.
No other setup is needed. You do not have to grant the app space permissions.
Who can require acknowledgement
By default, anyone who can edit a page can require acknowledgement on it. Confluence administrators can do so on any page they can view.
A Confluence administrator can change this on the Settings tab, under Who can require acknowledgement:
- Anyone who can edit the page
- Confluence administrators only
The same people can see who has acknowledged, change the requirement and export the records. Confluence administrators always can. If you switch to Confluence administrators only, page editors can no longer open existing requirements.
The app asks Confluence about permissions each time, as the person using it.
Require acknowledgement on a page
You can start in two places.
- From the app page: choose Require acknowledgement. The flow has three steps.
- From the page itself: open the page menu (•••) and choose Acknowledgement requirement. The page is already chosen, so the flow has two steps.
The flow is titled Require acknowledgement and shows where you are, for example "Step 1 of 3". Move with Next and Back. Cancel leaves without saving.
Step 1: Which page?
Skip this step if you started from the page menu.
- In the Page field, type a page title (two or more characters) and pick the page from the list. You can also paste the page link. Only pages you can view are listed.
- Check the card under the field. It shows the page title, the space, the version and when it was last updated. Open page opens the page in a new tab.
- Choose Next.
Next stays greyed out if a notice appears under the card:
- You cannot require acknowledgement on this page. You need edit permission on the page, or your site allows only Confluence administrators.
- This page already requires acknowledgement. A page has one requirement at a time. Choose Open it to work with the existing one.
- Subscription inactive. See "When the subscription is inactive".
Step 2: Who needs to acknowledge?
- Under Groups, search for Confluence groups and select them. Each member is asked individually. People who join a group later are added within a day.
- Under People, search for individual people and select them.
- Choose Next.
You need at least one group or person. You can add up to 200 groups and people in total. For a larger audience, use a group. To ask everyone, add the group that contains all your Confluence users.
If something is missing, a message appears under the field, for example "Add at least one group or person."
Step 3: When should they be asked?
- Ask again: tick or untick When the page is updated. See "How versions work".
- And on a schedule: choose No schedule, Every 6 months, Every 12 months or Custom. For Custom, enter the number of days after Every. See "Schedules".
- Due date: choose No due date, Within 7 days, Within 14 days or Within 30 days. See "Due dates and Overdue".
- Optional: tick Add a message for readers and type it under Message, up to 500 characters. It is shown in the banner as plain text.
- Read the summary line under the fields. It states who will be asked, which version they will acknowledge and the rules you chose.
- Choose Require acknowledgement.
A short confirmation, "Requirement created", appears and the requirement opens. From that moment the audience sees the banner on the page. No email or notification is sent, so tell people through your usual channel.
If something needs a second look, a yellow box titled One thing needs your attention explains what, and offers the action that fixes it.
Acknowledge a page (readers)
The banner
A person in the audience who opens the page sees a banner at the top: Please read and acknowledge this page. It shows the page owner's message if there is one, and the due date if there is one.
- Read the page.
- Choose Read and Understood.
- In the dialog Confirm you have read and understood, tick I have read and understood this page.
- Choose Confirm.
The dialog states what is recorded: your account, the page version and the time. An acknowledgement cannot be undone or withdrawn.
Afterwards the banner turns green and reads You have acknowledged this page, with the version and time. If a schedule applies, it also says when you will be asked again.
If you are asked again later, the banner says why. For example: "The page changed since the last acknowledgement", followed by the version you last acknowledged.
If you are past the due date, the banner turns yellow and shows "Overdue since" with the date.
If the page changed while you were reading
If someone published a new version between you opening the page and choosing Confirm, nothing is recorded. The dialog shows This page was updated. Choose Reload page, read the current version, and acknowledge again. A record is never attached to text you were not shown.
If the page was edited after you acknowledged
Some pages do not ask again after every edit. On those pages your green banner says the page has been edited since, names the current version, and says your confirmation covers the version you acknowledged only. Choose Acknowledge version N if you want to confirm the current version as well.
Assigned to me
On the app page, the Assigned to me tab lists the pages you are asked to acknowledge, with Page, Status, Due and Last acknowledged. Overdue pages come first, then outstanding, then completed.
- Choose the page title to open the page.
- Acknowledge it there, in the banner. You cannot acknowledge from the list.
If a row reads "A page you cannot open. Ask whoever assigned it for access.", ask the person who set it up for access to the page.
What other people see
- People who can manage the requirement, and are outside the audience, see one line on the page with a count such as "12 of 40" and a pointer to the page menu.
- For everyone else the app shows nothing and does not reveal that a requirement exists.
See who has acknowledged
The app page
Overview shows:
- A notice if you have pages to acknowledge yourself, with View assigned to me.
- One summary strip: Active pages, Acknowledgements required, Completed, Still to acknowledge, and a progress bar. Acknowledgements required counts each person once per page, so a person asked on two pages counts twice.
- Needs attention: up to five pages with the most people still to acknowledge. View all pages opens the Pages tab.
- Recent activity. Choose View all for the full list.
Administrators see totals for every active page on the site. Everyone else sees totals for the pages they set up and can still manage.
Pages lists one row per requirement with Page, Completed, Ask again and Created. Use the filter to switch between Active and Closed. Administrators see every page that requires acknowledgement. Others see the pages they set up. To manage a page someone else set up, open that page and use the page menu (•••).
To open a requirement, choose the page title in the Page column.
The requirement
The requirement view shows:
- The page title with an Active or Closed label, and the buttons Ask everyone again and Export report.
- A line with Open page, Audience, Ask again and Due.
- A summary strip with Completed, Outstanding, Overdue and a progress bar. The three numbers add up to the audience.
- A line that states which versions count, for example "Counting acknowledgements of version 12, the current version."
- Three tabs: People, History and Settings.
If you opened the requirement from the app page, All pages takes you back to the list.
People lists everyone in the audience with Name, Status, Last acknowledged and Due. People who still need to act come first: overdue, then outstanding, then completed. Use the filter above the table to show All statuses, Completed, Outstanding or Overdue. Each option shows its count. For a person who is outstanding or overdue, Last acknowledged shows their most recent earlier acknowledgement, if any.
History lists everything that has happened to the requirement: created, audience changes, new page versions, acknowledgements, exports and more. Entries cannot be edited or removed.
Settings holds the audience, the rules and other actions. See "Change the audience or rules".
View one person's record
- Open the requirement and stay on the People tab.
- Choose View record at the end of the person's row.
The Acknowledgement record dialog shows the person's status, the reason if they still have to acknowledge, when they joined the audience, and a table of every acknowledgement they gave: Acknowledged, Version and Version published. Choose Done to close it.
Reasons you may see:
- Not yet acknowledged
- The page changed since the last acknowledgement
- Scheduled re-acknowledgement is due
- A new acknowledgement was requested
How versions work
Every acknowledgement records the exact page version, read from Confluence at that moment. The When the page is updated checkbox decides what happens after an edit.
Ticked (the default)
Every published edit asks for a new acknowledgement, so a record always matches the current text. Any published version counts, including small edits.
Example: Ana acknowledges version 3 of the travel policy. An editor publishes version 4. Ana is Outstanding again and the banner asks her to read the current version. She acknowledges version 4. The history keeps both records.
Not ticked
Edits do not reset anything. People who already acknowledged stay Completed. Each record still shows which version that person acknowledged, and you can ask everyone again at any time.
Example: Ana acknowledges version 3. An editor fixes a typo and publishes version 4. Ana stays Completed and her record still says version 3. Her banner tells her the page is now version 4 and offers Acknowledge version 4. Later the policy changes in substance at version 5. The page owner chooses Ask everyone again, and everyone must acknowledge version 5.
In this case the requirement states which versions count, for example: "Counting acknowledgements of version 3 or later. The page is now at version 5. Each record shows the version that person acknowledged."
Good to know
- An acknowledgement counts only if it was given on the required version or a later one, after the last Ask everyone again, and has not lapsed under a schedule.
- Only a person's newest acknowledgement decides their status.
- If you later tick When the page is updated on an existing requirement, the latest version becomes required at once. People who acknowledged an older version become Outstanding.
- The Ask again line shows the rule in force: "When the page is updated", a schedule, both, or "Only when you ask".
- If the version number of a page goes down, the app starts a new cycle. Everyone is asked to acknowledge the current version again. Earlier records are kept. The app believes a lower number only after the requirement has gone 10 minutes without a change, so a brief mismatch right after an edit resets nobody.
Schedules
A schedule makes each acknowledgement lapse after a set time, so people confirm again regularly.
| Option | Meaning |
|---|---|
| No schedule | Acknowledgements do not lapse by time |
| Every 6 months | An acknowledgement lapses 180 days after it was given |
| Every 12 months | An acknowledgement lapses 365 days after it was given |
| Custom | Every N days, from 1 to 1095 |
The clock runs for each person from their own last acknowledgement. It is not tied to a calendar date. When an acknowledgement lapses, the person becomes Outstanding again and the banner returns.
A schedule and When the page is updated can be used together.
Due dates and Overdue
A due date gives people a number of days to acknowledge. People who have not acknowledged by then show as Overdue.
The period starts at the latest of these moments:
- the person was added to the audience,
- a new page version became required, or someone chose Ask everyone again,
- the person's previous acknowledgement lapsed under a schedule.
So a person added later gets the full period.
Overdue is a status only. Nothing is blocked and nothing is sent. With No due date, nobody is ever overdue.
Ask everyone again
Use this when everyone must confirm the current version again, for example after an important change on a page where When the page is updated is not ticked.
- Open the requirement.
- Choose Ask everyone again at the top right.
- Read the dialog Ask everyone to acknowledge again?. It states how many people will be asked and which version.
- Choose Ask everyone again.
Everyone in the audience becomes Outstanding, including people who already acknowledged. Due dates count from now. Earlier acknowledgements stay in the history. You must be able to view the page yourself to do this.
Change the audience or rules
- Open the requirement and go to the Settings tab.
- Under Audience, change Groups and People.
- Under Rules, change Ask again, And on a schedule, Due date or the message for readers.
- Choose Save changes.
- People you remove are no longer asked. Their past acknowledgements are kept and stay in the full history export.
- People you add for the first time get the full due period.
Refresh group members
Group members are copied into the requirement as individual people. The app refreshes this list:
- when you set up the requirement,
- when you choose Save changes,
- once a day, automatically,
- when you refresh by hand.
To refresh by hand:
- Open the requirement and go to the Settings tab.
- Under Other actions, find Refresh group members and choose Refresh now.
Use this when someone has just joined a group and should see the banner straight away. Refresh group members appears only when the audience includes a group. If a group cannot be read, nobody is removed. App accounts in a group are skipped.
Export
Exports are CSV files, UTF-8, with times in UTC (ISO 8601). Names and email addresses are looked up in Confluence at the moment of export. Email is empty when a person's privacy settings hide it.
Status report
One row per person currently in the audience.
- Open the requirement.
- Choose Export report at the top right. The file downloads straight away.
- A dialog titled Export downloaded names the file and the number of rows. Choose Done.
File name: page-acknowledgements-status-<page ID>-<date>.csv
| Column | Content |
|---|---|
| User | Display name |
| Email address, if visible | |
| Status | Completed, Outstanding or Overdue |
| Acknowledged At (UTC) | Time of the person's newest acknowledgement |
| Page Version | Version of that acknowledgement, for example v12 |
| Due (UTC) | Due time, when the person still has to acknowledge and a due date is set |
| Valid Until (UTC) | When the acknowledgement lapses, when a schedule is set |
| Account ID | Atlassian account ID |
| Page | Page title |
| Page ID | Confluence page ID |
| Required Version | The version that currently counts |
| Latest Version Seen | The newest page version the app has seen |
| Re-acknowledge | The rule in force |
| Exported At (UTC) | Time of the export |
Full history
One row per acknowledgement ever recorded for the requirement, including those from people since removed from the audience.
- Open the requirement and go to the History tab.
- Choose Export all acknowledgements.
- A large history comes in parts of 5,000 rows. The dialog says how many files there are and which part you have. Choose Download part 2 of N, and so on, until you have every part.
- Choose Done.
File name: page-acknowledgements-history-<page ID>-<date>.csv. When there are several parts, the name ends in -part-1-of-N, -part-2-of-N and so on.
| Column | Content |
|---|---|
| User | Display name |
| Email address, if visible | |
| Acknowledged At (UTC) | Time of the acknowledgement |
| Page Version | Version acknowledged |
| Version Published At (UTC) | When that page version was published |
| Statement | The words the person agreed to |
| Page Title At The Time | Page title when they acknowledged |
| Account ID | Atlassian account ID |
| Page ID | Confluence page ID |
| Record ID | Unique ID of the record |
| Exported At (UTC) | Time of the export |
If no file was downloaded
- If the browser blocked the download, the dialog is titled Export ready and shows the CSV text. Copy the text into a plain text file and save it with the file name shown in the dialog.
- If the dialog is titled Export downloaded but you cannot find the file, choose Show the CSV text next to "Nothing downloaded?" and copy the text the same way.
Text cells that start with =, +, - or @ are prefixed with a single quote so a spreadsheet does not run them as formulas. Every export is itself listed in History.
Close a requirement
- Open the requirement and go to the Settings tab.
- Under Other actions, find Close this requirement and choose Close requirement.
- In the dialog Close this requirement?, choose Close requirement.
People stop being asked and the banner disappears from the page. All records are kept and can still be exported. Find closed requirements on the Pages tab with the filter set to Closed.
A closed requirement cannot be reopened. You can require acknowledgement on the page again later. The new requirement starts empty: acknowledgements do not carry over.
Site settings
Confluence administrators manage site-wide settings on the Settings tab of the app page, or under Page Acknowledgements in Confluence administration.
| Setting | Options | Default |
|---|---|---|
| Who can require acknowledgement | Anyone who can edit the page, or Confluence administrators only | Anyone who can edit the page |
| Ask again: When the page is updated | Ticked or not ticked | Ticked |
| And on a schedule | No schedule, Every 6 months (180 days), Every 12 months (365 days) | No schedule |
| Due date | No due date, Within 7 days, Within 14 days, Within 30 days | Within 14 days |
The last three are Defaults for new requirements. Each requirement can change them. To apply a change:
- Change the setting.
- Choose Save settings.
Changing a default does not change existing requirements. The Data and privacy text at the bottom of the tab summarises what the app stores.
Limits
| Item | Limit |
|---|---|
| Requirements per page | One active requirement at a time |
| People per requirement | 5,000. Above that the list is cut off, keeping people who were added individually first. |
| Groups and individually added people per requirement | 200 entries in total. Use a group for larger audiences. |
| Message for readers | 500 characters |
| Custom schedule | 1 to 1095 days |
| Full history export | Parts of 5,000 rows each |
| Assigned to me | 100 pages |
| Requests per person per minute | 60 searches, 120 list loads, 20 exports, 60 saves. Above that you see Too many requests. Wait a minute and try again. |
Not built: email or in-app reminders, requiring acknowledgement for a whole space in one step, setting up many pages at once, reopening a closed requirement, quizzes, video, signatures, PDF export, scheduled exports, an API. The app is for Confluence Cloud only. Data Center is not supported. Blog posts, whiteboards and databases are not supported.
The app runs on Atlassian's Forge platform, which applies its own quotas and rate limits. In rare cases these can slow down or pause the app for a short time.
When the subscription is inactive
When the trial has ended or the subscription was cancelled or lapsed, the app shows Subscription inactive.
| Paused | Still works |
|---|---|
| Require acknowledgement | Viewing requirements, people and history |
| Save changes, Refresh now, Ask everyone again | Export report and Export all acknowledgements |
| Acknowledging. Readers who still have to acknowledge see Acknowledgement is paused. | Close requirement |
A Confluence administrator can renew the app under Apps, Manage apps. Billing is handled by Atlassian.
Uninstalling
Export everything you need to keep first: for each requirement, the status report and the full history. Include closed requirements.
After an uninstall, Atlassian deletes the app's stored data once its retention period ends. Installing the app again creates a new, empty installation. We cannot restore data, because we have no access to it.
Data and privacy summary
- Where: records are stored in Atlassian's own app storage for your site. Each site has its own database. According to Atlassian's documentation, this storage follows your Confluence data residency region.
- What is stored: Atlassian account IDs, page IDs, page titles, page version numbers, timestamps, requirement settings, the IDs and names of the groups you chose, your optional message for readers, and the history of events.
- What is not stored: names, email addresses and page content. Names in the app are shown by Confluence. Names and emails in exports are fetched at the moment of export.
- Who can see it: people who can manage a requirement see its records. Confluence administrators can open every requirement, including its stored page title, even when the page itself is restricted from them. Readers see only their own status.
- The vendor: we cannot see your records. The app sends nothing to us or to any third party. It reports the account IDs it holds to Atlassian, which issued them, so that closed accounts stop being asked. We see only anonymous usage counters and technical error logs provided by Atlassian.
- Records are permanent: nobody can edit or delete an acknowledgement or a history entry in the app, including administrators.
See the privacy policy for full details.
Permissions the app asks for and why
| Permission | Why the app needs it |
|---|---|
read:page:confluence | Read a page's title and current version number, and check whether you may edit the page |
write:page:confluence | Set one hidden property on a page that switches the banner on or off. The app never changes page content. |
read:confluence-content.summary | Be told when a page is updated, so the app knows a new version exists |
read:confluence-groups | Search groups and read their members to build the audience |
read:confluence-user | Check whether you are a Confluence administrator |
read:user:confluence | Look up names and email addresses for an export. They are not stored. |
search:confluence | Search pages by title when you require acknowledgement. Only pages you can view are returned. |
report:personal-data | Tell Atlassian which account IDs the app holds, so Atlassian can tell the app when an account has been closed. Atlassian requires this of apps that store account IDs. |
The app declares no access to any external service.
Getting help
Start with the FAQ. If you still need help, write to support@pageack.com and include the title and text of any error message. Please do not send exports or screenshots that contain personal data.