FTP Tracking Sample Profile Overview

This profile contains several routes that show you how to download data from the FTP server while tracking the process by using Edifecs XESManager. This approach allows you to identify and resolve processing issues more efficiently.

Profile Location

Edifecs Library / Best Practices / Common Tasks / FTP Tracking Sample

Requirements

  • Edifecs XEngine 9.2.2 or later
  • Edifecs XEServer 9.2.2 or later
  • Edifecs Application Manager 9.2.2 or later
  • Edifecs XEConnect 9.2.2 or later
  • Edifecs XESManager 9.2.2 or later

Prerequisites

  1. Copy the file commons-net-3.6.jar from the folder ${XESProfileConfig}/lib to ${XESRoot}/platform/lib.user/shared.
  2. In EAM, go to the profile and on the Outline tab, expand Services, expand XEConnect, and then click FTP Server Service.
  3. On the Configuration tab, click XEConnect FTP User Management.
  4. On the Outline tab, click FTP Users.
  5. On the User Management tab, in the section List of FTP Users click New.
  6. In Name, enter test.
  7. In Password, enter Test123$, and then click OK.
  8. Click Edit and copy the Home folder path.
  9. Go back to the profile Configuration.
  10. On the profile Environment tab, double-click the property ftpRoot.
  11. Replace the value with the Home folder path copied earlier (Step 8).
  12. Save changes.
  13. Go to the folder ${XESProfileConfig}/sample_data/ftp and copy all 4 folders to the Home folder location.
  14. Start XESManager.

Scenario 1. Successful

  1. In EAM, on the Admin Console tab, start the profile.
  2. Copy the contents of the folder ${XESProfileConfig}/sample_data/scenarios/1.HappyPath to ${XESWorkspace}/test-data/inbound.
  3. Go to the folder ${XESWorkspace}/test-data/outbound/associatedSurgeons to view the resulting file healthFlorida.dat.

Scenario 2. List Error

This scenario illustrates a case when the list of files that need to be downloaded from the FTP server could not be retrieved.

  1. Ensure that XESManager is up and running.
  2. In EAM, on the Admin Console tab, ensure that the profile is running.
  3. Copy the contents of the folder ${XESProfileConfig}/sample_data/scenarios/2.ListError to ${XESWorkspace}/test-data/inbound.
  4. In XESManager, on the top menu, click , and then click Data Storage Monitoring.
  5. In Server URL, from the drop-down menu, select jdbc:h2:file:${XESWorkspace}/DS/data;AUTO_SERVER=TRUE
  6. Click Connect & Start.
  7. Select Live Items and click Search to see one record with the following path:
  8. IncompleteTriggerSessions – the session that was not completed

Scenario 3. File Download Error

This scenario illustrates a case when the required file could not be downloaded from the FTP server.

  1. Ensure that XESManager is up and running.
  2. In EAM, on the Admin Console tab, ensure that the profile is running.
  3. Copy the contents of the folder ${XESProfileConfig}/sample_data/scenarios/3.FileDownloadError to ${XESWorkspace}/test-data/inbound.
  4. In XESManager, refresh the page, select Live Items and click Search to see two records with the following paths:
  • sessionsWithErrors- the session that was not completed because of errors
  • downloadErrorFiles>{session id}>{file name} – the file that was not downloaded

Scenario 4. Long File Upload Error

This scenario illustrates a case when the initial file hash is different from the downloaded file hash. New records appeared during the downloading process.

  1. Ensure that XESManager is up and running.
  2. In EAM, on the Admin Console tab, ensure that the profile is running.
  3. Copy the contents of the folder ${XESProfileConfig}/sample_data/scenarios/ 4.LongUploadError to ${XESWorkspace}/test-data/inbound.
  4. In XESManager, refresh the page, select Live Items and click Search to see one record with the following path:
  5. LongLoadIssues>{session id} – you can view the contents of the file in the section Data on the right side of the page.

Scenario 5. List Read Retry Attempt Error

This scenario illustrates a case when the initial file hash is different from the downloaded file hash. New records appeared during the downloading process, but an error occurred while the route was trying to get the list.

  1. Ensure that XESManager is up and running.
  2. In EAM, on the Admin Console tab, ensure that the profile is running.
  3. Copy the contents of the folder ${XESProfileConfig}/sample_data/scenarios/ 5.ErrorReRead to ${XESWorkspace}/test-data/inbound.
  4. In XESManager, refresh the page, select Live Items and click Search to see one record with the following path:
  5. ReReadList>{session id} – you can view the contents of the file in the section Data on the right side of the page.

Profile Data Cleanup

  1. In EAM, on the Admin Console tab, stop the profile.
  2. Delete the contents of the folder ${XESWorkspace}/test-data/outbound.
  3. Delete the contents of the folder ${XESWorkspace}/DS.
  4. Delete the contents of the folder ${XESProfile}/elasticsearch/duplication-check-cluster.