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

Fa overview #2415

Merged
merged 19 commits into from
Jan 4, 2024
Merged
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: 6 additions & 2 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4022,10 +4022,12 @@ entries:
include_versions:
- "202311.0"
nested:
- title: Fulfillment App feature overview
url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html
- title: Fulfillment App overview
url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-overview.html
- title: Warehouse Picking feature overview
url: /docs/pbc/all/warehouse-management-system/unified-commerce/warehouse-picking-feature-overview.html
- title: Warehouse User Management feature overview
url: /docs/pbc/all/warehouse-management-system/unified-commerce/warehouse-user-management-feature-overview.html
- title: Install and upgrade
nested:
- title: Install features
Expand All @@ -4036,6 +4038,8 @@ entries:
url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html
- title: Warehouse User Management
url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html
- title: Set up Fulfillment App
url: /docs/pbc/all/warehouse-management-system/unified-commerce/set-up-fulfillment-app.html
- title: "Back Office: Assign and deassign warehouses from warehouse users"
url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html
- title: "Fulfillment App: Fulfill orders"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ originalArticleId: 0a38b991-f10c-4f6c-90db-247a62cda2e7
redirect_from:
- /docs/scos/dev/data-import/202212.0/data-export.html
- /docs/scos/dev/sdk/data-export.html
- /docs/scos/dev/data-export/202307.0/data-export.html
- /docs/scos/dev/data-export/202307.0/data-export-orders-.csv-files-format.html
related:
- title: Install the Sales Data Export feature
link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ The following table describes the states you can select for order items.
| Cancel | Select this state to cancel the order on the customer’s behalf. |
| Skip Timeout | Select this status to end the time period during which the customer can cancel the order. |
| Generate invoice | Select this state to generate the invoice and send it to the customer. If invoice BCC is configured for your project, the copy of the invoice will be sent to the specified email address as well. You can trigger the invoice-generate only for the whole order. Even if you selected just some of the order items, the invoice is generated for the whole order.|
| Picking list generation schedule | Select this state to generate a picklist. Available with the [Fulfillment App feature](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html). |
| Prepare for picking | Makes the picklist available in the Fulfillment App. Available with the [Fulfillment App feature](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html). |
| Picking list generation schedule | Select this state to generate a picklist. Available with the [Fulfillment App](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-overview.html). |
| Prepare for picking | Makes the picklist available in the Fulfillment App. Available with the [Fulfillment App](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-overview.html). |
| Ship | Select this state once the order is shipped.|
| Stock-update | Select this state when you update the number of available products of products in **Products&nbsp;<span aria-label="and then">></span> Availability**. |
| Close| Select this state when your customer has successfully received the ordered items and is satisfied with their quality.|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ You can set different states for your order by clicking the action buttons. The
| ORDER STATE | DESCRIPTION |
|---|---|
| Pay | Click this button once you receive the payment for the order from your customer. |
| Picking list generation schedule | Select this state to generate a picklist. Available with the [Fulfillment App feature](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html). |
| Prepare for picking | Makes the picklist available in the Fulfillment App. Available with the [Fulfillment App feature](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html). |
| Picking list generation schedule | Select this state to generate a picklist. Available with the [Fulfillment App](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-overview.html). |
| Prepare for picking | Makes the picklist available in the Fulfillment App. Available with the [Fulfillment App](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-overview.html). |
| Cancel | Click this button to cancel the order on the customer’s behalf. |
| Close | Click this button when your customer has successfully received the ordered items and is satisfied with their quality. |
| Refund | Click this button in case of a refund. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ This opens the **Users** page with the success message displayed. The created us
| LAST NAME | User's last name. |
| ASSIGNED GROUPS | User groups to assign this user to. User groups define what areas and actions the user will have access to. To learn how to create user groups, see [Create user groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html). |
| AGENT | Defines if this user is an [agent assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) |
| WAREHOUSE USER| Defines if this user works in a warehouse to [fulfill orders](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-feature-overview.html). |
| WAREHOUSE USER| Defines if this user works in a warehouse to [fulfill orders](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-overview.html). |
| INTERFACE LANGUAGE | Defines the interface language of the Back Office for this user. |
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ The following table describes the attributes you enter and select when editing u
| LAST NAME | User's last name. |
| ASSIGNED GROUPS | The user groups this user is assigned to. User groups define what areas and actions the user has access to. To learn how to create user groups, see [Create user groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html). |
| AGENT | Defines if this user is an [agent assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) |
| WAREHOUSE USER| Defines if this user works in a warehouse to [fulfill orders](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-feature-overview.html). |
| WAREHOUSE USER| Defines if this user works in a warehouse to [fulfill orders](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-overview.html). |
| INTERFACE LANGUAGE | Defines the interface language of the Back Office for this user. |
| STATUS | Defines if the user can access the Back Office. |
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Fulfillment App feature overview
title: Fulfillment App overview
description: Fulfillment App streamlines the process of fulfilling orders.
last_updated: Oct 3, 2023
template: concept-topic-template
---

