Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
namePage Info
id278129461
classwatermark-layer
Content Column
namePage Body
width100.00001%
id278129463
Content Block
background-colortransparent
namePrompt
id494677873
classtight manual-prompt-flex

Learn how to connect an Outlook Calendar in order to display its events on a page.

Content Block
nameOutcome
rich-link-hoverstrue
id1042866408
classtight manual-outcome-flex

After installing Brikit Calendar Integrations, the next step is to connect to an existing Microsoft Outlook Calendar. This guide will lead you through creating an application in Azure, adding credentials, connecting a calendar, and displaying it on a page using the Outlook Calendar Events Browser Macro.

Tip

Brikit Calendar Integrations version 1.2 and above uses the Microsoft Graph integration instead of the Outlook Exchange Server (EWS). This means that one must first configure a Graph-accessible application using Microsoft Azure. Please follow the instructions and links below to do so.

Content Block
nameSteps
rich-link-hoverstrue
id494842117
classsteps-block numbered manual-steps-flex tight-bottom

Determine if you have System Administrator privileges

In order to configure an Outlook Calendar, you must be a System Administrator in Confluence and you must have access to the Microsoft Azure environment for the user/organization account associated with the calendar.

Create a new Enterprise Application using the Azure Active Directory Portal

Follow Microsoft's documentation called Use the portal to create an Azure AD application and service principal that can access resources. For the name of your enterprise application, use "Brikit Calendar Integrations" with the homepage URL set to "https://www.brikit.com/calendar-integrations". 

When selecting the right Authentication method, choose Option 2, "Create a new Application Secret".

Note the Application configuration data

Temporarily copy and save the following Azure application information:

  • User ID (aka "userPrincipalName")
  • Application (client) ID
  • Client Secret
  • Tenant ID

Grant the application Microsoft Graph permissions

Add the following permissions to your application:

  • Calendars.Read - read calendars in all mailboxes
  • User.Read.
Access
  • All - read all users' full profiles

Be sure to "grant admin consent" for the organization. For more information about these permissions, please see Microsoft Graph Calendar Permissions.

Navigate to the Brikit Calendar Integrations configuration page

.

In your Confluence environment, a A site administrator can configure the app by navigating as follows:

  1. Clicking on the Confluence Administration icon Image RemovedImage Added
  2. Selecting General Configuration
  3. In the sidebar menu, under the heading Brikit Calendar Configurations, click Outlook 

Add a credential

Before you can add a specific Calendar, you must first connect to your Microsoft Outlook Exchange Server. This requires establishing and authenticating credentials.

  1. Click the +Add Credential button
  2. Enter the Exchange Server URL (e.g.  https://outlook.office365.com/ews/exchange.asmx)Enter your UserID and  Passwordconfiguration data noted above (User ID, Application ID, Client Secret, and Tenant ID)

  3. Click Save

Test credentials

You should see a green check mark under the heading 'authentication status'. If not, double check to see that your credentials are correct (examine the URL, UserID, and password). If you are still receiving an error, check with your Exchange Server administrator. You may need to add your Confluence site as an allowed domain to the Outlook Exchange Server whitelistback on your Azure configuration to ensure all the steps were followed and permissions allowed.

Add a calendar

Once your credentials are authenticated, you may now add the Calendar or Calendars associated with this account.

  1. Click the +Add Calendar button.
  2. Enter the name of the CalendarEnter a name for the Calendar ID (should look like an email address)(optional).
  3. Select the associated credential (it will default to the above credential if you have only included one)credential from the dropdown.
  4. Select a calendar from the dropdown or leave blank to select the default calendar.
  5. Type the name of Add a color to help associate and differentiate this calendar from any others you may add, for example goldenrod.
  6. Click Save

Navigate to a page and edit it

You are now ready to add a macro to a Confluence page and start displaying Calendar events.

Add the Outlook Calendar Events Browser Macro

Add the macro to the page, then click the macro and Edit it. In the first macro parameter, be sure to use the same Calendar ID you entered in the Add a Calendar step aboveas displayed in the configuration table from the step above, it should have the pattern "user ID" or "user ID:calendar name". Configure any other parameters as you see fit. Click save in the Macro window, then Save the edits to the page.

The Outlook Calendar Events Browser Macro displays events as a scrollable list. If you'd like to see the events in a traditional monthly calendar view, add the Outlook Calendar Events Month View Macro.

View the calendar on the page

Your connected Calendar should now be displaying events on the page as a list (or, if there are no events, then it should display the No Events Message).

Content Block
nameNote
rich-link-hoverstrue
id495965127
classmanual-note-flex
collapsiblecollapse
Note

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the Steps block above to narrow the gap between the two blocks.
Content Block
nameTip
rich-link-hoverstrue
id894522670
classmanual-tip-flex
Tip

What time is it?

Brikit Calendar Integrations retrieves events from the connected Outlook Calendar and then displays them according to the timezone of the user viewing the calendar. However, your timezone in Confluence may not have been updated to reflect your current timezone (it defaults to the timezone setting of the server on which Confluence is installed).

To update your timezone, and display calendar events relative to your current time, read Changing Your Timezone.

Content Block
nameWarning
rich-link-hoverstrue
id894530759
classmanual-warning-flex
collapsiblecollapse
Warning

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Block
nameInfo
rich-link-hoverstrue
id894537203
classmanual-info-flex
collapsiblecollapse
Info

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Layer
background-color$lightGrayColor
nameRelated
id888168050
Content Column
nameRelated
width100%
id888168051
Content Block
rich-links-hide-descriptiontrue
rich-link-hoverstrue
rich-links-columns4
rich-links-verticaltrue
rich-links-image-height100px
rich-links-hide-site-icontrue
rich-links-details-padding10px
nameRelated
rich-links-enabletrue
border-width0
rich-links-details-alignmentleft
rich-links-margin20px 30px 0 0
id496234544
classrelated-block clean manual-related-flex