Server Configuration Parameters
This section contains a description of the
parameters you can specify in the
ActiveTransfer Server properties configuration file,
CommandCentral.cnf. This file is located in the
Integration Server_directory
\instances\instance_name\packages\WmMFT\config
directory on
ActiveTransfer Server. To update the files, you should first shut down
ActiveTransfer Server and, if you are using
ActiveTransfer Gateway, edit the file using a text editor. After you make the
changes, restart the
ActiveTransfer Server and Gateway.
ActiveTransfer Server uses default values for many of the parameters. If a parameter has a default, it is listed with the description of the parameter.
You can also use the wm.mft.admin:manageProperties service to view and change the current values of some of these parameters. For details, see webMethods ActiveTransfer Built-In Services Reference.
mft.aliases.tn
Specifies the remote server aliases for Trading Networks instances hosted on remote Integration Server hosts. These remote server aliases are defined in the Integration Server Administrator portal. When synchronizing partner details and transferring files to remote Trading Networks instances, ActiveTransfer checks this parameter in order to determine to which remote Trading Networks instances it must connect. Use commas to separate the remote server aliases.
mft.aliases.tn=remote server alias 1,remote alias 2,remote
alias 3
If you do not specify any value in this parameter, ActiveTransfer only connects to local Trading Networks instances (that is, Trading Networks instances hosted on the same Integration Server host as ActiveTransfer).
mft.client.file.optimizeListing
Specifies if ActiveTransfer's optimized or normal file listing functionality must be used on Microsoft Windows Server directories.
When you have an extremely large number of files for
ActiveTransfer to list, set this parameter to
true to enable the optimized file listing
functionality. If you retain the default value of
false,
ActiveTransfer uses its normal file listing functionality.
mft.client.ftp.list.command
Specifies the list command to use on remote FTP servers. The value for this parameter is not case-sensitive. The possible values are:
LIST. ActiveTransfer executes the LIST command to list the file directories on the remote FTP servers. LIST is the default value if you have not specified a value for the parameter or if the value you specified is invalid.MLST. If the remote FTP servers support the MLST command, ActiveTransfer executes the MLST command to list the file directories on the remote servers. If the remote FTP servers do not support the MLST command, LIST command is used.
mft.client.http.maxUploadSize
Specifies the maximum file size for non-chunked
data in upload operations to HTTP(S) servers. The default value is
10 MB.
mft.client.outbound.useProxy
Specifies if you want to enable the use of proxy server settings for file transfers. The possible values are:
true: Supports outbound connections through proxy servers.false: ActiveTransfer ignores all proxy server alias configurations, and creates a direct connection to the remote server. This is the default.
mft.client.session
This section describes the parameters that you can configure in the ActiveTransfer Server cache for client sessions. These parameters are only available with ActiveTransfer Server 9.7 fix 7 and higher.
- mft.client.session.cache.ttl
- This parameter relates to the caching of
the client sessions created to connect to remote servers when
ActiveTransfer executes an event. Specifies the time-to-live in seconds
for the client session stored in the cache. A client session is logged out and
removed from the cache when this parameter is exceeded. The default value is
120seconds. - mft.client.session.cache.pingInterval
- This parameter relates to the caching of
the client sessions created to connect to remote servers when
ActiveTransfer executes an event. Specifies the idle time in seconds for
a client session stored in the cache after which a test command is run to
verify if the client session is valid, before the session is used again. The
default value is
30seconds. If the value of this property is set to0, ActiveTransfer runs a test command to verify the validity of the session each time, prior to executing a remote operation. Set the value of this property to a higher value (>0) to reduce the number of test commands to run in scenarios that involve transfer of a large number of files, and frequent use of remote operations.
- mft.event.session.reuse
-
Important: Do not configure this parameter in your production environment. This parameter is provided to help solution providers debug the individual actions in an event.ActiveTransfer reuses the connections (sessions) to remote servers that are created by ActiveTransfer event actions. This is achieved by caching the sessions for the event and reusing them later in similar actions within the same event instance. This parameter specifies if client sessions should be reused or not in ActiveTransfer events. The default value is
true. If you set this parameter tofalse, a new session is created for each operation involving a remote server connection in the ActiveTransfer event actions. The new session is closed soon after the remote operation is completed.
- mft.log.sessionlog.disable
- Specifies if logging of session information should be disabled for individual user sessions.
mft.client.sftp.unmask
Specifies the default unmask used to connect to
SFTP servers. The default value is
022.
mft.db
This section describes the parameter you can set in ActiveTransfer to retry a database connection.
- mft.db.connection.retry
- Specifies the number of times
ActiveTransfer should retry a connection to a database when there is a
broken connection caused by transient database errors. The default value is
0.
- mft.db.connection.retryInterval
- Specifies the interval in seconds
ActiveTransfer should wait between connection retries to a database. The
default value is
10seconds.
mft.commandcentral
This section describes the parameters you can use
to register the
Command Central
instance used to install
ActiveTransfer Agent
instances. These parameters are available in the
CommandCentral.cnf file.
ActiveTransfer Server
uses the information in these parameters to connect to the
Command Central
instance when synchronizing agent installation details from
Command Central.
- mft.server.commandCentral.host
- Specifies the host name or IP address of the machine that hosts the Command Central instance used to install ActiveTransfer Agent instances.
- mft.server.commandCentral.port
- Specifies the port for the Command Central instance used to install ActiveTransfer Agent instances.
- mft.server.commandCentral.port.secure
- Specifies if communication between the Command Central instance and ActiveTransfer Server must use SSL protocol.
- mft.server.commandCentral.username
- Specifies the user name to use when ActiveTransfer Server connects with Command Central.
- mft.server.commandCentral.password
- Specifies the password to use when ActiveTransfer Server connects with Command Central.
mft.event
This section describes the parameter you can set for post-processing events configured on ActiveTransfer Server.
- mft.event.sleep.time
- Specifies the time interval
ActiveTransfer Server should wait to trigger a post-processing event. The
default is
1second. If you set the value of this property to20seconds, ActiveTransfer Server holds a post-processing event in a queue and triggers the event along with the other events that are queued, at 20 second intervals.
- mft.event.scheduler.runAsUser
- Specifies the user name associated with the
scheduled task whenever an
Integration Server
scheduled task is created by
ActiveTransfer.
The default is
Administrator. However, ActiveTransfer does not change the user while updating the scheduled task.
mft.group.aliases
Specifies the remote server aliases of ActiveTransfer nodes that are part of a group. The remote server aliases are defined in the Integration Server Administrator portal. ActiveTransfer instance shares asset information with other ActiveTransfer nodes in the group.
For example:
mft.group.aliases=remote server alias 1,remote server alias
2,remote server alias 3
For instance, let us assume that you have node A and node B. Now,
to configure the
mft.group.aliases for node A, you must point it
as,
mft.group.aliases=node B, excluding node A.
Configuring the node that points to itself results in a performance issue.
mft.http
This section describes the parameters you can configure for HTTP ports.
- mft.http.default.port
- Specifies the default HTTP port for
ActiveTransfer Server to use for collecting data for the Logs page. The default
is
2080.
mft.query.maxrows
Specifies the maximum number of asset records to fetch from the database and display in the My webMethods Server management and monitoring pages. The maximum value for this parameter is 1000.
mft.never.ban.list
Restart the ActiveTransfer Server and the ActiveTransfer Gateway instances associated with the server for this property to take effect.
mft.partners.useTNPartners
Specifies if ActiveTransfer must synchronize with and use the partners configured in Trading Networks. You can either use ActiveTransfer partners or Trading Networks partners, not both.
The default value is
false. Set this parameter to
false if you want to use partners configured in
ActiveTransfer.
true to use partners configured in
Trading Networks.
On changing the parameter value to
true, the
ActiveTransfer
partners become invalid.
mft.server
This section describes the parameters you can configure for ActiveTransfer Server to enable SSO.
- mft.server.https.auth.saml
- The default value is
false. Set this parameter totrueto enable SSO for HTTPS listeners in ActiveTransfer Server for access through the ActiveTransfer web client.
- mft.server.https.auth.saml.redirecturi
- The default value is
false. Set this parameter totrueand set the ActiveTransfer Server URL that you provided when registering with the identity provider.
mft.session.replication
This section describes the parameters you can configure for ActiveTransfer Servers to enable session replication in a group of ActiveTransfer Servers.
- mft.session.replication.enable
- Enables session replication for this
ActiveTransfer Server node. The default value is
false. If you want to enable session replication in an ActiveTransfer Server node, change the value of this property totrue.
- mft.session.replication.address
- Specifies the IP address or host name, and port details of this ActiveTransfer Server node. The parameters are as follows:
- mft.session.replication.other.nodes
- Specifies the IP address or host name, and port details of the ActiveTransfer Server nodes that forms a group with this server node. The parameters are as follows:
mft.sharing.account.tempdir
Specifies the shared file location. Use only forward slashes in the file path. For example, D:/activetransfer/sharedcontent/.
Software AG recommends that you replace the default shared file location with any local or shared directory.
mft.ssl.client
This section describes the parameter you can configure for SSL authentication of a remote server.
- mft.ssl.client.acceptAnyCert
- Specifies if
ActiveTransfer Server should validate the SSL certificates from a remote server
against the certificates in its truststore and allow communication only from
trusted remote servers, or accept all SSL certificates. The default is
true. Set the value of the property tofalseif you want ActiveTransfer Server to accept SSL certificates only from servers that have a truststore entry.
- mft.ssh.client.preferred.publickey
- Specifies the preferred public key
algorithm that
ActiveTransfer Server should use to communicate with a SFTP server. The default
is
ssh-dss. Set the value of the property tossh-rsaif you want ActiveTransfer Server to use the RSA key as the preferred public key algorithm. You must restart Integration Server for this change to take effect. This property is available only on the application of ActiveTransfer Server 9.7 Fix 4 and higher.
mft.user.email
This section describes the parameters you can configure for the emails that are sent to ActiveTransfer users.
- mft.user.email.from
- Specifies the email address of the ActiveTransfer administrator who will send messages to ActiveTransfer users when adding or editing the user’s profile. If this parameter is not set, the message is sent without any “from email” address. The value you specify here is overridden by any value you set in the File Share settings.
- mft.user.email.public.ip
- Specifies the
ActiveTransfer Server host name to use for the external server URL that is
emailed to users for logging in to the server. If this parameter is not set,
the internal IP address is used in the email. This parameter also applies to
the email notifications sent for shared files. The shared file link contains
either the
ActiveTransfer Server or
ActiveTransfer Gateway
if the source location of the shared file is the
ActiveTransfer Server VFS or
ActiveTransfer Gateway.
For example, the host for ActiveTransfer Server port 8080 is defined on the Server Management page as localhost or 127.9.1.10. If this parameter is not set, the server URL that is emailed to users will contain the internal IP address of the server (in this example, http://localhost:8080 or http://128.1.10:8080, respectively). If you set this parameter to the external host or domain name that your organization uses to represent the server’s internal IP address, the server URL will reflect the external host name (for example, http://xyz.com:8080).
- mft.user.email.subject
- Specifies the subject line of the email message that is sent to the user. If this parameter is not set, messages are sent without any subject.