Baseline Configuration
Application Properties
To enable the integration for Outlook, the following parameters in file 'application.properties' (refer to 'General Property and Ontology File Management' for additional information) need to be maintained:
revenuegrid.url
revenuegrid.secret
Note: The values will be provided by your customer success manager or by the implementation team. Also, be advised that the tenant instance needs to be restarted for the changes to take effect.
Enable Groupware Sync Tabs for Activities
Under 'Administration' -> 'Master Data Management' -> 'SettingBoolean' -> 'Enable Outlook Integration', the flag needs to be set to 'Yes'. This will enable the respective tabs for administrating the Outlook integration as well as personalize user settings under 'Activities' work center:
UI Profile Configuration
It is advised that only administrators are allowed to access the tab 'Groupware Administration'. If a respective Outlook synchronization user does not exist for the currently logged in CRM user, clicking on this link will create a new admin user. Hence, this link should be hidden behind a UI Profile which is only assigned to CRM administrators (refer to 'UI Profile' for additional information).
Create Connected Client
Under 'Administration' -> 'Connected Clients', create a new client with the ID revenuegrid according to the following settings:
Grant Types | Meaning |
---|---|
authorization_code | This is required for SSO |
password | This is required for user / password authorization |
refresh_token | This is required for application to application authorization |
The redirect URL can be constructed by taking the RG tenant URL and appending the following:
/ui/redirect.html
So, for example, if the tenant URL was https://acmecorptest--0us4--0hana--0ondemand--0com.inmindcloud.com/, the full redirect would be
https://acmecorptest--0us4--0hana--0ondemand--0com.inmindcloud.com/ui/redirect.html
Upon saving or regenerating the system will prompt the Administrator to copy the secret. This will be required in the next step.
Connect CRM and Outlook Integration Tenant
In CRM navigate to 'Activities' -> 'Groupware Administration' and maintain the client ID and client secret as per screenshot below.
With this the baseline configuration is completed.
Optional: Granting Access to the Mailbox in Server-Side Integration
When a standard user is trying to authenticate their Office 365 mailbox into Server-Side Integration and they encounter the error that says "Approval required" as shown in the screenshot below.
The issue occurs because of the setting of the customer’s Azure Active Directory > Enterprise applications> User settings, option “User can consent to apps accessing company data on their behalf” is set to “No”.
To resolve this situation, there are 2 options available:
Option 1): Grant Admin Consent for Server-Side integration
- Log on into Azure AD using the admin account
- Go to "Enterprise Applications" and find "IMC, server-side integration" in the list.
Note: Application may not be present in the list if none of the users previously consented to the app on his behalf. Refer to Option 2) to proceed further.
- Go to "Permissions" tab and click "Grant Admin consent for […]”.
- In the pop-up, log-in with Office 365 admin account and click "Accept".
- "Signed In successfully" message should be displayed.
- In "Admin Consent" tab on the application page a list of consented permissions will be displayed.
Option 2): Office 365 Administrator Can consent Application During Initial Log-in
- Office 365 administrator should be a Digital Sales Platform user and should be provisioned as server-side integration user.
- Log-on into the Digital Sales Platform as Office 365 administrator.
- Go to 'Activities” -> 'My Sync Settings' and click on the gear icon for "MAIL SERVER CONNECTION STATUS".
- In the Office365 OAuth log-in dialog, log in with your Office 365 administrator account.
- On the "Permissions Required" dialog checkbox "Consent on behalf of your organization" and click "Accept".
- "Signed in successfully" message will appear.
- The application will consent for the organization and standard users will be able to authenticate successfully.
- If Office 365 administrator is not planning to use server-side integration, a "Reset mailbox" procedure can be executed for the user in "Groupware
- Settings" tab, or user can be deprovisioned from server-side integration.
Related Documentation
For more information you can refer to the following links:
- https://docs.microsoft.com/en-us/azure/active-directory/develop/application-consent-experience
- https://docs.microsoft.com/en-us/azure/active-directory/develop/consent-framework
User Provisioning
In order to use the add-in or server-side sync as an Administrator, you will need to first provision users.
Click on the Provisioning tab and you will find the list of all employees. Click on the (+) action to provision users:
Select the action "Provisioning" to confirm.
You will be able to find the user under the User tab. By default, the sync will be disabled and mailbox status as not initialized.
Once the user has been provisioned, the end-user can install the add-in manually.
You can also perform mass provisioning of users by selecting the checkboxes as shown in the image below and then by clicking the Activate Selected button:
If you want to centrally install the Add-in and enable server-side sync please follow the steps ahead.
The next step needs to be performed by the end-user.
- Log-on to employee-facing application
- Go to 'Activities” -> 'My Sync Settings' and click on the gear icon for "MAIL SERVER CONNECTION STATUS".
3. Select Microsoft Office 365 as your e-mail service
- In the pop-up window that appeared, log on to your Microsoft Office 365 account and allow In Mind Cloud to access your data. If you don't see the pop-up window, please check if it's behind the main window in the background.
5. "Signed in successfully" message will appear and as you click on the dashboard you will see a checkmark for mail server connection status. you can now click on "Force Sync" to start initial synchronization. if Synchronization is enabled then in the next sync cycle you the sync will happen
Handling the Outlook Add-in
Installation Via 'Groupware Administration' Tab in CRM
An admin user can also install, uninstall and check the status of the Add-In on a user level as outlined in the following figure and table:
Action | Meaning |
---|---|
Install Revenue Grid... | Allows an admin to install the Add-In at the user's inbox |
Check Add-In Status | Checks the Add-In status |
Remove Add-In | Removes the Add-In from the user's inbox |
Manually Installing the Outlook Add-in
Follow these steps to manually install the Outlook Add-in:
- If your add-in was not automatically installed, you will have received an XML file from your IT organization or from In Mind Cloud.
- Save it in your system (for example, this can be in the Downloads folder).
- Select 'Manage Add-ins' under your Outlook settings:
- Go to Custom add-ins and click on Add a custom add-in.
- Choose Add from File -> select the XML file that you received from In Mind Cloud and add it.
- This will perform the installation and you will now have In Mind Cloud's Outlook Add-in as part of your Outlook application.
If you have successfully installed the Add-in, you will see the In Mind Cloud icon in your Outlook toolbar as shown in the screenshot below:
The user will need to enter the proper URL of the CRM tenant, e.g.
https://XXX.hana.ondemand.com/
Manually Uninstalling the Add-in
Follow these steps to uninstall the Outlook Add-in:
- Select 'Manage Add-ins' under your Outlook settings:
- Select 'Manage Add-ins' under your Outlook settings. In the pop-up dialog, select 'remove':
Setting Up for Exchange 2013 and Beyond
For correct work of integration these things required to be configured/fixed:
- EWS URL should be opened for connection from outside of their network (this is required for MailApp and synchronization functionality)
- Metadata URL also should be exposed without password validation (this is required for MailApp functionality)
- Refer to this exchange article for troubleshooting https://docs.microsoft.com/en-us/archive/blogs/jenstr/getting-internal-server-error-500-when-creating-new-cspartnerapplication-for-exchange-2013
As an alternative to 1) and 2) admins can whitelist firewall IPs of resources that are used for MailApp and synchronization.