Skip to content

Get started with Factory Orchestrator

Install the service

The service can be downloaded from the GitHub releases page.

The Factory Orchestrator service (Microsoft.FactoryOrchestrator.Service) runs on your device under test (DUT) and acts as the engine powering Factory Orchestrator. To interact with the service, you can use the Factory Orchestrator Windows app or programmatically using the Factory Orchestrator client APIs. Multiple clients can be connected to the same service simultaneously.

Once installed, the service can either be started manually (on demand) or configured to automatically start every boot.

Image of service start

Install the service on Windows

Download and unzip the service for 'win'(dows) and your target architecture. Then use an Administrator PowerShell to run the included InstallFactoryOrchestratorService.ps1 file. If you want the service to start automatically every boot, use the -AutoStart switch. Without this switch the service must be started manually every boot.

    # Optionally, set its start up to automatic with: -AutoStart
    # Optionally, choose the installation directory with: -DestinationPath
    .\InstallFactoryOrchestratorService.ps1 # -AutoStart -DestinationPath C:\FactoryOrchestrator

Execution Policy

If you see the following error, you need to set your ExecutionPolicy to RemoteSigned.

File InstallFactoryOrchestratorService.ps1 cannot be loaded because running scripts is disabled on this system.
For more information, see about_Execution_Policies at https://go.microsoft.com/fwlink/?LinkID=135170.

Run the following command to temporarily allow you to run the install script:

    # Temporarily allow your PC to run signed scripts
    Set-ExecutionPolicy RemoteSigned -Scope Process

    # Then, you can install the service!
    .\InstallFactoryOrchestratorService.ps1 # -AutoStart

Start the service manually on Windows

To start the service manually, run the following from an administrator PowerShell:

     Start-Service -Name "Microsoft.FactoryOrchestrator"

Windows UWP app support

If you want Factory Orchestrator to be able to install, launch, or exit Windows Store/UWP apps, your device must support running UWP apps and Windows Device Portal must be running on the device with HTTP enabled & no authentication. Image of WDP settings

Install the service on Linux

Download and unzip the service for 'linux' and your target architecture. Then run the included InstallFactoryOrchestratorService.sh file with bash as sudo. If you want the service to start automatically every boot, add an "enable" argument. Without this the service must be started manually every boot.

     ## Optionally set its start up to automatic with: enable
    sudo bash ./InstallFactoryOrchestratorService.sh # enable

The install script requires the "unzip" command. If you prefer to use another command to unzip a .zip file, edit InstallFactoryOrchestratorService.sh, replacing "unzip" with your desired command.

Start the service manually on Linux

To start the service manually, run the following from bash:

    sudo systemctl start Microsoft.FactoryOrchestrator.service

Service configuration

See Service configuration for details on how you can configure the Factory Orchestraor service's default behavior, including enabling network access so you can communicate with the service over your local network.

Install the app

You can install the Factory Orchestrator app on your DUT or on a technician PC running Windows. The app can be downloaded from the GitHub releases page.

To install the app, run the .msixbundle to install the app. Alternately, use Windows Device Portal to install the app on your DUT. The app on the GitHub releases page is signed by Microsoft and does not require a certificate file to install.

Run the app

To run the Factory Orchestrator app, use the Start menu to launch "Factory Orchestrator". The Factory Orchestrator app will start on the PC. If the PC has the Factory Orchestrator service running, it will automatically connect to the service. If not, you will be prompted to select the remote PC running Factory Orchestrator service you wish to connect to.

Connect page of app

See Using the application for details on how to use the app.

Run the app via Windows Device Portal

Alternately, use Windows Device Portal to run the app:

  1. Connect to the device where the app is installed with Device Portal
  2. From Device Portal's Apps manager tab, choose Factory Orchestrator (App) from the Installed Apps list.
  3. Click Start

Install the PowerShell module

The PowerShell module is available on PowerShell Gallery and can be installed by running the following command:

Install-Module Microsoft.FactoryOrchestrator.Client

PowerShell 7+ is required. See Using PowerShell or C# code for usage details.