First Release Version
69.22
CONTENTS
Confirm Details - Glossary
Term | Definition |
---|---|
Confirmation Period | A time period which schools set, and during which student contacts are asked to check, update and confirm their families 'My Details' in Community Portal. |
Community Member whose My Details are being confirmed | The Community Member whose My Details need to be confirmed. Referred to as Confirmee in Maint, Audit and Action Centre messages. |
Confirmer (Approver) | The Community Member who is confirming the My Details of another Community Member (or themselves). |
Fully Confirmed | When a Community Member has confirmations for all of the My Details Groups in a Confirmation Period, with the confirmations being in the periods open to close dates, then they are Fully Confirmed in that Confirmation Period. |
Impersonation | Community Portal allows staff to log-in "as" a family member and impersonate a family member. While impersonating they have the ability to do all functionality that the impersonated family member can. |
My Details | My Details - a tab in Community Portal in which are listed the personal details of family members. Community members identified as approvers are able to edit and confirm My Details. |
My Details Group | My Details are grouped in to 'like' Groups, eg Personal Information, Medical and Immunisation information, Census Information, etc. |
Overview
Schools require confidence that the ‘My Details’ of students and their contacts are correct and up to date.
To facilitate this, Synergetic has the Confirm My Details process. This process centres around Confirmation Periods - a time period which schools set, and during which student contacts are asked to check, update and confirm their families 'My Details' in Community Portal. Parents are reminded that confirmations are due by banners in Community Portal and via targeted action centre messages.
Schools are able to monitor progress of confirmations in Synergetic Application and Synergetic Web, by the use of purpose designed screens, reports and action centre messages.
Confirmation Period Configuration
Confirmation periods define who are to have their My Details confirmed, what My Details Group are to be confirmed, what messages a community member sees in Community Portal and when the Confirmation Period is in effect.
Confirmation Periods are configured in Look Up table maintenance.
My Details are Confirmed in Community Portal
My Details are confirmed in Community Portal on the My Details tab. They can be also be confirmed via Impersonation, or via manual confirmation functionality for school staff in Synergetic Application and Synergetic Web)
During the Confirmation Period, when parents log-in to Community Portal a Community Portal header banner prompts them to go to My Details and confirm their families My Details.
Families are expected to update My Details as required prior to confirming them.
Within My Details there are visual queues for who and where confirmation is required. As confirmations are completed these visual queues disappear. When a families My Details are fully confirmed, then there will be no Confirm My Details visual queues remaining visible in Community Portal.
Functionality for Staff in Synergetic Windows and Synergetic Web
Synergetic Windows and Synergetic Web have purpose designed tabs and pages with functionality to allow staff to:
- Monitor the progress of individuals My Details confirmations within Confirmation Periods
- View the confirmation status of each My Details Group for Community Members
- Manually add and remove confirmations
- Review individual confirmation activity for each My Details Group
Synergetic Application has this functionality for:
Current Student Maintenance
Future Student Maintenance
Community Maintenance
Maint
Synergetic Web has a sub-set of this functionality for:
Current Student Maintenance
Community Maintenance
Action Centre Messages
There are 4 Staff use and 2 Parent use Action Centre messages for Confirmation Periods.
For Staff use:
Confirmation Periods Open and Empty
Confirmations Made Recently - Daily
Confirmation Periods Open Status - Daily
Confirmation Periods Overdue Status - Daily
For Parent use:
Confirmations - Portal Approver
Confirmations Overdue - Portal Approver
Reports
Reports that allow monitoring of progress in Confirmation Periods are:
Confirmation Period - Confirmers Report
Confirmation Period - Aggregate Progress
Report Confirmation Period - Confirmation Periods Report
Confirmation Period - Individual Progress Report
Audit table
There exists an Audit table to track:
- Every confirmation transaction activity made, who made it and who it was made for
- The nightly status of every Confirmee for every Open and Active Confirmation Period they are in
Licensing
Confirm My Details functionality is linked to licensing, so that only schools licensed for My Details can use Confirm My Details.
Detailed Description
Using the 'Confirmation of Details Dates' Look Up table
The luConfirmationOfDetailsDates lookup table is used to define a Confirmation Period:
- Name
- When the period runs
- Who is included
- Messages to display in Community Portal
- What is to be confirmed
As minimal validations have been built in to luConfirmationOfDetailsDates lookup table, ie:
- Description is mandatory
- PortalMessage is mandatory
- PortalMessageOverdue is mandatory
the User has maximum flexibility to establish Confirmation Periods that meet their needs. However this will allow non-sensical Confirmation Periods to be established. Users need to take care when establishing Confirmation Periods, that the Period is configured to achieve the desired outcome; eg check that:
- dates are in chronological order
- If student contacts are included that student contact - My Details Groups have been selected for confirmation (and vice versa),
- Year Levels exist at chosen Campus
- Year Level To is greater than Year Level From.
- etc
Example: luConfirmationOfDetailDates
luConfirmationOfDetailDates Contents
Field | Description |
---|---|
Seq | The sequence number of the Confirmation Period row in the Look Up table. |
ConfirmationDescription | Description of the Confirmation Period |
OpenDate | Date from which the Confirmation Period will appear in Community Portal, Synergetic Application, Synergetic Web, Action Centre Messages, Reports, etc |
RequiredDate | From this date the school considers any outstanding My Details confirmations as overdue. On 'Required Date' the 'Portal Message Overdue' header banner displays in Community Portal. |
PortalCutOffDate | An in-built extension to Required Date; between Required Date and up to and including the Cut-Off Date, non confirmed Community Members are considered late, but can still make confirmations. The 'Portal Message Overdue' displays in Community Portal as a header banner. |
CloseDate | The last day upon which the Confirmation Period will appear in 'Confirm Details' tabs in SynMain and Synergetic Web. |
Campus | Only students and their Contacts from this Campus will be included in the Confirmation Period as Confirmees. Either All (blank) or one Campus only, can be selected. |
YearLevelFrom | Only students and their contacts in this Year Level or higher will be included in the Confirmation Period as confirmees. |
YearLevelTo | Only students and their contacts in this Year Level or below will be included in the Confirmation Period as confirmees. Note: Ensure that Year Level To is greater than Year Level From. |
PortalMessage | This message will display as a header banner in Community Portal from Open Date to the day before Required Date. Message can include a html link in the form: <a href="https://www.w3schools.com/SynergeticCommunityPortal/MyDetails.aspx">Please confirm all My Details for your family.</a> |
PortalMessageOverdue | This message will display as a header banner in Community Portal from Required Date up to and including Portal Cut-Off Date. Message can include a html link in the form: <a href="https://www.w3schools.com/SynergeticCommunityPortal/MyDetails.aspx">Please confirm all My Details for your family.</a> |
IncludeCurrentStudentsAndContacts | Include Current students and their student contacts in the Confirmation Period. Student contacts are included if one or more of the Include SC flags below is On. |
IncludeFutureStudentsAndContacts | Include Future students and their student contacts in the Confirmation Period. Student contacts are included if one or more of the Include SC flags below is On. |
IncludeAllSCContacts | Include all types of student contacts for students included in the Confirmation Period. (If this Flag is on, this flag overrides the next 4 Include contacts flags |
IncludeLivesWithContacts | Include student contacts marked as living with the student. * See Note |
IncludeParentContacts | Include student contacts marked as parents of the student. * See Note |
IncludeMailContacts | Include student contacts marked as mail contacts of the student. * See Note |
IncludeReportsContacts | Include student contacts marked as receiving reports on the student. * See Note |
IncludeOtherConstits | ** Reserved for future use. Not currently in use. ** |
ConfirmStudentPersonal | Include the My Details Group - 'Personal' for students in the Confirmation Period. If 'On', Personal information will need to be confirmed for students included in the Confirmation Period. |
ConfirmStudentMedical | Include the My Details Group - 'Medical' for students in the Confirmation Period. If 'On', Medical information will need to be confirmed for students included in the Confirmation Period. |
ConfirmStudentImmHC | Include the My Details Group - 'Immunisation and Health Care' for students in the Confirmation Period. If 'On', 'Immunisation and Health Care information will need to be confirmed for students included in the Confirmation Period. |
ConfirmStudentReqs | Include the My Details Group - 'Requirements' for students in the Confirmation Period. If 'On', 'Requirements the student has will need to be confirmed for Students included in the Confirmation Period. |
ConfirmStudentAbilities | Include the My Details Group - 'Abilities' for students in the Confirmation Period. If 'On', Student Abilities will need to be confirmed for students included in the Confirmation Period. |
ConfirmStudentLegal | Include the My Details Group - 'Legal' for students in the Confirmation Period. If 'On', Legal information will need to be confirmed for students included in the Confirmation Period. |
ConfirmStudentCensus | Include the My Details Group - 'Census' for students in the Confirmation Period. If 'On', Legal information will need to be confirmed for students included in the Confirmation Period. |
ConfirmContactCommunityPersonal | Include the My Details Group - 'Personal' for student contacts in the Confirmation Period. If 'On', Personal information will need to be confirmed for student contacts included in the Confirmation Period. |
ConfirmContactCommunityAddresses | Include the My Details Group - 'Addresses ' for student contacts in the Confirmation Period. If 'On', the Address of student contacts included in the Confirmation Period will need to be confirmed . |
ConfirmContactCommunityOccupation | Include the My Details Group - 'Occupation' for student contacts in the Confirmation Period. If 'On', the Occupation of student contacts included in the Confirmation Period will need to be confirmed . |
ConfirmContactCommunityCensus | Include the My Details Group - 'Census' for student contacts in the Confirmation Period. If 'On', the Census of student contacts included in the Confirmation Period will need to be confirmed . |
ActiveFlag | Whether the selected Confirmation Period is active. |
ModifiedDate | Date Confirmation Period last modified. |
ModifiedUser | User Confirmation Period last modified by. |
Those Being Confirmed and Those Confirming
Community Member whose My Details are being confirmed
This is a Community Member who meets the requirements of a Confirmation Period; and is thus, someone who must have their My Details confirmed. Such a Community Member is sometimes referred to as a Confirmee. If such a Community Member has all of their My Details Groups within a Confirmation Period confirmed, then they are fully confirmed.
Confirmer
A Confirmer is a Community Portal Approver who has Community Members in an open, active Confirmation Period.
What is a Confirmation
When each individual confirmation is made the following is recorded:
(even when multiple confirmations are manually made simultaneously):
- A sequence number for the confirmation
- Who the Confirmee was
- What My Details Group was confirmed
- When the confirmation is "As At"
- Who the Confirmer was
- When the confirmation actually happened
- Who actually made the confirmation
- A Reason for the confirmation
Note
- For confirmations made through Community Portal (including impersonation) the "As At" is the date and time the confirmation is made
- For manual confirmation the 'When the confirmation is "As At".', may differ to when the confirmation was actually made.
- For manual confirmation (including impersonation) the 'Who actually made the confirmation.' may differ to who the Confirmer was.
- For confirmations made through Community Portal (including impersonation) the Reason is automatically recorded as 'Community Portal' or 'Impersonation', otherwise they are entered by the User.
Confirmation Periods are Dynamic
The system dynamically determines the contents of a Confirmation Period; the contents of a Confirmation Period are not stored and maintained, but calculated as and when needed, such as when:
- A Confirmer logs into Community Portal
- the system determines who of the family requires confirmation (confirmees) and displays them, based on the Community Portal configuration
- A Windows tab or Synergetic Web Confirm Details row is loaded
- the system determines which, if any, Confirmation Periods and confirmations should be displayed
- A report is run; or
- the system determines the Confirmation Period specific contents of the report when the report is generated
- An Action Centre message is generated, etc
If the:
- contents of an luConfirmationOfDetailDates is changed
- Student Campus or Year Level changes
- Future Student or Current Student changes to be Current or Past
these changes will flow out across Confirmation Period functionality.
When Is A Confirmation Relevant to a Confirmation Period
When a confirmation meets the requirements ( Who | What | When ) of a Confirmation Period, ie:
- Confirmee fits the Confirmation Period, eg Current Student | Year 11 | Campus S
- My Details Group fits the Confirmation Period, ie luConfirmationOfDetailDates column is 'On', eg StudentPersonal is ticked
- Confirmation Date, is between Open and Close Dates
then the system applies that confirmation to the Confirmation Period.
A single confirmation can apply to one, many or no Confirmation Periods.
Community Portal
My Details are confirmed in Community Portal on the My Details tab. They can be also be confirmed via Impersonation, or via manual confirmation functionality by school staff in Synergetic Application and Synergetic Web.
During the Confirmation Period, when parents log-in to Community Portal a Community Portal header banner prompts them to go to My Details and confirm their families My Details.
Families are expected to update My Details as required prior to confirming them.
Within My Details there are visual queues for who and where confirmation is required. As confirmations are completed these visual queues disappear. When a families My Details are fully confirmed, there will be no Confirm My Details visual queues remaining visible in Community Portal.
A Family's Community Portal Page with Confirmations To Be Done
Key | Description |
---|---|
(1) | The Portal Message / Portal Message Overdue banner. |
(2) | Family members who are Confirmees will have an Action Required or a Confirmed. If neither a or a displays this means either that the Confirmee is not in the Period, or the family is fully confirmed. |
(3) | My Details will have an Action Required or a Confirmed. If neither a or a displays, this means either that the Confirmee is not in the Period, or the family is fully confirmed. |
(4) | This banner instructs the Confirmer on what to do, and names the My Details Group and Confirmee selected. |
(5) | "Awaiting confirmation" - At least one member of the family has at least one My Details Group not yet confirmed. |
(6) | Confirm banner is where the confirmation is made by the Confirmer ticking the box and clicking confirm. The banner names the My Details Group and Confirmee selected. |
Synergetic Application and Synergetic Web
Synergetic Windows and Synergetic Web have purpose designed tabs and rows with functionality to allow staff to:
- Monitor the progress of individuals My Details confirmations within Confirmation Periods
- View the confirmation status of each My Details Group for Community Members
- Manually add and remove confirmations
- Review individual confirmation activity for each My Details Group
Synergetic Application has this functionality for:
Future Student Maintenance > Confirm Details
Current Student Maintenance > Confirm Details
Community Maintenance > Confirm Details
Maint tab within these modules
Synergetic Web has this functionality for:
Current Student Maintenance > Confirm Details
Community Maintenance > Confirm Details
Synergetic Application
Student Maintenance > Confirm Details tab
(1) Confirm Details has three sub tabs:
- Open Confirmation Periods
- Student Confirmation Status
- Student Contacts Confirmation Status
Open Confirmation Periods sub tab
For the Student (as Confirmee) and their Student Contacts (as Confirmers) display all open and active Confirmation Periods, and their current status. (For image see above.)
Key | Item | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
(2) | Open Confirmation Periods sub-tab > Confirmation Periods (Student) grid | Displays all open and active Confirmation Periods, and their current status, for the Current Student.
| ||||||||||||||||
(3) | Open Confirmation Periods sub-tab > Confirmation Periods (Student Contacts) grid | Displays all open and active Confirmation Periods, and their current status for the Student Contacts of the Current Student
| ||||||||||||||||
(4) | Add Confirmations button | Clicking Add Confirmation opens the Manual Confirmation window. Clicking cancel at any time closes the Manual Confirmation window. The user selects / enters the:
When the details have been selected / entered the 'Confirm' button is clicked This displays a final Confirm window:
| ||||||||||||||||
(5) | Remove Confirmations button | Clicking Remove Confirmation opens the Remove Confirmation window. The name of the confirmee is displayed. Clicking cancel at any time closes the Manual Confirmation window. To remove a confirmation, the user chooses selection criteria, hits Refresh to display potential 'for removal' confirmations, selects the confirmations for removal, enters a removal reason and clicks remove. Step by Step:
The 'Confirm Remove Confirmation' window is displayed: This displays a final Confirm window:
| ||||||||||||||||
(6) | Launch Community Maintenance | Click to launch into Community Maintenance. |
Student Confirmation Status sub tab
For the Student (as Confirmee) display all the latest confirmation detail.
All of the My Details Groups (Personal, Medical etc) relevant to the student are displayed. Each My Details Group shows:
- Last Confirmed
- the date the My Details Group was last confirmed
- Confirmed By,
- the Confirmer who confirmed the My Details Group as correct
If the My Details Group is not yet confirmed, these two fields will be empty.
This page allows a quick visual scan to see the currency of the students My Details Groups.
Student Contacts Confirmation Status sub tab
The Student Contacts Confirmation Status sub tab displays confirmation information for the students' contacts.
Key | Item | Description |
---|---|---|
(1) | Student Contacts Grid | This grid is made up of a view of some of the information shown in the Contacts tab. The last update date of the My Details Groups shows. |
(2) | Student Contacts Confirmations | This is a view of some of the information shown in the Contacts tab, for the selected Student Contact. |
(3) | My Details Groups | All of the My Details Groups (Personal, Occupation etc) relevant to the Student Contact are displayed. Each My Details Group shows:
If the My Details Group is not yet confirmed, these two fields will be empty. This page allows a quick visual scan to see the currency of the Student Contacts My Details Groups. |
Future Student Maintenance > Confirm Details tab
Future Student Maintenance has the same functionality as Current Student Maintenance (see) above.
Community Maintenance > Confirm Details tab
Community Maintenance > Confirm Details sub tabs:
(1) Open Confirmation Periods
- See Student Maintenance > Open Confirmation Periods above
(2) Community Confirmation Status
- See Student Maintenance > See Student Contacts Confirmation Status
Student Maintenance > Maint tab > Confirm Details sub tab
Use the Maint tab to track confirmation activity and overnight status. This information is retained for audit purposes.
A row is inserted into Maint for two activities:
- Each time a confirmation activity occurs
- Add confirmation
- Remove confirmation
- Nightly insert
- Each night a row is inserted for each active, open Confirmation Period to capture the current confirmation status of the Community Member.
Maint tab rows are a composite row of matching rows from the:
- My Details Confirmation Audit table; and the
- My Details Confirmation History table
Column Name | Description | Source table |
---|---|---|
Date/Time | The Date/Time the maintenance row was inserted. | My Details Confirmation Audit table |
Audit table Seq | There is an Audit table underlying Maint tab. This field is the sequence number of the Maint row in the Audit table. | My Details Confirmation Audit table |
Action Type |
| My Details Confirmation Audit table |
Confirmee ID | ID of the Community Member | My Details Confirmation Audit table |
Confirmer ID's | The list of those Community Members:
| My Details Confirmation Audit table |
Confirmation Period |
| lu Confirmation Of Details Dates |
Personal Status | Nightly Audit
Confirmation
Confirmation Removal
| My Details Confirmation Audit table |
Medical Status | ||
Imm & HC Status | ||
Reqs Status | ||
Abilities Status | ||
Legal Status | ||
Census Status | ||
Address Status | ||
Occupation Status | ||
Triggered By |
| My Details Confirmation Audit table |
Modified Date |
| My Details Confirmation History table |
Modified By |
| My Details Confirmation History table |
History table Seq |
| My Details Confirmation History table |
Action |
| My Details Confirmation History table |
Confirmed Date |
| My Details Confirmation History table |
Confirmed By |
| My Details Confirmation History table |
Confirmation Flag Name |
| My Details Confirmation History table |
Reason |
| My Details Confirmation History table |
Synergetic Web
Student Maintenance > Confirm Details tab
Students > Student Maintenance > Confirm Details > Open Confirmation Period
Functionality is same as Synergetic Application. (See above.)
Students > Student Maintenance > Confirm Details > Student Confirmation Status
Functionality is same as Synergetic Application. (See above.)
Students > Student Maintenance > Confirm Details > Student Contacts Confirmation Status
Functionality is same as Synergetic Application. (See above.)
Note: Synergetic Web does not have Future Students.
Community > Confirm Details tab
Open Confirmation Period
Community Confirmation Status
(5 & 6) Action Centre Messages
The following Action Centre messages are available:
Synergetic Application > System > Settings Maintenance (Action Centre Message Types) > Community > Confirm My Details
Action Centre Messages For Staff
Name | Code | Descripiton |
---|---|---|
Confirmation Periods Open and Empty | COM_ConfirmationPeriodsEmpty_I | This information message is for Staff and is a report that lists any open Confirmation Periods for which there are no Community Members meeting the Confirmation Periods that are between their 'Open' and 'Close Dates' are included. The message will be created by an overnight process and sent to all users that are subscribed to this message type. The message runs nightly and reports the status as at run time. If there are no open, empty Confirmation Periods, no message is sent.
|
Confirmations Made Recently - Daily | COM_ConfirmationsMadeDaily_I | This information message is for Staff and is a listing of Confirmations made:
The message will be created by an overnight process and sent to all users that are subscribed to this message type. If no Confirmation has been made during the report period no message is sent. If the report runs between 8 am and midnight, it will not pick up any confirmations made between run-time and midnight.
Confirmee | Confirmer | My Details Group | Date Confirmed for all confirmations that meet the above criteria |
Confirmation Periods Open Status - Daily | COM_ConfirmationsDaily_I | This information message is for Staff and shows the confirmation status of all Community Members included in Confirmation Periods which have not yet reached the Required By Date. The message will be created by an overnight process and sent to all users that are subscribed to this message type. The message runs nightly and reports the status as at run time. If there is no Active, Current Confirmation Period, no message is sent. Confirmation Periods that are between their 'Open' and 'Required By' Dates are included.
|
Confirmation Periods Overdue Status - Daily | COM_OverdueConfirmationsDaily_I | This information message is for Staff and shows the confirmation status of all Community Members included in Confirmation Periods which are past the Required By Date. The message will be created by an overnight process and sent to all users that are subscribed to this message type. The message runs nightly and reports the status as at run time. If there are no active, Confirmation Periods past their required by date, no message is sent. Confirmation Periods that are between their 'Required By' and 'Close Dates' are included,
|
Action Centre Messages For Families
Name | Code | Descripiton |
---|---|---|
Confirmations - Portal Approver | COM_ConfirmationsApprover_I | This information message is for Portal Approvers and is a reminder to complete My Details confirmations. |
Confirmations Overdue - Portal Approver | COM_ConfirmationsApproverOverdue | This information message is for Portal Approvers and is a reminder to complete overdue My Details confirmations. The message will be created by an overnight process and sent to all Portal Approval Authorities with outstanding confirmations, and access to Community Portal - My Details tab. The message uses the latest My Details Confirmation Audit table data, if the Audit table nightly update has not run, the message will not generate and an error will log. If no overdue My Details confirmations exist then no message is sent. |
(7) Reports
Reports are currently in development.
(9) Audit table
The Audit table (MyDetailsConfirmationAudit) is discussed in the Maint tab >Confirm Details sub tab section above.
The columns of the Audit table are:
Audit Table column |
---|
MyDetailsConfirmationAuditSeq |
ActionDateTime |
ActionType |
ConfirmeeID |
ConfirmerIDs |
luConfirmationOfDetailsDatesSeq |
PersonalStatus |
MedicalStatus |
ImmHCStatus |
ReqsStatus |
AbilitiesStatus |
LegalStatus |
CensusStatus |
AddressStatus |
OccupationStatus |
MyDetailsConfirmationHistorySeq |
(10) Licensing
Schools have to be licensed users of My Details to utilise the Confirm My Details functionality.