Using Inspector on NOUMENA Cloud
Inspector is the official tool to explore protocol data in an NPL Engine. It helps list and visualize data, discover bugs, analyze access rights, and bookmark protocols. This interactive tool provides a user-friendly interface to view and debug your NPL applications, making it easier to understand their behavior and troubleshoot issues.
Prerequisites
Before this track, you should have:
- Completed the Using your NPL application track
- Created an instance of a protocol
Setup
Inspector is a service provided on NOUMENA Cloud for all apps. It can be found under Services > Inspector.
Logging in
NPL Inspector requires the same IAM service as your NPL app. To log in, the credentials should be the same as those used to interact with your NPL application. Inspector will use your credentials to list the state of protocols to which you are a party, so make sure you have the necessary permissions to access the protocols you want to inspect.
Usage
Browsing Protocols
All protocols accessible to the application user are visible in the search view. The access management is performed by the NPL Engine, as it also is done for NPL API or Postgraphile queries. No admin special access or bypass is possible.
A protocol quick view can be opened by clicking on the chevron on the left, or on the row itself.
The protocol detail view can be accessed by clicking on the details button. The details view contains details about party claims, states, and fields.
Navigating Protocol Links
From the detail view, by clicking on a protocol reference, the detail view of the referenced protocol is opened as a second pane. This can be repeated multiple times. The side-by-side protocol view allows easy navigation in a protocol arborescence, for an easy and quick retrieval of information.
Searching Protocols
Protocols can be searched for by prototype name or by state. A search bar at the top also allows filtering for matches for protocol ID or prototype name.
Managing Protocol Collections
Protocols can be added to protocol collections with the bookmark star on each protocol row and in the protocol detail view.
Protocol collections can be created and managed in the collections menu. It can be opened from the left menu bar.
When multiple protocol collections exist, protocols can be added to each collection individually.
Coming Soon
Inspector is under continuous development, and we have a few features in mind. Let us know which ones you would want the earliest.
Action Mode
Enable the action mode to call permissions on protocols and see the changes in real time. Save the initial effort of developing your frontend with this actionable dashboard.
Protocol History
Visualize previous states and actions on specific protocol instances. Search for a previous state and bring debugging to the next level. Retrace user actions through different versions of logic and time.
Protocol Data Visualization
Improve the view of structs, collections, and parties for an even better and more intuitive protocol navigation.
Advanced Search
Retrieve protocols by field, party, or past action. All aspects of a protocol should help it become discoverable.
Your Favorite Feature
What more are you looking for? Tell us!