You use Span.Eco.UIAllowed to control whether users can access a Span through the user interface; this setting is for modelers who expose some spans only through REST.
What Span.Eco.UIAllowed controls
Span.Eco.UIAllowed is a Boolean span setting.
- True (default) allows the span to be reached through the UI.
- False prevents a user from reaching the span through the UI.
This setting is commonly paired with Span.Eco.RestAllowed, which controls whether the span is available to the REST API.
Defaults
| Setting | Default | Purpose |
|---|---|---|
| Span.Eco.UIAllowed | True | Allows access to the span through the user interface. |
| Span.Eco.RestAllowed | True | Allows access to the span through the REST API. |
Choose UI and REST availability
Configure the two settings according to how the span is intended to be used.
| Span.Eco.UIAllowed | Span.Eco.RestAllowed | Result |
|---|---|---|
| True | True | The span is available through both the UI and REST API. |
| True | False | The span is available through the UI, but not through the REST API. |
| False | True | The span is intended for REST API access and is not reachable through the UI. |
| False | False | The span is available through neither the UI nor the REST API. |
Expose a REST-only span
Use this configuration when an integration needs to call a span through REST but users must not navigate to that span in the application UI.
- Select the span that provides the REST endpoint.
- Set Span.Eco.RestAllowed to True.
- Set Span.Eco.UIAllowed to False.
- Verify the REST call against the span and verify that the span cannot be reached through the UI.
For example, an integration span named OrderExport can have RestAllowed = True and UIAllowed = False. The integration can call the REST API for OrderExport, while application users do not access that span through the UI.
Important distinction
Span.Eco.UIAllowed controls UI reachability. Span.Eco.RestAllowed controls REST availability. Set both values deliberately when you publish REST services; setting one does not replace setting the other.
For the combined behavior and related configuration, see RestAllowed UIAllowed.