Role extensions - Revision history

Administrator: /* Inheritance */

2019-12-20T12:53:03Z

Inheritance

← Older revision		Revision as of 12:53, 20 December 2019
Line 14:		Line 14:

	Depending of the role extension works on users or roles, the actual value returned may be a [[RoleExtensionUserDocumentation class\|RoleExtensionUserDocumentation]], or a [[RoleExtensionRoleDocumentation class\|RoleExtensionRoleDocumentation]]. It is also possible to return a [[RoleExtensionEventDocumentation class\|RoleExtensionEventDocumentation]] for those extensions that are event on changes to membership of a role, these are called automatically so documentation makes little sense.		Depending of the role extension works on users or roles, the actual value returned may be a [[RoleExtensionUserDocumentation class\|RoleExtensionUserDocumentation]], or a [[RoleExtensionRoleDocumentation class\|RoleExtensionRoleDocumentation]]. It is also possible to return a [[RoleExtensionEventDocumentation class\|RoleExtensionEventDocumentation]] for those extensions that are event on changes to membership of a role, these are called automatically so documentation makes little sense.

	~~== Inheritance ==~~

	== Helper functions/classes ==		== Helper functions/classes ==

Administrator: /* Documentation */

2019-12-20T12:52:41Z

Documentation

← Older revision		Revision as of 12:52, 20 December 2019
Line 2:		Line 2:

	== Parameters ==		== Parameters ==
	The parameter given is either an instance of the [[RoleExtensionParameter]] class or zero parameters.		The parameter given is either an instance of the [[RoleExtensionParameter class\|RoleExtensionParameter]] class or zero parameters.

	If called with zero parameters, the script should return [[Role extensions#Documentation\|documentation]] for itself.		If called with zero parameters, the script should return [[Role extensions#Documentation\|documentation]] for itself.
Line 11:		Line 11:
	When the role extension is called with zero parameters, it should return some documentation for itself.		When the role extension is called with zero parameters, it should return some documentation for itself.

	The documentation consists of a [[RoleExtensionDocumentation]] class instance.		The documentation consists of a [[RoleExtensionDocumentation class\|RoleExtensionDocumentation]] class instance.

	Depending of the role extension works on users or roles, the actual value returned may be a [[RoleExtensionUserDocumentation]], or a [[RoleExtensionRoleDocumentation]]. It is also possible to return a [[RoleExtensionEventDocumentation]] for those extensions that are event on changes to membership of a role, these are called automatically so documentation makes little sense.		Depending of the role extension works on users or roles, the actual value returned may be a [[RoleExtensionUserDocumentation class\|RoleExtensionUserDocumentation]], or a [[RoleExtensionRoleDocumentation class\|RoleExtensionRoleDocumentation]]. It is also possible to return a [[RoleExtensionEventDocumentation class\|RoleExtensionEventDocumentation]] for those extensions that are event on changes to membership of a role, these are called automatically so documentation makes little sense.

	== Inheritance ==		== Inheritance ==

Administrator: /* Documentation */

2019-12-18T09:19:36Z

Documentation

← Older revision		Revision as of 09:19, 18 December 2019
Line 11:		Line 11:
	When the role extension is called with zero parameters, it should return some documentation for itself.		When the role extension is called with zero parameters, it should return some documentation for itself.

	The documentation consists of a [[RoleExtensionDocumentation]] class instance:		The documentation consists of a [[RoleExtensionDocumentation]] class instance.

	~~"name" where~~ the value is a [[~~LocalizedString class\|LocalizedString~~]] ~~must contain the name of the functionality provided for an admin user to see. e.g. "Reset password"~~.		Depending of the role extension works on users or roles, the actual value returned may be a [[RoleExtensionUserDocumentation]], or a [[RoleExtensionRoleDocumentation]]. It is also possible to return a [[RoleExtensionEventDocumentation]] for those extensions that are event on changes to membership of a role, these are called automatically so documentation makes little sense.

	~~"description" where the value~~ is a [[~~LocalizedString class\|LocalizedString~~]] ~~must contain a short description of the functionality~~ for ~~an admin user~~ to ~~better understand what it actually does. e.g. "Sets~~ a ~~new random password for the user and emails it to the address registered for the user".~~

	~~Optionally "permissionRequired": 2 = read, 4 = write, 6 = full control. Default, if not given, is "write". This is the minimum permission required to run this~~ role ~~extension on a user.~~

	~~Optionally "toggleable": true or false. Default is false. If true, a user can either has a given status or not, which can be toggled.~~

	~~Optionally "informsUser": true or false. Default is false. If true~~, ~~this script will send a notification to the user about the change~~.

	== Inheritance ==		== Inheritance ==
Line 29:		Line 21:
	== Discovery of role extensions ==		== Discovery of role extensions ==
	Role extensions are discovered in the following order:		Role extensions are discovered in the following order:
	# Workflow scripts that are children of roles in parent folders with same name. I.E. if the current role is named R1, and is located in the Path \Products\Dashboard1\Company A\Dept B, then it will look for role extensions in		# Workflow scripts may be defined in folders named "Role exts" anywhere in the system.
	~~#* \Products\Dashboard1\Company A\Dept B\R1~~
	~~#* \Products\Dashboard1\Company A\R1~~
	~~#* \Products\Dashboard1\R1~~
	~~#* \Products\R1~~
	~~#* \R1~~
	~~# Generic~~ scripts may be defined in folders named "Role exts" in ~~any of~~ the ~~parents. I~~.~~E. following the example from above the following folders are examined:~~
	~~#* \Products\Dashboard1\Company A\Dept B\Role exts~~
	~~#* \Products\Dashboard1\Company A\Role exts~~
	~~#* \Products\Dashboard1\Role exts~~
	~~#* \Products\Role exts~~
	~~#* \Role exts~~
	# If the current user does not have read access to the role extension itself, then the extension is ignored.		# If the current user does not have read access to the role extension itself, then the extension is ignored.
	# If ~~multiple role extensions are found with~~ the ~~same name~~, then ~~only the first one found~~ is ~~"discovered". But it is possible inside a role extension~~ to ~~call the "parent" version of the~~ role ~~extension~~.		# If the documentation has LimitToPath, then that is examined to filter out if not applicable to current role.
	[[Category:Roles]]		[[Category:Roles]]

Administrator: /* Documentation */

2019-12-13T05:23:52Z

Documentation

← Older revision		Revision as of 05:23, 13 December 2019
Line 6:		Line 6:
	If called with zero parameters, the script should return [[Role extensions#Documentation\|documentation]] for itself.		If called with zero parameters, the script should return [[Role extensions#Documentation\|documentation]] for itself.

	If the script is called with other parameters, then the script is not called via ~~theRole~~ framework, which can be useful if scripts can be utilized for other functions.		If the script is called with other parameters, then the script is not called via the Role framework, which can be useful if scripts can be utilized for other functions.

	== Documentation ==		== Documentation ==
	When the role extension is called with zero parameters, it should return some documentation for itself.		When the role extension is called with zero parameters, it should return some documentation for itself.

	The documentation consists of a ~~dictionary with the following keys and values~~:		The documentation consists of a [[RoleExtensionDocumentation]] class instance:

	"name" where the value is a [[LocalizedString class\|LocalizedString]] must contain the name of the functionality provided for an admin user to see. e.g. "Reset password".		"name" where the value is a [[LocalizedString class\|LocalizedString]] must contain the name of the functionality provided for an admin user to see. e.g. "Reset password".
Line 18:		Line 18:

	Optionally "permissionRequired": 2 = read, 4 = write, 6 = full control. Default, if not given, is "write". This is the minimum permission required to run this role extension on a user.		Optionally "permissionRequired": 2 = read, 4 = write, 6 = full control. Default, if not given, is "write". This is the minimum permission required to run this role extension on a user.

			Optionally "toggleable": true or false. Default is false. If true, a user can either has a given status or not, which can be toggled.

			Optionally "informsUser": true or false. Default is false. If true, this script will send a notification to the user about the change.

	== Inheritance ==		== Inheritance ==

Administrator: /* Documentation */

2019-12-10T11:30:00Z

Documentation

← Older revision		Revision as of 11:30, 10 December 2019
Line 17:		Line 17:
	"description" where the value is a [[LocalizedString class\|LocalizedString]] must contain a short description of the functionality for an admin user to better understand what it actually does. e.g. "Sets a new random password for the user and emails it to the address registered for the user".		"description" where the value is a [[LocalizedString class\|LocalizedString]] must contain a short description of the functionality for an admin user to better understand what it actually does. e.g. "Sets a new random password for the user and emails it to the address registered for the user".

	Optionally "permissionRequired": 2 = read, 4 = write, 6 = full control. Default, if not given, is "write".		Optionally "permissionRequired": 2 = read, 4 = write, 6 = full control. Default, if not given, is "write". This is the minimum permission required to run this role extension on a user.

	== Inheritance ==		== Inheritance ==

Administrator: /* Documentation */

2019-12-10T10:10:28Z

Documentation

← Older revision		Revision as of 10:10, 10 December 2019
Line 9:		Line 9:

	== Documentation ==		== Documentation ==
			When the role extension is called with zero parameters, it should return some documentation for itself.

			The documentation consists of a dictionary with the following keys and values:

			"name" where the value is a [[LocalizedString class\|LocalizedString]] must contain the name of the functionality provided for an admin user to see. e.g. "Reset password".

			"description" where the value is a [[LocalizedString class\|LocalizedString]] must contain a short description of the functionality for an admin user to better understand what it actually does. e.g. "Sets a new random password for the user and emails it to the address registered for the user".

			Optionally "permissionRequired": 2 = read, 4 = write, 6 = full control. Default, if not given, is "write".

	== Inheritance ==		== Inheritance ==

Administrator at 05:13, 10 December 2019

2019-12-10T05:13:01Z

← Older revision		Revision as of 05:13, 10 December 2019
Line 2:		Line 2:

	== Parameters ==		== Parameters ==
			The parameter given is either an instance of the [[RoleExtensionParameter]] class or zero parameters.

			If called with zero parameters, the script should return [[Role extensions#Documentation\|documentation]] for itself.

			If the script is called with other parameters, then the script is not called via theRole framework, which can be useful if scripts can be utilized for other functions.

	== Documentation ==		== Documentation ==
Line 17:		Line 22:
	#* \Products\R1		#* \Products\R1
	#* \R1		#* \R1
	# Generic scripts may be defined in folders named "Role exts" in any of the parents. I.E. ~~followng~~ the example from above the following folders are examined:		# Generic scripts may be defined in folders named "Role exts" in any of the parents. I.E. following the example from above the following folders are examined:
	#* \Products\Dashboard1\Company A\Dept B\Role exts		#* \Products\Dashboard1\Company A\Dept B\Role exts
	#* \Products\Dashboard1\Company A\Role exts		#* \Products\Dashboard1\Company A\Role exts
Line 25:		Line 30:
	# If the current user does not have read access to the role extension itself, then the extension is ignored.		# If the current user does not have read access to the role extension itself, then the extension is ignored.
	# If multiple role extensions are found with the same name, then only the first one found is "discovered". But it is possible inside a role extension to call the "parent" version of the role extension.		# If multiple role extensions are found with the same name, then only the first one found is "discovered". But it is possible inside a role extension to call the "parent" version of the role extension.
			[[Category:Roles]]

Administrator: Created page with "Role extensions are extensions points for a role. == Parameters == == Documentation == == Inheritance == == Helper functions/classes == == Discovery of role extensions ==..."

2019-12-03T08:09:20Z

Created page with "Role extensions are extensions points for a role. == Parameters == == Documentation == == Inheritance == == Helper functions/classes == == Discovery of role extensions ==..."

New page

Role extensions are extensions points for a role.

== Parameters ==

== Documentation ==

== Inheritance ==

== Helper functions/classes ==

== Discovery of role extensions ==
Role extensions are discovered in the following order:
# Workflow scripts that are children of roles in parent folders with same name. I.E. if the current role is named R1, and is located in the Path \Products\Dashboard1\Company A\Dept B, then it will look for role extensions in
#* \Products\Dashboard1\Company A\Dept B\R1
#* \Products\Dashboard1\Company A\R1
#* \Products\Dashboard1\R1
#* \Products\R1
#* \R1
# Generic scripts may be defined in folders named "Role exts" in any of the parents. I.E. followng the example from above the following folders are examined:
#* \Products\Dashboard1\Company A\Dept B\Role exts
#* \Products\Dashboard1\Company A\Role exts
#* \Products\Dashboard1\Role exts
#* \Products\Role exts
#* \Role exts
# If the current user does not have read access to the role extension itself, then the extension is ignored.
# If multiple role extensions are found with the same name, then only the first one found is "discovered". But it is possible inside a role extension to call the "parent" version of the role extension.