Jobs
A job equates to an asynchronous operation that will take a longer duration to complete. A job is created when bulk downloading a zip or CSV file, using bulk 'save to folder' or when directly downloading a folder.
Here you can view all your created jobs up to the past seven days. You can sort the list based on the name of the job, the date time when the job was created and the number of files associated with the job. You can also download a job asset if available.
A job and the associated downloadable asset will only last up to 7 days after its creation. A job cannot be manually deleted.
Job List
Here are the description of all the fields.
Field | Description |
---|---|
Name | The name of the job is a combination of the job type and a unique set of characters. |
Started On | Date and time value at when the job started processing. |
Item Count | The item count describes the total amount of files processed for the job. |
Status | Current status of the job. Possible values are SUCCEEDED , PARTIALLY SUCCEEDED , IN PROGRESS and FAILED . |
Actions | Job specific actions available when the job either fails or succeeds. A downloadable asset is created for a download zip or download csv job. The name of the asset is the same as the name of the job.The asset name for a failed or partially succeeded save to folder job is a combination of the job name and the -errors word.No downloadable asset is created for a successful save to folder job, and the user can directly navigate to the destination folder by clicking the folder icon. |
Job Types
Jobs are generally classified into three types.
Download as Zip
A Download as Zip
job is created when bulk downloading original/transformed contents or when directly downloading a folder from the folder's context menu.
After the successful completion of the job, a zip file is created that can be downloaded. The original folder structure of the contents is maintained in the zip.
An additional errors.csv
file is created and included in the zip if any occurs during the processing.
The errors.csv
file includes File and Failure Reason columns. The File column contains the path of the file that failed and the Failure Reason column contains a relevant error message for troubleshooting.
There is a possibility for the failed files to be created in the zip with a size of 0 bytes. This usually happens if any error occurs during the streaming process.
If all files fail to process, then the job status will be set to FAILED.
Download as CSV
A Download as CSV
job is created when bulk downloading original/transformed contents as CSV.
After the successful completion of the job, a CSV file is created that can be downloaded.
Here is the description of all the fields found in the CSV file.
Field | Description |
---|---|
File Id | Unique id for the file. |
Name | Name of the file. |
URL | Pixelbin CDN URL. |
Status | Status of file transformation. |
Failure Reason | Reason for failure in transformation. Empty if transformation is successful. |
Path | Path of the file from root. Empty if the file is found at root. |
Parent Folder | Parent folder name of the file. |
Format | Format of the file. |
Size | Size of the file in bytes. |
Width | Width of the file. Empty for non image file. |
Height | Height of the file. Empty for non image file. |
Transformed Format | Format of the transformed image file. Empty for files that are not transformed. |
Transformed Size | Size of the file in bytes. Empty for files that are not transformed. |
Transformed Width | Width of the file. Empty for files that are not transformed. |
Transformed Height | Height of the file. Empty for files that are not transformed. |
Save To Folder
A Save To Folder
job is created when saving bulk transformed files in a PixelBin Storage
folder.
If the job is successful, no downloadable asset is created. When creating the job, you can directly check the transformed files in the selected destination folder by navigating or clicking on the folder icon in the Actions
column, which will redirect you to the destination folder.
For any conflict with the file names, a set of characters will be appended to the newly saved files/folders.
A CSV file is created if any error occurs during processing. The name of the CSV file is a combination of the job name and the -errors
word.
The CSV file includes File and Failure Reason columns. The File column contains the path of the file that failed and the Failure Reason column contains a relevant error message for troubleshooting.
If all files fail to process, then the job status will be set to FAILED.