From 86872f94fca3ea567ce091676b8a4a0e5f75341e Mon Sep 17 00:00:00 2001 From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com> Date: Fri, 17 Feb 2023 17:35:59 -0500 Subject: [PATCH] Office CSP --- windows/client-management/mdm/office-csp.md | 630 ++++++++++++++++---- windows/client-management/mdm/office-ddf.md | 573 ++++++++++-------- windows/client-management/mdm/toc.yml | 2 +- 3 files changed, 838 insertions(+), 367 deletions(-) diff --git a/windows/client-management/mdm/office-csp.md b/windows/client-management/mdm/office-csp.md index ce956ea412..4921403985 100644 --- a/windows/client-management/mdm/office-csp.md +++ b/windows/client-management/mdm/office-csp.md @@ -1,102 +1,523 @@ --- title: Office CSP -description: The Office configuration service provider (CSP) enables a Microsoft Office client to be installed on a device. This CSP was added in Windows 10, version 1703. +description: Learn more about the Office CSP. +author: vinaypamnani-msft +manager: aaroncz ms.author: vinpa -ms.topic: article +ms.date: 02/17/2023 +ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage -author: vinaypamnani-msft -ms.date: 08/15/2018 -ms.reviewer: -manager: aaroncz +ms.topic: reference --- + + + # Office CSP -The table below shows the applicability of Windows: - -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| - + + The Office configuration service provider (CSP) enables a Microsoft Office client to be installed on a device via the Office Deployment Tool (ODT). For more information, see [Configuration options for the Office Deployment Tool](/deployoffice/office-deployment-tool-configuration-options) and [How to assign Office 365 apps to Windows 10 devices with Microsoft Intune](/intune/apps-add-office365). + -This CSP was added in Windows 10, version 1703. + +The following example shows the Office configuration service provider in tree format. -For more information, see [Office DDF](office-ddf.md). - -The following shows the Office configuration service provider in tree format. - -```console -./Vendor/MSFT -Office -----Installation ---------id -------------Install -------------Status - - -./Device/Vendor/MSFT -Office -----Installation ---------id -------------Install -------------Status - - -./Vendor/MSFT -./Device/Vendor/MSFT -Office -----Installation ---------id -------------Install -------------Status +```text +./Device/Vendor/MSFT/Office +--- Installation +------ {id} +--------- FinalStatus +--------- Install +--------- Status +------ CurrentStatus +./User/Vendor/MSFT/Office +--- Installation +------ {id} +--------- FinalStatus +--------- Install +--------- Status +------ CurrentStatus ``` + -**./Device/Vendor/MSFT/Office/ or ./User/Vendor/MSFT/Office** -The root node for the Office configuration service provider.

