Document Control Documentation

Revision: 2024-10-10

A controlled document can be a page in a space. When you create a new controlled document in a restricted space or document, make sure the user "Electronic Signing for Confluence Cloud" has permissions on the new page. If you are creating a new page from scratch, the best practice is to choose the "Controlled document" template from the Create dialog:

This template sets up the page with everything needed for use with the Document Control add-on.

If you want to use a different template, or if you want to take an existing page and convert it to a controlled document, it's a simple two-step process:

1. Add the "Document Control" macro somewhere in the body of the page (typically at the bottom):

2. Add the "controlled-document" label to the page:

There are two ways to add reviewers to a page:

1. Click the Document Control byline on the page (the link under the page title)
2. From the page menu (the three-dot icon with links to Move, Copy, Delete, etc.), click "Manage Reviewers".

Once the "Manage Reviewers" dialog is open, you can add a reviewer to a page by searching by name.

When the "reviewer meaning / role" configuration setting is enabled, you can add a signature meaning / role in the reviewers dialog:

You can also use this dialog to remove a reviewer by clicking the small "x" next to each reviewer's name.

If you have the Email notification setting enabled, the new reviewer will receive an email inviting them to review the page:

The page's document control status will change to Needs Review until all reviewers have added a signature to the page. External collaborators or guest users can be assigned as a reviewer by a regular user. However external collaborators can't change the reviewers.

From the page menu, click "Add Signature" or click the "Add Signature" button (if enabled by your Confluence administrator):

Fill out the form and click Submit to sign the page.

External collaborators or guest users can sign a document if they have been selected as a reviewer by a regular Confluence user. Due to Confluence restrictions, guest users can only view and sign documents in a single space.

If the Authentication setting is enabled, the user is required to authenticate with Document Control with one of the following methods:

• Enter a personal token, which must set by the user and validated through email.
• Enter a 2FA code generated with an authanticator app.
• Authentication through SSO/OpenID.
• Enter their email and a secure API key as token, and both must match the presently logged in Confluence user.

Personal token: When using a personal token, a user needs to set a secret token and validate the token through a validation code received by email. The validation code is only valid for a short time. The token can be revoked on demand. If the secure token does not match, it will be revoked after several failures.

The email for the validation code must be the email address used for Confluence login. You can find your login email at your Atlassian profile page. The personal token can be reset by going to the Document Control General page and clicking on the setup button.

2FA: For 2FA authentication, a user needs to install and pair an authenticator app. Compatible apps are:

• FreeOTP+ Authenticator
• Google Authenticator
• Microsoft Authenticator
• Alternative authenticator apps compatible with "TOTP"

The 2FA codes are unique to each user, and can be revoked on demand using a user-specific API token. When signing, the signature dialog ask you to enter a 6 digit code called 2FA token. This token is generated by your authenticator app. The token is refreshed regularly. If the token does not match, an error message is shown to indicate a problem:

Authentication through SSO/OpenID: SSO/OpenID is configured by your Confluence administrator. The user interface depends on the authentication provider.

API key: When using API key authentication, a user needs to generate a secure token once by using the Atlassian provided secure token management page at the Atlassian API token page. The token is unique to each user, and can be revoked on demand. If the email and the secure token do not match, an error message is shown under the email and token fields to indicate a problem:

The email for the signature must be the email address used for Confluence login. You can find your login email at your Atlassian profile page.

All pages set up for document control will have one of three statuses:

1. Not reviewed - No reviewers have been added to this page.
2. Needs review - One or more reviewers have been added to this page, but not all reviewers have signed the most recent version of the page.
3. Reviewed - All reviewers have signed the most recent version of the page.

The document control status is reflected in the byline (the link under the page title) of each page. It's also reflected in the Document Control macro. For example, in the following screenshot, Jason Wright and Lucille Bluth have been assigned as reviewers, but only Lucille Bluth has signed:

Once Jason Wright signs the page, the page looks like this:

If the page is edited, all reviewers will need to sign the page again to maintain the "Reviewed" status; see Page versioning for more details.

To see the document control status of all pages in a space at a glance, you can use the "Space View" setting of the Document Control macro. Typically, you might want to add the macro to the top-level page in a space. To do this, start editing a page. Then choose from the menu "+" and "View more" to insert the Document Control macro. The macro will show an overview of all pages where Document Control is used, even if a user does not have direct access to the pages. Choose the "Space View" setting:

You can use the shortcut "/dccc" to insert the Document Control macro. Below you can see an example of the macro with "Space View" setting.

