Getting Started With Properties

Specific types of work require specific kinds of information for your team to successfully complete their tasks. Properties collects and displays this information to provide your team the context they need to get the job done.

 

Every form field reflects one property. The whole form represents one property group.


1. Create a property group

After installing Properties you can find a new entry in the Apps section of the Confluence navigation. Select Properties to access the Properties portal. This is the hub in which the configuration takes place.

Navigate to the left sidebar and click on ‘Create property group’. You will be prompted the property group dialog and asked to fill in the details: name, description, and icon.

 

2. Create properties

Now you can create custom fields that will act as form fields. You can choose from various field types that fit your information type best:

  • Text

  • Select

  • Multiselect

  • Date

  • People

  • Page

  • Email

  • URL

  • Phone

  • Number

By choosing one field typ you are adding a new property to your property group. Every property can be given a name and a description. Depending on the field type (eg. select) you can add options users can select from when interacting with the ‘Property Group’ macro.

You can use multiple properties of different field types in one property group. Created properties are listed within the property group where they can be edited or reordered.

The order of your properties in the property group reflects the order of the form fields in the Property Group macro.

3. Embed the Property Group macro

Create or edit a regular Confluence page and embed the Property Group macro:

  1. In the Confluence editor, choose  + > Other Macros

  2. Find and select the Property Group macro

The macro dialog opens up. Select a previously created property group in the left sidebar of the macro dialog. Your properties will appear which can be edited within there.

When embedding the Property Group macro in a template you might want to leave all properties blank so users can fill them out when they create new pages.

After filling out the properties the macro placeholder reflects the given values. To change them you can just edit the macro again. Alternatively, fill out the form in the view mode of the Confluence page after publishing the page.

Only users who have permissions to edit the page can change values in the Property Group macro.

All changes to the form fields, whether in edit or view mode, are being logged.


After completing these three steps you created and used your first property group. Congratulations! Insert the Property Group macro on different pages and display all information collectively in the Page Properties Report macro.

Next

Review our detailed documentation: