Manage File IO Configuration

The Manage File IO Configuration window allows the user to create and configure file transfers that are executed as part of an existing configured task (Manage Tasks). Although any task may execute an input/output (IO) configuration, typically Import and Export Tasks execute file transfers. An import configuration moves files before the task executes. Imports move files from a single file share (or FTP server) to one or more file shares. An export configuration moves files after the task executes. Exports move files from one or more file shares to one or more FTP servers or file shares. The Configuration has two tabs: Imports and Exports.

Import Tab

The Imports tab presents the list of configured Import file transfers with the following fields:

  • Import ID. The unique identifier of the File IO configuration.
  • Description. This optional field provides a description of the task.
  • Wild Card. This optional field provides the filename wildcard used when selecting files to import. e.g. (*.csv). If a wildcard is not specified all files are imported
  • Delete After Import. A True/False field. If set to true, the file will be deleted from the FTP site or file share after the file transfer is complete. If set to false, the files will not be deleted after file transfer.
  • Process by Date. A True/False field. If set to true, transfer only files newer than the date of the last download. If set to false, transfer all files meeting the wildcard criteria. If ‘Delete After Import’ is false, to avoid transferring files that have already been processed, it is recommended that ‘Process by Date’ is set to True.
  • Import Task Name. This name corresponds to an existing Task Name in the Scheduled or Saved Tasks tabs of the Manage Tasks Dialog. The IO configuration executes prior to the execution of the Task.
  • Last Processed. The modified date of the last file transferred. Only applicable when Process by Date is set to True.
  • Custom1-Custom20. Fields that can be used to specify custom characteristics of the specified IO configuration.

To add an Import file, select the Add button and configure the list fields. To edit an Import file, select an ImportID and select the Edit button. To remove an Import file, select an Import ID and select the Remove button.

Import Source Tab

When an import item is selected in the top window, the Sources tab presents the list of FTP sites or file shares containing the files to transfer. MetrixIDR only retrieves files from the first validated source. This list has the following fields:

  • Try Order. A numeric value indicating the order in which the import will attempt to validate the import source. Once MetrixIDR validates a source, sources with higher Try Orders are ignored. A try order of 1 indicates the first source to attempt.
  • URL. This field describes the location of the files to be transferred. Files can be transferred from an FTP server or a file share. This field contains either the FTP URL or the file share path. If the import files are located on an FTP server, the URL will begin with ftp://. e.g. ftp://ftp.dtn.com. If the import files are located on a file share, the URL will begin with file://. E.g. file://networkserver/metrixidr/weather
  • FTP Mode. An optional field indicating the FTP mode used to transfer the files from an FTP server. Valid values are ‘Passive’ and ‘Active’. This field is not used when the import files originate from a file server.
  • Username. An optional field indicating the Username used to connect to the FTP server. This field is not used when the import files originate from a file server.
  • Password. An optional field indicating the Password used to connect to the FTP server. This field is not used when the import files originate from a file server.
  • FTP Directory. An optional field indicating the remote directory on the FTP server. This field is not used when the import files originate from a file server.
  • Transfer Mode. A field indicating the mode of the file transfer. Valid values are File, FTP SSL, FTP SSH.

To add a Source, select the ImportID in the top window, select the Source tab, then select the Add button. This action opens the Edit Import Source dialog. Configure the dialog as described in the Add/Edit File Import Source section. Sources may be edited using the Edit button and removed using the Remove button. The Move Import Source Up and Move Import Source Down buttons increments or decrements the Source Try Order.

Import Destination Tab

When an import item is selected in the top window, the Destinations Tab presents the file locations for the transferred files. The files are moved to each of the locations in the Destinations list. This list has the following fields:

  • Destination Path. The file share destination for the transferred files.

To add an Destination, select an ImportID and then select the Add button. This action opens an Explorer browser. Select the import file Destination. To edit a Destination, select an ImportID and select the Edit button. To remove a Destination, select an Import ID and select the Remove button.

Export Tab

The Exports tab presents the list of configured Export file transfers with the following fields:

  • Export ID. The unique identifier of the File IO configuration.
  • Description. This optional field provides a description of the task.
  • Wild Card. This optional field provides the filename wildcard used when selecting files to export. e.g. (*.csv). If a wildcard is not specified all files are exported .
  • Delete After Export. A True/False field. If set to true, the file will be deleted from the file share after the file transfer is complete. If set to false, the files will not be deleted after file transfer.
  • Export Task Name. This name corresponds to an existing Task Name in the Scheduled or Saved Tasks tabs of the Manage Tasks Dialog. The IO configuration executes after the execution of the Task.
  • Custom1-Custom20. Fields that can be used to specify custom characteristics of the specified IO configuration.

To add an Export file, select the Add button and configure the list fields. To edit an Export file, select an ExportID and select the Edit button. To remove an Export file, select an Export ID and select the Remove button.

Export Source Tab

When an export item is selected in the top window, the Sources Tab presents the file share locations of the files to transfer. Files are moved from each of the locations in the Sources list. This list has the following fields:

  • Source Path. The file share of the files to transfer.

To add Source, select an ExportID and then select the Add button. This action opens an Explorer browser. Select the export file Source. To edit a Source, select an ExportID and select the Edit button. To remove a Source, select an Import ID and select the Remove button.

Export Destination Tab

When an export item is selected in the top window, the Destinations Tab presents the list of FTP sites or file shares for the transfer files. The files are moved to each of the locations in the Destination list. This list has the following fields:

  • URL. A field that describes the location for the transferred files. Files can be transferred to an FTP server or a file share. This field contains either the FTP URL or the file share path. If the export files are transferred to an FTP server, the URL will begin with ftp://. e.g. ftp://ftp.dtn.com. If the export files are transferred to a file share, the URL will begin with file://. For example, file://networkserver/metrixidr/weather.
  • FTP Mode. An optional field indicating the FTP mode used to transfer the files to a FTP server. Valid values are ‘Passive’ and ‘Active’. This field is not used when the export files are transferred to a file share.
  • Username. An optional field indicating the Username used to connect to the FTP server. This field is not used when the export files are transferred to a file share.
  • Password. An optional field indicating the Password used to connect to the FTP server. When using SSH authentication, this field should contain the password of the private key file. This field is not used when the export files are transferred to a file share.
  • FTP Directory. An optional field indicating the remote directory on the FTP server. This field is not used when the export files are transferred to a file share.
  • Transfer Mode. A field indicating the mode of the file transfer. Valid values are File, FTP SSL, FTP SSH, and FTP.

To add a Destination, select the ExportID in the top window, select the Destination tab, then select the Add button. This action opens the Edit Import Destination dialog. Configure the dialog as described in the Add/Edit File Export Destination section. Destination may be edited using the Edit button and removed using the Remove button.