MyAnalytics setup for Office 365 Administrators

The steps in this topic describe how to set up MyAnalytics for the users in your organization. Before you begin setup, complete the following:

To set up MyAnalytics, complete the following tasks.

Task Owner Outcome
Step 1 - Configure user settings Office 365 Administrators Configure MyAnalytics for each user in your organization.
Step 2 - Assign licenses with the MyAnalytics service plan Office 365 Administrators Assign licenses to users, which enables the MyAnalytics service plan for them.

Setup tasks

Step 1: Configure the user PrivacyMode setting

You can configure MyAnalytics (change its default behavior) for users in your organization by setting the PrivacyMode parameter. For information about the values of PrivacyMode, see PrivacyMode options.

You can set this parameter for one user or for many users:

PrivacyMode options

PrivacyMode Licensed user Unlicensed user
Opt-in (This is the default setting)
  • Office 365 data is used for aggregated information shown to licensed users.
  • Personal dashboard is available.
  • User can opt-out.
  • Office 365 data is used for aggregated information shown to licensed users.
  • Admins can opt-out unlicensed users through the admin PowerShell.
Opt-out
  • Office 365 data is not used for aggregated information shown to licensed users.
  • Personal dashboard is not available.
  • User can opt-in through the Feature settings menu.
  • Office 365 data is not used for aggregated information shown to licensed users.
Excluded
  • Office 365 data is not used for aggregated information shown to licensed users.
  • Dashboard is available.
  • User cannot opt-in through the Feature settings menu.
  • Do not specify Excluded for unlicensed users. Instead, specify Opt-out.

Note

  • Licensed users have MyAnalytics automatically enabled for them after a license is assigned to them.
  • All users in your organization, whether or not they have MyAnalytics licenses issued to them, are opted-in. If you want a licensed user to be opted out by default, which would give them the choice to opt-in, change the value of the PrivacyMode parameter for that user to "Opt-out."

Set PrivacyMode for one user

Configure MyAnalytics settings for a user with the following PowerShell cmdlet:

Set-UserAnalyticsConfig –Identity <string> [PrivacyMode <string[]>]
Parameter Required Description Default value
Identity Yes User ID for the current user as stored in Azure Active Directory (AAD). -
PrivacyMode Yes
  • Excluded: MyAnalytics will not use the current user's data to compute derived statistics for other users. The current user will not be able to change this from the Feature settings menu in MyAnalytics, but will still be able to see personalized statistics in their MyAnalytics dashboard and the Insights Outlook add-in.
  • Opt-out: MyAnalytics will not use the current user's data to compute derived statistics for other users. The current user will not see statistics in MyAnalytics, but can change this from the Feature settings menu and choose to opt-in.
  • Opt-in: MyAnalytics will use the current user's data to compute derived statistics for other users. The current user will see statistics in MyAnalytics, and can change this from the Feature settings menu to opt out.
Opt-in

Get PrivacyMode for one user

To determine the value of PrivacyMode for one user, use the following cmdlet:

Get-UserAnalyticsConfig –Identity <string>
Parameter Required Description Default value
Identity Yes User ID for the current user as stored in AAD -

Set PrivacyMode for multiple users

You can use PowerShell to change the value of PrivacyMode for multiple users at once. To do this, run a PowerShell script that iterates through the users, changing the value one user at a time. Follow these steps:

  1. Create a comma-separated value (.csv) text file that contains the UserPrincipalName field and the addresses of the users you want to configure. For example:
UserPrincipalName,UsageLocation
ClaudeL@contoso.onmicrosoft.com,FR
LynneB@contoso.onmicrosoft.com,US
ShawnM@contoso.onmicrosoft.com,US
  1. Specify the location of the input .csv file, the output .csv file, and the value of PrivacyMode that you want to set for each user:
$inFileName="<path and file name of the input .csv file that contains the users, example: C:\admin\Users2License..csv>"
$outFileName="<path and file name of the output .csv file that records the results, example: C:\admin\Users2License-Done..csv>"
$privacyMode = "Opt-in"

$users=Import-Csv $inFileName
ForEach ($user in $users)
{
$user.Userprincipalname
$upn=$user.UserPrincipalName

Set-UserAnalyticsConfig –Identity $upn -PrivacyMode $privacyMode
Get-UserAnalyticsConfig –Identity $upn | Export-Csv $outFileName
}
  1. Run the resulting commands at the PowerShell command prompt. For more information about the Exchange Online PowerShell, see Connect to Exchange Online PowerShell.

This PowerShell command block does the following:

  • Displays the user principal name of each user.
  • Sets the specified privacy mode for each user.
  • Creates a .csv file with all the users that were processed and shows their status.

Step 2: Assign licenses with the MyAnalytics service plan

You must assign a license with the MyAnalytics service plan to each participant that wants to get statistics from MyAnalytics. For information on how to do this, see Assign licenses to users in Office 365 for business. If you don’t want a user to see any statistics from MyAnalytics, you can disable the MyAnalytics service plan for that user.

Note

Assigning licenses with the MyAnalytics service plan turns it on for those participants. Before you do this, you might notify them in email that MyAnalytics will be available soon. To help you with this notification, use this email template. You can download it, customize it with your company’s information, and then email it to the new MyAnalytics participants. To learn more about adopting MyAnalytics, see Adopt MyAnalytics.

MyAnalytics elements become available

After you assign a user license with the MyAnalytics service plan, the new participant will gain access to the following MyAnalytics elements.

  • Insights Outlook add-in: Users can see the Insights Outlook add-in in a day or so after their license with the MyAnalytics service plan is granted.

  • MyAnalytics personal dashboard: Users can visit their personal dashboard a few days after their license with the service plan is granted.

  • MyAnalytics welcome email:

    • Existing users of Office 365 will receive the welcome email a few days (up to four weeks) after their license is granted.
    • New users will receive the welcome email approximately four weeks after their license is granted.

    Note

    Users will not receive the welcome email outside of their work week. If a user's set work week is Monday to Friday, and the person's welcome email would otherwise arrive on a weekend, its arrival time is delayed to the following Monday. For more details, see MyAnalytics welcome email.

  • Weekly email digest: Users will begin to receive the MyAnalytics email digest on the Monday of the first week after they receive the welcome email.