Install the desktop widget
Install the desktop widget on your staff's Windows computers with an MSI file.
- You need admin access to do this. About roles
The desktop widget is a Windows app. It shows a website widget on your staff's computers. Your IT team installs it with an MSI file, for example through a Group Policy (GPO) or SCCM. You get the MSI file from Yump.
The app is installed per user. It starts each time the user logs in to Windows.
Find your website ID and widget ID
The install needs two IDs:
- WEBSITE_ID: the ID of the website. It is in the script on the website's Installation step, in the call
window.oiwidgets.init("WEBSITE_ID",u). - WIDGET_ID: the ID of the website widget. The widget must use Using JavaScript. The ID is in its call
window.oiwidgets.show('WIDGET_ID').
Install the MSI file
Set the properties as arguments to msiexec:
msiexec /i <installer>.msi WEBSITE_ID=123456 WIDGET_ID=654321
You can also put the properties in a transform file (MST) and use it during the install.
MSI properties
The install writes these properties to a settings.ini file in the app folder.
| Property | Required | What it sets | Default |
|---|---|---|---|
| WEBSITE_ID | Yes | The ID of the website. | |
| WIDGET_ID | Yes | The ID of the website widget. | |
| TIME | No | The earliest time of day the widget can show, in 24-hour format. | 00:00 |
| DAYS | No | The weekdays the widget can show. | mon,tue,wed,thu,fri,sat,sun |
| MONTHS | No | The months the widget can show. | jan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec |
| OCCURRENCE | No | first, last or all. Show the widget only on the first or last matching day of the month, or on every matching day. | all |
The stream can limit further when the widget shows.
Example: after 10:00 on Mondays, Thursdays and Fridays, August to December
msiexec /i <installer>.msi WEBSITE_ID=123456 WIDGET_ID=654321 MONTHS=aug,sep,oct,nov,dec DAYS=mon,thu,fri TIME=10:00
Example: after 15:00 on the first Monday of August and September
msiexec /i <installer>.msi WEBSITE_ID=123456 WIDGET_ID=654321 MONTHS=aug,sep DAYS=mon TIME=15:00 OCCURRENCE=first
Share one settings file
The install writes one more property, SETTINGS_FILE_PATH, to a separate app-bootstrap.ini file. It sets where the app reads settings.ini: a file path or an http(s) URL. The default is the app folder. With SETTINGS_FILE_PATH, you can keep one settings.ini on a network drive or a web server. Then you can change the settings without reinstalling.
Example settings.ini
[config]
website_id=600f3e4a96e50bc7c12c4fb9
widget_id=600f3e5196e50bc7c12c4fba
time=10:00
days=mon,thu,fri
months=aug,sep,oct,nov,dec
occurrence=all