invainn / ARIA

CS 425 - CS 426 Project
0 stars 1 forks source link

[CoEN & Future Work] -- Workflows #235

Open njirwin opened 5 years ago

njirwin commented 5 years ago

Workflows Guide for Innovation Day

High-Level List of Workflows for Innovation Day, May 3rd

  1. [Admin Portal] - Create An Event
  2. [Non-Portal & Customer Portal] - Customer Registration, Participant Event Registration
  3. [Admin Portal] - Generate Documents
  4. [Admin & Teacher Portal] - Add/Upload A Teacher
  5. [Customer Portal] - Contact Us Form

Workflow 1 - Create An Event

Workflow 2 - Customer Registration, Participant Event Registration

Workflow 3 - Generate Documents

Workflow 4 - Add/Upload A Teacher

Workflow 5 - Contact Us

njirwin commented 5 years ago

@invainn

For Workflow 4

Accounts Database Table

ID Email Password First Name Last Name Verified
... ... ... ... ... True
... ... ... ... ... False
... ... ... ... ... False
njirwin commented 5 years ago

@invainn

For Workflow 1

Tasks Table

ID Task Name Teacher First Name Teacher Last Name
... Proctor ... ...
... Door Monitor ... ...
... Food Preparer ... ...
... Cleanup Helper ... ...

Sessions Table

ID Session Number Name of Room Class Type Time of Session Day of Session
... 1 (Recital Hall) Master Class 9:00 am Friday
... 2 Little Mozart's Studio Traditional 9:00 am Friday
... 1 ... ... 9:30 am Saturday

Create An Event Component Variables

After Capturing Event Variable Data

  1. After clicking "Next" on the Teacher Registrations Step (Step 3)
    • Prompt admin if the event was created successfully with message "Event Created Successfully"
    • Below the prompt, have a button that says "Schedule the Event" which navigates to the "Schedule An Event" component
  2. When on the "Schedule An Event" component, have the admin select an event for review.
    • Once selected, have the admin click "Next" and then on step 2 show the event details
    • If the administrator accepts the event criteria provide a button to "Publish Event"
    • Otherwise, allow the admin to "Go Back" or "Delete Event"
  3. If published, the event will show on the customer portal in the following components:
    • [Customer Portal] -- Register for an Event
    • [Customer Portal] -- My Enrollments (ONLY IF THE STUDENT REGISTERS FOR THE EVENT)
njirwin commented 5 years ago

@invainn

For Workflow 2

I'll focus on the data required after a new customer successfully registers and logs in since those two criteria are already built.

The requirements for this workflow will be broken down by component in the customer portal and subsequently the teacher portal (for song selection and completing the registration).

Students Database Table

ID First Name Last Name Customer ID Teacher ID Teacher First Name Teacher Last Name
... ... ... ... ... ... ...
... ... ... ... ... ... ...
... ... ... ... ... ... ...

[Customer Portal] My Participants Component Variables

[Customer Portal] Register for an Event Component Variables

[Customer Portal] Active Registrations

njirwin commented 5 years ago

@invainn

For Workflow 3

Since most of the data requirements are related to the JSON object I'll focus on that, however, I will mention that only the 'announcing sheet' should be able to be selected and generated.

There is an announcing_sheet_test.json object that displays the JSON structure for processing announcing sheets.

[Admin Portal] Document Generator

JSON Object Variables

Response Data

The document generator will return string-data that explains which documents were not requested, which were created successfully, and which failed to process.

I don't know if you'll use this but it exists...

