webMethods ActiveTransfer Documentation
About this Documentation
Document Conventions
Online Information and Support
Data Protection
Using ActiveTransfer
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
Administering ActiveTransfer Server
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 to Support Single Sign-On
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
Welcome to webMethods ActiveTransfer (new user interface)
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
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 or Scheduled Action
Searching for a Post-Processing or Scheduled 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 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
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
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
Security Configuration Parameters
Server Variables
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.commandcentral
mft.event
mft.group.aliases
mft.http
mft.query.maxrows
mft.never.ban.list
mft.partners.useTNPartners
mft.session.replication
mft.server
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
Administering 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.
Administering ActiveTransfer Agent
Understanding ActiveTransfer Agent
What is ActiveTransfer Agent?
How ActiveTransfer Agent Works
Setup Summary for ActiveTransfer Agent
Installing ActiveTransfer Agent
Overview
ActiveTransfer Agent License File
Prerequisites for Installing ActiveTransfer Agent
Preparing ActiveTransfer Server for ActiveTransfer Agent Installation
Using Command Central to Install ActiveTransfer Agent
Configuring ActiveTransfer Server Details for the Agent
Installing ActiveTransfer Agent Directly On-Premise
Configuring the ActiveTransfer Server on the ActiveTransfer Agent Host
Managing Agents, Groups, and Events
Overview
Managing ActiveTransfer Agents
Synchronizing ActiveTransfer Agent Installations from Command Central
Registering ActiveTransfer Agents Directly Installed On Premise
Editing Agent Details
Defining Filters for Agents
ActiveTransfer Agent Statuses in ActiveTransfer Server
ActiveTransfer Agent Availability in ActiveTransfer Server
Creating Agent Groups
Creating Agent Events
Agent Event Statuses in ActiveTransfer Server
Monitoring ActiveTransfer Agents
Overview
Defining Filters for Agent Event Logs
Viewing Agent Event Logs
Defining Filters for Agent Activity Logs
Viewing Agent Activity Log Details
Configuration Parameters and Variables
Server Configuration Parameters
mft.agent.user
mft.agent.event.log.activityTypes
mft.commandcentral
Agent Configuration Parameters
mft.agent.client.assets.refresh.interval
mft.agent.client.auth.retry.interval
mft.agent.client.auth.retry.count
Server Variables
ActiveTransfer Agent Variables
File Reference Variables
Date/Time Variables
Working with Services in ActiveTransfer
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.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
Copyright
Copyright
webMethods ActiveTransfer Documentation
Copyright
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_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
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
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
server_config_parameters
security_config_parameters
server_variables