API Configuration - Teradata Ecosystem Manager

Teradata® Ecosystem Manager API Reference

Product
Teradata Ecosystem Manager
Release Number
16.20
Published
December 2020
Language
English (United States)
Last Update
2020-12-23
dita:mapPath
loa1512743917841.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-3204
Product Category
Analytical Ecosystem

Configure the API so that it identifies the following:

  • The host and port where the receiver is listening for messages.
  • Where to store the message in the event the API cannot pass the message off to the receiver.

Configure these using an XML file named apiconfig.xml, which is located under EM_HOME.

For Windows systems, modify that file at this location:

<drive>\..\client\em\conf

For Linux or UNIX-based operating systems, modify that file at this location:

/opt/teradata/client/em/conf

The datastore is also listed in the apiconfig.xml file.

<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="http://schemas.teradata.com/tmsm/v2009"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://schemas.teradata.com/tmsm/v2009 resillientpublisher.xsd ">
  <receiver>
    <host>localhost</host>
    <port>61620</port>
  </receiver>
  <persistency-mechanism>
    <method>
      <diskStoreLocation>store.dat</diskStoreLocation>
    </method>
  </persistency-mechanism>

</configuration>

The TMSM_ENABLED system environment variable serves as a flag to enable or disable the Ecosystem Manager messaging system for the C and C++ API only. If the environment variable is either unset or set to an empty string, the Ecosystem Manager messaging system is disabled; otherwise, it is enabled. If the value is defined, it signals that events should be sent by the API calls. If the value is not defined (unset TMSM_ENABLED), the API functions do not take any action and return immediately.

The TMSM_ENABLED system environment variable also informs all TTU utilities to be TMSM_ENABLED or not. If undefined or disabled, no Ecosystem Manager events are sent by the local utilities.

TMSM_ENABLED Value Ecosystem Manager Messaging Status
Undefined Disabled
Zero length string (empty string) Disabled
All other values Enabled

On Windows systems, add the following to the environment system variables:

TMSM_HOME= <drive>: \Program Files\teradata\client\em

On UNIX systems, add the following to the profile:

TMSM_HOME=/opt/teradata/client/em