Integrating On-Premises and Cloud Applications
General Information
Document Conventions
Online Information and Support
Data Protection
webMethods Cloud Products
Software AG Cloud
webMethods.io Integration
webMethods.io B2B
webMethods.io API
webMethods Cloud Container
webMethods Integration Cloud
webMethods AgileApps Cloud
Integration Cloud
Document Conventions
Online Information and Support
Data Protection
What's New
Integration Cloud
Version 7.0.0 (April 2021)
Version 6.6.0 (August 2020)
Version 6.1.0 (April 2020)
Version 6.0.0 (October 2019)
Version 5.6.0 (August 2019)
Create and secure your account
Registration
Creating an Account
Securing your Account
Settings
Users
Adding Users
Updating Users
Resetting Passwords
User Profile
Security Question
Change Password
My Certificate
Capability
Access Profiles
Adding or Updating Access Profiles
Access Control Lists
Adding or Updating Access Control Lists
Preferences
Project Permissions
Single Sign-On
Configuring SAML Settings for Single Sign-On
Company Information
Updating Company Information
Password Policy
Updating Password Policy Settings
Client Certificate
Adding Client Certificates
Executing Integrations using Two-way SSL
OAuth 2.0
About OAuth 2.0
Configuring OAuth 2.0
Registering Clients
Managing Scopes
Generating Tokens
Refreshing Access Tokens Using Refresh Tokens
Managing Tokens
Running Services Using OAuth 2.0
Audit Log
Projects, Permissions, Sharing Assets
Projects
Project Permissions
Sharing Assets across Projects
Applications
Overview
Predefined Applications
Applicability Statement 2 (AS2)
AS2 Predefined Operations
receive
send
Configuring the Auto Detect Option
Creating an Endpoint URL
Alfabet
Amazon DynamoDB
Amazon Kinesis
Amazon Simple Storage Service (S3)
Amazon Simple Notification Service(SNS)
Amazon Simple Queue Service (SQS)
CloudStreams Connector for Anaplan®
Apache Solr Search
Avalara AvaTax
Atlassian Jira
Cloud Deployment and webMethods Cloud Container
Cloud Deployment Operations
CloudStreams Connector for Microsoft Azure Cosmos DB
webMethods CloudStreams Connector for Microsoft Azure Data Lake Store
CloudStreams Connector for Microsoft Azure Storage
CloudStreams Connector for NetSuiteTM
Concur
Coupa
Cumulocity
Database
Database Application Operations
Advanced Options
Configuring the Parameter Values
Custom SQL Operation
Select Operation
Update Operation
Insert Operation
Delete Operation
Stored Procedure Operation
Batch Insert Operation
Batch Update Operation
JDBC Data Type to Java Data Type Mappings
Important Considerations When Using BLOB and CLOB Data Types
Important Considerations When Using the Array and Struct Database Specific Data Types
Using the SetAsString Data Type in Database Application
JDBC Data Type to Java Data Type Mapping Constraints
Driver Management
Driver Management Fields
Certified Databases and JDBC Driver Jars
Samples Accounts
Microsoft SQL Server
Oracle
PostgreSQL
MySQL
MariaDB
Tibero
Supported Cloud Databases
How to use the Insert and Select operations using the Database Application
DocuSign
Electronic Data Interchange
Predefined Operations
File Transfer Protocol (FTP/FTPS)
FTP Predefined Operations
getFile
listFiles
deleteFiles
putFile
renameFile
Google Analytics
Google Apps Admin
Google BigQuery
Google Calendar
Google Contacts
Google Drive
Google Cloud Pub/Sub
Google Cloud Storage
Google Prediction
Google Sheets
IBM Watson Tone Analyzer
Magento eCommerce Platform
Marketo
Microsoft Dynamics CRM
OData v2.0
OData v4.0
Salesforce
Salesforce® Bulk v2 Data Loader
Salesforce® CRM REST
SAP Cloud for Customer(C4C) OData v2.0
SAP S/4HANA Marketing Cloud
Secure File Transfer Protocol (SFTP)
SFTP Predefined Operations
cd
chgrp
chmod
chown
get
ls
mkdir
put
pwd
rename
rm
rmdir
symlink
ServiceNow Enterprise Service Management
Shopify
Siemens MindSphere
Simple Mail Transfer Protocol (SMTP)
Using the SMTP Application to send emails
SMTP Predefined Operation
Slack
StrikeIron Contact Verification
SuccessFactors HCM
SugarCRM
Twilio
webMethods.io B2B
webMethods.io B2B account configuration
Predefined Operations
Workday
Zendesk
Zuora
REST Applications
Creating and updating REST Applications
REST Applications - Account Configuration Details
Tweet the status on Twitter using the REST Application
On-Premises Applications
Dedicated infrastructure support for hybrid integration scenarios
Uploading on-premises services to Integration Cloud
SOAP Applications
SOAP Applications - Account Configuration Details
SOAP Signature
Flat File Applications
Creating a flat file Application manually
Creating a flat file Application from a sample file
Flat File Predefined Operations
convertFlatFileToDocument
convertDocumentToFlatFile
Accounts, Operations, Listeners
Accounts
Adding or Editing Accounts
Troubleshooting tips on Account configurations
Operations
Adding or Editing Operations
Listeners
Creating and updating listeners
Integrations
Overview
Point-to-Point Integrations
Orchestrated Integrations
Pipeline and Signatures
Default Pipeline Rules for Linking to and from Array Variables
Indexed Mapping
Smart Mapping
Integration Details
Versioning of Integrations
Preview Integrations
Debug Integrations
Lock and Unlock Integrations
View the status of a locked Integration
Export Integrations
Import Integrations
Upgrade assets
How to upgrade assets
Recipes
How to view and use Recipes
Marketo Lead to SAP C4C Contact Data Sync
Marketo to SAP C4C Activities Data Sync
Marketo to SAP C4C Leads Data Sync
SAP C4C to Marketo Appointment Activity Data Sync
SAP C4C to Marketo CBO Lead Data Sync
SAP C4C to Marketo Event Notification for Delete Sync
SAP C4C to Marketo Master Data Sync
SAP C4C to Marketo Phone Activity Data Sync
SAP C4C to Marketo Task Activity Data Sync
SAP C4C Account to Marketo Company Data Sync
SAP C4C Contact to Marketo Lead Data Sync
SAP C4C to Marketo Opportunity Data Sync
SAP C4C Employee to Marketo Sales Person Data Sync
Built-In Services
Overview
Built-In Services
Date Services
calculateDateDifference
compareDates
currentNanoTime
dateBuild
dateTimeBuild
dateTimeFormat
elapsedNanoTime
formatDate
getCurrentDate
getCurrentDateString
incrementDate
Document Services
findDocuments
insertDocument
deleteDocuments
documentListToDocument
documentToDocumentList
groupDocuments
documentToBytes
bytesToDocument
searchDocuments
sortDocuments
List Services
addItemToVector
appendToDocumentList
appendToStringList
sizeOfList
stringListToDocumentList
vectorToArray
Math Services
addObjects
divideObjects
min
multiplyObjects
subtractObjects
toNumber
absoluteValue
addFloatList
addFloats
addIntList
addInts
divideFloats
divideInts
max
multiplyFloatList
multiplyFloats
multiplyIntList
multiplyInts
randomDouble
roundNumber
subtractFloats
subtractInts
MIME Services
addBodyPart
addMimeHeader
createMimeData
getBodyPartContent
getBodyPartHeader
getContentType
getEnvelopeStream
getMimeHeader
getNumParts
getPrimaryContentType
getSubContentType
mergeHeaderAndBody
Storage Services
add
deleteStore
get
keys
lock
put
remove
unlock
String Services
HTMLDecode
HTMLEncode
base64Decode
base64Encode
bytesToString
concat
indexOf
length
lookupDictionary
makeString
messageFormat
numericFormat
objectToString
padLeft
padRight
replace
stringToBytes
substring
tokenize
toLower
toUpper
trim
URLDecode
URLEncode
fuzzyMatch
isNumber
isAlphanumeric
isNullOrBlank
isDate
substitutePipelineVariables
compareStrings
Flow Services
clearPipeline
getLastError
getSessionInfo
getHTTPRequest
setHTTPResponse
countProcessedDocuments
logCustomMessage
sleep
Hashtable Services
containsKey
createHashtable
get
listKeys
put
remove
size
Flat File Services
delimitedDataBytesToDocument
delimitedDataStreamToDocument
delimitedDataStringToDocument
documentToDelimitedDataBytes
documentToDelimitedDataStream
documentToDelimitedDataString
JSON Services
documentToJSONBytes
documentToJSONStream
documentToJSONString
jsonBytesToDocument
jsonStreamToDocument
jsonStringToDocument
Transaction Services
Transaction:commit
Transaction:rollback
Transaction:setTimeout
Transaction:start
XML Services
documentToXMLBytes
documentToXMLStream
documentToXMLString
xmlBytesToDocument
xmlNodeToDocument
xmlStreamToDocument
xmlStringToDocument
xmlStringToXMLNode
getXMLNodeType
queryXMLNode
IO Services
bytesToStream
streamToBytes
streamToString
stringToStream
Utils Services
generateUUID
Document Types
Overview
Creating Document Types from Scratch
Creating Document Types from an XML Schema Definition
About Variable Constraints
Applying Constraints to a Variable
Content Types
Customizing a String Content Type
Reference Data
Overview
Add Reference Data
Reference Data Signature
Monitor
Overview
Dashboard
Execution Results
Alert Rules
Reports
Clear Storage Locks
REST APIs
Overview
Creating REST APIs from scratch
Modifying Resource Operations
Creating REST APIs with Swagger
Copying REST APIs
Exporting REST APIs
Importing REST APIs
SOAP APIs
Overview
Creating SOAP APIs from scratch
Creating SOAP APIs with WSDL
Copying SOAP APIs
Exporting SOAP APIs
Importing SOAP APIs
Manage stages, Deploy assets
Manage Stages
Apply Access Profiles to a Stage
Deploy Assets
Change Stage To View
Keys and Certificates
Overview
Add Keystore
Add Truststore
Add Partner Certificate
Containers
Overview
Managing Repositories
Viewing Tag Details
Managing Services
End-to-End Monitoring
Overview
Architecture
General Data Protection Regulation (GDPR) Considerations
Working with End-to-End Monitoring
Dashboard for End-to-End Monitoring
Creating a Group of Transactions
Viewing the Transactions List
Editing a Transactions Group
Deleting a Group
Filtering the Business Transactions
Alert
Viewing Alerts
Creating a Rule
Default Rules
Working with Rule Violations
Working with Rule List
Business Transaction Details Page
Viewing the Transaction Details
Environment Groups and Stages
Example - Environment Groups and Stages
Migration - Environment Groups and Stages
User Journey
Configuring On-Premises Integration Servers for webMethods Cloud
About this Guide
About Configuring an On-Premise Integration Server
What is an On-Premise Integration Server?
About Accounts, Stages, and Environments
webMethods Integration Cloud
webMethods.io Integration
About Applications
Deploying Assets
Steps to Configure an On-Premise Integration Server
Configuring Settings
About webMethods Cloud Settings
Specifying Settings
Editing and Deleting Settings
Setting Maximum Thread Pool Usage for Cloud Requests
Setting Two-Way SSL Communication
Configuring Accounts for webMethods Cloud
Overview
Viewing the Accounts that Reside on the Server
Creating Accounts on an On-Premise Integration Server
Uploading Accounts to webMethods Cloud
Testing Accounts
Enabling and Disabling Accounts
Deleting On-Premise Accounts
Editing Accounts
Monitoring On-Premise Listeners for webMethods Cloud Accounts
Managing Applications
About Sharing Metadata on an On-Premise Integration Server
Viewing the Applications that Reside on Your Server
Defining Applications
Uploading Applications
Deleting Applications
Editing Applications
Managing Docker Services
Overview
Specifying Services to Expose to Consumers in webMethods Cloud
Connecting to webMethods Cloud through a Proxy
About Configuring Integration Server
Creating a Proxy Server Alias
Updating JVM Configuration Settings for Proxies
Configuring the Internet Proxy
Administering CloudStreams
webMethods CloudStreams Documentation
About this Documentation
Document Conventions
Online Information and Support
Data Protection
Administering webMethods CloudStreams
Overview
About CloudStreams
CloudStreams Components
SOAP/REST Outbound Architecture
SOAP/REST Inbound Architecture
Streaming Architecture
Virtual Services and Connector Virtual Services
The Processing Steps of Virtual Services
The Processing Steps of Connector Virtual Services
Policies for Virtual Services and Connector Virtual Services
Policies for Virtual Services
Policies for Connector Virtual Services
The CloudStreams Analytics Dashboard
The Run-Time Events
The Key Performance Indicator (KPI) Metrics
Getting Started with CloudStreams
CloudStreams Configuration Options
Overview
The Administration Options
Setting the General Options
Setting the E-mail Options for Logging Payloads and Sending Performance Monitoring Alerts
Setting the Database Options for Publishing Performance Metrics and Events
The Intervals for Metric Publishing
The Virtual Services Option
Setting the STS Options
Setting the Service Fault Configuration Options
Setting the Consumers Options
Setting the OAuth Tokens Options
The Providers Options
The Streaming Options
Setting the Streaming Providers Options
Setting the Streaming Subscribers Options
Creating an ESB Service as a Streaming Subscriber Destination
ESB Services for the Client Type of Comet
ESB Services for the Client Type of HTTP
Streaming subscriber behavior in case of an error
Connection Options
Virtual Services
Overview
Define a CloudStreams Server Target
Create a CloudStreams Governance Project
Create the Virtual Services
The Processing Steps of a Virtual Service
The Processing Steps of a Connector Virtual Service
Create Policies for the Virtual Services
Policies for Connector Virtual Services
Defining and Managing a CloudStreams Server Target
Creating a CloudStreams Governance Project
Creating a New Virtual Service (SOAP)
The Properties of a Virtual Service (SOAP)
Managing a Virtual Service (SOAP)
The In Sequence Step (SOAP)
The Entry Step (SOAP)
The Transform Step (Inbound, SOAP)
The Invoke IS Service Step (Inbound, SOAP)
The Routing Rule Step for HTTP or HTTPS (SOAP)
The Straight Through Routing Rule Step (SOAP)
The Context-Based Routing Rule Step (SOAP)
The Content-Based Routing Rule Step (SOAP)
The Load Balancing Routing Rule Step (SOAP)
The Out Sequence Step (SOAP)
The Transform Step (Outbound, SOAP)
The Invoke IS Service Step (Outbound, SOAP)
The Error Sequence Step (SOAP)
The Fault Handler Variables
IS Service Constructs
Using the Security API in IS Services
pub.cloudstreams.security.ws.AddUserNameToken
pub.cloudstreams.security.ws.AddX509Token
pub.cloudstreams.security.ws.AddSamlSenderVouchesToken
pub.cloudstreams.security.ws.AddTimestamp
pub.cloudstreams.security.ws.AddWSAddressingHeaders
Using Context Variables in IS Services
The Predefined Context Variables
The API for Context Variables
Creating a New Connector Virtual Service (SOAP)
The Properties of a Connector Virtual Service (SOAP)
Managing a Connector Virtual Service (SOAP)
The In Sequence Step (Connector Virtual Service, SOAP)
The Entry Step (Connector Virtual Service, SOAP)
The Routing Rule Step (Connector Virtual Service, SOAP)
The Invoke IS Service Step (Inbound, Connector Virtual Service, SOAP)
The Out Sequence Step (Connector Virtual Service, SOAP)
The Error Sequence Step (Connector Virtual Service, SOAP)
Creating a New Virtual Service (REST)
The Properties of a Virtual Service (REST)
Managing a Virtual Service (REST)
The In Sequence Step (REST)
The Entry Step (REST)
The Transform Step (Inbound, REST)
The Invoke IS Service Step (Inbound, REST)
The Routing Rule Step (REST)
The Straight Through Routing Rule Step (REST)
The Context-Based Routing Rule Step (REST)
The Content-Based Routing Step (REST)
The Load Balancing Routing Rule Step (REST)
The Out Sequence Step (REST)
The Transform Step (Outbound, REST)
The Invoke IS Service Step (Outbound, REST)
The Error Sequence Step (REST)
Creating a New Connector Virtual Service (REST)
The Properties of a Connector Virtual Service (REST)
Managing a Connector Virtual Service (REST)
The In Sequence Step (Connector Virtual Service, REST)
The Entry Step (Connector Virtual Service, REST)
The Routing Rule Step (Connector Virtual Service, REST)
The Invoke IS Service Step (Inbound, Connector Virtual Service, REST)
The Out Sequence Step (Connector Virtual Service, REST)
The Error Sequence Step (Connector Virtual Service, REST)
Important Considerations for REST Virtual Services
HTTP Method/Content-Type Combinations
Changing the HTTP Method of a REST Virtual Service
Implications of Changing HTTP Methods
Changing HTTP Methods in Requests Dynamically Using a Context Variable
Sample XSLT Transformation for GET-to-POST or GET-to-PUT
Policies
Overview of Policies
Policies for Virtual Services
WS-SecurityPolicy 1.2 Actions
Monitoring Actions
Additional Actions
Policies for Connector Virtual Services
Creating Policies
Modifying Policies
The Policy Actions
Action Evaluation Order and Dependencies
Usage Cases for Identifying/Authenticating Consumers
Multiple Security Elements in Requests/Responses
The Policy Action Reference
Authorize User
Identify Consumer
Include Timestamps
Log Invocation
Monitor Service Performance
Monitor Service Level Agreement (SLA)
Require Encryption
Require HTTP Basic Authentication
Require SAML Token
To Identify a Trusted STS to Integration Server
Require Signing
Require SSL
Require WSS Username Token
Require X.509 Token
Throttling Traffic Optimization
Validate Schema
Deploying Virtual Services and Connector Virtual Services
Overview of Deployment
Before You Deploy Virtual Services or Connector Virtual Services
Deploying All Services in a CloudStreams Governance Project
Deploying a Single Service
Undeploying Services
What Happens When You Deploy a Service?
Policy Validation
Policy Conflict Resolution Rules
What if You Need to Modify Deployed Services?
Cloud Connections, Services, and Connector Listeners
CloudStreams Provider
CloudStreams Connector
Cloud Connection
Cloud Connector Service
Working with Connector Listeners
Replaying Salesforce events
Detection and processing of duplicate Salesforce events
Persistent configuration of events for duplicate detection
Persistent configuration of last received Replay IDs
Configuring Error Recovery and Callback information for Salesforce
Managing Cloud Connectors
Managing Cloud Connector Packages
Using inline connection details while running a cloud connector service
Support for multiple authentication schemes in a single connector
Generating OAuth 2.0 Tokens while configuring connections
Multipart/form-data content type
Message Transmission Optimization Mechanism (MTOM)
Service signatures having complex nested document structures
Multiple root JSON data format with anonymous collection
REST Parameters
Parameter Types
URI_CONTEXT
QUERYSTRING_PARAM
CFG_PARAM
FORM_ENCODED_PARAM
Parameter Data Types
String
Record
Parameter Formatters for REST Connector Services
Using the Default Parameter Formatter
Implementing a Custom Parameter Formatter
Viewing the Constraints Applied to Variables
Server Name Indication (SNI) Support
Clustering
Clustering support for connector listeners
Using CloudStreams Configuration Variables Templates with webMethods Microservices Runtime
Overview
Configuration Variables Template
Configuration Variables Template Assets
Deploying Assets using webMethods Deployer
Overview
Building Assets
Deploying assets to other servers
CloudStreams Analytics
Overview
The Run-Time Events
The Key Performance Indicator (KPI) Metrics
Installation and Configuration Tasks
Creating the Schema and Tables Required by CloudStreams Analytics
Creating a JDBC Connection Pool for CloudStreams
SQL Statement Execution and Connection Timeouts
Installing and Starting MashZone NextGen Server
Copying the Resource Files for CloudStreams Analytics
Configuring the Data Feed
Configuring the record limit for Transaction and Event tables
Importing the CloudStreams Analytics Dashboard
Setting the Publishing Options for Performance Metrics and Events
Using the CloudStreams Analytics Dashboard
Performance Summary
API Usage
Performance Trends
Error Trends
Transaction
Event
Admin Folder
Summary of Elements in this Folder
pub.cloudstreams.admin.connection:disableConnection
pub.cloudstreams.admin.connection:enableConnection
pub.cloudstreams.admin.connection:getConnectionStatistics
pub.cloudstreams.admin.connection:queryConnectionState
pub.cloudstreams.admin.listener:disable
pub.cloudstreams.admin.listener:enable
pub.cloudstreams.admin.listener:queryListenerState
pub.cloudstreams.admin.listener:listEnabledListeners
pub.cloudstreams.admin.listener:update
pub.cloudstreams.admin.service:update
pub.cloudstreams.admin.service:batchUpdate
pub.cloudstreams.upgrade:batchUpgrade
Advanced Settings
Introduction
pg.backupFailedProxies
pg.CollectionPool.
pg.CollectionWorkQueue.
pg.debug.
pg.delayedRefresher.
pg.ehcache.config.
pg.email.
pg.endpoint.
pg.failedProxies.
pg.http.
pg.IntervalPool.
pg.jaxbFileStore.
pg.jdbc.
pg.keystore.
pg.lb.
pg.passman.
pg.PgMenConfiguration.
pg.PgMenSharedCacheManager.
pg.PgMetricsFormatter.
pg.policygateway.
pg.proxyLoader
pg.rampartdeploymenthandler.
pg.ReportingPool.
pg.ReportingWorkQueue.
pg.serviceReader.
wst.cloudConnectorService.
wst.connfactory.
wst.default.tenant.
wst.product.
wst.largedata.
webMethods CloudStreams Development
CloudStreams Governance Project
Governance Project Wizard
CloudStreams Servers Dialog Boxes
CloudStreams Servers Dialog Box
Add CloudStreams Servers Dialog Box
Connector Virtual Services (SOAP)
New Connector Virtual Service Wizard (SOAP)
General Properties View (SOAP Connector Virtual Service)
Advanced Properties View (SOAP Connector Virtual Service)
Entry Step (SOAP Connector Virtual Service)
Routing Rule Step (SOAP Connector Virtual Service)
Invoke IS Service Step (Inbound, SOAP Connector Virtual Service)
Invoke IS Service Step (Outbound, SOAP Connector Virtual Service)
Error Messaging Step (SOAP Connector Virtual Service)
Connector Virtual Services (REST)
New Connector Virtual Service Wizard (REST)
General Properties View (REST Connector Virtual Service)
Advanced Properties View (REST Connector Virtual Service)
Entry Step (REST Connector Virtual Service)
Routing Rule Step (REST Connector Virtual Service)
Invoke IS Service Step (Inbound, REST Connector Virtual Service)
Invoke IS Service Step (Outbound, REST Connector Virtual Service)
Error Messaging Step (REST Connector Virtual Service)
Policies
Create a New Policy Wizard
General Properties View (Policy)
Action: Authorize User
Action: Identify Consumer
Action: Include Timestamps
Action: Log Invocation
Action: Monitor Service Performance
Action: Monitor Service Level Agreement (SLA)
Action: Require Encryption
Action: Require HTTP Basic Authentication
Action: Require SAML Token
Action: Require Signing
Action: Require SSL
Action: Require WSS Username
Action: Require X.509 Token
Action: Throttling Traffic Optimization
Action: Validate Schema
Virtual Services (SOAP)
New Virtual Service Wizard (SOAP)
General Properties (SOAP Virtual Service)
Advanced Properties (SOAP Virtual Service)
Virtual Service Namespaces Dialog Box (SOAP Virtual Service)
VSD Dialog Box (SOAP Virtual Service)
Applicable Policies Dialog Box (SOAP Virtual Service)
Endpoint Dialog Box (SOAP Virtual Service)
Entry Step (SOAP Virtual Service)
Transform Step (SOAP Virtual Service)
Transform Step (Inbound, SOAP Virtual Service)
Invoke IS Service Step (Inbound, SOAP Virtual Service)
Routing Rule Step (Straight Through Routing, SOAP Virtual Service)
Routing Rule Step (Context-Based Routing, SOAP Virtual Service)
Routing Rule Step (Content-Based Routing, SOAP Virtual Service)
Routing Rule Step (Load Balancing Routing, SOAP Virtual Service)
Attach WSDL Dialog Box (SOAP Virtual Service)
Transform Step (Outbound, SOAP Virtual Service)
Invoke IS Service Step (Outbound, SOAP Virtual Service)
Error Messaging Step (SOAP Virtual Service)
Virtual Services (REST)
New Virtual Service Wizard (REST)
REST Resources Wizard
General Properties (REST Virtual Service)
Advanced Properties View (REST Virtual Service)
Virtual Service Namespaces Dialog Box (REST Virtual Service)
VSD Dialog Box (REST Virtual Service)
Applicable Policies Dialog Box (REST Virtual Service)
Endpoint Dialog Box (REST Virtual Service)
Entry Step (REST Virtual Service)
Transform Step (REST Virtual Service)
Transform Step (Inbound, REST Virtual Service)
Invoke IS Service Step (Inbound, REST Virtual Service)
Routing Rule Step (Straight Through Routing, REST Virtual Service)
Routing Rule Step (Context-Based Routing, REST Virtual Service)
Routing Rule Step (Content-Based Routing, REST Virtual Service)
Routing Rule Step (Load Balancing Routing, REST Virtual Service)
Transform Step (Outbound, REST Virtual Service)
Invoke IS Service Step (Outbound, REST Virtual Service)
Error Messaging Step (REST Virtual Service)
Deploy
CloudStreams Provider Project
Creating a Provider Project
CloudStreams Connector
Creating a Connector
Connector Overview-General Information
Editing the Connection Properties
Adding Properties
Editing Properties
Removing Properties
Start and Stop Sequences for REST-based providers
Start and Stop Sequences for SOAP-based providers
Configuring References
Creating and Renaming Resource Groups
Configuring Assignments in Resource Groups
REST Connector
Creating a REST Resource
Creating a Resource Request Parameter
Creating a Resource Request Header
Adding a Resource Request Body
Changing the Sequence of Local Assignments
Creating a Resource Response Header
Adding a Resource Response Body
Handling JSON representations of REST resources
SOAP Connector
Creating a SOAP Request Parameter
SOAP Request Header
SOAP Request Body
Changing the Sequence of Local Assignments
SOAP Response Header
SOAP Response Body
Moving and Copying Elements
Advanced Configurations
Assigning Values
Assigning Values from a Service
Abstract Object Definition
Parameter Data Types and Formatters
Importing Provider Packages
Exporting Provider Packages
Publishing and Unpublishing Providers
Service Development
About webMethods Service Development
Before You Use Designer for Service Development
Opening the Service Development Perspective
Working with webMethods Integration Server
Working with Server Definitions
Creating Server Definitions
Fetching Server Definitions from an Integration Server
Importing Server Definitions
Exporting Server Definitions
Removing Server Definitions
Editing Server Definitions
Considerations for Process Development
Setting a Default Server Definition
Placing a Server Definition Offline
Bringing a Server Definition Online
Connecting to an Integration Server
Connecting to an Integration Server through Preferences
Disconnecting from an Integration Server
Disconnecting from an Integration Server via Preferences
Refreshing an Integration Server
Notification of Server Shutdown
Opening Integration Server Administrator
Viewing Integration Server Properties
Changing Passwords
Changing Your Password
Synchronizing Passwords
Working with Elements
About Element Names
Package Names and Element Names
Creating New Elements
Guidelines for Naming Elements
Guidelines for Working with Elements
Opening Elements
Closing Elements
Editing and Saving Elements
Adding Comments for an Element
Configuring Dependency Checking for Elements
Controlling the Reuse of Elements Published to CentraSite
Allowing Editing of Derived Elements
Moving and Copying Elements
Guidelines for Moving and Copying All Types of Elements
Guidelines for Moving and Copying Services
Guidelines for Copying Elements Between Servers
Notes for Moving and Copying Adapter Notifications and Related Elements
Renaming Elements
Guidelines for Refactoring Elements
Refactoring Elements
Deleting Elements
Finding Dependents and References
What Is a Dependent?
Finding Dependents
What Is a Reference?
Finding References
Inspecting Pipeline References
Inspecting Pipeline References
Finding Elements
Guidelines for Searching Elements
Searching for Elements in Package Navigator
Performing a Quick Search of Elements in Package Navigator
Locating Invoked Services
Locating Referenced Document Types
Linking Open Editors
Filtering Displayed Elements
Hiding or Displaying Automatically Generated Flow Services
Creating Working Sets
Caching Elements
Clearing the Designer Cache
Exporting Elements
Viewing Server Files for an Element
Using Property Templates with Elements
Creating Property Templates
Applying Property Templates to Elements
Editing Property Templates
Deleting Property Templates
Importing Property Templates
Exporting Property Templates
Assigning and Managing Permissions for Elements
What Is an ACL?
What Happens When a Client Runs a Service with ACLs?
Is ACL Usage Required?
Creating ACLs
ACLs and Inheritance
Default ACLs and Inheritance
Assigning ACLs
Viewing ACL Information for a Server
ACLs and Locking
ACLs and Running/Debugging Services
ACLs and Creating, Viewing, and Deleting Elements
Troubleshooting ACL Usage
Locking and Unlocking Elements
What Is a Lock?
About Locking Elements
Locking Elements in Designer
Guidelines for Locking Java and C/C++ Services
Guidelines for Locking Templates
System Locking Elements
Viewing the Status of Locked Elements
Viewing Lock Status of Elements
Listing All of Your Locked Elements
Copying, Moving, or Deleting Locked Elements
Unlocking Elements
Unlocking Elements in Designer
Automatically Unlocking an Element Upon Saving
Troubleshooting
Lock and Unlock Problems
Package Management Problems
Save Problems
Other Problems
Frequently Asked Questions
Using the Local Service Development Feature
About the Local Service Development Workflow
Supported Platforms and Eclipse Plug-ins
Supported Elements
Supported and Unsupported Actions
Prerequisites
Permissions and Locking
Permissions
System Locking and Local Service Development
Setting the Local Development Server
Creating a Local Service Development Project
Adding Folders and Elements to the VCS
Modifying Packages, Folders, or Elements in the VCS
Checking Out an Element from the VCS
Checking In Packages and Element to the VCS
Getting the Latest Version from the VCS
Getting a Specific Version from the VCS
Copying Packages from the VCS to Integration Server
Reloading a Package
Comparing Revisions of an Element
Building Java and C Services
Deleting a Package Associated with a Local Service Development Project
Deleting a Local Service Development Project
Managing Packages
Creating a Package
Guidelines for Naming Packages
Documenting a Package
Accessing Package Documentation
Viewing Package Settings, Version Number, and Patch History
Assigning a Version Number to a Package
About Copying Packages Between Servers
Copying Packages
Reloading a Package
Comparing Packages
Deleting a Package
Exporting a Package
About Package Dependencies
Identifying Package Dependencies
Removing Package Dependencies
Assigning Startup, Shutdown, and Replication Services to a Package
What Is a Startup Service?
Assigning a Startup Service
Removing a Startup Service
What Is a Shut Down Service?
Assigning a Shutdown Service
Removing a Shutdown Service
What Is a Replication Service?
Assigning a Replication Service
Removing a Replication Service
Building Services
A Process Overview
Package and Folder Requirements
About the Service Signature
Guidelines for Specifying Input Parameters
Guidelines for Specifying Output Parameters
Declaring Input and Output Parameters
Using a Specification as a Service Signature
Using an IS Document Type to Specify Service Input or Output Parameters
Inserting Input and Output Parameters
About Service Run-Time Parameters
Maintaining the State of Service
Specifying the Run-Time State for a Service
About Service Caching
When Are Cached Results Returned?
Types of Services to Cache
Controlling a Service’s Use of Cache
Specifying the Duration of Cached Results
Refreshing Service Cache by Using the Prefetch Option
Configuring Caching of Service Results
Specifying the Execution Locale
About URL Aliases for Services
Creating a Path Alias for a Service
Automatically Saving or Restoring the Pipeline at Run Time
Configuring Saving or Restoring of the Service Pipeline at Run Time
Specifying the Default Format for an XML Document Received by the Service
Configuring HTTP Methods Allowed for a Service
About Automatic Service Retry
About the Maximum Retry Period
Configuring Service Retry
About Service Auditing
Service Auditing Use Cases
Error Auditing
Service Auditing
Auditing for Recovery
Auditing Long-Running Services
Configuring Service Auditing
Logging Input and Output Fields
Selecting Input or Output Fields for Logging
Logged Field Data Types in JDBC
Assigning a Custom Value to an Auditing Context
Using a Circuit Breaker with a Service
Considerations for Configuring a Circuit Breaker for a Service
Configuring a Circuit Breaker for a Service
About Universal Names for Services or Document Types
Implicit and Explicit Universal Names
Assigning, Editing, or Viewing an Explicit Universal Name
Deleting an Explicit Universal Name
The Universal Name Registry
Services You Use to Interact with the Universal Name Registry
About Service Output Templates
Creating an Output Template
Assigning an Output Template to a Service
Viewing Service Information
Building Flow Services
What Is a Flow Service?
What Is a Flow Step?
What Is the Pipeline?
Building Services Using the Tree Tab or Layout Tab
Creating a New Flow Service
Creating an Empty Flow Service
Creating a Flow Service from an XML Document, DTD, or XML Schema
Creating a Flow Service from an XML Document
Creating a Flow Service from a DTD
Creating a Flow Service from an XML Schema Definition
Inserting Flow Steps
Changing the Position of a Flow Step
Changing the Level of a Flow Step
Setting Properties for a Flow Step
The INVOKE Step
Specifying the Service Property
Invoking a Built-In Service
Invoking a Service on Another Integration Server
Building an Invoke Step
The BRANCH Step
Branching on a Switch Value
Specifying the Switch Value
Specifying the Label Value
Branching on an Expression
Branching on Null and Empty Values
Specifying a Default Step
Using a SEQUENCE as the Target of a BRANCH
Building a BRANCH Step
The REPEAT Step
Specifying the REPEAT Condition
Setting the REPEAT Counter
When Does REPEAT Fail?
Using REPEAT to Retry a Failed Step
Using REPEAT to Retry a Successful Step
The SEQUENCE Step
Using SEQUENCE to Specify an Exit Condition
The LOOP Step
Specifying the Input Array
Collecting Output from a LOOP Step
About the Pipeline for a LOOP Step
Building a LOOP Step
The EXIT Step
Exiting on Success or Failure
Exiting from Iterations, Steps, or Services
Java Equivalents for EXIT Behavior
Building an EXIT Step
The MAP Step
The TRY, CATCH, and FINALLY Steps
Printing a Flow Service
Comparing Flow Services
Working in the Layout Tab
What Is the Layout Tab
When Should You Use Layout Tab?
What Does a Flow Service Look Like in the Layout Tab?
Viewing Flow Steps in the Layout Tab
Viewing Steps that Contain Child Steps in the Layout Tab
Show or Hide the Grid Lines in the Flow Service Editor
Building a Flow Service in the Layout Tab
Inserting a Flow Step
Inserting a Flow Step Using the Palette View
Inserting a Flow Step Using the Context Menu
Notes for Inserting a Child Step into a BRANCH Step
Changing the Order of Steps in a Flow Service
Mapping Data in Flow Services
What Does the Pipeline View Contain?
Pipeline View for an INVOKE Step
Pipeline View for a MAP Step
Scrolling in Pipeline View
Viewing Full Namespace Path of Referenced Document Types
Printing the Pipeline
Basic Mapping Tasks
About Linking Variables
Creating a Link Between Variables
What Happens When Integration Server Executes a Link?
Example of Copying By Reference
Preventing Pipeline Values from Being Overwritten
Linking to Document and Document List Variables
Linking Variables of Different Data Types
Converting a String List to a Document List in the Pipeline
Converting Two String Lists to a Document List in the Pipeline
Linking to and from Array Variables in the Pipeline
Creating a Link to or from an Array Variable
Default Pipeline Rules for Linking to and from Array Variables
Deleting a Link Between Variables
Linking Variables Conditionally
Linking Multiple Source Variables to a Target Variable
Applying a Condition to a Link
About Assigning Values to Pipeline Variables
Assigning a Value to a Pipeline Variable
Assigning String Variables to Pipeline Variables
Assigning Global Variables to Pipeline Variables
Assigning String Variables and Global Variables to the Same Pipeline Variable
Copying Assigned Values Between Pipeline Variables
Dropping Variables from the Pipeline
Adding Variables to the Pipeline
Working with Transformers
Using Built-In Services as Transformers
Inserting a Transformer
Linking Variables to a Transformer
Transformers and Array Variables
Example of Dimensionality Mismatch
Validating Input and Output for Transformers
Copying Transformers
Renaming Transformers
Debugging Transformers
Testing Flow Steps Before Running a Flow Service
Opening the Data Mapper View
Testing a Flow Step in the Data Mapper View
Mapping Using ForEach
Creating a ForEach Mapping
Specifying ForEach Mapping Properties
ForEach Mapping Rules
Failure Handling in Flow Services Using the TRY, CATCH, and FINALLY Steps
About Failure Handling in Flow Services
What Happens When a Failure Occurs?
com.wm.lang.flow.FlowException versus com.wm.lang.flow.Failure
About the TRY, CATCH, and FINALLY Steps
The TRY Step
The CATCH Step
The FINALLY Step
Usage Patterns for Failure Handling
TRY-CATCH
TRY-FINALLY
TRY-CATCH-FINALLY
Summary of TRY, CATCH, and FINALLY Behavior
Normal and Abrupt Completion and Failure of TRY, CATCH, and FINALLY Steps
Notable Behavior for Abrupt Completion in TRY, CATCH, and FINALLY Steps
Overview of Building the TRY, CATCH, and FINALLY Steps
Limitations for the TRY, CATCH, and FINALLY Steps
Positioning Guidelines and Limitations for TRY, CATCH, and FINALLY Steps
CATCH Step Considerations
EXIT Step Considerations in TRY, CATCH, or FINALLY
Building TRY, CATCH, and FINALLY Steps
Performing Data Validation
Blueprints or Models Against which Data is Validated
Performing Input/Output Validation
Specifying Input/Output Validation via the Input/Output Tab
Specifying Input/Output Validation via the INVOKE Step
Performing Pipeline Validation
Performing Document Validation
Performing XML Validation in Integration Server
Performing Validation from within a Java Service
Validation Errors
Validation Exceptions
Preventing Running Out of Memory Error During Validation
Building Java Services
Overview of Building Java Services
Java Service Editor
Source Tab
Protected Sections of a Java Service
Editable Sections of a Java Service
Service Development Projects in the Local Workspace
About the Service Development Project Name
Format of a Service Development Project
How Java Services Are Organized on Integration Server
Creating a Java Service
Notes about Creating and Editing Java Services in Designer
Using an IData Object for the Java Service Input and Output
Generating Java Code from Service Input and Output Parameters
Example of Java Code Generated from Service Signature
Editing an Existing Java Service
Adding Classes to the Service Development Project
Compiling a Java Service
Performance When Compiling a Java Service
Generating Code a Java Service Can Use to Invoke a Specified Service
Generating Java Code to Invoke a Service
Example of Java Code Generated for Invoking a Service
Deleting a Java Service
Building Java Services in Your Own IDE
How Java Services are Organized on Integration Server
Requirements for the Java Service Source Code
IData Object for Java Service Input and Output
Adding Comments to Your Java Code for the jcode Utility
Example of Code Commented for the jcode Utility
Using the jcode Utility
Using jcode make/makeall to Compile Java Source
Using jcode frag/fragall to Split Java Source for Designer
Using jcode comp to Create Java Source from Fragments
Using jcode Shortcut Commands
Building Map Services
What Is a Map Service?
Building Map Services Using the Tree Tab or Graphical View Tab
Creating a Map Service
Creating a Map Service
Setting Properties for a Map Service
Working in the Graphical View tab
Debugging Map Services
Building C/C++ Services
The Java Code for a C/C++ Service
Overview of Building C/C++ Services
Prerequisites for Building C/C++ Services
C/C++ Service Editor
Source Tab
Protected Sections of a C/C++ Service
Editable Sections of a C/C++ Service
Service Development Projects in the Local Workspace
About the Service Development Project Name
Format of a Service Development Project
How C/C++ Services Are Organized on Integration Server
Creating a C/C++ Service
Editing an Existing C/C++ Service
Generating C/C++ Code from Service Input and Output Parameters
Adding Classes to the Service Development Project
Building the C/C++ Source Code
Compiling the C/C++ Source Code
Performance When Compiling a C/C++ Service
Generating Code a C/C++ Service Can Use to Invoke a Specified Service
Debugging C/C++ Services
Building Services from .NET Methods
Environment Setup for Creating .NET Services
.NET Service Editor
.NET Properties Tab
Creating a .NET Service
Modifying the .NET Assembly Information
Modifying the Class Lifetime for a .NET Service
Running a .NET Service in Designer
Building XSLT Services
What Is XSLT?
What Is an XSLT Service?
How Does an XSLT Service Work?
What Is a Translet?
About the XSLT Service Editor
Overview of Building XSLT Services
Creating an XSLT Service
XSLT Service Signature
Running an XSLT Service
Debugging an XSLT Service
Creating a Launch Configuration for an XSLT Service
Debugging an XSLT Service
Guidelines for the XSLT Style Sheet
Using Name/Value Pairs with an XSLT Service
Passing Name/Value Pairs from the Pipeline to the Style Sheet
Specifying New Values for Name/Value Pair
Defining Name/Value Pair as an XSLT Parameter
Passing Name/Value Pairs from the Style Sheet to the Pipeline
Sample Style Sheet: Adding Name/Value Pairs to the Pipeline
Configuring XSLT Transformer Factory Settings
Building Cloud Connector Services
Creating a Cloud Connector Service
Editing a Cloud Connector Service for a SOAP-Based Provider
Editing a Cloud Connector Service for a REST-Based Provider
Viewing the Constraints Applied to Variables
Building Connector Listeners
Creating Connector Listeners
Editing Connector Listeners
Running Services
Using Launch Configurations to Run Services
Creating a Launch Configuration for Running a Service
Supplying Input Values to a Service
Entering Input for a Service
Specifying a Value for a String Variable
Specifying Values for a String List Variable
Specifying Values for a String Table Variable
Specifying Values for a Document Variable that Has Defined Content
Specifying Values for a Document Variable with No Defined Content
Specifying Values for a Document List Variable
Specifying a Value for an Object Variable
Specifying Values for an Object List Variable
Saving Input Values
Loading Input Values
Running a Service
Viewing Results from Running a Service
Messages Tab
Call Stack Tab
Pipeline Tab
Saving the Results
Restoring the Results
Running Services from Results view
Removing the Results from Results View
Pinning a Result to Results View
Sorting Results by Element Names in Results View
Running Services from a Browser
Debugging Flow Services
About Debugging Flow Services
About Debug Sessions
About the Debug Perspective
About Debug View
Creating Launch Configurations for Debugging Flow Services
Debugging a Flow Service
Stepping Through Flow Services
Stepping Through a Flow Service
Stepping Into and Out of a Child Service
Stepping Into and Out of a MAP Step
Stepping Into and Out of a ForEach Mapping
Using Breakpoints When Debugging Flow Services
Breakpoint States
Setting and Removing Breakpoints on Flow Step
Setting and Removing Breakpoints on a Transformer
Enabling and Disabling Breakpoints in a Flow Service
Skipping Breakpoints in a Flow Service
Disabling and Enabling Flow Steps and Transformers
Disabling and Enabling Conditions
Modifying the Flow Service Pipeline while Debugging
Changing Variable Values
Dropping Variables
Saving and Restoring the Flow Service Pipeline while Debugging
Saving the Flow Service Pipeline while Debugging
Saving the Pipeline to a File while Debugging
Restoring the Flow Service Pipeline while Debugging
Loading a Saved Pipeline while Debugging
Viewing Service Results from a Flow Service Debug Session
Using the Server Log for Debugging
Writing Information to the Server Log
Writing an Arbitrary Message to the Log
Dumping the Pipeline to the Log
Debugging Map Services
Debugging Java Services
About Debugging a Java Service while its Class Runs in Designer
About Test Harnesses
Creating a Test Harness
About Java Application Launch Configuration
Creating a Java Application Launch Configuration
Updating a Java Application Launch Configuration
How to Suspend Execution of a Java Class while Debugging
Debugging a Java Service while its Class Runs in Designer
Viewing Service Results from Debugging a Java Service
About Debugging a Java Service while it Runs in Integration Server
Benefits of Debugging Java Services Running in Integration Server
Drawbacks of Debugging Java Services Running in Integration Server
Setting Up Integration Server Version 9.7 or Later for Remotely Debugging a Java Service
Setting Up Integration Server Version 9.0, 9.5.x, or 9.6 for Remotely Debugging a Java Service
Creating a Java Project for an IS Package in Designer
Creating a Remote Java Application Launch Configuration
Debugging a Java Service while it Runs in Integration Server
Working with REST API Descriptors
OpenAPI Based Provider REST API Descriptors
Creating a Provider REST API Descriptor from an OpenAPI Document
Viewing General Information of the REST API Descriptor
Working with Servers
Viewing the Server Details
Adding a New Server
Removing a Server
Modifying the Server Details of a Server
Adding Server Variables
Modifying Server Variables
Removing Server Variables
Working with Resources
Viewing the REST V2 Resources in the REST API Descriptor
Working with Operations
About REST Requests
About REST Responses
About Services
About Callbacks
Working with Schemas
Viewing the Schemas
About JSON Document Types
Working the Security
Viewing the Security Schemes
Working the Tags
Viewing the Tags
Viewing the OpenAPI Document for a REST API Descriptor
Swagger Based Provider REST API Descriptors
Approaches for Developing REST Resources
Configuring a REST V2 Resource
Creating a REST V2 Resource
Supporting Elements for a REST V2 Resource
Configuring REST V2 Resources as JSON API Compliant
Examples of Configuring REST Resources Based on JSON API
Working with REST V2 Resource Operation
Defining a REST V2 Resource Operation
Example of Defining a REST V2 Resource Operation
Editing a REST V2 Resource Operation
Deleting a REST V2 Resource Operation
Working with REST V2 Resource Attributes
Defining a REST V2 Resource Attribute
Editing a REST V2 Resource Attribute
Deleting a REST V2 Resource Attribute
Creating a Provider REST API Descriptor from a REST Resource
Editing General Information for a REST API Descriptor
Changing the Available MIME Types for a REST API Descriptor
Working with Security Definitions
Adding a Security Definition
Removing a Security Definition
Working with Tags
Adding Tags
Removing a Tag
Editing a Tag
Working with REST Resources in a REST API Descriptor
Adding REST Resources to a REST API Descriptor
Removing REST Resources from a REST API Descriptor
Setting the Path or Suffix for a REST Resource
Working with Operations
Changing the MIME Types for an Operation in a REST Resource
Modifying Tags for Operations in a REST Resource
Modifying Security Scheme for Operations in a REST Resource
Modifying External Document for Operations in a REST Resource
About the Operation Parameters
Reviewing and Changing the Assigned Source for an Operation Parameter
About Operation Responses
Adding an Operation Response
Removing an Operation Response
Viewing REST V2 Resources in Group by Tags Mode
Running a REST V2 Resource Operation from REST API Descriptor Editor
Executing an Operation Using Editor
About REST Definitions
Viewing the Swagger Document for a REST API Descriptor
Creating a Provider REST API Descriptor from a Swagger Document
Mapping Integration Server Data Types to Swagger Data Types
Mapping Integration Server Content Type Constraints to Swagger Type Constraints
Swagger Based Consumer REST API Descriptors
Creating a Consumer REST API Descriptor from a Swagger Document
Refreshing a REST API Descriptor
Publishing REST API Descriptors to API Portal
Working with OData Services
Understanding OData Service Terminology
Supported and Unsupported OData Features
Overview of Creating an OData Service
Creating an OData Service
Creating an OData Service Using an External Source Type
Adding OData Elements to the OData Service
Adding Properties to the OData Elements
Adding Associations to OData Elements
Editing the OData Service
Synchronizing the External Entity Type
How Integration Server Processes an OData Service Request
Querying Data Using $filter
Working with Document Types
Creating an IS Document Type
Creating an Empty IS Document Type
Adding Fields to an IS Document Type
Creating an IS Document Type from an XML Document, DTD, or XML Schema
Creating an IS Document Type from an XML Document
Creating an IS Document Type from a DTD
Creating an IS Document Type from an XML Schema Definition
Creating IS Document Types from JSON Objects
Mapping JSON Data Types
Generating Fields from Unquoted Fields in a JSON Object
Creating an IS Document Type from a JSON Object
Creating an IS Document Type from a Broker Document Type
Creating an IS Document Type from an E-form Template
Notes About IS Document Types Created from E-form Templates
Creating a Document Type from a Flat File Schema
Determining How to Represent Complex Types in Document Types
Derived Types and IS Document Types
*doctype Fields in IS Document Types and Document Fields
*doctype Fields in IS Document Types
*doctype Fields in Document Fields
Registering Document Types with Their Schema Types
Generating Fields for Substitution Groups
*Any Fields in Document Types and Document Fields
About Run-time Processing for an IS Document Type that Complies with the Content Model
Editing Document Types
About Universal Names and Document Types
Printing an IS Document Type
Publishing Documents as JMS Messages
Creating a Launch Configuration to Publish a Document as a JMS Message
Publishing a Document as a JMS Message
Working with Publishable Document Types
Making a Document Type Publishable
About the Associated Provider Definition
About the Envelope Field
About the Properties Field
About Adapter Notifications and Publishable Document Types
Making a Document Type Unpublishable
About the Encoding Type for a Publishable Document Type
Using Protocol Buffers as the Encoding Type
Limitations for Representing Fields in Protocol Buffer Descriptors
Encoding Documents as Protocol Buffers during Document Publishing
Decoding Protocol Buffers
Setting the Encoding Type for a Publishable Document Type
About the Type of Document Storage
Document Storage Versus Broker Client Queue Storage
Setting the Document Storage Type for a Publishable Document Type
About the Time-to-Live for a Publishable Document Type
Setting the Time to Live for a Publishable Document Type
About Run-Time Validation for a Published Document
Specifying Document Validation for Instances of a Publishable Document Type
Important Considerations When Modifying Publishable Document Types
About Synchronizing Publishable Document Types
Synchronization Status
Synchronization Actions
Combining Synchronization Action with Synchronization Status
Synchronizing a Single Publishable Document Type
Synchronizing Multiple Document Types Simultaneously
Synchronizing Document Types in a Cluster
Synchronizing Document Types Across a Gateway
Importing and Overwriting References During Synchronization
What Happens When You Overwrite Elements on the Integration Server?
What Happens If You Do Not Overwrite Elements on the Integration Server?
About Testing Publishable Document Types
Creating a Launch Configuration for a Publishable Document Type
Testing a Publishable Document Type
Deleting Publishable Document Types
Working with XML Document Types
What Is an XML Document Type?
What Is XMLData?
Why Use XML Document Types Instead of IS Document Types?
Differences Between XML Document Types and IS Document Types
Limitations of XML Document Type Usage
Creating an XML Document Type
Working with JSON Document Types
What Is a JSON Document Type?
Considerations for Using JSON Document Types
Data Type Mapping
Creating a JSON Document Type
JSON Document Type Properties
Working with Specifications
Creating a Specification
Working with Variables
Creating a Document Reference or a Document Reference List Variable
Using XML Namespaces and Namespace Prefixes with Variables
Guidelines for Using XML Namespaces and Prefixes with Web Service Descriptors
Assigning XML Namespaces and Prefixes to Variables
Assigning Display Types to String Variables
About Variable Constraints
Considerations for Object Constraints
Applying Constraints to a Variable
Customizing a String Content Type
Viewing the Constraints Applied to Variables
Working with Schemas
What Does an IS Schema Look Like?
Schema Browser
Component Details
Creating an IS Schema
Creating an IS Schema from XML Schemas that Reference Other Schemas
About Editing Simple Type Definitions
Editing a Simple Type Definition
About Schema Domains
Working with JMS Triggers
About SOAP-JMS Triggers
Overview of Building a Non-Transacted JMS Trigger
Standard JMS Trigger Service Requirements
Creating a JMS Trigger
Adding JMS Destinations and Message Selectors to a JMS Trigger
Creating a Destination on the JMS Provider
About Durable and Non-Durable Subscribers
Creating a Message Selector
Adding Routing Rules to a Standard JMS Trigger
Creating a Local Filter
Managing Destinations and Durable Subscribers on the JMS Provider through Designer
Modifying Destinations or Durable Subscribers via a JMS Trigger in Designer
Building Standard JMS Triggers with Multiple Routing Rules
Guidelines for Building a JMS Trigger that Performs Ordered Service Execution
Enabling or Disabling a JMS Trigger
JMS Trigger States
Setting an Acknowledgement Mode
About Join Time-Outs
Join Time-Outs for All (AND) Joins
Join Time-Outs for Only One (XOR) Joins
Setting a Join Time-Out
About Execution Users for JMS Triggers
Assigning an Execution User to a JMS Trigger
About Message Processing
Serial Processing
Concurrent Processing
Message Processing and Message Consumers
Message Processing and Load Balancing
About Batch Processing for Standard JMS Triggers
Guidelines for Configuring Batch Processing
Using Multiple Connections to Retrieve Messages for a Concurrent JMS Trigger
Retrieving Multiple Messages for a JMS Trigger with Each Request
Prefetching Messages from webMethods Broker
Prefetching Messages with Universal Messaging
Configuring Message Processing
Fatal Error Handling for Non-Transacted JMS Triggers
Configuring Fatal Error Handling for Non-Transacted JMS Triggers
Transient Error Handling for Non-Transacted JMS Triggers
About Retry Behavior for Trigger Services
Service Requirements for Retrying a Trigger Service
Handling Retry Failure
Overview of Throw Exception for Retry Failure
Overview of Suspend and Retry Later for Retry Failure
Configuring Transient Error Handling for a Non-Transacted JMS Trigger
Exactly-Once Processing for JMS Triggers
Duplicate Detection Methods for JMS Triggers
Configuring Exactly-Once Processing for a JMS Trigger
Disabling Exactly-Once Processing for a JMS Trigger
Debugging a JMS Trigger
Building a Transacted JMS Trigger
Prerequisites for a Transacted JMS Trigger
Properties for Transacted JMS Triggers
Steps for Building a Transacted JMS Trigger
Fatal Error Handling for Transacted JMS Triggers
Configuring Fatal Error Handling for Transacted JMS Triggers
Transient Error Handling for Transacted JMS Triggers
Overview of Recover Only for Transaction Rollback
Overview of Suspend and Recover for Transaction Rollback
Configuring Transient Error Handling for Transacted JMS Triggers
Working with webMethods Messaging Triggers
Overview of Building a webMethods Messaging Trigger
webMethods Messaging Trigger Requirements
Trigger Service Requirements
Creating a webMethods Messaging Trigger
Creating Conditions
Using Filters with a Subscription
Creating Filters for Use with Universal Messaging
Universal Messaging Provider Filters and Encoding Type
Examples of Universal Messaging Provider Filters for Use with Protocol Buffers
Creating Filters for Use with webMethods Broker
Using Hints in Filters
Detecting Deadletters with Hints
Using Multiple Conditions in a webMethods Messaging Trigger
Using Multiple Conditions for Ordered Service Execution
Ordering Conditions in a webMethods Messaging Trigger
Disabling and Enabling a webMethods Messaging Trigger
Disabling and Enabling a webMethods Messaging Trigger in a Cluster or Non-Clustered Group
About Join Time-Outs
Join Time-Outs for All (AND) Join Conditions
Join Time-Outs for Only One (XOR) Join Conditions
Setting a Join Time-Out
About Priority Message Processing
Enabling and Disabling Priority Message Processing for a webMethods Messaging Trigger
About Execution Users for webMethods Messaging Triggers
Assigning an Execution User to a webMethods Messaging Trigger
About Capacity and Refill Level for the webMethods Messaging Trigger Queue
Guidelines for Setting Capacity and Refill Levels for webMethods Messaging Triggers
Setting Capacity and Refill Level for a webMethods Messaging Trigger
About Document Acknowledgements for a webMethods Messaging Trigger
Setting the Size of the Acknowledgement Queue
About Message Processing
Serial Processing
Serial Processing in a Cluster or Non-Clustered Group of Integration Servers
Serial Processing with the webMethods Broker in a Clustered or a Non-Clustered Group of Integration Servers
Serial Processing with Universal Messaging in a Clustered or a Non-Clustered Group of Integration Servers
Serial Triggers Migrated to Integration Server 10.3 or Later from Earlier Versions
Concurrent Processing
Selecting Message Processing
Changing Message Processing When webMethods Broker Is the Messaging Provider
Changing Message Processing When Universal Messaging Is the Messaging Provider
Synchronizing the webMethods Messaging Trigger and Durable Subscription on Universal Messaging
Fatal Error Handling for a webMethods Messaging Trigger
Configuring Fatal Error Handling for a webMethods Messaging Trigger
About Transient Error Handling for a webMethods Messaging Trigger
Service Requirements for Retrying a Trigger Service for a webMethods Messaging Trigger
Handling Retry Failure
Overview of Throw Exception for Retry Failure
Overview of Suspend and Retry Later for Retry Failure
Configuring Transient Error Handling for a webMethods Messaging Trigger
About Retrying Trigger Services and Shutdown Requests
Exactly-Once Processing for webMethods Messaging Triggers
Duplicate Detection Methods for a webMethods Messaging Trigger
Configuring Exactly-Once Processing for a webMethods Messaging Trigger
Disabling Exactly-Once Processing for a webMethods Messaging Trigger
Modifying a webMethods Messaging Trigger
Modifying a webMethods Messaging Trigger in a Cluster or Non-Clustered Group
Deleting webMethods Messaging Triggers
Deleting webMethods Messaging Triggers in a Cluster or Non-Clustered Group
Running a webMethods Messaging Trigger with a Launch Configuration
Creating a Launch Configuration for a webMethods Messaging Trigger
Running a webMethods Messaging Trigger
Testing Join Conditions
Debugging a webMethods Messaging Trigger
Enabling Trace Logging for All webMethods Messaging Triggers
Enabling Trace Logging for a Specific webMethods Messaging Trigger
Transient Error Handling During Trigger Preprocessing
Server and Trigger Properties that Affect Transient Error Handling During Trigger Preprocessing
Overview of Transient Error Handling During Trigger Preprocessing
Working with MQTT Triggers
Overview of Building an MQTT Trigger
MQTT Trigger Requirements
MQTT Trigger Service Requirements
Creating an MQTT Trigger
Disabling and Enabling an MQTT Trigger
MQTT Trigger States
Setting an Acknowledgement Mode for an MQTT Trigger
Assigning an Execution User to an MQTT Trigger
Configuring Message Processing for an MQTT Trigger
Transient Error Handling for an MQTT Trigger
Service Requirements for Retrying an MQTT Trigger
Handling Retry Failure
Overview of Throw Exception
Overview of Stop Trigger
Configuring Transient Error Handling for an MQTT Trigger
Building a Resource Monitoring Service for an MQTT Trigger
Modifying an MQTT Trigger
Deleting an MQTT Trigger
Working with Web Services
What Are Web Service Descriptors?
About Provider Web Service Descriptors
Service Signature Requirements for Service First Provider Web Service Descriptors
Using XML Namespaces with Prefixes with Fields in Service Signatures
Handling Incomplete Service Signatures Using Wrapper Services
Creating a Service First Provider Web Service Descriptor
Protocol Mismatch Between Transport and Primary Port
Creating a WSDL First Provider Web Service Descriptor
About Consumer Web Service Descriptors
Creating a Consumer Web Service Descriptor
Supporting Elements for a Consumer Web Service Descriptor
About Web Service Connectors
Refreshing a Web Service Connector
Invoking a Web Service Using a Web Service Connector
About Response Services
About Refreshing a Web Service Descriptor
How Refresh Affects a Web Service Descriptor
Considerations for Refreshing a Web Service Descriptor
Refreshing a Web Service Descriptor
Viewing the WSDL Document for a Web Service Descriptor
WS-I Compliance for Web Service Descriptors
Modifying WS-I Compliance for a Web Service Descriptor
Reporting the WS-I Profile Conformance for a Web Service Descriptor
Changing the Target Namespace for a Web Service Descriptor
Viewing the Namespaces Used within a WSDL Document
Enabling MTOM/XOP Support for a Web Service Descriptor
Enabling SOAP Attachments for a Web Service Descriptor
Using pub.string:base64Encode with MTOM Implementations
Adding SOAP Headers to the Pipeline
Validating SOAP Response
Validating Schemas Associated with a Web Service Descriptor
Enabling Xerces Schema Validation for a Web Service Descriptor
Omitting xsd:any from the WSDL Document
Working with Binders
Binders and Mixed Use
Existing Web Service Descriptors with Mixed Use Binders
Binders and Mixed Style
Adding a Binder to Web Service Descriptor
Copying Binders Across Provider Web Service Descriptors
Changing the Binder Transport
Deleting a Binder from a Web Service Descriptor
Deleting an Operation from a Binder
Modifying the SOAP Action for an Operation in a Binder
Assigning a Web Service Endpoint Alias to a Binder
Configuring Use of the Client Side Queue
Working with Operations
Adding Operations
Adding an IS Service as an Operation
Adding an Operation from another Provider Web Service Descriptor
Using a 6.5 SOAP-MSG Style Service as an Operation
Modifying the Signature of a 6.5 SOAP-MSG Style Operation
Deleting Operations
Viewing the Operation Input and Output
Adding Headers to an Operation
Adding a Header to an Operation
About SOAP Fault Processing
About SOAP Fault Elements
Adding a Fault Element to an Operation
The $fault Variable
Modifying a Returned SOAP Fault
Viewing Document Types for a Header or Fault Element
Working with Handlers
Setting Up a Header Handler
Registering a Header Handler
Adding a Handler to a Web Service Descriptor
Deleting a Handler from a Web Service Descriptor
Working with Policies
Attaching a Policy to a Web Service Descriptor
Removing a Policy from a Web Service Descriptor
About Pre-8.2 Compatibility Mode
Setting Compatibility Mode
Features Impacted by Compatibility Mode
Working with GraphQL Descriptors
Understanding the GraphQL Terminology
Supported and Unsupported GraphQL Features
GraphQL Data Type Mapping
Overview of Creating a GraphQL Descriptor
Creating a GraphQL Descriptor
How Integration Server Generates GraphQL Descriptor and Supporting Assets
How Integration Server Generates Input Signature for Resolver Services
How Integration Server Generates Output Signature for Resolver Services
How Integration Server Invokes a Resolver Service While Processing a GraphQL Request
Usage Notes for GraphQL Descriptors
Invoking a GraphQL Descriptor
Working with GET Request
Working with POST Request
How Integration Server Sends Response to a GraphQL Request
Modifying Properties to the GraphQL Descriptor
How Integration Server Calculates the Query Parameters
Refreshing a GraphQL Descriptor
Working with a GraphQL Dataloader
Creating a Dataloader
How Integration Server Uses Dataloader in Resolver Service
Using personLoader in listPersonResolver Root Resolver Service
Using personLoader in friendsResolver Resolver Service
Working with WebSocket Endpoints
Creating a WebSocket Server Endpoints
Creating a WebSocket Client Endpoint
Working with Recipes
Installing or Downloading Recipes
Working with UDDI Registry
Opening UDDI Registry View
Connecting to a UDDI Registry
Disconnecting from a UDDI Registry
Refreshing a UDDI Registry Session
Browsing for Web Services in a UDDI Registry
Applying a Filter to UDDI Registry
Clearing an Applied Filter
Creating a Web Service Descriptor from a UDDI Registry
Publishing a Service to UDDI Registry
Deleting a Service from UDDI Registry
Working with Flat Files
Concepts
What Is a Flat File Schema?
What Is a Flat File Dictionary?
When Should I Create a Flat File Dictionary?
Creating Flat File Schemas
Creating the Flat File Schema
Creating a Flat File Schema From a Sample File
Creating a Flat File Schema Manually
Specifying a Record Parser
Specifying a Delimited Record Parser for the Schema
Specifying a Fixed Length Record Parser for the Schema
Specifying a Variable Length Record Parser for the Schema
Specifying a Record Identifier
Defining the Schema Structure
Setting a Default Record
Allowing Undefined Data
Creating an Area
Specifying a Floating Record
Editing a Flat File Schema
Testing Flat File Schemas
Creating a Launch Configuration for a Flat File Schema
Testing a Flat File Schema
Creating Flat File Dictionaries
Creating a Flat File Dictionary
Adding Elements to the Flat File Dictionary
Setting Properties for the Flat File Dictionary
Editing a Flat File Dictionary
Defining Flat File Elements
Adding a Record Definition
Adding a Record Reference
Adding a Composite Definition
Adding a Composite Reference
Adding a Field Definition
Adding a Field Reference
Working with Adapters
About Adapter Connections
About Adapter Services
About Adapter Listeners
About Adapter Notifications
Subscribing to Events
What Happens When an Event Occurs?
Subscribing to Events
Creating Event Filters
Creating Event Filters for Services
Viewing and Editing Event Subscriptions
Suspending Event Subscriptions
Deleting an Event Subscription
Building an Event Handler
Invoking Event Handlers Synchronously or Asynchronously
About Alarm Events
About Audit Events
About Audit Error Events
About Exception Events
About Guaranteed Delivery Events
Guaranteed Delivery Events and Transaction Events
About JMS Delivery Failure Events
About JMS Retrieval Failure Events
About Port Status Events
About Replication Events
About Security Events
About Session Events
About Stat Events
About Transaction Events
Submitting and Receiving XML Documents
Submitting and Receiving XML in a String Variable
Sample Client Code to Submit an XML Document in a String Variable
Considerations When Coding the Target Service to Receive the XML Document that is Passed in a String Variable
Submitting and Receiving XML in $xmldata
Sample Client Code to Submit an XML Document in $xmldata
Considerations When Coding the Target Service to Receive the XML Document that is Passed in $xmldata
Submitting and Receiving XML via HTTP
Creating a Client that Submits an XML Document via HTTP
Using pub.client:http to Submit an XML Document via HTTP
About the xmlFormat Value
Submitting and Receiving XML via $xmldata without Parsing
Using pub.client:http to Submit $xmldata via HTTP
Submitting and Receiving XML via FTP
Naming the File that the Client is to Submit via FTP
Actions a Client Takes to Submit an XML Document via FTP
Actions a Client Takes to Retrieve Output from the Target Service
Considerations When Coding the Target Service to Receive the XML Document
Submitting and Receiving XML via E-mail
Actions a Client Must Take to Submit an XML Document via Email
Using pub.client:smtp to Submit an XML Document via Email
Considerations When Coding the Target Service to Receive the XML Document
Working with Load and Query Services
What Are the Load and Query Services?
Basic Concepts
About the pub.xml:loadXMLNode Service
About the pub.xml:loadEnhancedXMLNode Service
About the pub.xml:queryXMLNode Service
Building Services that Retry
Requirements for Retrying a Service
Example Service that Throws an Exception for Retry
Creating Client Code
Building a Java Client
Limitations when Generating Java Client Code
Files that Designer Generates for a Java Client
Generating Java Client Code
Building a C/C++ Client
Prerequisites for Generating C/C++ Client Code
Limitations when Generating C/C++ Client Code
Files that Designer Generates for a C/C++ Client
Generating C/C++ Client Code
Building a Browser-Based Client
Prerequisites for Building Browser-Based Client Code
URL Client Uses to Invoke Services
How Input Values are Passed to the Service the Browser-Based Client Invokes
When Browser-Based Clients Pass Multiple Values for the Same Input Variable
When Browser-Based Clients Pass Multiple Input Variables with the Same Name
How Integration Server Returns Output from the Service the Client Invoked
Building a REST Client
Comparing Integration Server Packages and Elements
Working with the Compare Editor
Change List Panel
Content Panel
Guidelines for Comparing Packages, Folders, and Elements
Comparing Integration Server Elements
Merging IS Elements
Comparing Integration Server Folders
Comparing Integration Server Packages
Publishing and Retracting Metadata for IS and TN Assets
Available IS and TN Assets
Publishing and Retracting Metadata
Considerations for Publishing and Retracting Metadata
Publishing Metadata for IS Assets or TN Document Types at the Integration Server Level
Retracting Metadata for IS Assets or TN Document Types at the Integration Server Level
Publishing Metadata for IS Assets or TN Document Types at the Asset Level
Retracting Metadata for IS Assets or TN Document Types at the Asset Level
Usage Notes for IS Assets
Status Information for Publish and Retract Requests
Summary Information for Publish and Retract Requests
Connecting to webMethods API Portal for Publishing REST API Descriptors
Configuring a Connection to API Portal
Adding a Connection Configuration for API Portal
Editing a Connection Configuration for API Portal
Removing a Connection Configuration for API Portal
Changing the Default Connection Configuration for API Portal
Publishing Assets to webMethods API Gateway
Configuring a Connection to API Gateway
Editing a Connection Configuration for API Gateway
Removing a Connection Configuration for API Gateway
Changing the Default Connection Configuration for API Gateway
Publishing Assets to API Gateway
Connecting to webMethods Cloud Container
Configuring a Connection to Cloud Container
Adding a Connection Configuration for Cloud Container
Editing a Connection Configuration for Cloud Container
Removing a Connection Configuration for Cloud Container
Deploying to webMethods Cloud Container
Deploying Packages and Configuration Assets to Cloud Container
Checking the Deployment Status
Asset Repository
Opening the Asset Repository View
Building Packages and Assets in Asset Repository View
Deploying Packages and Assets from Asset Repository View
Retracting Packages and Assets
Deleting Packages and Assets
Configuring a Universal Messaging Server
Modifying a Universal Messaging Server
Removing a Universal Messaging Server
Using Landscape Navigator to View Runtime Configurations (Deprecated)
What Does the Landscape Navigator View Contain?
Creating Command Central Definitions
Editing Command Central Definition
Deleting a Command Central Definition
What Does the Configuration Browser View Contain?
Browsing Runtime Instances and Configurations
Deploying Customized Configuration to Cloud Container
Exporting Deployable Configuration
Using Configuration Project
Editing Configuration Template
Deploying a Configuration Project
Using the Cloud Service Development Feature
Prerequisites
Opening the Cloud Service Development Perspective
The Cloud Explorer View
Supported and Unsupported Functions
API Portal Preferences
Command Central Preferences
Command Central Connection Configuration
Labels and Decorations
Monitoring
Projects
Document Expansion Preferences
Cloud Container Preferences
Integration Server Preferences
Universal Messaging Preferences
Service Development Preferences
Adapter Service/Notification Editor Preferences
Compare Editor Preferences
Element Property Templates Preferences
Flow Service Editor Preferences
HTML Generation Preferences
Java/C Service Editors Preferences
Launching Preferences
Local Service Development Preferences
Package Navigator Preferences
Publishable Document Type Preferences
Results View Preferences
Run/Debug Preferences
Schema Editor Preferences
Swagger Syntax Coloring Preferences
Web Service Descriptor Editor Preferences
Properties
Integration Server Properties
Event Manager Properties
My Locked Elements
Server ACL Information
Server Information
Package Properties
Package Information
Package Dependencies
Package Settings
Package Permissions
Package Replication Services
Package Startup/Shutdown Services
Element Properties
Element Information
Element Permissions
Element General Properties
REST Resource Configuration
Document Type Properties
General Properties for IS Document Types
JSON Document Type Properties
webMethods Messaging Properties
Universal Name Properties
Flat File Dictionary Properties
General Properties for a Flat File Dictionary
Flat File Element Properties
Record Definition Properties
Record Reference Properties
Composite Definition Properties
Composite Reference Properties
Field Definition Properties
Field Reference Properties
Flat File Schema Properties
General Properties for a Flat File Schema
Default Record Properties
Settings Properties
Schema Definition Properties
JMS Trigger Properties
General Properties for Non-Transacted JMS Triggers
General Properties for Transacted JMS Triggers
Message Processing Properties
Fatal Error Handling Properties
Transient Error Handling with a Non-Transacted JMS Trigger
Transient Error Handling with a Transacted JMS Trigger
Exactly Once Processing Properties
webMethods Broker Properties (Deprecated)
Link Properties
General Properties for Links
MQTT Trigger Properties
General Properties for an MQTT Trigger
Message Processing Properties
Transient Error Handling Properties
OData Service Properties
General Properties for OData Services
OData Element Properties
Entity Type Properties
Complex Type Properties
External Entity Type Properties
Simple Property Properties
General Properties for Simple Property
Facets Properties for Simple Property
Complex Property Properties
Association Properties
General Properties for Association
OData Association End Properties
OData Association Navigation Properties
REST V2 Resource Properties
REST API Descriptor Properties
General Properties for REST API Descriptors
REST Resource Properties
Operation Properties
REST Definition Properties
REST Definition Parameter Properties
Schema Properties
General Properties for IS Schemas
Schema Component Properties
All Content Model
Any Attribute Declaration
Any Element Declaration
Attribute Declaration
Attribute Reference
Choice Content Model
Complex Type Definition
Element Declaration
Element Reference
Empty Content
Mixed Content Model
Sequence Content Model
Simple Type Definition
Service Properties
General Properties for Services
Run Time Properties for Services
Transient Error Handling Properties
Audit Properties
Circuit Breaker Properties
Universal Name Properties for Services
Output Template Properties for Services
Specification Properties
General Properties for Specifications
Transformer Properties
General Properties for Transformers
Variable Properties
General Properties for Variables
Constraints Properties for a Variable
Constraints Applied to Variables
webMethods Messaging Trigger Properties
General Properties for webMethods Messaging Triggers
Trigger Queue Properties
Message Processing Properties
Fatal Error Handling Properties
Transient Error Handling Properties
Exactly Once Properties
Web Service Connector Properties
General Properties for Web Service Connectors
Run Time Properties
Audit Properties
Universal Name Properties
Output Template Properties
Web Service Descriptor Properties
General Properties for Web Service Descriptors
Web Service Descriptor Operation Properties
Operation Properties
Body Element Properties
Header Element Properties
Fault Element Properties
Web Service Descriptor Binder Properties
General Properties for Binders
JMS Settings Properties for a Binder
JMS Message Details Properties for a Binder
Web Service Descriptor Header Handler Properties
GraphQL Descriptor Properties
Query Properties for GraphQL Descriptor
GraphQL Dataloaders
WebSocket Endpoint Properties
webMethods Flow Steps
BRANCH
Branching on a Switch Value
Branching on Expressions
BRANCH Properties
Conditions that Will Cause a BRANCH Step to Fail
CATCH
CATCH Properties
EXIT
EXIT Properties
Examples of When to Use an EXIT Step
FINALLY
FINALLY Properties
INVOKE
INVOKE Properties
Conditions that Will Cause an INVOKE Step to Fail
LOOP
LOOP Properties
Conditions that Will Cause a LOOP Step to Fail
MAP
MAP Properties
Example of When to Use a MAP Step
REPEAT
REPEAT Properties
When Does REPEAT Fail?
Examples of When to Use a REPEAT Step
SEQUENCE
SEQUENCE Properties
Conditions that Will Cause the SEQUENCE Step to Fail
TRY
TRY Properties
Data Types
Data Types in IData Objects
Java Classes for Objects
How Designer Supports Tables
Icons
Package Navigator View Icons
UDDI Registry View Icons
Flat File Element Icons
Flow Step Icons
OData Service Icons
REST API Descriptor Icons
Schema Component Icons
Toolbars
Compare Editor Toolbar
Document Type Editor Toolbar
Flat File Schema and Dictionary Editors Toolbars
Package Navigator View Toolbar
Cloud Explorer View Toolbar
Pipeline View Toolbar
REST API Descriptor Toolbar
GraphQL Descriptor Toolbar
Service Editor Toolbar
Results View Toolbar
Specification Editor Toolbar
UDDI Registry View Toolbar
Variables View Toolbar
Web Service Descriptor Editor Toolbar
Keyboard Shortcuts
Conditional Expressions
Guidelines for Writing Expressions and Filters
Syntax
Comparing Java Objects to Constants
Verifying Variable Existence
Operators for Use in Conditional Expressions
Relational Operators
Standard Relational Operators
Lexical Relational Operators
Logical Operators
Operator Precedence in Conditional Expressions
Addressing Variables
Addressing Variables that Contain Special Characters
Typing Special Characters in Expressions
Rules for Use of Expression Syntax with the Broker
Regular Expressions
Using a Regular Expression in a Mask
Regular Expression Operators
Validation Content Constraints
Content Types
Constraining Facets
webMethods Query Language
Overview
Object References
Sibling Operators
Object Properties
Property Masking
Appendix
Usage Notes on REST
Configuring a REST Resource Using the Legacy Approach
Processing Requests Using Partial Matching of URL Aliases
Setting Up a REST Application on Integration Server
Services for REST Resources Configured Using the Legacy Approach
Configuration
Converting an Existing Application to a REST Application
Examples of Configuring REST Resources Based on JSON API
Example of Defining a REST V2 Resource Operation
Usage Notes on REST API Descriptor
Administering Integration Server
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 the Integration Server Administrator
What Is the Integration Server Administrator?
Starting the Integration Server Administrator
Starting Integration Server Administrator on Windows
Accessing Integration Server Administrator through My webMethods
Basic Operations of Integration Server Administrator
Logging Off Integration Server Administrator
Getting Help
The Server Configuration File
Software AG Command Central
Introduction to the New webMethods Integration Server Administrator
Accessing the New Integration Server Administrator
First Look at the New Integration Server Administrator
Dashboard
Overview
JVM Metrics
Usages
Services
Service Instances
Cache and Prefetch Information
Circuit Breaker Information
APIs
Common Directory Services
Monitoring
Naming and Navigation Changes in the New Integration Server Administrator
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
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
View the Universal Messaging Client Log
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
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
TLSv1.3 Support
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
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
Sample Package
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 Ehcache on Integration Server
What is 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 Ehcache Activity
Logging 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
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 Port
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
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
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.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.
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 Logged by Axis2, Kerberos, SAML, and other Third Party Libraries
Wireless Communication with the Integration Server
Overview
How Does the Integration Server Communicate with Wireless Devices?
Using URLs for Wireless Access to the Integration Server
Invoking a Service with a URL
Requesting a WML or HDML Page with a URL
WML and HDML Samples
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
Integration Server Built-In Services
About this Guide
About Built-In Services
List of Public Folders
Access Permissions for Built-In Services
About Deprecated Services
Alert Folder
Summary of Elements in this Folder
pub.alert.notifier:create
pub.alert.notifier:delete
pub.alert.notifier:disable
pub.alert.notifier:enable
pub.alert.notifier:list
pub.alert.notifier:update
pub.alert:channels
pub.alert:countAll
pub.alert:countUnread
pub.alert:emit
pub.alert:fetch
pub.alert:fetchAll
pub.alert:getSettings
pub.alert:markAllAsRead
pub.alert:markAsRead
pub.alert:markAsUnread
pub.alert:setSettings
pub.alert:severities
ART Folder
Summary of Elements in this Folder
pub.art:listRegisteredAdapters
pub.art.connection:disableConnection
pub.art.connection:enableConnection
pub.art.connection:getConnectionStatistics
pub.art.connection:listAdapterConnections
pub.art.connection:queryConnectionState
pub.art.listener:disableListener
pub.art.listener:enableListener
pub.art.listener:listAdapterListeners
pub.art.listener:queryListenerState
pub.art.listener:resumeListener
pub.art.listener:setListenerNodeConnection
pub.art.listener:suspendListener
pub.art.notification:disableListenerNotification
pub.art.notification:disablePollingNotification
pub.art.notification:disablePublishEvents
pub.art.notification:enableListenerNotification
pub.art.notification:enablePollingNotification
pub.art.notification:enablePublishEvents
pub.art.notification:listAdapterListenerNotifications
pub.art.notification:listAdapterPollingNotifications
pub.art.notification:queryListenerNotificationState
pub.art.notification:queryPollingNotificationState
pub.art.notification:resumePollingNotification
pub.art.notification:setListenerNotificationNodeListener
pub.art.notification:setPollingNotificationNodeConnection
pub.art.notification:suspendPollingNotification
pub.art.service:listAdapterServices
pub.art.service:setAdapterServiceNodeConnection
pub.art.transaction:commitTransaction
pub.art.transaction:rollbackTransaction
pub.art.transaction:setTransactionTimeout
pub.art.transaction:startTransaction
Assets Folder
Summary of Elements in this Folder
pub.assets:getChecksums
Cache Folder
About Checkpoint Restart
Summary of Elements in this Folder
pub.cache:containsKey
pub.cache:get
pub.cache:getAll
pub.cache:getKeys
pub.cache:put
pub.cache:putAll
pub.cache:remove
pub.cache:removeAll
pub.cache:search
pub.cache.admin:clearAllCaches
pub.cache.admin:clearCache
pub.cache.admin:disableCache
pub.cache.admin:enableCache
pub.cache.admin:evictExpiredElements
pub.cache.admin:isCacheDisabled
pub.cache.atomic:putIfAbsent
pub.cache.atomic:remove
pub.cache.atomic:replace
pub.cache.atomic:replaceIfKeyExists
pub.cache.bulk:isClusterBulkLoadEnabled
pub.cache.bulk:isNodeBulkLoadEnabled
pub.cache.bulk:setNodeBulkLoadEnabled
pub.cache.bulk:waitUntilClusterBulkLoadComplete
pub.cache.lock:acquireLock
pub.cache.lock:isLockedByCurrentThread
pub.cache.lock:releaseLock
pub.cache.serviceResults:addCacheEntry
pub.cache.serviceResults:listServiceCache
pub.cache.serviceResults:resetServerCache
pub.cache.serviceResults:resetServiceCache
Client Folder
Summary of Elements in this Folder
pub.client:ftp
pub.client.ftp:append
pub.client.ftp:cd
pub.client.ftp:cdls
pub.client.ftp:delete
pub.client.ftp:dir
pub.client.ftp:get
pub.client.ftp:getCompletedNotification
pub.client.ftp:login
pub.client.ftp:logout
pub.client.ftp:ls
pub.client.ftp:mdelete
pub.client.ftp:mget
pub.client.ftp:mput
pub.client.ftp:put
pub.client.ftp:putCompletedNotification
pub.client.ftp:quote
pub.client.ftp:rename
pub.client.ftp:sessioninfo
pub.client:http
pub.client.ldap:add
pub.client.ldap:bind
pub.client.ldap:cancelNotification
pub.client.ldap:compare
pub.client.ldap:delete
pub.client.ldap:modify
pub.client.ldap:registerNotification
pub.client.ldap:rename
pub.client.ldap:search
pub.client.oauth:executeRequest
pub.client.oauth:getExternalAccessToken
pub.client:restClient
pub.client.sftp:cd
pub.client.sftp:chgrp
pub.client.sftp:chmod
pub.client.sftp:chown
pub.client.sftp:get
pub.client.sftp:login
pub.client.sftp.admin:getDefaultAlgorithms
pub.client.sftp.admin:getHostKey
pub.client.sftp:logout
pub.client.sftp:ls
pub.client.sftp:mkdir
pub.client.sftp:put
pub.client.sftp:pwd
pub.client.sftp:rename
pub.client.sftp:rm
pub.client.sftp:rmdir
pub.client.sftp:symlink
pub.client:smtp
pub.client:soapClient
pub.client:soapHTTP
pub.client:soapRPC
pub.client:websocket
Compress Folder
Summary of Elements in this Folder
pub.compress:compressData
pub.compress:decompressData
Date Folder
Pattern String Symbols
Time Zones
Examples
Notes on Invalid Dates
Summary of Elements in this Folder
pub.date:calculateDateDifference
pub.date:compareDates
pub.date:currentNanoTime
pub.date:dateBuild
pub.date:dateTimeBuild
pub.date:dateTimeFormat
pub.date:elapsedNanoTime
pub.date:formatDate
pub.date:getCurrentDate
pub.date:getCurrentDateString
pub.date:getWorkingDays
pub.date:incrementDate
Datetime Folder
Supplying Time Zones
Summary of Elements in this Folder
pub.datetime:build
pub.datetime:increment
Db Folder
Summary of Elements in this Folder
pub.db:call
pub.db:clearTransaction
pub.db:close
pub.db:closeAll
pub.db:commit
pub.db:connect
pub.db:delete
pub.db:execSQL
pub.db:getProcInfo
pub.db:getProcs
pub.db:getTableInfo
pub.db:getTables
pub.db:insert
pub.db:query
pub.db:rollback
pub.db:startTransaction
pub.db:update
Document Folder
Summary of Elements in this Folder
pub.document:bytesToDocument
pub.document:deleteDocuments
pub.document:documentListToDocument
pub.document:documentToBytes
pub.document:documentToDocumentList
pub.document:documentToXMLValues
pub.document:groupDocuments
pub.document:insertDocument
pub.document:searchDocuments
pub.document:sortDocuments
pub.document:XMLValuesToDocument
Event Folder
Summary of Elements in this Folder
pub.event:addSubscriber
pub.event:alarm
pub.event:alarmInfo
pub.event:audit
pub.event:auditError
pub.event:auditErrorInfo
pub.event:auditInfo
pub.event:callstackItem
pub.event:deleteSubscriber
pub.event.eda:event
pub.event.eda:eventToDocument
pub.event.eda:schema_event
pub.event:error
pub.event:errorInfo
pub.event:exception
pub.event:exceptionInfo
pub.event:gdEnd
pub.event:gdEndInfo
pub.event:gdStart
pub.event:gdStartInfo
pub.event:getEventTypes
pub.event:getSubscribers
pub.event:jmsReceiveErrorEvent
pub.event:jmsSendErrorEvent
pub.event:journal
pub.event:journalInfo
pub.event:modifySubscriber
pub.event:portStatus
pub.event:portStatusInfo
pub.event:reloadEventManagerSettings
pub.event:replication
pub.event:replicationInfo
pub.event.routing:eventAcknowledgement
pub.event.routing:send
pub.event.routing:subscribe
pub.event.routing:unsubscribe
pub.event:saveEventManagerSettings
pub.event:security
pub.event:securityInfo
pub.event:sessionEnd
pub.event:sessionEndInfo
pub.event:sessionExpire
pub.event:sessionExpireInfo
pub.event:sessionStart
pub.event:sessionStartInfo
pub.event:stat
pub.event:statInfo
pub.event:txEnd
pub.event:txEndInfo
pub.event:txStart
pub.event:txStartInfo
File Folder
File Access Control Configuration for the pub.file Services
Parameter Settings
Summary of Elements in this Folder
pub.file:bytesToFile
pub.file:checkFileExistence
pub.file:copyFile
pub.file:deleteFile
pub.file:getFile
pub.file:listFiles
pub.file:moveFile
pub.file:readerToFile
pub.file:streamToFile
pub.file:stringToFile
Flat File Folder
Summary of Elements in the Flat File Folder
pub.flatFile:convertToString
pub.flatFile:convertToValues
pub.flatFile:FormatService
pub.flatFile:getSupportedEncodings
pub.flatFile.generate:createDocumentType
pub.flatFile.generate:createFFDictionary
pub.flatFile.generate:deleteFFDictionary
pub.flatFile.generate:deleteFFDictionaryEntry
pub.flatFile.generate:deleteFFSchema
pub.flatFile.generate:FFDictionary
pub.flatFile.generate:FFSchema
pub.flatFile.generate:findDependants
pub.flatFile.generate:findReferences
pub.flatFile.generate:getFFDictionaryAsXML
pub.flatFile.generate:getFFDictionaryEntryAsXML
pub.flatFile.generate:getFFSchemaAsXML
pub.flatFile.generate:listFFDictionaryEntries
pub.flatFile.generate:saveXMLAsFFDictionary
pub.flatFile.generate:saveXMLAsFFSchema
pub.flatFile.generate:updateFFDictionaryEntryFromXML
Flow Folder
Summary of Elements in this Folder
pub.flow:clearPipeline
pub.flow:debugLog
pub.flow:getCallingService
pub.flow:getLastError
pub.flow:getLastFailureCaught
pub.flow:getRetryCount
pub.flow:getSession
pub.flow:getTransportInfo
pub.flow:HTTPRequest
pub.flow:HTTPResponse
pub.flow:invokeService
pub.flow:iterator
pub.flow:restorePipeline
pub.flow:restorePipelineFromFile
pub.flow:savePipeline
pub.flow:savePipelineToFile
pub.flow:setCustomContextID
pub.flow:setResponse
pub.flow:setResponse2
pub.flow:setResponseCode
pub.flow:setResponseHeader
pub.flow:setResponseHeaders
pub.flow:throwExceptionForRetry
pub.flow:tracePipeline
pub.flow:transportInfo
GraphQL Folder
Summary of Elements in this Folder
pub.graphql:load
pub.graphql:loadMany
Hashtable Folder
Summary of Elements in this Folder
pub.hashtable:containsKey
pub.hashtable:createHashtable
pub.hashtable:get
pub.hashtable:listKeys
pub.hashtable:put
pub.hashtable:remove
pub.hashtable:size
IO Folder
Summary of Elements in this Folder
pub.io:bytesToStream
pub.io:close
pub.io:createByteArray
pub.io:mark
pub.io:markSupported
pub.io:read
pub.io:readAsString
pub.io:readerToString
pub.io:reset
pub.io:skip
pub.io:streamToBytes
pub.io:streamToReader
pub.io:streamToString
pub.io:stringToReader
pub.io:stringToStream
JDBC Folder
Summary of Elements in this Folder
pub.jdbc:getPoolInfo
JMS Folder
Summary of Elements in This Folder
pub.jms:acknowledge
pub.jms:batchTriggerSpec
pub.jms:createConsumer
pub.jms:documentResolverSpec
pub.jms:JMSMessage
pub.jms:receive
pub.jms:reply
pub.jms:send
pub.jms:sendAndWait
pub.jms:sendBatch
pub.jms:triggerSpec
pub.jms:waitForReply
pub.jms.wmjms:receiveStream
pub.jms.wmjms:sendStream
JSON Folder
Data Type Mapping
Summary of Elements in This Folder
pub.json:closeArrayIterator
pub.json:documentToJSONString
pub.json:getArrayIterator
pub.json:getNextBatch
pub.json:jsonStreamToDocument
pub.json:jsonStringToDocument
pub.json.schema:validate
List Folder
Summary of Elements in this Folder
pub.list:addItemToVector
pub.list:appendToDocumentList
pub.list:appendToStringList
pub.list:sizeOfList
pub.list:stringListToDocumentList
pub.list:vectorToArray
Math Folder
Summary of Elements in this Folder
pub.math:absoluteValue
pub.math:addFloatList
pub.math:addFloats
pub.math:addIntList
pub.math:addInts
pub.math:addObjects
pub.math:divideFloats
pub.math:divideInts
pub.math:divideObjects
pub.math:max
pub.math:min
pub.math:multiplyFloatList
pub.math:multiplyFloats
pub.math:multiplyIntList
pub.math:multiplyInts
pub.math:multiplyObjects
pub.math:randomDouble
pub.math:roundNumber
pub.math:subtractFloats
pub.math:subtractInts
pub.math:subtractObjects
pub.math:toNumber
Metadata Folder
Summary of Elements in this Folder
pub.metadata.assets:publishPackages
MIME Folder
Summary of Elements in this Folder
pub.mime:addBodyPart
pub.mime:addMimeHeader
pub.mime:createMimeData
pub.mime:getBodyPartContent
pub.mime:getBodyPartHeader
pub.mime:getContentType
pub.mime:getEnvelopeStream
pub.mime:getMimeHeader
pub.mime:getNumParts
pub.mime:getPrimaryContentType
pub.mime:getSubContentType
pub.mime:mergeHeaderAndBody
pub.mime:releaseBodyPartReferenceInTSpace
MQTT Folder
Summary of Elements in this Folder
pub.mqtt:publish
pub.mqtt:triggerSpec
OAuth Folder
Summary of Elements in this Folder
pub.oauth:authorize
pub.oauth:getAccessToken
pub.oauth:getToken
pub.oauth:introspectToken
pub.oauth:refreshAccessToken
pub.oauth:removeExpiredAccessToken
pub.oauth:revokeToken
Packages Folder
Summary of Elements in this Folder
pub.packages:activatePackage
pub.packages:backupPackage
pub.packages:disablePackage
pub.packages:enablePackage
pub.packages:installPackage
pub.packages:recoverPackage
pub.packages:reloadPackage
pub.packages.hotdeployment:cancel
Parquet Folder
Summary of Elements in this Folder
pub.parquet:closeBatchIterator
pub.parquet:documentTypeToSchema
pub.parquet:getBatchIterator
pub.parquet:getNextBatch
pub.parquet:read
pub.parquet:write
Publish Folder
Summary of Elements in this Folder
pub.publish:deliver
pub.publish:deliverAndWait
pub.publish:documentResolverSpec
pub.publish:envelope
pub.publish:getRedeliveryCount
pub.publish:publish
pub.publish:publishAndWait
pub.publish:reply
pub.publish:syncToBroker
pub.publish:syncToProvider
pub.publish:waitForReply
pub.publish.notification:error
Remote Folder
Summary of Elements in this Folder
pub.remote:invoke
pub.remote.gd:end
pub.remote.gd:getStatus
pub.remote.gd:invoke
pub.remote.gd:restart
pub.remote.gd:retrieve
pub.remote.gd:send
pub.remote.gd:start
pub.remote.gd:submit
Replicator Folder
Summary of Elements in this Folder
pub.replicator:addReleaseRegistryEntry
pub.replicator:deleteReleaseRegistryEntry
pub.replicator:distributeViaFTP
pub.replicator:distributeViaSvcPull
pub.replicator:distributeViaSvcPush
pub.replicator:generateReplicationEvent
pub.replicator:getLocalReleasedList
pub.replicator:getRemoteReleasedList
pub.replicator:notifyPackageRelease
pub.replicator:packageCreation
Report Folder
Summary of Elements in this Folder
pub.report:runFileTemplate
pub.report:runFileTemplateOnPipe
pub.report:runStringTemplate
pub.report:runStringTemplateOnPipe
pub.report:runTemplate
pub.report:runTemplateOnPipe
Scheduler Folder
Summary of Elements in this Folder
pub.scheduler:addComplexTask
pub.scheduler:addOneTimeTask
pub.scheduler:addRepeatingTask
pub.scheduler:cancelTask
pub.scheduler:getTaskIDs
pub.scheduler:getTaskInfo
pub.scheduler:getUserTaskList
pub.scheduler:migrateTasksToJDBC
pub.scheduler:resumeTask
pub.scheduler:suspendTask
pub.scheduler:updateComplexTask
pub.scheduler:updateOneTimeTask
pub.scheduler:updateRepeatingTask
Schema Folder
Summary of Elements in this Folder
pub.schema:createXSD
pub.schema:validate
pub.schema:validatePipeline
pub.schema.w3c
pub.schema.w3c:datatypes
pub.schema.w3c:structures
pub.schema.w3c:xml
pub.schema.w3c:xsi
Security Folder
About the Security Elements
Summary of Elements in this Folder
pub.security:clearAuthenticationCache
pub.security:clearKeyAndChain
pub.security:setKeyAndChain
pub.security:setKeyAndChainFromBytes
pub.security.enterpriseGateway:alertSpec
pub.security.enterpriseGateway:customFilterSpec
pub.security.keystore:getCertificate
pub.security.keystore:getKeyAndChain
pub.security.keystore:getTrustedCertificates
pub.security.keystore:setKeyAndChain
pub.security.keystore.pkcs7:sign
pub.security.outboundPasswords:setPassword
pub.security.outboundPasswords:getPassword
pub.security.outboundPasswords:listKeys
pub.security.outboundPasswords:removePassword
pub.security.outboundPasswords:updatePassword
pub.security.pkcs7:sign
pub.security.pkcs7:verify
pub.security:userInfoSpec
pub.security.util:createMessageDigest
pub.security.util:getCertificateInfo
pub.security.util:loadPKCS7CertChain
pub.security.util:createSecureString
pub.security.util:convertSecureString
pub.security.util:destroySecureString
pub.security.xml:decryptXML
pub.security.xml:encryptXML
pub.security.xml:signXML
pub.security.xml:verifyXML
SMIME Folder
Summary of Elements in this Folder
pub.smime:createCertsOnlyData
pub.smime:createEncryptedData
pub.smime:createSignedAndEncryptedData
pub.smime:createSignedData
pub.smime:processCertsOnlyData
pub.smime:processEncryptedData
pub.smime:processSignedData
pub.smime.keystore:createSignedAndEncryptedData
pub.smime.keystore:createSignedData
pub.smime.keystore:processEncryptedData
SOAP Folder
Summary of Elements in this Folder
pub.soap.handler:addBodyBlock
pub.soap.handler:addFaultBlock
pub.soap.handler:addHeaderBlock
pub.soap.handler:addHeaderElement
pub.soap.handler:generateDocumentTypesFromWSDL
pub.soap.handler:getBodyBlock
pub.soap.handler:getBodyBlockQNames
pub.soap.handler:getFaultBlock
pub.soap.handler:getHeaderBlock
pub.soap.handler:getHeaderBlockQNames
pub.soap.handler:getHeaderElement
pub.soap.handler:getInitialSOAPMessage
pub.soap.handler:getMessageAddressingProperties
pub.soap.handler:getProperty
pub.soap.handler:getServicePipeline
pub.soap.handler:getSOAPMessage
pub.soap.handler:getWebServiceInvocationProperties
pub.soap.handler:handlerSpec
pub.soap.handler:hasFaultMessage
pub.soap.handler:listConsumer
pub.soap.handler:listProvider
pub.soap.handler:registerConsumer
pub.soap.handler:registerProvider
pub.soap.handler:registerWmConsumer
pub.soap.handler:registerWmProvider
pub.soap.handler:removeBodyBlock
pub.soap.handler:removeHeaderBlock
pub.soap.handler:removeHeaderElement
pub.soap.handler:removeProperty
pub.soap.handler:setProperty
pub.soap.handler:setSOAPMessage
pub.soap.handler:unregisterConsumer
pub.soap.handler:unregisterProvider
pub.soap.handler:updateFaultBlock
pub.soap.processor:list
pub.soap.processor:processMessage
pub.soap.processor:processRPCMessage
pub.soap.processor:registerProcessor
pub.soap.processor:unregisterProcessor
pub.soap.schema:encoding
pub.soap.schema:encoding_1_2
pub.soap.schema:envelope
pub.soap.schema:envelope_1_2
pub.soap.utils:addBodyEntry
pub.soap.utils:addHeaderEntry
pub.soap.utils:addTrailer
pub.soap.utils:callbackServiceSpec
pub.soap.utils:convertToVersionSpecificSOAPFault
pub.soap.utils:createSoapData
pub.soap.utils:createXOPObject
pub.soap.utils:exitUnableToUnderstand
pub.soap.utils:getActor
pub.soap.utils:getBody
pub.soap.utils:getBodyEntries
pub.soap.utils:getDocument
pub.soap.utils:getEncoding
pub.soap.utils:getHeader
pub.soap.utils:getHeaderEntries
pub.soap.utils:getMustUnderstand
pub.soap.utils:getQName
pub.soap.utils:getTrailers
pub.soap.utils:getXOPObjectContent
pub.soap.utils:QName
pub.soap.utils:removeBodyEntry
pub.soap.utils:removeHeaderEntry
pub.soap.utils:removeTrailer
pub.soap.utils:requestResponseSpec
pub.soap.utils:resetWSDEffectivePolicy
pub.soap.utils.setWSDEffectivePolicy
pub.soap.utils:soapDataToBytes
pub.soap.utils:soapDataToString
pub.soap.utils:soapFault
pub.soap.utils:streamToSoapData
pub.soap.utils:stringToSoapData
pub.soap.utils:validateSoapData
pub.soap.wsa:action
pub.soap.wsa:faultTo
pub.soap.wsa:from
pub.soap.wsa:messageID
pub.soap.wsa:problemAction
pub.soap.wsa:problemHeaderQName
pub.soap.wsa:problemIRI
pub.soap.wsa:relatesTo
pub.soap.wsa:replyTo
pub.soap.wsa:retryAfter
pub.soap.wsa:to
pub.soap.wsa:schema_wsa
pub.soap.wsa.submission:action
pub.soap.wsa.submission:faultTo
pub.soap.wsa.submission:from
pub.soap.wsa.submission:messageID
pub.soap.wsa.submission:relatesTo
pub.soap.wsa.submission:replyTo
pub.soap.wsa.submission:retryAfter
pub.soap.wsa.submission:to
pub.soap.wsa.submission:schema_wsa_submission
pub.soap.wsrm:closeSequence
pub.soap.wsrm:createSequence
pub.soap.wsrm:sendAcknowledgementRequest
pub.soap.wsrm:terminateSequence
pub.soap.wsrm:waitUntilSequenceCompleted
Storage Folder
About the Storage Elements
Locking Considerations
Entry Locking
Data Store Locking
Automatic Promotion to Exclusive Lock
Wait Time and Duration
Sample Flow Service for Checkpoint Restart
Summary of Elements in this Folder
pub.storage:add
pub.storage:closeStore
pub.storage:deleteStore
pub.storage:get
pub.storage:keys
pub.storage:listLocks
pub.storage:lock
pub.storage:put
pub.storage:registerStore
pub.storage:releaseLocks
pub.storage:remove
pub.storage:shutdown
pub.storage:startup
pub.storage:unlock
String Folder
Summary of Elements in this Folder
pub.string:base64Decode
pub.string:base64Encode
pub.string:bytesToString
pub.string:compareStrings
pub.string:concat
pub.string:HTMLDecode
pub.string:HTMLEncode
pub.string:indexOf
pub.string:isAlphanumeric
pub.string:isDate
pub.string:isNullEmptyOrWhitespace
pub.string:isNullOrBlank
pub.string:isNumber
pub.string:length
pub.string:lookupDictionary
pub.string:lookupTable
pub.string:makeString
pub.string:messageFormat
pub.string:numericFormat
pub.string:objectToString
pub.string:padLeft
pub.string:padRight
pub.string:replace
pub.string:stringToBytes
pub.string:substitutePipelineVariables
pub.string:substring
pub.string:tokenize
pub.string:toLower
pub.string:toUpper
pub.string:trim
pub.string:URLDecode
pub.string:URLEncode
Sync Folder
Summary of Elements in this Folder
pub.sync:notify
pub.sync:shutdown
pub.sync:wait
Synchronization Folder
Summary of Elements in this Folder
pub.synchronization.latch:closeLatch
pub.synchronization.latch:isLatchClosed
pub.synchronization.latch:openLatch
pub.synchronization.xref:createXReference
pub.synchronization.xref:deleteByObjectId
pub.synchronization.xref:deleteXReference
pub.synchronization.xref:getCanonicalKey
pub.synchronization.xref:getNativeId
pub.synchronization.xref:insertXReference
Trigger Folder
Summary of Elements in this Folder
pub.trigger:createJMSTrigger
pub.trigger:createTrigger
pub.trigger:deleteJMSTrigger
pub.trigger:deleteTrigger
pub.trigger:disableJMSTriggers
pub.trigger:enableJMSTriggers
pub.trigger:resourceMonitoringSpec
pub.trigger:resumeProcessing
pub.trigger:resumeRetrieval
pub.trigger:suspendJMSTriggers
pub.trigger:suspendProcessing
pub.trigger:suspendRetrieval
TX Folder
Summary of Elements in this Folder
pub.tx:init
pub.tx:shutdown
pub.tx:resetOutbound
UniversalName Folder
Summary of Elements in this Folder
pub.universalName:find
pub.universalName:findDocumentType
pub.universalName:list
pub.universalName:listAll
Utils Folder
Summary of Elements in this Folder
pub.utils:deepClone
pub.utils:executeOSCommand
pub.utils:generateUUID
pub.utils:getServerProperty
pub.utils.messaging:migrateDocTypesTriggersToUM
pub.utils:transcode
pub.utils.ws:setCompatibilityModeFalse
WebSocket Folder
Summary of Elements in this Folder
pub.websocket:close
pub.websocket:disconnect
pub.websocket:getCookies
pub.websocket:getExtensions
pub.websocket:getHeaders
pub.websocket:getPathParameters
pub.websocket:getPathParameter
pub.websocket:getRequest
pub.websocket:getQueryParameters
pub.websocket:getQueryParameter
pub.websocket:getSubProtocols
pub.websocket:onBinary
pub.websocket:onClose
pub.websocket:onConnect
pub.websocket:onError
pub.websocket:onText
pub.websocket:ping
pub.websocket:pong
pub.websocket:send
XML Folder
Summary of Elements in this Folder
pub.xml:documentToXMLString
pub.xml:freeXMLNode
pub.xml:getNextXMLNode
pub.xml:getXMLNodeIterator
pub.xml:getXMLNodeType
pub.xml:loadEnhancedXMLNode
pub.xml:loadXMLNode
pub.xml:queryXMLNode
pub.xml:xmlNodeToDocument
pub.xml:xmlStringToEnhancedXMLNode
pub.xml:xmlStringToXMLNode
XMLData Folder
Summary of Elements in this Folder
pub.xmldata.domNodeToXMLData
pub.xmldata:getAttributes
pub.xmldata:getInstanceTag
pub.xmldata:getNamespaceTags
pub.xmldata:setAttribute
pub.xmldata:setInstanceTag
pub.xmldata:setNamepaceTag
pub.xmldata:xmlDataToXMLString
XSLT Folder
Summary of Elements in this Folder
pub.xslt.Transformations:transformSerialXML
pub.xslt.Cache:removeAllTemplates
pub.xslt.Cache:removeTemplate
Universal Messaging
About this Documentation
Online Information and Support
Data Protection
Overview
Universal Messaging Enterprise Manager
About the Enterprise Manager
Starting the Enterprise Manager
Tab-by-Tab Overview
About the Enterprise View
Realm Administration
Creating and Starting a Realm Server
Viewing a Realm
Monitoring a Realm
About Monitoring a Realm
The Enterprise Manager Logs Panel
Realm Connections
Threads Status
The Top Tab
The Audit Tab
The Metrics Tab
Updating Connection Information
Working with Realm Profiles
Realm Federation
Realm Configuration
Connecting to Multiple Realms
Disconnecting from Realms
Interface Status
Zone Administration
Cluster Administration
Viewing the Available Clusters
Viewing Information for a Cluster
Creating Clusters
Before Creating a Cluster
Creating a Cluster
Deleting a Cluster
Adding and Removing Cluster Members
Creating Cluster Channels
Creating Cluster Queues
Setting Up Inter-Realm Communication
Setting Up Non-Encrypted Inter-Realm Communication
Setting Up Encrypted Inter-Realm Communication
Switching from Non-Encrypted to Encrypted Inter-Realm Communication
Note on Public/Private Keys Used for Inter-Realm Handshake
Interconnecting Two Clusters
Creating Clusters with Sites
Case Study: Migrating Between Single-Node and Multi-Node Active/Active Cluster
Channel Administration
About Channel Administration
Viewing the Channel Status
Creating Channels
Valid Channel Names
Editing Channels
Updating the Protobuf Descriptor
Copying Channels
Creating Channel Joins
Viewing Channel Connections
Snooping on a Channel
Viewing Details About Snooped Events on a Channel
Purging Events from a Channel
Publishing Events on a Channel
Publishing a New Event on a Channel
Republishing Events on a Channel
Viewing and Managing Durables for a Channel
Deleting Channels and Queues
Queue Administration
Creating Queues
Viewing Queues
Viewing the Queue Status
Viewing Queue Joins
Viewing Consumer Information
Editing Queues
Copying Queues
Snooping on a Queue
Viewing Details About Snooped Events on a Queue
Purging Events from a Queue
Publishing Events on a Queue
Publishing a New Event on a Queue
Republishing Events on a Queue
Data Group Administration
About Data Groups
Creating Data Groups
Viewing the Data Group Status
Adding Existing Data Groups to Data Groups
Removing Data Groups from data Groups
Deleting Data Groups
Container Administration
Viewing the Container Status
Monitoring Container Usage
Using ACLs for Role-Based Security
About Realm ACL Permissions
About Channel ACL Permissions
About Queue ACL Permissions
Adding and Removing ACL Subjects
Modifying ACL Permissions
Creating Security Groups
About Interface VIA Lists
Managing Interface VIA Lists
Scheduling
About Scheduling
Creating and Editing Scheduler Scripts
Creating Scheduler Scripts
Viewing and Editing Scheduler Scripts
Scheduling Script Language Summary
Calendar Schedules (Time-based Triggers)
Conditional Triggers for Executing Tasks
Scheduling Tasks
Scheduler Examples
Universal Messaging Scheduling : Example Realm Script
Universal Messaging Scheduling : Store Triggers Example
Universal Messaging Scheduling : Interface Triggers Example
Universal Messaging Scheduling : Memory Triggers Example
Universal Messaging Scheduling : Realm Triggers Example
Universal Messaging Scheduling : Cluster Triggers Example
Universal Messaging Scheduling : Counter Trigger Example
Universal Messaging Scheduling : Time Triggers Example
Universal Messaging Scheduling : Configuration Example
Integration with JNDI
About Integration with JNDI
The Initial JNDI Context and the JNDI Namespace
Creating Connection Factories
The URL Syntax of a Horizontal Scalability Connection Factory
Creating References to Topics and Queues
Viewing and Editing JNDI Settings of a Connection Factory
Using Channel Snoop to View JNDI Settings
Administering TCP Interfaces, IP Multicast, and Shared Memory
About Working with Interfaces
Creating Interfaces
Usage of 0.0.0.0 When Defining Interfaces
Basic Attributes for an Interface
Starting and Stopping Interfaces
Modifying Interface Attributes
JavaScript Configuration Properties
About SSL Interfaces
Creating an SSL-Enabled Interface
How to Generate Certificates for Use
Adding a Multicast Configuration
Considerations When Using Multicast
Advanced Multicast Settings
Adding a Shared Memory Configuration
Plugins
File Plugin
XML Plugin
Proxy Passthrough Plugin
REST Plugin
Servlet Plugin
Health Monitor Plugin
Exporting and Importing Realm XML Configurations
Exporting a Realm Configuration into an XML File
Importing a Realm Configuration from an XML File
Using the clusterWide Attribute for Channels and Queues
Version compatibility issues
Sample XML File for Import
Using the Enterprise Viewer
Using Command Central to Manage Universal Messaging
About Using Command Central to Manage Universal Messaging
Managing Universal Messaging Server Instances
Creating a Universal Messaging Server Instance
Deleting a Universal Messaging Server Instance
Starting, Stopping, and Restarting Universal Messaging
Securing Communication Between Command Central and Universal Messaging
How does Command Central Connect to Universal Messaging?
About Securing Communication Between Command Central and Universal Messaging
Considerations When Using System Properties to Specify Truststore and Keystore Files
Configuring the JSSE System Properties
Configuring the Universal Messaging Client Properties
Switching Off the System Properties Mode
Configuring Universal Messaging
About Configuring Universal Messaging
Working with Universal Messaging Configuration Types
Channels
Clustering
Before You Create a Universal Messaging Cluster
Cluster Configuration Properties
Supported Cluster Configuration Tasks
Cluster Migration
General Properties
Groups
Internal Users
JNDI Connection Factories
JNDI Destinations
JVM Options
Java System Properties
License Keys
Memory
Ports
NSP Ports
NHP Ports
NHPS Ports
NSPS Ports
SHM Ports
Queues
Realm ACL
Zones
Securing Access to Command Central
Changing the Authentication Mode
Verifying the Outbound Authentication Settings
Using Unix Shell Scripts to Change Connection Credentials for Managed Products
Enabling Basic Authentication for Universal Messaging Users
Administering Universal Messaging
Administering Channels
Administering Durable Subscribers
Administering Queues
Snooping on Channels
Considerations When Snooping on Channels
Starting the Channel Snoop
Stopping the Channel Snoop
Viewing Channel Event Details
Purging Snooped Events from a Channel
Snooping on Queues
Considerations When Snooping on Queues
Starting the Queue Snoop
Stopping the Queue Snoop
Viewing Queue Event Details
Purging Snooped Events from a Queue
Publishing Events
Publishing Events on a Channel or Queue
Publishing Protobuf Events
Republishing Events on a Channel or Queue
Viewing Universal Messaging Run-time Monitoring Statuses
Viewing Universal Messaging KPIs
Viewing Universal Messaging Logs
Viewing Universal Messaging Inventory
Configuration Types That the Universal Messaging Server Supports
Using the Command Line to Manage Universal Messaging
Universal Messaging Instance Management
Create Instances
Update Instances
Delete Instances
Migrate Instances
User Configuration
Create Users
List Users
Update Users
Delete Users
License Configuration
Add License Keys
Get License Details
Update License Keys
Port Configuration
Create Ports
Update Ports
Delete Ports
Security Group Configuration
Get Security Group Configuration Data
Realm ACL Configuration
Get Realm ACL Configuration Data
General Properties Configuration
Get Configuration Properties
Update Configuration Properties
JNDI Connection Factories Configuration
Create Connection Factories
Get Connection Factory Data
Update Connection Factories
Delete Connection Factories
JNDI Destinations Configuration
Create Destinations
Get Destination Data
Delete Destinations
Channel Configuration
Create Channels
Get Channel Data
Update Channels
Queue Configuration
Create Queues
Get Queue Data
Update Queues
Zone Configuration
Create Zones
Get Zone Data
Update Zones
Delete Zones
Java System Properties Configuration
Get Java System Properties
Update Java System Properties
JVM Options Configuration
Get JVM Options
Update JVM Options
Cluster Configuration
Before You Create or Update a Cluster
Create Clusters
View Cluster Details
Update Clusters
Delete Clusters
Migrate Clusters
Channel and Queue Monitoring
List Administration Namespaces
List Monitoring Options
List Channels or Queues
Get Channel or Queue Status
Durable Subscribers Monitoring
View Administration Namespaces
View Monitoring Options
List Durable Subscribers
List Durable Subscriber Attributes
List Events
Purge Events
Delete a Durable Subscriber
Channel Snoop
Start Snooping on a Channel
List Snooped Events on a Channel
View Details of a Snooped Event on a Channel
Purge Snooped Events from a Channel
Stop Snooping on a Channel
Queue Snoop
Start Snooping on a Queue
List Snooped Events on a Queue
View Details of a Snooped Event on a Queue
Purge Snooped Events from a Queue
Stop Snooping on a Queue
Event Publishing
Publish Events
Republish Events
Server Inventory Commands
Get Server Inventory
List Server Inventory
Asset Deployment
List Assets
Install Assets
Lifecycle Actions for Universal Messaging Server
Run-time Monitoring States for Universal Messaging Server
Run-time Monitoring Statuses for Universal Messaging Server
Deployment of Universal Messaging Assets
On-Premise Deployment of Assets
Asset Deployment in the Cloud
Templates for Provisioning Universal Messaging
Comparison of Enterprise Manager and Command Central Features
Setting up Active/Passive Clustering with Shared Storage
About Active/Passive Clustering
Active/Passive Clustering Requirements
Universal Messaging Capabilities for Active/Passive Clustering
Virtual IP Address of an Active/Passive Cluster
Failover Mechanism in an Active/Passive Cluster
Cluster Verification
Roles and Responsibilities for Configuring an Active/Passive Cluster
Overview of Active/Passive Clustering on Windows
How Does Universal Messaging Run in a Windows Cluster?
Active/Passive Cluster Configuration on Windows Server
Overview of Active/Passive Clustering on UNIX
Cluster Monitoring Scripts
Summary of Active/Passive Cluster Configuration on UNIX
Configuring a Universal Messaging Active/Passive Cluster on UNIX
Install Universal Messaging on Cluster Nodes
Verify the Universal Messaging Server Installation
Configure the Start, Stop, and Status Scripts
Verify Failover in the Cluster
Command Line Administration Tools
Introduction to the Administration Tools
Starting the Tools using the Tools Runner Application
Performing Standard Administration Tasks on Realms and Clusters
Running a Configuration Health Check
The "Realm Information Collector" Diagnostic Tool
The ExportEventsFromOfflineMemFile Tool
The RepublishEventsFromOfflineFile Tool
Syntax reference for command line tools
Syntax: Store Tools
Syntax: Cluster Tools
Syntax: Interface Tools
Syntax: Data Group Tools
Syntax: Publish Tools
Syntax: Subscribe Tools
Syntax: Security Tools
Syntax: Zone Tools
Syntax: JMS Tools
Syntax: Recovery Tools
Syntax: Durable Tools
Syntax: Miscellaneous Tools
Syntax: Site Tools
Syntax: Diagnostic Tools
Universal Messaging Administration API
Introduction
Administration API Package Documentation
Namespace Objects
nRealmNode
nLeafNode (Channels and Queues)
Realm Federation
Channel Join
Realm Server Management
Interfaces
Scheduling
Config
Clustering
Multicast
Security
Access Control Lists
Nirvana Admin API - Nirvana Security Groups
Realm Access Control List (nACL)
Channel Access Control List (nACL)
Queue Access Control List
Management Information
nRealmNode
nClusterNode
nLeafNode
Connection Information
Configuring the Java Service Wrapper
Migrating from IPv4 to IPv6
Data Protection and Privacy
Clustering
An Overview of Clustering
What Is Clustering?
What Data Is Shared in a Cluster?
Load Balancing in a Stateful or Stateless Cluster
Failover Support for Stateful Clusters
Reliability
Guaranteed Delivery for Stateful or Stateless Clusters
Exactly Once for Document History
Checkpoint Restart for Stateful and Stateless Clusters
Putting It All Together
Integration Server Session Objects for Stateful Clusters
Usage Notes for Session Storage
Scheduled Jobs for Stateful or Stateless Clusters
Client Applications
Using remote Integration Servers in a Stateful or Stateless Cluster
Installation and Setup
Using Terracotta as the Caching Software for a Stateful Cluster
Installing Terracotta Server Array for a Stateful Cluster
Setting up the Terracotta Server Array for Use by the Cluster of Integration Servers
Installing and Setting Up the Integration Servers in a Stateful or Stateless Cluster
Server Environment
Adding a Server with an Embedded Database to a Cluster
Enabling Clustering for a Stateful Cluster
About Action on Startup Error Options
What Happens When an Integration Server in a Stateful Cluster Cannot Connect to the Distributed Cache?
Controlling Logging for Caching in a Stateful Cluster
Scheduling Jobs to Run in a Stateful or Stateless Cluster
Specifying Unique Logical Names for Integration Servers in a Stateful or Stateless Cluster
Using Guaranteed Delivery with a Stateful or Stateless Cluster
Managing Server Clustering
Overview
Viewing the Servers in a Stateful Cluster
Removing a Server from a Stateful Cluster
Adding a Server Back into a Stateful Cluster
Taking a Server Offline from a Stateful or Stateless Cluster
Bringing a Server Back Online to a Stateful or Stateless Cluster
Increasing the Cache Size for a Stateful Cluster
Increasing the Maximum Elements on Disk Size
Increasing the Maximum Elements on Disk Size When the Terracotta Server Array Uses Permanent-Store Persistence Mode
Increasing the Maximum Elements on Disk Size When the Terracotta Server Array Uses Temporary-Swap-Only Persistence Mode
How a Stateful Integration Server Cluster and a Terracotta Server Array Handle Failures
What Happens when an Integration Server in a Stateful Cluster Cannot Connect to the Terracotta Server Array?
Integration Server Cannot Download the tc-config.xml File
Integration Server Cannot Connect to the Servers in the tc-config.xml File
What Happens When Integration Server in a Stateful Cluster Is Disconnected from the Terracotta Server Array?
What Happens When Terracotta Servers in the Terracotta Server Array Are Disconnected?
How Do Integration Servers Respond when Terracotta Servers in the Terracotta Server Array Are Disconnected?
DSPs and building output templates
About this Guide
Using Dynamic Server Pages (DSPs)
What Is a Dynamic Server Page?
What Does a DSP Look Like?
When Do You Use DSPs?
What Are the Advantages of Using DSPs?
Creating DSPs
File Encoding and Character Set Limitations
Publishing DSPs
Securing DSPs
Securing DSPs Against Unauthorized Access
Securing DSPs Against Cross Site Scripting Attacks
Securing DSPs Against CSRF Attacks
Limiting the External URLs that Can Be Used for Redirection
Requesting DSPs
Hyperlinks to DSPs
Using the DSP Tags
Begin...End Constructs
Invoking Services Using the %invoke% Tag
What Is Scope?
Why Does Scope Matter?
Ending the Scope of the Invoke Action
Referencing Variables In and Out of Scope
Passing Parameters with a DSP
Passing Parameters Between DSPs
Passing Parameters Between Services within a DSP
Catching Errors
Extracting Results from an Array Variable
Extracting Results from a Document
Using the %loop% Tag to Examine the Current Scope
Conditionally Executing Blocks of Code
Building Conditional Blocks With the %ifvar% Tag
Testing for a Particular Value
Building Conditional Blocks with the %switch% Tag
Specifying a Default Case
Inserting Text Files in a DSP
Specifying a List of Permitted URLs for Redirection
Arbitrarily Processing DSP Tags
Using Output Templates to Format Service Output
What is an Output Template?
What Does an Output Template Look Like?
When Does the Server Use an Output Template?
Using Output Templates to Return Output to HTTP Clients
Guidelines for Using HTML-Based Output Templates with HTTP Clients
Guidelines for Using XML-Based Output Templates with HTTP Clients
Using Output Templates to Return Output to SMTP and FTP Clients
Using Output Templates to Return Output to Wireless Devices
Guidelines for Creating WML Output Templates
Guidelines for Creating HDML Output Templates
Applying Output Templates Arbitrarily
Creating an Output Template
Assigning an Output Template to a Service
Securing Pages and Documents Created from Output Templates
Securing Documents and HTML Pages Against Cross Scripting Attacks
Limiting the External URLs that Can Be Used for Redirection
Tag Descriptions
Overview
%comment%
%ifvar%
%include%
%invoke%
%loop%
%loopsep%
%nl%
%rename%
%scope%
%switch%
%sysvar%
%validConst%
%value%
DSPs and Output Templates in Different Languages
Overview
Creating DSPs and Templates in Other Languages
Creating Localized DSPs and Templates
Creating a Default DSP or Template
Points to Remember
Using Localized DSPs and Templates
Setting Up Your Browser
Publishing Localized DSPs and Templates
Publishing a Localized DSP to the Server
Publishing a Localized Template to the Server
Requesting a Localized DSP
The localeID Value
For More Information
Processing Flat Files
About this Guide
Concepts
What is a Flat File?
What is a Flat File Schema?
How Is a Flat File Schema Used to Parse Records?
Record Parsers
Record Identifiers
Extractors
Undefined Data
Default Records
What is a Flat File Dictionary?
When Should I Create a Flat File Dictionary?
Processing Flat Files Overview
Overview of Processing Flat Files
Formatting Inbound and Outbound Data
Processing Inbound Flat Files
Handling Large Flat Files
Processing Outbound Flat Files
Working with Elements in Flat File Schemas and Dictionaries
Overview
Floating Records
Examples: Parsing Inbound Floating Records
Examples: Parsing Outbound Floating Records
Extractors
Validators
Conditional Validators
Field Validators
Length Validator
Code List Validator
Byte Count Validator
Format Services
Creating Format Services
Working with Format Error Messages
Disabling Format Services
Managing Dictionary Dependencies on Format Services
Managing Flat File Dictionary Dependencies
Customizing the Flat File Configuration Settings
Sending and Receiving Flat Files
Overview
Flat File Content Handler and Content Type
Choosing the Service to Receive the Flat File from the Content Handler
Submitting a Flat File to Integration Server in a String Variable
Submitting a Flat File to Integration Server via HTTP
Building a Client that Posts a Flat File to a Service
Submitting a Flat File to Integration Server via FTP
FTPing a File From a webMethods Integration Server
Getting Results from an FTP’d Document
Submitting a Flat File to Integration Server via File Polling
Submitting a Flat File to Integration Server via an E-mail Message
Requirements for Submitting a Flat File Document via an E-mail Message
Getting Results from an E-mailed Document
Validation Errors
Validation Error Contents
General Error Entries in the errors Array
Entries for Conditional Validator Errors in the errorDetails Array
Validation Error Codes
Programming Creating Flat File Schemas and Dictionaries
Overview
Creating Flat File Dictionary Entries, Dictionaries, and Schemas
Creating Flat File Dictionary Entries
Creating an Entire Flat File Dictionary with Data
Creating an Empty Flat File Dictionary
Creating a Flat File Schema
Modifying Flat File Dictionary Entries, Dictionaries, and Schemas
Modifying an Existing Flat File Dictionary Entry
Modifying an Existing Flat File Dictionary
Modifying an Existing Flat File Schema
Deleting Flat File Dictionary Entries, Dictionaries, and Schemas
Sample Flow Services for Working with XML Files
Creating a Service that Retrieves the XML File
Retrieving Namespace Data to Write to an XML File
Flat File Byte Count Parser
Overview
Configuring the flat file byte count parser
Handling Partial Characters
Reading Partial Characters
Writing Partial Character Encodings
Stateful Encodings
Writing Stateful Encodings
Guaranteed Delivery
About this Guide
Overview of Guaranteed Delivery
Overview
What Is Guaranteed Delivery?
Indicating You Want to Use Guaranteed Delivery
How Transactions Are Managed
Customizing the Job Manager
Identifying Transactions
Specifying How Long Transactions Are Active
Handling Failures
Creating a Java Client that Uses Guaranteed Delivery
Overview
Sample Code (Synchronous Request)
Sample Code (Asynchronous Request)
Creating a Flow Service that Uses Guaranteed Delivery
Overview
Sample Flow (Synchronous Request)
Sample Flow (Asynchronous Request)
Managing MIME messages
About this Guide
Overview of MIME and S/MIME Messages
Overview
What Is MIME?
Basic Structure of a MIME Message
Header Fields
The Body
Multipart MIME Messages
What Is S/MIME?
Digital Certificates
Digital Signatures
Explicit and Implicit Signatures
Encryption
The MIME and S/MIME Services
Services Used to Construct MIME and S/MIME Messages
Services Used to Extract Data from MIME and S/MIME Messages
MIME Messages, MIME Entities, and MIME Objects
Building MIME and S/MIME Messages
Overview
Creating a MIME Message
How to Create a MIME Message
Example—Creating a Single-Part MIME Message
Example—Creating a Multipart MIME Message
Signing a MIME Message
How to Create a Signed S/MIME Message
Example—Signing a MIME Message
Encrypting a MIME Message
How to Create an Encrypted S/MIME Message
Example—Encrypting a MIME Message
Signing and Encrypting a MIME Message
Example—Signing and Encrypting a MIME Message
Extracting Data from MIME and S/MIME Messages
Overview
Extracting the Payload from a MIME Message
How to Extract the Payload from a MIME Message
Example—Extracting One Part from a Multipart MIME Message
Example—Extracting All Parts from a Multipart MIME Message
Extracting the Payload from a Signed MIME Message
How Do You Know Whether the Message Is Signed?
Working with InputStreams
What Happens when the Signature is Processed?
Error Codes and Messages
How to Extract the Payload from a Signed S/MIME Message
Example—Extracting Content from a Signed S/MIME Message
Extracting the Payload from an Encrypted MIME Message
How Do You Know Whether the Message Is Encrypted?
How to Extract the Payload from an Encrypted S/MIME Message
Example—Extracting Content from an Encrypted S/MIME Message
Extracting Data from a Signed and Encrypted MIME Message
Example—Extracting Content from a Signed and Encrypted S/MIME Message
Accessing databases
About this Guide
Database Drivers
Configuring Access to Database Systems
Overview
Supported Databases
Database Connection Information
About the Server Configuration File
Preloading JDBC Drivers at Server Initialization
Making the Java Classes for JDBC Drivers Accessible
Identifying Database Aliases
Enabling Database Connection Pooling
Updating Information for Database Aliases
Deleting Database Aliases
Accessing Databases with Services
Overview
Deciding Which Type of Service to Create
Creating Database Flow Services
Generating a Database Flow Service from an SQL Statement
Specifying a Dynamic SQL Statement
Using Question Marks (?) in SQL Statements
Using Template Tags in SQL Statements
Steps for Generating a Flow Service from an SQL Statement
Generating a Database Flow Service from a Table
Restricting the List of Database Tables
Steps for Generating the Flow Service from a Table
Output from the Flow Service
Creating Database Services with Java or C/C++
Built-in Database Services
Testing SQL Statements
Error Handling
Creating Clients that Access Databases
Invoking a Database Service from a Browser-based Client
Invoking a Built-in Service from a Java, C/C++, or VB Client
Determining Whether to Use the WmDB Package or the Adapter for JDBC
Overview
When to Use the WmDB Package
When to Use the webMethods Adapter for JDBC
Audit logging
About this Guide
Types of Audit Logs
Overview
IS Core Audit Logging
API Gateway Transaction Logging
Document Audit Logging
Error Audit Logging
Guaranteed Delivery Audit Logging
Messaging Audit Logging
Security Audit Logging
Service Audit Logging
Session Audit Logging
Process Audit Log
Business Process Audit Logging
Integration Process Audit Logging
Task Audit Logging
Additional Processing for Audit Log Entries
Globalization
webMethods Broker Client Logging
webMethods Adapter Logging
Setting Up IS Core Audit Logging
Configure Audit Logging
Start the Logger Configuration
Enable the Logger
For the Service Logger, Choose the Logging Level
Identify the Destination
File Names and Locations
Database Error Handling
Configure Logging Mode (Synchronous or Asynchronous)
Configure Asynchronous Mode
Choose the Queue Provider
Choose Whether to Persist the Queue
Specify Maximum Queue Size
Specify the Connection Alias for the Universal Messaging Queue
Specify Reader Threads for the Universal Messaging Queue
Queue Fail-Fast Mode for Loggers that Use Universal Messaging Queues
Additional Fields for the Security Logger
Set the Log Level for the Messaging Logger
Set Up Additional Service Logging
Set Up Customized Service Logging in Designer
Write User-Defined Messages or Input Pipelines to the Integration Server Server Log
Write Custom Values for the Current Context to the Integration Server Server Log
Write User-Defined Messages to the IS Core Audit Log
Send Messages About Service Failures to Email Addresses
Perform Additional Processing on Audit Log Entries
Controlling the Level of Exception Logging Detail
Controlling Date-Time Stamp and Time Zone Details
Rotate Audit Logs Based on Size
Limit the Number of Audit Log Files Kept by Integration Server
Use Delimiters in a File-Based Audit Log
Receiving Notifications When Logging Fails
Fail-Fast Mode for Synchronous Logging
Queue Size Considerations for Fail-Fast Mode
Other Considerations for Using Fail-Fast Mode with Audit Logging
Viewing Audit Log Data
Overview
View the Audit Logs in Integration Server Administrator
View the Error Log
View the Guaranteed Delivery Log
View the Messaging Log
View the Security Log
View the Service Log
View the Session Log
View the API Gateway Transaction Logs
Change the Log Displays
Display Logged Data in Different Languages
Change the Display Permanently for All Logs
Change the Display Temporarily for a Particular Log
Copyright
Integrating On-Premises and Cloud Applications
Copyright
IL_whatsnew
whats_new_700
whats_new_660
whats_new_610
whats_new_600
whats_new_560
IL_RegistrationScrn
IL_Reg1_CreateAccScrn
IL_Reg2_SecureAccScrn
IL_UsersScrn
IL_NewUserScrn
IL_Settings_EditUserScrn
IL_ResetPwdScrn
IL_MyInformationScrn
IL_SecurityQuesScrn
IL_ChangePassword
IL_mycertificate
capabilities
IL_AccessProfScrn
IL_NewEditAccessProfScrn
IL_AccessControls
IL_NewEditAccessControls
IL_PreferenceScrn
IL_SingleSignOnScrn
IL_SingleSignOnConfigScrn
IL_CompanyInfoScrn
IL_UpdateCompanyInfoScrn
IL_PwdPolicyScrn
IL_UpdatePolicySettingsScrn
IL_clientcertificate
IL_add_clientcertificate
whatisoauth2
howtoconfigureoauth2
oauth2_client
outh2_scope
oauth2_token
IL_AuditLogScrn
projects
project_permissions
shareassets
IL_ApplicationsScrn
WmAS2Provider
WmAlfabetProvider
WmAmazonDynamoDBProvider
WmAmazonKinesisProvider
WmAmazonS3Provider
WmAmazonSNSProvider
WmAmazonSQSProvider
WmAnaplanProvider
WmApacheSolrProvider
WmAvalaraAvaTaxProvider
WmJiraProvider
WmCloudDeploymentProvider
clddep_ops
WmMicrosoftAzureCosmosDBProvider
WmMicrosoftAzureDataLakeStoreProvider
WmMicrosoftAzureStorageProvider
WmNetSuiteProvider
WmConcurProvider
WmCoupaProvider
WmCumulocityProvider
WmJDBCAdapter
Database_OpScrn
Database_AdvancedOpt
Database_SQLOp
Database_SelectOp
Database_UpdateOp
Database_InsertOp
Database_DeleteOp
Database_SProcedureOp
Database_BInsertOp
Databasae_BUpdateOp
Database_DriverScrn
Database_DriverFields
WmDocuSignProvider
WmEDIProvider
WmFTPProvider
WmGoogleAnalyticsProvider
WmGoogleAppsAdminProvider
WmGoogleBigQueryProvider
WmGoogleCalendarProvider
WmGoogleContactsProvider
WmGoogleDriveProvider
WmGooglePubSubProvider
WmGoogleCloudStorageProvider
WmGooglePredictionProvider
WmGoogleSheetsProvider
WmIBMWatsonProvider
WmMagentoProvider
WmMarketoProvider
WmMicrosoftDynamicsCRMProvider
WmODataProvider
WmOData4Provider
WmSalesforceProvider
WmSalesforceBulkProvider
WmSalesforceRESTProvider
WmSAPC4CProvider
WmSAPS4HANAMarketingCloudProvider
WmSFTPProvider
WmServiceNowProvider
WmShopifyProvider
WmSiemensMindSphereProvider
WmSMTPProvider
smtp_op
WmSlackProvider
WmStrikeIronProvider
WmSuccessFactorsProvider
WmSugarCRMProvider
WmTwilioProvider
WmB2BProvider
WmWorkdayProvider
WmZendeskProvider
WmZuoraProvider
IL_CustomAppScrn_REST
WmRESTProvider
WmIntegrationServerProvider
IL_CustomAppScrn_SOAP
WmSOAPProvider
IL_FlatFile
create_flatfileapp_manually
create_flatfileapp_samplefile
IL_AccountsScrn
IL_AccountsAddEditScrn
IL_OperationsScrn
IL_OperAddEditSelAccScrn
listeners
IL_Listeners
IL_IntegrationsScrn
IL_IntegrAddEditScrn
IL_AddOrchestIntegrScrn
IL_IntegrationDetailsScrn
lock_unlock_integrations
IL_Export_Integrations
IL_Import_Integrations
IL_UpgradeUtilityScrn
IL_RecipesScrn
MarketoLeadToSAPC4CContactDataSync
MarketoToSAPC4CActivitiesDataSync
MarketoToSAPC4CLeadsDataSync
SAPC4CToMarketoActvtyAppoinDataSync
SAPC4CToMarketoCBOLeadDataSync
SAPC4CToMarketoDeleteSync
SAPC4CToMarketoMasterDataSync
SAPC4CToMarketoActvtyPhoneDataSync
SAPC4CToMarketoActvtyTasksDataSync
SAPC4CToMarktoCompanyDataSync
SAPC4CContactToMarketoLeadDataSync
SAPC4CToMarketoOpportunityDataSync
SAPC4CToMarketoSalesPersonDataSync
IL_DocTypesScrn
IL_DocTypesScratch
IL_DocTypes_XSD
IL_RefDataScrn
IL_monitorDashboardScrn
IL_ExecResultsScrn
IL_AlertsScrn
IL_IntegrationReport
clearstoragelocks
IL_RADsScrn
IL_CreateRADsManually
IL_modifyresourceoperations
IL_CreateRADs_usingswaggerfile
IL_copy_restapi
IL_export_restapi
IL_import_restapi
soapapis
createSOAPAPI_scratch
createsoapapi_wsdl
IL_copy_soapapi
export_soapapi
import_soapapi
IL_manage
IL_applyaccessprofiletostage
IL_deploy
IL_activestage
IL_AdvancedSecScrn
IL_AddKeystoreScrn
IL_AddTruststoreScrn
IL_AddCertScrn
IL_viewtagdetailsScrn
uhm_architecture
gdpr_uhm
dashboard_uhm
create_tranx_groups
view_trxns_list
edit_trxn_group
delete_trxn_group
filter_biztxns
alerts
view_alerts_uhm
create_rule
biztxndetails
view_txn_details
envgrp_uhm
ex_envgrp_uhm
user_journey
Cloud_Project_ProjectScrn
Cloud_Servers_ServersScrn
Cloud_Servers_AddServersScrn
Cloud_CVSS_NewServiceScrn
Cloud_CVSS_GeneralScrn
Cloud_CVSS_AdvancedScrn
Cloud_CVSS_EntryScrn
Cloud_CVSS_RoutingScrn
Cloud_CVSS_InvokeIS_In_Scrn
Cloud_CVSS_InvokeIS_Out_Scrn
Cloud_CVSS_CustomErrorScrn
Cloud_CVSR_NewServiceScrn
Cloud_CVSR_GeneralScrn
Cloud_CVSR_AdvancedScrn
Cloud_CVSR_EntryScrn
Cloud_CVSR_RoutingScrn
Cloud_CVSR_InvokeIS_In_Scrn
Cloud_CVSR_InvokeIS_Out_Scrn
Cloud_CVSR_CustomErrorScrn
Cloud_Policy_NewPolicyScrn
Cloud_Policy_GeneralScrn
Cloud_Policy_AuthorizeScrn
Cloud_Policy_IdentifyScrn
Cloud_Policy_TimestampsScrn
Cloud_Policy_LogScrn
Cloud_Policy_PerformanceScrn
Cloud_Policy_SLAScrn
Cloud_Policy_EncryptScrn
Cloud_Policy_HTTPAuthScrn
Cloud_Policy_SAMLTokenScrn
Cloud_Policy_SigningScrn
Cloud_Policy_SSLScrn
Cloud_Policy_UsernameToken
Cloud_Policy_509TokenScrn
Cloud_Policy_ThrottlingScrn
Cloud_Policy_SchemaScrn
Cloud_VSS_NewServiceScrn
Cloud_VSS_GeneralScrn
Cloud_VSS_AdvancedScrn
Cloud_VSS_NamespacesScrn
Cloud_VSS_VSDScrn
Cloud_VSS_ApplicablePoliciesScrn
Cloud_VSS_EndpointScrn
Cloud_VSS_EntryScrn
Cloud_VSS_Transform_In_Scrn
Cloud_VSS_InvokeIS_In_Scrn
Cloud_VSS_StraightScrn
Cloud_VSS_ContextScrn
Cloud_VSS_ContentScrn
Cloud_VSS_LoadScrn
Cloud_VSS_AttachWSDLScrn
Cloud_VSS_Transform_Out_Scrn
Cloud_VSS_InvokeIS_Out_Scrn
Cloud_VSS_CustomErrorScrn
Cloud_VSR_NewServiceScrn
Cloud_VSR_RESTResourcesScrn
Cloud_VSR_GeneralScrn
Cloud_VSR_AdvancedScrn
Cloud_VSR_NamespacesScrn
Cloud_VSR_VSDScrn
Cloud_VSR_ApplicablePoliciesScrn
Cloud_VSR_EndpointScrn
Cloud_VSR_EntryScrn
Cloud_VSR_Transform_In_Scrn
Cloud_VSR_InvokeIS_In_Scrn
Cloud_VSR_StraightScrn
Cloud_VSR_ContextScrn
Cloud_VSR_ContentScrn
Cloud_VSR_LoadScrn
Cloud_VSR_Transform_Out_Scrn
Cloud_VSR_InvokeIS_Out_Scrn
Cloud_VSR_CustomErrorScrn
Cloud_Deploy_DeployScrn
CustomConnector_ProviderProjectScrn
CloudStreamsConnector_Intro
CustomConnector_NewConnectorScrn
CustomConnector_OverviewScrn
ConnectionConfig_AuthenScrn
add_connauth_property
edit_connauth_property
remove_connauth_property
startstop_sequence_rest
startstop_sequence_soap
CustomConnector_ConfigureReferences
CustomConnector_NewResourceGroupScrn
configureassignment_resourcegroups
create_rest_resource
add_resource_request_parameter
create_resource_request_header
add_resource_request_body
rest_resource_request_assignment_order
create_resource_response_header
add_resource_response_body
CustomConnector_ExcludeRoot
add_soap_request_parameter
soap_request_header
soap_request_body
soap_request_assignment_order
soap_response_header
soap_response_body
cut_copy_paste
CustomConnector_AssignScrnREST
CustomConnector_AbstractObjects
parameter_datatypes_formatters
CustomConnector_ImportPackages
CustomConnector_ExportPackages
CustomConnector_PublishProviders
help_refactor_guidelines
help_refactoring_elements
help_search_guidelines
help_search_elements_packagenavigator
test_flow
for_each_map
define_map_service
map_service
build_map_service
create_map_service
set_map_property
graphical_tree_tab
help_working_with_RAD_openapi
rad_createfrmopenapiprov
rad_general_openapi
rad_server_openapi
rad_resources_openapi
rad_schemas_openapi
rad_security_openapi
rad_tags_openapi
rad_source_openapi
help_generate_REST
help_RESTV2_res_opn
rad_secdefine
rad_resttags
rad_edit
rad_createfromswagger
rad_is_swagger_mapping
help_working_with_RAD
rad_createfrmswaggerconsu
help_publish_REST_API
help_configure_json_documenttype
help_graphql_create
help_graphqlDataloader_create
help_with_websocket
help_with_server_endpoint
rad_create
help_working_with_recipes
help_ffschema_create
help_configure_connection
help_connect_API-Portal
help_remove_gateway_connection
help_configure_gateway_connection
help_publish_REST_wsd
help_connect_IC
help_configure_ICconnection
help_cloud_overview_clouddep
help_cloud_deploy_asset
help_cloud_overview_assetrepo
help_cloud_open_assetrepoview
help_cloud_build_assetinrepoview
help_cloud_deploy_assetrepoview
help_cloud_del_asset
help_cloud_config_univmsg
help_cloud_landscapr_navigatorview
help_cloud_create_ccdef
help_cloud_edit_ccdef
help_cloud_del_ccdef
help_cloud_browse_runtimeconfig
help_cloud_export_depconfig
help_cloud_configproject