Appearance
Archiving
Archiving offers numerous benefits, primarily cost savings and operational efficiency. Businesses can significantly reduce their expenses on physical space or high-end digital storage systems by leveraging more affordable storage options. Less expensive storage solutions often provide scalable options, enabling companies to store massive amounts of data without worrying about increasing costs.
Currently, AWS S3 is the only supported cloud-based service for archiving purposes.
WARNING
It is not recommended to allow archiving to move files during the day as this may cause unexpected results when retrieving files and other data.
Relevant Settings
Group | Setting | Description |
---|---|---|
ArchiveSettings | DaysAfterComplete | The number of days after a transaction reaches a "complete" state after which the files will be moved to the archive location. A complete state is Complete, Expired, Voided, Cancelled or Closed. |
ArchiveSettings | EarliestStartTime | This is the earliest time the process will start moving files. This is based on the server time. Given the server time is set to UTC, a value of 00:01 will allow the process to start at 7pm EST. |
ArchiveSettings | IsActive | Should the process be moving files? When false, the process will no move files. All files already moved will still be accessible. |
ArchiveSettings | LatestEndTime | The lastest time the process will attempt to move files. This is based on the server time. Given the server time is set to UTC, a value of 10:59 will stop queuing transactions to be moved at 5:59am EST. |
ArchiveSettings | Location | The location of the archive. For file system, NTFS, etc. this may be a file path like Z:\\Archive or a UNC location like \\archive\\location . For AWS S3, the bucket name is prefixed with S3:\\ as in S3:\\my-archive-location . |
ArchiveSettings | LockDurationInDays | Transactions are "locked" to avoid multiple process attempting to move the same files at the same time. The lock duration is the number of days a process can lock a transaction. Another process will be able acquire lock and attempt to complete the processing if the move is not complete within this time frame. This can be set lower if the number and size of files in a transaction are generally small. |
ArchiveSettings | MaximumAttempts | The maximum number of attempts to be made to archive a transaction. A transaction will not be considered for archiving once this threshold is reached. |
ArchiveSettings | MaximumConcurrentOperations | The maximum number of transactions processing at the same time. Use with MaximumRowsToFetch to control the maximum number of transactions being archived in a single run. When set to 5000, no more than 5000 transactions will be queued for processing. |
ArchiveSettings | MaximumRowsToFetch | The number of transactions to process in a single batch. Use with MaximumConcurrentOperations to control the maximum number of transactions being archived in a single run. When set to 1000, a maximum of 1000 transaction will be read and added to the processing queue. Additional transactions will not be queued if the number of transactions in the queue exceeds MaximumConcurrentOperations. |
ArchiveSettings | SleepDelayInMinutes | The number of minutes the process will wait before attempting to queue additional transactions. |
AmazonSettings | UseCloudArchiving | Allows the archive processing to write files to an AWS S3 bucket when set to true—see ArchiveSettings.Location for information on designating an AWS S3 archive location. |