Table of Contents

TSV EXPORTER

Introduction

Available only on MibFront, it enables the export of data in file format from a list page. It is possible to export data in two ways: one for the current page and another to export all pages.

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.

Configuration

MibTsvExportAgentConfig

  • granttype, string: Type of authentication, which can be password, client_credentials, or authorization_code, commonly used password for tsvExport.
  • clientid, string: Application client ID.
  • clientsecret, string: Application client secret.
  • username, string: Authentication username.
  • password, string: Authentication password.
  • authorizationurl, string: Url access for authorization server.
  • apiurl, string: Url access for api server.
  • temporarytsvfilefolder, string: Path where temporary TSV files are stored.
  • tsvsubfolder, string: Path of the subfolder where TSV files are located, by default, it is empty.
  • tsvexporturl, string: URL enabled to download the file where it is stored.
  • storageType, string: Localization type, where the file is stored, can be disk, amazon, or SMB. The default is disk.
  • maximumExportWaitMinutes, int: The maximum time limit allowed for attempting a file export, the default, is 120 minutes.
  • retryAttempts, int: Variable to determine how many times it should retry the call before considering it a permanent failure, the default is 5 attempts.
  • retryAwaitSeconds, int: Representing the number of seconds to wait before making a new attempt, default is 10 seconds.
  • mibFrontUrl, string: Url acess for Mib3 (to get the dictionaries).
  • useFileManagementService: Indicates whether the FileManagement microservice should be used to upload files. (default = false) only from version MIB 6.0
  • authTokenEarlyRenewalMinutes: Sets secure time margin before authorization token has expired so that it can be renewed sonner rather than later. (default = 10)
  • mibApiCallTimeoutSeconds: defines timeout of batch processings from MibApi. (default = HttpClient default timeout)
  • mibAuthCallTimeoutSeconds: defines timeout when calling MibAuthorization. (default = HttpClient default timeout)
  • mibFileManagementCallTimeoutSeconds: defines timeout when calling MibFileManagement. (default = HttpClient default timeout)
  • minutesOfAgentInactivityToConsiderJobAbandoned: defines for how long an exportation job should not be progressing so that it is considered abandoned and reassigned to another agent (default = 5 minutes, minimum = 1 [not recommended]).
  • dateFormat (default = yyyy/MM/dd) only from version MIB 6.0
  • dateTimeFormat (default = yyyy/MM/dd HH:mm:ss) only from version MIB 6.0
  • separatorCharacter - defines which character will be used as a separator when writing files (default = \t) only from version MIB 6.0
  • generateDetailedLogFormattingColumns - defines whether to generate logs detailing the process of formatting the information coming from MibApi (default = false) only from version MIB 6.0
  • fileUploadBufferSizeBytes - defines buffer size in bytes for uploading files via FileManagement service (default = 1048576)

The "dateFormat" and "dateTimeFormat" are used to format the AdmFields types: Date, DateTime and UtcDateTime.

MibEditHistoryTsvExportertAgentConfig

  • granttype, string: Type of authentication, which can be password, client_credentials, or authorization_code, commonly used password for tsvExport.
  • clientid, string: Application client ID.
  • clientsecret, string: Application client secret.
  • username, string: Authentication username.
  • password, string: Authentication password.
  • authorizationurl, string: Url access for authorization server.
  • apiurl, string: Url access for api server.
  • temporarytsvfilefolder, string: Path where temporary TSV files are stored.
  • tsvsubfolder, string: Path of the subfolder where TSV files are located, by default, it is empty.
  • tsvexporturl, string: URL enabled to download the file where it is stored.
  • storageType, string: Localization type, where the file is stored, can be disk, amazon, or SMB. The default is disk.
  • mibFrontRootUrl, string: Url acess for Mib3 (to get the dictionaries).

MibFileManagementMicroServiceClientConfig

only from version MIB 6.0

For more details check click here

⚠️ Attention ⚠️

When using the File Management Service in TSV, the upload process used is the simplified upload. Learn more about how it works in this documentation

MIB3UX_TSV_REQUESTS STATUS

  • 0 → Newjob
  • 1 → Completed
  • 2 → Pending
  • 3 → Error 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:

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