<service>.ini
The service configuration files contain all the definitions of the file transfers to carry out. Each service has its own configuration file.
These definitions describe the Vaults that are used in the file transfers, and which Vault user accounts are used. They also describe the actual file transfer details – the source of the files to be transferred, the destination for the transfer, etc.
Note: These configurations are specified in the GUI, and must not be made manually.
Following is a description of each of the parameters in the service parameter file:
Token Meaning Mandatory Default
Value
Acceptable Values
Name The name of the service
Yes None String
Description A description of the service
No None String
UserName The username that will be used to log onto the Vault.
Yes No String
VaultName The name of the Vault that files will be transferred to or from.
Yes None String
SafeName The name of the Safe that files will be transferred to or from.
Yes None String
FolderName The name of the local folder that files will be transferred to or from.
Yes None Path
SafeFolderName The name of the folder in the Safe where files will be transferred to or from.
Yes None String
FilePattern The complete or part of the name of the file to transfer. You can use wildcards to specify more than one file.
Appendix A: Parameter Files
Token Meaning Mandatory Default
Value
Acceptable Values
ArchiveFolderName The name of the folder where files will be moved to after a service.
No None Path
PostMsg The message to display after a service has been carried out successfully.
No None String
FileNewName The new name of the file on the local file server after it has been copied into the Vault. This parameter is mandatory if RenameProperty =Yes None String
LogFileName The full path of the log file.
No None String
DesktopShortcutPath The path of the shortcut on the desktop to the service. No None Path SuccessMailTemplate Path
The path of the text file that contains the message to send by email. This parameter is mandatory if SendSuccessMail =Yes None Path
SuccessMailSubject The text to include in the Subject field.
This parameter is mandatory if SendSuccessMail =Yes
None String
SuccessMailServerIP The IP address of the Mail Server. This parameter is mandatory if SendSuccessMail =Yes None IP address SuccessMailSender Address
The e-mail address of the sender. This parameter is mandatory if SendSuccessMail =Yes None IP address SuccessMailRecipient Address
The e-mail address of the recipient. This parameter is mandatory if SendSuccessMail =Yes None IP address
ErrorMailTemplatePath The path of the text file that contains the message to send by email. This parameter is mandatory if SendErrorMail =Yes None Path
ErrorMailSubject The text to include in the Subject field.
This parameter is mandatory if SendErrorMail =Yes
Token Meaning Mandatory Default Value
Acceptable Values
ErrorMailServerIP The IP address of the Mail Server. This parameter is mandatory if SendErrorMail =Yes None IP address ErrorMailSender Address
The e-mail address of the sender. This parameter is mandatory if SendErrorMail =Yes None IP address ErrorMailRecipient Address
The e-mail address of the recipient.
This parameter is mandatory if SendErrorMail =Yes
None IP address
InteractiveRule Whether or not the service will display a user interface or not.
Yes No Yes/No Yes=with interface No=without interface InteractiveLogon Whether logon to the
Vault will be manual or with a credential file.
Yes Yes Yes/No Yes=manual logon
No=credential file logon DisplayInteractiveMsg Whether or not to
display success or error messages. Yes Yes/No Yes=display messages No=do not display messages OpenAfterDownload Whether or not to
open the file(s) after downloading them.
Yes No Yes/No Yes=open the files
No=do not open the files AddTimeStamp Whether or not to add
a timestamp to the filename after the transfer.
No No Yes/No Yes=add a timestamp No=do not add a timestamp AddTimestampOn
Archive
Whether or not to add a timestamp to the filename in the archive folder. This parameter is mandatory if PostOperation=1 No Yes/No Yes=add a timestamp No=do not add a timestamp RenameFile Whether or not to
rename a file after transferring it.
No No Yes/No Yes=rename the file No=do not rename the file
Appendix A: Parameter Files
Token Meaning Mandatory Default
Value
Acceptable Values
SendSuccessMail Whether or not to send a message after a successful transfer. No No Yes/No Yes=send message No=do not send message SendErrorMail Whether or not to
send a message after an unsuccessful transfer. Yes No Yes/No Yes=send message No=do not send message ChangePasswordOn EveryLogon Whether or not to change the user’s password after every logon. Yes No Yes/No Yes=change password No=do not change password PostOperation The action that will
be carried out after a transfer.
Yes 0 0/1
0=no action 1=archive 2=delete files ActionType Whether the service
will upload files into the Vault or
download them to a local file server.
Yes 0 0/1 0=upload 1=download
Vault.ini
The Vault.ini file contains all the information about the Vault.
Parameter Description Default Value Acceptable
Values
Vault The name of the Vault. None String Address The IP address of the Vault. None IP address Port The Vault IP Port. 1858 Number
Optional Parameters:
Timeout The number of seconds to wait for a Vault to respond to a command before a timeout message is displayed.
30 Number
AuthType The type of authentication to be used to log onto the Vault.
PA_AUTH PA_AUTH (Password), NT_AUTH, RADIUS_AUTH, PKI_AUTH NTAuthAgentName The name of the NT
Authentication Agent.
None String
NTAuthAgentKeyFile The name of the NT Authentication Key File.
None String
VaultDN The Distinguished Name of the Vault (PKI Authentication).
None String
ProxyType The type of proxy through which the Vault is accessed.
None HTTP, HTTPS, SOCKS4, SOCKS5 ProxyAddress The proxy server IP address.
This is mandatory when using a proxy server.
None IP address
ProxyPort The Proxy server IP Port. 8081 Number ProxyUser User for Proxy server if NTLM
authentication is required.
None User name
ProxyPassword The password for Proxy server if NTLM authentication is
required.
None Password
ProxyAuthDomain The domain for the Proxy server if NTLM authentication is required.
NT_DOMAIN_ NAME
Domain name
BehindFirewall Whether or not the Vault is being accessed via a Firewall.
Appendix A: Parameter Files
Parameter Description Default Value Acceptable
Values
UseOnlyHTTP1 Use only HTTP 1.0 protocol. Valid either with proxy settings or with BEHINDFIREWALL.
No Yes/No
NumofRecordsPerSend The number of file records to transfer together in a single TCP/IP send/receive commands.
15 Number
NumOfRecordsPer Chunk
The number of file records to transfer together in a single TCP/IP send/receive operation.
15 Number
ReconnectPeriod The number of seconds to wait before the sessions with the Vault is re-established.
1 Number
CIFSGateway The name of the CIFS Gateway. None String HTTPGatewayAddress The URL of the HTTP Gateway. URL URL