Integrations & Applications FAQ

How do I delete files?

Occasionally, a file is uploaded incorrectly and should be deleted in keeping with good data grooming habits. To delete a file, take the following steps:

The Files tab on Sheila Abbot's person record. In this instance, the "test_1.xls" file is about to be deleted.

  1. After accessing the record that the file is currently stored on, click on the Other/Files tab.
  2. Locate the file you wish to delete in the embedded query, scroll all the way to the right, and click the red X.
  3. Double-check that this is actually the file that you want to delete.
  4. Click Update to delete the file.

You may also find the following articles useful:

Can we set up single sign on (SSO) for our Canvas Integration?

SSO for the Canvas integration is available on request and allows for a seamless transition from Veracross portals out to the Canvas site without an additional login. 

To set this up, please notify your account manager at the beginning of the implementation that your school would like to have SSO available upon launch of your live production site.

Can we use profile codes through the API?

The Veracross API has been built to connect third party vendors, in partnership with schools, to data stored within a school’s database.

The "Profile Codes" query on the System homepage. Check the "Include in API" box to enable API for that individual profile code.

For security reasons, profile codes are disabled for the API by default, but you can update the "Include in API" flag on the profile code query.

You may also find these articles helpful:

Can I change a file’s classification?

A file's classification is an additional level of security that applies to files that a school has that may contain sensitive information — such as enrollment contracts or immunization records.

The Security tab of a File Classification detail — this ine pertains to person photos!

Due to the sensitivity surrounding file permissions, Veracross manages security permissions around already existing files; meaning, you are not able to adjust a file's classification. If you have a set of files that you’d like to update, please submit a ticket to our support portal with a query of the files you’d like updated and which classification you’d like them updated to.

You may also find these articles helpful:

Can I share admission files with my teachers?

Files uploaded via the admission portal likely have a default file security that restricts viewing to those with admissions security roles, so teachers would not be able to view the documents even if you sent a link to them. If you have files uploaded in the admission portal that you want teachers to have access to, here is a suggested workflow:

First, update the file classification of the new files coming in via the admission portal.

  1. Add a new file classification on the System homepage with the security you want, e.g., that includes faculty security roles.
  2. Head to the admission checklist item associated with the file upload and update the file classification to your new security you just configured.
  3. If you have existing files you’d like converted to the new classification, submit a ticket in our support portal; you cannot update file security on existing files.

Second, consider how you would share the files with your teachers. One easy way is to publish a query in the teacher portal. To do this:

  1. Create a “Find Files” query that displays the files you want. Tip: subtotal and sort by student if displaying multiple files for students.
  2. Save the query to a workspace and note the query ID.
  3. Head to the “Published Queries” tab of the teacher portal and add a new record for the new query you just created, supplying the query ID.
  4. Add a button/icon/notification link in the teacher portal to the query you just published. Optional: if you want to filter the display of the button to a particular group of teachers, use a notification link because that’s the only component that supports filtering.

Finally, if you have a backlog of files that you want to change the security settings on, e.g., to update to the new file classification you just added, submit a ticket to our support portal. You are not able to change the file classification of existing files. 

Can Person Reference Numbers be pulled through the API?

Not at this time. Currently only the Legacy ID and Student Legacy ID fields from the Other tab are the only fields that pull through the API.

What is an API feed and how do we set up a new API feed?

In basic terms, an Application Programming Interface (API) defines the request of data from one software to another. Veracross clients can allow some 3rd party platforms to request data directly from their school's database through an API feed.
To setup an API feed:

  1. Contact your Account Manager to confirm that the data you are looking to push out of Veracross is available in an API feed.
  2. Submit a ticket to Veracross support for the API credentials. Include:
    •  the name of the company that will be receiving the API feed
    • contact information for that company
      •  If Veracross has not previously setup API credentials for that company, additional information may be required
  3. Once the API credentials exist, your Account Manager will share them through a secure channel of your choosing.
  4. Take the username and password provided by Veracross and use them to create the URL. API URLs are not generated by Veracross staff, a user as the school will have to configure the API parameters.
  5. Once the API URL is complete, send the URL to the 3rd Party and you're ready to go.

How do we know what information syncs from Veracross to Canvas?

You can review this documentation article, which details the data that syncs from Veracross to Canvas.