Metadata for Confluence Cloud

Overview

Metadata for Confluence Cloud enables you to easily assign and manage metadata in Confluence.

1. Define custom fields of a large variety of options
2. Assign any field to any page you like
3. Use built-in marcos to:
   1. Display the metadata of a page
   2. Summarise metadata of multiple pages
4. Manage your pages using the overview page:
   1. Filter by Metadata
   2. Filter by Space or label
   3. Bulk update pages with metadata
5. Access and interact with your metadata programmatically via REST API. View API documentation

Configuring metadata field and sets

What are metadata fields?

Metadata fields are predefined page attributes comprising name and type that you use to fill in metadata.

Available types are: text, boolean (true / false), list (single / multi), date, external links and user.

What are metadata sets?

Metadata sets are collections of fields that can also be assigned to Confluence spaces.

It is possible to assign a field to different sets and have different values for the two on the same page.

Due to platform limitations, every organization can have up to 20 metadata sets and each set is limited to a number of fields from each type as below:

1. Text - 10
2. Checkbox - 10
3. Select - 10
4. Date - 8
5. User - 8
6. Link - 5
7. Group - 2

How to create fields and sets?

1. Go to Confluence Home
2. Click on the "Metadata" menu item.
3. A page with 3 tabs will show: "Metadata Fields", "Metadata Sets" and "Overview". By default, the fields tab is open.
4. Click the "Add field" button on the top right corner and fill in the form. Finally, click save.
5. After you have created the necessary fields, move to the sets tab.
6. Click "Add set" button on the top right corner and fill in the form. Choose the fields it will be associated with. Optionally, you can also choose default spaces for the set. Finally, click save.
   1. You can also configure default values for the fields you choose. Once a page is created, the metadata will be populated automatically with the default values for the specified spaces.
7. Now you can add metadata to all pages for the fields you have defined!

Edit and view Metadata

1. Go to the confluence page you would like to input the metadata.
2. Between the title and the content of the page, you will find some links. Look for "Metadata" and click it.
3. A pop-up window will open displaying the metadata for the page.
4. If you would like to fill in the metadata, click on the edit toggle on the right top corner.
   1. Choose the metadata sets for this page.
   2. Fill in the metadata for each collapsable set.
   3. Click submit on the bottom right corner of the pop-up.

Overview page

The overview page helps you manage your pages and together with its' metadata by advanced filtering capabilities and bulk operations.

To change the displayed columns click on the "Columns" button above the table, on the right side of the page, and selected the columns you want. Your selection will be remembered until the next time you decide to change it.

Filters

• The filters are located above the table on the left side of the page.
• There are 2 static filters: "Spaces" and "Labels". The other filters are dynamic.
• To add metadata filters, click on the "+ Filter" button and choose a field (All of the fields are grouped by their sets).
• The field will be added to the filters, click on it, set a value, and then click "Update".

Bulk Update

1. Select the pages you want to update using the checkbox on the row of the page (first column)
   1. You may also check all rows on the page or all matching rows using the checkbox in the table header.
2. Click on the "Bulk Update" button next to the "Columns" button.
3. Choose the "fields to update" and enter values for each field
4. Click update Note: Large amount of pages to update may take some time to complete

Macros

The app contains a couple of built-in Confluence macros to integrate the metadata into Confluence pages.

• Display Macro - Shows the metadata of a specified page
• Overview Marco - Shows a summary of multiple pages metadata. Including advanced filter capabilities and the ability to select the columns to display.

1. Go to the confluence page you would like to use the macro in.
2. Turn on the edit mode (click on the edit button).
3. Locate the editor toolbar and click on Insert (+).
4. In the pop-up menu click "View more".
5. Search for "Metadata" in the select macro pop-up. Alternatively, you may find the macro under "Confluence content" or "Reporting".
6. Choose the macro you would like to include on the page, fill in the parameters and click "Insert".
7. Finally, publish the page.

REST API

Admin can generate an API key to integrate with their organization's metadata via REST.

How to generate an API Key?

1. Open the Metadata app:
2. Go to Settings:
3. Click "Generate API Key"
4. Set a descriptive name for the API Key and click Save. This name will be visible only on this screen and will help you identify your organization's tokens.
5. Once the API Key is generated make sure to securely store it. No one has access to this key and we won't be able to regenerate it for you in case you forget it.
6. This API Key will be used as the Bearer token for your API integration.
7. View the documentation to make your first request easily.

Rate Limits

100 requests per 1 minute

Contact us if you'd like to extend your limits.