Kiosk

Self-Service Kiosk Overview

FileWave Kiosk lets users install approved apps and content themselves while admins keep control of assignments, categories, and licensing.

Standard Assignment

With a Standard Assignment, the Fileset content installs automatically without user interaction.

Kiosk Assignment

With a Kiosk Assignment, the user chooses approved items from the self-service Kiosk and starts the installation themselves.

Since the FileWave process runs at root or system level on computers, the end user does not need to be a local administrator in order to install applications and content through the Kiosk.

Computer Clients

User access to the Kiosk is by way of a macOS Menu Bar or Windows System Tray icon.

The Kiosk is activated on computers by installing the FileWave client and having at least one Fileset configured as a Kiosk item associated with that Client. 

If no Kiosk association exists, the macOS menu bar or Windows system tray will not include the Kiosk icon.

If an association exists and the icon still does not appear, check operating-system icon visibility rules. For example, macOS or Windows may hide extra menu bar or system tray icons when space is limited.

You can also open Kiosk from the command line, as described here: Manual Trigger of FileWave Kiosk for macOS and Windows

Mobile clients

On mobile devices, users access Kiosk through the automatically installed FileWave App Portal app.

The Kiosk is activated on a mobile device when that device enrolls with the FileWave MDM.

Associations

Any Fileset, including App Store apps, can be configured as a Kiosk item and placed into categories such as department, class, or application type.

Apple VPP

An Apple VPP Kiosk item contains the link to the store.  The application or book is downloaded from Apple, directly to the device, when the user clicks Install.

VPP licenses can be returned for reuse only after all related standard or Kiosk associations/deployments are removed.

Mobile Kiosk versus Desktop Kiosk

FileWave Kiosk for macOS and Windows overview (15.3+)

This article will explain the details of the refreshed Kiosk for macOS and Windows that is included in FileWave 15.3+.

Browse Payloads/Filesets

The "Browse Payloads/Filesets" screen is a central feature within the app that enables users to explore and discover a diverse array of payloads/filesets available for access or download. Much like the experience of browsing through the Android Play Store or the Apple App Store, this screen offers users an organized and visually appealing interface that showcases different payloads/filesets, each accompanied by relevant details and information.

Key components and elements commonly found on the "Browse Payloads/Filesets" screen include:

image.png

image.png

image.png

These enhancements not only simplify the user experience but also provide a comprehensive set of tools for effective payload/fileset management. By incorporating these features, we aim to empower users with a more personalized and efficient approach to navigating and managing their payloads/filesets within FileWave.

image.png

image.png

image.png

Payload/Fileset details view

We are excited to introduce significant enhancements to the Desktop Kiosk versions, mirroring the user-centric improvements made for iOS/iPadOS. With these updates, users can expect a more intuitive and informative experience when interacting with filesets and payloads on their desktop devices.

Key Features:

image.png

These enhancements aim to streamline the desktop browsing experience, aligning it closely with the intuitive interface seen on iOS/iPadOS. By providing users with comprehensive information and intuitive navigation, the Desktop Kiosk versions empower users to make informed decisions and maximize productivity.

Device Information view

We're thrilled to unveil enhancements to the Device Information view on Desktop Kiosk, paralleling the user-centric improvements made for iOS/iPadOS. This revamped interface provides users with a comprehensive overview of vital device details, fostering transparency and effective management within the app's ecosystem.

Key Features:

These enhancements bolster transparency and facilitate efficient device management within the Desktop Kiosk environment. By providing users with a holistic overview of device and server information, coupled with booster management capabilities, the Desktop Kiosk version empowers users to make informed decisions and optimize their workflows with ease.

image.png

Logo and primary color selection

The Adding Logo and Primary Color Selection feature enhances customization within the app by enabling users to personalize the visual representation of their profiles or entities. This feature allows users to define their brand identity and establish a cohesive look and feel throughout the app. Here's how the feature works:

The "Add Logo and Primary Color Selection" feature empowers users to infuse their identity into the app's interface, enhancing recognition, and contributing to a personalized and engaging experience for both users and their audiences.

FileWave Kiosk for iOS/iPadOS overview (15.3+)

What

The Self-Service Kiosk is FileWave's self-service experience for iOS and iPadOS devices. It lets users browse Kiosk-associated applications, profiles, books, and other approved content without IT having to assign every item directly to each iPad or iPhone.

The newer iOS/iPadOS Kiosk experience started with FileWave 15.3, but the deployment method changed again in FileWave 16.3.0. On 16.3.0 and later, the iOS/iPadOS Kiosk is the Apple App Store version of FileWave Kiosk, deployed as a VPP / Apps and Books app.

This article focuses on the Kiosk interface and user experience after the app is installed. For deployment, upgrade behavior, and the required ASM/ABM app-license preparation for 16.3.0+, use Automatic updating of iOS/iPadOS Kiosk (15.3+) as the source of truth.

Important for FileWave 16.3.0 and later

When/Why

The transition from Technical Preview version 15.1 to the Production version 15.3 of our app signifies a major leap forward in terms of user experience and visual appeal, much like the transformation seen when comparing the Android Play Store and the App Store. In this upgrade, the primary focus has been on completely revamping the user interface (UI) to provide a sleek, modern, and highly intuitive platform that caters to our users' evolving expectations.

With version 15.3.1, the app undergoes a stunning visual makeover, drawing inspiration from the aesthetic excellence of both the Android Play Store and the App Store:

  1. Unified Design Paradigm: Our new UI design unifies elements from both the Android Play Store and the App Store, creating a harmonious blend of familiarity and innovation. This design consistency ensures that users across various platforms feel comfortable while navigating the app.

  2. Intuitive Navigation: Introduces a reimagined navigation system. Users can effortlessly explore and discover content thanks to intuitive menus, recognizable icons, and seamless navigation flows, akin to the ease of navigation in both app marketplaces.

  3. Visual Delight: The new UI is not just about functionality; it's a visual treat. Engaging animations, subtle transitions, and tastefully curated visuals combine to make every interaction with the app a delightful experience, echoing the immersive nature of the Android Play Store and the App Store.

  4. Enhanced Customization: Introduces enhanced customization options, allowing users to personalize their interface just as they would within the Android Play Store and the App Store. Users can arrange and prioritize content according to their preferences, granting them a sense of ownership over their app experience.

  5. Responsive Design: Much like the Android Play Store and the App Store's responsiveness across devices, our app now adapts seamlessly to various screen sizes and orientations. This ensures a consistent and optimized experience whether users are browsing on smartphones, tablets, or desktops.

