Dispatch Server Settings


Dispatch - Server Setup

  • Server: (select) This defines where you would want to upload your files to.
    • Default: Localhost (webroot)
    • Possible Values:
      • Localhost: This will upload your local webserver. The directory will be defined from the server root.
      • Localhost (webroot): This will upload your local webserver. The directory will be defined from the root of your website.
      • Remote SFTP Server: This is an external server that you want to upload the file via SFTP protocol.
  • Server Name: (input) The port that SFTP is listening on the server. (Advanced) In most cases this will be port 22.
    • Enable: When Server is set to sftp
    • Default: server.domain.com
  • Server Port: (number) The port that SFTP is listening on the server. (Advanced) In most cases this will be port 22.
    • Enable: When Server is set to sftp
    • Default: 22
    • Min Value: 0
    • Max Value: 10000
  • Username: (input) Username (required)
    • Enable: When Server is set to sftp
    • Default:
  • Password: (input) Password (required)
    • Enable: When Server is set to sftp
    • Default:
  • Destination: (input) Destination Folder (optional)
    • Default: /uploads

Dispatch - Form Fields

  • Show Input 1?: (checkbox) Show the custom input form field #1
    • Default: false
  • Clear on Submit?: (checkbox) Clear the input field after the form has been submitted.
    • Enable: When Show Input 1? is set to true
    • Default: false
  • Require Input 1?: (checkbox) Require that the input field have content
    • Enable: When Show Input 1? is set to true
    • Default: false
  • Verify Email String?: (checkbox) If the contents of the field is supposed to be an email address, verify that its properly formatted.
    • Enable: When Require Input 1? is set to true
    • Default: false
  • Validation Error: (input) The error to be displayed if validation fails for this field.
    • Enable: When Require Input 1? is set to true
    • Default: Please enter your name.
  • Input 1 Label: (input) The label for input field #1
    • Enable: When Show Input 1? is set to true
    • Default: Name

  • Show Input 2?: (checkbox) Show the custom input form field #2
    • Default: false
  • Clear on Submit?: (checkbox) Clear the input field after the form has been submitted.
    • Enable: When Show Input 2? is set to true
    • Default: false
  • Require Input 2?: (checkbox) Require that the input field have content
    • Enable: When Show Input 2? is set to true
    • Default: false
  • Verify Email String?: (checkbox) If the contents of the field is supposed to be an email address, verify that its properly formatted.
    • Enable: When Require Input 2? is set to true
    • Default: false
  • Validation Error: (input) The error to be displayed if validation fails for this field.
    • Enable: When Require Input 2? is set to true
    • Default: Please enter a valid email address.
  • Input 2 Label: (input) The label for input field #2
    • Enable: When Show Input 2? is set to true
    • Default: Email

  • Show Textarea?: (checkbox) Show the custom input form textarea
    • Default: false
  • Rows: (slider) The number of text rows used in the textarea
    • Enable: When Show Textarea? is set to true
    • Default: 10
    • Min Value: 1
    • Max Value: 50
  • Clear on Submit?: (checkbox) Clear the input field after the form has been submitted.
    • Enable: When Show Textarea? is set to true
    • Default: false
  • Require Textarea?: (checkbox) Require that the input field have content
    • Enable: When Show Textarea? is set to true
    • Default: false
  • Validation Error: (input) The error to be displayed if validation fails for this field.
    • Enable: When Require Textarea? is set to true
    • Default: Please enter notes.
  • Textarea Label: (input) The label for text area field
    • Enable: When Show Textarea? is set to true
    • Default: Notes

  • Show Human Test?: (checkbox) Show the human test field
    • Default: false
  • Use as password?: (checkbox) Turn the human test into a password. The answer is the password.
    • Enable: When Show Human Test? is set to true
    • Default: true
  • Human Test Label: (input) The label for human test field
    • Enable: When Show Human Test? is set to true
    • Default: Passphrase
  • Answer: (input) The passphrase the the users must enter in order to upload files.
    • Enable: When Show Human Test? is set to true
    • Default:
  • Validation Error: (input) The error to be displayed if validation fails for this field.
    • Enable: When Show Human Test? is set to true
    • Default: Please enter the passphrase.
  • Password Icon: (image) The icon used in the passphrase field
    • Enable: When Show Human Test? is set to true
    • Default: %assetPath%/dispatch_images/upload_lock.png

  • Inline Field Labels?: (checkbox) Show the form field labels inline instead of on top of each field. You must preview your page for this to take effect.
    • Default: true
  • Split Form?: (checkbox) Style the form into 2 columns
    • Default: false
  • Horizontal Split: (slider) Adjust the split between the form while horizontal
    • Enable: When Split Form? is set to true
    • Default: 50%
    • Min Value: 10%
    • Max Value: 90%

  • Custom Field Styles?: (checkbox) Show the custom form style controls.
    • Default: false
  • Shadow: (select) The type of shadow applied to the fields.
    • Enable: When Custom Field Styles? is set to true
    • Default: Inset Shadow
    • Possible Values:
      • Inset Shadow: This will add an inset shadow onto the fields.
      • Drop Shadow: This will add a drop shadow to the fields.
  • Text Size: (number) The size of the text of the labels and in the fields
    • Enable: When Custom Field Styles? is set to true
    • Default: 15px
    • Min Value: 5px
    • Max Value: 50px
  • Round Corners: (slider) Add round corners to the form fields.
    • Enable: When Custom Field Styles? is set to true
    • Default: 5px
    • Min Value: 0px
    • Max Value: 20px
  • Labels: (color) The color of the field labels
    • Enable: When Custom Field Styles? is set to true
    • Allows Opacity: false
  • Text: (color) The color of the field text
    • Enable: When Custom Field Styles? is set to true
    • Allows Opacity: false
  • Background: (color) The color of the field background
    • Enable: When Custom Field Styles? is set to true
    • Allows Opacity: false
  • Border: (color) The color of the field border
    • Enable: When Custom Field Styles? is set to true
    • Allows Opacity: false
  • Focused Text: (color) The color of the field text when the field is in focus
    • Enable: When Custom Field Styles? is set to true
    • Allows Opacity: false
  • Focused Bg: (color) The color of the field background when the field is in focus
    • Enable: When Custom Field Styles? is set to true
    • Allows Opacity: false
  • Focused Border: (color) The color of the field border when the field is in focus
    • Enable: When Custom Field Styles? is set to true
    • Allows Opacity: false

