---
title: "set system setting · RUAL Documentation"
description: "define a system setting"
canonical: https://docs.rual.nl/block-types/system%20settings/function_set_system_key
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# set system setting

This block is part of the [`system settings`](https://docs.rual.nl/block-types/system%20settings) group and was last modified in core [`v10.4.28`](https://docs.rual.nl/core-versions/100428).

define a system setting

- flow `flow`

- Field required `value` name of this system key

- Value required `value` value of this system key

- description `value` Describes what this key is used for

- secure `condition` Sets the key to be containing secure values

- flow `flow`

Creates a document in the system_key_value storage with the given field name and value (plus description when wired), then continues; there is no success or error output. An empty or unwired field does nothing at all, and a failing write is silently swallowed. The is_secure pin is declared but not read by the Go executor.

A typical wiring for [set system setting](https://docs.rual.nl/block-types/system%2520settings/function_set_system_key): a [function trigger](https://docs.rual.nl/block-types/globals/trigger_custom_function) starts the flow; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `field` pin; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `value` pin; the `flow` out pin feeds [debug](https://docs.rual.nl/block-types/state%2520ui/state_debug).

[![Studio canvas example for the set system setting block: typical wiring for set system setting.](https://docs.rual.nl/canvas-examples/function_set_system_key.png)](https://docs.rual.nl/canvas-examples/function_set_system_key.png?v=3)

## Version history

Introduced in [`v10.4.28`](https://docs.rual.nl/core-versions/100428).

- [Back to `system settings`](https://docs.rual.nl/block-types/system%20settings): Return to the main group to view all sub-groups

- [Back to `system`](https://docs.rual.nl/block-types/system%20settings?group=system): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)