Guide: Entitlement & Eligibility - Revision history

As1844 at 12:02, 12 May 2026

2026-05-12T12:02:01Z

← Older revision		Revision as of 12:02, 12 May 2026
Line 27:		Line 27:
	=== Quota Entitlements ===		=== Quota Entitlements ===
	A quota entitlement consists of two parts, the namespace and the identifier (eligibility):		A quota entitlement consists of two parts, the namespace and the identifier (eligibility):
	~~[urn:geant:dfn.de:bwidm:bwcloud-os:group:ELIGIBILITY_DATA~~ <nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''ELIGIBILITY_DATA''']		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''ELIGIBILITY_DATA'''
	bzw.		bzw.
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''<quota_flavor>:<cost_center>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]'''		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''<quota_flavor>:<cost_center>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]'''
	The ~~syntax~~ for ~~valid eligibilities~~ is ~~described~~ in the sections ~~below~~.		=== Entitlement structure for eligibilities ===
			The following structure for a eligibiltiy may be used to provide further information and define constraints for the quota flavor:
			'''<quota_flavor>:<cost_center>'''[:CONSTRAINTS]
			respectively
			'''<quota_flavor>:<cost_center>'''[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]
			Further explenation is provided in the next sections.

	=== Access Entitlement ===		=== Access Entitlement ===
Line 50:		Line 55:
	* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.		* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.
	* The eligibility owner is dedicated to the home organization named in <code><nowiki>http://bwidm.de/bwidmOrgId</nowiki></code>, not by pattern in the cost center.		* The eligibility owner is dedicated to the home organization named in <code><nowiki>http://bwidm.de/bwidmOrgId</nowiki></code>, not by pattern in the cost center.
	~~=== Structure ===~~
	~~Optionally, the following structure for Eli may be used to provide further information and define constraints for the quota flavor:~~
	~~'''<quota_flavor>:<cost_center>'''[:CONSTRAINTS]~~
	~~respectively~~
	~~'''<quota_flavor>:<cost_center>'''[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]~~

	=== Owner ===		=== Owner ===
	The user holding the eligibility, e.g., the account carrying the related entitlement, owns the eligibility.		The user holding the eligibility, e.g., the account carrying the related entitlement, owns the eligibility.

As1844 at 11:57, 12 May 2026

2026-05-12T11:57:35Z

← Older revision		Revision as of 11:57, 12 May 2026
Line 12:		Line 12:

	* Entitlements are strings assigned to a user carrying information about his/her privileges.		* Entitlements are strings assigned to a user carrying information about his/her privileges.
	* Every [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota entitlements]] (which can be ~~seen as~~ a "package") contains an eligibility. After "unpacking", the bwCloud-OS works only with the eligibility. This is kind of a "protocol" to communicate with the [[Guide: Enterprise Resource Planning\|Enterprise Resource Planning (ERP)]].		* Every [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota entitlements]] (which can be considered a "package") contains an eligibility data. After "unpacking", the bwCloud-OS works only with the eligibility. This is kind of a "protocol" to communicate with the [[Guide: Enterprise Resource Planning\|Enterprise Resource Planning (ERP)]].
	* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].		* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].
	* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.		* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.
Line 27:		Line 27:
	=== Quota Entitlements ===		=== Quota Entitlements ===
	A quota entitlement consists of two parts, the namespace and the identifier (eligibility):		A quota entitlement consists of two parts, the namespace and the identifier (eligibility):
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''~~ELIGIBILITY~~'''		[urn:geant:dfn.de:bwidm:bwcloud-os:group:ELIGIBILITY_DATA <nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''ELIGIBILITY_DATA''']
	bzw.		bzw.
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''<quota_flavor>:<cost_center>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]'''		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''<quota_flavor>:<cost_center>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]'''
	The syntax for valid ~~eligibilitues~~ is described in the sections below.		The syntax for valid eligibilities is described in the sections below.

	=== Access Entitlement ===		=== Access Entitlement ===
