- 6 minutes to read

Add or manage Endpoint

Unlock the full potential of Nodinite Endpoints. This guide shows you how to add, manage, and optimize Endpoints using the Nodinite Web Client. Empower your team with self-service log views, documentation, and actionable insights for your system integration solutions.

What you’ll achieve by following this guide:

  • ✅ Effortless creation and management of Endpoints for all integration scenarios
  • ✅ Flexible documentation and metadata for every Endpoint
  • ✅ Rapid editing, filtering, sorting, and exporting for compliance and reporting
  • ✅ Context-aware governance and visibility for integrations, services, and more
  • ✅ Override the character encoding when a Message Type arrives differently on this Endpoint

The Nodinite Logging feature, using information from the Nodinite Log Events, automatically creates the Endpoints.

Add or manage Endpoint

Add a new Endpoint by clicking the Add Endpoint button.
Add Endpoint
Click the 'Add Endpoint' button to open the edit page for Endpoints.

The Add Endpoint page has more fields than fit on one screen. The top holds the name, description, web site, and URI, with the Custom Fields and Articles cards on the right:
Add Endpoint page, top part, with Name, Description, Web Site, and URI on the left, and the Custom Fields and Articles cards on the right (7.12)
The top of the Add Endpoint page.

Scroll down for Direction, Endpoint Type, Log Agent, Character encoding, Visual Type, and Custom Metadata:
Add Endpoint page, bottom part, with Direction, Endpoint Type, Log Agent, Character encoding, the uniqueness note, Visual Type, and Custom Metadata (7.12)
The bottom of the Add Endpoint page; Direction and Endpoint Type are required.

Edit any existing Endpoint by clicking the row in the overview.

Endpoint General tab, top part: Name, Description, Web Site, Tags, URI, and Direction (7.12)
The General tab of the Endpoint Contoso Orders In, with the Custom Fields and Articles cards on the right.

Endpoint General tab, bottom part: Endpoint Type, Log Agent, Character encoding, Visual Type, and Custom Metadata (7.12)
Further down, Character encoding is left on Inherit from the Message Type. At the bottom are Delete, Save, Save and close, and Close.

Icon Mandatory Field Description
Name Enter a user-friendly name
Description Add a user-friendly description
Web Site Add a link to external documentation or system
Tags Add Tags to label and find the Endpoint New 7.12
URI Specify the physical or logical address (Uniform Resource Identifier used for message exchange in your integration solution)
Direction Select the direction for the Endpoint from pre-defined options
Endpoint Type Select the type of Endpoint from pre-defined options
Log Agent Select the Log Agent that is the source of this Endpoint
Character encoding Character encoding of messages on this Endpoint; default Inherit from the Message Type New 7.11

Warning

Endpoints are unique by their Name, URI, Direction, Endpoint Type, and Log Agent. Changing any of these on an existing Endpoint might break the Log Views that use it.

Visual Type

Expand Visual Type to set how the Endpoint is drawn in diagrams. See Component Types.

Articles

New 7.12

The Articles card lists the Articles that document the Endpoint, such as connection details or a partner's onboarding guide. Click Edit on the card to choose them. See The Articles Card on Repository Entities.

Document a BizTalk Endpoint

New 7.12

An Endpoint of a BizTalk Log Agent has two actions, in the toolbar and in the row's Action menu on the Endpoints list. Both write documentation from the BizTalk configuration, with no AI:

  • Document this port writes or refreshes the port's Building Block, a Snippet that describes it, with no dialog.
  • Document the integration opens the route picker with the routes through this Endpoint ticked, to write one Integration Article. The direction is worked out from the port: a send port traces back to its sources, a receive location forward to its subscribers. If an Article already documents those routes, the picker opens on that Article, so you change it instead of writing a second one.

On the Endpoints list, With Selected › Document these ports (n) documents every selected BizTalk port at once. The actions are shown only to Administrators, when the installation has a Mapify product key.

Endpoint page of a BizTalk send port with Document this port and Document the integration in the toolbar (7.12)
The Articles card on the right lists the Articles that already document this Endpoint.

Running an action again doesn't create a duplicate; the page reports that the document is already up to date. See Document from the Repository.

Character encoding

A Message Type can arrive on different Endpoints in different encodings. For example, an order format is UTF-8 on the REST API but Windows-1252 from a legacy FTP drop. Use Character encoding to override the Message Type encoding for messages on this Endpoint only. New 7.11

Character encoding dropdown on the Endpoint edit page (7.11)
Pick an encoding to supersede the Message Type, or clear the field to return to Inherit from the Message Type.

  • Inherit from the Message Type (default, shown when the field is empty) – use the Character encoding set on each message's Message Type. Clear the field to return to this.
  • Any supported encoding, such as UTF-8 (with BOM), Windows-1252, EBCDIC (IBM037), or Base64 Decode into UTF-8 (without BOM) – use this encoding for every message on this Endpoint, whatever its Message Type.

The Endpoint setting is the third of four priorities. An encoding named in the XML declaration of the body, and an ExtendedProperties/1.0#Encoding context property on an individual Log Event, both win over it. See Character Encoding for the full priority order and every supported encoding.

You can also set the encoding from DevOps pipelines with the Web API.

Custom Metadata

Add Custom Metadata to your Endpoint to provide additional documentation and business context.
Custom Metadata
Custom Metadata enriches your Endpoint documentation and governance.

Nodinite presents Custom Metadata at the bottom of the page. Click Add Custom Metadata to add a field, and switch to Preview to see how it reads. See Add or manage Custom Metadata.

Custom Fields

Add Custom Fields to your Endpoint for flexible, reusable metadata.
Custom Fields
Custom Fields provide extra documentation and support for your Endpoint.

Services

View the list of Services associated with your Endpoint for complete integration context.

Advanced

Use the Advanced tab to manage BizTalk Server-specific settings. Only Administrators see it, and only on Endpoints of a BizTalk Server Log Agent:

  • Default Message Type on send port – Override pass-thru ports where the message type for non-XML messages would otherwise be:
    • Unparsed interchange
    • Serialized Interchange
  • Enable re-mapping of dynamic send ports – Use this when your static or dynamic send port (by code, such as in a custom pipeline) changes the type of port or address. Nodinite would otherwise miss tracked data since the expected configuration does not match.

Advanced
Advanced tab for BizTalk Server-specific Endpoint settings.

Statistics

Open the Statistics tab to see the perpetual traffic statistics for your selected Endpoint: the number of events per Message Type over time, and a list of every Message Type recorded on it. Pick a date range or check Include deleted. What the statistics show explains how to read them.

Statistics tab of an Endpoint with events per Message Type (7.12)
Traffic pattern and known Message Types on the selected Endpoint.

Next Steps

Add or manage Service
Add or manage Custom Field
Character Encoding
Add or manage Article
Document from the Repository
Manage Endpoints - delete, restore, and permanently delete Endpoints

Articles
Systems
Repository Model
Services
Custom Fields
Add or manage Message Type