file container for object attachments

define - create new filespace definition

  filespace define   AdminName {FileSpace_DefineOption} [force];

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

  filespace clone  AdminName define AdminName {FileSpace_EditOption} [force];

edit - update the filespace properties

  filespace edit   AdminName {FileSpace_EditOption} [force];

show - print the filespace properties

  filespace show   AdminName [FileSpace_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract filespaces on the base of query filters

  filespace select AdminPatternList {Filter_Option} [FileSpace_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

synchronize - synchronize all the files from the filespace to/from a localarea

  filespace synchronize AdminName  [FileSpace_SyncOption] [force] [add] [commit NUMBER] ;

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

  filespace check  AdminName ;

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

  filespace defrag  AdminName ;

empty - remove all files from the filespace

  filespace empty  AdminName ;

undefine - remove a empty filespace from the database

  filespace undefine AdminName ;

FileSpace_DefineOption
	description GenericValue
	application AdminName
	image  FileName
	imagedata GenericString
	protocol   FileSpace_Protocol
	host GenericString
	port NUMBER
	path FileName
	subpath FileName
	permission NUMBER
	account GenericString
	password GenericString
	url FileName
	localarea   AdminName { AdminName }
	[! / not] hashnames
	[! / not] subfolders
	[! /not] hidden

FileSpace_EditOption
	name AdminName
	description GenericValue
	application AdminName
	svnrev NUMBER
	image  FileName
	imagedata GenericString
	protocol   FileSpace_Protocol
	host GenericString
	port NUMBER
	path FileName
	subpath FileName
	permission NUMBER
	account GenericString
	password GenericString
	url FileName
	rehash
	localarea Edit_Operator AdminName { Edit_Operator AdminName }
	[! / not] hashnames
	[! / not] subfolders
	[! /not] hidden

FileSpace_Protocol
	file
	ftp
	http
	database

FileSpace_SyncOption
	to localarea AdminName
	from localarea AdminName

FileSpace_GetOption
	get [FileSpace_GetBasicOption]
	FileSpace_GetBasicOption
		{ FileSpace_GetBasicToken [as IDENTIFIER] { FileSpace_GetBasicToken [as IDENTIFIER] } }
		FileSpace_GetBasicToken [as IDENTIFIER]
		FileSpace_GetBasicToken
			Common_GetBasicOption
			protocol
			host
			port
			path
			subpath
			permission
			account
			password
			url
			localarea	[. LocalArea_GetBasicOption]
			localarea[]	[. LocalArea_GetBasicOption]
			localarea[ AdminName ]
			hashnames
			subfolders

KEYWORDs
	account	the username to access the filespace (ftp/http types)
	add	synchronization: add file if it doesn't exist inside the localarea (otherwise only common files are synchronized)
	application	the associated application menu
	description	the filespace description
	force	this flag allows to ignore errors during the creation/update (for example, the folder physical creation or some localarea not yet defined) synchronization: replaces files also if they are more recent
	hashnames	this flag enables the file name encryption to avoid collisions inside the filespace
	host	filespace host IP address or name (only for ftp type; default = localhost or 127.0.0.1)
	hidden	administration hidden objects are not visible/usable
	localarea	associated localareas (storage mirrors) for local file replications
	image	local path for the filespace icon to upload
	imagedata	base64 code for the filespace icon
	moddate	last modification date
	name	the filespace name
	password	the password to access the filespace (ftp/http types)
	path	the filespace location path (relative for ftp/http types; absolute for file type)
	permission	folder access permissions ( unix code; ex: 755 ) (ftp/file types)
	port	filespace host port (only for ftp type; default = 21)
	protocol	the filespace type: - database: content of files is placed inside database BLOB fields - 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)
	subpath	filespace root folder included into the path folder (ftp/http/file types)
	svnrev	SVN repository revision number
	url	the webservice url (only for http type)