Viewing the Structural Overview Diagram of an Agent

Developer mode lets GUI developers see a structural overview of an agent's managed object model. The overview includes agent type, object types, operations, parameters, return types, and developer notes. You can collapse and expand the branches of the overview diagram.

Prerequisites

Enable developer mode.

Procedure

  1. Navigate to an agent page.
    1. Navigate to the home page.
    2. In the Settings pane, click the Agents icon.
      The server GUI displays the Agent Management page.
    3. Click an agent row.
      An Open API Documentation button appears among the operations for the agent. This button is visible only when developer mode is enabled. It is visible to all users.
  2. Click the Open API Documentation operation button to view the agent's structural overview diagram.
  3. Use the diagram to do the following:
    • Collapse or expand subtrees of the diagram using the - or + icons.
    • Collapse or expand all the operations of an object type with one click using the - or + button to the right of that Object Type item in the diagram
    • Download a JSON file representing the information in the diagram by clicking the Export link to the right of the Agent Type item at the top of the diagram.
Contents
Search Results