This page contains information related to an old version of the File Upload Component.
Old versions do not appear in category lists; only the newest versions are listed.
To take advantage of the latest features and improvements, we always recommend you use the latest versions of Interface Components whenever possible. See the latest version's page for information about what's been changed.
Allows users to upload a file. File upload is only enabled on start and task forms.
|Label||label||Text||Optional text to display as the field label.|
|Label Position||labelPosition||Text|| Optional text to determine where the label appears. Valid values include
|Instructions||instructions||Text||Optional text displayed below the field's value.|
|Help Tooltip||helpTooltip||Text|| Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is
|Target||target||Document or Folder||Determines the eventual location of the uploaded file. When a Folder, the uploaded file is created as a document in that folder. When a Document, the uploaded file is created as a new version of that document.|
|Document Name||documentName||Text||Optionally determines the name for the document. When not provided, the uploaded filename is used.|
|Document Description||documentDescription||Text||Determines the description for the document. When not provided, the description of the new file or version is empty.|
|Selected Document||value||Document||The document associated with this field.|
|Save Document To||saveInto||Save Array|| One or more variables that are updated with the document when the user uploads a file. Removing an uploaded file saves a null document. Use
|Required||required||Boolean|| Determines if a value is required to submit the form. Default is
|Required Message||requiredMessage||Text||Custom message to be displayed when the field's value is required and not provided.|
|Disabled||disabled||Boolean|| Determines if the user is prevented from changing the value and determines if the field should be grayed out. Default is
|Validations||validations||Text Array||Validation errors to be displayed below the field when the value is not null.|
|Validation Group||validationGroup||Text||When present, this field is only validated when a button in the same validation group is clicked.|
|Visibility||showWhen||Boolean||Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.|
\ / " ; : | ? ' < > *
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Single File Upload
1 2 3 4 5 6 7 8 =a!fileUploadField_17r1( label: "Upload resume", instructions: "Accepted Formats: docsx, xlsx, png, etc", target: cons!RESUME_FOLDER, value: ri!file, saveInto: ri!file, required: true )
Displays the following:
Using the field to upload a file called "Resume.pdf" displays the following: