Data Warehouse Center Application Integration Guide

Step.tag

Use this template to define a step that will be managed by the Data Warehouse Center. This template includes information about the relationships to security group, process, and agent site.

This template is required for all partner applications that are generating relationships between source and target data or defining programs that the Data Warehouse Center is to run.

If you create a new step object, the value that you provide for the *StepName token must be unique to all steps that are defined in the warehouse control database.

Tokens

Table 26 provides information about each token in the template.

Table 26. Step.tag tokens

Token	Description	Allowed values
Entity parameters
*StepName	The unique name of the step that is being created or related.	A text string, up to 80 bytes in length.
*StepDescription	The description that is associated with the step.	A text string, up to 254 bytes in length.
*StepNotes	The long description that is associated with the step.	A text string, up to 32,700 bytes in length.
*StepDataNotPresent	The processing options if there was no source data.	One of the following values: ISV_StepDataNotPresent_OK If data is not present, continue processing. ISV_StepDataNotPresent_Warning If data is not present, issue a warning and continue processing. ISV_StepDataNotPresent_Error If data is not present, issue an error message and stop processing.
*StepSelectStatementGenerated	A flag that specifies whether the Data Warehouse Center is to generate the SQL, or whether the SQL statement is included by the token *StepSelectStatement.	One of the following values: ISV_StepSelectStatementNo The SELECT statement is not generated, but is included in the *StepSelectStatement. ISV_StepSelectStatementYes The SELECT statement is generated, and *StepSelectStatement is ignored.
*StepSelectStatement	The SQL statement to be issued if ISV_StepSelectStatementNo.	A SQL string.
*StepContact	The name of a person or group to contact for questions or concerns about this step.	A text string.
*StepExternalPopulation	A flag that indicates that the step is expected to be run outside the Data Warehouse Center environment..	One of the following values: ISV_StepExternalNo The table will not be externally populated by other means. ISV_StepExternalYes The table will be externally populated by other means.
*StepType	The type of step that is being created.	One of the following values: ISV_StepType_Editioned_Append The data in the table will be appended when the Step is run. ISV_StepType_Full_Replace The data in the table will be replaced when the Step is run. ISV_StepType_Uneditioned_Append The data in the table will be appended when the Step is run. ISV_StepType_VWP_Population The data in the table is populated by a Data Warehouse Center program.
*StepSQLWarning	The processing options if an SQL warning occurs.	One of the following values: ISV_StepSQLWarning_OK If an SQL warning occurs, continue processing. ISV_StepSQLWarning_Warning If an SQL warning occurs, issue a warning and continue processing. ISV_StepSQLWarning_Error If an SQL warning occurs, issue an error and stop processing.
*StepCommit	A flag that specifies if the Data Warehouse Center is to intermittently commit after *StepCommitAfterNumberRows is inserted into the target table of the step.	One of the following values: ISV_Step_Incremental_Commit_On The data is to be incrementally committed at the target. ISV_Step_Incremental_Commit_Off The data is not to be incrementally committed at the target.
*StepCommitAfterNumberRows	The number of rows to insert before committing.	A numeric value.
Relationship parameters
*SecurityGroup	The security group that is to contain all the objects that you are importing. This token is required, and you must specify the default security group.	ISV_DEFAULTSECURITYGROUP for the default security group.
*ProcessName	The name of the process. This token is required.	A text string, up to 80 bytes in length.
*AgentSite	The name of a new agent site, or the name of the default agent site, if the agent is not new. If you specify a new name, it must be unique within the Data Warehouse Center control database. This token is required, but you can specify the default agent site, ISV_DEFAULTAGENTSITE	A text string, up to 80 bytes in length. If you do not want to create a new agent site, use ISV_DEFAULTAGENTSITE for the default agent site.
*CurrentCheckPointID++	An index, starting with 0, that increases each time it is substituted in a token. This token is required.	A numeric value.

Examples of values

Table 27 provides example values for each token to illustrate the kind of metadata that you might provide for each token.

Table 27. Example values for Step.tag tokens

Token	Example value
*StepName	Revenue by location
*StepDescription	This step will pull data to create the revenue for each location in a DB2 table
*StepNotes	Revenue for Geography 7 comes from 4 source Oracle tables
*StepDataNotPresent	ISV_StepDataNotPresent_Error
*StepSelectStatementGenerated	ISV_StepSelectStatementNo
*StepSelectStatement	SELECT * FROM IWH.REVENUE_BY_LOCATION
*StepContact	Jason Smythe
*StepExternalPopulation	ISV_StepExternalNo
*StepType	ISV_StepType_Full_Replace
*StepSQLWarning	ISV_StepSQLWarning_Warning
*StepCommit	ISV_Step_Incremental_Commit_On
*StepCommitAfterNumberRows	10000
*SecurityGroup	ISV_DEFAULTSECURITYGROUP
*ProcessName	Marketing process
*AgentSite	My agent site
*CurrentCheckPointID++	5