By transitioning to the 15.3 release of the Kiosk, with a UI overhaul reminiscent of the Android Play Store and the App Store, our app solidifies its commitment to delivering an unparalleled user experience. This transformation isn't just about aesthetics; it's a testament to our dedication to meeting the evolving needs of our users in an engaging, intuitive, and visually striking manner. As we bridge the gap between the old and the new, version 15.3 sets the stage for a future where our app continues to evolve in tandem with user expectations and industry trends.

How

Browse Payloads/Filesets

The "Browse Payloads/Filesets" screen is a central feature within the app that enables users to explore and discover a diverse array of Payloads/Filesets available for access or download. Much like the experience of browsing through the Android Play Store or the Apple App Store, this screen offers users an organized and visually appealing interface that showcases different Payloads/Filesets, each accompanied by relevant details and information.

Key components and elements commonly found on the "Browse Payloads/Filesets" screen include:

iPhone iPad
image.png

image.png

iPhone iPad

image.png

image.png

The "Browse Payloads/Filesets" screen serves as a gateway for users to immerse themselves in the app's content ecosystem, allowing them to discover and access various Payloads/Filesets that align with their needs and interests. Its design, layout, and functionality play a crucial role in delivering a user-friendly and enjoyable browsing experience, reminiscent of the fluid exploration on the Android Play Store and the Apple App Store.

Payload/Fileset details view

The "Details View" is the screen that users encounter after clicking on a specific Payload/Fileset they wish to install or access. This screen provides comprehensive information about the selected Fileset, offering a deeper understanding of its features, functionality, and relevance. Much like the detailed view of an app in the Android Play Store or the Apple App Store, this interface is designed to empower users to make informed decisions about their installation or usage.

Key elements and components often present on the "Details View" include:

iPhone iPad

image.png

image.png

The "Details View" enriches the user's decision-making process by providing an in-depth look into the selected Fileset's attributes. By offering clear explanations, visuals, and relevant information, this interface ensures that users can confidently proceed with the installation or access of the chosen Fileset, enhancing their overall app experience.

Device Information view

The "Device Information" page provides a comprehensive overview of essential details about a specific device, enhancing transparency and management within the app's ecosystem. This page showcases crucial information related to the device and its integration, allowing users to make informed decisions and take necessary actions. The following information is displayed:

iPhone iPad

image.png

image.png

The "Device Information" page serves as a valuable tool for users to gain insights into the device's ownership, enrollment history, status, and app-related details. By presenting this information in a user-friendly manner, the page enhances user management and facilitates seamless interactions within the app's ecosystem.

Logo and primary color selection

The Adding Logo and Primary Color Selection feature enhances customization within the app by enabling users to personalize the visual representation of their profiles or entities. This feature allows users to define their brand identity and establish a cohesive look and feel throughout the app. Here's how the feature works:

The "Add Logo and Primary Color Selection" feature empowers users to infuse their identity into the app's interface, enhancing recognition, and contributing to a personalized and engaging experience for both users and their audiences.

image.png

image.png

How do I change the logo and primary color? It's easy if you follow this guide: Setting the Primary Color, Name and Logo in Kiosk/App Portal (15.3+) but if you are a Hosted customer, you will need Customer Technical Support to help you because you'll need to change files on the server itself.

App Portal and Kiosk 2 Transition History

iOS/iPadOS App Portal

FileWave 15.3 moved the iOS/iPadOS App Portal out of technical preview and made it the supported self-service application. This page records that transition; use the current Kiosk articles for setup and deployment guidance.

FileWave 16 removed Kiosk 1 from macOS and Windows clients. Kiosk 2 is the current desktop self-service application, and Kiosk 1 is end of life.

What changed in FileWave 15.3

  1. Supported iOS/iPadOS application: App Portal moved from technical preview to the supported self-service workflow.

  2. Updated desktop interface: Kiosk 2 replaced the original macOS and Windows Kiosk design.

  3. Reboot visibility: Kiosk can tell users when an assigned Fileset requires a restart.

Desktop Kiosk for macOS and Windows

Kiosk 2 introduced a redesigned desktop interface for browsing and installing administrator-approved content on macOS and Windows.

The transition affected interface behavior and older customization files:

  1. Navigation: Kiosk 2 uses the current browsing and item-detail layout.

  2. Screen sizes: The interface adapts to different window and device sizes.

  3. Branding: Current color, name, and logo settings replace older desktop customization methods.

  4. Legacy cleanup: Pre-15.3 Kiosk customization files may have no effect after the transition.

  5. Duplicate Kiosk icons: One older customization can leave both Kiosk versions visible during a legacy transition; use the cleanup article below.

If an assigned Fileset requires a restart, Kiosk displays that requirement before installation so the user can plan for the interruption.

If you still maintain a pre-15.3 desktop Kiosk configuration, remove obsolete customization files before troubleshooting branding or duplicate Kiosk icons.

FileWave App Portal for iOS (IPA Install)

This legacy IPA installation workflow is retired. Do not create new IPA-based FileWave Kiosk / App Portal filesets for iOS or iPadOS. For current guidance, see IPA-based FileWave Kiosk for iOS/iPadOS - EOL.

Current guidance

FileWave 16.3.0 and later deploy iOS/iPadOS Kiosk through the Apple App Store version of FileWave Kiosk, using Apps and Books / VPP licenses from Apple School Manager or Apple Business Manager.

Automatic updating of iOS/iPadOS Kiosk

What

FileWave Kiosk on iOS and iPadOS is the self-service application that lets users open Kiosk, view Kiosk-associated content, install available items, and trigger actions such as Verify.

