webMethods ActiveTransfer Documentation
Document Conventions
Online Information and Support
Data Protection
Using ActiveTransfer
Introduction to webMethods 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 contents of the Basket
Copying the Folder Link
Sharing Files and Folders
Overview
Sharing Files and Folders
Administering ActiveTransfer Server
Understanding ActiveTransfer
Overview of webMethods ActiveTransfer
What is webMethods ActiveTransfer?
Windows Deployment
Linux Deployment
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 Single Sign-On for ActiveTransfer User Interface
Managing Listeners
Overview
Features in Listeners
Adding a Listener
Configuring Additional Settings for a Listener
Configuring Single Sign-On for ActiveTransfer
Configuring Single Sign-On in Listeners User Interface
IDP initiated Single Sign-On in Properties.cnf
Activating or Deactivating a Listener
Modifying a Listener
Including Listener Information in User Emails
API Support for HTTP file operations
Introduction
Creating a folder
Deleting a file or a folder
Renaming a file or folder
Uploading a file
Listing of files
Verifying the input
Downloading a file
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
Operating Actions
Modifying a Post-Processing, Scheduled, or Monitor folder Action
Searching for a Post-Processing, Scheduled, or Monitor folder Action
Parameterizing Scheduled Action Tasks
Additional Information on Parameterizing Actions
Managing Users and Templates
Overview
Features in Users 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
Modifying a User
Password Change (By Administrators)
Password Change (By Partner Users)
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
Rerun a Post-Processing Action
Viewing the Audit Log
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 Certificates
Overview
Adding Certificates
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
Configuring ActiveTransfer to Send Emails
Configuring the SMTP Server
Configuring Default Email Settings in the User Interface
Configuring Default Email Settings in properties.cnf
Disabling Email Alerts
Configuring Password Complexity for Users
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
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
Importing Assets
Exporting Assets
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.client.zip.extract.maxFileSize
mft.client.zip.extract.maxFiles
mft.sftp.port.forward.allow
mft.client.sftp.unmask
mft.db
mft.server
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
mft.server.event.monitor.threads
mft.server.event.monitor.fileEvent.threads
mft.server.http.header.csp.xss
mft.server.http.header.csp
mft.event.scheduler.target.anyServer
mft.ui.client.json.user.agent
mft.webclient.change.password.disabled
mft.server.http.response.header.server
mft.server.sftp.auth.keyboard.prompt
mft.activity.log.show.filesize
mft.client.ftp.pasv.ip.auto.skip
mft.client.sftp.ciphers.preferred
mft.client.sftp.ciphers.exclude
mft.fileshare.use.password.config
Security Configuration Parameters
mft.ssl
mft.web.security
Server Variables
Calendar and Processing Options for Scheduled Actions
Scheduled Action 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
Limitations
Limitations
Administering ActiveTransfer Gateway
Introduction to Managing File Transfers with webMethods 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
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
Administering ActiveTransfer Agent
Introduction to Managing File Transfers with webMethods 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 Actions
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 Actions
Agent Action Statuses in ActiveTransfer Server
Monitoring ActiveTransfer Agents
Overview
Defining Filters for Agent Action Logs
Viewing Agent Action 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
Introduction to webMethods 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.scheduledEvent:changeStatus
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
Copyright
webMethods ActiveTransfer Documentation
Copyright
at_overview
at_what_is_at
install_activetransfer_server
at_features
at_capabilities
at_usage_scenarios
at_supported_protocols
configure_activetransfer
server_listeners
listeners_advanced_functionalities
listener_add_listeners
listener_configure_advanced_settings
listener_check_listener_status
listener_modify_listeners
listener_include_listener_info_in_emails
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
rerun_post_process_action
view_audit_log
view_agent_action_log
view_agent_activity_log
ta-downloading_transaction__activity_logs
proxy_servers
proxy_server_usage_scenarios
proxy_add_proxy_servers
certificate_overview
adding_certificates
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
configuring_emails
configuring_smtp
configuring_emails_ui
configuring_emails_properties_cnf
disabling_emails
password_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
migrating_assets
importing_assets
exporting_assets
server_configuration_parameters_and_variables
server_configuration_parameters
security_configuration_parameters
server_variables
agents
agent_add_agents
agent_add_agent_groups
agent_add_agent_actions