You will use the Works with Tool to:
- Test your application and earn the Works with Windows Server 2008 R2 Logo.
- Test internal line-of-business and mission-critical applications for compatibility
- Test third party software prior to platform adoption, purchase, or consideration
- Milestone testing during development cycle
- Partner Program tests
Works with Tool is:
- Completely a Wizard based tool. No learning curve.
- Testing can be run on a virtual machine, a physical box or through remote access.
- Test Server and Client components for compliance and compatibility in under 2 to 4 hours.
- View comprehensive report and logs at any time during and after testing.
Server and Client components can be tested with the Works with Tool on x64 versions of:
- Windows Server 2008 R2 Enterprise
- Windows Server 2008 Enterprise
- Windows 7
- Vista Ultimate or Enterprise
Install all application prerequisites, prior to testing:
- Applications
- .NET
- IIS
- Devices and Storage depots
- Server Features and Roles
- etc.
The current Works with Tool is installed with the Software Certification Toolkit from the Works with Windows Server landing page, where you can:
- Download the Works with Specifications
- Download the Works with Test Framework
- Learn about Windows Server 2008 R2 and how to get started in the Logo Program
- Learn about other free tools and resources to use during your development cycle
Ready to begin testing
Follow the simple guides of the Wizard to name your Server or Client component. Click the appropriate component type radio button. Click Next. Etc.
Note any yellow highlighted textboxes throughout wizard with important information regarding requirements in other logo programs.
The Works with Tool has many uses and may show configuration status as a failure on the Prerequisite screen. Depending on level of testing being performed, the tool will allow you to continue test and ignore error warnings.
Focus of the following is the Works with Windows Server 2008 R2 Logo Program, and how to interpret your results.
When submitting an application for Windows Server 2008 R2 Logo, the Prerequisite screen must show all status as green, unless otherwise noted in yellow textbox.
Assure that the following status show as passing or are enabled for Windows Server 2008 R2:
- 64-bit Windows Server 2008 R2 or Windows 7
- Virtual Machine Status must show “Microsoft Hyper-V R2”
- Firewall
- IPv6
- Windows Error Reporting
Note: If Windows Error Reporting is listed as Disabled, do not click Next. In Windows Taskbar, Start/Search, type services.msc and hit Enter. Click through any UAC to launch Services Manager. On Right pane, Name column, locate Windows Error Reporting Service, and double click. Change Startup type: to Automatic or Manual. Click OK to close, then close Services Manager. On Prerequisite screen, click the F5 link to refresh.
Assure an Antivirus program is installed and running.
The Works with Tool performs all testing in the background, including monitoring the above prerequisites.
On Installer Information screen select either an MSI package, or setup executable. Alternately, if the application under test does not include an installer, you may select the appropriate radio button and include requested information.
At any time during the following screens, you may click View Report link to see current testing status and logs.
The tests performed are outlined in the Works with Windows Server 2008 R2 Test Framework.
Important: To qualify for Works with Windows Server 2008 R2 Logo, the Works with Tool must be used.
The Works with Tool will inform when to install, test, and uninstall the application. Rebooting may be necessary. The Works with Tool will allow you to resume a test at launch. Select this radio option, Select the proper test, and you will return to the last page prior to rebooting.
Between steps the tool may take a snapshot of the system. This may take a up to 15 minutes depending on speed, capacity, and resources of the system.
If your application contains drivers, you may be prompted to reboot to set up special driver testing during boot up and during primary functionality testing.
Client components: If the application contains client components, assure the Server components are operational, then follow the above steps on another machine to test Client components using Works with Tool. If client components were designed to run on a Server, then another Server can be used, otherwise run client components on Windows 7 64-bit. The client components will be used to exercise the Server components. Note that testing on a virtual machine is optional for clients running on Windows 7.
When testing is nearly complete, you will be presented with a series of quick, but important questions about the testing.
When testing is complete, a quick report will launch presenting the results of the tests, and testing status achieved.
If all tests show as a pass for the Logo Program desired, you will now create a Submission package which includes the test results from the Server components and any Client components from another machine. This can be created from the Finish screen or by launching the Works with Tool and selecting the Create Submission Package option.
These test results may now be submitted to the test vendor.
If submitting test results to a test vendor...
If you are ready to submit your test results to a test vendor for independent validation:
- Assure all tests are listed as Pass or documentation exists for each failure.
- Establish a Winqual Account that identifies your company with the Windows Logo Program.
- If the application contains drivers, then all Drivers must have passed separate WHQL testing as well. Please submit your WHQL Submission ID.
- Provide Microsoft Pre-approved Waivers. (Only granted on a limited basis.)
- Provide documentation for 3rd party file failures to test vendor. Include all failing 3rd party file names installed found by Works with Tool and file owners in publicly facing documentation. Waivers not required.
- See the Works with page for details on above steps and on how to select a test vendor.
When submission package has been validated by test vendor, you will be granted the use of the Works with Windows Server 2008 Logo artwork. See the Innovate On web site for benefits associated with each Logo Program.
Interpreting the Logs from Works with Tool
Since the Works with program is one of self testing, you will be interpreting the test logs generated.
Help can be had on the dedicated MSDN Forum for Windows Server 2008 Application Compatibility and Certification issues. There you will find Windows experts, as well as a community of developers and Independent Software Vendors helping each other with the new operating system and Logo program requirements.
Below are the most common issues encountered when attempting to interpret your own logs. Most are common to many of the test case logs, so they do not bear repeating for each log. The Works with Tool has built in intelligence to automatically remove noise from the logs and allowed failures.
Interpreting log failures:
3rd party files
Definition: Any file not part of your build process, and not owned by your Product group or Company.
If these files do not have signatures or valid file properties, these files will fail the test case, but will NOT block achieving Works with designation.
Do not sign files that do not belong to your Product group or Company.
Do not assign file properties to files that do not belong to your Product Group or Company.
Document, no waiver required.
Documentation must include all 3rd party file names and owners which appear as failing the test cases.
Documentation must be publicly facing for the use and convenience of your Customers: ReadMe, FAQ, Product manual or webpage
Documentation must be provided to test vendor upon submission.
Temporary files
Files in all temp folders that are expected to be deleted by Windows can be safely ignored.
Temp folders:
- Temp IIS, ASP, ASP.NET folders (transient files, or created on the fly, and expected to be deleted)
- Temp .NET folders
- Temp Java folders
- Temp Windows Installer folders (example: x:\Windows\Installer, many icon files appear here as 16 bit executables.)
Any temp files not automatically ignored by the Works with Tool may fail the test case, so must be documented as temporary files on which the application does not have a dependency. No waiver required.
Interop files
Interop files do not contain file properties, by design.
This known by Microsoft, no documentation required, and ignored by the Works with Tool.
If built and owned by Product group or Company, Interop files should be signed as a best practice, but will not fail the Works with test.
Files using known binary extensions
Some (text, log) files used by application using known binary extensions must document these extensions. (Example, .sys, .bat, .com, etc.)
For instance, a text log file extension of .com may be improperly labeled a 16 bit binary.
Internal Consistency Evaluators (ICE) Errors or Warnings in MSI packages
ALL ICE Errors appearing on logs must be fixed.
See ICE Error reference MSDN page for guidance on fixing.
ICE Warnings do not require a fix. All Warnings should be investigated, and as a best practice, should be fixed.
These are the ICE errors being validated in Works with Tool:
- (ICE) 1-2, 4-7, 9-15, 17-24, 27-29, 31, 33-36, 38, 40-42, 44-56, 59, 61-63, 65, 67-71, 74-78, 81-84, 86-87, 89-94, 96-105
Package Identity
Windows Installer packages must comply with ICE validation as well as identify installer package and properly prepare for upgrade.
To Pass this test case the Property Table and the Upgrade Table must contain:
Property Table:
- Manufacturer
- ProductCode
- ProductLanguage
- ProductName
- ProductVersion (major and minor)
Upgrade Table:
- UpgradeCode
- VersionMin (Major.minor.build)
- VersionMax (Major.minor.build)
The UpgradeCode in the Upgrade table must be identical to the UpgradeCode in the Property table.
VersionMin and VersionMax: BOTH cannot be null.
Custom Actions
Custom table starting with MSI : MsiSFCBypass or MsiDriverPackage
- These can be safely ignored. No Waiver required. These are allowed MSI Prefixed Standard Tables.
16 bit files found
Some installer programs create an icon file with an .exe extension. These will be flagged as failures, and appear as 16 bit files to Work with Tool.
If these are found in the C:\Windows\Installer directory or similar User redirected folder, these are considered to be installed into a temporary directory and will be automatically ignored by the Works with Tool.
Be sure you do not own any files you list as 3rd party.
No Installer, No Windows executables
The Windows Server Logo Program will evaluate on a case by case basis any application which has no installer, and installs no Windows executables.
The Logo Program requires a Waiver be filed for failure in the Works with 2008 R2 Report labeled: “Were any binaries installed for this Component?”
The ISV must document:
- All major components installed
- Their interaction with specific hosted application(s) or Windows feature(s)
- Any other prerequisite software installed and versions
- Submit waiver to wslogofb@microsoft.com
With no other failures in the Works with logs, there should not be any issues in achieving the Works with Logo.
The Logo Program will review only complete waivers and respond with Microsoft approval to proceed with submission.
Waivers
As mentioned earlier, there will be very limited Waivers granted.
Examples: Logo Tool errors, Windows limitation, or technical documentation exists why no other workaround existed for exemption (very limited).
When Waiver is necessary, it must be sent to Microsoft for pre-approval, prior to sending submission package to test vendor. R2 Waiver document can be downloaded from Works with web site.
Waivers are not required when only documentation is sufficient to detail test case issues as mentioned above.
Hope the above is helpful,
-PaulS