We are excited that you decided to take Orderly Databases for a spin and want to provide you with all the important information for a perfect start. In this quick guide, you will learn how to set up a database and display it on a Confluence page.

Before You Start

Prerequisites 

Before you begin, please make sure you meet the following prerequisites:

  • You have installed Orderly Databases for Confluence Cloud. If not, go to the Atlassian Marketplace and try the app for free for 30 days by clicking on Try it free.
  • You might want to create a new space for this tutorial as you will create a couple of new pages on-the-fly while setting up the database.

What is a database?

A database is a container for structured and unstructured content that lives in a Confluence space.

  • Structured content, or metadata, is organized and predictable information like customer IDs or license keys.
  • Unstructured content, in contrast, does not follow a specific pattern, for example, meeting notes or marketing images.

In a database, those two types of content can be linked to one another.  

Orderly Databases are a combination of database fields and entries.

  • Database fields define the database structure. Those are shown as columns in the table view of the database and describe the value type.
  • Database entries define the database content. Those are shown as rows in the table view of the database and represent the values.

There is no limit for fields or entries for a database but be aware that large databases can take longer to load and can quickly become very complex.

How to Set Up a Database

Step 1: Create Your First Database

For better demonstration, we'll have a look at the fictitious company Good Software setting up a new database to manage their projects. Here they can collect and share details for current or upcoming projects like smaller tasks like updates of articles but also bigger ones like launching a new website.

First, navigate to the space you just created (see Prerequisites), or any other desired Confluence space, and click on Orderly Databases in the sidebar.

Click on the New Database button in the upper right corner. In the dialog box, give a name to your database, e.g. "Projects". If you wish, you can also add an image for the database by pressing Change image. When you're done, click on create.

Step 2: Add Fields and Entries 

Now you want to fill your database with some useful information! First, you need to define the database structure by configuring the field types you need. As you can see the database already has a Title field (Text field type). You can add more fields by clicking on the + symbol in the upper right of the database. 

You can choose between several field types. As you click on the desired field, a dialog box opens where you can configure the field settings, e.g. the name of the field.

To document their projects, Good Software added a few different field types to structure the management and documentation process for their projects.

  • Title (Text, default field)
  • Manager (User)
  • Target date (Date)

  • Priority (Select)

  • Status (Select)

For the Select field type, you need to set up the selectable items in the field type setting, e.g. the project's priority or status. You can do so by hovering over one of the Select fields, clicking on the three dots, and then on Edit field.

Next, in the dialog box, you have to click on Add item and enter the items you need e.g. "Delayed" for defining a delayed project within the Status field. You can add as many items as you like by clicking on Add item again. If you click on the colored square next to the item, you can also choose a different color for it. Click Apply when you are done.

Finally, you can enter the values for your entry. When you have entered all necessary values, click on Save changes to save your entries. You can always add new entries by clicking on + Add entry at the bottom of the database.

Voila! You created your first own database.

Step 3: Display it Everywhere

Of course, you don't want the information to just sit within the Orderly Database app. That's why in the next step we are going to reference this database on a Confluence space with the help of the Orderly Database macro

Go to any page you want the database to be displayed on, like the "Projects" Confluence page, and edit the page. Search for "Orderly Database" within the macros and add it to the page.

For Database, you need to select the project database you just created.

Click on save to insert the macro.

Finally, publish the page to leave the edit mode. That's it!

Congratulations 🎉
You have successfully completed the Get Started tutorial for Orderly Databases. You have now set up a new Orderly Database and are ready to enable your team to quickly edit, filter, and share databases on any Confluence page!

Need More Help?

If you need further assistance with or information about Orderly Databases, take a look at our guides and tutorials. If you have any questions or want to provide feedback, we would love to hear what you think! Feel free to contact our support. We are happy to answer any questions you might have.