List of request parameters
The following table shows a list of request parameters. The parameters are described in an alphabetical order of the item name.
| Item name | Request parameters |
Supplements |
See |
|---|---|---|---|
| DEFLATE level | deflateLevel | Specify a value to adjust the compression ratio and compression speed when the transfer file is compressed. | |
| MAC address | macAddress | ||
| OS | os | ||
| PID | pid |
Specify a process ID of an Agent instance that output logs. |
|
| Architecture (Agent) | cpu | Specify the CPU architecture on which the Agent module runs. | |
| Access Date and Time (start) | geAccessedDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Access Date and Time (end) | leAccessedDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Access Log Type | type | ||
| Threshold for the Access Log (Records) | offset | Specify the maximum number of records to keep logs. | |
| Threshold for the Access Log (Days) | minusDays |
Specify the maximum number of days to keep logs. For example, if 30 is specified, logs are kept for 30 days. |
|
| Truncating the Access Log (On/Off) | enableTruncate | ||
| Truncation Mode for the Access Log | truncateMode | ||
| Activation whitelist | whitelistEnabled | Specify to switch the whitelist function on or off. | |
| Value | value | ||
| Compression Method | compressionMode | Specify whether to have transfer files be compressed. | |
| Upload file name | FILENAME | ||
| Address (cc) | cc |
You can enter email addresses that are based on the RFC and are divided by a comma (,). Use one of the following formats for the email addresses: • foo@example.com • <foo@example.com> • foo <foo@example.com> |
|
| Address (To) | address |
You can enter email addresses that are based on the RFC and are divided by a comma (,). Use one of the following formats for the email addresses: • foo@example.com • <foo@example.com> • foo <foo@example.com> |
|
| Encryption Key | encryptKey |
When you specify HULFT encryption for Encryption Type, specify an encryption key to be used for transfers. If the product is a region edition, this parameter is invalid when it is specified. |
|
| Encryption Type | encryptMode |
Specify whether to encrypt transfer files. If the product is a region edition, this parameter is invalid when it is specified. |
|
| Unsuccessful Job (From) | jobNameOnError | Describe jobs that are executed after a file transfer fails. | |
| Unsuccessful Job (To) | receiveJobOnError |
Describe jobs that are executed on the application server after an attempt to receive files fails. 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 Execution Mode (From) | jobExecModeOnError | Specify whether jobs that are run after file transfers failed are executed at the level of scripts or steps. | |
| Number of items per page | size |
Acquire a list of whitelist entries Acquire a list of Agent instances Acquire a list of receive tasks Acquire a list of update modules Acquire a list of reception settings Acquire a list of transfer settings Acquire a list of Receive Logs Acquire a list of Transfer Logs |
|
| Date and Time of Occurrence (start) | geEventDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Date and Time of Occurrence (end) | leEventDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Agent ID | agentId |
Acquire a list of Agent instances Acquire Agent instance details Change status of an Agent instance Change operation settings for an Agent instance Acquire a list of receive tasks |
|
| Agent offline notification (ON/OFF) | enableNotification | ||
| Agent offline notification threshold | offlineTime | Specify when the notification email will be sent by using the number of minutes after a session between Manager and an instance of Agent becomes offline. | |
| Agent Version | agentVersion | ||
| Agent Name | agentName |
Acquire a list of Agent instances |
|
| Agent Name | name | ||
| Error | error | ||
| Start Time (Communication Time Limit) | startCommunicationTimeHour |
Specify the time of day when Agent can start to communicate with Manager if you limit the time when Agent can communicate with Manager. Specify the value with "End Time". |
|
| Starting Identifier | startProcessId | ||
| Monitoring Interval (From) | triggerInterval | Specify the interval at which the file that is specified in Monitored File Name is monitored. | |
| Elapsed Monitoring Time (From) | triggerElapsedTime | Specify this value according to the type that is specified in Monitoring Mode. | |
| Monitoring Size (From) | triggerSize | Specify this value according to the type that is specified in Monitoring Mode. | |
| Monitored File Name (From) | triggerFileName |
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. |
|
| Monitoring Mode (From) | triggerMode | Specify what will trigger a file transfer that is monitored by Agent. | |
| Receive End Code | exitCode | ||
| Term License Key | termKey | ||
| Term License Key expiration notification (ON/OFF) | enableNotification | ||
| Term License Key expiration notification threshold | beforeDays | Specify when the notification email will be sent by using the number of days before the term of license is expired. | |
| Current Password | currentPasswd | If an administrator changes the password of the other users, this parameter is not required. | |
| Search Order (From) | searchOrderDescending | Specify the order that Agent searches a file to be transferred when Agent transfers multiple files at the same time of a trigger fire. | |
| Search Target | filter | ||
| Search Target (From) | searchTarget | Specify the item that becomes the key of a transfer order when Agent transfers multiple files at the same time of a trigger fire. | |
| Subject prefix | subjectPrefix | You can add the letters to the beginning of the subject for all notification emails. | |
| Subject prefix | subjectPrefix | You can add the letters to the beginning of the subject for the test email. | |
| Connection Retry Count | connectionRetryCount | Specify the number of times to retry a connection when Agent fails to connect to HULFT. | |
| Connection Retry Interval | connectionRetryInterval | Specify the amount of time to wait before Agent retries a connection when Agent fails to connect to HULFT. | |
| Latest Processing Identifier | latestProcessId | ||
| Reissue Key | clientSecret | ||
| Auto Resend Retry Count | autoResendingRetryCount |
Specify the number of times that Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT. |
|
| Auto Resend Retry Interval | autoResendingRetryInterval | Specify the amount of time to wait before Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT. | |
| Notification (To) | jobWait |
Specify when the notification that file reception is completed is sent to an instance of Agent. At the specified time, the completion of the receiving files is displayed on the Logs screen of Manager. |
|
| Receive End Code | rcvExitCode | ||
| Receiving File Name (To) | receiveFileName |
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. |
|
| Port Number on Receiver | shushinPort | ||
| Host Name of Receiver | shushinHostName | ||
| End Time (Communication Time Limit) | endCommunicationTimeHour | Specify the time of day when Agent ends the communication with Manager if you limit the time when Agent can communicate with Manager. Specify the value with "Start Time". | |
| Reception Start Date and Time (UTC) | receivingStartDateUtc | ||
| Reception Start Date and Time (string) | receivingStartDateStr | ||
| Reception Start Date and Time (string) (start) | geReceivingStartDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Reception Start Date and Time (string) (end) | leReceivingStartDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Receive Queue Polling Interval | receivingQueuePollingInterval | Specify the interval at which Agent polls the Receive Task Queue. | |
| Reception Completion Date and Time (UTC) | receivingEndDateUtc | ||
| Reception Completion Date and Time (string) | receivingEndDateStr | ||
| Reception Completion Date and Time (string) (start) | geReceivingEndDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Reception Completion Date and Time (string) (end) | leReceivingEndDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Reception Settings ID | receivingProfileId |
Acquire a list of Receive Logs Acquire reception settings details |
|
|
Reception Settings Name |
receivingProfileName | ||
| Receiving Task ID | receivingTaskId | ||
| Size of Receive Task Queue | receivingTaskQueueSize |
Specify the maximum number of file distribution tasks that can be registered in the Receive Task Queue. If the number of tasks exceeds the maximum, tasks in the queue are deleted in order from the oldest one to the newest one. |
|
| Receive Log ID | receivingLogId | ||
| Receive log error notification (ON/OFF) | enableNotification | ||
| Threshold for the Receive Log (Records) | offset | Specify the maximum number of records to keep logs. | |
| Threshold for the Receive Log (Days) | minusDays |
Specify the maximum number of days to keep the logs. For example, if 30 is specified, the logs are kept for 30 days. |
|
| Truncating the Receive Log (On/Off) | enableTruncate | ||
| Truncation Mode for the Receive Log | truncateMode | ||
| Job | jobScript | Describe jobs that are executed after a distribution file is received successfully. | |
| Job Timeout (Time) | jobTimeout | Specify the amount of time to wait before generating an error when the result of a job for a file transfer or file distribution is not returned. | |
| Job Timeout (Valid or invalid) | jobTimeoutEnabled |
Specify whether Agent generates an error or not when the result of a job for a file transfer or file distribution is not returned. If you set it invalid, Agent keeps waiting for a result without timing out. |
|
| End Code of Job | jobExitCode | ||
|
Job Execution Mode (Reception Settings) |
jobExecMode | Specify whether jobs that are run after a distribution file was received successfully are executed at the level of scripts or steps. | |
| Serial Number | serial | ||
| New Password | newPasswd | ||
| Status (Agent) | status | ||
| Successful Job (From) | jobName | Describe jobs that are executed after files are successfully transferred. | |
| Successful Job (To) | receiveJob |
Describe jobs that are executed on the application server after files are successfully received. Maximum 13 jobs and 200 characters per job are specifiable. You must separate each job by using a newline code (CRLF or LF). |
|
| Successful Job Execution Mode (From) | jobExecMode | Specify whether jobs that are run after files were successfully transferred are executed at the level of scripts or steps. | |
| Generation File Count (To) | generationFileCount |
If you select GEN_CTL for File Creation Method, specify the number of generations to be managed. |
|
| Sort Order | sort |
Acquire a list of Agent instances Acquire a list of reception settings Acquire a list of transfer settings Acquire a list of Receive Logs |
|
| Type | attribute | ||
| Socket Buffer Size (Type) | socketBufferSizeMode |
Specify the type of socket buffer that is used for socket communication to HULFT by Agent. When you select User Specified, specify the byte count for socket buffer size. |
|
| Socket Buffer Size (Byte count) | socketBufferSize | Specify the socket buffer size that is applied to socket communication to HULFT by Agent. | |
| Socket Read Timeout | socketTimeout |
Specify the time until a timeout occurs when Agent does not receive a response from HULFT during a socket communication between Agent and HULFT. If a timeout occurs, Agent regards the state as a communication error and disconnects the communication. |
|
| Communication Time Limit | communicationTimeLimitEnabled | Specify whether the time when Agent communicates with Manager is restricted. | |
| Verify Data | dataVerify | Choose whether you want to verify the data of the transfer files on the receiver. | |
| File Deletion after Transfer (From) | deleteFile |
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. |
|
| Transfer Settings ID | sendingProfileId |
Acquire transfer settings details |
|
| Transfer Settings Name | sendingProfileName | ||
| Transfer Type | sendType |
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. |
|
| Transfer Log ID | transferLogId | ||
| Transfer log error notification (ON/OFF) | enableNotification | ||
| Threshold for the Transfer Log (Records) | offset | Specify the maximum number of records to keep logs. | |
| Threshold for the Transfer Log (Days) | minusDays |
Specify the maximum number of days to keep the logs. For example, if 30 is specified, the logs are kept for 30 days. |
|
| Truncating the Transfer Log (On/Off) | enableTruncate | ||
| Truncation Mode for the Transfer Log | truncateMode | ||
| Temporary File Transfer (From) | temporaryFile |
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. |
|
| Registration Date and Time (start) | geRegistrationDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Registration Date and Time (end) | leRegistrationDate | If you specify both start and end parameters, you can set a period of a search target. | |
| Trace log error notification (ON/OFF) | enableNotification | ||
| Truncating the Trace Log (On/Off) | enableTruncate | ||
| Truncation Mode for the Trace Log | truncateMode | ||
| Threshold for the Trace Log (Records) | offset | Specify the maximum number of records to keep logs. | |
| Threshold for the Trace Log (Days) | minusDays |
Specify the maximum number of days to keep the logs. For example, if 30 is specified, the logs are kept for 30 days. |
|
| Trace Log Unique ID | traceLogUniqueId | ||
| Trace Log Pool Size | traceLogPoolSize | Specify the amount of Trace Logs that are kept in Agent. | |
| Send Process Multiplex Level | sendProcessMultiplexLevel |
Specify the maximum number of send processes that Agent can start at the same time. If the number of transfer files in an instance of Agent exceeds the maximum number of send processes, Agent puts off transferring the extra files until the next trigger fire after the time of the monitoring interval that is specified on the Transfer Settings screen elapsed. |
|
| Send End Code | sndExitCode | ||
| Pre-send Job (From) | preJobName | Describe jobs that are executed before file transfer processing. | |
| Pre-send Job Execution Mode (From) | preJobExecMode | Specify whether Pre-send Jobs are executed at the level of scripts or steps. | |
| Send Log Pool Size | sendLogPoolSize | Specify the amount of Send Logs that are kept in Agent. | |
| File Name at Send Destination | fileName | Specify the file name to use when Agent receives the file on the IoT equipment, by using the full path of the file storage location on the IoT equipment. | |
| Password | password | ||
| Password | newPasswd | ||
|
Bit Count (Agent) |
bit | Specify the value that indicates the bit count of Agent module. | |
| File ID | fileId | Specify a file ID to be used in transfers to HULFT. | |
| File ID | fileId | Specify a file ID that was used in transfers to HULFT. | |
| File Creation (To) | fileCreation |
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 |
|
| File Name | FILENAME | ||
| Product Key | productKey | ||
| Profile ID | profileId |
Acquire a list of Agent instances Acquire a list of reception settings Acquire a list of transfer settings |
|
| Profile Version | profileVersion | ||
| Profile Name | profileName |
Acquire a list of Agent instances Acquire a list of Receive Logs |
|
| Number of pages | page |
Acquire a list of whitelist entries Acquire a list of Agent instances Acquire a list of receive tasks Acquire a list of update modules Acquire a list of reception settings Acquire a list of transfer settings Acquire a list of Receive Logs Acquire a list of Transfer Logs |
|
| Polling Interval | pollingInterval | Specify the interval at which Agent polls Manager. | |
| Host Name | hostName | ||
| Host Name | host | ||
| Whitelist ID | activationWhiteListId | ||
| To send an email (ON/OFF) | enableNotification | ||
| Module ID | moduleId | ||
| Module Version | moduleVersion | ||
| Module File Name | moduleFileName | ||
| User ID | userId | ||
| User Name | userName | ||
| Unit ID | unitId |
Acquire a list of Agent instances Acquire a list of Receive Logs Acquire a list of Transfer Logs |
|
| Unit ID (Array) | unitIds | ||
| Unit Version | unitVersion | ||
| Unit Name | unitName |
Acquire a list of Agent instances Acquire a list of Receive Logs |
|
| Request Timeout | requestTimeout |
Specify the time until a timeout occurs when Agent does not receive a response from Manager during any communications between Agent and Manager. If a timeout occurs, Agent regards the state as a communication error and disconnects the communication. |
|
| Log Output Mode | historyMode | Specify whether Agent always outputs Send Logs or whether Agent outputs Send Logs only when an error occurs. | |
| Log Output Mode (Receive Log Settings on the receiver) | hulrcvLogHistoryMode | Specify whether HULFT always outputs Receive Logs or whether HULFT outputs Receive Logs only when an error occurs. | |
| Role ID | userRoleId | ||
| Role Name | userRoleName | ||
| Log Level | logLevel |