This article will provide guidance on the steps required for Google Apps Integration with ClickView.
Important Note: If the implementation of Single Sign On at your institution will lead to a change in e-mail addresses for users, please inform ClickView Technical Support when sending your completed SSO setup information so that we can migrate existing user data such as Workspaces and Playlists
If you are not sure of this, please contact ClickView Technical Support for further guidance prior to commencing the SSO setup.
ClickView Metadata Information
Note: Ensure that you use the URL that is appropriate for your institution's geographic location.
Australia
ACS URL: https://saml-in5.clickview.com.au/Shibboleth.sso/SAML2/POST
Entity ID: https://saml-in5.clickview.com.au/shibboleth
New Zealand
ACS URL: https://shibboleth.clickview.co.nz/Shibboleth.sso/SAML2/POST
Entity ID: https://shibboleth.clickview.co.nz/shibboleth
United Kingdom
ACS URL: https://saml-in3.clickview.co.uk/Shibboleth.sso/SAML2/POST
Entity ID: https://saml-in3.clickview.co.uk/shibboleth
United States of America
ACS URL: https://saml-in1.clickview.us/Shibboleth.sso/SAML2/POST
Entity ID: https://saml-in1.clickview.us/shibboleth
Integration Steps
Note: Before performing the setup of the ClickView SSO App, please ensure that the 'Department' attribute for each user contains one of the below values:
- Staff
- Year xx ("xx" signifying the year level of the student)
Recommended ways to populate the Department field are listed here.
1. Login to your Google Apps Administration Site:
https://admin.google.com
2. Select Web and mobile apps from the Apps menu.
3. Click Add app then Add custom SAML app.
4. Enter the following information for Application Name and App Icon and click Continue
Application Name: ClickView
App icon can be downloaded from here.
5. Choose Option 1 and Download IdP Metadata. It will need to be forwarded to ClickView Support to complete the provisioning. Press Next.
6. Enter ACS URL and Entity ID then press Continue:
Australian Institutions:
ACS URL: https://saml-in5.clickview.com.au/Shibboleth.sso/SAML2/POST
Entity ID: https://saml-in5.clickview.com.au/shibboleth
New Zealand Institutions:
ACS URL: https://shibboleth.clickview.co.nz/Shibboleth.sso/SAML2/POST
Entity ID: https://shibboleth.clickview.co.nz/shibboleth
UK Institutions:
ACS URL: https://saml-in3.clickview.co.uk/Shibboleth.sso/SAML2/POST
Entity ID: https://saml-in3.clickview.co.uk/shibboleth
US Institutions:
ACS URL: https://saml-in1.clickview.us/Shibboleth.sso/SAML2/POST
Entity ID: https://saml-in1.clickview.us/shibboleth
7. You need to specify the necessary mappings to integrate with ClickView. Please enter the following mappings in accordance with the table below:
8. Updating the 'Department' field:
There are three ways we recommend to update the Department field for Google G-Suite. They are outlined below.
NB: You only need to choose one method.
- Log in to the server hosting GCDS (usually the AD Server)
- Launch GCDS
- Under General Settings, Ensure User Profiles is checked
- Go to User Profiles and ensure to map department > Department. The below two articles may assist if you wish to sync other attributes:
https://support.google.com/a/answer/6162412?hl=en#userprofile
https://support.google.com/a/answer/6258071#user_profile - Ensure Active Directory has a common value populated in the Department field (i.e. Staff for staff members or the year group such as Year 7, Year 8 for students)
If you use Google Cloud Directory Sync (GCDS), any synchronization with Active Directory will override changes made in G-Suite
- Sign into your Admin Console (https://admin.google.com/)
- Click on Users tile
- Select required organizational unit in the menu on the left then click on Download users button
- Select All user info columns and currently selected columns and Comma-separated values (.csv) options, then click on Download button
- Click on Download CSV from Google Admin task area
- Open the CSV file with user information that you just downloaded
- Under the Department column, enter appropriate values (i.e. Staff for staff members or the year group such as Year 7, Year 8 for students)
Important things to remember:
- Any information in columns you can edit replaces existing information in the Admin console when you upload the file.
- For columns you don't want to change, you can either delete them (if the column isn't required), leave their information in the file, or delete their information.
- If you delete all information from a column that's not required, but leave the column in the spreadsheet, the existing information is not removed from the user's account when you upload the file.
- If you don't want to change a user's password, make sure the Password column contains the symbols **** (4 asterisks). - Save the CSV file
- Go back to Google Admin Console and click on Bulk upload users button
- Click on ATTACH CSV button and navigate to the updated CSV spreadsheet you saved. Then click on Upload button.
- This will merge the spreadsheet as opposed to creating new users.
- Sign into your Admin Console (https://admin.google.com/)
- Click on Users
- Click on the user you wish to update/modify the department field for
- Click on User Information under basic information
- Scroll down until you see Department. Click on the attribute and enter appropriate values (i.e. Staff for staff members or the year group such as Year 7, Year 8 for students).
9. Click Finish and the SAML App will be added to your Google Apps account.
10. After the ClickView SAML App has been added, ensure that it has been enabled for all users within your institution. Click on the Expand panel and change the setting from OFF for everyone to ON for everyone then press Save. Please bear in mind that it may take up to 24 hours for this change to propagate to all users.
Submitting your information
To start a new onboarding form, please click SSO Onboarding form,otherwise please continue with the form if you are already in the process of completing:
Please submit the completed onboarding form linked above, and email the downloaded metadata XML file to support@clickview.com.au.