From ca7404dc790d9975b87b27bce53abe01ff8a1289 Mon Sep 17 00:00:00 2001 From: Greg Lindsay Date: Thu, 20 Oct 2016 16:40:53 -0700 Subject: [PATCH] added exit code table and minor tweaks --- .../deploy/upgrade-analytics-get-started.md | 50 +++++++++++++++---- 1 file changed, 41 insertions(+), 9 deletions(-) diff --git a/windows/deploy/upgrade-analytics-get-started.md b/windows/deploy/upgrade-analytics-get-started.md index 070a9e137c..5dcb740498 100644 --- a/windows/deploy/upgrade-analytics-get-started.md +++ b/windows/deploy/upgrade-analytics-get-started.md @@ -2,28 +2,28 @@ title: Get started with Upgrade Analytics (Windows 10) description: Explains how to get started with Upgrade Analytics. ms.prod: w10 -author: MaggiePucciEvans +ms.mktglfcycl: deploy +ms.sitesec: library +ms.pagetype: deploy +author: greg-lindsay --- # Get started with Upgrade Analytics -Use Upgrade Analytics to plan and manage your upgrade project end to end. After you’ve established communications between user computers and Microsoft, Upgrade Analytics collects computer, application, and driver data for analysis. We use this data to identify compatibility issues that can block your upgrade and suggest fixes that are known to Microsoft. +you can use Upgrade Analytics to plan and manage your upgrade project end to end. After you’ve established communications between user computers and Microsoft, Upgrade Analytics collects computer, application, and driver data for analysis. This data is used to identify compatibility issues that can block your upgrade and to suggest fixes that are known to Microsoft. -For system, application, and driver data to be shared with Microsoft, you must configure user computers to send data. For information about what telemetry data Microsoft collects and how that data is used and protected by Microsoft, see: +To enable system, application, and driver data to be shared with Microsoft, you must configure user computers to send data. For information about what telemetry data Microsoft collects and how that data is used and protected by Microsoft, see the following topics: - [Configure Windows telemetry in your organization](https://technet.microsoft.com/itpro/windows/manage/configure-windows-telemetry-in-your-organization) - - [Manage connections from Windows operating system components to Microsoft services](https://technet.microsoft.com/itpro/windows/manage/manage-connections-from-windows-operating-system-components-to-microsoft-services) - - [Windows 7, Windows 8, and Windows 8.1 appraiser telemetry events and fields](https://go.microsoft.com/fwlink/?LinkID=822965) -This topic explains how to obtain and set up Upgrade Analytics components. If you haven’t done so already, see [Upgrade Analytics requirements](https://technet.microsoft.com/itpro/windows/deploy/upgrade-analytics-requirements) for information about requirements for using Upgrade Analytics. +This topic explains how to obtain and set up Upgrade Analytics components. If you haven’t done so already, see [Upgrade Analytics requirements](https://technet.microsoft.com/itpro/windows/deploy/upgrade-analytics-requirements) for information about requirements for using Upgrade Analytics. Also, check out the [Upgrade Analytics blog](https://blogs.technet.microsoft.com/UpgradeAnalytics) for new announcements and helpful tips for using Upgrade Analytics. To configure Upgrade Analytics, you’ll need to: - Add the Upgrade Analytics solution to a workspace in the Operations Management Suite portal - - Establish communications and enable data sharing between your organization and Microsoft Each task is explained in detail in the following sections. @@ -109,9 +109,7 @@ IMPORTANT: Restart user computers after you install the compatibility update KBs To ensure that user computers are receiving the most up to date data from Microsoft, we recommend that you establish the following data sharing and analysis processes. - Enable automatic updates for the compatibility update and related KBs. These KBs are updated frequently to include the latest application and driver issue information as we discover it during testing. - - Schedule the Upgrade Analytics deployment script to automatically run so that you don’t have to manually initiate an inventory scan each time the compatibility update KBs are updated. Computers are re-scanned only when the compatibility KBs are updated, so if your inventory changes significantly between KB releases you won’t see the changes in Upgrade Analytics until you run the script again. - - Schedule monthly user computer scans to view monthly active computer and usage information. ## Run the Upgrade Analytics deployment script @@ -170,6 +168,40 @@ To run the Upgrade Analytics deployment script: 6. After you finish editing the parameters in RunConfig.bat, run the script as an administrator. +The deployment script displays the following exit codes to let you know if it was successful, or if an error was encountered. + +
+ + +
Exit codeMeaning +
0Success +
1Unexpected error occurred while executing the script +
2Error when logging to console. $logMode = 0. +
3Error when logging to console and file. $logMode = 1. +
4Error when logging to file. $logMode = 2. +
5Error when logging to console and file. $logMode = unknown. +
6The commercialID parameter is set to unknown. Modify the script. +
7Function -CheckCommercialId: Unexpected failure. +
8Failure to create registry key path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\DataCollection. +
9Error when writing CommercialId to registry. +
10Error when writing CommercialDataOptIn to registry. +
11Function -SetupCommercialId: Unexpected failure. +
12Can’t connect to Microsoft – Vortex. Check your network/proxy settings. +
13Can’t connect to Microsoft – setting. Check your network/proxy settings. +
14Can’t connect to Microsoft – compatexchange. Check your network/proxy settings. +
15Error connecting to Microsoft. Check your network/proxy settings. +
16Machine requires reboot. +
17Function -CheckRebootRequired: Unexpected failure. +
18Outdated compatibility update KB package. Update via Windows Update/WSUS. +
19This machine doesn’t have the proper KBs installed. Make sure you have recent compatibility update KB downloaded. +
20Error writing RequestAllAppraiserVersions registry key. +
21Function – SetRequestAllAppraiserVersions: Unexpected failure. +
22Error when running inventory scan. +
23Error finding system variable %WINDIR%. +
+ +
+ ## Seeing data from computers in Upgrade Analytics After data is sent from computers to Microsoft, it generally takes 48 hours for the data to populate in Upgrade Analytics. The compatibility update KB takes several minutes to run. If the KB does not get a chance to finish running or if the computers are inaccessible (turned off or sleeping for example), data will take longer to populate in Upgrade Analytics. For this reason, you can expect most your computers to be populated in OMS in about 1-2 weeks after deploying the KB and configuration to user computers.