XMetaL® Developer 12.0 Install Readme

Important Digital Signature Changes

Effective January 1, 2016, Microsoft has mandated that software vendors digitally sign their products using the SHA256 algorithm. All XMetaL 11.0 and newer products are signed using the mandated SHA256 algorithm. As a result of using this new signing algorithm, attempts to install the software on older unsupported Windows systems such as Windows XP will fail. Please confirm the system requirements are met.

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 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 10
  • Windows 8
  • Windows 8.1
  • Windows 7
  • Windows Vista

In addition, your system must have the following, or higher:

  • 450-megahertz (MHz) Pentium II-class processor, 600-MHz Pentium III-class processor recommended
  • Super VGA (1024 x 768) or higher-resolution display with 256 colors
  • 1 GB of available disk space (including 800MB required for XMetaL Author Enterprise and XMetaL XMAX)
  • 40 MB extra available disk space during installation

Required Memory:

  • 320 MB of RAM

XMetaL Developer runs on the following operating systems:

  • Windows 10, Windows 8/8.1, Windows 7, Windows Vista, provided user account has administrator privileges and UAC is disabled (as required by Visual Studio)

Before you begin

Prior to installing XMetaL Developer, you must have already installed Microsoft Visual Studio, preferably 2012 or newer.

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. v12.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 12.0.

Note: If you plan on using the XMetaL Java API Toolkit included with XMetaL Developer, it's recommended that you install the Oracle JRE before installing XMetaL Developer.

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 for Visual Studio 2012 and newer:

  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 (x86)\XMetaL 12.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.

To install these guides successfully with UAC disabled, follow these steps for Visual Studio 2010:

  1. Launch Visual Studio.
  2. Choose Help.Manage_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 (x86)\XMetaL 12.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.

Installing Microsoft Internet Explorer

You must have certain components of Microsoft Internet Explorer, version 10 or above, installed on your PC in order for XMetaL Author to function.

At the start of the XMetaL Author installation, you will be warned if Internet Explorer is not installed, or if the version that is installed is an older incompatible version, and you will be given the option to install it.

You can also go to this web site: http://www.microsoft.com/windows/ie/default.htm and download the latest version of Internet Explorer. Internet Explorer is language-specific; if you are using a non-English version of Windows, make sure that you download the version (plus service pack if required) that applies to your system.

Updates to MSIE

Microsoft regularly provides updates to their software. We strongly recommend that you visit Microsoft's web site to get any patches or updates to Microsoft Internet Explorer.

Installing Microsoft Data Access Components

The XMetaL Database Import wizard requires Microsoft Data Access Components (MDAC) to be installed on your PC in order to function.

At the start of the XMetaL Author Enterprise installation, you will be warned if MDAC is not installed, or if the version that is installed is an older incompatible version, and you will be given the option to install it.

You can also launch the MDAC Installer from your XMetaL CD (in the redist folder). Alternatively, you can go to the Web site http://msdn.microsoft.com/en-us/data/aa937730 and look for "MDAC 2.1.2.4202.3 (GA) Typical install for x86" or greater (later versions are referred to as RTM instead of GA).

The Database Import wizard will not function unless these components are installed before XMetaL Author Enterprise is installed. If you have already installed XMetaL Author Enterprise, and the Database Import wizard fails with one of the following errors:

Automation server can't create object
ODBC Driver manager: Failed to load resource DLL odbcint.dll

then you should uninstall XMetaL, make sure the required components are installed, and then re-install XMetaL.

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 nn.n\Common7\IDE.

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

XMetaL Author displays script error messages at startup after uninstalling XMetaL Developer 9.0

Due to bugs within the XMetaL Developer 9.0 installer, certain registry entries are removed by mistake. To fix this issue, goto the Add/Remove programs control panel and repair the XMetaL Author installation.

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.

Program entry left-over after upgrading to XMetaL Developer 12.0

After you upgrade to XMetaL Developer 12.0, you may see a program entry in Add/Remove programs left-over from a previous version. You can safely remove the old program entry and ignore any error messages given.

Debug session doesn't exit after quiting XMetaL when using Visual Studio 2008 and earlier

When debugging a customization using Visual Studio 2008 or older, the debug session does not end after quiting XMetaL. In order to work around this issue, simply "Stop Debugging" from the Debug menu.

Debugging customization hangs

Confirm that XMetaL Author (xmetal.exe) is version 12.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.

DLL unregistration error

Symptom

Dialog boxes displaying the following unregistration errors might appear during uninstallation of XMetaL Developer 4 (if you are uninstalling XMetaL 4 prior to installing XMetaL 12.0):

Error 1905. Module "C:\Program Files\Corel\XMetaL 4\Developer\Bin\XMWizard.dll" failed to unregister. HRESULT...
Error 1905. Module "C:\Program Files\Corel\XMetaL 4\Developer\Bin\DTDDataProvider.dll" failed to unregister. HRESULT...
Error 1905. Module "C:\Program Files\Corel\XMetaL 4\Developer\Bin\CTMDataProvider.dll" failed to unregister. HRESULT...
Cause

Uninstalling the core XMetaL Developer after uninstalling an XMetaL Service Pack causes the error.

Workaround

You can safely ignore the unregistration errors.

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.

Activating IntelliSense for XMetaL Developer

To activate IntelliSense for XMetaL Developer

Please add a reference to the group by do the following:

  1. Launch Visual Studio 2012 or newer.
  2. Goto the Tools menu and select Options...
  3. In the listbox of options, select the Text Editor\JavaScript\IntelliSense\References option.
  4. In the Reference Group dropdown, select the Implicit (Web) group.
  5. Click the [...] button and navigate to %PROGRAMFILES%\XMetaL 12.0\Developer\Help folder and select the XMetaL.IntelliSense.js file.
  6. Click the Add button to make XMetaL.IntellSense.js file part of the Included Files for Visual Studio IntelliSense.
  7. Optional: To make the XMetaL intellisense appear first, click the Up Arrow button repeatedly until the XMetaL.IntellSense.js file is first in the Included Files listbox.
  8. If you are using Visual Studio 2017, you must also do the following to disable the new JavaScript language service:
    • Goto the Tools menu and select Options...
    • In the listbox of options, select the Text Editor\JavaScript/TypeScript\Language Service\General option.
    • In the Language Service section, uncheck the Enable the new JavaScript language service.* option.

For more information on setting up Visual Studio IntelliSense, see this MSDN page.