windows-itpro-docs/windows/configuration/assigned-access/shell-launcher-configuration-file.md

title, description, ms.date, ms.topic

title	description	ms.date	ms.topic
Create an Shell Launcher configuration file	Learn how to create an XML file to configure a device with Shell Launcher.	02/12/2024	how-to

Create an Shell Launcher configuration file

This article provides practical examples of Shell Launcher XML configuration files.

Let's start by looking at the basic structure of the XML file.

• A configuration xml can define one or multiple Profiles
  • Each profile has a unique Profile Id and defines a Shell elemnt, which is the application that executes when the user signs in
  • A profile can define a default action to be taken when the application exits and may define actions to be taken when the application exits with a specific return code
  • A profile must be associated to a user account to have an effect
  • You can define a Default profile that is used when no other profile is associated to a user account
• A configuration xml can define one or multiple configs
  • Each config associates a user account to a profile Id
  • A profile has no effect if it's not associated to a user account

You can start your file by pasting the following XML code into a text editor, and saving the file with an xml extension. For example, kiosk.xml.

<?xml version="1.0" encoding="utf-8" ?>
<ShellLauncherConfiguration
    xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
    xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
    <Profiles>
        ...
    </Profiles>
    <Configs>
        ...
    </Configs>
</ShellLauncherConfiguration>

Profiles node

If you want to define a default profile, you can use the DefaultProfile element:

<Profiles>
    <DefaultProfile>
        ...
    </DefaultProfile>
</Profiles>

Each profile is identified by a unique identifier Profile Id, for example:

<Profiles>
    <Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}">
        ...
    </Profile>
</Profiles>

Shell node

The Shell node defines the application that executes when the user signs in:

• The Shell attribute is the path to the application
• The V2:AppType attribute defines the type of application
• The V2:AllAppsFullScreen attribute is a boolean value that defines if all applications are executed in full screen

<Shell Shell="" V2:AppType="" V2:AllAppsFullScreen="">
    <ReturnCodeActions>
        <ReturnCodeAction ReturnCode="" Action=""/>
    </ReturnCodeActions>
    <DefaultAction Action=""/>
</Shell>

<?xml version="1.0" encoding="utf-8" ?>
<ShellLauncherConfiguration
    xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
    xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
    <Profiles>
        <DefaultProfile>
            <Shell Shell=""/>
        </DefaultProfile>
        <Profile Id="">
            <Shell Shell="" V2:AppType="" V2:AllAppsFullScreen="">
                <ReturnCodeActions>
                    <ReturnCodeAction ReturnCode="" Action=""/>
                </ReturnCodeActions>
                <DefaultAction Action=""/>
            </Shell>
        </Profile>
    </Profiles>
    <Configs>
        <Config>
            <AutoLogonAccount/>
            <Profile Id=""/>
        </Config>
    </Configs>
</ShellLauncherConfiguration>

AppType

Allowed values are Desktop and UWP.

AllAppsFullScreen is a boolean value. If true, all applications are executed in full screen. If false...

:::row::: :::column span="1"::: Scenario :::column-end::: :::column span="3"::: Sample Xml :::column-end::: :::row-end::: :::row::: :::column span="1"::: Desktop application :::column-end::: :::column span="3"::: In this example, Microsoft Edge is executed in full screen, opening a website. The website is reloaded after 2 minutes of inactivity. xml <Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}"> <Shell Shell="%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe --kiosk https://www.contoso.com --edge-kiosk-type=fullscreen --kiosk-idle-timeout-minutes=2" V2:AppType="Desktop" V2:AllAppsFullScreen="true"> <ReturnCodeActions> <ReturnCodeAction ReturnCode="0" Action="RestartShell"/> <ReturnCodeAction ReturnCode="-1" Action="RestartDevice"/> <ReturnCodeAction ReturnCode="255" Action="ShutdownDevice"/> </ReturnCodeActions> <DefaultAction Action="RestartShell"/> </Shell> </Profile> :::column-end::: :::row-end::: :::row::: :::column span="1"::: UWP application In this example, the Weather app is executed in full screen. :::column-end::: :::column span="3"::: xml <?xml version="1.0" encoding="utf-8"?> <ShellLauncherConfiguration xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration" xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration"> <Profiles> <DefaultProfile> <Shell Shell="Microsoft.BingWeather_8wekyb3d8bbwe!App" V2:AppType="UWP"> <DefaultAction Action="RestartShell"/> </Shell> </DefaultProfile> </Profiles> <Configs/> </ShellLauncherConfiguration> :::column-end::: :::row-end:::

Kiosk example

[!INCLUDE shell-launcher-quickstart-xml]