Improved: Convert DimensionServices.xml minilang to groovy (OFBIZ-10948)

bi/groovyScripts/DimensionServices.groovy

@@ -0,0 +1,135 @@
+/*
+ * 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.
+ */
+
+import org.apache.ofbiz.entity.condition.EntityCondition
+import org.apache.ofbiz.entity.condition.EntityOperator
+import org.apache.ofbiz.entity.GenericValue
+import org.apache.ofbiz.entity.util.EntityListIterator
+import org.apache.ofbiz.service.ModelService
+import org.apache.ofbiz.service.ServiceUtil
+
+def quickInitDataWarehouse() {
+    Map inMap = dispatcher.getDispatchContext().makeValidContext("loadDateDimension", ModelService.IN_PARAM, parameters)
+    serviceResult = run service: "loadDateDimension", with: inMap
+    if (!ServiceUtil.isSuccess(serviceResult)) return error(serviceResult.errorMessage)
+
+    inMap.clear()
+    serviceResult = run service: "loadCurrencyDimension", with: inMap
+    if (!ServiceUtil.isSuccess(serviceResult)) return error(serviceResult.errorMessage)
+
+    // loads all products in the ProductDimension
+    serviceResult = run service: "loadAllProductsInProductDimension", with: inMap
+    if (!ServiceUtil.isSuccess(serviceResult)) return error(serviceResult.errorMessage)
+
+    // loads the invoice items in the SalesInvoiceItemFact fact entity
+    entryExprs = EntityCondition.makeCondition([
+            EntityCondition.makeCondition("invoiceTypeId", EntityOperator.EQUALS, "SALES_INVOICE"),
+            EntityCondition.makeCondition("invoiceDate", EntityOperator.GREATER_THAN_EQUAL_TO, parameters.fromDate),
+            EntityCondition.makeCondition("invoiceDate", EntityOperator.LESS_THAN_EQUAL_TO, parameters.thruDate)
+    ], EntityOperator.AND)
+    EntityListIterator listIterator = from("Invoice").where(entryExprs).queryIterator()
+    GenericValue iterator
+    while (iterator = listIterator.next()) {
+        inMap.invoiceId = iterator.invoiceId
+        serviceResult = run service: "loadSalesInvoiceFact", with: inMap
+        if (!ServiceUtil.isSuccess(serviceResult)) return error(serviceResult.errorMessage)
+    }
+
+    // loads the order items in the SalesOrderItemFact fact entity
+    entryExprs = EntityCondition.makeCondition([
+            EntityCondition.makeCondition("orderTypeId", EntityOperator.EQUALS, "SALES_ORDER"),
+            EntityCondition.makeCondition("orderDate", EntityOperator.GREATER_THAN_EQUAL_TO, parameters.fromDate),
+            EntityCondition.makeCondition("orderDate", EntityOperator.LESS_THAN_EQUAL_TO, parameters.thruDate)
+    ], EntityOperator.AND)
+    listIterator = from("OrderHeader").where(entryExprs).queryIterator()
+    inMap.clear()
+    while (iterator = listIterator.next()) {
+        inMap.orderId = iterator.orderId
+        serviceResult = run service: "loadSalesOrderFact", with: inMap
+        if (!ServiceUtil.isSuccess(serviceResult)) return error(serviceResult.errorMessage)
+    }
+
+    // loads the inventory items in the InventoryItemFact fact entity
+    listIterator = from("InventoryItem").where("inventoryItemTypeId", "NON_SERIAL_INV_ITEM").queryIterator()
+    inMap.clear()
+    while (iterator = listIterator.next()) {
+        inMap.inventoryItemId = iterator.inventoryItemId
+        serviceResult = run service: "loadInventoryFact", with: inMap
+        if (!ServiceUtil.isSuccess(serviceResult)) return error(serviceResult.errorMessage)
+    }
+}
+
+def loadCurrencyDimension() {
+    // Initialize the CurrencyDimension using the update strategy of 'type 1
+    EntityListIterator listIterator = from("Uom").where("uomTypeId", "CURRENCY_MEASURE").queryIterator()
+    GenericValue currency
+    while (currency = listIterator.next()) {
+        currencyDims = from("CurrencyDimension").where("currencyId", currency.uomId).queryList()
+        if (currencyDims) {
+            for (GenericValue currencyDim: currencyDims) {
+                currencyDim.description = currency.description
+                currencyDim.store()
+            }
+        } else {
+            currencyDim = delegator.makeValue("CurrencyDimension")
+            currencyDim.currencyId = currency.uomId
+            currencyDim.description = currency.description
+            currencyDim.create()
+        }
+    }
+}
+
+def prepareProductDimensionData() {
+    GenericValue product = from("Product").where("productId", parameters.productId).queryOne()
+    if (product == null) {
+        return error(UtilProperties.getMessage('ProductUiLabels', 'ProductProductNotFoundWithProduct', locale))
+    }
+    productDimension = delegator.makeValue("ProductDimension")
+    productDimension.setNonPKFields(parameters)
+    GenericValue productType = select("description").from("Product").where("productId", parameters.productId).queryOne()
+    productDimension.productType = productType.description
+    Map result = success()
+    result.productDimension = productDimension
+    return result
+}
+
+def loadProductInProductDimension() {
+    Map inMap = dispatcher.getDispatchContext().makeValidContext("prepareProductDimensionData", ModelService.IN_PARAM, parameters)
+    serviceResult = run service: "prepareProductDimensionData", with: inMap
+    GenericValue productDimension
+    if (ServiceUtil.isSuccess(serviceResult)) {
+        productDimension  = serviceResult.productDimension
+    }
+    inMap.clear()
+    inMap = dispatcher.getDispatchContext().makeValidContext("storeGenericDimension", ModelService.IN_PARAM, parameters)
+    inMap.naturalKeyFields = "productId"
+    inMap.dimensionValue = productDimension
+    run service: "storeGenericDimension", with: inMap
+}
+
+def loadAllProductsInProductDimension() {
+    EntityListIterator listIterator = from("Product").queryIterator()
+    GenericValue product
+    Map inMap
+    while (product = listIterator.next()) {
+        inMap = dispatcher.getDispatchContext().makeValidContext("loadProductInProductDimension", ModelService.IN_PARAM, parameters)
+        inMap.productId = product.productId
+        run service: "loadProductInProductDimension", with: inMap
+    }
+}

