MPage Log Component
Overview
The MPage Log component offers several tabs that will help you develop and debug your MPage. In addition, if left in your code after deployment, it can be used by helpdesk staff to help identify errors and report them back to the MPage development team.
The video shown below demonstrates the MPage Log in action. Implementation instructions are provided below the video.
Usage Instructions
If you are using an unmodified MPage template, you have the activity log enabled. The activity log component is configured by a combination of setting the enableLog parameter to true in the setMaxInstances method of the MPageService and by adding the <mpage-log-component> to your app.html file.
Disabling the Activity Log
The MPage Developer GitHub templates are pre-configured with the activity log turned on. If you wish to disable the log, set the enableLog parameter to false in the setMaxInstances method of the MPageService. You can also optionally remove the <mpage-log-component> from app.html however this step is not needed.
this.mPage.setMaxInstances(2, false, 'CHART', false);
* We highly recommended that you keep the activity log enabled on your MPages as it is an invaluable tool in diagnosing production issues that may come up with your MPage. The log keeps the last 100 transactions in memory and clears older values as new ones are added to keep memory usage down. Training your helpdesk to have users open the log and send print screens will greatly reduce your debugging time.
Showing/Hide the Activity Log
Opening and closing the activity log is done by holding the CTRL and / buttons at the same time.
Once you have opened the log, you will have access to several views which are described immediately after the properties section of this document.
Properties
The MPage log component offers a single option parameter called properties that can be passed in your HTML. The properties object allows setting up preferences for your log including positioning, sizing and more. The table below describes the available properties.
| Property | Description | Data Type | Allowed Values | Default Value |
|---|---|---|---|---|
| debugRawMessage |
Returns the raw JSON data retrieved from CCL. This can slow your MPage down if large volumes of data are
being returned, however, it will give more testing data when you are having issues.
|
boolean | false, true | false |
| position | Assigns the default position of the log on the screen. Workflow components should always be set to 'inline' as multiple components on the same Workflow MPage will overlap the log on screen. | string | 'bottom', 'top', 'right', 'left', 'fullscreen', 'inline' | 'bottom' for Full MPages, 'inline' for Workflow Components |
| size | Assigns screen size percentage to use for the log display. | number | Any number between 25 and 100 | 25 |
Changing the Test Patient
You can assign a test patient if your MPage is a CHART LEVEL MPage and is running on a development machine through the Angular proxy.
To change the test patient, click on the patient name found in the right corner of the log. The first time you access this feature, the patient name will be called 'No Visit Selected'.
You will be presented with a patient search window. Find your patient, click the name and finally click the visit row to have your MPage refresh with a test patient.
From this point on, any CHART level MPage you work on with the Angular proxy will use this test patient until you decide to use these steps again to change patients.
Available Views
The MPage Log offers four views accessible from the tabs shown at the top of the log. Click the tab name to change to the view you wish to see.
Activity Log
The activity log is a realtime view of calls to CCL, error messages and any putLog messages you may call from your data services.
Activity is identified as Info, Payload, Error and Debug which can be filtered by using the checkbox prompts on screen. Debug messages will only show if you have the debugRawMessage property enabled.
Info messages are displayed in black text, Debug messages in gray and error messages display in red.
Payload log entries represent the calls made to CCL. Blue Payload entries show the request made to CCL while green entries show the completion of your CCL call. If a CCL error occurs, you will additionally see an error message in red.
You can test your Payload in CCL by clicking the DEBUG button shown on your payload entry in the log. Clicking this button creates a test file in the back-end with the name 1co_debug_{{ your prsnlId }}.json.
Once your test file has been created, you will see an Info log entry showing the name of the debug file as well as the node it was created on. From here, you can open a CCL back-end session on the appropriate node and run 1co5_mpage_test:group1 "MINE" go to see the JSON output of your script as well as any CCL error messages.
Alternatively, if another user is running the MPage, you can enter the filename on the node to test the CCL code (e.g. 1co5_mpage_test:group1 "MINE", "1co_debug_14308939.json" go).
Data Queues
The data queues tab displays information on the data queues you have assigned to your MPage. By default, there are two queues, however, you can assign more in your MPage when initializing the MPageService.
If a queue is currently running a CCL script, clicking on the instance name will show you the request that was sent to CCL. A timer also shows indicating the running time of the request.
Queues currently not running will show the output of the last execution to the queue.
Data Services
The data services tab gives you the ability to view all data loaded into the Clinical Office data services.
A list is provided on the left side of the screen listing the service names along with the number of rows of data retrieved. Clicking on the service name expands the view to see the entries available.
If you click on the entry name, the panel on the right hand side of the screen will show the content of the data service entry.
System
The system tab provides information about your environment, the current patient context and the current user.
