Export (0) Print
Expand All

SurfaceOutOfOrder.XML File

There are certain conditions that cause the Surface software to display an error screen or an out-of-order screen:

  • The device made for Microsoft Surface encounters an unrecoverable failure (both the error and out-of-order screens appear).

  • Someone remotely logs on to the device made for Surface (the out-of-order screen appears).

For more information about error and out-of-order screens, see Configuring Surface Shell Time-Out Durations. If you plan to install localized applications on a device, you should also provide localized error and out-of-order screens. For more information about how to provide these localized screens, see Deploying Localized Surface Applications.

Changing the Wording and Images in the Out-of-Order and Error Screens

You can change the wording and the background images for the error and out-of-order screens. One of the methods you can use to customize error and out-of-order screens is to specify alternate error and out-of-order words and images in an XML file. This XML file is not included with devices, so you must create a file named SurfaceOutOfOrder.xml and put it in the %ProgramData%\Microsoft\Surface\v2.0\ folder.

TipTip
If you prefer, you can use Surface Configuration Editor to configure customized error and out-of-order screens. This tool automatically creates and edits a SurfaceOutOfOrder.xml file using well-formed XML, and automatically places it in the correct location. For more information about using Surface Configuration Editor to customize error and out-of-order screens, see Configuring Error and Out-of-Order Screens.

If your XML file contains any schema problems or if there are any problems with the images, the device displays the default wording or images instead.

The following code example shows a template for the SurfaceOutOfOrder.xml file. You can copy and paste this example as a starting point for your own SurfaceOutOfOrder.xml file. The following sections explain the important lines in detail.

<?xml version="1.0" encoding="utf-8" ?>
<OutOfOrder xmlns="http://www.microsoft.com/Surface/1.0/Shell/OutOfOrderSchema">
   <ErrorScreen>
      <PrimaryText>First error line</PrimaryText>
      <SecondaryText>Second error line</SecondaryText>
      <ImageFile>%SystemDrive%\path\filename</ImageFile>
   </ErrorScreen>
   <OutOfOrderScreen>
      <PrimaryText>First out of order line</PrimaryText>
      <SecondaryText>Second out of order line</SecondaryText>
      <Images>
          <ImageFile>%SystemDrive%\path\filename1</ImageFile>
          <ImageFile>%SystemDrive%\path\filename2</ImageFile>
          <ImageFile>%SystemDrive%\path\filename3</ImageFile>
          <ImageFile>%SystemDrive%\path\filename4</ImageFile>
          <ImageFile>%SystemDrive%\path\filename5</ImageFile>
          <ImageFile>%SystemDrive%\path\filename6</ImageFile>
          <ImageFile>%SystemDrive%\path\filename7</ImageFile>
          <ImageFile>%SystemDrive%\path\filename8</ImageFile>
          <ImageFile>%SystemDrive%\path\filename9</ImageFile>
          <ImageFile>%SystemDrive%\path\filename10</ImageFile>
          <ImageFile>%SystemDrive%\path\filename11</ImageFile>
          <ImageFile>%SystemDrive%\path\filename12</ImageFile>
          <ImageFile>%SystemDrive%\path\filename13</ImageFile>
          <ImageFile>%SystemDrive%\path\filename14</ImageFile>
          <ImageFile>%SystemDrive%\path\filename15</ImageFile>
          <ImageFile>%SystemDrive%\path\filename16</ImageFile>
          <ImageFile>%SystemDrive%\path\filename17</ImageFile>
          <ImageFile>%SystemDrive%\path\filename18</ImageFile>
          <ImageFile>%SystemDrive%\path\filename19</ImageFile>
          <ImageFile>%SystemDrive%\path\filename20</ImageFile>
      </Images>
   </OutOfOrderScreen>
</OutOfOrder>
ImportantImportant
Remember that XML is case-sensitive.

ErrorScreen

The ErrorScreen element and its sub-elements (PrimaryText, SecondaryText, and ImageFile) determine what is displayed when an error condition occurs.

Error screen - <Primary Text> and <Secondary Text>

The error screen appears if one of the following situations occurs:

  • Surface Shell fails several times.

  • Surface Shell could not be loaded.

  • The Windows 7 user interface has been suppressed several times.

  • User interface elements from a non-Microsoft Surface application could not be suppressed.

  • The Attract application could not be started.

PrimaryText and SecondaryText

The PrimaryText and SecondaryText elements specify the first and second line of error text, respectively. The space for this text is limited so you should test the text before you deploy the customized XML file. If the text is too long, your text is truncated. For information about how to test the text and images, see the "Testing Your Custom Error and Out of Order Screens" section.

You cannot change the font, font size, font color, position, or orientation of the text.

If you do not want to include one or both lines of the error text, leave the associated XML element empty. Do not omit the element. If you do not include the element, the default Surface error text is used.

ImageFile

The ImageFile element specifies the background image to use for the error screen. Make sure that the image file is in PNG (Portable Network Graphics) format and that the size is at least 1920 x 1080 pixels and no larger than 4096 x 4096 pixels.

OutOfOrderScreen

The OutOfOrderScreen element and its subelements (PrimaryText, SecondaryText, Images, and ImageFile) determine what is displayed when an out-of-order condition occurs.

Out-of-order - <Primary Text> and <Secondary Text>

The out-of-order screen appears if one of the following situations occurs:

  • An administrator has remotely logged on to the device.

  • Windows 7 does not finish an auto logon operation. (For example, this condition can occur when updates are installed silently and the device made for Surface is restarted, but no one puts the device made for Surface into Surface mode.)

  • A malicious user connects a keyboard and mouse to the device made for Surface and logs off Surface mode or switches to a different user.

By default, the out-of-order executable file (SurfaceOutOfOrder.exe) is registered as the screen saver.

PrimaryText and SecondaryText

The PrimaryText and SecondaryText elements specify the first and second line of the out-of-order text, respectively. The space for this text is limited so you should test the text before you deploy the customized XML file. If the text is too long, your text is truncated. For information about how to test the text and images, see the following "Testing Your Custom Error and Out of Order Screens" section.

You cannot change the font, font size, font color, position, or orientation of the text.

ImageFile

You can specify from 1 through 20 background images for the out-of-order screen. These images are shown in the order in which they are listed in your SurfaceOutOfOrder.xml file, slowly fading from one image to the next and then repeating. For horizontally positioned devices made for Surface, choose images that have no obvious orientation to avoid your out-of-order text from appearing upside down. If you do not specify an image file, the default background image is used.

Each ImageFile element specifies one background image to use for the out-of-order screen. Make sure that the image file is in PNG (Portable Network Graphics) format and that the size is at least 1920 x 1080 pixels and no larger than 4096 x 4096 pixels.

Testing Your Custom Error and Out of Order Screens

You should always test your new SurfaceOutOfOrder.xml file or any changes that you make to an existing SurfaceOutOfOrder.xml file before you deploy the XML file.

To test the error and out-of-order screens

  1. Log on to the device, or use Remote Desktop Connection to remotely connect to the device.

  2. To display the error screen, in a Command Prompt window, run "C:\Program Files (x86)\Microsoft Surface\v2.0\SurfaceOutofOrder", including the quotation marks. The error screen displays.

  3. To display the out-of-order screen, in a Command Prompt window, run "C:\Program Files (x86)\Microsoft Surface\v2.0\SurfaceOutofOrder" /s. The out-of-order screen or screens display.

Did you find this information useful? Please send us your suggestions and comments.

© 2011 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft