Add or manage Custom Metadata
This guide teaches how to add or manage Custom Metadata fields part of the Nodinite Repository Model.
Add or manage Custom Metadata
Add a new Custom Metadata field by clicking on the Add Endpoint button.
Click on the 'Add Custom Metadata' button to open the edit page for Custom Metadata
You can also Edit an existing Custom Metadata field from the list in the overview
A Name is first required to create the new Custom Metadata field.
Enter a unique name for the Custom Metadata field
| Mandatory | Name | Description | |
|---|---|---|---|
| Name | The user-friendly name | ||
| Description | The user-friendly description | ||
| Web Site | Link to external documentation or system |
Relations
The Custom Metadata field also has a Data Type and associated context with other entities in the Repository Model.
Once you start adding entries to the Values list, you usually cannot change the Datatype, which possibly yields a loss of data. The conversion, in many cases, is impossible to perform by the system automatically.
Custom Metadata field (due to the simple fact that it is in use)
Example of scoping the Custom Metadata field.
Data Type
The Data Type determines what type of content you can set. The list of available Data Types is grows over time.
Select one of the data type plugins
The following datatypes exist:
| Name | Description | |
|---|---|---|
| Text Field | Single row text field | |
| Text Area | Multi row text field | |
| Markdown | The actual code renders as HTML in view mode | |
| Mermaid Diagram | A coded diagram that renders as an image, for examples, please visit: About mermaid | |
| Link | Hyperlink | |
| Select | Dropdown combobox with single select items | |
| Checkbox | Provides a list of checkboxes | |
| Table | Table with user-defined columns | |
| Attachment | Placeholder for any files |
Repository Types
To keep the Repository Model clean and user-friendly Custom Metadata fields can be associated with the context where they are intended to make sense. Nodinite is context-aware and will provide this information where it makes the end-users more aware and as a result, your documentation has more meaning.
| 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 End Points |
How to assign values for Custom Metadata fields
On every Nodinite Repository Model entity, where there is a Custom Metadata assigned, you can easily manage the values. For example, editing an Integration, scroll down on the page and you will find two tabs:
- Edit
- Preview
Some of the Custom Metadata fields are editable directly, the others that are more complex, have a modal where there is an editor with a preview section.
Click on the Edit button where one exists to open the modal:
This editor is available for:
- Articles
- Markdown
- Mermaid diagrams