Macro Results

Teradata Warehouse Miner User Guide - Volume 1Introduction and Profiling

brand
Software
prodname
Teradata Warehouse Miner
vrm_release
5.4.4
category
User Guide
featnum
B035-2300-077K

The following tables display the results for each macro.

Get All ADS

What are available ADS tables/views/procedures and their properties and procedures?

Macro Results: Get All ADS
Column Name Column Description
Database The database that contains the advertised object (table, view or procedure).
Name The name of the advertised object.
Kind
  • T — Table
  • V — View
  • P — Procedure
Comment An optional comment describing the object.
Created By The database user that created the object.
Created The date and time the object was created.
AnchorDB The database containing the Anchor Table, if any.
AnchorTable The name of the Anchor Table, if any.
TargetDate The Target Date, if used in the underlying analyses.
NbrLiteralParameters The number of literal parameters used in the ADS.
NbrVariables The number of variables (columns) in the ADS.
ProcDB If created by procedure, the database procedure resides in.
ProcName If created by procedure, the name of the procedure
DefaultCall Procedure call with parameters simulating the results if a procedure wasn't used.
ActualCall The actual procedure call reflecting the parameters used.
Start Start time of procedure execution.
Stop Stop time of procedure execution.
MetadataDB Metadata database containing analysis that created object.
AnalysisNam The name of the analysis that created the object.
AnalysisType The type of the analysis that created the object.
AnalysisDesc Optional description of the analysis that created the object.
AnalysisCreated Date and time the analysis was created.
ProjectName Name of the project containing the creating analysis.
ProjectDesc Optional description of the containing project.
ProjectCreated Date and time the project was created.

Get All Scores

What are the available Score tables/procedures and their properties and procedures?

Macro Results: Get All Scores
Column Name Column Description
Database The database that contains the advertised object (table, view or procedure).
Name The name of the advertised object.
Kind
  • T — Table
  • P — Procedure
Comment An optional comment describing the object.
Created By The database user that created the object.
Created The date and time the object was created.
InputDB The database containing the scoring input table.
InputTable The name of the scoring input table.
NbrModelVariables The number ADS variables used in scoring.
ProcDB If created by procedure, the database procedure resides in.
ProcName If created by procedure, the name of the procedure.
DefaultCall Procedure call with parameters simulating the results if a procedure wasn't used.
ActualCall The actual procedure call reflecting the parameters used.
Start Start time of procedure execution.
Stop Stop time of procedure execution.
MetadataDB Metadata database containing analysis that created object.
AnalysisName The name of the analysis that created the object.
AnalysisType The type of the analysis that created the object.
AnalysisDesc Optional description of the analysis that created the object.
AnalysisCreated Date and time the analysis was created.
ProjectName Name of the project containing the creating analysis.
ProjectDesc Optional description of the containing project.
ProjectCreated Date and time the project was created.

Get Profiles By Database

What are the Profile tables/views/procedures profiling tables in a particular database?

Macro Results: Get Profiles By Database
Column Name Column Description
SubjectTable The profiled table or view.
Database The database that contains the advertised object (table, view or procedure).
Name The name of the advertised object.
Kind
  • T — Table
  • V — View
  • P — Procedure
Comment An optional comment describing the object.
Created By The database user that created the object.
Created The date and time the object was created.
ProcDB If created by procedure, the database procedure resides in.
ProcName If created by procedure, the name of the procedure.
DefaultCall Procedure call with parameters simulating the results if a procedure wasn't used.
ActualCall The actual procedure call reflecting the parameters used.
Start Start time of procedure execution.
Stop Stop time of procedure execution.

Get Profiles By Table

What are the Profile tables/views/procedures profiling a particular table?

Macro Results: Get Profiles By Table
Column Name Column Description
Database The database that contains the advertised object (table, view or procedure).
Name The name of the advertised object.
Kind
  • T — Table
  • V — View
  • P — Procedure
Comment An optional comment describing the object.
Created By The database user that created the object.
Created The date and time the object was created.
ProcDB If created by procedure, the database procedure resides in.
ProcName If created by procedure, the name of the procedure.
DefaultCall Procedure call with parameters simulating the results if a procedure wasn't used.
ActualCall The actual procedure call reflecting the parameters used.
Start Start time of procedure execution.
Stop Stop time of procedure execution.

Get Profiled Columns

What are columns profiled by tables/views/procedures profiling a particular table?

Macro Results: Get Profiled Columns
Column Name Column Description
Database The database that contains the advertised object (table, view or procedure).
Name The name of the advertised object.
Kind
  • T — Table
  • V — View
  • P — Procedure
Column The profiled column.
Description Description of column use, for example, Group By.

Get Variables

What are the Model Variables of a particular ADS or Score by name?

Macro Results: Get Variables
Column Name Column Description
SequenceId Sequential integer from 0 to n-1 where n is the number of Variables in the ADS or Score Model.
VarName The name of the Variable (column).
VarDesc The optional description of the variable.
VarSql Pseudo-SQL representing how the variable was derived, concatenating the contributions of referenced analyses, if any, separated by |||.

Note that if a column is simply passed along from a referenced analysis this is not recorded, unless the column name changes via aliasing.

Get Variable Columns

What columns contributed to the Model Variables for this ADS or Score table/procedure?

