/
Export
Export
- Kiss, Mate
Owned by Kiss, Mate
Feb 23, 2024
Overview
The system has 3 different export features:
- Advanced export: advanced export is designed to export data from the system on-demand or continuously with many configurable options.
The advanced export is described on this page in detail.
- Export policy: the export policy is designed to extract a large volume of data from the system on a continuous basis with only basic options.
The description of the export policy can be found here: Export policy
- Direct export policy: the direct export is designed to automatically extract all content directly from the Recording Servers, instead of querying the database. It is most suitable for exporting all data on a continuous basis from the system. The description of the export policy can be found here: Export policy
The following table describes the difference in the export features:
| Advanced Export | Export Policy | Advanced IM Export Policy | Direct Export Policy | |
|---|---|---|---|---|
| Place of execution | Media Repository / Application Server | Media Repository / Application Server | Media Repository / Application Server | Recording Server |
| Suitable for Large Volumes | No | Yes | Yes | Yes, recommended |
| Data Types and Source Platforms | Any | Any | Microsoft Teams | Limited |
| Database Query / File Based | Database Query | Database Query | Database Query | File |
| Filters | Any | Any | Any | Limited |
| User Assignment | Yes (policy filter configuration) | Yes (policy filter configuration) | Yes (policy filter configuration) | Yes (user/extension configuration) |
| Available from Search | Yes | No | No | No |
| Custom CDR File | Yes | No | No | No |
| Manifest File | Yes | No | No | No |
| Audit Log | Yes | Yes | Yes | Yes |
| Configurable Schedule | Yes | Yes | Hourly or less frequent only | No |
| Supports imported records | Yes | Yes | No | No |
| Simultaneous Execution | A single advanced export job can only run on a single server. | A single export policy can run on multiple servers, data is split across the servers. | A single export policy can run on multiple servers, data is split across the servers. | No |
Advanced conversation export allows exporting recordings from the system:
- The export feature is available for both users and administrators. Users can export recordings accessible for them, administrators can export any recordings.
- Access to the export features is controlled by permissions.
- Exports are executed by the storage service running on the Media Repository server(s). When users start a new export job, the system executes the job in the background and notify the users after completing the job in an email. Progress can be monitored on the export task list page.
- Storage targets are available specifically for export jobs. The system places exported files to these locations. Access to storage targets can be restricted for configured users/groups. The system also offers a direct download option, where exported files are hosted on the Media Repository server.
- The system is able to export media files for voice and video recordings, and IM transcript files if available (the system does not generate IM transcript files from the database if the file is missing).
- The process can export metadata files in two formats: CSV and XML. The columns in the CSV file are customizable and created during the export process. The XML metadata file is the original metadata file created by the recording services. If the XML file is not available, the export process will not create it.
- The export feature can create a Conversation Detail Records (CDR) file for each job in CSV/PDF format, listing all recordings.
- The system can create an export manifest file for each export job. It details how the search was run (query), the number of items exported, by who the search was run, the exceptions involved/encountered.
- Export jobs can be run based on a configured schedule.
User permissions for conversation export
User permissions
The table below summarizes user-level permissions controlling access to export features. Users are only allowed to access export features through the search/list page, providing access to recordings available for the specific user only.
| Permission | Description |
|---|---|
Download a Conversation | Allows downloading a single conversation on the search/list page. |
| Conversation Export | Grants access to advanced conversation export on the search/list page:
|
| Recurring Conversation Export | Grants access to scheduled/recurring export under advanced export. |
| Conversations List Export | Allows exporting conversation detail records to CSV/XLS/PDF on the search/list page. |
Administrator permissions
The table below summarizes administrator-level permissions controlling access to export features. Administrator level permissions allow exporting all recordings under Administration -> Conversation Export.
| Permission | Description |
|---|---|
| Conversation Export | Grants access to advanced conversation export under Administration -> Conversation Export:
|
| Recurring Conversation Export | Grants access to scheduled/recurring export under advanced export. |
Starting a conversation export
The system allows exporting and downloading conversations in various ways:
- Users can download voice/video recordings, media files on the search/list page by clicking on the download icon (disk), for more information see Downloading a single media file.
- Users can export conversation detail records on the search/list page by clicking on one of the export options (Excel, CSV, PDF) under the export button in the top toolbar.
- Users can use the advanced export features on the search/list page by clicking on the Advanced option under the export button in the top toolbar.
- Administrators can use the advanced export features under Data > Export.
Configuring advanced conversation exports
Once you start an advanced conversation export, you can configure various settings for the export job.
Conversation Export
In this section, you can configure the general settings for the export job.
| Configuration Item | Description |
|---|---|
| Name | Descriptive name of the export job. |
| Target Type | Type of the storage destination, the process moves the files to this location.
|
| Storage Target | Storage Target selected for the export job. This option is only available if the Target Type is set to Storage Target. For more information, see Storage and export targets. |
| Time zone | The event times in the conversation metadata will be shown based on the selected time zone. |
| Rename Files | Files exported using their original file name unless a specific pattern is defined to rename the files. All media and metadata files will be renamed using the configured pattern. |
| Do Not Create Subfolders | If turned on, the export job won't place the files into different folders based on the date of the recordings. |
| Do Not Create Log in the Database | If turned on, then the system will not generate log in the database. This can be used to save space when no reporting is needed. Note that the system will not export a conversation multiple times for the same Export Task even if this option is turned on. |
| Server | Sets which server(s) should run the export job. Servers can be added by clicking on the >> button, or removed by the << button. The server(s) on the same geographical location as where the user resides should be selected. |
| Query | Descriptive/friendly representation of the query used to select conversations for export. If a user starts the export from the search/list page, the query shows the criteria configured on the search page. If an administrator starts the advanced export job, this field reflects the query built on this page below. |
| Send Notification to Email Address(es) | Email address(es) for notifications, separated by line breaks. The system sends a notification to the configured email address(es) after completing the export job. If the recurring job is scheduled, the system sends the notification after each run. |
| Email Subject | The subject of the notification email. |
| Email Message | Body of the notification email. |
| Source Dataset | Administrators can limit the scope of exported conversations to online, archived or both. |
| Ignore CDR-Only Records Without Related Media | For trader voice conversations, the system can create CDR-Only records without a reference to any media. These records can be ignored during export. |
| Conversation Detail Fields | Administrators can define the criteria for selecting records for the export job. |
Conversation Detail Fields
The table below summarizes the available conversation details fields which can be configured as a filter for the export.
| Category | Field | Description |
|---|---|---|
| Participants | From | The number of the caller party in the conversation |
| From Info | The number of the called party in the conversation | |
| From (digits) | The number of digits in the phone number of the initiator of the conversation | |
| From Device ID | The Device ID of the initiator of the conversation | |
| From IP | The IP address of the caller party in the conversation | |
| To | The name of the caller party in the conversation | |
| To Info | The name of the called party in the conversation | |
| To (digits) | The number of digits in the phone number of the target of the conversation | |
| To Device ID | The Device ID of the target of the conversation | |
| To IP | The IP address of the called party in the conversation | |
| Both To or From | The number of any party participating in the conversation | |
| Both To or From Info | The name of any party participating in the conversation | |
| Dialed Number | The original dialed number | |
| User | The user associated with the conversation based on the extension configuration | |
| User Location | The location of the user, defined in the user configuration | |
| Extension | The extension numbers in a conversation, a selection list of the configured extensions, otherwise similar to the 'Any party number' field below | |
| Group | The group where a conversation belongs to based on the users associated with the conversations | |
| User ID | The User/Agent/Trader ID obtained from the recorded platform | |
| Details | Start Time (UTC) | The start time of the conversation in UTC timezone |
| Recent Than | Only conversations selected where the start time is recent than the defined value. Make sure it is not used with a recurring schedule, otherwise conversations can be skipped if the defined value is close to the recurring period. | |
| Older Than | Only conversations selected where the start time is older than the defined value | |
| Direction | The direction of the conversation (e.g. internal, inbound, outbound, etc.) | |
| End Cause | The end cause of the conversation (e.g. normal, hold, transfer, etc.) | |
| Duration Interval | The length of the conversation | |
| Conversation Type | The type of conversation. Available options:
| |
| Forward Reason | The forward reason for the conversation (e.g. forwarded, transferred, team call, delegated, etc.) | |
| Protected | Defines whether the conversation is protected | |
| Label | The labels added to the conversation | |
| Case | The cases containing the conversation | |
| Encrypted with Certificate | The certificate used to encrypt the conversation | |
| Signed with Certificate | The certificate used to sign the conversation | |
| Quality Management Scorecard Exist | Checks if there is a Quality Management Scorecard assigned to the conversation | |
| Analytics | Silence ratio | The silence ratio in a conversation |
| Talkover ratio | The talkover ratio of the conversation | |
| Longest Silence | The longest silence present in a conversation | |
| Technical | Recording Server | The hostname of the server that recorded the conversation |
| Media file name | The name of the stored media file | |
| Storage target | The current storage location of the media file(s) | |
| Source Platform | Defines which telephony / unified communications system the conversation was recorded on (Cisco, Sfb, Avaya, etc.) | |
| Secondary | Defines whether the conversation is recorded on a server marked as secondary (using 2N / duplicate recording) | |
| CDR/Media Record | Defines whether the conversation is a Standard, CDR-Only or Media-Only record. CDR-Only and Media-Only records are used for trader voice recording. | |
| Elapsed Time Since Transcoding (UTC) | The time elapsed since transcoding in UTC timezone | |
| Time of Transcode (UTC) | The date and time of transcoding in UTC timezone | |
| Metadata Fields | Custom Metadata Fields | Custom metadata fields configured in the system, the list of available fields might vary depending on the integration configured and the metadata templates added |
Media Files
In this section, you can configure how you want to export media files (voice/video recordings and IM transcript files if available).
| Configuration Item | Description |
|---|---|
| Export Media Files | Enables exporting media files. |
| Decrypt Encrypted Conversations | If a voice/video file is encrypted, the system can automatically decrypt the files before exporting. Original files remain encrypted. |
| Generate Media Files for CDR-Only Conversations | For trader voice recordings, the system can stitch related media files together for the CDR-Only records. If not enabled, the system will export the metadata file only for the CDR-Only records. |
| Voice Format | Voice recordings can be optionally transcoded to the selected format. |
| Video Format | Video recordings can be optionally transcoded to the selected format. |
| Desktop Recording and Screen/Application Sharing Format | Screen share recordings can be optionally transcoded to the selected format. |
Metadata Files
In this section, you can configure how you want to export metadata files.
| Configuration Item | Description |
|---|---|
| Export XML Metadata Files | Enables exporting original XML metadata files. Metadata XML files are generated by the recording services. If the file is missing, the system will not create it during the export process. |
| Create CSV Metadata Files | Enables creating customized CSV metadata files for each exported recording. By clicking on the Configure Columns button, you can select the fields and the order of the fields stored in the CSV file. The header names and the time format are configurable too. |
| CSV Delimiter | If CSV export is selected, the CSV delimiter can be configured here. |
CDR File
In this section, you can configure how you want to create a conversation detail record file for the export job.
| Configuration Item | Description |
|---|---|
| Create Conversation Detail Records (CDR) File | Enables creating a CDR file for the export job, listing all conversations. The system creates one CDR file for each export job. By clicking on the Configure Columns button, you can select the fields and the order of the fields displayed in the CDR file. The header names and the time format are configurable too. |
| Conversation Detail Records (CDR) File Format | The system supports CSV and PDF formats for CDR files. |
| CSV Delimiter | If CSV format is selected, the CSV delimiter can be configured here. |
Manifest File
In this section, you can configure how you want to create a manifest file for the export job. The manifest file is an HTML formatted file with configurable content.
| Configuration Item | Description |
|---|---|
| Create Manifest File | Enables creating a manifest file for the export job. |
| Include User Identification | Defines if user identification is included in the manifest file. |
| Include Query | Defines if the descriptive/friendly query (see above) included in the manifest file. |
| Include List of Exported Files | Defines if all files exported listed (with an indication of error) in the manifest file. |
| File Extension | Defines the file extension for the manifest file. |
Scheduling
In this section, you can configure how you want to export conversation detail record files.
| Configuration Item | Description |
|---|---|
| Schedule | Scheduling setting for the export job.
|
| Time of Next Export | Date and time of the next export run. |
| Period Settings | Scheduling settings for periodic/recurring exporting. By clicking on the ... button, the scheduling wizard opens. |
Checking export progress and status
Advanced export jobs can be monitored in the following way:
- Advanced export jobs initiated by users can be checked under Data > Export. Users can only check their own export jobs.
- Advanced export jobs initiated by administrators under Data > Export. Administrators can check the status of any export job, regardless of the initiator of the export job.
- Advanced export jobs initiated by both users and administrators can be followed under System > Background Tasks. Access to this page is controlled by special permission.
Finished export tasks can be removed by opening the export task, then clicking on the Delete button at the bottom. When removing an export task, it's also possible to remove the exported files, by ticking the Delete files on the export location checkbox in the deletion confirmation popup.
Failure behavior
It is a rare occurrence, but recording export might fail, for example, unexpected permissions change or media unavailable. The behavior of export jobs in this scenario depends on job scheduling - Export jobs can be configured to run once and also to run continuously.
- If run once is selected, then failed records are never retried.
- If run continuously is selected, failed records are dealt with according to the scheduling:
- If no scheduling is set, or minute by minute scheduling is configured, the “end” of the export job is considered at the end of the day. At this point, background task and manifests are closed. During the day, failed exports will be retried and they will also be retried indefinitely on every following day. Exported recordings are placed in folders according to call start time date and not from export run time. Only the latest manifest contains details of exported recordings that failed on previous occasions but are now successful.
- If daily/weekly/monthly scheduling is set, failed records will be reported at the end of each export job and the manifest will contain them. As per the schedule, when the export runs again, failed recording exports will be retried. Exported recordings are placed in folders according to call start time date and not from export run time. Only the latest manifest contains details of exported recordings that failed on previous occasions but are now successful.
At present, it is not possible to configure a job that exports previously failed exports of recordings. In order to prevent the retry of failed exports, it is recommended to use the Recent Than condition to limit efforts. In general, this approach is recommended for reasons of performance.
Disabling direct download
You may want to completely disable the direct download option. By disabling the direct download option, users will only able to export recordings to specified storage targets.
In order to disable this option, follow the steps below:
Step 1 - In the Verba web interface click on System > Servers and select your Media Repository server, or select the appropriate Configuration Profile at System > Configuration Profiles.
Step 2 - Click on the Change Configuration Settings tab.
Step 3 - Expand Web Application > Miscellaneous.
Step 4 - Configure Enable direct download folder field on the export page.
Step 5 - Click on the Save icon to save your settings
Step 6 - The system will notify you that the changes need to be applied to the server by restarting the involved services. Execute the required tasks.
, multiple selections available,