| Expandpanel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
The FTPPut component is used for uploading files to the FTP Server. It can be used for uploading one or more files in a directory.
...
Please refer to the Monitoring Configuration section in Common Configurations page.
Postprocessing Action
Specifies the type of action that is to be performed after the file has been processed successfully by the FTPPUT component.
Figure 15: Interaction Configurations panel With Post Processing Action
This property provides three options:
- DELETE
- MOVE
- NO_ACTION
Figure 16: With Post Processing Action MOVE
Postprocessing Directory
Specifies the name of the directory where the file is to be moved after it has been processed successfully.
Append Timestamp
Specifies whether a time-stamp needs to be appended to the name of the file after it has been processed successfully.
Timestamp Format
If selected, provide Timestamp Format which specifies the format in which date is to be appended.
Append Counter
Specifies whether a counter value is to be appended to the time stamp.
Elements to Decrypt
Select elements to decrypt in the Input Message.
...
Monitoring is done by monitoring the source directory in the regular scheduling interval. The scheduler configurations can be defined by the user in Scheduler Configurations Panel and this is the only case that FTPPut component uses scheduler configurations.
Figure 1517: Monitoring Settings properties
...
Monitor Directory Configuration
Figure 1618: Sample monitoring configuration
...
This property provides the capability of monitoring only specific files depending on their modification times. This property provides 5 options based on which the files to be monitored could be filtered.
Figure 1719: Time-based file filtering types
...
Files whose last modification time is greater than the Base Time is monitored. This ensures that only the files modified/added after the last polling cycle are monitored.
Figure 1820: Time-based file filtering type - TIME
...
Files whose last modification time is greater than the highest last modification time found in the last polling cycle is monitored. This ensures that only files which are newer than the newer file already polled are selected.
Figure 1921: HIGHEST MODIFICATION TIME Filter Type
...
Files whose last modification time is less than the current polling time minus the age is monitored. This ensures that the file modification time is at least Minimum Age earlier than the current time.
Figure 2022: MINIMUM AGE filter type
...
Files whose time difference between the current scheduling time and the last modification time is less than the specified max age will be monitored. This ensures that the file modification time is not older than MaximumAge time for the current poll.
Figure 2123: MAXIMUM AGE filter type
...
Files whose last modification time is greater than the last recent poll time will be monitored. This ensures that only files which are newer than the last recent poll time in the system are selected.
Figure 2224: LAST RECENT POLL TIME filter type
...
Click the ellipsis button the configure Target Directory.
Figure 2325: Target Directory Configuration
...
The name of the file that is being uploaded is changed based on the properties given below:
Figure 2426: Appender counter
Append date-time format postfix: When existing files in the Target directory are not to be overwritten, FTPPut provides the flexibility of uploading the content into a new file whose name is in the format <NameOfExistingFile_CurrentDateTime>. The format in which the date and time are to be appended should be specified as a value for this property.
Example: If the date-time format is specified as MMddyyyyHHmmssss for the file Sample.txt, the target file created would be Sample_0305200811300013.txt.Note The default date-time format in CPS is MMddyyHHmmss. Please configure the date-time format postfix in CPS appropriately to avoid remote file name clashes when using multiple sessions for FTPPut.
Info icon false title Example: Set the postfix value to "MMddyyHHmmssSSS" to have milliseconds precision of 3 digits.
...
When Request type is set to File, input and output structures are defined as shown in figures below respectively.
Figure 2627: Input schema structure for the request type - File
...
Table 1: Input schema element descriptions for - File request type
Figure 2728: Output schema structure for the request type - File
...
| Note |
|---|
Input port appears only when Monitor Directory is disabled. |
Figure 2829: Input schema structure for the request type - Data
Figure 2930: Output schema structure for the request type – Data
When the property "Use Connection details from the input" is chosen, an additional element ConnectionFactorySettings is added to the input schema, as shown in the figure. Properties that are used to create the connection are present under this element.
Figure 3031: Input schema with ConnectionFactorySettings
...
The configuration can be tested by sending a text file when you click on the Test option in the interaction properties panel.
Figure 3132: Sample input sent from CPS
The FTP server can be configured in the connection properties panel of CPS.
Figure 3233: Sample output
Functional Demonstration
...
Send files from a local directory to the FTP server's remote directory.
Configure the FTP Put as described in Configuration and Testing section and use feeder and display components to send sample input and check the response respectively. In the Interaction Configuration choose the option File for property Request type.
Figure 3334: Event Process demonstrating Scenario 1
Sample Input
Figure 3435: Input sample when Request type is File.
Output
Figure 3536: Output message received for the input
...
Send data to the FTP Server and save it as a file in the remote directory.
Configure the FTP Put as described in Configuration and Testing section and use feeder and display component to send sample input and check the response respectively. In the interaction configuration choose the option Data for the property Request type.
Sample Input
Figure 3637: Input sample when Request type is Data
Output
Figure 3738: Output message received for input
...
Connection Configuration of FTPPut component for SFTP protocol is as shown in the figure below, and the remaining procedures are same as explained in Scenario 1.
Figure 3839: Protocol type selection
...
In the revenue control packet, example error messages are sent to an FTP server and are stored there for tracking using the FTP Put component.
Figure 3940: Demonstration scenario
The event process demonstrating this scenario is bundled with the installer. The bundled process shows it as a File Writer component instead of the FTP Put component.
Documentation of the scenario and instructions to run the flow can be found in the Help tab of flow when open in Studio.
...