Table of Contents

Tsv Exporter Agent

The Tsv Exporter Agent is a robust solution built with MibAgentWebHost technology. It supports both the Front and Edit History export modules, making it versatile for most use cases.

Installation

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

Port

The service is mapped to Port 8670 in the container by default.

Dependent services

  • MibServer3
  • MibServerApi
  • MibAuthorization
  • MibPermissions
  • MibEditHistory (required if the Edit History export module is enabled)
  • MibFileManagement (required if any module uses the File Management Microservice)

Configurations

Enabling export modules

Both Front and Edit History export modules are enabled by default, with one running agent each. Number of agents can be customized with the environment variables below. Setting 0 disables the module.

AGENTSWEB_MIBPLUGINCONFIG_MIBFRONTTSVEXPORT_INSTANCECOUNT=1
AGENTSWEB_MIBPLUGINCONFIG_EDITHISTORYTSVEXPORT_INSTANCECOUNT=1

Each enabled module requires specific configurations:

Heartbeat Interval

Defaults to 10 seconds. This is the time interval in seconds that the agents check for new jobs.

TSVEXPORT_MIBAGENTCONFIG_DEFAULT_HEARTBEAT=10

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.

TSVEXPORT_MIBDATABASECONFIG_DEFAULT_DATABASE=FRONT
TSVEXPORT_MIBDATABASECONFIG_DEFAULT_SERVER=db.sqlserver.example.com
TSVEXPORT_MIBDATABASECONFIG_DEFAULT_TYPE=sql2005
TSVEXPORT_MIBDATABASECONFIG_DEFAULT_USERNAME=username
TSVEXPORT_MIBDATABASECONFIG_DEFAULT_PASSWORD=secret

Refer to MibDatabaseConfig for complete list of configuration keys.

MibPermissionMicroServiceClientConfig - required

Indicates the url of the Mib Permission Microservice.

TSVEXPORT_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.

TSVEXPORT_MIBSTORAGELIB2CONFIG_DEFAULT_TYPE=disk
TSVEXPORT_MIBSTORAGELIB2CONFIG_DISK_PATH=/app/storage/tsv

MibAuthorizationClientConfig - required

TSVEXPORT_MIBAUTHORIZATIONCLIENTCONFIG_DEFAULT_SERVERURL=http://authorization
TSVEXPORT_MIBAUTHORIZATIONCLIENTCONFIG_DEFAULT_CLIENTID=clientid
TSVEXPORT_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:
TSVEXPORT_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 module

Note

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

MibTsvExportAgentConfig - required

These are the minimum configurations:

TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_GRANTTYPE=password
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_CLIENTID=clientid
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_CLIENTSECRET=secret
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_USERNAME=user
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_PASSWORD=password
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_AUTHORIZATIONURL=http://mibauth
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_APIURL=http://mibapi
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_TEMPORARYTSVFILEFOLDER=/app/temp/tsv
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_TSVEXPORTURL=http://mibfront
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_MIBFRONTURL=http://mibfront
TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_USEFILEMANAGEMENTSERVICE=true

Refer to MibFrontTsvExporterConfig for complete list of configuration keys and accepted value format. Take note of the keys and use them in the following format:

TSVEXPORT_MIBTSVEXPORTAGENTCONFIG_DEFAULT_{KEY}

Configurations for edit history module

Note

The following configurations are required only when edition history export module is enabled

MibEditHistoryTsvExportertAgentConfig - required

These are the minimum configurations:

TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_GRANTTYPE=password
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_CLIENTID=clientid
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_CLIENTSECRET=secret
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_USERNAME=user
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_PASSWORD=password
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_AUTHORIZATIONURL=http://mibauth
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_APIURL=http://mibapi
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_TEMPORARYTSVFILEFOLDER=/app/temp/tsv
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_TSVEXPORTURL=http://mibfront
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_MIBFRONTROOTURL=http://mibfront
TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_STORAGETYPE=disk

Refer to MibEditHistoryTsvExporterConfig for complete list of configuration keys and accepted value format. Take note of the keys and use them in the following format:

TSVEXPORT_MIBEDITHISTORYTSVEXPORTERTAGENTCONFIG_DEFAULT_{KEY}
Edit this page