admin/raven-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
184c06ee5faf2dd6d1abfcad1fdc567c296b00dd
raven-client/ayanova/devdocs/todo.txt
John Cardinal 184c06ee5f
2019-04-15 22:56:51 +00:00

357 lines
19 KiB
Plaintext
Raw Blame History

# CLIENT TODO (J.F.C. - Just fucking code it already)
## IMMEDIATE ITEMS
Need a sprint to get to a fully testable client with entry form, list and as much as possible all features from COMMON-* specs list
-----------------------
///
TODO CLIENT STUFF
#### A PHONE IS PROBABLY NOT THE MOST COMMON SIZE FORM FACTOR THAT WILL BE USED. SUPPORT PHONES, YES, BUT DON'T GET HUNG UP ON IT TO THE POINT WHERE IT RUINS THE EXPERIENCE ON A FULL COMPUTER OR TABLET
TODO NEXT
FORM MENU see down below, then other items in the list like feedback in save button when broken rules etc
Just put up latest build to server now...
- Test on mobile and desktop all browsers before moving on, it must be solid with error handling (required, after before etc) and etc and then if all is well we can move on to the other field types
TEST RESULTS
All platforms and browsers
- IN PROGRESS: Initially outdated, had to force a refresh to make it load the latest version
- STATUS: I'm going to do another update and see if it's handled properly
- I thought they would update automatically via the loader code?!?
-
- IMPLEMENTED / NOT TESTED: Login user name field auto capitalizes first character on phones, need that to not do it
- IMPLEMENTED / NOT TESTED: Login, doesn't have any ui if failed login, maybe a red frowny face icon? :)
- IMPLEMENTED / NOT TESTED: need clear buttons on pw and login
- IMPLEMENTED / NOT TESTED: Numeric input fields don't give numeric keyboard
- Save on broken rules in Widget edit form it's not clear that save does nothing if there are broken rules. Button should be deactivated or there should be a message if you click on it or something.
- Red outline and inactive seems ideal
- Save button placement, not sure I like having to scroll down the page to save on small format screens where there is potentially going to be a *lot* of scrolling needed which hides the info box etc
- How do modern apps do it?
- Widget list, refresh page causes items per page to reset back to 5 from custom setting, it should cache that shit at least for a session anyway
- Although people probably would want this to be saved to survive sessions
- maybe it should save it per device locally only so that the customizations are local to the device so they can customize differently for different ui's?
- Or, maybe they always want to see 50 widgets no matter where but 10 clients??
- Edit form title, does the edit form need a title so users know where they are at?
- currently widget edit doesn't have a particular look or title so if you are at the top of it on a small device you can't see the url fully or really know which page it is
- A small title top left that stands out might be approprpiate, also a icon beside it?
- IMPLEMENTED / NOT TESTED: Application name is all lowercase "ayanova" when installed to device, must be something in the manifest files?
- Check about page localization code, is it firing in the right place because on Edge and iPad firefox it didn't show localized at first until a refresh so it fetched the keys but didn't display properly
- Calendar on iPad in two occasions with ff and opera the calendar date could not be selected until a time was changed then the date worked. Before that it would always stay the same no matter what selection was made and the UI would not show a change on select or press of date either.
- FORM MENU / NAVIGATION BAR / OVERFLOW MENU
- According to official specs:
- Nav bar should show where you are in the title part
- Name of form or object in nav bar itself, possibly an icon also indicating the item in question?
- It should change colour when in a sub screen and not the main screen with only a back button
- I like being able to go anywhere any time from the navigation menu so I'm not sure I can support only a back button, but I can see having a back button
- I like it changing colour to indicate it's become contextual in the overflow and options
- So, when in any main view it's standard coloured but as soon as you're editing a record or in any form that demands a contextual menu item then it flips to black
- It should have the most used features surfaced adn the least in an overflow 3 dots menu to the far right.
- Search, save, whatever is most used on that form
- As the screen gets smaller items progressively move into the overflow until, at the smallest they are all in the overflow
- So what I'm reading is I should enable only one app bar at the top and morph it for states where appropriate
- Try to make a menu in the top bar APP.VUE and if not then explore options inside the form
- Is a fab appropriate for save and new the most common options??
- See the best way to do this, either in the very top bar or in somethign in the page itself
- Top bar is good because it's always visible even when at the bottom of a form, however it won't be actually inside the form itself so
- If can connect to it via the form that would be excellent
- for now make stub items similar to v7: Print, wiki, history, duplicate, delete, help
- Make a 3 dots menu item that is contextual and appears at the top of any form in the shell interface??
- Put the help option there since it's contextutal to whatever form is being displayed
- Move help menu item in shell into menu as bottom item instead
- TODO: CODE THIS FOR THIS MENU ISSUE
- Just added ability to send info to store that is picked up by nav menu
iPad
=-=-
Safari
- login page username auto capitalizes first letter how to stop that
- login, enter key should trigger login
Chrome
done
Firefox
- calendar selection again wouldn't take until I selected a time then the calendar would work, weird
- About page is showing unlocalized text like Edge did, need to check that code
Opera Mini
- All works ok, calendar selection a little finicky and overly precise but works
LENOVO ANDROID TABLET
=-=-=-=-=-=-=-=-=-=-=-
Chrome
- Everything seems to work properly
FireFox version 66 (old version 56 didn't work with time picker)
- very slow, but not unusably so
- Everything works
PIXEL PHONE
=-=-=-=-=-=-
Chrome 73.0.3683.90
- Would not update to latest version, showing old cached version instead, on other browsers I could just refresh but here it wouldn't no matter what
- Weird, I logged in, went to inventory it was outdated but when I hit refresh on that page it suddenly updated everything
- Did though, offer immediately to put it on the desktop as an app link
Firefox
- App updated immediately didn't even need to refresh I think
- similar to iPad, widget list open button very cut off in portrait, ends at price and only shows 3 fields
- Widget edit form layout is all good except for buttons group which is not centered and save button which in portrait is sitting right on the far right edge of the screen. Usable but not centered as a group.
- Can slightly "wiggle" page side to side by dragging, it's as if it's not 100% page width or something
W10 PC
=-=-=-=-
Chrome browser
- all ok
Firefox browser
- all ok
MS EDGE browser
- all ok, quite snappy actually except that on the about page it initially loaded not localized but a refresh localized it. Had just logged in. Didn't see this on other platforms but will re-check
STILL NEEDS TESTING
=--=-=-=-=-=-=-=-=-=-=
TODO NEXT
- Some changes are required then re-testing this again
End to end action
- Code for new record to the server
TODO: Delete widget button and rights stuff
TODO: History button, other AyaNova 7 example buttons all need to be there or their equivalent, do we need a top menu type thing?
- Also Save button at bottom seems like an issue too
TODO: Rights stuff for form if insufficient rights / read only etc
TODO: About AyaNova form should show the exact client browser and device info as much as possible as it also serves as the tech support info thing
- Maybe make a support info local class in client that can gather the correct info and then can be used to both display and to send to us for support with a click
- Also add a tech support reporting form / button that will gather up support info and possibly also send it to us??
- Sends to rockfish?
- Generates an email?
- At least copy it to clipboard on desktop or enable sharing so can share on device to email
TODO: Automated testing of UI by driving web interaction, that needs to be instituted asap
TODO: Server needs to do widget validation 666 test rules not only in debug mode so can test when put up to the devops server
TODO: Dark mode (dark with a half moon icon)
TODO: Grid / LIST VIEW = I know customers will want to control what shows in the list views (grid equivalent in v8).
- I had a customer today request the Description field from unit show in the workorder service grid, it doesn't do that
- Customers probably want the option of picking what fields show and what don't
- Need to think this over, do I have defined columns or is the list just for display to select the record in which case can it just be one column with user selected values showing??
DON'T code the user options with the currency symbol etc until after it's all been worked out client side. Use static values instad in locale.
Locale should fetch those settings the first time it sees they are not present so that they are refreshed upon use and are not stored in localstorage
(or should they be? anyway, can work that out later)
Other fields that are locale dependent
DateTime field next
FIXES REQUIRED
- API get code is incorrectly dealing with expired bearer cert, a 401 is returned and it tries to parse the result as if it succeeded when it really should trigger a login process
- Time zone offset mismatch warning needs expansion, it should only prompt a few times (maybe or find a way to deal with this) and it should offer to change it at the server automatically
- Localize time zone mismatch warning
- Don't like popup messages, would rather see a notification icon and be part of that unless it's super critical
- Implement a toaster or some similar notification
Figure out why custom fields don't exist in widgets test data and put it there so can code it.
Put all the widget fields on the form
Check rights when navigating to the form
Fetch the record when the form opens
Localize the validations
Ensure my own validations work to match the biz rules for the widget form.
Add update and save code
Make all fields work according to specs below
Make a basic crud form with all the fields necessary, then iterate over it adding the items below.
- CRUD form for widget:
- Needs to be a main form that is opened via route and parameter so that any part of AyaNova can just navigate to that page and it can be bookmarked.
- Not suitable for a popup form
- This means the list needs to remember where it was at when navigating back to it
Everything needs to work in this form right down to the reports so that once it's done I can move forward confidentally with testing, demo-ing and with cranking out the other forms
- Don't want to solve any problems that should have been solved with this form later as I will inevitably be full on copy and pasting once I get it down and so it needs to be as solid as possible First
- TEST SMALL and LARGE device layout regularly, don't get too far ahead of the testing
- Every type of entry field fully localized properly including numeric, date, time, tags etc
- Client: initialize after login sets locale formats for everything.
- Best to do this useroptions stuff after a form is in place that I can play with at the client and experiment to see what is possible
- How much flexibility do we have to set things like numeric / currency input / display format?
- First it gets useroptions to know what to override or not, then sets defaults based on browser or override settings in central client area for all display/parsing etc
- All numeric and date displays and input in locale format
- numeric inputs need to be set as such so that the number keyboard appears
- And all specialty inputs of course
- Custom fields implemented!
- A printable report
- Even if there is no designer yet for the report and it has to use a manually created report format HTML doc
- Error and validation properly implemented
- broken rule display
- Error reporting overall properly implemented
- ensure error messages that come back from API that start with LT: will be localized correctly before display / logging (may need string interpolation too for some in future, consider that)
- Validation / validation rules
- Vee validate and vuedelate both work tightly with vuetify and v-form
- Vee-validate can be localized
- https://baianat.github.io/vee-validate/guide/rules.html#after
- Dirty check and warning if navigate away.
- Dirty form check and prevent route leave: https://router.vuejs.org/guide/advanced/navigation-guards.html#in-component-guards
- Menu with common options
- File attachments set and get
- Duplicate
- ETC (look it up)
- WIKI PAGE
- Doesn't require docs support as is now changed to a standard file attachment
- This should just be kept in mind as a technique to use if necessary:
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3494
- UI:GENERAL:LAYOUT: - All layout, not just workorder needs to be modular and optional sections with simple starting view.
- Calendar form using new vuetify calendar control
- MISC
- Search area seems to take up too much space
- SERVER CHANGE USEROPTIONS SETTINGS NEEDED:
- Best to do this useroptions stuff after a form is in place that I can play with at the client and experiment to see what is possible
- Will need currency symbol, date format, numeric format from user settings at server
- Allow a choice: browser native display format or forced format set in useroptions
- Code the client so it will do either one from a setting fetched off the server for a session
- THESE SETTINGS NEEDED FOR USEROPTIONS
- Use browser TimeZone
- Use this timezoneoffset (already have this)
- Use browser Numeric format
- Override browser with these numeric format settings instead (see below)
- Digit grouping symbol i.e. the , in 1,000,000
- Decimal symbol i.e. the . in 1.00
- Currency symbol string (may be more than one character in some locales i.e. "Eur")
- negative display format one of these: -1.1, (1.1), 1.1-
- Use browser Datetime format
- Override browser datetime with these settings instead (see below)
- One single date format string? Or one for time, one for date and one for date/time? (see v7)
- Take from day.js (https://github.com/iamkun/dayjs/blob/master/docs/en/API-reference.md#list-of-all-available-formats)
- Do not allow anything other than numeric display, i.e. no January or Saturday so we avoid localization issues
......
- LIST
- Ellipsis submenu with mass ops options and other list wide options appear there
- Print / report
- Show tags in main list as they were added to widget recently
- They come from the api as an array of strings
- Check the rights to the list before it gets the data
- Sort and filter dialog
- Widget list component that works with real data
- paging, sorting, filtering (columns and by tag), items per page
- Single column sorting only
- Filter by popup dialog
- generic dialog that accepts a object specifying column names and types and builds a UI with the options on it
- when applied it saves it as an object that is sent up to the server for each column sorted on in query string
- Server list needs to accept those options and sort accordingly.
- Each item can be edited if they have the rights or viewed etc by opening into crud component
- List should remember where the user was when they go to edit and back again
- What to do if they edit? Refresh the list but keep the same page location?
TESTING TODO
Localized input and parsing and validation
- Going to need to handle localized numeric entry formats
- Deal with this once form is in good shape and worth testing with different locales
-----------------
TODO AFTER CLIENT block ABOVE:
ON UPDATE: have an url that opens automatically or a notification and link to one after a new version has been detected just like visual studio does in order to show what is new in this version
ABOUT form - add the user settings such as timezone offset, locale formatting patterns etc, will be useful for troubleshooting
AUTOCOMPLETE
- This article is spot on and I need to implement it like this: http://jeremymikkola.com/posts/2019_03_19_rules_for_autocomplete.html
- Check article responses and comments here for tweaks: https://news.ycombinator.com/item?id=19438826
"THORNY ISSUES" below are needed to be resolved sooner than later
- Stage 2 AFTER POSTED TEST ROUND COMPLETED
- Error handling at client (log? display?)
- Notification of some kind (bell / toast)
- Add intro.js somewhere, even if just a quick hello type thing with one single pointer to something on the screen
- Look into: should each component do it's own ajax calls?
- Make a widget component / form to view/list/enter/edit
- Graph / Readonly UI component
- Widget: List, search, edit, localized WIDGET UI components
- Post up another build with the entry form and re-round of testing
- Stage 2.5 TESTING
- Enable some end to end testing and use it going forward all over.
- Stage 3:
- At the end of this phase re-assess and see what needs to be the focus going forward and if anything is amiss
- Plan out the next phase
- UI layout design, how I want to see things, don't re-invent the wheel; v7 isn't perfect but I don't have forever either
- Just remember roles and role based security and that might lead into the UI
- the dashboard can drive a lot because for example a graph or list of workorders could also be where you add a new wo
- Thorny issues:
- Reporting
- Notifications from the server
- File upload / download
- Offline abilities?
- TIME TO MARKET TIME TO MARKET TIME TO MARKET
- RELEASE IT, RELEASE IT, RELEASE IT!!!!
- Need a good think about this, time to market is of utmost importance but it would not hurt to see what can be done now or defferred to vNext
- v7 is technically an always online app so there's that.
- Would be nice to maybe be able to do some limited stuff offline
- scope out a scenario or leave for vNext?
- Fill out a workorder that is already up on the phone?
- Parts can't be cached locally, there could be thousands, but maybe labour only is supported?
- Maybe parts can be entered as text when offline for later lookup?
- NOTE: many users want to see some progress on v8 so it's important that the initial shell have some "flash" to it
- Nice transitions
- Some sample charts
- test well on all form factors
- Have examples of a form with all RAVEN required control types enabled
- Use Intro.js to introduce the demo to new users and also to introduce the UI elements and it will be used all over the place!!
- Stage 4:
- Customer demo!!
Reference in New Issue View Git Blame Copy Permalink