Faspex package states and statuses

Edit online

A package has a both a state and an upload status. The Faspex 5 UI uses a combination of these values to report the package status.

Package statuses

Package status	State	Upload status
Starting	`held`	`submitted`
Uploading	`held`	`queued`
Uploading (%, ETA)	`held`	`transferring`
Paused	`held`	`paused` or `stopped`
Failed + error message	`held`	`timed_out`, `will_retry`, `error` or `failed`
Uploaded for processing	`held`	`completed`
Processing	`transient_held_to_released_start`	`completed`
Checking relays	`transient_held_to_released_routing_packages`	`completed`
Relaying	`transient_held_to_released_finish`	`completed`
Complete	`released`	`completed`
Expiring	`transient_released_to_expired`	`completed`
Expired	`expired`	`completed`
Deleting	`transient_released_to_deleted` or `transient_expired_to_deleted`	`complete`
Deleted	`deleted`	`completed`
Uploaded for file processing	`held`	`completed`
File processing failed	`file_processing_failed`	`completed`
File processing timed out	`file_processing_timeout`	`completed`

Package states

State	Description
`held`	Faspex is waiting for the package upload to complete or for a pending package to be released.
`released`	Package contents exist on the server and are available.
`expired`	Package contents exist but are unavailable.
`deleted`	Package contents no longer exist on the server.
`transient_held_to_released_start`	A background job is running post-processing tasks such as email notifications.
`transient_held_to_released_routing_packages`	A background job is checking if the package has relays.
`transient_held_to_released_finish`	All relay jobs are submitted, and Faspex is waiting for relay transfers to complete.
`transient_held_to_expired`	A background job is changing the state of this package from `held` to `expired`.
`transient_held_to_deleted`	A background job is changing the state of this package from `held` to `deleted`.
`transient_released_to_expired`	A background job is changing the state of this package from `released` to `expired`.
`transient_released_to_deleted`	A background job is changing the state of this package from `released` to `deleted`.
`transient_expired_to_deleted`	A background job is changing the state of this package from `expired` to `deleted`.
`file_processing_failed`	The out of transfer validator returned an error.
`transient_file_processing_needed`	Faspex is waiting for the package to be processed by the out of transfer validator or a similar application.
`transient_file_processing`	The package is currently being processed by the out of transfer validator or a similar application.
`file_processing_timeout`	The out of transfer validator doesn't return a response in the expected time.
`transient_file_processing_failed_to_deleted`	A background job is changing the state of this package from `file_processing_failed` to `deleted`.
`transient_file_processing_timeout_to_deleted`	A background job is changing the state of this package from `file_processing_timeout` to `deleted`.
`transient_file_processing_needed_to_deleted`	A background job is changing the state of this package from `file_processing_needed` to `deleted`.
`transient_file_processing_to_deleted`	A background job is changing the state of this package from `file_processing` to `deleted`.

Note: Transient states represent in-between states when transitioning from one state to another.

Upload statuses

Upload status	Description
`completed`	The upload finished successfully.
`error`	An error occurred during the upload.
`failed`	The upload failed to complete.
`paused`	The upload is temporarily paused.
`queued`	The upload is waiting for its turn to start.
`stopped`	The upload was stopped.
`submitted`	The upload request has been submitted.
`timed_out`	The upload stopped because it took too long to complete.
`transferring`	The upload is actively transferring data.
`will_retry`	The upload failed but will attempt to restart.
`pre_initiation`	The upload is preparing to start.