|
|
|
@@ -14,21 +14,16 @@ Sound and Notifications Test (15 min)-------------------------------------------
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
0) Prepare:
|
|
|
|
|
- Sounds are enabled by default, but we now have a key that can enable/disable them from the server as well. This was necessary to prevent crashing on systems without connected sound devices. If this key exists in your spark.conf, please make sure it's enabled = true (or simply remove it)
|
|
|
|
|
SoundNotifications {
|
|
|
|
|
enabled = true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
- open an OrderBook, then click the Window Settings button in the Spark Menu to open the OWSD.
|
|
|
|
|
- *add a sound trigger.
|
|
|
|
|
|
|
|
|
|
1) Sound Preview/Author Credentials:
|
|
|
|
|
1) Sound Preview:
|
|
|
|
|
First: check "Play Sound" (if it is not already checked)
|
|
|
|
|
Perform the following steps for each trigger in the dropdown, the variable sound will be reffered to as 'X'
|
|
|
|
|
- select 'X'
|
|
|
|
|
- hover over the "?" help button next to the dropdown
|
|
|
|
|
- the tool tip should contain some basic info about 'X':
|
|
|
|
|
i) [Required] the official name (it may not exactly match the name in the dropdown, but it should be similar in subject matter, e.g. "Reload" vs "1911 Reload")
|
|
|
|
|
ii) [Required] the author's name or username (e.g. "zstewart09")
|
|
|
|
|
iii) [Optional] a url to the author's own site/account page (e.g. https://freesound.org/people/kianda/sounds/)
|
|
|
|
|
- the last line in the tool tip should say: "Click to preview, Ctrl + click to copy to clipboard"
|
|
|
|
|
- click the "?" button to confirm the preview works,
|
|
|
|
|
- ctrl + click the "?" button, then paste the result in a text editor, it should be identical to the tool tip (except the last line, with clicking instructions)
|
|
|
|
|
|
|
|
|
|
2) Duplicate sound triggers do not cause crash:
|
|
|
|
|
- *delete the sound trigger you added in the previous step.
|
|
|
|
@@ -85,47 +80,8 @@ Prepare: open a ladder for a security that has steady market data activity (in t
|
|
|
|
|
- enter a limit order ACROSS the market to trigger an immediate fill.
|
|
|
|
|
- this time, the "When order is filled" sound should play; the "When order is canceled" sound should not be heard.
|
|
|
|
|
|
|
|
|
|
7) Toast Notifications:
|
|
|
|
|
A) Simultaneously with sounds:
|
|
|
|
|
- in the OWSD, check "Show Notification" for both the "filled" and "canceled" sound-triggers, then click apply.
|
|
|
|
|
- enter a 1 lot limit order across the market to trigger an immediate fill.
|
|
|
|
|
- as soon as it is filled, you should see a notification AND hear the sound.
|
|
|
|
|
B) Without sounds:
|
|
|
|
|
- in the OWSD, uncheck "Play Sound" in the "When order is filled" trigger.
|
|
|
|
|
- you should be a pro by now, no more redundant baby talk: trigger an immediate fill.
|
|
|
|
|
- you should see the filled notification, but not hear the sound.
|
|
|
|
|
C) Rapid fire fills:
|
|
|
|
|
- open a Fills window.
|
|
|
|
|
- trigger a rapid succession of 1 lot limit order fills as you did earlier, by repeatedly clicking on a price well-across the market
|
|
|
|
|
- the toast notifications should keep pace with the fills, as they arrive in the Fills window.
|
|
|
|
|
- if it is hard to tell, most likely that means it is keeping up.
|
|
|
|
|
- if the notifications continue to arrive more than a few seconds after the fills window has finished updating.
|
|
|
|
|
D) Settings:
|
|
|
|
|
First: in the OWSD, check "Play Sounds," then click OK (both sounds and notifications should be enabled now).
|
|
|
|
|
----Notes---------------------------------------------------------------------------------------------------------------
|
|
|
|
|
- you will be opening the Notification Settings Dialog (NSD), there are only a couple of properties in this form,
|
|
|
|
|
so there is no "Apply" button, only an "OK" button which applies the changes and closes the window.
|
|
|
|
|
the steps will not tell you to open the NSD again each time you need to change a different setting, but yes, that is what you need to do.
|
|
|
|
|
If this is terribly annoying, tell John and he might add an "Apply" button for you ;)
|
|
|
|
|
- this dialog contains "application-level" settings, which override Window settings.
|
|
|
|
|
- if sounds/notifications are disabled here, any sounds/notifications in OrderBook Window Settings will be ignored.
|
|
|
|
|
- COMING SOON: if they are disabled, the Orderbook settings dialog will indicate this to the user,
|
|
|
|
|
to avoid potential frustration they might endure as they wonder why the notifications/sounds aren't working.
|
|
|
|
|
-------------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
- from the launcher: Settings -> Settings to open the Notification Settings dialog.
|
|
|
|
|
Note: this dialog also has 1 setting for sounds.
|
|
|
|
|
- disable sounds (this should be obvious, it's just a checkbox), then click OK.
|
|
|
|
|
- trigger a fill, and verify that the notification is shown, but the sound is not heard.
|
|
|
|
|
- in the notification settings dialog, disable toast notifications, the click OK.
|
|
|
|
|
- trigger a fill, and verify that neither the notification nor the sound are shown/played.
|
|
|
|
|
- enable both sounds and notifications again.
|
|
|
|
|
- trigger a fill, and verify that the sound is heard, and the notification shown.
|
|
|
|
|
- in the NSD, change the Toast Notification "Flash Duration" to 1 second (or any duration that is different enough from the current, so that the difference is easily detectable), click OK.
|
|
|
|
|
- trigger a fill, the notification box should disappear after thet appropriate time.
|
|
|
|
|
- in the NSD, chagne the Toast Notification "Mode" to "Manual" (the duration control should be disabled now).
|
|
|
|
|
- trigger a fill, the NSD should NOT dissappear.
|
|
|
|
|
|
|
|
|
|
8) Saved with workspace:
|
|
|
|
|
7) Saved with workspace:
|
|
|
|
|
----Note----------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
- you have completed the sound-functionality testing, don't be alarmed by the 4 sound triggers you are about to add.
|
|
|
|
|
- this step just requires comparing 2 images of the settings dialog to confirm that they were retained with the workspace.
|
|
|
|
@@ -136,11 +92,23 @@ Prepare: open a ladder for a security that has steady market data activity (in t
|
|
|
|
|
- you may replace sounds referred to as 'A' and 'B' with whatever you like; if such free will is too cumbersome, A=Game Sound Correct, B=Powerup)
|
|
|
|
|
- the steps won't specifically say "check Play Sound," but if the trigger has a sound, check it, otherwise don't.
|
|
|
|
|
i) "When order is filled", "(any order)", Sound 'A'
|
|
|
|
|
ii) "When order is filled", "(choose securities)" pick any 2 securities, Sound 'B', enable "Show Notifications"
|
|
|
|
|
ii) "When order is filled", "(choose securities)" pick any 2 securities, Sound 'B'
|
|
|
|
|
iii) "When order is canceled", "(any order)", Sound 'B'
|
|
|
|
|
- close the shell, then restart it with the "Where I left off on" workspace.
|
|
|
|
|
- open the OWSD to verify that the sound triggers were saved with the workspace.
|
|
|
|
|
|
|
|
|
|
8) Test shell does not crash when no sound card present
|
|
|
|
|
- use a machine that does not have a sound card, such as eh-2 (check with Eric first)
|
|
|
|
|
- update config to turn off sounds
|
|
|
|
|
|
|
|
|
|
SoundNotifications {
|
|
|
|
|
enabled = false
|
|
|
|
|
}
|
|
|
|
|
- restart your shell to pick up your config change
|
|
|
|
|
- Pressing the Preview Sound button should not crash the shell
|
|
|
|
|
- Having a sound notification triggered by the orderbook should not crash the shell
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TEST COMPLETE-----------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|