Create transfer settings

This is an API function to create transfer settings. This API function corresponds to the [Transfer Settings] operation on the screen that is displayed by selecting a profile after selecting the [Profile] on the operation screen of Manager.

= Remarks =

The request parameters in JSON format of the following API functions are the same.

Create transfer settings
Modify transfer settings details

The response parameters of the following API functions are the same.

Create transfer settings
Modify transfer settings details
Acquire transfer settings details

Format
Request body (JSON format)
Request parameter (JSON format)
Request parameter (Path format)
Response
Response parameter

Item name	Request parameter	Type	Value	Default value
Compression Method	compressionMode	Integer	Specify whether to have transfer files be compressed. 0 \| 1 •　0: No compression •　1: DEFLATE compression	0
DEFLATE level	deflateLevel	Integer	Specify a value to adjust the compression ratio and compression speed when the transfer file is compressed. 1 \| 2 \| 3 •　1: Default •　2: Prioritize Compression Ratio •　3: Prioritize Compression Speed	1
File Deletion after Transfer (From)	deleteFile	String	Specify whether to have Agent delete files after they have been transferred. If you do not have Agent delete files, delete files by using a Successful Job. Otherwise, the same files will be detected again. "K" \| "D" •　K: Keep (Do not delete) •　D: Delete	"D"
Encryption Key	encryptKey	String	When you specify HULFT encryption for Encryption Type, specify an encryption key to be used for transfers. 8 to 20 bytes Alphanumeric characters^* * If the product is a region edition, this parameter is invalid when it is specified.	If you specify 1 for the "encryptMode", this parameter cannot be omitted.
Encryption Type	encryptMode	Integer	Specify whether to encrypt transfer files. If the product is a region edition, this parameter is invalid when it is specified. 0 \| 1 ^* • 0: No encryption • 1: HULFT encryption * If the product is a region edition, this parameter is invalid when it is specified.	If the product is a region edition, this parameter can be omitted. Otherwise, this parameter cannot be omitted.
File ID	fileId	String	Specify a file ID to be used in transfers to HULFT. Maximum 50 characters	Impossible to omit
Successful Job Execution Mode (From)	jobExecMode	Integer	Specify whether jobs that are run after files were successfully transferred are executed at the level of scripts or steps. 0 \| 1 •　0: Script execution •　1: Step execution	0
Unsuccessful Job Execution Mode (From)	jobExecModeOnError	Integer	Specify whether jobs that are run after file transfers failed are executed at the level of scripts or steps. 0 \| 1 •　0: Script execution •　1: Step execution	0
Successful Job (From)	jobName	String	Describe jobs that are executed after files are successfully transferred. Maximum 2048 ASCII characters (without NULL)
Unsuccessful Job (From)	jobNameOnError	String	Describe jobs that are executed after a file transfer fails. Maximum 2048 ASCII characters (without NULL)
Pre-send Job Execution Mode (From)	preJobExecMode	Integer	Specify whether Pre-send Jobs are executed at the level of scripts or steps. 0 \| 1 •　0: Script execution •　1: Step execution
Pre-send Job (From)	preJobName	String	Describe jobs that are executed before file transfer processing. Maximum 2048 ASCII characters (without NULL)
Search Order (From)	searchOrderDescending	Boolean	Specify the order that Agent searches a file to be transferred when Agent transfers multiple files at the same time of a trigger fire. •　true: Descending order •　false: Ascending order	false
Search Target (From)	searchTarget	Integer	Specify the item that becomes the key of a transfer order when Agent transfers multiple files at the same time of a trigger fire. 1 \| 2 •　1: File name •　2: Update date and time	2
Transfer Settings Name	sendingProfileName	String	Maximum 64 characters	Impossible to omit
Transfer Type	sendType	String	Specify whether transfer data is handled as binary data or text data. When data is handled as text data, character codes and newline codes are converted before the transfer. "B" \| "T" •　B: Binary •　T: Text	"B"
Temporary File Transfer (From)	temporaryFile	Boolean	If this parameter is valid, temporary file transfer is performed. Agent changes the name of a file to a temporary file name before Agent transfers the file. You can use temporary file names when you want to continue using the same file name during file transfers. •　true: Do temporary file transfer •　false: Do not temporary file transfer	false
Elapsed Monitoring Time (From)	triggerElapsedTime	String	Specify this value according to the type that is specified in Monitoring Mode. "1s" to "59d" Specify numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d).	"1m"
Monitored File Name (From)	triggerFileName	String	Specify a file name or a path to be monitored. If a path is specified, all files in the specified path are monitored. You can use an asterisk (*) as a wildcard character in the file name to have Agent monitor multiple files. Maximum 256-byte character string (?"<>\| are not available to use)	Impossible to omit
Monitoring Interval (From)	triggerInterval	String	Specify the interval at which the file that is specified in Monitored File Name is monitored. "1s" to "59d" Specify numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d).	"1m"
Monitoring Mode (From)	triggerMode	String	Specify what will trigger a file transfer that is monitored by Agent. "SIZE" \| "TIMESTAMP"	"SIZE"
Monitoring Size (From)	triggerSize	String	Specify this value according to the type that is specified in Monitoring Mode. "1b" to "1023g" Specify numeral (1 to 1023) with a unit (byte: b, kilobyte: k, megabyte: m, or gigabyte: g).	"1k"
Verify Data	dataVerify	Boolean	Choose whether you want to verify the data of the transfer files on the receiver. •　true: Verify •　false: Do not verify	Impossible to omit
File Creation (To)	fileCreation	String	Select the file creation method on the receiver. "REPLACE" \| "NEW_CREATION" \| "APPEND" \| "GEN_CTL" •　REPLACE: replace an existing file •　NEW_CREATION: newly create a file •　APPEND: append to an existing file •　GEN_CTL: control files by creating generation files If you receive files from only one host, you must select REPLACE, NEW_CREATION or GEN_CTL. If you receive files from multiple hosts, you must select APPEND. • REPLACE: An old file is replaced by a new file. If the file that is specified by [Receive File Name] does not exist on the receiver, the file is created. • NEW_CREATION: New file is created. An error occurs when the file with the same name as Received File Name already exists. • APPEND: The received data are appended to the end of the existing file, so that the received files can be merged into one file. If the file that is specified by [Receive File Name] does not exist on the receiver, the file is created. • GEN_CTL: The specified number of files are created. If "C:\test\rcv.txt" is set for [Receiving File Name], a suffix number is added after the extension that is divided by a dot such as "rcv.txt.0001", "rcv.txt.0002", and so on. If an attempt to receive a transfer file failed, Agent treats the transfer file as follows: • REPLACE: save it The transfer files remain in the monitored directory. • NEW_CREATION: delete it The transfer files are deleted from the monitored directory. • APPEND: save it The transfer files remain in the monitored directory. • GEN_CTL: delete it The transfer files are deleted from the monitored directory.	Impossible to omit
Generation File Count (To)	generationFileCount	Integer	If you select GEN_CTL for File Creation, specify the number of generations to be managed. 0, 2 to 9999 If the "fileCreation" is other than GEN_CTL, specify 0.	Impossible to omit
Notification (To)	jobWait	String	Specify when Manager sends the notification that file reception is completed to an instance of Agent. At the specified time, Manager displays the completion of the receiving files on the Logs screen. "Receive" \| "Successful_Job" •　Receive: after the reception is complete •　Successful_Job: after Successful Job is complete	Impossible to omit
Receiving File Name (To)	receiveFileName	String	Specify a name of transferred files on the receiver by using a full path. If Agent monitors multiple files, the name of the received files will be the same. Maximum 200 ASCII characters (without NULL)	Impossible to omit
Successful Job (To)	receiveJob	String	Describe jobs that are executed on the application server after files are successfully received. ASCII characters only Maximum 13 jobs and 200 characters per job are specifiable. You must separate each job by using a newline code (CRLF or LF).
Unsuccessful Job (To)	receiveJobOnError	String	Describe jobs that are executed on the application server after an attempt to receive files fails. ASCII characters only Maximum 13 jobs and 200 characters per job are specifiable. You must separate each job by using a newline code (CRLF or LF).