Space view by default shows all pages with the label "controlled-document". If you have the Document Control macro on pages without this label, you can list them also by using the option "Show all documents containing the Document Control macro in space view".

An alternative version of the space view is available as a dynamic macro. Type "/document" into the editor, and a completion for "Document Control -- Space View" will appear. Choose this macro, and a table of the pages with the Document Control macro will be rendered. The display is slightly different than the older Space View, however it serves the same purpose. This dynamic macro will only show pages visible to the user viewing the macro.

If the Confluence API is too slow for Document Control to render the default space view, as a fallback the dynamic space view macro will be used.

You can list all documents where you are a reviewer by going to the General Page and clicking on the button "Load Documents". The resulting table can be sorted by clicking on the column headers.

You can access the Document Control general page directly from the top menu. This page provides links to the documentation and signature authentication setup if enabled.

Document Control can add a label to a document if the review status changes. On the configuration page, you need to check the option "Use a label as a flag when document state changes."

When Document Control detects a change in the document review status, it will add a label to the document. The label acts like a flag. The default label is "dc-review-change". Adding a label generates a webhook event if you have set up a webhook listener. For example, ScriptRunner by Adaptavist lets you listen to such events and run automatic actions in response to such an event.

Once you have received the webhook event, you should remove the label from the document with your automation tool. If the label is not removed, subsequent changes to the document review state will not add a new label.

After receiving a webhook event, you can check the document review status and run an automation with e.g. ScriptRunner. The document review status can be queried by checking the content property "dccc-byline" of the document.

Document Control can send a webhook to a HTTPS URL. This webhook will send a POST request. For this request you can choose a payload, containing information about the document and its state. A webhook can be used to integrate with Confluence Automation. Usually the webhook is uses as a trigger/condition for Confluence Automation.
Warning Please make sure to only send a webhook and/or payload to a secure and trusted URL. It is your responsibility to make sure the URL is safe and the recipient is authorized to receive the information.

Confluence Automation allows you to receive a payload and/or to check Confluence page properties for the document state. When you receive a payload, the content of the payload is usually available as {{webhook.body}} (see Triggers in Confluence automation - Integrations).
The value of the content property "dccc-byline" contains the property "documentStatus" with these possible values:

1. "not-reviewed" A document is in this state if no reviewers are added to the document.
2. "needs-review" If a document has reviewers, and not all reviewers have signed, a document is in this state.
3. "reviewed" Once all reviewers have signed, a document is in the "reviewed" state.

{
...
    "documentStatus": {
      "value": "not-reviewed"
    },
...
}
        

In addition to listening to webhook events, you can check for the presence of the label "dc-review-change" on a regular schedule with e.g. a cron expression.

After adding a reviewer or a signature to a document, Document Control updates the content property "dccc-state". This content property encodes the current document state. You can read this property or receive it as the payload on a webhook and get information on reviewers, signatures, and document state. You should not modify this content property, as Document Control will rewrite the content property regularly.

