Antylogic
DemoApp login

399 operational guides

Docs sections
DocsProduct catalogues
Device

How to edit an allergen

Update an existing organisation or location allergen for Harbor Demo Group or Harbor Soho by changing its name, description, colour and optional image while keeping existing product assignments unchanged.

In this article

Use this flow when catalogue managers need to maintain an allergen record that already exists in the Allergens tab. The edit changes the allergen's displayed details; products that already reference the allergen keep the same relationship and show the updated information after the save.

Antylogic honours the allergen owner scope. A location screen can show inherited organisation allergens, but saving uses the allergen's owner scope and system allergens remain read-only.

Before you start

  • You are signed in with Harbor Demo Group selected.
  • For location-level edits, Harbor Soho is selected as the active location.
  • An editable allergen exists in the Allergens tab or can be opened by direct route.
  • You have `catalog:manage` for the allergen owner scope. With only `catalog:view`, the detail can be opened in read-only mode.
  • To replace the image, file upload is available and you have an image file to upload.

Instructions

  1. 1.

    Open the Allergens tab

    Open catalogue management for Harbor Soho and select Allergens. Use the list to identify the allergen by name, colour or image, description and owner before opening it.

  2. 2.

    Open the allergen detail

    Open the allergen row. The detail screen loads the current name, description, colour and image. If the allergen is inherited from another scope, the app uses the allergen owner scope when saving.

  3. 3.

    Update the fields

    Change the name, description, colour or image. The name is required, the colour is saved as a normalised `#RRGGBB` value, and a replacement image is uploaded first before its file id is attached to the allergen.

  4. 4.

    Save the change

    Select Save. The app trims text fields, sends the update to the organisation or location endpoint for the owner scope, refreshes list and detail data, shows success feedback and returns to the Allergens tab.

Validations and limits

  • Saving requires `catalog:manage`; users with only `catalog:view` can open the detail in read-only mode.
  • System allergens and allergens outside the editable owner scope cannot be edited.
  • Name must contain non-blank text; the backend rejects a blank `name`.
  • Save remains disabled until there is a real change and the required fields are valid.
  • Invalid or empty colour values are normalised by the UI to `#98A2B3`; the backend trims the colour but no hexadecimal format validation was found in `UpdateAllergen`.
  • If image upload fails, the app shows an error and does not change the saved image reference.
  • The current screen does not expose `name_translations` or `description_translations`, although the API accepts them.
  • The inspected image field supports uploading or replacing an image, but does not show an explicit control to remove an existing image.
  • If `image_file_id` is sent, it must be a valid UUID for PostgreSQL storage.

Expected result

The allergen is updated in its owner scope, catalogue snapshots are preserved where needed, list and detail data refresh, and products that reference the allergen keep the same relationship while showing the updated details.

Related articles