Documentation Generator

This feature automatically generates comprehensive system reports, covering all entities and components. It also supports specific business-case reports based on your need.


Default Report

The Default Report offers insights into all system components. It contains two report types:

  • Default Report List: A detailed list of components offering key system insights, searchable by name.

  • Visualization Report: A comprehensive diagram that illustrate the interconnectivity and dependencies of all components.

Default Report List

The Default Report List provides a comprehensive overview of the global system.

  • System: Identifies the specific system to which each component belongs, clarifying its role in the infrastructure.

  • Component: Differentiates components by name and type, such as Azure function, C# code, or D365 object.

  • Number of calls: Shows how many access points a component has for different kind of events, highlighting interdependencies.

  • Number of triggers: Indicates the number of entry points a component has to other events, aiding in the assessment of system criticality and reliability.

  • Component Link: Provides direct links to components for quick reference and deeper investigation.

  • Source Code Link: Direct access to a component's source code for in-depth analysis.

Real-life Example:

  • System: Azure from the Golet.Ketion Project (Example Project)

  • Component: Azure Function named GoletHTTPFunction3

  • Number of calls: The GoletHttpFunction3 has two APICalls

  • Number of triggers: The Azure Function is triggered by one other component

  • Component Link: Click to access the component

  • Source: Click to view the source code of the component

Default Report Visualization

All component in the system are visualized in detailed diagrams, simplifying the understanding of component connectivity. The diagrams offer the flexibility to interchange components and events, enhancing clarity on specific system processes. For example, to focus on the account creation process, user can reorganize components and events in the Default Report or search for the specific component. Additional component information is accessible by clicking the "i" or “<>” icons.

Standard Default Report visualization

The standard default report provides a holistic overview, presenting a clear and informative snapshot of your system.

Specific Process Analysis

Refine analysis by adjusting and organizing components and events to focus solely on specific chosen processes.

Detailed Component Information

For in-depth details about a component, including its creation and modification timestamps, click on the "i" icon.

Differentiate between Components and Events

Glossar | Components: depicted as gray boxes, include entities like D365-Objects, Azure Functions, or C# entry points (e.g., Plugin, WebApi, ConsoleApp).

Glossar | Event: depicted as green boxes, include items such as Triggers or, in this example, HTTP calls.

Need help? Contact support