FileBox
Overview
Filebox is a virtual storage and forwarding space for business files. It allows for direct file exchange between the mobile devices and MCL-Mobility Platform.
The Filebox service allows the mobile devices to send data to a central location (which renders the implementing of in-house file servers to host data unnecessary).
Filebox can be organized into a shared or a private space. A shared Filebox is accessed by all the sites in the account. A private Filebox is only accessed by the site that created it (to create a site's private filebox, see Site Details).
The Filebox sub-module displays, by default, the shared Filebox content. However, if the site includes a private Filebox, the "Filebox" sub-module will only display that site's private Filebox content. It is NOT possible to access both Filebox spaces, simultaneously or alternately.
Filebox (shared or private) is divided into two areas: Inbox (which includes incoming files) and Outbox (a container for outgoing files).
Workflow between MCL-Mobility Platform's Filebox and Devices
The illustration below displays the flow of information between the account's back-end host, the MCL-Mobility Platform's Filebox (with Inbox and Outbox areas) and a device's own filebox (which also includes Inbox and Outbox areas.
Back-end Host - Generates and collects business data in the form of files. When required, it forwards files into the Outbox (an MCL-Mobility Platform's Filebox area) that are synchronized with devices included in a device group and/or the operators within an operator group. At the same time, the back-end host can retrieve business files from Inbox (an MCL-Mobility Platform's Filebox area) that were sent by the devices.
MCL-Mobility Platform's Filebox - A virtual space that consists of an Inbox and an Outbox area, which not only receives/stores files forwarded by devices (in Inbox) but also sends files to the devices (through Outbox).
Devices running MCL Applications - The emitters (via their Outbox) and receivers (via their Inbox) of business files. |
Incoming Files (MCL-Mobility Platform's "Inbox")
(Device) Outbox ⇒ (MCL-Mobility Platform's Filebox) Inbox
The devices associated to your account send business files to the Inbox of the MCL-Mobility Platform's Filebox. These files are transferred by the MCL-Agent in the background.
Those incoming files are organized into the same directory structure in Inbox as they were in the device. In other words, if an incoming file was included in folder "123", Inbox will create a folder "123" to contain the file. If a file was stored in the device's root directory, the file will be sent to the Inbox's root.
Once the file transfer is complete, the files are removed from the device's Outbox.
In terms of Inbox management, you can:
•define archive/deletion rules for the files added to Inbox.
•organize the incoming files into folders you create according to your own criteria.
•Retrieve the files for processing. This can be done manually (you can locally download all or the intended files) or automatically - a back-end can call a web service that periodically poles the Inbox area and retrieves the files it finds and downloads them into the back-end (ex: MCL provides a service that allows you to automatize file downloads/uploads within Filebox named Filebox Back-end Service).
Outbound Files (MCL-Mobility Platform's "Outbox")
(MCL-Mobility Platform's Filebox) Outbox ⇒ (Device) Inbox
All outgoing files (intended for the account's devices) must be placed in the MCL-Mobility Platform's Outbox. This can be done manually (files uploaded into the Outbox area) - or automatically, meaning, a back-end can call a web service to access Outbox and upload the intended files (ex: MCL's Filebox Back-end Service).
Files can be sent to all the devices associated to the account or to specific device or operator groups:
•Files placed in the Outbox’s root are distributed to all the account’s devices.
•To deliver a file to a specific device/operator group, place the file in the target group's reference folder (every device/operator group has a reference folder associated to it). For instance:
▪If calling a web service, make sure that the target group’s reference folder is included in the proper parameter's path.
▪If creating a folder in Outbox, rename it according to the corresponding reference folder (you can check the name of the reference folder in the target group's "...Details" page). Whenever a device or operator group is created, MCL-Mobility Platform suggests a reference folder but you can create a folder in Outbox and, then, associate it to a device or operator group (see To Associate an Outbox Folder to an Element's Profile).
Once a device connects to the platform, the files included in the Outbox area of the MCL-Mobility Platform's Filebox are automatically synchronized to the target element's Inbox.
If you create a sub-folder within Outbox and upload files into it, those files will NOT be delivered to the intended operator or device group unless you specify the sub-folder as the target element's reference folder in the corresponding "...Details" page ("Filebox Name" or "Filebox Sync Folder" option).
An external system can access the filebox 's private or shared spaces via web services (ex: Filebox Back-end Service). To access the shared filebox, the external system needs to use the Account Administrator's user role credentials. To access the private filebox, the external system needs to use the Filebox User's credentials.
Ex: To access the filebox web services, you will have to:
a. Go through the http authentication to ensure a connection to the account with the use of the "filebox password" (see "Account Details" - Service Passwords tab).
b. Use the account administrator's credentials (login and password). This will redirect you to the shared filebox area.
Filebox Sub-module
To access the Filebox sub-module, click and, in the resulting row below, select
.
The image below illustrates the page that is accessed when clicking .
Filebox Areas
The MCL-Mobility Platform's Filebox is divided into two main areas:
•Inbox (it includes incoming files from the mobile devices).
•Outbox (a container for outgoing files to the mobile devices).
By default, the Filebox page opens with the Inbox area, but you can change the display to the Outbox area.
Use the and
buttons to change the view accordingly.
Regardless of the selected area (Inbox or Outbox), the existing folders are displayed in a tree view on the left section.
OR
Use this section to view the folders included in each area as well as the sub-folders included in each folder. To do so, double-click the selected folder OR click the corresponding to expand its content. To hide it again, click
.
The expanded content is, also, represented in a tree view.
The sub-folders/files can be viewed with greater detail on the right section.
The right section displays the content of the folder selected in the tree view (left section).
Inbox Area
This area displays the following information:
Left Section |
|
Displays a tree view of all the folders/sub-folders included in Inbox. |
|
Right Section |
|
Name column |
Displays the name of the folder/file/sub-folder. |
Owner column |
Displays the name of the user or device that created the folder/file/sub-folder. |
Date column |
Displays the folder/file/sub-folder's creation date. |
Size column |
Displays the size (in MB/Kb/bytes) of the data in a file. |
Availability start date |
Does not apply to Inbox. |
Availability end date |
Does not apply to Inbox. |
Outbox displays reference folders of device or operator groups that have received files as well as the folders you create. These folders are used to synchronize files between the MCL-Mobility Platform's Filebox and a device/operator group's own filebox. Any files sent to a device/operator group's reference folder will be redistributed to all the devices/operators included in that device group/operator group.
When you create a device group and/or an operator group, MCL-Mobility Platform suggests a reference folder to be used as a synchronization folder with the device/operator group (this information is available in each device/operator group's profile).
This area displays the following information:
Left Section |
|
Displays a tree view of all folders/sub-folders included in Outbox. |
|
Right Section |
|
Name column |
Displays the name of the folder/file/sub-folder. |
Owner column |
Displays the name of the user or device that created the folder. |
Date column |
Displays the folder/file/sub-folder's creation date. |
Size column |
Displays the size (in Kb) of the data in a file. |
Availability start date |
Refers to the start date of file availability. This date can only be defined by back-end systems that post files for delivery. This is NOT editable within the "Outbox" area. |
Availability end date |
Refers to the end date of file availability. This date can only be defined by back-end systems that post files for delivery. This is NOT editable within the "Outbox" area. |
The "Filebox" page (Inbox or Outbox areas) also offers the following options:
•Use this button to display hidden options. In this case, when clicked, it expands to display an advanced filter:
Use one or all of the following search parameters:
Archived |
Check this option to include all archived folders/files/sub-folders as well as the active ones in the search. |
||||||
Name |
Enter the name of the folder/file/sub-folder to search. |
||||||
Owner |
Enter the name of the user/device that created the folder/file/sub-folder. |
||||||
from ... to... |
This time period refers to the creation date of a folder/file/sub-folder. Define a time frame for the search. Either enter a date/time (DD/MM/YYYY_HH:MM) or click the corresponding
|
After having defined the advanced filter parameters, click to proceed.
The filters you added are displayed in the right section:
If you want to delete any filters, either empty the corresponding box in the advanced filter option and click OR click the corresponding filter's
, in the right section.
• Use these buttons to display either the Inbox or the Outbox area.
•Use this button to open an information window. The displayed information will concern the currently open area (Inbox or Outbox). See Detail of an Information window.
•Use the search box to look for specific list items:
a. Enter what you want to search for.
b. Click or press <ENTER> in your PC keyboard to initiate the search.
c. To conclude the search operation, empty the search box and click or press <ENTER> in your PC keyboard.
•Click this button to refresh the page's information.
•Use the buttons, included in this bar, to organize the listed items of the corresponding column:
•by ascending order.
•by descending order.
•Click this button to select the listed items on display. In this case, the folders/files/sub-folders.
•Use and
, before the folder name, to navigate to sub folders within a folder.
Detail of a Filebox Area's Information on... Window
Use to open an information window on the currently open Filebox area (Inbox or Outbox).
This window consists of three tabs ("General", "Details"and "User Data"). Only the "General" tab, open by default, is editable.
General tab
The "General" tab presents the following information:
Name |
Identifies the area that the information refers to. |
Automatic deletion of...(archived files) |
This option is always on "edit" mode and refers to the deletion of archived files within the selected area (Inbox or Outbox). These are the available options: "– Default-" – MCL-Mobility Platform deletes the archived files of the selected area after 30 days. "Never" - MCL-Mobility Platform never deletes the archived files of the selected area. "Automatic" – MCL-Mobility Platform deletes the archived files of the selected area after a specified number of days. Ex: If you define 5 days, the files will be deleted 5 days after they have been archived. The number of days you define here becomes the value for the "Default" option of file automatic deletion at folder level (in a selected folder or sub-folder "Information on..." window). |
For more information on how to delete archived files, see Deleting Folders/Files in Filebox.
Details tab
The information this tab provides does NOT apply to Inbox/Outbox.
User Data tab
The information this tab provides does NOT apply to Inbox/Outbox.
Available Operations in the Inbox and Outbox areas
To delete files/folders, use the button. For more information, see Deleting Folders/Files in Filebox.
To create a new folder, use the button. For more information, see Creating a New Folder.
To edit a folder, use the button. For more information, see Editing a Folder.
To upload files into a folder, use the button. For more information, see Uploading Files to Filebox.
To move files, use the button. For more information, see Moving Files.
To copy files, use the button. For more information, see Copying Files in Filebox.
To download files/folders, use the button. For more information, see Downloading Files/Folders from Filebox.
This chapter includes the operations available in the Filebox sub-module and the user profiles that have access to them:
Keep in mind that the Account Administrator and/or the Site Manager, at a lower level, can restrict other users' access rights. This user guide is presenting all the possibilities in terms of access.
Topic/Operation |
Description |
User access |
---|---|---|
View the content/details of folders and files. |
Account Administrator Site Manager Site User |
|
Create a new folder/sub-folder. |
Account Administrator Site Manager Site User |
|
Rename a folder/sub-folder. |
Account Administrator Site Manager Site User |
|
Upload files to Inbox and/or Outbox. |
Account Administrator Site Manager Site User |
|
Move files to another location (within the selected Inbox or Outbox). |
Account Administrator Site Manager Site User |
|
Copy files. |
Account Administrator Site Manager Site User |
|
Download folders/files included in the Filebox. |
Account Administrator Site Manager Site User |
|
Delete files/folders/sub-folders, either because they are no longer necessary or because the disk space is needed. |
Account Administrator Site Manager Site User |