Customize the initialize.properties file

A common practice is to copy the initialize.properties file, which you can find in the downloaded installation package. This leaves the initial version intact.

Customize (and rename if needed) the copy of the initialize.properties file. Use the table below to help you with parameter settings; note that the CryptoKey_Password is mandatory. If you want to use special characters in a configuration file field, protect the value by enclosing it in double quotation marks ("").

Note If you are installing Transfer CFT but have another Transfer CFT profile loaded, you cannot have environment variables in the initialize.properties file for the new installation.

Example

To use the # character in a value, for example, protect the entire string using "" as follows:

CryptoKey_Password = "Aedft#439"

If you do not enclose this value in "", the string is interpreted as: CryptoKey_Password = Aedft

Note Some parameters can be calculated during the installation (flagged by @automatic); you can leave these fields blank.
Note Parameters that have default values are flagged by @default.
Parameter Automatic or default Description UCONF 
Silent installation  
Installation architecture @default = single

Defines single or cluster mode installation.

Values: single, first_host, additional_host

N/A
installdir   Transfer CFT installation directory. cft.install_dir
Basic installation  
runtimeDir ./runtime

Transfer CFT runtime directory.

Specify the directory where you want to install the Transfer CFT runtime directory.

By default, the runtime directory is installed in a sub-directory of the Transfer CFT installation directory. Use the default directory, or specify a new directory. A runtime directory will be created if it does not already exist.

cft.runtime_dir

Full_Hostname

@automatic

Host Address of the local server: FQDN (Fully Qualified Domain Name) or IP Address. See Note*

cft.full_hostname
multinode_hostname @automatic

When not defined, this field is filled with the hostname of the machine where you are installing Transfer CFT, whether it is the first host or an additional host.

If the hostname contains a "." period, the value used consists of the name of the host preceding the first period. For example, "myhost.fqdn.net" would be shortened to "myhost".

cft.multi_node.hostnames
multinode_host_address @automatic

If you do not specify a value, the machine's FQDN address is used.

Note that if there is an error in the machine's configuration, the value taken could be incorrect. Be sure to check that you can ping the address, and that it is the value for the cluster network.

cft.multi_node.hostnames.<hostname>.host

Instance_ID

@default

 

The maximum length is 24. cft.instance_id
Instance_Group  

Transfer CFT instance group.

The maximum length is 1000.

cft.instance_group
Security configuration  

CryptoKey_Password

@mandatory

Seed password to generate the encryption key.

The password must contains at least 8 characters, contain upper and

lower case characters as well as numeric and special characters (*$!?+-@).

N/A

CryptoKey_Key_File

@default = $CFTDIRRUNTIME/data/crypto/crypkey Location that stores the generated key file. crypto.key_fname     

CryptoKey_Salt_File

@default = $CFTDIRRUNTIME/data/crypto/crypsalt Location that stores the generated salt file. crypto.salt_fname
Runtime configuration  

Key

 

Enter the license key for the Transfer CFT product.

The key is stored in the $CFTDIRRUNTIME/conf/cft.key.

Without the key you can install, but not start the product.

 
Catalog_File_Size @default= 10000

Sets the default catalog size.

cft.cftcat.default_size
Communication_File_Size @default = 1000 Sets the default communication file size. cft.cftcom.default_size
PESIT_Port @default = 1761

The port number of the PeSiT protocol.

 

samples.pesitany_sap.value
PESIT_SSL_Port @default = 1762 The port number of the PeSIT protocol using SSL. samples.pesitssl_sap.value
COMS_Port @default = 1765

The port number of the COMS synchronous communication media.

 

samples.coms_port.value
Copilot_Port @default = 1766

Sets the port number for the Transfer CFT UI server that listens for

incoming unsecured and secured (SSL) connections.

The same port number is used for the Graphical User Interface and Web Services

with or without SSL.

copilot.general.serverport
Copilot_OnlySSL @default = Yes

Copilot only allows SSL connection.

This value applies to the old Transfer CFT UI, Webservices and JPI.

If you set this to Yes, it disables the use of the HTTP server when an SSL context is defined (HTTPS only).

copilot.http.onlyssl
Copilot_SSL_Port @default = 1767 Sets the port number for the Transfer CFT UI server that listens for incoming secured (SSL with mutual authentication) connections. Only used by the Governance. copilot.general.ssl_serverport

UI_DefaultUser_Username

UI_DefaultUser_Password

UNIX systems only

The default Transfer CFT UI user/password.

N/A

RESTAPI_Enable

 

 

@default = Yes

Setting this to Yes activates the Transfer CFT REST API Server.

copilot.restapi.enable
RESTAPI_Port 1768

The port number used to connect to the REST API server.

copilot.restapi.serverport

RESTAPI_Certificate_Path

RESTAPI_Cert_Pass

 

Sets the certificate and the corresponding password to be used by the Transfer

CFT REST API Server and for HTTPS connections with Copilot (the old Transfer CFT UI, Web services, and JPI).

  • When REST API is enabled, you must complete these fields.
  • When Copilot_OnlySSL is activated, you must complete these fields.

When using Central Governance, the REST API server automatically uses the SSL business certificate generated during the registration; there is no need to pre-define this value if you are going to register Transfer CFT with Central Governance.

copilot.ssl.SslCertFile
Multi-node and Cluster
Multinode_Enable @default = No