Line 44:		Line 44:

	== Eligibility ==		== Eligibility ==
	Every project is associated with an ~~entitlement~~, making sure the project is chargeable.		Every project is associated with an eligibility, making sure the project is chargeable.

	* An eligibility is a unique combination of owner, quota flavor, and cost center.		* An eligibility is a unique combination of owner, quota flavor, and cost center.
	* An eligibility can be assigned to a maximum of one project~~. The eligibility-project association is therefore unique~~. The Eligibility-Project-Mapping is a <code>1:{0..1}</code>-Mapping.		* An eligibility can be assigned to a maximum of one project. The Eligibility-Project-Mapping is a <code>1:{0..1}</code>-Mapping. The eligibility-project association is therefore unique.
	* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.		* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.
	* The eligibility owner is dedicated to the home organization named in <code><nowiki>http://bwidm.de/bwidmOrgId</nowiki></code>, not by pattern in the cost center.		* The eligibility owner is dedicated to the home organization named in <code><nowiki>http://bwidm.de/bwidmOrgId</nowiki></code>, not by pattern in the cost center.
Line 55:		Line 55:
	respectively		respectively
	'''<quota_flavor>:<cost_center>'''[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]		'''<quota_flavor>:<cost_center>'''[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]

			=== Owner ===
			The user holding the eligibility, e.g., the account carrying the related entitlement, owns the eligibility.

	=== Quota flavors ===		=== Quota flavors ===
