---
title: Acquire Assist Plugin for Wayfinder
description: Acquire Assist Plugin for Wayfinder
---
[Skip to content](https://knowledge.acquiredigital.com/acquire-assist-plugin-for-wayfinder#main-content)
English
Show submenu for translations
[More support](https://knowledge.acquiredigital.com/kb-tickets/new?hsLang=en) [Support Portal](https://knowledge.acquiredigital.com/support?hsLang=en)
Open main navigation
Close main navigation
- English
Show submenu for translations
- [More support](https://knowledge.acquiredigital.com/kb-tickets/new)
- [Support Portal](https://knowledge.acquiredigital.com/support)
- Contact us
Contact us
How can we help you?
- There are no suggestions because the search field is empty.
1. [Acquire Digital Knowledgebase](https://knowledge.acquiredigital.com/?hsLang=en)
2. [Acquire Assist](https://knowledge.acquiredigital.com/acquire-assist?hsLang=en)
# Acquire Assist Plugin for Wayfinder
## Overview
A Wayfinder plugin used to communicate with the **Acquire Assist kiosk App** via the,
**See: Assist API**
The **AA Kiosk App** connects to an **Acquire Assist Server** which links the kiosk user to an **Operator Client.**
The plugin has a button to request assistance, and popups to show video etc. once connected.
The assistance button can be disabled, and the plugin controlled externally by Wayfinder messages. e.g. the **Main Menu** assist button uses this.
#### **Usage**
The **Plugin** should be add to **Overlays** at a position where it will appear in front over everything, and activated with the **Enable.Assistance** variable.
On startup of the plugin will a) save **AA Kiosk App Settings** from Wayfinder variable to an ini file and b) run the **AA Kiosk App** from the projects NeverSend\\Apps\\ folder. It will attempt to re-start the app should it crash. The location of the app is configurable, and can be left out if run from elsewhere.
The app will be included in the project and the latest version (as of writing!) can be found here: **N:\\Internal Jobs\\AcquireAssist\\2.0.0.11\\Kiosk\\Standalone API\\**
The **Plugin** connects to the **AA Kiosk App** via the **Assist API** once the app has started. It will re-connect if the connection drops. Re-connect frequency is configurable.
An **Assist Button** is shown. Clicking this opens a **Confirmation Popup**. You can also invoke this popup via Wayfinder messages or from the **Main Menu** assist button.
On clicking continue the popup shows a connecting spinner, and once connected to on **Operator Client** it will show a **Call Popup**.
The **Call Popup** has a **hang-up** button and may show the **operator video** if they turn that on. It also shows the **audio status** (connected or on-hold)
#### **Internal Messages**
Below are the messages that can be used to communicate with other plugins in Wayfinder:
- **AcquireAssistStatusChanged** - Sent when the status of the Assist API is updated. Params include the state and the number of operators available.
- **AcquireAssistRingtoneStatusChanged**- Sent when the Ringtone status is updated from the Assist API. One argument "true" for when started and "false" for when stopped. **AcquireAssistRequestAssistance** - Sent from an external plugin to request assistance via the Assist API. The Main Menu assist button sends this when clicked.
- **AcquireAssistCancelAssistance** - This can be sent by an external plugin to cancel assistance via the Assist API.
- **AcquireAssistButtonState** - Sent when the Assist button's state is changed to Ready, Busy, or Unavailable. It is sent even when the Assist button is turned off. The Main Menu assist button uses this to change it style to Normal, Down, or Disabled.
#### **Configuration**
Below are an example config and style sheet.
The system is configured by overriding the following Wayfinder variables:
- **Enable.Assistance** Run the plugin
- **AcquireAssist.ShowAssistButton**
Show an Assist button (you can still control it via aWayfinder message)
- **AcquireAssist.HideIfNotAvailable**
The assist button will hide, instead of being disabled, when Assist is not avalable.
- **AcquireAssist.KioskApp**
The Assist Kiosk App to run and keep alive. Leave this blank if its run elsewhere.
- **AcquireAssist.IP**
- **AcquireAssist.Port**
- **AcquireAssist.ServerPortUDP**
These server connection settings are saved to the Kiosk App ini file prior to running it.
- **AcquireAssist.UserName**
**Id$$\_machineid**
**AcquireAssist.Password**
**Id$$\_machineid**
**AcquireAssist.KioskName**
These login settings are passed via the API when connecting. Kiosk Name can include these special tags: $$\_playername - $$\_machineid
- **AcquireAssist.DDA.X**
- **AcquireAssist.DDA.Y**
Amount to move controls on DDA
- **AcquireAssist.AssistButton.X**
- **AcquireAssist.AssistButton.Y**
- **AcquireAssist.AssistButton.UseDDA**
Position of the Assist button and whether to move with DDA (you might only want popups to move)
- **AcquireAssist.ConnectPopup.X**
- **AcquireAssist.ConnectPopup.Y**
Position of the Connect popup
- **AcquireAssist.CallPopup.X**
- **AcquireAssist.CallPopup.Y**
Position of the call popup
- **AcquireAssist.Colour.Connected**
- **AcquireAssist.Colour.OnHold**
- **Colour.Action.Two.Button**
- **Colour.Action.Two.Button.Down**
Various colours
#### **Main Menu**
To add an assist button to the **Main Menu** add this line to its layout.xml:
```
```
- [Software Installers](https://knowledge.acquiredigital.com/software-installers?hsLang=en)
- [StudioDX & DX Player](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#main-content)
- [Studio DX FAQ's](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#studio-dx-faqs)
- [Acquire StudioDX User Documentation](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#acquire-studiodx-user-documentation)
- [User Guide](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#user-guide)
- [Widgets](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#widgets)
- [Transitions](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#transitions)
- [Warning Alerts](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#warning-alerts)
- [Setup App](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#setup-app)
- [Project Apps](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#project-apps)
- [StudioDX Stream Deck Plugin](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#studiodx-stream-deck-plugin)
- [XML Formats](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#xml-formats)
- [Acquire Wayfinder](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#main-content)
- [Map Editor - Atlas](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#map-editor-atlas)
- [Devices](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#devices)
- [CMS User Management](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#cms-user-management)
- [Project Settings](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#project-settings)
- [The Map Editor](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#the-map-editor)
- [JS Web Map UI V2.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-map-ui-v2-0)
- [JS Web Map API V2.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-map-api-v2-0)
- [JS Web Directory API V1.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-directory-api-v1-0)
- [Wayfinder Map API](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#wayfinder-map-api)
- [Broadsign Integration](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#broadsign-integration)
- [Adverts Plugin](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#adverts-plugin)
- [Wayfinder FAQs](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#wayfinder-faqs)
- [Beacon](https://knowledge.acquiredigital.com/beacon?hsLang=en#main-content)
- [Devices](https://knowledge.acquiredigital.com/beacon?hsLang=en#devices)
- [Layouts](https://knowledge.acquiredigital.com/beacon?hsLang=en#layouts)
- [Information Displays](https://knowledge.acquiredigital.com/beacon?hsLang=en#information-displays)
- [Playlists](https://knowledge.acquiredigital.com/beacon?hsLang=en#playlists)
- [Project Settings](https://knowledge.acquiredigital.com/beacon?hsLang=en#project-settings)
- [Activity Logs](https://knowledge.acquiredigital.com/beacon?hsLang=en#activity-logs)
- [Acquire DOOHAD](https://knowledge.acquiredigital.com/acquire-doohad?hsLang=en#main-content)
- [DOOHAd Standalone Installer & Advert Configuration Tool](https://knowledge.acquiredigital.com/acquire-doohad?hsLang=en#doohad-standalone-installer-advert-configuration-tool)
- [DooHad FAQs](https://knowledge.acquiredigital.com/acquire-doohad?hsLang=en#doohad-faqs)
- [Acquire Vision User Guide](https://knowledge.acquiredigital.com/acquire-vision-user-guide?hsLang=en)
- [Acquire StudioDX & Wayfinder Trial Install Guides](https://knowledge.acquiredigital.com/acquire-studiodx-wayfinder-trial-install-guides?hsLang=en#main-content)
- [Acquire Wayfinder Trial](https://knowledge.acquiredigital.com/acquire-studiodx-wayfinder-trial-install-guides?hsLang=en#acquire-wayfinder-trial)
- [Acquire StudioDX Trial Installation Guide](https://knowledge.acquiredigital.com/acquire-studiodx-wayfinder-trial-install-guides?hsLang=en#acquire-studiodx-trial-installation-guide)
- [Acquire Assist](https://knowledge.acquiredigital.com/acquire-assist?hsLang=en)
- [Acquire Premier](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#main-content)
- [Quick Start Guide.](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#quick-start-guide)
- [Acquire Editor User Guide](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#acquire-editor-user-guide)
- [Toolbox](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#toolbox)
- [The PLUS! Network](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#the-plus-network)
- [Acquire Site Manager](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#acquire-site-manager)
- [Apps & Helpers Manuals](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#apps-helpers-manuals)
- [Minute Master-Classes](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#minute-master-classes)
- [Acquire Editor FAQs](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#acquire-editor-faqs)
- [Acquire Player FAQs](https://knowledge.acquiredigital.com/acquire-player-faqs?hsLang=en)
- [Site Manager](https://knowledge.acquiredigital.com/site-manager?hsLang=en#main-content)
- [Site Manager User Guide](https://knowledge.acquiredigital.com/site-manager?hsLang=en#site-manager-user-guide)
- [Site Manager FAQs](https://knowledge.acquiredigital.com/site-manager?hsLang=en#site-manager-faqs)
- [Watchdog](https://knowledge.acquiredigital.com/watchdog?hsLang=en#main-content)
- [Watchdog User Guide](https://knowledge.acquiredigital.com/watchdog?hsLang=en#watchdog-user-guide)
- [Watchdog FAQs](https://knowledge.acquiredigital.com/watchdog?hsLang=en#watchdog-faqs)
- [FAQs](https://knowledge.acquiredigital.com/faqs?hsLang=en)
[](http://acquiredigital.com)
[mailto:email@email.com](mailto:email@email.com)
Copyright © 2026, Acquire Digital