devdocs/specs/core-reviews.txt

@@ -0,0 +1,303 @@
+# Reviews (was follow-ups, follow ups, followups, schedulemarkers)
+
+JOYCE SPEC DOC NOTES:
+
+Follow Ups
+
+SEE CASE 3511 for this.
+
+Overdue Follow Ups
+Home area – user based Follow Ups
+Home area - role based Follow Ups
+List area - Follow Ups
+Follow Ups View list
+Changing Active state of record to inactive that has Follow Up(s)  Linked To:
+Changing Active state of User record to inactive that has Follow Up(s) Assigned To:
+Follow Ups historical
+Role rights
+Follow Up form and fields
+⦁	Special note: Toggle to allow Assigned to edit or not
+Records that have associated Follow Ups:
+
+
+
+Overdue Follow Ups:
+⦁	Form display:
+⦁	In the form, shows OVERDUE whether it be a stamp or whatever – its not something that is set by a user, but AyaNova displays when sees that there is no completed date and Due By Date is older than now. 
+⦁	List display:
+⦁	Each listed item that is overdue displays with an OVERDUE stamp too
+⦁	So is very noticeable
+
+
+
+Home area – user based Follow Ups 
+⦁	Follow Ups
+⦁	(each logged in user has their own Follow Ups area that displays the two types of relevant Follow Ups panel with badge)
+⦁	
+⦁	Overdue Follow Ups #xx
+⦁	Follow Ups that are Active,  that are Assigned To this user logged in, that have empty Completed Date, that Due By Date is prior to todays date & time.
+⦁	Follow Ups Due over next 7 days #xx
+⦁	Follow Ups that are Active, that are Assigned To this user logged in, that have empty Completed Date, that Due By Date is between todays date & time and 7 days from now.
+⦁	
+
+Home area - role based Follow Ups
+⦁	Panel shown for following role(s):
+⦁	Dispatcher
+⦁	
+⦁	Overdue Follow Ups #xx
+⦁	Follow Ups that are Active,  that are Assigned To any user, that have empty Completed Date, that Due By Date is prior to todays date & time.
+⦁	Follow Ups Due over next 7 days #xx
+⦁	Follow Ups that are Active, that are Assigned To any user, that have empty Completed Date, that Due By Date is between todays date & time and 7 days from now.
+⦁	List Actions when viewing the actual list:
+⦁	Set to inactive selected
+⦁	Delete selected
+⦁	Reassign selected
+⦁	Reschedule selected
+
+
+List area - Follow Ups
+⦁	Where all Follow Ups for all records could  be viewed
+⦁	regardless of who Assigned To, Active state, Linked To, Due By Date, Completed Date
+⦁	List available to be viewed and edited and actions performed on by specific roles only:
+⦁	Dispatcher-full
+⦁	Setup-full
+⦁	List Actions when viewing list:
+⦁	Change Active state of selected
+⦁	Delete selected
+⦁	Reassign selected
+⦁	Reschedule selected
+⦁	List filter/sort options
+⦁	Active (Active/Inactive – true/false isn't what shows, so we should NOT list the filter as such. Filter should actually be what this is)
+⦁	Due By Date (empty, equal to specific date, greater than, less than)
+⦁	Completed Date (empty, equal to specific date, greater than, less than)
+⦁	Assigned to
+⦁	Tag(s)
+⦁	Provide ability to filter to show all records that have this tag OR this tag ?
+⦁	Provide ability to filter to show all records that have this tag AND this tag?
+⦁	Provide ability to filter to show all records that have this tag AND/OR this tag
+
+
+
+Follow Ups View list:
+⦁	Each main record has a Follow Ups view that lists:
+⦁	By default shows: 
+⦁	Overdue: Active Follow Ups for THIS record that are Active, that do not have a Completed Date, whose Due By Date is past are shown with OVERDUE
+⦁	By default sorted by:
+⦁	Due By Date
+⦁	Filtering options:
+⦁	Preset selections of:
+⦁	Not Yet Completed (nor overdue)
+⦁	Overdue
+⦁	Completed
+⦁	Active (Active/Inactive – true/false isn't what shows, so we should NOT list the filter as such. Filter should actually be what this is)
+⦁	Due By Date (empty, equal to specific date, greater than, less than)
+⦁	Completed Date (empty, equal to specific date, greater than, less than)
+⦁	Assigned to
+⦁	This list does NOT list Follow Ups for the record's “children” 
+⦁	i.e. a client's Follow Ups View does NOT include listing follow ups for its units, for its workorders.
+⦁	(I mean yes, it would be awesome if the list included Follow Ups of items linked to this same project so that a user could see at a glance all related Follow ups – i.e. follow ups for workorders where this Project has been selected) but at this time I am not sure is a necessity, so we will leave as is
+⦁	List Actions:
+⦁	Mass change who assigned to
+⦁	be able to select one or more multiple followups in the list and “Mass change who assigned to” (so can assign to someone else)
+⦁	action NOT available for Tech-limited, Subcontractor-full, Subcontractor-limited as Follows Ups able to view are only those assigned to themselves
+⦁	Mass Edit the Due Date
+⦁	be able to select one or more multiple followups in the list and “Mass Edit the Due Date” such as Move existing Due Date xx yyy ahead where xx equals a number, and yyy equals the amount of change. 
+⦁	Same feature here will be used “inside” the Follow Up form to set the Due By Date
+⦁	i.e. gives options for quick selection (i.e. 1 day from now, 1 week from now, 1 month from now, As well as ability to manually select specific date/time
+⦁	See for example: Wrike.com
+⦁	Actions available for read only list of tasks include ability to reschedule – changing the existing of all selected ahead either days, weeks or months. ( I would like to also include hours)
+⦁	Which is a superb QUICK way to quickly reschedule a number of items at the same time, putting all forward the same amount (i.e. push forward all selected by an hour, three hours, a day, a week, etc)
+ 
+
+
+
+
+
+
+
+
+
+Changing Active state of a record to inactive that has a FollowUp Linked To:
+
+Active/Inactive:
+⦁	Only the follow roles can edit the Active state of a record – because doing so affects other records:
+⦁	Setup-full
+⦁	Dispatcher-full
+Circumstances that Follow Up may be unchecked Active automatically
+⦁	When the Linked To of the Follow Up is set to inactive, AyaNova8 automatically sets Follow Up(s) linked to that record also to inactive.
+⦁	i.e. set a unit to inactive, all of its Follow Ups that are not yet completed automatically set to inactive
+⦁	i.e. set a client to inactive, all of its Follow Ups not yet completed are set to inactive, all of its PM's Follow Ups set to inactive, all of its PMs set to inactive, all of its Unit's Follow Ups set to inactive, all of its Units set to inactive, etc
+What about going from inactive to active, does it then re-activate those items?
+[ED: no this isn't a good idea, people may want the Review to be active but not the main record and it's a can of worms to reactivate etc]
+
+Changing Active state of User record to inactive that has Follow Up(s) Assigned To:
+⦁	Exception related to Assigned To
+⦁	The user Assigned To can not be unchecked Active if this user has ANY  follow ups that do not have a Completed Date.
+⦁	Whether inactive or Active.
+⦁	Idea behind this aspect is so that there are not inactive follow ups floating around that are not needed.
+⦁	And internally for us, so that setting a user to inactive does make the enduser keep their AyaNova clean.
+⦁	This way end user doesn't set all Follow Ups to inactive whether are outstanding or not.
+[ED: no, again these should not be affected because a supervisor may set a user inactive then see their followups in their master grid and batch reassign them keeping them in play]
+
+
+
+
+Follow Ups historical:
+⦁	AyaNova will  not automatically prune records created by a user
+⦁	i.e. AyaNova will auto prune the access log, and notifications logs, but NOT actual records such as Follow Ups, Workorders, Pos, etc.
+⦁	Completed Follow Ups are not pruned
+⦁	Provide ability to mass delete from the list being viewed by specific roles only
+⦁	i.e. tech and subcontractor roles can not delete a Follow Up
+⦁	i.e. Dispatcher can view Follow Ups for a tech, and mass delete those completed.
+⦁	
+
+Role rights:
+⦁	Each user regardless of role, can view Follow Ups that they are the Assigned To
+⦁	Each user regardless of role, can view Follow ups that they are who is the type (user) Linked To
+⦁	Each user regardless of role, can set a Follow Up to Completed IF they are the Assigned To.
+⦁	.
+⦁	Specific roles can NOT create a new Follow Up
+⦁	Tech-limited, Sub-contractor-limited can NOT create
+⦁	The user creating can set whether the Assigned can edit the Due Date or not
+⦁	This than allows for scenarios where want to give the assigned ability to edit the due date or not. 
+⦁	Otherwise only specific roles can edit the Due By Date
+⦁	.
+⦁	Specific roles restricted in what can be edited in the Follow Up assigned to them
+⦁	
+⦁	Is user Assigned To:?
+⦁	Yes
+⦁	
+⦁	No
+⦁	Can view if setup-full and dispatcher-full
+⦁	Can edit if setup-full and dispatcher-full
+⦁	.
+⦁	Only specific roles can assign someone other than themselves to a Follow Up
+⦁	Only specific role(s) can manually edit the Completed Date
+⦁	Only specific role(s) can set a Follow Up to inactive
+⦁	Only specific role(s) can delete a Follow Up
+⦁	Setup-full
+⦁	Dispatcher-full
+
+
+Follow Up form and fields:
+⦁	Active/Inactive
+⦁	Assigned to
+⦁	Due By Date
+⦁	Summary
+⦁	Details
+⦁	Completed Date
+⦁	Completed Details
+⦁	Shows but not editable by enduser regardless of role
+⦁	Record History
+⦁	Created/Created By  Last Modified/Last Modified By
+⦁	Record Type
+⦁	type of record
+⦁	Linked To 
+⦁	name of record
+⦁	Actions on single Follow Up
+⦁	Delete
+⦁	Only available to Setup-full
+⦁	Save
+⦁	Cancel out of (disgards changes not yet saved)
+⦁	Actions on multiple Follow Ups (in a list for the source, in a list for a record)
+⦁	Set selected to Inactive
+⦁	Delete selected
+⦁	Only available to Setup-full
+⦁	Note that not all fields editable by user creating, user editing:
+⦁	Type of record for
+⦁	Not a selectable field, is set internally based on the record Assigned To
+⦁	To facilitate filtering by type of record linked to
+⦁	i.e. Unit is a Type, Client is a Type, etc
+⦁	Record Activity
+⦁	Same ole as AyaNova7
+⦁	Created By, Created Date
+⦁	Last Modified By, Last Modified Date
+⦁	Active/Inactive
+⦁	Only following role(s) can change Active state
+⦁	Dispatcher-full
+⦁	Setup-full
+⦁	For any other role, ONLY shows stamp of Inactive if set to inactive, otherwise nothing shows when is Active
+⦁	Completed Date:
+⦁	Only specific role(s) have access to edit the actual Completed Date
+⦁	Dispatcher-full
+⦁	Setup-full
+⦁	Rest of the roles have access only to select Set to Completed, which auto fills in Completed Date
+⦁	Linked To:
+⦁	This is the record the Follow Up is for – any main record in AyaNova (client, wo, pm, unit, unit model, project, user)
+⦁	Automatically populated as a Follow Up is only ever created “from” the record itself
+⦁	Not editable by any user.
+⦁	Additional:
+⦁	Note: a Follow Up Linked To a user can be viewed by that same user but CAN NOT be edited as NOT the same as Assigned To:
+⦁	This way a user can see follow ups to do with themselves (i.e. mgmt set Follow Up to go over time spent on breaks with Bob. Bob can see this follow up, but can not edit it).  NOT SURE I AGREE WITH THIS AS IT IS PRIVATE INFO IN THE SCENARIO OUTLINED
+⦁	Hmmmm do client's by default get to see Follow Ups linked to themselves?
+⦁	?? is there a need to be able to create a Follow Up elsewhere and need to select the record Linked To??
+⦁	NO - A user can only create a follow up for a record they have access to, so no is my answer
+⦁	Too db intensive to bring back every possible type of record this user has access to
+⦁	Assigned To:
+⦁	Can not be blank – required field
+⦁	This is who is to perform the Follow Up
+⦁	If don't know who to assign to, then suggestion is to assign to yourself, the person creating.
+⦁	By default, the user creating the Follow Up is pre-selected.
+⦁	Additional:
+⦁	Selection list depends on the role of the user creating:
+⦁	Dispatcher-full, Setup-full: 
+⦁	list of all active users.
+⦁	All other roles, their own name is default selected and is the only available selection.
+⦁	Due By Date:
+⦁	Can not be blank – required field
+⦁	Creator by default can always edit the Due By Date when creating and when editing
+⦁	Provide quick selection in the form in addition to Date/Time field
+⦁	i.e. Hour from now, Day from now, Week from now, Month from now.
+⦁	.
+⦁	Summary
+⦁	Single line
+⦁	Creator by default can
+⦁	Follow Up Details
+⦁	Multi-line – meant for entering details about what need to do
+⦁	Completed Details
+⦁	Multi-line – where source user can enter details about what they did
+⦁	Tags
+⦁	A way for grouping and filtering 
+⦁	i.e. so if search for all records with a specific tag, returns all that have, each sorted by type of record returned as in all Follow Ups returned and listed together, all Clients that have this tag returned and listed together. 
+⦁	See tags doc
+⦁	Assigned can edit :
+⦁	If user created the followup, can edit all fields.
+⦁	
+⦁	If user is NOT who Created the followup (only certain roles can create selecting for another user – Dispatcher-full, Setup-full), source user can only edit :
+⦁	Completed Date
+⦁	Completed Details
+⦁	Certain roles can edit all fields including Active/Inactive of existing Follow Ups that have anotherr user assigned (Dispatcher-full and Setup-full)
+
+
+
+
+
+
+Records that have associated Follow Ups:
+⦁	Any record that has”views”
+⦁	Client
+⦁	HeadOffice
+⦁	Project
+⦁	Unit
+⦁	Unit Model
+⦁	WO
+⦁	PM
+⦁	PO
+⦁	Vendor
+⦁	User
+⦁	
+⦁	Not sure of, as not sure if would have views
+⦁	Contract
+⦁	
+
+
+
+
+
+
+
+
+
+
+
+