Jump to: navigation, search

Administration

From the CDDS Administration menu, you can access the Jobs page. From the Jobs page, you can create new data export jobs or monitor and manage existing ones.

The page displays a list of data export jobs, including details such as the data source, type, latest status, and date when each job last ran. (To view full details for all active and completed jobs, go to the History page, which you can access from the Export menu.)

If a job is still running, the Latest Status column features a status bar to indicate the progress of the active data export job. If you hover your mouse over the bar, it displays the estimated time remaining until the job completes.

Cdds admin jobs progress.png

Adding a new job

To create a new job, click the Add new job button:

"Add new job"

This opens the job settings editor:

Cdds admin create new job.png

  • You must give the job a Title and specify the data Source and Type . All other settings are optional.
  • By default, Media Types is enabled for all. If you turn the slider off, you must select at least one media type (for example, Chat). You can add multiple media types.
  • The Run setting lets you specify how often the job should run. You can then choose to run the job immediately, or specify a date and time for the job to start.
Important
If you select Hourly, the start time is calculated based on 00:00 UTC (Coordinated Universal Time) and not the local timezone. For example, let's say you want the job to run every 4 hours. The first run of the job will be at 00:00 UTC, the next at 04:00 UTC, then 08:00 UTC, and so on.
  • The Export Timeframe setting lets you choose whether to export all data or just the data from a specific time period. If you select Fixed interval, you can then specify the Start and End dates for the export.
  • By default, the data is exported as a single file. If you want to break the exported data into a set of smaller files, use the File Split Size setting to specify the size of each file.

When you are finished setting up the job, click Save.

Important
If you leave this page without running the job, the job settings are NOT saved.


Cloning a job

This option is useful if you want to create a new job based on the settings of an existing job.

Select the job you want to clone and choose Clone selected from the Add new button dropdown menu:

Cdds clone selected job.png

This opens the job settings editor. You can keep the existing job settings, or make any desired changes. For example, you might want to give the job a different Title or adjust the range of the Export Start/End dates.

When you are finished, click Save.

Suspending (and resuming) a job

Use the slider to change the state of a job to suspended or active.

Cdds suspend enable job.png

Important
If you create a one-time data export job (i.e. a job you intend to only run once) and submit it to run immediately, it is automatically added in a suspended state and can't be resumed. If you create and submit a one-time job with a delayed (i.e. scheduled) start time, it automatically changes to a suspended state when the job starts.

Editing a job

Select the job you want to edit and click the pencil icon:

Cdds admin edit button.png

When you are finished making changes, click Save.

Important
If the data export job is only going to be run once, you won't be able to edit it after it is submitted.

Deleting a job

Select the job you want to delete and click the trash icon:

Cdds admin trash button.png

Important
You can't delete a job that is still in progress.

Viewing the job history

If you select a job and click the collapsed (or "hamburger") button, it will take you to the History page, where the results will be filtered to show the history of the selected job.

Cdds jobs search history.png

This page was last modified on June 5, 2019, at 08:36.

Feedback

Comment on this article:

blog comments powered by Disqus