Jump to: navigation, search
(Update with the copy of version: draft)
(Modified comment string {{Template:PEC_Migrated}} with __NOINDEX__ {{Template:PEC_Migrated}})
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Administration =
 
= Administration =
 +
 +
__NOINDEX__
 +
{{Template:PEC_Migrated}}
 +
 +
 
{{AnchorDiv|cdds_jobs}}
 
{{AnchorDiv|cdds_jobs}}
−
From the CDDS '''Administration''' menu, you can access the '''Jobs''' page. From the '''Jobs''' page, you can [[CDDSAdmin#new|create new data export jobs]] or monitor and manage existing ones.  
+
From the CDDS '''Administration''' menu, you can access the '''Jobs''' page. The '''Jobs''' page displays a list of your data export jobs. From here, you can [[CDDSAdmin#new|create a new data export job]] 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 [[CDDSExport#History_page|History]] page, which you can access from the [[CDDSExport|Export]] menu.)
+
{{NoteFormat|You can view full details for all active and completed jobs on the [[CDDSExport#History_page|History]] page, which you can access from the [[CDDSExport|Export]] menu.|2}}
  
−
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.
+
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.
  
−
[[file:cdds_admin_jobs_progress.png]]
+
[[File:cdds_admin_jobs_progress_02.png]]
  
 
{{AnchorDiv|new}}
 
{{AnchorDiv|new}}
Line 13: Line 18:
 
To create a new job, click the '''Add new job''' button:
 
To create a new job, click the '''Add new job''' button:
  
−
[[file: CDDS_create_manual_job_button.png|alt="Add new job"]]
+
[[File:CDDS_create_manual_job_button.png|alt="Add new job"]]
  
−
This opens the job settings editor:
+
This opens the job editor page, where you can specify the settings for the new job. Mandatory fields are marked with an asterisk (*).
  
−
[[file:cdds_admin_create_new_job.png]]
+
{{NoteFormat|Info Mart exports are not supported. Do not select Info Mart as the data source for your job.}}
  
−
* You must give the job a '''Title''' and specify the data '''Source''' and '''Type''' . All other settings are optional.
+
You must give the job a '''Title'''. You can also add a '''Description''', but this is optional.
−
<!--* If you select GIM as the data '''Source''', the '''Type''' is automatically set to '''All'''. This is the only option available for this type of data export job.-->
 
−
* 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.
 
−
{{NoteFormat|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.<!-- (This option is not available for GIM exports.) -->
 
  
−
When you are finished setting up the job, click '''Save'''.  
+
After you select '''Contact History''' as the data '''Source''', you can select either '''Interaction''' or '''Contact''' as the data '''Type'''.
 +
 
 +
[[File:cdds_admin_create_new_job_02.png]]
 +
 
 +
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.  
  
−
{{NoteFormat|If you leave this page without running the job, the job settings are NOT saved.}}
+
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.  
  
−
<!--{{AnchorDiv|new}}
+
{{NoteFormat|
−
{{CloudStep_Stack
+
* 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.
−
|title=Adding a new job
+
* Also, note that CDDS uses Coordinated Universal Time (UTC) to calculate the start time for scheduled jobs and not the local timezone. As a result, job start times are not automatically adjusted to align with changes to the local timezone, such as for Daylight Savings Time. After a local timezone change, review the start times for your scheduled jobs and adjust accordingly.}}
−
|text=There are a couple of different ways you can add a data export job. You can [[CDDSAdmin#clone|clone an existing job]], or create a new job.
 
  
−
To create a new job, click [[file: CDDS_create_manual_job_button_sm.png|alt="Add new job"]] or select '''Add new''' from the dropdown. You must give the job a '''Title''' and specify the '''Source''' and '''Type'''. All other settings are optional.
+
The '''Export Timeframe''' 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.
  
−
* If you select GIM as the data '''Source''', the '''Type''' is automatically set to '''All'''. This is the only option available for this type of data export job.
+
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.
−
* 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 run the job immediately, or specify a date and time for the job to start.
 
−
* 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. (This option is not available for GIM exports.)
 
  
 
When you are finished setting up the job, click '''Save'''.  
 
When you are finished setting up the job, click '''Save'''.  
  
−
{{NoteFormat|If you leave this page without running the job, the job settings are NOT saved.}}
 
−
|media1=cdds_admin_create_new_job.png
 
−
}}-->
 
−
 
−
<!--{{AnchorDiv|manage}}
 
−
==Managing jobs==
 
−
You can manage a job by selecting it and then choosing the action you want to take.-->
 
 
{{AnchorDiv|clone}}
 
{{AnchorDiv|clone}}
 +
{{CloudStep_Stack
 +
|title=Cloning a job
 +
|text=If you want to create a new job that is based on the settings of an existing job, you can clone the job.
  
−
==Cloning a job==
+
Select the job you want to clone and choose '''Clone selected''' from the dropdown menu. This opens the job settings editor.
−
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:
 
  
−
[[file:cdds_clone_selected_job.png]]
+
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.  
−
 
 
−
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'''.
 
When you are finished, click '''Save'''.
 +
|media1=cdds_clone_selected_job_01.png
 +
}}
  
 
{{AnchorDiv|status}}
 
{{AnchorDiv|status}}
Line 70: Line 61:
 
Use the slider to change the state of a job to '''suspended''' or '''active'''.   
 
Use the slider to change the state of a job to '''suspended''' or '''active'''.   
  
−
[[file:cdds_suspend_enable_job.png]]
+
[[File:cdds_suspend_enable_job_01.png]]
  
 
{{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.}}
 
{{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.}}
  
 
{{AnchorDiv|edit}}
 
{{AnchorDiv|edit}}
 +
 
==Editing a job==
 
==Editing a job==
 
Select the job you want to edit and click the pencil icon:
 
Select the job you want to edit and click the pencil icon:
  
−
[[file:cdds_admin_edit_button.png]]
+
[[File:cdds_admin_edit_button.png]]
  
 
When you are finished making changes, click '''Save'''.  
 
When you are finished making changes, click '''Save'''.  
Line 89: Line 81:
 
Select the job you want to delete and click the trash icon:
 
Select the job you want to delete and click the trash icon:
  
−
[[file:cdds_admin_trash_button.png]]
+
[[File:cdds_admin_trash_button.png]]
  
 
{{NoteFormat|You can't delete a job that is still in progress.}}
 
{{NoteFormat|You can't delete a job that is still in progress.}}
 
{{AnchorDiv|history}}
 
{{AnchorDiv|history}}
  
−
==Viewing the job history==
+
{{CloudStep_Stack
−
If you select a job and click the collapsed (or "hamburger") button, it will take you to the [[CDDSExport#cdds_history|History page]], where the results will be filtered to show the history of the selected job.
+
|title=Viewing the job history
−
 
+
|text=If you select a job and click the collapsed (or "hamburger") button, it takes you to the [[CDDSExport#cdds_history|History page]], where the results are filtered to only show the history of the selected job.
−
[[file:cdds_jobs_search_history.png]]
+
|media1=cdds_jobs_search_history_01.png
 +
}}
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 12:32, October 2, 2020

Administration

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to Genesys Engage cloud for Administrators.


From the CDDS Administration menu, you can access the Jobs page. The Jobs page displays a list of your data export jobs. From here, you can create a new data export job or monitor and manage existing ones.

Tip
You can view full details for all active and completed jobs on the History page, which you can access from the Export menu.

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.

Cdds admin jobs progress 02.png

Adding a new job

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

"Add new job"

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

Important
Info Mart exports are not supported. Do not select Info Mart as the data source for your job.

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

After you select Contact History as the data Source, you can select either Interaction or Contact as the data Type.

Cdds admin create new job 02.png

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.

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.

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.
  • Also, note that CDDS uses Coordinated Universal Time (UTC) to calculate the start time for scheduled jobs and not the local timezone. As a result, job start times are not automatically adjusted to align with changes to the local timezone, such as for Daylight Savings Time. After a local timezone change, review the start times for your scheduled jobs and adjust accordingly.

The Export Timeframe 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.

Cloning a job

1

If you want to create a new job that is based on the settings of an existing job, you can clone the job.

Select the job you want to clone and choose Clone selected from the 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.

Suspending (and resuming) a job

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

Cdds suspend enable job 01.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

1

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

This page was last edited on October 2, 2020, at 12:32.
Comments or questions about this documentation? Contact us for support!