Macro Results: Get Variable Columns
Column Name Column Description
SequenceId Sequential integer from 0 to n-1 where n is the number of Variables in the ADS or Score Model.
VarName The name of the Variable (column).
SourceDB Database containing the table or view that contains the contributing column.
SourceTable The name of the table or view that contains the contributing column.
SourceColumn The name of the column that contributed to the creation of the indicated variable.

Get ADS Parameters

What are the literal parameters of a particular ADS by name?

Macro Results: Get ADS Parameters
Column Name Column Description
ParameterName The name of the literal parameter.
ParameterDescription The optional description of the literal parameter.
ParameterType String, Numeric, Date, Time, Timestamp, or Text
ParameterValue A character string representation of the original value of the parameter.

Get Score Columns

What are the output columns contained in this Score table/procedure?

Macro Results: Get Score Columns
Column Name Column Description
SequenceId Sequential integer from 0 to n-1 where n is the number of score output columns.
ColumnName The name of the score output column.
ColumnDescription If used, a generated description of the use of the score output column, for example, “Index Column”.

Get Analyses

What was the analysis or chain of analyses that built this table/view/procedure?

Macro Results: Get Analyses
Column Name Column Description
SequenceId Sequential integer from 0 to n-1 where n is the number of analyses that contributed to building this table/view/procedure.
MetaDB Metadata database containing analysis that created object.
AnalysisName The name of the analysis that created the object.
AnalysisType The type of the analysis that created the object.
AnalysisDesc Optional description of the analysis that created the object.
AnalysisCreated Date and time the analysis was created.
ProjectName Name of the project containing the creating analysis.
ProjectDesc Optional description of the containing project.
ProjectCreated Date and time the project was created.

Get Analysis Properties

What are the properties of the analyses that built this table/view/procedure?

Macro Results: Get Analysis Properties
Column Name Column Description
AnalysisName The name of one of the analyses that contributed to creating the given table/view/procedure.
AnalysisProperty Description of a property of an analysis as logged in error logs or displayed interactively in the Property panel.

Get Procedure Parameters

What are the parameters of a particular procedure by name?

Macro Results: Get Procedure Parameters
Column Name Column Description
ParmName The name of the parameter.
ParmDesc The optional description of the parameter.
SQLType The SQL type string of the parameter. For example, VARCHAR(30).
OrigValue A character string representation of the original value of the parameter.

Get Procedure Tables

What are the tables/views created by a particular procedure by name?

Macro Results: Get Procedure Tables
Column Name Column Description
Database The database that contains the table/view created by the procedure.
Name The name of the table/view created by the procedure.
Call The procedure call statement in use when the object was created.
Start The date and time when procedure execution began.
Stop The date and time when procedure execution completed.

Get Advertised Objects

What are all the advertised tables/views/procedures?

Macro Results: Get Advertised Objects
Column Name Column Description
ObjectDatabase The database that contains the advertised object (table, view or procedure).
ObjectName The name of the advertised object.
ObjectKind
  • T — Table
  • V — View
  • P — Procedure
CreateUser The database user that created the object.
CreateTimestamp The date and time the object was created.
CommentString An optional comment describing the object.
OutputCategory 1 for Data Set, 2 for Score table, 3 for Profile or 0 for Other.
AdvertiseNote Optional free-form text that may be used to categorize the object, for example by internal project or purpose.
OutputStatus This attribute is used by maintenance functions to indicate an object that is either Missing or Outdated with respect to the Teradata data dictionary.
  • Missing — not in the dictionary
  • Outdated — the dictionary has a later entry with the same name.

Get Projects Table Input

What are the projects that select from a particular table to build a profile, ADS or score table?

Macro Results: Get Projects Table Input
Column Name Column Description
Metadata DB Metadata database containing selecting project.
ProjectName Name of the selecting project.
ProjectDesc Description of the selecting project.

Get Analyses Table Input

What are the profile, score and ADS analyses that select from a particular table?

Macro Results: Get Analyses Table Input
Column Name Column Description
MetadataDB Metadata database containing selecting analysis.
ProjectName Name of the selecting project.
ProjectDesc Description of the selecting project.
AnalysisName Name of the selecting analysis.
AnalysisDesc Description of the selecting analysis.
ObjectDatabase Database containing the object created by the selecting analysis.
ObjectName Name of the object created by the selecting analysis.

Get Analyses Column Input

What are the profile, score and ADS analyses that select from a particular column?

Macro Results: Get Analyses Column Input
Column Name Column Description
MetadataDB Metadata database containing selecting analysis.
ProjectName Name of the selecting project.
ProjectDesc Description of the selecting project.
AnalysisName Name of the selecting analysis.
AnalysisDesc Description of the selecting analysis.
ObjectDatabase Database containing the object created by the selecting analysis.
ObjectName Name of the object created by the selecting analysis.

Get Creating Analysis

What project and analysis created the given table/view/procedure?

Macro Results: Get Creating Analysis
Column Name Column Description
MetadataDB Metadata database containing the creating analysis.
ProjectName Name of the project containing the creating analysis.
ProjectDesc Description of the project containing the creating analysis.
AnalysisName Name of the creating analysis.
AnalysisDesc Description of the creating analysis.