Repository files navigation

An Out-of-the-Box Experience like user interface for Operating System Deployments

A PowerShell Driven UI that looks and feels like Windows 10 OOBE. Used in SCCM/MDT TaskSequence Bare-metal deployments

To support the UI in windows PE, these features must be installed:

• DISM Cmdlets
• Microsoft Data Access Component (MDAC/ADO) support
• Windows PowerShell

The recommended command to run the UI is:

Work-In-ProgressThe UI is designed o look and feel like Windows 10 OOBE startup wizard but with more control

"%DEPLOYROOT%\tools\%architecture%\ServiceUI.exe" -process:TSProgressUI.exe"%SYSTEMROOT%\System32\WindowsPowerShell\v1.0\powershell.exe" -ExecutionPolicy Bypass -Sta -File"%SCRIPTROOT%\Custom\OSDOOBEUI\OSDOOBEUI.ps1"

The UI is designed to be a single page with the option to add an additional app page if needed. The UI will look like this:

"%DEPLOYROOT%\tools\%architecture%\ServiceUI.exe" -process:TSProgressUI.exe"%SYSTEMROOT%\System32\WindowsPowerShell\v1.0\powershell.exe" -ExecutionPolicy Bypass -Sta -File"%SCRIPTROOT%\Custom\OSDOOBEUI\OSDOOBEUI_SinglePage.ps1" -ConfigPath OOBEUIWPF.config

• Splash screen: can be enabled or disabled by the config file. The splash screen is useful when hiding the PowerShell window screen while the UI is loading and task sequence progress bar

All settings are configurable within theOSDOOBEUI.config file

• Logo1Position[string]; Changes the position of the logo in menu. Options: Left, Right, Both, Hidden; default is Left.
• Logo2Position[string]; Changes the position of the logo in menu. Options: Left, Right, Both, Hidden; default is right
• Logo1File[string]; Location where log file exists. (Recommend size is 100x100)
• Logo2File[string]; Location where log file exists. (Recommend size is 100x100)
• FormVariable[string]; Set the variable used for the Object sin XAML. No need to change
• VerboseMode[Boolean]; Output verbose messages to PowerShell window
• DebugMode[Boolean]; Output additional messages to PowerShell window
• Test mode[Boolean]; Does not show the menu, just runs all functions and menu itemsAfter menu is played/started, run these commands in PowerShell to trigger validation tests:

$OSDOOBEUI_txtComputerName.text='ADPROD12345PAW'$ComputerNameObject=$OSDOOBEUI_txtComputerName        Validate-ComputerNameRules$ComputerNameObject

• BackgroundColor[string];Changes the main background color of the UINOTE: Buttons are not changeable. Recommend keeping background a blue tone

