Export Service is a dedicated service that allows OCP users to gain access to their raw application data. The Exports UI is accessible to all OCP users, however only users with privileged rights may create a new export or download data.
To access Export Service, go to Insights → Export Service in the side panel.
As such, the Export provides information about the following:
Omilia OCP® Data Warehouse and Export Service comply with General Data Protection Regulation (GDPR) requirements. For any data type exported from OCP, through Export Service, the OCP users are responsible to ensure that their exported data are handled accordingly and meet necessary regulations.
The Export Service Archive provides information about the total number of export requests per OCP Group to which the user has access. Users can select the desired group from a dropdown list of available groups they have access to.
Export Requests board
All the submitted exports are located as a list on the Exports board with most recents ones always displayed first.
The listed exports contain the following information:
Name: The dedicated Name for this export request.
Job ID: The unique ID for the export request.
Status: The status of the export request, can be split into three categories.
Submitted - The export request was submitted successfully.
Processing - The export request is being processed (collecting info to make the request).
Running - The export request is running after being processed.
Completed - The export request was completed and data are available for export.
Failed - The export request wasn’t completed successfully.
Expired - The data are not longer available for export.
Group: The OCP Group the export request was made for.
Submitted Date: the date the export request was made.
Data is available for download only for 24 hours after the export request was completed successfully.
Additional Exports Metadata
By selecting the (i) tooltip, the user may also view additional information about the exports requested. This includes the data types for each export request, and the date range the data were requested for.
Create an Export
OCP users with privileged access rights can create a new Export request by clicking the Create an export button at the top right of their screen.
When the Create an Export button is clicked, the following parameters should be filled in the pop-up window.:
Date Range: The selected date time the user wants to export data from.
Group: The name of the OCP group the user wants to make an export request. Can be selected from the dropdown list of the available ones.
Name: The selected name for the export request.
Data Type: The data the user wants to export from OCP. Can be selected from the dropdown list of the available ones. Navigate to the Supported Data section to learn more.
Click the Create button to finish. The success message will appear on the top right of your screen.
After that, you will see the new export on top of the exports requests list as submitted.
You can not have two different export requests for the same OCP group being processed at the same time. If you want to make multiple export requests for the same data and OCP groups, the first request needs to be completed, and only after that you proceed with the next request.
The new export request may have a minimum timespan of the 1 hour data and maximum of 48 hours. Data is NOT available real time for batch export requests but has a latency of at least 2 hours. If the data is not available for export, you will receive the “Data is not available for exports” message.
After a successful export request (depends on the size of the export request), and some period of processing, the data will be available to be downloaded. The available data for download have the Ready status along with a Save icon you need to click to start the downloading process.
Depending on the size of the exports, this process can take a couple of minutes with resulting in one or more ZIP files.
In the event of large exports, where multiple files are generated, it is common for the export process to pause momentarily due to rate limiting, before proceeding with the remaining files. This is automatically managed by the Export Service as part of its rate limiting configuration.
Export ZIP file
The downloaded Export ZIP file has the respective Export ID on it with the order number in case of multiple files from the same export request.
The Export Request ZIP example of single file can be found below:
Where the (1_of_1) refers to file 1 out of 1 total files for this export ID.
The downloaded ZIP files have the following file paths:
OCP Group Name (example ocp_test ) -> Export ID -> Streaming -> cdr -> message type (ex message_type=dialog_end) -> date= data time of exported data (example date=2023-09-04-22) -> group = OCP Group name (example group=ocp_test ) -> DownloadedJSONs.txt
The example of valid export file path is provided below:
The file splits are based on default optimal configurations to make the exports optimal and avoid delays during processing.
OCP Data has UTC timestamps.
Export Service supports the following OCP Data:
Call Detail Records
By selecting Dialog Data, the user is requesting all three Start, End and Step files within the same request.
More information about OCP Data can be found within CRD Models Schema guide.
If you want to build a more automated process for creating Exports, visit the Export API User Guide for more information.
The Export API is available for OCP users who have access to Export Service to create export requests.