16.10 - End User Properties - Teradata Ecosystem Manager

Teradata Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.10
created_date
June 2017
category
Programming Reference
featnum
B035-3204-067K

For any event (START, STEP, END, ALERT).

Environment Variable Property Name Description Default Value
TMSM_PROCESSID resourceId Identifier for the job Utility name
TMSM_JOBNAME jobName Identifies a job step within a job Blank
TMSM_APPLICATIONID applicationId Ecosystem Manager application identifier associated with the processor Blank
TMSM_LOGFILE logFile Reference to the log of the job execution in the form "<hostname>:<filepath>" Blank
TMSM_OPTIONAL1 optionalArgument1 User-defined property for the event Blank
TMSM_OPTIONAL2 optionalArgument2 User-defined property for the event Blank
TMSM_OPTIONAL3 optionalArgument3 User-defined property for the event Blank

Example

If no environment variables are set, the load utility uses the default values. Utilities are usually called using a scripting interface and scheduled to start at certain times.

The following example shows shell scripts calling a TTU utility (TPT) and the overriding values. It overrides UoW ID, class, source system, time stamp, process ID, job name, application ID, and log file and then calls TPT to execute the load.

Nightlyload.sh:
# .bash_profile
export TMSM_UOWID=d98d4099-ae0e-11de-88e6-444553544200
export TMSM_UOWCLASS=ERP_DAILY_LOAD
export TMSM_UOWSOURCE=ORACLE_APPS_OPERATION
export TMSM_UOWTS='12/12/2009 1:00:00.00000'
export TMSM_PROCESSID=TBUILD_CUSTOM
export TMSM_JOBNAME=GL_CDC_LOAD
export TMSM_APPLICATIONID=APPID_CUSTOM
export TMSM_LOGFILE=localhost:\home\runtime\dailyload.log
tbuild -r tptload.txt -u jobattr1 jobname1 


If multiple loads are performed, but overrides are made with different values, calls to the load utility must be done in a different shell execution to prevent the variable from being overridden multiple times. For example:
# .bash
export TMSM_UOWID=d98d4099-ae0e-11de-88e6-444553544200
tbuild -r tptload.txt -u jobattr1 jobname1 &
export TMSM_UOWID=d98d4099-ae0e-11de-88e6-444559999999
tbuild -r tptload.txt -u jobattr2 jobname2 &
‘jobname2’ overrides the value for ‘jobname1,’ which causes the first execution of tbuild to pick up values from the second one.