FormFile

From GeoMedia Smart Client
Jump to: navigation, search
Settings WorkflowSetting FormSetting CommonSetting




Tutorial

The tutorial can be found here.


FormFile-Attributes

Attribute Mandatory Description
name yes Unique name (inside the form) of the FormFile which corresponds to the column-name of the table.


 <FormFile ... name="FILEPATH" ... />
authorization no Only users with the appropriate Role/Claim are authorized to view/process the element.


 <FormFile ... authorization="ROLE[ADMIN,EDITOR]" ... />
 <FormFile ... authorization="CLAIM[WF_ADMIN,WF_EDIT]" ... />
editable no Boolean value which defines if the form is editable:
  • editable="true"
  • editable="SCRIPT[...]"
  • editable="SESSION[KeyExists(...)]"
  • editable="SQL[...]"
  • editable="OBJECT[...]"


 <FormFile ... editable="false" ... />
help no Help text for the FormFile.


 <FormFile ... help="Do not use special characters here!" ... />
label no Label for the FormFile displayed in Workflow-Form.


 <FormFile ... label="Symbology:" ... />
persisted no Boolean value which defines if the FormFile can be stored inside the actual table.


 <FormFile ... persisted="false" ... />
required no Boolean value which defines if the FormFile may contain NULL values or not. The attribute can be generated in several ways:
  • required="true"
  • required="SCRIPT[...]"
  • required="{FORM.FIELDNAME}"
  • required="{SESSION.SELECTION}"


 <FormFile ... required="false" ... />
saveinsession no Attribute to persist (after a submit) the actual FormFile value in a session variable which can be referenced later (for example, from another Form), for example,:

saveinsession="FORMNAME.FORMFILENAME" This variable will be stored in the SEC_SESSION table.

 <FormFile ... saveinsession="FORMNAME.FORMFILENAME" ... />
validation no The validation of user input can be done at runtime using the following methods:
  • validation="SCRIPT[...]"
  • validation="OBJECT[...]"
  • validation="SQL[...]"

As a result, either of these methods must deliver true or false (1/0).

 <FormFile ... validation="SCRIPT[...]" ... />
 <FormFile ... validation="OBJECT[classname.methodname({SESSION.SELECTION})]" ... />
 <FormFile ... validation="SQL[SELECT DECODE(COUNT(*),0,1,0) FROM PR_UNIT WHERE PR_ID={FORM.PR_ID}]" ... />
visible no Sets the visibility of the FormFile and defines in which workflow elements the FormFile should be used/visible:
  • visible="false"
  • visible="SESSION[KeyExists(...)]"
  • visible="SCRIPT[...]"
  • visible="list,form"
  • visible="hidden"
  • visible="OBJECT[...]"


 <FormFile ... visible="false" ... />
uploaddir no Absolute path to upload directory.


 <FormFile ... uploaddir="C:\UploadedFiles" ... />
multiple no Boolean value which defines if multiple files can be uploaded.


 <FormFile ... multiple="false" ... />
filenamefield no Persist file name of the uploaded file in the specified column.


 <FormFile ... filenamefield="FileName" ... />
contenttypefield no Persist content type of the uploaded file in the specified column.


 <FormFile ... contenttypefield="ContentType" ... />
useuniquename no If useuniquename is true, uploaded file will be prefixed with an unique id.


 <FormFile ... useuniquename="true" ... />
fileextension no Comma-separated list of allowed file extensions.


 <FormFile ... fileextension="png,jpg,jpeg" ... />


Examples

Example 1: Definition of a simple file upload. File is uploaded in "C:\Temp\Upload" directory and the full file path is persisted in "FilePath" column

 <FormFile name="FilePath" datatype="file" uploaddir="C:\Temp\Upload" multiple="false" />


Example 2: Definition of a simple binary file upload. File is only as binary persisted in "FileData" column

 <FormFile name="FileData" datatype="binary" multiple="false" />


Example 3: Like Example 1, but additional file name and content type are stored in the "FileName" and "ContentType" columns

 <FormFile name="FilePath" datatype="file" uploaddir="C:\Temp\Upload" multiple="false" filenamefield="FileName" contenttypefield="ContentType" />


Example 4: Like Example 2, but additional file name and content type are stored in the "FileName" and "ContentType" columns

 <FormFile name="FileData" datatype="binary" multiple="false" filenamefield="FileName" contenttypefield="ContentType" />


Language: English