Querying the content property "dccc-state" returns a JSON object. The example JSON object below contains comments (after //) explaining the field just before the comment. If you write code using the Document Control State, please check the field "stateFormatVersion". If this version is incremented, the format has changed.

{
...
"value": {
    "example": false,
    "stateFormatVersion": 2,
    "status": {
      "name": {
        "value": "Reviewed"
      },
      "documentStatus": {
        "value": "reviewed"
      }
    },
    "documentVersion": 7,  // The Confluence assigned document version.
    "documentDt": "2021-06-28T14:26:03.593Z", // The timestamp of the last document edit.
    "documentId": "123456789",  // The Confluence Id of the document.
    "lastMeaning": "Review",  // The meaning of the last signature (if a meaning was given).
    "lastSigDt": "2021-06-28T14:26:22.700Z", // The timestamp of the last signature.
    "reviewersDt": "2021-06-28T14:26:22.700Z", // The timestamp of the last reviewers change.
    "reviewersVersion": 5,  // The version of the reviewers.
    "signaturesVersion": 2, // The version of the signatures.
    "signaturesDt": "2021-06-28T14:26:22.700Z", // The timestamp of the last signatures change.
    "signatures": [  // A list of signatures applied to the document in reverse chronological order.
      {
        "most_recent": true,  // A property which is "true" if the signature was applied to the most recent document version.
        "version_known": true,
        "documentVersion": 7, // The document version the signature was applied to.
        "accountId": "XXXXXXXXXXXXXX", // The identifier of the user who signed.
        "timestamp": "2021-06-28T14:26:22.700Z", // The timestamp of the signature.
        "comment": "signature comment", // Signature comment, if present.
        "signature_version": 2,
        "meaning": "Review",  // The meaning of the signature (if a meaning was given).
        "name": "Jane Example", // The name of the signer.
        "documentId": "123456789", // The Confluence Id of the document to which the signature was applied.
        "documentDt": "2021-06-28T14:26:03.593Z" // The timestamp of the last document edit.
      },
      {  // Another signature, it was applied to a previous document version.
        "most_recent": false,
        "version_known": true,
        "documentVersion": 6,
        "accountId": "XXXXXXXXXXXXXX",
        "timestamp": "2021-06-28T13:23:43.983Z",
        "comment": "old signature",
        "signature_version": 2,
        "meaning": "Other",
        "name": "John Example"
      }
    ],
    "reviewers": [  // List of reviewers for the current document.
      {
        "accountId": "XXXXXXXXXXXXXX", // The identifier of the reviewer.
        "name": "Jane Example", // The name of the reviewer.
        "signed": true,  // "true" if the reviewer signed the last document version, "false" if not.
        "meaning": "",
        "reviewerFormatVersion": 4
      }
    ]
  }
...
          

The "status" field describes the current document status as described above about the "dccc-byline" field.

The "signatures" list contains the most recent signatures with a limit of up to 50 signatures. The "reviewers" list contains the current document reviewers. If no signatures or reviewers are present, these lists will be empty.

The Document Control State content property is available from 2021-07-01. Documents produced before this date will not have a "dccc-state" content property. If a signature and/or reviewer is added to an older document, the "dccc-state" will be added with the information available. Documents produced before 2021-07-01 might not contain all information documented above. The content property might contain additional fields not documented here.

If you have view/edit restrictions enforced either on a space or a page and wish to use the Document Control add-on, you'll need to ensure that the add-on user has both view and edit privileges (the add-on user is "Electronic Signing for Confluence Cloud"). You can change page restrictions by clicking on the lock symbol in top right of the Confluence page. This lock symbol will not be accessible if you don't have permission to change page restrictions.

Add the "Electronic Signing for Confluence Cloud" user:

The Document Control add-on uses Confluence's built-in versioning system to ensure that signatures are linked to a specific version of a page. For example, if a page has been signed by all reviewers, but is then edited, the Document Control macro will show that those signatures were for previous versions of the page:

You can click the link in the macro to see the full version history of the page:

Note: Restoring a page to a previous version does not resolve the need to re-sign the page. This is because Confluence actually creates a new version that duplicates the restored version.

As an option you can restrict signature visibility to show only signatures for the current document version. In order to apply this setting you need to edit the document (and thus create a new document version in this process). To change the setting you need to edit the Document Control macro and check the checkbox "Show signatures applied to the most recent document version only."

After checking the checkbox, only the most recent signatures are visible:

If you later to decide to unchecked the checkbox, the earlier signatures will be visible again. Please note that this change also creates a new document version.

The Document Control add-on stores information in each page's content properties. This is essentially a form of metadata stored in the page without being directly visible in the page's body.

The way Confluence handles content properties:

• When a page is moved, content properties are preserved.
• When a page is copied, content properties are not preserved.

As a result, copies of controlled documents will not preserve signatures or reviewers. You should make sure to keep the original page intact and move it around your Confluence instance instead of making copies.
If you move a space containing signatures to another Confluence instance, it is necessary to disable the setting another Confluence instance automatically results in changes to the pages and content properties. You should add a new signature to each page, e.g. with a custom meaning of "document/space import approved", and then enable the setting again.

If you get an error saying that there are outdated signatures, this is most likely caused by an older document template. Document templates created before 2022-07-19 might cause this error. A possible solution is to update the document template by creating a new document template and deleting the old one.

If you use SAML single sign-on to authenticate with Confluence, it's highly likely that the API Token Authentication setting will not work. Your users need to have an Atlassian account and password for the add-on's API authentication process to work. The other authentication methods will work.
The addon also offers SSO for signature authentication. This is described in the Set up section.

You can install Document Control for Confluence Cloud from the Atlassian Marketplace. Click the "Try it free" button to get started.

Once the add-on is installed, expand the Document Control for Confluence Cloud add-on in the Universal Plugin Manager and click "Configure".

The "Get started" page helps you with considering the configuration options.

The configuration page provides these settings:

Authentication requires users to authenticate using their Confluence login before signing a page. (If your intent is to comply with 21 CFR 11, you should enable this setting.) If your approval flow is lightweight, you can disable this setting and allow users to review/approve a document with a click.

Document Control supports authentication with a secret key provided by Atlassian (API Key), authentication through a personal token or code, through a 2FA (two-factor authentication) process using an authenticator app, and using SSO with OpenID.

21 CFR 11 requires the signer to authenticate for each signature. Bulk signatures, i.e. a single electronic signature for multiple documents, are not conformant. Document Control offers both two-factor authentication and authentication using a secret key. Please contact us if you need additional authentication methods.

The "require signatures to match pages" ensures that signatures match the page where they were applied to. Troubleshooting / Page copying describes the usage of this setting when moving data to a new Confluence instance.

Authentication Settings documentation

The Signature Button setting enables a button with click to sign functionality in the Document Control macro.
The Meanings settings allow the configuration of meanings associated with each signature added to a controlled document. You can customize the available Meaning options (the default options are based on the language of 21 CFR §11.50), or disable Meanings entirely. Optionally you can define up to ten custom signature meaning types.
Once you have configured the meanings, these meanings show up during the signing flow and allow a signer to indicate the signature meaning.
The configuration option "Add a meaning/role to reviewers" allows adding a meaning when a reviewer is added to a document. If the option is enabled, you can pre-define a meaning for a reviewer. The reviewer has the option to change this at signature time. When the setting is "Locked to reviewer", only a signature with the pre-defined meaning is possible.

Notification: The Email notification setting will trigger automatic emails to reviewers whenever they are added to a page.

Restrictions: The restrictions settings allows to restrict editing, signing, and changing reviewers on a page. Restrictions will only be applied to a page after reviewers are updated.

Document Control can only adjust the restrictions if the user "Electronic Signing for Confluence Cloud" has the permissions to add/delete restrictions in the space. If the user "Electronic Signing for Confluence Cloud" does not have these permissions, the setting has no effect.

1. Restrict page edits to reviewers, and give reviewers edit rights. This allows only reviewers to edit a page. When this setting is selected, a new reviewer automatically gets edit rights on the document. The final edit permission also depends on the group permissions of the reviewer.
2. Restrict signatures to reviewers allows only reviewers to sign a page.
3. Restrict changing reviewers to document editors allows only users with document edit rights to change the reviewers. As a document editor, you can add reviewers. These reviewers can sign documents, even if they have no edit rights.

Timestamp display: You can choose to display signature timestamps in either the ISO 8601 format (e.g. 2021-04-26T10:15:41Z), or in a US date format. The US format shows the abbreviated month and full weekday (e.g. Monday, Apr 26, 2021, 06:15 AM EDT). This display format prevents possible confusion about dates like 03/04/2021 in international settings.
The timezone for display of the timestamp can be set to either UTC or an IANA Time Zone Database listed time zone.

These settings are described at Automation and webhook events.

The Document Control changelog is available at Changelog.

The Document Control add-on helps with review and 21 CFR 11 compliant document signing on Confluence Cloud, including the ability to ensure that all signatures are authenticated at the time of signature. All transactions with Confluence Cloud are secured using Atlassian Connect Express / JWT. Data transport is secured using TLS (Transport Layer Security).

The add-on server stores your configuration settings. It does not store any data from your Confluence instance, including users, pages, reviewers, signatures, or anything else. All of the data generated by the add-on is stored in your Confluence instance, not the add-on server. The Confluence instance is managed by you and Atlassian, and it is your and Atlassian's responsibility to ensure data integrity and access controls. As a user of Document Control, it is your responsibility to keep Confluence backups. These backups will allow you to restore lost documents and signatures. As we do not store your Confluence data, we do not have backups of those and can't restore lost documents and/or signatures.
If you opt in to secondary authentication (2FA, personal token), Document Control stores an identifier and cryptographic information to secure the secondary authentication process in your Confluence instance.

The add-on is not certified by any authority. 21 CFR 11 compliance is a complex process, and this add-on is merely a small part. Full compliance will depend on Confluence settings, user management, and other operational processes.

The add-on server, which stores your configuration settings, is automatically backed up by Heroku. In addition we keep offsite backups for disaster recovery. These backups do not contain your data from your Confluence instance.

All transactions are secured using HTTPS/JWT. Because no personal data is stored, there is no long-term privacy risk to using this add-on.

The add-on will request email addresses for your users if you enable the "Send email notification to new reviewers" option in the add-on configuration, and if you use an authentication method which uses email. Email addresses are only used to send one-time notifications to users who are added as reviewers for a page, and to users who use an authentication method requiring email. Email address are not stored in the add-on, shared, or used for any other purpose.

Secondary authentication (2FA) is based on TOTP,a fixed personal token or SSO through OpenID.

We keep logs in order to audit for possible security incidents and other errors.