Open the Refinery, save changes, use the JSON editor and download the standard
The Refinery is where you edit an information standard. This page covers the controls shared by every tab. For what a standard contains, see The Refinery.
Before you start
To edit a workspace's standard, you need to be an Admin or Manager. To edit a session's standard, you need to be an Admin, Manager or Member. Everyone else can view the Refinery, but its fields are read-only. See Roles and permissions.
Open the Refinery
- For a workspace, open the workspace and select the Refinery tab.
- For a session, open the session and select Data Refinery in the session sidebar.
The Refinery has four tabs:
| Tab | What you define |
|---|---|
| Classify | Classifications. See Define classifications. |
| Search | Search fields. See Define search fields. |
| Tag | Tag columns. See Define tags. |
| Workflow | The processing steps. See View the workflow. |
Refinery header controls: auto-save toggle, save status, Save, Advanced JSON editor and Download standard
Saving your changes
Auto-save is on whenever you open the Refinery. Hoppa saves your changes three seconds after you stop editing. The status next to the toggle shows where things stand:
| Status | Meaning |
|---|---|
| Unsaved changes | You have edits that have not been saved yet. |
| Saving... | Hoppa is saving your edits. |
| Saved | Your edits are saved. |
| Fix duplicate codes to save | Two categories in a classification share a code. Saving is paused until you fix it. See Codes must be unique. |
To save manually instead, select Auto-save on to turn it off. Then select the Save icon whenever you want to save. Auto-save turns back on the next time you open the Refinery.
Edit the standard as JSON
The Advanced JSON editor shows the whole standard as JSON. It is useful for bulk changes, or for copying a standard between workspaces.
- Select the Advanced JSON editor icon in the Refinery header.
- Edit the JSON.
- Select Save. To undo your edits instead, select Revert.
The editor checks that the JSON is valid before saving. It does not check that the structure is a valid standard, so take care with bulk edits.
If you close the editor with unsaved edits, Hoppa asks you to confirm. Select Keep editing to go back, or Discard changes to lose them.
Download the standard
Select the Download standard (Excel) icon to download the standard as an Excel workbook. Use it to review the standard or share it for sign-off. The file name includes the date and time of the download.
The workbook contains:
| Sheet | Contents |
|---|---|
| Classifiers Summary | One row per classification, with the number of categories in each. |
| One sheet per classification | The Code, Description and Prompt of each category. |
| Search Terms | The Name, Body (the prompt) and Type of each search field. |
| Tags Summary | One row per tag column, with the number of tags in each. |
| One sheet per tag column | The tags in that column. |
Downloading the standard needs the same permission as exporting results, which Admins, Managers and Members have.