Starting with FileWave 16.3.0, the current delivery method for iOS/iPadOS Kiosk is the Apple App Store version of the app, deployed as a VPP / Apps and Books app. As long as FileWave is correctly syncing with Apple School Manager (ASM) or Apple Business Manager (ABM) and the required FileWave Kiosk licenses have already been acquired there, the FileWave server will push the App Store Kiosk to managed devices and replace the older Kiosk.

App Store listing: FileWave Kiosk on the Apple App Store

When/Why

This is the current and recommended behavior for FileWave 16.3.0 and later. The move to the App Store / VPP model aligns Kiosk deployment with Apple's current best practices and with the way other MDM and UEM platforms typically deliver managed iOS and iPadOS applications.

The most important operational change is that administrators should not treat the Kiosk upgrade as fully self-contained anymore. Before upgrading to FileWave 16.3.0 or later, make sure FileWave is connected to ASM/ABM for app-license sync and that enough free FileWave Kiosk licenses have already been obtained. If those preconditions are in place, the transition is straightforward. If they are not, Kiosk deployment can be delayed or fail to appear when expected.

The steps below describe the current behavior in FileWave 16.3.0 and later. If you are still running FileWave 15.3.0 through 16.2.x, or need to compare the older workflow, see the reference section later in this article.

How

Current behavior in FileWave 16.3.0 and later

Before upgrading to FileWave 16.3.0 or later:

A practical example is to acquire about 1500 licenses if you currently manage 1000 devices.

If the licenses are already present before the upgrade and are not reserved by a legacy Kiosk fileset, devices remove the older enterprise Kiosk and install the new App Store Kiosk shortly afterward, typically within a few minutes.

Upgrade note for customers coming from 16.2.x: It is fine, and recommended, to acquire the free FileWave Kiosk licenses in ASM/ABM before upgrading to 16.3.0. The important part is making sure those licenses are not already reserved by the older Kiosk fileset workflow. If you acquire and sync the licenses while still on 16.2.x, FileWave may prompt you to create an iOS App - FileWave Kiosk fileset. That legacy fileset is not required for the 16.3.0+ App Store Kiosk workflow and can reserve the available VPP licenses.

Preventing or recovering from reserved Kiosk licenses

If the legacy Kiosk fileset exists before the 16.3.0 upgrade, the server may reserve the FileWave Kiosk VPP licenses against that fileset. After upgrading, the 16.3.0+ Kiosk deployment can then appear not to push because FileWave believes there are no free licenses available for the new workflow.

To prevent or recover from this state:

  1. Delete the legacy iOS App - FileWave Kiosk fileset if it exists.
  2. Run a Model Update.
  3. Run an Apps and Books / VPP sync with Apple.
  4. Verify the affected devices, or allow them to check in during their normal verification cycle.

If the licenses are only acquired after the upgrade, the change is less immediate. In that case, purchase the licenses, run a Model Update, run an Apps and Books / VPP sync, and then Verify the affected devices. If some other model change is made and pushed, that should also trigger verification. Without that follow-up activity, devices may not receive the new Kiosk until their next normal verify cycle, which can be up to 24 hours later.

There is currently no in-product warning that tells administrators they upgraded without the needed Kiosk licenses. If VPP is configured but the app has not been acquired in ASM/ABM, one useful clue is in filewave_django.log, which can show:

Permissions and profile updates

Because the App Store Kiosk is a new app, iOS/iPadOS treats it as a different application even though it serves the same purpose. Administrators should expect permission prompts such as notifications or location services to appear again after the transition.

The new iOS/iPadOS Kiosk app uses this bundle identifier:

If you deploy a configuration profile that forces notifications or uses any other app-specific payload for Kiosk, review and update that profile for the new bundle identifier before or during the FileWave 16.3.0 transition.

Reference: behavior in FileWave 15.3.0 through 16.2.x

From FileWave 15.3.0 through 16.2.x, FileWave automatically deployed the newer iOS/iPadOS Kiosk through the older built-in workflow rather than the App Store / VPP model used in 16.3.0 and later.

In that earlier behavior:

FileWave Kiosk Displays Company Information

What

FileWave Kiosk / App Portal can display Company Information configured in FileWave Central. Use this to give users a consistent place to find your organization name, support contact details, address, or other help desk information from macOS, Windows, iOS, and iPadOS devices.

Where to configure it

In FileWave Central, open Preferences and select the Organization Info tab. Update the organization details you want users to see in Kiosk / App Portal.

FileWave Admin Preferences window with the Organization Info tab visible.

What users see

macOS and Windows

On macOS and Windows computers, the Company Information panel appears in the Kiosk / App Portal device information view.

Kiosk App Portal device information view showing the Company Information panel.

iOS and iPadOS

On iOS and iPadOS devices, the same organization details appear in the Device Information view along with enrollment and verification information.

iOS App Portal Device Information screen showing company contact information.

Kiosk Package Updates Category (macOS PKG)

Description

Kiosk can show Package Updates for associated PKG Filesets when an older version of the same PKG is already installed on the device.

KioskPackageUpdates.png

Information

When a PKG Fileset is associated to a device as a Kiosk item, the FileWave Client checks the PKG receipts on that device. If it finds a matching receipt and the installed version is older, Kiosk lists the newer item under Package Updates. This category is generated automatically, so it does not appear in either location below:

For example, a device may already have version 1.0 of My Awesome App installed from a PKG.

MyAwesomeApp-1.0.png

Because the app was installed by PKG, the device should have a package receipt. If you know the PKG identifier, you can confirm the installed version in Terminal:

# pkgutil --pkg-info com.myawesomeapp.pkg.app
package-id: com.myawesomeapp.pkg.app
version: 1.0

Upload the newer PKG and create a Kiosk association for it.

MyAwesomeAppFileset-1.1..png

When the device receives the association, the Kiosk drop-down menu adds Available Updates:

KioskAvailableUpdates.png

Selecting that option opens the Kiosk Installer window and shows the Package Updates category.

The older PKG can have been installed through FileWave or locally. This is useful when users can install their own PKGs but you still want Kiosk to show that FileWave is offering a newer version.

