Installing the Package for Microsoft .NET

Overview

This chapter explains how to install, upgrade, and uninstall Package for Microsoft .NET . The instructions use the Installer and the Uninstaller wizards. For complete information about the wizards or other installation methods, or to install other webMethods products, see the Installing IBM webMethods Products On Premises for your release.

The Package for Microsoft .NET contains three elements that can be installed individually. Install each one on the same host as the product with which they interact:

This element... Needs to be installed with...
Package for Microsoft .NET Integration Server
webMethods for Microsoft Code Generator Package Integration Server
Note: The Integration Server for Microsoft Code Generator Package is called by Designer and by the IBM webMethods Add-In for Microsoft Visual Studio to generate code, but does not require a Windows environment to run.
IBM webMethods Add-In for Microsoft Visual Studio Microsoft Visual Studio

You cannot use Installer to install the IBM webMethods Add-In for Microsoft Visual Studio. You must install this element separately, as described in Installing the IBM webMethods Add-In for Microsoft Visual Studio.

Supported Platforms, Operating Systems, and Microsoft Products

For a list of the operating systems, webMethods products, and required Microsoft products supported by the Package for Microsoft .NET, see the IBM webMethods Adapters System Requirements.

Installing the Package for Microsoft .NET

About this task

Important: This section provides only instructions that are specific to installing the Package for Microsoft .NET and the webMethods for Microsoft Code Generator Package. For complete instructions on using the Installer, see the Installing IBM webMethods Products On Premises for your release.

Installation for the Package for Microsoft .NET and the webMethods for Microsoft Code Generator Package is similar. Install each element on the appropriate computer:

Install this element... On the same computer as...
Package for Microsoft .NET Integration Server
webMethods for Microsoft Code Generator Package Integration Server
Important: IBM recommends that you use only one instance of Integration Server with Package for Microsoft .NET installed on the Integration Server on a system. However, if you need to use Package for Microsoft .NET with multiple instances of Integration Servers on the same system, see Using Package for Microsoft .NET with multiple instances of Integration Server.

To install elements of the Package for Microsoft .NET:

Procedure

  1. Shut down all webMethods products.
  2. Download Installer.
  3. Start the Installer wizard.
    • Choose the webMethods release that includes the Integration Server on which to install the package. For example, if you want to install the package on Integration Server 8.2, choose the 8.2 release.
    • If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server. If you are installing both the host Integration Server and the package, specify the installation directory to use. The Installer will install the package in the Integration Server_directory\packages directory.
  4. In the product selection list, select Adapters > webMethods Package for Microsoft .NET . The following elements are automatically selected and will be installed:
    Note: You can deselect any of the individual components and install only the ones that you need.
    • Program Files 9.0 - This component will install the Package for Microsoft .NET (WmDotNet) containing services that you use to create and manage a Microsoft .NET CLR.
    • Code Generator 9.0 - This component will install the webMethods for Microsoft Code Generator Package (WmMSCodeGen) containing services that generate .NET source code.
  5. Enter the HTTP port to be used by Package for Microsoft .NET.
    Note: If the DotNetHost service already exists on the machine, you will not be asked to enter the HTTP port. Further installations of Package for Microsoft .NET will use the existing DotNetHost service.
  6. After Installer completes the installation, close Installer.
  7. Start the host Integration Server.
    Note: IBM recommends that you install the latest fix to include updates from previous fixes for this adapter.

Installing the IBM webMethods Add-In for Microsoft Visual Studio

About this task

Install the IBM webMethods Add-In for Microsoft Visual Studio on the same machine as Microsoft Visual Studio.

To install IBM webMethods Add-In for Microsoft Visual Studio :

Procedure

  1. Shut down Microsoft Visual Studio.
  2. Use the Install VS Plugin page in Integration Server Administrator, as described in The Install VS Plugin Page, to access the webMethods Add-In Setup.msi files.
  3. Run the executable file.

Upgrading to IBM webMethods Package 9.0 for Microsoft .NET

About this task

You can upgrade to IBM webMethods Package 9.0 for Microsoft .NET from IBM webMethods Package 7.1 for Microsoft .NET .

To upgrade from IBM webMethods Package 7.1 for Microsoft .NET to IBM webMethods Package 9.0 for Microsoft .NET :

Procedure

  1. Back up the entire webMethods installation directory where the IBM webMethods Package 7.1 for Microsoft .NET is installed.
  2. Uninstall the IBM webMethods Package 7.1 for Microsoft .NET using the Uninstaller, using the instructions in the IBM webMethods Package 7.1 for Microsoft .NET Installation and User’s Guide.
  3. Install the IBM webMethods Package 9.0 for Microsoft .NET using the instructions in Installing the Package for Microsoft .NET.
  4. After installing IBM webMethods Package 9.0 for Microsoft .NET , if you want to migrate your custom packages created in IBM webMethods Package 7.1 for Microsoft .NET , use the pub.dotnet.migration:upgradeDotNetServices service as explained in the below section Migrating Custom Packages.

Migrating Custom Packages

About this task

You can migrate the custom packages created in IBM webMethods Package 7.1 for Microsoft .NET to use these custom packages in IBM webMethods Package 9.0 for Microsoft .NET .

To migrate custom packages created in webMethods Microsoft Package 7.1 to IBM webMethods Package 9.0 for Microsoft .NET :

Procedure

  1. Shut down the host Integration Server.
  2. Set the dependency on the custom packages you want to migrate by editing the manifest.v3 file. The manifest.v3 file is located in the same folder as your custom package.

    Go to the folder of each custom package that you want to migrate, and edit the requires tag in the manifest.v3 file, as shown below: 

    <record name="requires" javaclass="com.wm.util.Values">  
  <value name="WmDotNet">9.0</value>  
