Admin Global Parameters - Revision history

Craig at 00:30, 24 May 2025

2025-05-24T00:30:55Z

← Older revision		Revision as of 00:30, 24 May 2025
Line 31:		Line 31:

	To use an existing global parameter in a job, instead of supplying a literal value, you will supply the global parameter name surrounded by double curly braces (e.g. <code>{{param}}</code>). Obsidian will see this is a global parameter reference and will import the global parameter values in its place when validating the job and when executing it. The [[Admin Jobs#Global Parameters\|Jobs]] screen page has more detail on referencing global parameters.		To use an existing global parameter in a job, instead of supplying a literal value, you will supply the global parameter name surrounded by double curly braces (e.g. <code>{{param}}</code>). Obsidian will see this is a global parameter reference and will import the global parameter values in its place when validating the job and when executing it. The [[Admin Jobs#Global Parameters\|Jobs]] screen page has more detail on referencing global parameters.

			[[File:Obsidian-6.2.0-Global-Parameter-Mouseover.png]]

Craig at 23:49, 7 June 2023

2023-06-07T23:49:02Z

← Older revision		Revision as of 23:49, 7 June 2023
Line 3:		Line 3:
	= Global Parameters =		= Global Parameters =

	By default, Users who have ''Write'' privileges will be able to edit and save values. Users who have ''Limited Read'' access will see obfuscated values instead of the true configuration values (see [[#~~Access Control~~\|Access Control]]).		By default, Users who have ''Write'' privileges will be able to edit and save values. Users who have ''Limited Read'' access will see obfuscated values instead of the true configuration values (see [[Admin_Global_Parameters#Customized_Access_Control\|Access Control]]).

	== Customized Access Control==		== Customized Access Control==

Carfey at 17:19, 1 July 2016

2016-07-01T17:19:09Z

← Older revision		Revision as of 17:19, 1 July 2016
Line 6:		Line 6:

	== Customized Access Control==		== Customized Access Control==
	By default, '''Write''' users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin Scheduler Settings ~~4.0~~\|Scheduler settings]] <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' category can be used to change this behaviour to restrict these abilities to ''Admin'' users. The former is used to exposed write privileges only to ''Admin'' users, and the latter is used to allow users other than ''Limited Read'' users to view actual configured values instead of obfuscated text.		By default, '''Write''' users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin Scheduler Settings\|Scheduler settings]] <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' category can be used to change this behaviour to restrict these abilities to ''Admin'' users. The former is used to exposed write privileges only to ''Admin'' users, and the latter is used to allow users other than ''Limited Read'' users to view actual configured values instead of obfuscated text.

	== Editing Global Parameters ==		== Editing Global Parameters ==
Line 30:		Line 30:
	A global parameter must be defined before using it in a job.		A global parameter must be defined before using it in a job.

	To use an existing global parameter in a job, instead of supplying a literal value, you will supply the global parameter name surrounded by double curly braces (e.g. <code>{{param}}</code>). Obsidian will see this is a global parameter reference and will import the global parameter values in its place when validating the job and when executing it. The [[Admin Jobs ~~4.0~~#Global Parameters\|Jobs]] screen page has more detail on referencing global parameters.		To use an existing global parameter in a job, instead of supplying a literal value, you will supply the global parameter name surrounded by double curly braces (e.g. <code>{{param}}</code>). Obsidian will see this is a global parameter reference and will import the global parameter values in its place when validating the job and when executing it. The [[Admin Jobs#Global Parameters\|Jobs]] screen page has more detail on referencing global parameters.

Carfey: Carfey moved page Admin Global Parameters 4.0 to Admin Global Parameters

2016-07-01T17:09:33Z

Carfey moved page Admin Global Parameters 4.0 to Admin Global Parameters

← Older revision	Revision as of 17:09, 1 July 2016
(No difference)

Carfey: /* Customized Access Control */

2016-06-29T22:43:54Z

Customized Access Control

← Older revision		Revision as of 22:43, 29 June 2016
Line 6:		Line 6:

	== Customized Access Control==		== Customized Access Control==
	By default, '''Write''' users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin Scheduler Settings 4.0\|~~scheduler~~ settings]] <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' category can be used to change this behaviour to restrict these abilities to ''Admin'' users. The former is used to exposed write privileges only to ''Admin'' users, and the latter is used to allow users other than ''Limited Read'' users to view actual configured values instead of obfuscated text.		By default, '''Write''' users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin Scheduler Settings 4.0\|Scheduler settings]] <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' category can be used to change this behaviour to restrict these abilities to ''Admin'' users. The former is used to exposed write privileges only to ''Admin'' users, and the latter is used to allow users other than ''Limited Read'' users to view actual configured values instead of obfuscated text.

	== Editing Global Parameters ==		== Editing Global Parameters ==

Carfey: /* Editing Global Parameters */

2016-06-29T22:43:37Z

Editing Global Parameters

← Older revision		Revision as of 22:43, 29 June 2016
Line 9:		Line 9:

	== Editing Global Parameters ==		== Editing Global Parameters ==

	~~[[Image:GlobalParameters_4.0.png]]~~


	This screen allows users to either view or edit global parameter values.		This screen allows users to either view or edit global parameter values.
Line 18:		Line 15:

	The ''Remove'' button will remove the parameter and all its values.		The ''Remove'' button will remove the parameter and all its values.

			[[Image:GlobalParameters_4.0.png]]

	== Saving ==		== Saving ==

Carfey: /* Editing Global Parameters */

2016-06-29T22:43:13Z

Editing Global Parameters

← Older revision		Revision as of 22:43, 29 June 2016
Line 10:		Line 10:
	== Editing Global Parameters ==		== Editing Global Parameters ==

	[[Image:~~GlobalParameters~~.png]]		[[Image:GlobalParameters_4.0.png]]

Carfey: /* Editing Global Parameters */

2016-06-29T22:41:28Z

Editing Global Parameters

← Older revision		Revision as of 22:41, 29 June 2016
Line 17:		Line 17:
	To add a global parameter, click the ''Add Parameter'' button. Global parameters always allow multiple values since they have no fixed definition, and you may add values by clicking the (+) and trash buttons to the right of the field. Any entered values will be validated against the selected type, and the selected type will determine how they are stored. Note that the defined type does not have to match the type of job parameters that reference it - Obsidian will perform automatic type conversion where possible. Data types are defined here so that you can avoid configuration errors.		To add a global parameter, click the ''Add Parameter'' button. Global parameters always allow multiple values since they have no fixed definition, and you may add values by clicking the (+) and trash buttons to the right of the field. Any entered values will be validated against the selected type, and the selected type will determine how they are stored. Note that the defined type does not have to match the type of job parameters that reference it - Obsidian will perform automatic type conversion where possible. Data types are defined here so that you can avoid configuration errors.

	The ''Remove ~~Parameter~~'' button will remove the parameter and all its values.		The ''Remove'' button will remove the parameter and all its values.

	== Saving ==		== Saving ==

Carfey: /* Global Parameters */

2016-06-29T22:41:01Z

Global Parameters

← Older revision		Revision as of 22:41, 29 June 2016
Line 3:		Line 3:
	= Global Parameters =		= Global Parameters =

	Users who have ''Write'' privileges will be able to edit and save values. Users who have ''Limited Read'' access will see obfuscated values instead of the true configuration values (see [[#Access Control\|Access Control]]).		By default, Users who have ''Write'' privileges will be able to edit and save values. Users who have ''Limited Read'' access will see obfuscated values instead of the true configuration values (see [[#Access Control\|Access Control]]).

	== Access Control==		== Customized Access Control==
	By default, '''Write''' users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin Scheduler Settings 4.0\|scheduler settings]] <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' category can be used to change this behaviour to restrict these abilities to ''Admin'' users. The former is used to exposed write privileges only to ''Admin'' users, and the latter is used to allow users other than ''Limited Read'' users to view actual configured values instead of obfuscated text.		By default, '''Write''' users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin Scheduler Settings 4.0\|scheduler settings]] <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' category can be used to change this behaviour to restrict these abilities to ''Admin'' users. The former is used to exposed write privileges only to ''Admin'' users, and the latter is used to allow users other than ''Limited Read'' users to view actual configured values instead of obfuscated text.

Line 15:		Line 15:
	This screen allows users to either view or edit global parameter values.		This screen allows users to either view or edit global parameter values.

	To add a global parameter, click the ''Add Parameter'' button. Global parameters always allow multiple values since they have no fixed definition, and you may add values by clicking the ~~''Add Value''~~ and ~~''Remove'' links~~ to the ~~left~~ of the field. Any entered values will be validated against the selected type, and the selected type will determine how they are stored. Note that the defined type does not have to match the type of job parameters that reference it - Obsidian will perform automatic type conversion where possible. Data types are defined here so that you can avoid configuration errors.		To add a global parameter, click the ''Add Parameter'' button. Global parameters always allow multiple values since they have no fixed definition, and you may add values by clicking the (+) and trash buttons to the right of the field. Any entered values will be validated against the selected type, and the selected type will determine how they are stored. Note that the defined type does not have to match the type of job parameters that reference it - Obsidian will perform automatic type conversion where possible. Data types are defined here so that you can avoid configuration errors.

	~~Note that the first field has a~~ ''Remove Parameter'' ~~link instead of ''Remove'', and it~~ will remove all values ~~for that named parameter~~.		The ''Remove Parameter'' button will remove the parameter and all its values.

	== Saving ==		== Saving ==

Carfey: Created page with "Global Parameters allow you to configure job parameters globally, and then simply import them into jobs as needed. This screen can be ..."

2016-06-29T22:38:49Z

Created page with "Global Parameters allow you to configure job parameters globally, and then simply import them into jobs as needed. This screen can be ..."

New page

[[Implementing_Jobs#Global_Parameters|Global Parameters]] allow you to configure job parameters globally, and then simply import them into jobs as needed. This screen can be accessed from the primary navigation sidebar, underneath the Configuration parent menu item.

= Global Parameters =

Users who have ''Write'' privileges will be able to edit and save values. Users who have ''Limited Read'' access will see obfuscated values instead of the true configuration values (see [[#Access Control|Access Control]]).

== Access Control==
By default, '''Write''' users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin Scheduler Settings 4.0|scheduler settings]] <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' category can be used to change this behaviour to restrict these abilities to ''Admin'' users. The former is used to exposed write privileges only to ''Admin'' users, and the latter is used to allow users other than ''Limited Read'' users to view actual configured values instead of obfuscated text.

== Editing Global Parameters ==

[[Image:GlobalParameters.png]]

This screen allows users to either view or edit global parameter values.

To add a global parameter, click the ''Add Parameter'' button. Global parameters always allow multiple values since they have no fixed definition, and you may add values by clicking the ''Add Value'' and ''Remove'' links to the left of the field. Any entered values will be validated against the selected type, and the selected type will determine how they are stored. Note that the defined type does not have to match the type of job parameters that reference it - Obsidian will perform automatic type conversion where possible. Data types are defined here so that you can avoid configuration errors.

Note that the first field has a ''Remove Parameter'' link instead of ''Remove'', and it will remove all values for that named parameter.

== Saving ==

To save your configuration changes, click the Save button at the bottom of the form. If there are problems with your changes, you will be notified at the top of the screen. You can then correct your entered information and re-save. Upon success, you will see a success confirmation.

== Job Validation ==

When saving changes, any jobs that reference global parameters will be re-validated, which may result in a validation error which prevents you from saving your changes. This is to ensure that jobs always have valid configuration based on their defined parameters, that all referenced global parameters exist, and that data types are consistent. [[Implementing_Jobs#Global_Parameters|Parameterization - Global Parameters]] has more detail on global parameter validation.

== Using Global Parameters in Jobs ==

A global parameter must be defined before using it in a job.

To use an existing global parameter in a job, instead of supplying a literal value, you will supply the global parameter name surrounded by double curly braces (e.g. <code>{{param}}</code>). Obsidian will see this is a global parameter reference and will import the global parameter values in its place when validating the job and when executing it. The [[Admin Jobs 4.0#Global Parameters|Jobs]] screen page has more detail on referencing global parameters.