Table of Contents

TSV EXPORTER

Introduction

The TSV export feature feature allows users to export data from list pages to file format, which can then be downloaded. Users have the option to export either all pages or just the current page.

When an export request is made via front-end, an export job is queued and then processed by some TSV export service, which must be running. The user is notified with the download link after the export finishes. There are two available distributions of such export services:

Distributions

  • Tsv Exporter Agent

    • Technology: Utilizes MibAgentWebHost
    • Included export modules: Front, Edit History
    • Go to documentation

  • Tsv Exporter Worker (Beta)

Click on the documentation link for the chosen distribution to get started.

Export Modules

A TSV export service can support multiple export modules. Each module handles different types of export requests, which may require query data in various formats and from different sources in order to generate the export file.

Front Module

This module process export requests that comes from all places other than the Edit History. It queries the table MIB3UX_TSV_REQUESTS for new jobs. See the documentation of the TSV exporter distribution you are using for instructions on how to enable this module.

Export request format

Below is the export request format accepted by this module:

Current page

criteria: 
{
  "Page": 0,
  "Limit": "20",
  "MediaType": "movie_contents",
  "Clause": "",
  "Order": "ID,desc",
  "Conditions": [],
  "ImplicitConditions": [],
  "DisplayFields": [
    "ID",
    "NAME",
    "INSTANCE_ID",
    "OWNER",
    "MOVIE_TYPE_ID",
    "MOVIE_VERSION_ID",
    "CONTENT_TYPE_ID",
    "VOD_OFFER_TYPE_ID",
    "SOURCE_ID"
  ],
  "IsAdvancedSearch": false,
  "SearchFavoriteId": 0,
  "SourcePermission": {
    "Write": "none",
    "Delete": "none"
  },
  "ReturnUrl": "https://localhost/MibFront/Display/movie_content_list",
  "ContentCriteriaTemplateComponentKey": "",
  "SelectedSources": [],
  "DisplayValuePattern": "",
  "TemplateComponentKey": "one_list_template_list_1",
  "ShowOnlySelectedItems": false
}

All pages To export all pages, the “Limit” field is set to -1. When this option is selected, items are exported in batches of 250 until all items have been fetched from MibApi.

Edit History Module

This module process export requests related to edition history. It queries the table MIB3UX_TSV_EDITHISTORY_REQUESTS for new jobs. See the documentation of the TSV exporter distribution you are using for instructions on how to enable this module.

Export status

The following are the statuses that a TSV Export job can assume:

  • 0 (NULL) → Newjob
  • 1 → Completed
  • 2 → Pending
  • 3 → Error
Edit this page