------------------------------------------------
---    Installing a Visual Warehouse Sample  ---
------------------------------------------------
  The Sample Installer Program can be used to install a 
Visual Warehouse Sample on a Visual Warehouse Server machine.
The Visual Warehouse Server does not need to be running.

  The Visual Warehouse is shipped with some sample warehouses
for your reference and exploration.  You can also use the
Sample Installer Program to build a sample of your own.  This
file explains how you can build such a sample.  Consult the
readme files for each sample for install-time instructions,
which you may wish to provide to your users.



---------------------------------------------------
---      Running the Sample Installer Program   ---
---------------------------------------------------

  Program Syntax
	vwsample.exe  script_file

  Program Parameters
	script_file	Optional. Pathname of script file containing 
			installation steps. Default 'vwsample.dmo'.

  Program Output
	The following log files are placed in the VW install path:

   vwsample.log    Informational log file.
   impmsg.log	    DB2 import log file.
   <Metadata>.log	 Metadata import log file, where <Metadata> is
			          the name of the metadata import file.



------------------------------------------------
---      Building a Sample Installation      ---
------------------------------------------------
  The Visual Warehouse Sample Installer Program assist you in
distributing a Visual Warehouse Sample. The program is driven by
a script file which defines the steps for installing a sample.
The following is an explanation of how to package your sample so 
that others can use the Sample Installer Program to install it.

Create Sample Directory
   Create a directory to hold all of your sample related files.

Create Sample Installation Script file
   Use supported commands to define your sample installation. As you 
   identify the pieces of your sample scenario, create the commands
   necessary to install them.  See "Sample Installation Commands" 
	section below for command syntax and usage.

README file
   Create a README file with a full description of your sample.
   Copy file to sample directory.

Data Sources
   Identify all Data Sources that your sample uses.
   o DB2/NT
	Export data from source tables using DB2 Export Utility. 
	Specify file format PC/IXF. This will generate one file 
	for each table. Copy files to sample directory.
   o Local Flat Files
        Put files in sample directory
   o Others
	Other sources are not supported by the Sample Installation
	program. You'll have to document the required creation 
	steps in a README file, and provide any required data files. 

Target Warehouses
   Identify target warehouses used. You do not need to export tables
   from a warehouse. The tables will be created when Business Views
   are promoted.

Visual Warehouse Model
   o Export the Model
	Use Visual Warehouse Export Utility to export Metadata.
	Copy generated tag files to the sample directory.

Miscellaneous Files (e.g., User Defined Programs etc.)
   Copy files to sample directory.  

Sample Installation Program
   Copy program to sample directory.


------------------------------------------------
---       Sample Installation Commands       ---
------------------------------------------------
  The following are commands supported by the Sample Installer
Program.  The syntax and function of each command is explained,
and usage notes provided as appropriate.

------------------------------------------------
:REM - Remark
	Allows a comment line.
Syntax
	:REM comment
Parameters
	comment		Any comment text.

------------------------------------------------
:CREATEDB - Create Database
	Creates a DB2/NT database. Registers database with 
	ODBC Administrator as a System DSN.
Syntax
	:CREATEDB dbname
Parameters
	dbname		Database name.
Example
	:CREATEDB revenue
Usage Notes

------------------------------------------------
:IMPORT - Import Data
	Inserts data from a PC/IXF file into a table.
Syntax:
	:IMPORT dbname filename tablename
Parameters
	dbname		Database name.
	filename	Name of file from which data is to be imported.
	tablename	Name of table in which data is to be inserted.
Example
	:IMPORT revenue atlanta.ixf iwh.atlanta
Output
	impmsg.log	DB2 import log file in VW install path. File is
			appended to if it already exists.
Usage Notes
	PC/IXF file format only.
	If the specified table name is already defined, an error is 
	returned. Otherwise, the table definition and the row contents
	are created using the PC/IXF information.

------------------------------------------------
:MODEL - Import Visual Warehouse Metadata
	Imports Visual Warehouse Metadata that has been exported to a
        tagfile via Visual Warehouse export.
Syntax
	:MODEL tagfile
Parameters
	tagfile		Name of VW metadata export file.
Example
	:MODEL samplebvs.tag
Usage Notes
	Calls VW Import Utility (iwh2impt.exe). Requires VW install path,
	control DB, and other information created during VW Initialization. 

------------------------------------------------
:FILECOPY - File Copy
	Copies a file to the specified directory.
Syntax
	:FILECOPY filename path
	or
	:FILECOPY filename VWBIN

Parameters
	filename	Name of file to copy.
	path		Destination to copy the file to.
	VWBIN		Destination is <VW install path>\bin.
Example
	:FILECOPY address.asc c:\vwdemo
Usage Notes
	The directory will be created if it does not exist.

------------------------------------------------
