Skip to content

Configuration Editing

The Configuration section lets you edit and store configurations in the dashboard. JSON import and download are the only ways to move configurations between the dashboard and Surfmeter Automator.

It has four pages:

  • Study Catalog contains reusable study definitions.
  • Measurement Configs select the studies included in publicConfig.json.
  • Schedule Configs define when those studies run in automatorConfig.json.
  • Service Credentials stores logins used by measurement studies.

Warning

Saving or publishing a configuration does not send it to any client. Download the published JSON files and apply them using Changing the Configuration. We are working on the next version of this functionality that ships the config to the clients without your involvement.

Study Catalog

Create studies in the catalog before adding them to a measurement config. The study form changes with the measurement type and checks its fields against the matching configuration schema.

Editing a study creates a new revision. Config revisions keep the study revision that was selected when the config was saved. Existing configs therefore do not change until you update them.

The study detail page shows the current content as fields and JSON, its revision history, and the measurement configs that use it. You cannot delete a catalog study while a saved config revision still refers to it.

Some studies need their own login. Add it on the study detail page. Only admins and organization admins can enter or change the username and password.

Measurement Configs

A measurement config is the source for one publicConfig.json file. The reference lists the available study types and parameters.

To create one:

  1. Open Configuration > Measurement Configs.
  2. Select New Measurement Config, then enter its name and optional description.
  3. Add studies from the catalog.
  4. Select Save Draft.
  5. Ask an admin to review and publish the draft.

You can also import an existing publicConfig.json. The import creates any missing catalog studies and leaves the new config as a draft.

The config detail page also lets you duplicate a config, edit its metadata, and view its revision history. Admins can select the default measurement config used by the export process.

Schedule Configs

A schedule config is the source for one automatorConfig.json file. Each schedule has an ID, one or more study IDs, and a cron expression. The page also contains the global schedule, update, and Automator settings.

Create or import a schedule config, edit its schedules, and select Save Draft. An admin must publish the draft before it becomes the published version. Admins can also select the default schedule config used by the export process.

The study IDs in a schedule must match studies in the measurement config that will be used with it.

Publishing and rollback

Saving changes creates a draft revision. It does not replace the published revision.

Admins and organization admins can:

  • publish a draft
  • roll back to an earlier revision
  • choose the default measurement and schedule configs
  • delete studies and configs

Editors can create studies and configs, edit drafts, import JSON, and duplicate configs. Viewers can read the configuration pages.

Deleting a published config also deletes its revision history. The dashboard asks for confirmation before doing this.

Moving configurations between the dashboard and Automator

The dashboard does not read configuration from clients and does not install configuration on them.

Use Import JSON to bring an existing publicConfig.json or automatorConfig.json into the dashboard. Imports create dashboard drafts, which you can review before publishing.

Download buttons export the published version:

Only admins and organization admins receive a measurement config with working service logins. Downloads for viewers and editors mask those values. The dashboard warns before downloading a masked file that contains affected services.

Follow Changing the Configuration to place the downloaded files in a native or Docker installation and load the schedule.

Service Credentials

Service credentials hold reusable usernames and passwords for services measured by the studies. Admins and organization admins can create, edit, and delete them.

Deleting a credential removes it from future composed measurement configs. It does not change previously downloaded files.