PKG version is set inside the PKG by the package developer. If the developer does not increase the package version from the previous release, FileWave cannot show the newer Fileset as a Package Update.

PKG installers have their own version, and that version does not have to match the app version shown in Finder.

Control Which Apps Appear in Kiosk (15.3+)

FileWave Kiosk shows apps and other content assigned for self-service installation. A standard app assignment does not make the app appear in Kiosk, even when Allow removal is enabled.

What changed in FileWave 15.3

Before FileWave 15.3, an app with a standard assignment and Allow removal could also appear in Kiosk as a reinstall path after the user removed it. From FileWave 15.3 onward, that fallback listing is gone: only content with a Kiosk assignment appears in self-service.

Behavior in FileWave 15.3 and later

If an app is missing from Kiosk

  1. Confirm that the app has a Kiosk assignment to the intended device or group.
  2. Confirm that the assignment or Deployment is active.
  3. For Apple Apps and Books content, confirm that the correct token has available licenses.
  4. Update the model and allow the device to check in and refresh Kiosk.

Setting the Primary Colour, Name and Logo in Kiosk/App Portal (16.0+)

What

This article provides step-by-step instructions for configuring the new Kiosk2 and App Portal introduced in FileWave 16.0, including how to set a primary colour, name, and logo for the App Portal / Kiosk on FileWave v16.0+.

When/Why

For brand consistency, options exist (depending on device type) for configuring:

How

FileWave 16+ now offers a Policy Fileset for Kiosk customisation.  Default configurations are applied when no custom Fileset is associated:

From the Create New Fileset option, select Policy:

image.png

Kiosk is the newly added feature:
image.png

The expected minimum image size for custom logo is: 112 x 96, 8-bit/colour RGBA, non-interlaced.

File formats accepted are: SVG, PNG, JPG.

SVG, by their nature, should provide the best looking image, regardless of screen resolution: https://www.w3schools.com/graphics/svg_intro.asp

At this time, the macOS Menu Bar or Windows System Tray Icon requires an additional Fileset.  Details included below.

iOS & iPadOS

App Portal is the name of the Kiosk on Apple mobile devices.  As of FileWave 15.3, the App Portal IPA is not only automatically delivered to devices, but will also update automatically.

Example Customisation Options

Note: For iOS/iPad, you will not see an entry in Fileset Status tab for the Kiosk Policy. After deployment, look under Client Info > Policies tab, and verify that the Kiosk Policy displays "true" in the Active column. If customizations do not display, force quit the Filewave Kiosk app and re-open to initiate the policy.

image.png

Example Customisation Options

Displayed in the below image:

image.png

macOS

Kiosk access is via Menu Bar.

Example Customisation Options

Displayed in the below image:

image.png

The following method provides a pre-configured Fileset for customising this icon with a local file.

The Menu Bar Extra Icon will show in black or white alone.

macOS may automatically hide one or more Menu Bar Extras to prevent crowding of the Menu Bar.

FileWave Kiosk2 Menu Bar Icon.fileset.zip

The Fileset needs to be edited prior to deployment.  Out of the two files shown, the chosen custom image should be named to match the first png: 'tray-icon-macos.png'.  Leave the other file in place.

image.png

 Dragging the custom icon over the shown file should prompt a message as below.  Select Replace.

image.png

Associate with a test device, and once happy with the look, you can broaden the association.

The Fileset is designed to:

Windows

Kiosk is accessed via the System Tray icon.

Example Customisation Options:

Displayed in the below image:

image.png

 

Windows System Tray Icon

The following method provides a pre-configured Fileset for customising this icon with a local file.

FileWave Kiosk2 Sytem Tray Icon.fileset.zip

The provided Fileset contains two revisions:

image.png

The Fileset needs to be edited prior to deployment.  Out of the four files shown, the chosen custom icon should be named to match the two icon files: 'tray-icon-dark.ico' and 'tray-icon-light.ico'.  Leave the other two files in place.

Unlike the other images, the Windows System Tray is using '.ico' files.  These need to be of equal size, e.g. 256x256, 128x128, etc.

Consider exporting the current 'ico' files, editing them with the chosen logo and then upload, if unsure how to create '.ico' files.

FileWave 15.4- (FileWave Client 32bit)

image.png

FileWave 15.5+ (FileWave Client 64bit)

image.png

Dragging the custom icon over the shown files should prompt a message as below.  Select Replace.

image.png

Associate the relevant revision with a test device and once happy broaden the association.

The new image will not show until the FileWave Client is restarted or the user logs out and back in.

FileWave 15.3 - Pre 16.0

The below was introduced in FileWave 15.3.  For for FileWave 16+ please use the above information.

How

iOS & iPadOS

Devices of this nature use the App Portal.  As of FileWave 15.3, the App Portal IPA is automatically delivered to devices and will automatically update.

Customisation Options:

image.png

Logo Customisation

If you are a Hosted Customer then you will need Technical Support to assist with these changes for now.

Direct editing of the IPA is not feasible.  As such, the logo needs to be hosted from the FileWave Server.  The chosen image needs to be placed in the following location:

/usr/local/filewave/django/static/kiosk2/images/

For the IPA to utilise this image, edit the the following file:

/usr/local/filewave/django/filewave/settings_custom.py

The line may be added to the bottom of the custom settings file and needs to include the FQDN of the FileWave Server, along with the named image in the format:

KIOSK_LOGO_URL = 'https://[fully_qualified_domain_name]/filewave/static/kiosk2/images/[file name]'

For example, imagine those details are:

The line added will then appear as:

KIOSK_LOGO_URL = 'https://demo.filewave.ch/filewave/static/kiosk2/images/image.svg'

Supported file formats are:

- SVG
- JPEG
- PNG
- GIF
- Animated GIF
- WebP
- Animated WebP
- BMP
- WBMP

Customise Colour

Colour may be customised by editing the same custom settings file.  The colour should be presented in hex of either 6 or 8 characters.  The line to add (again this may be added to the bottom of the custom settings file), should be of the format:

KIOSK_PRIMARY_COLOR = '[hex colour]'

 For example:

KIOSK_PRIMARY_COLOR = '#e580ff'

or

