B2B Integration
Understanding Software AG Products
About this Guide
Quick Start
Agile Process Quick Start
Design
Analysis
Governance
Implementation
Execution
Administration and Monitoring
Composite Applications
Analytics & Decisions Quick Start
API Management Quick Start
Application Integration Quick Start
Development
Local Development and Testing
Execution
Events
Administration and Monitoring
B2B Integration Quick Start
In-Memory Data Management
Master Data Management Quick Start
Agile Process
Business Process Management
Designing Business Processes
ARIS Connect, ARIS Designer, and ARIS Architect
Software AG Designer
Governing Business Process Models
Implementing Business Process Models
Software AG Designer
Developing Services
Developing Rules
Developing Tasks
Task Engine
AgileApps
Terracotta
Executing Business Processes
Integration Server
Universal Messaging
My webMethods Server
Business Process Model Implementation Details
Creating Documents, Services, Tasks, and Rules
Developing Tasks Within a Process
Simulating and Debugging Business Processes
Logging and Monitoring Processes
Mapping Process Steps to Run Times
Developing in a Collaborative Environment
Developing Composite Applications
Software AG Designer
Application Platform
My webMethods Server
Integration Server
Developing in a Collaborative Environment
Administering and Monitoring Business Processes
Administering Business Processes
Monitoring Business Process Instances
Administering and Working with Business Processes and Tasks
Solving Problems with Closed Loop Analytics
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
Analytics & Decisions
Analytics & Decisions
Business Event Processing
Business Activity Monitoring
Products Involved in Analytics & Decisions
Analytics & Decisions Example
Visualizing Data
MashZone NextGen Business Analytics
MashZone NextGen Visual Analytics
Terracotta
Mining Process Data and Analyzing Root Causes
ARIS Process Performance Manager
Defining Baselines, Metrics, and Alerts
Optimize for Process
Terracotta
Detecting and Analyzing Complex Patterns in Real Time
Apama
Developing Apama Applications
Integrating Apama with External Data Sources
Building Dashboards
Making Predictions
Zementis Predictive Analytics
Monitoring System Resources
Optimize for Infrastructure
Sharing Events Across Products
Digital Event Services
Universal Messaging
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
API Management
API Management
Exposing and Consuming APIs
API Portal
Governing and Securing Your API Management System
Mediator
Terracotta
CentraSite
Terracotta
Enterprise Gateway Server
API Gateway
Terracotta
Monitoring and Managing Your API Management System
Insight
Application Integration
Application Integration
Developing Application Integrations
Software AG Designer
CloudStreams
Terracotta
Adapters
Integration Cloud
EntireX
ApplinX
Web Enablement
Instant Solution
HTML Emulation Solution
Composite Solution
SOA Enablement
Webpage Integration
Developing and Testing Integration Server Assets Locally
Local Version Control Integration
Unit Test Framework
Application Platform
Executing Application Integrations
Integration Server
Terracotta
Integration Agent
Universal Messaging
Application Integration Examples
Synchronization
Propagation
Composition
Sharing Events Across Products
Digital Event Services
Universal Messaging
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
B2B Integration
B2B Integration
Building, Managing, and Monitoring a Trading Network
Trading Networks
Terracotta
eStandards Modules
Terracotta
Optimize for B2B
B2B Analytics
Managing File Transfers
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
In-Memory Data Management
In-Memory Data Management
Terracotta BigMemory Max
Terracotta Server Array
Master Data Management
Master Data Management
OneData
Working with My webMethods
About this Guide
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
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
Performing a Keyword Search for Users, Groups, or Roles
Advanced Searches
Performing an Advanced Search for Users or Groups
Searching for Data
About Searching for Data
Keyword Searches
Determining the Fields that Keywords are Searched Against
Performing a Keyword Search for Data
Basic and Advanced Searches
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
Software AG Event Routing
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
Software AG Event Routing
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
About this Guide
Understanding webMethods Trading Networks
webMethods Trading Networks
Architecture
Partners in a Trading Network
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
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
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
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 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
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
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
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
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
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
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
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
About this 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 Complex 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
Managing the Activity Log
Viewing Activity Log Entries
Deleting an Activity Log Entry
Trading Networks Built-In Services Reference
About this Guide
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: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: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:secondaryFtp
wm.tn.transport:secondaryFtps
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 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: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
Optimize for B2B User’s Guide
About this 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
About this Guide
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?
Using Command Central to Manage ActiveTransfer
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
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 ActiveTransfer to Work with Trading Networks
Configuring ActiveTransfer to Receive Partner Information in Trading Networks
Configuring Software AG MashZone for Analytics
Setting Up the Software AG MashZone Environment
Connecting Software AG MashZone Server to My webMethods Server
Starting and Stopping ActiveTransfer
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
Modifying 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
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
Setting 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
Managing ActiveTransfer Gateway
Overview
How ActiveTransfer Gateway Works
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
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 and User Groups
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
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 a 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
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 and 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
Migrating Assets
Overview
ActiveTransfer Assets You Can Migrate
Migration Methods
ActiveTransfer Asset Dependencies
How ActiveTransfer Server Detects Assets in the Target System Before Importing Them
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.outbound.useProxy
mft.client.session.
mft.client.sftp.unmask
mft.db
mft.external.tn.maxFileSize
mft.event.
mft.gatewayServer.
mft.group.aliases
mft.http.
mft.query.maxrows
mft.never.ban.list
mft.partners.useTNPartners
mft.session.replication.
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
ActiveTransfer Built-In Services Reference
About this Guide
Admin Folder
Overview
Summary of Elements in the Admin Folder
wm.mft.admin:exportData
wm.mft.admin:importData
wm.mft.admin:property
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.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
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
About this Guide
Understanding ActiveTransfer Web Client
Overview of ActiveTransfer Web Client
Preparing to Work with ActiveTransfer Web Client
Overview
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 with External Users
Miscellaneous
Rebranding the ActiveTransfer Web Client
Legal Notices
Copyright
B2B Integration
Copyright
to-b2b_integration_landing_page
to-quickstart
to-bus_process_mgmt
to-analytics_decisions
api_management
to-application_integration
to-b2b_integration
to-in_memory_data_mgmt
to-master_data_mgmt
to-login_out
to-fabric_ui
to-update_profile
ta-changing_time_zone
to-manage_workspaces
to-workspace_content
to-tools
to-search_principals
to-webm_products_using_terracotta
to-licensingRequirements
to-installing_terracotta_server_array
to-using_cc_to_manage
to-system_cache
to-admin_about_this_guide
to-admin_concepts
to-getting_started
to-configuration
to-permissions
to-attributes
to-XML_doctypes
to-flatfile_doctypes
to-delivery
to-rules
to-partner_onboarding
to-profiles
to-search
to-app_archive_delete_docs
to-database_partition
to-cache_configuration
to-managing_events
to-analytics
to-app_tn_config_props
to-app_tn_server_config_params
to-xql_ref
to-app_large_doc_handling
to-app_userstatus_example
to-user_about_this_guide
to-user_concepts
to-prepare
to-user_search
to-documents
to-activitylog
to-bis_about_this_guide
to-tnbis_coreservices
to-tnbis_adminfolder
to-tnbis_archivefolder
to-tnbis_chartingfolder
to-tnbis_deliveryfolder
to-tnbis_dictionaryfolder
to-tnbis_docfolder
to-tnbis_docattrfolder
to-tnbis_doctypefolder
to-tnbis_enumeratefolder
to-tnbis_mimefolder
to-tnbis_pollingfolder
to-tnbis_profilefolder
to-tnbis_queryfolder
to-tnbis_queuingfolder
to-tnbis_routefolder
to-tnbis_securityfolder
to-tnbis_taskfolder
to-tnbis_tpafolder
to-tnbis_transportfolder
to-tnbis_utilfolder
to-tnbis_servicespecifications
to-tnbis_isdocumenttypes
to-java_api
to-about_this_guide
to-overview
to-config
to-data_monitoring
to-about_this_guide_ag
to-understanding_active_transfer
to-configuring_active_transfer
to-granting_access_to_active_transfer
to-preparing_to_work_with_pages
to-managing_the_server
to-managing_gateway
to-managing_templates
to-managing_the_user
to-managing_virtual_folders
to-postprocessing
to-monitoring_active_transfer
to-viewing_log_information
to-migrate
to-server_variables
to-scheduled_event_options
to-jump-condition
to-activetransfer_access_points
to-about_this_guide_bis_ref
to-at-bis_adminfolder
to-at-bis_assetfolder
to-at-bis_schedulefolder
to-at-bis_securityfolder
to-at-bis_serverfolder
to-at-bis_documenttypes
to-about_this_guide_wc_ug
to-concepts
to-preparing_to_work_web_client
to-working_with_folder_files
to-tasks
to-miscellaneous
to-online-copyright-page