Admin Global Parameters (3.x.x and earlier) - Revision history

Carfey: /* Access Control */

2016-07-01T17:00:04Z

Access Control

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

	== 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 ~~System~~\|System]] settings <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' section 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 System_(3.x.x_and_earlier)\|System]] settings <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' section 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: Carfey moved page Admin Global Parameters to Admin Global Parameters (3.x.x and earlier) without leaving a redirect

2016-07-01T16:51:48Z

Carfey moved page Admin Global Parameters to Admin Global Parameters (3.x.x and earlier) without leaving a redirect

← Older revision	Revision as of 16:51, 1 July 2016
(No difference)

Carfey: /* Access Control */

2014-03-19T16:43:39Z

Access Control

← Older revision		Revision as of 16:43, 19 March 2014
Line 6:		Line 6:

	== 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 System\|System]] settings <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' section can be used to change this behaviour to restrict these 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 System\|System]] settings <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' section 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: /* Access Control */

2014-03-19T16:43:20Z

Access Control

← Older revision		Revision as of 16:43, 19 March 2014
Line 6:		Line 6:

	== Access Control==		== Access Control==
	By default, ~~only admin~~ users may edit global parameters, and all users except ''Limited Read'' users may view them in clear text. [[Admin System\|System]] settings <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' section can be used to change this behaviour. The former is used to exposed write privileges ~~to ''Write'' users in addition~~ 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 System\|System]] settings <code>globalParamEditAdminRequired</code> and <code>globalParamReadAdminRequired</code> under the ''Dashboard'' section can be used to change this behaviour to restrict these 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 */

2014-03-18T04:46:48Z

Editing Global Parameters

← Older revision		Revision as of 04:46, 18 March 2014
Line 15:		Line 15:
	This screen will allow users to either read or edit and save global parameter values.		This screen will allow users to either read or edit and save global parameter values.

	To add a global parameter, click the ''Add Parameter'' link. 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 ~~defined here~~ are defined here so that you can avoid configuration errors.		To add a global parameter, click the ''Add Parameter'' link. 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.		Note that the first field has a ''Remove Parameter'' link instead of ''Remove'', and it will remove all values for that named parameter.

Carfey: /* Job Validation */

2014-03-18T04:32:24Z

Job Validation

← Older revision		Revision as of 04:32, 18 March 2014
Line 27:		Line 27:
	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.		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 ==		== Using Global Parameters in Jobs ==

	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#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 at 04:32, 18 March 2014

2014-03-18T04:32:11Z

← Older revision		Revision as of 04:32, 18 March 2014
Line 26:		Line 26:

	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.		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#Global Parameters\|Jobs]] screen page has more detail on referencing global parameters.

Carfey at 04:28, 18 March 2014

2014-03-18T04:28:57Z

← Older revision		Revision as of 04:28, 18 March 2014
Line 19:		Line 19:
	Note that the first field has a ''Remove Parameter'' link instead of ''Remove'', and it will remove all values for that named parameter.		Note that the first field has a ''Remove Parameter'' link instead of ''Remove'', and it will remove all values for that named parameter.

	'''Note:''' When making 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.		== Saving ==

			To save your configuration changes, click the Save button at the bottom of the form or in the left navigation area. 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.

	== ~~Saving~~ ==		== Job Validation ==

	~~To save your configuration~~ changes, ~~click the Save button at the bottom of the form or~~ in ~~the left navigation area. 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~~.		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.

Carfey at 04:28, 18 March 2014

2014-03-18T04:28:28Z

← Older revision		Revision as of 04:28, 18 March 2014
Line 18:		Line 18:

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

			'''Note:''' When making 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.


	== Saving ==		== Saving ==

	To save your configuration changes, click the Save button at the bottom of the form or in the left navigation area. 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.		To save your configuration changes, click the Save button at the bottom of the form or in the left navigation area. 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.

	'''Note:''' 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.

Carfey: /* Saving */

2014-03-18T04:26:54Z

Saving

← Older revision		Revision as of 04:26, 18 March 2014
Line 23:		Line 23:
	To save your configuration changes, click the Save button at the bottom of the form or in the left navigation area. 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.		To save your configuration changes, click the Save button at the bottom of the form or in the left navigation area. 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.

	'''Note:''' 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.		'''Note:''' 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.