View source for Organization DSL

==Introduction==

OrganizationDSL is used to define the organizations and their positions. The roles which are defined in [[Authorization DSL]] could be assigned to the positions here.

==OrganizationDSL==

The OrganizationDSL is working at runtime. It used to define the organizations, their positions and assign the roles to them. There will be no exported file generated after editing the model. Each user should have its own position, and the roles defined in [[Authorization DSL]] could be assigned to the positions. The authorization of user will be done according to the authorization rules of roles at runtime.

The main semantic elements of the OrganizationDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages. 

* “organization” - define organization and its positions in the fact, e.g. president, VP, manager. . .

* “superiorPos” - define which position is the superior position of the current position. 

* “position” -  define the position details, including superior position and role. 

* “role” - assign the roles which are defined in [[Authorization DSL]] to the positions.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>  {
    organization <organization name> . . . [{...}]
    ...
}
</syntaxhighlight>

The package definition of OrganizationDSL is just like most of the DSL models, you just need to define the package name and in eclipse like other java project press ctrl+shift+o, all necessary models or java classes will be imported automatically. After that, you can define the organizations and positions. One or more organizations can be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package org.eclipse.osbp.foodmart.authorizations {
	import org.eclipse.osbp.foodmart.authorizations.* 
	. . .
	organization FoodMart . . . {. . .}
	. . .
}
</syntaxhighlight>

====organization====

This is the main part of this model. Either position or sub-organization could be defined in the main organization.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <mainOrganization name 1>  Title <organization title 1> [{
position <mainPosition name> {. . .}
[position <position name> superiorPos <superiorPosition name 1> {. . .}]
	. . .
[organization <organization name 2>  Title <organization title 2>   
  superiorPos <superiorPosition name 2> [{ . . . }]]
. . .
}]
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
organization FoodMart Title "Organization" {
position President {. . .}
	position VP_Country_Manager superiorPos President {. . .}
. . .
organization Store_Manager_Org Title "Stores" superiorPos  VP_Country_Manager {. . .}
. . .
}
</syntaxhighlight>

In this example, main <code>organization</code> '''''FoodMart''''' with <code>title</code> “Organization” is defined. Many positions and organizations can be defined in this main organization. The main <code>position</code> of this organization is '''''President'''''; another <code>position</code> '''''VP_Country_Manager''''' uses this main position as its superior position. A sub organization '''''Store_Manager_Org''''' with <code>title</code> “Stores” is also defined in this main organization, which uses '''''VP_Country_Manager''''' as its superior position.

=====position======

You can define the position and its role here.

► '''Syntax''':
<syntaxhighlight lang="java">
position <position name> [superiorPos <position name>] {
		[role <role name>]
		. . .
}
</syntaxhighlight>

* If the position is not a main position of an organization, its superior position must be defined.

* Superior position must be defined before it is used.

* One position can be defined without role, and also can be defined with one or more roles. 

* All roles must be defined in [[Authorization DSL]].

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager  {
position Store_Manager {
		role Sales
}

	position Store_Shift_Supervisor superiorPos Store_Manager {
		role Sales
}

position Store_Temporary_Checker superiorPos Store_Shift_Supervisor {
}
. . .
}
</syntaxhighlight>

In this example, the <code>position</code> '''''Store_Manager''''' is the main position of the sub <code>organization</code> '''''Store_Manager_Org''''', so it is defined without a superior position; its superior position is defined by the definition of <code>organization</code> '''''Store_Manager_Org''''', which means, <code>position</code> '''''VP_Country_Manager''''' is the superior position of <code>position</code> '''''Store_Manager'''''.  Another <code>position</code> '''''Store_Shift_Supervisor''''' is also defined in this organization, and <code>position</code> '''''Store_Manager''''' is its superior position. <code>role</code> '''''Sales''''' is assigned to both of the position. The third <code>position</code> '''''Store_Temporary_Checker''''' is under <code>position</code> '''''Store_Shift_Supervisor''''', it is defined without a role.

=====organization . . . superiorPos  . . .=====

The sub organization could be defined in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <organization name 1>  Title <organization title 1>   
superiorPos <superiorPosition name 1> [{ 
	position <mainPosition name> {. . .}
	position <position name> superiorPos <superiorPosition name 2> {. . .}
	. . .
[organization <organization name 2>  Title <organization title 2>   
  superiorPos <superiorPosition name 3> [{ . . . }]]
. . .

}]
</syntaxhighlight>

* Sub organization must be defined with a superior position.

* Otherwise, the syntax of sub organization is totally as same as main organization.

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager  {
position Store_Manager {
		role Sales
}

	position Store_Assistant_Manager superiorPos Store_Manager {
		role Sales
	}
. . .
organization Store_Temporary_Stocker_Org Title "Stocker"  superiorPos Store_Assistant_Manager { 
		position Store_Temporary_Stocker {
			role Sales
	}

		position Store_Permanent_Butcher
		superiorPos Store_Temporary_Stocker {
			role Sales
	}
}
}
</syntaxhighlight>

We use the same example, sub <code>organization</code> '''''Store_Manager_Org''''':  <code>position</code> '''''Store_Assistant_Manager''''' is defined under main <code>position</code> '''''Store_Manager'''''. A new <code>organization</code> '''''Store_Temporary_Stocker_Org''''' is defined under <code>position</code> '''''Store_Assistant_Manager'''''; it has 2 <code>position</code>:  main <code>position</code> is '''''Store_Temporary_Stocker''''', which default has the same superior <code>position</code> as this organization, in this case, it is '''''Store_Assistant_Manager'''''; another <code>position</code> is '''''Store_Permanent_Butcher''''' and its superior <code>position</code> is '''''Store_Temporary_Stocker'''''; <code>role</code> '''''Sales''''' is assigned to both of the position.

The whole organigram can be shown in os.bee applications like the following picture:

<br><br>[[File:OrganizationDSL_01.png|600px]]<br><br>

== Copyright Notice ==
{{Copyright Notice}}