Basic settings for the Backload component library. TIP: You do not need to include any of these setting in your web.config or external config file, if these default settings suit your needs. Sets the attributes for filesystem storage Root upload folder. If the value starts with '~/' (e.g. ~/files) the path is relative to the web application root, otherwise set an absolute local path (e.g. d:\files) and also set a the virtual path name in the "virtualDirectory" attribute [Default: "~/Files"] Name of virtual directory in your IIS application to an external storage location (unc or full file system path). If filesRoot is relative to the web application root (starts with '~/', see filesRoot), you do not need to set this value. If filesRoot is an absolute path, you usually set a virtual path in IIS to this external location. In this case, the virtualDirectory attribute must be set to the name of the virtual path and filesRoot to the external path. Example: If the virtual path is z:\files and the name is "files", set filesRoot="z:\files" and virtualDirectory="/files" [Default: "/"] Subfolder within the filesRoot. Set it to objectsRoot="" if you do not need a subfolder [Default: ""] Root of a folder where Backload stores a copy of an uploaded file, if set to a none empty string. If the value is empty ("") not copies are stored. If the value starts with '~/' (e.g. ~/copies) the path is relative to the web root. if the value not starts with '~/' and it isn't an absolute local path, the value will be treated as a subfolder to filesRoot ('copies' -> ~/files/copies). Otherwise set an absolute local path (e.g. d:/backup) [Default: ""] Temporäry folder prefix if file chunks are uploaded into the upload folder before they are merged [Default: "$$"]. Subfolder for supporting files (previews, mappings, etc). If "auxFilesFolder" is not empty (e.g. auxFilesFolder="_aux") supporting files will be stored in an external path ([filesRoot]\[auxFilesFolder]\). In this case the main upload directories only contain the uploaded files. [Default: ""]. Provides setting for database configuration. Supports codeless storage (no application code needed), Entity Framework, Sql FileStreams, Sql FileTables and external file storage (filesystem). Name of the database connection (see Web.config). Can also be a connection string. [Default: "FilesContext"] Name of the underlying database table [Default: "Files"] Name of the SqlFileTable if a SqlFileTable is running on Sql Server. In a SqlFileTable, files will be stored outside of the database file in a filesystem directory, but managed by the database engine. This allows to store very large files. In contrast to SqlFileStreams, SqlFileTable files can be accessed, created and deleted directly within the file system as normal files. This allows us for example to copy a file with the explorer to the FileTable's directory in the file system where Sql Server catches the file and manages it. When you create a virtual path in IIS to the FileTable directory in the filesystem, A client can download the files in the SqlFileTable directly from the browser. FileTables (SQL Server). [Default: "FileTable"]. Defines if files are stored within the database file or as SqlFiieStream. SqlFIleStreams are stored outside of the database file as blob within the file system, but they are managed by the database engine. When using SqlFileStreams, SQL Server and the database must enable the SqlFileStream feature. More info: FILESTREAM (SQL Server). [Default: "Internal"] Files will be stored within the database (default). Files will be stored as SqlFileStream outside of the database file in a filesystem directory, but managed by the database engine. This allows us to store very large files. More info: FILESTREAM (SQL Server). Unlike SqlFileTable, files (blobs) cannot be accessed directly on the file system. Like SqlFileStreams, files will be stored in a SqlFileTable outside of the database file in a filesystem directory, but managed by the database engine. This allows us to store very large files. More info: FileTables (SQL Server). Unlike SqlFileStreams FileTable files can be accessed, created and deleted within the file system as normal file. This allows us for example to copy a file with the explorer to the FileTable's directory in the file system where Sql Server catches the file and manages it. You can also enable a client to directory download the file if you create a virtual path from IIS to the FileTable directory. Files will be stored on the filesystem. A virtual path in the database points to the file. Storage mode "SqlFileTable" or "FileSystem" only. This setting is only needed if direct download of files is enabled in the configuration with the setting filesUrlPattern="{url}" (default: {backload}). Note: Direct download of files is only available in the storage modes "SqlFileTable" and "FileSystem", because in these modes files are stored as regular files on the file system. As in standard filesystem storage, VirtualDirectory needs to be set as the name of a virtual directory in IIS or an absolute url //if the file system to download files is outside the web application (e.g. UNC shares). VirtualDirectory represents the name of virtual path in your IIS application to an external storage location. If filesRoot is relative to the web application root (starts with '~/', see filesRoot), you do not need to set this value. If filesRoot is an absolute path, you usually set a virtual path in IIS to this external location. In this case, the virtualDirectory attribute must be set to the name of the virtual path and filesRoot to the absolute path. Example: If the virtual path is z:\files and the name is "files", set filesRoot="z:\files" and virtualDirectory="/files" [Default: "/"] Root path of the file directory when using external file storage (storageMode: SqlFileTable or FileSystem) (SqlFileTable example: "\\Server\SQLEXPRESS\FILES\Uploads\" where "FILES" is the database and "Uploads" is the name of the SqlFileTable.) (FilePath example: z:\Uploads). NOTE: If rootPath is not configured in storageMode "SqlFileTable", rootPath will be automatically retrieved from Sql Server. [Default: "~/Files"] If set to a none empty string, this setting is used to store file chunks, before the full uploaded file will be stored into the database. If you use chunked file uploads, it is recommend to store the chunks in a temporary directory to get best performance. (Examples: "~/Files/Temp/" (app relative), "z:\dbstorage\temp\" (absolute), "\\server\dbstorage\temp\" (unc)) [Default: ""] If the data model has different column names than the defaults (e.g. FileId instead of the default Id), a column mapping for column names can be set. Example: columnMapping="{Id=FileId,Name=FileName,Original=OriginalName}". See also the database demo package. [Default: ""] Name of the plugin file, e.g. extension="Backload.Plugin.Database.dll". If this is an empty string the extension name will be automatically set to: "Backload.Plugin.Database.dll [Default: "Backload.Plugin.Database.dll"] Sets the attributes for cloud storage Microsoft Azure File storage settings Root upload folder. If the value starts with '~/' (e.g. ~/files) the path is relative to the web application root, otherwise set an absolute local path (e.g. d:\files) and also set a the virtual path name in the "virtualDirectory" attribute [Default: "~/Files"] Name of virtual path in your IIS application to an external storage location (unc or full file system path). If filesRoot is relative to the web application root (starts with '~/', see filesRoot), you do not need to set this value. If filesRoot is an absolute path, you usually set a virtual path in IIS to this external location. In this case, the virtualDirectory attribute must be set to the name of the virtual path and filesRoot to the external path. Example: If the virtual path is z:\files and the name is "files", set filesRoot="z:\files" and virtualDirectory="/files" [Default: "/"] Special subfolder within the filesRoot to store user related files like photos etc. Set it to usersRoot="" if you do not need this subfolder [Default: ""] Subfolder within the filesRoot. Set it to objectsRoot="" if you do not need a subfolder [Default: ""] Root of a folder where Backload stores a copy of an uploaded file, if set to a none empty string. If the value is empty ("") not copies are stored. If the value starts with '~/' (e.g. ~/copies) the path is relative to the web root. If the value not starts with '~/' and it isn't an absolute local path, the value will be treated as a subfolder to filesRoot ('copies' -> ~/files/copies). Otherwise set an absolute local path (e.g. d:/backup) [Default: ""] Temporary folder prefix if file chunks are uploaded into the upload folder before they are merged [Default: "$$"]. Subfolder for supporting files (previews, mappings, etc). If "auxFilesFolder" is not empty (e.g. auxFilesFolder="_aux") supporing files will be stored in an external path ([filesRoot]\[auxFilesFolder]\). In this case the main upload directories only contain the uploaded files. [Default: ""]. Name of the plugin file, e.g. extension="Backload.Plugin.AzureFileStorage.dll". If this is an empty string the extension name will be automatically set to: "Backload.Plugin.AzureFileStorage.dll [Default: "Backload.Plugin.AzureFileStorage.dll"] Microsoft Azure Blob storage settings Azure Storage Service connection string name, usually located in the .cscfg file or Web.config. If this is an empty string, the local storage emulator will be used [Default: "StorageConnectionString"] Name of the files upload container. Example: uploadContainer="files". Must start with a lowercase letter. Automatically created if it doesn't exist [Default: "files"] Virtual subfolder within the uploadContainer. Set it to objectsRoot="" if you do not need a subfolder [Default: ""] Virtual subfolder within the uploadContainer. Set it to objectsRoot="" if you do not need a subfolder [Default: ""] Sas access type only. Time period (in minutes) before the shared access token expires. [Default: "60"] Public access type to the uploaded files [Default: "token"] No public access. Anyone with the url can get or list, but not store or delete files. Ad-hoc shared access signature (SAS). Storage access requires a valid access token [Default]. A shared (stored) access policy will be used. Define a name of the stored policy within the storedPolicyName attribute. Note: Note: Your code is responsable to renew the policy before it expires! Sets the container existence checking and auto creation behavior [Default: "auto"] Container existence is verified on first access, created it if neccessary, after that assumed that the container exists (Default). Verify container exsistence on every request and try to create it if it not exists. No checks for container exsistence. The containers (files, previews, [archives]) must be available (pre-created) on a request. If accessType is set to "storedPolicy", this is the name of the shared access policy. Note: Your code is responsable to renew the policy before it expires! [Default: "backload"] Name of the plugin file, e.g. extension="Backload.Plugin.AzureBlobStorage.dll". If this is an empty string the extension name will be automatically set to: "Backload.Plugin.AzureBlobStorage.dll [Default: "Backload.Plugin.AzureBlobStorage.dll"] Google Drive storage settings Azure Storage Service connection string name, usually located in the .cscfg file or Web.config. If this is an empty string, the local storage emulator will be used [Default: "StorageConnectionString"] Name of the files upload container. Example: uploadContainer="files". Must start with a lowercase letter. Automatically created if it doesn't exist [Default: "files"] Azure Storage Service connection string name, usually located in the .cscfg file or Web.config. If this is an empty string, the local storage emulator will be used [Default: "StorageConnectionString"] Virtual subfolder within the uploadContainer. Set it to objectsRoot="" if you do not need a subfolder [Default: ""] Sas access type only. Time period (in minutes) before the shared access token expires. [Default: "60"] Sas access type only. Time period (in minutes) before the shared access token expires. [Default: "60"] Root upload folder. [Default: "Files"] Subfolder within the filesRoot. Set it to objectsRoot="" if you do not need a subfolder [Default: ""] Public access type to the uploaded files [Default: "token"] All files are stored on a central Google Drive accout in the same upload folder. All users have access to all uploaded files. All files are stored on a central Google Drive accout into an user individual folder. User only has access to his uploaded files. Files are stored in the users Google Drive account. The user must have a Google Drive account. Name of the plugin file, e.g. extension="Backload.Plugin.GoogleDrive.dll". If this is an empty string the extension name will be automatically set to: "Backload.Plugin.GoogleDrive.dll [Default: "Backload.Plugin.GoogleDrive.dll"] Storage service provider. [Default: "AzureBlobStorage"] Microsoft Azure Blob storage provider Microsoft Azure File storage provider Google Drive storage provider If the bundeling feature is used (@Render.Scripts(), @Render.Styles()), set the appropriate files folder. TIP: Don't forgat to register the bundeling feature in the global.asax. See example project. Scripts folder [Default: "~/Backload/Client"] Styles folder [Default: "~/Backload/Client"] Setting for the handling of uploaded images. Width or max width (depends on resizeMode) of the resulting image [Range: 1-100000, Default: "1024"] Height or max height (depends on resizeMode) of the resulting image [Range: 1-100000, Default: "768"] Resolution of the resulting image (dots per inch). If set to -1 resolution of the original image is used. [Range: 1-2400, Default: "96"] Background color of the canvas. Only used when resize mode is fit and the image ratio of the source and target image differ. You can also use argb (rgb with alpha channel, e.g. background: #00ffffff (transparent), #80ffffff (white, 50% transparency), #ffffffff (white, opaque)) [Default: #ffffff] Sets the resize mode if the image should be resized into a max width or height canvas [Default: "none"] Keep original image, no resizing or cropping No Canvas, preserves ratio, width and height are max sizes Same as ratio, but smaller images are not upscaled. If the source image is bigger than the canvas same as fit. If it is smaller than the canvas, it will be placed in the center of the canvas without resizing Fit into canvas, preserves ratio, centered on canvas Placed on canvas, cropped if neccessary with center of the original image By default the image type of the original image is used. Set this attribute to always output a different type [Default:none] Use the original image type .png (protable network graphics) Files with .jpeg or .jpg extension Files with .tif or .tiff extension Files with .gif extension Microsoft bitmap format. JPEG extended range (MS Photo) format Optional background image if images are placed or fit onto a canvas. Example: background="~/Backload/Imaging/background.png". [Default: "" (no background image)]. Optional watermark image if images are uploaded. Example: watermark="~/Backload/Imaging/watermark.png". [Default: "" (no watermark)]. Vertical position of a watermark to be placed on an image[Default: "center"] Top position Center position Bottom position Max file size (bytes) of an image to be processed by the image processing sub pipeline. If the file size is bigger, the image is stored directly bypassing image processing [Default: "0" (unlimited)]. Setting for the handling of thumbnails. If set to "true" (default), preview images are stored physically. If this attribute is set to false and you request preview images (e.g. in a plugin ui) thumbnails have to be created on every request. If you usually use preview images it is recommed to set this attribute to "true". [Default: "true"] Location of the thumbnail subfolder within the folder where the main file is stored (thumbnails only). Set to an empty string (path="") to avoid physical storage. [Default: "_thumbs"] Width or max width (depends on resizeMode) of the resulting thumbnail [Range: 16-10000, Default: "80"] Height or max height (depends on resizeMode) of the resulting thumbnail [Range: 16-10000, Default: "60"] Resolution of the resulting thumbnail (dots per inch) If set to -1 resolution of the original image is used. If set to -1 resolution of the original image is used. [Range: 72-2400, Default: "96"] Background color of the canvas. Only used when resize mode is fit and the image ratio of the source and target image differ. You can also use argb (rgb with alpha channel, e.g. background: #00ffffff (transparent), #80ffffff (white, 50% transparency), #ffffffff (white, opaque)) [Default: #ffffff] Sets the resize mode if the thumbnail should be resized into a max width or height of a thumbnail canvas [Default: "place"] Keep original image, no resizing or cropping No Canvas, preserves ratio, width and height are max sizes Same as ratio, but smaller images are not upscaled. If the source image is bigger than the canvas same as fit. If it is smaller than the canvas, it will be placed in the center of the canvas without resizing Fit into canvas, preserves ratio, centered on canvas Placed on canvas, cropped if neccessary with center of the original image Thumnail images must all have the same image type in order the upload handler can find and return the correct thumbnail path [Default: "image/png"] .png (protable network graphics) Files with .jpeg or .jpg extension Files with .gif extension Security related settings. By default there are no restrictions. If you need a deeper control, set up your own controller to receive the request, do the authentication/authorization and then call the handler. Enables/disables and configures CROSS-ORIGIN RESOURCE SHARING (CORS). CORS is used in environments, where file requests (e.g. GET) come from diffenrent domains (e.g. client: http://www.yourwebsite.com, Backload: http://fileservice.com/Backload/Filehandler ). To enable cors requests set enable to true [Default=°false°] Comma-separated list of allowed domains for client side requests or "*" to allow all client side cors requests. Example: allowedOrigin="http://www.myservice.com". [Default="*"] Comma-separated list of allowed http methods. [Default="GET,POST,DELETE"] Comma-separated list of allowed headers. [Default=""] Validity period of cors permission settings (in seconds) before the client makes a new permissions request. Note: Not all clients use this value [Default="36000"] Specifies if a request should send credentials by setting credentials="true" [Default="false"] A request must always include an none empty objectContext parameter (query or form) to be valid. If you use "objectContext" to store/retirieve user related files, a malicious request could reveal some other users files, if forceObjectContext is false [Default:"false"] True: Anyone is allowed, false: The user must be authenticated [Default: "true"] By default there are no restrictions on who can download files by a GET request. You can change this by adding a comma separated list of roles [Default: "*"] By default there are no restrictions on who can upload files whithin a POST/PUT request. You can change this by adding a comma separated list of roles [Default: "*"] By default there are no restrictions on who can delete files by a DELETE request. You can change this by adding a comma separated list of roles [Default: "*"] Defines which cache headers are added to the response, and returns a http status 304 (Not Modified), if no files have been uploaded or deleted since the last request. Note: If you manually or by a different application change files, don't use "LastModified=true", because only requests handled by the Backload component will be recognized and a new LastModified date is set. If true, a "Last-Modified" header is added to the response. In a subsequent request Backload returns a 304 (Not Modified) if no files have been uploaded or deleted since the last request [Default="false"]. If true, a ETag is returned in the response on a single file request. In the next request for this file a 304 is returned, if the file has not been modified [Default="false"]. Adds an Expires header to the response, if the value is not 0 (seconds). Example: useExpires="3600" (adds 1 hour to the Expires header) [Default="0"] Sets "must-revalidate" within the Cache-Control header. Caches (e.g. Browser, Proxy) are forced to validate if the request has changed [Default="false"]. Adds a Cache-Control header to the response (Please refer to the System.Web.HttpCacheability enumeration for more info) [Default="ServerAndPrivate"] Doesn't add a "Cache-Control" header to the response. Adds a "Cache-Control: no-cache" header to the response Adds a "Cache-Control: private" header to the response (Response can only be stored in the browser) Adds a "Cache-Control: public" header to the response (Response can be stored everywhere: server, proxies, browser) Adds a "Cache-Control: no-cache" header to the response (Response may be stored on the server, but not on proxies or the browser) Same as "Server" Adds a "Cache-Control: private" header to the response (Response can stored in the browser and on the server) ContentTypes has two purposes: First, it is used to send an appropriate thumbnail of the file type back to the browser if it is not an image. Second: on uploads you can define a subfolder for a content-type that matches a regular expression, in order to store any content of this type in this folder (e.g. pdf files in a pdf folder) Clears the entire contentType list Removes a contentType entry by name The name of the entry [required] New contentType entry (MS Office, OpenOffice, PDF and text file are included by default. No need to inlude these anymore): An unique name of the entry Complete or fragment (.net RegEx string) of the file extension (e.g. .mp finds .mp3, .mp4, etc). Leave it blank, to skip this test. Complete or fragment (.net RegEx string) of the content-type (e.g. mpeg or application/pdf). Leave it blank, to skip this test. Content-types matches are preferred over extension matches. File name of the thumbnail image within the content-types thumbnail folder. Special handling of Images: Leave it blank, to send a preview of the uploaded image back, or set a thumbnail if you do not want to return a preview. Subfolder of the object context folder. Has to be set only if files of this content-type should be stored seperatly from other types (e.g. "movies") [Default: ""] Path to the content-types thumbnail folder (contains different resolutions) [Default: "~/Backload/ContentTypes"] Size of the thumbnail [Range: 16-500, Default: "64"] (Tip: Use the following sizes to avoid resizing: 16,24,32,48,64,72,96,128) Uses the thumbnail canvas (width, height, canvasColor) and places the content type specific thumbnail in the center of it [Default: "true"] Provided license data for Pro/Enterprise editions only Provided licensee value (usually email adress). Obligatory field in the paid editions. Provided license key. Obligatory field in the paid editions. Name of an external config file [Default: "Web.Backload.config"] In your custom code you can bind a handler to events. If set to true (default), events will be fired [Default: false]. Enables tracing support. Note that tracing consumes some system resources and should only be enabled during development or to find errors in production. [Default: false]. Max length of a base64 encoded embedded data url. Only required if a url pattern is set to return a base64 string (e.g. thumbsUrlPattern="{base64}") [Default="1000"]. This attribute sets the pattern of the url for the DELETE request returned back to the client in order to delete the file. You can use the shortcuts described in the config file. If you do not set this attribute, a link to the Backload component is returned by default. If you do not want to return a url, set this to an empty string or use the shortcut {none} (e.g. deleteUrlPattern="{none}" [Default="{backload}"]. By default the internal file upload handler is running and ready to receive incoming files or requests. This enables us zero configuration. If you want to set up your own controller in order to do some business logic, set this to "false". [Default: "true"] This setting determines the behaviour, if a file in a GET or DELETE request is not found [Default: "auto"] Returns nothing with an http status 200 (ok). Use this setting, if you do not want to expose internal data. If the output is not file data (e.g. DELETE request), this setting returns an error message. If the output is file data (bytes) it returns a 404 status code [Default]. Returns a 404 http status code (Not Found). This attribute sets the pattern of the url (File) returned back to the client in order to download the file. You can use the shortcuts described in the config file. If you do not set this attribute, a direct link is returned by default. If you do not want to return a url, set this to an empty string or use the shortcut {none} (e.g. thumbsUrlPattern="{none}" [Default="{url}"]. On a GET request (return links to uploaded files) only the upload root folder (default filesRoot) is searched for uploaded files. Set to true in order to include subfolders. (Example: A content-type specific subfolder is set to "pdffiles" the search will find files within this subfolder. There are several ways set up subfolders, e.g. uploadContext and objectContext) [Default: "false"] Only applies if you use the uniqueFileNames option. If set to true, the original file name will be stored (subfolder: _mappings) [Default: "false"] Defines the default Json output format. You can overwrite the Json output in your code or within the OutgoingResponseCreated event. See examples [Default: "JQueryFileUpload"] Generates Json for the jQuery FileUpload plugin from blueimp [Default] Generates Json for the PlUpload plugin from Moxiecode Generates Json for the Fine Uploader from Widen Enterprises Send a (not case sensitive) plugin=[JQueryFileUpload|PlUpload|Custom] querystring with your request (Example: plugin=plupload). Because this is request based you can change the JSON output with every ajax request. Does not generate an output before calling the OutgoingResponseCreated event and you have to generate your own output in this event. We use this setting, to return internal information for the jQuery File Upload Plugin. If you do not want this, set it to "none" [Default: "basic"] No extra infos where send back to the client Returns the original file name as it is send by the upload, upload path and messages from the handler (e.g. file already exists [Default] Returns basic information plus a detailed folder structure. Files may be stored in the file system or in a cloud storage [Default: "Filesystem"] Saves uploaded files in the file system (or SMB/unc shared folder) [Default] Saves uploaded files to a database and enables the database configuration element. Supports codeless storage (no application code needed), Entity Framework, Sql FileStreams, Sql FileTables and external file storage (filesystem). Saves uploaded files to a cloud storage. This attribute sets the pattern of the url (Thumbnail) returned back to the client in order to download the thumbnail. You can use the shortcuts described in the config file. If you do not set this attribute, a direct link is returned by default. If you do not want to return a url, set this to an empty string or use the shortcut {none} (e.g. thumbsUrlPattern="{none}" [Default="{url}"]. Generates unique file names based on guids [Default: "false"] Obsolete. Use "virtualDirectory" in the FileSystem element instead. This attribute will be removed in a future release. If set to "global" (default) the IWebConfig configuration instance in IFile_config is static, so if a property is changed in code (e.g. event handler), all subsequent requests use the new setting. If set to "request" a property change in code is only available in this single request. Other concurrent or subsequest requests use the original (global) setting. IFile_config returns the global settings used in all reuqests IFile_config returns a request based configuration instance. Note: The GlobalConfig property in IFile_config has a reference to the global configuration.