Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #107

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions data/SimpleScreensSetupData.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Order/FindOrder.xml"
docIndex="110" docLocation="component://SimpleScreens/document/order/Order Status Reference.md"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Order/FindOrder.xml"
docIndex="120" docLocation="component://SimpleScreens/document/order/Create Purchase Order Button.md"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Order/FindOrder.xml"
docIndex="130" docLocation="component://SimpleScreens/document/order/Create Sales Order.md"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Order/OrderDetail.xml"
docIndex="100" docLocation="component://SimpleScreens/document/order/Order Roles and Parts.md"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Order/OrderDetail.xml"
docIndex="110" docLocation="component://SimpleScreens/document/order/Order Status Reference.md"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Order/OrderDetail.xml"
docIndex="120" docLocation="component://SimpleScreens/document/order/Order Button Bar.md"/>

<!-- Shipment -->
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Shipment/FindShipment.xml"
docIndex="100" docLocation="component://SimpleScreens/document/shipment/Shipment Status Reference.md"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Shipment/ShipmentDetail.xml"
docIndex="100" docLocation="component://SimpleScreens/document/shipment/Shipment Status Reference.md"/>
<moqui.screen.ScreenDocument screenLocation="component://SimpleScreens/screen/SimpleScreens/Shipment/FindShipment.xml"
docIndex="110" docLocation="component://SimpleScreens/document/shipment/New Outgoing Shipment.md"/>

<!-- ==================================================== -->
<!-- ========== Pre-configured form-list finds ========== -->
Expand Down
36 changes: 36 additions & 0 deletions document/order/Create Purchase Order Button.md
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions document/order/Create Sales Order.md
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions document/order/Order Button Bar.md
Original file line number Diff line number Diff line change
@@ -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

38 changes: 38 additions & 0 deletions document/shipment/New Outgoing Shipment.md
Original file line number Diff line number Diff line change
@@ -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