XML Schema

Parent Previous Next

The following XSD schema may be used to validate XML files intended for use with the Environment Variables Wizard GUI.  The schema may also be found in the file SetEnvUIConfig.xsd in <BTDFInstall>\Framework\DeployTools.


<?xml version="1.0" encoding="utf-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

 <xs:element name="SetEnvUIConfig" nillable="true" type="SetEnvUIConfig" />

 <xs:complexType name="SetEnvUIConfig">

   <xs:sequence>

     <xs:element minOccurs="1" maxOccurs="1" name="DialogCaption" type="xs:string" />

     <xs:element minOccurs="1" maxOccurs="unbounded" name="SetEnvUIConfigItem" type="SetEnvUIConfigItem" />

   </xs:sequence>

 </xs:complexType>

 <xs:complexType name="SetEnvUIConfigItem">

   <xs:sequence>

     <xs:element minOccurs="1" maxOccurs="1" name="PromptText" type="xs:string" />

     <xs:element minOccurs="0" maxOccurs="1" name="Caption" type="xs:string" />

     <xs:element minOccurs="0" maxOccurs="1" name="PromptValue" type="xs:string" />

     <xs:element minOccurs="0" maxOccurs="1" default="true" name="PersistValue" type="xs:boolean" />

     <xs:element minOccurs="1" maxOccurs="1" name="ValueType" type="SetEnvUIValueType" />

     <xs:element minOccurs="1" maxOccurs="1" name="EnvironmentVarName" type="xs:string" />

     <xs:element minOccurs="0" maxOccurs="1" name="RadioPrompts">

       <xs:complexType>

         <xs:sequence>

           <xs:element minOccurs="1" maxOccurs="5" name="string" type="xs:string" />

         </xs:sequence>

       </xs:complexType>

     </xs:element>

     <xs:element minOccurs="0" maxOccurs="1" name="RadioValues">

       <xs:complexType>

         <xs:sequence>

           <xs:element minOccurs="1" maxOccurs="5" name="string" type="xs:string" />

         </xs:sequence>

       </xs:complexType>

     </xs:element>

   </xs:sequence>

 </xs:complexType>

 <xs:simpleType name="SetEnvUIValueType">

   <xs:restriction base="xs:string">

     <xs:enumeration value="Text" />

     <xs:enumeration value="Password" />

     <xs:enumeration value="FileSelect" />

     <xs:enumeration value="Checkbox" />

     <xs:enumeration value="RadioButtons" />

   </xs:restriction>

 </xs:simpleType>

</xs:schema>


Argument

Description

Caption

The text that appears after a Checkbox control

EnvironmentVarName

Name of the environment variable into which the value will be saved.  This name translates directly into an MSBuild property of the same name.  If you specify MY_SETTING here, then in your .btdfproj file you can reference $(MY_SETTING).

PersistValue

True to save the selected value to a settings file upon completion of the wizard, False to not save the value.  If a value is saved, then the next time the wizard is shown, usually in a second run of Deploy or Undeploy, the previously selected values will be pre-populated in the wizard.  When the MSI is uninstalled, the saved settings file is deleted.

PromptText

Specifies the text displayed for the wizard page that directs the user to take some action

PromptValue

Specifies the default value for the control: text for a Textbox, Password or FileSelect; true or false for a Checkbox

RadioPrompts

Specifies up to five radio button captions

RadioValues

Specifies the value to be saved to the environment variable when the corresponding radio button is selected. Must have the same number of elements as RadioPrompts.

ValueType

Specifies one of: Text, Password, FileSelect, Checkbox or RadioButtons


This is a common example of a default server deployment definition file (InstallWizard.xml).  This instance defines two wizard steps (two SetEnvUIConfigItem elements), each of which sets the value of a single environment variable (named in EnvironmentVarName).  The wizard caption/title is defined in DialogCaption.


<?xml version="1.0" encoding="utf-8" ?>

<SetEnvUIConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <DialogCaption>Deployment Framework for BizTalk Sample</DialogCaption>

 <SetEnvUIConfigItem>

   <PromptText>Select the XML file that contains configuration information:</PromptText>

   <PromptValue></PromptValue>

   <ValueType>FileSelect</ValueType>

   <EnvironmentVarName>ENV_SETTINGS</EnvironmentVarName>

 </SetEnvUIConfigItem>

 <SetEnvUIConfigItem>

     <PromptText>Is this the LAST server in the BizTalk Group you are deploying to?</PromptText>

     <Caption>This is the LAST server in the BizTalk Group</Caption>

     <PromptValue>true</PromptValue>

     <ValueType>Checkbox</ValueType>

     <EnvironmentVarName>BT_DEPLOY_MGMT_DB</EnvironmentVarName>

  </SetEnvUIConfigItem>

</SetEnvUIConfig>


This is an example that uses radio buttons for a single wizard page.


<?xml version="1.0" encoding="utf-8" ?>

<SetEnvUIConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <DialogCaption>Deployment Framework for BizTalk Sample</DialogCaption>

 <SetEnvUIConfigItem>

   <PromptText>Please select Debug or Release:</PromptText>

   <PromptValue>Rls</PromptValue>

   <ValueType>RadioButtons</ValueType>

   <EnvironmentVarName>DebugOrRelease</EnvironmentVarName>

   <RadioPrompts>

     <string>Debug</string>

     <string>Release</string>

   </RadioPrompts>

   <RadioValues>

     <string>Dbg</string>

     <string>Rls</string>

   </RadioValues>

 </SetEnvUIConfigItem>

</SetEnvUIConfig>


Created with the Personal Edition of HelpNDoc: Write EPub books for the iPad