Navigating the Properties Portal

After installing Properties you made the first step in bringing more structure and joy to your Confluence users.

On this page


Accessing the Properties portal

The Properties portal can be accessed by all users through the Confluence navigation at the top. Go to Apps > Properties.

We will be implementing permissions to give you more control of who can access and make changes in the Properties portal.

Setting up a property group

Properties act as form fields on your Confluence pages. In order to create or use one you need to create property group first.

In the left sidebar click on ‘+ New property group’.

You will be prompted the ‘Create property group’ dialog and be asked to fill in the details.

 

Paramater

Description

Paramater

Description

Icon

Allows you to pick an icon from the gallery Properties is equipped with.

Name

The value entered here will be the name of the property group that can be selected in the Property Group macro. This is a mandatory field.

Description

Shows under the name of your property group in the portal.

Restrictions

Set restrictions for specific users or groups.

After providing at least a name your property group is ready to be assigned properties to.

 

You can change or delete property groups by clicking on the toolbar (…) at the top.

By clicking on the lock icon you can see users and user groups that have the permission to edit the Property Group.

Deleting a property group also deletes all assigned properties permanently.

Creating and customizing properties

Select the property group you want to create a property in.

It is not possible to move or duplicate properties to other property groups.

In the now available right sidebar of the portal you get to choose from various field types for every property. By clicking on a field type you are adding a property to your property group. Following field types are available:

Text

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Select

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Options

Values users get to select from. Options can be ordered via drag and drop.

Display options in uppercase

Displays selected values in uppercase.

Multiselect

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Options

Values users get to select from. Options can be ordered via drag and drop.

Colors

Automatically assigned to options.

Display options in uppercase

Displays selected values in uppercase.

Date

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Highlight when date is expired

Highlights all selected dates when they are already expired.

Display creation date

Displays the creation date of the page.

Display last modified date

Displays the latest modified date of the page.

People

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Restrict to a single person

Restricts mentions to one user.

Display Avatar

Option to display the avatar of the selected user.

Display page creator

Shows only the page creator in the property.

Display last modifier

Shows only the latest modifier of the page.

Page

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Display current page

Display the current page where the Property Group is embedded.

Email

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

URL

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Phone

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Default country

Selection of every country with country calling code.

Number

Parameter

Description

Parameter

Description

Name

The value entered here will be shown to the user in the Properties macros.

Description

Shows in the form field within the Property Group macro.

Format

Selection of number formats and optional currency.

You can create infinite properties within one property group. They will all be listed as form fields in the Property Group macro and as columns in the Property Group Report macro.

Editing, deleting and reordering properties

Created properties are displayed as white boxes within their assigned property groups in the middle of the Properties portal.

By clicking on properties you can collapse the boxes and edit them.

 

For every property you get a distinct ‘Delete’ button to remove it permanently. When you are done editing you can save the changes by clicking on the ‘Save changes’ button at the bottom of the Properties portal.

Created properties can be reordered by drag and drop.

 

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


Next

Learn how to put your properties and property groups to action by embedding them as macros and using them as forms.