# White Labeling FileWave Components

# White Labeling FileWave components

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

Please use the How-To articles below for detailed customization instructions.

<table id="bkmrk-filewave-feature-com"><tbody><tr style="background-color: rgb(251, 238, 184);"><td>FileWave Feature</td><td>Components</td><td>How-To Articles to Follow</td></tr><tr><td>iOS Management</td><td>MDM enrollment profile, App Portal Web Clip</td><td>[White Labeling the OTA Enrollment profile, MDM profile, and App Portal Web Clip](https://kb.filewave.com/books/white-labeling-filewave-components/page/white-labeling-the-ota-enrollment-profile-and-mdm-profile "White Labeling the OTA Enrollment profile, MDM profile, and App Portal Web Clip")</td></tr><tr><td> </td><td>App portal as native app (logo and color)</td><td>[Setting the Primary Color, Name and Logo in App Portal (15.3+)](https://kb.filewave.com/books/kiosk/page/setting-the-primary-color-name-and-logo-in-kioskapp-portal-153 "Setting the Primary Color, Name and Logo in App Portal (15.3+)")</td></tr><tr><td> </td><td>Enrollment page</td><td>[White Labeling the iOS, macOS and Android enrollment pages](https://kb.filewave.com/books/white-labeling-filewave-components/page/white-labeling-the-ios-macos-and-android-enrollment-pages "White Labeling the iOS, macOS, and Android enrollment pages")</td></tr><tr><td>Android Management</td><td>Enrollment page</td><td>[White Labeling the iOS, macOS and Android enrollment pages](https://kb.filewave.com/books/white-labeling-filewave-components/page/white-labeling-the-ios-macos-and-android-enrollment-pages "White Labeling the iOS, macOS, and Android enrollment pages")</td></tr><tr><td>macOS Management</td><td>MDM enrollment profiles</td><td>[White Labeling the OTA Enrollment profile and MDM profile](https://kb.filewave.com/books/white-labeling-filewave-components/page/white-labeling-the-ota-enrollment-profile-and-mdm-profile "White Labeling the OTA Enrollment profile and MDM profile")</td></tr><tr><td> </td><td>Self Service Kiosk</td><td>[Setting the Primary Color, Name and Logo in App Portal (15.3+)](https://kb.filewave.com/books/kiosk/page/setting-the-primary-color-name-and-logo-in-kioskapp-portal-153 "Setting the Primary Color, Name and Logo in App Portal (15.3+)")</td></tr><tr><td> </td><td>Enrollment page</td><td>[White Labeling the iOS, macOS and Android enrollment pages](https://kb.filewave.com/books/white-labeling-filewave-components/page/white-labeling-the-ios-macos-and-android-enrollment-pages "White Labeling the iOS, macOS, and Android enrollment pages")</td></tr><tr><td>Windows Management</td><td>Self Service Kiosk</td><td>[Setting the Primary Color, Name and Logo in App Portal (15.3+)](https://kb.filewave.com/books/kiosk/page/setting-the-primary-color-name-and-logo-in-kioskapp-portal-153 "Setting the Primary Color, Name and Logo in App Portal (15.3+)")</td></tr></tbody></table>

# 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).

<table id="bkmrk-feature-customizatio"><thead><tr style="background-color: rgb(251, 238, 184);"><th>Feature</th><th>Customization type</th><th>Technology</th></tr></thead><tbody><tr><td>iOS, macOS MDM, Android</td><td>Server template</td><td>HTML</td></tr></tbody></table>

<table id="bkmrk-managed-platform-ser"><tbody><tr style="background-color: rgb(251, 238, 184);"><td>Managed Platform</td><td>Server Platform</td><td>Location</td></tr><tr><td>Android</td><td>macOS and Linux</td><td>`/usr/local/filewave/django/user_templates/android/welcome.html`</td></tr><tr><td>iOS and macOS</td><td>macOS and Linux</td><td>`/usr/local/filewave/django/user_templates/ios/welcome.html`</td></tr></tbody></table>

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](https://docs.djangoproject.com/en/1.11/ref/templates/) - but in a very limited way; only a few variables are important.

#### iOS and MacOS

<table id="bkmrk-variable-usage-stati"><thead><tr style="background-color: rgb(251, 238, 184);"><th>variable</th><th>usage</th></tr></thead><tbody><tr><td>`static`</td><td>Path where FileWave stores static files like icons, css files</td></tr><tr><td>`<already_trusted_ca`</td><td>True if the server has a valid, trusted SSL certificate</td></tr></tbody></table>

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

In case of self signed certificate:

- step 1 is to download the certificate (to be manually installed in the device trust store); link must point to "/CA"
- step 2 is to enroll the device; link must point to "/enroll"

In case of trusted certificate (recommended):

- step 1 is to enroll the device; link must point to "/enroll"

#### Android

<table id="bkmrk-variable-usage-stati-1"><thead><tr style="background-color: rgb(251, 238, 184);"><th>variable</th><th>usage</th></tr></thead><tbody><tr><td>`static`</td><td>Path where FileWave stores static files like icons, css files</td></tr><tr><td>`filewave_version`</td><td>FileWave server current version. "12.4.0" for instance</td></tr><tr><td>server\_host</td><td>FileWave server FQDN as set in preferences. "[server.filewave.ch](http://server.filewave.ch)" for instance</td></tr><tr><td>server\_port</td><td>FileWave server port as set in preferences. 20443 by default.</td></tr></tbody></table>

Android template always shows two steps:

- step 1 is to download FileWave Android Native App Portal on FileWave CDN, using *filewave\_version* variable. You may want to change this link if you have a custom Android Native App Portal.
- step 2 is to automatically configure the Android Native App Portal, once it has been installed, using *server\_host* and *server\_port* variables.

**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:

```html
<link rel='stylesheet' href="/user_templates/ios/enroll.css" />
```

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.

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

- macOS and Linux: `/usr/local/filewave/django/user_templates`

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

- enrolment\_ios.example.plist
- enrolment\_macos.example.plist
- mdm\_profile.example.plist

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:

- "enrolment\_ios.example.plist", for iOS
- "enrolment\_macos.example.plist", for macOS

These files are plists that look like this:

```xml
<?xml version="1.0" encoding="UTF-8"?>

 
<!--
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](https://kb.filewave.com/uploads/images/gallery/2023-06/CQFMwNx4nfdkl2ip-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](https://kb.filewave.com/uploads/images/gallery/2023-06/OJHpc83U9rZyPYzM-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
<?xml version="1.0" encoding="UTF-8"?>

 
<!--
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](https://kb.filewave.com/uploads/images/gallery/2023-06/pntzcKQC8TEhEFy8-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:

```xml
...
    <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](https://kb.filewave.com/uploads/images/gallery/2023-06/iokmodu6UAWZFNlN-mdmprofilewebclipwb-consent.png)

## Related Content

- [Setting the Primary Color, Name and Logo in App Portal (15.3+)](https://kb.filewave.com/books/kiosk/page/setting-the-primary-color-name-and-logo-in-kioskapp-portal-153 "Setting the Primary Color, Name and Logo in App Portal (15.3+)")

# White Labeling the Chromebook Extension

## What

It was previously possible to customize the user-visible information for the FileWave Inventory Extension. It was possible to customize icons, name and description. This involved:

1. Download [chromebook-whiteboxing.zip](https://kb.filewave.com/attachments/38) and modify the data inside (adding a new icon, description, etc.)
2. Create a support Ticket titled "Chromebook Custom Extension" and attach your new modified Zip File
3. Wait till we send back your "whiteboxed" extension then continue to the "How to publish" section below

## When/Why

As part of an overhaul of the extension to leverage new APIs and enhancements the ability to publish it with customizations is removed for now. If this returns in a future version then this article will be updated.

## How

This customization is not possible in FileWave 15.4+ and this article remains to make customers aware of the change. You would use the inventory extension as outlined in [Chromebook Client Pre-Requisites](https://kb.filewave.com/books/evaluation-guide/page/chromebook-client-pre-requisites "Chromebook Client Pre-Requisites") rather than this customized method.

## Related Content

- [Chromebook Client Pre-Requisites](https://kb.filewave.com/books/evaluation-guide/page/chromebook-client-pre-requisites "Chromebook Client Pre-Requisites")

## Digging Deeper

This was the actual process to publish in the past.

The ZIP file contained:

- icon\_.png (so far we have 19, 38, 128 as size)
- data.json

**data.json**

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

### How to publish a "whiteboxed" version of the extensions

Once you get the "whiteboxed" version of your extension, you have to follow some steps to make it available to your organization.

1. Login/Create an account to [Google Developer Dashboard](https://chrome.google.com/webstore/developer/dashboard)
2. Click on the "Add New Item" button  
    ![ChromeWB-devdashboard.png](https://kb.filewave.com/uploads/images/gallery/2023-06/mvuQbo0kql9iBtqk-chromewb-devdashboard.png)
3. Upload the ZIP file  
    ![ChromeWB-uploadextension.png](https://kb.filewave.com/uploads/images/gallery/2023-06/CQoFja80ChN3Jjg3-chromewb-uploadextension.png)
4. Edit/add Additional Info  
    ![ChromeWB-customwebstore.png](https://kb.filewave.com/uploads/images/gallery/2023-06/t3oyiF2nczc8IlNK-chromewb-customwebstore.png)
5. Publish the extension