Skip to content

Custom variables

A custom variable is a user defined variable, derived using other data variables in your system or by using data which can be imported into your system. Once created, it behaves like any other variable in Orbit, whether as a dimension on a dashboard tile or a filter on an audience.

Note

This is a preview feature. Your system administrator must enable Custom Variables in Preview Features before you can use it.

Examples

  • Scores or codes from an external file
  • A variable that groups other data together based on rules you define

Custom variables bring together every variable in one place, whether built directly in Orbit or created in your underlying FastStats system. If you change or delete a variable in FastStats, that change reflects in Orbit automatically.

Note

Not every variable listed here can be edited from Orbit. Variables built directly by the FastStats system itself, rather than by a user, are read-only.

Access custom variables

To open custom variables:

  1. Click the Account and settings icon in the top-right corner.
  2. Click Resources.
  3. Select Custom Variables.

    Custom Variables card on the Resources page

Manage variables

The list shows every custom variable in your system, split across two tabs: Custom Variables (active) and Archived.

Custom Variables list, showing variables and their type, usage, and edit history

By default, the Custom Variables tab shows the Status, Type, Used Date, Edited Date, Refreshed Date, and Created By columns.

You can:

  • Search for a variable

  • Sort the list by name, date created, last edited, or last refreshed, in ascending or descending order

    Sort menu, listing sort fields and A-Z/Z-A order

  • Filter the list by type, or by used, created, edited, or refreshed date

    Filter panel, showing type and date-range filters

  • Choose which columns to show

    Column visibility menu with all columns selected

  • View the details of a variable using the options menu, then View Details

  • Select multiple variables at once to refresh, archive, or delete them together

    Multiple variables selected, with Refresh, Archive, and Delete actions available

Refresh a variable

Refresh recreates a custom variable using its original definition, picking up any changes to the underlying data since it was created. You'll see a confirmation notification once it's done.

Edit a variable

Use the options menu on a variable, then Edit, to reopen the dialog you created it with, pre-populated with its current settings. You'll see a confirmation notification once your changes are applied.

Archive and restore variables

  • Archive a custom variable to remove it from the active list without permanently deleting it. You're asked to confirm before it's archived.
  • Restore an archived custom variable, from the Archived tab, to bring it back.

    Archived tab, with a variable selected and the Restore action available

Delete a variable

  • Delete a custom variable to remove it permanently. You're asked to confirm before it's deleted, and this cannot be undone.

Permissions

Access works in two parts: whether you can see the Custom Variables area at all, and what you can do with an individual variable once you're there.

Accessing the Custom Variables area

This depends on whether permissions are switched on for your system:

Permissions Role Access
Off Non-admin No access
Off Admin Access
On Non-admin, without the permission No access
On Admin, without the permission No access
On Non-admin, with the permission Access
On Admin, with the permission Access

Once permissions are switched on, being an admin doesn't grant access on its own — the permission must also be applied to your profile.

Working with an individual variable

What you can do with a specific custom variable depends on the standard FastStats permissions for that variable, not a separate Custom Variables permission:

Action FastStats permission required
View Read
Refresh Update
Edit Update
Archive Delete
Delete Delete

Note

These permissions only apply once a variable has been refreshed at least once and is active. An unrefreshed variable has no restrictions.

See Permissions for more detail on setting up roles and rights.