Viewing and editing config data
Summarize
Summary of Viewing and editing config data
This functionality allows ServiceNow customers to update application configuration data by creating or opening changesets on the Config data tab. You can modify the structure and Config Data Items (CDIs) within these changesets, enabling precise control over application settings and deployables. Note that starting with the Washington D.C. release, DevOps Config features are being phased out for new instances but remain supported on existing ones.
Show less
Tabs on the Application Page
- Overview: Displays basic application settings and provides a Manage deployables button to edit config data.
- Snapshots: Lists snapshots per deployable, showing validation and publication status. Published snapshots can be released to the CI/CD pipeline.
- Config data: Provides a read-only tree view of config data with the option to create or edit changesets. Editing is done via an Editor and Preview panel; snapshots themselves cannot be changed but can be used as a starting point for new changesets.
- Settings: Shows policies mapped to deployables, selectable for editing.
- Activity: Lists changesets for review, editing, or publishing as new application config versions.
Config Data Tab: Editing and Managing Changesets
When editing config data by opening a changeset, you interact with a tree structure representing the config data nodes. Key interface elements include:
- Config data tree: Navigate and select nodes to edit associated config data.
- View selector: Switch between Script view (key-value pairs in script format) and List view (editable list of CDIs and values).
- Editor panel: Edit the config data directly for the selected node, showing only data directly contained to minimize clutter.
- Preview panel: Shows the fully resolved and persisted state of the config data, updating in real time upon saves.
- Actions menu: Apply variables, view encrypted data (restricted to users with the CDM Secrets role), and view excluded inherited data.
- Action buttons: Save Changes (persist changes without committing), Commit Changeset (generate snapshots and update application config), Delete Changeset, and Refresh View.
Important: Always save your changes before leaving the Config data tab. Commits are blocked if conflicts exist between concurrently open changesets.
Changeset Header and Details
The changeset header displays read-only metadata such as the unique changeset number, description, application name, and timestamps for creation, updates, and commits. The state of a changeset indicates whether it is open, committed, blocked due to conflicts, or in the process of committing. This metadata helps users track changeset status and history effectively.
You can update the config data of an application by creating or opening a changeset on the Config data tab, where you update the structure and CDIs of the config data.
Tabs on the Application page
When you open an application, the header area for each tab displays administrative details for the application: Application name, name of the user that created the application, and timestamp of creation.
- Overview: Basic settings of the application and a Manage deployables button that enables you to edit config data.
- Snapshots: List of snapshots for each deployable in the application. Each entry includes validation and publication status. Policies that execute against a snapshot return validation result. Published snapshots are available for release to the CI/CD pipeline.
- Config data: Read-only view of the config data in a tree structure. Select a node in the tree to view the config data for that node in the application service or infrastructure service. (You can edit
an open changeset or create a new or changeset. The tab then updates to show an Editor panel and a Preview panel where you can create, edit, and save the changeset. You cannot change an existing snapshot, but you can start
with a snapshot changeset and save the changes in a new changeset.)Important:Save your changes whenever you are confident of the changes and before you leave the Config data tab.
- Settings: A list of policies that are mapped to the deployables. Select an item to open it.
- Activity: List of changesets. On this tab, you can open a changeset to continue editing or publish a changeset as a new version of the application config data.
Config data tab
After you open a changeset by selecting Edit config data, you can edit the config data on the Config Data tab. In the config data tree (A in the screenshot), select the node to edit. By default, the editing panel (C) displays the script view of the key-value pairs (the config data items or CDIs) in the selected node.
- A: Config data tree
- The config data tree displays the structured config data. Select a node to edit the associated data.
- B: View selector
- To switch from the Script view (shown as panels C and D) to an editable list of CDIs and their values, slide the selector to List view.
- C: Editor panel
- The Editor panel displays the contents of the selected node. You can edit the config data directly in the Editor panel.Important:To ensure that you edit only the data that you intend to edit, the panel displays only data that is directly in the selected node. The Editor panel lists all included collection and component names but not their contents. This strategy reduces clutter and clarifies the structure of the deployable. To view the fully resolved config data, view the Preview panel (D).
- D: Preview panel
- The Preview panel displays the persisted state of the data in structured form. If you make any changes in the Editor panel and save the changes, the data in the Preview panel is updated to include the changes.
- To resolve variables and view the fully resolved data in the preview panel: In the More actions menu (
), select Apply variables.
- Encrypted data appears as ********. Users with the CDM Secrets [sn_cdm.cdm_secrets] role can view all encrypted values in the preview panel. In the More actions menu (
), select View encrypted data.
- To see nodes and CDIs that are excluded from inheritance: In the More actions menu (
), select View excluded data.
- To resolve variables and view the fully resolved data in the preview panel: In the More actions menu (
- E: Actions
- Refresh View: Update data in the view.
- Save Changes: Save (persist) the current changes but do not commit the data. The Editor panel, List view, and Preview panel refreshes to reflect the resolved state of the changeset. The system updates the changeset but does not update the application. Changes appear on the Activity tab. You must commit a changeset to update the config data for the application. After saving, you can move on to other activities and return later to edit the changeset. The button appears only if you have made changes.
- Delete Changeset: Delete the record of the changeset.
- Commit Changeset:
The system generates a snapshot of each deployable that is affected by the changes.
Note:Because changes in two changesets that are open at the same time can conflict, the system blocks such commits. See Conflicts between changeset commits.
- F: Header for the changeset
- The header displays general read-only information about the changeset. You can view this information and additional information on the Details tab, as described in the next section.
- G: Name path of the selected node
- The name path is the complete folder path of the selected node in the list. Select the copy name path to clipboard icon (
) to copy the name path of the node.
Changeset - Header and Details tab
| Field | Description |
|---|---|
| Changeset number | Unique sequential changeset number that the system auto-assigns. |
| Description | Description that helps other users understand the purpose, scope, and intent of the changeset. |
| Application | Application on which the changeset is based. |
| State |
|
| Created / Created by | User who created the changeset and the timestamp of creation. |
| Updated / Updated by | User who updated the changeset and the timestamp of the update. |
| Committed / Committed by | User who committed the changeset and the timestamp of the commit. |