...
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 FTPGET component.
Figure 18: Interaction Configurations panel With Post Processing Action
This property provides three options:
- DELETE
- MOVE
- NO_ACTION
Figure 19: 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
Please refer to the Configuring Components for Message Encryption section in Common Configurations page.
Monitoring Settings
Figure 1820: Monitoring Settings section
...
Click the ellipsis button to configureMonitorDirectoryconfigure Monitor Directory.
Figure 1921: Monitor Directory Configuration properties
...
This property provides the capability of monitoring only specific files depending on their modification times. This property provides six options including 'NONE' based on which the files to be monitored could be filtered.
Figure 2022: Time-based file filtering types
The behavior of each Filter Type is described in the following sections.
...
Files whose last modification time is greater than the Base Time time is monitored. This ensures that only the files modified/added after the last scheduling cycle are monitored.
Figure 2123: TIME Filter Type
- Base Time: Base time in dd:MM:yyyy hh:mm format after which the changed files are to be downloaded.
- Remote host time offset: If the FTP server and the component are not in the same time zone, the difference in the time zone of FTP Server time zone from the component's time zone should be specified in (+/-) hh:mm format.
...
Files whose last modification time is greater than the highest last modification time found in the last scheduling cycle is monitored. This ensures that only files which are newer than the newer file already polled are selected.
Figure 2224: HIGHEST MODIFICATION TIME Filter Type
...
Files whose time difference between the current scheduling time and the last modified time greater than the minimum age is monitored. This ensures that the file modification time is at least Minimum Age earlier than the current time.
Figure 2325: 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 2426: 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 2527: LAST RECENT POLL TIME Filter Type
...
Following is the option available for Response Type - 'Data'.
Send XML output?
Figure 2628: Interaction Configuration with response type - 'Data'
...
Following are the options available for Response Type - 'File'.
Figure 2729: Interaction Configurations with response type - 'File'
...
Click the ellipsis button to configureTargetDirectory.
Figure 2830: Target Directory Configuration properties
...
Action that must be taken if the target directory already has a file with a name that is same as the file that is being downloaded. The behavior will be dependent on the selection as shown below.
Figure 2931: Append settings
OVERWRITE
...
The name of the file that is being downloaded is changed based on the properties given below.
Figure 3032: Append settings
Append date-time format postfix: When existing files in the Target directory are not to be overwritten, FTPGet provides the flexibility of downloading 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.
...
Miscellaneous Settings
Figure 3133: Miscellaneous settings properties
...
The interaction configurations can be tested by clicking the Test button in the panel.
Example 1: Sample input and output when the Response type is set to 'Data' and Send XML Output? is enabled.
Figure 3334: Sample input sent from CPS
Figure 3435: Sample output
Example 2: Sample input and output when the Response type is set to 'Data' and Send XML Output is disabled.
Figure 3536: Sample input sent from CPS
Figure 3637: Sample output
The FTP server can be configured in the Connection Configuration property under Connection Properties sections in Managed Connection Factory panel of CPS.
Figure 3738: Sample FTP server configuration
Server connection can be tested from within the CPS by clicking on Test in the connection properties panel.
Figure 3839: Sample connection test result indicating success
Sender information can be configured using Target Directory Configuration property under Target Settings section in the Interaction Properties panel.
Figure 3940: Sample Get information configuration
The configuration can be tested by getting a text file when you click on the Test option in the Interaction Properties panel.
Figure 4041: Sample input
Figure 4142: Sample response
Input and Output Schema
...
| Note |
|---|
Input port appears only when Monitoring Property is disabled. |
Figure 4243: Input schema structure for the response type – File
...
Table 1: Input schema element descriptions for - File response type
Figure 4344: Output schema structure for the response type – File
...
Below figures show the input and output schema structures when the response type is Data. Please refer Table 1 for the description of input schema elements and Table 2 for the description of output schema elementsexceptData. When the response type is Data, this element holds all the downloaded content.
Figure 4445: Input schema structure for the response type - Data
Figure 4546: Output schema structure for the response type - Data
When the property "Use Connection details from 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 4647: Input schema with ConnectionFactorySettings
...
Receive files from a remote directory on the FTP server and save it in a local directory.
Configure the FTP Get 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 File.
Figure 4748: Configuration the FTP Get
Sample Input
Figure 4849: Demonstrating Scenario 1 with sample input
Sample Output
Figure 4950: Demonstrating Scenario 1 with sample output
...
Receive files from a remote directory on the FTP Server and send it out as data in the output message.
Configure the FTP Get 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
Sample Input
Figure 5051: Demonstrating scenario 2 with sample input
Sample Output
Figure 5152: Demonstrating scenario 2 with sample output
...
The configuration of the connection properties of FTPGet component for SFTP protocol is shown in the figure below, and the remaining procedures are same as explained in Scenario 1.
Figure 5253: Connection Properties attributes
...
In the retail television example, media production requests are received on an FTP server and are downloaded using the FTP Get component.
Figure 5354: Demonstrating scenario
The event process demonstrating this scenario is bundled with the installer. The bundled process shows it as a File Reader component instead of an FTP Get component.
Documentation of the scenario and instructions to run the flow can be found in the Help tab of flow when open in Studio.
...