November 13th 2024, Release Note: RME | Nutrition Reference Removed When Ingredient Nutrition Updated Via Import API

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: November 13th 2024

Nutrition reference removed when POST /ingredientnutrient is used

• Enabled by default? - Y
• Set up by customer admin? - N
• Enable via support ticket? - N
• Affects configuration or data? - Y
• Roles affected: If applicable

What's Changing?

When we send a POST request to /ingredientnutrient, if the ingredient has a reference to a public database, that reference will be removed. A new value for the specified nutrient will be imported, while the values for the other nutrients will remain unchanged.

Reason for the Change

Refine the ingredient nutrition reference information so that it is accurate when an ingredient is updated via the import API.

Customers Affected

Customers using the import API to update ingredient nutrition.

Release Note Info/Steps

When an ingredient has an existing 'nutrition database reference' (i.e. its nutrition is populated via importing data from the RME nutrition databases such as McCance and Widdowson) and the ingredient nutrition is subsequently updated via the import API, then the 'nutrition database reference' is removed from the ingredient.

Example

Send a POST request to /ingredientnutrient with Energy (kcal) = 222 in the payload.  If the ingredient has a reference to a nutrition database, that reference will be removed. A new value for Energy (kcal) will be imported, while the values for the other nutrients will remain unchanged.

Fig.1 - Before update via import API, the nutrition database reference is displayed on the ingredient Nutritional Values tab

Fig.2 - After update via import API, the nutrition database reference is removed on the ingredient nutritional values tab

Fig.3 - Nutrition updates are tracked in the ingredient audit history

POST/ingredients > Allow Ingredient Name Update When 'Supply Quantity' and/or 'Unit Size' is Read- Only 

• Enabled by default? - Y
• Set up by customer admin? - N
• Enable via support ticket? - N
• Affects configuration or data? - N
• Roles affected: If applicable

What's Changing?

Previously when Supply Quantity and/or Unit Size were read-only, the ingredient name and short name could not be updated via the request POST /ingredients. This has been changed to allow the update of ingredient name and short name when the 'read-only' setting is enabled for Supply Quantity and/or Unit Size.

Reason for the Change

Increased flexibility when updating ingredients via the request POST /ingredients.

Customers Affected

All customers using the request POST /ingredients to update ingredient name and short name.

Release Note Info/Steps

Please note the detailed criteria for the request to succeed.

Valid scenarios for ingredient update when Supply Qty or Unit Size or both are read-only

Scenario 1

When an ingredient is updated using POST /ingredients
and when Supply Quantity is read-only (or Unit Size is read-only or both are read-only)
and when Supply Quantity (or Unit Size or both, depending on GDB settings) is excluded from the payload
then the other ingredient fields including ingredient name and short name can be successfully updated (if their values pass validation)
and Supply Quantity (or Unit Size or both) will not be changed.

Scenario 2

When an ingredient is updated using POST /ingredients
and when Supply Quantity is read-only (or Unit Size is read-only or both are read-only)
and when Supply Quantity (or Unit Size or both) are populated as NULL in the payload then the other ingredient fields including ingredient name and short name can be successfully updated (if their values pass validation)
and Supply Quantity (or Unit Size or both) will not be changed.

Additional Resources 

See developer.fourth.com for detailed information on how to use the RME APIs.

Import API, request to POST /ingredients to update 'First Date Available to Order' Validation has been refined for Parent Ingredients

• Enabled by default? - Y
• Set up by customer admin? - N
• Enable via support ticket? - N
• Affects configuration or data? - N
• Roles affected: If applicable

What's Changing?

Validation has been refined for Parent Ingredients to allow an existing 'date in the past' to pass validation.

Reason for the Change

Increase ease of use when updating ingredients via POST /ingredients

Customers Affected

All customers using the request POST /ingredients to update 'First Date Available to Order'

Release Note Info/Steps

Validation for Create parent ingredient

If 'firstDelivery' date in payload is current or future date then the date passes validation

If 'firstDelivery' date in payload is past date then an error will be generated

Validation for Update parent ingredient

1.  Check if 'firstDelivery' date in payload is different from existing date

• If date is different from existing date
  • If date in payload is current or future date then the date passes validation
  • If date in payload is past then an error will be generated
• If date is the same as existing then ignore the date, do not generate an error

Additional Resources 

See developer.fourth.com for detailed information on how to use the RME APIs.

Technical Improvements

What's Changing?

Optimisations have been implemented to reduce the load on the SQL server.

Reason for the Change

The goal of these optimisations is to incrementally improve RME performance.

Customers Affected

All customers.