This service transition is used for simple workflows for services that require a quantity set; such as Coffee, Ice cubes, and Hot water.
When to Use
- When manually entering a quantity for a service
- When adjusting an existing service quantity
- When adding a new service and setting its initial quantity
- When the quantity needs to be recorded with remarks explaining the value
Contents:
Transition properties
SetQuantity transition screen
Product settings
There are no product settings for this transition.
Configuration string settings
The following ‘Configuration string' settings can be set on the transition in Service workflows.
All settings must be separated by a semi-colon ';'. If not specified the default settings apply.
| Configuration string | Type | Default | Description | Example |
|---|---|---|---|---|
| Quantity | Integer | Blank |
Sets the quantity for the service to a default amount that cannot be changed.
Note: Quantity can be changed via ‘Edit service’ |
Quantity=2;
|
| Description | String | Blank | Adds a description text below the quantity field, this can be used as user instruction. |
Description=Coffee is charged in whole liters only.;
|
| ShowServiceInternalRemarks | Boolean | True | Indicates if the Internal Remarks field is shown in the transition (default is to show). | |
| ShowServiceExternalRemarks | Boolean | True | Indicates if the External Remarks field is shown in the transition (default is to show). | |
| OnCancelSetQuantityToZero | Boolean | True |
Indicates if the service quantity should be set to 0 by default (checkbox ticked) when canceling a service. Possible values:
|
OnCancelSetQuantityToZero=False;
|
| OnCancelAddExternalRemark | String | *Cancelled* | Adds an external remark when the service is canceled. |
OnCancelAddExternalRemark=Cancelled with thanks;
|
What Happens When You Submit
In Edit Mode:
- The quantity is updated on the service
- If internal remarks were entered, they're saved
- If external remarks were entered, they're saved
- The service moves to the next workflow state
- An audit log entry is created
In Add Mode:
- A new orderline is created with the entered quantity
- Remarks are saved to the new service
- The service is added with the transition's next workflow state
- The order is recalculated
- An audit log entry is created
Important Notes
Default Remarks Visibility
Unlike most service transitions where remarks are hidden by default, SetQuantity shows BOTH internal and external remarks by default. This is because quantity changes often need documentation.
Single Service in Edit Mode
When editing existing services, only one service can be selected. However, when using as a start transition (add mode), it works without any selected services.
Quantity Section Always Shown
The quantity section is always displayed because ShowQuantitySection is overridden to return true. The ShowQuantity config setting cannot hide it.
Fixed Quantity Option
When Quantity=X is set in the config string, the quantity field becomes read-only and displays the fixed value. This is useful for services that always have a standard quantity.
Tips
- Use the Description setting to provide guidance on what quantity to enter
- The fixed Quantity setting is useful for standardized services
- Internal remarks are helpful for documenting why a quantity was set to a particular value
- External remarks appear on customer documents, so use them for customer-facing notes
Comments
0 comments
Please sign in to leave a comment.