White Labeling FileWave Components

Starting with FileWave 12.7, it is possible to customize end-user components and change FileWave defaults.

White Labeling FileWave Components

Use the guides below to apply your organization's name, colors, logos, and enrollment branding to supported FileWave components.

Choose the component you want to change. Each linked article lists the supported assets, settings, and rollout steps for that part of FileWave.

FileWave Feature Components How-To Articles to Follow
iOS Management MDM enrollment profile, App Portal Web Clip White Labeling the OTA Enrollment profile, MDM profile, and App Portal Web Clip
  App portal as native app (logo and color) Setting the Primary Colour, Name and Logo in Kiosk/App Portal (16.0+)
  Enrollment page White Labeling the iOS, macOS and Android enrollment pages
Android Management Enrollment page White Labeling the iOS, macOS and Android enrollment pages
macOS Management MDM enrollment profiles White Labeling the OTA Enrollment profile and MDM profile
  Self Service Kiosk Setting the Primary Colour, Name and Logo in Kiosk/App Portal (16.0+)
  Enrollment page White Labeling the iOS, macOS and Android enrollment pages
Windows Management Self Service Kiosk Setting the Primary Colour, Name and Logo in Kiosk/App Portal (16.0+)

White Labeling the iOS, macOS, and Android enrollment pages

Getting Started

This article explains how to customize the enrollment page for iOS, macOS (MDM), and Android devices - the enrollment page is what is made visible for your end users when they enroll their devices manually (BYOD or manual enrollment).

Hosted FileWave customers: These enrollment-page templates live on the FileWave Server filesystem. Self-managed customers with server access can edit the files directly. If your FileWave Server is hosted by FileWave, contact FileWave Technical Support for assistance with hosted-server template changes.

Feature Customization type Technology
iOS, macOS MDM, Android Server template HTML
Managed Platform Server Platform Location
Android macOS and Linux /usr/local/filewave/django/user_templates/android/welcome.html
iOS and macOS macOS and Linux /usr/local/filewave/django/user_templates/ios/welcome.html

This HTML document is actually a template, containing variables that will be replaced by the real values when processed by the FileWave server. We are using Django template language - but in a very limited way; only a few variables are important. 

iOS and MacOS

variable usage
static Path where FileWave stores static files like icons, css files
<already_trusted_ca True if the server has a valid, trusted SSL certificate

The template will show one or two steps depending on the SSL certificate your server is using.

In case of self signed certificate:

In case of trusted certificate (recommended):

Android

variable usage
static Path where FileWave stores static files like icons, css files
filewave_version FileWave server current version. "12.4.0" for instance
server_host FileWave server FQDN as set in preferences. "server.filewave.ch" for instance
server_port FileWave server port as set in preferences. 20443 by default.

Android template always shows two steps:

Additional files

Additional files can be placed in the same directory and will be served with the /user_templates/ios/ prefix. For instance, if you want to include a CSS file, you can add to your index.html:

And copy "enroll.css" in the same directory as index.html.

White Labeling the OTA Enrollment profile and MDM profile

Getting Started

It is possible to white label the OTA enrollment profile, the MDM profile, and the Web Clip for the App Portal. These profiles are the ones used while enrolling an Apple device. White Labeling the MDM profile also allows customizing the information displayed for the profile in the Settings iOS app.

The process of White Labeling these profiles consists of copying template files located on the MDM server to the correct location and editing them with a plain text editor. These files are read by the MDM server and persist server upgrades.

Hosted FileWave customers: These templates live on the FileWave Server filesystem. Self-managed customers with server access can edit the files directly. If your FileWave Server is hosted by FileWave, contact FileWave Technical Support for assistance with hosted-server template changes.

All templates are located in the following directory on the server:

In the "user_templates" directory, you will see the following templates that can be used as reference point when making your customizations:

In order to customize the profile, find the file "xxxx.example.plist". Copy the file to another one in the same directory removing ".example" from the name, e.g. copy "xxxx.example.plist" to "xxxx.plist"). You can then edit the file in a text editor.

For the purpose of demonstrating the feature, we will use the fake company name "Argon5".

OTA enrollment profile

The OTA enrollment profile is used during the first step of MDM enrollment. The information it contains is displayed by the OS while the enrollment is in progress. There are 2 files you can customize:

