Skip to content

How-to guide

Evolve a type already in use

Evolve a type already in use

2 min

Goal: add a property without assuming historical records are compatible. Estimated duration: 20 minutes for a small test set. Access: edit the model and native demonstration instances.

Prepare the change

In a test workspace, use Client with instance CLI-001. Record the current definition and consumers: forms, source links, APIs and agents. Export the definition when available and retain sample values.

The proposed change is segment (optional Text). It neither renames an existing key nor immediately requires values missing from older customers.

1. Add the property

Open Client in the Modeler or Navigator. Add segment, its display label and a description explaining its meaning. Save and reopen the type to check persistence and constraints.

If a conflict occurs, read the current definition before reapplying changes. A silent save or closed panel does not prove server persistence.

2. Test old and new instances

Open CLI-001: a missing segment should remain understandable. Create CLI-002 with segment = SME. Reopen both records and compare values. Also test a form with an empty field.

For external records, inspect mapping and source data. Adding a type property does not automatically populate synchronized rows.

3. Check consumers

ConsumerCheck
FormVisible field with correct type and optional status
SourceDefined mapping or explicitly accepted absence
Published APIExisting reads preserved; new field interpreted according to contract
AgentMissing values stated, no invented segmentation

Before making segment required, plan historical data handling and test creation and updates. A new constraint is not an automatic data migration.

4. Retain or revert

Retain the change after these checks. To revert, restore the previous definition through available capabilities and inspect related values. Removing a property may make its values less accessible; it does not guarantee restoration or physical erasure.

Expect a change verified against old and new usage, with missing values identified. Consult Naming conventions before renaming and Instances before deletion.

Did this page help you achieve your goal?