May 15th 2024, Release Notes: RME | Import API, Ingredient 'Short Name' Added, Bulk Edit Recipes, PLU 'Read-only' for Batch Recipes

Summary

Select the release feature from the table below to be taken directly to that section of the release note.

Release date for all features: May 15th 2024

Import API, GET and POST /ingredients, Ingredient 'Short Name' Added

• Enabled by default? - Yes
• Set up by customer admin? - No
• Enable via support ticket? - No
• Affects configuration or data? - No
• Roles affected: - if applicable

What's Changing?

The ingredient 'Short Name' property has been added to the import API requests for POST /ingredients and GET /ingredients.

Reason for the Change

To expand the ingredient values that can be updated using the import API.

Customers Affected

Customers using the POST /ingredients request who also include the 'Short Name' property in the payload. 

If the Short Name property is not included in the payload, there will be no impact on existing 'Short Name' values. If the 'Short Name' property is included as an empty string, any existing 'Short Name' values will be changed to blank.

Also, all customers using GET /ingredients will see the ingredient 'Short Name' in the response.

Release Note Info/Steps

For detailed guidelines on using Fourth's APIs, please go to developer.fourth.com. 

Fig.1 - POST /ingredients, example of new 'Short Name' property in payload.  Please note that only a snippet of the payload is displayed

The data type for this property is 'String'.

Validation will check the global database setting 'max length' in the Short Name configuration. If the Short Name in the payload exceeds the 'max length' value, an error will be generated.

Fig. 2 - An ingredient 'Short Name on RME's main ingredient screen

Additional Resources

• Choosing between RME APIs | Fourth
• Recipe & Menu Engineering Import API Guide | Fourth

Bulk Edit Recipes, Refinement - PLU Read-Only for Batch Recipes 

• Enabled by default? - Yes
• Set up by customer admin? - No
• Enable via support ticket? - No
• Affects configuration or data? - No
• Roles affected: - if applicable

What's Changing?

In the Bulk Edit Recipes workflow, on Step 3, if a batch recipe is selected for editing, the 'Suggested PLU' value will be read-only.

Reason for the Change

To increase ease of use by preventing a field from being edited when the change won't be saved. 

Customers Affected

Customers using the Bulk Edit Recipes workflow with 'Batch' recipes enabled for their organisation.

Release Note Info/Steps

There are no steps required to see this change in the Bulk Edit Recipes workflow. The change will be applied automatically.

Similar to other fields relevant for Standard recipes but not Batch recipes, e.g., Pending Sell Price, the cell displaying the Batch recipe PLU will not be editable when selected.

Fig. 3 - Batch recipe 'Suggested PLU' is read-only, unlike Standard recipe PLU

Context for this change: Batch recipes do not have a PLU field on the main recipe UI but a PLU is automatically generated (this is the batch recipe's product key which is system-generated).  Before this change to make the PLU read-only in the Bulk Edit Recipes workflow, the PLU appeared to be editable but the change was not saved.