Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section contains links and downloadable files that implementers may find useful. This page includes:

Table of Contents
maxLevel2
minLevel2

A few resources worth knowing about:

  • The Snapp Data Standard and Sample Data Files can be downloaded in the Download Snapp v4.0 section of this site.
  • Snapp UI elements and images can be found on ScholarSnapp.org website here.

Snapp Profile Data Standard - Reference Documentation

The Snapp Profile is an XML Schema Definition (XSD) file. We've create a PDF reference document for your reading pleasure.

Panel
borderColor#0f6ab4
bgColor#e7f0f7
titleColor#FFFFFF
borderWidth1
titleBGColor#0f6ab4
titleDownload Link

Download a PDF showing the overall organization and type definitions in the Snapp Data Standard:
Snapp-Data-Standard-v4.pdf

Snapp Profile Data Standard - Data Dictionary File

Most projects start with a data mapping exercise. Developers can, of course, map to the Snapp XSD file – but many project teams have nontechnical (or semi-technical) analysts and subject matter experts assist in the process.

To support those teams, we've provided a version of the Snapp data standard as an Excel file.

Panel
borderColor#0f6ab4
bgColor#e7f0f7
titleColor#FFFFFF
borderWidth1
titleBGColor#0f6ab4
titleDownload Link

Download an Excel file showing the structure and organization of the Snapp Data Standard:
Scholar-Snapp-Data-Dictionary-v4.xlsx

Backward-Compatibility & Version Migration Resources

The Snapp Data Standard is updated annually. We've developed a few transformations to assist in updating a Snapp integration.

Upgrade and Downgrade Snapp Profiles using XSLT

We've developed an XSLT that illustrates the specific changes in the latest version of Snapp. The XSLT can also be used to upgrade or downgrade Snapp Profiles. Developers and analysts can inspect and run the XSLT locally to get a sense of what's changed between versions. Example "before" and "after" Snapp Profile XML files are provided with each transformation.

Scenarios Covered:

  • Upgrade v2.0 Snapp Profiles to v4.0
  • Upgrade v3.0 Snapp Profiles to v4.0
  • Downgrade v4.0 Snapp Profiles to v3.0
Panel
borderColor#0f6ab4
bgColor#e7f0f7
titleColor#FFFFFF
borderWidth1
titleBGColor#0f6ab4
titleDownload Link

Download a ZIP archive containing XSLT along with sample input and output XML data files:
Snapp-Upgrade-to-v4-0.zip

The XSLT has been tested using OxygenXML, XML Spy, and the free Saxon XSLT engine.

Note that the primary purpose of this XSLT was to be expressive, functional documentation illustrating the differences between Snapp Data Standard versions. However, presuming your technology stack supports server-side transformations, you can execute XSLT such as these at runtime (e.g., to decouple the effort of updating any UI components from the updates to your data transfer components). The obvious caveats apply: while the transformation code downloadable here is similar to what we use on the Snapp API site to perform dynamic conversions, It may not be suitable for use on your production server. So, test thoroughly before any server-side use.