• [Still Testing] SinglePageOnly[Boolean]; Display the UI as a single page. App page can be enabled if set to true
• ShowAppSelection[Boolean]; Display the App page (used for both single and multi page UI's)

• [Still Testing] AutoGenerateName[string]; Auto generates name based option selected[AD, SQL or Locale, disabled]. Using a SQL table and AD, name will be autogenerated and validated, Locale uses local config from network locale

• [Still Testing] GenerateNameMethod[string]; Auto generates name based option selected _[AD, SQL,ODJFile,ODJBlob,Locale,TSEnv,Clear].

• [Still Testing] GenerateNameSource[string]; Used only with ODJ set in GenerateNameMethod Property; specifies location to pull ODJ file. Path can be a local, network share, or a URL (Will use invoke method). ODJ file path will search for odj files that follow the naming format. Must be named:.odj. Using a SQL table and AD, name will be autogenerated and validated, Locale uses local config from network localeNOTE: ODJ set custom properties: ODJ_FilePath,ODJ_BlobData

• OverWriteUIControlByTS[Boolean]; Determines if tasksequence controls the UI vs Config (only changes UI_Control section)TS variables needs to mirror control but with UI prefix added (eg. <Control_ShowSplashScreen>True</Control_ShowSplashScreen> -> UIControl_ShowSplashScreen=True)

• ShowSplashScreen[Boolean]; Display splash screen prior to menu loaded. Hides verbose command window

• ShowSiteCode[Boolean]; Displays site code. Site code can be changed is displayed

• ShowSiteListSelection[Boolean]; Dropdown of all sites with site ID and site Code(if exists)

• EnableNetworkDetection[Boolean]; Select site locales based on current IP

• ValidateNameRules[Boolean]; Uses Generation Rule Sets to ensure name is valid. Does not check if name is available on domain

• ShowClassificationProperty[string]; Displays classification property in Identity field with appropriate color based on device name (Values to choose from: Id,Level,Type,None)

• ShowDomainOUListSelection[Boolean]; Dropdown to select the OU to join to. Can be controlled by site locale

• AllowCustomDomain[Boolean]; If enabled the domain field is a fillable textbox, if disabled the domain field is a dropdown (populated by Locale Domain Info)

• AllowWorkgroupJoin[Boolean]; If set to false, the workgroup option is filtered out.

• AllowSiteSelection[Boolean]; Enables the ability to change the Site ID from selection list (Must have ShowSiteListSelection enabled)

• FilterAccountDomainType[string]; Set this value to match a Locale Domain Type property. If set, the matching domain by classification will be filled in for the account domain

• FilterDomainProperty[string]; Value is used when matching domain property to classification id property. Currently supports only classification id filter.

• AllowRuleBypassModeKey[string]; If set, the validation rules can be bypassed by pressing shift before clicking validate. This allows custom names. Other validations are still checked

• HideDomainList[Boolean]; If this is set to true, the domains fields will be hidden and no validation or variables will be set; overwrites ShowDomainOUListSelection

• HideDomainCreds[Boolean]; If this is set to true, the credential fields will be hidden and no validation or variables will be set-->

AllowRuleBypassModeKey screenshot

This is highly configurable and can have up to 5 areas. Please read theconfig file for more details

The varname can be renamed. however keep theID the same

• IDMachineType[table]; Value is controlled based computer name field (eg.;ADPROP12345PAW").

example:

<rulesetsId="Id1"Name="Machine Type"VarName="IDMachineType"MustExist="True" >    <ruleChar="A"Name="Administrative"VarValue="Admin" />    <ruleChar="D"Name="Developer"VarValue="Developer" />    <ruleChar="R"Name="Training"VarValue="Training" /></rulesets>

• IDFormFactor[table]; Value is controlled based computer name field (eg.ADPROP12345PAW").

example:

<rulesetsId="Id2"Name="Form Factor"VarName="IDFormFactor"MustExist="True" >    <ruleChar="D"Name="Desktop"VarValue="Desktop" />    <ruleChar="H"Name="Virtual Desktop (VDI)"VarValue="VDI" />    <ruleChar="L"Name="Laptop"VarValue="Laptop" />    <ruleChar="U"Name="Virtual Machine"VarValue="VM" /></rulesets>

• SiteID[stable]; Value is controlled based computer name field (eg.ADPROP12345PAW").

example:

<rulesetsId="Id3"Name="Site Identifier"VarName="SiteID"MustExist="True" >    <ruleName="Local Sites"GetVariable="MenuLocaleSiteList"MatchProperty="ID"DisplayProperty="BaseLocation"SetVariable="SiteID" /></rulesets>

• IDMachineClass[table]; Value is controlled based computer name field (eg.ALDTLAB123456PA). Value is determined by the first and/or second digits.

example:

<rulesetsId="Id4"Name="Machine Class"VarName="IDMachineClass"MinCharIdentifier="5"MustExist="True" >    <ruleChar="0#####"Name="Corporation"VarValue="Corp" />    <ruleChar="1#####"Name="Laboratory"VarValue="Lab" /></rulesets>

• IDMachineRole[table]; Value is controlled based computer name field (eg.ALDTLAB123456PA). Value can be Null. Variable name can be changed in ruleset'sVarName property

example:

<rulesetsId="Id5"Name="Role Identifier"VarName="IDMachineRole"MustExist="True" >    <ruleChar="dPAW"Name="Privilege Access Workstation"VarValue="PAW" />    <ruleChar="SSW"Name="Security Access Workstation"VarValue="SAW" />    <ruleChar="JMP"Name="Jump Box Workstation"VarValue="JMP" /></rulesets>

If enabled, list is pre selected based on Computer Machine AS Rule; Searches for Type

example:

<Locale_Classifications><classificationId="Prod"Level="Confidential"Type="Confidential"Color="Green"  /><classificationId="Lab"Level="Laboratory"Type="Laboratory"Color="Yellow"/></Locale_Classifications>

Value is controlled based on dropdown field or by computer name value and when Validate is pressed. Not all options are present:

example:

<Locale_Domains><domainName="LABD"FQDN="lab.contoso.com"ClassId="Lab"Type="Join" /><domainName="PROD"FQDN="prod.contoso.com"ClassId="Prod"Type="Join" /><domainName="PROD"FQDN="prod.contoso.com"ClassId="Prod"Type="Auth" /></Locale_Domains>

If enabled, this list will poplulate a dropdown based on site selected

example:

<Locale_DomainOUs><OUName="Lab"Domain="LABD"LDAPOU="OU='Test',OU='lab',DC='contoso',DC=com"ClassId="Lab" /><OUName="Production"Domain="PROD"LDAPOU="OU='Systems',OU='Prod',DC='contoso',DC=com"ClassId="Prod" /></Locale_DomainOUs>

Value is controlled based on dropdown field or by computer name value and when Validate is pressed. Not all options are present:

example:

<Locale_SitesDisplayFormat="&lt;id&gt; -&lt;Baselocation&gt;"SiteCodeFormat=" _[&lt;SiteCode&gt;]" >    <siteID="LAB"BaseLocation="Laboratory Site, USA"TZ="MST"Region="US"SiteCode="LAB"Domain="LABD" />    <siteID="PRO"BaseLocation="Production Site, USA"TZ="CST"Region="US"SiteCode="PRO"Domain="PROD" /></Locale_Sites>

If enabled, it will match the IP subnet with the Site code and preselect the option in the UI

example:

<Locale_NetworkDetection>    <NetworkSiteId="TEST"CidrAddr="192.168.1.0/24" />    <NetworkSiteId="SITEB"CidrAddr="10.11.0.0/24" />    <NetworkSiteId="SITEA"CidrAddr="10.21.0.0/24" /></Locale_NetworkDetection>

<Menu_AppButtons><itemid="1"Name="Update Microsoft Office"TSvar="MSO13"DefaultEnabled="No"Desc='This will attempt to install updates for office if detected. This can prolong the deployment' />    <itemid="2"Name="Install Microsoft InfoPath"TSvar="MSOIP"DefaultEnabled="Yes"Desc='InfoPath 2013 is a forms-creation and data-gathering tool that helps organizations streamline business processes' />    <itemid="3"Name="Install Adobe Reader DC"TSvar="ADRDC"DefaultEnabled="No"Desc='Install Adobes PDF reader instead of using Windows built-in PDF reader' /><itemid="4"Name="Install Mozilla Firefox"TSvar="MOZF"DefaultEnabled="No"Desc='A browsers that supports specific DoD websites' /><itemid="5"Name="Install Google Chrome"TSvar="GCE"DefaultEnabled="No"Desc='A browsers that supports specific DoD websites' /><itemid="7"Name="Run GPO Script"TSvar="SCRIPT1"DefaultEnabled="No" /><itemid="8"Name="Add CMtrace"TSvar="SCRIPT2"DefaultEnabled="Yes"Desc='A tool that was created by Microsoft to view their "*.log" live and works in different environments.'/></Menu_AppButtons>

If a task sequence is detected, the output will be a TS variable

• OSDComputerName[string]; value is what is in field
• OSDNetworkJoinType[0]; set only if domain name field is a string other thanworkgroup
• OSDJoinType[workgroup, domain]; set todomain if domain field is a string other thanworkgroup
• OSDDomainName[string]; value is what is in field
• OSDDomainOUName[LDAP string];
• OSDJoinDomainOUName[LDAP string];
• OSDJoinAccount[string];
• OSDJoinDomainName[string];
• OSDJoinPassword[string];
• CMSiteCode[string]; if enabled in configuration the site code is a 3 character string
• TimeZone[[integer];
• OSDTimeZone[time zone];
• TimeZoneName[time zone];
• OSDWorkgroupName[workgroup]; only available when typing inworkgroup in the domain field
• OSDJoinWorkgroupName[workgroup]; only available when typing inworkgroup in the domain field
• OSDLocalAdminPassword[string];
• TimeZoneName[string];

Here are some screenshots or errors presented in UI