| <?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. |
| --> |
| |
| <services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/services.xsd"> |
| <description>Product Component Services</description> |
| <vendor>OFBiz</vendor> |
| <version>1.0</version> |
| |
| <!-- Permission Services --> |
| <service name="facilityGenericPermission" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="facilityGenericPermission"> |
| <implements service="permissionInterface"/> |
| </service> |
| <service name="checkProductFacilityRelatedPermission" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="checkProductFacilityRelatedPermission"> |
| <description>ProductFacility Permission Checking Logic</description> |
| <implements service="permissionInterface"/> |
| </service> |
| <!-- Product Inventory Services --> |
| <service name="createInventoryItem" default-entity-name="InventoryItem" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryItem" auth="true"> |
| <description>Create an InventoryItem</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="OUT" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"> |
| <exclude field-name="availableToPromiseTotal"/> |
| <exclude field-name="quantityOnHandTotal"/> |
| </auto-attributes> |
| <attribute name="isReturned" mode="IN" type="String" default-value="N" /> |
| <override name="inventoryItemTypeId" optional="false"/> |
| <override name="productId" optional="false"/> |
| <override name="facilityId" optional="false"/> |
| </service> |
| <service name="createInventoryItemCheckSetAtpQoh" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryItemCheckSetAtpQoh" auth="false"> |
| <description> |
| </description> |
| <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="IN" optional="true"/> |
| </service> |
| |
| <service name="updateInventoryItem" default-entity-name="InventoryItem" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="updateInventoryItem" auth="true"> |
| <description>Update an InventoryItem</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"> |
| <exclude field-name="availableToPromiseTotal"/> |
| <exclude field-name="quantityOnHandTotal"/> |
| </auto-attributes> |
| <attribute name="oldOwnerPartyId" mode="OUT" optional="true" type="String"/> |
| <attribute name="oldProductId" mode="OUT" optional="true" type="String"/> |
| <attribute name="oldStatusId" mode="OUT" optional="true" type="String"/> |
| </service> |
| <service name="changeOwnerUponIssuance" engine="simple" auth="true" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="changeOwnerUponIssuance"> |
| <description>If product store setOwnerUponIssuance is Y or empty, set the inventory item owner upon issuance.</description> |
| <attribute name="itemIssuanceId" type="String" mode="IN" optional="false"/> |
| </service> |
| <service name="createInventoryItemStatus" engine="simple" default-entity-name="InventoryItemStatus" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryItemStatus"> |
| <description>Create an inventory item status record</description> |
| <auto-attributes mode="IN" include="all" optional="true"/> |
| <override name="inventoryItemId" optional="false"/> |
| <override name="statusId" optional="false"/> |
| </service> |
| |
| <service name="checkProductInventoryDiscontinuation" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="checkProductInventoryDiscontinuation" auth="false"> |
| <description>Check Product Inventory Discontinuation</description> |
| <attribute name="productId" mode="IN" optional="false" type="String"/> |
| </service> |
| <service name="inventoryItemCheckSetDefaultValues" default-entity-name="InventoryItem" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="inventoryItemCheckSetDefaultValues" auth="false"> |
| <description>Check and, if empty, fills with default values ownerPartyId, currencyUomId, unitCost</description> |
| <attribute name="inventoryItemId" type="String" mode="IN" optional="true"/> |
| <attribute name="inventoryItem" type="Map" mode="IN" optional="true"/> |
| </service> |
| <service name="createInventoryItemDetail" default-entity-name="InventoryItemDetail" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryItemDetail" auth="true"> |
| <description>Create an createInventoryItemDetail - note that the quantityOnHand and availableToPromise are relative (positive or negative) and will be added to the corresponding value on the given InventoryItem</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"> |
| <exclude field-name="effectiveDate"/> |
| </auto-attributes> |
| <override name="inventoryItemDetailSeqId" mode="OUT"/> |
| </service> |
| <service name="updateInventoryItemFromDetail" default-entity-name="InventoryItemDetail" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="updateInventoryItemFromDetail" auth="false"> |
| <description> |
| Sums all availableToPromiseDiff and quantityOnHandDiff elements for the inventoryItemId and sets the availableToPromise and quantityOnHand fields on the corresponding InventoryItem. |
| Meant to be run as an Entity ECA triggered on any modify operation on the InventoryItemDetail entity. |
| </description> |
| <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> |
| </service> |
| <service name="updateSerializedInventoryTotals" default-entity-name="InventoryItem" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="updateSerializedInventoryTotals" auth="false"> |
| <description>Sets the ATP/QOH totals for serialized inventory items</description> |
| <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="createInventoryItemVariance" default-entity-name="InventoryItemVariance" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryItemVariance" auth="true"> |
| <description>Create an InventoryItemVariance - note that the quantityOnHand and availableToPromise are relative and will be added to the corresponding value on the given InventoryItem</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="createPhysicalInventory" default-entity-name="PhysicalInventory" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create an PhysicalInventory</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="OUT" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="createPhysicalInventoryAndVariance" engine="simple" auth="true" transaction-timeout="600" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createPhysicalInventoryAndVariance"> |
| <description>Create a PhysicalInventory and an InventoryItemVariance</description> |
| <auto-attributes entity-name="InventoryItemVariance" include="pk" mode="IN" optional="false"/> |
| <auto-attributes entity-name="PhysicalInventory" include="nonpk" mode="IN" optional="true"/> |
| <auto-attributes entity-name="InventoryItemVariance" include="nonpk" mode="IN" optional="true"/> |
| <override name="physicalInventoryId" mode="OUT"/> |
| </service> |
| |
| <service name="getMktgPackagesAvailable" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="getMktgPackagesAvailable" auth="false" use-transaction="false"> |
| <description>Get Marketing Packages Available From Components In Inventory</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="true"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| </service> |
| <service name="getProductInventoryAvailable" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="getProductInventoryAvailable" auth="false" use-transaction="false"> |
| <description>Get Inventory Availability for a Product</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="useCache" type="Boolean" mode="IN" optional="true"/> |
| </service> |
| <service name="getInventoryAvailableByFacility" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="getProductInventoryAvailable" auth="false" use-transaction="false"> |
| <description>Get Inventory Availability for a Product constrained by a facilityId</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="lotId" mode="IN" type="String" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="useCache" type="Boolean" mode="IN" optional="true"/> |
| </service> |
| <service name="getInventoryAvailableByLocation" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="getProductInventoryAvailable" auth="false"> |
| <description>Get Inventory Availability for a Product constrained by a facility and location</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="locationSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="useCache" type="Boolean" mode="IN" optional="true"/> |
| </service> |
| <service name="getInventoryAvailableByContainer" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="getProductInventoryAvailable" auth="false" use-transaction="false"> |
| <description>Get Inventory Availability for a Product constrained by a containerId</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="containerId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| </service> |
| <service name="getInventoryAvailableByItem" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="getProductInventoryAvailable" auth="false" use-transaction="false"> |
| <description>Get Inventory Availability for an InventoryItem</description> |
| <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="useCache" type="Boolean" mode="IN" optional="true"/> |
| </service> |
| <service name="getProductInventoryAvailableFromAssocProducts" engine="java" |
| location="org.apache.ofbiz.product.inventory.InventoryServices" invoke="getProductInventoryAvailableFromAssocProducts" auth="false" use-transaction="false"> |
| <description> |
| Get Inventory Availability for a product based on List of associated products, |
| usually marketing package components. |
| </description> |
| <attribute name="facilityId" type="String" mode="IN" optional="true"/> |
| <attribute name="assocProducts" type="List" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| </service> |
| <service name="getProductInventoryAvailableBySupplier" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="getProductInventoryAvailable" auth="false" use-transaction="false"> |
| <description>Get Inventory Availability for a Product by a Supplier</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="partyId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseTotal" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="useCache" type="Boolean" mode="IN" optional="true"/> |
| </service> |
| <service name="countProductInventoryOnHand" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="countProductInventoryOnHand" auth="true" use-transaction="false"> |
| <description>Count Inventory On Hand for a Product constrained by a facilityId at a given date.</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="inventoryCountDate" type="Timestamp" mode="IN" optional="false"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="true"/> |
| </service> |
| <service name="countProductInventoryShippedForSales" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="countProductInventoryShippedForSales" auth="true" use-transaction="false"> |
| <description>Count Inventory Shipped for Sales Orders for a Product constrained by a facilityId in a given date range.</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="fromDate" type="Timestamp" mode="IN" optional="false"/> |
| <attribute name="thruDate" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandTotal" type="BigDecimal" mode="OUT" optional="true"/> |
| </service> |
| <service name="getProductInventorySummaryForItems" engine="java" |
| location="org.apache.ofbiz.product.inventory.InventoryServices" invoke="getProductInventorySummaryForItems" auth="false" use-transaction="false"> |
| <description>Get ATP/QOH Availability for a list of OrderItems by summing over all facilities. If the item is a MARKETING_PKG_AUTO/PICK, then put its quantity available from components |
| in the mktgPkgATPMap and mktgPkgQOHMap.</description> |
| <attribute name="orderItems" type="List" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityOnHandMap" type="Map" mode="OUT" optional="false"/> |
| <attribute name="availableToPromiseMap" type="Map" mode="OUT" optional="false"/> |
| <attribute name="mktgPkgQOHMap" type="Map" mode="OUT" optional="false"/> |
| <attribute name="mktgPkgATPMap" type="Map" mode="OUT" optional="false"/> |
| </service> |
| <service name="getProductInventoryAndFacilitySummary" engine="java" |
| location="org.apache.ofbiz.product.inventory.InventoryServices" invoke="getProductInventoryAndFacilitySummary" auth="false" use-transaction="false"> |
| <description>Get ATP/QOH Availability for a list of OrderItems by summing over all facilities. If the item is a MARKETING_PKG_AUTO/PICK, then put its quantity available from components |
| in the mktgPkgATPMap and mktgPkgQOHMap.</description> |
| <attribute name="checkTime" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="minimumStock" mode="IN" type="BigDecimal" optional="true"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityUomId" type="String" mode="OUT" optional="true"/> |
| <attribute name="totalQuantityOnHand" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="totalAvailableToPromise" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="quantityOnOrder" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="offsetQOHQtyAvailable" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="offsetATPQtyAvailable" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="defaultPrice" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="listPrice" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="wholeSalePrice" mode="OUT" type="BigDecimal" optional="true"/> |
| <attribute name="usageQuantity" mode="OUT" type="BigDecimal" optional="true"/> |
| </service> |
| |
| <service name="checkInventoryAvailability" engine="java" |
| location="org.apache.ofbiz.product.inventory.InventoryServices" invoke="checkInventoryAvailability"> |
| <description>Batch service for checking and sending backorder notifications. Will also set an autoCancelDate for sales orders to 30 days (hard coded) |
| beyond the OISGIR's promisedDatetime, which is in turn set by reserveProductInventory service using ProductFacility.daysToShip or 30 days by default.</description> |
| <!-- this service has no parameters IN or OUT --> |
| </service> |
| |
| <service name="balanceInventoryItems" engine="simple" transaction-timeout="600" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="balanceInventoryItems" auth="true"> |
| <description>Balance inventory items based on the new item specified which will have available inventory that back-order (negative ATP) reservations can be reassigned to.</description> |
| <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> |
| <attribute name="priorityOrderId" type="String" mode="IN" optional="true"/> |
| <attribute name="priorityOrderItemSeqId" type="String" mode="IN" optional="true"/> |
| <attribute name="noLongerOnBackOrderIdSet" type="Set" mode="OUT" optional="true"/> |
| </service> |
| |
| <service name="reassignInventoryReservations" engine="simple" transaction-timeout="600" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="reassignInventoryReservations" auth="true"> |
| <description>Balance inventory reservations for a given product/facility, considering all the reservations with promised date greater than fromDate.</description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="fromDate" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="noLongerOnBackOrderIdSet" type="Set" mode="OUT" optional="true"/> |
| <attribute name="priority" type="String" mode="IN" optional="true"/> |
| </service> |
| <service name="balanceOrderItemsWithNegativeReservations" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="balanceOrderItemsWithNegativeReservations"> |
| <description>For each product with a negative reservation in the order, calls reassignInventoryReservations</description> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="reserveAnInventoryItem" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="reserveAnInventoryItem" auth="true"> |
| <description></description> |
| <attribute name="inventoryItemId" type="String" mode="INOUT" optional="false"/> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> |
| <attribute name="reservedDatetime" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="requireInventory" type="String" mode="IN" optional="false"/> |
| <attribute name="serialNumber" type="String" mode="IN" optional="true"/> |
| <attribute name="sequenceId" type="Long" mode="IN" optional="true"/> |
| <attribute name="promisedDatetime" type="Timestamp" mode="IN" optional="false"/> |
| <attribute name="priority" type="String" mode="IN" optional="true"/> |
| </service> |
| |
| <service name="reserveProductInventory" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="reserveProductInventory" auth="true"> |
| <description>Reserve Inventory for a Product. |
| If requireInventory is Y the quantity not reserved is returned, if N then a negative |
| availableToPromise will be used to track quantity ordered beyond what is in stock. |
| </description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> |
| <attribute name="reservedDatetime" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="requireInventory" type="String" mode="IN" optional="false"/> |
| <attribute name="reserveOrderEnumId" type="String" mode="IN" optional="false"/> |
| <attribute name="sequenceId" type="Long" mode="IN" optional="true"/> |
| <attribute name="lotId" mode="IN" type="String" optional="true" /> |
| <attribute name="priority" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityNotReserved" type="BigDecimal" mode="OUT" optional="false"/> |
| </service> |
| <service name="reserveProductInventoryByFacility" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="reserveProductInventory" auth="true"> |
| <description>Reserve Inventory for a Product By Facility |
| If requireInventory is Y the quantity not reserved is returned, if N then a negative |
| availableToPromise will be used to track quantity ordered beyond what is in stock. |
| </description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> |
| <attribute name="reservedDatetime" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="requireInventory" type="String" mode="IN" optional="false"/> |
| <attribute name="reserveOrderEnumId" type="String" mode="IN" optional="true"/> |
| <attribute name="sequenceId" type="Long" mode="IN" optional="true"/> |
| <attribute name="quantityNotReserved" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="priority" type="String" mode="IN" optional="true"/> |
| <attribute name="lotId" type="String" mode="IN" optional="true" /> |
| </service> |
| <service name="reserveProductInventoryByContainer" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="reserveProductInventory" auth="true"> |
| <description>Reserve Inventory for a Product By Container |
| If requireInventory is Y the quantity not reserved is returned, if N then a negative |
| availableToPromise will be used to track quantity ordered beyond what is in stock. |
| </description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="containerId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> |
| <attribute name="reservedDatetime" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="requireInventory" type="String" mode="IN" optional="false"/> |
| <attribute name="reserveOrderEnumId" type="String" mode="IN" optional="true"/> |
| <attribute name="sequenceId" type="Long" mode="IN" optional="true"/> |
| <attribute name="quantityNotReserved" type="BigDecimal" mode="OUT" optional="false"/> |
| </service> |
| <service name="reserveOrderItemInventory" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="reserveOrderItemInventory" auth="true"> |
| <description>Create OrderItemShipGrpInvRes or increment existing reserved quantity.</description> |
| <auto-attributes mode="IN" entity-name="OrderItemShipGrpInvRes" include="pk" optional="false"/> |
| <auto-attributes mode="IN" entity-name="OrderItemShipGrpInvRes" include="nonpk" optional="true"> |
| <exclude field-name="createdDatetime"/> |
| </auto-attributes> |
| <attribute name="priority" type="String" mode="IN" optional="true"/> |
| <override name="quantity" optional="false"/> |
| </service> |
| <service name="cancelOrderInventoryReservation" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="cancelOrderInventoryReservation" auth="true"> |
| <description> |
| Iterates through each OrderItemShipGrpInvRes on each OrderItem for the order |
| with the given orderId and cancels the reservation by changing the status |
| of the OrderItemShipGrpInvRes and incrementing the corresponding non-serialized |
| inventoryItem's availableToPromise quantity, or setting the status of the |
| corresponding serialized inventoryItem to available. |
| </description> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderItemSeqId" type="String" mode="IN" optional="true"/> |
| <attribute name="shipGroupSeqId" type="String" mode="IN" optional="true"/> |
| </service> |
| <service name="cancelOrderItemInvResQty" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="cancelOrderItemInvResQty" auth="true"> |
| <description>Cancel a specific quantity for an order item</description> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="shipGroupSeqId" type="String" mode="IN" optional="true"/> |
| <attribute name="cancelQuantity" type="BigDecimal" mode="IN" optional="true"/> |
| </service> |
| <service name="cancelOrderItemShipGrpInvRes" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryReserveServices.xml" invoke="cancelOrderItemShipGrpInvRes" auth="true"> |
| <description>Cancels an inventory reservation</description> |
| <auto-attributes entity-name="OrderItemShipGrpInvRes" include="pk" mode="IN" optional="false"/> |
| <attribute name="cancelQuantity" type="BigDecimal" mode="IN" optional="true"/> |
| </service> |
| |
| <service name="interfaceInventoryTransfer" engine="interface" location="" invoke=""> |
| <description>Inventory Transfer Interface</description> |
| <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="true"/> |
| <attribute name="locationSeqId" type="String" mode="IN" optional="true"/> |
| <attribute name="containerId" type="String" mode="IN" optional="true"/> |
| <attribute name="facilityIdTo" type="String" mode="IN" optional="true"/> |
| <attribute name="locationSeqIdTo" type="String" mode="IN" optional="true"/> |
| <attribute name="containerIdTo" type="String" mode="IN" optional="true"/> |
| <attribute name="itemIssuanceId" type="String" mode="IN" optional="true"/> |
| <attribute name="sendDate" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="receiveDate" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="comments" type="String" mode="IN" optional="true"/> |
| </service> |
| <service name="createInventoryTransfer" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryTransfer" auth="true"> |
| <description>Create an inventory transfer. Uses the prepareInventoryTransfer service; see comments there about transfer quantities and inventory items.</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <implements service="interfaceInventoryTransfer"/> |
| <attribute name="xferQty" type="BigDecimal" mode="IN" optional="false"/> |
| <attribute name="inventoryTransferId" type="String" mode="OUT" optional="false"/> |
| </service> |
| <service name="updateInventoryTransfer" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="updateInventoryTransfer" auth="true"> |
| <description>Update an inventory transfer record</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <implements service="interfaceInventoryTransfer"/> |
| <attribute name="inventoryTransferId" type="String" mode="IN" optional="false"/> |
| </service> |
| <service name="prepareInventoryTransfer" engine="java" |
| location="org.apache.ofbiz.product.inventory.InventoryServices" invoke="prepareInventoryTransfer"> |
| <description>Prepares inventory item for transfer. If the xferQty is less than quantityOnHandTotal of the inventory item, then the inventory |
| item is "split," and an new inventory item will be created with xferQty and used for the inventory transfer.</description> |
| <attribute name="inventoryItemId" type="String" mode="INOUT" optional="false"/> |
| <attribute name="xferQty" type="BigDecimal" mode="IN" optional="false"/> |
| </service> |
| <service name="completeInventoryTransfer" engine="java" |
| location="org.apache.ofbiz.product.inventory.InventoryServices" invoke="completeInventoryTransfer"> |
| <description>Completes the inventory transfer</description> |
| <attribute name="inventoryTransferId" type="String" mode="IN" optional="false"/> |
| <attribute name="receiveDate" type="Timestamp" mode="IN" optional="true"/> |
| </service> |
| <service name="cancelInventoryTransfer" engine="java" |
| location="org.apache.ofbiz.product.inventory.InventoryServices" invoke="cancelInventoryTransfer"> |
| <description>Cancel the inventory transfer</description> |
| <attribute name="inventoryTransferId" type="String" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="createInventoryTransfersForProduct" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryTransfersForProduct" auth="true"> |
| <description>Create inventory transfers for the given product and quantity. Return the units not available for transfers.</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="containerId" type="String" mode="IN" optional="true"/> |
| <attribute name="facilityIdTo" type="String" mode="IN" optional="false"/> |
| <attribute name="sendDate" type="Timestamp" mode="IN" optional="true"/> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> |
| <attribute name="reserveOrderEnumId" type="String" mode="IN" optional="true"/> |
| <attribute name="quantityNotTransferred" type="BigDecimal" mode="OUT" optional="false"/> |
| <attribute name="statusId" type="String" mode="IN" optional="true"/> |
| </service> |
| |
| <service name="issueImmediatelyFulfilledOrder" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryIssueServices.xml" invoke="issueImmediatelyFulfilledOrder" auth="false"> |
| <description> |
| Issues the Inventory for an Order that was Immediately Fulfilled. |
| Note that this skips the normal inventory reservation process, and the shipment process (no shipment is created). |
| </description> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| </service> |
| <service name="issueImmediatelyFulfilledOrderItem" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryIssueServices.xml" invoke="issueImmediatelyFulfilledOrderItem" auth="false"> |
| <description> |
| Issues the Inventory for an Order Item that was Immediately Fulfilled for more info see the issueImmediatelyFulfilledOrder service. |
| </description> |
| <attribute name="orderId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="orderHeader" type="org.apache.ofbiz.entity.GenericValue" mode="IN" optional="true"/> |
| <attribute name="orderItem" type="org.apache.ofbiz.entity.GenericValue" mode="IN" optional="true"/> |
| <attribute name="productStore" type="org.apache.ofbiz.entity.GenericValue" mode="IN" optional="true"/> |
| </service> |
| |
| <service name="createProductFacility" default-entity-name="ProductFacility" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create an ProductFacility</description> |
| <permission-service service-name="checkProductFacilityRelatedPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="updateProductFacility" default-entity-name="ProductFacility" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update an ProductFacility</description> |
| <permission-service service-name="checkProductFacilityRelatedPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteProductFacility" default-entity-name="ProductFacility" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete an ProductFacility</description> |
| <permission-service service-name="checkProductFacilityRelatedPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="createProductFacilityLocation" default-entity-name="ProductFacilityLocation" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create an ProductFacilityLocation</description> |
| <permission-service service-name="checkProductFacilityRelatedPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="updateProductFacilityLocation" default-entity-name="ProductFacilityLocation" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update an ProductFacilityLocation</description> |
| <permission-service service-name="checkProductFacilityRelatedPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteProductFacilityLocation" default-entity-name="ProductFacilityLocation" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete an ProductFacilityLocation</description> |
| <permission-service service-name="checkProductFacilityRelatedPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <!-- Product Storage Services --> |
| <service name="createFacility" default-entity-name="Facility" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a Facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="OUT" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="facilityTypeId" optional="false"/> |
| <override name="facilityName" optional="false"/> |
| <override name="ownerPartyId" optional="false"/> |
| </service> |
| <service name="updateFacility" default-entity-name="Facility" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a Facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteFacility" default-entity-name="Facility" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete a Facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <!-- Facility Attribute --> |
| <service name="createFacilityAttribute" default-entity-name="FacilityAttribute" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create Facility Attribute</description> |
| <auto-attributes mode="IN" entity-name="FacilityAttribute" include="pk" optional="false"/> |
| <auto-attributes mode="IN" entity-name="FacilityAttribute" include="nonpk" optional="true"/> |
| </service> |
| <service name="updateFacilityAttribute" default-entity-name="FacilityAttribute" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update Facility Attribute</description> |
| <auto-attributes mode="IN" entity-name="FacilityAttribute" include="pk" optional="false"/> |
| <auto-attributes mode="IN" entity-name="FacilityAttribute" include="nonpk" optional="true"/> |
| </service> |
| <service name="deleteFacilityAttribute" default-entity-name="FacilityAttribute" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete Facility Attribute</description> |
| <auto-attributes mode="IN" entity-name="FacilityAttribute" include="pk" optional="false"/> |
| </service> |
| |
| <service name="createFacilityLocation" default-entity-name="FacilityLocation" engine="simple" |
| location="component://product/minilang/product/storage/StorageServices.xml" invoke="createFacilityLocation" auth="true"> |
| <description>Create a Facility Location</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="locationSeqId" type="String" mode="OUT" optional="false"/> |
| </service> |
| <service name="updateFacilityLocation" default-entity-name="FacilityLocation" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a Facility Location</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteFacilityLocation" default-entity-name="FacilityLocation" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete a Facility Location</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="createFacilityGroup" default-entity-name="FacilityGroup" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a Facility Group</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="OUT" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="facilityGroupName" optional="false"/> |
| <override name="facilityGroupTypeId" optional="false"/> |
| </service> |
| <service name="updateFacilityGroup" default-entity-name="FacilityGroup" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a Facility Group</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteFacilityGroup" default-entity-name="FacilityGroup" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete a Facility Group</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <!-- Facility ContactMech services --> |
| <service name="createFacilityContactMech" engine="simple" debug="true" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="createFacilityContactMech" auth="true"> |
| <description>Create a FacilityContactMech</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="CREATE"/> |
| <auto-attributes entity-name="ContactMech" include="nonpk" mode="IN" optional="true"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <attribute name="contactMechPurposeTypeId" type="String" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="INOUT" optional="true"/> |
| </service> |
| <service name="updateFacilityContactMech" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="updateFacilityContactMech" auth="true"> |
| <description>Update a FacilityContactMech</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="UPDATE"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="INOUT" optional="false"/> |
| <attribute name="contactMechTypeId" type="String" mode="IN" optional="false"/> |
| <attribute name="infoString" type="String" mode="IN" optional="true"/> |
| <attribute name="newContactMechId" type="String" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteFacilityContactMech" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="deleteFacilityContactMech" auth="true"> |
| <description>Delete a FacilityContactMech</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="DELETE"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="contactMechId" type="String" mode="IN" optional="false"/> |
| </service> |
| <service name="createFacilityPostalAddress" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="createFacilityPostalAddress" auth="true"> |
| <description>Create a Postal Address</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="CREATE"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <auto-attributes entity-name="PostalAddress" include="nonpk" mode="IN" optional="true"/> |
| <attribute name="paymentMethodId" type="String" mode="IN" optional="true"/> |
| <attribute name="contactMechPurposeTypeId" type="String" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="OUT" optional="false"/> |
| <override name="address1" optional="false"/> |
| <override name="city" optional="false"/> |
| <override name="postalCode" optional="true"/> |
| </service> |
| <service name="updateFacilityPostalAddress" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="updateFacilityPostalAddress" auth="true"> |
| <description>Update a Postal Address</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="UPDATE"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <auto-attributes entity-name="PostalAddress" include="nonpk" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="INOUT" optional="false"/> |
| <attribute name="directions" type="String" mode="IN" optional="true"/> |
| </service> |
| <service name="createFacilityTelecomNumber" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="createFacilityTelecomNumber" auth="true"> |
| <description>Create a Telecommunications Number</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="CREATE"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <auto-attributes entity-name="TelecomNumber" include="nonpk" mode="IN" optional="true"/> |
| <attribute name="contactMechPurposeTypeId" type="String" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="OUT" optional="false"/> |
| </service> |
| <service name="updateFacilityTelecomNumber" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="updateFacilityTelecomNumber" auth="true"> |
| <description>Update a Telecommunications Number</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="UPDATE"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <auto-attributes entity-name="TelecomNumber" include="nonpk" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="INOUT" optional="false"/> |
| </service> |
| <service name="createFacilityEmailAddress" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="createFacilityEmailAddress" auth="true"> |
| <description>Create an Email Address</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="UPDATE"/> |
| <auto-attributes entity-name="ContactMech" include="nonpk" mode="IN" optional="true"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <attribute name="contactMechPurposeTypeId" type="String" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="INOUT" optional="true"/> |
| <attribute name="emailAddress" type="String" mode="IN" optional="false"/> |
| </service> |
| <service name="updateFacilityEmailAddress" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="updateFacilityEmailAddress" auth="true"> |
| <description>Update an Email Address</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="UPDATE"/> |
| <auto-attributes entity-name="FacilityContactMech" include="all" mode="IN" optional="true"/> |
| <attribute name="contactMechId" type="String" mode="INOUT" optional="false"/> |
| <attribute name="emailAddress" type="String" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="createFacilityContactMechPurpose" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="createFacilityContactMechPurpose"> |
| <description>Create a purpose for facility contact mech</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="CREATE"/> |
| <auto-attributes entity-name="FacilityContactMechPurpose" include="pk" mode="IN" optional="false"> |
| <exclude field-name="fromDate"/> |
| </auto-attributes> |
| <attribute name="fromDate" type="Timestamp" mode="OUT" optional="false"/> |
| </service> |
| <service name="deleteFacilityContactMechPurpose" engine="simple" |
| location="component://product/minilang/product/storage/FacilityContactMechServices.xml" invoke="deleteFacilityContactMechPurpose"> |
| <description>Delete a purpose for facility contact mech</description> |
| <permission-service service-name="facilityPermissionCheck" main-action="DELETE"/> |
| <auto-attributes entity-name="FacilityContactMechPurpose" include="pk" mode="IN" optional="false"/> |
| </service> |
| <!-- end cm --> |
| |
| <service name="addContactMechToFacility" default-entity-name="FacilityContactMech" engine="entity-auto" invoke="create" auth="true"> |
| <description>Add ContactMech To Facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| </service> |
| <service name="removeContactMechFromFacility" default-entity-name="FacilityContactMech" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Remove ContactMech From Facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| </service> |
| |
| <service name="addFacilityToGroup" default-entity-name="FacilityGroupMember" engine="entity-auto" invoke="create" auth="true"> |
| <description>Add Facility To FacilityGroup</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="fromDate" optional="true"/> |
| </service> |
| <service name="updateFacilityToGroup" default-entity-name="FacilityGroupMember" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update Facility -> Group Member</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="removeFacilityFromGroup" default-entity-name="FacilityGroupMember" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Remove Facility From FacilityGroup</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| </service> |
| |
| <service name="addFacilityGroupToGroup" default-entity-name="FacilityGroupRollup" engine="entity-auto" invoke="create" auth="true"> |
| <description>Add FacilityGroup To FacilityGroup</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="fromDate" optional="true"/> |
| </service> |
| <service name="updateFacilityGroupToGroup" default-entity-name="FacilityGroupRollup" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update FacilityGroup To FacilityGroup Rollup</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="removeFacilityGroupFromGroup" default-entity-name="FacilityGroupRollup" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Remove FacilityGroup From FacilityGroup</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN"/> |
| </service> |
| |
| <service name="addPartyToFacility" default-entity-name="FacilityParty" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a FacilityParty record</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="fromDate" optional="true"/> |
| </service> |
| <service name="removePartyFromFacility" default-entity-name="FacilityParty" engine="simple" |
| location="component://product/minilang/product/storage/StorageServices.xml" invoke="removePartyFromFacility" auth="true"> |
| <description>Remove Party From Facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="addPartyToFacilityGroup" default-entity-name="FacilityGroupRole" engine="entity-auto" invoke="create" auth="true"> |
| <description>Add Party To FacilityGroup</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| <service name="removePartyFromFacilityGroup" default-entity-name="FacilityGroupRole" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Remove Party From FacilityGroup</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <service name="createFacilityContent" default-entity-name="FacilityContent" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a Facility Content</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="fromDate" optional="true"/> |
| </service> |
| <service name="deleteFacilityContent" default-entity-name="FacilityContent" engine="simple" |
| location="component://product/minilang/product/storage/StorageServices.xml" invoke="deleteFacilityContent" auth="true"> |
| <description>Delete Content From Facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <!-- Stock Move Services --> |
| <service name="findStockMovesNeeded" engine="simple" |
| location="component://product/minilang/product/inventory/StockMoveServices.xml" invoke="findStockMovesNeeded"> |
| <description> |
| Find all Stock Moves that need to be done. |
| This service differs from the inventory transfer services in that it does not require |
| sufficient availableToPromise to move the stock, in fact it is generally triggered because |
| some promised inventory is in a bulk location and needs to be moved to a pick location. |
| </description> |
| <permission-service service-name="facilityPermissionCheck" main-action="VIEW"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="moveByOisgirInfoList" type="List" mode="OUT" optional="true"/> |
| <attribute name="stockMoveHandled" type="Map" mode="OUT" optional="true"/> |
| <attribute name="warningMessageList" type="List" mode="OUT" optional="true"/> |
| </service> |
| <service name="findStockMovesRecommended" engine="simple" |
| location="component://product/minilang/product/inventory/StockMoveServices.xml" invoke="findStockMovesRecommended"> |
| <description> |
| Find all Stock Moves that should be done based on minimum quantities on each Pick/Primary ProductFacilityLocation. |
| </description> |
| <permission-service service-name="facilityPermissionCheck" main-action="VIEW"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="stockMoveHandled" type="Map" mode="IN" optional="true"/> |
| <attribute name="moveByPflInfoList" type="List" mode="OUT" optional="true"/> |
| <attribute name="warningMessageList" type="List" mode="OUT" optional="true"/> |
| </service> |
| <service name="processPhysicalStockMove" engine="simple" |
| location="component://product/minilang/product/inventory/StockMoveServices.xml" invoke="processPhysicalStockMove"> |
| <description> |
| Process a Physical Stock Move from one FacilityLocation to another, in the same Facility. |
| This service will not only move quantities from one InventoryItem to another but it will |
| also reassign any existing OrderItemShipGrpInvRes records to the new InventoryItem. |
| </description> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="locationSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="targetLocationSeqId" type="String" mode="IN" optional="false"/> |
| <attribute name="quantityMoved" type="BigDecimal" mode="IN" optional="false"/> |
| <attribute name="warningMessageList" type="List" mode="INOUT" optional="true"/> |
| </service> |
| <!-- Inventory Label Services --> |
| <service name="createInventoryItemLabelType" default-entity-name="InventoryItemLabelType" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create an InventoryItemLabelType</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="updateInventoryItemLabelType" default-entity-name="InventoryItemLabelType" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update an InventoryItemLabelType</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteInventoryItemLabelType" default-entity-name="InventoryItemLabelType" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete an InventoryItemLabelType</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| <service name="createInventoryItemLabel" default-entity-name="InventoryItemLabel" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create an InventoryItemLabel</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="inventoryItemLabelTypeId" optional="false"/> |
| </service> |
| <service name="updateInventoryItemLabel" default-entity-name="InventoryItemLabel" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update an InventoryItemLabel</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"> |
| <exclude field-name="inventoryItemLabelTypeId"/> |
| </auto-attributes> |
| </service> |
| <service name="deleteInventoryItemLabel" default-entity-name="InventoryItemLabel" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete an InventoryItemLabel</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| <service name="createInventoryItemLabelAppl" default-entity-name="InventoryItemLabelAppl" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createInventoryItemLabelAppl" auth="true"> |
| <description>Create an InventoryItemLabelAppl</description> |
| <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"> |
| <exclude field-name="inventoryItemLabelTypeId"/> <!-- The type is automatically retrieved from the inventoryItemLabel --> |
| </auto-attributes> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <override name="inventoryItemLabelId" optional="false"/> |
| </service> |
| <service name="updateInventoryItemLabelAppl" default-entity-name="InventoryItemLabelAppl" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update an InventoryItemLabelAppl</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"> |
| <exclude field-name="inventoryItemId"/> |
| </auto-attributes> |
| </service> |
| <service name="deleteInventoryItemLabelAppl" default-entity-name="InventoryItemLabelAppl" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete an InventoryItemLabelAppl</description> |
| <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| <service name="setOrderReservationPriority" engine="simple" invoke="setOrderReservationPriority" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" auth="true"> |
| <description>set order priority</description> |
| <attribute name="priority" mode="IN" type="String" optional="true"/> |
| <attribute name="orderId" mode="IN" type="String" optional="false"/> |
| </service> |
| <service name="findProductInventorylocations" engine="simple" |
| location="component://product/minilang/product/inventory/StockMoveServices.xml" invoke="findProductInventorylocations"> |
| <description>Find Product's inventory locations from facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="VIEW"/> |
| <attribute name="facilityId" type="String" mode="IN" optional="false"/> |
| <attribute name="productId" type="String" mode="IN" optional="false"/> |
| <attribute name="LocationList" type="List" mode="OUT" optional="true"/> |
| </service> |
| <service name="setLastInventoryCount" engine="simple" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="setLastInventoryCount"> |
| <description>Service which run as EECA (on InventoryItemDetail entity) and updates lastInventoryCount for products available in facility in ProductFacility entity</description> |
| <attribute name="inventoryItemId" mode="IN" type="String" optional="false"/> |
| </service> |
| <service name="createUpdateFacilityGeoPoint" engine="simple" default-entity-name="GeoPoint" |
| location="component://product/minilang/product/inventory/InventoryServices.xml" invoke="createUpdateFacilityGeoPoint"> |
| <description>Create or update GeoPoint assigned to facility</description> |
| <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> |
| <attribute name="facilityId" mode="IN" type="String"/> |
| <auto-attributes include="all" mode="IN" optional="true"/> |
| <override name="dataSourceId" optional="false"/> |
| <override name="latitude" optional="false"/> |
| <override name="longitude" optional="false"/> |
| </service> |
| <service name="createContainer" default-entity-name="Container" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a new Container Record</description> |
| <auto-attributes mode="INOUT" include="pk" optional="true"/> |
| <auto-attributes mode="IN" include="nonpk" optional="true"/> |
| </service> |
| <service name="updateContainer" default-entity-name="Container" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a Container</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteContainer" default-entity-name="Container" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete an existing Container Record</description> |
| <auto-attributes mode="IN" include="pk" optional="false"/> |
| </service> |
| <service name="createContainerType" default-entity-name="ContainerType" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a new ContainerType Record</description> |
| <auto-attributes mode="INOUT" include="pk" optional="true"/> |
| <auto-attributes mode="IN" include="nonpk" optional="true"/> |
| </service> |
| <service name="updateContainerType" default-entity-name="ContainerType" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a ContainerType</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteContainerType" default-entity-name="ContainerType" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete an existing ContainerType Record</description> |
| <auto-attributes mode="IN" include="pk" optional="false"/> |
| </service> |
| |
| <!-- FacilityGroupType services --> |
| <service name="createFacilityGroupType" default-entity-name="FacilityGroupType" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a FacilityGroupType</description> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <auto-attributes include="pk" mode="INOUT" optional="true"/> |
| </service> |
| <service name="updateFacilityGroupType" default-entity-name="FacilityGroupType" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a FacilityGroupType</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteFacilityGroupType" default-entity-name="FacilityGroupType" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete a FacilityGroupType</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <!-- FacilityTypeAttr services --> |
| <service name="createFacilityTypeAttr" default-entity-name="FacilityTypeAttr" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a FacilityTypeAttr</description> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <auto-attributes include="pk" mode="INOUT" optional="false"/> |
| </service> |
| <service name="updateFacilityTypeAttr" default-entity-name="FacilityTypeAttr" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a FacilityTypeAttr</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="removeFacilityTypeAttr" default-entity-name="FacilityTypeAttr" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Remove a FacilityTypeAttr</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| <!-- FacilityType services --> |
| <service name="createFacilityType" default-entity-name="FacilityType" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a FacilityType record</description> |
| <auto-attributes include="pk" mode="INOUT" optional="true"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="updateFacilityType" default-entity-name="FacilityType" engine="entity-auto" invoke="update" auth="true"> |
| <description>Update a FacilityType record</description> |
| <auto-attributes include="pk" mode="IN"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteFacilityType" default-entity-name="FacilityType" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete a FacilityType record</description> |
| <auto-attributes include="pk" mode="IN"/> |
| </service> |
| |
| <!-- FacilityCarrierShipment services --> |
| <service name="createFacilityCarrierShipment" default-entity-name="FacilityCarrierShipment" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a FacilityCarrierShipment record</description> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <auto-attributes include="pk" mode="INOUT" optional="false"/> |
| </service> |
| <service name="deleteFacilityCarrierShipment" default-entity-name="FacilityCarrierShipment" engine="entity-auto" invoke="delete" auth="true"> |
| <description>Delete a FacilityCarrierShipment record</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <!-- FacilityLocationGeoPoint services --> |
| <service name="createFacilityLocationGeoPoint" default-entity-name="FacilityLocationGeoPoint" engine="entity-auto" invoke="create" auth="true"> |
| <description>Create a FacilityLocationGeoPoint record</description> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| <auto-attributes include="pk" mode="INOUT" optional="false"/> |
| </service> |
| <service name="expireFacilityLocationGeoPoint" default-entity-name="FacilityLocationGeoPoint" engine="entity-auto" invoke="expire" auth="true"> |
| <description>Expire a FacilityLocationGeoPoint record</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| |
| <!-- InventoryItemType services --> |
| <service name="createInventoryItemType" engine="entity-auto" default-entity-name="InventoryItemType" invoke="create" auth="true"> |
| <description>Create InventoryItemType</description> |
| <auto-attributes include="pk" mode="INOUT" optional="true"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="updateInventoryItemType" engine="entity-auto" default-entity-name="InventoryItemType" invoke="update" auth="true"> |
| <description>Update InventoryItemType</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| <auto-attributes include="nonpk" mode="IN" optional="true"/> |
| </service> |
| <service name="deleteInventoryItemType" engine="entity-auto" default-entity-name="InventoryItemType" invoke="delete" auth="true"> |
| <description>Delete InventoryItemType</description> |
| <auto-attributes include="pk" mode="IN" optional="false"/> |
| </service> |
| </services> |
