Integration Server 10.5 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client.ftp:sessioninfo
 
pub.client.ftp:sessioninfo
WmPublic. Returns session information for all of the FTP servers that users are currently logged into.
Input Parameters
name
Not used. Reserved for future use.
Output Parameters
sessioninfo
Document List Information about the current FTP sessions. Each document in sessioninfo represents a single session and contains the following information:
Key
Description
serverhost
String Name or IP address of the FTP server.
serverport
String Port number on which the FTP server listens for requests.
dataport
String Listener port of the data transfer channel used by this session.
username
String User logged on to FTP server.
password
String Password for the FTP user specified in username.
account
String Conditional. The user name for an account on the FTP server. The account is defined in the FTP protocol to further identify the user that is identified by the username and password input variables.
transfertype
String Data transfer mode (passive or active) used by this session.
encoding
String Conditional. IANA character set used by this session. If encoding is not returned, the encoding was not explicitly set and the default JVM encoding is in effect.
Usage Notes
When you start an FTP session with pub.client.ftp:login, you can set the optional dataport parameter to specify the port number for data transfers. During the FTP session, pub.client.ftp:sessionInfo returns the dataport parameter with the port number used for data transfers.
If you do not set the dataport parameter in pub.client.ftp:login, the server uses a random port number. During the FTP session, pub.client.ftp:sessionInfo will return a 0 for the dataport parameter to indicate that the port number used for data transfers is random.