Files

Overview

These API methods may be used to upload files, retrieve file information, retrieve the original file and return file data as a list of IDs (for IDList uploaded files).

There are six types of file groups:

  • Export
  • IDList
  • MARC
  • Report
  • EDI
  • BulkAddToPO

Export

The Export group is used to generate output files. It allows the following file extensions for upload:

  • .xlsx
Export files are uploaded and retrieved to/from the path defined by web.config's "ExportsFilePath" value. The default path is:
  • ~/App_Data/Exports/

IDList

The IDList group is used to provide lists of IDs for processing. It allows the following file extensions for upload:

  • .csv
  • .txt
  • .xls
  • .xlsx
IDList files are uploaded and retrieved to/from the path defined by web.config's "UploadsFilePath" value. Ultimately, the files are stored using the session context of the user ("{tenant}/users/{loggedOnUserID}/"). The default path is:
  • ~/App_Data/Uploads/{tenant}/users/{loggedOnUserID}

MARC

The MARC group is used to provide MARC data for processing. It allows the following file extensions for upload:

  • .dat
  • .mrc
  • .txt
  • .xml
MARC files are uploaded and retrieved to/from the path defined by web.config's "UploadsFilePath" value. Ultimately, the files are stored using the session context of the user ("{tenant}/users/{loggedOnUserID}/"). The default path is:
  • ~/App_Data/Uploads/{tenant}/users/{loggedOnUserID}

Report

The Report group is used to provide simple output for review. Reports are generated by the server and are all "_txt" files.

Report files are retrieved from the path defined by web.config's "ReportsFilePath" value. The default path is:

  • ~/App_Data/Reports/

EDI

EDI is used to create EDI files and upload to 3rd party vendors via FTP. Example file extensions for upload:

  • .txt
  • .xpo
EDI files are uploaded to FTP server and retrieved from the path defined by appsettings.json's "ACQEDIPOFilePath" value. The default path is:
  • ~/App_Data/EDI/PurchaseOrders/

BulkAddToPO

BulkAddToPO is used to provide a simple report for review. The report is generated by the server and is a "_txt" file. BulkAddToPO report files are retrieved from the path defined by web.config's "BulkAddToPOFilePath" value. The default path is:

  • ~/App_Data/BulkAddTo/PurchaseOrder/

Security

The folders used to store and retrieve files must have the appropriate security settings that will allow the IIS 'Polaris Application Services' app pool to have read/write access. For example, grant both read and write ACL permissions to the ApplicationPoolIdentity (IIS APPPOOL\ApplicationPool) on the App_Data/Uploads folder.

  • Example account: IIS APPPOOL\Polaris Application Services

Clean up

At service startup, files older than 24 hours are automatically deleted from both the uploads and reports folders.