OBPIH-5455 Add filter for GL account

grails-app/conf/UrlMappings.groovy

@@ -49,22 +49,28 @@ class UrlMappings {
 
  // Category options for filters on product list page
  "/api/categoryOptions"(parseRequest: true) {
- controller = { "productApi" }
+ controller = { "selectOptionsApi" }
  action = [GET: "categoryOptions"]
  }
 
  // Catalog options for filters on product list page
  "/api/catalogOptions"(parseRequest: true) {
- controller = { "productApi" }
+ controller = { "selectOptionsApi" }
  action = [GET: "catalogOptions"]
  }
 
  // Tag options for filters on product list page
  "/api/tagOptions"(parseRequest: true) {
- controller = { "productApi" }
+ controller = { "selectOptionsApi" }
  action = [GET: "tagOptions"]
  }
 
+ // Gl account options for filters on product list page
+ "/api/glAccountOptions"(parseRequest: true) {
+ controller = { "selectOptionsApi" }
+ action = [GET: "glAccountOptions"]
+ }
+
  "/api/products"(parseRequest: true) {
  controller = { "productApi" }
  action = [GET: "list"]

grails-app/controllers/org/pih/warehouse/api/ProductApiController.groovy

@@ -10,6 +10,7 @@
 package org.pih.warehouse.api
 
 import grails.converters.JSON
+import org.pih.warehouse.core.GlAccount
 import org.pih.warehouse.core.Location
 import org.pih.warehouse.core.Tag
 import org.pih.warehouse.product.Category
@@ -32,6 +33,7 @@ class ProductApiController extends BaseDomainApiController {
  def categories = params.categoryId ? Category.findAllByIdInList(params.list("categoryId")) : null
  def tags = params.tagId ? Tag.getAll(params.list("tagId")) : []
  def catalogs = params.catalogId ? ProductCatalog.getAll(params.list("catalogId")) : []
+ def glAccounts = params.glAccountsId ? GlAccount.getAll(params.list('glAccountsId')) : []
 
  // Following this approach of assigning q into other params for productService.getProducts
  params.name = params.q
@@ -49,7 +51,7 @@ class ProductApiController extends BaseDomainApiController {
  params.max = -1
  }
 
- def products = productService.getProducts(categories, catalogs, tags, includeInactive, params)
+ def products = productService.getProducts(categories, catalogs, tags, glAccounts, includeInactive, params)
 
  if (params.format == 'csv') {
  boolean includeAttributes = params.boolean("includeAttributes") ?: false
@@ -262,29 +264,4 @@ class ProductApiController extends BaseDomainApiController {
  def demand = forecastingService.getDemand(origin, destination, product)
  render([monthlyDemand: demand.monthlyDemand, quantityOnHand: quantityOnHand] as JSON)
  }
-
- def catalogOptions = {
- def catalogs = ProductCatalog.list(sort: "name").collect {
- [id: it.id, label: "${it.name} (${it?.productCatalogItems?.size()})"]
- }
-
- render([data: catalogs] as JSON)
- }
-
- def categoryOptions = {
- def categories = Category.list().sort().collect {
- [id: it.id, label: it.getHierarchyAsString(" > ")]
- }
-
- render([data: categories] as JSON)
-
- }
-
- def tagOptions = {
- def tags = Tag.list(sort: "tag").collect {
- [id: it.id, label: "${it.tag} (${it?.products?.size()})"]
- }
-
- render([data: tags] as JSON)
- }
 }

grails-app/controllers/org/pih/warehouse/api/SelectOptionsApiController.groovy

@@ -0,0 +1,38 @@
+/**
+* Copyright (c) 2012 Partners In Health. All rights reserved.
+* The use and distribution terms for this software are covered by the
+* Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
+* which can be found in the file epl-v10.html at the root of this distribution.
+* By using this software in any fashion, you are agreeing to be bound by
+* the terms of this license.
+* You must not remove this notice, or any other, from this software.
+**/
+package org.pih.warehouse.api
+
+import grails.converters.JSON
+import org.pih.warehouse.core.SelectOptionsService
+
+class SelectOptionsApiController {
+
+ SelectOptionsService selectOptionsService;
+
+ def glAccountOptions = {
+ def glAccounts = selectOptionsService.getGlAccountsOptions()
+ render([data: glAccounts] as JSON)
+ }
+
+ def tagOptions = {
+ def tags = selectOptionsService.getTagsOptions()
+ render([data: tags] as JSON)
+ }
+
+ def catalogOptions = {
+ def catalogs = selectOptionsService.getCatalogsOptions()
+ render([data: catalogs] as JSON)
+ }
+
+ def categoryOptions = {
+ def categories = selectOptionsService.getCategoryOptions()
+ render([data: categories] as JSON)
+ }
+}

grails-app/controllers/org/pih/warehouse/core/GlAccountController.groovy

@@ -8,10 +8,11 @@
 * You must not remove this notice, or any other, from this software.
 **/
 package org.pih.warehouse.core
+
+import grails.converters.JSON
 import org.pih.warehouse.product.Product
 
 class GlAccountController {
-
  def index = {
  redirect(action: "list", params: params)
  }

grails-app/i18n/messages.properties

@@ -4103,6 +4103,7 @@ react.productsList.addProduct.label=Add product
 react.productsList.filters.category.label=Category
 react.productsList.filters.catalog.label=Formulary
 react.productsList.filters.tags.label=Tags
+react.productsList.filters.glAccount.label=Gl Account
 react.productsList.filters.search.placeholder.label=Search by product name
 react.productsList.column.active.label=Active
 react.productsList.column.code.label=Code

grails-app/services/org/pih/warehouse/core/SelectOptionsService.groovy

@@ -0,0 +1,40 @@
+/**
+* Copyright (c) 2012 Partners In Health. All rights reserved.
+* The use and distribution terms for this software are covered by the
+* Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
+* which can be found in the file epl-v10.html at the root of this distribution.
+* By using this software in any fashion, you are agreeing to be bound by
+* the terms of this license.
+* You must not remove this notice, or any other, from this software.
+**/
+package org.pih.warehouse.core
+
+import org.pih.warehouse.product.Category
+import org.pih.warehouse.product.ProductCatalog
+
+class SelectOptionsService {
+
+ def getGlAccountsOptions() {
+ return GlAccount.list().collect {
+ [id: it.id, label: "${it.code} - ${it.name}"]
+ }
+ }
+
+ def getTagsOptions() {
+ return Tag.list(sort: "tag").collect {
+ [id: it.id, label: "${it.tag} (${it?.products?.size()})"]
+ }
+ }
+
+ def getCatalogsOptions() {
+ return ProductCatalog.list(sort: "name").collect {
+ [id: it.id, label: "${it.name} (${it?.productCatalogItems?.size()})"]
+ }
+ }
+
+ def getCategoryOptions() {
+ return Category.list().sort().collect {
+ [id: it.id, label: it.getHierarchyAsString(" > ")]
+ }
+ }
+}

grails-app/services/org/pih/warehouse/product/ProductService.groovy

@@ -273,7 +273,7 @@ class ProductService {
  * @return
  */
  List<Product> getProducts(Category category, List<Tag> tags, boolean includeInactive, Map params) {
- return getProducts([category], [], tags, includeInactive, params)
+ return getProducts([category], [], tags, [], includeInactive, params)
  }
 
  /**
@@ -282,10 +282,11 @@ class ProductService {
  * @param category
  * @param catalogs
  * @param tags
+ * @param glAccounts
  * @param params
  * @return
  */
- List<Product> getProducts(List<Category> categories, List<ProductCatalog> catalogsInput, List<Tag> tagsInput, boolean includeInactive, Map params) {
+ List<Product> getProducts(List<Category> categories, List<ProductCatalog> catalogsInput, List<Tag> tagsInput, List<GlAccount> glAccounts, boolean includeInactive, Map params) {
  int max = params.max ? params.int("max") : 10
  int offset = params.offset ? params.int("offset") : 0
  String sortColumn = params.sort ?: "name"
@@ -323,6 +324,11 @@ class ProductService {
  }
  }
 
+ if (glAccounts) {
+ glAccount {
+ 'in'("id", glAccounts.collect { it.id })
+ }
+ }
 
  if (tagsInput) {
  tags {

src/js/api/services/GlAccountApi.js

@@ -0,0 +1,6 @@
+import { GL_ACCOUNTS_OPTION } from 'api/urls';
+import apiClient from 'utils/apiClient';
+
+export default {
+ getGlAccountOptions: () => apiClient.get(GL_ACCOUNTS_OPTION),
+};

src/js/api/urls.js

@@ -1,29 +1,34 @@
+const API = '/openboxes/api';
+
 // PURCHASE ORDER
-export const PURCHASE_ORDER_API = '/openboxes/api/purchaseOrders';
+export const PURCHASE_ORDER_API = `${API}/purchaseOrders`;
 export const PURCHASE_ORDER_DELETE = id => `${PURCHASE_ORDER_API}/${id}`;
 export const PURCHASE_ORDER_ROLLBACK_ORDER = id => `${PURCHASE_ORDER_API}/${id}/rollback`;
 
 // STOCK MOVEMENT
-export const STOCK_MOVEMENT_API = '/openboxes/api/stockMovements';
+export const STOCK_MOVEMENT_API = `${API}/stockMovements`;
 export const STOCK_MOVEMENT_DELETE = id => `${STOCK_MOVEMENT_API}/${id}`;
 export const STOCK_MOVEMENT_PENDING_SHIPMENT_ITEMS = `${STOCK_MOVEMENT_API}/pendingRequisitionItems`;
 export const STOCK_MOVEMENT_INCOMING_ITEMS = `${STOCK_MOVEMENT_API}/shippedItems`;
 
 // STOCK TRANSFER
-export const STOCK_TRANSFER_API = '/openboxes/api/stockTransfers';
+export const STOCK_TRANSFER_API = `${API}/stockTransfers`;
 export const STOCK_TRANSFER_DELETE = id => `${STOCK_TRANSFER_API}/${id}`;
 
 // INVOICE
-export const INVOICE_API = '/openboxes/api/invoices';
+export const INVOICE_API = `${API}/invoices`;
 
 // PRODUCT
-export const PRODUCT_API = '/openboxes/api/products';
+export const PRODUCT_API = `${API}/products`;
 
 // STOCK LIST
-export const STOCKLIST_API = '/openboxes/api/stocklists';
+export const STOCKLIST_API = `${API}/stocklists`;
 export const STOCKLIST_EXPORT = id => `${STOCKLIST_API}/${id}/export`;
 export const STOCKLIST_DELETE = id => `${STOCKLIST_API}/${id}`;
 export const STOCKLIST_CLEAR = id => `${STOCKLIST_API}/${id}/clear`;
 export const STOCKLIST_CLONE = id => `${STOCKLIST_API}/${id}/clone`;
 export const STOCKLIST_PUBLISH = id => `${STOCKLIST_API}/${id}/publish`;
 export const STOCKLIST_UNPUBLISH = id => `${STOCKLIST_API}/${id}/unpublish`;
+
+// GL ACCOUNTS
+export const GL_ACCOUNTS_OPTION = `${API}/glAccountOptions`;

src/js/components/products/FilterFields.jsx

@@ -18,13 +18,20 @@ export default {
  options: categories,
  }),
  },
- includeCategoryChildren: {
- type: CheckboxField,
- label: 'react.productsList.includeSubcategories.label',
- defaultMessage: 'Include all products in all subcategories',
+ glAccountsId: {
+ type: FilterSelectField,
  attributes: {
+ valueKey: 'id',
+ placeholder: 'react.productsList.filters.glAccount.label',
+ defaultPlaceholder: 'Gl Account',
+ multi: true,
+ closeMenuOnSelect: false,
+ blurInputOnSelect: false,
  filterElement: true,
  },
+ getDynamicAttr: ({ glAccounts }) => ({
+ options: glAccounts,
+ }),
  },
  catalogId: {
  type: FilterSelectField,
@@ -66,4 +73,12 @@ export default {
  filterElement: true,
  },
  },
+ includeCategoryChildren: {
+ type: CheckboxField,
+ label: 'react.productsList.includeSubcategories.label',
+ defaultMessage: 'Include all products in all subcategories',
+ attributes: {
+ filterElement: true,
+ },
+ },
 };

src/js/components/products/ProductsList.jsx

@@ -12,7 +12,7 @@ import useTranslation from 'hooks/useTranslation';
 
 const ProductsList = () => {
  const {
- defaultFilterValues, setFilterValues, categories, catalogs, tags, filterParams,
+ defaultFilterValues, setFilterValues, categories, catalogs, tags, glAccounts, filterParams,
  } = useProductFilters();
 
  useTranslation('productsList', 'reactTable');
@@ -24,7 +24,9 @@ const ProductsList = () => {
  defaultValues={defaultFilterValues}
  setFilterParams={setFilterValues}
  filterFields={filterFields}
- formProps={{ categories, catalogs, tags }}
+ formProps={{
+ categories, catalogs, tags, glAccounts,
+ }}
  />
  <ProductsListTable filterParams={filterParams} />
  </div>