|Summary||This article describes how to set up the File Uploader Service to be used for the file upload/media capture adc.|
|Applies to||Design, IIS|
|Written for||Support, Operations, Datacenter|
|Keywords||FTP; File Uploader ADC; Service;|
|Prerequisites||Access to a public FTP where the files will be transferred to.|
This web service is used with the ADC upload, camea and microphone which allows you to upload files during a web survey.
This ADC requires custom installation and testing/troubleshooting - should you require assistance from Askia for this, it is classified as non-standard support and is likely to incur consulting fees.
Please contact your key account manager for further clarification.
Windows features (Control Panel -> Turn windows features on or off)
- Windows Communication Foundation
- WCF Service
- Internet Information Service
1. Create an IIS Application pool called FileUploader on the server as below:
2. Run the Setup.exe file as administrator.
3. When asked, enter the directory where you would like to install the service, as well as the App Pool that will be used.
On navigation to the specified "Virtual Directory" you'll see a file called config_staging.json. This json file has 4 variables:
|Authentication||Array||Array storing the various Authentications|
|Credential||Array||Array storing the various Credentials|
|TemporarySaveLocation||String||Path to a temp directory on the server where files are stored before FTP|
Authentication and Credentials
The difference between the Credentials and the Authentications is that the Credentials store the private FTP details and the Authentication stores the keys to the relevant Credential.
A typical authentication may look like this. You can have multiple authentications stored within the array, separated by commas.
|Server||String||The name for the FTP server|
|PortalId||Number||A unique single digit ID|
|ApiKey||String||A string of random letters to be used as authentication token|
|SecretKey||String||A string of random letters to be used to verify the authentication token|
|CredentialId||Number||ID of the credential to be used from the credentials section|
To generate the ApiKey and SecretKey values you can use a site like random.org:
Make the lengths for the ApiKey value different to the SecretKey value
A typical credential may look like this. Again, you can have multiple credentials separated by commas.
|CredentialId||Number||Matching ID from authentication section|
|Type||Number||Type of FTP to use: 1 (FTP), 2 (FTPS), 3 (SFTP)|
|Port||Number||Port to be used|
|Username||String||Username for FTP|
|Password||String||Password for FTP|
|Root||String||root section of the URL path|
|RootVirtualPath||String||Full URL of the virtual path|
|CertificatePath||String||If certificate is being used then enter here|
|SupportedFileTypes||String||String storing the extensions for the accepted file types, separated by comma|
When this service is used with any file/media upload ADC (see QEX file), the following fields are needed:
- URL: This should refer to the public address of the
- API Key: This should refer to the
ApiKeyfor the relevant Authentication
- Secret Key: This should refer to the
SecretKeyfor the relevant Authentication
! IMPORTANT : encrypt API & Secret Keys before setting them in the ADC's properties.
Browse the index.html page located at the root of the FileUploader folder : http://[SERVERNAME]/FileUploader/index.html
Insert the API and Secret Keys and press "Encrypt keys and Generate Token".
Add the encrypted keys to the ADC's properties