Integrate Software AG Products Using Digital Event Services
General Information
Document Conventions
Online Information and Support
Data Protection
Using Digital Event Services to Communicate between Software AG Products
Understanding Digital Event Services
Digital Event Services Overview
Support of Digital Event Services
The Digital Event Type Model
Delivery Modes for Digital Event Services
The Store-and-Forward Queue
Non-Queued Delivery of Digital Events
Messaging Services and Service Groups
Administering Digital Event Services
About Administering Digital Event Services
Configuring Services
Configuring Universal Messaging Services
Using Universal Messaging Services with SSL
Defining a DES Keystore
Defining a DES Truststore
Using the In-Process Service
Configuring Service Groups
Configuring the Default Service Group
Configuring Custom Service Groups
Considerations When Modifying a Service Group Configuration
Configuring Event Type Associations
Configuring Storage Settings
Using DES Command Line Tools
Monitoring Digital Event Services
Secure Password Handling
Changing the Master Password
Lifecycle Actions for Digital Event Services
Managing Digital Event Services Licenses
Registering a DES License in Command Central
Updating a Digital Event Services License in Command Central
Viewing Digital Event Services License Details
Performance Considerations on Linux
Deployment of Digital Event Types
Deployment of Digital Event Types
Considerations for Deploying Digital Event Types
Design-Time Considerations
Design-Time Considerations for Digital Event Services
Digital Event Services MBeans
Event Type Information MBean
Universal Messaging Service MBean
In-Process Service MBean
Queue MBean
Subscriber MBean
Integration Server Administrator’s Guide
About this Guide
The Role of the Administrator
What Does an Administrator Do?
Typical Administrative Responsibilities
The Integration Server Administrator
Receiving Administrative Messages from the Server
The Administrator User
The Administrator's Password
Adding Backup Administrators
An Overview of the Server
The Role of the Server
About Integration Server Instances
Architecture
Services
Retrieving Data for Services
How the Server Executes Services
Integration Server Security
Integration Server Logging
Logging, Data Protection, and Privacy
Integration Server Caching
About Integration Server Fixes
Starting and Stopping the Server
Starting the webMethods Integration Server
Starting an Integration Server Instance on Windows
Starting Integration Server on UNIX
Starting a Server Instance from the Command Prompt
What Happens When You Start the Server?
How to Tell if the Server Is Running Correctly
Running Integration Server as a Windows Application vs. a Windows Service
Switching the Server from a Windows Service to a Windows Application
Switching the Server from a Windows Application to a Windows Service
Increasing File Descriptors on Mac OS X or Other UNIX System
Changing Settings in the Configuration File custom_wrapper.conf
Passing Java System Properties to Integration Server
Shutting Down the Integration Server
Shutting Down the Integration Server from Integration Server Administrator
Shutting Down Integration Server from Windows
Shutting Down Integration Server from the Command Prompt
Viewing Active Sessions
Killing Sessions
Viewing the Integration Server Process ID
Restarting the Integration Server
Server Recovery
Unapplied Changes to Integration Server Configuration Files
Integration Server Data Integrity and Recoverability Considerations
Critical Integration Server Data Files
The Java Service Wrapper
The Java Service Wrapper Configuration Files
JVM Configuration
The Wrapper Log
Logging Properties
Fault Monitoring
Generating a Thread Dump
Running Multiple Integration Server Instances
Overview of Integration Server Instances
Guidelines for Running Multiple Integration Server Instances on the Same Machine
About Creating a New Integration Server Instance
About the is_instance Script
Syntax
is_instance Script Commands
Creating a New Integration Server Instance
Updating an Integration Server Instance
Updating Packages on a Server Instance
Updating Database Properties of a Server Instance
Deleting Packages from a Server Instance
Updating Language Packs on a Server Instance
Deleting a Server Instance
Using Integration Server Administrator
What Is Integration Server Administrator?
Starting Integration Server Administrator
Starting Integration Server Administrator on Windows
Accessing Integration Server Administrator through My webMethods Server
Introduction to webMethods Integration Server Administrator
Accessing the Legacy Integration Server Administrator
Naming and Navigation Changes in the new Integration Server Administrator
The Server Configuration File
Logging Off Integration Server Administrator
Using the Dashboard
Overview
JVM Metrics
Usages
Services
Service Instances
Cache and Prefetch Information
Circuit Breaker Information
APIs
Configuring the Dashboard
Managing Notifications
Overview
Viewing Notifications
Dismissing Notifications
Ignoring Notification Types
Restoring Ignored Notification Types
Managing Users and Groups
Users and Groups
Purpose of Users and Groups
Defining a User Account
Predefined User Accounts
Adding User Accounts
Deleting User Accounts
Adding an Administrator User
Adding a Developer User
Changing Passwords
Configuring Password Requirements and Expiration Settings
Setting Password Requirements
Setting Password Expiration Requirements
Configuring Account Locking Settings
Unlocking User Accounts
Disabling and Enabling User Accounts
Disabling a User Account
Enabling a User Account
Defining Groups
Predefined Groups
Adding Groups
Adding Users to a Group
Removing Users from a Group
Viewing Group Membership
Removing Groups
Configuring the Server
Viewing and Changing Licensing Information
The License Key
Viewing Licensing Information
Changing Licensing Information
Renewal Reminders
Renewing a Key
Adding Licensed Features
Licensed Sessions
Viewing Active Sessions
Managing the Server Thread Pool
Managing Server Sessions
Setting the Session Timeout Limit
Setting the Stateful Session Limit
Configuring Outbound HTTP Settings
Specifying Outbound HTTP Settings
Setting Up Aliases for Remote Integration Servers
Adding an Alias for a Remote Integration Server
Testing the Connection to a Remote Server
Editing an Alias
Deleting an Alias
Specifying Third-Party Proxy Servers for Outbound Requests
How Integration Server Uses Proxy Servers
Creating a Proxy Server Alias
Editing a Proxy Server Alias
Disabling a Proxy Server Alias
Enabling a Proxy Server Alias
Specifying a Default Proxy Server Alias
Deleting a Proxy Server Alias
Bypassing a Proxy Server
Configuring Where the Integration Server Writes Logging, Status, and Other Information
Switching from the Embedded Database to an External RDBMS
Working with Extended Configuration Settings
Specifying Character Encoding
Configuring the JVM
Specifying the JDK or JRE for Integration Server
Changing the JVM Heap Size Used by Integration Server
Publishing and Retracting Information about Integration Server Assets
Configuring Integration Server to Connect to CentraSite
Testing the Connection to CentraSite
Setting a Port for Remote Client JMX Monitoring
Configuring Integration Server to Accept a Debug Connection During Startup
Using CORS with Integration Server
How Integration Server Handles CORS Requests
Configuring Integration Server to Accept CORS Requests
Connecting Integration Server to Database Components in an External RDBMS
Concepts
Pointing Functions at Connection Pools
Installing the MySQL Community Edition Database Driver
Installing the Tibero JDBC Driver
Creating a Driver Alias Definition
Creating a Connection Pool
Using Kerberos Authentication for Outbound Connections to a Database
Using the Kerberos Re-Authentication Feature
Using a Different Kerberos Ticket Cache File with each JDBC Connection Pool
Configuring Ports
About Ports
Available Port Types
Default Ports
About the Port Alias
Package Associations for Ports
Considerations for Adding Ports
Reasons to Add Additional Ports
Considerations for Configuring Ports
AS/400 Considerations
Bind Addresses
Prerequisites to Configuring a Port for SSL
Port Usage and Security
Adding an HTTP Port
Advanced Controls for HTTP Ports
Editing Advanced Controls
Adding an HTTPS Port
About File Polling Ports
Adding a File Polling Port
Adding an FTPS Port
How Client Authentication Works for FTPS Ports
Adding an FTP Port
Adding an E-Mail Port
Security Considerations for E-Mail Ports
Adding an HTTP Diagnostic Port
Adding an HTTPS Diagnostic Port
Suspending an HTTP/HTTPS Port
Resuming an HTTP/HTTPS Port
Testing for HTTPS Requests
Using an FTP/FTPS Port Range
Specifying an FTP/FTPS Port Range
About the Primary Port
Changing the Primary Port
Deleting a Port
Editing a Port
About Enabling/Disabling a Port
Disabling a Port
Enabling a Port
Configuring How Ports Handle Client Certificates
Adding a Security Provider
Disabling Protocols for JSSE per Port
Designating an HTTP/S Port as Stateless
Setting Up the Server Log
Overview of the Server Log
Specifying Amount and Type of Information to Include in the Server Log
Logging Levels
Specifying Whether to Queue Server Log Entries
Changing the Default Server Log Location
Configuring the Server Log to Rotate Based on Size
Limiting the Number of Server Log Files Kept by Integration Server
Sending Messages About Critical Issues to E-mail Addresses
Performing Additional Processing on Log Entries
Viewing the Server Log
Using an Alternative Server Log Entry Format
Changing the Log Displays
Specifying the Date and Time Format to Use in Log Entries
Displaying Logged Data in Different Languages
Changing the Display Permanently for All Logs
Changing the Display Temporarily for the Server Log
Overriding Logging Level and Server Log Location for a Session
Globalization and the Server Log
The Statistics Log
About the Statistics Log
Viewing the Statistics Log
Server Configuration Parameters that Affect the Statistics Log
The HTTP Log
About the HTTP Log
Common Log Format
Combined Log Format
Legacy Log Format
Setting the Format for the HTTP Log
Configuring Integration Server for webMethods Messaging
Overview of webMethods Messaging
Working with Messaging Connection Aliases
Predefined Messaging Connection Aliases
Creating a Broker Connection Alias
Creating a Universal Messaging Connection Alias
About Follow the Master for webMethods Messaging
Editing a Messaging Connection Alias
Enabling a Messaging Connection Alias
About Disabling a Message Connection Alias
Disabling a Messaging Connection Alias
Messaging Connection Alias Status
Specifying the Default Messaging Connection Alias
Deleting a Messaging Connection Alias
Authenticating Connections to the Universal Messaging Server
Specifying the Keep-Alive Mode for the Broker Connection
Setting Server Configuration Parameters for Keep-Alive Mode
Normal Mode
Listen Only Mode
Disabled
Synchronizing Broker Clients When the Primary Port for Integration Server Changes
Configuring Document Stores
Configuring the Default Document Store
About the Trigger Document Store
Configuring the Trigger Document Store
Maintaining Inbound Document History for Received Documents
Enabling Inbound Client-Side Queuing
About the Outbound Document Store
Configuring the Rate at which Integration Server Drains the Outbound Document Store
Setting the Capacity of the Outbound Document Store
Associating a User Account with webMethods Messaging Trigger Services
Specifying a User Account for Invoking webMethods Messaging Trigger Services
Load Balancing with a Non-Clustered Group of Integration Servers
Important Considerations for Using a Stateless Cluster with webMethods Messaging
Configuring Integration Server for JMS Messaging
Overview of JMS Messaging Configuration
Working with JNDI Providers
Predefined JNDI Provider Aliases
Creating a JNDI Provider Alias
Editing a JNDI Provider Alias
Deleting a JNDI Provider Alias
Creating a JNDI Provider Failover List
Performing a Test Lookup for a JNDI Provider
JNDI Provider Cache and Timeout Behavior for Administered Objects
Working with JMS Connection Aliases
Connecting to webMethods Broker with the Native webMethods API
Predefined JMS Connection Aliases
Creating a JMS Connection Alias
Allowing Destinations to Be Managed through the JMS Connection Alias and Designer
Allowing Multiple Connections for a JMS Connection Alias
About the Connection Client ID
Creating a Dedicated Listener for Receiving Replies
Configuring Producer Caching for Sending JMS Messages
Configuring Automatic Retry when Sending JMS Messages Using the pub.jms:send Service
About Retrying the pub.jms:send Service when Software AG Universal Messaging Is the JMS Provider
Editing a JMS Connection Alias
Enabling and Disabling a JMS Connection Alias
Deleting a JMS Connection Alias
Specifying a Connection Monitoring Period
Specifying a Retry Interval for Failed Connections
Specifying a Keep-Alive Interval
Creating Administered Objects
Monitoring a Connection Factory Object for Changes
Polling for Changes
Registering an Event Listener
How Integration Server Updates the Connection
Configuring Integration Server to Monitor a Connection Factory Object
Using SSL with JMS
Supported JMS Providers
Considerations for JMS Providers
About Using Software AG Universal Messaging as the JMS Provider
Adding JMS Provider Client Libraries to Integration Server Classpath
Configuring Integration Server for MQTT Messaging
Overview of MQTT Support in Integration Server
Limitations of MQTT Support in Integration Server
Supported MQTT Servers
Creating an MQTT Connection Alias
Editing an MQTT Connection Alias
Enabling and Disabling an MQTT Connection Alias
Deleting an MQTT Connection Alias
Specifying a Retry Interval for Failed Connections to the MQTT Server
Using Enhanced Logging for Messaging
About Enhanced Logging for Messaging
What Is in Log Entries for Enhanced Logging?
Logging Levels for Enhanced Messaging Logging
Using the Messaging Log or the Server Log for Enhanced Logging
Configuring Enhanced Logging for Messaging
Viewing the Messaging Log
Setting Up Universal Messaging Client Logging
Universal Messaging Client Logging
Configuring Universal Messaging Client Logging
Event Lifecycle Logging
Configuring Event Lifecycle Logging
Configuring Endpoint Aliases for Web Services
About Web Service Endpoint Aliases
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with HTTP/S
Setting a Default Endpoint Alias for Provider Web Service Descriptors
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with HTTP/S
Creating an Endpoint Alias for Message Addressing for Use with HTTP/S
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with JMS
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with JMS
Creating an Endpoint Alias for Message Addressing for Use with JMS
Timestamps in the WS-Security Header
Configuring Reliable Messaging in Integration Server
Overview of Reliable Messaging
Understanding Reliable Messaging Terminology
Using Reliable Messaging in Integration Server
Persistent Storage Support for Reliable Messaging Data
Limitations When Using Reliable Messaging in Integration Server
Configuring Reliable Messaging in Integration Server
Reliable Messaging Sequence Reports
Client and Server Sequences
Viewing Reliable Messaging Sequence Reports
Closing a Sequence
Terminating a Sequence
Sending an Acknowledgement Request
Configuring Integration Server to Use JWT
Overview of JWT
Using JWT with Integration Server
Support for JWT in Integration Server
Configuring Integration Server to use JWT
Enhanced Support for JWT in Integration Server
Trusted Issuers
Adding Trusted Issuers
Deleting a Trusted Issuer
Issuer-Certificate Mapping
Creating an Issuer-Certificate Mapping
Deleting an Issuer Certificate Mapping
Skew Mapping
Creating an Issuer Skew Mapping
Editing Global Claim Settings
Configuring Integration Server to Use Kerberos
Overview of Kerberos Usage in Integration Server
About Kerberos
Kerberos Terminology
Kerberos Delegated Authentication
Prerequisites to Configuring Kerberos
Limitations When Using Kerberos Authentication in Integration Server
Configuring Integration Server to Use Kerberos
Order of Precedence for Principal Name and Password
JAAS Contexts for Kerberos
Troubleshooting Kerberos Configuration
Setting Up HTTP URL Aliases
Overview
Creating an HTTP URL Alias
Specifying the URL Path
Using Port Mappings with a URL Alias
Adding a Port Mapping to a URL Alias
Deleting a Port Mapping for a URL Alias
Using a URL Alias for the “Empty Path”
Creating a URL Alias for the Empty Path
Enabling Partial Matching of URL Aliases
Displaying HTTP URL Aliases
About HTTP URL Alias Association
Editing a URL Alias
Deleting a URL Alias
Portability of URL Aliases and Possible Conflicts
Using HTTP Interceptors
Overview of HTTP Interceptors
Types of HTTP Interceptors
HTTP Interceptor Interfaces
Working of HTTP Interceptors
Considerations for Creating an HTTP Interceptor
Creating an HTTP Interceptor
Configuring Integration Server for HTTP Compression
Overview
HTTP Request Compression
HTTP Response Compression
Configuring Integration Server to Connect to an SFTP Server
Overview of SFTP
Creating an SFTP Server Alias
Editing an SFTP Server Alias
Creating an SFTP User Alias
Editing an SFTP User Alias
Migration Impact on SFTP Configurations
Testing the Connection to the SFTP Server
Configuring Integration Server for Secure Communications
Overview of SSL in Integration Server
Supported SSL Authentication Types
Supported SSL/TLS Protocols
Changes to watt.net.jsse* Parameters for Default Disabled Protocols
Disabling TLS Renegotiation
Specifying Cipher Suites for Use with SSL
Preparing to Configure SSL in Integration Server
Creating Public/Private Keys and Certificates for Integration Server
Creating a Keystore and Truststore
Obtaining the Public Keys and Certificates of the Partner Application or Resource
Configuring Integration Server SSL Keys and Certificates
Specifying Integration Server SSL Certificates and Keys
Usage of CA Certificates: Technical Considerations
Handling Expired CA Certificates
Customizing Usage of Truststores
Configuring Integration Server as an SSL Server
Configuring an HTTPS or FTPS Port
Controlling Server SSL Security Level by Port
Configuring Integration Server as an SSL Client
Configuring SSL Information for the Integration Server JVM
Order of Precedence for the javax.net.ssl Properties
Using Multiple Client Certificates with SSL Servers
Setting Up a Remote Server Alias
Coding Your Flow Services
WS-Security and Integration Server
Setting Up SSL Session Logging
Overview of the SSL Session Log
Enabling the SSL Session Logging
Viewing the SSL Session Log
Changing the Default SSL Session Log Location
Managing the SSL Session Log Size
Avoiding Duplicate Entries in the Log
Using Keystores and Truststores with Integration Server
Keystores and Truststores
Keystore File
Keystore File Formats
HSM-Based Keystores
Creating a Keystore
Truststore File
Truststore File Formats
How Integration Server Uses a Keystore and Truststore
Protecting Keystore and Truststore Files
Keystore, Truststore, and Key Aliases
Default Keystore and Truststore Aliases
Creating Keystore Aliases
Creating Truststore Aliases
Controlling Access to Resources
Overview
Controlling Access to Resources by Port
Restricting IP Addresses that Can Connect to a Port
Controlling IP Access to All Ports (Globally)
Allow Inbound Connections from Specified Hosts (Deny All Others)
Deny Inbound Connections from Specified Hosts (Allow All Others)
Allow Inbound Requests from Specified Hosts (Deny All Others)
Deny Inbound Requests from Specified Hosts (Allow All Others)
If You Inadvertently Deny IP Access to All Hosts
Resetting the Global Setting IP Access Setting
Resetting the IP Access Setting for an Individual Port
Restricting the Services or Web Service Descriptors Available from a Port
Allow Access to Specified Services (Deny All Others)
Deny Access to Specified Services (Allow All Others)
Resetting a Port to the Default Access
Controlling the Use of Directives
Controlling Access to Resources with ACLs
About ACLs
Package Replication
Implicit and Explicit Protection
Users that Belong to More than One Group
Predefined ACLs
When Does the Server Perform ACL Checking?
Creating ACLs
Allowing or Denying Group Access to ACLs
Deleting ACLs
Default Settings and Inheritance
What Happens When You Change Existing ACL Assignments
Assigning ACLs to Folders, Services, and Other Elements
Removing an ACL from a Folder or Service
Assigning ACLs to Files the Server Can Serve
Rules for Using .access Files
Removing ACL Protection from a File
Adding Services to a Blacklist
Using a File for the Service Blacklist
Authenticating Clients
Overview
Basic Authentication
Digest Authentication
Kerberos Authentication
Client Certificate Authentication
Certificate Mapping
Importing a Client Certificate and Mapping It to a User
Changing a Certificate Mapping
Client Certificates and Port Configuration
Client Authentication and Access Control
Single Sign-On Authentication for My webMethods
Configuring the MWS Single Sign-On Resource Setting
SAML Authentication
Requirements for SAML Authentication
Identifying Trusted STSs to Integration Server
Accepting SAML2 Tokens at the Transport Level
Customizing Authentication Using JAAS
Overview
Using JAAS with Integration Server
JAAS Configuration File
Pre-installed Login Modules
X509ValidatorModule
Pluggable Authentication Modules (PAMs)
Writing a Custom JAAS Login Module for Integration Server
Extend SagAbstractLoginModule
Implement Commit()
Place the JAR File in the Integration Server Classpath
Modify the JAAS Configuration File
JAAS Custom Login Module Example
JAAS Login Module for Integration Server: Sample Code
JAAS Custom Login Module: Code Explanation
JAAS Configuration File: Sample Module
Master Passwords and Outbound Passwords
Overview
Managing Outbound Passwords
Backing Up Outbound Password and Master Password Files
Changing the Master Password
Changing the Expiration Interval for the Master Password
About the configPassman.cnf File
Working with Outbound Password Settings
Controlling Name and Location of Outbound Password File
Controlling Encryption of Outbound Password File
Working with Master Password Settings
Storing the Master Password in a File
Prompting for the Master Password at Server Initialization
What to Do if You Lose or Forget Your Master Password
When Problems Exist with the Master Password or Outbound Passwords at Startup
Determining Whether You Can Restore the Passwords
Restoring the Master Password and Outbound Password Files
Resetting the Master Password and Outbound Passwords
E-mail Listeners and Package Replication
Securing Integration Server with CSRF Guard
What is CSRF?
How Does Integration Server Prevent CSRF Attacks?
Understanding CSRF Guard Terminology
Configuring CSRF Guard in Integration Server
Limitations when Configuring CSRF Guard in Integration Server
Configuring webMethods Enterprise Gateway
Overview
How Enterprise Gateway Works
Enterprise Gateway Ports
Enterprise Gateway Rules and Alerts
About Enterprise Gateway Rules
About Enterprise Gateway Alerts
Version Interoperability Between Enterprise Gateway Server and Internal Server
Advantages of Enterprise Gateway over Traditional Third-Party Proxy Servers
About Denial of Service Protection
About Trusted IP Addresses
About Mobile Application Protection
About Mobile Data Synchronization
About SQL Injection Protection
About Antivirus Scan Filter
About Custom Filter
Clustering in the Enterprise Gateway Configuration
Setting Up an Enterprise Gateway
Configuring the Enterprise Gateway Ports
Deleting Enterprise Gateway External and Registration Ports
Connecting Your Internal Server to an Enterprise Gateway Server
Viewing Connections to the Enterprise Gateway Registration Port
Performing Client Authentication on Enterprise Gateway Server
Working with Enterprise Gateway Rules
Creating an Enterprise Gateway Rule
Enabling an Enterprise Gateway Rule
Disabling an Enterprise Gateway Rule
Editing an Enterprise Gateway Rule
Copying an Enterprise Gateway Rule
Changing the Priority of an Enterprise Gateway Rule
Deleting an Enterprise Gateway Rule
Specifying Alert Options
Specifying Default Alert Options
Specifying Rule-Specific Alert Options
Preventing Denial of Service Attacks
Limiting Requests Globally
Limiting Requests by IP Address
Controlling Use of Mobile Applications
Frequently Asked Questions about Enterprise Gateway
Configuring OAuth
What Is OAuth?
Using OAuth with Integration Server
Integration Server as an OAuth Client
Integration Server as an Authorization Server
Integration Server as an External Authorization Server
Integration Server as a Resource Server
OAuth Client Types
Authorization Grant Types Supported by Integration Server
Authorization Code Grant
Using PKCE with the Authorization Code Grant
Implicit Grant
Resource Owner Password Credentials Grant
Client Credentials Grant
The Integration Server OAuth Services
Important Considerations for Using OAuth Features
Configuring Integration Server for OAuth
Configuring OAuth Settings
Defining Clients
Registering Clients
Enabling and Disabling Clients
Editing Clients
Deleting Clients
Defining Scopes
Adding a Scope
Editing Scopes
Deleting Scopes
Associating Scopes and Clients
Adding Associations Between Clients and Scopes
Removing Client and Scope Associations
Viewing Associations Between Clients and Scopes
Managing Tokens
Viewing Tokens
Deleting Tokens
Revoking Tokens
Removing Expired Access Tokens
Customizing the Approval Page
About Using Integration Server as the Resource Server
Using an External Authorization Server
Creating an External Authorization Server Alias
Deleting an External Authorization Server
Configuring a Central User Directory or LDAP
Before You Begin
Overview of How Integration Server Works with Externally Defined Users and Groups
How the Server Uses Externally Defined Users and Groups
When the Server Accesses Externally Defined Information
How Integration Server Authenticates Externally Defined Clients
Configuring Central User Management
Requirements for Integration Server to Use Central User Management
Considerations for My webMethods Server Query Roles
Overview of Using LDAP
About LDAP and Caching
Configuring the Server to Use LDAP
Defining an LDAP Directory to Integration Server
Mapping an LDAP User's Access to ACLs
Stopping Use of an LDAP as an External Directory
Considerations for User Accounts and Groups
About Keeping Internal and External User Accounts and Group Names Unique
About User Groups and Package Replication
About Granting Administrator Privileges to External Users
Granting Administrator Privileges to an Externally Defined User
Granting Developer Privileges to External Users
Granting Access to Services and Files to External Users
Managing Packages
Using Packages
Predefined Packages
The Package Repository
How the Server Stores Package Information
Manifest File
Finding Information about Your Packages
Viewing the Packages that Reside on Your Server
Filtering the List of Packages
Refining the Filtered Package List
Determining Whether the Server Successfully Loaded the Package
Determining Whether the Package Is Enabled or Disabled
Displaying Information about a Package
Package Information
Displaying Information about Services and Folders in a Package
Displaying Documentation for a Package
Accessing a Web Document for a Package
Working with Packages
Creating a Package
Activating a Package
Reloading a Package
Enabling a Package
Disabling a Package
Deleting a Package
Recovering a Package
Archiving a Package
Copying Packages from One Server to Another
Overview of Package Replication
Version Checking
Who Can Subscribe?
Guidelines for Using Package Replication
The Publishing Server
Displaying Subscribers for a Specific Package
Displaying Subscribers for all Packages
Adding Subscribers from a Publishing Server
Updating Subscriber Information
Removing Subscribers for a Package
Publishing a Package
Creating a Release
Sending a Release
Specifying File and Version Information for a Release or Archive
The Subscribing Server
Displaying Packages to Which Your Server Subscribes
Manually Pulling a Package
Subscribing to a Package from a Subscribing Server
Requesting a Subscription to a Package from Another Server
Updating Your Subscription Information
Canceling a Subscription
About Installing Packages Published by Another Server
Installing a Package Published by Another Server
Using a Package Class Loader
Hot Deployment of Packages
How Hot Deployment Works
Determining Package Dependencies during Hot Deployment
Considerations for Hot Deployment of Packages
Enabling and Configuring Hot Deployment of Custom Packages
Disabling Hot Deployment of Custom Packages
Automatic Package Deployment
Managing Services
About Services
Fully Qualified Service Names
Package Names and Service Names
HTTP URL Aliases for Services
Finding Information about Services and Folders
Listing Folders and Services
Displaying Information about a Service
Service Information
Manually Adding a Service to the Server
Testing Services
Canceling and Killing Threads Associated with a Service
Canceling or Killing a Thread
Running Services When Packages Are Loaded, Unloaded, or Replicated
What Is a Startup Service?
What Is a Shutdown Service?
What Is a Replication Service?
Guidelines for Using Startup, Shutdown, and Replication Services
Running Services in Response to Specific Events
Managing Global Variables
Creating a Global Variable
Deleting Global Variables
Scheduling Services
Overview
Tasks Provided by Integration Server
Scheduling a User Task
Viewing Scheduled User Tasks
Filtering the List of Scheduled Tasks
Updating Scheduled User Tasks
Suspending User Tasks
Suspending a Single User Task
Suspending All User Tasks
Resuming Suspended User Tasks
Resuming a Suspended User Task
Resuming All Suspended User Tasks
Canceling a Scheduled User Task
Viewing the Scheduled System Tasks
Simple Repeating Option
Complex Repeating Option
Target Node Options
Tasks in a Clustered Environment
How Transitioning to or from Daylight Savings Time Affects Scheduled Tasks
Caching Service Results
What Is Caching?
When Are Cached Results Returned?
Using a Public Cache for Service Results Caching
Resetting the Cache
Resetting the Cache for All Services
Resetting the Cache for a Specific Service
Monitoring Service Cache Usage
Viewing Service Results in a Public Cache
Configuring Guaranteed Delivery
About Guaranteed Delivery
Configuring the Server for Guaranteed Delivery
Settings Shared by Both Inbound and Outbound Transactions
Settings for Inbound Transactions
Settings for Outbound Transactions
Specifying an E-Mail Address and SMTP Server for Error Messages
Using Guaranteed Delivery with Multiple Servers that Share an ISInternal Database
Administering Guaranteed Delivery
Shutting Down Guaranteed Delivery
Reinitializing Guaranteed Delivery
Reinitializing Guaranteed Delivery for Inbound Transactions
Reinitializing Guaranteed Delivery for Outbound Transactions
Configuring Terracotta Ehcache on Integration Server
What is Terracotta Ehcache?
Caching Configurations
On-Heap Cache
Local Disk Store
BigMemory
Terracotta Server Array
Understanding Caches and Cache Managers
System Caches
Cache Manager Configuration Files
Specifying the Parameters for a Cache
Dynamic vs. Non-Dynamic Cache Parameters
Installing, Viewing, and Changing the Terracotta License
Determining if You Have a Terracotta License
Adding a Terracotta License
Configuring an On-Heap Cache
Considerations for Configuring On-Heap Cache
Configuring a BigMemory Cache
Allocating Direct Memory Space to Integration Server
Considerations for Configuring BigMemoryCache
Configuring a Distributed Cache
Configuring tc-config.xml on the Terracotta Server Array
Considerations for Configuring a Distributed Cache
Cache-Wide and Client-Specific Parameters for a Distributed Cache
Cache-Wide Parameters
Client-Specific Parameters
The Rejoin Behavior of a Distributed Cache
The Nonstop Behavior of a Distributed Cache
About the Maximum Entries in Cache Value
Making a Cache Searchable
Defining Attributes
Extracting Attributes by Class
Example Extractor
Working with Cache Managers
Creating a Cache Manager
Viewing or Modifying a Cache Manager
Shutting Down a Cache Manager
Starting a Cache Manager
Reloading a Cache Manager
Deleting a Cache Manager
Reinitializing a Cache Manager
Adding a Cache Manager Configuration File to Integration Server
Manually Editing a Cache Manager Configuration File
Working with Caches
Creating a Cache
Viewing or Modifying Cache Settings
Modifying Settings for a Distributed Cache
Disabling a Cache
Enabling a Cache
Clearing a Cache
Deleting a Cache
Logging Terracotta Ehcache Activity
Logging Terracotta Ehcache Caching Services
Logging Cache Manager Activity in the Terracotta Server Array
Configuring the Enhanced XML Parser
What Is the Enhanced XML Parser?
How Does the Enhanced XML Parser Work?
When Is the Enhanced XML Parser Used?
What Services Consume an Enhanced Node?
Configuring the Enhanced XML Parser
Setting the Partition Size
Viewing Peak Usage Statistics
Configuring WebSockets
Overview
How WebSocket Works
Setting Up Integration Server for WebSockets
Configuring a WebSocket Ports
Configuring a WebSocketSecure Ports
Viewing WebSocket Server Endpoints for a WebSocket Port
WebSocket Server Sessions Page
Limitations When Using WebSocket Protocol in Integration Server
Configuring gRPC in Integration Server
Overview of gRPC
gRPC Support in Integration Server
Authentication for gRPC
Requiring or Requesting Client Certificates
Using “Plaintext” Mode for Communication with the gRPC Server
Working with gRPC Channels
Editing a gRPC Channel
Enabling or Disabling a gRPC Channel
Managing gRPC Descriptors
Limiting Integration Server Resources for gRPC
Locking Administration and Best Practices
Introduction
Choosing Local Server Locking or VCS Integration Locking
Disabling and Re-enabling Locking
Disabling Locking
Re-Enabling Locking
Best Practices
Remote Server Configuration
Server User Names
Package Replication and Publishing
Package and Folder Organization
Source Code
Upgrading webMethods Integration Server
Managing webMethods Messaging Triggers
Introduction
Managing Document Retrieval
Increasing or Decreasing Threads for Document Retrieval from webMethods Broker
When to Increase or Decrease Threads for Retrieving Documents from webMethods Broker
Decreasing the Capacity of Trigger Queues
Decreasing the Capacity and Refill Level for webMethods Messaging Triggers
Suspending and Resuming Document Retrieval
About Suspending and Resuming Document Retrieval for All Triggers
Suspending or Resuming Document Retrieval for All webMethods Messaging Triggers
About Suspending and Resuming Document Retrieval for a Specific Trigger
Suspending or Resuming Document Retrieval for a webMethods Messaging Trigger
Managing Document Processing
Increasing or Decreasing Threads for Processing Documents Received by webMethods Messaging Triggers
When to Increase or Decrease Threads for Processing Documents
Decreasing Document Processing for Concurrent Triggers
Decreasing Execution Threads for Concurrent webMethods Messaging Triggers
Suspending and Resuming Document Processing
About Suspending and Resuming Document Processing for all Triggers
Suspending or Resuming Document Processing for All webMethods Messaging Triggers
About Suspending and Resuming Document Processing for Specific Triggers
Suspending or Resuming Document Processing for a Specific webMethods Messaging Trigger
Limiting Server Threads for webMethods Messaging Triggers
Setting the Maximum Number of Server Threads for webMethods Messaging Triggers
Cluster Synchronization for webMethods Messaging Trigger Management
Configuring Cluster Synchronization
Cluster Synchronization at Run Time
Monitoring Cluster Synchronization
Modifying webMethods Messaging Trigger Properties
Managing Trigger Service Retries and Shutdown Requests
Delaying Polling Requests for webMethods Messaging Triggers
How Integration Server Delays a Polling Request for a webMethods Messaging Trigger
Serial Triggers Migrated to Integration Server 10.3 or Later from Earlier Versions
Synchronizing the webMethods Messaging Trigger and Durable Subscription on Universal Messaging
Managing JMS Triggers
Introduction to JMS Trigger Management
Searching for JMS Triggers
About JMS Trigger Status and State
Enabling, Disabling and Suspending a JMS Trigger
Configuring Integration Server to Enable JMS Triggers Automatically after a Consumer Error
Controlling Thread Usage for JMS Triggers
Viewing Thread Usage for JMS Triggers
Throttling Thread Usage for JMS Triggers
Establishing a Threshold for Using Multiple Threads with a Concurrent JMS Trigger
Configuring Integration Server Session Reuse
Configuring JMS Session Reuse
Delaying Polling Requests for Concurrent JMS Triggers
How JMS Trigger Delays a Polling Request
Examples of Extended Polling Delay Configuration
What Happens When JMS Triggers Fail to Start?
How Does the JMS Trigger Restart Task Work?
About WS Endpoint Triggers
Editing WS Endpoint Triggers
Managing MQTT Triggers
Introduction to MQTT Trigger Management
MQTT Trigger State and Status
Changing the State of an MQTT Trigger
Configuring Integration Server Session Reuse for MQTT Triggers
Automatic Retry for Starting MQTT Triggers
Using a Document History Database with Exactly-Once Processing
Overview
Removing Expired Entries from the Document History Database
Clearing Expired Entries from the Document History Database
Viewing Exactly-Once Processing Statistics
Clearing Exactly-Once Processing Statistics
Using Integration Server to Manage XA Transactions
Overview of XA Transaction Management
How the Integration Server Persists the State of a Transaction
How the Integration Server Resolves Uncompleted Transactions
About Unresolved XA Transactions
Details for an Unresolved XA Transaction
Configuring XA Options in Integration Server
Enabling or Disabling XA Transaction Recovery
Configuring the XA Recovery Store
Configuring XA Server Parameters
Manually Resolving a Transaction
Content Handlers in Integration Server
How Integration Server Uses Content Handlers
How Integration Server Chooses a Content Handler for an HTTP Request
How Integration Server Chooses a Content Handler for an FTP Request
Content Handlers for HTTP and FTP Requests
About Content Handlers for HTTP Responses
Accept Header Field
About Content Handlers for FTP Responses
Class Loading in Integration Server
How Class Loading Works in Integration Server
Class Loaders
OSGi Bundle Class Loader
Integration Server Class Loaders
Classpaths
How the Integration Server Classpath Is Set
Additional Information about How the Microservices Runtime Classpath Is Set
Adding Classes to the Server Classpath
Adding Classes to a Package
Class Searching Order
How Classes Are Found
How Classes Are Found in Microservices Runtime
Searching Order within a Package
Where to Put Your Classes and Jar Files
Accelerating Class Loading
Whitelist Filtering in Integration Server
About Whitelist Filtering in Integration Server
Enabling or Disabling Whitelist Class Filtering
Integration Server Whitelist Classes File
Creating a Package Whitelist Classes File
Logging Classes that Are Not on the Whitelist
Integration Server Blacklist Classes File
Quiescing the Server for Maintenance
Overview
What Happens when Integration Server Enters Quiesce Mode?
What Tasks Can You Perform in Quiesce Mode?
What Happens when Integration Server Exits Quiesce Mode?
Specifying the Quiesce Settings
Quiescing Integration Server
Starting the Server in Quiesce Mode from the Command Prompt
Quiescing an Active Server from Integration Server Administrator
Restarting a Server in Quiesce Mode from Integration Server Administrator
Exiting Quiesce Mode
Deploying Quiesce Mode Configuration
Diagnosing the Integration Server
Introduction
Configuring the Diagnostic Port
Diagnostic Thread Pool Configuration
Diagnostic Port Access
Using the Diagnostic Utility
Diagnostic Utility Performance
Running the Diagnostic Utility from Integration Server Administrator
Running the Diagnostic Utility Service
Starting the Integration Server in Safe Mode
Starting Integration Server in Safe Mode
When the Server Automatically Places You in Safe Mode
Generating Thread Dumps
Generating a Dump of an Individual Thread
Generating a Dump of the JVM
Debugging Service Exceptions Using the Error Log
Introduction
Controlling the Level of Exception Logging Detail
Displaying the Error Log
Interpreting the Error Log
Understanding the Service Stack
Understanding the Error Messages
Understanding the Stack Trace
Using Integration Server with Docker
Overview of Docker and Integration Server
Recommendations for Using Integration Server with Docker
About the is_container Script
is_container Script Commands
Prerequisites for Building a Docker Image
Excluding Web Services Support from a Docker Image for Microservices Runtime
Specifying Services to Expose to Consumers in webMethods Cloud
Building the Docker Image for an Integration Server Instance
Loading a Docker Image to an On-Premise Docker Registry
Pushing a Docker Image to an On-Premise Docker Registry
Running the Docker Image in an On-Premise Docker Container
Writing the Server Log to the Console
Writing Audit Logs to the Console
Accessing an Integration Server Running in a Docker Container
Externalizing Log and Configuration Files When Running Integration Server in a Docker Container
Pushing the Docker Image to Integration Cloud
Running the Docker Image in Integration Cloud
Stopping a Docker Container for Integration Server
Using a Configuration Variables Template with a Docker Image
Integration Server Administrator API
Introduction to the Administrator API
Authentication and Authorization
REST URL Structure
CRUD Operations
Administrative Actions
Credentials
Expanding Responses
Media Type for Responses
Media Type for Request Payloads
Getting Started
Controlling Access to the Administrator API
Creating a Read-Only Administrators Group
Logging Client Errors
Including a Stack Trace in the Response Body
Integration Server Administrator API Operations
Simulating Metering in Integration Server
About webMethods Metering
About the Metering Simulator
Enabling the Metering Simulator
Controlling JSON Output
Controlling Date Encoding in JSON Responses
Formatting JSON Output to Make it More Readable
Using Command Central to Manage Integration Server
An Overview of Command Central
Integration Server Instance Management
Creating Instances Using Command Central Web User Interface
Updating Instances Using Command Central Web User Interface
Deleting Instances Using Command Central Web User Interface
Managing Instances Using the Command Central Instance Management Commands
Accessing Integration Server Administrator through Command Central
Changing the Authentication Mode
Changing the Administrator User Password for Integration Server in Command Central
Configuring Integration Server for SSL Connection
Monitoring Integration Server Instances
Run-time Monitoring Statuses for IntegrationServer-instanceName
Run-time Monitoring States for IntegrationServer-instanceName
Monitoring KPIs of Integration Server Instances
Integration Server Configuration Types
Configuration Types that IntegrationServer-instanceName Supports
Working with Integration Server Configuration Types
Lifecycle Actions for Integration Server
Commands that Integration Server Supports
Using Unix Shell Scripts to Change Connection Credentials for Managed Products
Command Central Command Line Tool Upgrade
Integration Server Deployment Checklist
Introduction
Stage 1: Installation
Stage 2: Basic Configuration
Stage 3: Setting Up Users, Groups, and ACLs
Stage 4: Publishing Packages
Stage 5: Installing Run-Time Classes
Stage 6: Preparing Clients for Communication with the Server
Stage 7: Setting Up Security
Stage 8: Startup and Test
Stage 9: Archive Sources
Server Configuration Parameters
Introduction
watt.adapters.
watt.adminapi.
watt.art.
watt.broker.
watt.brokerCoder.
watt.cachedirective.
watt.cds.
watt.client.
watt.config.
watt.core.
watt.debug.
watt.debug2.
watt.frag.
watt.infradc.
watt.net.
watt.security.
watt.server.
watt.serverlog.
watt.ssh.
watt.ssl.
watt.tx.
watt.um
watt.wm.tnextdc.
watt.wmcloud.
Statistics Data Collector Configuration Parameters
Environment Variables
Environment Variables Defined in Integration Server and Microservices Runtime
FIPS 140-2 Compliance
FIPS 140-2 Compliance
Using NTLM Authentication when Integration Server Acts as the Client
Overview
Using Java-Based NTLM Support
Using Native NTLM Support via Integrated Windows Authentication
Activating Integrated Windows Authentication
Deactivating Integrated Windows Authentication
Removing User Data from Integration Server
Removing User Data
Removing References to a User Account
Removing References to Email Addresses
Removing Personal Data from Log Files
Removing Personally Identifiable Information from the Server Log
Removing Personally Identifiable Information from the Session Log
Removing Personally Identifiable Information from the Service Log
Removing Personally Identifiable Information from the Security Log
Removing Personally Identifiable Information from the SSL Session Log
Removing Personally Identifiable Information from the Configuration Variables Log
Removing Personally Identifiable Information from the HTTP Log
Removing Personally Identifiable Information Logged by Axis2, Kerberos, SAML, and other Third Party Libraries
Masking Session IDs in Integration Server Session and Server Logs
Server Log Facilities
About Server Log Facilities
Integration Server
WmJSONAPI Package
WmParquet Package
WmXSLT Package
Flat File
webMethods Task Engine User’s Guide
Deprecation of webMethods Broker
Deprecation of webMethods Broker
Understanding webMethods Tasks
Task Overview
Task Runtimes and Relationship with Software AG Designer
About Tasks and Task Types
Task Interaction with Users, Groups, and Roles
About User Information in Tasks and Task Engine Logs
Task Assignments, Events, and Rules
Task Assignment
Task Status and Life Cycle
How Permission-Based Access Affects Tasks
About Scheduling Tasks
About Collaboration Tasks
How Collaboration Tasks Differ from Standard Tasks
Using Collaboration Tasks in a Process
Using Collaboration Tasks Manually
About Collaboration Processes
About the Relationship Between Parent Tasks and Collaboration Tasks
About Collaboration Tasks and Task Business Data
Key Points About Collaboration Tasks
About Task Comments and Attachments Sharing
About E-form Integration with Tasks
About Task E-mail Notifications
Replying to a Notification without a My webMethods Connection
Permissions Required to Work with Task Notifications
About Mobile Task Integration
Where to Find Tasks in My webMethods
Monitoring Tasks in My webMethods
About My Inbox
About Task Actions
About Task List Management
About Task Type Inboxes
About Task Charts
Working with Tasks in My webMethods
About Task Inboxes
Viewing and Opening Tasks in the Task Inboxes
Selecting Tasks in Task Inboxes
Sorting Tasks in the Task Inboxes
About Duplicate Task Type Names in the My Inbox Results
Viewing Detailed Information About a Task
About the Data View
About the Details View
About the Audit View
About the Task Comments View
About the New Comments/Edit Comments Panel
About the Collaboration Tab
About the New Collaboration Task Panel
Customizing the Task Inbox Search Options
Searching and Filtering the Task List
Filtering and Searching in My Inbox
Searching in a Task Type Inbox
Customizing the My Inbox and Task Type Inbox Results List
Directing a Task to a User
About Task Assignment
Differences in Task Assignment and Delegation
Working with the Select Principals and Select Users Dialog Boxes
Assigning a Task from a Task Inbox
Viewing Task Assignments
Unassigning a Task
Delegating a Task
Accepting a Task
Releasing a Task
Delegating Tasks
Delegating a Task from Your Inbox
Removing a Delegation
Viewing Task Delegations
Scheduling Task Delegation
Scheduling a Task Delegation
Deleting a Scheduled Task Delegation
Viewing Scheduled Task Delegations
Working with Attachments
Working with Comments and Attachments in the Comments Tab
Adding a Comment to a Task
Updating a Comment in a Task
Deleting a Comment from a Task
Adding an Attachment to a Task
Updating an Attachment in a Task
Deleting an Attachment from a Task
Working with Attachments in an Attachments Panel
Attaching a File to a Task
Viewing an Attached File
Downloading an Attached File
Updating an Attached File
Removing an Attached File
Working with Notifications
Subscribing to a Task Notification for Your Own User Account
Unsubscribing from a Task Notification for Your Own User Account
Subscribing to a Notification Rule for Other Users
Unsubscribing from a Notification Rule for Other Users
Responding to an E-mail Notification
Working with E-form Data in Tasks
Downloading an E-form from a Task
Uploading an E-form to a Task
Exporting the Contents of a Task Inbox or Task List
Other Task Actions
Submitting a Task
Completing a Task
Working with Collaboration Tasks
Creating a Collaboration Task
Viewing a Collaboration Task
Opening a Task on the Collaboration Tab
Modifying the Collaboration Task Display
Modifying a Collaboration Task
Deleting a Collaboration Task
Searching for Collaboration Tasks
Working with Collaboration Processes
Viewing Collaboration Process Details
Searching for Collaboration Processes
Completing a Collaboration Process
Viewing Collaboration Processes in webMethods Monitor
Managing Tasks from the Task List Management Page
Overview
Viewing Tasks on the Task List Management Page
Selecting Tasks in Task List Management
Sorting Tasks in the Task Results List
About Duplicate Task Type Names in the Task List Management Results
Customizing the Task List Management Search Options
Customizing the List of Task Results
Filtering and Searching the Task Management List
Viewing Task Details
Managing Tasks
Suspending a Task
Resuming a Task
Assigning a Task from the Task List Management Page
Unassigning a Task from a User, Group, or Role
Accepting a Task for a User
Setting the Task Status
Deleting a Task
Process Implications When Deleting a Task
Delegating a Task from One User to Another
Removing All Task Delegations
Scheduling a Task Delegation
Modifying Task Properties
Rolling Back a Task
Administering Tasks
Configuring Task Permissions
About Access Permissions
Configuring Task Access Permissions
Limitations When Denying Access to My Inbox
About Functional Permissions
Configuring Global Task Functional Permissions
About Task Type Functional Permissions
Configuring Task Type Functional Permissions
Configuring Task Support for a User
Subscribing Users to Notifications
Configuring Support for Collaboration Tasks
Administering Task Types
Administrative Considerations for Task Publishing
Considerations When Publishing Task Types with Duplicate Names
About Optimized Task Type Publishing
Forcing a Full Publication of a Task Application
Searching for Task Type Instances
Deleting All Task Type Instances
Disabling and Enabling a Task Type
Disabling and Enabling Task Analytics
Disabling and Enabling Comments and Attachments
Disabling and Enabling Task Collaboration
Disabling and Enabling Task Data Sharing
Specifying Allowed Collaboration Tasks
Setting Display Options for the Collaboration Process Diagram
Administering Indexed Task Business Data
About Business Data Field Searches
Considerations When Publishing Task Types with Indexed Data
Reindexing Task Business Data
Considerations when Reindexing Task Business Data
Indexing Considerations in a Clustered Environment
Deleting a Task Type from My webMethods Server
Deleting a Task Application from My webMethods Server
Starting a New Task
Modifying Task Types in My webMethods Server
About Task Type Rules and Events
Viewing Task Type Rules in My webMethods
Administering Task Types with Date/Time Events
Recalculating Date/Time Events for a Single Task Type
Recalculating Date/Time Events for All Task Types
Scheduling Date/Time Event Recalculation for a Task Type
Configuring a Custom Data Source
Working with Global Task Rules
Managing Global Rules
Creating a Global Task Rule
Modifying a Global Task Rule
Copying a Global Task Rule
Removing a Global Task Rule
Changing the Rule Evaluation Order
Disabling Auditing for Task Rules
Specifying Task Audit View Logging Levels
Working with Task Charts
Viewing and Refreshing Charts on the Task Charts Page
Configuring a Task Chart
Working with Task Chart Portlets
Creating a Task Chart Portlet
Renaming a Task Chart Portlet
Placing Task Portlets on Other Pages in My webMethods
Deleting and Hiding Task Type Entries in My webMethods
Deleting a Task Type Inbox Entry
Hiding and Displaying a Task Type Inbox Entry
Deleting a Task Type Page
Hiding and Displaying a Task Type Page
Analyzing Task Engine Runtime Performance
Administering Task EDA Event Emission
About Global Settings for EDA Events
Enabling and Disabling Global EDA Event Emission for Tasks
Enabling and Disabling EDA Event Emission for a Task Type
About EDA Predefined Task Event Types
About Task Event Schemas
EDA Task Event Element Definitions
The EDA Predefined Task Event Type
Key Supporting Schemas
Importing the EDA Predefined Event Type Project in Designer
Exporting Task EDA Event Settings
Exporting and Importing Task Types at Run Time
Exporting and Importing a Task Type
Exporting Settings for a Task Type
Importing Settings for a Task Type
Archiving Tasks
About Task Archiving
Configuring Task Archiving
Modifying the Task Archiving Schedule
Triggering the Task Archiving Rule
Example: Task Archiving Configuration
Searching and Viewing Archived Tasks
Running Task Engine on Integration Server
About Task Engine on Integration Server
About Task Engine Packages on Integration Server
About Services in the WmTaskEngine Package
Installation Requirements and Post-Installation Steps
Using Task Engine on Integration Server with the webMethods Suite
Configuring the Task Engine Environment
About the Task Engine Configuration
Running Task Engine with Docker
Running Task Engine in a Clustered Environment
Configuring Task Engine in My webMethods
Configuring the Task Engine Logging Level
Configuring HPSTRA
Configuring a JDBC Data Source
Creating a Task Time-to-Live Eviction Policy
Working with Business Calendars
Creating a Business Calendar
Specifying a Default Business Calendar
Modifying a Business Calendar
Deleting a Business Calendar
Specifying a Business Calendar for a User Account
Working with Personal User Calendars
Configuring User Calendars — Microsoft Exchange
Configuring User Calendars — Lotus Notes
Installing the notes.jar File
Configuring the IBM Lotus Domino Server
Configuring a Task E-mail Listener
Managing Task E-mail Listeners
About E-mail Listener Security
About E-mail Listener Behavior
Running an E-mail Listener in a Clustered Environment
Configuring Task Analytics
About the Task Metrics Event Map
Working with the Task Metrics Event Map
Configuring a webMethods Broker (Deprecated) or JMS Server Connection and Deploying Event Maps
About Modifying the Task Analytics Schema
Configuring an E-form Environment
Applying Task Engine Optional Settings
Configuring the WmTaskClient Package
Specifying a User Account for the WmTaskClient Package
About WmTaskClient and Session Pooling
Configuring Task Service Retry and Timeout Values
Configuring Task Client in Integration Server or Microservices Runtime Containers
Configuring Task Engine on Integration Server
About Task Engine Logging
Task Engine Logging Configuration files
Modifying the Logging Configuration Files
Configure Logging for Task Engine on Integration Server
Applying Task Engine Optional Settings
About Task Engine Optional Settings
Allow Attachment Download for Task Instances
Allow Empty Business Data Field
Completed Task Re-Delivery Count
Completed Task Re-Delivery Interval
Disable Task Engine Initialization on Integration Server Start-up
Disable/Enable Task Logging in Processes
Limit the Number of Tasks Returned to a Results List
Look Up Principal Retry Behavior
Look Up Principal Retry Timeout
Maximum Thread Count
Preload the Task Cache at Startup
Remote Session Timeout Values
Return of Empty Documents
Return Order of Task Data Fields
Set Conditions for Task Preloading
Suppress Task Deleted Events
Synchronous Cluster Updates
Task Event Processing Wait Time
Task Locking in a Cluster Environment
Task Lock Timeout Values
Task Permission Checking Behavior
Task Search Thread Count
Task Update Behavior
Task Update Thread Count
Adjust for Network Latency in Service Call to Task Engine
Change the Default User for Services in the WmTaskClient Package
Turn on Oracle Database Hints
Using Command Central to Manage Task Engine
Administering Task Engine
About Administering Task Engine on My webMethods Server
Commands that Task Engine Supports
Configuration Types that Task Engine on My webMethods Server Supports
Run-Time Monitoring Statuses for Task Engine
About Administering Task Client
About Administering Task Client
Commands that WmTaskClient Supports
Configuration Types that WmTaskClient Supports
Run-Time Monitoring Statuses for WmTaskClient
Administering Task Engine on Integration Server
About Administering Task Engine on Integration Server
Commands that Task Engine on Integration Server Supports
Configuration Types that Task Engine on Integration Server Supports
Run-Time Monitoring Statuses for Task Engine on Integration Server
Adding a Cluster Configuration Endpoint for Task Engine on Integration Server
Configuring System Properties for Task Engine on Integration Server
Configuring Task Engine Variables
Considerations when Configuring Task Engine Variables in Command Central
Task Expression Reference
About Task Expressions
Understanding Task Expressions
About Condition Expressions
About Filter Rule Expressions
About Results Expressions
About Expression Operators
About Date/Time Values in Rule Expressions
About Global Rule Expressions
Expressions for Default Global Rules
Infinite Loop Rule
Delete a Task Rule
Example Global Rule - Expire Task
Connecting Apama Applications to Digital Event Services
Apama
webMethods API Gateway Documentation
webMethods API Gateway Documentation
About this Documentation
Document Conventions
Online Information and Support
Data Protection
Getting Started with API Gateway
Let's get you started
API Gateway Overview
Quick Start Milestones
Install API Gateway
How Do I Install API Gateway?
How Do I Install API Gateway using an Image in Windows system?
How Do I Install API Gateway using an Image in Linux system?
How Do I Install API Portal?
Getting Started
How Do I Launch and Log on to API Gateway?
How Do I Launch and Log on to API Portal?
Create an API
How Do I Create an API?
How Do I Create an API by Importing from a File?
How Do I View API Details?
How Do I Enforce Policies to Protect My APIs?
How Do I Enable Transaction Logs?
Publish an API
How Do I Configure Destination for Publishing APIs?
How Do I Publish an API?
How Do I View the published API?
Try an API
How Do I Request API Key to Access a Protected API?
How Do I Test a REST API in API Portal?
API Analytics
How Do I View API Analytics?
Quick Start.. In a Jiffy!
Quick Start Cheat-sheet
Administrating API Gateway
Deployment
API Gateway Deployment
Connecting to an External Elasticsearch
Connecting to an External Kibana
API Gateway, Elasticsearch, Kibana Compatibility Matrix
Troubleshooting Tips: External Elasticsearch
Protected Deployment
Configuring Reverse Invoke Setup
Protected Deployment with Integration Server in Green Zone
Importing a Certificate and Mapping to User
Troubleshooting Tips: API Gateway and DMZ Connectivity
Cluster Deployment
Configuring an API Gateway Cluster
API Gateway Cluster Configuration
Enabling Clustering for API Gateway through the User Interface
Terracotta Server Array Configuration
API Data Store Cluster Configuration
Configuring Elasticsearch Cluster
Adding New Nodes to an Elasticsearch Cluster
Load Balancer Configuration
Ports Configuration
Troubleshooting Tips
Troubleshooting Tips: API Gateway Cluster Environment
Configuring Multiple Instances of API Gateway in a Single Installation
Externalizing Configurations
Using the Externalized Configuration Files
Default Scenario
Troubleshooting
Operating API Gateway
Accessing the API Gateway User Interface
Starting and Stopping API Gateway
Starting and Stopping API Gateway Using Scripts
Restarting API Gateway Using User Interface
Monitoring
Cluster-level Monitoring
Troubleshooting: Cluster-level Monitoring
Node-level Monitoring
Application Monitoring
Monitoring API Gateway
Container Metrics
Troubleshooting: Monitoring API Gateway
How Do I Generate Thread Dump?
How Do I Generate Heap Dump?
Causes for timeout errors
Monitoring API Data Store
Container Monitoring Metrics
Troubleshooting: Monitoring API Data Store
Monitoring Terracotta
Container Metrics
Troubleshooting: Monitoring Terracotta Server Array
Monitoring Kibana
Troubleshooting Tips: Monitoring Performance
Application Log Configurations
Configuring Log Levels
Downloading the Log Files
Configuring Log Aggregation
Log Aggregation Flavors
Logs Housekeeping
Overview of Administration Tasks
General Configuration
Clusters and Load Balancers
Configuring Load Balancer URLs
Configuring Extended Settings
Configuring API Fault Settings
Approval Configuration
Configuring Approvals for Creating an Application
Configuring Approvals for Registering Application
Configuring Approvals for Updating Application
Configuring Approvals for Subscribing Package
Configuring Approvals for Updating Subscription
Configuring Approvals for Deleting Subscription
Managing Pending Requests
Deleting Requests
Outbound Proxy
Configuring Proxy Server Alias
Modifying a Proxy Server Alias
Deleting a Proxy Server Alias
Proxy Bypass
Adding a Proxy Bypass
Modifying a Proxy Bypass
Deleting a Proxy Bypass
URL Aliases
Creating URL Alias
Using Port Mappings with URL Alias
Adding Port Mapping to URL Alias
Deleting Port Mapping for URL Alias
Enabling Partial Matching of URL Aliases
Modifying a URL Alias
Deleting a URL Alias
Example: Usage Scenarios of URL Aliases
Custom Content-types
Configure Custom Content-types
Cache Configuration
Configuring Cache to Improve Performance
License Configuration
Viewing Licensing Information
Configuring Licenses
Configuring API Callback Processor Settings
Messaging
Creating a JNDI Provider Alias
Creating a JMS Connection Alias
Web Services Endpoint Alias
Creating an Endpoint Alias for a Provider Web Service Descriptor
Creating an Endpoint Alias for a Consumer Web Service Descriptor
JMS Triggers
Updating JMS triggers
Transaction Alerts
Configuring Criteria for Transaction Alert Notification
Modifying License Alert Configurations
Deleting a Transaction Alert Configuration
Destination Configuration
Configuring Events for API Gateway Destination
Troubleshooting Tips: API Gateway Destination
Configuring API Portal Destination
Configuring Events for API Portal Destination
Configuring Transaction Logger Destination
Configuring CentraSite Destination
Configuring Events for CentraSite Destination
Configuring Events for Database Destination
Configuring Events for Digital Events Destination
Configuring Elasticsearch Destination
Troubleshooting Tips: Elasticsearch Destination
Configuring Events for Elasticsearch Destination
Configuring Email Destination
Configuring Email Templates
Configuring SNMP Destination
Configuring Events for SNMP Destination
Troubleshooting Tips: API Gateway - API Portal Integration
Audit Logging
Configuring Audit Logs
Viewing Audit Logs
Filtering Audit Log Results
Downloading Audit Logs
Data Management
Types of data and their storage
Difference between backup and archive
Data housekeeping
Archive and purge using API
Archive and purge using UI
Archiving Data
Data archiving considerations
Purging Data
Data purging considerations
Job Listing
Restoring Archived Data
Archive and Purge Configuration
Data backup
Backup requirements analysis
Backup repository sizing analysis
Backup considerations
Backup Operation
Data Store Backup
Configuring a Backup Repository
Configuring a Local File System Repository
Configuring a Network File System Repository
Configuring a Cloud Repository in Amazon S3
Creating API Data Store Backup
Advanced Backup Options
Creating Backup of specific Indexes
Creating Rollover of an Index
Conditions that can be given with rollover command
Viewing Backup Files List
Verifying Backup Status
Deleting a Backup File
Specifying Log File Details
Troubleshooting a Failed Backup
Viewing Exit Codes for Backup Script Operations
List of Indexes that can be included in backup
List of Indexes that can be backed up individually
Platform Data Backup
Creating Platform Data Backup using Script
Creating Platform Data Backup using File System Backup
Restore Operation
Restoring Data Store Backup
Verifying Restore Status
Troubleshooting a Failed Restore
Restoring Platform Data
Renaming Data Store Windows Service
Troubleshooting Tips: API Data Store Backup
Adding New Nodes to an Elasticsearch Cluster
System Settings
Modifying API Gateway Configuration Parameters
External Accounts
Adding a Service Registry
Removing a Service Registry
Configuration Types and Properties
webApp Configuration Properties
API Gateway Package Configuration Properties
Troubleshooting Tips: API Data Store (Elasticsearch)
Security Configuration
Overview
Keystore and Truststore
Configuring Keystore Information
Modifying Keystore Information
Deleting Keystore Information
Configuring Truststore Information
Modifying Truststore Information
Deleting Truststore Information
Configuring Keystore and Truststore Information for Inbound Messages
Configuring Keystore and Truststore Information for Outbound Connections
Ports
Adding an HTTP Port
Adding an HTTPS Port
Adding an API Gateway External Port
Configuring the API Gateway Internal listener
Configuring the WebSocket Listener
Configuring IP Access Mode for a Port
Allowing Access to All IP Hosts
Denying Access to All IP Hosts
Configuring Access Mode for a Port
Global IP Access Settings For Ports
Allowing Connections from Specified Hosts
Denying Connections from Specified Hosts
If You Inadvertently Deny IP Access to All Hosts
Configuring Restriction to IP Address based on Authentication
SAML Issuer
Custom Assertions
Creating a Custom Assertion
Viewing Custom Assertion List and Assertion Configuration
Modifying Custom Assertion
Deleting Custom Assertion
Example: Custom Assertions
Kerberos Settings
Configuring API Gateway to Use Kerberos
Master Password Management
Backing up the Password and Master Password Files
Updating the Master Password
Managing Master Password Expiry Interval
Advanced Configuration to Manage Master Password
Restoring the Password and Master Password Files
Resetting the Master Password
OAuth, JWT, and OpenID Configuration
OAuth Authentication Use case and Workflow
Retrieving OAuth Token
JWT Authentication Use case and Workflow
Retrieving JWT Token
Retrieving JWT Token with Claim
OpenID Authentication Use case and Workflow
Configuring the Internal Authorization Server
Adding a Provider
Adding an External Authorization Server
Mapping OAuth or OpenID Scopes
Viewing Scope Mapping Details
Viewing Provider List and Provider Configuration
Modifying the Provider Configuration
Viewing Authorization Server List and Server Configuration
Modifying Authorization Server Configuration
Deleting an Authorization Server
Deleting a Provider
Configuring Communication Details for Microgateway
Securing API Gateway Server Communication using SSL or TLS
How Do I Secure API Gateway Server Communication with API Clients?
How Do I Secure API Gateway Server Communication with Backend Services?
How do I Secure API Gateway User Interface Communication?
How do I Configure a Secure Communication Channel between API Gateway and API Portal?
How do I Secure API Data Store Communication using HTTPS?
How do I Secure API Data Store Communication using HTTPS with ReadonlyREST Plugin?
How do I Secure API Data Store Communication using HTTPS?
Search Guard Properties
Creating a Custom Keystore with Self-Signed Certificates
Troubleshooting Tips: Securing API Data Store (Elasticsearch)
Container-based Provisioning
Docker Configuration
Building the Docker Image for an API Gateway Instance
Retrieving Port Information of the API Gateway Image
Running the API Gateway Container
Load Balancer Configuration with the Docker Host
Stopping the API Gateway Container
Managing API Gateway Images
API Gateway Docker Container with Externalized Elasticsearch and Kibana
API Gateway Container Cluster Configuration
Running API Gateway Docker Containers with Docker Compose
Running a Single API Gateway and an Elasticsearch Container
Running Clustered API Gateway Containers and Elasticsearch Containers
Running Clustered API Gateway and Elasticsearch Containers and a Kibana Container
Troubleshooting Tips: Docker Configuration
Kubernetes Support
Deploying API Gateway Pod with API Gateway and Elasticsearch Containers
Deploying API Gateway Pod with API Gateway Container connected to an Elasticsearch Kubernetes Service
API Gateway Clustering on Kubernetes
Kubernetes Sample Files
Helm Chart
Using Helm to Start the API Gateway Service
OpenShift Support
Building a Docker Image for an API Gateway Instance in OpenShift Environment
Running the API Gateway Docker Image with the sagadmin User
OpenShift Sample Files
High Availability and Disaster Recovery
High Availability
High Availability vs Fault Tolerance
Keypoints about High Availability and Disaster Recovery (HADR) solution
Keypoints about High Availability and Fault Tolerance (HAFT) solution
High Availability through Disaster Recovery
What is Cold Standby Mode?
How Do I Set Up Data Center in Cold Standby Mode?
How Do I Take a Backup of Asset Data
What is Warm Standby Mode?
How Do I Set Up Data Center in Warm Standby Mode?
Fault Tolerance
What is Hot Standby Mode?
How Do I Set Up the Data Centers in Hot Standby Mode Using Basic Operation?
How Do I Set Up the Data Centers in Hot Standby Mode Using Composite Operation?
What is Active-Active Mode?
How Do I Set Up the Data Centers in Active-Active Mode Using Basic Operation?
How Do I Set Up the Data Centers in Active-Active Mode Using Composite Operation?
Data Synchronization in Hot Standby and Active-Active Modes
How does Cross-DC Support Detect Data Center Failures?
How Do I Monitor the Health Status of the Data Center?
How Do I Bring Down a Single Data Center from Active-Active or Hot Standby Mode to Standalone Mode?
How Do I Bring Down Multiple Data Centers from Active-Active or Hot Standby Mode to Standalone Mode?
How Do I Read the Current Configuration of the Data Center?
Cross-DC Extended Settings
Performance Tuning and Scaling
Hardware and Product Configurations
Resource Sizing Guidelines
Logging Configurations
Product Configurations Guidelines
Changing the JVM Heap Size to Tune API Gateway Performance
API Gateway Configuration with Command Central
Overview
Install API Gateway using Command Central
Installing API Gateway using Command Central Commands
Manage API Data Store Configurations in Command Central
Administering API Data Store
Starting, Stopping, and Restarting API Data Store
Starting and Stopping API Data Store in Command Central
Starting, Stopping, and Restarting API Data Store on Windows
Starting, Stopping, and Restarting API Data Store on LINUX
Changing the API Data Store HTTP Port
Changing the API Data Store HTTP Port using Template
Changing the API Data Store TCP Port
Configuring an API Data Store Cluster
Configuring Data Store Cluster using Template
Configuring Custom API Data Store Properties
Configuring Elasticsearch Properties
Configuring Elasticsearch Properties using Template
Monitoring API Data Store
Manage API Gateway Product Configurations in Command Central
Configuring Properties
Configuring Keystores
Configuring Keystores using Template
Configuring Licenses
Configuring Loggers
Configuring HTTP Port
Configuring HTTPS Port
Configuring HTTPS Port using Template
Configuring Truststores
Configuring Truststores using Template
Manage Inter-component and Cluster configurations
Configuring Elasticsearch Connection Settings
Configuring External Elasticsearch using Template
Configuring Kibana Connection Settings
Configuring Kibana using Template
Configuring API Gateway Cluster
Configuring Cluster using Template
Command Line to Manage API Data Store
Commands that API Data Store Supports
Configuration Types that API Data Store Supports
Run-Time Monitoring Statuses for API Data Store
Lifecycle Actions for API Data Store
Troubleshooting Tips: API Gateway Configuration with Command Central
Using API Gateway
webMethods API Gateway
Introduction to webMethods API Gateway
Searching Data in API Gateway
Configuring the Number of APIs listed on a Page
Using Help in API Gateway
User Management
Manage Users, Groups, and Teams
Adding a User
Modifying User Details
Deleting a User
User Groups
Adding a Group
Modifying a Group
Deleting a Group
API Gateway Functional Privileges
Setting Password Restrictions
Setting Password Expiry Restrictions
Configuring Account Locking Settings
Unlocking User Accounts
Restricting User Accounts
Configuring API Gateway to Use LDAP
Managing LDAP Directories
Manage Your User Settings and Preferences
Changing Your Account Settings
Changing Your Password
Changing Your Display Language
Viewing Your Roles and Permissions
APIs
Creating APIs - Overview
Creating an API by Importing an API from a File
Creating an API by Importing an API from a URL
Creating an API from Scratch
Overview of Creating a REST API from Scratch
Creating a REST API
Creating a WebSocket API
API Mashups
Creating an API Mashup
Viewing API List and API Details
REST API Details
SOAP API Details
OData API Details
GraphQL API Details
Filtering APIs
Activating an API
Deactivating an API
Publishing APIs
Publishing APIs to API Portal
Publishing a Single API to API Portal
Publishing Multiple APIs to API Portal in a Single Operation
Publishing APIs to Service Registries
Publishing a Single API to Service Registries
Publishing Multiple APIs to Service Registries in a Single Operation
Unpublishing APIs
Unpublishing APIs from API Portal
Unpublishing a Single API from API Portal
Unpublishing Multiple APIs from API Portal in a Single Operation
Unpublishing APIs from a Service Registry
Unpublishing a Single API from Service Registries
Unpublishing Multiple APIs from Service Registries in a Single Operation
Modifying API Details
Updating APIs
Updating an API by Importing an API from a File
Updating an API by Importing an API from a URL
API Mocking
Enabling API Mocking
Modifying API Mocking Details
Custom Replacer
Attaching Documents to an API
SOAP to REST Transformation
Activating SOAP to Rest Transformation
Modifying the REST Definitions for SOAP Operations
Supported Content-types and Accept Headers
REST API Endpoints
Samples for REST Request
Limitations
CentraSite Provided APIs
Versioning APIs
Creating New API Version
API Scopes
Creating an API Scope
Viewing List of API Scopes and Scope Details
Modifying API Scope Details
Deleting an API Scope
Example: Usage Scenarios of API Scopes
Exposing a REST API to Applications
Exposing a SOAP API and GraphQL API to Applications
API Grouping
API Tagging
Adding Tags to an API
Exporting APIs
Exporting Specifications
Deleting APIs
Deleting a Single API
Deleting Multiple APIs in a Single Operation
Example: Managing an API
Troubleshooting Tips: APIs
Policies
Policies - Overview
Policy Validation and Dependencies
Managing Threat Protection Policies
Configuring Global Denial of Service Policy
Configuring Denial of Service by IP Policy
Managing Denied IP List
Configuring Rules
Registering a Mobile Device or Application
Configuring Alert Settings
System-defined Stages and Policies
Variable Framework
Transport
Enable HTTP/HTTPS
Enable JMS/AMQP
Configuring API Gateway for JMS with AMQP Protocol
Using Enable JMS/AMQP for a SOAP API
Using Enable JMS/AMQP for a REST API
Set Media Type
Identify and Access
Inbound Auth - Message
Authorize User
Identify & Authorize
Request Processing
Invoke webMethods IS
Request Transformation
Validate API Specification
Data Masking
Routing
Content-based Routing
Conditional Routing
Dynamic Routing
Load Balancer Routing
Straight Through Routing
Custom HTTP Header
Outbound Auth - Transport
Outbound Auth - Message
JMS/AMQP Policies
JMS/AMQP SOAP Routing
JMS/AMQP REST Routing
JMS/AMQP Properties
Traffic Monitoring
Log Invocation
Uncompressing a payload
Monitor Performance
Monitor Level Agreement
Traffic Optimization
Service Result Cache
Response Processing
Invoke webMethods IS
Response Transformation
Validate API Specification
CORS
Data Masking
Error Handling
Conditional Error Processing
Data Masking
System Context Variables
The API for Context Variables
Managing Global Policies
Creating a Global Policy
Modifying the Scope of a Global Policy
Refining the Scope of a Global Policy
Associating Policies to a Global Policy
Configuring Properties for a Global Policy
Viewing List of Global Policies and Policy Details
Modifying Global Policy Details
Activating a Global Policy
Deactivating a Global Policy
Deleting a Global Policy
Copying a Global Policy
Exporting Global Policies
Managing API-level Policies
Assigning a Policy to an API
Viewing API Policy Details
Modifying API Policy Details
Managing Scope-level Policies
Creating a Scope-level Policy
Viewing List of Scope-level Policies and Policy Details
Modifying Scope-level Policy Details
Deleting a Scope-level Policy
Managing Policy Templates
Creating a Policy Template
Associating Policies with a Policy Template
Configuring Properties for a Policy Template
Viewing List of Policy Templates and Template Details
Modifying Policy Template Details
Deleting a Policy Template
Copying a Policy Template
Applying a Policy Template on the API Details Page
Modifying a Policy Template on the API Details Page
Saving Policy Definition of an API as Policy Template
Supported Alias and Policy Combinations
Aliases
Overview
Creating a Simple Alias
Creating an Endpoint Alias
Creating an HTTP Transport Security Alias
Creating a SOAP Message Security Alias
Creating a webMethods Integration Server Service Alias
Creating an XSLT Transformation Alias
Applications
Overview
Creating an Application
Viewing List of Applications and Subscriptions
Regenerating API Access Key
Modifying Application Details
Registering an API with Consumer Applications from API Details Page
Suspending an Application
Activating a Suspended Application
API Packages and Plans
Overview
Creating a Package
Creating a Plan
Activating a Package
Publishing a Package
Viewing List of Packages and Package Details
Viewing List of Plans and Plan Details
Viewing a List of Subscriptions
Modifying a Package
Deleting a Package
Modifying a Plan
Deleting a Plan
Export and Import Assets and Configurations
Overview
Importing Asset and Configuration Archives
Troubleshooting Tips: Import and Export Assests
API Gateway Analytics
Analytics Dashboards
API Gateway Dashboard
API-specific Dashboard
Creating custom dashboards
Runtime Events and Metrics Data Model
API Gateway
API Portal
Audit Log
CentraSite
Elasticsearch
Email
JDBC
Local Log
Microgateway Management
Overview
Microgateway Groups
Microgateway Group Analytics
Microgateway Details
Deleting Microgateway Instances
Deleting a Microgateway
Deleting Multiple Microgateways
REST APIs in API Gateway
API Gateway Administration
Alias Management
Application Management
API Gateway Archive
API Gateway Availability
Document Management
Data Center Management
Internal Service
Port Configuration
Policy Management
Promotion Management
Public Services
API Gateway Search
Server Information
Service Management
Transaction Data
User Management
Subscription Management
Backward compatibility support for REST APIs
Remove User Data from API Gateway
Removing User Data
Usage Scenarios
Change Ownership of Assets
How Do I Change the Ownership of an Application?
How Do I Change the Ownership of an API?
How Do I Change the Ownership of Multiple Assets?
How Do I Configure the Approval Process for Ownership Change of Assets?
Custom Policy Extension
How Do I Invoke an API through HTTP or HTTPS using Custom Extension?
How Do I Invoke an IS Service using a Custom Extension?
How Do I Invoke an AWS Lambda Function using Custom Extension?
Configuring an AWS Alias
How Do I Invoke an API Asynchronously through JMS/AMQP using a Custom Extension?
How Do I Define a Custom Variable?
Custom Extension Properties
Data Objects and Variables Available in API Gateway
Team Support
Creating Teams
How do I Assign Teams during Asset Creation?
How do I Assign Teams Using Team Assignment Rule?
How do I Modify Teams Assigned to an API?
How do I Change the Ownership of Multiple Teams?
Enabling Teams Support
Team Support Considerations
API Gateway Functional Privileges
API First Implementation
API First Implementation using Integration Server
Configuring Integration Server Instance for API Implementation
API First Implementation using a Third-party Server
List of Parameters used in API Implementation
Gateway Endpoints
How do I Define API-specific Gateway Endpoints?
How do I Define Global Gateway Endpoint?
How do I Edit Global Gateway Endpoint?
How do I Delete Global Gateway Endpoint?
Other Gateway Endpoint Usecases
Custom Destination
How Do I Publish Data to an External Endpoint using Custom Destination?
How Do I Publish API-specific Traffic Monitoring Data to a Custom Destination?
How Do I Publish Data to an Integration Server Service using Custom Destination?
How Do I Publish Data to an AWS Lambda Function using Custom Destination?
How Do I Publish Data to a Message Queue using Custom Destination?
Secure API using OAuth2 with refresh token workflow
Configuring OAuth2 Authentication with Refresh Token
Refresh Token Process Flow
How to get the access token with resource owner permission?
How to get the access token without resource owner permission using refresh token in the subsequent attempts?
SAML SSO
SAML Assertion
How to enable SAML SSO in API Gateway?
Precedence in Group Mapping
Troubleshoot tips for SSO configuration
Request and Response Processing
Request and Response Transformation Policies
How do I transform a request using Request Transformation Policy?
Request Transformation Policy Properties
How do I transform a request and its response using Transformation Policy?
Response Transformation Policy Properties
Invoke webMethods IS Policy
How do I transform a request using Invoke webMethods IS policy?
Invoke webMethods IS Policy Properties for Request Processing
How do I transform a response using Invoke webMethods IS policy?
Invoke webMethods IS Policy Properties for Response Processing
Securing Access Token Calls with PKCE
How do I enforce PKCE globally?
How do I secure the access token with Authorization Code (With PKCE) grant type using postman?
How do I secure the access token by directly calling API Gateway's REST APIs?
How do I enforce PKCE selectively for each access token call?
How do I generate code verifier and code challenge using JAR files?
Trace API
How do I enable tracing?
How do I filter the runtime request?
How do I view the trace details?
How do I inspect failed runtime requests using tracer?
How do I import runtime requests?
How do I export or download runtime requests?
How do I archive or purge the tracer details?
How do I archive and purge the tracer details using REST API Calls?
AppMesh Support in API Gateway
Overview of webMethods AppMesh
Configure API Gateway to Connect to a Service Mesh Environment
Creating a Microgateway Image
AppMesh Deployment
Service Discovery
APIfy
Update API Definition and Policies
Deploy AppMesh
Undeploy AppMesh
Provisioning of API and Policy Updates
Staging and Promotion
Stages
Stages, Promotions, and Rollbacks
Manage Stages
Adding a Stage
Viewing Stage List and Stage Details
Modifying Stage Details
Deleting a Stage
Promotion
Manage Promotions
Promoting Assets from API Gateway User Interface
Viewing Promotion List and Promotion Details
Repromoting Assets
Promoting Assets Using Deployer
Promoting Assets Using Promotion Management API
Rollbacks
Manage Rollbacks
Viewing Rollback List and Rollback Details
Upgrading API Gateway
Upgrading
Introduction
Upgrading API Gateway in Zero Downtime
API Gateway Quiesce Mode
Migration of REST APIs
Webhook Notifications
Shutdown REST API
Upgrading Major Versions in Zero Downtime
Start new API Gateway Instance
Clean Data in new API Data Store
Put old API Gateway instance in Quiesce mode for Design Time
Migrate Design Time Data
Transform Design Time Data
Restart new API Gateway Instance
Add traffic to new API Gateway Instance
Put Old API Gateway Instance into Quiesce mode for All
Migrate Logs and Events Data
Shutdown old API Gateway Instance
Upgrading Minor Versions in Zero Downtime
Upgrade Standalone Deployment
Upgrade Cluster Deployment
Upgrading standalone API Gateway using Direct mode
Upgrading standalone API Gateway using Backup mode
Upgrading API Gateway cluster using Direct mode
Upgrading API Gateway cluster using Backup mode
General Migration configurations
Migration recovery
Quiesce Mode
Troubleshooting Tips: Upgrading
Migrating to API Gateway
Migrating from Mediator to API Gateway
Working with Business Rules in My webMethods
About this Guide
Document Conventions
Online Information and Support
Data Protection
Getting Started
Installation and Configuration Information for My webMethods System Administrators
Rules Development Terminology
Understanding the User Interface
The Navigation Pane
The Workspace Area
The Format of the Business Rules Page
The Decision Entity List Window
The Decision Entity Editor Window
The Rule Project Verification Window
Modifying Rule Projects Overview
Working with Decision Tables
Modifying a Decision Table
Adding an Operator and a Literal Value in Direct Edit Mode
Modifying an Operator in Direct Edit Mode
Modifying a Literal Value in Direct Edit Mode
Adding a Condition or Result Value with the Editor
Modifying a Condition or Result Value with the Editor
Clearing a Condition or Result Value
Adding a Rule
Deleting a Rule
Reordering Rules
Assigning a Principal to a Condition or Result Value
Configuring Principal Types
Setting Viewing Preferences for Conditions or Results
Filtering Rules
Setting an In Effect Date at Decision Table Level
Setting an In Effect Date at Rule Level
Working with a Preconfigured Data Provider Service
Configuring a Server Connection for a Preconfigured Data Provider Service
About Condition Operators
About Result Operators
About In Effect Operators
About Data Type Assignment
Working with Decision Trees
Modifying a Decision Tree
Modifying Condition Links or Assignment Result Nodes in Direct Edit Mode
Modifying Condition Links or Assignment Result Nodes with the Editor
Setting and Modifying Labels
Setting a Default Value for a Condition Node
Setting an In Effect Date at Decision Tree Level
Setting an In Effect Date at Branch Level
Showing and Hiding Decision Tree Properties
Expanding and Collapsing Nodes
Zooming In and Out
About Condition Operators
About Result Operators
About In Effect Operators
About Data Type Assignment
Working with Event Rules
Modifying an Event Result
Adding an Operator and a Literal Value in Direct Edit Mode
Modifying an Operator in Direct Edit Mode
Modifying a Literal Value in Direct Edit Mode
Adding a Result Value with the Editor
Modifying a Result Value with the Editor
Clearing a Result Value
About Result Operators
About Data Type Assignment
Global Functions Overview
Opening a Decision Entity
Locking a Decision Entity
Saving Changes to a Decision Entity
Modifying the Description of a Decision Entity
Creating and Modifying Lists with the Inline Editor
About Constants
Rule Verification Overview
About Automatic Verification
Verifying Rules Manually
Working with a Preconfigured Verification Service
Configuring a Server Connection for a Preconfigured Verification Service
Showing or Hiding Suppressed Warnings
About Verification Categories
Hot Deploying Rule Projects to Integration Server
Configuring an Integration Server Connection
Hot Deploying a Rule Project
Hot Deploying and Merging Rule Projects with webMethods Deployer
Configuring My webMethods Server
Working with Expressions
Adding an Expression
Using CSV Import
CSV Formatting
Importing a CSV File
Copyright
Integrate Software AG Products Using Digital Event Services
Copyright
gtw_configure_cluster
gtw_configure_loglevels
gtw_download_logfiles
gtw_configure_log_aggregation
gtw_administration
gtw_gen_config
gtw_configure_load_balancer
gtw_configure_extended_settings
gtw_configure_fault_settings
gtw_configure_approvals
gtw_configure_approvals_create
gtw_configure_approvals_register
gtw_configure_approvals_update
gtw_configure_approvals_subscribe
ta_pending_request
gtw_configure_outbound_proxy
gtw_configure_proxy_bypass
gtw_configure_url_aliases
gtw_custom_content_type
gtw_configure_cache
gtw_license_info
gtw_configure_license
gtw_configure_callback_settings
gtw_jndi_provider_alias
gtw_jms_connection_alias
gtw_jms_triggers
gtw_configure_license_alerts
gtw_configure_gateway
gtw_configure_portal
gtw_configure_portal_events
gtw_configure_audit_logger
gtw_configure_cs
gtw_configure_cs_events
gtw_configure_database
gtw_configure_des
gtw_configure_es
gtw_configure_es_events
gtw_configure_email
ta_configure_email_template
gtw_configure_snmp
gtw_configure_snmp_events
gtw_archive_purge
gtw_restore_data
gtw_archive_purge_config
gtw_configure_system_settings
gtw_service_registries
gtw_sec_config
gtw_configure_keystore
gtw_configure_truststore
gtw_configure_keystore_truststore
gtw_config_key_trust_outbound_connections
gtw_configure_ports
gtw_configure_ipaccessmode
gtw_configure_accessmode
gtw_configure_global_ip
gtw_configure_saml_issuer
gtw_policy_assertions
gtw_configure_policy_assertion
gtw_configure_kerberos
gtw_manage_master_password
gtw_configure_auth_server_int
gtw_configure_provider
gtw_configure_auth_server_ext
gtw_map_oauth_scope
gtw_manage_security_microgateway_communication
gtw_introduction
gtw_search
gtw_manage_users_groups_profiles
gtw_add_user
ta_modify_user
co_user_groups
gtw_add_group
ta_modify_group
gtw_manage_pwd_restrictions
gtw_manage_pwd_expiry_settings
gtw_manage_account_lock_settings
gtw_manage_locked_users
gtw_manage_provider_configuration
gtw_manage_ldap_directories
gtw_manage_user_accounts_settings
gtw_manage_apis
gtw_create_api_file
gtw_create_api_url
gtw_create_api_scratch
gtw_create_rest_api_scratch
gtw_create_websockets_api_scratch
gtw_add_api_mashup
gtw_view_api_details
updating_apis
updating_apis_file
updating_apis_url
api_mocking
ta_modifying_api_mocking
soap_rest_transformation
modifying_rest_definitions
content_type
endpoint
sample_rest_request
limitations
versioning_apis
create_new_versioning_apis
exporting_apis
exporting_specifications
gtw_manage_policies
gtw_manage_threat_protection_policies
gtw_transport_policies
gtw_iam_policies
gtw_payload_request
gtw_routing_policies
gtw_lmt_policies
gtw_payload_response
gtw_error_handling
gtw_manage_global_policies
gtw_create_global_policy
gtw_view_global_policy
gtw_modify_global_policy
exporting_global_policies
gtw_manage_policy_templates
gtw_create_policy_template
gtw_view_policy_template
gtw_modify_policy_template
gtw_apply_policy_template
gtw_manage_aliases
create_is_alias
create_transformation_alias
gtw_manage_applications
gtw_create_application
gtw_view_application_details
ta-modify_appln_ui
gtw_manage_packages
gtw_create_package
gtw_create_plan
ta-modify_package
ta-modify_plan
exporting_importing_files
gtw_analytics
gtw_manage_microgateways
gtw_view_microgateways_group_details
gtw_view_microgateway_details
gtw_configure_approval_change_owner
gtw_configure_aws_alias
gtw_add_profile
gtw_configure_is
gtw_configure_custom
gtw_configure_saml_sso
gtw_transformation_request
gtw_transformation_response
gtw_appmesh_manage
gtw_configure_service_mesh
gtw_manage_promotions
gtw_add_stage
ta_modify_stage