The *Fulfillment App* feature streamlines the process of fulfilling orders by introducing the Fulfillment App and the warehouse user.
*Fulfillment App* streamlines the process of fulfilling orders.


## Warehouse user

A *warehouse user* is a person that works in one or more warehouses to fulfill orders. They are a regular Back Office user. However, they don't have access to the Back Office. Instead, they are using the Fulfillment App.
A *warehouse user* is a person that works in one or more warehouses to fulfill orders. They are a regular Back Office user. However, they don't have access to the Back Office. Instead, they are using Fulfillment App.

In the Back Office, to create a warehouse user, you need to select a respective option when [creating](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html) or [editing](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/edit-users.html) a regular Back Office user.

Expand Down Expand Up @@ -43,7 +43,7 @@ Warehouse allocation shouldn't be confused with the reservation process, meaning

## Warehouse picklists

A *warehouse picklist* is a document available in the Fulfillment App that contains a list of items to be picked and shipped to fulfill and order. It includes the following information:
A *warehouse picklist* is a document available in Fulfillment App that contains a list of items to be picked and shipped to fulfill and order. It includes the following information:
* Product name
* Product image
* Quantity to be picked
Expand Down Expand Up @@ -76,7 +76,7 @@ Picking is semi-automated and follows the steps:

## Fulfillment App state machine

The feature is shipped with exemplary picking subprocesses for the state machine. You can check them in the Back Office&nbsp;<span aria-label="and then">></span>**Administration**&nbsp;<span aria-label="and then">></span>**OMS**.
The Warehouse Picking feature is shipped with exemplary picking subprocesses for the state machine. You can check them in the Back Office&nbsp;<span aria-label="and then">></span>**Administration**&nbsp;<span aria-label="and then">></span>**OMS**.

| Demo Shop | Subprocess |
| - | - |
Expand All @@ -85,11 +85,11 @@ The feature is shipped with exemplary picking subprocesses for the state machine

## Push notifications

The Fulfillment App supports push notifications. This lets warehouse users receive new picklists without having to refresh the application.
Fulfillment App supports push notifications. This lets warehouse users receive new picklists without having to refresh the application.

## Offline mode

To reduce costs and improve flexibility, Fulfillment App support offline mode. Warehouse users can perform picking tasks when regardless of internet connectivity. Any changes performed in offline mode are synchronized when you get online. This is relevant for warehouses in remote areas or big warehouses that do not have full network coverage.
To reduce costs and improve flexibility, Fulfillment App support offline mode. Warehouse users can perform picking tasks even without internet connectivity. Any changes performed in offline mode are synchronized when they get online. This is relevant for warehouses in remote areas or big warehouses that do not have full network coverage.

The offline mode is enabled by the [Push Notification](/docs/pbc/all/miscellaneous/{{page.version}}/push-notification-feature-overview.html) feature.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Set up Fulfillment App
description: Learn how to install and configure Fulfillment App
last_updated: Nov 23, 2023
template: howto-guide-template
---

This document describes how to install Fulfillment App and connect it to your project.

## Install the required features

To enable the support of Fulfillment App in your project, install the following features:

| NAME | VERSION | INSTALLATION GUIDE |
|----------|------------------|--------------------|
| Warehouse picking | {{page.version}} | [Install the Warehouse picking feature](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html) |
| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html) |
| Warehouse picking + Product | {{page.version}} | [Install the Warehouse picking + Product feature](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html) |

## Install Fulfillment App

For instructions on installing Fulfillment App, see [Set up Oryx](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/set-up-oryx.html).

## Connect Fulfillment App

To connect Fulfillment App to your project using Glue API, set the URL of your Glue Backend API in the environment configuration:

```text
...
SCOS_BASE_URL={GLUE_BACKEND_API_URL}
...
```
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,22 @@ title: Warehouse Picking feature overview
description: General overview of the Warehouse Picking feature
last_updated: Oct 3, 2023
template: concept-topic-template
related:
- title: Fulfillment App overview
link: docs/pbc/all/warehouse-management-system/page.version/unified-commerce/fulfillment-app-overview.html
- title: Install the Warehouse Picking feature
link: docs/pbc/all/warehouse-management-system/page.version/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html
---


