ftpsiteModel

Namespace:	http://filecatalyst.com/model
XML Schema:	model.xsd

FTP site model class

XML

Attributes

name	type	description
addUserToFCServer	boolean	Flag to indicate if users should be added to the FTP server.
address	string	Company contact address.
adminEmail	string	Administrator's email
backupDirectory	string	FTP backup directory location.
cellPhoneCarrier	cellPhoneCarrierType	Company contact cell phone carrier. See cellPhoneCarrierType.
cellPhoneNumber	string	Company contact cell phone number.
company	string	Company name.
enableRemoteAdmin	boolean	Flag to enable remote administration of a FileCatalyst server.
fax	string	Company fax number.
friendlyName	string	This is the actual text that will appear to the end users for the site name. Default Site ID will be used if this text is not set.
host	string	FTP host DNS name or IP address.
id	string	Unique FTP site ID.
initdir	string	Initial Directory.
isDefault	boolean	Flag to indicate if this is the default server.
isFileCatalystServer	boolean	Flag to indicate if this is a FileCatalyst server.
jobFilesLocation	string	Specifies the location where to store the job files.
jobPDFLocation	string	Specifies the location where to store the PDF files.
pass	string	FTP user password.
passive	boolean	Flag to indicate if the FTP server uses passive mode.
port	int	FTP server port. Usually 21.
remoteAdminPass	string	Remote administration password for a FileCatalyst server.
remoteAdminPort	int	Remote administration port for a FileCatalyst server.
remoteAdminUser	string	Remote administration user for a FileCatalyst server.
serverType	string	FTP server type.
telephone	string	Company contact telephone number.
transferMode	ftpTransferType	Connection Type can be set to regular FTP or FTPS (Implicit). Some FTP server can accept secure FTPS connections, set your connection type if your FTPS server can accept secure connections via FTPS (Implicit mode). See ftpTransferType.
useInternal	boolean	This option will toggle the use of the internal FTP server. If you would like to use the default internal FTP server, please check the "Use Internal Server" field. This will automatically overwrite the entries in the host, username, password, and port fields to those of the internal server. To use the internal server, please ensure it is enabled from the "Edit Internal FTP" menu within the Administration Control Panel.
user	string	FTP user credentials.
postScript	string	Post script command
href	string	Hyperlink reference to the resource

JSON

property	type	description
addUserToFCServer	boolean	Flag to indicate if users should be added to the FTP server.
address	string	Company contact address.
adminEmail	string	Administrator's email
backupDirectory	string	FTP backup directory location.
cellPhoneCarrier	cellPhoneCarrierType	Company contact cell phone carrier. See cellPhoneCarrierType.
cellPhoneNumber	string	Company contact cell phone number.
company	string	Company name.
enableRemoteAdmin	boolean	Flag to enable remote administration of a FileCatalyst server.
fax	string	Company fax number.
friendlyName	string	This is the actual text that will appear to the end users for the site name. Default Site ID will be used if this text is not set.
host	string	FTP host DNS name or IP address.
id	string	Unique FTP site ID.
initdir	string	Initial Directory.
isDefault	boolean	Flag to indicate if this is the default server.
isFileCatalystServer	boolean	Flag to indicate if this is a FileCatalyst server.
jobFilesLocation	string	Specifies the location where to store the job files.
jobPDFLocation	string	Specifies the location where to store the PDF files.
pass	string	FTP user password.
passive	boolean	Flag to indicate if the FTP server uses passive mode.
port	int	FTP server port. Usually 21.
remoteAdminPass	string	Remote administration password for a FileCatalyst server.
remoteAdminPort	int	Remote administration port for a FileCatalyst server.
remoteAdminUser	string	Remote administration user for a FileCatalyst server.
serverType	string	FTP server type.
telephone	string	Company contact telephone number.
transferMode	ftpTransferType	Connection Type can be set to regular FTP or FTPS (Implicit). Some FTP server can accept secure FTPS connections, set your connection type if your FTPS server can accept secure connections via FTPS (Implicit mode). See ftpTransferType.
useInternal	boolean	This option will toggle the use of the internal FTP server. If you would like to use the default internal FTP server, please check the "Use Internal Server" field. This will automatically overwrite the entries in the host, username, password, and port fields to those of the internal server. To use the internal server, please ensure it is enabled from the "Edit Internal FTP" menu within the Administration Control Panel.
user	string	FTP user credentials.
postScript	string	Post script command
href	string	Hyperlink reference to the resource