Data Warehouse Center Application Integration Guide

BusinessView.tag

Use this template to define a business view. You must use this template if your partner application generates relationships between data sources and targets or contains programs that Visual Warehouse is to run.

The template also includes relationships to a security group, a subject area, and one or more agent sites.

Tokens

Table 130 provides information about each token in the template.

Table 130. BusinessView.tag tokens

Token Description Allowed values Window or notebook: field
Entity parameters
*BVName Name of the business view.
The name must be unique within the Visual Warehouse control database.
This token is required.
A text string, up to 80 bytes in length. Business View: Business Name
*BVDescription Short description of the business view.
This token is optional.
A text string, up to 200 bytes in length. Business View: Description
*BVNotes Long description of the business view.
This token is optional.
A text string, up to 32700 bytes in length. Business View: Notes
*BVDataNotPresent Setting for how to handle warnings when the agent finds no data to extract for the business view.
This token is required.
One of the following values:

ISV_BVDataNotPresent_OK
The business view is to successfully process if the agent finds no data to extract.
ISV_BVDataNotPresent_Warning
The business view is to fail if the agent finds no data to extract.
ISV_BVDataNotPresent_Error
The business view is to process with a warning if the agent finds no data to extract.
Business View: No Rows Returned Processing Options
*BVSelectStatementGenerated
Flag indicating whether Visual Warehouse is to generate the SQL, or if the SQL is provided as the value of the *BVSelectStatement token.
This token is required.
One of the following values:

ISV_BVSELECTSTATEMENTYES
Visual Warehouse is to generate the SQL.
ISV_BVSELECTSTATEMENTNO
The SQL is provided as the value of the *BVSelectStatement token.
None
*BVSelectStatement SQL statement to be executed.
This token is required if *BVSelectStatementGenerated is set to N.
An SQL statement, up to 32700 bytes in length. Modify Business View SQL: SQL Statement
*BVContact Name of a person or group to contact for questions about this business view.
This token is optional.
A text string, up to 64 bytes in length. Business View: Admin Contact
*BVExternalPopulation Flag indicating whether an external application can populate the table.
This token is required.
One of the following values:

ISV_BVEXTERNALYES
An external application can populate the table.
ISV_BVEXTERNALNO
Only Visual Warehouse can populate the table.
Business View: Externally Populated
*BVCreateTargetTable Flag indicating if Visual Warehouse is to create the target table when the business view is promoted to test status.
This token is required.
One of the following values:

ISV_BVCREATETABLEYES
Visual Warehouse is to create the target table.
ISV_BVCREATETABLENO
Visual Warehouse is not to create the target table.
Business View: Visual Warehouse Created Table
*BVType Type of the business view.
This token is required.
One of the following values:

ISV_BVType_EditionedAppend
Append a new edition of data to the target table each time the business view runs.
ISV_BVType_Full_Replace
Replace all the data in the target table each time the business view runs.
ISV_BVType_Uneditioned_Append
Append new data to the existing data each time the business view runs.
ISV_BVType_VWP_Population
Use a Visual Warehouse program to manage the data.
None
*BVSQLWarning Setting for whether the business view continues processing if an SQL warning code is issued.
This token is required.
One of the following values:

ISV_BVSQLWarning_OK
The business view is to process successfully if an SQL warning code is issued.
ISV_BVSQLWarning_Warning
The business view is to process with a warning if an SQL warning code is issued.
ISV_BVSQLWarning_Error
The business view is to fail if an SQL warning code is issued.
Business View: SQL Warning Processing Options
Relationship parameters
*SecurityGroup Security group in which to create all the objects being imported.
This token is required, and you must specify the default security group.

ISV_DEFAULTSECURITYGROUP for the default security group.
Business View: Update Security Group
*SubjectArea Name of the group of business views.
This token is required.
A text string, up to 80 bytes in length. Subject: Name
*AgentSite Agent site to use for the business view: either a new agent site or the default agent site.
This token is required, but you can specify the default agent site.
A text string, up to 80 bytes in length.
Specify ISV_DEFAULTAGENTSITE for the default agent site.
Business View: Agent Site
*CurrentCheckPointID++ Index, starting with 0, that increases each time it is substituted in a token.
This token is required.
A numeric value. None

