Cloud Streaming - Patient Entertainment App - AppleTV - Setup Instructions

This guide aims to assist customers in adding the Patient Entertainment app to your organization and requires familiarity with managing Apple app deployments. 

Before you begin, ensure your company meets the below requirements. 

Requirements

1. Your Organization has an Apple Business Manager Account: https://business.apple.com/

   1. Apple Documentation: https://support.apple.com/guide/apple-business-manager/welcome/1/web

2. Your Organization has linked a Mobile Device Manager (MDM) to your Business Manager Account

   1. Known valid MDMs: JAMF and SimpleMDM - many others likely to work.

   2. Apple Documentation: https://support.apple.com/guide/apple-business-manager/link-to-a-third-party-mdm-server-axm1c1be359d/1/web/1

3. AppleTV Devices in the 4K Generations - Released Sept 22, 2017 (AppleTV6 or later)

4. Network Requirements: open access for the following:

   Domain	IP Address
   *.swankmp.net	20.221.242.164, 12.38.100.99, 12.38.100.75, 71.14.206.75
   cdn.swankidc.com	https://api.fastly.com/public-ip-list
   swankcontentuseast.blob.core.windows.net	https://www.microsoft.com/en-us/download/details.aspx?id=56519
   *.easeltv.com	(varies)
   http://www.google-analytics.com	https://www.gstatic.com/ipranges/goog.json

Step 1. Provide your Apple Organization ID

1. To locate your Organization ID within your Apple Business Manager Account, navigate to the Preferences >Organization Information page.  

2. Copy the value from the Organization ID field. 

3. Send the ID to your Swank Account Manager.  As a result, Swank adds you as a Private Business-to-Business customer for our Patient Entertainment Custom Application. 
   

4. To enable Custom Apps, go to the Organization Settings page and verify the Enabled switch is on (checked).  
   

Apple Documentation: https://support.apple.com/guide/apple-business-manager/manage-device-suppliers-axmef1c47493/web

Step 2. Acquire Patient Entertainment Licenses

1. After Swank has added your Organization ID, you’ll find the Patient Entertainment app available under Custom Apps tab.
   

    

2. Select the Patient Entertainment application to open the License management page.

3. Get (Buy) Licenses in a quantity as required by your organization. These are of zero cost, and will not require a financial transaction with Apple.

   1. Select License Type as Managed and Assign To as the appropriate location for your MDM service.

       

      

4. In the Managed Licenses section, verify you have enough available licenses.

    

   

   Apple Documentation: https://support.apple.com/guide/apple-business-manager/learn-about-custom-apps-axm58ba3112a/1/web/1

Step 3. Assign Apple TVs to your MDM

1. Ensure your Apple TVs assigned to your Apple Customer Numbers are configured correctly to your MDM of Choice

2. In your MDM, verify that Apple TV devices are enrolled and available

   • Setup Device Groups as required

     

3. Also in your MDM, find the Patient Entertainment app available in your application catalog.

   

Apple Documentation: 

https://support.apple.com/guide/apple-business-manager/intro-to-mdm-servers-axm659f6bd48/1/web/1

Simple MDM Documentation: 

https://simplemdm.pdq.com/hc/en-us/articles/9355306124059-Connecting-a-DEP-Account-Automated-Enrollment 

https://simplemdm.pdq.com/hc/en-us/articles/9355276502939-Apple-VPP-Apps-and-Books

JAMF Documentation: 

https://learn.jamf.com/en-US/bundle/jamf-pro-getting-started/page/Automated_Device_Enrollment_Integration.html

https://learn.jamf.com/en-US/bundle/jamf-pro-getting-started/page/Volume_Purchasing_Integration.html

https://learn.jamf.com/en-US/bundle/jamf-now-documentation/page/B2B_Apps.html

Step 4. Apply Managed Configuration to the App in your MDM

Use this step to assign attributes permitting the tvOS to share its UDID of the device to the application. This allows managed devices to be wiped and reinstalled while retaining the enrollment to the Patient Entertainment application service. 

1. Open the configuration of the Patient Entertainment app, navigating to the section for Managed Configurations
   

    

    

2. Assign the UDID attribute via either of the following methods. 

   • UI method (SimpleMDM):

     • Key: deviceId

     • Value Type: String and

     • Value: {{udid}} :warning:

   • Plist method:

     • Select the Use custom config plist checkbox. 

     • Import or paste in the plist XML file provided by Swank (see appendix below). :warning:

WARNING: Different MDMs have different syntax for assigning Device Attributes. You may require a different input to provide the UDID.

Simple MDM Documentation: 

https://simplemdm.pdq.com/hc/en-us/articles/9355295764635-Managed-App-Configurations 

https://simplemdm.pdq.com/hc/en-us/articles/9355313240347-Attributes-Custom-Attributes

JAMF Documentation: 

https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-current/page/Mobile_Device_Configuration_Profiles.html

Step 5. Push installation of App to your Devices

1. Via your MDM, ensure that all desired devices are being pushed the installation of Patient Entertainment. Follow the methods appropriate for your MDM.
   

    

Simple MDM Documentation: https://simplemdm.pdq.com/hc/en-us/articles/9355282918555-Deploying-and-Updating-Apps

JAMF Documentation: https://learn.jamf.com/en-US/bundle/jamf-now-documentation/page/B2B_Apps.html

Step 6. Export list of UDID of Devices installed with Patient Entertainment.

1. Via your MDM, export a list of Devices that have (or will have) the installation of Patient Entertainment.
   

    

2. This export should include the UDID of each device to enroll against.

   • Export needs to be in Excel .xlsx or Comma-Seperated Value .csv format

   • Optionally may include a devicename, room #, or similar short string to easily identity the device with support if the need ever arises.

   • **NOTE: Each future export should include the full list of all desired devices. Any missing devices will be removed and any new devices will be added.

3. Send this export to your Swank Account Manager for device registration.

Step 7. Complete!

After Swank completes enrolling your devices to our Patient Entertainment application, your devices will successfully connect to your content catalog.

If necessary, this will require the app to be exited from the enrollment screen and reopened.

Please enjoy your Swank Streaming experience!

Appendix

PLIST File

pe_udid.plist

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>deviceId</key>
        <string>$UDID</string>
    </dict>
</plist>

Specfile

For advanced users that prefer to generate their own plist or confirm our design intentions, the Managed Configuration specfile may be used:

specfile_pe_udid.xml

<?xml version="1.0"?>
<managedAppConfiguration>
    <version>1</version>
    <bundleId>com.swank.tv</bundleId>
    <dict>
        <string keyName="deviceId">
            <defaultValue>
                <deviceVariable value="udid"></deviceVariable>
            </defaultValue>
            <constraint nullable="true"></constraint>
        </string>
    </dict>
    <presentation defaultLocale="en-US">
        <field keyName="deviceId" type="hidden"></field>
    </presentation>
</managedAppConfiguration>