LocalDiagnosticPackage Complex Type

  • Article

Defines the manifest as a local troubleshooting pack.

<xs:complexType name="LocalDiagnosticPackage">
    <xs:sequence>
        <xs:element name="DiagnosticIdentification"
            type="dcmPS:DiagnosticIdentification"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="DisplayInformation"
            type="dcmPS:DisplayInformation"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="PrivacyLink"
            type="xs:string"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="PowerShellVersion"
            type="dcmPS:Version"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="SupportedOSVersion"
            type="dcmPS:SupportedOSVersion"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="Rootcauses"
            type="dcmPS:LocalRootcauses"
            minOccurs="1"
            maxOccurs="1"
        >
            <xs:unique name="No_local_rootcause_may_have_the_same_ID">
                <xs:selector
                    xpath="Rootcause"
                 />
                <xs:field
                    xpath="ID"
                 />
            </xs:unique>
        </xs:element>
        <xs:element name="Interactions"
            type="dcmPS:Interactions"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="ExtensionPoint"
            type="dcmPS:ExtensionPoint"
            minOccurs="1"
            maxOccurs="1"
         />
    </xs:sequence>
    <xs:attribute name="SchemaVersion"
        type="dcmPS:Version"
        use="required"
     />
    <xs:attribute name="Localized"
        type="xs:boolean"
        use="required"
     />
</xs:complexType>

Child elements

Element Type Description
DiagnosticIdentification [dcmPS:DiagnosticIdentification](package-diagnosticidentification-complextype.md) The identifier and version used to identify the pack.
DisplayInformation [dcmPS:DisplayInformation](package-displayinformation-complextype.md) The name and description of the pack.
ExtensionPoint [dcmPS:ExtensionPoint](package-extensionpoint-complextype.md) One or more extensions that the client supports. Used by the client to extend the functionality of the AdvDiagnosticPackage node. The MSDT client supports the following extensions:
Extension Description
HelpKeywords Specifies a single keyword. The extension contains the localized resource identifier for the keyword (for example, "@resource.dll,-123"). To specify multiple keywords, include a HelpKeywords element for each keyword.
The keywords are used only if the package fails. If the package fails and the user clicks Explore additional options, the keywords are used to find related information if the user then clicks Help and Support, Windows Communities, or Related Troubleshooters.
For Help and Support, the keywords are used in a logical OR operation and for Windows Communities and Related Troubleshooters, the keywords are used in a logical AND operation.
These keywords are used only if the root cause that failed does not specify keywords (see the ContextParameters child element of the [LocalRootcause](package-localrootcause-complextype.md) complex type).
Icon An icon to display next to the package. The Icon element contains the resource identifier for the icon (for example, "@resource.dll,-123").

Interactions [dcmPS:Interactions](package-interactions-complextype.md)

The interactions that the pack uses.
PowerShellVersion [dcmPS:Version](package-version-simpletype.md)

The minimum Windows PowerShell version required to run the pack.
PrivacyLink xs:string

The URL to the privacy information that tells the user how the data collected by your troubleshooting pack will be used.
Rootcauses [dcmPS:LocalRootcauses](package-localrootcauses-complextype.md)

The collection of root causes to detect, resolve, and verify.
SupportedOSVersion [dcmPS:SupportedOSVersion](package-supportedosversion-complextype.md)

The minimum operating system version on which the pack can run.

Attributes

Name Type Description
Localized xs:boolean Determines whether the strings specified in the manifest are resource strings (true) or literals (false). If true, all UI elements in the manifest must specify a resource identifier (for example, @resource.dll,-123). For localization details, see Localizing the Troubleshooting Pack.
SchemaVersion dcmPS:Version The version of the troubleshooting pack schema used to write this manifest. For Windows 7, the version is 1.0.

Remarks

A manifest that contains this node contains multiple troubleshooters and each troubleshooter detects a single root cause. WTP runs all the troubleshooters in the package in the order they are defined in the manifest. Because the troubleshooter scripts each focus on a single root cause, you can use the same script for troubleshooting and verification.

Requirements
Minimum supported client
 Windows 7 [desktop apps only]
Minimum supported server
 Windows Server 2008 R2 [desktop apps only]

See also

AdvDiagnosticPackage Element