The *Warehouse Picking* feature adds the following:
* The *picking list* entity
* `picking-lists` and `picking-list-items` Glue API resources
* Support for [push notifications](/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.html)
* OMS example
* Picklist generation strategies
* OAuth
The *Warehouse Picking* feature enables [Fulfillment App](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-overview.html) by adding the following:

* The *picking list* entity.
* `picking-lists` and `picking-list-items` Glue API resources.
* Support for [push notifications](/docs/pbc/all/miscellaneous/{{page.version}}/push-notification-feature-overview.html).
* An OMS example.
* Picklist generation strategies.
* OAuth.


## Example of a picklist generation strategy
Expand All @@ -25,4 +30,4 @@ You can extend this strategy or create custom strategies on the project level. E

## Fulfillment App OAuth

Fulfillment App's early access OAuth authorization supports the Authorization Code Grant flow. The flow is customized to meet the needs of Fulfillment App.
Fulfillment App's early access OAuth supports the Authorization Code Grant flow. The flow is customized to meet the needs of Fulfillment App.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Warehouse User Management feature overview
description: General overview of the Warehouse User Management feature
last_updated: Nov 23, 2023
template: concept-topic-template
related:
- title: Fulfillment App overview
link: docs/pbc/all/warehouse-management-system/page.version/unified-commerce/fulfillment-app-overview.html
- title: Install the Warehouse User Management feature
link: docs/pbc/all/warehouse-management-system/page.version/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html
---

The *Warehouse User Management* feature enables [Fulfillment App](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app-overview.html) by providing all the functionalities for creating and managing warehouse users.


## Warehouse user and warehouse assignment

Back Office users can create warehouse users and assign warehouses to them.

## Warehouse Glue API resources

Using the `warehouse-tokens` Backend Glue API, warehouse users can log in to fulfill orders. This feature provides only the authorization capability.

Using the `warehouse-user-assignments` Backend Glue API, Back Office users can assign and deassign warehouses from warehouse users.
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,6 @@ cd composable-frontend && \
npm i
```


2. Optional: To install [Fulfillment App](/docs/pbc/all/warehouse-management-system/{{site.version}}/unified-commerce/fulfillment-app-feature-overview.html) instead of Composable Storefront, checkout the `fulfillment` branch from the boilerplate:

```shell
git checkout fulfillment
```

{% info_block infoBox "Fulfillment App" %}

Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync.

{% endinfo_block %}


2. Run the application:

```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ redirect_from:
- /docs/scos/dev/front-end-development/202311.0/oryx/set-up-oryx.html
---

This document describes how to set up an environment for developing in the Oryx framework. We provide a [boilerplate project](https://github.com/spryker/oryx-starter) that helps you quickstart the development. It contains minimum dependencies and configuration to install a standard Oryx application.
This document describes how to set up an environment for developing in the Oryx framework. We provide a [boilerplate project](https://github.com/spryker/composable-frontend) that helps you quickstart the development. It contains minimum dependencies and configuration to install a standard Oryx application.

## Prerequisites

Expand All @@ -16,14 +16,28 @@ This document describes how to set up an environment for developing in the Oryx

## Install Oryx with the boilerplate project

1. Download the boilerplate project and install dependencies:
1. Clone the boilerplate project and install dependencies.

```shell
git clone https://github.com/spryker/oryx-starter && \
cd oryx-starter && \
git clone https://github.com/spryker/composable-frontend && \
cd composable-frontend && \
npm i
```


2. Optional: To install [Fulfillment App](/docs/pbc/all/warehouse-management-system/{{site.version}}/unified-commerce/fulfillment-app-overview.html) instead of Composable Storefront, checkout the `fulfillment` branch from the boilerplate:

```shell
git checkout fulfillment
```

{% info_block infoBox "Fulfillment App" %}

Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync.

{% endinfo_block %}


2. Run the application:

```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/scos/user/intro-to-spryker/docs-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In November 2023, we have added and updated the following pages:

### New pages

- [Fulfillment App feature overview](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html).
- [Fulfillment App overview](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-overview.html).
- [Warehouse Picking feature overview](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.html).
- [Assign and deassign warehouses from warehouse users](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html): Learn how to assign and deasign warehouses from warehouse users in the Back Office.
- [Fulfillment App: Fulfill orders](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-fulfill-orders.html).
Expand Down
Loading
Loading