***** Sample Data Generation *****

The following file provides a brief description of the steps involved in
performing data generation to a CSV file.  For more examples,
refer to the "custom" and "samples" directories in the distribution package.

Please contact support@thinkui.com if you have any questions or comments.


***** SETUP *****

Download and install the ThinkUI Data Generator software (version 1.0.0 or later).
Follow the instructions in the README.TXT and verify that you are able to access your database.


***** STEPS *****

To perform data generation via Ant, please follow the following steps:

1. Define the classpath in Ant.
e.g.
<path id="classpath.run">
    <path path="${java.class.path}"/>
    <path location="lib/apache-derby.jar"/>
    <path location="lib/velocity-dep.jar"/>
    <path location="thinkui_datagen.jar"/>
</path>

Tip: You may need to add your the JDBC jar file for your database to the path.

2. Define the custom Data Generator Generate Ant Task to generate data.
e.g.
<target name="generate.init" description="Define the ThinkUI Data Generator GenerateTask">
    <taskdef name="datagen" classname="thinkui.datagen.ant.GenerateTask">
        <classpath refid="classpath.run"/>
    </taskdef>
</target>

3. Define the "datagen" task to generate data.
The writer element is used to specify where the generated data should be written.
The attribute and corresponding generator element is used to specify what data values to generate.
e.g.
<target name="gen.data.csv" description="Use the GenerateTask to generate sample test data in CSV file format" depends="generate.init">
    <datagen name="${target.output.name}" mode="OVERWRITE" numRecords="100">

        <writer class="CSVDataObjectWriter">
            <param name="file_name" value="${target.output.dir}/${target.output.name}.csv"/>
            <param name="uppercase" value="true"/>
            <param name="header" value="true"/>
        </writer>

        <attribute name="oid" caption="Object ID" type="Long" required="true" access="R/O" computed="true"/>
        <attribute name="index" caption="Index" type="Integer" required="true" access="R/W" constraints="ValueRangeConstraints(1, 10000000)">
            <generator class="thinkui.datagen.generators.IntegerGenerator" generatorMode="SEQUENTIAL" />
        </attribute>
        <attribute name="author" caption="Author" type="String" required="true" access="R/O">
            <generator class="thinkui.datagen.generators.StringGenerator" generatorMode="CONSTANT" constantValue="THINKUI"/>
        </attribute>
        <attribute name="domain_tld" caption="Domain TLD" type="String" required="false" access="R/W" visible="false">
            <generator class="DynamicDataGenerator" probabilityNull="50">
                <param name="table_name" value="THINKUI.WEB_TLD"/>
                <param name="attribute_name" value="CODE"/>
            </generator>
        </attribute>
        <attribute name="gender" caption="Gender" type="Character" required="true" access="R/W" visible="false">
            <generator class="thinkui.datagen.generators.EnumGenerator" probabilityNull="10">
                <param name="values" value="M, F"/>
                <param name="probabilities" value="50, 50"/>
                <!-- Need to tie values with social title and first name -->
            </generator>
        </attribute>
        <attribute name="social_title" caption="Social Title" type="String" required="false" access="R/$" constraints="">
            <generator class="thinkui.datagen.generators.EnumGenerator" probabilityNull="20">
                <param name="values" value="MR, MRS, MS, DR, SIR"/>
                <param name="probabilities" value="30, 25, 5, 10, 1"/>
                <!-- Need to tie values with first name and gender -->
            </generator>
        </attribute>
        <attribute name="first_name" caption="First Name" type="String" required="true" access="R/W" constraints="">
            <generator class="DynamicDataGenerator">
                <param name="data_object" value="FirstName"/>
                <param name="attribute_name" value="NAME"/>
                <param name="attribute_index" value="INDEX"/>
                <param name="search_criteria" value="SEX = 'M'"/>
            </generator>
        </attribute>
        <attribute name="last_name" caption="Last Name" type="String" required="true" access="R/W" constraints="">
            <generator class="thinkui.datagen.generators.DynamicDataGenerator">
                <param name="data_object" value="LastName"/>
                <param name="attribute_name" value="NAME"/>
                <param name="attribute_index" value="INDEX"/>
            </generator>
        </attribute>
        <attribute name="user_id" caption="User ID" type="String" required="true" access="R/O" constraints="">
            <generator class="thinkui.datagen.generators.StringGenerator" probabilityNull="0" generatorMode="UNIFORM" minValue="3" maxValue="15">
                <param name="alphabet" value="ABCDEFGHIJKLMNOPQRSTUVWYZ_0123456789"/>
            </generator>
        </attribute>
        <attribute name="user_name" caption="User Name" type="String" required="true" access="R/O" constraints="">
            <generator class="thinkui.datagen.generators.UserNameGenerator" probabilityNull="0" minValue="3" maxValue="15">
                <param name="attribute_first_name" value="first_name"/>
                <param name="attribute_last_name" value="last_name"/>
                <param name="user_sex" value="M"/>
            </generator>
        </attribute>
        <attribute name="email_addr" caption="Email Address" type="String" required="false" access="R/O" constraints="">
            <generator class="EmailAddressGenerator" probabilityNull="20">
                <param name="attribute_first_name" value="first_name"/>
                <param name="attribute_last_name" value="last_name"/>
                <param name="attribute_user_name" value="user_name"/>
                <param name="attribute_domain_tld" value="domain_tld"/>
            </generator>
        </attribute>
        <attribute name="password" caption="Password" type="Password" required="true" access="R/W" constraints="StringLengthConstraints(6,30)">
        </attribute>
        <attribute name="pwd_hint" caption="Password Hint" type="String" required="true" access="R/W" constraints="StringLengthConstraints(10)">
            <generator class="thinkui.datagen.generators.DynamicDataGenerator">
                <param name="data_object" value="Word"/>
                <param name="attribute_name" value="WORD"/>
                <param name="attribute_index" value="INDEX"/>
                <param name="search_criteria" value="CLASS = 'n'"/>
            </generator>
        </attribute>
        <attribute name="addr_country" caption="Country" type="String" required="false" access="R/W" constraints="">
            <generator class="DynamicDataGenerator" probabilityNull="10">
                <param name="data_object" value="thinkui.parser.objects.Country"/>
                <param name="attribute_name" value="CODE"/>
            </generator>
        </attribute>
        <attribute name="addr_prov_state" caption="Province/State" type="String" required="false" access="R/W" constraints="">
            <generator class="DynamicDataGenerator" probabilityNull="5">
                <param name="data_object" value="thinkui.parser.objects.ProvState"/>
                <param name="attribute_name" value="NAME"/>
                <param name="search_criteria" value="COUNTRY_CODE = 'CAN'"/>
            </generator>
        </attribute>
        <attribute name="birth_country" caption="Birth Country" type="String" required="false" access="R/W" constraints="">
            <generator class="DynamicDataGenerator" probabilityNull="90">
                <param name="data_object" value="thinkui.parser.objects.Country"/>
                <param name="attribute_name" value="NAME"/>
            </generator>
        </attribute>
        <attribute name="age" caption="Age" type="Integer" required="false" access="R/W" constraints="">
            <generator class="thinkui.datagen.generators.IntegerGenerator" probabilityNull="50" generatorMode="NORMAL" meanValue="30" stdDev="10"/>
        </attribute>
        <attribute name="work_desc" caption="Work Description" type="String" required="false" access="R/W" constraints="">
            <generator class="DynamicDataGenerator" probabilityNull="50">
                <param name="table_name" value="thinkui.naics"/>
                <param name="attribute_name" value="DESCRIPTION"/>
            </generator>
        </attribute>
        <attribute name="notes" caption="Notes" type="Text" required="false" access="R/W" constraints="StringLengthConstraints(0, 80)">
            <generator class="StringGenerator" probabilityNull="25" generatorMode="POISON" meanLength="40">
                <param name="alphabet" value="ABCDEFGHIJKLMNOPQRSTUVWYZabcdefghijklmnopqrstuvwxyz~!@#$%^&amp;*()_+{}|:[dbquote];&lt;&gt;?`1234567890-=[]\;',./"/>
            </generator>
        </attribute>
        <attribute name="registration_date" caption="Registration Date" type="Date" required="true" access="R/W" constraints="ValueRangeConstraints(2008-09-18)">
            <generator class="thinkui.datagen.generators.DateGenerator" generatorMode="NORMAL" meanValue="2001-01-01" stdDev="10"/>
        </attribute>
        <attribute name="create_datetime" caption="Create Time" type="Timestamp" required="true" access="R/W" constraints="">
            <generator class="thinkui.datagen.generators.TimestampGenerator" generatorMode="NORMAL" meanValue="2008-09-02 00:00:00" stdDev="365" maxValue="2008-09-02"/>
        </attribute>
    </datagen>
</target>

4. Invoke your Ant build.xml file as follows:
e.g.
C:\Program Files\ThinkUI\DataGenerator\samples>ant -f sample_build.xml

5. The generated data are found in the "output" directory or is written directly to the target database.
If no target file or database has been configured, the output will be displayed to stdout.