Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

XML files containing one or more data fix sql statements, a sql statement to back up data, and validation statements used to determine whether the data fix should be committed or rolled back.

Object Type Identification

  • If a file with .xml extension is in datafix folderthe folder specified by the Data Fix Root Source Directory project property, then it is considered a data fix file

...

NameCodeDescriptionDefault Value
Data Fix Root Source DirectoryFDEBS_DATA_FIX_ROOT_SOURCE_DIRThe source directory to recognize files as data fixesdatafix
Data Fix Root Destination DirectoryFDEBS_DATA_FIX_DESTINATION_DIRThe destination directory to copy file to.  Leave blank to not copy file anywhere

Sample Build Commands 

N/A - Build commands not supported for this type.

...

Tag NameRequiredDescription
DescriptionYesA description for the data fix being run
FixSQLYesThe SQL which implements the data fix. It can be multiple statements delimited by a semicolon or slash
BackupSQLYesSQL to perform necessary backup of data before executing FixSQLConnectStringYes. This must be one valid SQL statement, not followed by a semicolon
ConnectStringPropertyNoThe JDBC connection string for the database. Can also use environment instance propertyUserYesThe APPS_JDBC_URL environment variable will be used if property is not specified in file
UserPropertyNoUser to connect to database with.  PasswordYesEnvironment instance property FDEBS_DB_USER will be used if property is not specified in file
PasswordPropertyNoPassword for the database user. Must be a FlexDeploy property so it is not in clear text in  Environment instance property FDEBS_DB_PASSWORD will be used if property is not specified in file
ValidationsYesThe rule(s) used to validate the data fix before committing changes
       ValidationYesA single validation rule. See below for more details

A single validation contains the following:

Tag NameRequiredDescription
DescriptionYesA description for the validation rule
ValidationSQLYesSelect query which is executed before and after the FixSQL is executed, and result is compared with before and after values. This must be one valid SQL statement, not followed by a semicolon
EnvironmentYesThe expected results defined by an environment.
See more info below
 See below for more details

An environment contains the following:

...

If more than one of these elements are present, all must evaluate to true for the validation to pass.

Data Fix

...

Source Template

Code Block
languagexml
themeRDark
titleBasic Data Fix Template
linenumberstrue
<?xml version="1.0" encoding="UTF-8"?>
<DataFix>
<DataFix xmlns="http://flexagon.com/database/datafix">
    <Description></Description>
    <FixSQL></FixSQL>
    <BackupSQL></BackupSQL>
    <ConnectString><<ConnectStringProperty></ConnectString>ConnectStringProperty>
    <User><<UserProperty></User>UserProperty>
    <Password><<PasswordProperty></Password>PasswordProperty>
    <Validations>
        <Validation> 		<!-- Can be one or more -->
        <Validation>
            <Description></Description>
            <ValidationSQL></ValidationSQL>
			<!-- Can be one or more -->
            <Environment> 
                <EnvironmentCode></EnvironmentCode>
                <Before>
                    <Equals></Equals>
                    <NotEquals></NotEquals>
                    <GreaterThan></GreaterThan>
                    <GreaterThanEqual></GreaterThanEqual>
                    <LessThan></LessThan>
                    <LessThanEqual></LessThanEqual>
                </Before>
                <After>
                    <Equals></Equals>
                    <NotEquals></NotEquals>
                    <GreaterThan></GreaterThan>
                    <GreaterThanEqual></GreaterThanEqual>
                    <LessThan></LessThan>
                    <LessThanEqual></LessThanEqual>
                </After>
                <UpdateCount>
                    <Equals></Equals>
                    <NotEquals></NotEquals>
                    <GreaterThan></GreaterThan>
                    <GreaterThanEqual></GreaterThanEqual>
                    <LessThan></LessThan>
                    <LessThanEqual></LessThanEqual>
                </UpdateCount>
            </Environment>
        </Validation>
    </Validations>
</DataFix>

Data Fix Source Examples

The first example is a simple data fix that updates one row of a table, then verifies only the expected row is updated.

