Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 1: Line 1:
−
= Exporting your data =
+
= Export =
−
From the '''Export''' menu, select '''Manual''' to go to the '''Manual Jobs''' page. From here, you can [[#create|create]], [[#manage|manage]], [[#clone|clone]], and [[#view|view]] your manual data export jobs.  
+
From the CDDS '''Export''' menu, you can access the job [[CDDSExport#cdds_history|History]] and [[CDDSExport#cdds_artifacts|Artifacts]] pages.
  
−
[[file:CDDS_export_manual_nav.png]]
+
{{AnchorDiv|cdds_history}}
 +
== History page ==
 +
The '''History''' page shows a list of active and completed export jobs, with details such as the data source, job type, the current status of the job, when the job started, and the resulting file name. You can use the column headers to select, sort, or filter the files in the list.
  
−
==Requirements ==
+
For jobs with a status of '''In Progress''', a progress bar indicates that the data export is currently active. If you hover your mouse over the bar, it will show you the estimated remaining time for the job to complete.
−
Before you can export data, you must have a [[CDDS#importcert|valid encryption certificate specified in your user preferences]].  
 
  
−
{{AnchorDiv|create}}
+
From this page, you can select a job and use the buttons to view additional details about the job, delete the job, clone that particular instance of the job, or locate the related file(s) on the '''Artifacts''' page.
  
−
==Creating a new manual job==
+
[[file:cdds_export_history_02.png]]
−
Click the '''Create''' button to open the '''New Manual Job''' page. Enter the desired [[#Job_settings|job settings]] and click '''Run & Close'''. The job is submitted right away and you can monitor it from the '''Manual Jobs''' page.
 
  
−
[[file:CDDS_export_create_job.png]]
+
{{AnchorDiv|cdds_artifacts}}
  
−
To cancel without creating or running the job, click the '''back''' button ([[file:CDDS_back_button_sm.png|baseline]]).  
+
== Artifacts page ==
 +
The '''Artifacts''' page shows the exported data files that are available for download. You can see additional details about each file, such as the data type, when it was created, and how many days are remaining in the 30-day storage limit. You can use the column headers to select, sort, or filter the files in the list.
  
−
{{NoteFormat|If you leave this page without running the job, the job settings are NOT saved.}}
+
From this page, you can select a file(s) and then use the buttons to '''download''' or '''delete''' the selected file(s). You can select up to a maximum of 100 files, but note that each download opens in a separate browser window. Depending on your browser settings, you might need to disable any pop-up blockers.  
  
−
===Job settings ===
+
Alternatively, you can also download a single file by clicking its download icon ([[file:CDDS_ui_download_icon.png]]). This sends the file directly to your specified download location.
−
Mandatory settings are marked by '''*'''. All other settings are optional.
 
−
{| class="no-border"
 
−
|'''Title *'''
 
−
|Enter a name for the job.
 
−
|-
 
−
|'''Export Start/End Dates'''
 
−
|If you want to specify a range of data to export, use the date pickers to select the start and end dates (captures data from 0:00:00 on the specified starting day to 23:59:59 on the specified ending day). 
 
−
|-
 
−
|'''File Split Size'''
 
−
|By default, the data is exported as a single file. Use this setting to specify the file size if you want to break the exported data into smaller files.
 
−
|-
 
−
|'''Source *'''
 
−
|Select where the data is coming from. (Currently, you can only export data from UCS.)
 
−
|-
 
−
|'''Type *'''
 
−
|Select which type of data to export.
 
−
|-
 
−
|'''Media Types'''
 
−
|By default, the job applies to '''all''' media types. If you turn this slider off, you must select at least one media type (for example, '''Chat'''). You can add multiple media types.
 
−
|-
 
−
|'''Description'''
 
−
|If you like, you can enter a description for this job.
 
−
|}
 
  
−
{{AnchorDiv|clone}}
+
[[file:cdds_export_artifacts_page.png]]
−
== Cloning a manual job ==
 
−
To clone a job, select it and click the '''Clone''' button.  
 
  
−
[[file:CDDS_export_clone_job.png]]
+
{{NoteFormat|Files are stored for a maximum of 30 days. When the '''Remaining Days''' value reaches zero (0), the file is removed from storage and no longer available for download.}}
  
−
This opens the '''Edit Manual Job''' page, where you can review or change the [[#Job_settings|job settings]]. For example, you might want to give the job a different '''Title''' or adjust the range of the '''Export Start/End''' dates.
+
===Downloading split files===
 +
If a job was set up using the '''File Split Size''' option, you must download all of the files associated with that job before extracting the data.  
  
−
When you are finished making changes, click '''Run & Close'''. The job is submitted right away and you can monitor it from the '''Manual Jobs''' page.
+
You can tell if a file belongs to a split job by the filename &mdash; it will indicate that the file is part of a numbered set. For example, '''export-2b710a2c-0e7f-4918-983c-c02d108eaeb0.<font color="red">z12</font>.smime''' indicates that this file is part 12 of a compressed data file.  
  
−
To cancel without creating or running the job, click the '''back''' button ([[file:CDDS_back_button_sm.png|baseline]]).  
+
When you have downloaded all of the split files for a job, you just need to initiate the extraction for one of the files. The extraction utility will automatically locate and extract the other pieces that belong to the data file.
  
−
{{NoteFormat|If you leave this page without running the job, the job settings are NOT saved.}}
+
{{AnchorDiv|decrypt}}
 +
== Decrypting downloaded data files ==
 +
You'll need to have a [[CDDS#importcert|valid encryption certificate specified in your CDDS user preferences]].
  
−
{{AnchorDiv|manage}}
+
You can decrypt the downloaded data files using the private key that is associated with the valid certificate you provided. Refer to [[Documentation:PSAAS:Administrator:Backup#Decrypting_the_downloaded_files|Decrypting the downloaded files]] in the GIR documentation for information about decrypting encrypted data files.
  
−
==Managing manual jobs==
+
After the file is decrypted, you can extract the contents of the zip file. The extracted folder contains several JSON files that are formatted in {{#Widget:ExtLink|link=http://jsonlines.org|displaytext=line text format}}.  
−
When a manual job completes, the exported data file is encrypted and compressed in S/MIME (Secure/Multipurpose Internet Mail Extensions) format. For example: '''export-f2ef2e7f-304a-4d13-a691-8d89e707c761.zip.smime'''. (For more details about the exported file format, see [[CDDSDownload#decrypt|Decrypting downloaded data files]].)
 
  
−
The manual jobs list also displays details for each job, such as the '''Source''' of the exported data, the data '''Type''', the '''Created Date''', and the current '''Status''' of the job.
+
Each line corresponds to one interaction or contacts attribute in '''key:value''' format. For example:
  
−
You can use the column headers to select, sort, or filter the jobs in the list.
+
<source lang="text">{"ContactId":"00001a57JGQ00A8T","tenantid":101,"createddate":"2009-08-05 08:31:20.78"}</source>
  
−
===Canceling a job===
+
Fields with empty values are not included in the data export.  
−
If a job is still in progress, you can cancel it by clicking '''x''' in the '''Cancel''' column.
 
−
 
 
−
[[file:CDDS_manual_job_cancel.png]]
 
−
 
 
−
===Deleting a job===
 
−
To delete a job(s), select it and click the trash icon.
 
−
 
−
{{NoteFormat|You can't delete a job that is still in progress.}}
 
−
 
 
−
{{AnchorDiv|view}}
 
−
 
 
−
== Viewing job details ==
 
−
Select a job and click the '''View''' button to see the job details.
 
−
 
 
−
[[file:CDDS_export_view_details.png]]
 
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 15:35, June 5, 2019

Export

From the CDDS Export menu, you can access the job History and Artifacts pages.

History page

The History page shows a list of active and completed export jobs, with details such as the data source, job type, the current status of the job, when the job started, and the resulting file name. You can use the column headers to select, sort, or filter the files in the list.

For jobs with a status of In Progress, a progress bar indicates that the data export is currently active. If you hover your mouse over the bar, it will show you the estimated remaining time for the job to complete.

From this page, you can select a job and use the buttons to view additional details about the job, delete the job, clone that particular instance of the job, or locate the related file(s) on the Artifacts page.

Cdds export history 02.png

Artifacts page

The Artifacts page shows the exported data files that are available for download. You can see additional details about each file, such as the data type, when it was created, and how many days are remaining in the 30-day storage limit. You can use the column headers to select, sort, or filter the files in the list.

From this page, you can select a file(s) and then use the buttons to download or delete the selected file(s). You can select up to a maximum of 100 files, but note that each download opens in a separate browser window. Depending on your browser settings, you might need to disable any pop-up blockers.

Alternatively, you can also download a single file by clicking its download icon (CDDS ui download icon.png). This sends the file directly to your specified download location.

Cdds export artifacts page.png

Important
Files are stored for a maximum of 30 days. When the Remaining Days value reaches zero (0), the file is removed from storage and no longer available for download.

Downloading split files

If a job was set up using the File Split Size option, you must download all of the files associated with that job before extracting the data.

You can tell if a file belongs to a split job by the filename — it will indicate that the file is part of a numbered set. For example, export-2b710a2c-0e7f-4918-983c-c02d108eaeb0.z12.smime indicates that this file is part 12 of a compressed data file.

When you have downloaded all of the split files for a job, you just need to initiate the extraction for one of the files. The extraction utility will automatically locate and extract the other pieces that belong to the data file.

Decrypting downloaded data files

You'll need to have a valid encryption certificate specified in your CDDS user preferences.

You can decrypt the downloaded data files using the private key that is associated with the valid certificate you provided. Refer to Decrypting the downloaded files in the GIR documentation for information about decrypting encrypted data files.

After the file is decrypted, you can extract the contents of the zip file. The extracted folder contains several JSON files that are formatted in line text format.

Each line corresponds to one interaction or contacts attribute in key:value format. For example: 

{"ContactId":"00001a57JGQ00A8T","tenantid":101,"createddate":"2009-08-05 08:31:20.78"}

Fields with empty values are not included in the data export.

Comments or questions about this documentation? Contact us for support!