Enable the multi-node architecture.

To use a multi-node architecture, you must define the multi-node option in the initialize.properties file.

cft.multi_node.enable
Multinode_Number @default = 2 Enter the number of nodes. cft.multi_node.nodes
LoadBalancer_Host  

Specify the host address of the load balancer.

When using an ACTIVE/ACTIVE or ACTIVE/PASSIVE deployment, you require a load balancer to connect to the Transfer CFT UI server.

cft.multi_node.load_balancer.host
LoadBalancer_Port   Specify the load balancer port, which is redirected to the Central Governance dedicated port of the Transfer CFT UI Server.

When using ACTIVE/ACTIVE or ACTIVE/PASSIVE deployment, you require a load balancer to connect to the Transfer CFT UI server.

cft.multi_node.load_balancer.port
Central Governance

CG_Enable

@default = No

Enter Yes to enable Central Governance connectivity. cg.enable
CG_Host  

The Central Governance host address.

If you enabled Central Governance, you must complete this field.

cg.host

CG_Port

@default = 12553

The Central Governance port.

If you enabled Central Governance, you must complete this field.

cg.port
CG_Mutual_Port @default = 12554

The Central Governance port for Mutual Authentication.

If you enabled Central Governance, you must complete this field.

cg.mutual_auth_port
CG_SharedSecret  

Specify the shared secret, which is needed to register with the Central Governance server.

If you enabled Central Governance, you must complete this field.

cg.shared_secret
CG_ConfigurationPolicy   Specify Central Governance configuration policy to apply to the Transfer CFT instance. cg.configuration_policy
CG_Certificate_Path @default = $CFTDIRRUNTIME/conf/pki/passportCA.pem Specify the Custom Certificate to authenticate Central Governance. N/A
Sentinel Connector
Sentinel_Enable @default = No

Set to Yes to enable Sentinel.

Do not enable this if you have enabled Central Governance.

sentinel.xfb.enable
Sentinel_Host   Enter the Sentinel host address. sentinel.trkipaddr
Sentinel_Port @default= 1305

Enter the Sentinel port.

You do not need to define this field if you are registering Transfer CFT with Central Governance.

sentinel.trkipport
Sentinel_Log_Filter @default = EWF

Sentinel Log Filter: (I)nformation, (W)arning, (E)rror, (F)atal Authorized characters are only I, W, E, F

You can only use each letter once.

sentinel.xfb.log
Sentinel_Transfer_Filter @default = ALL

Sentinel Transfer Filter

Possible values are: ALL, SUMMARY, NO, ERROR

sentinel.xfb.transfer
Sentinel_Use_SSL  @default = Yes Enables an SSL connection with Sentinel. sentinel.xfb.use_ssl
Sentinel_Certificate_Path @default=$CFTDIRRUNTIME/conf/pki/passportCA.pem Sentinel root certificate. N/A
Windows Services
CFT_StartAsService @default = No Start Transfer CFT Server using service mode. cft.nt.service_mode

CFT_ServiceName

CFT_ServiceDisplayName

@default= Transfer_CFT

@default= AMPLIFY Transfer CFT

Transfer CFT Server Service name.

You cannot have spaces in the CFT_ServiceName.

 cft.nt.service_name
CFT_ServiceSpecificUser @default= No Use a specific account to start the Transfer CFT Server Service. N/A

CFT_ServiceUsername

CFT_ServicePassword

  The Username (Domain\User) of the user who will start the Transfer CFT Server. N/A
CFT_StartType @default= auto Transfer CFT Server service start type: auto, manual, disabled N/A
CFTUI_StartAsService @default= No Start Transfer CFT UI Server using service mode. copilot.nt.service_mode
CFTUI_ServiceName CFTUI_ServiceDisplayName

@default= Transfer_CFT_UI

@default= AMPLIFY Transfer CFT UI

Transfer CFT UI Server Service name.

You cannot have spaces in the CFTUI_ServiceName.

copilot.nt.service_name
CFTUI_ServiceSpecificUser @default= No Use a specific account to start the Transfer CFT UI Server Service. N/A
CFTUI_ServiceUsername CFTUI_ServicePassword   The Username (Domain\User) of the user who will start the Transfer CFT UI Server. N/A
CFTUI_StartType @default= auto The Transfer CFT UI Server service start type: auto, manual, disabled N/A
Miscellaneous
JAVA_BINARY_PATH   Java binary path used to start Transfer CFT jar files. cft.jre.java_binary_path
SAML
Enable SAML @default = No   am.type= 'saml'
       
       
       
       
       
       
Note *This host address defines:
  • unconf:sentinel.trkproductipaddr: the host address that identifies this host
  • the host address used to connect this Transfer CFT UI server
Note In contrast with previous versions of Transfer CFT on Windows platforms, the Start menu option is automatically created and desktop icons are no longer an option.

Password management

The passwords used in the initialize.properties file are encrypted in the original file when you run the installation builder. You can then use the original file as a template for future installations. Impacted passwords are prefaced by <CFT_PASSWORD>, and include the following:

  • CryptoKey_Password
  • UI_DefaultUser_Password
  • CFT_ServicePassword
  • CFTUI_ServicePassword
  • RESTAPI_Cert_Pass
  • CG_SharedSecret

Related Links