Office 365 Calendar Sync - Administrative Setup: Difference between revisions
Jspenceratty (talk | contribs) No edit summary |
Jspenceratty (talk | contribs) |
||
| (44 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Prime 16 utilizes technologies made available through Office 365 (O365) to provide users with the ability to synchronize their Prime and O365 calendars. This new sync is very easy to use in Prime. | Prime 16 utilizes technologies made available through Office 365 (O365) to provide users with the ability to synchronize their Prime and O365 calendars. This new sync is very easy to use in Prime. This is the updated version as of 05/19/2026. Prior version information is below in the "Archived/old material" section. | ||
= Prime Microsoft 365 Calendar Sync Setup Instructions = | |||
These instructions are for organizations setting up Prime calendar sync with Microsoft 365 / Outlook. Each organization should create its own Microsoft Entra application registration in its own Microsoft tenant. | |||
== 1. Setup == | |||
=== A. Microsoft 365 / Entra Administrator Setup === | |||
The organization's Microsoft 365 administrator must create an app registration in Microsoft Entra. This allows Prime to connect each Prime user to that user's Microsoft 365 Outlook calendar. | |||
# Sign in to the Microsoft Entra admin center. https://entra.microsoft.com | |||
# Go to: | |||
#: <pre>Entra ID → App registrations</pre> | |||
# Choose: | |||
#: <pre>New registration</pre> | |||
# Enter a name such as: | |||
#: <pre>Prime Access Calendar Sync</pre> | |||
# For supported account types, choose: | |||
#: <pre>Single tenant only - <your domain name></pre> | |||
#: This means the app is only for your organization's Microsoft tenant. | |||
# Create the app registration by clicking "Register" | |||
# After the app is created, copy these two values: | |||
#:<pre>Application (client) ID and Directory (tenant) ID</pre> | |||
# These will be entered into Prime. | |||
=== B. Configure the Redirect URI === | |||
In the app registration, go to: | |||
<pre>Authentication</pre> | |||
Click "Add Redirect URI" and choose: | |||
<pre>Mobile and desktop applications</pre> | |||
In the blank box (that may show an example entry), add this custom redirect URI exactly: | |||
<pre>http://localhost:3017/</pre> | |||
'''Important:''' The final slash matters! | |||
Prime uses a desktop OAuth sign-in flow where Microsoft signs the user in through the browser and redirects back to a local listener on the user's workstation. | |||
=== C. Enable Public Client Flow === | |||
Still under the app registration's '''Authentication''' page, in the ''Settings'' section, enable: | |||
<pre>Allow public client flows</pre> | |||
= | Set it to: | ||
<pre>Enabled</pre> | |||
Prime is a desktop Access front end, so it should be treated as a public client. | |||
=== D. Add Microsoft Graph Permissions === | |||
In the app registration, go to: | |||
<pre>API permissions</pre> | |||
Add Microsoft Graph delegated permissions: | |||
<pre> | |||
User.Read | |||
Calendars.ReadWrite | |||
Mail.ReadWrite | |||
Mail.ReadWrite.Shared | |||
Mail.Send | |||
Mail.Send.Shared | |||
offline_access | |||
</pre> | |||
Prime uses delegated permissions because each Prime user signs in as themselves. | |||
Review the list of delegated permissions. Once that list includes all those shown above, click the "Grant admin consent for <your domain>". | |||
== 2. Prime Administrator Setup == | |||
After the Microsoft administrator creates the Entra app, open Prime and go to the calendar sync settings screen. | |||
<pre>Admin → Custom Admin</pre> | |||
and choose | |||
<pre>Exchange Calendar Sync Settings</pre> | |||
In the "Exchange Calendar Sync Admin" form, choose "Open Org Settings". | |||
Enter the following values: | |||
<pre> | |||
Tenant ID: Directory (tenant) ID from Entra | |||
Client ID: Application (client) ID from Entra | |||
Redirect URI: <<As instructed by Kemp's Case Works staff>> | |||
Default Time Zone: <<Select the appropriate time zone>> | |||
</pre> | |||
Then enable organization-level calendar sync: | |||
<pre>Calendar Sync Enabled = Yes</pre> | |||
Recommended sync window: | |||
<pre> | |||
Sync Past Days: 30 | |||
Sync Future Days: 365 | |||
</pre> | |||
Each organization can adjust those values later. | |||
In the "Exchange Calendar Sync Settings" page click "Save Settings" and close this form. This should put you back in the "Exchange Calendar Sync Admin" form. Click on "Refresh Status" to see the values you've entered. | |||
===Testing Settings=== | |||
====Test Chilkat/OAuth==== | |||
In the "Exchange Calendar Sync Admin" click the "Test Chilkat/OAuth" button. This will test to ensure the underlying/background systems are in place that are necessary for the system to run. | |||
At the bottom you should see "Chilkat.OAuth2 object created and configured success". That means the system should be ready. Click OK to close this screen and return to the "Exchange Calendar Sync Admin" screen. | |||
====Test Sign-in / Me==== | |||
This button will test sign in with Microsoft using your Microsoft account. Be prepared to pass whatever credentials and two-factor authentication tests you may have set up with Microsoft. | |||
When you click this button, a web browser page should appear asking you to log in. You must use your account credentials in the agency. After successful logon, you should see "OAuth2 access is granted." This informs you the Microsoft system has authenticated you and returned information that Prime can use. | |||
Close the web browser. | |||
You should see a "Microsoft Graph sign-in succeeded" notification together with information about your name and email account. | |||
====Test Calendar Create/Delete==== | |||
This tests Prime's ability to create and then delete an entry in the calendar. Once again, you will be required to log on using your Organization's account. Use the web browser to enter your credentials and then close it. (It should again show the "OAuth2 access is granted" message. | |||
You should see a note saying a test calendar event was created, together with a question of whether you want to delete it, click "Yes" to test deletion capacity. | |||
You should see "The Outlook test event was created and deleted successfully." This indicates your setup is complete. | |||
You can click "Close" to close the "Exchange Calendar Sync Admin" form. | |||
Latest revision as of 15:06, 27 May 2026
Prime 16 utilizes technologies made available through Office 365 (O365) to provide users with the ability to synchronize their Prime and O365 calendars. This new sync is very easy to use in Prime. This is the updated version as of 05/19/2026. Prior version information is below in the "Archived/old material" section.
Prime Microsoft 365 Calendar Sync Setup Instructions
These instructions are for organizations setting up Prime calendar sync with Microsoft 365 / Outlook. Each organization should create its own Microsoft Entra application registration in its own Microsoft tenant.
1. Setup
A. Microsoft 365 / Entra Administrator Setup
The organization's Microsoft 365 administrator must create an app registration in Microsoft Entra. This allows Prime to connect each Prime user to that user's Microsoft 365 Outlook calendar.
- Sign in to the Microsoft Entra admin center. https://entra.microsoft.com
- Go to:
Entra ID → App registrations
- Choose:
New registration
- Enter a name such as:
Prime Access Calendar Sync
- For supported account types, choose:
Single tenant only - <your domain name>
- This means the app is only for your organization's Microsoft tenant.
- Create the app registration by clicking "Register"
- After the app is created, copy these two values:
Application (client) ID and Directory (tenant) ID
- These will be entered into Prime.
B. Configure the Redirect URI
In the app registration, go to:
Authentication
Click "Add Redirect URI" and choose:
Mobile and desktop applications
In the blank box (that may show an example entry), add this custom redirect URI exactly:
http://localhost:3017/
Important: The final slash matters!
Prime uses a desktop OAuth sign-in flow where Microsoft signs the user in through the browser and redirects back to a local listener on the user's workstation.
C. Enable Public Client Flow
Still under the app registration's Authentication page, in the Settings section, enable:
Allow public client flows
Set it to:
Enabled
Prime is a desktop Access front end, so it should be treated as a public client.
D. Add Microsoft Graph Permissions
In the app registration, go to:
API permissions
Add Microsoft Graph delegated permissions:
User.Read Calendars.ReadWrite Mail.ReadWrite Mail.ReadWrite.Shared Mail.Send Mail.Send.Shared offline_access
Prime uses delegated permissions because each Prime user signs in as themselves.
Review the list of delegated permissions. Once that list includes all those shown above, click the "Grant admin consent for <your domain>".
2. Prime Administrator Setup
After the Microsoft administrator creates the Entra app, open Prime and go to the calendar sync settings screen.
Admin → Custom Admin
and choose
Exchange Calendar Sync Settings
In the "Exchange Calendar Sync Admin" form, choose "Open Org Settings".
Enter the following values:
Tenant ID: Directory (tenant) ID from Entra Client ID: Application (client) ID from Entra Redirect URI: <<As instructed by Kemp's Case Works staff>> Default Time Zone: <<Select the appropriate time zone>>
Then enable organization-level calendar sync:
Calendar Sync Enabled = Yes
Recommended sync window:
Sync Past Days: 30 Sync Future Days: 365
Each organization can adjust those values later.
In the "Exchange Calendar Sync Settings" page click "Save Settings" and close this form. This should put you back in the "Exchange Calendar Sync Admin" form. Click on "Refresh Status" to see the values you've entered.
Testing Settings
Test Chilkat/OAuth
In the "Exchange Calendar Sync Admin" click the "Test Chilkat/OAuth" button. This will test to ensure the underlying/background systems are in place that are necessary for the system to run.
At the bottom you should see "Chilkat.OAuth2 object created and configured success". That means the system should be ready. Click OK to close this screen and return to the "Exchange Calendar Sync Admin" screen.
Test Sign-in / Me
This button will test sign in with Microsoft using your Microsoft account. Be prepared to pass whatever credentials and two-factor authentication tests you may have set up with Microsoft.
When you click this button, a web browser page should appear asking you to log in. You must use your account credentials in the agency. After successful logon, you should see "OAuth2 access is granted." This informs you the Microsoft system has authenticated you and returned information that Prime can use.
Close the web browser.
You should see a "Microsoft Graph sign-in succeeded" notification together with information about your name and email account.
Test Calendar Create/Delete
This tests Prime's ability to create and then delete an entry in the calendar. Once again, you will be required to log on using your Organization's account. Use the web browser to enter your credentials and then close it. (It should again show the "OAuth2 access is granted" message.
You should see a note saying a test calendar event was created, together with a question of whether you want to delete it, click "Yes" to test deletion capacity.
You should see "The Outlook test event was created and deleted successfully." This indicates your setup is complete.
You can click "Close" to close the "Exchange Calendar Sync Admin" form.