Install Pulse
Pulse is a Forge app distributed through the Atlassian Marketplace. Installing it takes a couple of minutes and needs a Confluence admin. There is nothing to configure afterwards: Pulse starts reading your site by itself.
Before you install
Section titled “Before you install”- Confluence Cloud. Forge apps do not run on Confluence Data Center or Server.
- An account with the Confluence admin right, which installing an app needs.
Install from the Marketplace
Section titled “Install from the Marketplace”- Sign in to your Confluence site as an admin.
- Open the Pulse listing: marketplace.atlassian.com → Pulse.
- Choose Get it now, or Try it free to start a trial, and pick the site.
- Review the permissions Atlassian shows (below) and confirm.
Atlassian installs the app in under a minute.
The permissions Pulse asks for
Section titled “The permissions Pulse asks for”Pulse asks for eleven permissions (scopes). Its screens ask Confluence for things as the person using them, so Confluence applies that person’s own rights, and every change is made as that person. The background work that keeps Pulse’s page index current reads as the app, and nothing it reads is shown to a person until Confluence has answered for those pages as that person.
| Permission | What Pulse does with it |
|---|---|
read:page:confluence |
Reads pages and blog posts, their versions and drafts: to score a page, to coach the author while the page is open in the editor, and for the page index. |
read:space:confluence |
Lists the spaces a person can open, to count each person’s numbers over the pages that person can open, and to check the space admin right. |
read:content-details:confluence |
Reads the signed in person’s permissions (the admin check), the names of a page’s owner and last editor (looked up by the person’s browser and never stored), and counts through Confluence search. |
read:analytics.content:confluence |
Reads how many people viewed a page, for the reader numbers. |
read:confluence-content.summary |
Receives Confluence’s page and blog post events, which keep the page index current. |
storage:app |
The app’s Forge hosted storage. This version keeps all its data in Forge SQL and makes no call to the key value store. |
write:page:confluence |
Apply a fix and its undo: saves a new version of a page, as the signed in person, after that person confirms the change. |
write:label:confluence |
Adds or removes the label needs-review, as the signed in person, after one click. |
read:label:confluence |
Confluence asks for it together with write:label:confluence to add a label. |
write:comment:confluence |
Posts a footer comment that mentions the page owner, with the person’s own words, as that person, after they confirm it. |
read:content.metadata:confluence |
Not used by this version. It is requested in advance for a planned feature, archiving a page from Clean up, so that admins approve one set of permissions. Pulse sends no request that uses it. |
Approving the changes Pulse can make
Section titled “Approving the changes Pulse can make”Pulse can change a page in three ways only, each made as the signed in person after that person confirms it: Apply a fix, the label needs-review and a comment that mentions the page owner. They need the four write permissions above.
- A new install approves every permission when you install, so the three changes work from the start.
- An existing install that updates to this version gets the new version straight away and keeps working. Only the three changes wait: they stay locked until a site admin approves Pulse’s new permissions in Atlassian Administration, under Connected apps. Until then Pulse sends Confluence no change at all, and its screens show those buttons locked with the reason.
Pulse settings shows the state of the approval under Index status:
After the install
Section titled “After the install”Pulse reads your spaces by itself, with no scan to start. How long the first read takes depends on the size of the site, and it goes on in the background while people work. Admins can follow it on Get started, which also shows what authors will see. See Getting started.
From then on, Pulse scores a page again on every edit, and checks every page once a week.
Checking that it works
Section titled “Checking that it works”- Apps → Pulse opens For you.
- Under the title of a page, the byline shows Page Health with a score.
- Each space’s sidebar has Pulse space report under its apps.
- Confluence Home has a section Pulse · your pages to fix.
- When you edit a page, a line appears above it.
Updates
Section titled “Updates”Pulse updates itself through Forge. Most updates need nothing from you. An update that asks for a new permission is a new major version: your site gets it, and the parts that need the new permission wait until an admin approves it.
Uninstalling
Section titled “Uninstalling”Uninstall Pulse from your site’s app management. Pulse keeps no data outside your site’s own Forge storage; Atlassian deletes that data after an uninstall. See the privacy policy.