Token	Description	Allowed values	Window or notebook: field
Entity parameters
`*BVName`	Name of the business view. The name must be unique within the Visual Warehouse control database. This token is required.	A text string, up to 80 bytes in length.	Business View: Business Name
`*BVDescription`	Short description of the business view. This token is optional.	A text string, up to 200 bytes in length.	Business View: Description
`*BVNotes`	Long description of the business view. This token is optional.	A text string, up to 32700 bytes in length.	Business View: Notes
`*BVDataNotPresent`	Setting for how to handle warnings when the agent finds no data to extract for the business view. This token is required.	One of the following values: ISV_BVDataNotPresent_OK The business view is to successfully process if the agent finds no data to extract. ISV_BVDataNotPresent_Warning The business view is to fail if the agent finds no data to extract. ISV_BVDataNotPresent_Error The business view is to process with a warning if the agent finds no data to extract.	Business View: No Rows Returned Processing Options
`*BVSelectStatementGenerated`	Flag indicating whether Visual Warehouse is to generate the SQL, or if the SQL is provided as the value of the `*BVSelectStatement` token. This token is required.	One of the following values: ISV_BVSELECTSTATEMENTYES Visual Warehouse is to generate the SQL. ISV_BVSELECTSTATEMENTNO The SQL is provided as the value of the `*BVSelectStatement` token.	None
`*BVSelectStatement`	SQL statement to be executed. This token is required if `*BVSelectStatementGenerated` is set to N.	An SQL statement, up to 32700 bytes in length.	Modify Business View SQL: SQL Statement
`*BVContact`	Name of a person or group to contact for questions about this business view. This token is optional.	A text string, up to 64 bytes in length.	Business View: Admin Contact
`*BVExternalPopulation`	Flag indicating whether an external application can populate the table. This token is required.	One of the following values: ISV_BVEXTERNALYES An external application can populate the table. ISV_BVEXTERNALNO Only Visual Warehouse can populate the table.	Business View: Externally Populated
`*BVCreateTargetTable`	Flag indicating if Visual Warehouse is to create the target table when the business view is promoted to test status. This token is required.	One of the following values: ISV_BVCREATETABLEYES Visual Warehouse is to create the target table. ISV_BVCREATETABLENO Visual Warehouse is not to create the target table.	Business View: Visual Warehouse Created Table
`*BVType`	Type of the business view. This token is required.	One of the following values: ISV_BVType_EditionedAppend Append a new edition of data to the target table each time the business view runs. ISV_BVType_Full_Replace Replace all the data in the target table each time the business view runs. ISV_BVType_Uneditioned_Append Append new data to the existing data each time the business view runs. ISV_BVType_VWP_Population Use a Visual Warehouse program to manage the data.	None
`*BVSQLWarning`	Setting for whether the business view continues processing if an SQL warning code is issued. This token is required.	One of the following values: ISV_BVSQLWarning_OK The business view is to process successfully if an SQL warning code is issued. ISV_BVSQLWarning_Warning The business view is to process with a warning if an SQL warning code is issued. ISV_BVSQLWarning_Error The business view is to fail if an SQL warning code is issued.	Business View: SQL Warning Processing Options
Relationship parameters
`*SecurityGroup`	Security group in which to create all the objects being imported. This token is required, and you must specify the default security group.	`ISV_DEFAULTSECURITYGROUP` for the default security group.	Business View: Update Security Group
`*SubjectArea`	Name of the group of business views. This token is required.	A text string, up to 80 bytes in length.	Subject: Name
`*AgentSite`	Agent site to use for the business view: either a new agent site or the default agent site. This token is required, but you can specify the default agent site.	A text string, up to 80 bytes in length. Specify `ISV_DEFAULTAGENTSITE` for the default agent site.	Business View: Agent Site
`*CurrentCheckPointID++`	Index, starting with 0, that increases each time it is substituted in a token. This token is required.	A numeric value.	None

Examples of values

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

Table 131. Example values for BusinessView.tag tokens

Token Example value
*BVName Revenue_by_Geography_7
*BVDescription This business view will extract Geography 7 data and write it to an UDB table
*BVNotes The Revenue for Geography 7 data comes from four source Oracle tables.
*BVDataNotPresent ISV_BVDataNotPresent_Warning1
*BVSelectStatementGenerated ISV_BVSELECTSTATEMENTNO
*BVSelectStatement "SELECT * FROM IWH.REVENUE_BY_GEOGRAPHY7"
*BVContact Greg Holland
*BVExternalPopulation ISV_BVEXTERNALNO
*BVCreateTargetTable ISV_CREATETABLEYES
*BVType ISV_BVType_VWP_Population
*BVSQLWarning ISV_BVSQLWarning_Error
*SecurityGroup ISV_DEFAULTSECURITYGROUP
*Subject Area Group of business views generated for the partner tool
*AgentSite My agent site
*CurrentCheckPointID++ 10

Token	Example value
`*BVName`	Revenue_by_Geography_7
`*BVDescription`	This business view will extract Geography 7 data and write it to an UDB table
`*BVNotes`	The Revenue for Geography 7 data comes from four source Oracle tables.
`*BVDataNotPresent`	ISV_BVDataNotPresent_Warning1
`*BVSelectStatementGenerated`	ISV_BVSELECTSTATEMENTNO
`*BVSelectStatement`	"SELECT * FROM IWH.REVENUE_BY_GEOGRAPHY7"
`*BVContact`	Greg Holland
`*BVExternalPopulation`	ISV_BVEXTERNALNO
`*BVCreateTargetTable`	ISV_CREATETABLEYES
`*BVType`	ISV_BVType_VWP_Population
`*BVSQLWarning`	ISV_BVSQLWarning_Error
`*SecurityGroup`	ISV_DEFAULTSECURITYGROUP
`*Subject Area`	Group of business views generated for the partner tool
`*AgentSite`	My agent site
`*CurrentCheckPointID++`	10

[ Top of Page | Previous Page | Next Page ]