Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Lest Last version : 1.6 (released the 09th of august 2022)

...

Parameter

Description

Example

pages

Section Name

Level 1

List of sections.

Out of the box sections : sfs (ship from store), ckc (click & collect), ropis (reserve & collect).

To add a custom section, simply add it to the configuration and add its translation in the translation file.

pages:

  sfs:

    claim:

      condition: "_"

    pack:

      condition: "_"

  custom_section:

    custom_page:

      condition: "_"

      path: "url"

Level 2

List of pages to be displayed in the given section.

Out of the box pages that can be displayed: claim, pack, pack_scan, dispatch, bag, bag_scan, receive, collect, reserve, carry, picking, sorting, moving, consolidation, boxing, prepare_select

Extensions can be displayed: simply add a custom page key, add its translation in the translation file and indicate a path to recover the counters from.

 

condition

String that defines the conditions under which this counter will bring the alert to the foreground:

>with n being an integer (>= 0), as soon as the counter is higher than n

>  as soon as the counter is higher than its previous value.

_or (empty)  never

!= as soon as the counter has a different value from its previous value

<  as soon as the counter is lower than its previous value

pages:

  sfs:

    claim:

      condition: ">0"

    pack:

      condition: "_"

    dispatch:

      condition: ">"

  custom_section:

    custom_page:

      condition: "!="

      path: "url"

path

Custom url to recover counter from. Usually used when configuring extension custom pages.

pages:

  custom_section:

    custom_page:

      condition: "_"

      path: "url"

route

By default counters redirect to vi_url + "/" + key, which in most cases works fine.

For example, claim counter redirects to vi_url/claim. Nevertheless, a custom route can be configured using the route field, in which case the counter will redirect to vi_url + "/" + route.

In the example code, custom page will redirect to vi_url/custom/page

pages:

  sfs:

    claim:

      condition: ">0"

  custom_section:

    custom_page:

      condition: "_"

      path: "url"

      route: "custom/page"

...