- 6 minutes to read

Add or manage Service

Unlock the full power of Nodinite by adding or managing a Service entity. This guide helps you:

  • ✅ Add, edit, and document services for complete integration clarity
  • ✅ Connect systems, endpoints, and message types for seamless mapping
  • ✅ Manage transport contracts and service direction for robust documentation
  • ✅ Leverage custom fields to tailor your repository to business needs

Adding the Service Contoso ERP Return Intake from Administration, Services: Name, Direction Receive, System Contoso ERP, then Save, ending on the saved Service with its Transport Contracts card, animated walkthrough (7.12)
Animated walkthrough: Add Service, fill in the mandatory Name and Direction, pick the System, and Save. Next, add its Transport Contracts.

This guide shows you how to add or manage a Nodinite Service entity.

Instructions

Add a new Service, or edit an existing one from the overview list. After you create a Service, include Message Types, Endpoints, System, and Custom Fields.
Add Service button (7.12)
The Add Service button lets you create a new Service.

Mandatory Fields

Enter a Name and pick a Direction (see Direction) to create the Service.
Add Service page with Name, Description, Web Site, Tags, Direction, and the System card on the left, and the Integrations, Transport Contracts, Custom Fields, Contracts, Resources, BPMs, and Articles cards on the right (7.12)
The Add Service page: the fields on the left, and a card per relation on the right.

The cards on the right show what the Service is connected to:

Card What it shows
Integrations The Integrations the Service is part of; Edit to change them
Transport Contracts The Transport Contracts of the Service (see Manage Transport Contracts)
Custom Fields Custom Fields values; Edit to change them
Contracts The Contracts that use the Service. Tick Include deleted to list deleted Contracts too
Resources The monitored Resources assigned to the Service; Edit to change them
BPMs The BPMs the Service appears in
Articles New 7.12 The Articles that document the Service; Edit to choose them (see The Articles Card on Repository Entities)

Optional fields

Add a Description and Web Site to make your Service more informative and user-friendly.

  • Description: Add a user-friendly description.
  • Web Site: Provide a quick link for users, such as a WIKI or SharePoint site with additional documentation.
  • Tags: New 7.12 Add Tags to label the Service. Find it later with Filter on Tag in the list, and tag many at once with With Selected > Manage Tags.
  • C4 Properties: Expand to set how the Service is drawn in C4 Diagrams, such as its container type and technology; see Repository Properties for C4 Diagramming.
  • Custom Metadata: Click Add Custom Metadata in the section at the bottom of the page to add Custom Metadata, and switch to Preview to see how it reads. See Add or manage Custom Metadata.

System

Specify the System (Source or Destination) for the Service. This setting ensures the Integration Landscape displays the correct symbols.

Type the name of the System. If it doesn't exist yet, Nodinite says so; click Quick Add System to create it with only its name set. Edit the System further in Add or manage System.
System field with a name that doesn't exist and the Quick Add System button (7.12)
System does not exist: click Quick Add System to add TheNewSystem as a new System.


Manage Transport Contracts

Read about the Transport Contract concept on this page before you proceed.

A Transport Contract is a log point for the Service: a set of Message Types and Endpoints. A Log Event always contains a Message Type and an Endpoint, and the match decides which Service it belongs to.

Click Edit on the Transport Contracts card to open the Transport Contracts dialog. On a new Service the list is empty; click Add to create a Transport Contract.
Transport Contracts dialog with no Transport Contracts and the Add button (7.12)
An empty list of Transport Contracts; Confirm keeps the dialog open, Confirm and close saves and closes it.

The editor has three tabs. Selected shows the name, description, and what you picked so far; its header counts the selected Message Types and Endpoints.
Transport Contract editor with the Selected tab, a required Name, Description, and empty Message Types and Endpoints lists (7.12)
Name is required; the Message Types and Endpoints lists fill as you tick entries on the other two tabs.

Enter a Name for the Transport Contract. This name helps you understand the relationship you are creating. You can change it later without disruption.

Message Types

Open the All Message Types tab and tick the expected Message Types. Tick several, for example historical and current Message Types. Type in the filter to narrow the list, and tick Include deleted to list deleted Message Types too.
All Message Types tab filtered on orders, with two Message Types ticked (7.12)
The Selected tab header counts the ticked Message Types.

Endpoints

Open the All Endpoints tab and tick the expected Endpoints. Narrow the list by text, Direction, Endpoint Type, or Log Agent, and tick Include deleted to list deleted Endpoints too. The list shows each Endpoint's URI, Endpoint Type, and Log Agent.
All Endpoints tab with filters for text, Direction, Endpoint Type, and Log Agent, and the Include deleted checkbox (7.12)
Filter the Endpoints, tick the ones the Service uses, then click Update.

Click Update to keep the Transport Contract, then Confirm and close in the dialog, and Save the Service. Each Transport Contract in the list has Edit and Delete; expand it to see its Message Types and Endpoints.

On the saved Service Contoso ERP Return Intake, Transport Contracts, Edit, Add, name Orders from the webshop, tick the Message Type Contoso.Webshop.Order/1.0 and the Endpoint Contoso Webshop Order API, Update, Confirm and close, and Save, animated walkthrough (7.12)
Animated walkthrough: one Transport Contract with one Message Type and one Endpoint. After Save, the card lists the contract with both.

See how the Service Connects

You don't draw relations between Services by hand. Nodinite derives them from what you document: the Service's System, Integrations, Transport Contracts, and the Message Types and Endpoints in them. Once the Service is saved, its toolbar has Mapify and Mermaid, which show those relations in Mapify or as a Mermaid diagram, with the Service in the center. The Add Service page doesn't have them yet.

  • Mermaid draws a static diagram in your choice of diagram types, ready to print, export, or copy as Mermaid source; see Mermaid Rendering. It opens at depth 1: the Service's System and its Transport Contracts. Increase traversal depth (>) adds the next level: the Message Types and Endpoints of the contracts, and the System's Integrations.
  • Mapify draws an interactive graph you can drag, zoom, and drill through, and can include deleted entities; it needs a Mapify license. See Mapify Rendering.

Mermaid dialog of the Service Contoso ERP Return Intake at depth 1 with Contoso ERP and the Transport Contract Orders from the webshop, then Increase traversal depth adds the System's Integrations, the Message Type, and the Endpoint, animated walkthrough (7.12)
Animated walkthrough: Mermaid, then one level more.

Both read the same current relations, so whatever you change on this page shows up the next time you open them.

Custom Fields

As part of the Repository Model, add Custom Fields to provide additional documentation about your Service.

Direction

Pick the Direction of your Service; it's mandatory. Choose from:

  • Receive
  • Send
  • Two way Receive
  • Two way Send
  • None
  • Unknown

Direction dropdown with Receive, Send, Two way Receive, Two way Send, None, and Unknown (7.12)
Each Direction has its own icon, used in lists and diagrams.

Next Steps