“Out of Memory” Exception When Building Documentation

Overview

Some users may receive an error message about an 'OutOfMemory' exception while building documentation.  The error message will be similar to the following:

Unable to build documentation.  An error was encountered while merging XML documenation.  Exception of type 'System.OutOfMemoryException' was thrown.

This error is typical when large projects (or solutions with multiple projects) are being documented and the XML file that is generated for the documenter contains too much information.  To prevent the error, the size of the merged XML file must be reduced.

Solution

The primary solution is to remove source code from the generated document.  The inclusion of source code can cause signficant bloat to the size of the XML file used for documenting.

The Default setting is to include source code, so you will need to use the Custom setting to turn off the source code.  When using the Documenter Wizard, you will need to select 'Custom settings' on the 'Configuration Style' page.  On the 'General Options' page, you will then need to clear the box labeled 'Include source code' under the 'Other Settings' section.  This option is also available on the 'Documenter' tab of the Property Pages for the project.

Install and Configure Concurrent License Monitor

Overview

The Network License Monitor must be installed on a machine that will be accessible from other machines on the network that will need licenses managed by the Network License Monitor.  It may be installed either on a workstation or a server.

Installation Requirements

The Network License Monitor is built using Microsoft .NET Framework 3.0, so you must have that version of the framework or newer installed.  Any operating system that support that version of the .NET Framework may be used (i.e. Windows XP, Windows Vista, Windows 7, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, and newer versions of Client and Server OS).

A user with administrator access will need to be used to install the software and configure the license.  Elevated privileges will be required on operating systems with UAC enabled.

Installing the Software

The current release of the Concurrent License Monitor application should be downloaded from our Downloads page:

http://www.patterson-consulting.net/downloads/Default.aspx

To install the software, simply execute the ConcurrentLicenseMonitor.msi installer package and follow the on-screen prompts.

After the installation is complete, you will need to manually copy the license file (*.lic) to the installation folder of the Network License Monitor (i.e. C:\Program Files\Patterson Consulting\Concurrent License Monitor on 32-bit operating system, or C:\Program Files (x86)\Patterson Consulting\Concurrent License Monitor on 64-bit operating system).  Contact 'support@patterson-consulting.net' if you have not received your license file.  This file is typically called 'monitor.lic' or 'monitor.x.x.lic' (where the 'x' values represent a version of the monitor software, e.g. 'monitor.1.1.lic').

Applying the License and Verifying Functionality

To apply the license, you will need to start the Concurrent License Monitor GUI application.  You may do so by selecting the corresponding entry from the Program Files -> Patterson Consulting -> Concurrent License Monitor program files folder.

Upon launching the application, you will be prompted to register your software.  If you do not receive a registration prompt, your license is likely not configured properly or was not copied to the proper folder.

Complete the registration form by entering the serial number that was supplied along with your license and click Next.  This will display the activation screen.

The activation process will tie your serial number to the specific machine where you perform the activation.  In most cases, you may activate your software using our on-line activation server.  Otherwise, you will need to manually request an activation code.  Follow the prompts on the wizard interface to determine the 'Machine Code' for your installation.  E-mail that 'Machine Code' to 'support@patterson-consulting.net' and we will provide you with the corresponding 'Activation Code'.

Once registration is complete, you will see a log entry in the application indicating the status of the application monitor.  The log messages will include the TCP Port being used by the application and the details of the applications which are licensed to the monitor.  If you do not see this information along with entry 'Server Activated' in the log, your monitor is probably not working properly.  Ensure the TCP Port in the log is available for use.  Contact 'support@patterson-consulting.net' for additional assistance.

Changing the TCP Port

If you are unable to use the default TCP Port, you may change it.  Currently, the only way to modify the TCP Port is to edit the system registry.  Using a tool like 'regedit', locate the following registry key

HKEY_LOCAL_MACHINE\SOFTWARE\Patterson Consulting\Concurrent License Monitor

This key will have a string value called TcpPort.  Update the value in the registry and close the registry editing tool.  Stop/Restart the monitor using the Ribbon commands on the application and the monitor will use the newly defined port.

Firewall Protection

If your monitor is installed behind a software/hardware firewall, you will need to configure the TCP Port for access through the firewall.  Without access, clients will not be able to request a license.

Configuring the Client

You will be provided a license file for each client that will connect to the license monitor.  Follow the license instructions for the client to apply the license file.  When prompted, enter the name of the host running the network monitor and the TCP Port that has been configured for use (Default = 8085).

