webMethods Service Designer 11.1 and 10.15 - Documentation
Important: The documentation applies to both webMethods Service Designer 11.1 and 10.15 with few specific changes exclusive to 11.1. Consider these distinctions while exploring the content.
Overview
webMethods Service Designer is a lightweight integrated design and development tool that includes:
- webMethods Service Development for designing and developing Integration Server assets (such as services, document types, triggers, and web service descriptors) and managing them under version control.
- Unit Test Framework for creating unit tests for the services that you develop and include in Continuous Integration for build verification.
- webMethods Microservices Runtime (referred to as Local Development Server) for deploying and testing the assets.
- webMethods CloudStreams Service Development for designing and developing
CloudStreams assets, such as Cloud Connector Services and Connector Listeners (exclusive to 11.1).
Installing webMethods Service Designer
Prerequisites:
- Supported Platforms: Windows, Linux, and macOS
- Service Designer 11.1 (Zulu Java 17) and Service Designer 10.15 (Zulu Java 11)
- File compression tools for respective platforms. For example, 7zip (Windows), tar (Linux), and so on.
The supported platform variants are as follows:
| Platform Name | Platform Version | Platform Hardware |
|---|---|---|
| Windows | 10 Professional | x86-64 |
| Windows Server | 2016 | x86-64 |
| Windows Server | 2019 | x86-64 |
| SUSE Linux Enterprise Server | 15 | x86-64 |
| Red Hat Enterprise Linux | 8 | x86-64 |
| macOS | 14 | ARM 64-bit |
| macOS | 14 | Intel Mac |
To install:
Download the webMethods Service Designer archive for your operating system from
webMethods Service Designer Free download (ensure that you login
from a Tech Community account or sign up for a free account).
You can also replace the trial license with your purchased license.
For more information, see Is there a way to replace the trial license with my purchased license?.
Note: Archive files, both with and without Zulu Java, are available on the portal. If you want to use an archive without the JDK, make sure to set the JAVA_HOME variable to the location of Zulu JDK 17 or JDK 11, depending on your Service Designer version, before proceeding.
To install webMethods Service Designer on supported platforms, follow these steps:
Windows
- Extract the downloaded Service Designer archive to a directory that does not include spaces in the name.
- From the extracted folder run ServiceDesigner.exe to launch webMethods Service Designer.
Linux
- Extract the downloaded Service Designer archive to a directory that does not include spaces in the name. Use the 'tar -xvf <archive Name> -C <destination folder>' command for extracting the files.
- From the extracted folder run ServiceDesigner to launch webMethods Service Designer.
macOS
- Open the downloaded Service Designer dmg file and drag the 'wMServiceDesigner' folder to the Application folder.
- Run the wMServiceDesigner/setup.sh file with Administrator access.
- Go to the application Launchpad and run ServiceDesigner to launch webMethods Service Designer.
After Service Designer launches, it prompts you to start the Local Development Server. You can also start (and stop) the Local Development Server from the Server menu in Service Designer.
Notes:
It is recommended that while working with Local Service Development use cases, maintain the VCS repository and projects outside of the Service Designer workspace and Integration Server packages directory.
Important: For security purposes, we recommend that you change the default Integration Server password.
Managing Local Development Server
You can start, stop, restart, and debug the Local Development Server using the Server menu in webMethods Service Designer.
Installing a JDBC Driver on Integration Server
For information on installing a JDBC Driver, see the webMethods Adapter for JDBC Installation and User's Documentation.
Ensure that you are logged into Tech Community to access the documentation.
Updating webMethods Service Designer
To update an existing version of webMethods Service Designer, follow these steps:
- Export the Service Designer preferences.
Click File > Export to launch the export wizard. In the Select panel, go to General > Preferences and click Next. In the To Preference file field, type a name for the .epf file to which you want to export your preferences. Click Finish. - Copy the Integration Server custom packages and configurations (if any) to a folder outside of the Integration Server installation folder before you start the update process.
- Download and extract the new version of webMethods Service Designer at a different system location.
- Copy the backed up Integration Server custom packages and configurations and paste at the location where the new version of webMethods Service Designer is extracted.
- Import the Service Designer preferences.
Click File > Import to launch the import wizard. In the Select panel, go to General > Preferences and click Next. In the From preference file field, select the .epf file to which you exported your preferences. Click Finish. - Import your local service development projects from the local VCS repository into the new Service Designer workspace. Move the project to Integration Server packages.
Included components
- webMethods Service Development (restricted to capabilities for use with the bundled runtime)
- webMethods Microservices Runtime
- Local Version Control Integration
- webMethods Unit Test Framework
- webMethods Adapter for JDBC
- webMethods CloudStreams Service Development (exclusive to 11.1)
Known issues
-
After updating to the latest macOS 14 version (macOS Sonoma), the webMethods Service Designer splash screen appears inverted or upside down.
The upside down or inverted splash screen is experienced universally among users who have updated to macOS 14, irrespective of their underlying Eclipse or Designer version. For more information, see Eclipse splash screen image issue.As of now, there is no workaround for this issue.
In Service Designer, under Local Service Development when a package is created as an Integration Server linked resource and is deleted from the Package Navigator view, Service Designer removes the package from the 'ServiceDesigner_Home\IntegrationServer\packages' directory as well as from the externally linked folder of the VCS system.
As a workaround for this issue and to avoid deletion of the contents from the externally linked folder, first, delete the linked folder from 'ServiceDesigner_Home\IntegrationServer\packages' directory and then go to 'Packages > Management' page in Integration Server Administrator and delete the package.
Documentation
Disclaimer
webMethods Service Designer is not officially supported by Software AG. You can also post your queries to the Tech Community forum 'webMethods Service Designer'. We will do our best to answer your questions and welcome your feedback. If there are any issues reported, we will do our best to address them but cannot guarantee that they will be resolved.