+ +## Device/Installation -**Installation** -Specifies the options for the Microsoft Office installation. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + -The supported operations are Add, Delete, and Get. + +```Device +./Device/Vendor/MSFT/Office/Installation +``` + -**Installation/_id_** -Specifies a unique identifier that represents the ID of the Microsoft Office product to install. + + +Installation options for the office CSP. + -The supported operations are Add, Delete, and Get. + + + -**Installation/_id_/Install** -Installs Office by using the XML data specified in the configuration.xml file. + +**Description framework properties**: -The supported operations are Get and Execute. +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Get | + -**Installation/_id_/Status** -The Microsoft Office installation status. + + + -The only supported operation is Get. + -**Installation/_id_/FinalStatus** -Added in Windows 10, version 1809. Indicates the status of the Final Office 365 installation. + +### Device/Installation/{id} -The only supported operation is Get. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + -Behavior: -- When Office CSP is triggered to install, it will first check if the FinalStatus node exists or not. If the node exists, delete it. -- When Office installation reaches any terminal states (either success or failure), this node is created that contains the following values: - - When status = 0: 70 (succeeded) - - When status!= 0: 60 (failed) + +```Device +./Device/Vendor/MSFT/Office/Installation/{id} +``` + -**Installation/CurrentStatus** -Returns an XML of current Office 365 installation status on the device. + + +A unique identifier which represents the installation instance id. + -The only supported operation is Get. + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Add, Delete, Get | +| Dynamic Node Naming | UniqueName: A unique identifier which represents the installation instance id. | + + + + + + + + + +#### Device/Installation/{id}/FinalStatus + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1809 [10.0.17763] and later | + + + +```Device +./Device/Vendor/MSFT/Office/Installation/{id}/FinalStatus +``` + + + + +Final Office 365 installation status. + + + + +- When Office CSP is triggered to install, it will first check if the FinalStatus node exists or not. If the node exists, delete it. +- When Office installation reaches any terminal states (either success or failure), this node is created that contains the following values: + - When status = 0: 70 (succeeded) + - When status != 0: 60 (failed) + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Get | + + + + + + + + + +#### Device/Installation/{id}/Install + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + + + +```Device +./Device/Vendor/MSFT/Office/Installation/{id}/Install +``` + + + + +The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Exec, Get | + + + + + + + + + +#### Device/Installation/{id}/Status + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + + + +```Device +./Device/Vendor/MSFT/Office/Installation/{id}/Status +``` + + + + +The installation status of the CSP. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Get | + + + + + + + + + +### Device/Installation/CurrentStatus + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later | + + + +```Device +./Device/Vendor/MSFT/Office/Installation/CurrentStatus +``` + + + + +The current Office 365 installation status on the machine. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Get | + + + + + + + + + +## User/Installation + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + + + +```User +./User/Vendor/MSFT/Office/Installation +``` + + + + +Installation options for the office CSP. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Get | + + + + + + + + + +### User/Installation/{id} + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + + + +```User +./User/Vendor/MSFT/Office/Installation/{id} +``` + + + + +A unique identifier which represents the installation instance id. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Add, Delete, Get | +| Dynamic Node Naming | UniqueName: A unique identifier which represents the installation instance id. | + + + + + + + + + +#### User/Installation/{id}/FinalStatus + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1809 [10.0.17763] and later | + + + +```User +./User/Vendor/MSFT/Office/Installation/{id}/FinalStatus +``` + + + + +Final Office 365 installation status. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Get | + + + + + + + + + +#### User/Installation/{id}/Install + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + + + +```User +./User/Vendor/MSFT/Office/Installation/{id}/Install +``` + + + + +The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Exec, Get | + + + + + + + + + +#### User/Installation/{id}/Status + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later | + + + +```User +./User/Vendor/MSFT/Office/Installation/{id}/Status +``` + + + + +The installation status of the CSP. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Get | + + + + + + + + + +### User/Installation/CurrentStatus + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later | + + + +```User +./User/Vendor/MSFT/Office/Installation/CurrentStatus +``` + + + + +The current Office 365 installation status on the machine. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Get | + + + + + + + + + + ## Examples Sample SyncML to install Microsoft 365 Apps for business Retail from current channel. @@ -147,38 +568,45 @@ To get the current status of Office 365 on the device. ```xml -    -      7 -        -          -            ./Vendor/MSFT/Office/Installation/CurrentStatus -          -        -    -    + + + 7 + + + ./Vendor/MSFT/Office/Installation/CurrentStatus + + + + + ``` ## Status code -|Status|Description|Comment| -|--- |--- |--- | -|0|Installation succeeded|OK| -|997|Installation in progress|| -|13|ERROR_INVALID_DATA
Cannot verify signature of the downloaded Office Deployment Tool (ODT)|Failure| -|1460|ERROR_TIMEOUT
Failed to download ODT|Failure| -|1602|ERROR_INSTALL_USEREXIT
User canceled the installation|Failure| -|1603|ERROR_INSTALL_FAILURE
Failed any pre-req check.
  • SxS (Tried to install when 2016 MSI is installed)
  • Bit mismatch between the currently installed Office and the Office that was attempting to be installed (such as when you try to install a 32-bit version while 64-bit version is currently installed.)|Failure| -|17000|ERROR_PROCESSPOOL_INITIALIZATION
    Failed to start C2RClient|Failure| -|17001|ERROR_QUEUE_SCENARIO
    Failed to queue installation scenario in C2RClient|Failure| -|17002|ERROR_COMPLETING_SCENARIO
    Failed to complete the process. Possible reasons:
  • Installation canceled by user
  • Installation canceled by another installation
  • Out of disk space during installation
  • Unknown language ID|Failure| -|17003|ERROR_ANOTHER_RUNNING_SCENARIO
    Another scenario is running|Failure| -|17004|ERROR_COMPLETING_SCENARIO_NEED_CLEAN_UP
    Possible reasons:
  • Unknown SKUs
  • Content does't exist on CDN
  • Signature check issue, such as failed the signature check for Office content
  • User canceled|Failure| -|17005|ERROR_SCENARIO_CANCELLED_AS_PLANNED|Failure| -|17006|ERROR_SCENARIO_CANCELLED
    Blocked update by running apps|Failure| -|17007|ERROR_REMOVE_INSTALLATION_NEEDED
    The client is requesting client clean-up in a "Remove Installation" scenario|Failure| -|17100|ERROR_HANDLING_COMMAND_LINE
    C2RClient command-line error|Failure| -|0x80004005|E_FAIL
    ODT cannot be used to install Volume license|Failure| -|0x8000ffff|E_UNEXPECTED
    Tried to uninstall when there is no C2R Office on the machine.|Failure| +| Status | Description | Comment | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| +| 0 | Installation succeeded | OK | +| 997 | Installation in progress | | +| 13 | ERROR_INVALID_DATA
    Cannot verify signature of the downloaded Office Deployment Tool (ODT) | Failure | +| 1460 | ERROR_TIMEOUT
    Failed to download ODT | Failure | +| 1602 | ERROR_INSTALL_USEREXIT
    User canceled the installation | Failure | +| 1603 | ERROR_INSTALL_FAILURE
    Failed any pre-req check.
  • SxS (Tried to install when 2016 MSI is installed)
  • Bit mismatch between the currently installed Office and the Office that was attempting to be installed (such as when you try to install a 32-bit version while 64-bit version is currently installed.) | Failure | +| 17000 | ERROR_PROCESSPOOL_INITIALIZATION
    Failed to start C2RClient | Failure | +| 17001 | ERROR_QUEUE_SCENARIO
    Failed to queue installation scenario in C2RClient | Failure | +| 17002 | ERROR_COMPLETING_SCENARIO
    Failed to complete the process. Possible reasons:
  • Installation canceled by user
  • Installation canceled by another installation
  • Out of disk space during installation
  • Unknown language ID | Failure | +| 17003 | ERROR_ANOTHER_RUNNING_SCENARIO
    Another scenario is running | Failure | +| 17004 | ERROR_COMPLETING_SCENARIO_NEED_CLEAN_UP
    Possible reasons:
  • Unknown SKUs
  • Content does't exist on CDN
  • Signature check issue, such as failed the signature check for Office content
  • User canceled | Failure | +| 17005 | ERROR_SCENARIO_CANCELLED_AS_PLANNED | Failure | +| 17006 | ERROR_SCENARIO_CANCELLED
    Blocked update by running apps | Failure | +| 17007 | ERROR_REMOVE_INSTALLATION_NEEDED
    The client is requesting client clean-up in a "Remove Installation" scenario | Failure | +| 17100 | ERROR_HANDLING_COMMAND_LINE
    C2RClient command-line error | Failure | +| 0x80004005 | E_FAIL
    ODT cannot be used to install Volume license | Failure | +| 0x8000ffff | E_UNEXPECTED
    Tried to uninstall when there is no C2R Office on the machine. | Failure | + + + + +## Related articles + +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/office-ddf.md b/windows/client-management/mdm/office-ddf.md index 9dec2a31e2..85276e8c25 100644 --- a/windows/client-management/mdm/office-ddf.md +++ b/windows/client-management/mdm/office-ddf.md @@ -1,61 +1,112 @@ --- -title: Office DDF -description: This topic shows the OMA DM device description framework (DDF) for the Office configuration service provider. DDF files are used only with OMA DM provisioning XML. -ms.reviewer: +title: Office DDF file +description: View the XML file containing the device description framework (DDF) for the Office configuration service provider. +author: vinaypamnani-msft manager: aaroncz ms.author: vinpa -ms.topic: article +ms.date: 02/17/2023 +ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage -author: vinaypamnani-msft -ms.date: 08/15/2018 +ms.topic: reference --- -# Office DDF + -This topic shows the OMA DM device description framework (DDF) for the **Office** configuration service provider. DDF files are used only with OMA DM provisioning XML. +# Office DDF file -Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md). - -The XML below is for Windows 10, version 1809. +The following XML file contains the device description framework (DDF) for the Office configuration service provider. ```xml -]> +]> 1.2 + + + + Office + ./User/Vendor/MSFT + + + + + Root of the office CSP. + + + + + + + + + + + + + + 10.0.15063 + 1.0 + 0x4;0x1B;0x30;0x31;0x48;0x54;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD; + + + + Installation + + + + + Installation options for the office CSP. + + + + + + + + + + + + + - Office - ./User/Vendor/MSFT + + + + - Root of the office CSP. + A unique identifier which represents the installation instance id. - + - + + id - com.microsoft/1.5/MDM/Office + + + A unique identifier which represents the installation instance id. + - Installation + Install + - Installation options for the office CSP. + The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office. - + @@ -64,149 +115,21 @@ The XML below is for Windows 10, version 1809. - + + + - - - - - - - - - - A unique identifier which represents the instalation instance id. - - - - - - - - - - id - - - - - - Install - - - - - - The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office. - - - - - - - - - - - text/plain - - - - - Status - - - - - The installation status of the CSP. - - - - - - - - - - - text/plain - - - - - FinalStatus - - - - - Final Office 365 installation status. - - - - - - - - - - - text/plain - - - - - - CurrentStatus - - - - - The current Office 365 installation status on the machine - - - - - - - - - - - text/plain - - - - - - Office - ./Device/Vendor/MSFT - - - - - - - - - - - - - - - com.microsoft/1.5/MDM/Office - - - Installation + Status + The installation status of the CSP. - + @@ -215,117 +138,237 @@ The XML below is for Windows 10, version 1809. - + - - id - - - - - - - A unique identifier which represents the instalation instance id. - - - - - - - - - - id - - - - - - Install - - - - - - - - - - - - - - - - text/plain - - - - - Status - - - - - - - - - - - - - - - text/plain - - - - - FinalStatus - - - - - Final Office 365 installation status. - - - - - - - - - - - text/plain - - - - - - CurrentStatus - - - - - The current Office 365 installation status on the machine - - - - - - - - - - - text/plain - - - + + + FinalStatus + + + + + Final Office 365 installation status. + + + + + + + + + + + + + + 10.0.17763 + 1.5 + + + + CurrentStatus + + + + + The current Office 365 installation status on the machine + + + + + + + + + + + + + + 10.0.16299 + 1.3 + + + + + + + Office + ./Device/Vendor/MSFT + + + + + Root of the office CSP. + + + + + + + + + + + + + + 10.0.15063 + 1.0 + 0x4;0x1B;0x30;0x31;0x48;0x54;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD; + + + + Installation + + + + + Installation options for the office CSP. + + + + + + + + + + + + + + + + + + + + + + + A unique identifier which represents the installation instance id. + + + + + + + + + + id + + + + + A unique identifier which represents the installation instance id. + + + + Install + + + + + + The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office. + + + + + + + + + + + + + + + + + + Status + + + + + The installation status of the CSP. + + + + + + + + + + + + + + + + FinalStatus + + + + + Final Office 365 installation status. + + + + + + + + + + + + + + 10.0.17763 + 1.5 + + + + + + CurrentStatus + + + + + The current Office 365 installation status on the machine + + + + + + + + + + + + + + 10.0.16299 + 1.3 + + + + + ``` + +## Related articles + +[Office configuration service provider reference](office-csp.md) diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index 65d19347b2..0b998c6302 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -794,7 +794,7 @@ items: - name: Office href: office-csp.md items: - - name: Office DDF + - name: Office DDF file href: office-ddf.md - name: PassportForWork href: passportforwork-csp.md