...
On This Page
| Table of Contents |
|---|
Overview
The jobs grid provides an overview of all jobs created and options to manage them. The Jobs tab displays all the transfer jobs (jobs that actively move content), and the Simulation tab displays the simulation jobs (jobs not actually moving content). This makes it easier to manage your transfer and simulation jobs. The grid options are the same for both grids.
...
| Info |
|---|
If a job name is too long to display fully in the Jobs list, you can hover on the name. This will display a pop-up that displays the full name of the job. |
Searching for Jobs
Use the search field to quickly find a job. Simply type the search criteria you want to use and press ENTER. The Jobs list will show only jobs that meet your search criteria. Select Clear filters to reset the jobs list.
Filtering the Jobs List
The Filter by option allows you to refine the Jobs list based on job type, status, category, source platform, or destination platform. The filters can be used in combination with the search as needed.
...
Customizing Column Options
Last run and Job status are the default columns displayed on the jobs grid. You can what displays in these columns based on the information you prefer to view. Click the arrow next to the column name to display the list of available column content. The list also includes options to sort the columns in ascending or descending order based on the selected data for the column.
...
Column name | Description |
|---|---|
ID | Unique ID assigned to the job at the time of creation |
Source | Source path for the job |
Destination | Destination path for the job |
Last run | Default column option. The last run date and time for the job |
Next run | The next run date and time for the job. "Not scheduled" appears for jobs not set to run on a schedule. |
Job status | Default column option. Status indicating what's happening with the job. See Job Status, Item Error & Warnings Categories for more information. |
Job duration | The duration of a running job. Jobs that are not actively running will display a dash ( - ) as the status. |
Category | Category assigned to the job |
Created | Date the job was created (month and day) |
Modified | Date the job was last modified (month and day) |
Transfer rate | Previous or current job's execution transfer rate in bytes per second. Only counts file data payload |
Status data | Sum of latest version sizes of items with selected status during transfer job. The available options are:
|
Status data (all versions) | Sum of all version sizes of items with selected status during transfer job. The available options are:
|
Status items | Number of files and folders with selected status during transfer job. The available options are:
|
Viewing More Options
When you select a job or multiple jobs in the list, a More options button displays. This button opens a menu with options you can use to manage job schedules, rename jobs, reset jobs, duplicate jobs, and delete jobs. The More options button is not available when selecting system jobs since you can't alter these jobs.
...
Managing Multiple Jobs
Selecting more than one job enables options to manage the schedules and run the selected jobs. When adding multiple job status filters, the grid will display jobs that match any of the selected statuses.
...
Exporting the Jobs List
The Export this list option exports the current job list to a csv file and provides additional information about the jobs. The export will reflect any filters applied to the job list before exporting the information.
Field | Description |
|---|---|
job_id | The ID assigned to the job in the SkySync application |
job_name | The job name |
source_path | The source path used for the job |
source_id | The ID assigned to the source connection used for the job. The ID is assigned by the SkySync application when the connection is created. |
source_name | The name assigned to the source when it was created in the SkySync application |
source_account | The account on the source platform used for the job |
destination_path | The destination path used for the job |
destination_id | The ID assigned to the destination connection used for the job. The ID is assigned by the SkySync application when the connection is created. |
destination_name | The name assigned to the source when it was created in the SkySync application |
destination_account | The account on the destination platform used for the job |
successful_item_count | The number of items in the job that were successfully transferred |
flagged_item_count | The number of items in the job that were flagged for review. These are items that were flagged because they could not be transferred or because there was an issue with the transfer that needs to be reviewed. |
number_of_executions | The number of times the job has run |
last_failure_message | The last failure message the job received (if applicable) |
...
List Jobs Using the REST API
You can retrieve the same information available in the Jobs grid using the REST API.
List All Jobs
| Code Block |
|---|
GET {{url}}v1/jobs?fields=category&limit=1000 |
List All Simulation Jobs
| Code Block |
|---|
GET {{url}}v1/jobs?simulation_mode=true |
List all Child Jobs for a Convention Job
| Code Block |
|---|
GET {{url}}v1/jobs?parent_job={{job}} |
List All Jobs by Filter
List All Jobs By Category
| Code Block |
|---|
GET {{url}}v1/jobs?job_category_id={{id}} |
List All Jobs By Job Type
| Code Block |
|---|
GET {{url}}v1/jobs?kind=personal_drive
Options include:
transfer
personal_drive
folder_mapping
system |
List All Jobs By Source Platform
| Code Block |
|---|
GET {{url}}v1/jobs?sources={{platform name}}
Options include:
box, office365, onedrive-business, sharepoint, dfb, fs, nfs, onedrive, box-service, dropbox
google-suite, google-teams, google-drive, azure-blob |
List All Jobs By Destination Platform
| Code Block |
|---|
GET {{url}}v1/jobs?destinations={{platform name}}
Options include:
box, office365, onedrive-business, sharepoint, dfb, fs, nfs, onedrive, box-service, dropbox
google-suite, google-teams, google-drive, azure-blob |
List All Jobs By Category
| Code Block |
|---|
GET {{url}}v1/jobs?transfer_type=sync
Options include:
copy
sync
move
migrate
publish
taxonomy |
Export Jobs List
This will export a list of all jobs to a csv file. The endpoint will return a download link (in its "links" section).
...