What are note parameters?

MultiTech Supporters Area Note Parameter Workshop
1

Introduction to “Note Parameters” in AppSheet

In the world of AppSheet, customization and efficiency are key to building powerful and user-friendly applications. One of the forgotten but incredibly powerful hidden-features available to AppSheet developers is the use of “Note Parameters.” These special JSON code snippets, when placed in the “Notes” field of a header in your Google Sheets or Excel tables, can significantly streamline the process of configuring your app’s data structure. Here’s how it works and why you should start using it today.

What are “Note Parameters”?

“Note Parameters” are JSON formatted instructions that you can embed within the “Notes” section of your spreadsheet’s header rows. When your table is imported into AppSheet, these parameters instruct the platform on how to treat each column in your app. This includes configuring:

  • Column Type
  • Visibility conditions (Show-If formula, required formula, etc.)
  • Automatic calculations (App formula, initial values)
  • Custom display names
  • Options for enum columns
  • And much more

Effectively, “Note Parameters” allow you to pre-define the behavior and properties of your app’s columns right from your spreadsheet, making them an essential tool for creating Auto-Tables in AppSheet.

The Power of “Note Parameters”

By utilizing “Note Parameters,” you’re not just saving time by pre-configuring column settings; you’re also ensuring consistency and reducing the likelihood of errors during app development. Whether you’re working on a small project or a large-scale app, leveraging these parameters can dramatically enhance your development workflow.

Examples of “Note Parameters” in Action

To help you better understand how “Note Parameters” are used, here are a few examples, taken from Auto-Tables shared with supporters of MultiTech Visions. Gain access

  • Note that we’ve expanded the JSON with line breaks for readability.

Example 1: [ID] from SST

This configuration sets a column to be hidden, required, and generates a unique ID as the initial value.

AppSheet: {
  "IsRequired":true,
  "IsHidden":true,
  "Type":"Text",
  "DEFAULT":"uniqueid()",
  "TypeAuxData":"{\"LongTextFormatting\":\"Plain Text\"}",
  "IsLabel":false,
  "IsKey":true,
  "IsScannable":false,
  "IsNfcScannable":false,
  "Searchable":false,
  "IsSensitive":false
}

View in Spreadsheet

Example 2: [Onboarding_Title] from Onboarding

Configures a column for onboarding titles, making it visible and required.

AppSheet:{
  "Description":"Title for this page",
  "IsRequired":true,
  "IsHidden":false,
  "Type":"Text",
  "TypeAuxData":"{}"
}

View in Spreadsheet

Example 3: [Quick_Menu_Icon_Display] from Quick_Menu

Demonstrates conditional display and dynamic content for a menu icon, using complex formulas for visibility and content.

AppSheet:{
  "IsRequired":false,
  "Type":"Image",
  "DEFAULT":"",
  "TypeAuxData":"{\"Show_If\":\"switch(context(\\\"ViewType\\\"), \\\"Form\\\", isnotblank([Quick_Menu_Image_URL]),true)\"}",
  "AppFormula":"ifs(isnotblank([Quick_Menu_Image_URL]), [Quick_Menu_Image_URL],isnotblank([Quick_Menu_Image_Upload]), [Quick_Menu_Image_Upload])",
  "DisplayName":"if(isblank([Quick_Menu_Icon_Label]), \" \", [Quick_Menu_Icon_Label])",
  "IsLabel":false,
  "IsKey":false,
  "IsScannable":false,
  "IsNfcScannable":false,
  "Searchable":false,
  "IsSensitive":false
}

View in Spreadsheet

Example 4: [Dev_Check_Remaining_Display] from Dev_Checklist

Shows how to create a “Priority” button:

AppSheet:{
  "IsRequired":true,
	"IsHidden":false,
	"Type":"Enum",
	"DEFAULT":"\"Medium\"",
	"TypeAuxData":"{
	  \"EnumValues\":[\"Priority One\",\"High\",\"Medium\",\"Low\"],
		\"AllowOtherValues\":false,
		\"EnumInputMode\":\"Buttons\",
		\"BaseType\":\"Text\",
		\"Editable_If\":\"IF(IN([Dev_Check_Auto_Status], list(\\\"Complete\\\", \\\"Canceled\\\")), 
	NOW() <= [Dev_Check_Edit_Window_Close], 
true)\"
  }",
	"DisplayName":"Priority",
	"IsLabel":false,
	"IsKey":false,
	"IsScannable":false,
	"IsNfcScannable":false,
	"Searchable":true,
	"IsSensitive":false
}

View in Spreadsheet

  • Notice how in this one we’ve got unencoded line breaks in the Editable_If formula.
    • It’s okay to include these inside your formula space.

It’s the double quotes that you need to worry about. Only those really need to be encoded for note parameters.