The Clio Operate Outlook Add-in is a web-based add-in built on the Microsoft Office Add-ins framework. It can be pushed to all users centrally or installed manually by individuals. The add-in updates automatically when a new version is released.
Before you start
Before deploying the add-in, confirm the following configuration is in place in Clio Operate:
- The Outlook Add-in Global Feature is enabled
- Contact support to configure the necessary authorisation flow and Cross-Origin Resource Sharing (CORS) settings. Proper configuration of these elements is crucial to ensure the add-in functions correctly and securely. Failure to do so may result in operational issues. The Outlook Global Feature automatically configures CORS and authorisation flow for the Outlook Add-in.
- The identity client sharedo-outlook-addin is configured
- The Content Security Policy includes the required O365 frame-ancestor URLs
- Work type relationships for inbound and outbound email are correctly configured
Centralised deployment
Centralised deployment pushes the add-in to all users or selected groups via the Microsoft 365 admin centre. Users do not need to install anything manually.
- Sign in to the Microsoft 365 admin centre at admin.microsoft.com.
- Navigate to Settings > Integrated apps.
- Select Upload custom apps.
- Choose Office Add-in as the app type.
- Upload the ShareDo Outlook Add-in.
- Assign the add-in to the relevant users or groups.
- Select Deploy.
The add-in appears in Outlook for assigned users within 24 hours. It may take longer in large tenants.
Manual Installation
Individual users can sideload the add-in directly from Outlook if the Microsoft 365 administrator has permitted it.
After installation, the ShareDo add-in appears in the Outlook Home menu ribbon. You may need to restart Outlook to refresh the ribbon. See Microsoft's article, Use add-ins in Outlook, for more details.
Outlook on the web and New Outlook
If you've toggled the Try New Outlook switch and are using the New Outlook, you must turn on the optional connected experiences to use the ShareDo Outlook Add-in.
- Open Outlook settings by clicking the gear icon on the top right of the window.
- Select General settings.
- Select Privacy and data.
- Select Privacy settings.
- Make sure Turn on optional connected experiences is turned on.
To add the app:
- Select the Apps icon in the Outlook ribbon (or More apps on a message).
- Select Add apps.
- Select My add-ins, then select Add a custom add-in from the dropdown.
- Select Add from file.
- Upload the ShareDoOutlook Add-in.
If users on New Outlook cannot see the add-in after deployment:
- Verify that the version in use is compatible with New Outlook.
- Confirm the add-in has the required permissions in the Microsoft 365 admin centre.
- Check that the Content Security Policy in Clio Operate includes the required O365 domains (see Admin configuration).
Classic Outlook for Windows
- Select File > Manage Add-ins. This opens Outlook on the web in a browser.
- Select the + button and choose Add from file.
- Upload the ShareDo Add-in.
If the sideloading option is not visible, contact your Microsoft 365 administrator to enable it, or use centralised deployment instead.
Uninstall
To remove the add-in, follow the steps in this Microsoft article: Use Add-ins in Outlook.
Authentication
On first use, the add-in prompts the user to enter the URL of their Clio Operate environment and authorise the connection. Authentication uses OAuth 2.0.
From version 7.9.0, the add-in supports PKCE (Proof Key for Code Exchange) as an enhanced authentication method. When enabled, the add-in uses PKCE for OAuth authentication. For details on how to enable, see the Configuration tab > PKCE authentication.
Troubleshooting
Outlook Add-in Global Feature
The Add-in itself verifies that the Global Feature is enabled and if not, shows an error message:
See Outlook Add-in Global Feature for more information.
CORS Configuration
The Outlook Global Feature automatically configures CORS and authorisation flow for the Outlook Add-in. If there is a problem with this configuration, you will typically encounter a problem where you are unable to connect to your ShareDo instance.
Content Security Policy
The Outlook Add-in requires that Office 365 URLs be added to the Allowed frame-ancestor origins text box of the Content Security Policy Global Feature. The help text from the Content Security Policy blade is shown here:
Frame ancestors and the Office add-ins: If you are using the official ShareDo Office add-ins via the appropriate web-based online application, you will need to allow certain O365 URLs to iframe the ShareDo identity server. Without doing so, the login form will not be allowed to render within the online interface.
Remember to recycle the cache after making these changes.
Errors
Most errors are self-explanatory, but for reference, here are a few more common errors:
-
Error: Your email address does not match the one registered in ShareDo.
Meaning: You're trying to file it from an email address that's not registered to ShareDo.
-
Error: The email subject is empty.
Meaning: Self-explanatory.