Server Management App
The Server Management App is a new feature introduced to MacPractice Build 12.11. In Builds 12.11 and higher, the Server Management App is the method in how we start the MacPractice Server, manage Server Processes, and restore server backups.
Setting up the Server Management App is required in Builds 12.11 and above.
In this article, we'll cover how to set up the Server Management App, how to access the SMA, and we'll cover the functionality available within the app.
If you have any questions that aren't answered in this article, please reach out to MacPractice Support and we'll be happy to assist you.
What is the Server Management App?
The Server Management App is a Web Application that is used to manage the processes and database for your MacPractice Server. By utilizing this App, a user will be able to start and restart the MacPractice Server and diagnose whether a process is properly running or not. The functionality of the App will be expanded over time, so please provide us your feedback!
What Benefits Will Users Receive?
Users on MacOS Catalina will no longer need to run the Catalina start up script!
Server start up times and restart times should be significantly faster.
A user without knowledge of the Activity Monitor will still be able to ascertain whether their MacPractice Server has all processes running.
More to come!
Getting Started
You will need to have your Database Name handy prior to updating to 12.11 or higher in order to complete the Server Management App setup.
The Server Management App can be accessed in three different ways. You must be on the same local network as the MP Server in order to access the Server Management App. You cannot utilize a VPN to bypass this restriction as a security measure.
If the MacPractice software is not running, you can open a web browser and navigate to the following URL:
https://localhost:26700If you've started MacPractice but are at the login prompt, you can access the Server App by clicking the gear icon on the MacPractice Login Window.
If the MacPractice software is running, you can access the App via the MacPractice Menu:
Creating a Server Administrator User
The first time you access the App, you'll be prompted to create a Server Administrator User. This is not the same as a MacPractice User. Currently, there can only be one Server Administrator User. You'll want to ensure you're on the Server when setting up your first Server Admin User.
After creating the Server Administrator User, you'll be able to log in. On future visits to the App, you'll simply be presented with this login prompt. Simply enter the Login Username and Password that you set for the Server Admin User.
If you forget your password, MacPractice Support can assist you with resetting your password.
Initial Login
Upon first login, you'll be asked to mount the Data Sparsebundle. This simply means you need to enter the security password for the MacPractice database.
Then, you'll be prompted to enter the Database Hostname, which typically is localhost.
IF THIS IS localhost, THEN IT MUST BE ALL LOWERCASE OTHERWISE ERRORS WILL OCCUR. Please note that once you set the Database Hostname, this can't be changed later without complete removal/installation.
Finally, you'll be asked to "Create a database". This prompt is asking to set what database is currently connected to the App. For most existing users, they'll want to "Select an existing Database", but you can also create or restore a database here as well by using the drop down selector.
You'll need to fill in the Serial Number field with the client's MacPractice license number. Be sure to capitalize the leading letters, for example: MD.
The Database Name field will reference the practice's Database Name, which in most cases is typically "macpractice".
If the database name is macpractice, it MUST BE LOWER CASE OTHERWISE ERRORS WILL OCCUR.
Interface Overview
When you get logged in, you'll be presented with the Management App interface.
The sidebar will first default to the Server Node.
Server Node
This is where you can monitor your processes, determine the mounted status of the sparse bundle, and use the management buttons as necessary to stop and restart processes and the server. You can also change the location of the Sparse Bundle here by clicking the Change Location button. You can only use the Change Location button once the Sparse Bundle has been unmounted, and then you can enter a new path.
Any time you interact with one of these stop or restart buttons, a status indicator will appear at the top of the window to indicate that the interface is performing an action.
The Status indicators capture the moment the Server Node is accessed. If you need to verify a process is running, we recommend clicking the refresh button.
Important Note: Spamming any buttons will not improve performance and in some cases may cause technical issues. When you click a button, you should wait for the action to resolve before clicking another.
Database Management
In the Database Management node, there are currently two available options. You can either Validate your Database (this normally happens during Database updates), or you can Restore from a Backup.
Validating your Database is typically done during updates, but can identify and in some cases correct an issue. Typically you won't need to utilize this function unless directed to by MacPractice Support.
Restoring a Backup
Restore From Backup allows you to select a previously created backup which you can then restore your database from.
In Builds 15.9 and below, backups must be located in the default MacPracticeBackups folder in order to select and restore a database.
In Builds 15.13 and above, you can select the path of the backup you’d like to restore from.
Users Node
The Users Node is split into three tabs. "Users", "History", and "Archived Users". Let's break down each of these tabs in order.
The Users Tab allows you to review and add users that have access to the Server Management App. You can identify if these users are logged in, their last login time, and the address which they're connecting rom. You can add a user by clicking on the plus by "Add a User" to the right of the user table.
Clicking a User will reveal more information about the selected user. This will reveal Last and First Name fields, the Login Username, and a button to Reset the Password. To lock in any changes on the fields, click the Save button below.
The History Tab keeps a running tally of all login attempts to the Server Management App, as well as their originating location. You can also identify created users in the History Tab. You can type into the Filter searchbar to narrow down specific items you're searching for, such as a particular user or a particular location.
The Archived Tab contains a record of all previous users for the Server Management App that have been archived via the Users Tab, and when they have been archived.
By clicking a User in the Archived Users Tab, you can review all users that have been archived. When you click them, you can see the date they were archived, their Last Login Time, and their Last Login Address.
You can re-activate those users via the "Activate User" button in the lower left.
Settings
Currently the Settings tab only contains a place for the Serial Number.