Dispatch - File Queue

  • Height: (number) The height of the file queue
    • Default: 175px
    • Min Value: 0px
    • Max Value: 2000px
  • Background: (select) The style of background used for the file queue.
    • Default: Solid Color
    • Possible Values:
      • Solid Color
      • Tiled Image
  • Tile Image: (image) The tile image background for the queue
    • Enable: When Background is set to tile
    • Default:
  • Color: (color) The color of the queue background
    • Enable: When Background is set to color
    • Allows Opacity: false
  • Queue Icon: (image) The icon centered in the middle of the queue
    • Default: %assetPath%/dispatch_images/queue_bg.png
  • Round Corners: (slider) Add round corners to the queue.
    • Default: 5px
    • Min Value: 0px
    • Max Value: 20px
  • Border Size: (slider) The size of the queue border
    • Default: 2px
    • Min Value: 0px
    • Max Value: 20px
  • Border: (color) The color of the border of the file queue
    • Allows Opacity: false

  • Entry Background: (color) The color of the file entry background
    • Allows Opacity: false
  • Entry Text: (color) The color of the file entry text
    • Allows Opacity: false
  • Entry progress: (color) The color of the file entry progress bar.
    • Allows Opacity: false
  • Entry Complete: (color) The color of the file entry background once its been successfully uploaded
    • Allows Opacity: false
  • Entry Error: (color) The color of the file entry background if there was an error uploading the file.
    • Allows Opacity: false
  • Entry Close: (image) The close icon used on each entry.
    • Default: %assetPath%/dispatch_images/uploadifive-cancel.png