JSON Structure for Announcing Sheet

    "documents": {
        "adjudicationForm": false,
        "announcingSheet": true,
        "certificates": false,
        "masterJudgeRepertoire": false,
        "masterJudgeSchedule": false,
        "resultsSheet": false,
        "roomSchedules": false,
        "sessionAssignments": false,
        "sessionLabels": false,
        "teacherMaster": false
    },
    "adjudicationForm": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "announcingSheet": {
        "eventName": "2019 Upper Festival",
        "documentTitle": "Announcing Sheet",
        "sessions": {
            "friday": [{
                "day": "Friday",
                "time": "9:00 am",
                "sessionNumber": "1",
                "nameOfRoom": "(Recital Hall)",
                "classType": "Master Class",
                "levels": "5",
                "judges": [{
                    "firstJudge": "Dr. Stephen Pierce, Univ. of Southern California",
                    "secondJudge": "",
                    "thirdJudge": ""
                }],
                "proctorName": "Sonnet Johnson",
                "doorMonitorName": "Catherine Lin",
                "performanceOrder": "Performance Order",
                "students": [{
                    "firstStudent": [{
                        "studentFullName": "Bob White",
                        "individualLevel": "5",
                        "firstSongName:": "Sea Piece",
                        "firstSongComposer": "MacDowell",
                        "secondSongName": "Sonatina for Piano, 1st movement - Bagpipers",
                        "secondSongComposer": "Bartok"
                    }],
                    "secondStudent": [{
                        "studentFullName": "Jack Liu",
                        "individualLevel": "5",
                        "firstSongName:": "Minuet G minor (without Trio)",
                        "firstSongComposer": "Stozel",
                        "secondSongName": "Faded Dreams",
                        "secondSongComposer": "Mier"
                    }],
                    "thirdStudent": [{
                        "studentFullName": "Alice Peng",
                        "individualLevel": "5",
                        "firstSongName:": "Four Landlers, G Major",
                        "firstSongComposer": "Schubert",
                        "secondSongName": "Winter Splendor",
                        "secondSongComposer": "Mier"
                    }],
                    "fourthStudent": [{
                        "studentFullName": "",
                        "individualLevel": "",
                        "firstSongName:": "",
                        "firstSongComposer": "",
                        "secondSongName": "",
                        "secondSongComposer": ""
                    }],
                    "fifthStudent": [{
                        "studentFullName": "",
                        "individualLevel": "",
                        "firstSongName:": "",
                        "firstSongComposer": "",
                        "secondSongName": "",
                        "secondSongComposer": ""
                    }]
                }]
            },
            {
                "day": "Friday",
                "time": "10:00 am",
                "sessionNumber": "2",
                "nameOfRoom": "(Little Mozart's Studio)",
                "classType": "Traditional",
                "levels": "5, 6",
                "judges": [{
                    "firstJudge": "Dr. Adela Park, UNR",
                    "secondJudge": "Katy Sargent, Bountiful, Utah",
                    "thirdJudge": ""
                }],
                "proctorName": "Youseon Kim",
                "doorMonitorName": "Christine Barden",
                "performanceOrder": "Performance Order",
                "students": [{
                    "firstStudent": [{
                        "studentFullName": "Bob Hopkins",
                        "individualLevel": "5",
                        "firstSongName:": "Solfeggietto",
                        "firstSongComposer": "Bach, C.P.E.",
                        "secondSongName": "Evening in the Country",
                        "secondSongComposer": "Bartok"
                    }],
                    "secondStudent": [{
                        "studentFullName": "Frank Reyher",
                        "individualLevel": "5",
                        "firstSongName:": "Sonatina A minor",
                        "firstSongComposer": "Benda",
                        "secondSongName": "Phantom Rider",
                        "secondSongComposer": "Gillock"
                    }],
                    "thirdStudent": [{
                        "studentFullName": "Alice Lee",
                        "individualLevel": "6",
                        "firstSongName:": "Fantasia D minor",
                        "firstSongComposer": "Telemann",
                        "secondSongName": "Polonaise, G minor, 1817",
                        "secondSongComposer": "Chopin"
                    }],
                    "fourthStudent": [{
                        "studentFullName": "Grace Soto",
                        "individualLevel": "6",
                        "firstSongName:": "Mazurka, A minor",
                        "firstSongComposer": "Chopin",
                        "secondSongName": "Jubilato",
                        "secondSongComposer": "Alexander"
                    }],
                    "fifthStudent": [{
                        "studentFullName": "Edward Hwang",
                        "individualLevel": "6",
                        "firstSongName:": "Remembrance",
                        "firstSongComposer": "Schumann",
                        "secondSongName": "Quiet Nights",
                        "secondSongComposer": "Rocherolle"
                    }]
                }]
            }],
            "saturday": [{
                "day": "Saturday",
                "time": "11:00 am",
                "sessionNumber": "1",
                "nameOfRoom": "(Recital Hall)",
                "classType": "Master Class",
                "levels": "7, 8",
                "judges": [{
                    "firstJudge": "Dr. Stephen Pierce, Univ. of Southern California",
                    "secondJudge": "",
                    "thirdJudge": ""
                }],
                "proctorName": "Sonnet Johnson",
                "doorMonitorName": "Carol Taylor",
                "performanceOrder": "Performance Order",
                "students": [{
                    "firstStudent": [{
                        "studentFullName": "Alice Venzon",
                        "individualLevel": "7",
                        "firstSongName:": "Waltz A-flat Major",
                        "firstSongComposer": "Chopin",
                        "secondSongName": "Cantico Iberico",
                        "secondSongComposer": "Rocherolle"
                    }],
                    "secondStudent": [{
                        "studentFullName": "Grace Spadone",
                        "individualLevel": "7",
                        "firstSongName:": "Allegro agitato in C minor",
                        "firstSongComposer": "Burgmuller",
                        "secondSongName": "Joc cu Bata",
                        "secondSongComposer": "Bartok"
                    }],
                    "thirdStudent": [{
                        "studentFullName": "Anne C. Jones",
                        "individualLevel": "8",
                        "firstSongName:": "Waltz B minor",
                        "firstSongComposer": "Chopin",
                        "secondSongName": "Zambra",
                        "secondSongComposer": "Turina"
                    }],
                    "fourthStudent": [{
                        "studentFullName": "",
                        "individualLevel": "",
                        "firstSongName:": "",
                        "firstSongComposer": "",
                        "secondSongName": "",
                        "secondSongComposer": ""
                    }],
                    "fifthStudent": [{
                        "studentFullName": "",
                        "individualLevel": "",
                        "firstSongName:": "",
                        "firstSongComposer": "",
                        "secondSongName": "",
                        "secondSongComposer": ""
                    }]
                }]
            },
            {
                "day": "Saturday",
                "time": "11:00 am",
                "sessionNumber": "2",
                "nameOfRoom": "(Little Mozart's Studio)",
                "classType": "Traditional",
                "levels": "6, 7",
                "judges": [{
                    "firstJudge": "Dr. Adela Park, UNR",
                    "secondJudge": "Katy Sargent, Bountiful, Utah",
                    "thirdJudge": ""
                }],
                "proctorName": "Catherine Lin",
                "doorMonitorName": "Amy Jahn",
                "performanceOrder": "Performance Order",
                "students": [{
                    "firstStudent": [{
                        "studentFullName": "Bob Desai",
                        "individualLevel": "6",
                        "firstSongName:": "Polonaise, B-flat 1817",
                        "firstSongComposer": "Chopin",
                        "secondSongName": "Zigzag",
                        "secondSongComposer": "Alexander"
                    }],
                    "secondStudent": [{
                        "studentFullName": "Frank Wang",
                        "individualLevel": "6",
                        "firstSongName:": "Alla Tarantelle",
                        "firstSongComposer": "MacDowell",
                        "secondSongName": "Sonatina, C Major 1st-Allegro con spirito",
                        "secondSongComposer": "Kuhlau"
                    }],
                    "thirdStudent": [{
                        "studentFullName": "Alice Tenneti",
                        "individualLevel": "7",
                        "firstSongName:": "Sonata, G Major 1st-Allegro ma non Troppo",
                        "firstSongComposer": "Beethoven",
                        "secondSongName": "Prelude, B minor",
                        "secondSongComposer": "Chopin"
                    }],
                    "fourthStudent": [{
                        "studentFullName": "John Kim",
                        "individualLevel": "7",
                        "firstSongName:": "Waltz A-flat Major",
                        "firstSongComposer": "Chopin",
                        "secondSongName": "Invention No. 1, C Major",
                        "secondSongComposer": "Bach, J.S."
                    }],
                    "fifthStudent": [{
                        "studentFullName": "Alan Miercort",
                        "individualLevel": "7",
                        "firstSongName:": "Invention No. 1, C Major",
                        "firstSongComposer": "Bach, J.S.",
                        "secondSongName": "Tarantella Bravura",
                        "secondSongComposer": "Barden"
                    }]
                }]
            }],
            "sunday": [{
                "day": "Sunday",
                "time": "2:30 pm",
                "sessionNumber": "2",
                "nameOfRoom": "(Little Mozart's Studio)",
                "classType": "Traditional",
                "levels": "5, 6, 7",
                "judges": [{
                    "firstJudge": "Dr. Jim Winn, UNR",
                    "secondJudge": "Katy Sargent, Bountiful, Utah",
                    "thirdJudge": ""
                }],
                "proctorName": "Lacey Cope",
                "doorMonitorName": "Rong Lucchesi",
                "performanceOrder": "Performance Order",
                "students": [{
                    "firstStudent": [{
                        "studentFullName": "Alice Hur",
                        "individualLevel": "5",
                        "firstSongName:": "Solfeggietto",
                        "firstSongComposer": "Bach, C.P.E.",
                        "secondSongName": "The Horseman",
                        "secondSongComposer": "Schumann"
                    }],
                    "secondStudent": [{
                        "studentFullName": "Bob Kaya Evenson",
                        "individualLevel": "5",
                        "firstSongName:": "Invention",
                        "firstSongComposer": "Kirnberger",
                        "secondSongName": "Fantasy Dance",
                        "secondSongComposer": "Schumann"
                    }],
                    "thirdStudent": [{
                        "studentFullName": "John Park",
                        "individualLevel": "6",
                        "firstSongName:": "Smoldering Blues",
                        "firstSongComposer": "Alexander",
                        "secondSongName": "Sonatina D Major 1st-Allegro con Spirito",
                        "secondSongComposer": "Clementi"
                    }],
                    "fourthStudent": [{
                        "studentFullName": "Alan Hopkins",
                        "individualLevel": "7",
                        "firstSongName:": "Invention No. 1, C Major",
                        "firstSongComposer": "Bach, J.S.",
                        "secondSongName": "Song of the Lark  (March)",
                        "secondSongComposer": "Tchaikowsky"
                    }],
                    "fifthStudent": [{
                        "studentFullName": "",
                        "individualLevel": "",
                        "firstSongName:": "",
                        "firstSongComposer": "",
                        "secondSongName": "",
                        "secondSongComposer": ""
                    }]
                }]
            },
            {
                "day": "Sunday",
                "time": "4:00 pm",
                "sessionNumber": "1",
                "nameOfRoom": "(Recital Hall)",
                "classType": "Master Class",
                "levels": "5, 7, 8, 9",
                "judges": [{
                    "firstJudge": "Dr. Stephen Pierce, Univ. of Southern California",
                    "secondJudge": "Dr. Jim Winn, UNR",
                    "thirdJudge": "Katy Sargent, Bountiful, Utah"
                }],
                "proctorName": "Cindy Harris",
                "doorMonitorName": "Olga Barry",
                "performanceOrder": "Performance Order",
                "students": [{
                    "firstStudent": [{
                        "studentFullName": "Grace Yuan",
                        "individualLevel": "5",
                        "firstSongName:": "Sonatina, C Major 3rd-Finale:Allegro",
                        "firstSongComposer": "Haydn",
                        "secondSongName": "Hummingbird",
                        "secondSongComposer": "Gillock"
                    }],
                    "secondStudent": [{
                        "studentFullName": "Edward Oranges",
                        "individualLevel": "7",
                        "firstSongName:": "Nocturne C Major",
                        "firstSongComposer": "Grieg",
                        "secondSongName": "Joc cu Bata",
                        "secondSongComposer": "Bartok"
                    }],
                    "thirdStudent": [{
                        "studentFullName": "Alan Oranges",
                        "individualLevel": "8",
                        "firstSongName:": "Divertimento",
                        "firstSongComposer": "Wagenseil",
                        "secondSongName": "Toccata",
                        "secondSongComposer": "Tauriello"
                    }],
                    "fourthStudent": [{
                        "studentFullName": "Alice Tucker",
                        "individualLevel": "9",
                        "firstSongName:": "Prelude",
                        "firstSongComposer": "Grieg",
                        "secondSongName": "Maple Leaf Rag",
                        "secondSongComposer": "Joplin"
                    }],
                    "fifthStudent": [{
                        "studentFullName": "Bill Pitani",
                        "individualLevel": "9",
                        "firstSongName:": "Sonata, A Major Rondo alla Turca: Allegretto",
                        "firstSongComposer": "Mozart, W.A.",
                        "secondSongName": "Arabesque I, E Major",
                        "secondSongComposer": "Debussy"
                    }]
                }]
            }]
        }
    },
    "certificates": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "masterJudgeRepertoire": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "masterJudgeSchedule": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "resultsSheet": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "roomSchedules": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "sessionAssignments": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "sessionLabels": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    },
    "teacherMaster": {
        "eventName": "",
        "documentTitle": "",
        "sessions": {
            "friday": [{}],
            "saturday": [{}],
            "sunday": [{}]
        }
    }
}