153 lines
11 KiB
Plaintext
153 lines
11 KiB
Plaintext
Sound and Notifications Test (15 min)-------------------------------------------
|
|
|
|
----Terminology-----------------------------------------------------------------
|
|
OWSD - Orderbook Window Settings Dialog
|
|
NSD - Notification Settings Dialog (application-level, it will be used near the end of the test)
|
|
Trigger - a sound/notification "trigger-item" that can be added/removed from in the OWSD (the whole test revolves around these sound/notification triggers)
|
|
[Test]Sections - each numbered item is a "section"
|
|
[Section]Steps - the hyphenated instructions within each [test]section
|
|
--------------------------------------------------------------------------------
|
|
|
|
----FYI-------------------------------------------------------------------------
|
|
- there is a "How-To Reference" at the bottom of the test; hopefully the ui is intuitive enough that you don't need it.
|
|
- steps that have a corresponding "how-to" reference will indicate this with an asterisk
|
|
--------------------------------------------------------------------------------
|
|
|
|
0) Prepare:
|
|
- 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:
|
|
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.
|
|
- click the "(click to add)" hyperlink twice to add 2 sound triggers.
|
|
- do not change any fields (they should be the exact same), then click OK.
|
|
- in the orderbook, click the Window Settings button to open the settings dialog again.
|
|
- you should only see 1 sound trigger (the duplicate should be removed).
|
|
|
|
----Sounds in the Field--------------------------------------
|
|
Prepare: open a ladder for a security that has steady market data activity (in the following steps you will be asked to enter trades, get filled, etc.)
|
|
|
|
3) "Any Order" filled sounds:
|
|
First: "Play Sound" should still be checked, "Show Notifications" should NOT be checked
|
|
- select "When order filled" and "(any order)," 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 hear the sound.
|
|
- it should be the same one you selected
|
|
Note: if you can't recall the sound, open the orderbook window settings dialog and click the "?" button next to the sound-type dropdown to hear a preview.
|
|
|
|
4) "Any Order" filled sounds don't queue indefinitely:
|
|
First: In the ladder, make sure "Auto Clear" is NOT checked.
|
|
|
|
Description:
|
|
You will be testing that a tsunami of fills does not cause sounds to queue behind one another.
|
|
Basically, if 50 fills come in at once, the sound should only play a few times, not repeatedly for 5 minutes.
|
|
|
|
- find a price well-across the market to guarentee immediate fills for a rapid succession of 1 lot limit orders
|
|
- rapidly click on the price cell to trigger a littany of fills (up to the tester's discretion as to how many clicks, but 25+ should be sufficient).
|
|
- when you stop clicking, the sounds should not continue playing for more than a few seconds.
|
|
|
|
5) "Security Order" filled sounds:
|
|
A)
|
|
- in the OWSD, click the "(any order)" dropdown and select "choose securities."
|
|
- click the "None" button that appears to add the security you chose for the ladder, then click apply.
|
|
- enter a 1 lot limit order across the market to trigger an immediate fill.
|
|
- you should hear the appropriate sound
|
|
B)
|
|
- in the settings dialog, open the sound's security picker and remove the ladder's security,
|
|
- add a different security
|
|
- enter a 1 lot limit order across the market to trigger an immediate fill.
|
|
- you should NOT hear any sound.
|
|
|
|
6) "Any Order" canceled sounds:
|
|
Description:
|
|
You will be verifying that the order canceled sound trigger works, and that it can coexist with the order filled trigger.
|
|
|
|
- in the settings dialog, change "choose securities" back to "(any order)" for your "When order is filled" sound.
|
|
- click the "(click to add)" hyperlink to add another sound trigger.
|
|
Note: the new sound trigger will be inserted at the top, of the list (not the bottom).
|
|
- select "When order is canceled" and "(any order)," then click apply.
|
|
- in the ladder, enter a limit order away from the market, so it is NOT liable to get filled.
|
|
- click the order-badge to cancel the order.
|
|
- you should hear the sound you selected for "When order is canceled"; the "When order is filled" sound should not be heard
|
|
- 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:
|
|
----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.
|
|
------------------------------------------------------------------------------------------------------------------------------
|
|
- *delete all current triggers
|
|
- read the note below, then add the triggers that follow (i-iii)
|
|
Note:
|
|
- 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"
|
|
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.
|
|
|
|
TEST COMPLETE-----------------------------------------------------------------
|
|
|
|
|
|
----How-To Reference--------------------------------------------------------------------------------------------------------------
|
|
How to add a trigger?
|
|
- In the OWSD, click the "(click to add)" hyperlink next to the "Sound and Notifications" section header.
|
|
|
|
How to delete a trigger?
|
|
- Click the "x" button in the top-left corner of the trigger-item.
|
|
---------------------------------------------------------------------------------------------------------------------------------- |