KIOSK_PRIMARY_COLOR = '#FF0000CC'

The FileWave Server Service should be restarted after modification of the custom settings python file.

macOS

Kiosk access is via Menu Bar.

image.png

macOS Kiosk App

Customisation Options:

3 items can be specified through a single file:

macOS:

/usr/local/sbin/FileWave.app/Contents/MacOS/FileWave\ Kiosk.app/Contents/custom/settings.json

The contents should appear similar to:

{
    "logo_url": "https://buffer.com/cdn-cgi/image/w=1000,fit=contain,q=90,f=auto/library/content/images/size/w1200/2023/10/free-images.jpg",
    "primary_color": "#0465DA",
    "kiosk_app_name": "Custom Kiosk Name"
}

Defined as:

Key Name Key Value Default
logo_url URL path to hosted custom image FileWave Logo
primary_color Colour in hex format, e.g. #RRGGBB #0465DA
kiosk_app_name Text Name of opened Kiosk Window FileWave Kiosk

 It may be necessary to reboot the computer or log out and back in, before changes take effect; particularly if customisation of the older Version 1 Kiosk was removed at the same time that the new Version 2 Kiosk and customisation is applied.

If the custom icon is added as per the instructions for i(Pad)OS devices, the same URL may be used in the above settings.

macOS Menu Bar Extra Icon

The following method provides a pre-configured Fileset for customising this icon with a local file.

The Menu Bar Extra Icon will show in black or white alone.

macOS will automatically hide one or more Menu Bar Extras to prevent crowding of the Menu Bar.

FileWave Kiosk2 Menu Bar Icon.fileset.zip

The Fileset needs to be edited prior to deployment.  Out of the two files shown, the chosen custom image should be named to match the first png: 'tray-icon-macos.png'.  Leave the other file in place.

image.png

 Dragging the custom icon over the shown file should prompt a message as below.  Select Replace.

image.png

Associate with a test device, and once happy with the look, you can broaden the association.

The Fileset is designed to:

Windows

Kiosk is accessed via the System Tray icon.

image.png

Windows Kiosk App

Customisation Options:

All 3 items can be specified through a single file:

Windows (32bit FileWave Client: 15.4-):

C:\Program Files (x86)\FileWave\kiosk\custom\settings.json

Windows (64bit FileWave Client: 15.5+):

C:\Program Files\FileWave\client\kiosk\custom\settings.json

The contents should appear similar to:

{
   "logo_url": "https://my.company/logo.svg",
   "primary_color": "#0465DA",
   "kiosk_app_name": "My Kiosk"
}

Defined as:

Key Name Key Value Default
logo_url URL path to hosted custom image FileWave Logo
primary_color Colour in hex format, e.g. #RRGGBB #0465DA
kiosk_app_name Text Name of opened Kiosk Window FileWave Kiosk

 It may be necessary to reboot the computer before changes take effect; particularly if customisation of the older Kiosk was removed at the same time that the new Kiosk and customisation is added.

If the custom icon is added as per the instructions for i(Pad)OS devices, the same URL may be used in the above settings.

Windows System Tray Icon

The following method provides a pre-configured Fileset for customising this icon with a local file.

FileWave Kiosk2 Sytem Tray Icon.fileset.zip

The provided Fileset contains two revisions:

image.png

The Fileset needs to be edited prior to deployment.  Out of the four files shown, the chosen custom icon should be named to match the two icon files: 'tray-icon-dark.ico' and 'tray-icon-light.ico'.  Leave the other two files in place.

Unlike the other images, the Windows System Tray is using '.ico' files.  These need to be of equal size, e.g. 256x256, 128x128, etc.

Consider exporting the current 'ico' files, editing them with the chosen logo and then upload, if unsure how to create '.ico' files.

FileWave 15.4- (FileWave Client 32bit)

image.png

FileWave 15.5+ (FileWave Client 64bit)

image.png

Dragging the custom icon over the shown files should prompt a message as below.  Select Replace.

image.png

Associate the relevant revision with a test device and once happy broaden the association.

The new image will not show until the FileWave Client is restarted or the user logs out and back in.


Missing Device Message in Kiosk for macOS and Windows (16.0+)

What

Use the Missing Device state when a macOS or Windows device should stop offering self-service Kiosk actions and show return or contact instructions instead. In FileWave Central, right-click the device, choose Client State > Missing, and run a Model Update. The next time FileWave Kiosk opens on the client, it shows the Missing Device message. The message can use the Lost Mode Message, Lost Mode Footnote, and organization contact number from Preferences > Organization Info. If no custom text is set, Kiosk shows: “This device is currently marked as missing. Self-service Kiosk is not available. Please contact your administrator.”

The Missing Device message appears only when the user opens Kiosk. If users need instructions before they open Kiosk, also send a FileWave End-User Notification.

When/Why

This is useful for end-of-year student device returns, overdue loaner laptops, leased-device turn-ins, or any managed device that should display clear return instructions when the user opens Kiosk.

For example, a school can set the message to “End of Year Reminder: Please return your device to the school’s IT office.” A corporate IT team can use the same state to tell an employee where to return a loaner or lease-replacement device.

How

In FileWave Central, right-click the macOS or Windows client, select Client State > Missing, and run a Model Update. The next time the user opens FileWave Kiosk, Kiosk shows the Missing Device message instead of normal self-service content.

For example, in an educational setting, the Kiosk might display a custom message like:

“End of Year Reminder: Please return your device to the school’s IT office. This device is needed for inventory and future student use.”

Configure this text in FileWave Central under Preferences > Organization Info. You can set the Lost Mode Message, add a Lost Mode Footnote, and include an organization contact number that appears as a clickable link.

Kiosk shows the Missing Device message only after Kiosk opens. If you need the user to see return instructions immediately, send a pop-up through FileWave End-User Notifications and include a link to your return form or internal instructions.

While the device remains in the Missing state, Kiosk blocks installation, uninstallation, and normal self-service access until the device is recovered, replaced, or moved out of the Missing state.

Notes on the Missing Device message

image.png

image.png

App Portal on iOS/iPadOS devices that don't support the application (15.3+)

