applications/order/entitydef/entitymodel_olap.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<entitymodel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/entitymodel.xsd">
    <!-- ========================================================= -->
    <!-- ======================== Defaults ======================= -->
    <!-- ========================================================= -->
    <title>OLAP entities for the Order component</title>
    <description>None</description>
    <copyright>Copyright 2001-2007 The Apache Software Foundation</copyright>

    <!-- ========================================================= -->
    <!-- Facts                                                     -->
    <!-- ========================================================= -->
    <entity entity-name="SalesOrderItemFact" package-name="org.ofbiz.bi.fact.order" title="Sales Order Item Fact">
        <description>A transaction fact entity with order item grain.</description>
        <field name="orderId" type="id-ne"></field> <!-- degenerate dimension -->
        <field name="orderItemSeqId" type="id-ne"></field> <!-- degenerate dimension -->
        <field name="orderDateDimId" type="id-ne"></field>
        <field name="productDimId" type="id-ne"></field>
        <field name="origCurrencyDimId" type="id-ne"></field>
        <field name="billToCustomerDimId" type="id-ne"></field> <!-- TODO: implement the dimension -->
        
        <field name="productStoreId" type="id-ne"></field>      
        <field name="salesChannelEnumId" type="id-ne"></field>
        <field name="saleChannel" type="description"></field>
        <field name="orderStatus" type="description"></field>
        <field name="visitId" type="id-ne"></field>
        <field name="initialReferrer" type="url"></field>
        <field name="productPromoCode" type="id"></field>
        <field name="categoryName" type="id"></field>
        
        <field name="quantity" type="fixed-point">
            <description>Quantity order. From OrderItem.quantity</description>
        </field>

        <field name="extGrossAmount" type="currency-precise">
            <description>Extended gross amount: quantity item multiplied by the unit price.</description>
        </field>
        <field name="extGrossCost" type="currency-precise">
            <description>Extended gross cost: quantity item multiplied by the last price.</description>
        </field>
        <field name="extDiscountAmount" type="currency-precise">
            <description>Extended discount amount.</description>
        </field>
        <field name="extNetAmount" type="currency-precise">
            <description>Extended net amount: gross amount less discounts.</description>
        </field>
        <field name="extShippingAmount" type="currency-precise">
            <description>Extended shipping amount.</description>
        </field>
        <field name="extTaxAmount" type="currency-precise">
            <description>Extended tax amount.</description>
        </field>
        
        <field name="GrossSales" type="currency-precise">
            <description>Gross Sales: extGrossAmount less extShippingAmount.</description>
        </field>
        <field name="GrossMerchandizeSales" type="currency-precise">
            <description>Gross Merchandize Sales: extGrossAmount.</description>
        </field>
        <field name="GrossMerchandizeProfit" type="currency-precise">
            <description>Gross Merchandize Profit: GrossMerchandizeSales less default price.</description>
        </field>
        <field name="GrossShippingProfit" type="currency-precise">
            <description>Gross Shipping Profit</description>
        </field>
        <field name="GrossProfit" type="currency-precise">
            <description>Gross Profit: GrossMerchandizeProfit less GrossShippingProfit.</description>
        </field>
        
        <field name="eBay" type="currency-precise">
            <description>eBay Fee: current ebay fee is captured manually by employee and updated into sharepoint list.</description>
        </field>
        <field name="RRC" type="currency-precise">
            <description>RRC: the total amount of our RRC (refund, replace and cancellation).</description>
        </field>
        <field name="OtherFree" type="currency-precise">
            <description>Others: other fee which calculation is just a percentage of GrossSales.</description>
        </field>
        
        <field name="NBO" type="currency-precise">
            <description>NBO: NBO which calculation is GrossProfit minus all the fees (eBay,RRC and Others).</description>
        </field>
        
        <field name="CountDate" type="currency-precise">
            <description>CountDate: Count of date.</description>
        </field>
