XMetaL® Developer 19.0 (x64) Install Readme

Important License Changes

With the release of version 9.0, the software no longer requires an Internet connection to register or unregister a per-seat license. A new license file (e.g. XMDE.lic) is required to activate this software.

Note: Older .lic files are incompatible with this version.

Contact your JustSystems Sales representative if you have further licensing-related questions.

Installation Notes

System Requirements

XMetaL® Developer is a plug-in to Microsoft® Visual Studio®. Your system must have one of the Microsoft Visual Studio 17.x standard language products, e.g., Microsoft Visual Basic® .NET Standard, or alternatively Visual Studio .NET Enterprise or Professional versions installed prior to installing XMetaL Developer. See https://www.visualstudio.com/.

Your operating system must meet the system requirements for Visual Studio for your particular Windows version. XMetaL Developer supports the following:

  • Windows 11
  • Windows 10

XMetaL Developer runs on the following operating systems:

  • Windows 11/10, provided user account has administrator privileges.

Before you begin

Prior to installing XMetaL Developer, you must have already installed one of the following Microsoft Visual Studio development environments:

Visual Studio 17.x (x64) (2022) Professional Edition, Enterprise Edition or free Community Edition.

With newer versions of Microsoft Visual Studio, the Microsoft Help feature is not installed by default. Please insure this feature is installed in order to view the XMetaL Programmer's and Customization Guides.

This version of XMetaL Developer can only be installed beside like versions of XMetaL Author and XMetaL XMAX (i.e. v16.0).

If you are upgrading from a previous release, you need to run Add/Remove Programs and remove any previous versions of XMetaL Developer before you install XMetaL Developer 19.0 (x64).

Licensing and Product Registration

Activating your XMetaL Developer software is required in order to be fully licensed to use the software. The license information required for activation is provided by a license file.

When XMetaL is started without a full license, you will be prompted with three options:
  • Activate - Allows you to select a license file. Choose this option if you have been supplied with a license file (e.g. XMDE.lic).
  • Continue Trial - Allows you to continue with the trial version of XMetaL. The trial lasts 30 days from the time of installation.
  • Exit - Closes XMetaL.

Installing XMetaL Developer

To install XMetaL Developer

  1. Via Add/Remove programs, uninstall the previous version of XMetaL Developer if present.
  2. Run the downloaded .exe file (or setup.exe if you received XMetaL on disk) from Windows Explorer or from the Windows Run dialog. The installer setup program must be run as an administator.
  3. Click Install XMetaL Developer. This launches the installer.
  4. Proceed with the installation, following the on-screen directions.

Programmer's Guide and Customization Guide not accessible because Microsoft Help feature not installed

With newer versions of Visual Studio, you must enable the option which installs the Microsoft Help feature in order to view the XMetal Customization and Programmer's Guide content.

Please re-run the Visual Studio installer to modify its installation to include the Microsoft Help feature. After the Microsoft Help feature is installed, you can either re-run the XMetaL Developer installer to repair its installation which will add the XMetaL help guides. Or, you can use Visual Studio's Help Manager's features to manually add the XMetaL help guides (see next section below).

Programmer's Guide and Customization Guide installation may fail when UAC Enabled

The XMetal Developer installer includes an automated script for integrating the Customization Guide and Programmer's Guide into Visual Studio. This automated script will not complete successfully if UAC is enabled.

To install these guides successfully with UAC disabled, follow these steps:

  1. Launch Visual Studio.
  2. Choose Help.Add_and_Remove_Help_Content... and the Microsoft Help View window should appear.
  3. Click the Manage Content tab.
  4. Change the Installation source selection to Disk.
  5. Click the [...] button to browse to location when XMetaL Developer manifest is installed (typically the C:\Program Files\XMetaL 19.0\Developer\Help\v2.0\helpcontentsetup.msha file).
  6. Click Add action for new entry.
  7. Click the Update button. A popup certificate will appear. Click OK to continue with registration of XMetaL help.

Reinstalling or uninstalling XMetaL Developer

You can re-run the installer by selecting XMetaL Developer from the Add/Remove Programs Control Panel.

If you have already installed XMetaL Developer, the installer presents various options if you run it again, including the option to uninstall XMetaL Developer. See the section Maintenance installations below for more information.

