Hi,
We had this discussion before, I made a proposition but w/o much feedback did
not work on it https://markmail.org/message/wvlaie5lro4w7pp4
Propositions so far seem good to me, looking forward for action,
Jacques
Le 17/09/2018 à 22:25, Gil Portenseigne a écrit :
Hello,
There is an old wiki page around entity deprecation
(https://cwiki.apache.org/confluence/display/OFBIZ/General+Entity+Overview#GeneralEntityOverview-DeprecatedEntities)
But I couldn't find any about service or others.
I agree with the need of deprecation process for
services/entity/methods. I met some deprecation examples with no date to
remove them (see oldXXXSequenceEnumId in PartyAcctgPreference entity,
that date from 2010).
So +1 for Michael suggestion ! And I agree with Taher process example !
Should we file a jira to populate developer-manual.adoc with those
guidelines and maintain another adoc for the deprecation changelog ?
Gil
Le mercredi 12 sept. 2018 à 15:42:23 (+0300), Taher Alkhateeb a écrit :
One way to make the transition smooth, is to do the following:
1- create a new service definition (the renamed service)
2- rename the implementation service (where the source code lives)
3- point both the old and new service definitions to the same new and
renamed implementation
4- Mark the old service definition as deprecated and specify _when_
you would intend to remove it.
On Wed, Sep 12, 2018 at 3:39 PM Taher Alkhateeb
<[email protected]> wrote:
+1 to Michael's suggestion. We are changing core services in core applications.
On Wed, Sep 12, 2018 at 3:22 PM Michael Brohl <[email protected]> wrote:
Hi Jacques, all,
I think these renames are problematic for exitsing users who might use
these services in their productive environments.
We should agree upon a "deprecation period" where these changes are
announced but not implemented and implement them in the next major release.
We also need a proper documentation/changelog for these changes between
major releases to allow for easy migration. The changelog and/or
documentation should be part of the commit.
What do you and others think?
Regards,
Michael
Am 12.09.18 um 13:09 schrieb [email protected]:
Author: jleroux
Date: Wed Sep 12 11:09:50 2018
New Revision: 1840659
URL: http://svn.apache.org/viewvc?rev=1840659&view=rev
Log:
Improved: [Naming Convention] Change 'quickShipPurchaseOrder' to
'quickReceivePurchaseOrder'
(OFBIZ-10558)
We have the option of 'Quick Receive Purchase Order' from Order Overview screen.
In the feature, the request and service name is 'quickShipPurchaseOrder which
is confusing. Change the name to 'quickReceivePurchaseOrder'.
Thanks: Deepak Nigam for the patch and Suraj Khurana for review
Modified:
ofbiz/ofbiz-framework/trunk/applications/order/template/order/OrderShippingInfo.ftl
ofbiz/ofbiz-framework/trunk/applications/product/minilang/shipment/shipment/ShipmentServices.xml
ofbiz/ofbiz-framework/trunk/applications/product/servicedef/services_shipment.xml
ofbiz/ofbiz-framework/trunk/applications/product/webapp/facility/WEB-INF/controller.xml
Modified:
ofbiz/ofbiz-framework/trunk/applications/order/template/order/OrderShippingInfo.ftl
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/applications/order/template/order/OrderShippingInfo.ftl?rev=1840659&r1=1840658&r2=1840659&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/applications/order/template/order/OrderShippingInfo.ftl
(original)
+++
ofbiz/ofbiz-framework/trunk/applications/order/template/order/OrderShippingInfo.ftl
Wed Sep 12 11:09:50 2018
@@ -69,7 +69,7 @@ under the License.
<#if ownedFacilities?has_content>
<#if !allShipments?has_content>
<li>
- <form
action="/facility/control/quickShipPurchaseOrder?externalLoginKey=${externalLoginKey}"
method="post">
+ <form
action="/facility/control/quickReceivePurchaseOrder?externalLoginKey=${externalLoginKey}"
method="post">
<input type="hidden" name="initialSelected"
value="Y"/>
<input type="hidden" name="orderId"
value="${orderId}"/>
<#-- destination form
(/facility/control/ReceiveInventory) wants purchaseOrderId instead of orderId, so we
set it here as a workaround -->
@@ -83,7 +83,7 @@ under the License.
</form>
</li>
<li>
- <form name="receivePurchaseOrderForm"
action="/facility/control/quickShipPurchaseOrder?externalLoginKey=${externalLoginKey}"
method="post">
+ <form name="receivePurchaseOrderForm"
action="/facility/control/quickReceivePurchaseOrder?externalLoginKey=${externalLoginKey}"
method="post">
<input type="hidden" name="initialSelected" value="Y"/>
<input type="hidden" name="orderId"
value="${orderId}"/>
<input type="hidden" name="purchaseOrderId"
value="${orderId}"/>
Modified:
ofbiz/ofbiz-framework/trunk/applications/product/minilang/shipment/shipment/ShipmentServices.xml
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/applications/product/minilang/shipment/shipment/ShipmentServices.xml?rev=1840659&r1=1840658&r2=1840659&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/applications/product/minilang/shipment/shipment/ShipmentServices.xml
(original)
+++
ofbiz/ofbiz-framework/trunk/applications/product/minilang/shipment/shipment/ShipmentServices.xml
Wed Sep 12 11:09:50 2018
@@ -1359,12 +1359,12 @@ under the License.
</iterate>
</simple-method>
- <simple-method method-name="quickShipPurchaseOrder" short-description="Quick ships
an entire purchase order to a facility">
+ <simple-method method-name="quickReceivePurchaseOrder" short-description="Quick
receives an entire purchase order in a facility">
<entity-one entity-name="OrderHeader" value-field="orderHeader"/>
<entity-one entity-name="Facility" value-field="facility"/>
<call-simple-method method-name="getOrderItemShipGroupLists"/>
<call-simple-method
method-name="createShipmentForFacilityAndShipGroup"/>
- <log level="info" message="Finished quickShipPurchaseOrder for orderId
${parameters.orderId} and destination facilityId ${parameters.facilityId} shipment created
${shipmentIds}"/>
+ <log level="info" message="Finished quickReceivePurchaseOrder for orderId
${parameters.orderId} and destination facilityId ${parameters.facilityId} shipment created
${shipmentIds}"/>
<field-to-result field="shipmentIds" result-name="shipmentIds"/>
</simple-method>
Modified:
ofbiz/ofbiz-framework/trunk/applications/product/servicedef/services_shipment.xml
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/applications/product/servicedef/services_shipment.xml?rev=1840659&r1=1840658&r2=1840659&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/applications/product/servicedef/services_shipment.xml
(original)
+++
ofbiz/ofbiz-framework/trunk/applications/product/servicedef/services_shipment.xml
Wed Sep 12 11:09:50 2018
@@ -85,8 +85,8 @@ under the License.
<attribute name="setPackedOnly" type="String" mode="IN"
optional="true"/>
<attribute name="shipmentId" type="String" mode="OUT"
optional="false"/>
</service>
- <service name="quickShipPurchaseOrder" engine="simple"
- location="component://product/minilang/shipment/shipment/ShipmentServices.xml"
invoke="quickShipPurchaseOrder" auth="true">
+ <service name="quickReceivePurchaseOrder" engine="simple"
+ location="component://product/minilang/shipment/shipment/ShipmentServices.xml"
invoke="quickReceivePurchaseOrder" auth="true">
<description>The mirror of quickShipEntireOrder, this service
automatically creates shipments for an entire purchase order.
All order items on each ship group is created as a Shipment. All
items on a Shipment are automatically issued to a Package.
The shipment's status is first set to CREATED and then set as
SHIPPED. The facilityId is used to set the destinationFacilityId
Modified:
ofbiz/ofbiz-framework/trunk/applications/product/webapp/facility/WEB-INF/controller.xml
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/applications/product/webapp/facility/WEB-INF/controller.xml?rev=1840659&r1=1840658&r2=1840659&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/applications/product/webapp/facility/WEB-INF/controller.xml
(original)
+++
ofbiz/ofbiz-framework/trunk/applications/product/webapp/facility/WEB-INF/controller.xml
Wed Sep 12 11:09:50 2018
@@ -933,9 +933,9 @@ under the License.
<security https="true" auth="true"/>
<response name="success" type="view" value="QuickShipOrder"/>
</request-map>
- <request-map uri="quickShipPurchaseOrder">
+ <request-map uri="quickReceivePurchaseOrder">
<security https="true" auth="true"/>
- <event type="service" invoke="quickShipPurchaseOrder"/>
+ <event type="service" invoke="quickReceivePurchaseOrder"/>
<response name="success" type="view" value="ReceiveInventory"/>
<response name="error" type="view" value="ReceiveInventory"/>
</request-map>