What

If you have an iOS/iPadOS device that is older than what is officially supported by FileWave and you are working ok but you can't get the Kiosk (App Portal) to install.

When/Why

You can revert for now to the old WebClip using the documented process here. This is a temporary workaround.

How

It is possible to activate Web Clip of an old App Portal on devices which don't support new App Portal.

  1. Create new Apple Profile → Web Clip Profile (can be done in both FileWave Central and Anywhere)

    image.png


  2. Fill in URL field with: https://fqdn:20443/ios/recommended_apps/%device_id%#apps replacing "fqdn" with your server's DNS name.
  3. Deploy profile to desired device(s).

Applications Preventing Reboot (macOS/Windows)

Description

When a Fileset requires a reboot, the FileWave client can warn the user to "Quit All Running Processes" before the restart continues.

Some apps and background processes do not respond cleanly when FileWave Kiosk uses "Quit all" or "Quit Application". A process may restart immediately through LaunchDaemon, or it may ignore the signal FileWave sends. When that happens, users can be blocked from installing Filesets that have the Requires Reboot flag set.

Information

The warning itself is expected, but some listed processes can be surprising. For example:

S8JE03rDHgojhv40-embedded-image-teimxkjz.png

A background service can appear even when the user is not actively using the related application.

Solution

Requirements to prevent this experience are:

You can configure settings.ini to ignore specific apps or processes. Create a Fileset containing settings.ini, then associate it with the target clients. The destination folder depends on the operating system:

macOS
/usr/local/sbin/FileWave.app/Contents/Resources/fwGUI.app/Contents/custom
Windows (FW v15.4.2 or lower)
C:\Program Files (x86)\FileWave\custom
Windows (FW v15.5.0 or higher)
C:\Program Files\FileWave\kiosk\custom

The desktop Kiosk reads these changes after the user logs out and logs in again.

To stop an unexpected process from blocking the reboot, first identify the listed app's bundle ID on macOS or process name on Windows. 

Obtain Bundle ID or Process Name

Windows

OvnDIMUfAFkBZOQo-embedded-image-xe0alvhz.png

In this example, excluding Notepad requires notepad.exe.

macOS

~/Library/Application\ Support/FileWave/FWGUI.log

There should be lines similar to the following, for each process that has prevented the reboot:

|DEBUG|INSTALLER|[addProcessInfo] new process added /Applications/Utilities/Terminal.app pid 67345 bundleID com.apple.Terminal
|DEBUG|INSTALLER|[addProcessInfo] new process added /Applications/Preview.app pid 73400 bundleID com.apple.Preview
|DEBUG|INSTALLER|[addProcessInfo] new process added /Applications/TextEdit.app pid 73718 bundleID com.apple.TextEdit

Configure 'settings.ini'

Configure settings.ini with the following format. Use a comma-separated list for bundle IDs or process names:

[General]
ignoredApplications=com.bar, com.foo

For the example of Windows Notepad, it should read:

[General]
ignoredApplications=notepad.exe

For common Windows shell processes that can appear during reboot prompts, consider ignoring the following:

[General]
ignoredApplications=StartMenuExperienceHost.exe,SearchApp.exe,TextInputHost.exe

For the example of macOS TextEdit, it should read:

[General]
ignoredApplications=com.apple.TextEdit

Combining this with current generic settings, it may look something like:

show_top_downloads=false
window_title="My Customized Kiosk"
hide_system_tray=false

[General]
ignoredApplications=com.adobe.acc.AdobeDesktopService,com.apple.TextEdit

Deployment

Deploy settings.ini to the following locations: 

macOS

/usr/local/sbin/FileWave.app/Contents/Resources/fwGUI.app/Contents/custom

Windows (FW 15.4.2 and lower)

C:\Program Files (x86)\FileWave\custom

Windows (FW 15.5.0 and higher)

C:\Program Files\FileWave\kiosk\custom

Manual Trigger of FileWave Kiosk for macOS and Windows (15.3+)

What

By default, the Kiosk icon is only shown when one or more assignments between Filesets and Devices are created; set as Kiosk installation.  

It may be desirable to view the Kiosk even where Kiosk assignments do not exist, since the Kiosk also shows other details, which may be useful to the user, e.g. device information.  

image.png

image.png

The following provides information for triggering the Kiosk manually.

When

Prior to Kiosk v2, it was possible to provide a custom file to show the Kiosk icon, regardless of assignments.  Currently Kiosk v2 has no similar option.

How

For both macOS and Windows, the executable file may be targeted directly from a shell:

macOS (shell):

/usr/local/sbin/FileWave.app/Contents/MacOS/FileWave\ Kiosk.app/Contents/MacOS/FileWave\ Kiosk

Windows (PowerShell):

& "C:\Program Files\FileWave\client\kiosk\FileWaveKiosk.exe"

GUI

As a script line, this isn't the most user friendly method for users to execute and of course the obvious place to have something for users to self trigger would be in the FileWave Kiosk, but clearly that is nonsensical.  There are alternatives though.

macOS

There is already a KB on integration of the amazing 3rd party tool: 'Hello-IT'

Through this tool, it could be possible to provide users with another method to open the Kiosk, where Kiosk assignments do not exist:

image.png

By following the provided guide on Hello-IT, the small one-liner script could be added as one of the sub menu items.  When clicked, FileWave Kiosk would launch.

Windows

A similar trick could be used on Windows with another amazing 3rd party tool: 'About My Device'

Although it doesn't immediately offer the option to add scripts in the way Hello-IT does, it can be hijacked to do so.  One of the features is an option to trigger a script to provide logs:

image.png

However, by editing the configuration and script files, this could be renamed and the script altered to include the PowerShell one-liner from above:

AboutMyDevice_Systray.ps1

image.png

Collect_Logs.ps1

image.png

Example

image.png

Of course, it might be desirable to keep the option to send logs, so choose the best method for adaption to suit requirements.

Additionally, there may be other 3rd party tools that could be of consideration.  Do please let other FileWavers know if other tools could be considered as appropriate or better.

FileWave End-User Notifications

FileWave End-User Notifications

