diff --git a/data/SimpleScreensSetupData.xml b/data/SimpleScreensSetupData.xml index bedca7b5..67e4fe34 100644 --- a/data/SimpleScreensSetupData.xml +++ b/data/SimpleScreensSetupData.xml @@ -122,16 +122,24 @@ along with this software (see the LICENSE.md file). If not, see docIndex="100" docLocation="component://SimpleScreens/document/order/Order Roles and Parts.md"/> + + + + diff --git a/document/order/Create Purchase Order Button.md b/document/order/Create Purchase Order Button.md new file mode 100644 index 00000000..5227d85f --- /dev/null +++ b/document/order/Create Purchase Order Button.md @@ -0,0 +1,36 @@ +## Create Purchase Order Button + +### Fields Description + +#### Supplier + +The supplier represents vendor or vendor organization from which order is associated. + +#### Customer Org + +Customer Org represents the organization or the party through which the customer is associated. + +#### Facility + +The facility represents a facility that is associated with the customer organization. + +#### Ship Before Date + +Date before which shipment should be happening. + +#### Delivery Date + +The delivery date represents an estimated delivery date. + + +### Actions when Create button pressed + +#### Transitions + +When we click on the 'Create' button, the following transition will be called. +- SimpleScreens/screen/SimpleScreens/Order/FindOrder.xml: 'createOrder' + +#### Services + +In the 'createOrder' transition, the following service will be called. +- mantle.order.OrderServices.create#Order diff --git a/document/order/Create Sales Order.md b/document/order/Create Sales Order.md new file mode 100644 index 00000000..e14853a1 --- /dev/null +++ b/document/order/Create Sales Order.md @@ -0,0 +1,32 @@ +## Create Sales Order Button +​ +### Fields Description +​ +#### Store +A store has all the information needed to sell products. It is composed of a collections of catalogs, which are composed of product categories and products. +#### Vendor Org +The vendor (seller) of the items. +#### Facility +The Facility to fulfil the order from. +#### Customer +The customer (buyer) of the items. +#### Their Order Id +Purchase order id of the customer. +#### Priority +Numeric priority, 1 to 9 where 1 is highest priority and 9 is lowest priority (like a to do list), defaults to 5. +#### Ship Before Date +Date before which shipment should be happen. +#### Delivery Date +The Delivery represents estimated delivery date. +​ +​ +### Actions on Create button +​ +#### Transitions +The following transition will take place on clicking the 'Create' button: +- SimpleScreens/screen/SimpleScreens/Order/FindOrder.xml: 'createOrder' + + +#### Services +The following service will be called through the 'createOrder' transition: +- mantle.order.OrderServices.create#Order \ No newline at end of file diff --git a/document/order/Order Button Bar.md b/document/order/Order Button Bar.md new file mode 100644 index 00000000..b2dc7bba --- /dev/null +++ b/document/order/Order Button Bar.md @@ -0,0 +1,32 @@ +## Place/Place Warnings +Users can place the order using this button. If no information is missing in the order, then the user will see the 'Place' button else user will see 'Place Warnings' button. +On clicking the 'Place Warnings' button, a pop-up window will come containing warnings about the missing information in the order. + +Following are some examples of warnings: + +- Order has no items +- Part 01 has no customer +- Part 01 has no shipping address selected +- Part 01 has no shipment method selected + +However, the user can ignore the warnings and place the order by clicking on the 'Place Order Anyways' button. + +### Transitions +The following transition will take place on clicking the 'Place' or 'Place Order Anyway' button: +- SimpleScreens/screen/SimpleScreens/Order/FindOrder.xml: placeOrder + +### Services +The following service will be called through the 'placeOrder' transition: +- mantle.order.OrderServices.place#Order + +## Quote Requested +If a customer requested for a quote then we can this feature to change the status of the order to 'Quote Requested' status. + +### Transitions +The following transition will take place on clicking the 'Quote Requested' button: +- SimpleScreens/screen/SimpleScreens/Order/OrderDetail.xml: requestOrder + +### Services +The following service will be called through the 'requestOrder' transition: +- mantle.order.OrderServices.update#OrderStatus + diff --git a/document/shipment/New Outgoing Shipment.md b/document/shipment/New Outgoing Shipment.md new file mode 100644 index 00000000..0013919e --- /dev/null +++ b/document/shipment/New Outgoing Shipment.md @@ -0,0 +1,38 @@ +## New Outgoing Shipment Button + +If the 'From Party' is an internal organization, it is an outgoing shipment. +​ +### Fields Description +​ +#### Type + +It defines the type of outgoing shipment i.e: + +- Outgoing +- Purchase Return +- Sales Shipment + +#### Origin Facility + +The facility from the shipment was originated i.e., the starting location of the shipment. + +#### To Party + +Party Id of the user who will receive the shipment. + +#### Ready Date + +The ready date is the date on which the shipment is expected to be ready. + +### Actions on Create button + +#### Transitions + +The following transition will take place on clicking the 'Create' button: +- SimpleScreens/screen/SimpleScreens/Shipment/FindShipment.xml: 'createShipment' + + +#### Services + +The following service will be called through the 'createShipment' transition: +- mantle.shipment.ShipmentServices.create#Shipment \ No newline at end of file