- 3 minutes to read

What is a Contract?

Get started now: How to Add or manage Contract user guide.

A Nodinite Contract represents one end of a communication chain and is, by definition, a member of a Nodinite System. It ties a Service to the Message Types and Endpoints it uses, through its Transport Contract.

Open the Contract Contoso ERP: Orders from its Service and follow it to its Message Type, animated walkthrough (7.12)
Animated walkthrough: from a Service to its Contract, and from the Contract to the Message Type it carries.

  1. Open the Service Contoso ERP Order Intake. Its Contracts card lists the Contract Contoso ERP: Orders.
  2. Open the Contract. The header shows the System Contoso ERP and the Service Contoso ERP Order Intake.
  3. The Transport Contract card names the Message Type and the Endpoint, Contoso Orders to ERP. The Resources card shows the Resource that monitors it.
  4. Click the Message Type to open it.

Find Contracts

Open Repository > Contracts to list every Contract, or Administration > Repo Management > Contracts to manage them. A Contract also opens from the Contracts card of its Service, as in the walkthrough above.

Tip

You should know about the SOA architecture to maximize the usage of the Nodinite Repository Model.

graph LR subgraph "Contract" roSystem(fal:fa-dice-d6 System) roContract(fal:fa-handshake Contract) roService(fal:fa-gear Service) roContract -.-> | 0..1 | roService roTCS(fal:fa-dot-circle TransportContracts) roMessageType(fal:fa-file MessageTypes) roEndpoint(fal:fa-sign-in Endpoints) roContract --> | 1..1 | roSystem roContract -.-> | 0..* | roTCS roTCS -.-> | 0..* | roMessageType roTCS-.-> | 0..* | roEndpoint roContract -.-> | 0..* | roCF(fal:fa-paint-roller Custom Fields) roContract -.-> | 0..* | roR(fal:fa-lightbulb-on Resources) end

A Contract belongs to one System and to at most one Service. Its Transport Contracts name the Message Types and Endpoints, and Custom Fields and Resources can be added to it.

A Nodinite Contract is similar to a Nodinite Service. The differences are:

  • A Contract is connected with at most one Service; the Service is optional.
  • A Contract belongs to the Integrations of its Service: its page lists all of them, for example INT001: Orders and INT1001: Contoso Orders to ERP.
  • A Contract can not be connected with other Contracts.
  • A Transport Contract without Message Types and Endpoints shows an Incomplete badge.
  • The System Parameter UseContracts must be set to true; otherwise, the Contracts feature is disabled.

Custom Metadata

As with all the entities of the Nodinite Repository Model, a Contract can have any number of Custom Metadata fields assigned.

Custom Fields

As with all the entities of the Nodinite Repository Model, a Contract can have any number of Custom Fields assigned.

Resources

New 6.1

The System Administrator can add one or more Resources from Monitoring and assign them to the Contract. The Contract then shows the most severe Monitoring State of its Resources in the Integration Landscape.

Add the Resource INT001: Receive Order from Service Bus to the Contract Contoso ERP: Orders, animated walkthrough (7.12)
Animated walkthrough: link a monitored Resource to a Contract.

  1. Edit the Contract, and click Edit on the Resources card.
  2. Filter on the Resource, here INT001: Receive Order from Service Bus, and tick it.
  3. Click Confirm and close, then Save. The Resource is listed on the Contract.

Contract Contoso ERP: Orders in the Integration Landscape with the Connection Error state of its Resource, next to its Service with OK (7.12)
In the Landscape, the Contract carries the state of its Resource: here Connection Error, while its Service is OK.

Read the Articles about a Contract

New 7.12 The button on a row counts the Articles that document the Contract. Click it to read an Article in a reader dialog without leaving the list, or click the icon next to a title to open it in a new tab instead. See Read an Article without leaving the page.

Change, tag, or delete Contracts

New 7.12

To change one Contract, see Add or manage Contract. If your Role allows it, tick Contracts in the list and open With Selected: Manage Tags sets Tags on every selected Contract (see Manage Tags for the dialog), and Delete (n) deletes them. Restore (n) and, for Administrators, Permanently Delete (n) count the deleted Contracts in the selection (check Include deleted first). New 7.12 Permanently Delete opens the same impact dialog as for Systems; see Permanently delete Systems.

With Selected menu on the Contracts list with Manage Tags and Delete (2) for two selected Contracts (7.12)
Two Contracts ticked, so With Selected offers Delete (2) next to Manage Tags.


Next Steps

Repository Model
UseContracts
What is a Tag?