FileWave End-User Notifications (15.5+)

What

With the release of FileWave version 15.5.0 and onward, administrators can now send custom messages to enrolled devices directly from FileWave Anywhere, FileWave Central, or through API calls. These messages appear as system notifications on users’ devices, allowing administrators to communicate important information efficiently and effectively, thereby enhancing user engagement and experience.

Key Functionality

Send Notification requires Permissions granted within the Managed Administrator view.  'fwadmin' account will automatically be granted such permissions, but other accounts or groups should be enabled as desired.

When/Why

When to Use

Why Use This Feature

How

Sending a Notification

  1. In FileWave Central right click on a Client, Group or Smart Group and pick Send Notification...
  2. Ensure that all of the options are set how you want. 
    Author: Your name
    Title: The title of the notification dialog
    Text: The detailed text to display
    Add Link: This allows you to have a clickable link on the notification
    Expiration date: After this date and time the system will not continue to try to get the notification to the selected devices.

    image.png

  3. A confirmation dialog will ask you to confirm sending and tell you the number of devices being messaged. Check that the number reflects what you think it should be. If it says 500 but you meant to message 5 devices then click Back and then Cancel if you want to try to pick devices again. Once you click the final Send button on the confirmation dialog there is no canceling it.

If you selected a Group or Smart Group it is important to know that the targets will be the devices that were in that group at the time you sent the message. If a device enters the group tomorrow it will not get the message even if the message has not expired yet. Similarly if a device leaves the group after you already sent the message it will still receive the message when it comes online.

User Experience

Examples of what is seen by users

iPadOS / iOS

image.png

macOS

image.png

Android

image.png

Windows

image.png

ChromeOS

image.png

Digging Deeper

Important Considerations

General (All Platforms)

FileWave Central will show the local timezone of the computer running FileWave Central.  FileWave Server will convert the set time as UTC instead and expire the notification at that UTC time.

Platform-Specific Behaviors

Troubleshooting: Requirements for Notifications

Notification activity is logged in the Audit History, available through FileWave Central's Assistant drop down menu.  Entries may appear as below

