OBEROn - OOQL Language

home

project

documentation

support

applications

downloads

contacts

assignment

user role for the application context

define - create new assignment definition

  assignment define AdminName {Assignment_DefineOption} [force];

clone - duplicate a assignment and set the properties for the new instance

  assignment clone AdminName define AdminName {Assignment_EditOption} [force];

edit - update the assignment properties

  assignment edit AdminName {Assignment_EditOption} [force];

show - print the assignment properties

  assignment show AdminName [Assignment_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract assignments on the base of query filters

  assignment select AdminPatternList {Filter_Option} [Assignment_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

undefine - remove an assignment from the database

  assignment undefine AdminName ;

Assignment_DefineOption
	description GenericValue
	application AdminName
	image FileName
	imagedata GenericString
	language GenericString
	email GenericValue
	user AdminName { AdminName }
	team AdminName { AdminName }
	[! /not] hidden

Assignment_EditOption
	name AdminName
	description GenericValue
	application AdminName
	svnrev NUMBER
	image FileName
	imagedata GenericString
	language GenericString
	email GenericValue
	user Edit_Operator AdminName { Edit_Operator AdminName }
	team Edit_Operator AdminName { Edit_Operator AdminName }
	[! /not] hidden

Assignment_GetOption
	get [Assignment_GetBasicOption]

	Assignment_GetBasicOption
		{ Assignment_GetBasicToken [as IDENTIFIER] { Assignment_GetBasicToken [as IDENTIFIER] } }
		Assignment_GetBasicToken [as IDENTIFIER]

		Assignment_GetBasicToken
			Common_GetBasicOption
			language
			email
			user	[. User_GetBasicOption]
			user[]	[. User_GetBasicOption]
			user[ AdminName ]
			team	[. Team_GetBasicOption]
			team[]	[. Team_GetBasicOption]
			team[ AdminName ]

KEYWORDs
	application	the associated application menu
	description	the assignment description
	email	the assignment email address (if not specified the messages will be sent to the associated user email addresses)
	force	this flag allows to ignore errors during the creation/update (for example, the teams or users not yet defined)
	hidden	administration hidden objects are not visible/usable
	image	local path for the assignment icon to upload
	imagedata	base64 code for the assignment icon
	language	the default assignment language for UI label translation
	moddate	last modification date
	name	the assignment name
	svnrev	SVN repository revision number
	team	teams assigned with this role
	user	users assigned with this role

SAMPLES

assignment define AS01 description "Assignment 01" email "as01@gmail.com" user User2 "User3" team TM4 ;

assignment define "AS03" description Assignment 03" email "as03@yahoo.com" user User3 team TM1 TM4 ;

assignment clone AS01 define AS02 description "AS 02" user add 'User5' remove User3 team add TM0;

assignment edit AS02 description "Assignment 02" user add 'User4' team remove TM4 force;

assignment show 'AS01' token xml exportfile "c:\temp\exportAS01.xml";

assignment show AS02 get { name email user[].{ address name } team.{ name subteam } } token { "|" ";" ","} ;

assignment select AS0? get { name description language team[ TM0 ] team[ 'TM4' ] } token { "|" ";" } ;

Common_GetBasicOption
	Common_GetBasicToken [ as IDENTIFIER ]

Common_GetBasicToken
	id
	name
	origdate
	moddate
	moduser
	description
	svnrev
	hidden
	image
	imagedata
	feature[ AdminName ]	[. Feature_GetBasicOption]
	feature[]	[. Feature_GetBasicOption]
	feature	[. Feature_GetBasicOption]
	application	[. Menu_GetBasicOption]
	super
	admintype

Edit_Operator
	add
	remove

Edit_RefOperator
	addbefore AdminName set
	addafter AdminName set
	add
	remove
	movebefore
	moveafter

Edit_AddOperator
	addbefore AdminName define
	addafter AdminName define
	append

Edit_MoveOperator
	movebefore
	moveafter

Event_Type
	action
	check

AdminPatternList
	AdminNamePattern {, AdminNamePattern}

AdminNamePattern
	*
	PATTERNIDENTIFIER
	STRINGVAL
	AdminName

GenericPatternList
	GenericPattern {, GenericPattern}

GenericPattern
	*
	IDENTIFIER
	PATTERNIDENTIFIER
	GenericValue

AdminActor
	user AdminName
	team AdminName
	assignment AdminName

AdminName
	IDENTIFIER
	QUOTED_STRING
	SQUOTED_STRING

GenericValue
	DATETIME
	GenericNumber
	GenericString
	BOOLEANVAL

GenericString
	STRINGVAL
	QUOTED_STRING
	SQUOTED_STRING

GenericNumber
	NUMBER
	REALNUMBER

Filter_Option
	moddate Date_Range
	application AdminNamePattern

Date_Range
	= DATETIME
	!= DATETIME
	< DATETIME
	> DATETIME
	<= DATETIME
	>= DATETIME
	in [ DATETIME , DATETIME ]
	in ( DATETIME , DATETIME ]
	in [ DATETIME , DATETIME )
	in ( DATETIME , DATETIME )

Token_Option
	token { Token_Separator { Token_Separator } }
	token Token_Separator

Token_Separator
	QUOTED_STRING
	SQUOTED_STRING
	IDENTIFIER
	STRINGVAL
	json
	json-
	json+
	xml
	xml-
	xml+

ExportFile_Option
	exportfile FileName [append] [xml \| json ]

ImportFile_Option
	importfile FileName [xml \| json \|emxxml]

LogFile_Option
	logfile FileName [append]

FileName
	QUOTED_STRING
	SQUOTED_STRING

grammar rules
[ ]	= optional element - only one item is allowed : ( 0 or 1 )
{ }	= optional element - more than one is allowed : ( 0 or N )
/	= alternative
	= one of ...

	all bold texts represent keywords or command syntax

IDVAL
	#<5 dec digits [ 0-9 ]>-<8 hex digits [ 0-9 A-F ]>
	example: #00020-34F2A80E

COMMENT
	// <any character until the end of the line(\n \r)>
	example: // My single line comment

LONGCOMMENT
	/* <any character> */
	example: /* My multi line comment starts here continue here and finish here */

DATETIME
	<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits>
	examples: 2009-12-23 2009/03/19 2009.11.14
	<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits> <hours>:<minutes>:[<seconds>]
	examples: 2009-12-23 10:23 2009/03/19 16:03:34 2009.11.14 00:20:04

NUMBER
	[+-]<decimal digits [ 0-9 ]>
	examples: -1203 +276 25

BOOLEANVAL
	true / false

REALNUMBER
	[+-]<decimal digits [ 0-9 ]>.<decimal digits [ 0-9 ]>[E(+-)<esponent [0-9]>]
	example: -37.837 +2.3874 13.887 1.4862E-04

QUOTED_STRING
	"<any character>"
	example: "my quoted string"

SQUOTED_STRING
	'<any character>'
	example: 'my single quoted string'

IDENTIFIER
	<one or more of [ a-z A-Z ]><zero or more of [ a-z A-Z 0-9 _ ]>
	example: Var1 object_Name_02

VARIABLE
	$<one o more of [ a-z A-Z 0-9 ]><zero or more of [ a-z A-Z 0-9 _ ]>
	example: $1 $var_02 $1b

STRINGVAL
	<one or more of [ a-z A-Z 0-9 -_ $ ? @ \| ~ % & / = : + \ # ' ]>
	a string not recognized as identifier

PATTERNIDENTIFIER
	<a string with * (match 0 or more characters) and ? (match 1 character) wildcards>
	example: mypaer?_ide?ti