uip rpa settings

Syntax and options for `uip rpa settings`, which reads the effective Studio settings with governance applied and overrides a setting for the open project session.

uip rpa settings reads the effective Studio settings, with any governance policy applied, and overrides a setting for the open project session. Each setting reports its value, whether a policy binds it, and where the value comes from.

Synopsis

uip rpa settings get [--name <setting>]
uip rpa settings set --name <setting> [--value <value>]

uip rpa settings get

Get the effective Studio settings with any governance policy applied. Does not require an open project.

Options

Long	Value	Required	Description
--name <setting>	string	no	Setting name, for example object-repository-enforced. When omitted, every setting is returned.

Output

Each setting is reported with the following fields.

Field	Description
Value	The effective value, or (no value asserted).
binding	Whether the setting is binding. A binding setting is one the policy forbids overriding locally, or one where governance applies but could not be read, so the most restrictive value stands. A setting the policy sets but allows overriding is reported as not binding.
source	Where the value comes from, as listed in the table below.
policy	Name of the governance policy that sets the value, when one does.
profile	Governance profile, when one applies.

Source	Meaning
Governance	Set by an administrator's governance policy.
SessionOverride	Overridden for this session with settings set.
UserSettings	Set in the user's Studio settings.
Default	Product default; nothing governs or sets it.
Unresolved	Known to the backend, but nothing governs or sets it and it asserts no value of its own.
Unknown	Governance applies but could not be read; the most restrictive value applies.
None	Not known to the backend.

When --name matches no setting, the command reports that no setting has that name.

Examples

# List every setting
uip rpa settings get

# Read one setting
uip rpa settings get --name object-repository-enforced

uip rpa settings set

Set a Studio setting for the open project session only, or revert it by omitting --value. Nothing is written to disk, and the override lasts until the session ends. The command is refused when a governance policy binds the setting, and the refusal names the policy. Requires an open project.

Options

Long	Value	Required	Description
--name <setting>	string	yes	The setting to override, for example object-repository-enforced. Run uip rpa settings get for the names.
--value <value>	string	no	The value to set, for example false. Omit it to drop the override and fall back to the governance policy and the user's settings.

Examples

# Override a setting for this session
uip rpa settings set --name object-repository-enforced --value false

# Drop the override
uip rpa settings set --name object-repository-enforced

Related

• uip rpa analyze — run the workflow analyzer against the tenant's governance policy.

See also

• RPA tool overview
• Global options
• Exit codes