<!--        <field name="AverageMerchandizeProfit" type="currency-precise">
            <description>Average Merchandize Profit</description>
        </field>
        <field name="AverageGrossProfit" type="currency-precise">
            <description>Average Gross Profit</description>
        </field>-->

        <!--<field name="extGrossAmount" type="currency-precise">
            <description>Extended gross amount: quantity invoiced multiplied by the list unit price.</description>
        </field>
        <field name="extDiscountAmount" type="currency-precise">
            <description>Extended discount amount.</description>
        </field>
        <field name="extNetAmount" type="currency-precise">
            <description>Extended net amount: gross amount less discounts.</description>
        </field>
        <field name="extShippingAmount" type="currency-precise">
        <description>Extended shipping amount.</description>
        </field>
        <field name="extTaxAmount" type="currency-precise">
            <description>Extended tax amount.</description>
        </field>
        <field name="extManFixedCost" type="currency-precise">
            <description>Extended manufacturing fixed cost.</description>
        </field>
        <field name="extManVarCost" type="currency-precise">
            <description>Extended manufacturing variable cost.</description>
        </field>
        <field name="extStorageCost" type="currency-precise">
            <description>Extended storage cost.</description>
        </field>
        <field name="extDistributionCost" type="currency-precise">
            <description>Extended distribution cost.</description>
        </field>
        <field name="contributionAmount" type="currency-precise">
            <description>Extended net amount less all the costs.</description>
        </field>-->
        <!--
        TODO: implement multi-currency fields
        <field name="extGrossAmountOrig" type="currency-precise">
            <description>Extended gross amount in the original currency: quantity invoiced multiplied by the list unit price.</description>
        </field>
        <field name="extDiscountAmountOrig" type="currency-precise">
            <description>Extended discount amount in the original currency.</description>
        </field>
        <field name="extNetAmountOrig" type="currency-precise">
            <description>Extended net amount in the original currency: gross amount less discounts.</description>
        </field>
        <field name="extManFixedCostOrig" type="currency-precise">
            <description>Extended manufacturing fixed cost in the original currency.</description>
        </field>
        <field name="extManVarCostOrig" type="currency-precise">
            <description>Extended manufacturing variable cost in the original currency.</description>
        </field>
        <field name="extStorageCostOrig" type="currency-precise">
            <description>Extended storage cost in the original currency.</description>
        </field>
        <field name="extDistributionCostOrig" type="currency-precise">
            <description>Extended distribution cost in the original currency.</description>
        </field>
        <field name="contributionAmountOrig" type="currency-precise">
            <description>Extended net amount less all the costs in the original currency.</description>
        </field>
        -->

        <prim-key field="orderId"/>
        <prim-key field="orderItemSeqId"/>

        <relation type="one" fk-name="SOIF_ORDERDATE" rel-entity-name="DateDimension">
            <key-map field-name="orderDateDimId" rel-field-name="dimensionId"/>
        </relation>
        <relation type="one" fk-name="SOIF_CURRENCY" rel-entity-name="CurrencyDimension">
            <key-map field-name="origCurrencyDimId" rel-field-name="dimensionId"/>
        </relation>
        <relation type="one" fk-name="SOIF_PRODUCT" rel-entity-name="ProductDimension">
            <key-map field-name="productDimId" rel-field-name="dimensionId"/>
        </relation>

    </entity>

    <!-- ========================================================= -->
    <!-- Star Schemas                                              -->
    <!-- ========================================================= -->
    <view-entity entity-name="SalesOrderItemStarSchema" package-name="org.ofbiz.bi.starschema.order" title="Sales Order Item Star Schema">
        <description>Order Item star schema (Profit and Loss Statement).</description>

        <member-entity entity-alias="SOIF" entity-name="SalesOrderItemFact"/>
        <member-entity entity-alias="ODD" entity-name="DateDimension"/>
        <member-entity entity-alias="PD" entity-name="ProductDimension"/>
        <member-entity entity-alias="CD" entity-name="CurrencyDimension"/>

        <alias-all entity-alias="ODD" prefix="orderDate" group-by="true">
            <exclude field="dimensionId"/>
        </alias-all>
        <alias-all entity-alias="PD" prefix="product" group-by="true">
            <exclude field="dimensionId"/>
        </alias-all>
        <alias-all entity-alias="CD" prefix="currency" group-by="true">
            <exclude field="dimensionId"/>
        </alias-all>
        <alias-all entity-alias="SOIF" function="sum">
            <exclude field="orderId"/>
            <exclude field="orderItemSeqId"/>
            <exclude field="orderDateDimId"/>
            <exclude field="productDimId"/>
            <exclude field="origCurrencyDimId"/>
            <exclude field="billToCustomerDimId"/>
            <exclude field="productStoreId"/>
            <exclude field="salesChannelEnumId"/>
            <exclude field="saleChannel"/>
            <exclude field="orderStatus"/>
            <exclude field="visitId"/>
            <exclude field="initialReferrer"/>
            <exclude field="productPromoCode"/>
            <exclude field="categoryName"/>
        </alias-all>
        <alias entity-alias="SOIF" name="orderId" group-by="true">
            <description>Order id</description>
        </alias>

        <alias entity-alias="SOIF" name="orderItemSeqId" group-by="true"/>
        <alias entity-alias="SOIF" name="productStoreId" group-by="true"/>
        <alias entity-alias="SOIF" name="salesChannelEnumId" group-by="true"/>
        <alias entity-alias="SOIF" name="saleChannel" group-by="true"/>
        <alias entity-alias="SOIF" name="orderStatus" group-by="true"/>
        <alias entity-alias="SOIF" name="visitId" group-by="true"/>
        <alias entity-alias="SOIF" name="initialReferrer" group-by="true"/>
        <alias entity-alias="SOIF" name="productPromoCode" group-by="true"/>
        <alias entity-alias="SOIF" name="categoryName" group-by="true"/>

        <view-link entity-alias="SOIF" rel-entity-alias="ODD">
            <key-map field-name="orderDateDimId" rel-field-name="dimensionId"/>
        </view-link>
        <view-link entity-alias="SOIF" rel-entity-alias="PD">
            <key-map field-name="productDimId" rel-field-name="dimensionId"/>
        </view-link>
        <view-link entity-alias="SOIF" rel-entity-alias="CD">
            <key-map field-name="origCurrencyDimId" rel-field-name="dimensionId"/>
        </view-link>

    </view-entity>

</entitymodel>