Jump to: navigation, search
(Update with the copy of version: draft)
(Modified comment string {{Template:PEC_Migrated}} with __NOINDEX__ {{Template:PEC_Migrated}})
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
= Export =
+
=Export=
 +
 
 +
__NOINDEX__
 +
{{Template:PEC_Migrated}}
 +
 
 +
 
 
From the CDDS '''Export''' menu, you can access the job [[CDDSExport#cdds_history|History]] and [[CDDSExport#cdds_artifacts|Artifacts]] pages.
 
From the CDDS '''Export''' menu, you can access the job [[CDDSExport#cdds_history|History]] and [[CDDSExport#cdds_artifacts|Artifacts]] pages.
  
 
{{AnchorDiv|cdds_history}}
 
{{AnchorDiv|cdds_history}}
−
== History page ==
+
==History page==
 
The '''History''' page shows a list of active and completed export jobs, including details such as the data source, job type, current status, start time, and the resulting file name. You can use the column headers to select, sort, or filter the files in the list.
 
The '''History''' page shows a list of active and completed export jobs, including details such as the data source, job type, current status, start time, and the resulting file name. You can use the column headers to select, sort, or filter the files in the list.
  
Line 10: Line 15:
 
From this list, you can select a job and use the toolbar 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.
 
From this list, you can select a job and use the toolbar 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.
  
−
[[file:cdds_export_history_02.png]]
+
[[File:cdds_export_history_03.png]]
  
 
{{AnchorDiv|cdds_artifacts}}
 
{{AnchorDiv|cdds_artifacts}}
−
== Artifacts page ==
+
 
 +
==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.
 
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.  
 
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 ([[file:CDDS_ui_download_icon.png]]). This sends the file directly to your specified download location.
+
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.
  
−
[[file:cdds_export_artifacts_page.png]]
+
[[File:cdds_export_artifacts_page_02.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.}}
 
{{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.}}
Line 32: Line 38:
  
 
{{AnchorDiv|decrypt}}
 
{{AnchorDiv|decrypt}}
−
== Decrypting downloaded data files ==
+
==Decrypting downloaded data files==
−
Before you can decrypt an exported data file, you'll need to have a [[CDDS#importcert|valid encryption certificate specified in your CDDS user preferences]].  
+
To obtain exported data files, you must have a [[CDDS#importcert|valid encryption certificate specified in your CDDS user preferences]]. During the generation of data files, the original files are zip-compressed and packaged in an S/MIME message with an enveloped-data content type that is encrypted using the public key of the certificate you provided. Once you download the data files, you can decrypt them by using the private key associated with the certificate.
−
 
 
−
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 Recording Cloud Backup Service documentation for more information about decrypting encrypted data files.
 
  
−
After the file is decrypted, you can extract the contents of the zip file. Typically, the extracted files and folders are arranged in a hierarchical structure. For example, the hierarchy of an interaction export from UCS might look like this:
+
You can use OpenSSL to decrypt your data export files. You can download the software by following the instructions {{#Widget:ExtLink|link=https://www.openssl.org/|displaytext=here}}. If you are working with Windows, the OpenSSL binaries can be downloaded {{#Widget:ExtLink|link=https://wiki.openssl.org/index.php/Binaries|displaytext=here}}.
  
−
[[file:cdds_export_archive_format.png]]
+
To decrypt a downloaded data file, use the following OpenSSL command:
  
−
Each folder contains one or more JSON files that are formatted in {{#Widget:ExtLink|link=http://jsonlines.org|displaytext=line text format}}. You can view a JSON file by opening it in most standard text editors or web browsers.  
+
<pre>openssl smime -decrypt -binary -inkey <private_key_file>.key -in <encrypted_file>.zip.smime -out <output_file>.zip</pre>
  
−
Each line in the file corresponds to one interaction or contacts attribute in '''key:value''' format. For example, an entry in a JSON file for a contact export from UCS might look like this:
+
where:<br>
 +
<tt><encrypted_file></tt> is the file to be decrypted<br>
 +
<tt><private_key_file></tt> is the private key you used to initially configure file encryption, so that the exported files can be decrypted<br>
 +
<tt><output_file></tt> is the file that would be written after decryption
  
−
<source lang="text">{"ContactId":"00001a57JGQ00A8TZSA","tenantid":101,"createddate":"2015-08-05 08:31:20.78"}</source>
+
After the file is decrypted, you can extract the contents of the zip file. Typically, the extracted files and folders are arranged in a hierarchical structure.
  
−
This entry shows values for the customer's Contact ID, Tenant ID, and the date and time that the contact record for the customer was created.
+
For more information about the formats and schemas used for data export files, see the [[SchemaRef|Contact History Export Reference]] page.
  
−
{{NoteFormat|Keys (or fields) with empty values are not included in data exports.}}  
+
If you want to decrypt your data files using a Java program, you can leverage code from {{#Widget:ExtLink|link=https://github.com/GenesysGenesys Engage/data-download-client-java|displaytext=this repository}}.
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

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

Export

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 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, including details such as the data source, job type, current status, start time, 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 list, you can select a job and use the toolbar 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 03.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 02.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

To obtain exported data files, you must have a valid encryption certificate specified in your CDDS user preferences. During the generation of data files, the original files are zip-compressed and packaged in an S/MIME message with an enveloped-data content type that is encrypted using the public key of the certificate you provided. Once you download the data files, you can decrypt them by using the private key associated with the certificate.

You can use OpenSSL to decrypt your data export files. You can download the software by following the instructions here. If you are working with Windows, the OpenSSL binaries can be downloaded here.

To decrypt a downloaded data file, use the following OpenSSL command: 

openssl smime -decrypt -binary -inkey <private_key_file>.key -in <encrypted_file>.zip.smime -out <output_file>.zip

where:
<encrypted_file> is the file to be decrypted
<private_key_file> is the private key you used to initially configure file encryption, so that the exported files can be decrypted
<output_file> is the file that would be written after decryption

After the file is decrypted, you can extract the contents of the zip file. Typically, the extracted files and folders are arranged in a hierarchical structure.

For more information about the formats and schemas used for data export files, see the Contact History Export Reference page.

If you want to decrypt your data files using a Java program, you can leverage code from this repository.

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