Document viewers

Viewers for PDF documents are available at the following locations:

PDF: http://www.adobe.com/products/acrobat/readermain.html

After installation

After the installer is finished, you may be asked to reboot your system prior to launching XMetaL Developer for the first time. If you do not, you may experience unpredictable behavior.

Maintenance installations

You can perform various additional installation tasks after you have installed the product. For example, you might want to do one of the following:

  • Repair already installed components
  • Uninstall the entire product

Note: In order to be able to perform maintenance installations (except for the 'Remove' option), you will need to have the files that you unpacked during the initial installation still available. If you installed from a CD you will need the CD media again.

To access the Maintenance installer

  1. Choose Control Panel from the Start menu.
  2. Double-click Add/Remove Programs.
  3. Select XMetaL Developer.
  4. Click Change.

    If you have already successfully installed this version of XMetaL Developer, you will see a dialog box that gives you three options: Repair or Remove.

  5. Select an option and click Next.

Repair

Select Repair if you suspect that the currently installed product has become corrupted in some way. Repair will reinstall the same set of components that were installed in the previous installation.

Note: Any files that you downloaded must still be available on your hard drive if you choose this option.

In some cases there may be two or more choices that the installer can make when installing certain components. In this situation a dialog box appears asking for your preference.

Remove

  1. Select Remove if you want to uninstall the complete product. Click Next.
  2. Click OK, then wait while XMetaL uninstalls.
  3. Click Finish .
  4. Reboot your computer.
  5. At the DOS command prompt, run the command: 
    devenv.exe /setup
    Note that devenv.exe is normally found in C:\Program Files (x86)\Microsoft Visual Studio\**n\Common7\IDE x86 platform or C:\Program Files\Microsoft Visual Studio\**n\Common7\IDE x64 platform.

Notes about uninstallation

  • It is recommended that you reboot the computer prior to uninstalling XMetaL Developer. This ensures that the XMDbgSvr.exe is not running or in use prior to uninstalling the software. Not doing so beforehand may result in a "Files in use: XMDbgSvr" message to appear.
  • Uninstalling XMetaL Developer may damage the installation of XMetaL Author. If you uninstall XMetaL Developer and leave XMetaL Author on your system, you must run the XMetaL Author installation program and select the Repair option.
  • This removes all product files (except for files that exist in the WINSYS folder and which may be shared by other products), product shortcut icons, and product registry settings that were created when the product was first installed.

Other types of User Data, which might be files that were created directly by the user or that contain user preferences that a customer may wish to re-use in a later version installation, are not removed at uninstallation time. If you wish to remove them you must remove them manually after uninstallation has completed. Such files may exist here:

  • Files that the user has created directly in the XMetaL Developer installation folder

Installation issues

Running a form using XFLayout has script errors

When running a form with the XFLayout program, script errors may occur if a script is executed that references XMetaL Author or XMAX top-level objects such as ActiveDocument or Selection. This is a known issue and can be worked around by running the form via XMetaL Author or XMAX directly. With the x64 version of XMetaL products now available and the XFLayout program being only 32-bit, it was necessary to stop injecting top-level objects when running a form.

Upgrading XMetaL Developer xx.x

Upgrading to XMetaL Developer version xx.x may not automatically remove the previous version. If this happens, go to the Windows Control Panel, under "Programs and Features" or "Add or Remove Programs," and run the "Remove" command for the original version of XMetaL Developer. Ignore any error messages that appear during the upgrade or removal process.

Debugging customization hangs

Confirm that XMetaL Author (xmetal.exe) is version 16.0 or higher. If the version is lower, download the latest XMetaL Author Enterprise software (available at the same ftp link as before), uninstall your current version and reinstall the newly download software.

Installing XMetaL without Administrative Privileges

The XMetaL Developer Installer Setup program will warn you if you do not have sufficient privileges to perform the installation (e.g., if you are logged in as a normal or restricted user). The solution is to install XMetaL Developer by logging in as a User who has Administrative privileges.

Anti-virus program interference

Anti-virus programs sometimes interfere with the installation process, causing the installer to hang, usually within a short time after it starts up. If you encounter this problem, and you have any type of anti-virus program installed on your computer, disable it while you are installing XMetaL.