The Administration - System screen provides an overview of current:
The Application Caches window displays current memory use and statistics for select caches in OpenVPMS.
This is launched by clicking Caches in Administration - System.
The table displays:
|
The cache name. |
|
The number of elements currently in the cache. |
|
The maxium number of elements the cache can hold, before old elements are discarded. |
|
The cache use, expressed as a percentage. |
|
The number of times an element was in the cache when it was requested. |
|
The number of times an element was not in the cache when it was requested. |
|
An approximate calculation of the cache size. |
The buttons are:
|
Change the selected cache. |
|
Refreshes the statistics. |
|
Resets the Cache Hits and Cache Misses to zero. This can be used to help evaluate the effectiveness of a change to the Max Elements of a cache. |
|
Releases memory allocated to a cache. |
|
Close the window. |
The Edit button displayed a Change Cache window for the selected cache.
This displays the current maximum elements for the cache, and provides options to select a suggested value for the cache size, or enter a new one.
The cache size should be changed if:
Note that the suggested size does not take into account memory consumption.
The Diagnostics window supports viewing:
This can aid quick diagnosis of problems where access to the server or database is limited.
The buttons are:
|
Refresh the current view. |
|
Emails a snapshot of the system information. |
This tab displays:
|
The maximum amount of memory that the Java virtual machine will attempt to use. |
|
The amount of unused memory. |
|
The memory use, expressed as a percentage. |
|
The amount of memory currently available to the Java Virtual Machine. |
|
The amount of memory currently available to the Java Virtual Machine that is unused. |
This tab displays the result of the SQL statement:
SHOW ENGINE INNODB STATUS
If the message:
Access denied; you need (at least one of) the PROCESS privilege(s) for this operation
is displayed, it means that the MySQL user doesn't have permissions to execute the command.
This can be granted using the following SQL statement:
GRANT SELECT, PROCESS ON *.* TO 'openvpms'@'localhost';
Replace 'openvpms' and 'localhost' the actual database user name and host if they have been changed from their default values.
NOTE: this may not take effect until Tomcat has been restarted.
The Logs tab enables:
The buttons are:
|
Enables logging categories to be added.
|
|
Re-reads the log4j2.xml file in <TOMCAT-HOME>\webapps\openvpms\WEB-INF\classes and then apply the changes without having to restart Tomcat. |
See also Troubleshooting. |
The Document Locks tab displays the users that have locks on documents to prevent other users from overwriting their changes. These locks are created by OpenOffice when External Edit is used to edit a document.
Each row in the table displays:
Locks can be filtered by login name, user name or host.
The Delete button can be used to delete a lock that needs to be cleared. Normally the lock will be removed when the document has finished being edited.
OpenVPMS includes a firewall that can limit access to specific IP addresses.
This should be enabled where OpenVPMS is deployed on a publically accessible host with no or limited firewall support of its own.
The firewall only applies to OpenVPMS. It doen't restrict access to other applications that may be deployed on the web container.
If the web container is behind a proxy or load balancer, it needs to be configured to pass the client IP addresses through, otherwise OpenVPMS will see clients as coming from the proxy host. See Tomcat Configuration below, for instructions on how to do this for Tomcat.
The firewall is configured via Administration - System - Settings.
It provides the following options:
|
Determines where users can connect from. One of:
|
|
When selected, users connecting from outside the firewall will be required to use multifactor authentication. This only applies when:
|
|
The IP addresses that users can connect from. Only applicable if Access Type is not Unrestricted. An address may be specified as a single IP address (e.g. 192.12.33.3), or a range of addresses specified using CIDR notation e.g. (192.168.10.0/24). |
Use:
|
If OpenVPMS is already behind a firewall.
|
|
To restrict access to the listed IP addresses.
|
|
To restrict access to the listed IP addresses, but allow specific users to connect from anywhere. This can be used if access should be restricted to particular addresses, but:
Note that the Connect From Anywhere flag is only checked on login. To revoke access to a logged in user, untick their Connect From Anywhere flag and use Terminate Session to forcibly log them out. |
The firewall can also be configured from the command line using the toolbox firewall command.
It can take up to 5 minutes for changes to take effect.
Multifactor authentication can be via a one-time code sent to the user's preferred email address, or using a Time-based one-time password (TOTP). The latter can be more convenient, as the user simply enters a code displayed on their mobile device.
Time-based one-time passwords are configured per-user via the TOTP Authentication button in user preferences. This displays a QR code that can be scanned into apps that support TOTP.
The following apps can be used to manage Time-based one-time passwords:
A more comprehensive list can be found at this Wikipedia page.
If OpenVPMS is hosted behind a proxy or load balancer, Tomcat needs to be configured to pass the correct client IP addresses through.
This is done by adding a RemoteIpValve valve to Tomcat's server.xml. E.g., if the proxy/load balancer passes the address in the X-Forwarded-For header, it is simply a matter of adding the element to the <Host>.
<Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true"> <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log" suffix=".txt" pattern="%h %l %u %t "%r" %s %b" /> <Valve className="org.apache.catalina.valves.RemoteIpValve" remoteIpHeader="x-forwarded-for" protocolHeader="x-forwarded-proto" protocolHeaderHttpsValue="https"/> </Host>
The OpenOffice settings in Administration - System - Settings enable the OpenOffice configuration to be changed, and OpenOffice restarted.
This displays the:
|
The OpenOffice installation directory. |
|
The ports OpenOffice uses when it runs. |
|
The maximum number of tasks an OpenOffice process can execute before restarting. A value of 0 indicates processes will not restart. |
|
Indicates if OpenOffice is currently running. OpenOffice is started on demand, so will initially display No. Click Refresh to update the status if it has recently been restarted but this still indicates that it isn't running. |
The buttons are:
|
Displays a window to configure OpenOffice. |
|
Refreshes the display. |
|
Restarts OpenOffice. Any document generation and printing tasks will be terminated. |
|
Closes the settings window. |
The following OpenOffice properties can be configured:
|
The OpenOffice installation directory. |
|
A comma-separated list of ports to run OpenOffice on. To improve performance, multiple instances of OpenOffice can be run to support document generation and printing. E.g. to run two instances on ports 8100 and 8101, specify: 8100,8101 |
|
The maximum number of tasks an OpenOffice process can execute before restarting. A value of 0 indicates processes will not restart. Reliablity and stability can be improved by setting this to a non-zero value, although setting it too low will impact performance. |
The Plugins screen displays the status of the plugin support in OpenVPMS.
Each row in the table displays the plugin:
The buttons are as follows:
|
Start the selected plugin. |
|
Stop the selected plugin. |
|
Install a plugin. |
|
Uninstall the selected plugin. Only available for user installed plugins. |
|
Refresh the display. Any plugins that have been installed from the command line since OpenVPMS started will be deployed. |
|
Configure plugin support. This may be used to enable or disable all plugins. |
The Sessions tab displays current user sessions.
Each row in the table displays:
NOTE: this may be the address of a firewall or proxy, rather than the user's actual address.
Sessions can be filtered by login name, user name or host.
The buttons are:
|
Displays the System Settings window. |
|
Displays the Smart Flow Sheet status and enables the interface to be restarted. |
|
Displays the Application Caches window. |
|
Displays the Diagnostics window. |
Administratively terminates the selected session. The user will lose their current work, and may need to use their browser's Reload current page button to log back in again. |
The System Settings window provides administrative access to system settings.
It is launched by clicking the Settings button in Administration - System.
These include:
The Query tab provides support to configure system-wide query options.
These include:
|
Determines how queries by product names match the query criteria. One of:
Users should re-login after changing this setting. |
The Report tab provides support to configure system-wide report options.
These include:
|
Limits the maximum number of pages a JasperReport can produce.
REPORT-0013: Report 'My Report.jrxml' has been terminated
as it exceeded the maximum limit of 1,000 pages Note that this setting does not affect reports exported to CSV or XLS. |