Code Studio — "mode" parameter: difference between Displayable, Editable and Saveable?

Liberty Create
1

We are currently reviewing Code Studio scripts with regard to the format parameter introduced in 24.2 for cs.search(), cs.save() and record.set().

The 24.2 release notes and the docs portal mention the three options — Displayable, Editable and Saveable — but do not explain what each mode does in practice or when each should be used. Could anyone clarify the practical difference between the three, in particular the Editable and Saveable modes?

2

Hi Salvi,

You can get a detailed summary in the docs section by asking “Libby” the AI assistant. Here is a summary.

  • Editable

    • The raw, unformatted value that the database stores.

    • Use this when you are writing the underlying data directly – e.g. a number, a date in ISO format, a reference ID.

    • If you omit the mode, the call defaults to editable.

  • Displayable

    • The value as it appears to a user in the UI – formatted for readability.

    • Examples: a date shown as “12 Oct 2026”, a currency shown as “£1,200.00”.

    • When you pass a displayable value, the system parses it back into the raw format before saving.

  • Saveable

    • A value that is already in the exact format the database expects.

    • Use this when you have already performed any required formatting or conversion and want to skip the parsing step.

    • It behaves like editable for storage, but signals that the value is ready to be persisted without further transformation.

I hope this helps :slight_smile: