Export & Import Schema

What is this for?

A tenant's Types, Attributes, Layouts, Programs, Custom Widgets, and everything else that makes up its configuration are together called its schema. Export & Import lets you take a copy of that configuration out of Protrak, and bring it back in again.

You'll typically reach for this when you want to:

• Back up your configuration before making a risky change.
• Move configuration from one tenant to another (for example, from a test tenant into your live tenant).
• Share configuration with another team or organization, without giving them a live connection to your tenant.

Both Export Schema and Import Schema live under Settings in the Admin app's top navigation.

Two ways to export

Protrak gives you two package formats. Which one you want depends on what you're doing with the export.

	Full Export	Export As Bundle
Format	A single .json file	A .zip package
What it covers	Anything you select	Programs and Custom Widgets only
Includes source code?	Yes	No (only the ready-to-run compiled version)
Code visible/editable after import?	Yes	No (the Code field is left empty)
Typical size	Grows with everything you select	Usually smaller (see Size limits)
Works behind a strict firewall?	Not guaranteed	Yes

If you're not sure which to use, Full Export is the safe default: it works for everything. Export As Bundle is a narrower option specifically for Programs and Custom Widgets. See below for when it's worth reaching for.

note

Importing works the same way no matter which format you exported with: the Import Schema page accepts both .json and .zip files in the same file picker.

Why would I use a bundle instead of a full export?

Two situations come up most often:

• You don't want to share the source code. A bundle only ever carries the compiled, ready-to-run version of a Program or Widget, never its source. Useful when you're sharing configuration with another team, customer, or organization and don't want them to see (or accidentally change) the underlying code.

• Your network won't let a plain export through. Some organizations run their web traffic through firewalls or security gateways that inspect requests and block anything that looks like program code. A regular .json export carries Program/Widget source as plain text, so this kind of policy can reject or strip it before it ever reaches Protrak. The import then fails for reasons that have nothing to do with Protrak itself. A bundle sends the compiled version instead of readable source text, so it passes through untouched.

If neither applies to you, Full Export is simpler and covers everything a bundle does, so just use that.

Where to go next

Page	What you'll learn
Exporting Your Schema	How to export, and what's inside a bundle package
Importing a Schema	How to import, how to read the result, and what to do if it fails