Difference between revisions of "Realtime Messaging API"

From 3forge Documentation
Jump to navigation Jump to search
Tag: visualeditor
Tag: visualeditor-switched
Line 1: Line 1:
 
= AMI Backend Interface =
 
= AMI Backend Interface =
 +
 +
== Goal ==
 +
The 3Forge Application Monitoring Interface (AMI) provides applications with a simple mechanism for connecting to the 3Forge Relay. 3Forge AMI's consolidated GUI lets users:
 +
 +
* View the application's health statistics
 +
* Receive and manage objects though a simple workflow procedure
 +
* Interact with applications to call routines inside the application
 +
 +
== Conventions ==
 +
 +
* This document is written from the perspective of the application. "Outbound" is the application ''sending'' data, and "inbound" is the Application ''receiving'' data.
 +
* All key words are in a "<span style="font-family: courier new; color: red;">courier</span>" font.
 +
* Trailing text is indicated with an ellipses or "...".
 +
* Special ASCII chars are qualified inside parenthesis.
 +
* Brackets "[]" indicate optionally supplied data.
 +
* Examples are in <span style="color: blue;">blue</span>.

Revision as of 22:10, 15 March 2021

AMI Backend Interface

Goal

The 3Forge Application Monitoring Interface (AMI) provides applications with a simple mechanism for connecting to the 3Forge Relay. 3Forge AMI's consolidated GUI lets users:

  • View the application's health statistics
  • Receive and manage objects though a simple workflow procedure
  • Interact with applications to call routines inside the application

Conventions

  • This document is written from the perspective of the application. "Outbound" is the application sending data, and "inbound" is the Application receiving data.
  • All key words are in a "courier" font.
  • Trailing text is indicated with an ellipses or "...".
  • Special ASCII chars are qualified inside parenthesis.
  • Brackets "[]" indicate optionally supplied data.
  • Examples are in blue.