With the Concurrent License Monitor application running, attempt to launch a client application that is managed by the monitor.  The log will display connection attempts and license validation data.  If no request information is displayed in the log, verify the following:

  1. The client has been configured with the concurrent license file
  2. The client has been configured with the proper host name and TCP Port
  3. A firewall is not blocking the TCP Port on the server or the client

 

For more details on configuring the Client, refer to the following Knowledge Base article:

http://www.patterson-consulting.net/blog/post/Configure-Client-for-Concurrent-License

Installing Monitor as a Service

While the Concurrent License Monitor application provides some useful information about the activity of the monitor, it must remain running for clients to be able to request a license.  In most cases, the application is used to verify the monitor is running properly.  Once proper operation is complete, you may install the application as a Windows Service.

To install the service, select 'Install Service' from the Program Files group where the Concurrent License Monitor was setup, or execute 'InstallService.bat' from the application installation folder.  This will configure Windows to recognize the service.  The service will be listed as Patterson Consulting Concurrent License Monitor.  You will need to start this service in order to process license requests.  If necessary, contact your Windows administration group for details on configuring a service to start automatically and/or use a specific account for authentication.  If you ever experience issues processing licenses from the service, stop the service and launch the GUI-based application.  The log data in the application will help debug the issue.

Uninstalling Monitor as a Service

To uninstall the service, select 'Uninstall Service' from the Program Files group where the Concurrent License Monitor was setup, or execute 'UninstallService.bat' from the application installation folder.

HTML Help Compiler Error HHC6003

Some installations of the HTML Help Compiler will report the error code HHC6003 referencing file itircl.dll. In fact, QuickTest® Professional has a documented issue where this error is often received after installing QuickTest® Professional. This is typically caused by the itcc.dll file being missing or improperly registered. Check if the following file exists on your system:

C:\Windows\System32\itcc.dll

If it does not exist, use the links above to download and re-install the HTML Help Workshop. If it does exist, it probably just needs to be re-registered on your system. You can re-register the file by executing the following command from a Command prompt or the Run window.

regsvr32 C:\Windows\System32\itcc.dll

Note:   The exact path to the itcc.dll file may vary based on your system configuration.

Configure Client for Concurrent License

Overview

Test Design Studio offers a concurrent license model.  Under this model, you configure a Concurrent License Monitor application that is responsible for tracking the total number of licenses that are in use.  Each Test Design Studio client is then configured to request a license from the monitor application.  The steps below define how to configure the license.

Information You Need

In order to connect to the Concurrent License Monitor, you will need to know the host name of the monitor as well as the TCP port number that has been configured to listen to license requests.  The default port number is 8085.  You will also need a license file that was distributed to your company for use with the concurrent license monitor.  This file is typically called 'tds20.concurrent.lic'.
In summary, you will need:

  • Host Name of Concurrent License Monitor
  • TCP Port Number
  • License File

Step 1 - Install Test Design Studio

Install the latest release of the Test Design Studio application for which you have a license.  The same installer is used for any of the license models.  After installation is complete, launch Test Design Studio.

Step 2 - License Wizard


When you launch Test Design Studio without a license already configured, the License Wizard will be displayed.  Click the 'Next' button to continue.

Step 3 - Choose Your License Model


For the concurrent license model, you will be configuring the License File that was provided to your oganization.  Select the option for 'I Have a License File to Apply'.

Step 4 - Apply License File


In the space provided, specify the full path of the License File that was provided to your organization.  You may use the 'Browse...' button to help locate the file.  When the full path has been entered, click the 'Next' button to continue.

Step 5 - Concurrent License Configuration


Since your license file is based on a concurrent license model, you will need to provide the 'Host Name' and 'TCP Port' that correspond to your Concurrent License Monitor.  When the information has been entered, click 'Next' to continue.

Step 6 - License Validated


If all the information has been correctly entered, you will receive a 'License Validated' confirmation.  If you do not receive this confirmation, confirm that you entered the correct 'Host Name' and 'TCP Port' for your Concurrent License Monitor.

 

Blocked HTML Help Files

Overview

Since HTML Help files use HTML technology, there is a potential security risk opening and displaying the HTML content. Most newer releases of Internet Explorer will only allow you to open the file if it is stored locally on your machine (not on a remote drive). Unfortunately, the HTML Help system does not provide a meaningful error message.

When a file is being blocked, you will typically see a screen similar to the following:

To open the file, you will either need to copy it to your local hard drive or, if supported, unblock the file.

Unblocking a File

If supported by your system, you may be required to unblock a file before it can be viewed. To unblock a file, right-click the file icon and select Properties to display the Properties dialog for your file.

If your system supports it, you may see an Unblock button. Click this button to unblock the file.