Example Format for OnCall Metadata Fields in Securly Sync

Overview:

When configuring OnCall and/or Home with Securly Sync, specific fields must be included to ensure accurate data is available in each product. When data is not available in the OneRoster API from your SIS, it can be augmented to your SIS data by sending a .csv file.

 

Below is an example format for the .csv data fields required, particularly focusing on student and guardian information. The column header names don’t need to match exactly as we can map them after they are uploaded.

Required data Fields:

guardianData.csv

Column Name	Required	Description	Example
studentSourcedId	Yes	This should be the sourcedId used in the OneRoster API for the student.	s938374
guardianSourcedId	Yes	This should be the sourcedId used in the OneRoster API for the parent/guardian/relative.	g44922
guardian_givenName	*No	Given/Legal/First name of  parent/guardian/relative. *Only required if this data is not in the API.	John
guardian_familyName	No	Family/Surname/Last name of  parent/guardian/relative.  *Only required if this data is not in the API.	Smith
guardian_email	*No	primary email address of guardian *Only required if this data is not in the API.	j.smith@email.mail
address1	Yes	First line of address for  parent/guardian/relative.	123 Main St
address2	No	Second line of address for  parent/guardian/relative. Include when needed.	Apt 4B
city	Yes	City part of address for parent/guardian/relative	Springfield
state	Yes	State part of address for parent/guardian/relative	IL
zipcode	Yes	Zip code of address for parent/guardian/relative	62701
phone	*No	Phone number for parent/guardian/relative *Only required if this data is not in the API.	123-456-7890
allowdataaccess	Yes	Data flag indicating this guardian's information should be used by On-Call analysts when directing a wellness check.	false
hascustody	Required for OnCall, optional for Home	Data flag indicating this guardian's information should be used by On-Call analysts when directing a wellness check.	true

 

Mapping Notes:

• The studentId and guardianId fields must correspond directly to the sourcedId values provided by your SIS through the OneRoster API.
• Each field should be populated with the appropriate data type to ensure correct mapping and functionality by Securly Sync.
• File and column names are flexible and can be managed after uploading.
• allowdataaccess tells both OnCall and Home if the user should be allowed access to the system or be contacted.
• hascustody tells OnCall that the contact is one that can be used. It can be used to filter what guardians have access to Home.

*Additional columns can be added to reflect if you would like other flags to be a part of determining who should or should not have access in Home or OnCall.

**Note, if a single column is difficult to export but easy to describe based on the other columns, we can handle defining the relationship. Let us know.