bi/servicedef/services.xml

@@ -35,8 +35,8 @@ under the License.
         <attribute name="naturalKeyFields" type="Map" mode="IN" optional="false"/> <!-- the names/values pairs of the fields that compose the natural key of the dimension -->
         <attribute name="dimensionId" type="String" mode="OUT" optional="true"/>
     </service>
-    <service name="quickInitDataWarehouse" auth="true" engine="simple"
-        location="component://bi/minilang/DimensionServices.xml" invoke="quickInitDataWarehouse">
+    <service name="quickInitDataWarehouse" auth="true" engine="groovy"
+        location="component://bi/groovyScripts/DimensionServices.groovy" invoke="quickInitDataWarehouse">
         <description>Quickly initialize the dimensions (Currency, Date, Product) and facts (SalesInvoiceItem): useful to quickly initialize the datawarehouse.</description>
         <attribute name="fromDate" type="Timestamp" mode="IN" optional="false"/>
         <attribute name="thruDate" type="Timestamp" mode="IN" optional="false"/>
@@ -49,37 +49,37 @@ under the License.
         <attribute name="fromDate" type="Timestamp" mode="IN" optional="false"/>
         <attribute name="thruDate" type="Timestamp" mode="IN" optional="false"/>
     </service>
-    <service name="loadCurrencyDimension" auth="true" engine="simple"
-        location="component://bi/minilang/DimensionServices.xml" invoke="loadCurrencyDimension">
+    <service name="loadCurrencyDimension" auth="true" engine="groovy"
+        location="component://bi/groovyScripts/DimensionServices.groovy" invoke="loadCurrencyDimension">
         <description>Loads data in the CurrencyDimension entity (olap entity) using the update strategy of 'type 1': overwrite the values of the attributes</description>
     </service>
     <!-- Product Dimension -->
-    <service name="prepareProductDimensionData" auth="true" engine="simple"
-        location="component://bi/minilang/DimensionServices.xml" invoke="prepareProductDimensionData">
+    <service name="prepareProductDimensionData" auth="true" engine="groovy"
+        location="component://bi/groovyScripts/DimensionServices.groovy" invoke="prepareProductDimensionData">
         <description>Pulls information from the Product* entities (oltp entities) and prepares data for the ProductDimension entity (olap entity)</description>
         <attribute name="productId" type="String" mode="IN" optional="false"/>
         <attribute name="productDimension" type="GenericEntity" mode="OUT" optional="false"/>
     </service>
-    <service name="loadProductInProductDimension" auth="true" engine="simple"
-        location="component://bi/minilang/DimensionServices.xml" invoke="loadProductInProductDimension">
+    <service name="loadProductInProductDimension" auth="true" engine="groovy"
+        location="component://bi/groovyScripts/DimensionServices.groovy" invoke="loadProductInProductDimension">
         <description>Pulls information from the Product* entities and stores them in the ProductDimension entity (olap entity)</description>
         <attribute name="productId" type="String" mode="IN" optional="false"/>
         <attribute name="updateMode" type="String" mode="IN" optional="false"/> <!-- TYPE1, TYPE2, TYPE3 -->
     </service>
-    <service name="loadType1ProductInProductDimension" auth="true" engine="simple"
-        location="component://bi/minilang/DimensionServices.xml" invoke="loadProductInProductDimension">
+    <service name="loadType1ProductInProductDimension" auth="true" engine="groovy"
+        location="component://bi/groovyScripts/DimensionServices.groovy" invoke="loadProductInProductDimension">
         <description>Same as loadProductInProductDimension; the update strategy is 'type 1': overwrite the values of the attributes</description>
         <attribute name="productId" type="String" mode="IN" optional="false"/>
         <attribute name="updateMode" type="String" mode="IN" optional="true" default-value="TYPE1"/>
     </service>
-    <service name="loadType2ProductInProductDimension" auth="true" engine="simple"
-        location="component://bi/minilang/DimensionServices.xml" invoke="loadProductInProductDimension">
+    <service name="loadType2ProductInProductDimension" auth="true" engine="groovy"
+        location="component://bi/groovyScripts/DimensionServices.groovy" invoke="loadProductInProductDimension">
         <description>Same as loadProductInProductDimension; the update strategy is 'type 2': add a dimension row</description>
         <attribute name="productId" type="String" mode="IN" optional="false"/>
         <attribute name="updateMode" type="String" mode="IN" optional="true" default-value="TYPE2"/>
     </service>
-    <service name="loadAllProductsInProductDimension" auth="true" engine="simple"
-        location="component://bi/minilang/DimensionServices.xml" invoke="loadAllProductsInProductDimension">
+    <service name="loadAllProductsInProductDimension" auth="true" engine="groovy"
+        location="component://bi/groovyScripts/DimensionServices.groovy" invoke="loadAllProductsInProductDimension">
         <description>Calls the loadProductInProductDimension service for all the products.</description>
         <attribute name="updateMode" type="String" mode="IN" optional="true" default-value="TYPE1"/>
     </service>