Refresh - INPUT - Analysis Parameters - Teradata Warehouse Miner

Teradata® Warehouse Miner™ User Guide - Volume 2ADS Generation

Teradata Warehouse Miner
Release Number
November 2018
English (United States)
Last Update
Product Category
  1. On the Refresh dialog, click on INPUT.

    The analysis parameters tab will automatically be selected.

    Refresh > Input > Analysis Parameters

  2. On this screen, select:
    • Available Analyses — Select a single analysis from the list of all of the analyses in the current project which are available for the Refresh analysis. Note that Variable Creation analyses used to generate Subqueries or With Recursive Views will not be available to refresh. A With Recursive base query may be refreshed, however, but not the seed or recursive component queries by themselves.
    • Modify Anchor Table — When selected, modifies the Anchor Table in the selected analysis or in the chain of analyses that may be referenced by the selected analysis. This affects only Variable Creation and Free Form SQL analyses that do not have the Creates Score Table option selected, and Variable Creation and Build ADS analyses that have Anchor Columns selected.
    • Modify Target Date — If selected, modifies the Target Date. This applies only if there are one or more Variable Creation, Variable Transformation or Free Form SQL Analyses that use a target date either as the selected analysis or, if it exists, in the chain of analyses referenced by the selected analysis.
    • Create Stored Procedure (applicable to Teradata Database) — The creation of a stored procedure containing the SQL generated for this analysis can be requested by entering the desired name of the stored procedure here. This creates a stored procedure in the user's login database in place of the execution of the SQL generated by the analysis.
      This option makes stored procedure creation available to some functions for which the Output Storage option to create a stored procedure is not available, including the various Scoring functions, the Free Form SQL analysis and the Sample analysis. It also provides capabilities not offered via the Output Storage option. One capability is to include the SQL for not only the analysis being “refreshed”, but for the entire chain of analyses, if any, referenced for input by the refreshed analysis. Another is that the Refresh analysis supports parameters for not only the output database and table but for the anchor table, target date and literal parameters.
      Any Free Form SQL analysis being refreshed, either directly or in a reference chain, must not select data when stored procedure output is requested or the refresh will fail with a message such as Invalid or missing INTO clause.
      • With Parameters — If selected, includes parameters in the stored procedure. The parameters included will depend on the analyses being refreshed and possibly the release of Teradata being used.
      • Procedure Comment — When an optional procedure comment is entered, it is applied to the requested Stored Procedure with an SQL Comment statement. It can be up to 255 characters in length and contain substitution parameters for the output category (Score, ADS, Stats or Other), project name and/or analysis name (using the tags <Category>, <Project> and <Analysis>, respectively).

        The default value of this field may be set on the Defaults tab of the Preferences dialog, available from the Tools > Preferences menu option.

      For more information, see Stored Procedure Support in the Teradata Warehouse Miner User Guide (Volume 1), B035-2300.

    • Generate SQL Only — If selected, generates SQL for the selected analysis (and any analysis it may reference) rather than execute it. With some exceptions, Refresh ignores any “Generate SQL only” request in the chain of analyses it is refreshing, completely relying on its own option for this functionality. A side effect of this is that analyses designed to generate the SQL for a derived table will not have this affect, but will rather create a volatile table that is selected from, with equivalent final results. The following are exceptions to this side effect:
      • When refreshing a Variable Creation Subquery or With (Recursive) Query, the subquery or seed query will always be embedded in the SQL as a derived table.
      • When a Free Form SQL analysis that does not create an output table is used to define a derived table, Table function or Table Operator, the Generate SQL Only option is required, and the select statement, function or operator is embedded in the SQL.
    • Retain All Columns — If selected, the column limiting feature of the Refresh analysis is disabled. The column limiting feature ordinarily ensures that any referenced analyses only generate the columns needed by the analysis being refreshed, potentially saving system resources. When this option is selected, each referenced analysis produces all of its specified output columns, which may be desirable if these columns contain important intermediate results.
    • Modify Output — If selected, you can change the output database and/or output table of the analysis to be refreshed.
      If the analysis to be refreshed is a Tree Scoring analysis that has requested that Profiling Tables be built, these tables will be named based on the modified output table name, but will not be listed on the Properties display for the Refresh analysis.
      • DatabaseName — Name of the output database of the analysis to be refreshed.
      • Table/View Name — Name of the output table or view of the analysis to be refreshed.
    • Advertise Output — The Advertise Output option may be requested when creating a table, view or procedure. This feature “advertises” output by inserting information into one or more of the Advertise Output metadata tables according to the type of analysis being “refreshed” and the options selected in the analysis. Note that when the analysis being “refreshed” is a scoring analysis chained to an ADS analysis, both the output of the scoring analysis and the ADS analysis are advertised. For more information about advertising output, see Advertise Output in the Teradata Warehouse Miner User Guide (Volume 1), B035-2300.
      • Advertise Note — An advertise note may be specified if desired when the Advertise Output option is selected or when the Always Advertise option is selected on the Connection Properties dialog. It is a free-form text field of up to 30 characters that may be used to categorize or describe the output.
    • Modify Literal Parameters — Any Literal parameters found in a referenced Variable Creation, Variable Transformation or Free Form SQL analysis, or, if it exists, in the chain of analyses referenced by the selected analysis, may be updated on this screen. As with other parameters that may be set in the Refresh analysis, any changes to the values displayed here will not permanently affect the values in the referenced analyses.

      The following options are available:
      • The Sort option can be used to sort the literal parameters in the display grid, By Name, By Type or By Entry (i.e., the order originally entered into the referenced analysis).
      • The Properties option can be used to change the Value and/or Description, if desired.