Skip to content

docs: Configuration Map keys containing dots need maps.get - #18

Merged
pacmano1 merged 1 commit into
OpenIntegrationEngine:mainfrom
djkene70:docs/configuration-map-dotted-keys
Nov 13, 2026
Merged

pacmano1 merged 1 commit into
OpenIntegrationEngine:mainfrom
djkene70:docs/configuration-map-dotted-keys

Conversation

@djkene70

@djkene70 djkene70 commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Documentation only, no behaviour change. Follows up on OpenIntegrationEngine/engine#417, where @tonygermano pointed out that ${maps.get('key')} already reads a dotted key and asked for the documentation rather than a code change, once the wiki move had landed. It has, so here it is.

What it adds

A Keys that contain dots section to docs/engine/velocity_variable_replacement.md:

  • a . inside ${...} is Velocity property navigation, so ${db.warehouse.url} looks for an object db, not a key of that name;
  • use ${maps.get('db.warehouse.url')};
  • the caveat that goes with maps.get — it reads the first loaded map, so it returns the lowest-priority match;
  • the failure mode, because it is what a reader will be searching for: an unresolved reference stays in the field as literal text, so the error reads No suitable driver found for ${db.warehouse.url} and points at the connector rather than at the key.

It also links the ${maps.get('key')} row of the utility variable table to the new section.

Notes

  • No new file, so .vitepress/config.mts needs no change.
  • I did not add the log warning that was the other half of #417. That idea is dropped — it would be noise for anyone passing ${...} through on purpose.

🤖 Generated with Claude Code

A dot inside ${...} is Velocity property navigation, so ${db.warehouse.url}
never looks for a key of that name. Nothing says so today, and an unresolved
reference is passed through as literal text, so the failure surfaces at the
connector rather than at the key.

Adds a "Keys that contain dots" section to the Velocity page with the
${maps.get('key')} form, the priority caveat that goes with maps.get, and the
error text a reader is most likely to be searching for. Links the maps.get row
of the utility variable table to it.

Documentation only. No behaviour change.

Refs: OpenIntegrationEngine/engine#417

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Ken Moss <46053166+djkene70@users.noreply.github.com>
@djkene70

djkene70 commented Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Reopening to re-run the ECA check; the Eclipse account is now signed and linked.

@djkene70 djkene70 closed this Nov 6, 2026
@djkene70 djkene70 reopened this Nov 6, 2026

@tonygermano tonygermano left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate you following up here with the documentation improvement. I left an inline comment I'd like you to verify before we merge.

This is non-blocking, but you could also mention that using underscores (db_warehouse_url) or camel case (dbWarehouseUrl) can help avoid this problem.

@pacmano1
pacmano1 merged commit aefdfa9 into OpenIntegrationEngine:main Nov 13, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Configuration Map keys containing dots silently fail to expand in connector fields (Velocity property navigation

4 participants