Working with Software AG Designer
Introduction to Software AG Designer
Tips for Working with Software AG Designer
Managing Designer User Configuration
Changing the JRE or JDK Used by Designer
Configuring the Secure Storage
Secure Storage Runtime Options
Monitoring and Modifying Memory Usage
Adjusting the Designer Memory Settings
Verifying Java Byte Code
Java Code Cache
Finding Installed Products, Versions, and Fixes
Identifying Installed Products, Versions, and Fixes
Viewing and Copying Information About Software AG Features
Using Designer with Software AG Runtime
Defining a Software AG Runtime Entry in the Servers View
Adding the Software AG Runtime Environment
Enabling Designer Console Output on Windows
Modifying the Designer Configuration to Enable Console Output
Adding Parameters to the Command Line to Enable Designer Console Output
Modifying a Designer Shortcut to Enable Console Output
Configuring SSL Connections in Designer
Enabling Automatic Updates
Enabling Eclipse Update Sites
Enabling Error Reporting Notifications
Enabling Preference Recorder
Excluding Derived Resources
Software AG Designer Integrated Help
Document Conventions
Online Information and Support
Data Protection
webMethods BPM Process Development Help
Introduction to webMethods BPM Process Development
Deprecation of webMethods Broker
Designer Workspace
Designer Workspace
Process Development Views
About Process Development Views
About the Properties View
About the Outline View
Using the Outline View
About the Navigator View
About the Solutions View
Working with Process Projects and Processes in the Solutions View
Working with ARIS Processes in the Solutions View
Working with Rules Projects in the Solutions View
Creating Solutions
Deleting Solutions
Associating Assets with Solutions
Removing Associations from Solutions
Renaming Process Assets
Adding Assets to a Process from the Solutions View
Importing and Exporting Assets from the Solutions View
Creating Process Projects in the Solutions View
Working with Process Projects in the Solutions View
Creating Processes in the Solutions View
Working with Processes in the Solutions View
About Team Development and Version Control
Locating the Files Associated with Assets for Version Control
About the Rules Explorer View
About the Package Navigator View
Displaying Generated Flow Services in the Package Navigator View
About the Build Report View
About the Problems View
About the Error Log View
Process Development Preferences
About Process Development Preferences
Configuring Process Development Preferences
About Capabilities Preferences
Configuring the Process Development Mode
Configuring Appearance Preferences
Configuring Colors And Fonts Preferences
Configuring Build and Upload Preferences
Configuring Optimize Server Preferences
Configuring Process Audit Database Preferences
Connecting to Process Audit Database Using Kerberos Authentication
Creating a Custom Image Set for Activity Steps
Process Projects
About Process Projects
Creating Process Projects
Deleting Process Projects
Processes
About Processes
About Process Development Modes
Legacy Processes and BPMN
About BPMN Process Steps
Creating a Process
Configuring a Process
Updating Process Model Versions
Troubleshooting a Process
Basic Process Properties
Advanced Process Properties
About Synchronizing Process Runtime Settings with webMethods Monitor
Deleting a Process
Printing a Process
Saving a Process Image
Copying a Process
Using E-forms in a Process
Configuring E-forms in a Process
Selecting an E-form Content Repository
Process Steps
Process Step Overview
About Step Labels
Moving Process Steps Using the Keyboard
Cutting or Copying Process Steps
Pasting Process Steps
Deleting a Process Step
Enabling a Step for Resubmission
Assigning Custom Step Ornaments
The Process Editor
Using the Process Editor
Using the Palette
Working with Speed Buttons
Resizing Objects on the Canvas
Resizing Activities, Events, and Gateways
Moving Process Steps Using the Keyboard
Changing an Activity, Event, or Gateway Type
Available Change Type Selections
Using the Canvas Clipboard
Using Keyboard Shortcuts
Toolbar Buttons
Step Inputs and Outputs
About Inputs and Outputs
Show and Hide Inputs and Outputs
Create Inputs and Outputs
Remove Inputs and Outputs
Auto-Populate Inputs and Outputs
Log Inputs and Outputs
Input and Output Types
Specifying Referenced Process Start and Return Documents
Defining a Global Process Specification
Rules
About Rules
About webMethods Business Rules
About Decision Entities
About Decision Tables
About Rule Sets
About Event Rules
About Rule Actions
About Rule Tasks
Using webMethods Business Rules in Processes
About Process Actions
About Manual Decisions
Creating a Process Action
Starting a New Process Instance
Joining a Running Process Instance
Invoking a User Task
Configuring a Remote Integration Server
Process Engine Processing
About Process Execution
Process Execution Table
Setting Quality of Service for a Process
Parallel Execution (Step Locking)
About Transitions
About Transition Type Behavior
About Transition Types
About Step Transition Behavior
About Transition Exceptions
About Importing Models with Subprocesses with Compensating Error Transitions
About Transitions and Standard Exception Handling
About Transition Line Shape
Creating a Transition
Configuring Transition Behavior
Configuring Custom Transition Line Appearance
Removing a Transition
About Looping
About Standard Looping
About Transition Looping
About Process Logic
Process Expression Evaluation Logic
About Joins
About Dead Path Notification and Join Steps
How Incomplete Transitions Affect Join Steps and Gateways
About Join Failures in Join Steps and Gateway Steps
Join Timeout when Multiple Timeout Values are Specified
Migrating Process Models with Join Steps to Version 9.7 and Later
Suppressing a Join Failure (Deprecated)
Ignoring a Dead Path Notification (Deprecated)
About OR Join Behavior (Synchronized vs. Unsynchronized)
About Complex Join Expressions
Defining a Complex Join Expression
About Process and Step Timeouts
Defining a Timeout Value
About Process Timeouts
Defining a Process Timeout
Dynamic Timeout Control for Processes
Process Timer Behavior
About Join Timeouts
Defining a Join Timeout
About Boundary Timer Event Timer Conditions
Defining a Boundary Timer Event Timer Condition
About Business Calendar Timeouts
Business Calendar Prerequisites
Specifying Business Calendar Timeout Values
Timeout Recovery Behavior
Subprocess Concepts
About Subprocess Types
Call Activity Concepts
About BPMN Callable Processes
About webMethods Referenced Processes
About the webMethods Referenced Process Step
About Statically-Invoked Processes
About Dynamically-Invoked Processes
Invoking Multiple Instances of a Dynamic Process
Dynamically Invoking Multiple Processes
Synchronous or Asynchronous Behavior of Dynamically Invoked Processes
About the Return Behavior of Child Processes
Handling CallActivityModel Documents with Dynamically Invoked Processes
Handling SubprocessModel Documents with Dynamically Invoked Processes
About Retries
Handling Process and Step Errors
About Step Failure Behavior
About Boundary Event Error Behavior in a Subprocess
About End Error Event Behavior
Process Cancellation
Process Suspension
Process Debugging
About Document Correlation
About Correlation Services
About Correlation Fields
Correlation Behavior with Non-Starting Events and Activities
Creating Correlation Services
Correlation Service Input and Output Variables
Specifying Correlations
About Document Merging
About Process Tracking
Tracking Process Start
Using Volatile Tracking
Using the Process Engine Database Component
Tracking Process Status
Tracking Process Completion
Tracking Correlation IDs
Tracking Correlation IDs with Volatile Tracking
Tracking Correlation IDs with the Process Engine Database Component (Volatile Tracking Disabled)
Process Logging Behavior
About Process Engine Logging
Changing the Process Engine Logging Levels
About Process Instance Diagnostic Logging
Viewing a Process Instance Diagnostic Log File
About Process Audit Logging
Process Audit Log Database Component Tables
About Expression Operators
Process Engine Services
Process Engine Built-In Services Location
Summary of Elements in the WmPRT\pub Folder
pub.prt:CorrelationService
pub.prt.admin:changeProcessStatus
pub.prt.admin:deleteProcess
pub.prt.admin:resumeProcesses
pub.prt.admin:scanPackage
pub.prt.admin:suspendProcesses
pub.prt.audit.truncateProcessAtRest
pub.prt.CallActivityModel
pub.prt.correlate:deleteCorrelation
pub.prt.correlate:establishCorrelation
pub.prt.correlate:lookupCorrelation
pub.prt.debugger:cleanupDebuggerTables
pub.prt:ErrorService
pub.prt.ExceptionTransitionInfo
pub.prt.jms:send
pub.prt.log:logActivityMessages
pub.prt.log:logCustomID
pub.prt:ProcessData
pub.prt.SubprocessModel
pub.prt.timer.process:cancel
pub.prt.timer.process:create
pub.prt.timer.process:createWithBusinessCalendar
pub.prt.timer.process:createWithDate
pub.prt.timer.process:get
pub.prt.tn:deleteByCID
pub.prt.tn:getPIDforCID
pub.prt.tn:getRoleInfo
pub.prt.tn:handleBizDoc
pub.prt.tn:mapCIDtoPID
pub.prt.tn:MatchBizDoc
pub.prt.tn:RoleInfo
Activity Steps
About Activities
About Activity Types
About Activity Behavior
About Subprocess Behavior
About the Compensating Check Box
Applying a Compensating Marker to an Activity Step
About Looping Behavior
About Task Types
Adding a Task Activity
Configuring Task Types
Removing Task Types
Changing Task Types
Changing Task Images
Changing Task Label Placement
Basic Task Properties
Advanced Task Properties
About Abstract Tasks
Configuring Abstract Tasks
Advanced Abstract Task Properties
About Service Tasks
Configuring Service Tasks
Advanced Service Task Properties
About User Tasks
Configuring User Tasks
Advanced User Task Properties
About Manual Tasks
Configuring Manual Tasks
Advanced Manual Task Properties
About Rule Tasks
Configuring Rule Tasks
Advanced Rule Task Properties
About Send Tasks
Configuring Send Tasks
Advanced Send Task Properties
About Receive Tasks
Configuring Receive Tasks
Advanced Receive Task Properties
About Subprocesses
About Subprocess Nesting
Adding a Subprocess
Recommendations On Changing the Subprocess Type
About Changing webMethods Subprocesses to BPMN Subprocesses
Changing the Subprocess Type
Configuring a Subprocess
Configuring a Subprocess Standard Loop
Removing a Subprocess
Setting the Subprocess Color
Basic Subprocess Properties
Advanced Subprocess Properties
About Call Activities
Adding Call Activities
Configuring Call Activities
Configuring a Call Activity Standard Loop
Removing Call Activities
Basic Call Activity Properties
Advanced Call Activity Properties
BPMN Event Steps
About BPMN Events
About Throwing and Catching Events
Adding an Event to a Process
Removing an Event from a Process
About Start Events
Configuring a Start Event
About None Start Events
Advanced None Start Event Properties
About Message Start Events
Advanced Message Start Event Properties
About Signal Start Events
Advanced Signal Start Event Properties
About Intermediate Events
Configuring an Intermediate Event
About None Intermediate Events
Advanced None Intermediate Event Properties
About Message Intermediate Events
Advanced Message Intermediate Event Properties
About Signal Intermediate Events
Advanced Signal Intermediate Event Properties
About Boundary Intermediate Events
About Interrupting Behavior for Boundary Intermediate Events
About Throwing and Catching Boundary Intermediate Events
Adding a Boundary Intermediate Event
Removing a Boundary Intermediate Event
Configuring a Boundary Intermediate Event
About Boundary Intermediate Timer Events
About Boundary Intermediate Error Events
About Boundary Message Intermediate Events
Advanced Boundary Message Intermediate Event Properties
About Boundary Signal Intermediate Events
Advanced Boundary Signal Intermediate Event Properties
Basic Boundary Intermediate Event Properties
About End Events
Configuring an End Event
About None End Events
Advanced None End Event Properties
About Error End Events
Advanced Error End Event Properties
About Message End Events
Advanced Message End Event Properties
About Signal End Events
Advanced Signal End Event Properties
About Terminate End Events
About Terminate End Event Behavior in a Subprocess
Advanced Terminate End Event Properties
Configuring Terminate End Event Status
Basic Event Properties
EDA (Deprecated) Event Types
About EDA Event Types
Working with EDA Event Types in BPMN Message Events
About EDA Event Type Storage
Adding a Custom EDA Event Type to a Message Step
Publishing an EDA Event from a Message Step
Listening for an EDA Event in Message Step
Adding an EDA Event Type to an Activity Step
Enabling and Disabling Predefined EDA Event Emission for a Process Model
About EDA Event Types and Integration Server Document Types
About EDA Event Types and Logged Fields
How Logged Fields are Packaged in EDA Process Events
Importing the EDA Predefined Event Type Project
About EDA Predefined Process Event Types
About Process Event Schemas
EDA Process Event Element Definitions
EDA Predefined Process Event Types
Process Instance Change
Process Instance Error
Process Instance Log Custom ID
Process Instance Log Message
Process Step Instance Change
Process Step Instance Error
Process Step Instance Transition
Process Step Loop Instance Change
Process Stage Events
Key Supporting Schemas
Process Activity
Process Custom ID
Process Error
Process Instance
Process Instance with Parent
Process Model
Process Parent
Process Step Model
Process Step Instance
Process Step Loop Instance
Gateway Steps
About Gateways
Importing Gateways from Earlier Versions
About Gateway Types
Adding a Gateway
Configuring a Gateway
Changing the Gateway Type
Removing a Gateway
Basic Gateway Properties
Advanced Gateway Properties
Stages and Milestones
About Process Stages and Milestones
About Milestones
Working with Stages
Adding a Stage
Selecting a Stage
Editing a Stage
Deleting a Stage
Synchronizing Stage Settings
Pools and Swimlanes
About Pools
Adding Pools
Configuring Pools
Renaming Pools
Resizing Pools
Removing Pools
About Swimlanes
Adding Swimlanes
Adding Steps to Swimlanes
Configuring Swimlanes
Moving Swimlanes
Renaming Swimlanes
Resizing Swimlanes
Changing Swimlane Colors
Changing Swimlane Label Colors
Removing Swimlanes
Notes and Annotations
About Notes and Annotations
Working with Notes
Working with Annotations
KPIs
About KPIs
About Dimensions
Defining Dimensions
Deleting Dimensions
Removing Associated Fields from Dimensions
About Process-Level KPIs
About Step-Level KPIs
Defining Step-Level KPIs
Modifying Step-Level KPIs
Deleting Step-Level KPIs
Removing Dimensions from Step-Level KPIs
About Uploading KPIs to Optimize
Uploading KPIs to Optimize when Building and Uploading a Process for Execution
Uploading KPIs to Optimize Explicitly (without Building and Uploading a Process for Execution)
Process Documentation
About Process Documentation
Adding Documentation Fields
Assigning Documentation Field Values
Removing Documentation Fields
Generating Documentation Reports
Configuring Default Documentation Fields Preferences
Adding Default Documentation Fields
Editing Default Documentation Fields
Removing Default Documentation Fields
Importing and Exporting Default Documentation Fields
Working with Escalation Processes
Escalation Process Overview
Importing Closed Loop Analytic Assets into Designer
Activating the WmClosedLoopAnalytics Package
Working with the Default Escalation Process
Working with the Default Escalation Task
Working with the Default webMethods Rule Projects
Mapping Data Fields in the Wrapper Services
Triggering a Test Escalation Process
Process Integration with ARIS
ARIS Process Integration
ARIS Process Transformation
ARIS Extended XPDL Attributes
The ARIS Tasks View
Configuring ARIS Server Preferences
About Importing ARIS Processes as XPDL Files
Avoiding CentraSite Predefined Services for Import/Export
Importing an ARIS Process (XPDL File)
Using the Process Import Wizard for ARIS Imports
Re-Importing an ARIS Process
About Importing ARIS Solutions
Accessing the ARIS Solution Import Wizard
Importing an ARIS Solution
Synchronizing ARIS Processes
Importing and Exporting Processes
About Importing and Exporting Processes
Importing Designer Processes
Importing Designer Processes Containing One or More Referenced Processes
Exporting Designer Processes
Importing Modeler Processes
Modeler to Designer Conversions
Importing XPDL Processes
Exporting XPDL Processes
BPMN to XPDL Mapping
Building and Uploading Processes
About Building and Uploading a Process
About Building and Uploading with the Command-Line Utility
Building and Uploading Processes with the Command-Line Utility
Generating a Process
Generating Process Version 1
Generating Process Version 2
About Receive Steps
About Subscription Triggered Process Generation
About Simple Service Triggered Process Generation
About JMS-Triggered Process Generation
About EDA (Deprecated) Triggered Process Generation
About Process Generation and Stage Status Display
Configuring the Process Tracker Retrieval Interval
About Mapping Services
Working with Process Versions
Creating a New Process Version
About Releasing New Process Versions
Working with Subscription Filters
Adding a Subscription Filter
Configuring a Subscription Filter
Removing a Subscription Filter
Working with Triggers
About Subscription Triggers
About Transition Triggers
Invoking Child Processes
Working with Protocols
Configuring a Subscription-Triggered Process
Setting the Encoding Type for the Universal Messaging Document Types
Configuring a Simple Service Triggered Process
Configuring a JMS-Triggered Process
Setting the Manage Destination Option for a Connection Alias
Configuring an EDA-Triggered Process (Deprecated)
About Enabling Processes
Setting Default Deployment Values for a Process Model
Metadata Deployment in a Docker Environment
Designer Process Development
Build and Upload Command Line Tool
Deploying Assets to the Container
Metadata Deployment and Process Activation
Debugging Processes
About Process Debugging
Configuring Process Debug Preferences
Creating a Process Debug Configuration
Debugging a Process
Navigating Steps during Debugging
About the Trace View
Debugging an Intermediate Receive Step
Debugging Parallel Tracks
Debugging a User Task
Debugging a Call Activity
Debugging a Subprocess
Debugging a Looped Step
Debugging a Boundary Event
Debugging a Process-Wide Timeout
Debugging a Join Timeout
Modifying Input Data
Loading Input Data
Saving Input Data
About the Pipeline Data View
Working with Breakpoints
About the Breakpoints View
Setting a Breakpoint
Removing a Breakpoint
Enabling a Breakpoint
Disabling a Breakpoint
Skipping All Breakpoints
Working with CentraSite Metadata for BPM and CAF Assets
About Metadata in CentraSite
Working with CentraSite Metadata
About The Registry Explorer View
Publishing Metadata for Processes and CAF Applications
Retracting Metadata for Processes and CAF Applications
About Searching for Asset Metadata
Performing a Basic Search for webMethods Assets
Performing an Advanced Search for webMethods Assets
Configuring Search Preferences
About the Search View
Related Assets
Showing Asset References and Dependencies
About Working with Saved Searches
Working with Saved Searches
Creating Saved Searches
Duplicating Saved Searches
Executing Saved Searches
Renaming Saved Searches
Editing Saved Searches
Exporting Saved Searches
Importing Saved Searches
webMethods BPM Rules Development Help
Introduction to webMethods Rules Development
Rules Development Overview
Before You Use Rules Development
About Rules Development Licenses
Rules Development Terminology
Rules Development Workspace
Rules Development Perspective
Opening the Rules Development Perspective
Rules Development Views
Working with the Outline View
Working with the Properties View
Working with the Rules Explorer View
Working with the Rule Verification View
Working with the Solutions View
Rules Development Editors
The Decision Table Editor
Decision Table Editor Toolbar Buttons
Decision Table Editor Palette View Buttons
Decision Table Editor Context Menu
Decision Table Editor Keyboard Shortcuts
The Decision Tree Editor
Decision Tree Editor Toolbar Buttons
Decision Tree Editor Palette View Buttons
Decision Tree Editor Context Menu
Decision Tree Editor Keyboard Shortcuts
The Event Rule Editor
Event Rule Editor Toolbar Buttons
Event Rule Editor Palette View Buttons
Event Rule Editor Context Menu
Event Rule Editor Keyboard Shortcuts
Rules Development Preferences
Decision Entity Editors Preferences
Annotations Preferences
Decision Table Preferences
Decision Tree Preferences
Event Rule Preferences
Decision Entity Launching Preferences
Rule Project Preferences
Rule Verification Preferences
Rules Explorer View Preferences
Rules Development Process Overview
Working with Rule Projects
Accessing the Rule Project Wizard
Creating a Rule Project
Renaming a Rule Project
Deleting a Rule Project
Working with Data Models and Parameters
About Data Types
Accessing the Data Model Wizard
Creating a Data Model
Synchronizing a Data Model with the Underlying IS Document Type
Renaming a Data Model
Deleting a Data Model
Working with Actions
Working with Service Actions
Working with Process Actions
Working with New Data Actions
Working with Predictive Analytics Actions
Accessing the Action Wizard
Creating a Service Action
Creating a Process Action
Starting a New Process Instance
Joining a Running Process Instance
Invoking a User Task
Creating a New Data Action
Creating a Predictive Analytics Action
About Data Types for Predictive Analytics Actions
Modifying an Action
Renaming an Action
Deleting an Action
Working with Rule Sets
About Rule Set Processing Modes
Accessing the Rule Set Wizard
Creating a Rule Set
Renaming a Rule Set
Deleting a Rule Set
Modifying the Processing Mode
Working with Decision Tables
About Decision Table Processing Modes
Accessing the Decision Table Wizard
Creating a Decision Table
Modifying a Decision Table
Adding an Operator
Modifying an Operator
Adding a Literal Value
Modifying a Literal Value
Adding a Condition Value or Result Value
Modifying a Condition Value or Result Value
Clearing a Condition Value or Result Value
Adding a Condition
Adding a Condition from the Rules Explorer View
Adding an Assignment Result
Adding an Assignment Result from the Rules Explorer View
Reassigning a Parameter Element to a Condition or Assignment Result
Adding an Action Result
Modifying an Action Result
Modifying the Status of an Action Result Value
Modifying the Input of an Action Result Value
Renaming a Condition or Result
Adding a Rule
Cutting, Copying and Pasting a Rule within the Same Decision Table
Cutting, Copying and Pasting a Rule from One Decision Table to Another
Reordering Rules
Deleting a Rule, a Condition, or a Result
Modifying the Processing Mode
Enabling Principal Status of a Condition or Result
Disabling Principal Status of a Condition or Result
Setting an In Effect Date at Decision Table Level
Setting an In Effect Date at Rule Level
Assigning a Data Provider Service to a Condition or Result
About Condition Operators
About Result Operators
About In Effect Operators
About Data Type Assignment
Working with Decision Trees
About Decision Tree Processing Modes
Accessing the Decision Tree Wizard
Creating a Decision Tree
Modifying a Decision Tree
Adding a Condition Node
Adding an Assignment Result Node
Deleting Condition Nodes or Result Nodes
Adding an Operator to a Condition Link or Assignment Result Node
Modifying the Operator of a Condition Link or Assignment Result Node
Adding a Literal Value to a Condition Link or Assignment Result Node
Modifying the Literal Value of a Condition Link or Assignment Result Node
Modifying Condition Values or Assignment Result Values
Clearing Condition Values or Assignment Result Values
Adding an Action Result Node
Modifying an Action Result Node
Modifying the Status of an Action Result Node
Modifying the Action Inputs of an Action Result Node
Cutting, Copying and Pasting Links and Nodes within a Decision Tree
Cutting, Copying and Pasting Links and Nodes from One Decision Tree to Another
Dragging and Dropping Links and Nodes within a Decision Tree
Reordering Nodes
Expanding and Collapsing Nodes
Zooming In and Out
Exporting a Decision Tree as an Image
Modifying the Processing Mode
Setting the Missing Value Approach
Setting a Default Value for Missing Values
Modifying a Label
Clearing a Label
About Condition Operators
About Result Operators
About Data Type Assignment
Working with Event Rules
About Event Rule Processing Modes
Accessing the Event Rule Wizard
Creating an Event Rule
Modifying an Event
Reassigning an Event Source
Modifying an Event Rule Result
Reassigning a Result
Adding an Operator
Modifying an Operator
Adding a Literal Value
Modifying a Literal Value
Adding a Result Value
Modifying a Result Value
Clearing a Result Value
Adding an Assignment Result
Adding an Assignment Result from the Rules Explorer View
Adding an Action Result
Modifying an Action Result
Modifying the Status of an Action Result Value
Modifying the Input of an Action Result Value
Deleting a Result
About Result Operators
About Data Type Assignment
Global Functions Overview
Opening a Decision Entity
Closing a Decision Entity
Saving a Decision Entity
Saving a Copy of a Decision Entity
Cutting, Copying and Pasting a Condition Value or Result Value within the Same Decision Entity
Cutting, Copying and Pasting a Condition Value or Result Value from One Decision Entity to Another
Cutting, Copying and Pasting a Condition or Result within the Same Decision Entity
Cutting, Copying and Pasting a Condition or Result from One Decision Entity to Another
Adding a Parameter to a Decision Entity
Deleting a Parameter of a Decision Entity
Renaming a Decision Entity
Deleting a Decision Entity
Modifying the Description of a Decision Entity
Adding a Decision Entity to a Rule Set
Removing a Decision Entity from a Rule Set
Reordering Decision Entities within a Rule Set
About Constants
Rule Verification Overview
About Automatic Verification
Verifying Rules Manually
Assigning a Verification Service to a Decision Table Condition or Decision Table Result
About Verification Categories
Suppressing Warnings in Single Cells
Local Rule Testing Overview
Creating a Launch Configuration for Local Testing
Testing a Decision Table Locally
Testing a Decision Tree Locally
Testing an Event Rule Locally
Testing a Rule Set Locally
Terminating a Running Test
About Entering Input Values
About Loading Input Values
About Saving Input Values
Rule Project Exchange with Integration Server
Exporting a Rule Project to Integration Server
Rule Project Exchange with the My webMethods Server Repository
Configuring a My webMethods Server Repository Connection
Accessing the Export Wizard
Accessing the Import Wizard
Exporting a Rule Project to the My webMethods Server Repository
Importing a Rule Project from the My webMethods Server Repository
Working with webMethods Search
Showing Asset Dependencies
Showing Asset References
Working with Expressions
Adding an Expression
Processing Personal Data
Modifying Personal Data in Business Rules Preferences
Modifying Personal Data on My webMethods Server
Modifying Personal Data Stored for Rules-related Events
Modifying Personal Data Stored When Deploying Rule Projects
Modifying Personal Data Stored for Audit Information
webMethods BPM Task Development Help
Introduction to webMethods Task Development
webMethodsTask Development Introduction
About Task Development
Task Development Prerequisites
About JavaServer Faces
About Views
About CAF Controls
Other Resources for Task Development
Setting Task Development Preferences
Working with Task Applications
About Task Applications
Task Application Overview
Working with Task Application Projects
About Task Application Projects
Accessing the Portlet Application Project Wizard
Creating a Task Application Project
Deleting a Task Application Project in Designer
Migrating Task Projects and .view Files to JSF 2.x Format
Migrating a JSF 1.x Task Application Project to JSF 2.x Format
Migrating .view Files to JSF 2.x Format
Task Overview
About Tasks
Task Key Features
About Task Characteristics
About Task Status
About Task Voting
About Task Names and Task Type IDs
About webMethods Business Rules Integration
About Collaboration Tasks
Using Collaboration Tasks in a Process
Using Collaboration Tasks Manually
About Collaboration Processes
About the Relationship Between Parent Tasks and Collaboration Tasks
About Task Comments and Attachments Sharing
Creating Tasks
About Creating Tasks
Accessing the Task Wizard
Creating a New Task with the Task Wizard
Creating a Collaboration Task
Creating a New Task from an Integration Server Document Type
Adding a Task to a Process
Creating a New Task from a Task Step in a Process
Adding an Existing Task to a Process
Adding a Task by Drag and Drop
Adding a Task by Selecting from a Task List
Working with Task Portlets
Task Portlet Overview
About Default Task Portlets
About the Task Overview Portlet
About the Task View (Task Details) Portlet
About the Task Inbox Bar Portlet
About the Task Inbox Results Portlet
About the Inbox Results Default View
About the Inbox Results Edit View
About the Task Start Portlet
About Customizable Task Portlets
About the Task Details View Portlet
About the Task Audit Portlet
About the Task Comments Portlet
About the Task Comments Default View
About the Task Comments Add-edit View
About the Task Collaboration Portlet
About the Task Collaboration Default View
About the Task Collaboration Createnew View
About Modifying the Default Task Portlets
Viewing and Opening Task Portlets
Adding a New Portlet to a Task
Accessing the New Portlet Wizard
About the Task Portlet Type Templates
Modifying the Task View Definition
About Modifying the Task Details Page Contents
Modifying the Task Start Definition
Adding a New View to an Existing Task Portlet
Accessing the New Portlet View Wizard
About the Portlet View Templates
Previewing a Task Portlet View in the Task Editor
Deleting Task Portlets and Portlet Views
Running Task Portlets and Views in My webMethods Server
Defining a Server for a Task Application Project
Running a Task Portlet
Running a Task Portlet View
Running a Task Page
Working with Security Roles
Security Roles Overview
Viewing Task Security Roles
Adding a Security Role to a Task
Adding a Task Assignment Security Role
Adding a Security Role for Binding a Task Privilege to a User Interface Control
Binding a Security Role to a User Interface Control
Modifying and Deleting a Task Security Role
Configuring Tasks
Task Configuration Overview
Configuring Business Data (Task Inputs and Outputs)
Viewing Business Data
About the Task Data Envelope
Modifying Task Information in the Task Envelope Data Flow
About Indexed Business Data Fields
About HPSTRA-enabled Tasks and Business Data Fields
About Business Data Fields in the Run-time Environment
About Business Data and Collaboration Tasks
Synchronizing Parent-Child Task Business Data
About Business Data and E-forms
Synchronizing E-form Templates and IS Document Types
Adding A Business Data Field with the Editor
Adding an Integration Server Document Type as Business Data
Modifying Task Business Data Fields
Considerations When Modifying Task Business Data
Deleting Task Business Data
Updating or Refreshing Task Business Data
Refreshing Document Business Data in the Editor
Refreshing Task Business Data from an Integration Server Document
Updating Business Data from a Task Step in a Process
Adding Task Business Data Fields to a Page or View
Dragging and Dropping Task Business Data Fields to a Page or View
Creating Custom Search Fields from Task Business Data
About Task Search Operators
Configuring Votable Tasks
Configuring Task Voting
About Task Voting Strategies
Runtime Considerations for Votable Tasks
About the Task Voting Chart and Statistics Table
Adding E-form Support to a Task
Adding E-forms Stored in a My webMethods Server Folder Location
Adding an E-form User Interface to the Task Details View with Snippets
Adding an E-form Download Link to the Inbox Results View with Snippets
Customizing Task E-form Behavior
Working with Services in Tasks
Adding a Service to a Task
Adding a Service by Dragging and Dropping
Adding a Service with the Web Service Connector Wizard
Modifying a Service in a Task
Extending a Task with Custom Java Code
Adding Your Own Java Code
Adding Actions and Data to a Task in the Bindings View
Working with Task Privileges
About Privilege Containers
Viewing Task Functional Privileges
Adding a Task Functional Privilege Container
Adding a Task Functional Privilege
Modifying and Deleting a Task Functional Privilege Component
Binding a Task Functional Privilege to a User Interface Control
Working with Task Assignments
Creating a Task Assignment
Configuring Assignment General Information
Configuring Assignees for a Task Assignment
Configuring a Task Assignment with a Decision Table
Configuring a Task Assignment with a Business Rule Set
Example Task Assignment with a Decision Table
Example Task Assignment with a Business Rule Set
Configuring Task Assignment Options and Conditions
Configuring Distribution Management for a Task Assignment
About Round-Robin Task Distribution
About Queue Length Task Distribution
About User Calendars and Task Distribution Management
Working with Task Events
Creating a Task Event
Configuring Event General Information
Configuring a Task Event Type
Configuring a Task Event Action
Configuring Simple Task Actions
Configuring a Date/Time Event
Filtering a Custom Inbox with a Task Event
Creating a Task Notification Event
Configuring Simple Task Conditions
Modifying Simple Task Conditions
Deleting Simple Task Conditions
Rearranging the Order of Simple Task Conditions
Working with Task Control Sets
Viewing Task Control Sets
Creating a Task Control Set
Associating an Assignment or Event with a Control Set
Removing an Assignment or Event from a Control Set
Changing the Task Type Name
Using Gadgets to Render the Task Detail Page in webMethods Business Console
Updating Tasks
Task Update Overview
Available Java APIs
Updating Tasks Applying Optional Settings
Working with Task Searches
Task Search Overview
Implementing Case-Insensitive Searching
About Indexed Searches
About HPSTRA Searches
Search Considerations with Task Type Inboxes
Implementing an Indexed Search Content Provider for Existing Task Types
Changing the Search Provider Base Class
Setting the Sorting and Value Bindings for Custom Inbox Business Data Columns
Setting the Sorting Bindings for Custom Inbox TaskInfo Columns
Setting the Bindings Configuration for Task Search Provider
Searching Indexed Data in a Custom Task Inbox
Implementing a Standard Search Provider for Existing Task Types
Considerations When Publishing Tasks with Indexed Data
Working with Task Client Options
About Task Client Options
Task Client Option Definitions
Modifying Client Options for a Task
Working with Tasks in the Bindings View
About Tasks in the Bindings View
About Available Task Binding Properties
About Available Collaboration Task Bindings
About Task Indexed Search Content Provider Binding Properties
Modifying Task Binding Properties
Working with Task Pages
Task Pages Overview
Accessing a Task Page
Renaming a Task Root Page
Renaming a Task Page
Hiding and Displaying a Task Page
Working with Task Notifications
About Task Notifications
Task Notification Overview
Understanding Task Notification Behavior
Limitations to Subscription Access
About Task E-mail Notification Replies
About the Task E-mail Listener
Accessing the Task Notification Wizard
Creating a Task Notification
Adding a Task Action Link to a Notification
Extracting Data from a Task Notification Return E-mail
Modifying and Deleting a Task Notification
Sending Task Notifications to Non-Assigned Users
Working with Task Delegation
Task Delegation Overview
Limitations to Scheduled Delegation Access
Publishing Tasks
About Publishing Tasks
Publishing a Task
Considerations When Publishing Task Types with Duplicate Names
Automatically Publishing Tasks in a Process
About Optimized Task Publishing
Forcing the Full Publication of a Task Application Project
Deleting Tasks
Deleting a Task
Deleting a Task in My webMethods
Removing Tasks from Integration Server
Working with Task Attachments
Task Attachment Overview
Adding Attachment Capability to a Task
Sharing Attachments by Setting the Attachments Scope
Working with Task Comments
Task Comments Overview
Setting a Scope for Task Comments
Working with Custom Task Inboxes
Custom Task Inbox Overview
About Creating a Custom Task Inbox
Modifying the Results List for a Custom Task Inbox
Configuring the Results List Column Display in a Custom Inbox
Configuring the Results List Page Size in a Custom Inbox
About the Column Width Preference for the Results List
Configuring the Results List Sorting Behavior in a Custom Inbox
Example Modifying the Default Search Fields and Results
Example Adding an Indexed Business Data Search Field
Working with Task Workflows
Task Workflow Overview
Basic Operation
Code Samples
Implementation Components
Working with the Sample Applications
Key Implementation Points
Working with Tasks in the Faces Configuration Editor
About Tasks and the Faces Configuration Editor
Finding Task Applications in Software AG Designer
Searching for Task Applications
Working with Task Metadata
Task Metadata Overview
Working with User and Business Calendars
About Tasks and User and Business Calendars
Importing Task Applications from Earlier Versions
Importing Task Applications Overview
Indexed Field Considerations When Importing into Version 8.2 or Later
Moving from JSF 1.x to JSF 2.x Support
Working with Task Expressions
About Task Expressions
Task Expression Overview
Configuring Advanced Task Expressions
Building a Sample Task Expression
Viewing Sample Task Expression Syntax
About Condition Expressions
About Action Expressions
About Filter Expressions
About Expression Operators
About Date/Time Values in Expressions
About Expression Managed Beans
About Java Providers and Related Classes
Understanding Task Providers
BPM Process Content Provider
Task Attachments Provider
Task Audit Content Provider
Task Audit Display Provider
Task Business Calendar Model
Task Comment List Provider
Task Content Provider
Task Display Provider
Task Indexed Search Content Provider
Task JCR Attachments Provider
Task Search Content Provider
Non-Public Task Providers
Task Inbox Queue Workload Provider
Task Round Robin Workload Provider
Task Saved Search Content Provider
Task Provider Utils
Processing Task Change Events
Task Change Event Overview
Typical Use of Task Change Events
Working with the Task Engine APIs
About the Task Engine APIs
webMethods BPM and CAF Workspace Metadata Help
Introduction to webMethods BPM and CAF Workspace Metadata
Workspace Metadata
webMethods Workspace Metadata
Metadata in Your Workspace
The Workspace Index
Enabling or Disabling Workspace Indexing
About Resetting the Workspace Index
Resetting the Workspace Index
Configuring Workspace Index Preferences
Metadata in CentraSite
Workspace Metadata Search
webMethods Workspace Metadata Search
Performing Basic Searches
Performing Advanced Searches
Configuring Search Preferences
Search View
Related Assets
Showing Asset References and Dependencies
Saved Searches View
Creating Saved Searches
Duplicating Saved Searches
Executing Saved Searches
Renaming Saved Searches
Editing Saved Searches
Exporting Saved Searches
Importing Saved Searches
webMethods CAF and OpenUI Development
Introduction to webMethods CAF and OpenUI Development
CAF and webMethods OpenUI Development Prerequisites and Resources
Technologies Required for CAF and webMethods OpenUI Development
Specifying an External Web Browser
Composite Application Framework Concepts
CAF and webMethods OpenUI Development Requirements
About JavaServer Faces
About Ajax
About Portlet Applications
About Portlets
About Views
About CAF Controls
About Managed Beans
Setting the Managed Bean Expiration Policy
About CAF File Names and Path Lengths
Developing CAF Applications
Setting CAF Development Preferences
About CAF Development Preferences
About Component Libraries
Removing a Component Library from an Application
Manually Adding a Component Library to an Application
About Web Application Project Templates
Cascading Style Sheets (CSS)
Changing the CSS Values for a Control
Applying CSS to a View
Importing a View into a VDL File
Working with Page Templates
Using Content Parameters with Page Templates
Navigation in Web Applications
Configuring Application Navigation
Adding a Home Link to a Web Application
Hiding Breadcrumbs on the Home Page
Setting Application Initialization Parameters
Setting Environment Variables
Finding the Home Page ID
Managing Text Overflow in Property Lines
Placing Modal Dialog and Popup Panel Controls
Importing CAF Projects
Validation Support for xmlImport Files
Specifying a Target Runtime Server
Debugging CAF Applications Remotely
Developing webMethods OpenUI Applications
About webMethods OpenUI
About webMethods OpenUI Shell
About JSF 2.x Facelets Support
Additional Resources for Developing OpenUI Applications
Security in OpenUI Applications
Security in CAF Applications
Security Roles in Web and Portlet Applications
Add a Security Role to a Web Application
Add a Security Role to a Portlet Application
Mitigating Portlet Security Vulnerabilities
Getting Started with Web Application Development
About Web Applications
Creating a Web Application Project
Adding a View to a Web Application
Adding a Control to a Web Application View
Preparing a Web Application for Localization
Getting Started with Portlet Application Development
About Portlet Application Projects
Creating a Portlet Application Project
Creating a Portlet
About Portlet Types
About Portlet Modes
Adding a View to a Portlet
Adding a Control to a Portlet View
Finding Information about CAF Controls
Adding a Portlet Application Project to My webMethods Server
Importing My webMethods Server Assets into a Portlet Application
Publishing a Portlet Application to My webMethods Server
Adding a Portlet to a My webMethods Server Page
Uninstalling Portlet Applications from My webMethods Server
Troubleshooting Portlet Applications
Repairing a Portlet Application Project
Opening the Portlet Application Configuration Editor
Getting Started with webMethods OpenUI Shell Page Development
About webMethods OpenUI Shell Page Templates
Creating an OpenUI Shell Page Project
Modifying an OpenUI Shell Custom Application Page
Modifying an OpenUI Shell Login Page
Modifying an OpenUI Shell Maintenance Page
Adding an OpenUI Shell Page to an Existing Project
About Creating Custom Templates with webMethods OpenUI
Creating a Custom OpenUI Page Template
Creating a Custom OpenUI Project Template
Editing a Custom Page or Project Template
Exporting a Custom Page or Project Template
Importing a Custom Page or Project Template in Designer
Deleting a Custom Page or Project Template
Default webMethods OpenUI Page Templates
Variable Conversion When Applying a Page Template
Handling of Existing Files When Applying a Page Template
Working with Facelets
About Facelets in CAF
Migrating CAF Projects and .view Files to JSF Facelets Format
Migrating a JSF .view File Project to JSF Facelets Format
Migrating .view Files to JSF .xhtml Facelets Format
About Migrating Managed Bean Declarations
Working with the CAF Control Tag Library
Working with Page Navigation in JSF Facelets Applications
Embedding Portal Resources in a Page File
Example of Inserting a Form Into a Portlet
Java Annotations in CAF and webMethods OpenUI Applications
Disabling and Enabling Declaration of Managed Beans by Annotation
Servlet Standard Annotations
JSF Standard Managed Bean Annotations
Bean Validation Standard Annotations
CAF Extended Managed Bean Annotations
CAF Client-Side Annotations
CAF Portlet Annotations
Working with Portlet Preferences
About Portlet Preferences
Creating a Portlet Preference
Modifying a Portlet Preference
Specifying a Portlet Preference Validator
Wiring Portlets with Preferences
Exposing Portlet Preferences in My webMethods Server
Enabling the Show All Managed Beans Toolbar Button
About Preferences for the Default Portlet Types
Working with Legacy Portlets
About Legacy Portlets
Enabling Legacy Portlet Support
Importing Legacy Portlets
Changing Legacy Portlet Preferences
Working with CAF Events and Notifications
About CAF Events
About the Default My webMethods Server Event Types
About My webMethods Server Login Events
Opening the CAF Events Editor and Enabling CAF Events
Creating a Custom CAF Event
Creating an Event Handler
About CAF Event Handler Actions
Configuring a Simple Event Handler Action
Configuring a Fire Ajax Event Action
Configuring an Invoke Service Action
Configuring a Send Notification Action
Creating a Notification
Configuring an RSS Notification
Creating a Subscription
Configuring the Default Subscription View
Configuring Simple Conditions
Modifying a Simple Condition
Deleting a Simple Condition
Rearranging the Order of Simple Conditions
Configuring Advanced Condition and Action Expressions
E-form Support in Portlet Applications
Adding E-form Support to a CAF Portlet Application
Configuring a CAF Portlet Application Project for E-form Support
Adding an IS Document Type for E-form Support
Adding an E-form Template Type to a CAF Portlet View
Adding an E-form Template from a File System or Web Server
Adding an E-form Template from a Repository
Adding a Basic Default E-form Download or Upload User Interface
Adding an Advanced Default E-Form Download or Upload User Interface
Using a Simple Email Deliverer
About the CAF Simple Email Deliverer
Adding a Simple Email Deliverer
Specifying the Mail Session
Specifying Data Binding for a Simple Email Deliverer
Working with the Bindings View
About the Bindings View
Binding a Managed Bean Property to Another Bean
Binding Data to a Control
Binding a User Attribute to an Output Text Control
Binding a Security Role to a Control
Binding Security Roles in an Access Control Panel
Creating a New Action Method
Working with My webMethods Server
Adding a My webMethods Server Instance in Designer
Editing a My webMethods Server Instance
Starting a My webMethods Server Instance
Stopping a My webMethods Server Instance
Running My webMethods Server in Debug Mode
Specifying a Default Application Server
Publishing an Application to My webMethods Server
Manually Deploying a Web Application to My webMethods Server
Deploying a Jar File to My webMethods Server
Exporting from My webMethods Server
My webMethods Server Runtime Assets
About Runtime Asset Extraction
Extracting Runtime Assets
Creating a Deployable Component
Performance Monitoring
Measuring Application Performance
Creating Custom Tokens for Performance Monitoring
Using Attachments Providers
About Attachments Providers
Adding an Attachments Provider Property
Adding a Shared Managed Bean and Attachments Provider Reference
Working with JCR Providers
About JCR Client Providers
Enabling the JCR Client for a CAF Application
Creating a JCR Client Attachments Provider
Creating a Node Children Table Provider
Adding Additional Properties to the JCR Provider
Creating a JCR Client Node Provider
Creating a Search Result Table Provider
Creating a JCR Sub-Folder Attachments Provider
Creating a JCR Client Temp Attachments Provider
Working with Web Services
About Web Services in CAF Applications
Connecting to webMethods Integration Server
Specifying a Web Service Connector
Creating a Web Service Descriptor
Generating a Web Service Connector Reference
Adding a Web Service Connector from Package Navigator
Adding an Operation from a Referenced Web Service
Setting Web Service Connector Preferences
Specifying a Web Service Connector Socket Timeout
Migrating a Web Service from Glue to WS-Stack
Configuring wsclient-socketTimeout at Run Time
Configuring Global Runtime Timeout
Web Service Connector Preferences
About XSD Schema Choice Declarations
Using the MWS Admin View
About the MWS Admin View
Creating a MWS Data Provider
Changing the Connection Properties for a Server Instance
Opening the MWS Administration Dashboard
Views in the Composite Application Framework
The UI Development Perspective
The Bindings View
Data Source Explorer View
Connecting to a Database
Creating a Database Connector
Outline View
Package Navigator View
Properties View
Properties View Toolbar
Snippets View
Customizing the Snippets View
E-forms Snippets Drawer
CAF Dialog Patterns
Solutions View
Database Connectors in the Solutions View
Creating a Portlet on the Solutions View
Using the Design Canvas
About the Design Canvas
Design Canvas Toolbar
Using the Design Canvas with Other Views
Manipulating Controls on the Design Canvas
Design Canvas Preview
Matching Controls
Changing Control Type
Changing Control Labels in the Design Canvas
The Palette View
About the Palette View
Palette View Toolbar
Adding an Object to the Favorites Node
Removing an Object from the Favorites Node
Customizing the Palette View
Filter the Palette View
Display Deprecated UI Controls
CAF Events Editor
Events Editor UI Reference
Introduction tab
Overview tab
Events tab
Handlers tab
Subscriptions tab
Notifications tab
Using Snippets
Using a Snippet for Controls or Containers
Using a Snippet for Source Code
Creating a Snippet of a Control or Container
Creating a Snippet of Source Code
Creating a Snippet of Clipboard Content
Editing a Snippet
Copying and Pasting a Snippet
Cutting and Pasting a Snippet
Deleting a Snippet
Exporting Snippets
Importing Snippets
Creating a Variable Placeholder
Inserting a Variable Placeholder into a Snippet
Deleting a Variable Placeholder
Using MWS Control Patterns Snippets
Customizing UI Controls
User Interface Controls Concepts
Control ID Reference
Hideable Controls
Toggle Controls
Scriptaculous Effects
Image URLs
Skinning
Client-Side Libraries
Strings
Logger
Logger Bookmarklet
Library
CAF.Dialog Class
CAF.Progress Class
CAF.Tooltip Class
CAF.Request Class
CAF.Updater Class
CAF.Draggable Class
CAF.Droppable Class
Understanding the Client-side Model
About the Client-Side Model
CAF.Model
CAF.Output.Model
CAF.Link.Model
CAF.Command.Model
CAF.Input.Model
CAF.Checkbox.Model
CAF.Select.Model
CAF.Table.Model
CAF.Table.Row.Model
Template Row
Paging
Listeners
CAF.Tree.Model
Script Placement in the CAF Model
Using Converters and Validators
About Using Converters and Validators with CAF Controls
Displaying Converters and Validators
Adding a Converter to a Control
Adding a Validator to a Control
Creating a Custom Converter
Creating a Custom Validator
Centrasite Eclipse UI Help
Introduction to CentraSite Eclipse UI
Getting Started
Introduction to CentraSite and its Eclipse GUI
Support for the SOA Design-Time Environment
Asset Management and Governance
Starting to Work with the Eclipse GUI
CentraSite Perspectives
CentraSite Views
CentraSite Details Editor
Connecting to CentraSite
Changing Preference Settings
Registry Tree Settings
Language
Connections
Restricted Localization
Working with Views, Editors and Perspectives
Working with the Perspectives
Working with the Details Editor
Refreshing Views
Executing Actions
Handling Errors
Getting Help
Exiting the Eclipse GUI
Concepts
Registry and Repository
Assets and Registry Objects
Assets
Supporting Objects
Properties of Registry Objects
Predefined Properties
Custom Properties
Status, Stability and Expiration of Registry Objects
Status
Stability
Expiration Date and Time
Versions of Registry Objects
Explicitly Creating Object Versions
Implicit Creation of Object Versions
Classifications of Registry Objects
Associations Between Registry Objects
Associations
Implicit References
External Links
Supporting Documents and Resources
Properties of Resources
Attributes
Attribute Data Types
Attribute Names
Names for the Other Attribute Types
Computed Attributes
Defining a Computed Attribute
Implementation guidelines for Java-based computed attributes
Structure of archive file
Sample code
Profiles
Generic Profiles
Computed Profiles
Defining a Computed Profile
Implementation guidelines for Java-based computed profiles
Structure of archive file
Sample code
Namespaces
Notifications
Security
Users, Groups and Roles in CentraSite
Security Settings for Object Types
Security Settings for Registry Objects
Security Settings for Folders and Files
Audit Logs
Tasks
Browsing the Registry
Asset Types View
My View
Registry Explorer View
Impact Analyzer View
Administration View
Contents and Search View
Details Editor
Browsing the Repository
Repository Explorer View
Documents View
Using Favorites
Adding Favorites
Managing Favorites
Working with Registry Objects
Searching and Finding Registry Objects
Executing a Search
Specifying Keywords
Specifying Search Conditions
Using XQuery
Creating Registry Objects
Creating Assets
Creating Supporting Objects
Creating Services
Versioning Services
Handling of Associations
Updating Registry Objects
Classifying Registry Objects
Assigning Classifications to Registry Objects
Deassigning Classifications from Registry Objects
Displaying Classified Registry Objects
Organizing Registry Objects in Lists
Impact Analysis for Registry Objects
Working with Registry Object Versions
Creating Registry Object Versions
Displaying Registry Object Versions
Deleting Registry Object Versions
Deleting the Most Recent Object Version
Purging Object Versions
Using Notifications
Registering and Managing Notification Requests for Registry Objects
Managing Change Notifications
Deleting Registry Objects
Working with Supporting Documents and Resources
Creating Folders and Files
Updating Properties of Folders and Files
Displaying the Contents of Files
Displaying File Versions
Impact Analysis for Folders and Files
Saving Files to the Eclipse Workspace
Renaming Folders and Files
Deleting Folders and Files
Working with Associations and External Links
Displaying Associations and External Links
Creating Associations Between Objects
Creating Associations by Drag and Drop
Creating Associations Using the Associations Tab
Removing Associations Between Objects
Creating External Links for Objects
Creating External Links by Drag and Drop
Creating External Links Using the External Links Tab
Creating External Links by Copying Existing Ones
Modifying External Links
Displaying the Targets of External Links
Removing External Links
Exporting Data from Centrasite
Importing Data into CentraSite
Importing Data from an Archive
Importing XML Schemas
Importing Web Services
Importing Reports
Importing BPEL Process Definitions
Importing XPDL Process Definitions
Working with Reports
Overview of the Reporting Features
Predefined Reports
Custom Reports
Building Reports with BIRT
Defining Data Sources
Defining a CentraSite Data Source
Defining a XQuery Data Source
Defining a JDBC Data Source
Building a Data Set with a Data Source
Building a Data Set with a XQuery Data Source
Working with Data Sources and Data Sets
Deploying Reports in CentraSite
Linking Reports to Object Types
Saving Reports to the Eclipse Workspace
Reference
Perspectives
Views
Navigation Views
Administration View
Asset Types View
Impact Analyzer View
My View
Registry Explorer View
Repository Explorer View
List Views
Contents View
Documents View
Search View
Details Editor
Details Editor for Registry Objects
General
Summary
Details Editor for Resources
Attached To
Dialogs and Wizards
Customize Dialog
General Tab (Customize Dialog)
Types Tab (Customize Dialog)
Associations Tab (Customize Dialog)
Implicit References Tab (Customize Dialog)
Edit Dialog
New/Modify Type Wizard
General Page
Attributes Page
Custom Profiles Page
Predefined Profiles Page
Associations
Audit Log
Classifications
External Links
Object-Specific Properties
Permissions
Notifications
Versions
Profile Order Page
New/Modify Attribute Dialog
Data Types in New/Modify Attribute Dialog
New/Modify Profile Dialog
Select Date and Time Dialog
Select Object Dialog
Pages in BIRT
Registry Page
Define Query Page
Specify XQuery Page
Define Table Mapping Page
Define Column Mapping Page
Pages in the Search Dialog
Advanced Search Page
Keyword Search Page
XQuery Page
Customizing Options for the Impact Analyzer
Types
Associations
Controls
Configuration
Search and Filter Conditions
Cloudstreams Development Help
Introduction to webMethods CloudStreams
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
Updating a Connector by importing a new Swagger or OpenAPI specification file (REST only)
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
Software AG Digital Event Services Help
Introduction to Software AG Digital Event Services
Digital Event Services Deprecation
Working with the Event Console
About the Event Console
Configuring the Event Console
Working with the Event Generator
About the Event Generator
Opening the Digital Events Development Perspective
Creating an Event Generator Project
Assigning Event Rules
Running the Event Generator
Creating Additional Event Rate Definitions
Creating Additional Event Rule Definitions
Modifying an Event Generator Project
Creating a Digital Event Generator Run Configuration
Publishing Events to Destination Services
Writing Events to an Event Sequence File
Running an Event Sequence File
Creating an Event Sequence Run Configuration
Exporting an Event Generator Project
Event Value Rule Types
String Event Rules
Boolean Event Rules
Bytes Event Rules
Number Event Rules
Time Event Rules
Array Rule Types
Map Event Rules
Any Event Rules
webMethods Event Processing Help
Introduction to webMethods Event Processing
Event Routing Deprecation
Introduction to Event Type Development
Overview
The Event Type Editor
The Event Type Lookup Path
Use of Relative Paths in the Event Type Definition
Configuring the Event Type Editor Environment
Eclipse Preferences
Working with Integration Server
Restrictions for Working with Integration Server Document Types
Working with Event Types
Overview
Starting the Event Type Editor
Creating Event Type Projects
Creating Event Types
Opening an Existing Event Type
Renaming Event Types
Saving Event Types
Working with Event Type Elements
Overview of Available Event Type Elements
Naming Conventions for Event Type Elements
Adding Event Type Elements
Modifying Properties of Event Type Elements
Viewing the Hierarchical Structure of Event Type Elements
Repositioning Event Type Elements
Renaming Event Type Elements
Deleting Event Type Elements
Publishing Event Types to CentraSite
Overview
Prerequisites for Connecting to CentraSite
Configuring the Connection to CentraSite
Defining the CentraSite Connection Parameters
Setting a CentraSite Configuration as Active
Removing a CentraSite Configuration
Publishing Event Types to CentraSite
Verifying Event Type Is Published
Unpublishing an Event Type in CentraSite
webMethods Service Development Help
Introduction to webMethods 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
Configuring Automatic Reconnection Attempts
Generating Log Information on Designer Connections to Integration Server
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
Refactoring Variable Names in Elements
Guidelines for Refactoring Variables
Refactoring Variables in 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 and Variables
Searching for Elements or Variables via Package Navigator
Guidelines for Searching for Variables in Elements
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
Generating Package Documentation
Viewing Package Attributes and Version Number
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
What Is Cached and Returned?
When Are Cached Results Used?
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
Limiting the Processing of Concurrent Requests for 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
Using Smart Mapping
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
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
OpenAPI-Based Consumer REST API Descriptors
Creating a Consumer REST API Descriptor from an OpenAPI Document
Working with Servers
Viewing the Server Details
Working with Operations
About REST Requests
About REST Responses
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
Encoding IData as XML When Publishing to Universal Messaging
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
XML Schema 1.0 Support in Integration Server
XML Schema 1.1 Support in Integration Server
Supported Features from XML Schema 1.1
Unsupported Features from XML Schema 1.1
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
How Triggers Correspond to Durable Subscribers on Universal Messaging
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 gRPC Descriptors
Overview of gRPC
Support for gRPC in Integration Server
Limitations for gRPC Support
About gRPC Descriptors
Example of a gRPC Service to a gRPC Descriptor
Overview of Building a gRPC Descriptor
Creating a gRPC Provider Descriptor
Guidelines for Working with gRPC Descriptors and Associated Elements
Editing a gRPC Method Flow Service
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 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++/C# Client
Generating C/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 webMethods Cloud Container
Checking the Deployment Status
Asset Repository
Opening the 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
Cloud Deployment 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
Package Status 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 Attributes
Package Dependencies
Patch History
Package Permissions
Package Replication Services
Package Startup/Shutdown Services
Element Properties
Element Information
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
Universal Messaging and webMethods Broker Properties
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
Concurrent Requests Limit Properties
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
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
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
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 Descriptors Created from Legacy REST Resources
webMethods Unit Test Framework Help
Introduction to webMethods Test Suite
Unit Test Framework
Overview
Terms and Concepts
Services
Pipeline
Unit Testing
Test Case
Test Suite
Mock
Service Mock
Exception Mock
Factory Mock
Capabilities
Server Definition
Environment
What it is not
Working with Unit Test Framework
Opening the Unit Test Framework Perspective
Layout
Test Suite Preferences
Advanced
Code Coverage
License
Editor
Validation
Creating a Test Suite
Before You Begin
To Create a Test Suite
Creating a Sample Test Suite
Adding Test Cases
Adding a Test Case
Test Details
Service Details
Inputs
Expected Output
Output Comparison
Generating Tests
Generating Tests Suites using Service Execution Results
Mocks
Using Mocks
Sample Mock Factory
Mocks Beyond Unit Testing
Advanced Options
Pipeline Filter
Comparators
Client Mock Factory
XPath Expressions
Test Suite Internals
Test Suite Internals
Java Unit Tests
Java Unit Tests
Executing Tests
Executing Test Cases
Executing Test Suites
Debugging Java Code
Continuous Integration
Creating a Test Suite Executor
Configuring a Test Suite Executor
Server Information
Project Information
View JUnit Test Results and Code Coverage Reports
Code Coverage Analysis
Running a Coverage Analysis
Viewing Code Coverage Analysis
Viewing Mock Event Details
Defining the Coverage Scope
Coverage Analysis in Headless Mode
Service Usage
WmServiceMock Services
WmServiceMock specification
References
Web Services Stack Help
Introduction to Web Services Stack plug-ins
Overview
About the Web Services Stack Designer Plug-in
Installing the Web Services Stack Plug-in on an Independent Eclipse Installation
Verifying the Installed Web Services Stack Application
Configuring Web Services Stack Preferences
Configuring XML View Preferences
Configuring Message Receivers, User Policies, and Password Callback Handlers
Configuring Message Receivers
Configuring User Policies
Configuring Password Callback Handlers
Configuring Deployment Locations
Configuring SSL Settings
Managing Web Service Packages
Creating Web Service Packages
Using the Web Services Stack Package Builder
Deleting Web Service Packages
Configuring Web Service Packages
Adding Supplementary Source Files to Web Service Packages
Updating the Configuration of Web Services within Web Service Packages
Configuring Web Services Operations within Web Service Packages
Configuring Advanced Policy Settings
Overview
Enabling Web Service Addressing
Enabling Web Service Reliable Messaging
Configuring Web Service Security
Saving Policy Configurations
Deploying and Undeploying Web Service Packages
Overview
Deploying Web Service Packages
Displaying Deployed Web Service Packages
Undeploying Web Service Packages
Publishing and Unpublishing Web Service Packages to CentraSite
Overview
Publishing a Web Service Package
Unpublishing a Web Service Package
Working with Business Console Gadgets
Introduction to Working with Business Console Gadgets
Business Console Deprecation
Getting Started with Business Console Gadgets
About Business Console Gadgets
Creating a New Business Console Gadget
New Business Console Gadget Wizard
Creating a Gadget Application Project
Gadget Definition Editor
Previewing a Gadget in Designer
Viewing a Gadget in a Web Browser
Working with Business Console Gadgets
Importing a Gradle or Apache Maven Based Web Project to Create Gadgets
Creating Gadget User Interfaces for a REST Resource
Creating a webMethods AgileApps Cloud Form Gadget
Copyright
Working with Software AG Designer
Copyright
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
Update_Connector
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_elements_packagenavigator
help_search_guidelines
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_working_with_RAD_openapi_consum
rad_createfrmopenapicon
rad_server_openapiconsum
rad_edit_openapiconsum
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_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
utf_utfperspective_open_Scrn
utf_pref_adv
utf_pref_lic
utf_pref_edi
utf_pref_val
utf.testsuite
utf_testsuite_createScrn
utf_testsuiteScrn
utf_testcase_add
utf_testdetails_viewScrn
utf_testcase_servicedetailsScrn
utf_testcase_inputScrn
utf_testcase_outputScrn
utf_testcase_outputcompareScrn
utf_generatetest_exeresultScrn
utf_mocks_useScrn
utf_exetest_executorScrn
utf_codecoverage_runScrn
utf_codecoverage_viewScrn
utf_mockevents_viewScrn
utf_codecoverage_launchScrn