Line 60:		Line 63:

	* A user can have several quota flavors.		* A user can have several quota flavors.
	* A quota flavor can be specified ~~several~~ times by using different cost centers. Each additional eligibility can be used for another project.		* A quota flavor can be specified many times by using different cost centers. Each additional eligibility can be used for another project.

	The given quota flavor name must be within the [[Guide: Project and Quota#List of quota flavors\|list of support project quota flavors]].		The given quota flavor name must be within the [[Guide: Project and Quota#List of quota flavors\|list of support project quota flavors]].
Line 70:		Line 73:

	==== Custom-eligibility ====		==== Custom-eligibility ====
	The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources. The entitlement looks similar to this		The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources. The entitlement associated with this eligibility looks similar to this
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''custom:'''<cost_center>		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''custom:'''<cost_center>

As1844 at 15:37, 7 May 2026

2026-05-07T15:37:15Z

← Older revision		Revision as of 15:37, 7 May 2026
Line 70:		Line 70:

	==== Custom-eligibility ====		==== Custom-eligibility ====
	The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources. The entitlement looks ~~like~~ this:		The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources. The entitlement looks similar to this
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''custom:'''<cost_center>		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''custom:'''<cost_center>

As1844 at 15:36, 7 May 2026

2026-05-07T15:36:07Z

← Older revision		Revision as of 15:36, 7 May 2026
Line 27:		Line 27:
	=== Quota Entitlements ===		=== Quota Entitlements ===
	A quota entitlement consists of two parts, the namespace and the identifier (eligibility):		A quota entitlement consists of two parts, the namespace and the identifier (eligibility):
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group~~:ELIGIBILITY~~</nowiki>		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''ELIGIBILITY'''
	bzw.		bzw.
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:<quota_flavor>:<~~cost_center_id~~>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''<quota_flavor>:<cost_center>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]'''
	The syntax for valid eligibilitues is described in the sections below.		The syntax for valid eligibilitues is described in the sections below.

	=== Access Entitlement ===		=== Access Entitlement ===
	There is also a special entitlement ''access'', which determines whether a user is allowed to access the bwCloud-OS at all. On the level of the bwIDM is this entitlement necessary to [[Registration\|register]] for the bwCloud-OS.		There is also a special entitlement ''access'', which determines whether a user is allowed to access the bwCloud-OS at all. On the level of the bwIDM is this entitlement necessary to [[Registration\|register]] for the bwCloud-OS.
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os~~:access~~</nowiki>		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os</nowiki>:'''access'''
	{\| class="wikitable"		{\| class="wikitable"
	!permition		!permition
Line 52:		Line 52:
	=== Structure ===		=== Structure ===
	Optionally, the following structure for Eli may be used to provide further information and define constraints for the quota flavor:		Optionally, the following structure for Eli may be used to provide further information and define constraints for the quota flavor:
	<quota_flavor>:<~~cost_center_id~~>[:CONSTRAINTS]		'''<quota_flavor>:<cost_center>'''[:CONSTRAINTS]
	respectively		respectively
	<quota_flavor>:<~~cost_center_id~~>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]		'''<quota_flavor>:<cost_center>'''[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]

	=== Quota flavors ===		=== Quota flavors ===
Line 65:		Line 65:

	==== Empty-eligibility ====		==== Empty-eligibility ====
	Each user owns this eligibility. This is set for each user within the bwCloud-OS environment and can't be removed from a user. An empty quota entitlement can't be given explicitly. Furthermore, this eligibility, and only this, can be used for multiple projects.		Each user owns this eligibility. This is set for each user within the bwCloud-OS environment and can't be removed from a user. An empty quota entitlement does not exist and can't be given explicitly. Furthermore, this eligibility, and only this, can be used for multiple projects. A project associated with this eligibility has no quota granted and therefore cannot generate costs. The eligibility looks exactly like this:

			<code>{'''<nowiki/>'quota_flavor': 'empty'''', 'cost_center': 'bwcos_erp_fallback', 'first_day_of_validation': null, 'last_day_of_validation': null, 'max_booking_units': null}</code>

	==== Custom-eligibility ====		==== Custom-eligibility ====
	The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources.		The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources. The entitlement looks like this:
			<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''custom:'''<cost_center>

	=== Cost centers ===		=== Cost centers ===

As1844 at 15:19, 7 May 2026

2026-05-07T15:19:15Z

← Older revision		Revision as of 15:19, 7 May 2026
Line 66:		Line 66:
	==== Empty-eligibility ====		==== Empty-eligibility ====
	Each user owns this eligibility. This is set for each user within the bwCloud-OS environment and can't be removed from a user. An empty quota entitlement can't be given explicitly. Furthermore, this eligibility, and only this, can be used for multiple projects.		Each user owns this eligibility. This is set for each user within the bwCloud-OS environment and can't be removed from a user. An empty quota entitlement can't be given explicitly. Furthermore, this eligibility, and only this, can be used for multiple projects.

			==== Custom-eligibility ====
			The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources.

	=== Cost centers ===		=== Cost centers ===

As1844 at 07:38, 30 April 2026

2026-04-30T07:38:51Z

← Older revision		Revision as of 07:38, 30 April 2026
Line 69:		Line 69:
	=== Cost centers ===		=== Cost centers ===
	{\| class="mw-message-box mw-message-box-warning"		{\| class="mw-message-box mw-message-box-warning"
	\| style="vertical-align:middle;" \| '''⚠️ Please Note:''' The cost center can be a random string, making only sense to the home organization.		\| style="vertical-align:middle;" \| '''⚠️ Please Note:''' The cost center can be a random string, making only sense to the home organization. By defining a propper string, the home organization can define the [[Guide: Charging#Cost aggregation by cost center\|positions listed on the final bill]].
	\|}		\|}
	Cost centers are used to allocate BEH generated within projects. This string does not need to be agreed upon with us and does not need to have any meaning outside the institution.		Cost centers are used to allocate BEH generated within projects. This string does not need to be agreed upon with us and does not need to have any meaning outside the institution.

As1844 at 06:42, 29 April 2026

2026-04-29T06:42:53Z

← Older revision		Revision as of 06:42, 29 April 2026
Line 47:		Line 47:

	* An eligibility is a unique combination of owner, quota flavor, and cost center.		* An eligibility is a unique combination of owner, quota flavor, and cost center.
	* An eligibility can be assigned to a maximum of one project. The eligibility-project association is therefore unique.		* An eligibility can be assigned to a maximum of one project. The eligibility-project association is therefore unique. The Eligibility-Project-Mapping is a <code>1:{0..1}</code>-Mapping.
	* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.		* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.
			* The eligibility owner is dedicated to the home organization named in <code><nowiki>http://bwidm.de/bwidmOrgId</nowiki></code>, not by pattern in the cost center.
	=== Structure ===		=== Structure ===
	Optionally, the following structure for Eli may be used to provide further information and define constraints for the quota flavor:		Optionally, the following structure for Eli may be used to provide further information and define constraints for the quota flavor:
Line 109:		Line 110:
	Interpreted as eligibility:		Interpreted as eligibility:
	quota_flavor = medium_1		quota_flavor = medium_1
	~~cost_center_id~~ = 42		cost_center = 42
	first_day_of_validation = <nowiki>{{today}}</nowiki>		first_day_of_validation = <nowiki>{{today}}</nowiki>
	last_day_of_validation = inf		last_day_of_validation = inf
Line 122:		Line 123:
	Interpreted as eligibility:		Interpreted as eligibility:
	quota_flavor = large_1		quota_flavor = large_1
	~~cost_center_id~~ = student		cost_center = student
	first_day_of_validation = <nowiki>{{today}}</nowiki>		first_day_of_validation = <nowiki>{{today}}</nowiki>
	last_day_of_validation = 31.12.2026		last_day_of_validation = 31.12.2026
Line 135:		Line 136:
	Interpreted as eligibility:		Interpreted as eligibility:
	quota_flavor = xtiny_1		quota_flavor = xtiny_1
	~~cost_center_id~~ = hfu_netze2		cost_center = hfu_netze2
	first_day_of_validation = 01.02.2026		first_day_of_validation = 01.02.2026
	last_day_of_validation = 31.01.2027		last_day_of_validation = 31.01.2027
Line 148:		Line 149:
	Interpreted as eligibility:		Interpreted as eligibility:
	quota_flavor = large_1		quota_flavor = large_1
	~~cost_center_id~~ = ufr_technical_faculty		cost_center = ufr_technical_faculty
	first_day_of_validation = <nowiki>{{today}}</nowiki>		first_day_of_validation = <nowiki>{{today}}</nowiki>
	last_day_of_validation = inf		last_day_of_validation = inf

As1844 at 13:39, 3 March 2026

2026-03-03T13:39:58Z

← Older revision		Revision as of 13:39, 3 March 2026
Line 63:		Line 63:
	The given quota flavor name must be within the [[Guide: Project and Quota#List of quota flavors\|list of support project quota flavors]].		The given quota flavor name must be within the [[Guide: Project and Quota#List of quota flavors\|list of support project quota flavors]].

	==== Empty eligibility ====		==== Empty-eligibility ====
	Each user owns this eligibility. This is set for each user within the bwCloud-OS environment and can't be removed from a user. An empty quota entitlement can't be given explicitly. Furthermore, this eligibility, and only this, can be used for multiple projects.		Each user owns this eligibility. This is set for each user within the bwCloud-OS environment and can't be removed from a user. An empty quota entitlement can't be given explicitly. Furthermore, this eligibility, and only this, can be used for multiple projects.

As1844 at 15:53, 27 February 2026

2026-02-27T15:53:25Z

← Older revision		Revision as of 15:53, 27 February 2026
Line 12:		Line 12:

	* Entitlements are strings assigned to a user carrying information about his/her privileges.		* Entitlements are strings assigned to a user carrying information about his/her privileges.
	* Every [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota entitlements]] (which can be seen as a "package") contains an eligibility. After "unpacking", the bwCloud-OS works only with the eligibility.		* Every [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota entitlements]] (which can be seen as a "package") contains an eligibility. After "unpacking", the bwCloud-OS works only with the eligibility. This is kind of a "protocol" to communicate with the [[Guide: Enterprise Resource Planning\|Enterprise Resource Planning (ERP)]].
	* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].		* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].
	* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.		* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.

As1844 at 15:33, 27 February 2026

2026-02-27T15:33:44Z

← Older revision		Revision as of 15:33, 27 February 2026
Line 15:		Line 15:
	* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].		* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].
	* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.		* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.
			* Eligibilities are used in the [[Guide: Charging\|charging process]].

	Every member of a higher education institution in Baden-Württemberg has a personal account. If the institution participates in the federated identity management system ('''bwIDM'''), its members can also apply for the external service bwCloud-OS, by providing additional information. This is handled through the assignment of <code>eduPersonEntitlement</code> to the user's account.		Every member of a higher education institution in Baden-Württemberg has a personal account. If the institution participates in the federated identity management system ('''bwIDM'''), its members can also apply for the external service bwCloud-OS, by providing additional information. This is handled through the assignment of <code>eduPersonEntitlement</code> to the user's account.