file container on a distributed file system

define - create new localarea definition

  localarea define   AdminName {LocalArea_DefineOption} [force];

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

  localarea clone  AdminName define AdminName {LocalArea_EditOption} [force];

edit - update the localarea properties

  localarea edit   AdminName {LocalArea_EditOption} [force];

show - print the localarea properties

  localarea show   AdminName [LocalArea_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract localarea on the base of query filters

  localarea select AdminPatternList {Filter_Option} [LocalArea_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

check - check if all object attached files are phisically present inside the localarea

  localarea check  AdminName ;

defrag - remove all files not related to any object from the localarea

  localarea defrag  AdminName ;

empty - remove all files from the localarea

  localarea empty  AdminName ;

undefine - remove a empty localarea from the database

  localarea undefine AdminName ;

LocalArea_DefineOption
	description GenericValue
	application AdminName
	image  FileName
	imagedata GenericString
	protocol   LocalArea_Protocol
	host GenericString
	port NUMBER
	path FileName
	permission NUMBER
	account GenericString
	password GenericString
	url FileName
	[! / not] hashnames
	[! / not] subfolders
	[! /not] hidden

LocalArea_EditOption
	name AdminName
	description GenericValue
	application AdminName
	svnrev NUMBER
	image  FileName
	imagedata GenericString
	protocol   LocalArea_Protocol
	host GenericString
	port NUMBER
	path FileName
	permission NUMBER
	account GenericString
	password GenericString
	url FileName
	rehash
	[! / not] hashnames
	[! / not] subfolders
	[! /not] hidden

LocalArea_Protocol
	file
	ftp
	http

LocalArea_GetOption
	get [LocalArea_GetBasicOption]
	LocalArea_GetBasicOption
		{ LocalArea_GetBasicToken [as IDENTIFIER] { LocalArea_GetBasicToken [as IDENTIFIER] } }
		LocalArea_GetBasicToken [as IDENTIFIER]
		LocalArea_GetBasicToken
			Common_GetBasicOption
			protocol
			host
			port
			path
			permission
			account
			password
			url
			hashnames
			subfolders
			filespace	[. FileSpace_GetBasicOption]
			filespace[]	[. FileSpace_GetBasicOption]
			filespace[ AdminName ]

KEYWORDs
	account	the username to access the localarea (ftp/http types)
	application	the associated application menu
	description	the localarea description
	filespace	list of filespaces supported by this localarea
	force	this flag allows to ignore errors during the creation/update (for example, the folder physical creation)
	hashnames	this flag enables the file name encryption to avoid collisions inside the localarea
	hidden	administration hidden objects are not visible/usable
	host	localarea host IP address or name (only for ftp type; default = localhost or 127.0.0.1)
	image	local path for the localarea icon to upload
	imagedata	base64 code for the localarea icon
	moddate	last modification date
	name	the localarea name
	password	the password to access the localarea (ftp/http types)
	path	the localarea location path (relative for ftp/http types; absolute for file type) the root folder is given by the associated filespace subpath
	permission	folder access permissions ( unix code; ex: 755 ) (ftp/file types)
	port	localarea host port (only for ftp type; default = 21)
	protocol	the localarea type: - file: files are stored in the Network File System (NFS) - ftp: uses the FTP to exchange and manipulate files over a TCP/IP network - http: files are exchanged by a "FileSystem" web service.
	rehash	re-generate the file names according to the hashnames flag
	subfolders	this flag enables the sub-folders creation based on the encrypted file names (allows to limit the number of files collected into a single folder)
	svnrev	SVN repository revision number
	url	the webservice url (only for http type)