This guide outlines the process for customers who choose to retrieve data files (Transaction Runs, Invoices, and Reports), by "pulling" them from the Unimarket sFTP server. Understanding the boundaries of responsibility and the directory structure is critical, for maintaining an efficient and error-free integration.

The Outbound Workflow

The transfer process follows a three-stage sequence:

1. File Generation: Based on your predefined schedule in the Insights module, Unimarket executes a job to generate the required output files (CSV or XML).
2. File Transfer: These files are securely moved to the Unimarket outbound sFTP server and placed in a specific directory.
3. Post-Transfer Hand-off: Once the file is successfully placed on the server, Unimarket's responsibility in the process concludes. There is no automated feedback loop or callback mechanism to confirm that the customer has retrieved the file.

Customer Responsibility & Lifecycle Management

Because the outbound server permissions prevent Unimarket from managing or deleting files once they are delivered, file lifecycle management is the sole responsibility of the customer.

Recommended Secondary Processing Steps

To prevent the reprocessing of old data or file duplication, your retrieval script or integration middleware should perform one of the following actions immediately after a successful download:

• Delete: Remove the file from the Unimarket outbound folder immediately after it has been ingested into your local system.
• Archive: Move the file to a different directory (e.g., /processed) if you wish to maintain a temporary backup on the server.

Directory & Folder Map

Unimarket automatically organizes files into subfolders based on the Schedule Name defined during setup. This ensures that different types of data remain separated and easy to target for automated scripts.

TIP:

Naming Conventions: The {schedule_name} in the path is dynamic. If you name your schedule "Weekly_Audit" in Unimarket, the system will automatically create and use a folder named Weekly_Audit in the appropriate directory.

When setting up the schedule for the different files, one of the credentials is the name of schedule. This will automatically create a folder with the same name in the appropriate outbound directory.

Key Integration Considerations

• Permissions: Outbound server permissions are strictly "Read/Download" for the files and "Delete/Move" for management. Unimarket cannot proactively clear these folders for you.
• Polling Frequency: Ensure your polling frequency aligns with your Unimarket schedule. If a report runs every Monday at 8:00 AM, your retrieval script should be scheduled to check the directory shortly after.
• Scalability: For high-volume communities, moving files to a /processed subfolder is the best practice to allow for easier troubleshooting if an automated job fails.
• Support: For initial sFTP credential setup or to update your list of authorized endpoints, please contact Unimarket Support at support@unimarket.com.