MultiPowUpload 3.4
Functionality Parameters
  Home page
Contact support

MultiPowUpload functionality parameters 

For more information about how to setup MultiPowUpload parameters see tutorial section.


Parameter name Type Desciption Default value
serialNumber String Setting the value to the valid serial number makes trial version work as full.
uploadUrl URL The URL of the server script configured to handle an upload through HTTP POST calls. The URL can be HTTP only.
If you are using symbols "&" in uploadUrl value, replace them with the "%26" string!
Special characters in URL must be encoded (like "~" should be "%7E")!!! Otherwise, it won't work at Mac OS
redirectUploadUrl URL URL of the page that will be loaded automatically after upload is finished.
MultiPowUpload sends the following information about each file (#INDEX# is an index of a file from 0 to count of files-1) :
MultiPowUploadId - unique identificator of MultiPowUpload instance.
MultiPowUploadFileId_#INDEX# - file id.
MultiPowUploadFileName_#INDEX# - file name.
MultiPowUploadFileSize_#INDEX#  - file size.
MultiPowUploadFileDate_#INDEX# - file modification date.
MultiPowUploadFileStatus_#INDEX# - file status. Check possible values here.

If you use symbols "&" in uploadUrl value, replace them with the "%26" string!
redirectTarget String Target to the redirect redirectUploadUrl. It is similar to the "target" parameter in <a> html tag. Default value is _self . _self
externalVariablesUrl URL Url to the xml file that contains MultiPowUpload parameters.
removeUploadedFilesFromList Boolean It determines whether to remove the uploaded files from list when the upload is complete. false
autoStart Boolean It determines whether MultiPowUpload should automatically start upload process when user add files. false
allowAddFilesDuringUpload Boolean It determines whether MultiPowUpload should allow (enabled browse button) to add files while upload process already active. false
readImageMetadata Boolean It determines whether MultiPowUpload should read metadata (EXIF) from the image files or not. If the parameter is enabled, the exif collection in ListItem will be available when the image file is read and a user will be able see image metadata in the FileInfo window. true
chunkedUpload.enabled Boolean

It determines whether MultiPowUpload should use chuncked mode for file uploads. If the parameter is enabled MultiPowUpload loads a file into memory and sends it to the server by chuncks.

Please note: Adobe Flash guarantees 100 MB files uploading by this method but even 500 MB files works correctly on most PCs. A specific handler should be used on server side to save the file. Read more about chuncked upload on the tutorials page.

 

false
chunkedUpload.rawMethod Boolean It determines whether MultiPowUpload should send file data in raw format or use MultiPart encoding when chuncked upload is enabled. If the parameter is set to true, MultiPowUpload will write the file body by chuncks directly to the request, otherwise MultiPowUPload will encode each chunck using MultiPart encoding. If the parameter is set to false, each chunk will be present as a file on server side. It allows to stick together file parts easily. false
chunkedUpload.chunkSize Number Size of a chunk in bytes. If the parameter is set to -1 , MultiPowUPload will automatically increase chunk size to an optimal value. -1
chunkedUpload.maxChunkSize Number Maximum chunk size. If chunkedUpload.chunkSize parameter is set to -1, the value of this parameter is used to limit the maximum size of a chunk. It should be less than a request or a file size limitation on the server side . 2097152
clearListOnAddNewFiles Boolean Determines whether MultiPowUpload should remove all files from list when new set of files selected in browse dialog.
Usefull when the value of the fileFilter.maxCount parameter is set to 1, instead of display error message about maximum allowed files count , existing file will be replaced by selected one.
false
cancelImmediately Boolean It determines whether MultiPowUpload should cancel upload process immidiately after the cancel button is press. If the parameter is set to false, MultiPowUpload will be waiting for the current file upload completion and then will stop the upload process. true
checkConnectionOnIOError Boolean It determines whether MultiPowUpload should check for connection restore when IOError occurs during an upload. IOError usually occurs when the connection to a server is lost for some reason. If the parameter is set to true MultiPowUpload will check the connection to a server every checkConnectionInterval seconds within checkConnectionUntil minutes. true
checkConnectionInterval Number Interval (in seconds) for test requests. 5
checkConnectionUntil Number Timeout for connection checking in minutes. 10
showIOError Boolean It determines whether MultiPowUpload should display error messages or retry an upload on IOError. If the parameter is set to true, MultiPowUpload will display an error message and stop the upload process, otherwise MultiPowUpload will retry the upload of the current file numberRetry times and skip it if it is not successful. false
numberRetry Number It determines the number of attemts to upload a file when IOError is occured. 3
backgroundColor Color MultiPowUpload background color. #FFFFFF
fileInfoWindow.enabled Boolean If the parameter is set to true, FileInfo window will be displayed by a mouse click on the file label or the status icon in the list or the thumbnails view. true
debug.enabled Boolean It determines whether MultiPowUpload should start debug events and write the debug messages to Flash console. If the parameter us set to true, MultiPowUpload will start the onDebug event handler. false
debug.level Number Debug level.
0 - basic information.
1 - debug information.
2 - developer level.
0

Upload form fields 

Parameter name Type Desciption Default value
formName String Id of a form on the html page whose values should be posted to server.  
customPostFields String

List of the parameters which should be added to the post request.
| - splitter for pairs
; - splitter for name and value
Please note: Characters | and ; inside a parameter name or a value should be encoded with corresponding %7C and %3B. You should also encode & character with %26 code.
Example:

paramname1;paramvalue1|paramname2;paramvalue2 
postFields.useGetMethod Boolean It determines whether MultiPowUpload should send form fields with GET method. If the parameter is set to false, MultiPowUpload sends form fields with POST method, otherwise using GET method. false
postFields.browserCookie String Name of the browser cookie form field in a request. MultiPowUpload_browserCookie
postFields.browserCookie.send Boolean It determines whether MultiPowUpload should send browser cookies.
Flash Player in non-IE browsers does not pass cookies during an upload. Therefore session, authentication information are lost in the upload script. To avoid this issue MultiPowUpload grabs browser cookies and includes them into the request.
true
postFields.file String Name of the file form field in a request. Filedata
postFields.fileCreationDate String Name of the file creation date form field in a request. fileCreationdate
postFields.fileCreationDate.send Boolean   true
postFields.fileId String Name of the file id form field in a request. fileId
postFields.fileId.send Boolean It determines whether MultiPowUpload should send file id to server. true
postFields.fileIndex String Name of the file index form field in a request. currentFileIndex
postFields.fileIndex.send Boolean It determines whether MultiPowUpload should send index of the current file to a server. true
postFields.fileModificationDate String Name of the file modification date form field in a request. fileModificationDate
postFields.fileModificationDate.send Boolean It determines whether MultiPowUpload should send the file modification date to a server. true
postFields.fileSize String Name of the file size form field in a request. fileSize
postFields.fileSize.send Boolean It determines whether MultiPowUpload should send the file size to a server. true
postFields.filesCount String Name of the files count form field in a request. filesCount
postFields.filesCount.send Boolean It determines whether MultiPowUpload should send the count of the files selected for an upload to a server. true
postFields.imageHeight String Name of the image height form field in a request. imageHeight
postFields.imageWidth String Name of the image width form field in a request. imageWidth
postFields.rotateAngle String Name of the roate angle form field in a request. rotateAngle
postFields.rotateAngleBeforeCrop String Name of the "roate angle before crop" form field in a request. rotateAngleBeforeCrop
postFields.thumbnail String Name of the thumbnail (file) form field in a request. thumbnail_
postFields.thumbnailHeight String Name of the thumbnail height form field in a request. thumbnailHeight
postFields.thumbnailWidth String Name of the thumbnail width form field in a request. thumbnailWidth
postFields.cropRect.height String Name of the crop rect width form field in a request. cropRectHeight
postFields.cropRect.width String Name of the crop rect height form field in a request. cropRectWidth
postFields.cropRect.x String Name of the crop rect x coordinate form field in a request. cropRectX
postFields.cropRect.y String Name of the crop rect y coordinate form field in a request. cropRectY
postFields.listView.textInput String Form field name for inline text input in the list view and the thumbnail view. userText

Thumbnails upload 

Parameter name Type Desciption Default value
sendOriginalImages Boolean It determines whether MultiPowUPLoad should send original images to a server when sendThumbnails parameter is set to true. true
sendThumbnails Boolean It determines whether MultiPowUpload should send the image thumbnails.
Note: due to Adobe API limitations, MultiPowUpload can't provide progress information for thumbnails upload process. Starting from version 3.0, thumbnails are uploaded one by one.
false
thumbnail.generateOnlyForModifiedImages Boolean If MultiPowUPload configured to send only thumbnails (sendOriginalIMages is set to false and sendThumbnails is set to true), this parameter can be used to generate thumbnails only for images to which user apply modification : crop or rotation . When set to true, MultiPowUpload will generate thumbnails only for those images which were cropped or rotated, other images will be uploaded without thumbnails generation. false
thumbnail.uploadUrl URL

Url to the server script which handles thumbnail uploads. If the thumbnailUploadUrl parameter is empty, MultiPowUpload uses uploadUrl value to post thumbnails. You should use it only if you need to post thumbnails and original images to other scripts.

thumbnail.width Number Width of a thumbnail in pixels. To set a thumbnail width as percentage from orginal image width, set the value as a number from 0.0 to 1.0. For example, to generate a thumbnail with half-size width, set the value to 0.5. 160
thumbnail.height Number Height of a thumbnail in pixels. To set a thumbnail height as percentage from orginal image height, set the value as a number from 0.0 to 1.0. For example, to generate a thumbnail with half-size width, set the value to 0.5. 120
thumbnail.resizeMode String

Resize mode for thumbnails generation. Available values:

fit - MultiPowUpload will generate thumbnails with a size based on the aspect ratio of an original image. The result thumbnail dimensions may differ from thumbnail.width and thumbnail.height if the aspect ration of an original image and destination thumbnail are different.

fitByWidth - the result thumbnail will always have specified width. The result thumbnails height calculated with respect of the the aspect ratio of the original image.

fitByHeight - the result thumbnail will always have specified height. The result thumbnails width calculated with respect of the the aspect ratio of the original image.

exactFit - Result thumbnail will always have specified dimensions. If the aspect rato of the original image and the destination thumbnail are different, "unused" space of thumbnail is filled with thumbnail.backgroundColor color. If the value of the thumbnail.format parameter set to "PNG" and the value of the thumbnail.transparentBackground parameter set to true, result thumbnail will have transparent background.

stretch - Result thumbnail will always have specified dimensions. If it is necessary, a necessary image will be stretched by width or height.

crop - Result thumbnail will always have specified dimensions. If it is necessary, the image will be cropped by width or height.

fit
thumbnail.resizeSmallImages Boolean Determines whether MultiPowUpload should apply resize rules to images which dimensions are less then values of thumbnail.height and thumbnail.width parameters. If set to false, small images will not be resized. true
thumbnail.format String Thumbnail image format. Possible values: "JPG", "PNG", "BMP",
"AUTO" - output format will be the same as original image format.
If output format is not supported by MultiPowUpload, then rules based on the value of the thumbnail.handleUnsupportedFormats will be applied.
JPG
thumbnail.handleUnsupportedFormats String

Determines what to do with unsupported images when thumbnails upload enabled and the value of the thumbnail.format is set to "AUTO" . For example when user select GIF file, MultiPowUpload will not able to generate output thumbnails in GIF format (it is not supported).
Available values:
JPEG: Convert unsupported file extensions like GIF into JPEG format.
BMP: Convert unsupported file extensions like GIF into BMP format.
PNG: Convert unsupported file extensions like GIF into PNG format and change alpha transparency to thumbnail.backgroundColor.
SOURCE: Just upload unsupported file extensions as they are without any image processing (attention: files are uploaded without resizing to thumbnail.width/thumbnail.height).

SOURCE
thumbnail.jpgQuality Number JPEG quality of thumbnail. Possible range: 0-100. The parameter is used if the thumbnail.format parameter is set to "JPG". 85
thumbnail.sharpness Number Sharpness of generated image thumbnails. Value from 0 to 100. 50
thumbnail.autoRotate Boolean It determines whether MultiPowUPLoad should automatically rotate thumbnails using information from EXIF (if it is available). false
thumbnail.backgroundColor Color Background color of thumbnail. #000000
thumbnail.transparentBackground Boolean It determines whether MultiPowUpload should generate a thumnail with transparent background. Transparency is not supported by JPEG format. To generate thumbnails with transparent background you should set the value of the thumbnail.format parameter to "PNG" and set the value of the thumbnail.resizeMode parameter to "exactFit". Value of the thumbnail.backgroundColor color will be ignored. true
thumbnail.fileName String Name of a thumbnail file in a request. Default value is thumbnail_<FILENAME> where <FILENAME> is the name of the original image file. The file extension is replaced by "jpg" or "png" (depending on the thumbnail.format parameter). thumbnail_<FILENAME>
thumbnail.loadFromExif Boolean It determines whether MultiPowUpload should load the thumbnails stored in the EXIF metadata.
Note: this value affects only images preview in the thumbnail view to increase performance. The thumbnails for upload are generated from original images!
true
thumbnail.watermark.enabled Boolean It determines wheter MultiPowUPLoad should add a watermark to the image thumbnails. false
thumbnail.watermark.alpha Number Watermark alpha. Range from 0.0. to 1.0. 0.6
thumbnail.watermark.imageUrl URL Url to an image file which should be used as a watermark .
thumbnail.watermark.position String Watermark position. Format : <vertical>.<horizontal>
Valid values for <vertical> part : top, center, bottom.
Valid values for <horizontal> part: left, center, right>

Example: top.left

It is possible to set margin for each direction. <br>
Format is: verticalPosition[:verticalMargin].horizontalPosition[:horizontalMargin]<br>
Margins can be omited. <br>
Here are examples: <br>
"thumbnail.watermark.position":"bottom:-10.right:-20",<br>
"thumbnail.watermark.position":"top:15.left:10",<br>
"thumbnail.watermark.position":"top.left", <br>

All of them are valid values for thumbnail.watermark.position parameter.
center.center
thumbnail.watermark.text String Text for a watermark. It is used only if the value of the thumbnail.watermark.imageUrl parameter is empty. Element-IT
thumbnail.watermark.textStyle TextStyle Watermark text style. color: #FF0000
font: _sans
size: 22
style: bold
thumbnail.watermark.textStyle.backgroundColor Color Background color for text watermark.

File filter 

Parameter name Type Desciption Default value
fileFilter.maxCount Number Maximum count of files allowed for upload. The count is unlimited if the parameter is set to -1. -1
fileFilter.maxSize Number Maximum file size in bytes. The size is unlimited if the parameter is set to -1. -1
fileFilter.maxTotalSize Number Maximun size of all files in bytes. The size is unlimited if the parameter is set to -1. -1
fileFilter.minCount Number Minimum files count for upload. The count is unlimited if the parameter is set to -1. -1
fileFilter.minSize Number Minmum size of file. The size is unlimited if the parameter is set to -1. -1
fileFilter.types String

An array of file types used to filter the files displayed in the dialog box.
; - splitter for type groups
| - splitter for group description and set of types
: - splitter for file types inside a group

Example:
All files|*.*;Images|*.jpg:*.jpeg:*.gif:*.png:*.bmp
All files|*.*
fileFilter.disabledTypes String

An array of file types (extensions) which are not allowed for an upload. You should set only file extensions here without dot or asterix.
; - splitter for type types

Example:
exe;php;aspx
All files|*.*
fileFilter.allowDuplicates Boolean Determines whether duplicate files allowed to be added to the files list. false
fileFilter.image.minWidth Number Minimum width (in pixels) of image files which is allowed for upload. -1
fileFilter.image.maxWidth Number Maximum width (in pixels) of image files which is allowed for upload. -1
fileFilter.image.minHeight Number Minimum height (in pixels) of image files which is allowed for upload. -1
fileFilter.image.maxHeight Number Maximum height (in pixels) of image files which is allowed for upload. -1
fileFilter.unsupportedImages.maxSize Number Allow to filter unsupported images by size. Work ONLY when the value of the thumbnail.format parenmetr is set to "AUTO" and the value if the "thumbnail.handleUnsupportedFormats parameter is set to "SOURCE". It allow to filter by size images which will be uploaded without thumbnails generation. -1

JavaScript communication 

Parameter name Type Desciption Default value
useExternalInterface Boolean It determines whether MultiPowUpload will use External Interface i.e communication between Flash and the Java Script. If the parameter is set to true, MultiPowUpload will start java script event handler and will allow to use java script methods. false
javaScriptEventsPrefix String Prefix for the Java Script event handlers. MultiPowUpload
eventHandler.onButtonClick String Name of the java script event handler. _onButtonClick
eventHandler.onAddFiles String Name of the java script event handler. _onAddFiles
eventHandler.onCancel String Name of the java script event handler. _onCancel
eventHandler.onClearList String NName of the java script event handler. _onClearList
eventHandler.onComplete String Name of the java script event handler. _onComplete
eventHandler.onDebug String Name of the java script event handler. _onDebug
eventHandler.onError String Name of the java script event handler. _onError
eventHandler.onErrorMessage String Name of the java script event handler. _onErrorMessage
eventHandler.onFileComplete String Name of the java script event handler. _onFileComplete
eventHandler.onFileStart String Name of the java script event handler. _onFileStart
eventHandler.onImageLoaded String Name of the java script event handler. _onImageLoaded
eventHandler.onListChange String Name of the java script event handler. _onListChange
eventHandler.onLoadVars String Name of the java script event handler. _onLoadVars
eventHandler.onLoadVarsError String Name of the java script event handler. _onLoadVarsError
eventHandler.onLoadVarsProgress String Name of the java script event handler. _onLoadVarsProgress
eventHandler.onMovieLoad String Name of the java script event handler. _onMovieLoad
eventHandler.onProgress String Name of the java script event handler. _onProgress
eventHandler.onRemoveFiles String Name of the java script event handler. _onRemoveFiles
eventHandler.onResponse String Name of the java script event handler. _onServerResponse
eventHandler.onSelectItems String Name of the java script event handler. _onSelectItems
eventHandler.onStart String Name of the java script event handler. _onStart
eventHandler.onThumbnailGenerateComplete String Name of the java script event handler. _onThumbnailGenerateComplete
eventHandler.onThumbnailGenerateProgress String Name of the java script event handler. _onThumbnailGenerateProgress
eventHandler.onThumbnailGenerateStart String Name of the java script event handler. _onThumbnailGenerateStart
eventHandler.onThumbnailUploadComplete String Name of the java script event handler. _onThumbnailUploadComplete
eventHandler.onThumbnailUploadStart String Name of the java script event handler. _onThumbnailUploadStart
browseButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0
uploadButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0
thumbViewButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0
listViewButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0
sortButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0
remoteFilesShowHideButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0
removeButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0
clearButton.action Number

What to do on button click?
Available values:
0 - default action.
1 - default action and then call java script onButtonClick event handler
2 - only call java script onButtonClick event handler

0

Upload to Amazon S3 

Please read tutorials section of documentation to learn how to generate parameters for Amazon S3 upload feature. Do not fill them by self.

Parameter name Type Desciption Default value
amazonS3.accessKeyId String Access Key ID to perform requests to Amazon.
amazonS3.policy String Encoded policy.
amazonS3.signature String Signature of request.
amazonS3.acl String Permissions to be set for uploaded file. Valid values are:
private
public-read
public-read-write
authenticated-read
"public-read"
amazonS3.key String Name of uploaded file. Use <FILENAME> placeholder for original file name.
This parameter helpfull if you need to upload files into some subfolder of your bucket.
Example: 'uploads/<FILENAME>'
<FILENAME>
amazonS3.contentType String Content type of uploaded files. Use <AUTODETECT> placeholder to allow MultiPowUpload automatically detect content type. <AUTODETECT>

Preview and download remote files 

Please read tutorials section of documentation to learn how to configure MultiPowUPload to work with remote files.

Parameter name Type Desciption Default value
remoteFiles String

List of files for download. Format:
URL1|FileName1|Size1|ID1|ThumbnailUrl1|Date1;URL2|FileName2|Size2|ID2|ThumbnailUrl2|Date2
You can omit id, thumbnailurl and date attributes .

Example:

landscape.jpg|landscape.jpg|48546||t_landscape.jpg|Wed, 19 Nov 2008 16:19:55 +0400;frog.jpg|frog.jpg|45119||t_frog.jpg|
remoteFiles.uploadOnlyModified Bool Determine whether remote files should be uploaded to server only if they were modified (rotated, cropped) or not. If set to false, then uploader will generate thumbnails for all of remote image files. true
remoteFiles.source URL Url to file (script) with list of files for download.
remoteFiles.source.type String

Type of data in source file.
Vaid values are: json, xml .

json
remoteFiles.allowDownload Bool Determines whether user will be able to download remote files from server to local computer. If download allowed, appropriate icon will be displayed for each file item in list .
Icon configured with fileView.fileDownload parameter.
true