Skip to content
3 changes: 2 additions & 1 deletion docs/src/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@
** xref:running-timefold-solver/overview.adoc[Overview]
** xref:running-timefold-solver/service/overview.adoc[As a service]
*** xref:running-timefold-solver/service/rest-api.adoc[leveloffset=+1]
*** xref:running-timefold-solver/service/model-config-overrides.adoc[Model configuration overrides]
*** xref:running-timefold-solver/service/model-enrichment.adoc[leveloffset=+1]
*** xref:running-timefold-solver/service/constraint-overrides.adoc[Constraint weights]

*** xref:running-timefold-solver/service/demo-data.adoc[leveloffset=+1]
*** xref:running-timefold-solver/service/exposing-metrics.adoc[leveloffset=+1]
*** xref:running-timefold-solver/service/consumer-guide.adoc[Service consumer guide]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ If it's missing, double check that `handleSubscription` is set to `true` in the
* *Constraints show up by name in score analysis*: the score analysis breakdown should show your constraints under human-readable names, not raw identifiers.
This requires the richer constraint metadata described in xref:deploying-to-platform/model-metadata.adoc#_constraint_descriptions_and_groups[Constraint descriptions and groups].
* *Input and output metrics show up*: the dataset view should display the metrics you exposed, as described in xref:deploying-to-platform/metrics.adoc[Using metrics].
* *You can add a configuration profile*: add a new configuration profile in the UI and override one of your xref:running-timefold-solver/service/constraint-overrides.adoc[constraint weights], then confirm a re-solve picks up the new weight.
* *You can add a configuration profile*: add a new configuration profile in the UI and override one of your xref:running-timefold-solver/service/model-config-overrides.adoc[constraint weights], then confirm a re-solve picks up the new weight.
See xref:deploying-to-platform/model-metadata.adoc#_configuration_profiles[Configuration profiles] for the properties that define the default profile shipped with your model.

[sectnums!]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To give consumers a better score analysis and configuration profile experience,
* `ConstraintInfo(id, name, description, constraintGroup)`: `id` is the stable identifier of the constraint, `name` is the human-readable name shown in the UI, `description` explains the constraint's goal, and `constraintGroup` optionally assigns the constraint to a `ConstraintGroupInfo`.
* `ConstraintGroupInfo(id, name, description, icon, tags)`: groups related constraints under a shared category. `icon` accepts any icon name from https://tabler.io/icons[Tabler Icons], and `tags` are optional labels you can use to classify or filter groups.

Extending the `TimetableConstraintProvider` from xref:running-timefold-solver/service/constraint-overrides.adoc[Adjusting constraint weights] with names, descriptions, and a group:
Extending the `TimetableConstraintProvider` from xref:running-timefold-solver/service/model-config-overrides.adoc[Adjusting constraint weights] with names, descriptions, and a group:

.The ConstraintProvider class, with ConstraintInfo attached.
[tabs]
Expand Down Expand Up @@ -140,7 +140,7 @@ class TimetableConstraintProvider : ConstraintProvider {
--
====

The `id` you pass into `ConstraintInfo` is still the identifier used by `@ConstraintReference` in your `ModelConfigOverrides`, as described in xref:running-timefold-solver/service/constraint-overrides.adoc[Adjusting constraint weights].
The `id` you pass into `ConstraintInfo` is still the identifier used by `@ConstraintReference` in your `ModelConfigOverrides`, as described in xref:running-timefold-solver/service/model-config-overrides.adoc[Adjusting constraint weights].
The `name`, `description`, and `constraintGroup` are purely presentational: they are what the platform's score analysis view and configuration profile editor use to show your constraints to consumers, instead of falling back to the raw ID.

The UI groups constraints that don't specify a `constraintGroup` under a default group.
Expand Down Expand Up @@ -187,7 +187,7 @@ This profile is what consumers get out of the box, before they add any profile o
|===

Once your model is deployed, tenant users can add additional configuration profiles on top of this default directly in the platform UI, without you making any code changes.
A configuration profile is where per-request xref:running-timefold-solver/service/constraint-overrides.adoc[constraint weight overrides], thread count, memory, and termination limits are set for a specific use case.
A configuration profile is where per-request xref:running-timefold-solver/service/model-config-overrides.adoc[constraint weight overrides], thread count, memory, and termination limits are set for a specific use case.
See https://docs.timefold.ai/timefold-platform/latest/how-tos/configuration-parameters-and-profiles[Configuration parameters and profiles] for how tenant users manage profiles from the platform side.

[#_visualization]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ However, this class is also the output of the solution:

NOTE: The `getConstraintWeightOverrides()` method is required by the `SolverModel` interface (implemented by `AbstractSimpleModel`), and `setConstraintWeightOverrides()` is optional.
For now `getConstraintWeightOverrides()` is left as a stub — `none()` means no constraint weights can be overridden per request.
Configuring this properly is covered in the xref:running-timefold-solver/service/constraint-overrides.adoc#serviceWeightOverrides[constraint weights] section and is not part of this guide.
Configuring this properly is covered in the xref:running-timefold-solver/service/model-config-overrides.adoc#serviceWeightOverrides[constraint weights] section and is not part of this guide.

include::../shared/school-timetabling/_school-timetabling-solution-value-range-providers.adoc[leveloffset=+1]

Expand Down

This file was deleted.

Loading