Table of Contents

Tsv Exporter Worker

The Tsv Exporter Worker is a Web Application built to support the .NET WorkerService technology and leverages MibWorker. Currently in its beta phase, only the export module for Front is included in this distribution. The worker solution is designed to provide a reliable, lightweight and streamlined approach to handling export tasks, when compared to the Agent distribution.

Installation

To get started with the Tsv Exporter Worker, spin up a Docker container using the mib-workers-tsv-exporter image. More details about our Docker Image Feeds can be found here.

Dependent services

  • MibServer3
  • MibServerApi
  • MibAuthorization
  • MibPermissions
  • MibFileManagement (required if using File Management Microservice)
Note

By default, the service is published on port 8680 and provides a route for controlling the health of the service: /health

Configurations

Workers count

The Front export module is enabled by default, with a single worker. Number of workers can be customized with the environment variable below. Setting 0 disables the module.

MIBWORKERCONFIG_FRONTTSVEXPORTERWORKER_INSTANCESCOUNT=1

Heartbeat Interval

Defaults to 10000 milliseconds. This is the time interval that the worker checks for new jobs.

MIBWORKERCONFIG_FRONTTSVEXPORTERWORKER_HEARTBEATINTERVALMILLISECONDS=10000

Common configurations

These configurations are shared among all export modules.

MibDatabaseConfig - required

Configuration used to indicate the front database, which is the one also used by MibServer3.

MIBDATABASECONFIG_DEFAULT_DATABASE=FRONT
MIBDATABASECONFIG_DEFAULT_SERVER=db.sqlserver.example.com
MIBDATABASECONFIG_DEFAULT_TYPE=sql2005
MIBDATABASECONFIG_DEFAULT_USERNAME=username
MIBDATABASECONFIG_DEFAULT_PASSWORD=secret

Refer to MibDatabaseConfig for complete list of configuration keys.

MibPermissionMicroServiceClientConfig - required

Indicates the url of the Mib Permission Microservice.

MIBPERMISSIONMICROSERVICECLIENTCONFIG_DEFAULT_URLMICROSERVICE=http://permissions

StorageLibConfig - required

Note

Required only when not using File Management Microservice

Indicates the directory in which the final export files should be stored inside the container. A docker volume can be mapped to the specified path.

MIBSTORAGELIB2CONFIG_DEFAULT_TYPE=disk
MIBSTORAGELIB2CONFIG_DISK_PATH=/app/storage/tsv

MibAuthorizationClientConfig - required

MIBAUTHORIZATIONCLIENTCONFIG_DEFAULT_SERVERURL=http://authorization
MIBAUTHORIZATIONCLIENTCONFIG_DEFAULT_CLIENTID=clientid
MIBAUTHORIZATIONCLIENTCONFIG_DEFAULT_CLIENTSECRET=clientsecret

MibFileManagementMicroServiceClientConfig - required

Note

Required only when using File Management Microservice

  • Available only from version MIB 6.0 ad above These are the minimum configurations:
MIBFILEMANAGEMENTMICROSERVICECLIENTCONFIG_DEFAULT_URLMICROSERVICE=http://filemanagement

Please refer to this documentation to see all available config keys.

When using the File Management Service in TSV, the upload process used is Resumable upload, in which the file is uploaded in chunks.

Configurations for Front Tsv Exporter

Note

The following configurations are required only when front export module is enabled

MibFrontTsvExporterConfig - required

These are the minimum configurations:

MIBFRONTTSVEXPORTERCONFIG_DEFAULT_GRANTTYPE=password
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_CLIENTID=clientid
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_CLIENTSECRET=secret
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_USERNAME=user
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_PASSWORD=password
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_AUTHORIZATIONURL=http://mibauth
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_APIURL=http://mibapi
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_TEMPORARYTSVFILEFOLDER=/app/temp/tsv
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_TSVEXPORTURL=http://mibfront
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_MIBFRONTURL=http://mibfront
MIBFRONTTSVEXPORTERCONFIG_DEFAULT_USEFILEMANAGEMENTSERVICE=true

Refer to MibFrontTsvExporterConfig for complete list of configuration keys and accepted value format.

Edit this page