Microsoft Office 365 Integration. Administrator Guide

Transcription

1 Administrator Guide

2 Contents Contents DOCUMENT CHANGE HISTORY...3 ABOUT MICROSOFT OFFICE 365 INTEGRATION WITH BRIGHTSPACE LEARNING ENVIRONMENT...4 MICROSOFT OFFICE 365 PERMISSIONS...4 BROWSER CONSIDERATION FOR THE MICROSOFT OFFICE 365 WIDGET...4 OUTBOUND TRAFFIC...5 SET UP INTEGRATION FOR THE MICROSOFT OFFICE 365 WIDGET...5 Register Brightspace Learning Environment with Microsoft Azure...6 Office 365 Mail, Calendar, and SharePoint Verification...7 API Calls...7 Configure Brightspace platform for Microsoft Office 365 Plug-in...8 Configure a client domain...9 ADD THE OFFICE 365 WIDGET TO A COURSE...9 ADD THE OFFICE 365 WIDGET TO A HOME PAGE...9 USER WORKFLOWS FOR THE OFFICE 365 WIDGET...10 TROUBLESHOOTING THE MICROSOFT OFFICE 365 INTEGRATION...11 ABOUT D2L by D2L Corporation. All rights reserved. 2

3 Document Change History Document Change History This version of the document replaces all previous versions. The following table describes the most recent changes to this document. Revision Date November 5, 2015 Summary of Changes Added information about outbound connections and configuring a proxy server. Removed the requirement that the configuration variables OrgHasSSLEnabledInternal and OrgHasSSLEnabled have the same value since this is no longer the case. Removed the statement that d2l.tools.office365.clientdomain is not available in Brightspace Learning Environment by default since it is now available in Brightspace Learning Environment by default. September 3, 2015 Added feature information about setting a new, optional configuration variable that allows users to bypass the login screen the first time they launch the widget. Added information about API calls, Office 365 verification, and troubleshooting. August 6, 2015 June 19, 2015 Added information about setting up the Microsoft Office 365 Widget and adding the widget to a course or home page. Initial Release 2016 by D2L Corporation. All rights reserved. 3

4 About Microsoft Office 365 integration with Brightspace Learning Environment About Microsoft Office 365 integration with Brightspace Learning Environment Brightspace Learning Environment integrates with Microsoft Office 365 services ( , Calendar, and OneDrive) to improve how students and teachers interact online. Using this integration, you can insert a widget on a course or home page that provides a user's , Calendar, and OneDrive status in Brightspace Learning Environment. You can also use the integration with Microsoft Office 365 to permit students to submit assignment files from OneDrive to Assignments. Microsoft Office 365 provides institutions with a collection of enterprise-grade communication and productivity services. Depending on your license, these services may include Exchange Online, SharePoint Online, Skype for Business Online, and Office Professional Plus. Microsoft Office 365 permissions Setting Allow users to Users will see Also required Applicable org unit types Can view Microsoft Office 365 Widget View and access the Microsoft Office 365 system widget The Microsoft Office 365 system widget on their course homepage None Any Browser consideration for the Microsoft Office 365 widget User sessions in the Microsoft Office 365 widget are saved on your Brightspace account and are not tied to your browser session. This avoids having to log in to Office 365 each time that you access Brightspace. When logging in from your browser, the first address that you use is saved in your cookies. Each subsequent login from your browser session uses this address. It might be necessary to clear your cache or reset your browser session to log in to the widget using a different address by D2L Corporation. All rights reserved. 4

