Using the IBM webMethods Add-In for Microsoft Visual Studio

What is IBM webMethods Add-In for Microsoft Visual Studio?

Microsoft Visual Studio is a set of development tools for building a variety of applications. The Visual Studio integrated development environment (IDE) supports several languages, including Visual C# .NET and Visual Basic .NET.

With the IBM webMethods Add-In for Microsoft Visual Studio, you can browse for and capture services supported by an instance of IBM webMethods Integration Server. You can then generate a client assembly or a service provider assembly that invokes a particular webMethods service. As needed, you can also manually create webMethods client or server assemblies.

Using the Add-In for Visual Studio.

With the IBM webMethods Add-In for Microsoft Visual Studio, you can introspect services on Integration Server and use them to generate client code in the C# or Visual Basic language.

Opening the Add-in and Generating Code

About this task

To create a C# or Visual Basic file from a webMethods service

Procedure

  1. Open Visual Studio.
  2. Open an existing .NET project or create a new one.
  3. On the Tools menu, click IBM webMethods Add-In for Microsoft Visual Studio.

    If this menu item is not visible, make sure you have installed the add-in.

  4. In the IBM webMethods Add-In for Microsoft Visual Studio dialog box, provide the following information about the instance of Integration Server to which you want to connect.
    In this field... Type this...
    IBM webMethods Integration Server The name and port number of Integration Server in the format ServerName:PortNum. The default is localhost:5555.
    UserID The name of a valid user account on this server.
    Password The password for the user account in UserID. Passwords are case-sensitive.
  5. Click Connect. The IBM webMethods Add-In for Microsoft Visual Studio window is displayed. This window contains a tree view of packages and services on the Integration Server to which you are connected.
    Tip: The add-in opens as a floating window. You can dock the window by dragging it to the Visual Studio toolbar.
  6. Right-click a service and click Generate Code, and then click either of the following:
    Click this... To create code in... With this extension...
    C# Code C# .NET .cs
    VB.NET Code Visual Basic .NET .vb

    The file takes the name of the service from which it was generated and has an extension based on the type of code generated.

Connecting to an Additional Integration Server

About this task

You can connect to multiple Integration Servers from the IBM webMethods Add-In for Microsoft Visual Studio.

To connect to an additional Integration Server

Procedure

  1. With IBM webMethods Add-In for Microsoft Visual Studio displayed, right-click the IBM webMethods Integration Server ’s node (or other nodes as well) and click Connect to Integration Server.
  2. In the IBM webMethods Add-In for Microsoft Visual Studio dialog box, provide the following information about the instance of Integration Server to which you want to connect.
    In this field... Type this...
    IBM webMethods Integration Server The name and port number of Integration Server in the format ServerName:PortNum.
    UserID The name of a valid user account on this server.
    Password The password for the user account in UserID. Passwords are case-sensitive.
  3. Click Connect.

Disconnecting from an Integration Server

About this task

To disconnect from an Integration Server

Procedure

  1. With IBM webMethods Add-In for Microsoft Visual Studio window displayed, right-click the node for the Integration Server you want to disconnect.
  2. Click Disconnect from server_name .

    The Integration Server is disconnected and the node is removed from the tree.

Using the Add-In for Visual Studio 2015 Onwards

With the IBM webMethods Add-In for Microsoft Visual Studio, you can introspect services on Integration Server and use them to generate client code in the C# or Visual Basic language.

Adding Integration Server and Generating Code

About this task

To create a C# or Visual Basic file from a webMethods service

Procedure

  1. Open Visual Studio.
  2. Open an existing .NET project or create a new one.
  3. On the Tools menu, click Invoke webMethods Extension.

    If this menu item is not visible, make sure you have installed the add-in.

  4. In the webMethods Extension template, click to add Integration Server. Provide the following information about the instance of Integration Server to which you want to connect:
    In this field... Type this...
    Server Name The name and port number of Integration Server in the format:ServerName:PortNum
    Username The name of a valid user account on Integration Server.
    Password The password for the user account to connect to an Integration Server. Passwords are case-sensitive.
  5. Click Add
  6. Click to connect.

    The webMethods Extension window appears. This window contains a tree view of packages and services on the Integration Server to which you are connected.

    Note: The Add-In opens as a floating window. You can dock the window by dragging it to the Visual Studio toolbar.
  7. Right-click any service and click Project Setting.
  8. Select a project from the Select Project drop-down box . Click Save.
  9. Right-click the service and click Generate C# Code or Generate VB.NET Code.
    File name is derived from the service that generates it, with a file extension depending on the type of code that was generated.

Removing an Integration Server

About this task

You can remove an Integration Server by using webMethods Extension:

To remove an Integration Server

Procedure

  1. In webMethods Extension, select the Integration Server to be removed from the drop-down box.
  2. Click to remove.

Connecting to an Integration Server

About this task

You can connect to multiple Integration Servers from the IBM webMethods Add-In for Microsoft Visual Studio.

To connect to an additional Integration Server

Procedure

  1. Click in webMethods Extension.
  2. Click
    The added Integration Servers can be found in the drop-down box.

Disconnecting an Integration Server

About this task

To disconnect an Integration Server

Procedure

  1. In webMethods Extension, select the Integration Server from the drop-down box.
  2. Click
    The Integration Server is disconnected.

Editing Integration Server details

About this task

To edit the Username and Password, click type the new Username and Password and then select Update. However, the Server Name is not editable.

Refreshing an Integration Server

About this task

Click to refresh the Integration Server. This action collapses the tree view.