File Library

Note: CAPI Administrator is deprecated. Please use CAPI Supervisor instead.

The File Library is an area in Forsta Plus that is allocated to the users/interviewers, in which files can be stored. This area can be used to transfer files to and from the interviewer devices (go to Files in CAPI Surveys for more information).

If files stored in the File Library are to be transferred to the devices during synchronization, then the files must stored as described elsewhere in this documentation. If a file is deleted from the File Library, then that file will also be deleted from the devices during the next synchronization.

Note: Each company is allocated its own File Library area, and a company’s File Library can be accessed by all users within the company. This means that if there are several Forsta Plus users in a company, then all of them will have access to all files stored in the File Library by any of the other users. Forsta therefore strongly recommends that to simplify navigation and file location, each user creates his/her own folder in the library in which to store their files.

The following File Library folders are currently downloaded during a synchronization:

• <Company root> - All CAPI users

• /CAPICommon - All CAPI users

• /<CAPI_UserName> - Files destined for that CAPI user. e.g. "CAPI_johnw"

• /<ProjectId> - Files for specific survey only. e.g. "p1234567890"

Transferring Files to a Specific Interviewer Console

The administrator can synchronize/transfer File Library files for a specific interviewer.

Note: During synchronization, the interviewer is checked to establish whether he/she is in the same company as the survey. If not, the capicommon and pxxx folders (if any) in the company file library are downloaded to the device.

Note: You must have System_File_library_Access permission to transfer files.

1. Log on to Forsta Plus as the administrator.
2. Go to the Home > File Library menu command.

The File Library window opens.



Figure 1 - The File Library window

3. If necessary, create a new folder in the File Library for the interviewer, into which the files are to be uploaded.
4. In the Folders column, click Create Folder. A new folder is created under the company folder.
5. Name this folder CAPI + the interviewer ID, for example “CAPI_adamapple”.
6. Click on the new folder to select it, and in the Root Folder column, click Upload.
7. Browse to and select the files you wish to upload (note that you can upload up to five files at one time), then click Upload Files.

The Files are copied into the selected folder.

Downloading File Library Files Based on Assigned Respondents

The CAPI App supports the ability to download File Library files based on assigned respondents. This is useful when you want to show custom images for each respondent. This also avoids CAPI users having to download all files contained in the CAPICommon or other designated folders.

To download File Library files based on assigned respondents, follow these steps:

1. In your survey, create a background variable using the following naming convention:

   __offline_file_[any text]”

   This variable can be used to indicate the path to a single File Library file. For example:

   https://survey.euro.confirmit.com/isa/BDJPFRDMEYBPBKLVADAYFQCDAVIOEQJR/1023.jpg

2. In the Respondent sample upload file, provide the full path to the target map image (see above)..

   Tip: Store the images in a folder that is not downloaded download by default. The root folder, CAPICommon and assigned project folders are downloaded by default.

3. Return to your survey, and reference the URL from the background variable to display the file.

Example

var mapURL = GetRespondentValue('__offline_file_map');
if(mapURL) {
var filename = mapURL.substring(mapURL.lastIndexOf('/') + 1);
f('mapfilename').set(filename);
}
<img
src="/isa/BDJPFRDMEYBPBKLVADAYFQCDAVIOEQJR/Somefolder/^f('mapfilename')^" width="437" height="407" />

As part of the CAPI sync, CAPI will loop through each project and assigned respondent.

For each background variable that matches the reserved prefix “__offline_file_” the app will then make a request to download that specific file only.