Administering and Monitoring B2B Transactions
Document Conventions
Online Information and Support
Data Protection
Working with My webMethods
Deprecation of webMethods Broker
Deprecation of webMethods Broker
Logging Into and Logging Out of My webMethods
About Logging Into and Out of My webMethods
Logging Into My webMethods
Logging Out of My webMethods
Changing Your Password
Familiarizing Yourself with My webMethods
My webMethods User Interface
Resizing the Content Area and Navigation Pane
Standard Links
Tabs
Closing Tabs
Displaying a Page When its Tab is Not Visible
Re-arranging the Order of the Tabs
Navigation Pane
Application Selections Available in the Navigate Tab
Monitoring Section of the Navigate Tab
Administration Section of the Navigate Tab
Workspace Selections in the Navigate Tab
Tool Selections in the Tools Tab
Layout Section of the Tools Tab
MWS Monitoring and Diagnostics Section of the Tools Tab
Workspace Tools Section of the Tools Tab
Format of Application Pages
Format of Workspace Pages
Viewing and Updating Your My webMethods Profile
The My webMethods Profile
Identifying Yourself to My webMethods
Exporting Your My webMethods Profile Data
Deleting Your My webMethods Profile
Setting Your User Preferences
My webMethods User Preferences
Calendars
Defining Your Business Calendar
Viewing Your Personal User Calendar
Configuring the Time Zone in My webMethods
Changing the Time Zone in My webMethods
Working with My webMethods Workspaces
About Workspaces
About Creating New Workspaces
Creating New Empty Workspaces
Using “Save As” to Create a New Workspace
Defining the Layout of a Workspace
Opening Workspaces
Workspace Properties
Setting General Properties for a Workspace
Renaming Workspaces
Workspace Sharing
Workspace Sharing Permissions
Sharing Workspaces
Unsharing Workspaces
Closing Workspaces
Deleting Workspaces
About Adding Workspaces to the Navigation Pane
Adding Workspaces to the Navigation Pane
Removing Workspaces from the Navigation Pane
Adding a Workspace Folder to the Navigation Pane
Renaming a Workspace Folder in the Navigation Pane
Removing a Workspace Folder from the Navigation Pane
Working with Workspace Content
About Workspace Content
Adding Tools to a Workspace
Adding Windows from Application Pages to a Workspace
Adding Windows from a Workspace to Another Workspace
General Properties for a Window in a Workspace
Viewing Window Properties
Renaming a Window in a Workspace
Updating the Description of a Window
Finding Windows in a Workspace
Resizing Windows
Positioning Windows in a Workspace
Deleting Windows from a Workspace
Using Tools to Enhance Workspaces
MWS Monitoring and Diagnostics Tools
Workspace Tools
Attachments Tool
Attaching Files to a Workspace
Setting Preferences for an Attachments Window
Updating an Attachment
Removing an Attachment
Bookmarks Tool
Adding Bookmarks to a Workspace
Using the Bookmark Tool to Access Bookmarked Pages
Updating a Bookmark Title or URL
Changing Whether a Bookmark is Opened in the Current or New Window
Deleting Bookmarks
Directory Browser Tool
Adding Directory Browsers to Workspaces
HTML Text Tool
Adding Formatted Text to Workspaces
Updating Existing Formatted Text
Image Tool
Adding an Image to a Workspace
Updating an Image in a Workspace
Note Tool
Adding Simple Notes to a Workspace
Changing the Background Color of a Note
Adding the Last Update Date to a Note
Updating the Text of an Existing Note
User Calendar Tool
Adding Your Calendar to a Workspace
Changing to View Another User’s Calendar
Searching for Users, Groups, and Roles
About Searching for Users, Groups, and Roles
Keyword Searches for Users, Groups, and Roles
Performing a Keyword Search for Users, Groups, or Roles
Advanced Searches for Users and Groups
Performing an Advanced Search for Users or Groups
Searching for Data
About Searching for Data
Keyword Searches for Data
Determining the Fields that Keywords are Searched Against
Performing a Keyword Search for Data
Basic and Advanced Searches for Data
Saving Your Search
Re-executing a Saved Search
Modifying a Saved Search
Deleting a Saved Search
Setting Search Options for a My webMethods Page
Defining How My webMethods Displays Search Results
Sorting the Search Results
Resorting the Search Results
Defining the Number of Search Results Rows to Display Per Page
Setting the Columns to Display and Their Display Order
Working with Search Results
Taking Action Against Items in the Search Results
Taking Action Against Multiple Items in the Search Results
Adding Items
Taking Action Against a Single Item in the Search Results
Adding Search Results to a Workspace
Exporting Search Results to a .csv File
Using Terracotta with webMethods Products
About this Guide
webMethods Products and Terracotta
Overview
Using Terracotta to Create Very Large In-Memory Caches with BigMemory
Using a Terracotta Server Array to Share Cached Data Among Applications
System Caches Used by webMethods Products
How webMethods Products Use Terracotta
Business Process Management
Software AG Common Platform
CentraSite
webMethods CloudStreams
Software AG Command Central
webMethods Event Routing (Deprecated)
webMethods eStandards Modules
webMethods Integration Server
webMethods Mediator
webMethods Mobile Support
webMethods OneData
webMethods Optimize
webMethods Trading Networks
Licensing Requirements
Installing the Terracotta License
License Requirements for Integration Server
Installing and Configuring the Terracotta Server Array for Use with webMethods Products
Installing the Terracotta Server Array
Configuring the Terracotta Server Array for Use with webMethods Product
Creating the tc-config File
Using Command Central to Manage Terracotta
Command Central Commands that Terracotta Supports
Configuration Types that Terracotta Supports
Lifecycle Actions for Terracotta
Run-time Monitoring Statuses for Terracotta
Run-time Monitoring Statuses for Terracotta
System Caches Used by the webMethods Product Suite
Overview
Business Process Management
SoftwareAG.IS.PE.FailedProcessAudit
Software AG Common Platform
SSOAssertionsCacheManager.SSOAssertionsCache
CentraSite
SoftwareAG.CentraSite.model.ObjectCache_machine_name_port
SoftwareAG.CentraSite.model.TypeCache_machine_name_port
webMethods CloudStreams
SoftwareAg.IS.CloudStreams.ClusterStatusCache
SoftwareAg.IS.CloudStreams.CollectionKeysCache
SoftwareAg.IS.CloudStreams.ConsumerApplicationsCache
SoftwareAg.IS.CloudStreams.IntervalNotificationCache
SoftwareAg.IS.CloudStreams.MetricAccumulatorCache
SoftwareAg.IS.CloudStreams.RegisteredConsumerNamesCache
SoftwareAg.IS.CloudStreams.RuntimePolicyCache
SoftwareAg.IS.CloudStreams.VirtualServicesCache
Software AG Command Central
com.softwareag.plm.cce.cache.alert
com.softwareag.plm.cce.cache.attributes
com.softwareag.plm.cce.cache.basicmonitoringstatecached
com.softwareag.plm.cce.cache.configurationDataInfo
com.softwareag.plm.cce.cache.configurationInstanceInfo
com.softwareag.plm.cce.cache.configurationTypeInfo
com.softwareag.plm.cce.cache.environment
com.softwareag.plm.cce.cache.fixInfo
com.softwareag.plm.cce.cache.licenseKeyContainer
com.softwareag.plm.cce.cache.licenseMeteringReport
com.softwareag.plm.cce.cache.licenseMeteringAggregateReport
com.softwareag.plm.cce.cache.licenseMeteringConfigurationAggregationStatus
com.softwareag.plm.cce.cache.licenseMeteringRequiredStatus
com.softwareag.plm.cce.cache.manifest
com.softwareag.plm.cce.cache.node
com.softwareag.plm.cce.cache.platformInfo
com.softwareag.plm.cce.cache.productInfo
com.softwareag.plm.cce.cache.repositories
com.softwareag.plm.cce.cache.runtimeComponentInfo
com.softwareag.plm.cce.cache.runtimeMetadata
webMethods Enterprise Gateway
SoftwareAG.IS.Core.NonceCache
webMethods eStandards Modules
webMethods Module for AS4
SoftwareAG.IS.AS4. Duplicate_Detection
SoftwareAG.IS.AS4. MPC_pmode_map
SoftwareAG.IS.AS4. Default_Cache
webMethods Chem eStandards Module
SoftwareAG.IS.Chem.CHEMModelSessionCache
webMethods ebXML Module
SoftwareAG.IS.ebXML.EBXML
webMethods FIX Module
SoftwareAG.IS.FIX.FIXCache
webMethods Module for HIPAA
SoftwareAG.IS.HIPAA.CodeSourceCache
SoftwareAG.IS.HIPAA.DefaultCache
webMethods RosettaNet Module
SoftwareAG.IS.RosettaNet.RNModelSessionCache
webMethods Event Routing (Deprecated)
eventTypeQName
webMethods Integration Server
SoftwareAG.IS.Core.ActiveOpenIDRequests
SoftwareAG.IS.Core.ClusterMembers
SoftwareAG.IS.Core.IteratorHandles
SoftwareAG.IS.Core.IteratorResults
SoftwareAG.IS.Core.NonceCache
SoftwareAG.IS.Core.OAuthAccessTokens
SoftwareAG.IS.Core.OAuthAuthCodes
SoftwareAG.IS.Core.OAuthClients
SoftwareAG.IS.Core.OAuthRefreshTokens
SoftwareAG.IS.Core.OAuthScope
SoftwareAG.IS.Core.OAuthTokens
SoftwareAG.IS.Core.SessionStore
SoftwareAG.IS.Core.XMLParser.Partitions
SoftwareAG.IS.Services.ServiceResults
webMethods Mediator
SoftwareAg.IS.Mediator.APIKeysCache
SoftwareAG.IS.Mediator.APIPortalCommunicationCache
SoftwareAG.IS.Mediator.ClusterStatusCache
SoftwareAG.IS.Mediator.ConsumerApplicationsCache
SoftwareAG.IS.Mediator.ESCommunicationCache
SoftwareAG.IS.Mediator.IntervalNotificationCache
SoftwareAG.IS.Mediator.MetricAccumulatorCache
SoftwareAG.IS.Mediator.OAuth2TokensCache
SoftwareAG.IS.Mediator.RegisteredConsumerNamesCache
SoftwareAG.IS.Mediator.RuntimeAliasesCache
SoftwareAG.IS.Mediator.RuntimeAliasesServicesAssociationCache
SoftwareAG.IS.Mediator.RuntimePolicyCache
SoftwareAG.IS.Mediator.VirtualServicesCache
webMethods Mobile Support
SoftwareAG.IS.MobileSupport.RecordLocker
webMethods OneData
SoftwareAG.OneData.core.cacheName
webMethods Optimize
Metadata Caches
sag.opt.clusterable.caches.deployed/dimensiondef
sag.opt.clusterable.caches.deployed/dimensiondef-BASE_TYPE
sag.opt.clusterable.caches.deployed/dimensiondef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/dimensiondef-ID
sag.opt.clusterable.caches.deployed/dimensiondef-NAME
sag.opt.clusterable.caches.deployed/dimensionfilter
sag.opt.clusterable.caches.deployed/dimensionjoin
sag.opt.clusterable.caches.deployed/dimensionjoin-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/dimensionjoin-ID
sag.opt.clusterable.caches.deployed/dimensionjoin-NAME
sag.opt.clusterable.caches.deployed/dimensionsubscriber
sag.opt.clusterable.caches.deployed/eventmap
sag.opt.clusterable.caches.deployed/eventmap-BASE_TYPE
sag.opt.clusterable.caches.deployed/eventmap-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/eventmap-ID
sag.opt.clusterable.caches.deployed/eventmap-NAME
sag.opt.clusterable.caches.deployed/hierarchydef
sag.opt.clusterable.caches.deployed/hierarchydef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/hierarchydef-ID
sag.opt.clusterable.caches.deployed/hierarchydef-NAME
sag.opt.clusterable.caches.deployed/ilink
sag.opt.clusterable.caches.deployed/kpidef
sag.opt.clusterable.caches.deployed/kpidef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/kpidef-EVENT_MAP_NAME
sag.opt.clusterable.caches.deployed/kpidef-ID
sag.opt.clusterable.caches.deployed/kpidef-NAME
sag.opt.clusterable.caches.deployed/rule
sag.opt.clusterable.caches.deployed/rule-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/rule-ID
sag.opt.clusterable.caches.deployed/rule-NAME
sag.opt.clusterable.caches.latest/dimensiondef
sag.opt.clusterable.caches.latest/dimensiondef-BASE_TYPE
sag.opt.clusterable.caches.latest/dimensiondef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/dimensiondef-ID
sag.opt.clusterable.caches.latest/dimensiondef-NAME
sag.opt.clusterable.caches.latest/dimensionfilter
sag.opt.clusterable.caches.latest/dimensionjoin
sag.opt.clusterable.caches.latest/dimensionjoin-DISPLAY_NAME
sag.opt.clusterable.caches.latest/dimensionjoin-ID
sag.opt.clusterable.caches.latest/dimensionjoin-NAME
sag.opt.clusterable.caches.latest/dimensionsubscriber
sag.opt.clusterable.caches.latest/eventmap
sag.opt.clusterable.caches.latest/eventmap-BASE_TYPE
sag.opt.clusterable.caches.latest/eventmap-DISPLAY_NAME
sag.opt.clusterable.caches.latest/eventmap-ID
sag.opt.clusterable.caches.latest/eventmap-NAME
sag.opt.clusterable.caches.latest/hierarchydef
sag.opt.clusterable.caches.latest/hierarchydef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/hierarchydef-ID
sag.opt.clusterable.caches.latest/hierarchydef-NAME
sag.opt.clusterable.caches.latest/ilinkdef
sag.opt.clusterable.caches.latest/kpidef
sag.opt.clusterable.caches.latest/kpidef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/kpidef-EVENT_MAP_NAME
sag.opt.clusterable.caches.latest/kpidef-ID
sag.opt.clusterable.caches.latest/kpidef-NAME
sag.opt.clusterable.caches.latest/rule
sag.opt.clusterable.caches.latest/rule-DISPLAY_NAME
sag.opt.clusterable.caches.latest/rule-ID
sag.opt.clusterable.caches.latest/rule-NAME
Operational Caches
sag.opt.clusterable.caches.AcceptedJMSMessageIdsCache
sag.opt.clusterable.caches.deleteAllKPIsCache
sag.opt.clusterable.caches.kpiCompInstStateCache
sag.opt.clusterable.caches.kpiInstStateCache
sag.opt.clusterable.caches.KPIISID2ID_IndexCache
sag.opt.clusterable.caches.kpiLastProcTimeCache
sag.opt.clusterable.caches.kpiLockCache
sag.opt.clusterable.caches.KPIN2IIDS_IndexCache
sag.opt.clusterable.caches.KPIN2MIDS_IndexCache
sag.opt.clusterable.caches.LIID2CIID_IndexCache
sag.opt.clusterable.caches.lockCache
sag.opt.clusterable.caches.metadataDefinitionLoadLockCache
sag.opt.clusterable.caches.metadataOpsLockCache
sag.opt.clusterable.caches.monitorCache
sag.opt.clusterable.caches.monitorChangeInFlightCache
sag.opt.clusterable.caches.monitorLastReadingTimeCache
sag.opt.clusterable.caches.OptAEClusterMemberCache
sag.opt.clusterable.caches.optimizeAlgorithmStateCache
sag.opt.clusterable.caches.optimizeDiagnosesCache
sag.opt.clusterable.caches.optimizeDimensionEnabledStateCache
sag.opt.clusterable.caches.optimizeDimensionIndexByStringIdCache
sag.opt.clusterable.caches.optimizeDimensionOpsCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByDimKeyCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByDimNameCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByIdentityCache
sag.opt.clusterable.caches.optimizeROStatsOpsCache
sag.opt.clusterable.caches.optimizeStatsAccumulationOpsCache
sag.opt.clusterable.caches.OreEvaluatorCache
sag.opt.clusterable.caches.OreEvaluatorIndex_EMID2RIIDS
sag.opt.clusterable.caches.OreEvaluatorIndex_ET2RIIDS
sag.opt.clusterable.caches.OreEvaluatorIndex_KMID2RIIDS
sag.opt.clusterable.caches.OreStubCache
sag.opt.clusterable.caches.OreStubCache_RDID2RIID
sag.opt.clusterable.caches.OreStubCache_RISID2RIID
sag.opt.clusterable.caches.OreStubIndex_EMID2RIIDS
sag.opt.clusterable.caches.OreStubIndex_KMID2RIIDS
sag.opt.clusterable.caches.pt_cluster_member_cache
sag.opt.clusterable.caches.pt_partitionTableCache
sag.opt.clusterable.caches.ScheduledKPIInstanceDeletionJobs
Locally Persistent Operational Caches
sag.opt.eventhandling.caches.EventsForStorage
sag.opt.eventhandling.caches.PendingEventLists
sag.opt.eventhandling.caches.TaskObserver_MessagesCache
sag.opt.eventhandling.caches.TaskObserver_TasksCache
sag.opt.eventhandling.caches.TempEventsForStorage
sag.opt.jmscommunication.caches.JMSCommunicationResendCache
sag.opt.notifications.caches.dimensionDefNotificationsCache
sag.opt.notifications.caches.dimSubscriberNotificationsCache
sag.opt.notifications.caches.eventMapNotificationsCache
sag.opt.notifications.caches.kpiDefNotificationsCache
sag.opt.notifications.caches.monitorChangeNotificationsCache
sag.opt.notifications.caches.ptRoutingTableNotificationsCache
sag.opt.notifications.caches.ruleDefNotificationsCache
webMethods Trading Networks
SoftwareAG.IS.TN.TNDocAttribute
SoftwareAG.IS.TN.TNDocType
SoftwareAG.IS.TN.TNProfile
SoftwareAG.IS.TN.TNProfileId
SoftwareAG.IS.TN.TNProfileSummary
SoftwareAG.IS.TN.TNProfileSummaryByDispName
SoftwareAG.IS.TN.TNQueryResults
SoftwareAG.IS.TN.TNTPA
SoftwareAG.IS.TN.TNTPAId
Trading Networks Administrator's Guide
Understanding webMethods Trading Networks
webMethods Trading Networks
Architecture
Partners in a Trading Network
Understanding the Trading Networks Terminology
Asset Definition
Document Attributes
Document Types
XML Document Types
Flat File Document Types
Processing Rules
Profiles
Overview of Creating Partner Profiles
Overview of the Partner Onboarding Process
TPAs
Business Process Definition
Document Delivery
Immediate Delivery
Scheduled Delivery
Queue Documents for Polling
Document Processing
Error Logging
Document Recognition Errors
Document Processing Errors
Monitoring Transactions
Security
Managing, Authenticating, and Authorizing Trading Networks Users
Protecting Access to User Interfaces
Protecting Partner Profile Passwords
Protecting Access to Trading Networks Processing
Certificates for Verifying, Signing, Encrypting, and Decrypting Documents and Authenticating Connections
Overlapping of Certificates
Verifying Digital Signatures
Digitally Signing Documents
Encrypting and Decrypting Data
Communicating Securely Using SSL
Run-Time Event Notifications
Caching
Dashboards and Charts
Database Partitioning
Getting Started
Before Configuring Trading Networks
Starting the Host Integration Server
Starting Integration Server on Microsoft Windows
Starting Integration Server on UNIX
Starting Integration Server from the Command Line
Shutting Down Integration Server
Planning Your Trading Network
Creating Services and Viewing Specifications
Additional Documentation
Sending Documents to Trading Networks
Sending Documents to Your Trading Networks from Another System
Sending Documents from One Trading Networks to Another
Sending a Document Back to Your Trading Networks
Summary of the Configuration Steps
Using Command Central to Manage Trading Networks
Configuring Trading Networks
Overview
Configuring Database Settings
Configuring a High Availability Environment
Configuring a Cluster to Share a Database
Configuring Multiple Clusters Instances to Share a Database
Configure a Non-Clustered Instance to Each Have Its Own Database
Configuring Trading Networks for MySQL Community Edition 5.7
Configuring Trading Networks for MySQL Enterprise Edition 5.7
Configuring Trading Networks for a Clustered Environment
Configuring E-mail Settings for Document Delivery
Configuring Alias for ActiveTransfer on Remote Server
Configuring Task Settings
Configuring User Status
Configuring Trading Networks to Work with My webMethods
Configuring Integration Server to Use Central User Management
Specifying the SAML Resolver Location
Connecting Trading Networks Servers to My webMethods Server
Configuring the Timeout for Trading Networks Web Services
Configuring Resubmission and Reprocessing Settings
Granting Access to Trading Networks
Overview
Defining Roles
Adding My webMethods Users to the TN Administrators Role
Granting Users Authority to Connect Trading Networks Server Instances to My webMethods
Granting Users Access to Trading Networks Server Instances
Granting Users Authority to Execute Trading Networks Services
Granting Users General Functional Permissions
Granting Users Data Permissions
Defining a Data Set
Granting Data Permissions to a Data Set
Setting Partner Permissions
Removing a Data Set and Its Data Permissions
Removing References to Users
Creating Custom Document Attributes
Create Custom Attributes
Creating XML Document Types
Before You Begin
Obtaining XML Document Samples
Creating IS Schemas
Creating IS Document Types
Creating Custom Transformations for Extracted Attributes
Creating a Service for the Check for Duplicate Document Action
Creating an XML Document Type
Creating and Naming the Document Type
Specifying Criteria for Matching Inbound Documents to the Document Type
Specifying the Root Tag
Specifying the DOCTYPE Identifier
Defining Identifying Queries
Specify Pipeline Variables
Specifying Document Attributes to Extract
Specifying the Attributes
SenderID and ReceiverID System Attributes
DocumentID
UserStatus
GroupID
ConversationID
SignedBody and Signature
Custom Attributes
Indicating Whether the Attribute is Required
Transforming Extracted Attributes
Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes
Built-In Transformations for STRING or STRING LIST Data Type Attributes
Built-In Transformations for NUMBER Data Type Attributes)
Custom Transformation Services
Specifying the Namespace Mapping
Defining Pre-Processing Actions for the Document Type
Format as an IS Document Type Option
Enable Processing Rule Routing Option
Verify Digital Signature Pre-Processing Action
Validate Structure Pre-Processing Action
Check for Duplicate Document Pre-Processing Action
Save Document to Database Pre-Processing Action
Editing an XML Document Types
Testing XML Document Types
Creating Flat File Document Types
Before You Begin
Registering Flat File Content Types
Creating Flat File Schemas
Creating Custom Transformations for Extracted Attributes
Creating a Service for the Verify Signature Action
Creating a Service for the Check for Duplicate Document Action
Creating a Document Gateway Service
Reading the Input Stream
Specifying and Passing the Outputs
DoctypeID or DoctypeName
SenderID and ReceiverID
DocumentID
GroupID
ConversationID
UserStatus
processingRuleID or processingRuleName
$receiveSvc
$contentType and $contentEncoding
Custom Attributes
Pass the Outputs to Trading Networks
Creating a Flat File Document Type
Creating and Naming the Document Type
Specifying Criteria for Matching Inbound Documents to the Document Type
Specifying Attributes to Extract
Specifying the Attributes
SenderID and ReceiverID System Attributes
DocumentID
UserStatus
GroupID
ConversationID
Custom Attributes
Indicating Whether the Attribute is Required
Transforming Extracted Attributes
Built-In Transformations for DATETIME and DATETIME LIST Data Type Attributes
Built-In Transformations for STRING or STRING LIST Data Type Attributes
Built-In Transformations for NUMBER Data Type Attributes
Custom Transformation Services
Defining Pre-Processing Actions for the Document Type
Enable Processing Rule Routing Option
Verify Digital Signature Pre-Processing Action
Validate Structure Pre-Processing Action
Check for Duplicate Document Pre-Processing Action
Save Document to Database Pre-Processing Action
Editing a Flat File Document Type
Preparing for Document Delivery
Overview
Creating Custom Immediate Delivery Services
Creating a Custom Immediate Delivery Service
Retrieving the Document Content to Deliver
Registering the New Delivery Service
Enabling Document Delivery Using a Web Service
Creating Custom Scheduled Delivery Services
Creating a Custom Scheduled Delivery Service
Scheduled Delivery Service Inputs
Scheduled Delivery Service Outputs
Retrieving the Document Content to Deliver
Required Logic to Include in the Scheduled Delivery Service
Typical Logic to Include in the Scheduled Delivery Service
Handling Exceptions
The wm.tn.transport:batchFtp Built-in Service
Registering the New Delivery Service
Adding a Public Queue to Trading Networks
Setting Up the Queue for Polling for webMethods for Partners
Creating Processing Rules
Overview
Before You Begin
Creating a Service for the Check for Duplicate Document Action
Creating a Service for the Execute a Service Action
Using Alert Email Messages
Performing Tasks for the Deliver Document By Action
Creating a Processing Rule
Creating and Naming the Rule
Specifying Criteria for the Rule
Specifying Sender and Receiver Criteria
Specifying Document Type Criteria
Specifying User Status Criteria
Specifying Recognition Error Criteria
Setting Up Extended Criteria for the Rule
Attribute Field
Operator Field
Value Field
Defining Pre-Processing Actions for the Rule
Verify Digital Signature Pre-Processing Action
Validate Structure Pre-Processing Action
Check for Duplicate Document Pre-Processing Action
Save Document to Database Pre-Processing Action
Defining Processing Actions for the Rule
Execute a Service Action
Alert e-Mail Message Action
Email To Field
Subject Field
Mail Body Field
Change User Status Action
Deliver Document By Action
Respond Action
Defining a Processing Rule Based on a Saved Document
Editing the Default Processing Rule
Reordering Processing Rules
Testing the Order of Processing Rules
Deleting a Processing Rule
Onboarding New Partners
Overview
Summary of the Partner Onboarding Process
Uploading Partner Information
Uploading Partner Information from a Spreadsheet
Adding Partner Information Using the Quick Add Feature
Managing Partner Onboarding Templates
Searching for a Template by Name
Adding a New Template
Creating a New Group from an Existing Group
Adding New Fields to an Existing Group
Managing Fields in a Group
Creating a Mapping Service for New Templates
Managing Invitation Emails
Configuring Invitation Emails
Sending Invitation Emails
Managing Partner Invitation Emails
Granting Partners Access to the Questionnaire Page
Approving or Rejecting a Partner
Viewing and Changing the Status of a Partner
Creating Profiles
Overview
Before You Begin
Creating Contact Types
Creating External ID Types
Creating Services for Use with TPAs
Creating a Profile
Creating and Naming a Profile
Adding External IDs to a Profile
Adding Addresses to a Profile
Copying or Sharing Addresses
Adding Contacts to a Profile
Copying or Sharing Contacts
Specifying Document Delivery in a Profile
Adding an Immediate Delivery Method to a Profile
Copying or Sharing Immediate Delivery Methods
Adding Scheduled Delivery Method to a Partner Profile
Specifying Reliable Delivery Settings in a Partner Profile
Specifying Queue for Polling Settings in a Partner Profile
Suspending or Resuming Document Delivery for a Partner
Scheduling a Delivery Suspension
Editing an Ongoing Delivery Suspension Schedule
Canceling an Ongoing Delivery Suspension Schedule
Associate My webMethods User Accounts with a Profile
Adding Security Information
Adding Certificate Sets to a Profile
Adding the Default Certificate Set to a Profile
Adding a Certificate Set to Use with a Specific Partner
Updating Certificate Sets
Updating Certificate Sets for Your Enterprise Profile
Updating Certificate Sets for a Partner Profile
Making Standard Fields Required
Adding Extended Fields to a Profile
Opening a Profile’s Extended Fields
Adding Extended Fields to a Profile
Associating Partners with Partner Groups
Working with TPAs
Defining a TPA
Opening a TPA for Editing
Editing a TPA
Editing a TPA’s Fields
Changing a TPA’s Agreement Status
Deleting a TPA
Deleting a Partner Profile
Finding Partner Certificates that Are Expired or Expiring Soon
Finding Expired Partner Certificates
Finding Partner Certificates that Expire Soon
Managing Partner Access to APIs
Associating Trading Networks with API Gateway
Configuring the API Gateway Property
Viewing the APIs Accessible to a Partner
Viewing the List of APIs of a Partner Group
Providing API Access for a Partner using Partner Profiles
Revoking API Access for a Partner from Partner Profile
Granting Permissions to a User to Access APIs
Providing API Access to a Partner Group
Revoking API Access for a Partner Group
Searching for Assets
Setting Search Options
Searching Using Keywords (Simple Search)
Searching Using Keywords and Filters (Advanced Search)
Improving Trading Networks Performance During Searches
Setting a Limit for Search Results
Deleting Search Results Periodically
Migrating Assets
Overview
Trading Networks Assets You Can Export
Migration Methods
Trading Networks Asset Dependencies
How Trading Networks Detects Assets in the Target System Before Importing Them
Migrating Assets Using webMethods Deployer
Selecting Trading Networks Assets For Export
Building the Exported Assets
Deploy the Assets to Other Servers
Migrating Using My webMethods
Exporting Assets Using My webMethods
Importing Assets Using My webMethods
Migrating Assets Using the tnexport and tnimport Utilities
tnexport Utility
Specifying Export Options on the Command Line
Specifying Export Options in a File
Examples
tnimport Utility
Specifying Import Options on the Command Line
Specifying Import Options in a File
Examples
Archiving and Deleting Documents
About Archiving and Deleting Documents
Setting Up Basic Archive and Deletion
Setting the Number of Days to Retain Documents
Scheduling Archive and Deletion
Setting Up Extended Archive and Deletion
Setting Up Extended Archive and Deletion Using Integration Server
Setting Archive and Deletion Criteria
Scheduling Archive and Deletion
Setting Up Extended Archive and Deletion Using My webMethods
Setting the Archive and Deletion Criteria
Scheduling Archive and Deletion
Setting Up Stored Procedure Archive and Deletion
Scheduling Archive and Deletion
Setting Up Stored Procedure Archive and Deletion Using Integration Server
Setting the Archive and Deletion Criteria
Scheduling Archive and Deletion
Using a Partitioned Database for Archival and Deletion
Database Partitioning
Overview
Partitioning Trading Networks Database
Deleting Run-time Data from a Partitioned Database
Dropping a table in a Partitioned Database
Using a Partitioned Database for Archiving Run-time Data
Deleting Archived Data from a Partitioned Database
Caching Assets and Query Results
Overview
Asset Caching
Query Results Caching
Viewing or Modifying System Cache Settings
Profile Cache Settings
Profile Summary Cache Settings
Profile ID Cache Settings
Document Type Cache Settings
Document Attribute Cache Settings
TPA Cache Settings
TPA ID Cache Settings
Query Results Cache Settings
Managing Events
Overview
Run-Time Events
Event Groups
Configuring Run-time Events
Working with Dashboards and Charts
Overview
Before You Begin
Dashboards
Viewing Dashboards
Charts
Viewing Charts
Monitoring API Usage
Overview
Viewing the API Usage Details of a Partner
Configuration Properties
Introduction
Activity Log Properties
tn.docType.EnableLogDocumentType
tn.partnerOnboarding.EnableLog
tn.procRule.EnableLogProcessingRule
tn.profile.EnableLogProfileChanges
tn.queue.EnableLogQueueStartStop
tn.tpa.EnableLogTPA
Cluster Properties
tn.cluster.notifyCacheChange
tn.cluster.notifyProfileAddUser
tn.cluster.notifyPropertyChange
tn.cluster.sync.remoteAliases
Database Properties
tn.db.log.level
tn.db.readonly
tn.store.encoding
tn.db.TNLocalDateFormat
Database Query Properties
tn.query.maxrows
tn.query.threshold
tn.query.ignoreWildCardSearchCharacters
tn.query.wildCardSearchCharacter
tn.query.timeout
Data Level Security Properties
tn.dls.EnableLogDataSetChanges
Debugging Properties
tn.store.logsql
Document Archiving Properties
tn.archive.archiveAfterDays
tn.archive.batchSize
tn.archive.batchBackoffTime
tn.archive.deleteAfterDays
tn.archive.maxRows
Document Validation Property
tn.doc.validate.max_errs
Document Delivery Properties
tn.delivery.ftpTransferType
tn.mail.from
tn.mail.subject
tn.delivery.active.transfer.server.aliases
Event Properties
tn.eda.events.transactions
tn.eda.events.completedTransactions
tn.eda.events.deliveryTasks
tn.eda.events.serviceExecutionTasks
tn.eda.events.userInitiatedTasks
Flat File Property
tn.ff.contenttypes
Large Document Handling Properties
tn.BigDocThreshold
tn.xml.xqlThreshold
Localization Properties
tn.locale.language
tn.locale.country
tn.locale.variant
Performance Properties
tn.clean.routePipeline
tn.db.fetchMaxRows
tn.db.sortDocTimestamp
tn.doc.saveAsDone
tn.receive.clearTNObjects
tn.receive.clearKeys
tn.store.pool.stmt
tn.resubmit.return.bizdocs
tn.tpa.cacheSize
tn.xml.cacheXQLQueryResults
Profile Properties
tn.default.idType
tn.export.deleted.profiles
tn.api.gateway.server.alias
Task Properties
tn.task.attempt.notPersisted
tn.task.dbupdate.enableNotifications
tn.task.dbupdate.retryEnabled
tn.task.dbupdate.retrySweepTime
tn.task.init.groupSize
tn.task.init.pauseLength
tn.task.maxRetries
tn.task.ttw
tn.task.retryFactor
tn.task.notifyFailure
tn.task.pauseOnMaxThreads
tn.task.sweepTime
tn.task.threadpool.pct
tn.task.orderingMethod
Miscellaneous Properties
tn.chart.fetchMaxRows
tn.check.ambiguous.docs
tn.checkUser.ignoreCase
tn.decimalFormatPattern
tn.eda.events.emittableDocumentAttributeNameFilter
tn.ism.stats.saveFrequency
tn.mail.onuserfail
tn.portal.rule.preventValidation
tn.portal.savetodisk.chunksize
tn.recursion.max
tn.server.seq
tn.transport.user
Server Configuration Parameters
Introduction
Server Configuration Parameters
XQL Reference
XQL Reference Information
Sample XML File
Example XQL Queries
Extracting Custom Attributes From XML Documents
Extracting STRINGLIST or STRING ATTRIBUTES
Extracting NUMBERLIST or NUMBER ATTRIBUTES
Extracting DATETIMELIST or DATETIME ATTRIBUTES
Large Document Handling
Overview
Sending Large XML Documents for Processing
Minimum Hardware Requirements
Size Limit for Delivering Large Documents
Configuring Large Document Handling
Defining Document Types for Large Documents
Creating Services that Recognize Large Document Handling
Determining Where the Document Content is Stored
Retrieving Document Content from Hard Disk Drive Space
Retrieving the Content for Document Delivery
Increasing the Size of the Largest Document that Can Be Saved When Using DB2
Example of User Status in Document Processing
An Example of User Status while Processing a Document
Trading Networks User's Guide
Understanding webMethods Trading Networks
webMethods Trading Networks
Assets and Processing
Documents
Tasks
Logging
Preparing to Work with Documents, Tasks, and Activity Log Entries
Selecting the Database to Work with
Preparing to Search for Documents, Tasks, and Activity Log Entries
Resetting the Local Cache of Trading Networks Information
Finding Documents, Tasks, and Activity Log Entries
Finding Trading Networks Assets
Finding Documents Using a Simple Search
Finding Documents, Tasks, or Activity Log Entries Using a Advanced Search
Document Query Fields
Task Query Fields
Activity Log Query Fields
Managing and Tracking Documents
Working with Attributes, Content, Comments, Tasks, and Activity Log Entries
Viewing Document Attributes and Changing User Status
Working with Document Content
Working with Document Comments
Working with Delivery and Service Execution Tasks
Working with Activity Log Entries
Viewing Related Documents
Resubmitting a Document
Reprocessing a Document
Managing Tasks
Viewing Tasks
Stopping a Task
Restarting a Task
Deleting a Task
Reassigning a Task
Viewing APIs
Overview
Viewing API Details in a Partner Profile
Viewing API Details of Each API Type in a Partner Group
Managing the Activity Log
Viewing Activity Log Entries
Deleting an Activity Log Entry
Trading Networks Built-In Services Reference
Core Services
Overview
Summary of Elements in this Folder
wm.tn:log
wm.tn:receive
wm.tn:reroute
wm.tn:submit
Admin Folder
Overview
Summary of Elements in this Folder
wm.tn.admin:exportData
wm.tn.admin:extendedExportData
wm.tn.admin:extendedImportData
wm.tn.admin:getDBLimits
wm.tn.admin:getDBPoolInfo
wm.tn.admin:getProperties
wm.tn.admin:getStartupErrors
wm.tn.admin:importData
wm.tn.admin:setProperties
Archive Folder
Overview
Summary of Elements in this Folder
wm.tn.archive:archive
wm.tn.archive:extendedArchive
wm.tn.archive:archiveByStoredProc
wm.tn.archive:purgeBizdocUniqueKeysData
wm.tn.archive:purgeEDITrackingData
Charting Folder
Overview
Summary of Elements in this Folder
wm.tn.charting:purgeTransactionSummaryData
wm.tn.charting:populateSummaryData
Delivery Folder
Overview
Summary of Elements in this Folder
wm.tn.delivery:deliver
wm.tn.delivery:getRegisteredService
wm.tn.delivery:getRegisteredServices
wm.tn.delivery:isServiceRegistered
wm.tn.delivery:refreshServiceCache
wm.tn.delivery:registerDefaults
wm.tn.delivery:registerService
wm.tn.delivery:removeService
Dictionary Folder
Overview
Summary of Elements in this Folder
wm.tn.dictionary:addContactType
wm.tn.dictionary:addFieldDefinition
wm.tn.dictionary:addFieldGroup
wm.tn.dictionary:addIDType
wm.tn.dictionary:addProfileGroup
wm.tn.dictionary:changeContactType
wm.tn.dictionary:changeFieldGroup
wm.tn.dictionary:changeIDType
wm.tn.dictionary:changeProfileGroup
wm.tn.dictionary:deleteContactType
wm.tn.dictionary:deleteFieldGroup
wm.tn.dictionary:deleteIDType
wm.tn.dictionary:deleteProfileGroup
wm.tn.dictionary:getBinaryTypes
wm.tn.dictionary:getContactTypes
wm.tn.dictionary:getFieldDefinitions
wm.tn.dictionary:getFieldGroups
wm.tn.dictionary:getIDTypes
wm.tn.dictionary:getProfileGroups
wm.tn.dictionary:updateFieldDefinition
Doc Folder
Overview
Summary of Elements in this Folder
wm.tn.doc:addAttributes
wm.tn.doc:addContentPart
wm.tn.doc:changeStatus
wm.tn.doc:createNewEnvelope
wm.tn.doc:createReply
wm.tn.doc:deleteDocuments
wm.tn.doc:getContentPart
wm.tn.doc:getContentPartData
wm.tn.doc:getDeliveryContent
wm.tn.doc:getEvents
wm.tn.doc:getSenderReceiver
wm.tn.doc:handleLargeDoc
wm.tn.doc:persist
wm.tn.doc:recognize
wm.tn.doc:relateDocuments
wm.tn.doc:replaceContentPart
wm.tn.doc:resubmit
wm.tn.doc:resubmits
wm.tn.doc:setAttribute
wm.tn.doc:sign
wm.tn.doc:updateAttributes
wm.tn.doc:updateComments
wm.tn.doc:updateSystemAttributes
wm.tn.doc:validate
wm.tn.doc:verify
wm.tn.doc:view
wm.tn.doc.viewAll
wm.tn.doc:viewAs
wm.tn.doc.ff:registerContentTypes
wm.tn.doc.ff:routeFlatFile
wm.tn.doc.ff:validate
wm.tn.doc.xml:bizdocToRecord
wm.tn.doc.xml:recordToBizdoc
wm.tn.doc.xml:routeXml
Docattr Folder
Overview
Summary of Elements in this Folder
wm.tn.docattr:add
wm.tn.docattr:disable
wm.tn.docattr:enable
wm.tn.docattr:list
wm.tn.docattr:listTypesForAttribute
wm.tn.docattr:setPersist
wm.tn.docattr:update
wm.tn.docattr:view
Doctype Folder
Overview
Summary of Elements in this Folder
wm.tn.doctype:add
wm.tn.doctype:delete
wm.tn.doctype:disable
wm.tn.doctype:enable
wm.tn.doctype:list
wm.tn.doctype:update
wm.tn.doctype:view
Enumerate Folder
Overview
Summary of Elements in this Folder
wm.tn.enumerate:cancel
wm.tn.enumerate:deleteQueryResults
wm.tn.enumerate:nth
wm.tn.enumerate:unregister
Mime Folder
Overview
Using the MIME Services to Send MIME Messages You Create
Using the MIME Services to Receive MIME Objects
Summary of Elements in this Folder
wm.tn.mime:addBodyPart
wm.tn.mime:addMimeHeader
wm.tn.mime:createCertsOnlyData
wm.tn.mime:createEncryptedData
wm.tn.mime:createMimeData
wm.tn.mime:createSignedAndEncryptedData
wm.tn.mime:createSignedData
wm.tn.mime:getBodyPartContent
wm.tn.mime:getBodyPartHeader
wm.tn.mime:getContentType
wm.tn.mime:getDigest
wm.tn.mime:getMimeHeader
wm.tn.mime:getNumParts
wm.tn.mime:getParameterList
wm.tn.mime:getPrimaryContentType
wm.tn.mime:getSharedInputStream
wm.tn.mime:getSize
wm.tn.mime:getSubContentType
wm.tn.mime:processCertsOnlyData
wm.tn.mime:processEncryptedData
wm.tn.mime:processSignedData
wm.tn.mime:removeHeader
wm.tn.mime:resetMimeHeader
wm.tn.mime:setDigestAlgorithm
wm.tn.mime:sign
wm.tn.mime:verify
wm.tn.mime:writeToStream
Polling Folder
Overview
Summary of Elements in this Folder
wm.tn.polling:acceptDocument
wm.tn.polling:localCheck
wm.tn.polling:remoteCheck
Profile Folder
Overview
Summary of Elements in this Folder
wm.tn.profile:addAddresses
wm.tn.profile:addConnections
wm.tn.profile:addContacts
wm.tn.profile:addIDs
wm.tn.profile:addProfile
wm.tn.profile:addProfileGroups
wm.tn.profile:addUsers
wm.tn.profile:changeStatus
wm.tn.profile:deleteAddress
wm.tn.profile:deleteConnection
wm.tn.profile:deleteConnectionOfPartner
wm.tn.profile:deleteContact
wm.tn.profile:deleteID
wm.tn.profile:deleteProfile
wm.tn.profile:deleteProfileGroup
wm.tn.profile:deleteUser
wm.tn.profile:deleteUsers
wm.tn.profile:getExtendedFields
wm.tn.profile:getExternalID
wm.tn.profile:getExternalIDs
wm.tn.profile:getHostProfile
wm.tn.profile:getInternalID
wm.tn.profile:getInternalIDsByGroup
wm.tn.profile:getInternalIDsForUser
wm.tn.profile:getPartnerBinary
wm.tn.profile:getProfile
wm.tn.profile:getProfileGroups
wm.tn.profile:getProfileMappings
wm.tn.profile:getProfileSummaries
wm.tn.profile:getProfileSummary
wm.tn.profile:getUserProfiles
wm.tn.profile:getUserProfilesSummaries
wm.tn.profile:getUsersForPartner
wm.tn.profile:setExtendedFields
wm.tn.profile:setPartnerBinary
wm.tn.profile:undeleteProfile
wm.tn.profile:updateAddresses
wm.tn.profile:updateConnections
wm.tn.profile:updateContacts
wm.tn.profile:updateCorporation
wm.tn.profile:updateIDs
wm.tn.profile:updateProfileGroups
wm.tn.profile.create:newAddress
wm.tn.profile.create:newContact
wm.tn.profile.create:newDelivery
wm.tn.profile.create:newExtendedFields
wm.tn.profile.create:newExternalID
wm.tn.profile.create:newPrivateQueue
wm.tn.profile.create:newProfile
Query Folder
Overview
Summary of Elements in this Folder
wm.tn.query:createDocumentQuery
wm.tn.query:createEventQuery
wm.tn.query:createProfileQuery
wm.tn.query:createTaskQuery
wm.tn.query:createTPAQuery
wm.tn.query:deliveryServiceDelete
wm.tn.query:deliveryServiceQuery
wm.tn.query:documentQuery
wm.tn.query:doQuery
wm.tn.query:eventDelete
wm.tn.query:eventQuery
wm.tn.query:getQueryResults
wm.tn.query:getSQL
wm.tn.query:profileQuery
wm.tn.query:taskDelete
wm.tn.query:taskQuery
wm.tn.query:tpaQuery
Queuing Folder
Overview
Summary of Elements in this Folder
wm.tn.queuing:deliverBatch
wm.tn.queuing:getQueuedTask
wm.tn.queuing:getRegisteredQueue
wm.tn.queuing:getRegisteredQueues
wm.tn.queuing:listQueuedTasks
wm.tn.queuing:queueDocument
wm.tn.queuing:reassign
wm.tn.queuing:registerQueue
wm.tn.queuing:removeQueue
wm.tn.queuing:updateQueue
wm.tn.queuing:updateQueuedTask
Route Folder
Overview
Summary of Elements in this Folder
wm.tn.route:abort
wm.tn.route:add
wm.tn.route:alert
wm.tn.route:containsRuleName
wm.tn.route:create
wm.tn.route:delete
wm.tn.route:disableDeliveryForPartner
wm.tn.route:getAllMatches
wm.tn.route:getAnyTask
wm.tn.route:getLastChangeID
wm.tn.route:getRule
wm.tn.route:getTask
wm.tn.route:list
wm.tn.route:load
wm.tn.route:mergeFlags
wm.tn.route:preroute
wm.tn.route:route
wm.tn.route:routeBizdoc
wm.tn.route:update
Security Folder
Overview
Summary of Elements in this Folder
wm.tn.security:addCertificateData
wm.tn.security:deleteCertificateData
wm.tn.security:getAllCertificateData
wm.tn.security:getCertificateData
wm.tn.security:getDecryptionKeyAndCert
wm.tn.security:getEncryptionChain
wm.tn.security:getSigningKeyAndChain
wm.tn.security:getSSLKeyAndChain
wm.tn.security:getVerifyingChain
wm.tn.security:queryExpiredCertificates
wm.tn.security:setPrimaryCertificate
wm.tn.security:setSSLKeyAndChain
wm.tn.security:updateCertificate
wm.tn.security:updateCertificateData
Task Folder
Overview
Summary of Elements in this Folder
wm.tn.task:changeServerForTask
wm.tn.task:getAnyTask
wm.tn.task:getTask
wm.tn.task:getTaskOutput
wm.tn.task:getTasks
wm.tn.task:getTaskStatus
wm.tn.task:reassign
wm.tn.task:removeTask
wm.tn.task:restartTask
wm.tn.task:shutdown
wm.tn.task:stopTask
wm.tn.task:updateProperties
TPA Folder
Overview
Summary of Elements in this Folder
wm.tn.tpa:changeStatus
wm.tn.tpa:createTPA
wm.tn.tpa:deleteTPA
wm.tn.tpa:getTPA
wm.tn.tpa:getTPAInLock
wm.tn.tpa:getTPALock
wm.tn.tpa:nextControlNumber
wm.tn.tpa:releaseTPALock
wm.tn.tpa:setLockError
wm.tn.tpa:updateControlNumber
wm.tn.tpa:updateControlNumberInLock
wm.tn.tpa:updateTPA
wm.tn.tpa:updateTPAData
wm.tn.tpa:updateTPADataInLock
wm.tn.tpa:validateTPA
Transport Folder
Overview
Summary of Elements in this Folder
wm.tn.transport:activeTransfer
wm.tn.transport:batchFtp
wm.tn.transport:Ftp
wm.tn.transport:Ftps
wm.tn.transport:Sftp
wm.tn.transport:Http
wm.tn.transport:Https
wm.tn.transport:primaryFtp
wm.tn.transport:primaryFtps
wm.tn.transport:primaryHttp
wm.tn.transport:primaryHttps
wm.tn.transport:primarySmtp
wm.tn.transport:primarySftp
wm.tn.transport:secondaryFtp
wm.tn.transport:secondaryFtps
wm.tn.transport:secondarySftp
wm.tn.transport:secondaryHttp
wm.tn.transport:secondaryHttps
wm.tn.transport:secondarySmtp
wm.tn.transport:Smtp
wm.tn.transport:webService
Util Folder
Overview
Summary of Elements in this Folder
wm.tn.util:longToSqlTimestamp
wm.tn.util:stringListToDateList
wm.tn.util:stringListToDoubleList
wm.tn.util:stringToDate
wm.tn.util:stringToDouble
Service Specifications
Overview
Summary of Specifications
wm.tn.rec:BizDocSigningService
wm.tn.rec:BizDocValidationService
wm.tn.rec:BizDocVerificationService
wm.tn.rec:DeliveryServiceSignature
wm.tn.rec:DupCheckService
wm.tn.rec:ProcessingService
wm.tn.rec:ReliableProcessingService
wm.tn.rec:GatewayService
wm.tn.rec:TPAValidationService
IS Document Types
Summary of Elements in this Folder
Document-Related to IS Document Types
Profile Management IS Document Types
Security-Related IS Document Types
Task Management Service IS Document Types
TPA IS Document Types
Delivery Service IS Document Types
Query-Related IS Document Types
wm.tn.rec:ActivityLogEntry
wm.tn.rec:Address
wm.tn.rec:BizDocAttribute
wm.tn.rec:BizDocContentPart
wm.tn.rec:BizDocContentPartCriteria
wm.tn.rec:BizDocEnvelope
wm.tn.rec:BizDocErrorSet
wm.tn.rec:BizDocType
wm.tn.rec:BizDocTypeSummary
wm.tn.rec:Contact
wm.tn.rec:Corporation
wm.tn.rec:Delivery
wm.tn.rec:DeliveryService
wm.tn.rec:DeliveryServiceOutput
wm.tn.rec:ExternalID
wm.tn.rec:Field
wm.tn.rec:FieldMetaData
wm.tn.rec:activeTransferOutput
wm.tn.rec:FtpDeliveryServiceOutput
wm.tn.rec:FtpOutput
wm.tn.rec:SftpDeliveryServiceOutput
wm.tn.rec:SftpOutput
wm.tn.rec:HttpDeliveryServiceOutput
wm.tn.rec:HttpOutput
wm.tn.rec:PreProcessingFlags
wm.tn.rec:Profile
wm.tn.rec:ProfileSummary
wm.tn.rec:queryField
wm.tn.rec:queryInput
wm.tn.rec:queryOutput
wm.tn.rec:ReliableServiceOutput
wm.tn.rec:SmtpDeliveryServiceOutput
wm.tn.rec:SmtpOutput
wm.tn.rec:svcResponse
wm.tn.rec:Task
wm.tn.rec:TaskDbUpdate
wm.tn.rec:TaskFailure
wm.tn.rec:tpa
wm.tn.rec:tpaError
wm.tn.rec:TPAValidateServiceOutput
wm.tn.rec:WebServiceDeliveryServiceOutput
wm.tn.rec:WebServiceOutput
Java API
webMethods Module for EDI
About this Guide
Document Conventions
Online Information and Support
Data Protection
Installing, Upgrading, and Uninstalling webMethods Module for EDI
Overview
Requirements
Installing Module for EDI
Upgrading the Module for EDI from 9.0 to 9.12
Uninstalling Module for EDI
Before You Begin
Uninstalling Module 9.12 for EDI
Configuring webMethods Module for EDI
Overview
Assigning User-Specific Permissions in My webMethods
Defining Module for EDI Properties
Setting Up Items Required for Structural Validation and Conversion
Configuring Format Services to Convert Field Values
Associating the EDI Format Services with EDI Data Types
Creating Flat File Schemas for Internal-Format Documents
Defining TN EDI Document Types
Step 1: Define Document Type Information
Defining Document Type Information Using My webMethods
Step 2: Define Attributes to be Extracted from Documents
Attributes Stored for TRADACOMS Document Types
Extracting a Document Attribute Using an XQL Query
Examples of Extracting a Document Attribute Using an XQL Query
Step 3: Define Processing Options
Creating a TN EDI Document Type Based on a Transaction
Flat File Schema Namespace Conventions
Flat File Schema Namespace Conventions for Non-TRADACOMS Standards
Flat File Schema Namespace Conventions When Using TRADACOMS
Managing TN EDI Document Types
Viewing the Code List Details
Viewing Alternate Name and Description of Segments
Updating TN EDI Document Types
Updating the Description or Status of a TN EDI Document Type
Updating the Processing Options Specified in the Document Type
Updating a TN EDI Document Type Based on a Transaction
Managing Document Attributes
Adding a Document Attribute
Editing a Document Attribute
Deleting a Document Attribute
Overwriting Document Attributes Extracted from Inbound Documents
EDI Transaction
TA1 Transaction
FA Transaction
Adding New Versions of EDI Standards
Defining Trading Partner Information
Overview
Partner Information You Need to Define
Defining Trading Partner Profiles
Adding External ID Types for EDI ID Qualifiers
Adding and Overriding EDI ID Qualifiers
Defining EDI Trading Partner Agreements
Modifying the Default EDITPA
Defining a Partner-Specific EDITPA
wm.b2b.editn.TPA:EDITPA IS Document Type
GSRouting Variables
PersistMultipleDocEnvelope Variable
processingMode Variable
splitOption Variable
FAReconciliation Variable
UNAmode Variable
publishBatchFailEvent Variable
delimiters Variables
envelopeIdentifier Variables
ICheaderInfo Variables
FAGeneration Variables
ControlNumberManagement Variables
useReverseRoute Variable
BatchCriteria Variables
EDITransportMedia Variable
persistOriginalEnvelope Variable
documentPersistOrder Variable
LateFA Variables
X12TA1Generation Variables
EANCOMAUTACK Variables
Defining Trading Partner Information When Using TRADACOMS
Overview
Partner Information You Need to Define When Using TRADACOMS
Defining Trading Partner Profiles When Using TRADACOMS
External ID Types When Using TRADACOMS
Optionally Configuring the External ID Types When Using TRADACOMS
Defining EDI Trading Partner Agreements When Using TRADACOMS
Modifying the Default EDITPA When Using TRADACOMS
Defining a Partner-Specific EDITPA When Using TRADACOMS
wm.b2b.editn.TPA:EDITPA IS Document Type When Using TRADACOMS
TRADACOM Variables
Storage Options for File Document Types
Errors that Prevent the Splitting of Transmissions
Validation Errors
Invalid File Structure
Defining Control Number Information for Trading Partners
Overview
Managing Control Number Information
Defining How Module for EDI Creates the Control Number Sequence
Adding Entries to the EDIControlNumber Table
Configuring Control Number Settings
Configuring Control Number Settings Using the My webMethods Control Numbers Page
Configuring Control Number Settings Using the My webMethods Partner Profiles Page
Updating Control Number Settings
Turning Inbound Control Number Validation On and Off
Activating Validation for ANSI X12 or UN/EDIFACT Documents
Activating Validation for VDA Documents
Activating Validation for TRADACOMS Documents
Defining Control Number Information for Processing Documents
Defining Control Number Information for Processing Inbound Documents
Defining Control Number Information for Processing Outbound Documents
Defining Actions Module for EDI Can Take for Invalid Control Numbers
Defining How to Handle Invalid Control Numbers for ANSI X12 or UN/EDIFACT Documents
Defining How to Handle Invalid Control Numbers for VDA Documents
Defining How to Handle Invalid Control Numbers for TRADACOMS Documents
Searching for Existing Control Number Settings
Searching for Existing Control Number Settings Using My webMethods
Creating Clients that Send EDI Documents to Integration Server
Overview
Defining the Content Type to Use
Before Creating the Service to Form an EDI Document
Creating the Service the Client Invokes to Handle EDI Documents
Logic to Include in the Service to Form an EDI Document
Validating the Input Internal-Format Document When It Is an IData Object
Adding UN/EDIFACT Envelopes
Validating the EDI Document Envelope
Sending EDI Documents to Integration Server via HTTP
Identifying the Service to Invoke
Logic to Include in the HTTP Client
Example of Input Parameters for the pub.client:http Service
Sending EDI Documents to Integration Server via FTP
Identifying the Service to Invoke
Logic to Include in the FTP Client
Example of Input Parameters for the pub.client:ftp Service
Sending EDI Documents to Integration Server via File Polling
Setting Up File Polling
Identifying the Service to Invoke
Creating Clients that Send EDI Documents to Trading Networks
Overview
Content Type to Use
Content Type for EDI Documents that Do Not Contain Mainframe Data
Content Types for EDI Documents that Contain Mainframe Data
Service the Client Invokes
Sending EDI Documents to Trading Networks via HTTP/S
Example of Input Parameters for the pub.client:http Service
Sending EDI Documents to Trading Networks via FTP
Example of Input Parameters for the pub.client:ftp Service
Sending EDI Documents to Trading Networks via File Polling
Sending EDI Documents to Trading Networks via My webMethods
Using a Service to Send Multiple EDI Documents to Trading Networks
Handling Large Documents When Using Trading Networks
Overview
Configuring Module for EDI for Large Document Handling
Determining When an EDI Document Is Large
Converting Large Documents to IData Objects Iteratively
Troubleshooting Memory Constraint Problems
Generating Acknowledgments
Overview
Generating Functional Acknowledgments
Before You Can Generate a Functional Acknowledgment
Configuring the Maximum Number of Transaction Errors
Determining How Module for EDI Reports FA Status
Determining If the Child Transaction is Allowed in Its Envelope
Determining If a Transaction Is an FA or If a Group Contains an FA
syntaxErrorStatus Parameter
logicalErrorStatus Parameter
childTransactionRejectedStatus Parameter
How Module for EDI Determines Which FA Status to Use
Transaction FA Status
Group FA Status
UN/EDIFACT Interchange FA Status
When to Invoke the generateFA Service
Using a Service that Processes Documents at One Time
Invoking generateFA Before Invoking envelopeProcess
Invoking generateFA Immediately after Invoking envelopeProcess
Using a Service that Processes Documents Iteratively
Output from the generateFA Service
Tracking Late Functional Acknowledgments
Before Tracking Late FAs
Tracking Late FAs
Example
Generating Interchange Acknowledgments
Before Creating the Service to Process EDI Documents
Overview
Inputs to Your Service
Logic to Include in the Service to Process EDI Documents
Determining Which Process Method to Use
Processing the Entire Document at One Time
Performing Envelope Validation and Compliance Checks
Processing the Document Iteratively, Segment by Segment
Customizing the EDI Flat File Schema
Logic for the Service to Process the Document Iteratively
Samples
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks
Overview
Preparing to Receive EDI Documents
Specifying EDITPA Variables that Affect Inbound Processing
Validating the EDIFACT Document Schema
Validating VDA Message Structure
Trading Networks Attributes and EDI Documents
System Attributes that Module for EDI Sets
DocumentID
GroupID
ConversationID
Enabling Extraction of ConversationIDs from an EDI Document
Disabling Extraction of ConversationIDs from EDI Documents
Custom Attributes that Module for EDI Sets
EDI Group Type
EDI Outbound FA
EDI Processing Mode
EDI Status
EDI Version
Envelope CntrlNum Status and Group CntrlNum Status
EDI FA Status
TA1 Status and TA1 Code
Managing Custom Attributes for EDI Documents
Setting the Attribute Values at Run Time
Defining a Processing Rule that Uses Your Custom Attribute as Criteria
Defining Processing Rules to Process Inbound EDI Documents
Specifying Processing Rule Criteria
Specifying Preprocessing Actions
Specifying Processing Actions
Coding Services to Process Transaction and Group Documents
Information in the Pipeline that Your Service Can Access
Logic to Process a Transaction Document
Logic to Process a Group Document when splitOption is Group
Processing Inbound TRADACOMS Documents Using Trading Networks
Overview
Before Setting Up Processing of Inbound EDI Documents When Using TRADACOMS
Specifying EDITPA Variables that Affect Inbound Processing When Using TRADACOMS
Trading Networks Attributes and EDI Documents When Using TRADACOMS
System Attributes that Module for EDI Sets When Using TRADACOMS
DocumentID
GroupID
Custom Attributes that Module for EDI Sets When Using TRADACOMS
Managing Your Own Custom Attributes for EDI Documents When Using TRADACOMS
Setting Attribute Values at Run Time When Using TRADACOMS
Defining a Processing Rule that Uses Your Custom Attribute as Criteria When Using TRADACOMS
Defining Processing Rules to Process Inbound EDI Documents When Using TRADACOMS
Specifying Processing Rule Criteria When Using TRADACOMS
Specifying Preprocessing Actions When Using TRADACOMS
Specifying Processing Actions When Using TRADACOMS
Coding Services to Process File and Batch Documents When Using TRADACOMS
Information in the Pipeline that Your Service Can Access When Using TRADACOMS
Logic to Process a File Document
Logic to Map a File Document to an Internal-Format Document
Optional Inbound Processing When Using Trading Networks
Overview
Validating Inbound Control Numbers
Valid Control Numbers
Invalid Control Numbers
Duplicate Control Numbers
Out-of-Sequence Control Numbers
Performing Control Number Validation
Actions Module for EDI Can Take for Invalid Control Numbers
Error & Continue
Process Normally
Reject
Defining Processing Rules to Handle Documents with Invalid Control Numbers
Setting the EDI Status Custom Attribute for Control Number Validation
Defining the Processing Rule to Handle Documents with Invalid Control Numbers
Reprocessing EDI Documents with Invalid Control Numbers
Reprocessing Documents with Duplicate Control Numbers
Reprocessing Documents with Out-of-Sequence Control Numbers
Creating a Service to Reprocess Documents with Out-of-Sequence Control Numbers
Automatically Generating Functional Acknowledgments
Turning Automatic FA Generation On and Off
Determining How Module for EDI Reports FA Status
Defining FA Statuses as Acceptable and Unacceptable
Defining Actions Module for EDI Takes Based on FA Status
Processing Documents with Acceptable FA Statuses
Processing Documents with Unacceptable FA Statuses
Defining a Processing Rule to Deliver FAs
Defining Processing Rules for Documents with Unacceptable FA Statuses
Automatically Generating Interchange Acknowledgments
Performing Optional Processing of Inbound EDI Documents
Forming EDI Documents to Send Outbound When Using Trading Networks
Overview
Preparing Trading Networks to Process Internal-Format Documents
Creating the Service to Form the EDI Document
Before Creating the Service to Form an EDI Document
Creating the Service
Obtaining Control Numbers for Outbound Processing (ANSI X12 and UN/EDIFACT)
Adding TRADACOMS Envelopes and Obtaining Control Numbers
Delivering the Outbound EDI Document
Delivering the EDI Document Directly from the Service that Forms It
Submitting the EDI Document to Trading Networks
Specifying Variables that Affect Outbound Processing
Specifying Variables that Affect Outbound Processing When Using TRADACOMS
Preparing Trading Networks to Deliver the EDI Document
Adding Logic to the Service that Forms the EDI Document to Submit to Trading Networks
Preparing the Pipeline to Invoke the wm.tn.doc.xml:routeXML Service
Routing the Outbound EDI Document to Trading Networks
Adding Logic to the Service that Forms the EDI Document that Routes through Trading Networks
Creating a BizDocEnvelope for the Outbound EDI Document
Batching EDI Documents
Overview
Indicating How Many Batch EDI Documents to Create
How Documents Are Combined to Create the Batch EDI Document
Extracting Transactions and Sorting the Batched Documents
Sorting Transactions in the Queued Documents
Collection Areas Representing an Interchange in the Final Batch EDI Document
Subcollections Representing a Group in the Final Batch EDI Document
Delimiters Associated with Collection Areas
Example of Sorting Documents
When EDI Documents Have No Interchange or Transmission Header
Sorting Transactions when Queued Documents Have No Interchange Headers
Default Collection Area (Interchange in the Final Batch EDI Document)
Subcollections when there Are No Headers (Groups in the Final Batch EDI Document)
Delimiters Associated with the Default Collection Area
Delimiters Used for the Batch EDI Document
Updating the Task Status and Publishing Documents for Failed Tasks
Recombining the Transactions into the Batch EDI Document
Creating the Batch EDI Document when Using SINGLEOUTPUT
Creating the Batch EDI Document when Using MULTIPLEOUTPUTS
Before You Can Batch EDI Documents
Controlling How the batchProcess Service Forms the Batch Document
EDITPA Variables that the batchProcess Service Uses
EDITPA Variables Used when Sorting Transactions
EDITPA Variables Used when Recombining Transactions
Preparing to Batch EDI Documents
Determining the Number of Queues You Need to Define
Defining the Scheduled Delivery Queues
Defining Processing Rules to Batch EDI Documents
Delivering the Batch EDI Document
Viewing Batched EDI Documents
Retrieving and Delivering EDI Documents from and to VANs
Overview
Preparing to Retrieve Documents from a VAN
Preparing to Deliver Documents to VANs
Defining the Scheduled Delivery Queue
Defining a Processing Rule to Place Documents in the Queue
Handling Conventions Required by Specific VANs
Customizing Built-In Services to Connect to Another VAN
Reconciling Functional Acknowledgments
Overview
FA Reconciliation
Turning FA Reconciliation On or Off
Information Module for EDI Records to Reconcile FAs
FA Statuses
Controlling FA Status for Documents Submitted Multiple Times
Setting FA Status Manually
Viewing Log Information for EDI Documents
Overview
Viewing the Server Log
Viewing the Trading Networks Activity Log
Viewing Information about EDI Documents
Overview
EDI Documents You Can View
Viewing EDI Documents
Trading Networks Processing Status and EDI Documents
Viewing Information about EDI Documents in Queues
Viewing Related Documents with Relationship Labels
Including Documents in a Business Process
Overview
Designing the Process Model
Sample Process Models for ANSI X12
Sample Process Models for UN/EDIFACT
Assigning Conversation IDs to EDI Documents
Instance IDs for Interchange, Group, and Transaction Documents
Instance IDs for Functional Acknowledgments
Sample Business Process
Monitoring Your Business Processes
Non-Standard Processing
Overview
Defining Partner Information When Using Non-Standard Processing
Defining Trading Networks Profiles When Using Non-Standard Processing
Defining a Partner-Specific EDITPA When Using Non-Standard Processing
wm.b2b.editn.TPA:EDITPA IS Document Type When Using Non-Standard Processing
Defining Interchange-Level Sender/Receiver Pair Information
Editing and Deleting Interchange-Level Sender/Receiver Pair Information
Defining Group-Level Sender/Receiver Pair Associations
Querying for Group-Level Sender/Receiver Pair Associations
Defining Control Number Information for Partners When Using Non-Standard Processing
Turning Inbound Control Number Validation On or Off When Using Non-Standard Processing
Defining Actions for Invalid Control Numbers
Defining the Control Number Settings
Processing Inbound EDI Documents using Trading Networks and Non-Standard Processing
Before You Can Process Inbound EDI Documents
Variables that Affect Inbound Processing
Forming EDI Documents to Send Outbound When Using Trading Networks and Non-Standard Processing
Before Creating the Service to Form an EDI Document
Creating the Service When Using Non-Standard Processing
Using Module for EDI Decoupled from Trading Networks
Overview
Using Only the WmEDI Package with Integration Server
Configuring Module for EDI Decoupled from Trading Networks
Preparing Module for EDI Decoupled from Trading Networks
Creating Flat File Schemas for EDI Documents
Creating a Flat File Schema from a SEF File
Creating a Flat File Schema from an IDOC
Forming EDI Documents and Sending Them Outbound
Validating the Input Internal-Format Document When It Is an IData Object
Adding UN/EDIFACT Envelopes
Checking Your Work
Example
webMethods Module for EDIINT
About this Guide
Concepts
What Is EDIINT?
What Is webMethods Module for EDIINT?
Features
AS2-Specific Features
How Module for EDIINT Relates to Other webMethods Components
Features Provided for EDIINT Processing
Inbound EDIINT Processing with AS1 and AS2
EDIINT Client
Processing Inbound EDIINT Documents
Processing Inbound EDIINT MDNs
Outbound EDIINT Processing with AS1 and AS2
Sending Outbound EDIINT Documents
Sending Outbound EDIINT MDNs
Run-Time Processing with EDIINT AS3
Run-Time Processing for Host Partners
Run-Time Processing for Client Partners
Using a Business Process to Send Outbound EDIINT Documents
Installing webMethods Module for EDIINT
Overview
Requirements
Installing Module for EDIINT
Upgrading to Module 8.2 SP1 for EDIINT
Uninstalling Module for EDIINT
Before You Can Transport Documents Using EDIINT
Overview
Including EDIINT Information in Profiles
External IDs Tab of the Profile
Behavior of External ID Matching
Updating Existing Profiles to Use EDIINT AS1, EDIINT AS2, and EDIINT AS3
Using the EDIINT ID Match Option
Delivery Settings Tab of the Profile
Extended Fields Tab of the Profile
Certificates Tab of the Profile
Configuring SMTP Settings to Enable EDIINT Message Exchange
Configuring Inbound EDIINT SMTP Settings
Configuring Outbound EDIINT SMTP Settings
Configuring Your System to Support EDIINT AS3
Creating Directories for Uploading/Downloading
Creating Trading Partner Agreements (TPAs) for AS3 Support
Creating a new TPA
Configuring Where Payloads Are Persisted
Persisting Payloads in Both Trading Networks and the File System
Persisting Payloads in Only the File System
Configuring Whether Trading Networks Is to Process Payloads
Configuring EDIINT Properties
Trading Networks Objects Provided for EDIINT
TN Document Types
Document Attributes
Extended Fields
Processing Rules
Services Invoked by Processing Rules
Restarting AS2 Message Transmission
Invoking the Send Service to Restart Message Transmission
Using EDIINT Properties to Restart Message Transmission
Restarting AS2 Message Transmission Manually
Creating a Client to Submit a Document Using EDIINT
Overview
Content Types to Use
Setting the Input Variables for the wm.EDIINT:send Service
Processing Inbound EDIINT Documents and MDNs
Processing Inbound EDIINT Documents
Before You Can Process Inbound EDIINT Documents
Example of an EDIINT Document Posted by HTTP
Creating Outbound MDNs that Acknowledge Receipt of an EDIINT Document
Setting Up to Process Payloads from EDIINT Documents
How the SMIME Type Profile Field Affects Processing Payloads
Processing Inbound EDIINT MDNs
Before You Can Process Inbound EDIINT MDNs
Example of an EDIINT MDN Posted by HTTP
Using EDIINT to Deliver Outbound Documents
Before You Can Deliver Outbound EDIINT Documents
Setting the SMIME Type of the Outbound EDIINT Document
Using the wm.EDIINT:send Service to Send EDIINT Documents
Viewing and Managing Information About EDIINT Documents and MDNs
Viewing Information about EDIINT Documents and MDNs
Viewing the User Status Associated with a Document
Viewing Related Documents
Resubmitting EDIINT Outbound Transactions
Error Handling
Overview
Message Logging
Error Codes
webMethods Module for EDIINT Services
Overview
Summary of Services in this Folder
wm.EDIINT:purgeFiles
wm.EDIINT:receive
wm.EDIINT:restart
wm.EDIINT:retrieveAS3Message
wm.EDIINT:send
Optimize for B2B User’s Guide
Overview of webMethods Optimize for B2B
Overview
Architecture and Components
Design-Time Actions
How Trading Networks Processes Transaction Data
Stages at Which Events Are Passed to the Broker
Preventing Duplicate Events
Configuring Trading Networks Transaction Data for Optimize for B2B
Overview
Required Permissions for Analyzing Transactional Data
Steps for Configuring Optimize for B2B
Configuring the Java Message Service (JMS) Server
Enabling BAM
Disabling BAM
Configuring TN Document Types and Attributes for BAM
Updating Existing TN Document Types for BAM
Monitoring Trading Networks-Specific Data
Enabling Trading Networks for Monitoring
Enabling Integration Server for Monitoring
Monitoring Multiple Events in Array Lists
Associating an Event Map with Multiple TN Document Types
Working with Software AG MashZone
Working with Trading Networks KPIs
About Viewing Trading Networks KPIs
Viewing Trading Networks KPIs
Using Admin Mode to Delete KPI Instances
Managing File Transfers with ActiveTransfer
Understanding ActiveTransfer
Overview of Managed File Transfer
What Is webMethods ActiveTransfer?
Features of webMethods ActiveTransfer
Typical Usage Scenarios
ActiveTransfer Architecture
The WmMFT Package
The ActiveTransfer OSGi Bundles
The ActiveTransfer Interfaces
How does ActiveTransfer work with Trading Networks?
Failover Support for File Transfer Operations
Inbound File Transfer
Prerequisites to Configuring Failover Support for Inbound File Transfer
How does Failover for an ActiveTransfer Server Work?
ActiveTransfer Server Group
Session Replication
Outbound File Transfer
Session Reuse
Use of Special Characters in Search
Configuring webMethods ActiveTransfer
Before Configuring ActiveTransfer
Summary of Configuration Steps
ActiveTransfer License File
Configuring Database Settings
Configuring a MySQL Community Server Version 5.7 Database
Adding an ActiveTransfer Server Instance to My webMethods
Configuring Timeout for ActiveTransfer Server Web Service Responses
Configuring Session Replication in ActiveTransfer Servers
Replacing the Default SSL Certificate
User Certificate Mapping
Enabling ActiveTransfer Server to Use the User-Certificate Mapping in Integration Server or My webMethods
Verifying the Location of Keystore Files for ActiveTransfer
Managing Proxy Server Aliases
Adding a Proxy Server Alias
Connecting to HTTP(S) Servers
Configuring ActiveTransfer to Send Emails
Configuring the SMTP Server
Configuring Default Email Settings
Configuring the Maximum Number Actions in an Event
Configuring and Managing Acceleration
Configuring Tunnels for Acceleration
Using Acceleration
Accelerating File Transfers Using the ActiveTunnel.jar File
Accelerating File Transfers Using JNLP
Limitations of File Acceleration
Achieving Maximum Throughput for File Transfers using Acceleration
Configuring MashZone NextGen
Setting Up the MashZone NextGen Environment
Connecting MashZone NextGen Server to My webMethods Server
Starting and Stopping ActiveTransfer
Configuring Single Sign-On for ActiveTransfer Web Client through SAML 2.0
Granting Access to ActiveTransfer Pages in My webMethods
Overview
Defining Roles
Adding My webMethods Users to the MFT Administrators Role
Granting a Role the Ability to Access an ActiveTransfer Server Instance
Associating an Existing My webMethods Server Role with ActiveTransfer
Granting or Denying Access to Specific ActiveTransfer Pages in My webMethods
Granting the Authority to Execute ActiveTransfer Services
Preparing to Manage and Monitor ActiveTransfer Server in My webMethods
Overview
Selecting the Instance to Work With
Searching for Items and Managing Search Results
Managing ActiveTransfer Server
Managing ActiveTransfer Ports
Adding a Port
Starting, Stopping, or Restarting a Port
Checking the Status of a Port
Activating or Deactivating a Port
Deleting a Port
Including Port Information in User Emails
Specifying a Keystore File for a Port
Setting Passive FTP Mode for ActiveTransfer Server
Configuring a FTP Port to Support Implicit and Explicit SSL
Configuring an HTTPS Port to Support Single Sign-On
Configuring the Certificate Revocation List for secure ports
Setting the Command Delay Interval
Setting the Encryption Method for ActiveTransfer Server
Setting SSH Encryption Algorithm, Ciphers, and Connection Options
Setting RSA and DSA Encryption
Setting the Supported Ciphers for SSH
Configuring SSH Connection Settings
Setting Throttling Options
Setting Server Restrictions
Banning IP Addresses
Specifying Hammering Settings
Allowing or Denying a Range of IP Addresses
Specifying Encryption Settings
Activating SSL Settings
Managing SSL Ciphers
Activating File-Based Encryption and Decryption
Accelerating Data Transfer
Configuring Miscellaneous Settings
Setting Protocol Options
Setting the Zip Compression Level
Setting Directory Listing Options
Working with Templates
Overview
Adding a Template
Specifying a Default Template
Specifying Throttling Options at the Template Level
Specifying Restrictions at the Template Level
Specifying Time Windows for Server Availability
Specifying File Name Filters
Setting Authentication and Login Restrictions
Setting Connection Restrictions
Specifying Encryption and Decryption Options at the Template Level
Specifying Acceleration Options at the Template Level
Managing Users, User Groups, and User Roles
Overview
Associating an Existing My webMethods Server User with ActiveTransfer
Associating an Existing My webMethods Server User Group with ActiveTransfer
Creating a New User
Viewing and Editing User Details
Associating a User with a Partner or with Your Enterprise
Editing Server Access Details for a User
Emailing Change of Password and Server Port Details
Specifying Throttling Options for a User
Specifying Restrictions for a User
Specifying Time Windows for Server Availability
Specifying File Name Filters
Setting Authentication and Login Restrictions
Setting Connection Restrictions
Specifying Encryption and Decryption Options for a User
Specifying Acceleration Options for a User
Managing Virtual Folders in a Virtual File System
Overview
Managing the Virtual File System in ActiveTransfer
Creating a Virtual Folder
Associating Virtual Folders with a Proxy Server Alias
Searching for Folders, Associated Users, and Associated Partners
Filtering the Virtual Folder List
Deleting a Virtual Folder
Organizing Virtual Folders
Associating a Virtual Folder with a Physical Folder Location
Configuring ActiveTransfer Server for SSL Communication with Remote Servers
Specifying Encryption and Decryption Options for a Virtual Folder
Specifying User Permissions for a Subfolder
User, Group, and Role Permission Propagation in VFS
Specifying User Access Privileges for a Virtual Folder
Specifying User Permissions for a Subfolder
Specifying User Access Privileges in the Parent Folder
Managing Events
About Events
Adding an Event
Adding a Post-Processing Event
Adding a Scheduled Event
Defining Conditions that Trigger an Event
Specifying Conditions for a Post-Processing Event
Specifying Conditions for a Scheduled Event
Defining Actions to Execute when an Event Is Triggered
File Processing in Event Actions
Executing File Operations
Creating a Basic File Operation Action
Finding Files
Copying or Moving Files
Deleting Files
Encrypting and Decrypting Files
Renaming Files
Unzipping Files
Writing Content to a File
Zipping Files
Executing an Integration Server Service
Executing a Script
Executing a Trading Networks Service
Sending Universal Messaging or Broker Notification
Sending an Email Message
Writing File Content to the Database
Jumping to a Designated Action
Excluding Files from an Action
Defining an Error Action
Activating an Event
Activating, Deactivating, and Deleting Multiple Events
Parameterizing Scheduled Event Actions
Additional Information on Parameterizing Event Actions
Parameterizing Scheduled Events to Poll Source URLs and Transfer Files to Destination URLs
Examples of Event Configurations and Actions
Examples for Configuring an Event
Monitoring ActiveTransfer
Overview
Monitoring File Transaction Activity
Defining a File Transaction Filter
Viewing File Transaction Details
Viewing File Transaction Activities
Monitoring Events
Defining an Event Filter
Viewing Event Details
Viewing Event Activities
Viewing ActiveTransfer Analytical Information
Types of Analytical Information
Viewing Analytical Details in My webMethods
Managing and Viewing Log Information
Managing Log Files
Configuring Logging in the Installation Directory
Setting Up Audit Logging from the My webMethods User Interface
Viewing ActiveTransfer Server Logs in My webMethods
Viewing Server Information in My webMethods
Searching for Keywords in ActiveTransfer Server Log
Filtering ActiveTransfer Server Logs for Keywords
Viewing User Information in My webMethods
Viewing Audit Logs in My webMethods
Partitioning the Database
Partitioning the ActiveTransfer Database
Migrating Assets
Overview
ActiveTransfer Assets You Can Migrate
Migration Methods
ActiveTransfer Asset Dependencies
How ActiveTransfer Server Detects Assets on the Target System Before Importing Them
Removing User Data from ActiveTransfer
Removing User Data
Removing PII from the ActiveTransfer Log Files
Removing PII from the ActiveTransfer Database
Removing PII from the My webMethods Server Database
Administering ActiveTransfer with Command Central
Overview
Managing ActiveTransfer Licenses in Command Central
Lifecycle Actions and Statuses of The WmMFT Package
Understanding ActiveTransfer
Overview of webMethods ActiveTransfer
What is webMethods ActiveTransfer?
ActiveTransfer Features
ActiveTransfer Capabilities
Typical Usage Scenarios
Protocols supported by ActiveTransfer
Configuring ActiveTransfer
Accessing ActiveTransfer New User Interface
Configuring Single Sign-On for ActiveTransfer Web Client
Configuring MashZone NextGen
Setting Up the MashZone NextGen Server Environment
Configuring ActiveTransfer to connect to MashZone NextGen Server
Managing Listeners
Overview
Features in Listeners
Adding a Listener
Configuring Additional Settings for a Listener
Activating or Deactivating a Listener
Modifying a Listener
Managing Gateways
Overview
Features in Gateways
Adding a Gateway
Configuring Additional Settings for a Gateway
Modifying a Gateway
Managing Virtual Folders
Overview
Features in Virtual Folders
Adding a Virtual Folder
Configuring Additional Settings for a Virtual Folder
Modifying a Virtual Folder
Searching for Virtual Folders
Managing Actions
Overview
Adding a Post-Processing Action
Adding a Scheduled Action
Adding a Monitor folder Action
Task Configuration Definitions
Find Task Configuration
Copy Task Configuration
Move Task Configuration
Delete Task Configuration
Rename Task Configuration
Encrypt Task Configuration
Decrypt Task Configuration
Zip Task Configuration
Unzip Task Configuration
Write Content Task Configuration
Execute Integration Server Service Task Configuration
Execute Script Task Configuration
Execute Trading Networks Service Task Configuration
Send Universal Messaging/Broker Notification Task Configuration
Send Email Task Configuration
Write File to Database Task Configuration
Jump Task Configuration
Exclude Task Configuration
Error Task Configuration
Activating or Deactivating Actions
Modifying a Post-Processing, Scheduled, or Monitor folder Action
Searching for a Post-Processing, Scheduled, or Monitor folder Action
Managing Users, Roles, Groups, and Templates
Overview
Features in Users, Roles, Groups, and Templates
Creating a New User
Associating an Existing User with ActiveTransfer
Associating an Existing Role with ActiveTransfer
Associating an Existing Group with ActiveTransfer
Configuring Advanced Settings for Users, Roles, and Groups
Modifying a User, Role, or Group
Searching for Users
Searching for Roles
Searching for Groups
Templates
Adding a Template
Configuring Additional Settings for a Template
Modifying a Template
Viewing and Downloading Logs
Overview
Viewing the Transaction Log
Viewing the Action Log
Viewing the Audit Log
Viewing the Analytical Details
Viewing the Agent Action Log
Viewing the Agent Activity Log
Downloading Log Data
Managing Proxy Servers
Overview
Proxy Server Alias Usage Scenarios
Adding Proxy Servers
Managing ActiveTransfer Settings
Overview
Features in ActiveTransfer Global Settings
Configuring Listener Preferences
Acceleration
Adding a Tunnel
Configuring Additional Settings for a Tunnel
Modifying a Tunnel
Configuring Audit Settings
Configuring File Share Settings
Configuring Server Properties
Managing User Interface Permissions for Users, Roles, and Groups
Overview
Configuring UI Permissions to Users, Roles, or Groups
Searching UI Permissions for Users, Roles, or Groups
Archiving Data
Overview
Configuring the Schema/Database for Data Archive
Configuring the ActiveTransferArchive Database Pool
Configuring the ActiveTransfer User Interface for Data Archive
Archiving Data from the ActiveTransfer User Interface
Scheduling Data Archive
Searching for Archived Data
Executing the Stored Procedure for Data Archive
Managing ActiveTransfer Account Settings
Configuring ActiveTransfer Account Settings
Removing User Data from ActiveTransfer
Overview
Removing PII from the ActiveTransfer Log Files
Removing PII from the ActiveTransfer Database
Removing PII from the My webMethods Server Database
Server Configuration Parameters and Variables
Server Configuration Parameters
mft.aliases.tn
mft.client.file.optimizeListing
mft.client.ftp.list.command
mft.client.http.maxUploadSize
mft.client.networkDiscovery.timeout
mft.client.outbound.useProxy
mft.client.session
mft.sftp.port.forward.allow
mft.client.sftp.unmask
mft.db
mft.server.commandcentral
mft.event
mft.group.aliases
mft.http
mft.query.maxrows
mft.never.ban.list
mft.vfs.tree.pagination.depth
mft.vfs.tree.pagination.pageSize
mft.partners.useTNPartners
mft.session.replication
mft.server
mft.server.dmz.cert.hostnames
mft.server.dmz.exclude
mft.server.sftp.alogorithms.keyexchange.exclude
mft.server.sftp.alogorithms.keyexchange.preferred
mft.server.crlUrl
mft.server.gateway.socket.timeout
mft.server.ftp.list.allowEmpty
mft.sharing.account.tempdir
mft.ssl.client
mft.user.email
Security Configuration Parameters
mft.ssl
mft.web.security
Server Variables
General Variables
File Reference Variables
Date/Time Variables
User Variables
Calendar and Processing Options for Scheduled Events
Scheduled Event Options
Date Range
Process Actions Every Time Period
Fixed Interval
Working with Jump Conditions
Overview
Jump Condition Elements
Server Variables
Jump Condition Qualifier
Values for the Server Variables
Defining a Jump Condition
Examples
ActiveTransfer Access Points
Overview
Ports that ActiveTransfer Uses
IP Addresses and Host Names that ActiveTransfer Uses
Products to Which ActiveTransfer Connects
File Paths
Limitations
Limitations
Managing File Transfers with ActiveTransfer Gateway
Understanding ActiveTransfer Gateway
Overview
How ActiveTransfer Gateway Works
Configuring ActiveTransfer Gateway
Before Configuring ActiveTransfer Gateway
Setting Up ActiveTransfer Gateway
Configuring ActiveTransfer Gateway
Configuring an Internal ActiveTransfer Server to Connect to ActiveTransfer Gateway
Managing the ActiveTransfer Gateway Configuration
Viewing and Editing Details for an ActiveTransfer Gateway
Banning IP Addresses
Supporting Virus Scanning with Internet Content Adaptation Protocol
How Does Virus Scan Work?
Memory Configuration for Virus Scanning of Files Exceeding Scan Buffer Size
Configuring Antivirus Scan for Inbound Files
Monitoring File Transaction Status for Virus Scanning
Server Configuration Parameters
Server Configuration Parameters
mft.gatewayServer.port
mft.gatewayServer.accept.ip.list
mft.gateway.is.external.port
mft.gateway.ping.interval
mft.gateway.ping.retry.count
mft.gateway.server.monitor.frequency
ActiveTransfer Built-In Services Reference
Admin Folder
Overview
Summary of Elements in the Admin Folder
wm.mft.admin:archiveData
wm.mft.admin:exportData
wm.mft.admin:importData
wm.mft.admin:property
wm.mft.admin:manageProperties
Asset Folder
Overview
Summary of Elements in the Asset Folder
wm.mft.assets.partner:add
wm.mft.assets.partner:delete
wm.mft.assets.partner:list
wm.mft.assets.partner.syncPartnerProfiles
wm.mft.assets.partner:update
wm.mft.assets.partner:view
wm.mft.assets.port:add
wm.mft.assets.port:delete
wm.mft.assets.port:list
wm.mft.assets.port:start
wm.mft.assets.port:stop
wm.mft.assets.port:update
wm.mft.assets.port:view
wm.mft.assets.postProcessEvent:add
wm.mft.assets.postProcessEvent:delete
wm.mft.assets.postProcessEvent:list
wm.mft.assets.postProcessEvent:update
wm.mft.assets.postProcessEvent:view
wm.mft.assets.scheduledEvent:add
wm.mft.assets.scheduledEvent:delete
wm.mft.assets.scheduledEvent:list
wm.mft.assets.scheduledEvent:update
wm.mft.assets.scheduledEvent:view
wm.mft.assets.monitorFolderAction:add
wm.mft.assets.monitorFolderAction:delete
wm.mft.assets.monitorFolderAction:list
wm.mft.assets.monitorFolderAction:update
wm.mft.assets.monitorFolderAction:view
wm.mft.assets.template:add
wm.mft.assets.template:delete
wm.mft.assets.template:list
wm.mft.assets.template:update
wm.mft.assets.template:view
wm.mft.assets.user:add
wm.mft.assets.user:delete
wm.mft.assets.user:list
wm.mft.assets.user:update
wm.mft.assets.user:view
wm.mft.assets.vfs:add
wm.mft.assets.vfs:changeParent
wm.mft.assets.vfs:delete
wm.mft.assets.vfs:list
wm.mft.assets.vfs:update
wm.mft.assets.vfs:view
Schedule Folder
Overview
Summary of Elements in the Schedule Folder
wm.mft.schedule:createRemoteURL
wm.mft.schedule:executeEvent
Security Folder
Overview
wm.mft.security.pgp:generatePGPKeyFiles
Server Services
Overview
Summary of Elements in Server Folder
wm.mft.server:listBannedIPs
wm.mft.server:unbanIPs
Asset Document Types
Overview
Event Document Types
wm.mft.assets.rec.event.action:Action
wm.mft.assets.rec.event.action.properties:CopyFile
wm.mft.assets.rec.event.action.properties:DecryptFile
wm.mft.assets.rec.event.action.properties:DeleteFile
wm.mft.assets.rec.event.action.properties:EncryptFile
wm.mft.assets.rec.event.action.properties:ExcludeFile
wm.mft.assets.rec.event.action.properties:ExecuteISService
wm.mft.assets.rec.event.action.properties:ExecuteScript
wm.mft.assets.rec.event.action.properties:ExecuteTNService
wm.mft.assets.rec.event.action.properties:FindFile
wm.mft.assets.rec.event.action.properties:Jump
wm.mft.assets.rec.event.action.properties:MoveFile
wm.mft.assets.rec.event.action.properties:RenameFile
wm.mft.assets.rec.event.action.properties:SendBrokerNotification
wm.mft.assets.rec.event.action.properties:SendEmail
wm.mft.assets.rec.event.action.properties:UnzipFile
wm.mft.assets.rec.event.action.properties:WriteFileToDB
wm.mft.assets.rec.event.action.properties:WriteToFile
wm.mft.assets.rec.event.action.properties:ZipFile
wm.mft.assets.rec.event:PostProcessEvent
wm.mft.assets.rec.event:ScheduleCriteria
wm.mft.assets.rec.event:ScheduledEvent
wm.mft.assets.rec.event.scheduleData
wm.mft.assets.rec.event:MonitorFolderAction
Partner Document Type
wm.mft.assets.rec.partner:Partner
Port Document Types
wm.mft.assets.rec.port:FTPDetails
wm.mft.assets.rec.port:HTTPDetails
wm.mft.assets.rec.port:PortInfo
wm.mft.assets.rec.port:SFTPDetails
wm.mft.assets.rec.port:SSLDetails
User Document Types
wm.mft.assets.rec.user:User
wm.mft.assets.rec.user:UserInfo
wm.mft.assets.rec.user:UserTemplate
VFS Document Types
wm.mft.assets.rec.vfs:FTP
wm.mft.assets.rec.vfs:LocalPath
wm.mft.assets.rec.vfs:RemoteVfs
wm.mft.assets.rec.vfs:SFTP
wm.mft.assets.rec.vfs:SSL
wm.mft.assets.rec.vfs:VfsDetails
wm.mft.assets.rec.vfs:VfsInfo
wm.mft.assets.rec.vfs:VfsUser
Service Response Document Type
wm.mft.assets.rec:svcResponse
ActiveTransfer Web Client User's Guide
Understanding ActiveTransfer Web Client
Overview of ActiveTransfer Web Client
Preparing to Work with ActiveTransfer Web Client
Overview
Accessing ActiveTransfer Web Client
Configuring Language Settings for Web Client
Rebranding the ActiveTransfer Web Client
Working with Folders and Files
Overview
Creating a New Folder
Downloading Files and Folders
Changing User Options
Uploading Files and Folders
Cutting, Copying, Pasting, Renaming, and Deleting Folders and Files
Adding Files and Folders to the Basket
Viewing What Is in the Basket
Copying the Folder Link
Sharing Files and Folders
Overview
Sharing Files and Folders
Integration Server Administrator's Guide
About this Guide
The Role of the Administrator
What Does an Administrator Do?
Typical Administrative Responsibilities
The Integration Server Administrator
Receiving Administrative Messages from the Server
The Administrator User
The Administrator's Password
Adding Backup Administrators
An Overview of the Server
The Role of the Server
About Integration Server Instances
Architecture
Services
Retrieving Data for Services
How the Server Executes Services
Integration Server Security
Integration Server Logging
Logging, Data Protection, and Privacy
Integration Server Caching
About Integration Server Fixes
Starting and Stopping the Server
Starting the webMethods Integration Server
Starting an Integration Server Instance on Windows
Starting Integration Server on UNIX
Starting a Server Instance from the Command Prompt
What Happens When You Start the Server?
How to Tell if the Server Is Running Correctly
Running Integration Server as a Windows Application vs. a Windows Service
Switching the Server from a Windows Service to a Windows Application
Switching the Server from a Windows Application to a Windows Service
Increasing File Descriptors on Mac OS X or Other UNIX System
Changing Settings in the Configuration File custom_wrapper.conf
Passing Java System Properties to Integration Server
Shutting Down the Integration Server
Shutting Down the Integration Server from Integration Server Administrator
Shutting Down Integration Server from Windows
Shutting Down Integration Server from the Command Prompt
Viewing Active Sessions
Killing Sessions
Viewing the Integration Server Process ID
Restarting the Integration Server
Server Recovery
Unapplied Changes to Integration Server Configuration Files
Integration Server Data Integrity and Recoverability Considerations
Critical Integration Server Data Files
The Java Service Wrapper
The Java Service Wrapper Configuration Files
JVM Configuration
The Wrapper Log
Logging Properties
Fault Monitoring
Generating a Thread Dump
Running Multiple Integration Server Instances
Overview of Integration Server Instances
Guidelines for Running Multiple Integration Server Instances on the Same Machine
About Creating a New Integration Server Instance
About the is_instance Script
Syntax
is_instance Script Commands
Creating a New Integration Server Instance
Updating an Integration Server Instance
Updating Packages on a Server Instance
Updating Database Properties of a Server Instance
Deleting Packages from a Server Instance
Updating Language Packs on a Server Instance
Deleting a Server Instance
Using the Integration Server Administrator
What Is the Integration Server Administrator?
Starting the Integration Server Administrator
Starting Integration Server Administrator on Windows
Accessing Integration Server Administrator through My webMethods
Basic Operations of Integration Server Administrator
Logging Off Integration Server Administrator
Getting Help
The Server Configuration File
Software AG Command Central
Introduction to the New webMethods Integration Server Administrator
Accessing the New Integration Server Administrator
First Look at the New Integration Server Administrator
Dashboard
Overview
JVM Metrics
Usages
Services
Service Instances
Cache and Prefetch Information
Circuit Breaker Information
APIs
Common Directory Services
Monitoring
Naming and Navigation Changes in the New Integration Server Administrator
Managing Users and Groups
Users and Groups
Purpose of Users and Groups
Defining a User Account
Predefined User Accounts
Adding User Accounts
Deleting User Accounts
Adding an Administrator User
Adding a Developer User
Changing Passwords
Configuring Password Requirements and Expiration Settings
Setting Password Requirements
Setting Password Expiration Requirements
Configuring Account Locking Settings
Unlocking User Accounts
Disabling and Enabling User Accounts
Disabling a User Account
Enabling a User Account
Defining Groups
Predefined Groups
Adding Groups
Adding Users to a Group
Removing Users from a Group
Viewing Group Membership
Removing Groups
Configuring the Server
Viewing and Changing Licensing Information
The License Key
Viewing Licensing Information
Changing Licensing Information
Renewal Reminders
Renewing a Key
Adding Licensed Features
Licensed Sessions
Viewing Active Sessions
Managing the Server Thread Pool
Managing Server Sessions
Setting the Session Timeout Limit
Setting the Stateful Session Limit
Configuring Outbound HTTP Settings
Specifying Outbound HTTP Settings
Setting Up Aliases for Remote Integration Servers
Adding an Alias for a Remote Integration Server
Testing the Connection to a Remote Server
Editing an Alias
Deleting an Alias
Specifying Third-Party Proxy Servers for Outbound Requests
How Integration Server Uses Proxy Servers
Creating a Proxy Server Alias
Editing a Proxy Server Alias
Disabling a Proxy Server Alias
Enabling a Proxy Server Alias
Specifying a Default Proxy Server Alias
Deleting a Proxy Server Alias
Bypassing a Proxy Server
Configuring Where the Integration Server Writes Logging, Status, and Other Information
Switching from the Embedded Database to an External RDBMS
Working with Extended Configuration Settings
Specifying Character Encoding
Configuring the JVM
Specifying the JDK or JRE for Integration Server
Changing the JVM Heap Size Used by Integration Server
Publishing and Retracting Information about Integration Server Assets
Configuring Integration Server to Connect to CentraSite
Testing the Connection to CentraSite
Setting a Port for Remote Client JMX Monitoring
Configuring Integration Server to Accept a Debug Connection During Startup
Using CORS with Integration Server
How Integration Server Handles CORS Requests
Configuring Integration Server to Accept CORS Requests
Connecting Integration Server to Database Components in an External RDBMS
Concepts
Pointing Functions at Connection Pools
Installing the MySQL Community Edition Database Driver
Installing the Tibero JDBC Driver
Creating a Driver Alias Definition
Creating a Connection Pool
Using Kerberos Authentication for Outbound Connections to a Database
Using the Kerberos Re-Authentication Feature
Using a Different Kerberos Ticket Cache File with each JDBC Connection Pool
Configuring Ports
About Ports
Available Port Types
Default Ports
About the Port Alias
Package Associations for Ports
Considerations for Adding Ports
Reasons to Add Additional Ports
Considerations for Configuring Ports
AS/400 Considerations
Bind Addresses
Prerequisites to Configuring a Port for SSL
Port Usage and Security
Adding an HTTP Port
Advanced Controls for HTTP Ports
Editing Advanced Controls
Adding an HTTPS Port
About File Polling Ports
Adding a File Polling Port
Adding an FTPS Port
How Client Authentication Works for FTPS Ports
Adding an FTP Port
Adding an E-Mail Port
Security Considerations for E-Mail Ports
Adding an HTTP Diagnostic Port
Adding an HTTPS Diagnostic Port
Suspending an HTTP/HTTPS Port
Resuming an HTTP/HTTPS Port
Testing for HTTPS Requests
Using an FTP/FTPS Port Range
Specifying an FTP/FTPS Port Range
About the Primary Port
Changing the Primary Port
Deleting a Port
Editing a Port
About Enabling/Disabling a Port
Disabling a Port
Enabling a Port
Configuring How Ports Handle Client Certificates
Adding a Security Provider
Disabling Protocols for JSSE per Port
Designating an HTTP/S Port as Stateless
Setting Up the Server Log
Overview of the Server Log
Specifying Amount and Type of Information to Include in the Server Log
Logging Levels
Specifying Whether to Queue Server Log Entries
Changing the Default Server Log Location
Configuring the Server Log to Rotate Based on Size
Limiting the Number of Server Log Files Kept by Integration Server
Sending Messages About Critical Issues to E-mail Addresses
Performing Additional Processing on Log Entries
Viewing the Server Log
Using an Alternative Server Log Entry Format
Changing the Log Displays
Specifying the Date and Time Format to Use in Log Entries
Displaying Logged Data in Different Languages
Changing the Display Permanently for All Logs
Changing the Display Temporarily for the Server Log
Overriding Logging Level and Server Log Location for a Session
Globalization and the Server Log
The Statistics Log
About the Statistics Log
Viewing the Statistics Log
Server Configuration Parameters that Affect the Statistics Log
Configuring Integration Server for webMethods Messaging
Overview of webMethods Messaging
Working with Messaging Connection Aliases
Predefined Messaging Connection Aliases
Creating a Broker Connection Alias
Creating a Universal Messaging Connection Alias
About Follow the Master for webMethods Messaging
Editing a Messaging Connection Alias
Enabling a Messaging Connection Alias
About Disabling a Message Connection Alias
Disabling a Messaging Connection Alias
Messaging Connection Alias Status
Specifying the Default Messaging Connection Alias
Deleting a Messaging Connection Alias
Authenticating Connections to the Universal Messaging Server
Specifying the Keep-Alive Mode for the Broker Connection
Setting Server Configuration Parameters for Keep-Alive Mode
Normal Mode
Listen Only Mode
Disabled
Synchronizing Broker Clients When the Primary Port for Integration Server Changes
Configuring Document Stores
Configuring the Default Document Store
About the Trigger Document Store
Configuring the Trigger Document Store
Maintaining Inbound Document History for Received Documents
Enabling Inbound Client-Side Queuing
About the Outbound Document Store
Configuring the Rate at which Integration Server Drains the Outbound Document Store
Setting the Capacity of the Outbound Document Store
Associating a User Account with webMethods Messaging Trigger Services
Specifying a User Account for Invoking webMethods Messaging Trigger Services
Load Balancing with a Non-Clustered Group of Integration Servers
Important Considerations for Using a Stateless Cluster with webMethods Messaging
Configuring Integration Server for JMS Messaging
Overview of JMS Messaging Configuration
Working with JNDI Providers
Predefined JNDI Provider Aliases
Creating a JNDI Provider Alias
Editing a JNDI Provider Alias
Deleting a JNDI Provider Alias
Creating a JNDI Provider Failover List
Performing a Test Lookup for a JNDI Provider
JNDI Provider Cache and Timeout Behavior for Administered Objects
Working with JMS Connection Aliases
Connecting to webMethods Broker with the Native webMethods API
Predefined JMS Connection Aliases
Creating a JMS Connection Alias
Allowing Destinations to Be Managed through the JMS Connection Alias and Designer
Allowing Multiple Connections for a JMS Connection Alias
About the Connection Client ID
Creating a Dedicated Listener for Receiving Replies
Configuring Producer Caching for Sending JMS Messages
Configuring Automatic Retry when Sending JMS Messages Using the pub.jms:send Service
About Retrying the pub.jms:send Service when Software AG Universal Messaging Is the JMS Provider
Editing a JMS Connection Alias
Enabling and Disabling a JMS Connection Alias
Deleting a JMS Connection Alias
Specifying a Connection Monitoring Period
Specifying a Retry Interval for Failed Connections
Specifying a Keep-Alive Interval
Creating Administered Objects
Monitoring a Connection Factory Object for Changes
Polling for Changes
Registering an Event Listener
How Integration Server Updates the Connection
Configuring Integration Server to Monitor a Connection Factory Object
Using SSL with JMS
Supported JMS Providers
Considerations for JMS Providers
About Using Software AG Universal Messaging as the JMS Provider
Adding JMS Provider Client Libraries to Integration Server Classpath
Configuring Integration Server for MQTT Messaging
Overview of MQTT Support in Integration Server
Limitations of MQTT Support in Integration Server
Supported MQTT Servers
Creating an MQTT Connection Alias
Editing an MQTT Connection Alias
Enabling and Disabling an MQTT Connection Alias
Deleting an MQTT Connection Alias
Specifying a Retry Interval for Failed Connections to the MQTT Server
Using Enhanced Logging for Messaging
About Enhanced Logging for Messaging
What Is in Log Entries for Enhanced Logging?
Logging Levels for Enhanced Messaging Logging
Using the Messaging Log or the Server Log for Enhanced Logging
Configuring Enhanced Logging for Messaging
Viewing the Messaging Log
Setting Up Universal Messaging Client Logging
Universal Messaging Client Logging
Configuring Universal Messaging Client Logging
View the Universal Messaging Client Log
Configuring Endpoint Aliases for Web Services
About Web Service Endpoint Aliases
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with HTTP/S
Setting a Default Endpoint Alias for Provider Web Service Descriptors
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with HTTP/S
Creating an Endpoint Alias for Message Addressing for Use with HTTP/S
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with JMS
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with JMS
Creating an Endpoint Alias for Message Addressing for Use with JMS
Timestamps in the WS-Security Header
Configuring Reliable Messaging in Integration Server
Overview of Reliable Messaging
Understanding Reliable Messaging Terminology
Using Reliable Messaging in Integration Server
Persistent Storage Support for Reliable Messaging Data
Limitations When Using Reliable Messaging in Integration Server
Configuring Reliable Messaging in Integration Server
Reliable Messaging Sequence Reports
Client and Server Sequences
Viewing Reliable Messaging Sequence Reports
Closing a Sequence
Terminating a Sequence
Sending an Acknowledgement Request
Configuring Integration Server to Use JWT
Overview of JWT
Using JWT with Integration Server
Support for JWT in Integration Server
Configuring Integration Server to use JWT
Trusted Issuers
Adding Trusted Issuers
Deleting a Trusted Issuer
Issuer-Certificate Mapping
Creating an Issuer-Certificate Mapping
Deleting an Issuer Certificate Mapping
Skew Mapping
Creating an Issuer Skew Mapping
Editing Global Claim Settings
Configuring Integration Server to Use Kerberos
Overview of Kerberos Usage in Integration Server
About Kerberos
Kerberos Terminology
Kerberos Delegated Authentication
Prerequisites to Configuring Kerberos
Limitations When Using Kerberos Authentication in Integration Server
Configuring Integration Server to Use Kerberos
Order of Precedence for Principal Name and Password
JAAS Contexts for Kerberos
Troubleshooting Kerberos Configuration
Setting Up HTTP URL Aliases
Overview
Creating an HTTP URL Alias
Specifying the URL Path
Using Port Mappings with a URL Alias
Adding a Port Mapping to a URL Alias
Deleting a Port Mapping for a URL Alias
Using a URL Alias for the “Empty Path”
Creating a URL Alias for the Empty Path
Enabling Partial Matching of URL Aliases
Displaying HTTP URL Aliases
About HTTP URL Alias Association
Editing a URL Alias
Deleting a URL Alias
Portability of URL Aliases and Possible Conflicts
Using HTTP Interceptors
Overview of HTTP Interceptors
Types of HTTP Interceptors
HTTP Interceptor Interfaces
Working of HTTP Interceptors
Considerations for Creating an HTTP Interceptor
Creating an HTTP Interceptor
Configuring Integration Server for HTTP Compression
Overview
HTTP Request Compression
HTTP Response Compression
Configuring Integration Server to Connect to an SFTP Server
Overview of SFTP
Creating an SFTP Server Alias
Editing an SFTP Server Alias
Creating an SFTP User Alias
Editing an SFTP User Alias
Migration Impact on SFTP Configurations
Testing the Connection to the SFTP Server
Configuring Integration Server for Secure Communications
Overview of SSL in Integration Server
Supported SSL Authentication Types
Supported SSL/TLS Protocols
TLSv1.3 Support
Changes to watt.net.jsse* Parameters for Default Disabled Protocols
Disabling TLS Renegotiation
Specifying Cipher Suites for Use with SSL
Preparing to Configure SSL in Integration Server
Creating Public/Private Keys and Certificates for Integration Server
Creating a Keystore and Truststore
Obtaining the Public Keys and Certificates of the Partner Application or Resource
Configuring Integration Server SSL Keys and Certificates
Specifying Integration Server SSL Certificates and Keys
Usage of CA Certificates: Technical Considerations
Handling Expired CA Certificates
Customizing Usage of Truststores
Configuring Integration Server as an SSL Server
Configuring an HTTPS or FTPS Port
Controlling Server SSL Security Level by Port
Configuring Integration Server as an SSL Client
Configuring SSL Information for the Integration Server JVM
Order of Precedence for the javax.net.ssl Properties
Using Multiple Client Certificates with SSL Servers
Setting Up a Remote Server Alias
Coding Your Flow Services
WS-Security and Integration Server
Setting Up SSL Session Logging
Overview of the SSL Session Log
Enabling the SSL Session Logging
Viewing the SSL Session Log
Changing the Default SSL Session Log Location
Managing the SSL Session Log Size
Avoiding Duplicate Entries in the Log
Using Keystores and Truststores with Integration Server
Keystores and Truststores
Keystore File
Keystore File Formats
HSM-Based Keystores
Creating a Keystore
Truststore File
Truststore File Formats
How Integration Server Uses a Keystore and Truststore
Protecting Keystore and Truststore Files
Keystore, Truststore, and Key Aliases
Default Keystore and Truststore Aliases
Creating Keystore Aliases
Creating Truststore Aliases
Controlling Access to Resources
Overview
Controlling Access to Resources by Port
Restricting IP Addresses that Can Connect to a Port
Controlling IP Access to All Ports (Globally)
Allow Inbound Connections from Specified Hosts (Deny All Others)
Deny Inbound Connections from Specified Hosts (Allow All Others)
Allow Inbound Requests from Specified Hosts (Deny All Others)
Deny Inbound Requests from Specified Hosts (Allow All Others)
If You Inadvertently Deny IP Access to All Hosts
Resetting the Global Setting IP Access Setting
Resetting the IP Access Setting for an Individual Port
Restricting the Services or Web Service Descriptors Available from a Port
Allow Access to Specified Services (Deny All Others)
Deny Access to Specified Services (Allow All Others)
Resetting a Port to the Default Access
Controlling the Use of Directives
Controlling Access to Resources with ACLs
About ACLs
Package Replication
Implicit and Explicit Protection
Users that Belong to More than One Group
Predefined ACLs
When Does the Server Perform ACL Checking?
Creating ACLs
Allowing or Denying Group Access to ACLs
Deleting ACLs
Default Settings and Inheritance
What Happens When You Change Existing ACL Assignments
Assigning ACLs to Folders, Services, and Other Elements
Removing an ACL from a Folder or Service
Assigning ACLs to Files the Server Can Serve
Rules for Using .access Files
Removing ACL Protection from a File
Adding Services to a Blacklist
Using a File for the Service Blacklist
Authenticating Clients
Overview
Basic Authentication
Digest Authentication
Kerberos Authentication
Client Certificate Authentication
Certificate Mapping
Importing a Client Certificate and Mapping It to a User
Changing a Certificate Mapping
Client Certificates and Port Configuration
Client Authentication and Access Control
Single Sign-On Authentication for My webMethods
Configuring the MWS Single Sign-On Resource Setting
SAML Authentication
Requirements for SAML Authentication
Identifying Trusted STSs to Integration Server
Accepting SAML2 Tokens at the Transport Level
Customizing Authentication Using JAAS
Overview
Using JAAS with Integration Server
JAAS Configuration File
Pre-installed Login Modules
X509ValidatorModule
Pluggable Authentication Modules (PAMs)
Writing a Custom JAAS Login Module for Integration Server
Extend SagAbstractLoginModule
Implement Commit()
Place the JAR File in the Integration Server Classpath
Modify the JAAS Configuration File
JAAS Custom Login Module Example
JAAS Login Module for Integration Server: Sample Code
JAAS Custom Login Module: Code Explanation
JAAS Configuration File: Sample Module
Master Passwords and Outbound Passwords
Overview
Managing Outbound Passwords
Backing Up Outbound Password and Master Password Files
Changing the Master Password
Changing the Expiration Interval for the Master Password
About the configPassman.cnf File
Working with Outbound Password Settings
Controlling Name and Location of Outbound Password File
Controlling Encryption of Outbound Password File
Working with Master Password Settings
Storing the Master Password in a File
Prompting for the Master Password at Server Initialization
What to Do if You Lose or Forget Your Master Password
When Problems Exist with the Master Password or Outbound Passwords at Startup
Determining Whether You Can Restore the Passwords
Restoring the Master Password and Outbound Password Files
Resetting the Master Password and Outbound Passwords
E-mail Listeners and Package Replication
Securing Integration Server with CSRF Guard
What is CSRF?
How Does Integration Server Prevent CSRF Attacks?
Understanding CSRF Guard Terminology
Configuring CSRF Guard in Integration Server
Limitations when Configuring CSRF Guard in Integration Server
Configuring webMethods Enterprise Gateway
Overview
How Enterprise Gateway Works
Enterprise Gateway Ports
Enterprise Gateway Rules and Alerts
About Enterprise Gateway Rules
About Enterprise Gateway Alerts
Version Interoperability Between Enterprise Gateway Server and Internal Server
Advantages of Enterprise Gateway over Traditional Third-Party Proxy Servers
About Denial of Service Protection
About Trusted IP Addresses
About Mobile Application Protection
About Mobile Data Synchronization
About SQL Injection Protection
About Antivirus Scan Filter
About Custom Filter
Clustering in the Enterprise Gateway Configuration
Setting Up an Enterprise Gateway
Configuring the Enterprise Gateway Ports
Deleting Enterprise Gateway External and Registration Ports
Connecting Your Internal Server to an Enterprise Gateway Server
Viewing Connections to the Enterprise Gateway Registration Port
Performing Client Authentication on Enterprise Gateway Server
Working with Enterprise Gateway Rules
Creating an Enterprise Gateway Rule
Enabling an Enterprise Gateway Rule
Disabling an Enterprise Gateway Rule
Editing an Enterprise Gateway Rule
Copying an Enterprise Gateway Rule
Changing the Priority of an Enterprise Gateway Rule
Deleting an Enterprise Gateway Rule
Specifying Alert Options
Specifying Default Alert Options
Specifying Rule-Specific Alert Options
Preventing Denial of Service Attacks
Limiting Requests Globally
Limiting Requests by IP Address
Controlling Use of Mobile Applications
Frequently Asked Questions about Enterprise Gateway
Configuring OAuth
What Is OAuth?
Using OAuth with Integration Server
Integration Server as an OAuth Client
Integration Server as an Authorization Server
Integration Server as an External Authorization Server
Integration Server as a Resource Server
OAuth Client Types
Authorization Grant Types Supported by Integration Server
Authorization Code Grant
Implicit Grant
Resource Owner Password Credentials Grant
Client Credentials Grant
The Integration Server OAuth Services
Important Considerations for Using OAuth Features
Configuring Integration Server for OAuth
Configuring OAuth Settings
Defining Clients
Registering Clients
Enabling and Disabling Clients
Editing Clients
Deleting Clients
Defining Scopes
Adding a Scope
Editing Scopes
Deleting Scopes
Associating Scopes and Clients
Adding Associations Between Clients and Scopes
Removing Client and Scope Associations
Viewing Associations Between Clients and Scopes
Managing Tokens
Viewing Tokens
Deleting Tokens
Revoking Tokens
Removing Expired Access Tokens
Customizing the Approval Page
About Using Integration Server as the Resource Server
Using an External Authorization Server
Creating an External Authorization Server Alias
Deleting an External Authorization Server
Configuring a Central User Directory or LDAP
Before You Begin
Overview of How Integration Server Works with Externally Defined Users and Groups
How the Server Uses Externally Defined Users and Groups
When the Server Accesses Externally Defined Information
How Integration Server Authenticates Externally Defined Clients
Configuring Central User Management
Requirements for Integration Server to Use Central User Management
Considerations for My webMethods Server Query Roles
Overview of Using LDAP
About LDAP and Caching
Configuring the Server to Use LDAP
Defining an LDAP Directory to Integration Server
Mapping an LDAP User's Access to ACLs
Stopping Use of an LDAP as an External Directory
Considerations for User Accounts and Groups
About Keeping Internal and External User Accounts and Group Names Unique
About User Groups and Package Replication
About Granting Administrator Privileges to External Users
Granting Administrator Privileges to an Externally Defined User
Granting Developer Privileges to External Users
Granting Access to Services and Files to External Users
Managing Packages
Using Packages
Predefined Packages
The Package Repository
Sample Package
How the Server Stores Package Information
Manifest File
Finding Information about Your Packages
Viewing the Packages that Reside on Your Server
Filtering the List of Packages
Refining the Filtered Package List
Determining Whether the Server Successfully Loaded the Package
Determining Whether the Package Is Enabled or Disabled
Displaying Information about a Package
Package Information
Displaying Information about Services and Folders in a Package
Displaying Documentation for a Package
Accessing a Web Document for a Package
Working with Packages
Creating a Package
Activating a Package
Reloading a Package
Enabling a Package
Disabling a Package
Deleting a Package
Recovering a Package
Archiving a Package
Copying Packages from One Server to Another
Overview of Package Replication
Version Checking
Who Can Subscribe?
Guidelines for Using Package Replication
The Publishing Server
Displaying Subscribers for a Specific Package
Displaying Subscribers for all Packages
Adding Subscribers from a Publishing Server
Updating Subscriber Information
Removing Subscribers for a Package
Publishing a Package
Creating a Release
Sending a Release
Specifying File and Version Information for a Release or Archive
The Subscribing Server
Displaying Packages to Which Your Server Subscribes
Manually Pulling a Package
Subscribing to a Package from a Subscribing Server
Requesting a Subscription to a Package from Another Server
Updating Your Subscription Information
Canceling a Subscription
About Installing Packages Published by Another Server
Installing a Package Published by Another Server
Using a Package Class Loader
Hot Deployment of Packages
How Hot Deployment Works
Determining Package Dependencies during Hot Deployment
Considerations for Hot Deployment of Packages
Enabling and Configuring Hot Deployment of Custom Packages
Disabling Hot Deployment of Custom Packages
Automatic Package Deployment
Managing Services
About Services
Fully Qualified Service Names
Package Names and Service Names
HTTP URL Aliases for Services
Finding Information about Services and Folders
Listing Folders and Services
Displaying Information about a Service
Service Information
Manually Adding a Service to the Server
Testing Services
Canceling and Killing Threads Associated with a Service
Canceling or Killing a Thread
Running Services When Packages Are Loaded, Unloaded, or Replicated
What Is a Startup Service?
What Is a Shutdown Service?
What Is a Replication Service?
Guidelines for Using Startup, Shutdown, and Replication Services
Running Services in Response to Specific Events
Managing Global Variables
Creating a Global Variable
Deleting Global Variables
Scheduling Services
Overview
Tasks Provided by Integration Server
Scheduling a User Task
Viewing Scheduled User Tasks
Filtering the List of Scheduled Tasks
Updating Scheduled User Tasks
Suspending User Tasks
Suspending a Single User Task
Suspending All User Tasks
Resuming Suspended User Tasks
Resuming a Suspended User Task
Resuming All Suspended User Tasks
Canceling a Scheduled User Task
Viewing the Scheduled System Tasks
Simple Repeating Option
Complex Repeating Option
Target Node Options
Tasks in a Clustered Environment
How Transitioning to or from Daylight Savings Time Affects Scheduled Tasks
Caching Service Results
What Is Caching?
When Are Cached Results Returned?
Using a Public Cache for Service Results Caching
Resetting the Cache
Resetting the Cache for All Services
Resetting the Cache for a Specific Service
Monitoring Service Cache Usage
Viewing Service Results in a Public Cache
Configuring Guaranteed Delivery
About Guaranteed Delivery
Configuring the Server for Guaranteed Delivery
Settings Shared by Both Inbound and Outbound Transactions
Settings for Inbound Transactions
Settings for Outbound Transactions
Specifying an E-Mail Address and SMTP Server for Error Messages
Using Guaranteed Delivery with Multiple Servers that Share an ISInternal Database
Administering Guaranteed Delivery
Shutting Down Guaranteed Delivery
Reinitializing Guaranteed Delivery
Reinitializing Guaranteed Delivery for Inbound Transactions
Reinitializing Guaranteed Delivery for Outbound Transactions
Configuring Ehcache on Integration Server
What is Ehcache?
Caching Configurations
On-Heap Cache
Local Disk Store
BigMemory
Terracotta Server Array
Understanding Caches and Cache Managers
System Caches
Cache Manager Configuration Files
Specifying the Parameters for a Cache
Dynamic vs. Non-Dynamic Cache Parameters
Installing, Viewing, and Changing the Terracotta License
Determining if You Have a Terracotta License
Adding a Terracotta License
Configuring an On-Heap Cache
Considerations for Configuring On-Heap Cache
Configuring a BigMemory Cache
Allocating Direct Memory Space to Integration Server
Considerations for Configuring BigMemoryCache
Configuring a Distributed Cache
Configuring tc-config.xml on the Terracotta Server Array
Considerations for Configuring a Distributed Cache
Cache-Wide and Client-Specific Parameters for a Distributed Cache
Cache-Wide Parameters
Client-Specific Parameters
The Rejoin Behavior of a Distributed Cache
The Nonstop Behavior of a Distributed Cache
About the Maximum Entries in Cache Value
Making a Cache Searchable
Defining Attributes
Extracting Attributes by Class
Example Extractor
Working with Cache Managers
Creating a Cache Manager
Viewing or Modifying a Cache Manager
Shutting Down a Cache Manager
Starting a Cache Manager
Reloading a Cache Manager
Deleting a Cache Manager
Reinitializing a Cache Manager
Adding a Cache Manager Configuration File to Integration Server
Manually Editing a Cache Manager Configuration File
Working with Caches
Creating a Cache
Viewing or Modifying Cache Settings
Modifying Settings for a Distributed Cache
Disabling a Cache
Enabling a Cache
Clearing a Cache
Deleting a Cache
Logging Ehcache Activity
Logging Ehcache Caching Services
Logging Cache Manager Activity in the Terracotta Server Array
Configuring the Enhanced XML Parser
What Is the Enhanced XML Parser?
How Does the Enhanced XML Parser Work?
When Is the Enhanced XML Parser Used?
What Services Consume an Enhanced Node?
Configuring the Enhanced XML Parser
Setting the Partition Size
Viewing Peak Usage Statistics
Configuring WebSockets
Overview
How WebSocket Works
Setting Up Integration Server for WebSockets
Configuring a WebSocket Ports
Configuring a WebSocketSecure Ports
Viewing WebSocket Server Endpoints for a WebSocket Port
WebSocket Server Sessions Page
Limitations When Using WebSocket Protocol in Integration Server
Locking Administration and Best Practices
Introduction
Choosing Local Server Locking or VCS Integration Locking
Disabling and Re-enabling Locking
Disabling Locking
Re-Enabling Locking
Best Practices
Remote Server Configuration
Server User Names
Package Replication and Publishing
Package and Folder Organization
Source Code
Upgrading webMethods Integration Server
Managing webMethods Messaging Triggers
Introduction
Managing Document Retrieval
Increasing or Decreasing Threads for Document Retrieval from webMethods Broker
When to Increase or Decrease Threads for Retrieving Documents from webMethods Broker
Decreasing the Capacity of Trigger Queues
Decreasing the Capacity and Refill Level for webMethods Messaging Triggers
Suspending and Resuming Document Retrieval
About Suspending and Resuming Document Retrieval for All Triggers
Suspending or Resuming Document Retrieval for All webMethods Messaging Triggers
About Suspending and Resuming Document Retrieval for a Specific Trigger
Suspending or Resuming Document Retrieval for a webMethods Messaging Trigger
Managing Document Processing
Increasing or Decreasing Threads for Processing Documents Received by webMethods Messaging Triggers
When to Increase or Decrease Threads for Processing Documents
Decreasing Document Processing for Concurrent Triggers
Decreasing Execution Threads for Concurrent webMethods Messaging Triggers
Suspending and Resuming Document Processing
About Suspending and Resuming Document Processing for all Triggers
Suspending or Resuming Document Processing for All webMethods Messaging Triggers
About Suspending and Resuming Document Processing for Specific Triggers
Suspending or Resuming Document Processing for a Specific webMethods Messaging Trigger
Limiting Server Threads for webMethods Messaging Triggers
Setting the Maximum Number of Server Threads for webMethods Messaging Triggers
Cluster Synchronization for webMethods Messaging Trigger Management
Configuring Cluster Synchronization
Cluster Synchronization at Run Time
Monitoring Cluster Synchronization
Modifying webMethods Messaging Trigger Properties
Managing Trigger Service Retries and Shutdown Requests
Delaying Polling Requests for webMethods Messaging Triggers
How Integration Server Delays a Polling Request for a webMethods Messaging Trigger
Serial Triggers Migrated to Integration Server 10.3 or Later from Earlier Versions
Synchronizing the webMethods Messaging Trigger and Durable Subscription on Universal Messaging
Managing JMS Triggers
Introduction to JMS Trigger Management
Searching for JMS Triggers
About JMS Trigger Status and State
Enabling, Disabling and Suspending a JMS Trigger
Configuring Integration Server to Enable JMS Triggers Automatically after a Consumer Error
Controlling Thread Usage for JMS Triggers
Viewing Thread Usage for JMS Triggers
Throttling Thread Usage for JMS Triggers
Establishing a Threshold for Using Multiple Threads with a Concurrent JMS Trigger
Configuring Integration Server Session Reuse
Configuring JMS Session Reuse
Delaying Polling Requests for Concurrent JMS Triggers
How JMS Trigger Delays a Polling Request
Examples of Extended Polling Delay Configuration
What Happens When JMS Triggers Fail to Start?
How Does the JMS Trigger Restart Task Work?
About WS Endpoint Triggers
Editing WS Endpoint Triggers
Managing MQTT Triggers
Introduction to MQTT Trigger Management
MQTT Trigger State and Status
Changing the State of an MQTT Trigger
Configuring Integration Server Session Reuse for MQTT Triggers
Automatic Retry for Starting MQTT Triggers
Using a Document History Database with Exactly-Once Processing
Overview
Removing Expired Entries from the Document History Database
Clearing Expired Entries from the Document History Database
Viewing Exactly-Once Processing Statistics
Clearing Exactly-Once Processing Statistics
Using Integration Server to Manage XA Transactions
Overview of XA Transaction Management
How the Integration Server Persists the State of a Transaction
How the Integration Server Resolves Uncompleted Transactions
About Unresolved XA Transactions
Details for an Unresolved XA Transaction
Configuring XA Options in Integration Server
Enabling or Disabling XA Transaction Recovery
Configuring the XA Recovery Store
Configuring XA Server Parameters
Manually Resolving a Transaction
Content Handlers in Integration Server
How Integration Server Uses Content Handlers
How Integration Server Chooses a Content Handler for an HTTP Request
How Integration Server Chooses a Content Handler for an FTP Request
Content Handlers for HTTP and FTP Requests
About Content Handlers for HTTP Responses
Accept Header Field
About Content Handlers for FTP Responses
Class Loading in Integration Server
How Class Loading Works in Integration Server
Class Loaders
OSGi Bundle Class Loader
Integration Server Class Loaders
Classpaths
How the Integration Server Classpath Is Set
Additional Information about How the Microservices Runtime Classpath Is Set
Adding Classes to the Server Classpath
Adding Classes to a Package
Class Searching Order
How Classes Are Found
How Classes Are Found in Microservices Runtime
Searching Order within a Package
Where to Put Your Classes and Jar Files
Accelerating Class Loading
Whitelist Filtering in Integration Server
About Whitelist Filtering in Integration Server
Enabling or Disabling Whitelist Class Filtering
Integration Server Whitelist Classes File
Creating a Package Whitelist Classes File
Logging Classes that Are Not on the Whitelist
Integration Server Blacklist Classes File
Quiescing the Server for Maintenance
Overview
What Happens when Integration Server Enters Quiesce Mode?
What Tasks Can You Perform in Quiesce Mode?
What Happens when Integration Server Exits Quiesce Mode?
Specifying the Quiesce Port
Quiescing Integration Server
Starting the Server in Quiesce Mode from the Command Prompt
Quiescing an Active Server from Integration Server Administrator
Restarting a Server in Quiesce Mode from Integration Server Administrator
Exiting Quiesce Mode
Deploying Quiesce Mode Configuration
Diagnosing the Integration Server
Introduction
Configuring the Diagnostic Port
Diagnostic Thread Pool Configuration
Diagnostic Port Access
Using the Diagnostic Utility
Diagnostic Utility Performance
Running the Diagnostic Utility from Integration Server Administrator
Running the Diagnostic Utility Service
Starting the Integration Server in Safe Mode
Starting Integration Server in Safe Mode
When the Server Automatically Places You in Safe Mode
Generating Thread Dumps
Generating a Dump of an Individual Thread
Generating a Dump of the JVM
Debugging Service Exceptions Using the Error Log
Introduction
Controlling the Level of Exception Logging Detail
Displaying the Error Log
Interpreting the Error Log
Understanding the Service Stack
Understanding the Error Messages
Understanding the Stack Trace
Using Integration Server with Docker
Overview of Docker and Integration Server
Recommendations for Using Integration Server with Docker
About the is_container Script
is_container Script Commands
Prerequisites for Building a Docker Image
Specifying Services to Expose to Consumers in webMethods Cloud
Building the Docker Image for an Integration Server Instance
Loading a Docker Image to an On-Premise Docker Registry
Pushing a Docker Image to an On-Premise Docker Registry
Running the Docker Image in an On-Premise Docker Container
Writing the Server Log to the Console
Writing Audit Logs to the Console
Accessing an Integration Server Running in a Docker Container
Externalizing Log and Configuration Files When Running Integration Server in a Docker Container
Pushing the Docker Image to Integration Cloud
Running the Docker Image in Integration Cloud
Stopping a Docker Container for Integration Server
Using a Configuration Variables Template with a Docker Image
Integration Server Administrator API
Introduction to the Administrator API
Authentication and Authorization
REST URL Structure
CRUD Operations
Administrative Actions
Credentials
Expanding Responses
Media Type for Responses
Media Type for Request Payloads
Getting Started
Controlling Access to the Administrator API
Creating a Read-Only Administrators Group
Logging Client Errors
Including a Stack Trace in the Response Body
Integration Server Administrator API Operations
Controlling JSON Output
Controlling Date Encoding in JSON Responses
Formatting JSON Output to Make it More Readable
Using Command Central to Manage Integration Server
An Overview of Command Central
Integration Server Instance Management
Creating Instances Using Command Central Web User Interface
Updating Instances Using Command Central Web User Interface
Deleting Instances Using Command Central Web User Interface
Managing Instances Using the Command Central Instance Management Commands
Accessing Integration Server Administrator through Command Central
Changing the Authentication Mode
Changing the Administrator User Password for Integration Server in Command Central
Configuring Integration Server for SSL Connection
Monitoring Integration Server Instances
Run-time Monitoring Statuses for IntegrationServer-instanceName
Run-time Monitoring States for IntegrationServer-instanceName
Monitoring KPIs of Integration Server Instances
Integration Server Configuration Types
Configuration Types that IntegrationServer-instanceName Supports
Working with Integration Server Configuration Types
Lifecycle Actions for Integration Server
Commands that Integration Server Supports
Using Unix Shell Scripts to Change Connection Credentials for Managed Products
Command Central Command Line Tool Upgrade
Integration Server Deployment Checklist
Introduction
Stage 1: Installation
Stage 2: Basic Configuration
Stage 3: Setting Up Users, Groups, and ACLs
Stage 4: Publishing Packages
Stage 5: Installing Run-Time Classes
Stage 6: Preparing Clients for Communication with the Server
Stage 7: Setting Up Security
Stage 8: Startup and Test
Stage 9: Archive Sources
Server Configuration Parameters
Introduction
watt.adapters.
watt.adminapi.
watt.art.
watt.broker.
watt.brokerCoder.
watt.cachedirective.
watt.cds.
watt.config.
watt.core.
watt.debug.
watt.debug2.
watt.frag.
watt.infradc.
watt.net.
watt.security.
watt.server.
watt.serverlog.
watt.ssh.
watt.ssl.
watt.tx.
watt.um
watt.wm.tnextdc.
watt.wmcloud.
Environment Variables
Environment Variables Defined in Integration Server and Microservices Runtime
FIPS 140-2 Compliance
FIPS 140-2 Compliance
Using NTLM Authentication when Integration Server Acts as the Client
Overview
Using Java-Based NTLM Support
Using Native NTLM Support via Integrated Windows Authentication
Activating Integrated Windows Authentication
Deactivating Integrated Windows Authentication
Removing User Data from Integration Server
Removing User Data
Removing References to a User Account
Removing References to Email Addresses
Removing Personal Data from Log Files
Removing Personally Identifiable Information from the Server Log
Removing Personally Identifiable Information from the Session Log
Removing Personally Identifiable Information from the Service Log
Removing Personally Identifiable Information from the Security Log
Removing Personally Identifiable Information from the SSL Session Log
Removing Personally Identifiable Information from the Configuration Variables Log
Removing Personally Identifiable Information Logged by Axis2, Kerberos, SAML, and other Third Party Libraries
Wireless Communication with the Integration Server
Overview
How Does the Integration Server Communicate with Wireless Devices?
Using URLs for Wireless Access to the Integration Server
Invoking a Service with a URL
Requesting a WML or HDML Page with a URL
WML and HDML Samples
Masking Session IDs in Integration Server Session and Server Logs
Server Log Facilities
About Server Log Facilities
Integration Server
WmJSONAPI Package
WmParquet Package
WmXSLT Package
Flat File
Service Development Help
About webMethods Service Development
Before You Use Designer for Service Development
Opening the Service Development Perspective
Working with webMethods Integration Server
Working with Server Definitions
Creating Server Definitions
Fetching Server Definitions from an Integration Server
Importing Server Definitions
Exporting Server Definitions
Removing Server Definitions
Editing Server Definitions
Considerations for Process Development
Setting a Default Server Definition
Placing a Server Definition Offline
Bringing a Server Definition Online
Connecting to an Integration Server
Connecting to an Integration Server through Preferences
Disconnecting from an Integration Server
Disconnecting from an Integration Server via Preferences
Refreshing an Integration Server
Notification of Server Shutdown
Opening Integration Server Administrator
Viewing Integration Server Properties
Changing Passwords
Changing Your Password
Synchronizing Passwords
Working with Elements
About Element Names
Package Names and Element Names
Creating New Elements
Guidelines for Naming Elements
Guidelines for Working with Elements
Opening Elements
Closing Elements
Editing and Saving Elements
Adding Comments for an Element
Configuring Dependency Checking for Elements
Controlling the Reuse of Elements Published to CentraSite
Allowing Editing of Derived Elements
Moving and Copying Elements
Guidelines for Moving and Copying All Types of Elements
Guidelines for Moving and Copying Services
Guidelines for Copying Elements Between Servers
Notes for Moving and Copying Adapter Notifications and Related Elements
Renaming Elements
Guidelines for Refactoring Elements
Refactoring Elements
Deleting Elements
Finding Dependents and References
What Is a Dependent?
Finding Dependents
What Is a Reference?
Finding References
Inspecting Pipeline References
Inspecting Pipeline References
Finding Elements
Guidelines for Searching Elements
Searching for Elements in Package Navigator
Performing a Quick Search of Elements in Package Navigator
Locating Invoked Services
Locating Referenced Document Types
Linking Open Editors
Filtering Displayed Elements
Hiding or Displaying Automatically Generated Flow Services
Creating Working Sets
Caching Elements
Clearing the Designer Cache
Exporting Elements
Viewing Server Files for an Element
Using Property Templates with Elements
Creating Property Templates
Applying Property Templates to Elements
Editing Property Templates
Deleting Property Templates
Importing Property Templates
Exporting Property Templates
Assigning and Managing Permissions for Elements
What Is an ACL?
What Happens When a Client Runs a Service with ACLs?
Is ACL Usage Required?
Creating ACLs
ACLs and Inheritance
Default ACLs and Inheritance
Assigning ACLs
Viewing ACL Information for a Server
ACLs and Locking
ACLs and Running/Debugging Services
ACLs and Creating, Viewing, and Deleting Elements
Troubleshooting ACL Usage
Locking and Unlocking Elements
What Is a Lock?
About Locking Elements
Locking Elements in Designer
Guidelines for Locking Java and C/C++ Services
Guidelines for Locking Templates
System Locking Elements
Viewing the Status of Locked Elements
Viewing Lock Status of Elements
Listing All of Your Locked Elements
Copying, Moving, or Deleting Locked Elements
Unlocking Elements
Unlocking Elements in Designer
Automatically Unlocking an Element Upon Saving
Troubleshooting
Lock and Unlock Problems
Package Management Problems
Save Problems
Other Problems
Frequently Asked Questions
Using the Local Service Development Feature
About the Local Service Development Workflow
Supported Platforms and Eclipse Plug-ins
Supported Elements
Supported and Unsupported Actions
Prerequisites
Permissions and Locking
Permissions
System Locking and Local Service Development
Setting the Local Development Server
Creating a Local Service Development Project
Adding Folders and Elements to the VCS
Modifying Packages, Folders, or Elements in the VCS
Checking Out an Element from the VCS
Checking In Packages and Element to the VCS
Getting the Latest Version from the VCS
Getting a Specific Version from the VCS
Copying Packages from the VCS to Integration Server
Reloading a Package
Comparing Revisions of an Element
Building Java and C Services
Deleting a Package Associated with a Local Service Development Project
Deleting a Local Service Development Project
Managing Packages
Creating a Package
Guidelines for Naming Packages
Documenting a Package
Accessing Package Documentation
Viewing Package Settings, Version Number, and Patch History
Assigning a Version Number to a Package
About Copying Packages Between Servers
Copying Packages
Reloading a Package
Comparing Packages
Deleting a Package
Exporting a Package
About Package Dependencies
Identifying Package Dependencies
Removing Package Dependencies
Assigning Startup, Shutdown, and Replication Services to a Package
What Is a Startup Service?
Assigning a Startup Service
Removing a Startup Service
What Is a Shut Down Service?
Assigning a Shutdown Service
Removing a Shutdown Service
What Is a Replication Service?
Assigning a Replication Service
Removing a Replication Service
Building Services
A Process Overview
Package and Folder Requirements
About the Service Signature
Guidelines for Specifying Input Parameters
Guidelines for Specifying Output Parameters
Declaring Input and Output Parameters
Using a Specification as a Service Signature
Using an IS Document Type to Specify Service Input or Output Parameters
Inserting Input and Output Parameters
About Service Run-Time Parameters
Maintaining the State of Service
Specifying the Run-Time State for a Service
About Service Caching
When Are Cached Results Returned?
Types of Services to Cache
Controlling a Service’s Use of Cache
Specifying the Duration of Cached Results
Refreshing Service Cache by Using the Prefetch Option
Configuring Caching of Service Results
Specifying the Execution Locale
About URL Aliases for Services
Creating a Path Alias for a Service
Automatically Saving or Restoring the Pipeline at Run Time
Configuring Saving or Restoring of the Service Pipeline at Run Time
Specifying the Default Format for an XML Document Received by the Service
Configuring HTTP Methods Allowed for a Service
About Automatic Service Retry
About the Maximum Retry Period
Configuring Service Retry
About Service Auditing
Service Auditing Use Cases
Error Auditing
Service Auditing
Auditing for Recovery
Auditing Long-Running Services
Configuring Service Auditing
Logging Input and Output Fields
Selecting Input or Output Fields for Logging
Logged Field Data Types in JDBC
Assigning a Custom Value to an Auditing Context
Using a Circuit Breaker with a Service
Considerations for Configuring a Circuit Breaker for a Service
Configuring a Circuit Breaker for a Service
About Universal Names for Services or Document Types
Implicit and Explicit Universal Names
Assigning, Editing, or Viewing an Explicit Universal Name
Deleting an Explicit Universal Name
The Universal Name Registry
Services You Use to Interact with the Universal Name Registry
About Service Output Templates
Creating an Output Template
Assigning an Output Template to a Service
Viewing Service Information
Building Flow Services
What Is a Flow Service?
What Is a Flow Step?
What Is the Pipeline?
Building Services Using the Tree Tab or Layout Tab
Creating a New Flow Service
Creating an Empty Flow Service
Creating a Flow Service from an XML Document, DTD, or XML Schema
Creating a Flow Service from an XML Document
Creating a Flow Service from a DTD
Creating a Flow Service from an XML Schema Definition
Inserting Flow Steps
Changing the Position of a Flow Step
Changing the Level of a Flow Step
Setting Properties for a Flow Step
The INVOKE Step
Specifying the Service Property
Invoking a Built-In Service
Invoking a Service on Another Integration Server
Building an Invoke Step
The BRANCH Step
Branching on a Switch Value
Specifying the Switch Value
Specifying the Label Value
Branching on an Expression
Branching on Null and Empty Values
Specifying a Default Step
Using a SEQUENCE as the Target of a BRANCH
Building a BRANCH Step
The REPEAT Step
Specifying the REPEAT Condition
Setting the REPEAT Counter
When Does REPEAT Fail?
Using REPEAT to Retry a Failed Step
Using REPEAT to Retry a Successful Step
The SEQUENCE Step
Using SEQUENCE to Specify an Exit Condition
The LOOP Step
Specifying the Input Array
Collecting Output from a LOOP Step
About the Pipeline for a LOOP Step
Building a LOOP Step
The EXIT Step
Exiting on Success or Failure
Exiting from Iterations, Steps, or Services
Java Equivalents for EXIT Behavior
Building an EXIT Step
The MAP Step
The TRY, CATCH, and FINALLY Steps
Printing a Flow Service
Comparing Flow Services
Working in the Layout Tab
What Is the Layout Tab
When Should You Use Layout Tab?
What Does a Flow Service Look Like in the Layout Tab?
Viewing Flow Steps in the Layout Tab
Viewing Steps that Contain Child Steps in the Layout Tab
Show or Hide the Grid Lines in the Flow Service Editor
Building a Flow Service in the Layout Tab
Inserting a Flow Step
Inserting a Flow Step Using the Palette View
Inserting a Flow Step Using the Context Menu
Notes for Inserting a Child Step into a BRANCH Step
Changing the Order of Steps in a Flow Service
Mapping Data in Flow Services
What Does the Pipeline View Contain?
Pipeline View for an INVOKE Step
Pipeline View for a MAP Step
Scrolling in Pipeline View
Viewing Full Namespace Path of Referenced Document Types
Printing the Pipeline
Basic Mapping Tasks
About Linking Variables
Creating a Link Between Variables
What Happens When Integration Server Executes a Link?
Example of Copying By Reference
Preventing Pipeline Values from Being Overwritten
Linking to Document and Document List Variables
Linking Variables of Different Data Types
Converting a String List to a Document List in the Pipeline
Converting Two String Lists to a Document List in the Pipeline
Linking to and from Array Variables in the Pipeline
Creating a Link to or from an Array Variable
Default Pipeline Rules for Linking to and from Array Variables
Deleting a Link Between Variables
Linking Variables Conditionally
Linking Multiple Source Variables to a Target Variable
Applying a Condition to a Link
About Assigning Values to Pipeline Variables
Assigning a Value to a Pipeline Variable
Assigning String Variables to Pipeline Variables
Assigning Global Variables to Pipeline Variables
Assigning String Variables and Global Variables to the Same Pipeline Variable
Copying Assigned Values Between Pipeline Variables
Dropping Variables from the Pipeline
Adding Variables to the Pipeline
Working with Transformers
Using Built-In Services as Transformers
Inserting a Transformer
Linking Variables to a Transformer
Transformers and Array Variables
Example of Dimensionality Mismatch
Validating Input and Output for Transformers
Copying Transformers
Renaming Transformers
Debugging Transformers
Testing Flow Steps Before Running a Flow Service
Opening the Data Mapper View
Testing a Flow Step in the Data Mapper View
Mapping Using ForEach
Creating a ForEach Mapping
Specifying ForEach Mapping Properties
ForEach Mapping Rules
Failure Handling in Flow Services Using the TRY, CATCH, and FINALLY Steps
About Failure Handling in Flow Services
What Happens When a Failure Occurs?
com.wm.lang.flow.FlowException versus com.wm.lang.flow.Failure
About the TRY, CATCH, and FINALLY Steps
The TRY Step
The CATCH Step
The FINALLY Step
Usage Patterns for Failure Handling
TRY-CATCH
TRY-FINALLY
TRY-CATCH-FINALLY
Summary of TRY, CATCH, and FINALLY Behavior
Normal and Abrupt Completion and Failure of TRY, CATCH, and FINALLY Steps
Notable Behavior for Abrupt Completion in TRY, CATCH, and FINALLY Steps
Overview of Building the TRY, CATCH, and FINALLY Steps
Limitations for the TRY, CATCH, and FINALLY Steps
Positioning Guidelines and Limitations for TRY, CATCH, and FINALLY Steps
CATCH Step Considerations
EXIT Step Considerations in TRY, CATCH, or FINALLY
Building TRY, CATCH, and FINALLY Steps
Performing Data Validation
Blueprints or Models Against which Data is Validated
Performing Input/Output Validation
Specifying Input/Output Validation via the Input/Output Tab
Specifying Input/Output Validation via the INVOKE Step
Performing Pipeline Validation
Performing Document Validation
Performing XML Validation in Integration Server
Performing Validation from within a Java Service
Validation Errors
Validation Exceptions
Preventing Running Out of Memory Error During Validation
Building Java Services
Overview of Building Java Services
Java Service Editor
Source Tab
Protected Sections of a Java Service
Editable Sections of a Java Service
Service Development Projects in the Local Workspace
About the Service Development Project Name
Format of a Service Development Project
How Java Services Are Organized on Integration Server
Creating a Java Service
Notes about Creating and Editing Java Services in Designer
Using an IData Object for the Java Service Input and Output
Generating Java Code from Service Input and Output Parameters
Example of Java Code Generated from Service Signature
Editing an Existing Java Service
Adding Classes to the Service Development Project
Compiling a Java Service
Performance When Compiling a Java Service
Generating Code a Java Service Can Use to Invoke a Specified Service
Generating Java Code to Invoke a Service
Example of Java Code Generated for Invoking a Service
Deleting a Java Service
Building Java Services in Your Own IDE
How Java Services are Organized on Integration Server
Requirements for the Java Service Source Code
IData Object for Java Service Input and Output
Adding Comments to Your Java Code for the jcode Utility
Example of Code Commented for the jcode Utility
Using the jcode Utility
Using jcode make/makeall to Compile Java Source
Using jcode frag/fragall to Split Java Source for Designer
Using jcode comp to Create Java Source from Fragments
Using jcode Shortcut Commands
Building Map Services
What Is a Map Service?
Building Map Services Using the Tree Tab or Graphical View Tab
Creating a Map Service
Creating a Map Service
Setting Properties for a Map Service
Working in the Graphical View tab
Debugging Map Services
Building C/C++ Services
The Java Code for a C/C++ Service
Overview of Building C/C++ Services
Prerequisites for Building C/C++ Services
C/C++ Service Editor
Source Tab
Protected Sections of a C/C++ Service
Editable Sections of a C/C++ Service
Service Development Projects in the Local Workspace
About the Service Development Project Name
Format of a Service Development Project
How C/C++ Services Are Organized on Integration Server
Creating a C/C++ Service
Editing an Existing C/C++ Service
Generating C/C++ Code from Service Input and Output Parameters
Adding Classes to the Service Development Project
Building the C/C++ Source Code
Compiling the C/C++ Source Code
Performance When Compiling a C/C++ Service
Generating Code a C/C++ Service Can Use to Invoke a Specified Service
Debugging C/C++ Services
Building Services from .NET Methods
Environment Setup for Creating .NET Services
.NET Service Editor
.NET Properties Tab
Creating a .NET Service
Modifying the .NET Assembly Information
Modifying the Class Lifetime for a .NET Service
Running a .NET Service in Designer
Building XSLT Services
What Is XSLT?
What Is an XSLT Service?
How Does an XSLT Service Work?
What Is a Translet?
About the XSLT Service Editor
Overview of Building XSLT Services
Creating an XSLT Service
XSLT Service Signature
Running an XSLT Service
Debugging an XSLT Service
Creating a Launch Configuration for an XSLT Service
Debugging an XSLT Service
Guidelines for the XSLT Style Sheet
Using Name/Value Pairs with an XSLT Service
Passing Name/Value Pairs from the Pipeline to the Style Sheet
Specifying New Values for Name/Value Pair
Defining Name/Value Pair as an XSLT Parameter
Passing Name/Value Pairs from the Style Sheet to the Pipeline
Sample Style Sheet: Adding Name/Value Pairs to the Pipeline
Configuring XSLT Transformer Factory Settings
Building Cloud Connector Services
Creating a Cloud Connector Service
Editing a Cloud Connector Service for a SOAP-Based Provider
Editing a Cloud Connector Service for a REST-Based Provider
Viewing the Constraints Applied to Variables
Building Connector Listeners
Creating Connector Listeners
Editing Connector Listeners
Running Services
Using Launch Configurations to Run Services
Creating a Launch Configuration for Running a Service
Supplying Input Values to a Service
Entering Input for a Service
Specifying a Value for a String Variable
Specifying Values for a String List Variable
Specifying Values for a String Table Variable
Specifying Values for a Document Variable that Has Defined Content
Specifying Values for a Document Variable with No Defined Content
Specifying Values for a Document List Variable
Specifying a Value for an Object Variable
Specifying Values for an Object List Variable
Saving Input Values
Loading Input Values
Running a Service
Viewing Results from Running a Service
Messages Tab
Call Stack Tab
Pipeline Tab
Saving the Results
Restoring the Results
Running Services from Results view
Removing the Results from Results View
Pinning a Result to Results View
Sorting Results by Element Names in Results View
Running Services from a Browser
Debugging Flow Services
About Debugging Flow Services
About Debug Sessions
About the Debug Perspective
About Debug View
Creating Launch Configurations for Debugging Flow Services
Debugging a Flow Service
Stepping Through Flow Services
Stepping Through a Flow Service
Stepping Into and Out of a Child Service
Stepping Into and Out of a MAP Step
Stepping Into and Out of a ForEach Mapping
Using Breakpoints When Debugging Flow Services
Breakpoint States
Setting and Removing Breakpoints on Flow Step
Setting and Removing Breakpoints on a Transformer
Enabling and Disabling Breakpoints in a Flow Service
Skipping Breakpoints in a Flow Service
Disabling and Enabling Flow Steps and Transformers
Disabling and Enabling Conditions
Modifying the Flow Service Pipeline while Debugging
Changing Variable Values
Dropping Variables
Saving and Restoring the Flow Service Pipeline while Debugging
Saving the Flow Service Pipeline while Debugging
Saving the Pipeline to a File while Debugging
Restoring the Flow Service Pipeline while Debugging
Loading a Saved Pipeline while Debugging
Viewing Service Results from a Flow Service Debug Session
Using the Server Log for Debugging
Writing Information to the Server Log
Writing an Arbitrary Message to the Log
Dumping the Pipeline to the Log
Debugging Map Services
Debugging Java Services
About Debugging a Java Service while its Class Runs in Designer
About Test Harnesses
Creating a Test Harness
About Java Application Launch Configuration
Creating a Java Application Launch Configuration
Updating a Java Application Launch Configuration
How to Suspend Execution of a Java Class while Debugging
Debugging a Java Service while its Class Runs in Designer
Viewing Service Results from Debugging a Java Service
About Debugging a Java Service while it Runs in Integration Server
Benefits of Debugging Java Services Running in Integration Server
Drawbacks of Debugging Java Services Running in Integration Server
Setting Up Integration Server Version 9.7 or Later for Remotely Debugging a Java Service
Setting Up Integration Server Version 9.0, 9.5.x, or 9.6 for Remotely Debugging a Java Service
Creating a Java Project for an IS Package in Designer
Creating a Remote Java Application Launch Configuration
Debugging a Java Service while it Runs in Integration Server
Working with REST API Descriptors
OpenAPI Based Provider REST API Descriptors
Creating a Provider REST API Descriptor from an OpenAPI Document
Viewing General Information of the REST API Descriptor
Working with Servers
Viewing the Server Details
Adding a New Server
Removing a Server
Modifying the Server Details of a Server
Adding Server Variables
Modifying Server Variables
Removing Server Variables
Working with Resources
Viewing the REST V2 Resources in the REST API Descriptor
Working with Operations
About REST Requests
About REST Responses
About Services
About Callbacks
Working with Schemas
Viewing the Schemas
About JSON Document Types
Working the Security
Viewing the Security Schemes
Working the Tags
Viewing the Tags
Viewing the OpenAPI Document for a REST API Descriptor
Swagger Based Provider REST API Descriptors
Approaches for Developing REST Resources
Configuring a REST V2 Resource
Creating a REST V2 Resource
Supporting Elements for a REST V2 Resource
Configuring REST V2 Resources as JSON API Compliant
Examples of Configuring REST Resources Based on JSON API
Working with REST V2 Resource Operation
Defining a REST V2 Resource Operation
Example of Defining a REST V2 Resource Operation
Editing a REST V2 Resource Operation
Deleting a REST V2 Resource Operation
Working with REST V2 Resource Attributes
Defining a REST V2 Resource Attribute
Editing a REST V2 Resource Attribute
Deleting a REST V2 Resource Attribute
Creating a Provider REST API Descriptor from a REST Resource
Editing General Information for a REST API Descriptor
Changing the Available MIME Types for a REST API Descriptor
Working with Security Definitions
Adding a Security Definition
Removing a Security Definition
Working with Tags
Adding Tags
Removing a Tag
Editing a Tag
Working with REST Resources in a REST API Descriptor
Adding REST Resources to a REST API Descriptor
Removing REST Resources from a REST API Descriptor
Setting the Path or Suffix for a REST Resource
Working with Operations
Changing the MIME Types for an Operation in a REST Resource
Modifying Tags for Operations in a REST Resource
Modifying Security Scheme for Operations in a REST Resource
Modifying External Document for Operations in a REST Resource
About the Operation Parameters
Reviewing and Changing the Assigned Source for an Operation Parameter
About Operation Responses
Adding an Operation Response
Removing an Operation Response
Viewing REST V2 Resources in Group by Tags Mode
Running a REST V2 Resource Operation from REST API Descriptor Editor
Executing an Operation Using Editor
About REST Definitions
Viewing the Swagger Document for a REST API Descriptor
Creating a Provider REST API Descriptor from a Swagger Document
Mapping Integration Server Data Types to Swagger Data Types
Mapping Integration Server Content Type Constraints to Swagger Type Constraints
Swagger Based Consumer REST API Descriptors
Creating a Consumer REST API Descriptor from a Swagger Document
Refreshing a REST API Descriptor
Publishing REST API Descriptors to API Portal
Working with OData Services
Understanding OData Service Terminology
Supported and Unsupported OData Features
Overview of Creating an OData Service
Creating an OData Service
Creating an OData Service Using an External Source Type
Adding OData Elements to the OData Service
Adding Properties to the OData Elements
Adding Associations to OData Elements
Editing the OData Service
Synchronizing the External Entity Type
How Integration Server Processes an OData Service Request
Querying Data Using $filter
Working with Document Types
Creating an IS Document Type
Creating an Empty IS Document Type
Adding Fields to an IS Document Type
Creating an IS Document Type from an XML Document, DTD, or XML Schema
Creating an IS Document Type from an XML Document
Creating an IS Document Type from a DTD
Creating an IS Document Type from an XML Schema Definition
Creating IS Document Types from JSON Objects
Mapping JSON Data Types
Generating Fields from Unquoted Fields in a JSON Object
Creating an IS Document Type from a JSON Object
Creating an IS Document Type from a Broker Document Type
Creating an IS Document Type from an E-form Template
Notes About IS Document Types Created from E-form Templates
Creating a Document Type from a Flat File Schema
Determining How to Represent Complex Types in Document Types
Derived Types and IS Document Types
*doctype Fields in IS Document Types and Document Fields
*doctype Fields in IS Document Types
*doctype Fields in Document Fields
Registering Document Types with Their Schema Types
Generating Fields for Substitution Groups
*Any Fields in Document Types and Document Fields
About Run-time Processing for an IS Document Type that Complies with the Content Model
Editing Document Types
About Universal Names and Document Types
Printing an IS Document Type
Publishing Documents as JMS Messages
Creating a Launch Configuration to Publish a Document as a JMS Message
Publishing a Document as a JMS Message
Working with Publishable Document Types
Making a Document Type Publishable
About the Associated Provider Definition
About the Envelope Field
About the Properties Field
About Adapter Notifications and Publishable Document Types
Making a Document Type Unpublishable
About the Encoding Type for a Publishable Document Type
Using Protocol Buffers as the Encoding Type
Limitations for Representing Fields in Protocol Buffer Descriptors
Encoding Documents as Protocol Buffers during Document Publishing
Decoding Protocol Buffers
Setting the Encoding Type for a Publishable Document Type
About the Type of Document Storage
Document Storage Versus Broker Client Queue Storage
Setting the Document Storage Type for a Publishable Document Type
About the Time-to-Live for a Publishable Document Type
Setting the Time to Live for a Publishable Document Type
About Run-Time Validation for a Published Document
Specifying Document Validation for Instances of a Publishable Document Type
Important Considerations When Modifying Publishable Document Types
About Synchronizing Publishable Document Types
Synchronization Status
Synchronization Actions
Combining Synchronization Action with Synchronization Status
Synchronizing a Single Publishable Document Type
Synchronizing Multiple Document Types Simultaneously
Synchronizing Document Types in a Cluster
Synchronizing Document Types Across a Gateway
Importing and Overwriting References During Synchronization
What Happens When You Overwrite Elements on the Integration Server?
What Happens If You Do Not Overwrite Elements on the Integration Server?
About Testing Publishable Document Types
Creating a Launch Configuration for a Publishable Document Type
Testing a Publishable Document Type
Deleting Publishable Document Types
Working with XML Document Types
What Is an XML Document Type?
What Is XMLData?
Why Use XML Document Types Instead of IS Document Types?
Differences Between XML Document Types and IS Document Types
Limitations of XML Document Type Usage
Creating an XML Document Type
Working with JSON Document Types
What Is a JSON Document Type?
Considerations for Using JSON Document Types
Data Type Mapping
Creating a JSON Document Type
JSON Document Type Properties
Working with Specifications
Creating a Specification
Working with Variables
Creating a Document Reference or a Document Reference List Variable
Using XML Namespaces and Namespace Prefixes with Variables
Guidelines for Using XML Namespaces and Prefixes with Web Service Descriptors
Assigning XML Namespaces and Prefixes to Variables
Assigning Display Types to String Variables
About Variable Constraints
Considerations for Object Constraints
Applying Constraints to a Variable
Customizing a String Content Type
Viewing the Constraints Applied to Variables
Working with Schemas
What Does an IS Schema Look Like?
Schema Browser
Component Details
Creating an IS Schema
Creating an IS Schema from XML Schemas that Reference Other Schemas
About Editing Simple Type Definitions
Editing a Simple Type Definition
About Schema Domains
Working with JMS Triggers
About SOAP-JMS Triggers
Overview of Building a Non-Transacted JMS Trigger
Standard JMS Trigger Service Requirements
Creating a JMS Trigger
Adding JMS Destinations and Message Selectors to a JMS Trigger
Creating a Destination on the JMS Provider
About Durable and Non-Durable Subscribers
Creating a Message Selector
Adding Routing Rules to a Standard JMS Trigger
Creating a Local Filter
Managing Destinations and Durable Subscribers on the JMS Provider through Designer
Modifying Destinations or Durable Subscribers via a JMS Trigger in Designer
Building Standard JMS Triggers with Multiple Routing Rules
Guidelines for Building a JMS Trigger that Performs Ordered Service Execution
Enabling or Disabling a JMS Trigger
JMS Trigger States
Setting an Acknowledgement Mode
About Join Time-Outs
Join Time-Outs for All (AND) Joins
Join Time-Outs for Only One (XOR) Joins
Setting a Join Time-Out
About Execution Users for JMS Triggers
Assigning an Execution User to a JMS Trigger
About Message Processing
Serial Processing
Concurrent Processing
Message Processing and Message Consumers
Message Processing and Load Balancing
About Batch Processing for Standard JMS Triggers
Guidelines for Configuring Batch Processing
Using Multiple Connections to Retrieve Messages for a Concurrent JMS Trigger
Retrieving Multiple Messages for a JMS Trigger with Each Request
Prefetching Messages from webMethods Broker
Prefetching Messages with Universal Messaging
Configuring Message Processing
Fatal Error Handling for Non-Transacted JMS Triggers
Configuring Fatal Error Handling for Non-Transacted JMS Triggers
Transient Error Handling for Non-Transacted JMS Triggers
About Retry Behavior for Trigger Services
Service Requirements for Retrying a Trigger Service
Handling Retry Failure
Overview of Throw Exception for Retry Failure
Overview of Suspend and Retry Later for Retry Failure
Configuring Transient Error Handling for a Non-Transacted JMS Trigger
Exactly-Once Processing for JMS Triggers
Duplicate Detection Methods for JMS Triggers
Configuring Exactly-Once Processing for a JMS Trigger
Disabling Exactly-Once Processing for a JMS Trigger
Debugging a JMS Trigger
Building a Transacted JMS Trigger
Prerequisites for a Transacted JMS Trigger
Properties for Transacted JMS Triggers
Steps for Building a Transacted JMS Trigger
Fatal Error Handling for Transacted JMS Triggers
Configuring Fatal Error Handling for Transacted JMS Triggers
Transient Error Handling for Transacted JMS Triggers
Overview of Recover Only for Transaction Rollback
Overview of Suspend and Recover for Transaction Rollback
Configuring Transient Error Handling for Transacted JMS Triggers
Working with webMethods Messaging Triggers
Overview of Building a webMethods Messaging Trigger
webMethods Messaging Trigger Requirements
Trigger Service Requirements
Creating a webMethods Messaging Trigger
Creating Conditions
Using Filters with a Subscription
Creating Filters for Use with Universal Messaging
Universal Messaging Provider Filters and Encoding Type
Examples of Universal Messaging Provider Filters for Use with Protocol Buffers
Creating Filters for Use with webMethods Broker
Using Hints in Filters
Detecting Deadletters with Hints
Using Multiple Conditions in a webMethods Messaging Trigger
Using Multiple Conditions for Ordered Service Execution
Ordering Conditions in a webMethods Messaging Trigger
Disabling and Enabling a webMethods Messaging Trigger
Disabling and Enabling a webMethods Messaging Trigger in a Cluster or Non-Clustered Group
About Join Time-Outs
Join Time-Outs for All (AND) Join Conditions
Join Time-Outs for Only One (XOR) Join Conditions
Setting a Join Time-Out
About Priority Message Processing
Enabling and Disabling Priority Message Processing for a webMethods Messaging Trigger
About Execution Users for webMethods Messaging Triggers
Assigning an Execution User to a webMethods Messaging Trigger
About Capacity and Refill Level for the webMethods Messaging Trigger Queue
Guidelines for Setting Capacity and Refill Levels for webMethods Messaging Triggers
Setting Capacity and Refill Level for a webMethods Messaging Trigger
About Document Acknowledgements for a webMethods Messaging Trigger
Setting the Size of the Acknowledgement Queue
About Message Processing
Serial Processing
Serial Processing in a Cluster or Non-Clustered Group of Integration Servers
Serial Processing with the webMethods Broker in a Clustered or a Non-Clustered Group of Integration Servers
Serial Processing with Universal Messaging in a Clustered or a Non-Clustered Group of Integration Servers
Serial Triggers Migrated to Integration Server 10.3 or Later from Earlier Versions
Concurrent Processing
Selecting Message Processing
Changing Message Processing When webMethods Broker Is the Messaging Provider
Changing Message Processing When Universal Messaging Is the Messaging Provider
Synchronizing the webMethods Messaging Trigger and Durable Subscription on Universal Messaging
Fatal Error Handling for a webMethods Messaging Trigger
Configuring Fatal Error Handling for a webMethods Messaging Trigger
About Transient Error Handling for a webMethods Messaging Trigger
Service Requirements for Retrying a Trigger Service for a webMethods Messaging Trigger
Handling Retry Failure
Overview of Throw Exception for Retry Failure
Overview of Suspend and Retry Later for Retry Failure
Configuring Transient Error Handling for a webMethods Messaging Trigger
About Retrying Trigger Services and Shutdown Requests
Exactly-Once Processing for webMethods Messaging Triggers
Duplicate Detection Methods for a webMethods Messaging Trigger
Configuring Exactly-Once Processing for a webMethods Messaging Trigger
Disabling Exactly-Once Processing for a webMethods Messaging Trigger
Modifying a webMethods Messaging Trigger
Modifying a webMethods Messaging Trigger in a Cluster or Non-Clustered Group
Deleting webMethods Messaging Triggers
Deleting webMethods Messaging Triggers in a Cluster or Non-Clustered Group
Running a webMethods Messaging Trigger with a Launch Configuration
Creating a Launch Configuration for a webMethods Messaging Trigger
Running a webMethods Messaging Trigger
Testing Join Conditions
Debugging a webMethods Messaging Trigger
Enabling Trace Logging for All webMethods Messaging Triggers
Enabling Trace Logging for a Specific webMethods Messaging Trigger
Transient Error Handling During Trigger Preprocessing
Server and Trigger Properties that Affect Transient Error Handling During Trigger Preprocessing
Overview of Transient Error Handling During Trigger Preprocessing
Working with MQTT Triggers
Overview of Building an MQTT Trigger
MQTT Trigger Requirements
MQTT Trigger Service Requirements
Creating an MQTT Trigger
Disabling and Enabling an MQTT Trigger
MQTT Trigger States
Setting an Acknowledgement Mode for an MQTT Trigger
Assigning an Execution User to an MQTT Trigger
Configuring Message Processing for an MQTT Trigger
Transient Error Handling for an MQTT Trigger
Service Requirements for Retrying an MQTT Trigger
Handling Retry Failure
Overview of Throw Exception
Overview of Stop Trigger
Configuring Transient Error Handling for an MQTT Trigger
Building a Resource Monitoring Service for an MQTT Trigger
Modifying an MQTT Trigger
Deleting an MQTT Trigger
Working with Web Services
What Are Web Service Descriptors?
About Provider Web Service Descriptors
Service Signature Requirements for Service First Provider Web Service Descriptors
Using XML Namespaces with Prefixes with Fields in Service Signatures
Handling Incomplete Service Signatures Using Wrapper Services
Creating a Service First Provider Web Service Descriptor
Protocol Mismatch Between Transport and Primary Port
Creating a WSDL First Provider Web Service Descriptor
About Consumer Web Service Descriptors
Creating a Consumer Web Service Descriptor
Supporting Elements for a Consumer Web Service Descriptor
About Web Service Connectors
Refreshing a Web Service Connector
Invoking a Web Service Using a Web Service Connector
About Response Services
About Refreshing a Web Service Descriptor
How Refresh Affects a Web Service Descriptor
Considerations for Refreshing a Web Service Descriptor
Refreshing a Web Service Descriptor
Viewing the WSDL Document for a Web Service Descriptor
WS-I Compliance for Web Service Descriptors
Modifying WS-I Compliance for a Web Service Descriptor
Reporting the WS-I Profile Conformance for a Web Service Descriptor
Changing the Target Namespace for a Web Service Descriptor
Viewing the Namespaces Used within a WSDL Document
Enabling MTOM/XOP Support for a Web Service Descriptor
Enabling SOAP Attachments for a Web Service Descriptor
Using pub.string:base64Encode with MTOM Implementations
Adding SOAP Headers to the Pipeline
Validating SOAP Response
Validating Schemas Associated with a Web Service Descriptor
Enabling Xerces Schema Validation for a Web Service Descriptor
Omitting xsd:any from the WSDL Document
Working with Binders
Binders and Mixed Use
Existing Web Service Descriptors with Mixed Use Binders
Binders and Mixed Style
Adding a Binder to Web Service Descriptor
Copying Binders Across Provider Web Service Descriptors
Changing the Binder Transport
Deleting a Binder from a Web Service Descriptor
Deleting an Operation from a Binder
Modifying the SOAP Action for an Operation in a Binder
Assigning a Web Service Endpoint Alias to a Binder
Configuring Use of the Client Side Queue
Working with Operations
Adding Operations
Adding an IS Service as an Operation
Adding an Operation from another Provider Web Service Descriptor
Using a 6.5 SOAP-MSG Style Service as an Operation
Modifying the Signature of a 6.5 SOAP-MSG Style Operation
Deleting Operations
Viewing the Operation Input and Output
Adding Headers to an Operation
Adding a Header to an Operation
About SOAP Fault Processing
About SOAP Fault Elements
Adding a Fault Element to an Operation
The $fault Variable
Modifying a Returned SOAP Fault
Viewing Document Types for a Header or Fault Element
Working with Handlers
Setting Up a Header Handler
Registering a Header Handler
Adding a Handler to a Web Service Descriptor
Deleting a Handler from a Web Service Descriptor
Working with Policies
Attaching a Policy to a Web Service Descriptor
Removing a Policy from a Web Service Descriptor
About Pre-8.2 Compatibility Mode
Setting Compatibility Mode
Features Impacted by Compatibility Mode
Working with GraphQL Descriptors
Understanding the GraphQL Terminology
Supported and Unsupported GraphQL Features
GraphQL Data Type Mapping
Overview of Creating a GraphQL Descriptor
Creating a GraphQL Descriptor
How Integration Server Generates GraphQL Descriptor and Supporting Assets
How Integration Server Generates Input Signature for Resolver Services
How Integration Server Generates Output Signature for Resolver Services
How Integration Server Invokes a Resolver Service While Processing a GraphQL Request
Usage Notes for GraphQL Descriptors
Invoking a GraphQL Descriptor
Working with GET Request
Working with POST Request
How Integration Server Sends Response to a GraphQL Request
Modifying Properties to the GraphQL Descriptor
How Integration Server Calculates the Query Parameters
Refreshing a GraphQL Descriptor
Working with a GraphQL Dataloader
Creating a Dataloader
How Integration Server Uses Dataloader in Resolver Service
Using personLoader in listPersonResolver Root Resolver Service
Using personLoader in friendsResolver Resolver Service
Working with WebSocket Endpoints
Creating a WebSocket Server Endpoints
Creating a WebSocket Client Endpoint
Working with Recipes
Installing or Downloading Recipes
Working with UDDI Registry
Opening UDDI Registry View
Connecting to a UDDI Registry
Disconnecting from a UDDI Registry
Refreshing a UDDI Registry Session
Browsing for Web Services in a UDDI Registry
Applying a Filter to UDDI Registry
Clearing an Applied Filter
Creating a Web Service Descriptor from a UDDI Registry
Publishing a Service to UDDI Registry
Deleting a Service from UDDI Registry
Working with Flat Files
Concepts
What Is a Flat File Schema?
What Is a Flat File Dictionary?
When Should I Create a Flat File Dictionary?
Creating Flat File Schemas
Creating the Flat File Schema
Creating a Flat File Schema From a Sample File
Creating a Flat File Schema Manually
Specifying a Record Parser
Specifying a Delimited Record Parser for the Schema
Specifying a Fixed Length Record Parser for the Schema
Specifying a Variable Length Record Parser for the Schema
Specifying a Record Identifier
Defining the Schema Structure
Setting a Default Record
Allowing Undefined Data
Creating an Area
Specifying a Floating Record
Editing a Flat File Schema
Testing Flat File Schemas
Creating a Launch Configuration for a Flat File Schema
Testing a Flat File Schema
Creating Flat File Dictionaries
Creating a Flat File Dictionary
Adding Elements to the Flat File Dictionary
Setting Properties for the Flat File Dictionary
Editing a Flat File Dictionary
Defining Flat File Elements
Adding a Record Definition
Adding a Record Reference
Adding a Composite Definition
Adding a Composite Reference
Adding a Field Definition
Adding a Field Reference
Working with Adapters
About Adapter Connections
About Adapter Services
About Adapter Listeners
About Adapter Notifications
Subscribing to Events
What Happens When an Event Occurs?
Subscribing to Events
Creating Event Filters
Creating Event Filters for Services
Viewing and Editing Event Subscriptions
Suspending Event Subscriptions
Deleting an Event Subscription
Building an Event Handler
Invoking Event Handlers Synchronously or Asynchronously
About Alarm Events
About Audit Events
About Audit Error Events
About Exception Events
About Guaranteed Delivery Events
Guaranteed Delivery Events and Transaction Events
About JMS Delivery Failure Events
About JMS Retrieval Failure Events
About Port Status Events
About Replication Events
About Security Events
About Session Events
About Stat Events
About Transaction Events
Submitting and Receiving XML Documents
Submitting and Receiving XML in a String Variable
Sample Client Code to Submit an XML Document in a String Variable
Considerations When Coding the Target Service to Receive the XML Document that is Passed in a String Variable
Submitting and Receiving XML in $xmldata
Sample Client Code to Submit an XML Document in $xmldata
Considerations When Coding the Target Service to Receive the XML Document that is Passed in $xmldata
Submitting and Receiving XML via HTTP
Creating a Client that Submits an XML Document via HTTP
Using pub.client:http to Submit an XML Document via HTTP
About the xmlFormat Value
Submitting and Receiving XML via $xmldata without Parsing
Using pub.client:http to Submit $xmldata via HTTP
Submitting and Receiving XML via FTP
Naming the File that the Client is to Submit via FTP
Actions a Client Takes to Submit an XML Document via FTP
Actions a Client Takes to Retrieve Output from the Target Service
Considerations When Coding the Target Service to Receive the XML Document
Submitting and Receiving XML via E-mail
Actions a Client Must Take to Submit an XML Document via Email
Using pub.client:smtp to Submit an XML Document via Email
Considerations When Coding the Target Service to Receive the XML Document
Working with Load and Query Services
What Are the Load and Query Services?
Basic Concepts
About the pub.xml:loadXMLNode Service
About the pub.xml:loadEnhancedXMLNode Service
About the pub.xml:queryXMLNode Service
Building Services that Retry
Requirements for Retrying a Service
Example Service that Throws an Exception for Retry
Creating Client Code
Building a Java Client
Limitations when Generating Java Client Code
Files that Designer Generates for a Java Client
Generating Java Client Code
Building a C/C++ Client
Prerequisites for Generating C/C++ Client Code
Limitations when Generating C/C++ Client Code
Files that Designer Generates for a C/C++ Client
Generating C/C++ Client Code
Building a Browser-Based Client
Prerequisites for Building Browser-Based Client Code
URL Client Uses to Invoke Services
How Input Values are Passed to the Service the Browser-Based Client Invokes
When Browser-Based Clients Pass Multiple Values for the Same Input Variable
When Browser-Based Clients Pass Multiple Input Variables with the Same Name
How Integration Server Returns Output from the Service the Client Invoked
Building a REST Client
Comparing Integration Server Packages and Elements
Working with the Compare Editor
Change List Panel
Content Panel
Guidelines for Comparing Packages, Folders, and Elements
Comparing Integration Server Elements
Merging IS Elements
Comparing Integration Server Folders
Comparing Integration Server Packages
Publishing and Retracting Metadata for IS and TN Assets
Available IS and TN Assets
Publishing and Retracting Metadata
Considerations for Publishing and Retracting Metadata
Publishing Metadata for IS Assets or TN Document Types at the Integration Server Level
Retracting Metadata for IS Assets or TN Document Types at the Integration Server Level
Publishing Metadata for IS Assets or TN Document Types at the Asset Level
Retracting Metadata for IS Assets or TN Document Types at the Asset Level
Usage Notes for IS Assets
Status Information for Publish and Retract Requests
Summary Information for Publish and Retract Requests
Connecting to webMethods API Portal for Publishing REST API Descriptors
Configuring a Connection to API Portal
Adding a Connection Configuration for API Portal
Editing a Connection Configuration for API Portal
Removing a Connection Configuration for API Portal
Changing the Default Connection Configuration for API Portal
Publishing Assets to webMethods API Gateway
Configuring a Connection to API Gateway
Editing a Connection Configuration for API Gateway
Removing a Connection Configuration for API Gateway
Changing the Default Connection Configuration for API Gateway
Publishing Assets to API Gateway
Connecting to webMethods Cloud Container
Configuring a Connection to Cloud Container
Adding a Connection Configuration for Cloud Container
Editing a Connection Configuration for Cloud Container
Removing a Connection Configuration for Cloud Container
Deploying to webMethods Cloud Container
Deploying Packages and Configuration Assets to Cloud Container
Checking the Deployment Status
Asset Repository
Opening the Asset Repository View
Building Packages and Assets in Asset Repository View
Deploying Packages and Assets from Asset Repository View
Retracting Packages and Assets
Deleting Packages and Assets
Configuring a Universal Messaging Server
Modifying a Universal Messaging Server
Removing a Universal Messaging Server
Using Landscape Navigator to View Runtime Configurations (Deprecated)
What Does the Landscape Navigator View Contain?
Creating Command Central Definitions
Editing Command Central Definition
Deleting a Command Central Definition
What Does the Configuration Browser View Contain?
Browsing Runtime Instances and Configurations
Deploying Customized Configuration to Cloud Container
Exporting Deployable Configuration
Using Configuration Project
Editing Configuration Template
Deploying a Configuration Project
Using the Cloud Service Development Feature
Prerequisites
Opening the Cloud Service Development Perspective
The Cloud Explorer View
Supported and Unsupported Functions
API Portal Preferences
Command Central Preferences
Command Central Connection Configuration
Labels and Decorations
Monitoring
Projects
Document Expansion Preferences
Cloud Container Preferences
Integration Server Preferences
Universal Messaging Preferences
Service Development Preferences
Adapter Service/Notification Editor Preferences
Compare Editor Preferences
Element Property Templates Preferences
Flow Service Editor Preferences
HTML Generation Preferences
Java/C Service Editors Preferences
Launching Preferences
Local Service Development Preferences
Package Navigator Preferences
Publishable Document Type Preferences
Results View Preferences
Run/Debug Preferences
Schema Editor Preferences
Swagger Syntax Coloring Preferences
Web Service Descriptor Editor Preferences
Properties
Integration Server Properties
Event Manager Properties
My Locked Elements
Server ACL Information
Server Information
Package Properties
Package Information
Package Dependencies
Package Settings
Package Permissions
Package Replication Services
Package Startup/Shutdown Services
Element Properties
Element Information
Element Permissions
Element General Properties
REST Resource Configuration
Document Type Properties
General Properties for IS Document Types
JSON Document Type Properties
webMethods Messaging Properties
Universal Name Properties
Flat File Dictionary Properties
General Properties for a Flat File Dictionary
Flat File Element Properties
Record Definition Properties
Record Reference Properties
Composite Definition Properties
Composite Reference Properties
Field Definition Properties
Field Reference Properties
Flat File Schema Properties
General Properties for a Flat File Schema
Default Record Properties
Settings Properties
Schema Definition Properties
JMS Trigger Properties
General Properties for Non-Transacted JMS Triggers
General Properties for Transacted JMS Triggers
Message Processing Properties
Fatal Error Handling Properties
Transient Error Handling with a Non-Transacted JMS Trigger
Transient Error Handling with a Transacted JMS Trigger
Exactly Once Processing Properties
webMethods Broker Properties (Deprecated)
Link Properties
General Properties for Links
MQTT Trigger Properties
General Properties for an MQTT Trigger
Message Processing Properties
Transient Error Handling Properties
OData Service Properties
General Properties for OData Services
OData Element Properties
Entity Type Properties
Complex Type Properties
External Entity Type Properties
Simple Property Properties
General Properties for Simple Property
Facets Properties for Simple Property
Complex Property Properties
Association Properties
General Properties for Association
OData Association End Properties
OData Association Navigation Properties
REST V2 Resource Properties
REST API Descriptor Properties
General Properties for REST API Descriptors
REST Resource Properties
Operation Properties
REST Definition Properties
REST Definition Parameter Properties
Schema Properties
General Properties for IS Schemas
Schema Component Properties
All Content Model
Any Attribute Declaration
Any Element Declaration
Attribute Declaration
Attribute Reference
Choice Content Model
Complex Type Definition
Element Declaration
Element Reference
Empty Content
Mixed Content Model
Sequence Content Model
Simple Type Definition
Service Properties
General Properties for Services
Run Time Properties for Services
Transient Error Handling Properties
Audit Properties
Circuit Breaker Properties
Universal Name Properties for Services
Output Template Properties for Services
Specification Properties
General Properties for Specifications
Transformer Properties
General Properties for Transformers
Variable Properties
General Properties for Variables
Constraints Properties for a Variable
Constraints Applied to Variables
webMethods Messaging Trigger Properties
General Properties for webMethods Messaging Triggers
Trigger Queue Properties
Message Processing Properties
Fatal Error Handling Properties
Transient Error Handling Properties
Exactly Once Properties
Web Service Connector Properties
General Properties for Web Service Connectors
Run Time Properties
Audit Properties
Universal Name Properties
Output Template Properties
Web Service Descriptor Properties
General Properties for Web Service Descriptors
Web Service Descriptor Operation Properties
Operation Properties
Body Element Properties
Header Element Properties
Fault Element Properties
Web Service Descriptor Binder Properties
General Properties for Binders
JMS Settings Properties for a Binder
JMS Message Details Properties for a Binder
Web Service Descriptor Header Handler Properties
GraphQL Descriptor Properties
Query Properties for GraphQL Descriptor
GraphQL Dataloaders
WebSocket Endpoint Properties
webMethods Flow Steps
BRANCH
Branching on a Switch Value
Branching on Expressions
BRANCH Properties
Conditions that Will Cause a BRANCH Step to Fail
CATCH
CATCH Properties
EXIT
EXIT Properties
Examples of When to Use an EXIT Step
FINALLY
FINALLY Properties
INVOKE
INVOKE Properties
Conditions that Will Cause an INVOKE Step to Fail
LOOP
LOOP Properties
Conditions that Will Cause a LOOP Step to Fail
MAP
MAP Properties
Example of When to Use a MAP Step
REPEAT
REPEAT Properties
When Does REPEAT Fail?
Examples of When to Use a REPEAT Step
SEQUENCE
SEQUENCE Properties
Conditions that Will Cause the SEQUENCE Step to Fail
TRY
TRY Properties
Data Types
Data Types in IData Objects
Java Classes for Objects
How Designer Supports Tables
Icons
Package Navigator View Icons
UDDI Registry View Icons
Flat File Element Icons
Flow Step Icons
OData Service Icons
REST API Descriptor Icons
Schema Component Icons
Toolbars
Compare Editor Toolbar
Document Type Editor Toolbar
Flat File Schema and Dictionary Editors Toolbars
Package Navigator View Toolbar
Cloud Explorer View Toolbar
Pipeline View Toolbar
REST API Descriptor Toolbar
GraphQL Descriptor Toolbar
Service Editor Toolbar
Results View Toolbar
Specification Editor Toolbar
UDDI Registry View Toolbar
Variables View Toolbar
Web Service Descriptor Editor Toolbar
Keyboard Shortcuts
Conditional Expressions
Guidelines for Writing Expressions and Filters
Syntax
Comparing Java Objects to Constants
Verifying Variable Existence
Operators for Use in Conditional Expressions
Relational Operators
Standard Relational Operators
Lexical Relational Operators
Logical Operators
Operator Precedence in Conditional Expressions
Addressing Variables
Addressing Variables that Contain Special Characters
Typing Special Characters in Expressions
Rules for Use of Expression Syntax with the Broker
Regular Expressions
Using a Regular Expression in a Mask
Regular Expression Operators
Validation Content Constraints
Content Types
Constraining Facets
webMethods Query Language
Overview
Object References
Sibling Operators
Object Properties
Property Masking
Appendix
Usage Notes on REST
Configuring a REST Resource Using the Legacy Approach
Processing Requests Using Partial Matching of URL Aliases
Setting Up a REST Application on Integration Server
Services for REST Resources Configured Using the Legacy Approach
Configuration
Converting an Existing Application to a REST Application
Examples of Configuring REST Resources Based on JSON API
Example of Defining a REST V2 Resource Operation
Usage Notes on REST API Descriptor
Copyright
Administering and Monitoring B2B Transactions
Copyright
wm_tn_log
wm_tn_receive
wm_tn_reroute
wm_tn_submit
wm_tn_admin_exportData
wm_tn_admin_extendedExportData
wm_tn_admin_extendedImportData
wm_tn_admin_getDBLimits
wm_tn_admin_getDBPoolInfo
wm_tn_admin_getProperties
wm_tn_admin_getStartupErrors
wm_tn_admin_importData
wm_tn_admin_setProperties
wm_tn_archive_archive
wm_tn_archive_extendedArchive
wm_tn_archive_archiveByStoredProc
wm_tn_archive_purgeBizdocUniqueKeysData
wm_tn_archive_purgeEDITrackingData
wm_tn_charting_purgeTransactionSummaryData
wm_tn_charting_populateSummaryData
wm_tn_delivery_deliver
wm_tn_delivery_getRegisteredService
wm_tn_delivery_getRegisteredServices
wm_tn_delivery_isServiceRegistered
wm_tn_delivery_refreshServiceCache
wm_tn_delivery_registerDefaults
wm_tn_delivery_registerService
wm_tn_delivery_removeService
wm_tn_dictionary_addContactType
wm_tn_dictionary_addFieldDefinition
wm_tn_dictionary_addFieldGroup
wm_tn_dictionary_addIDType
wm_tn_dictionary_addProfileGroup
wm_tn_dictionary_changeContactType
wm_tn_dictionary_changeFieldGroup
wm_tn_dictionary_changeIDType
wm_tn_dictionary_changeProfileGroup
wm_tn_dictionary_deleteContactType
wm_tn_dictionary_deleteIDType
wm_tn_dictionary_deleteFieldGroup
wm_tn_dictionary_deleteProfileGroup
wm_tn_dictionary_getBinaryTypes
wm_tn_dictionary_getContactTypes
wm_tn_dictionary_getFieldDefinitions
wm_tn_dictionary_getFieldGroups
wm_tn_dictionary_getIDTypes
wm_tn_dictionary_getProfileGroups
wm_tn_doc_addAttributes
wm_tn_doc_addContentPart
wm_tn_doc_changeStatus
wm_tn_doc_createNewEnvelope
wm_tn_doc_createReply
wm_tn_doc_deleteDocuments
wm_tn_doc_getContentPart
wm_tn_doc_getContentPartData
wm_tn_doc_getDeliveryContent
wm_tn_doc_getEvents
wm_tn_doc_getSenderReceiver
wm_tn_doc_handleLargeDoc
wm_tn_doc_persist
wm_tn_doc_recognize
wm_tn_doc_relateDocuments
wm_tn_doc_replaceContentPart
wm_tn_doc_resubmit
wm_tn_doc_resubmits
wm_tn_doc_setAttribute
wm_tn_doc_sign
wm_tn_doc_updateAttributes
wm_tn_doc_updateComments
wm_tn_doc_updateSystemAttributes
wm_tn_doc_validate
wm_tn_doc_verify
wm_tn_doc_view
wm_tn_doc_viewAll
wm_tn_doc_viewAs
wm_tn_doc_ff_registerContentTypes
wm_tn_doc_ff_routeFlatFile
wm_tn_doc_ff_validate
wm_tn_doc_xml_bizdocToRecord
wm_tn_doc_xml_recordToBizdoc
wm_tn_doc_xml_routeXml
wm_tn_docattr.add
wm_tn_docattr.disable
wm_tn_docattr.enable
wm_tn_docattr.list
wm_tn_docattr.listTypesForAttribute
wm_tn_docattr.setPersist
wm_tn_docattr.update
wm_tn_docattr.view
wm_tn_doctype.add
wm_tn_doctype.delete
wm_tn_doctype.disable
wm_tn_doctype.enable
wm_tn_doctype.list
wm_tn_doctype.update
wm_tn_doctype.view
wm_tn_enumerate_cancel
wm_tn_enumerate_deleteQueryResults
wm_tn_enumerate_nth
wm_tn_enumerate_unregister
wm_tn_mime_addBodyPart
wm_tn_mime_addMimeHeader
wm_tn_mime_createCertsOnlyData
wm_tn_mime_createEncryptedData
wm_tn_mime_createMimeData
wm_tn_mime_createSignedAndEncryptedData
wm_tn_mime_createSignedData
wm_tn_mime_getBodyPartContent
wm_tn_mime_getBodyPartHeader
wm_tn_mime_getContentType
wm_tn_mime_getDigest
wm_tn_mime_getMimeHeader
wm_tn_mime_getNumParts
wm_tn_mime_getParameterList
wm_tn_mime_getPrimaryContentType
wm_tn_mime_getSharedInputStream
wm_tn_mime_getSize
wm_tn_mime_getSubContentType
wm_tn_mime_processCertsOnlyData
wm_tn_mime_processEncryptedData
wm_tn_mime_processSignedData
wm_tn_mime_removeHeader
wm_tn_mime_resetMimeHeader
wm_tn_mime_setDigestAlgorithm
wm_tn_mime_sign
wm_tn_mime_verify
wm_tn_mime_writeToStream
wm_tn_polling_acceptDocument
wm_tn_polling_localCheck
wm_tn_polling_remoteCheck
wm_tn_profile_addAddresses
wm_tn_profile_addConnections
wm_tn_profile_addContacts
wm_tn_profile_addIDs
wm_tn_profile_addProfile
wm_tn_profile_addProfileGroups
wm_tn_profile_addUsers
wm_tn_profile_changeStatus
wm_tn_profile_deleteAddress
wm_tn_profile_deleteConnection
wm_tn_profile_deleteConnectionOfPartner
wm_tn_profile_deleteContact
wm_tn_profile_deleteID
wm_tn_profile_deleteProfile
wm_tn_profile_deleteProfileGroup
wm_tn_profile_deleteUser
wm_tn_profile_deleteUsers
wm_tn_profile_getExtendedFields
wm_tn_profile_getExternalID
wm_tn_profile_getExternalIDs
wm_tn_profile_getHostProfile
wm_tn_profile_getInternalID
wm_tn_profile_getInternalIDsByGroup
wm_tn_profile_getInternalIDsForUser
wm_tn_profile_getPartnerBinary
wm_tn_profile_getProfile
wm_tn_profile_getProfileGroups
wm_tn_profile_getProfileMappings
wm_tn_profile_getProfileSummaries
wm_tn_profile_getProfileSummary
wm_tn_profile_getUserProfiles
wm_tn_profile_getUserProfilesSummaries
wm_tn_profile_getUsersForPartner
wm_tn_profile_setExtendedFields
wm_tn_profile_setPartnerBinary
wm_tn_profile_undeleteProfile
wm_tn_profile_updateConnections
wm_tn_profile_updateAddresses
wm_tn_profile_updateContacts
wm_tn_profile_updateCorporation
wm_tn_profile_updateIDs
wm_tn_profile_updateProfileGroups
wm_tn_profile_newAddress
wm_tn_profile_newContact
wm_tn_profile_newDelivery
wm_tn_profile_newExternalID
wm_tn_profile_newPrivateQueue
wm_tn_profile_newProfile
wm_tn_query_createDocumentQuery
wm_tn_query_createEventQuery
wm_tn_query_createProfileQuery
wm_tn_query_createTaskQuery
wm_tn_query_createTPAQuery
wm_tn_query_deliveryServiceDelete
wm_tn_query_deliveryServiceQuery
wm_tn_query_documentQuery
wm_tn_query_doQuery
wm_tn_query_eventDelete
wm_tn_query_eventQuery
wm_tn_query_getQueryResults
wm_tn_query_getSQL
wm_tn_query_profileQuery
wm_tn_query_taskDelete
wm_tn_query_taskQuery
wm_tn_query_tpaQuery
wm_tn_queuing_deliverBatch
wm_tn_queuing_getQueuedTask
wm_tn_queuing_getRegisteredQueue
wm_tn_queuing_getRegisteredQueues
wm_tn_queuing_listQueuedTasks
wm_tn_queuing_queueDocument
wm_tn_queuing_reassign
wm_tn_queuing_registerQueue
wm_tn_queuing_removeQueue
wm_tn_queuing_updateQueue
wm_tn_queuing_updateQueuedTask
wm_tn_route_abort
wm_tn_route_add
wm_tn_route_alert
wm_tn_route_containsRuleName
wm_tn_route_create
wm_tn_route_delete
wm_tn_route_disableDeliveryForPartner
wm_tn_route_getAllMatches
wm_tn_route_getAnyTask
wm_tn_route_getLastChangeID
wm_tn_route_getRule
wm_tn_route_getTask
wm_tn_route_list
wm_tn_route_load
wm_tn_route_mergeFlags
wm_tn_route_preroute
wm_tn_route_route
wm_tn_route_routeBizdoc
wm_tn_route_update
wm_tn_security_addCertificateData
wm_tn_security_deleteCertificateData
wm_tn_security_getAllCertificateData
wm_tn_security_getCertificateData
wm_tn_security_getDecryptionKeyAndCert
wm_tn_security_getEncryptionChain
wm_tn_security_getSigningKeyAndChain
wm_tn_security_getSSLKeyAndChain
wm_tn_security_getVerifyingChain
wm_tn_security_queryExpiredCertificates
wm_tn_security_setPrimaryCertificate
wm_tn_security_setSSLKeyAndChain
wm_tn_security_updateCertificate
wm_tn_security_updateCertificateData
wm_tn_security_changeServerForTask
wm_tn_security_getAnyTask
wm_tn_security_getTask
wm_tn_security_getTaskOutput
wm_tn_security_getTasks
wm_tn_security_getTaskStatus
wm_tn_security_reassign
wm_tn_security_removeTask
wm_tn_security_restartTask
wm_tn_security_shutdown
wm_tn_security_stopTask
wm_tn_security_updateProperties
wm_tn_tpa_changeStatus
wm_tn_tpa_createTPA
wm_tn_tpa_deleteTPA
wm_tn_tpa_getTPA
wm_tn_tpa_getTPAInLock
wm_tn_tpa_getTPALock
wm_tn_tpa_nextControlNumber
wm_tn_tpa_releaseTPALock
wm_tn_tpa_setLockError
wm_tn_tpa_updateControlNumber
wm_tn_tpa_updateControlNumberInLock
wm_tn_tpa_updateTPA
wm_tn_tpa_updateTPAData
wm_tn_tpa_updateTPADataInLock
wm_tn_tpa_validateTPA
wm_tn_tpa_transport_activeTransfer
wm_tn_tpa_transport_batchFtp
wm_tn_tpa_transport_Ftp
wm_tn_tpa_transport_Ftps
wm_tn_tpa_transport_Sftp
wm_tn_tpa_transport_Http
wm_tn_tpa_transport_Https
wm_tn_tpa_transport_primaryFtp
wm_tn_tpa_transport_primaryFtps
wm_tn_tpa_transport_primaryHttp
wm_tn_tpa_transport_primaryHttps
wm_tn_tpa_transport_primarySmtp
wm_tn_tpa_transport_primarySftp
wm_tn_tpa_transport_secondaryFtp
wm_tn_tpa_transport_secondaryFtps
wm_tn_tpa_transport_secondarySftp
wm_tn_tpa_transport_secondaryHttp
wm_tn_tpa_transport_secondaryHttps
wm_tn_tpa_transport_secondarySmtp
wm_tn_transport_Smtp
wm_tn_transport_webService
wm_tn_util_longToSqlTimestamp
wm_tn_util_stringListToDateList
wm_tn_util_stringListToDoubleList
wm_tn_util_stringToDate
wm_tn_util_stringToDouble
wm_tn_rec_BizDocSigningService
wm_tn_rec_BizDocValidationService
wm_tn_rec_BizDocVerificationService
wm_tn_rec_DeliveryServiceSignature
wm_tn_rec_DupCheckService
wm_tn_rec_ProcessingService
wm_tn_rec_ReliableProcessingService
wm_tn_rec_GatewayService
wm_tn_rec_TPAValidationService
wm_tn_rec_ActivityLogEntry
wm_tn_rec_Address
wm_tn_rec_BizDocAttribute
wm_tn_rec_BizDocContentPart
wm_tn_rec_BizDocContentPartCriteria
wm_tn_rec_BizDocEnvelope
wm_tn_rec_BizDocErrorSet
wm_tn_rec_BizDocType
wm_tn_rec_BizDocTypeSummary
wm_tn_rec_Contact
wm_tn_rec_Corporation
wm_tn_rec_Delivery
wm_tn_rec_DeliveryService
wm_tn_rec_DeliveryServiceOutput
wm_tn_rec_ExternalID
wm_tn_rec_Field
wm_tn_rec_FieldMetaData
wm_tn_rec_activeTransferOutput
wm_tn_rec_FtpDeliveryServiceOutput
wm_tn_rec_FtpOutput
wm_tn_rec_SftpDeliveryServiceOutput
wm_tn_rec_SftpOutput
wm_tn_rec_HttpDeliveryServiceOutput
wm_tn_rec_HttpOutput
wm_tn_rec_PreProcessingFlags
wm_tn_rec_Profile
wm_tn_rec_ProfileSummary
wm_tn_rec_queryField
wm_tn_rec_queryInput
wm_tn_rec_queryOutput
wm_tn_rec_ReliableServiceOutput
wm_tn_rec_SmtpDeliveryServiceOutput
wm_tn_rec_SmtpOutput
wm_tn_rec_svcResponse
wm_tn_rec_Task
wm_tn_rec_TaskDbUpdate
wm_tn_rec_TaskFailure
wm_tn_rec_tpa
wm_tn_rec_tpaError
wm_tn_rec_TPAValidateServiceOutput
wm_tn_rec_WebServiceDeliveryServiceOutput
wm_tn_rec_WebServiceOutput
config_samlv2_sso_for_at_webclient
at_overview
at_what_is_at
at_features
at_capabilities
at_usage_scenarios
at_supported_protocols
configure_activetransfer
configure_mashzone
configure_mashzone_environment
configure_mashzone_with_at
server_listeners
listeners_advanced_functionalities
listener_add_listeners
listener_configure_advanced_settings
listener_check_listener_status
listener_modify_listeners
server_gateways
gateways_advanced_functionalities
gateway_add_gateways
gateway_configure_advanced_settings
gateway_modify_gateways
server_folders
folders_advanced_functionalities
folder_add_folders
folder_configure_advanced_settings
folder_modify_folders
folder_search_folders
server_actions
action_add_postprocessing_actions
action_add_scheduled_actions
action_add_monitor_folder_actions
action_task_configuration_definitions
action_task_find
action_task_copy
action_task_move
action_task_delete
action_task_rename
action_task_encrypt
action_task_decrypt
action_task_zip
action_task_unzip
action_task_writecontent
action_task_execute_is_service
action_task_execute_tn_service
action_task_execute_script
action_task_send_email
action_task_write_file_to_db
action_task_jump
action_task_exclude
action_task_error
action_activate_deactivate_actions
folder_modify_actions
action_search_actions
users
users_advanced_functionalities
users_add_new_user
users_associate_mws_users
users_associate_mws_roles
users_associate_mws_groups
users_advanced_settings
users_modify_users
users_search_users
users_search_roles
users_search_groups
templates
template_add_templates
template_configure_advanced_settings
template_modify_templates
logs
view_file_transaction_log
view_action_log
view_audit_log
monitor_analytics
view_agent_action_log
view_agent_activity_log
ta-downloading_transaction__activity_logs
proxy_servers
proxy_server_usage_scenarios
proxy_add_proxy_servers
settings
at_settings_advanced_functionalities
settings_configure_server_preferences
settings_acceleration
acceleration_add_tunnels
tunnel_configure_advanced_settings
tunnel_modify_tunnels
configure_audit_settings
configure_fileshare_settings
configure_properties
ui_permissions_overview
config_ui_permissions
search_ui_permissions
archive_db_overview
config_db_for_archive
config_at_archive_db_pool
config_at_for_archive
archive_db
schedule_archive
search_archive_db
execute_stored_procedure_for_archive
configure_admin_settings
user_data_concept
user_data_log_files
user_data_at_database
user_data_mws_database
help_refactor_guidelines
help_refactoring_elements
help_search_guidelines
help_search_elements_packagenavigator
test_flow
for_each_map
define_map_service
map_service
build_map_service
create_map_service
set_map_property
graphical_tree_tab
help_working_with_RAD_openapi
rad_createfrmopenapiprov
rad_general_openapi
rad_server_openapi
rad_resources_openapi
rad_schemas_openapi
rad_security_openapi
rad_tags_openapi
rad_source_openapi
help_generate_REST
help_RESTV2_res_opn
rad_secdefine
rad_resttags
rad_edit
rad_createfromswagger
rad_is_swagger_mapping
help_working_with_RAD
rad_createfrmswaggerconsu
help_publish_REST_API
help_configure_json_documenttype
help_graphql_create
help_graphqlDataloader_create
help_with_websocket
help_with_server_endpoint
rad_create
help_working_with_recipes
help_ffschema_create
help_configure_connection
help_connect_API-Portal
help_remove_gateway_connection
help_configure_gateway_connection
help_publish_REST_wsd
help_connect_IC
help_configure_ICconnection
help_cloud_overview_clouddep
help_cloud_deploy_asset
help_cloud_overview_assetrepo
help_cloud_open_assetrepoview
help_cloud_build_assetinrepoview
help_cloud_deploy_assetrepoview
help_cloud_del_asset
help_cloud_config_univmsg
help_cloud_landscapr_navigatorview
help_cloud_create_ccdef
help_cloud_edit_ccdef
help_cloud_del_ccdef
help_cloud_browse_runtimeconfig
help_cloud_export_depconfig
help_cloud_configproject