2026-01-02 15:42:08.820 [P:60] <ip:10.5.154.176> user:fwadmin, session hash: [a big number] - Send user notification (title: Today's Treat, body: Doughnuts for all in the cafe!!!!, URL: None, expiration date: 2026-01-02T15:44:00+00:00) to 1 devices: {54561} - SUCCESS

 

FileWave End-User Notifications

Force Enable Notifications on iOS and macOS for FileWave Kiosk

What

To ensure that notifications from the FileWave Kiosk and End User Notifications are consistently displayed on macOS and iOS/iPadOS devices, administrators can deploy an Apple Profile that forces notifications for the relevant Kiosk app bundle identifiers. This profile enforces the display of notifications and prevents end users from disabling them, ensuring important messages and alerts are always visible to users.

Bundle identifier note: the macOS Kiosk app remains com.filewave.kiosk2. For iOS/iPadOS, use com.filewave.ios.app.kiosk2 on FileWave 15.3.0 through 16.2.x, and use com.filewave.ios.app.kiosk3 on FileWave 16.3.0 and later.

When/Why

When to Use

Why Use This Feature

How

You can either use our premade Fileset: Profile - Apple FWKiosk Notifications.fileset.zip or you can create it yourself using the below steps. If you are on FileWave 16.3.0 or later, review the iOS/iPadOS entry in that profile and update it to com.filewave.ios.app.kiosk3 before deployment.

In FileWave Central or Anywhere you can create the profile. The images that follow are from Central, but the process is the same in Anywhere. 

image.png

image.png

Type in the Bundle Identifier and then select it and click Next
Bundle Identifier for macOS Kiosk: com.filewave.kiosk2 and then repeat for iOS/iPadOS using com.filewave.ios.app.kiosk2 on FileWave 15.3.0 through 16.2.x or com.filewave.ios.app.kiosk3 on FileWave 16.3.0 and later

image.png

    • Set up behavior that you would like for the notifications and click Save

image.png

Device Behavior

Troubleshooting

Troubleshooting

Checking what version of iOS/iPadOS App Portal is being pushed out (15.3+)

What

How do I know what version of App Portal (Kiosk) is being pushed out to iOS/iPadOS devices?

When/Why

After a FileWave upgrade, there likely will be a new version of the iOS/iPadsOS IPA pushed out through the automatic upgrade process. Because this process is a bit invisible, verifying what the server believes is the version it is pushing out is sometimes necessary.

How

In FileWave Central, go to Assistants -> Manage Administrators and then pick your user account, though depending on permissions, you may want to use fwadmin. Grab the base64 token seen below in the image, including the = at the end of it.

image.png

Now you can ask the server. Replace ezk5ODxxxmE0OyyyyyyyOX0= below with your token, and replace support2.filewave.net with your server's DNS name.  

Here is a command you can run in Terminal.app on a macOS system or any system that has curl installed:

curl -H "Authorization: ezk5ODxxxmE0OyyyyyyyOX0=" https://support2.filewave.net/filewave/api/kiosk/internal/kiosk-status

Here is a PowerShell example of the same command:

# Define the URL to make the request
$url = "https://support2.filewave.net/filewave/api/kiosk/internal/kiosk-status"

# Define the headers, including the Authorization token
$headers = @{
    "Authorization" = "ezk5ODxxxmE0OyyyyyyyOX0="
}

# Use Invoke-WebRequest to make the GET request with headers
$response = Invoke-WebRequest -Uri $url -Headers $headers -Method Get

# Output the content of the response
$response.Content

The output of the command will be something like below. 

{"installed":{"ipa_url":"https://fw-kiosk-v2-ipas.filewave.cloud/15.3.1/App_Portal_15.3.1.ipa","ipa_md5":"81628b83dad72e274ef93ea031db1484","build_date":"2024-03-27T20:08:49.192563Z","bundle_version":"15.3.1"},"latest":{"ipa_url":"https://fw-kiosk-v2-ipas.filewave.cloud/15.3.1/App_Portal_15.3.1.ipa","ipa_md5":"81628b83dad72e274ef93ea031db1484","build_date":"2024-03-27T20:08:49.192563Z","bundle_version":"15.3.1"},"available_versions":["15.3.1"]}%  
Troubleshooting

Removing pre-15.3 Kiosk Customizations (macOS/Windows)

Prior to FileWave 15.3 you had a method of customizing the Kiosk that is not used in 15.3 and beyond. Some of the customizations will be ignored with 15.3, but there are things you'll want to potentially remove and you may want to stop pushing out customizations that are no longer enforced. This article is a paired down version of the old article and simply contains information on what customizations you might have had in the past so you can look to potentially remove the files/edits. 

The look of the FileWave desktop Kiosk was customized using Qt Style Sheets. You would have had to create a file named fwGUI.qss and deploy it to clients in the right location. Several icons were also customizable by placing your custom icon in the right place with the right file name. All of this can be deployed via a Fileset.

Check out Setting the Primary Color, Name and Logo in Kiosk/App Portal (15.3+) and Applications Preventing Reboot (macOS/Windows) for the things that can be customized in FileWave 15.3 and beyond.

Deploy

fwGUI.qss -- You would have created a Fileset containing the fwGUI.qss and the icons, then associate it to the desired clients. The directory where these files was placed depends on the operating system. In 15.3 and beyond you don't want to push the qss file or icons out as they will have no effect on the Kiosk.

macOS
/usr/local/sbin/FileWave.app/Contents/Resources/fwGUI.app/Contents/custom
Windows
C:\Program Files\FileWave\custom (might be "Program Files (x86)", depending on the platform)

The changes will only be visible in the desktop Kiosk after the user logs out and logs in again.

Menu Bar/System Tray Settings

settings.ini -- contained generic kiosk ui settings. Especially important is that if hide_system_tray = false that you will end up with 2 icons for the Kiosk where one is the old Kiosk if you are on FileWave 15.3.

Example
window_title = "Your New Window Title"
show_top_downloads = true
hide_system_tray = false

Customizable icons

You might have included icon files that you used to replace them in Kiosk before 15.3. These icons will not appear in 15.3 or newer.

File name Description Example Pixel Size
action_back.png Icon for the "Back" action in the Software Installation dialog DesktopKiosk-back.png 48x48
action_forward.png Icon for the "Forward" action in the Software Installation dialog DesktopKiosk-fwd.png 48x48
background_icon.png Icon used for the watermark (FileWave icon) 512x512
rating_star_half.png Icon for half a rating star DesktopKiosk-star_half.png 40x40
rating_star_off.png Icon for a rating star that is off DesktopKiosk-star_off.png 40x40
rating_star_on.png Icon for a rating star that is on DesktopKiosk-star_on.png 40x40
tray_icon.png System tray icon. If missing, the background_icon.png is used. (FileWave icon) 16x16
warning.png Warning icon, displayed when a fileset has problems (e.g. missing VPP user) DesktopKiosk-error_red-cir_status.png 64x64



Troubleshooting

Kiosk with macOS in a VM: Enabling Metal support

Description

The FileWave Kiosk requires Metal support when it runs in macOS. VMware does not enable Metal support for macOS VMs by default. You can add the VMX settings below for testing, but treat this as a workaround: the VM may become unstable and the host Mac may kernel panic.

Use cautiously

Without Metal support, the Kiosk will not open and the user logs may show messages like these:

2024-05-13 10:40:15.324 FileWave Kiosk[1241:5674] Could not acquire Metal device.
2024-05-13 10:40:25.936 FileWave Kiosk[1241:5674] Unable to create FlutterView; no MTLDevice or MTLCommandQueue available.

Configuration

Shut down the VM before editing its configuration. Do not edit the file while the VM is running or paused.

Open the folder that contains the VM and find its .vmx file. For example, if the VM folder is named macOS 12.vmwarevm, the VMX file may be named macOS 12.vmx:

/Users/sholden/Documents/Virtual\ Machines/macOS\ 12.vmwarevm/macOS\ 12.vmx

Add these two lines:

appleGPU0.present = "TRUE"
svga.present = "FALSE"

Start the VM after saving the file. To undo the change, shut down the VM again and remove the same two entries.

You may also need to define the display size in the same file. This example uses 1920 x 1080:

appleGPU0.screenWidth="1920"
appleGPU0.screenHeight="1080"

This workaround may let the Kiosk launch in a VMware test VM, but in practice the VM often crashed or became unusable. Because the host Mac may also kernel panic, avoid this configuration unless the test requires it. Remove the entries when the test is complete.

Troubleshooting

Resolve FileWave Kiosk SSL and Manifest Validation Errors (15.3+)

What

FileWave Kiosk installation can fail on macOS or Windows with a manifest validation error followed by an SSL error. The example below was first documented with Kiosk 15.3.1.

When/Why

This usually means the device cannot reach or trust the Kiosk package host. Common causes include a content filter that classifies the host as unknown, a proxy or firewall block, or SSL inspection that changes the certificate chain.

"InstallApplication	command error		2024-04-22T07:36:38	2024-04-22T07:36:38				Could not validate manifest..An SSL error has occurred and a secure connection to the server cannot be made.	com.filewave.ios.app.kiosk2	"

How

Check the network path used by the affected device:

  1. Check the proxy, firewall, and content filter: Confirm that they allow the Kiosk package host and do not replace its certificate with an untrusted chain.

  2. Allow the required URLs: Add the following entries to the appropriate allowlist:

    • https://fw-kiosk-v2-ipas.filewave.cloud/
    • *.filewave.cloud

    The exact rule depends on your network security product. Apply the change to the same network path used by the affected devices.

  3. Retry the installation: After the network rule is active, send the installation again and check the device command history.

# Example command to verify if the URL is accessible from your network
curl -Iv https://fw-kiosk-v2-ipas.filewave.cloud/

Run the command from the same network path as an affected device when possible. If the host is reachable but certificate validation still fails, inspect SSL/TLS interception and the device's trusted certificate chain.

Digging Deeper

The combined log message points to a network or trust failure while the device validates the Kiosk manifest. Fix reachability and certificate trust first, then retry the Kiosk command.