Code Block
languagexml
themeRDark
titleProduct Price Fix
<?xml version="1.0" encoding="UTF-8"?>
<DataFix xmlns="http://flexagon.com/database/datafix">
    <Description>Fix list price of product ID 47809</Description>
    <FixSQL>update xxhr.XXHR_PRODUCT_LIST set list_price = 150 where product_id = 47809;</FixSQL>
    <BackupSQL>create table xxhr.xxhr_product_list_bkp as (select * from xxhr.xxhr_product_list)</BackupSQL>
    <ConnectStringProperty>CONNECT_STRING_PROPERTY</ConnectStringProperty>
    <UserProperty>DB_USER_PROPERTY</UserProperty>
    <PasswordProperty>DB_PASSWORD_PROPERTY</PasswordProperty>
    <Validations>
        <Validation>
            <Description>Make sure product_id = 47809 has a list_price of 150</Description>
            <ValidationSQL>select count(*) from xxhr.xxhr_product_list where list_price = 150 and product_id = 47809</ValidationSQL>
            <Environment>
                <EnvironmentCode>DEV</EnvironmentCode>
                <Before>
                    <Equals>0</Equals>
                </Before>
                <After>
                    <Equals>1</Equals>
                </After>
                <UpdateCount>
                    <Equals>1</Equals>
                </UpdateCount>
            </Environment>
        </Validation>
    </Validations>
</DataFix>

This example updates a row on the order_header table, then validates that the order_item total matches the updated order_header total.

Code Block
languagexml
themeRDark
titleOrder Header Fix
<?xml version="1.0" encoding="UTF-8"?>
<DataFix xmlns="http://flexagon.com/database/datafix">
    <Description>Fix total_price on order_header</Description>
    <FixSQL>update XXHR.xxhr_order_header set total_price = 250 where order_id = 1;</FixSQL>
    <BackupSQL>create table xxhr.xxhr_order_header_bkp as (select * from xxhr.xxhr_order_header)</BackupSQL>
    <Validations>
        <Validation>
            <Description>Make sure order_header total_price is equal to the line_item total</Description>
            <ValidationSQL>select case when o.order_total = l.line_item_total then 1 when o.order_total <> l.line_item_total then 0 end 
			               as validation from
                           (select order_id, order_total from xxhr.xxhr_order_header where order_id = 1) o, 
                           (select order_id, sum(unit_price * quantity) as line_item_total 
                           from XXHR.xxhr_order_items where order_id = 1 group by order_id) l
                           where o.order_id = l.order_id</ValidationSQL>
            <Environment>
                <EnvironmentCode>DEFAULT</EnvironmentCode>
                <Before>
                    <Equals>0</Equals>
                </Before>
                <After>
                    <Equals>1</Equals>
                </After>
                <UpdateCount>
                    <Equals>1</Equals>
                </UpdateCount>
            </Environment>
            </Environment>
        </Validation>
    </Validations>
</DataFix>

This example is a data fix that updates the price of multiple products, then verifies the amount of items affected by this change.

Code Block
languagexml
themeRDark
titleLine Item Fix
<?xml version="1.0" encoding="UTF-8"?>
<DataFix xmlns="http://flexagon.com/database/datafix">
    <Description>Fix line items for product IDs 47809 and 45203</Description>
    <FixSQL>update XXHR.xxhr_order_items set unit_price = 100 where product_id = 47809;
            update XXHR.xxhr_order_items set unit_price = 75 where product_id = 45203;</FixSQL>
    <BackupSQL>create table xxhr.xxhr_order_items_bkp as (select * from xxhr.xxhr_order_items)</BackupSQL>
    <ConnectStringProperty></ConnectStringProperty>
    <UserProperty></UserProperty>
    <PasswordProperty></PasswordProperty>
    <Validations>
        <Validation>
            <Description>Verify number of rows modified for product with id 47809</Description>
            <ValidationSQL>select count(*) from xxhr.xxhr_order_items where list_price = 100 and product_id = 47809</ValidationSQL>
            <Environment>
                <EnvironmentCode>DEV</EnvironmentCode>
               <EnvironmentCode>< <UpdateCount>
                    <GreaterThan>80</GreaterThan>
                    <LessThan>100</LessThan>
                </UpdateCount>
            </Environment>
            <Environment>
                <EnvironmentCode>default</EnvironmentCode>
                <UpdateCount>
                    <GreaterThan>87</GreaterThan>
                    <LessThan>93</LessThan>
                </UpdateCount>
            </Environment>
        </Validation>
        <Validation>
            <Description>Verify number of rows modified for product with id 45203</Description>
            <ValidationSQL>select count(*) from xxhr.xxhr_order_items where list_price = 75 and product_id = 45203</ValidationSQL>
            <Environment>
                <EnvironmentCode>default</EnvironmentCode>
                <UpdateCount>
                    <GreaterThan><<GreaterThan>120</GreaterThan>
                    <LessThan>125</LessThan>
                </UpdateCount>
            </Environment>
        </Validation>
    </Validations>
</DataFix>

...