Dispatch - Button Style

  • Button Style: (select) The style of buttons. Use customiable default buttons or any button stack you want.
    • Default: Default Buttons
    • Possible Values:
      • Default Buttons
      • Use Button Stack
  • Float Right?: (checkbox) Postiiont the button on the right side of the form.
    • Default: false
  • Browse Label: (input) The text that is contained within the browse for file button
    • Enable: When Button Style is set to default
    • Default: Select Files
  • Upload Label: (input) The text that is contained within the upload button
    • Enable: When Button Style is set to default
    • Default: Upload
  • Width: (number) The width of the buttons
    • Default: 100px
    • Min Value: 10px
    • Max Value: 1000px
  • Height: (number) The height of the buttons
    • Enable: When Button Style is set to default
    • Default: 30px
    • Min Value: 10px
    • Max Value: 1000px
  • Text Size: (number) The size of the text in the buttons
    • Enable: When Button Style is set to default
    • Default: 12px
    • Min Value: 8px
    • Max Value: 50px
  • Text: (color) The color of the button text
    • Enable: When Button Style is set to default
    • Allows Opacity: false
  • Background: (color) The color of the button
    • Enable: When Button Style is set to default
    • Allows Opacity: false
  • Border: (color) The color of the button
    • Enable: When Button Style is set to default
    • Allows Opacity: false
  • Border Size: (slider) The size of the border on the buttons
    • Enable: When Button Style is set to default
    • Default: 2px
    • Min Value: 0px
    • Max Value: 10px
  • Round Corners: (slider) The corner radius of the buttons
    • Enable: When Button Style is set to default
    • Default: 30px
    • Min Value: 0px
    • Max Value: 100px

Dispatch - On Upload Complete

  • Action: (select) The action that will launch after all uploads have completed.
    • Default: None
    • Possible Values:
      • None
      • Redirect to URL
      • Trigger SpecialFX Click
  • Redirect URL: (link) The url that will be redirected to after the uploads have completed.
    • Enable: When Action is set to redirect
    • Default:
  • SpecialFx ID: (input) The ID from the SpecialFx stack that you want to be launched.
    • Enable: When Action is set to spfx
    • Default:
  • Upload meta txt file?: (checkbox) Upload a meta text file wiht the same name as the file uploaded. The file will contain the contents of the form fields.
    • Default: false
  • Send Email?: (checkbox) Send an email with the upload information.
    • Default: false
  • To: (input) Comma delimited list of email addresses that you would like to send the email to.
    • Enable: When Send Email? is set to true
    • Default:
  • From: (select) This defines the from email address on the email sent.
    • Enable: When Send Email? is set to true
    • Default: Use Fallback
    • Possible Values:
      • Input Field 1
      • Input Field 2
      • Use Fallback
  • From Fallback: (input) Email address that will be put in the from field if none other is specified
  • Subject: (input) The subject of the email.
    • Enable: When Send Email? is set to true
    • Default: New File Upload

  • Rename Files?: (checkbox) Rename files upon upload.
    • Default: true
  • Rename Only Duplicates?: (checkbox) Only renmae files if a duplicate was found.
    • Enable: When Rename Files? is set to true
    • Default: false
  • Rename Rule: (select) The rule that the file rename will use.
    • Enable: When Rename Files? is set to true
    • Default: filename-.ext
    • Possible Values:
      • filename-.ext
      • filename-.ext
      • .ext
      • -filename.ext
      • -.ext
      • .ext
      • -filename.ext
      • -.ext
      • -.ext
      • --filename.ext
      • --.ext

Dispatch - Advanced Form Logic

  • Auto Upload Files?: (checkbox) Upload the files as soon as the user adds them to the form.
    • Default: false
  • Remove entry on upload?: (checkbox) Remove the entry from the queue after its upload is complete.
    • Default: false
  • Limit File Exts: (input) A comma delimited list of allowed file extensions. You can leave this blank to accept all files. Example: gif|jpg|png|pdf|zip
    • Default:
  • Max Size: (number) Maximum File Size in MB. Setting to 0 makes the file size unlimited.
    • Default: 5MB
    • Min Value: 0MB
    • Max Value: 1000MB
  • Num Uploads: (slider) The number of uploads allowed in a single session. For unlimited uploads use 0.
    • Default: 5
    • Min Value: 0
    • Max Value: 30

Dispatch - Custom Errors

  • Upload Complete: (input) The message shown when the upload is complete.
    • Default: Completed
  • File Extension: (input) The error for when the file extension is not allowed.
    • Default: File Type Not Allowed
  • File Size: (input) The error for when the file size is too large.
    • Default: File Too Large
  • Queue Size: (input) The error for when the too many files have been added to the queue.
    • Default: Please select fewer files. The maximum number of queue items has been reached.
  • Unable to Move: (input) The error for when the uplaoded file cannot be moved from the server tmp folder.
    • Default: Unable to move uploaded file. Please contact administrator.
  • Passphrase: (input) The error for when the too many files have been added to the queue.
    • Enable: When Show Human Test? is set to true
    • Default: Incorrect Passphrase. Please try again.
  • SFTP Login: (input) The error for when the login to the SFTP server fails
    • Enable: When Server is set to sftp
    • Default: Unable to login to server.