LanguageServerRobot Monitoring application
The TypeCobol.LanguageServer.Robot.Monitor is a WPF Graphical User Interface application, that is used to monitor TypeCobol.LanguageServerRobot application (LSR).
The application can be executed as a standalone application, for instance for replaying scripts, or displaying script. But its is intended to be launched by the LSR application itself using the -m or --monitoring option See: LanguageServerRobot User guide.
The Graphical User Interface of the monitor looks like this and its composed with the following parts:
- A menu bar
- A session, documents and scenarios(scripts) explorer.
- A Scenario attributes visualizer panel.
- An output view which displays all session messages exchanged betwwen the client and the server "via" LSR.
The menu bar provides the following menus:
- The File menu
- The View menu
- The Test Menu
Following paragraphs will describe all menus.
The File menu provides the following commands.
| Command | Description |
|---|---|
| Setting... | Opens the preferences setting dialog box |
| Quit | Quit the application |
The command displays the preferences setting dialog box.
The Preferences setting dialog has the following properties:
| Property | Description |
|---|---|
| Server Path | This property value is the location directory where the server application is installed on your machine. |
| LSR path | This property value is the location directory where the TypeCobol.LanguageServerRobot.exe is installed on your machine |
| Script Repository path | This propery value is the directory where session and script files are stored. |
| LSR Replay arguments | This property value is the Template arguments passed to the TYPECOBOL.LanguageServer.exe application. So : {0} will be set to the "Server Path" property value. {1} will be given the file path value of the script to be replayed. {2} will be given the server specific options value. |
| Batch Template | This property is the Template for the command batch generated in order to replay a created script by using a dos command line. |
| Mail Receiver | The email address to forward scenario report. |
| Smtp Server | The Smtp Server. |
| Smtp Port | The Smtp port. |
This command allows to quit the monitoring application.
The View menu provides the following commands.
| Command | Description |
|---|---|
| Output | Shows or Hides the output view |
This command allows to show or to hide the output view its a toggle action.
The Test menu provides the following commands.
| Command | Description |
|---|---|
| Play scenario | This command allows to load and to replay a scenario file |
| Play scenario with confirmation | This command allows to load and to prompt the user for replaying a scenario file |
| Display scenario... | This command allows to load and to display in a praphical view a scenario file |
This command allows to load and to replay a scenario file. The following actions are performed:
-
The open file dialog box is opened to select the scenario file.
-
Once the scenario file has been opened, a console Windows is opened to show the output of the scenario being executed.
-
At the end of the execution, a graphical dialog is displayed to show the result of the scenario replay.
This command allows to load and to replay a scenario file. The execution actions are the same than in the Play scenario command, except that the user is prompted to start the execution of the scenario.
This command allows to load and to display in a graphical view the content of a scenario file. The following actions are performed:
-
The open file dialog box is opened to select the scenario file.
-
Once the scenario file has been opened, a graphical dialog box is displayed to view the content of the file, here is a sample screenshot:
The Document contextual menu provides the following commands.
| Command | Description |
|---|---|
| Start Scenario... | This command will start a scenario recording |
| Create Snapshot | This command create a scenario file from all messages exchanged in the document. |
| Create last save Snapshot... | This command create a scenario file from all messages exchanged in the document since the last 'textDocument/didSave' message. |
| Email last save Snapshot | Email the last save snapshot scenario |
This command starts a scenario recording, the following actions are performed:
- A dialog box informing that the scenario recording is started, the OK button will stop the recording and the Cancel button will cancel it.
- The user can execute any LSP action in the client, LSR will record the corresponding LSP message.
- On OK, the Save as dialog box is opened so that the user can specify the scenario file to be created.
- The scenario recorded scenario is then replayed by the server and saved in the selected file and the result displayed in a dialog box.
- The scenario item is added Under the document item.
This command allows so send an email containing the a scenario containing all message from the last save LSP message. See in the settings for email address and stmp configuration.
Scenario attributes can be visualized and edited.
To visualize scenario attributes, just clic on the corresponding item, the right panel will display the following informations:
- The scenario's name
- The scenario's file
- The scenario's decription
To Edit scenario attributes, just double clic on the corresponding item, the right panel will display the following informations:
- The scenario's name (editable)
- The scenario's file (not editable)
- The scenario's decription (editable)
- The save button to save modifications
- The cancel to cancel modifications.
- The save action will update the scenario attributes in the TreeView at the left.