These files are plists that look like this:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Inc//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 
<!--
Note: define your values to substitute the OTA enrolment profile here.
Values present on the enrolment profile and not here will not be substituted.
Every key/value set here is final: they will be present on the enrolment profile.
-->
 
<plist version="1.0">
    <dict>
        <key>PayloadIdentifier</key>
        <string>com.argonfive.mobileconfig.profile-service</string>
        <key>PayloadDisplayName</key>
        <string>Argon 5 Inc.</string>
    </dict>
</plist>

To customize the profile, replace the strings with the value that you would like to see displayed. If you don't want to customize any key, it can safely be removed from the .plist file. This will cause the default value (with FileWave theming) to be sent instead. 

The result can be seen while enrolling an iOS device:

MDMProfileWebclipWB-installprofile.png

Apple TV Enrollment Profile

The file enrollment_ios.plist is also used to customize the profile to enroll Apple TVs with Apple Configurator.

MDMProfileWebclipWB-enrolliosdevice.png

MDM profile

Basic customization

The MDM profile template file is "mdm_profile.example.plist". You can replace any keys in the same way as explained in the previous section.


Sample customized MDM profile
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Inc//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 
<!--
Note: define your values to substitute the MDM profile here.
Values present on the MDM profile and not here will not be substituted.
Every key/value set here is final: they will be present on the MDM profile.
-->
 
<plist version="1.0">
<dict>
    <key>PayloadContent</key>
    <array>
        <dict>
            <key>PayloadContent</key>
            <dict>
                <key>Name</key>
                <string>Argon5 SCEP</string>
                <key>Subject</key>
                <array>
                    <array>
                        <array>
                            <string>O</string>
                            <string>Argon5 SCEP</string>
                        </array>
                    </array>
                    <array>
                        <array>
                            <string>CN</string>
                            <string>argonfivemdm</string>
                        </array>
                    </array>
                </array>
            </dict>
        </dict>
        <dict>
            <key>PayloadDescription</key>
            <string>Installs the Root certificate for the Argon5 MDM solution.</string>
        </dict>
    </array>
    <key>PayloadDescription</key>
    <string>This profile allows this device to be securely managed by the Argon5 MDM Server.</string>
    <key>PayloadDisplayName</key>
    <string>Argon5 MDM Configuration</string>
</dict>
</plist>

Which is displayed in iOS like this:

MDMProfileWebclipWB-profileconfig.png

Consent text

An additional key that you might want to add is "ConsentText". When this key is defined, iOS and macOS display a consent text during the enrollment process. The consent text must be explicitly accepted by the user. This can be used to request the user to accept terms and conditions before continuing with the enrollment. If this key is missing, this step will be skipped.

Here is an example of how to add the ConsentText at the end of the MDM profile:

...
    <key>ConsentText</key>
    <dict>
        <key>default</key>
        <string>Please be aware that by installing this profile, you agree to the terms and conditions of the Argon5 license.</string>
    </dict>
</dict>
</plist>

This consent text will be displayed by iOS like this:

MDMProfileWebclipWB-consent.png

Related Content

Chromebook Inventory Extension White Labeling (EOL)

What

White labeling the FileWave Chromebook Inventory Extension is no longer available. The steps below record the previous support-assisted process for historical reference; do not use them for a new deployment.

  1. Administrators downloaded the historical chromebook-whiteboxing.zip package and modified its icon and metadata.
  2. They opened a support ticket titled Chromebook Custom Extension and attached the modified ZIP file.
  3. After Support returned the customized extension, they published it through the Chrome Web Store developer dashboard.

Status

FileWave removed custom publishing when the extension moved to newer Chrome APIs. The supported path is the standard FileWave inventory extension.

Current workflow

FileWave 15.4 and later do not support this customization. Deploy the standard inventory extension by following Chromebook Client Pre-Requisites.

Related Content

Historical process details

The remaining steps and screenshots document the retired publishing process.

The ZIP file contained:

data.json

{
  "name": "<NAME_HERE>",
  "description": "<DESCRIPTION_HERE>"
}

Historical Chrome Web Store publishing steps

After FileWave returned the customized extension, administrators used the following Chrome Web Store steps to publish it to their organization.

  1. Login/Create an account to Google Developer Dashboard

  2. Click on the "Add New Item" button
    ChromeWB-devdashboard.png

  3. Upload the ZIP file
    ChromeWB-uploadextension.png

  4. Edit/add Additional Info
    ChromeWB-customwebstore.png

  5. Publish the extension