Creating a New or Modifying an Existing Refresh Analysis

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

In order to create a new or modify an existing Refresh analysis, the following analysis properties are defined:

Analysis Properties

  • Type — “Refresh Analysis” (needed only if “new” is “true”)
  • Name — the name of the new Refresh analysis or the name of an existing Refresh analysis to modify
  • New — “true” (needed to define a new Refresh analysis)
  • Modify — “true” (needed to modify an existing Refresh analysis)

Input Data Analysis properties can be specified to override the default values for a new Refresh analysis or to modify the values of an existing Refresh analysis.

Input Data Analysis Properties

  • Analysis — the name of the new Refresh analysis or the name of an existing Refresh analysis to modify
  • ModifyOutput — “true” if the output properties are to be defined or modified. Default is “false”.
  • OutputDatabase — the name of the existing database. ModifyOutput must be set to “true”.
  • OutputTable — the name of the table. ModifyOutput must be set to “true”.
  • ModifyAnchorTable — “true” if the anchor table is to be defined or modified. Default is “false”.
  • AnchorDatabase — the name of the existing database. ModifyAnchorTable must be set to “true”.
  • AnchorTable — the name of the anchor table. ModifyAnchorTable must be set to “true”.
  • ModifyTargetDate — “true” if the target date is to be defined or modified. Default is “false”.
  • TargetDate — the target date to be defined or modified. ModifyTargetDate must be set to “true”.
  • ModifyLiteralParameters — “true” if the literal parameters associated with the analysis to be refreshed are to be modified or defined. Default is “false”.
  • GenerateSqlOnly — “true” or “false” (default is false)
  • StoredProcedureEnabled — “true” or “false” (default is false)
  • ProcedureName — name of stored procedure to be created, if StoredProcedureEnabled is set to true
  • IncludeProcedureParameters — “true” or “false” (default is false), valid if StoredProcedureEnabled is set to true
  • ProcedureComment — comment associated with stored procedure to be created, if StoredProcedureEnabled is set to true
  • AdvertiseOutput (only valid if the analysis being refreshed creates a table or view) — “true” or “false”
  • AdvertiseNote — optional comment or note for advertised output (only used if AdvertiseOutput is “true” or if the Connection property AlwaysAdvertise is “true”)
  • RetainAllColumns — Value: “true” or “false”. Default is false.

If ModifyLiteralParameters has been set to “true” in the input data analysis properties, the following XML structure defines each literal parameter that is to be modified:

Literal Parameters

  • Name — the name of the literal parameter to be modified
  • Value — the value of the literal parameter. The type of the parameter must be consistent with the definition of its original type.

An example of the XML definition to modify three literal parameters follows.

<LiteralParameters>
	<LiteralParameter name="p1" value="20"/>
	<LiteralParameter name="p2" value="1/10/2008"/>
	<LiteralParameter name="p3" value= "'D','E','F'"/>
</LiteralParameters>

An XML example to define a new Refresh analysis follows:.

<Analysis name="My Refresh Analysis " type="Refresh Analysis" new="true"
	execute="true">
	<InputDataAnalysisProperties
		analysis="Variable Creation to Refresh"
		modifyOutput="true"
		outputDatabase="twm_results"
		outputTable="My Refresh Output"
		modifyTargetDate="true"
		TargetDate="01/01/09"
		modifyLiteralParameters="true"/>
	<LiteralParameters>
		<LiteralParameter name="p1" value="20"/>
		<LiteralParameter name="p2" value="1/10/2008"/>
		<LiteralParameter name="p3" value= "'D','E','F'"/>
	</LiteralParameters>
</Analysis>