Deploying the Commure Pro on Android Application to Providers
This section describes how to implement and distribute the Commure Pro on Android™ software application to the members of your organization who use an Android device. Before the Commure Pro application can be installed on an Android device:- An administrator must set up the institution, department, and user settings for handheld devices and end-users. Use the Admin tab on the web application to do the setup.
- A Commure Pro representative must install the appropriate version of the Commure Pro Android application software on the Commure Pro server. This typically occurs during initial installation or during an upgrade (for information, see the Manage Handheld Modules [Edit] setting.
- The following change should be made to the load balancer to support the syncing of Android devices: a new request (/api/sync08/) should be included in the proxy configuration (starting with Commure Pro version 8.2.0). Any requests from Android devices that include /api/sync08/ are then re-directed to the mobility mobilizer. The following example demonstrates how such a configuration would work with NetScaler:
- A link to the installation instructions in the Commure Pro on Android help (see the topic entitled I_nstalling Commure Pro on Your Device_).
- The written web address, or a link to the web address, for over-the-air installation. Typically, this is the organization’s Commure Pro web address followed by “/ota.” For example:
https://commure.generalhospital.com/ota - The proper response for each of the fields on the Login screen:
- Host: The address of your organization’s Commure Pro Application Server, without the “/ota.” Do not include “http://” or “https://” in the address. For example, the following format is acceptable:
commure.generalhospital.comYou may also use an IP address, as long as it also includes a port number, as in this example:172.55.5.555:1000 - Username and Password: If the providers have never logged into a Commure Pro application (web or handheld), you may need to send them information about which username and password to use the first time they log into Commure Pro with their device. For example, should they use their LDAP or AD password, the same password that they use in your backend system, or a new Commure Pro username and password that you will provide to them.
- Host: The address of your organization’s Commure Pro Application Server, without the “/ota.” Do not include “http://” or “https://” in the address. For example, the following format is acceptable:
Deploying the Commure Pro on Apple Application to Providers
This section describes how to implement and distribute the Commure Pro on Apple® software application to the members of your organization who use an Apple device, such as an iPhone®, iPod touch®, or iPad™. You have several options for distributing the Commure Pro application to your end-users. The type of software used (standard or custom) affects your distribution choices.| Distribution Method | Type of Application | Description | Where Documented |
|---|---|---|---|
| Distribution via the Apple® App Store | Standard Commure Pro application that is publicly available in the Apple App Store. | The end-user downloads the application from the Apple App Store. | Distribution via the Apple App Store |
| Distribution via the Volume Purchase Program for Business (VPP) | Standard Commure Pro application that is publicly available in the Apple App Store. OR Custom Business to Business (B2B) version of the Commure Pro application. | For both standard and custom applications, an organization can use the VPP to distribute the application to end-users. The distribution can be accomplished via either method below: • Managed Distribution (using an MDM) • Redeemable Codes (using e-mail, an internal web site, an MDM, or Apple Configurator 2) | Distribution via the Volume Purchase Program (VPP) for Business |
Distribution via the Apple App Store
To distribute the standard Commure Pro application that is publicly available in the Apple® App Store to your end-users, follow these steps:- Configure Institution, Department, and User Settings.
- Enable Firewall Access for Apple Push Notification Service
- Distribute the Application to Your Users via the Apple App Store
Configure Institution, Department, and User Settings
Before Commure Pro can be installed on an Apple® device, an administrator must perform the basic configuration of the institution, department, and user settings for handheld devices and end-users. Use the Admin tab on the web application to do the setup.Enable Firewall Access for Apple Push Notification Service
In order for push notifications to work on Apple devices, the Commure Pro application server must be able to communicate with the Apple Push Notification service (APNs). If your organization uses a firewall, you must modify the firewall to allow access to the following URLs:- gateway.push.apple.com
- feedback.push.apple.com In addition, the following ports must be opened to facilitate this communication.
| Port | Protocol | Description |
|---|---|---|
| 2195 | TCP | Used to send notifications to the APNs |
| 2196 | TCP | Used by the APNs feedback service |
| 5223 | TCP | Used by devices to communicate to the APNs servers |
| 443 | TCP | Used as a fallback when devices are unable to communicate to APNs on port 5223 |
Distribute the Application to Your Users via the Apple App Store
In this distribution model, an administrator or a provider simply downloads and installs the application from the Apple® App Store. This is the most common distribution method for clients who use the standard Commure Pro application. When this method is used, the Commure Pro application belongs to the Apple ID that downloads it. If an administrator is going to perform the installation, they should follow the same installation steps as a provider, described in the Commure Pro on Apple help (see the topic entitled Installing Commure Pro on Your Device). If providers are going to perform the installation, the administrator sends an e-mail to the end-user that contains a link that directs them to the correct version of the standard Commure Pro application in the Apple® App Store. The e-mail should contain the following items to ensure that the providers have all of the information necessary to perform the installation:- A link to the installation instructions in the Commure Pro on Apple help (see the topic entitled Installing Commure Pro on Your Device). Be sure to indicate to the user that they should follow the installation instructions in the section entitled Installing via the Apple App Store.
- The written web address, or a link to the web address, for downloading the Commure Pro application from the Apple App Store. A Commure Pro representative will provide administrators with the correct link to send to their providers.
- The proper responses for the fields on the Commure Pro Login screen:
- Host (required): Address of your organization’s Commure Pro Application Server. You can use either the host name or the IP address. It is not necessary to include the protocol in the address (the “http://” or “https://”), although it will not cause a problem if you do. The application always strips the protocol out of the address and then tries to connect using the secure encrypted version first (https://). If that fails, it then tries the unencrypted version (http://). For example, either of these formats are acceptable:
commure.generalhospital.com172.55.5.555
- Host (required): Address of your organization’s Commure Pro Application Server. You can use either the host name or the IP address. It is not necessary to include the protocol in the address (the “http://” or “https://”), although it will not cause a problem if you do. The application always strips the protocol out of the address and then tries to connect using the secure encrypted version first (https://). If that fails, it then tries the unencrypted version (http://). For example, either of these formats are acceptable:
For the Commure Pro version 9 or later application, it is not necessary to provide the user with a value for the Host field. If the user logs in using Basic Mode (the default mode), then after they enter their Username and Password, the application searches the Central Provisioning Server for a match and presents them with a list of hosts from which to select.
- Username and Password: If the providers have never logged into a Commure Pro application (web or handheld), you may need to send them information about which username and password to use the first time they log into Commure Pro with their device. For example, should they use their LDAP or AD password, the same password that they use in your backend system, or a new Commure Pro username and password that you will provide to them?
Distribution via the Volume Purchase Program (VPP) for Business
You can use the Volume Purchase Program (VPP) to distribute either the standard Commure Pro application (from the App Store) or a custom Business to Business (B2B) version of the Commure Pro application to your end-users. Please note that this document provides only a high-level summary of the steps involved in setting up and distributing via the VPP. Please see the following document for complete instructions from Apple: http://images.apple.com/business/docs/VPP_Business_Guide.pdf The table below describes the steps involved in the distribution procedure. The procedure is similar for both types of applications, although Steps 3, 5, and 7 are not applicable for the standard application.| Step | Step Required for Standard Application? | Step Required for Custom B2B Application? |
|---|---|---|
| 1. Configure Institution, Department, and User Settings | Yes | Yes |
| 2. Enable Firewall Access for Apple Push Notification Service | Yes | Yes |
| 3. Customize the Commure Pro Application | No | Yes |
| 4. Enroll in the Volume Purchase Program | Yes | Yes |
| 5. Coordinate with Commure Pro | No | Yes |
| 6. Purchase the Commure Pro Application on the VPP Web Site | Yes | Yes |
| 7. Configure the iPhone Client Version Settings for Your Custom Application | No | Yes |
| 8. Distribute the application to your users via the VPP using either method below: • Distribute the Application to Users via VPP using Redeemable Codes • Distribute the Application to Users via VPP using Mobile Device Management | Yes | Yes |
Customize the Commure Pro Application
You organization can create a custom Business to Business (B2B) version of the Commure Pro application if you are distributing the application via the Volume Purchase Program. Custom applications can have a custom name, a custom application icon, and default URL for the Host field. The requirements for custom elements are described below. If you wish to create a custom application, you must provide the items below to Commure Pro’s development team (contact your Commure Pro representative).- Custom application names: The application name can be anything, but we recommend limiting it to 10 to 12 characters, since anything longer would be truncated.
- Custom application icons: This image should have an equal width and height, or be as close as possible to the standard “square” shape that is used for Apple application icons. For example, a wide rectangular logo of the organization’s name will not work well.
- iPhone and iPod Touch: 57x57 pixels
- iPhone and iPod Touch Retina: 114x114 pixels
- iPad: 72x72 pixels
- iPad Retina: 144x144 pixels
Enroll in the Volume Purchase Program
Enrollment in the Volume Purchase Program is required in order to use the VPP distribution method. VPP is part of the Apple Deployment program; you must create an Apple Deployment Programs account to get started. Go to https://deploy.apple.com to enroll. See also http://images.apple.com/business/docs/VPP_Business_Guide.pdf for complete details. You will need to provide:- A Dun & Bradstreet (D-U-N-S) number for your company. To look up an existing D-U-N-S number, go to iupdate.dnb.com/iUpdate/companylookup.htm. Or, to obtain a new number, go to www.dnb.com/about-dnb/15145059-1.html to find a local Dun & Bradstreet office.
- Contact information for your company, including a business address, a business phone, and a business e-mail address. The business address must match the address on file in the Dun & Bradstreet database for your company. The e-mail address must be a business e-mail, and cannot be an e-mail address that is associated with a personal Apple ID account. Once you submit your enrollment, you will be assigned an Apple Deployment Programs Apple ID.
Coordinate with Commure Pro
If you are distributing a custom B2B application, you must provide Commure Pro with the e-mail address that is associated with your Apple Deployment Programs Apple ID (IMPORTANT: Do not disclose your Apple ID password; just the e-mail address). Commure Pro will use this e-mail address to identify you as an authorized business purchaser for the custom B2B application that we submit, and will also notify you when your custom application is available. Once we have done so, you can purchase your custom Commure Pro application on the VPP web site.Purchase the Commure Pro Application on the VPP Web Site
Log into the VPP web site at vpp.itunes.apple.com, using the Apple Deployment Programs Apple ID that you created during enrollment. If you are deploying a custom B2B Commure Pro application, and Commure Pro has notified you that it is ready, then it will be listed on your account.- Search for and select either the standard Commure Pro application from the App Store, or the custom B2B Commure Pro application that is listed on your account.
- Enter the quantity that you want to “purchase.” In both cases, the Commure Pro application will be listed as a free application.
- Select the distribution method. There are two ways to distribute applications via the VPP:
- Managed Distribution (using a Mobile Device Management, or MDM system): You can use a MDM to distribute the application to either users (iOS 7 or later) or devices (iOS 9 or later). With this option, your organization owns the application, and can revoke and reassign the it to different users or devices. See Distribute the Application to Users via VPP using Mobile Device Management.
- Redeemable Codes: You can distribute the application using redeemable codes. This method permanently transfers the application to the Apple ID that redeems the code. This Apple ID can be created and used on devices owned by your organization, or it can be the user’s personal Apple ID. See Distribute the Application to Users via VPP using Redeemable Codes.
- After the purchase is complete, you’ll receive an e-mail from Apple telling you that your order has been processed.
Configure the iPhone Client Version Settings for Your Custom Application
If you are distributing a custom B2B application via the Volume Purchase Program, the iPhone Client Version Settings option must be modified to define the specific Apple application and version(s) that are allowed to sync to the Commure Pro server.- Log into the Commure Pro web application.
- Go to Admin > Institution > Device settings.
- Click the Change Supported Version link next to iPhone Client Version Settings and change the values in the following fields:
- Bundle Identifier: Change the value to match exactly the client’s custom application name. For example, if General Hospital’s custom application were called PKGENHOSP, the bundle identifier would be: com.Commure Pro.PKGENHOSP. In most B2B cases, the “-AppStore” suffix is not included in the bundle identifier. (Contact your Commure Pro representative if you are unsure of the bundle identifier that you should use.)
- Lock Bundle Identifier: Set this to Yes, so that the bundle identifier you entered above does not get overwritten during upgrades.
- Minimum Version: Do not change the value in this field.
- Click the Save button.
Distribute the Application to Users via VPP using Mobile Device Management
You can use your MDM system or Apple Configurator 2 to distribute the standard or custom Commure Pro application that you purchased in the VPP to either users or devices. When you use the MDM distribution method, your organization owns application and you can easily keep track of the users or devices to whom you have distributed the application, as well as revoke and reassign the application to different users or devices. If your MDM supports App Config, you can also push default values for the Host and/or Username fields to your end-users, for both the standard and custom applications. Since each MDM is different, that process is not documented here; consult your MDM system’s documentation for instructions.- Link your MDM to your VPP account. To do so, log into the VPP web site and download a token to link your MDM server to your VPP account. Then upload the token to your MDM server. If you are using Apple Configurator 2, just sign into your VPP account from Apple Configurator 2.
- (Optional) If your MDM supports App Config, configure the Commure Pro application with default values for the Host and/or Username fields on the Commure Pro Login screen.
- Use your MDM to assign the standard or custom Commure Pro application to either users or devices:
- Assigning to Users: Use your MDM to invite users through an e-mail or a push notification message. Users can accept the invitation by signing in with their personal Apple ID. Next, they are connected to your MDM server where they can download the Commure Pro application. Or you can silently install the application on supervised devices. This option is available only for devices running iOS 7 or later.
- Assigning to Devices: Use your MDM or Apple Configurator 2 to assign the Commure Pro application directly to devices. After the application is assigned to a device, it is pushed to the device via the MDM or added to the device by Apple Configurator 2. No invitation or Apple ID is required and any person using that device has access to the application. This option is available only for devices running iOS 9 or later.
- Send the following additional information to your providers to ensure that they have all of the information necessary to perform the installation:
- A link to the following topic in the Commure Pro on Apple help: Installing Commure Pro on Your Device. Be sure to indicate to the user that they should follow the installation instructions in the section entitled Installing via your Organization’s MDM.
- The proper responses for the fields on the Commure Pro Login screen:
- Host (required): Custom B2B applications can be designed with a default value for the Host field, so that the user does not have to fill it in. Or you may be able to use your MDM to default a value for this field. If so, you do not have to send this information to the user. However, if a value is not defaulted, be sure to send the address of your organization’s Commure Pro Application Server to the user. It is not necessary to include the protocol in the address (the “http://” or “https://”), although it will not cause a problem if you do. The application always strips the protocol out of the address and then tries to connect using the secure encrypted version first (https://). If that fails, it then tries the unencrypted version (http://). For example, either of these formats are acceptable:
| Acceptable Formats for Host Field |
|---|
| commure.generalhospital.com |
| 172.55.5.555 |
For the Commure Pro version 9 or later application, if you choose not to default a value for the Host field, it is not necessary to provide the user with a value for the field. If the user logs in using Basic Mode (the default mode), then after they enter their Username and Password, the application searches the Central Provisioning Server for a match and presents them with a list of hosts from which to select.
- Username and Password: You may be able to use your MDM to default a value in the Username field, but not in the Password field. Whether defaulted or not, you may need to let your providers know which username and password to use the first time they log into Commure Pro with their device. For example, should they use their LDAP or AD password, the same password that they use in your backend system, or a new Commure Pro username and password that you will provide to them?
Distribute the Application to Users via VPP using Redeemable Codes
You can use Redeemable Codes to distribute the standard or custom Commure Pro application to users. When you use the Redeemable Codes method, you’ll receive a redemption code or each application you purchase to authorize the application download. The redemption codes are listed in a spreadsheet that contains multiple codes, one for each application in the quantity purchased. Each time a user redeems a code, the spreadsheet is updated on the VPP website so you can track the number of codes that have been redeemed by your users. This method permanently transfers ownership of the application to the Apple ID that redeems the code. The Apple ID can be created and used on devices owned by your organization, or it can be the user’s personal Apple ID. The spreadsheet also includes a redemption URL with the redemption code embedded in the link so that users don’t have to type or enter the redemption code manually when downloading the standard or custom Commure Pro application. Your organization can use any of the methods below to distribute the redemption URLs. This document describes each method briefly. Please refer to the Apple web site for more detailed information.- Send an e-mail containing the redemption URLs directly to users. When a user opens the e-mail on their device, they simply click the link containing the redemption URL, and the page for the Commure Pro application is opened automatically in the App Store. The redemption code is automatically entered, enabling users to immediately download the application.
- Post the redemption codes and URLs to an internal website, such as a company intranet page. Notify your users that the application is available, and then direct them to the internal website, where they can click a link to start the download. Since each code can be redeemed only once, make sure that the web page assigns a specific code to each user (so that multiple users do not try to redeem the same code).
- Use a Mobile Device Management (MDM) system to manage the redemption codes. Many MDM systems allow IT administrators to upload the spreadsheets into a console, provide the ability to distribute the codes to users, and keep track of the codes that have been used.
- Use Apple Configurator 2 on a Mac to install applications on new or supervised devices. You can import the spreadsheet, and track the number of applications that are installed on each device. To update deployed applications using Apple Configurator 2, you must reconnect to the same Mac from which the applications were installed. See http://help.apple.com/configurator/mac/1.4/ for more information. Regardless of which method above that you use, send the following additional information to your providers to ensure that they have all of the information necessary to perform the installation:
- A link to the following topic in the Commure Pro on Apple help: Installing Commure Pro on Your Device. Be sure to indicate to the user that they should follow the installation instructions in the section entitled Installing using Redeemable Codes.
- The proper responses for the fields on the Commure Pro Login screen:
- Host (required): Custom B2B applications can be designed with a default value for the Host field so that the user does not have to fill it in. If so, you do not have to send this information to the user. However, if a value is not defaulted, be sure to send the address of your organization’s Commure Pro Application Server to the user. It is not necessary to include the protocol in the address (the “http://” or “https://”), although it will not cause a problem if you do. The application always strips the protocol out of the address and then tries to connect using the secure encrypted version first (https://). If that fails, it then tries the unencrypted version (http://). For example, either of these formats are acceptable:
| Acceptable Formats for Host Field |
|---|
| commure.generalhospital.com |
| 172.55.5.555 |
For the Commure Pro version 9 or later application, if you choose not to default a value for the Host field, it is not necessary to provide the user with a value for the field. If the user logs in using Basic Mode (the default mode), then after they enter their Username and Password, the application searches the Central Provisioning Server for a match and presents them with a list of hosts from which to select.
- Username and Password: If the providers have never logged into a Commure Pro application (web or handheld), you may need let them know which username and password to use the first time they log into Commure Pro with their device. For example, should they use their LDAP or AD password, the same password that they use in your backend system, or a new Commure Pro username and password that you will provide to them?