This function allows you to view the status of the current
API messages in the 8MS application.
To access the API Message Status screen, select
the API Message Status link located in the Tools
section of the menu.
The screen is divided into three sections: Incoming Messages, Outgoing
Messages and a message detail display area. The following is the
Incoming Messages portion of the screen:
The following fields and buttons apply to the incoming message
portion of the screen:
-
The
button will re-access the database to update the list of messages.
-
The
button will delete the selected incoming message from the database.
-
The
button will delete all the incoming messages from the database.
-
The Limit field controls the number of messages
displayed in the list. By default, it is populated with the number
specified in the System Admin task. You can modify the number on
this screen by typing in the field provided and selecting the
Refresh button.
-
Checking the Unsolicited checkbox allows viewing of API requests to retrieve
messages for which the API client timed out, i.e. messages in which the API client
specified either a routeid or requestid to retrieve a response rather than generate a
new request.
The following is the outgoing messages portion of the screen:
The following fields and buttons apply to the outgoing
message portion of the screen:
-
The
button will re-access the database to update the list of messages.
-
The
button will delete the selected outgoing message from the database.
-
The
button will delete all the outgoing messages from the database.
-
The Limit field controls the number of messages displayed in
the list. By default, it is populated with the number specified in
the System Admin task. You can modify the number on this screen by
typing in the field provided and selecting the Refresh button.
To display the detail of either an incoming message or an outgoing message,
click anywhere on the message. The detail will be displayed as shown in
the following:
You can edit an incoming or outgoing API message by typing
in the text field provided in the detail. The
button will save any changes you have made.
Customization
There are preferences that may be set to change the behavior of
this screen.
Refer to
Customizing 8MS
for how to set User and Company Preferences and see
API Message Status Preferences for details
on customizing this screen.