Set Choice
set_choiceAdd or change a table column's list choice in a ServiceNow app and update set, setting label, sequence, hint, or inactive status; choice capture is verified in that update set.
Instructions
Add a choice to a column's list, or change one (label, sequence, hint, inactive), in the list's application and the named update set; the list's capture is verified there. Inactivating keeps the label and hides it from new selections.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | Hint shown for the choice. | |
| label | No | The label. Required to add a choice. | |
| scope | No | The record's application: its scope name (e.g. "x_acme_app"), or "global". Give this or scope_id. | |
| table | Yes | The table. | |
| value | Yes | The stored value; it identifies the choice in the list. | |
| column | Yes | The column, prefix included (u_ in Global). | |
| inactive | No | Inactivate (true) or reactivate (false). | |
| instance | No | The ServiceNow instance auth alias to connect to. This is the alias configured via `snc configure` (e.g., "myinstance", "prod", "test"). The user will typically refer to this by name when saying things like "on my myinstance instance". If not provided, falls back to the SN_AUTH_ALIAS environment variable. | |
| language | No | Choice language (sys_choice.language, e.g. en, pb); en when omitted. | |
| scope_id | No | The record's application by sys_scope sys_id, instead of scope. | |
| sequence | No | Position in the list. | |
| update_set | Yes | sys_id of an In progress update set of that application (create_update_set). The capture is verified there; for adding a column and for layout saves it must also be the working set (set_current_update_set). | |
| acknowledge_upgrade_skip | No | Only for an installed Store application, and only after the user has reviewed the change: upgrades of that application then skip this file until the customization is reviewed. |