5 Outbound traffic Outbound traffic If your institution's firewall configuration does not allow outbound traffic, you must use one of the methods below to establish an outgoing HTTPS connection to these URLs: Use one of these methods to permit HTTPS connections to the URLs listed above: Add a firewall rule to allow outbound connections (port 80 and port 443) from all web and scalable servers to the URLs listed above. Configure a proxy server on the network that allows outbound connections to the URLs listed above by setting the following configuration variables: d2l.system.infrastructure.proxyaddress - The address of the proxy server. It normally takes the form or where myproxy is the host name or IP address and 8080 is the port. d2l.system.infrastructure.proxybypassaddresses - The addresses or address patterns that should not go through the proxy server. Address patterns take the form scheme://hostname:port/path where scheme is either http or https; hostname can be set as a * wildcard; port can be a specific number or a * wildcard to apply to all port numbers; and path is optional and can also contain a * wildcard. Set up integration for the Microsoft Office 365 widget To set up your integration of the Microsoft Office 365 widget in Brightspace Learning Environment, you must complete several tasks, which are explained further in the following sections: 1. Register Brightspace Learning Environment with Microsoft Azure. 2. Enable Microsoft Office 365 in Brightspace Learning Environment by D2L Corporation. All rights reserved. 5

6 Set up integration for the Microsoft Office 365 widget 3. Configure Brightspace Learning Environment for the Microsoft Office 365 Plug-in. 4. Add the widget to a course or home page. Register Brightspace Learning Environment with Microsoft Azure To access secured Microsoft Office 365 services in Brightspace Learning Environment, you need to grant your instance rights to access those services. This is done by registering Brightspace Learning Environment in a Microsoft Azure tenant and then configuring Brightspace Learning Environment with the resulting Client (Application) ID and Key. D2L recommends creating single-tenant instances instead of multi-tenant instances. Before you begin, ensure that you have your Azure AD authentication information. This authentication information is a user name and password combination. 1. Browse to the Azure login URL at (see Microsoft Azure Log In page - or to a different login URL provided by Microsoft. 2. Log in to your Azure Active Directory account. 3. Click Active Directory. You may need to scroll down on the page to find the link. 4. Choose the appropriate directory or create a new directory if one does not yet exist. 5. Click Applications > ADD. 6. Click Add an application my organization is developing. 7. On the Tell us about your application screen, do the following: 1. Enter a name for your application, such as Brightspace. 2. Ensure that, in the Type area, the Web Application and/or WEB API option is selected. 3. Click the right arrow. 8. On the App Properties screen, do the following: 1. In the Sign-On URL field, enter the domain name of your Brightspace Learning Environment. 2. In the App ID URI field, enter the domain name that you entered in the Sign-On URL field. 9. Click the check mark icon. The new application appears on your AD Applications tab. 10. From the AD Applications list, click to select the application that you added. 11. Select the Configure tab. 12. In the Properties area, do the following: 1. Verify that the Sign-ON URL is the domain that you entered earlier by D2L Corporation. All rights reserved. 6

7 Set up integration for the Microsoft Office 365 widget 2. Verify that the Application is Multi-Tenant field is set to No. 3. Locate the Client ID and record it for later. 13. In the Keys area, do the following: 1. Select a duration of 1 year or 2 years. After the duration elapses, your key expires and you will need to generate a new key. 2. Verify that the App ID URI is the identifier that you entered earlier. 3. Enter any additional Reply URL domains that may be required. 14. In the Permissions and Other Applications section, select Add Applications. 15. Select Office 365 Exchange Online and Office 365 SharePoint Online as required applications. 16. Click the check mark icon. 17. Select the drop-down menu beside Delegated Permissions and do the following: 1. For Office 365 Exchange Online, select Read users calendars and Read users mail. 2. For Office 365 SharePoint Online, select Read users files. 18. Click Save. 19. After the process is complete, scroll up to the Properties page. 20. From the Keys area, record the Client key. Office 365 Mail, Calendar, and SharePoint Verification After the Azure tenant is configured, the widget will only work if all of the services it is accessing are configured. The widget accesses Office 365 Mail, Calendar, and SharePoint, which must all be available when you sign in for the widget to work. User accounts can sometimes take time to set up these services, so it is important for a user to first verify that they can access them within Office 365. API Calls The Office 365 widget makes client and server-side calls to the Microsoft Office 365 APIs to authenticate and retrieve user information from a user's , calendar, and OneDrive account. Note: These requests are determined by Microsoft and are subject to change if the APIs change. Client-side The requests made on the client-side in the browser are: by D2L Corporation. All rights reserved. 7

8 Set up integration for the Microsoft Office 365 widget Server-side The requests made on the server-side are: The last URL for the SharePoint calls is returned to the Brightspace platform from the previous Microsoft calls. Each organization's tenant may be different, and each user's site path may be different. See for more information. Configure Brightspace platform for Microsoft Office 365 Plug-in In Brightspace Learning Environment, complete the following tasks to integrate with Microsoft Office Enable the Microsoft Office 365 Plug-in: 1. From the Admin Tools menu on the minibar, click Organization Tools. 2. Locate the Office 365 Plug-in from the list and then click the Availability toggle to turn it on. 2. Set Role Permissions for each user role that uses the Office 365 Plug-in: 1. From the Admin Tools menu on the minibar, click Roles and Permissions. 2. Browse to the appropriate role and then click the drop-down menu. 3. Select Edit Permissions. 4. In the Filter by Tool drop-down menu, browse to Office Click Apply Filter. 6. Click to select the Can View Office 365 Widget permission. 7. Click Save. 8. Repeat the process to set role permissions for additional user roles. 3. Add the Client ID and Client Key to the configuration variable browser: 2016 by D2L Corporation. All rights reserved. 8

9 Add the Office 365 Widget to a course 1. From the Admin Tools menu on the minibar, click Config Variable Browser. 2. In the d2l.tools.office365.clientid variable, select Org Value. 3. Enter the Client ID from the application registered on your Azure tenant into the text box and then click Save. 4. In the d2ltools.office365.clientsecret variable, select Org Value. 5. Enter the Client Key from the application registered on your Azure tenant into both fields and click Save. 4. If you want to configure a client domain, set the d2l.tools.office365.clientdomain configuration variable to the client domain provided by your Identity Provider (IdP). See Configure a client domain for more information. Configure a client domain The d2l.tools.office365.clientdomain is an optional configuration variable that allows learners to bypass the login screen the first time that they launch the Microsoft Office 365 widget. This allows learners to connect to the Microsoft Office 365 integration without having to enter their address an additional time. The value of d2l.tools.office365.clientdomain is the client domain provided by your Identity Provider (IdP). This feature only works for clients that use a single domain; it will not work for clients using a Microsoft multi-tenant solution. Also, the feature only works when all learners addresses are on the same domain (for Add the Office 365 Widget to a course To add the widget to a course: 1. Open the course. 2. Click Edit. 3. In the Widgets section, click Add Widgets > System Widgets. 4. Select Office 365 and then click Add. 5. Click Save. Add the Office 365 Widget to a home page To add the widget to your homepage: 1. From the Admin Tools menu on the minibar, click Homepage Management. 2. Select the active homepage. 3. In the selected location, select Add Widgets > System Widgets by D2L Corporation. All rights reserved. 9

10 User workflows for the Office 365 Widget 4. Select Office 365 and then click Add. 5. Click Save. User workflows for the Office 365 Widget A user follows one of three possible workflows for initial sign in to the Office 365 widget, depending on whether the d2l.tools.office365.clientdomain configuration variable is set and whether Single Sign-On (SSO) is set up. ClientDomain is not configured and SSO is not set up 1. The user clicks the initial sign-in button in Brightspace Learning Environment. 2. A new tab opens and the user is redirected to a "Sign in" page where the user enters their address. 3. After clicking Next, the user is redirected to another "Sign in" page where the user re-enters their address and then enters their password. 4. After signing in, the tab closes and the user is redirected to Brightspace Learning Environment with the widget loaded. ClientDomain is not configured and SSO is set up 1. The user clicks the initial sign in button in Brightspace Learning Environment. 2. A new tab opens and user is redirected to a "Sign in" page where the user enters their address. 3. After clicking Next, the user is redirected to another "Sign in" page where the user enters their address again. After they enter their address and either tab or click out of the field, the page redirects the user to the Identity Provider (IdP) page, according to the instance configuration. 4. After the user has gone through the IdP process, the tab closes and the user is redirected to Brightspace Learning Environment with the widget loaded. ClientDomain is configured and SSO is setup 1. The user clicks the initial sign in button in Brightspace Learning Environment. 2. A new tab opens and the page goes through a series of redirects without the user's intervention. 3. After the redirects are complete, the tab closes and the user is redirected to Brightspace Learning Environment with the widget loaded by D2L Corporation. All rights reserved. 10

11 Troubleshooting the Microsoft Office 365 integration Troubleshooting the Microsoft Office 365 integration Page Not Found Verify that the URL that you use to access Brightspace Learning Environment is the same URL that is configured in the following configuration variables: d2l.settings.webservername and d2l.settings.webservernameinternal. Sign in - Application with ID was not found in directory After configuring the widget, if you proceed through the initial sign in for the widget and then see the error "Sign In - Sorry, but we're having trouble signing you in. We received a bad request", view the additional technical information. If the additional technical information includes, "Application with identifier <id> was not found in directory <id>", then there is an issue with your Azure tenant. Your App ID URI does not match the domain that your Brightspace Learning Environment instance is currently on. Verify that the App ID URI matches the URL of your Brightspace Learning Environment instance in your Azure tenant. Widget displays "Loading..." when viewing s This may be an issue with the cookies in your browser. Microsoft relies on the cookies in your browser session to verify the account to connect with, even if you type your address at the beginning of the authentication process. If you are using multiple work accounts, this may affect authentication. Open a private browser session, log in to Brightspace Learning Environment, and then try to view s. If you can view s in a private browser session, delete your cookies to solve the problem in your regular browser session. After authenticating with Office 365 and being redirected, the widget does not sign in If you sign in through the widget, go through the Microsoft authentication process, and then get redirected back to the LMS but the widget is still not signed in, the account may not be set up properly with the Office 365 services. One of Mail, Calendar, or OneDrive is not set up in the account that is being used to log in. Try logging into Office 365 and accessing your Mail, Calendar, and OneDrive account. After you have confirmed that you can view everything, try logging into the widget again. Additional information on configuring Microsoft Azure For more information on configuring Microsoft Azure, refer to the following links: by D2L Corporation. All rights reserved. 11

12 About D2L About D2L A global leader in EdTech, D2L is the creator of Brightspace, the world s first integrated learning platform. The company partners with thought-leading organizations to improve learning through data-driven technology that helps deliver a personalized experience to every learner, regardless of geography or ability. D2L s open and extensible platform is used by more than 1,100 clients and almost 15 million individual learners in higher education, K 12, healthcare, government, and the enterprise sector including Fortune 1000 companies. The company has operations in the United States, Canada, Europe, Australia, Brazil, and Singapore. ( ( Contact Us Phone: Toll Free: (Worldwide) (North America) (United Kingdom and Europe) (New Zealand) (Australia) (Brazil) Fax: Twitter: Web: ( ( D2L Corporation. The D2L family of companies includes D2L Corporation, D2L Ltd, D2L Australia Pty Ltd, D2L Europe Ltd, D2L Asia Pte Ltd, and D2L Brasil Soluções de Tecnologia para Educação Ltda. Brightspace, D2L, and other marks ("D2L marks") are trademarks of D2L Corporation, registered in the U.S. and other countries. Please visit d2l.com/trademarks for a list of other D2L marks by D2L Corporation. All rights reserved. 12

13 About D2L Microsoft, Exchange, SharePoint, Lync, Office 365, OneDrive, Active Directory, AD, and Azure are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries by D2L Corporation. All rights reserved. 13