admin/raven-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
02de48f3cc7bd2b86c6246ebef6bf55f85eaf337
raven-client/ayanova/devdocs/todo.txt
John Cardinal 02de48f3cc
2020-04-15 22:10:38 +00:00

714 lines
40 KiB
Plaintext
Raw Blame History

# CLIENT TODO
**************************************************************************************************************************************************************************
CURRENT ROADMAP
1) Get the widget edit form completely working with the exception of reporting which can be stubbed out but should be present even if not functional now
- Test manually with all devices before baking it in
- Make automated test for it
2) Fundamental stuff for editable objects (minus reporting)
Get the Widget list and filter and any other options (except reporting) fully working and ready to roll out.
- Nothing left to determine, all done, ready to copy and automated test, with a stubbed out reporting UI
- Test manually with all devices before baking it in
3) Organize and finalize misc items
Scaffold the shell framework completely in place as much as possible so that we know there will be minimal other changes required
- All areas stubbed out now even if empty, just so you can see it and know what needs to be fleshed out and for demo purposes
- Test manually with all devices before baking it in
4) Reporting - figure it out, flesh it out, make it happen
5) - FINALIZE ALL NON BIZ OBJECT SPECIFIC FUNCTIONALITY
All the final features needed that aren't tied to a specific business object
6) INSTALLER, LICENSING, ROCKFISH SUPPORT FOR RAVEN
Look for anything major missing at this point, make it deployable as a package and test the deployment on a raw server
- need to know it will be ready for 3rd parties to try out as much as possible.
- Windows installer for self contained fully testable
- Linux installation method
- Container installation method
Licensing / Rockfish get this ready with Rockfish to be able to license it in reality so it's ready for 3rd parties
- Test the full trial / license business cycle and confirm it's solid and integrated into the Rockfish database properly
- Doesn't have to be perfect, just working enough for the real world, can make it easier or nicer later
- READ THIS: https://medium.com/@gokulrajaram/self-serve-first-the-overlooked-but-essential-paradigm-underlying-great-software-companies-45a67dbec4c4
7) Build AyaNova 8 / port over all BIZ objects features of v7
8) PLUGINS / ACCOUNTING INTEGRATION
Port the plugins, need a separate server for QBI Windows etc
9) RELEASE
10) BACK END Self Serve readiness
- READ THIS: https://medium.com/@gokulrajaram/self-serve-first-the-overlooked-but-essential-paradigm-underlying-great-software-companies-45a67dbec4c4
- licensing changes for a online hosted app
- Self serve process in place
- Ability to upload v7 data from DataDump plugin
11) RELEASE SELF SERVE
**************************************************************************************************************************************************************************
CURRENT TODOs
=-=-=-=-=-=-=
@@@@@@@@@@@ ROADMAP STAGE 2:
todo: WIKI
todo: WIKI VIEWER
- make a sample doc to test with all elements required
- all formatting supported by standard and marked
- Remote and local attached images
- Edit button if have rights
- Download, open as pdf, email?
- Check the ability in v7 for wiki and see what can be supported
- basically it's just all the markdown stuff already doing and the rest is stuff that doesn't apply to markdown like colors, fonts etc
todo: Make an editor page
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2032
IMAGES
- easily add images https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2080
- both local and URL based images
- Local need some kind of chooser (or do we go with attached images attached to wiki object only?)
- People will just want to stick an image into the document
- Images are weird because they could be useful as an attachment anywhere but they are also something people put into a wiki to view inline
- So...need to think of them in two ways really.
todo: DATADUMP - v7 wiki to RAVEN markdown
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3468
- Need to export images and attached docs as attachments
.
SPECS
- Most often people will view them rather than edit, so need viewing to be fast an easy
- smaller payload to view
EDIT
- Fully support editing by entering plain markdown text
- Toolbar is simply to shortcut to enter the markdown text
- Make it easy to do with a phone by providing some way to easily enter the required characters as they are not present on the keyboard without dig
- Test on a phone early and often
- Edit mode is a switch to edit kind of thing, not a normal process
- switch to edit downloads a special payload for editing that is larger?
- Insert images from url or from attachments to same object that wiki is attached to
- click into editor in desired location then select image
It should offer to link or upload image
- if link, just enter url and whatever, description etc required
- if upload then it should open a file picker and then it should both attach the image to the parent object as a file attachment and then create the image url markdown
DELETED IMAGES
- ideally, if they delete an image url it should ask if the attachment sb deleted if it's a local attached image
- or maybe if they save the wiki and exit it should automatically remove any attached images no longer referenced in the wiki?
- Or offer to do so
- Although, I kind of prefer that they manually have to delete them when no longer required as then there is no chance of accidentally deleting an image carelessly that
is still needed as an attachment
- ATTACHED images maybe need an extra flag indicating they are wiki images for automated orphan image handling etc
- Using attached local files as image source is also handy in that users can just view the images through attachments if it's a common reference thing and they don't need to open the whole wiki
- When inserting local image, still uses same url based method as any image, just local url
- Need image route at server with rights and shit?
- or, if it's based on local object attachments anyway then sb fine because rights flow with object
- What if person deletes attached image being used by wiki from object?
- I guess this should be ok, just need maybe a warning that it's being used in the wiki or something?
- Deleted images in wiki should return a NOT FOUND or DELETED image as a placeholder
- Global images available from anywhere??
- Could this work for logos and shit because I didn't really have any place to hang logos off of before but this makes sense but needs some thinking about how to UI it
- VIEWER to edit mode
- saw on one that they put a persistent pencil corner icon for going to edit mode, maybe could use a FAB or something for editing to decrease wasted screen space?
- although, will need print and other shit probably so maybe will still need the toolbar menu anyway
- HELP DOCS
- Link to commonmark site standard and link to their tutorial which is pretty cool
............................
RESEARCH
- Evaluate the options
Payload size
works responsively?
pros and cons for building my own vs purchase (seems relatively easy to build the editor but who knows)
The pre-made ones use codemirror (they all do), if I need codemirror for something else (DSL MACROS STUFF?) then does it make more sense or...?
- How badly do I need to use a 3rd party markdown editor, considering it really is just a shortcut to entering the markdown text which I could do myself
- The table copy and paste thing toast shows is pretty cool, copied from excel and pasted into markdown
- maybe that's not super hard to support myself or the plugin code could be examined and modifed?
- some of them modify the displayed editor text to show / hint at what the preview would look like, but is that really necessary?
Render markdown:
MARKED library
Examples using Marked
https://vuejsfeed.com/blog/minimal-vue-js-markdown-editor
https://codepen.io/leetrunghoo/pen/ZWEgew
https://codepen.io/Paolo-Duzioni/pen/EwYooo A bit fancier than the above
https://codesandbox.io/s/github/vuejs/vuejs.org/tree/master/src/v2/examples/vue-20-markdown-editor?from-embed=&file=/index.html official!
Edit wiki from RAVEN
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2032
Need markdown editor that's responsive or build my own?
Must support as much as my docs do
IMAGES
- easily add images
- both local and URL based images
- Local need some kind of chooser (or do we go with attached images attached to wiki object only?)
- People will just want to stick an image into the document
- Images are weird because they could be useful as an attachment anywhere but they are also something people put into a wiki to view inline
- So...need to think of them in two ways really.
Export to pdf? (or is that a reporting function?)
Markdown to PDF is probably a separate thing
Useful links
Markdown reference / standard: https://commonmark.org/help/
Markdown wysiwyg editor https://github.com/Ionaru/easy-markdown-editor
Vue wrapped wysiwyg editor (can use has a vue wrapper need to investigate practicality)
https://ui.toast.com/tui-editor/
markdown to html c# (.net core compatible) lib: https://github.com/Knagis/CommonMark.NET superseded by https://github.com/lunet-io/markdig
Fucking cool markdown to display VUE component which seems kind of ideal:
https://miaolz123.github.io/vue-markdown/
Live example demo: https://miaolz123.github.io/vue-markdown/
Supports everything I want including IMAGES! FTW!
EDITOR TEST ON MOBILE
a phone sucks for editing even when the editor works perfectly, kind of need to assume that mobile will not be used very much for editing
This is mostly due to the keyboard
I think the important thing will be uploading pictures and stuff more than editing wiki pages on a phone
https://nhn.github.io/tui.editor/latest/tutorial-example01-editor-basic
- works,
https://easymde.tk/
works but same issues as above, not as sophisticated
https://vuejsexamples.com/vue-markdown-editor-component-for-vue-js/
same, works not sophisticated as toast
https://stackedit.io/app#
crappy, no toolbar ui could make that myself
https://f-loat.github.io/vue-simplemde/dist/demo.html
same as others, but I kind of like it better for some reason
https://simplemde.com/
Goes absolutely snaky on mobile when attempt to highlight a word to change settings
https://commonmark.org/
Upload photo into wiki
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2080
DATADUMP - v7 wiki to markdown
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3468
In format that can be edited with RAVEN wiki editor (supports same elements)
------------------------ /WIKI ---------------------------
todo: BUG Something fucked with history? When I click on a widget's history button in admin user history view it shows two created record with differing timestamps
- note, it doesn't seem to do it on the most recent widgets, but only on the first few created for some reason?!
todo: ATTACHMENTS
- ability to rename file on upload https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3546
- stuff https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3484
- handle initially missing files on import (they might fuck up the export from v7, ghost files idea see case in AyaNova regarding datadump)
- Images need special support but be part of this too
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2080
- UI https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1753
- PICTURES
- Make it hella easy to upload a snapped picture from a phone into any attachment
- Maybe thumbnail pictures in the UI for easier download when viewing the list of attachments
- Consider ability to show attachment links / thumbnails at bottom of edit forms
TODO: PRIORITIZE THE FOLLOWING BLOCK AND move INTO appropriate STAGES
(these items came up looking through the raven priority 1 cases for general UI stuff)
todo: Login form customizable for logo etc?
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3592
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1849
- possibly other cases?
todo: Customer UI pages ability to add analytics tracking codes:
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3574
todo: add long polling notification route
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3507
- Need way to acknowledge receipt of long poll info from client to server so that it can be removed or something?
- maybe successfull sending clears it regardless of client?
todo: Look into 2fa
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3395
RETEST HERE ON ALL DEVICES
todo: keyboard usage test:
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3481
todo: translation page with translation settings
- Translation feedback link in translation page https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3722
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1442
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1439
todo: Trial route ui support in client (ON HOLD NEEDS BACKEND WORK)
- Went to do this but found it's a bit of a maze and has some hacked temp code in the license fetch route etc for development purposes
- Need to determine what the actual solution is for production and make some changes at the backend first
- Also this might be the point to start looking at RockFish changes as well
- Add an area to support refreshing the database and generating test data
- Would be useful to see and manage OPS things related to deployment to server just to save time, can refine them later
todo: NOW THAT FORM IS THERE MOSTLY, CLEAN UP CODE FOR RE-USE in many other forms
- Look for things to componentize
- Can I componentize the whole form itself so that I have all the basic requirements built in and can just customize certain things for each object type?
- Look for things that are not specific to the widget edit form but can be abstracted away for other forms
- Don't need to replicate common code so put it somewhere else
- Are any of the controls better as a component and self contained to save the size of the form code and complexity?
- What I mean is, for example, a text entry field could be standardized then re-used as a component if it's props and settings take up so much space etc
- formstate shit is also menu shit really so can they be combined somehow, like present two sets of menu options one read only and one fully read-write?
- some forms will have special needs but could handle them outside of the regular boilerplate shit?
todo: when server is in ops only mode the client needs a way to prevent people from opening things that they shouldn't.
for example if a admin logs in they can and should access serverstate page and some other stuff ops related, but all other routes should be locked out
I know the server will send a 404 or something but maybe that needs tweaking to show a proper message at the client or just not show those options or something?
(part of long polling maybe??)
todo: Outstanding case with vuetify bug in clear button when readonly, check if fixed and if it isn't might need a workaround
- They decided to close the issue rather than fix it:
todo: Document in user manual the Widget form as an example with instruction on how to use the various controls etc
- "Anatomy of a AyaNova Form"
todo: Server needs to do widget validation 666.66 dollar amount test rules not only in debug mode so can test when put up to the devops server
- Test code is in widgetbiz.cs around line 445, but do we need it? Maybe just find a proper server error that can be made to happen naturally?
todo: found more presets in cases
can I do this date range preset:
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3343
or is it a feature of some kind on it's own
This one: https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1441
=========================================================================================================
@@@@@@@@@@@@@@@ ROADMAP STAGE 3
todo: INVESTIGATE / REDO THE TOP LEVEL SHELL - TIME TO MARKET / Is my shell layout fucked?
- wouldn't it just suck to have all those lists exposed at once in inventory?
- Opening that page once they are all there would trigger huge traffic to the server, better to confine things to their own area as much as possible
- TTM: isn't it faster to just turn the menu into a tree like v7 or put options in each one's screen? (Like inventory page just shows a bunch of other icons to open details like widgets)
- TTM: I'm concerned that the modular UI is a bit too ambitious, yes it makes sense for re-usability but exposing it to users so they can redo their UI seems crazy ambitious at this point
- People just want to work and simpler is always better, less to maintain
- How about the easiest simplest layout possible even if it's a bit uglier but keep it all clean and focused instead of too much shit on each form?
- Really, for maintainability it makes sense to have a very simple clean layout and not try to put a bunch of complex controls all over the fucking place!!
- I need to make money from this, not win prizes for design!
- Easier to show or not things for authorization purposes when they are each in their own navigation path as much as possible
- users are used to a certain thing with v7 why re-invent the wheel, just clean it up and modernize where necessary
- There are so many other things I need to focus on, this is just adding complexity in an area that might be a nightmare to maintain and troubleshoot.
- DON"T get too fancy with this, my instinct is to make it more complex all the time, but actually ugly and simple and effective is better than pretty but fucky to use
- Also, mobile really doesn't go well with fancy but more with clean and simple.
- Sounds like my minds made up, this issue is more about changing the SHELL UI
- IDEAS:
- old fashioned switchboard kind of thing, big buttons for each area sit in a row, on mobile they are vertical full width?
- ugly but effective
- Alternative is a Tree control in menu instead, but that would likely be ugly in mobile(could investigate but it's not common probably for reason, look at material apps on phone see what they do)
- Don't worry about having to navigate too deep with too many clicks for the top level, yes some won't like it, but it's more important to focus usability and minimizing clicks in the actual path that day to day users take
- In other words make the most common tasks quick to do from the top level / HOME screen perhaps and *thats* where to focus on customization so users can surface what they want there as a LINK
- Users can modify what shows by default in the home screen but not the fancy active widgets I had envisioned but instead different task based buttons / links so they can get to where they need to go quickly
- e.g. click on inventory, select the Widgets switchboard button, the widgetlist opens full screen to the right side, one of the menu options is "Add to home screen" with a favorite button
- They click on add to home screen and next time they are on home screen a new button / link is there to that item, autoamtically pre-grouped by area of functionality or maybe they can just order it how they see fit?
- I really like the idea of the widgetlist being full screen to the right rather than in a component sharing that space as it's pretty necessary
to have a lot of columns display at times, yes it's a ui made up of a bunch of lists but that's really what people understand, it's appropriate to the application,
no business software can simply hide everything and it doesn't have to suck or be ugly
todo: Clean up TODO list, have only actionable, not completed items.
- Make a to_test.txt doc so can move todo's to to test doc for testing
- anything in this doc that isn't related directly to individual todo's other than a small big picture stuff at top sb elsewhere
- Idea is to have a focused, clean actionable list here.
- Prioritize any basic stuff that will be replicated over and over again
- i.e. regular edit forms, not schedule or workorder form which will require their own separate work and are not replicated
- want to get going with all the background object types like clients and users etc before I try to make the schedule and workorder forms
- Identify any unique time consuming items and put them in their own block of todo's
- Self serve server stuff
- workorder form
- Accounting integration and other plugins
- import datadump etc
- There is a lot of crap at the bottom of this document in this todo!
todo: INVESTIGATE - DO I need to institute a back button? (in APP MODE?? installed to "desktop" on device will I be able to easily navigate without back and forward buttons)
todo: DASHBOARD
- Need to cement what is in there, some ideas are MRU
- these cases:
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2024
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1974
todo: MRU
- MRU in dashboard...where? https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3723
- GOOD case here with two great ideas (using "audit log" event log for mru or AS mru and doing it all locally (which I am, no MRU at backend))
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3442
todo: INVESTIGATE - Dark mode / theming (dark with a half moon icon)
- If it can be done with a half hour of work and doesn't affect anything support wise or maintainance wise then yes
- Also see how to allow theming maybe or colour choices? Nah, dark mode is the most useful; I should decide the colours and stick with them it's part of our image
#translation stuff
todo: translation form
- Dedicated area for translation adjustments
- Going to be a central form for all translation not form by form
- Review the spec doc and the cases regarding this as there are some little touches that were requested and make sense related to search and replace and other things.
todo: //todo: timezone doesn't match, offer to fix it in initialize.js there needs to be a prompt and autofix
todo: code the user options with the currency symbol etc on the server and then update client to fetch them. Use static values instad in translation.
translation 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)
todo: Local user settings page / UI where can
- set translation choices and values
- Reset to default form settings
- Other shit I can't think of right now but there will be a lot
todo: License trial handling front end code to make my life easier
todo: Add formstate data to technical support information
- whut? Not sure what this is
todo: Need to do all outstanding edit form stuff next
### RETEST ALL DEVICES WHEN GET TO HERE #####
TO TEST:
- above changes block
@@@@@@@@@@@@@@@ ROADMAP STAGE 4 - REPORTING
Do reporting here
Componentize of course
todo: Report editor for creating new report accessed from the report any **existing** reports preview form if have the rights.
- or maybe from the report selector dialog box if they have the rights, although would that fuck up navigation process?
- This seems better because, what if they can't preview a report for some reason, then they can never fix it or make a new one?
- NOT like v7 where accessed from the object edit form (this is to keep menu options down to a reasonable number)
- Every list sb reportable case https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3653
- Also search results and history? Can feed from UI level to report component?
- Reporting case with various things pertinent to look over BEFORE starting in on this:
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3451
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1849
Instantly print? https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/818
Guy took the time to request it, so have a look think and see if there is a way to do this
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1734
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/962
@@@@@@@@@@@@@ ROADMAP STAGE 5 - FINALIZE ALL NON BIZ OBJECT SPECIFIC FUNCTIONALITY
todo: MAPPING
getting a *lot* of request about this
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1816
todo: can I support keycodes for saving in AyaNova and other shit that are the same as in v7 or as much as possible, i.e. ctrl-s to save (or whatever was defined)
What v7 used to support:
f1 - help, case (Keys.Alt | Keys.X) //Close form, alt-w new workorder, alt-m new pm workorder, alt-q new quote, alt-c new client, alt-u new unit, alt-p new part, ctrl-alt-g grid criteria for development,
IMPORTANT / DO THIS: insert date and time (localized) as text anywhere with a key combo
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1514
todo: investigate snippets (via hotkeys?) (I like this idea, don't dismiss it outright)
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1834
todo: AyaScript / Look into MACROS (kind of like this idea, don't dismiss it too quickly, need AyaScript replacement)
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1833
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1680
todo: back and forward buttons when running without browser controls in application mode?
- wait and see on this one, as it will be likely outside of any particular form so not something to be baked in early necessarily
todo: GUIDED TOUR
- This is an important feature and at least get a basic one in there for starters and initial release
- This is a replacement for the tutorials and videos in v7 a
- Need to add that auto-pilot thingy that allows for guided tours in HTML apps
- Specifically it should at least have an ONBOARDING walk through of how to move around, enter data, get help etc. Not feature specific but usage specfic.
- Later I'll add feature specfic tutorials like how to make a workorder etc
todo: clickable urls
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1738
MAYBE: AUTO-LOGOUT EXPIRED SESSION?
- planning:
- Moved to maybe in case it's an issue down the road
- first off, is this really an issue?
- No, actually it's kind of useful for keeping on working when a server needs a restart or something
- Only real issue is cached data mismatch so perhaps when detected it should toss cached data forcing a reload
- Or is this really an issue either? things cached are form customization and translation text which in the normal course of things won't change much
- Right now a user can simply close the browser in the middle of a session, re-open it any amount of time later and it will just keep working, however it might have outdatd cached data from the server
- What about a time limit after which a session needs to login again just to protect the users from themselves?
- Perhaps it can detect a full page refresh (which is what a restart essentially is) and see how long ago it was last active, maybe the time of the last API call to the server and use that info to force re-login.
- ACTION:
- add code to reliably detect when a user opens the browser or reloads with a session active
- Add code to track last active
- User interacted with server sb good enough
- toss any cached data if it's been more than an hour since the session was last active
FIXES REQUIRED (WTF? Is this still valid stuff ????????????????????????????????????????????????????????????????????????????????????????????????)
- 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
- Translate time zone mismatch warning (PROBABLY NOT NOW)
- 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
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 translated properly including numeric, date, time, tags etc
- Client: initialize after login sets translation 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 translation 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 translated 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 translated
- 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
- decimalValid symbol i.e. the . in 1.00
- Currency symbol string (may be more than one character in some translations 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 translation 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?
- something I just forgot as I went to write it and got stuck reading older shit here
- AUTOMATED UI TESTING - I need to institute it now and make tests so I have a template to work off for all future tests
TESTING TODO
translated input and parsing and validation
- Going to need to handle translated numeric entry formats
- Deal with this once form is in good shape and worth testing with different translations
-----------------
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, translation formatting patterns etc, will be useful for troubleshooting
"THORNY ISSUES" below are needed to be resolved sooner than later
- Maybe an issue maybe not: On field change and lose focus, the save button is not enabled necessarily until the second click
- Can the save button be enabled more quickly after losing focus on the edited field or should I revamp that?
- I can see users making a quick change clicking on save once and it won't save but they think it has.
- Right now you need to click twice on save
- 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, translated 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
- Should reports be generated *at* the server then sent back as a pdf or html page or something?
- I'm wondering how it will handle huge datasets, the grids will have sane limits but a report must by necessity report all the user's chosen data
- 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!!
*********************************************************************************************************************************************************
## TODO...MAYBE??
This is stuff I thought of but is dubiously necessary for the initial release at least or could be polish added later:
todo: Form dirty indicator on the form and easy to see, maybe the background tinges or something
- Save button kind of is, do we need this?
todo: Trial mode client should offer alternative logins right on login page and fill in for user to try out
- So a list of user names and a short text of what that user is used for when testing
- User can select and it will prefill in the form
- Obvs when not trial mode then the client doesn't offer it
todo: Suggestion box feature
https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1323
@@@@@@@@@@@@@@@ ROADMAP STAGE 6 - INSTALLER, LICENSING, ROCKFISH SUPPORT FOR RAVEN
Completely packaged and installable. REady for users to install as a test as we iterate stage 7 below
All the stuff needed for someone to run it without the real objects yet.
todo: TRIAL AND LICENSE KEY / ROCKFISH STUFF
- PLAN IN core-license-key-system.txt on server side
- random notes maybe relevant
- Test when logging in and server is ops only due to license not installed
- Does it work?
- With ops level user?
- Should it go to a specific ops page only due to state?
- So user can remotely fetch key and shit
- Why not have server automatically fetch a trial license if it sees it's unlicensed?
- Does DBID get changed on erase?
- WHAT IT SHOULD DO ACCORDING TO PLAN IN core-license-key-system.txt on server side:
- user installs raven, opens client.
- Client checks if server is licensed, if it isn't then it goes to a license request form in client
- User fills out form and submits.
- Trial containerized for easy testing / online testing https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1784
@@@@@@@@@@@@@@@ ROADMAP STAGE 7 - REALITY
All in on porting over all the real objects from v7
todo: First of all triage the features to port over in the sanest order so not stubbing too much stuff
Try to get scheduleable stuff early because schedule form will take some time
todo: Schedule form
- This one is big but requires the data to be there so as soon as implement enough things that are scheduleable then do this
@@@@@@@@@@@@@@@ ROADMAP STAGE 8 - PLUGINS
@@@@@@@@@@@@@@@ ROADMAP STAGE 9 - RELEASE
@@@@@@@@@@@@@@@ ROADMAP STAGE 10 - BACKEND SELF SERVER READINESS
DO server allocation, rockfish revamp to drive this part (or maybe it's an alternate app)
@@@@@@@@@@@@@@@ ROADMAP STAGE 11 - RELEASE SELF SERVE
Fall of 2020 hopefully
links on website for sign up
marketing can begin in earnest
Reference in New Issue View Git Blame Copy Permalink