</record>

  3. To migrate the services with assembly path set as Mapped Drives or Shared UNC Paths, follow the directions below:
    • If your custom package consists of .NET services that refer to Mapped Drives as their assembly path, move those DLLs to local system drives, and update the Assembly Path property from Designer.
    • If your custom package consists of .NET services that refer to Shared UNC Path as their assembly path, run the windows service named webMethods Package for Microsoft .NET with Administrator user account (who has privileges to access the shared paths) and then migrate the .NET services.
  4. Start the host Integration Server and verify that the dependency has been set correctly by doing the following:
    1. Go to Integration Server Administrator, and select Packages > Management.
    2. Select your custom package from the Package List.
    3. Verify that the value for Packages on which this package depends is WmDotNet;9.0.
  5. Start Designer and run the service pub.dotnet.migration:upgradeDotNetServices.

    Verify that the service output is as follows: 

    status = success  
isWhiteListUpdated=true  
errors (if any)

  6. Open wmSystem.exe.config file from IBMwebMethods_directory/DotNetHost folder.

    Verify that the value of the WhitelistDirectories element is updated correctly. For information on white-listed directories, see Specifying white-listed directories.

Results

The migrated custom packages can now be used with IBM webMethods Package 9.0 for Microsoft .NET .

Uninstalling the Package for Microsoft .NET

About this task

To uninstall elements of the Package for Microsoft .NET:

Procedure

  1. Shut down the webMethods products associated with the element:
    For this element... Shut down this product...
    Package for Microsoft .NET Integration Server
    webMethods for Microsoft Code Generator Package Integration Server
  2. Start Uninstaller, selecting the webMethods installation directory that contains the host Integration Server. In the product selection list, select Adapters > > webMethods Package for Microsoft .NET .
  3. After Uninstaller completes, restart the host Integration Server.

    Uninstaller removes all Package for Microsoft .NET-related files that were installed into the Integration Server_directory\packages\WmDotNet directory or the WmMSCodegen directory.

  4. Uninstaller does not delete files created after you installed the product (for example, user-created or configuration files), nor does it delete the directory structure that contains the files. If you do not want to save the files, do one or both of the following:
    Go to... And delete the directory...
    Integration Server_directory\packages WmDotNet
    Integration Server_directory\packages WmMSCodegen

Uninstalling the IBM webMethods Add-In for Microsoft Visual Studio

About this task

Perform the following procedure to uninstall the IBM webMethods Add-In for Microsoft Visual Studio.

To uninstall the IBM webMethods Add-In for Microsoft Visual Studio:

Procedure

  1. Shut down Microsoft Visual Studio.
  2. In Windows Control Panel, click Add or Remove Programs to start Uninstaller.
  3. Select IBM webMethods Add-In for Microsoft Visual Studio as the program to uninstall.

    Uninstaller removes all IBM webMethods Add-In for Microsoft Visual Studio files that were installed.

Using Package for Microsoft .NET with multiple instances of Integration Server

Important: IBM recommends that you use only one instance of Integration Server with Package for Microsoft .NET installed on the Integration Server on a system.

The Package for Microsoft .NET uses the DotNetHost Windows Service with the HTTP port associated with the Package for Microsoft .NET. There can be only one instance of the DotNetHost windows service on a system.

If multiple instances of Integration Servers with Package for Microsoft .NET installed on each of the Integration Server are on the same system, all the instances of the Package for Microsoft .NET will use the same DotNetHost windows service with the same HTTP port number.

The DotNetHost windows service is primarily associated with the instance of the Package for Microsoft .NET along with which, the DotNetHost service was installed. Hence, any changes to this instance of the Package for Microsoft .NET can cause errors in the remaining instances.

For example, consider the following scenarios:

  • Scenario 1
    • Package for Microsoft .NET, say MIP A, is installed on an Integration Server, say Server_1. As this is the first instance of Package for Microsoft .NET installed on the system, the DotNetHost windows service is installed and associated primarily with MIP A. 50000 is set as HTTP Port for MIP A.
    • Next, another instance of Integration Server, say Server_2 is installed on the same system, and Package for Microsoft .NET, say MIP B is installed on the Server_2. As these instances are on the same system, the same HTTP Port is used by both MIP A and MIP B.
    • If you modify the HTTP port for MIP A to 60000, MIP B fails, as MIP B cannot connect to DotNetHost windows service on HTTP Port 50000.
    • As a resolution, you must modify the HTTP Port for MIP B also and set it as 60000. For information on modifying the HTTP Port, see Modifying HTTP port.
  • Scenario 2
    • Package for Microsoft .NET, say MIP A, is installed on an Integration Server, say Server_1. As this is the first instance of Package for Microsoft .NET installed on the system, the DotNetHost windows service is installed and associated primarily with MIP A. 50000 is set as HTTP Port for MIP A.
    • Next, another instance of Integration Server, say Server_2 is installed on the same system, and Package for Microsoft .NET, say MIP B is installed on the Server_2. As these instances are on the same system, the same HTTP Port is used by both MIP A and MIP B.
    • If you uninstall MIP A, the DotNetHost windows service is also uninstalled, as the DotNetHost windows service was installed along MIP A. Now MIP B cannot connect to DotNetHost windows service on HTTP Port 50000.
    • As a resolution, you must manually install the DotNetHost windows service, and associate with MIP B. For information on manually installing DotNetHost windows service, see Manually installing DotNetHost as Windows Service.