Skip to content

Update message definitions docs for single-definition documents - #11877

Open
aimiliatheologimendix wants to merge 1 commit into
mendix:developmentfrom
aimiliatheologimendix:message-definitions-single-document
Open

Update message definitions docs for single-definition documents#11877
aimiliatheologimendix wants to merge 1 commit into
mendix:developmentfrom
aimiliatheologimendix:message-definitions-single-document

Conversation

@aimiliatheologimendix

Copy link
Copy Markdown
Contributor

In Studio Pro 11.15, message definitions are split into separate documents, so each document now contains a single message definition.

  • Update the menu path to Add other > Message definition
  • Remove the list-based Managing Message Definitions section
  • Move Generate mapping(s)... under the General tab
  • Remove the Name field, as the document name is now the definition name
  • Rename Filter to Search and match the Example Value column header
  • Update both screenshots to the new UI
  • Fix "a message definitions" to singular in Import Mapping Action

In Studio Pro 11, message definitions are split into separate documents,
so each document now contains a single message definition.

- Update the menu path to Add other > Message definition
- Remove the list-based Managing Message Definitions section
- Move Generate mapping(s)... under the General tab
- Remove the Name field, as the document name is now the definition name
- Rename Filter to Search and match the Example Value column header
- Update both screenshots to the new UI
- Fix "a message definitions" to singular in Import Mapping Action

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
### Input Content Type

If the import mapping is based on a [message definitions](/refguide/message-definitions/), it can import both XML and JSON. Select whether the input object contains XML or JSON.
If the import mapping is based on a [message definition](/refguide/message-definitions/), it can import both XML and JSON. Select whether the input object contains XML or JSON.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Since there is no collection document, do we need to remove the plural format in the ref guide link? message-definitions to message-definition

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

How will the UI appear in Studio Pro? When a user is adding one to their app (following right-click > Add other), does it appear as "Message defintion" or "Message defintions" in the menu? We suggest matching the UI. However, keep in mind that if we change the URL to /refguide/message-definitions/, this will need to be updated if the link is hard coded in Studio Pro.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

nope

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The new UI will show singular but since I know that changing URLs is a painful, my suggestion is to keep it as it is!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants