Xavier: Published

2022-02-10T11:50:01Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Working with Jobs
|Context=You can access the '''Jobs''' page to set up, modify, and monitor your data export jobs.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext=The '''Jobs''' page displays a list of your data export jobs. From here, you can create new jobs or monitor and manage existing ones.{{NoteFormat|You can view full details for all active and completed jobs on the '''History''' page, which you can access from the '''Export''' menu.|2}}The page provides details about each job, such as data source, job type, latest status, and date when each job last ran. 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.
|Status=No
}}{{Section
|sectionHeading=Create a new job
|anchor=create-job
|alignment=Vertical
|structuredtext=To create a new job, click the '''Add new job''' button:

[[file:udm_create_job_button.png|alt="Add new job"]]

This opens the job settings editor, where you can specify the settings for the new job. Mandatory fields are marked with an asterisk (*).

[[File:udm_create_job_screen.png|alt="Create a new job"]]

You must give the job a '''Title'''. You can also add a '''Description''', but this is optional.

Select '''Contact History''' as the data '''Source'''. Then you can choose either '''Interaction''' or '''Contact''' as the data '''Type'''.

By default, '''Entity Types''' is enabled for '''all'''. If you turn the slider off, you must select at least one entity type (for example, '''Work Item'''). You can add multiple entity types.

Use the '''Run''' setting to specify how often to run the job. You can then choose to run the job immediately or schedule it to start at a specific date and time.

*'''Once''' - Select if this job is an one-time job that starts immediately after creation when '''Start immediately''' is selected or at a specific future date and time when '''Configure start date and time''' is selected.
*'''Hourly''' - Select if the job is to be run every hour. The valid hours can be between 1 and 23 and the minutes can be between 0 and 59.
*'''Daily''' - Select if the job is to be run every day at a specified time.
*'''Weekly''' - Select if the job is to be rum once a week at the specified day and time.
*'''Monthly''' - Select if the job is to be run once a month at the specified day and time. '''Note''': This job will be not be run in months with 30 days or less if you select ''30'' in the '''Day of month''' option.

The '''Date Range of Data''' setting lets you export all data or just the data for 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'''.
|FAQHeading=How do I create a job?
|Status=No
}}{{Section
|sectionHeading=Clone an existing job
|anchor=clone-job
|alignment=Horizontal
|Media=Image
|image=udm_clone_selected_job.png
|structuredtext=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:

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'''.
|Status=No
}}{{Section
|sectionHeading=Suspend (and resume) a job
|anchor=suspend-job
|alignment=Horizontal
|Media=Image
|image=udm_suspend_enable_job.png
|structuredtext=Use the slider to change the state of a job to '''Suspended''' or '''Active'''.

{{NoteFormat|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.}}
|Status=No
}}{{Section
|sectionHeading=Modify a job
|anchor=modify-job
|alignment=Vertical
|structuredtext=Select the job you want to edit and click the pencil icon[[file:cdds_admin_edit_button.png]].

When you are finished making changes, click '''Save'''.{{NoteFormat| If the data export job is only going to be run once, you cannot edit it after it is submitted. But you can modify the job before it is run.}}
|Status=No
}}{{Section
|sectionHeading=Delete a job
|anchor=delete-job
|alignment=Vertical
|structuredtext=Select the job you want to delete and click the trash icon [[file:cdds_admin_trash_button.png]].{{NoteFormat|You can't delete a job that is still in progress.}}
|Status=No
}}{{Section
|sectionHeading=View the history of a job
|alignment=Horizontal
|Media=Image
|image=udm_jobs_search_history.png
|structuredtext=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.
|Status=No
}}
}}

UDM/Current/Admin/Jobs - Revision history

Xavier: Published