Office CSP

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 and Add Microsoft 365 Apps to Windows devices with Microsoft Intune.

The following list shows the Office configuration service provider nodes:

Device/Installation

Scope Editions Applicable OS
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./Device/Vendor/MSFT/Office/Installation

Installation options for the office CSP.

Description framework properties:

Property name Property value
Format node
Access Type Get

Device/Installation/{id}

Scope Editions Applicable OS
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./Device/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.

Device/Installation/{id}/FinalStatus

Scope Editions Applicable OS
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1809 [10.0.17763] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1709 [10.0.16299] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1809 [10.0.17763] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1703 [10.0.15063] and later
./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
✅ Device
✅ User
✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC
✅ Windows 10, version 1709 [10.0.16299] and later
./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.

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
    <Exec>
      <CmdID>7</CmdID>
        <Item>
          <Target>
            <LocURI>./Vendor/MSFT/Office/Installation/0AA79349-F334-4859-96E8-B4AB43E9FEA0/install</LocURI>
          </Target>
          <Meta>
            <Format xmlns="syncml:metinf">chr</Format>
          </Meta>
          <Data>&lt;Configuration&gt;&lt;Add OfficeClientEdition=&quot;32&quot; Channel=&quot;Current&quot;&gt;&lt;Product ID=&quot;O365BusinessRetail&quot;&gt;&lt;Language ID=&quot;en-us&quot; /&gt;&lt;/Product&gt;&lt;/Add&gt;&lt;Display Level=&quot;None&quot; AcceptEULA=&quot;TRUE&quot; /&gt;&lt;/Configuration&gt;</Data>
        </Item>
    </Exec>
    <Final/>
  </SyncBody>
</SyncML>

To uninstall the Office 365 from the system:

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
    <Exec>
      <CmdID>7</CmdID>
        <Item>
          <Target>
            <LocURI>./Vendor/MSFT/Office/Installation/E24B23D8-94A8-4997-9E6E-8FF25025845B/install</LocURI>
          </Target>
          <Meta>
            <Format xmlns="syncml:metinf">chr</Format>
          </Meta>
          <Data>&lt;Configuration&gt;&lt;Remove All=&quot;TRUE&quot;/&gt;&lt;Display Level=&quot;None&quot; AcceptEULA=&quot;TRUE&quot; /&gt;&lt;/Configuration&gt;</Data>
        </Item>
    </Exec>
    <Final/>
  </SyncBody>
</SyncML>

To get the current status of Office 365 on the device.

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
    <Get>
      <CmdID>7</CmdID>
      <Item>
        <Target>
          <LocURI>./Vendor/MSFT/Office/Installation/CurrentStatus</LocURI>
        </Target>
      </Item>
    </Get>
    <Final />
  </SyncBody>
</SyncML>

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 doesn't exist on CDN
    • Such as trying to install an unsupported LAP, like zh-sg
    • CDN issue that content is not available
  • 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

    Configuration service provider reference