Add or manage Custom Metadata
Unlock the full power of Nodinite Custom Metadata. This guide shows you how to add, manage, and optimize metadata for every repository entity—empowering your team with structured documentation, governance, and actionable insights.
What you’ll achieve by following this guide:
- ✅ Effortless creation and management of Custom Metadata for all repository entities
- ✅ Flexible data types for every documentation need
- ✅ Context-aware scoping and governance for integrations, systems, services, and more
- ✅ Rapid editing, filtering, and exporting for compliance and reporting
Add or manage Custom Metadata
Add a new Custom Metadata field by clicking the Add Endpoint button.
Click the 'Add Custom Metadata' button to open the edit page for Custom Metadata.
You can also Edit any existing Custom Metadata field from the list in the overview.
Enter a unique Name to create the new Custom Metadata field.
Enter a unique name for the Custom Metadata field.
| Icon | Mandatory | Field | Description |
|---|---|---|---|
| Name | Enter a unique, user-friendly name | ||
| Description | Add an optional, user-friendly description | ||
| Web Site | Add an optional link to external documentation or systems |
Relations
You can scope a Custom Metadata field to limit which repository entities are available. Decide if each field should be optional or mandatory for governance. New 6.0
Here's an example of scoping the Custom Metadata field.
Important
Once you add entries to the Values list, you usually cannot change the Datatype. Changing it may cause data loss, and conversion is often impossible for the system to perform automatically.
Data Type
The Data Type defines what kind of content you can set for your Custom Metadata. Select the type that best fits your documentation and governance needs. Nodinite continues to add new data types to empower your integration landscape.
Select one of the data types.
| Icon | Reference | Description |
|---|---|---|
| Text Field | Store a single row of text. | |
| Text Area | Store multiple rows of text. | |
| Markdown | Write content in Markdown and render it as HTML. | |
| Mermaid Diagram | Create diagrams using Mermaid syntax and render them as images. | |
| Link | Add hyperlinks to external or internal resources. | |
| Select | Choose a single value from a dropdown list. | |
| Checkbox | Select one or more values using checkboxes. | |
| Table | Create a table with user-defined columns. | |
| Attachment | Upload and attach files to your metadata. |
Text Field
Store a single line of text, such as a name, code, or short description. Use this for concise metadata that does not require formatting.
Text Area
Store multiple lines of text for longer descriptions, notes, or instructions. Choose this when you need extra space for your metadata.
Markdown
Write rich content using Markdown syntax. Nodinite renders this as HTML, so you can add formatting, lists, links, and more for advanced documentation.
Mermaid Diagram
Create visual diagrams using Mermaid syntax. Nodinite automatically renders these diagrams as images, making it easy to visualize processes and relationships. Learn more about Mermaid.
Link
Add hyperlinks to external documentation, systems, or related resources. Help users quickly navigate to important information.
Select
Offer a dropdown list of single-select items. Use this for fields like SLA Level, where only one value should be chosen.
Checkbox
Allow users to select one or more values from a list. This is ideal for fields like Technical Contacts, where multiple selections are logical.
Table
Capture structured data with user-defined columns. Use this for tabular information, such as mappings or configuration lists.
Attachment
Upload and associate files (Word documents, images, zip files, etc.) with your metadata. Nodinite displays images directly in the Web Client and sends links in email alerts to conserve bandwidth.
Repository Types
Keep the Repository Model clean and user-friendly by associating Custom Metadata fields with the context where they make sense. Nodinite is context-aware and provides this information where it matters most, making your documentation more meaningful.
| Repository link | Description | |
|---|---|---|
| Integrations | Show Custom Metadata on Integrations | |
| Systems | Show Custom Metadata on Systems | |
| Services | Show Custom Metadata on Services | |
| Contracts | Show Custom Metadata on Contracts | |
| Message Types | Show Custom Metadata on Message Types | |
| Endpoints | Show Custom Metadata on Endpoints | |
| New 6.0 | Articles | Show Custom Metadata on Articles |
| New 6.1 | Resources | Show Custom Metadata on Resources |
| (Coming soon) | Domains | Show Custom Metadata on Domains |
| (Coming soon) | BPMs | Show Custom Metadata on BPMs |
How to assign values for Custom Metadata fields
You can easily manage values for Custom Metadata fields on every Nodinite Repository Model entity. For example, when you edit an Integration, scroll down to find two tabs:
- Edit
- Preview
Some Custom Metadata fields are directly editable. For more complex fields, use the modal editor with a preview section.
Edit tab for managing Custom Metadata values.
Click the Edit button to open the modal:
Editor with preview for advanced Custom Metadata fields.
You can use this editor for:
- Articles
- Markdown
- Mermaid diagrams - About mermaid