My Files
This page outlines the features of My Folders. Folders can either be S3 object storage containers, or subfolders that live within these containers.
- Navigation
- Configure folder
- Configure a subfolder
- Folder permissions
- Synchronize storage location
- Folder details
Once logged in, the initial screen will be displayed, which shows the button “My Folders” on the top navigation bar.
Clicking on "My Folders" will bring up a page displaying existing folders and the option to configure a new folder. (Should you encounter an error on this screen, it is a browser issue...simply click the Home tab and then the My Buckets tab to fix it OR use your browser's refresh button)
To navigate the page, use the dropdown at the bottom of the list of buckets to select how many buckets you want to see on the screen, or the left and right arrows to navigate between pages of buckets. This is only applicable if many buckets are being displayed.
To setup a new storage location source (also known as a "bucket" in S3), click on "Add a new storage location service". Once the button has been clicked, the dialog will be displayed, requiring you to fill in the bucket configuration information.
Need a bucket? Contact NRIDS Optimization (Natural Resource ministries) or your ministry's service desk.
- Folder Name (mandatory) - your custom display name for the folder.
- Bucket (mandatory) - your storage provider's bucket identifier.
- Endpoint (mandatory) - the URL of the object storage server.
- Access key identifier / User account (mandatory) - user/account identifier or username.
- Secret access key (mandatory) - a password used to access the bucket.
- Bucket sub-path (optional) - an optional path prefix within a bucket (the path will be created if it doesn't already exist).
You can also re-configure an existing folder by clicking the gear-shaped action button next to an existing bucket, which will open the same dialog.
By default, BCBox does not work with subfolders inside an underlying storage location. They must be first added to BCBox.
To add a subfolder, click on the folder-with-plus-sign icon and fill in the fields:
- Folder sub-path - the name of the subfolder being added
- Folder display name - the name to display inside BCBox (it does not need to match the actual folder name)
To add a folder that's nested in another, click on the "add folder" button for the parent folder, enter its sub-path, and click "save". For example, if you want to add some/folder/path, click on "add subfolder" for some, and enter folder/path as the sub-path.
If the added subfolder already contains files, they will not appear until they are brought into BCBox by syncing.
Subfolder permissions are not inherited from their parent; they are managed separately. This allows you to customize access to different parts of a storage location.
The permission model contains 5 discrete permission codes. Each of the codes represents a different set of permissions and actions that are allowed to be performed on the resource, which can be a file or folder. For the most part, the permissions follow general CRUD principles and should be relatively self-explanatory.
| PermCode | Permission | Description |
|---|---|---|
UPLOAD |
Create | Grants resource creation permission. Normally only the owner will have this permission assigned. |
READ |
Read | Grants resource read permission. Ignored when in public mode for files. |
UPDATE |
Update | Grants resource update permission. Allows user to upload a new version and/or edit metadata/tags for the file, or to edit bucket details. |
DELETE |
Delete | Grants resource deletion permission. Allows user to delete files and versions. |
MANAGE |
Manage | Grants resource permission management. Allows the user to add/remove these permissions to other users. |
The Bucket Permissions dialog (found by clicking the "people" action icon) allows the bucket administrator to manage bucket permissions - add or remove additional users/viewers to the bucket. To add an user click on the "Add user" button, search for an IDIR/BCeID user by typing in the user's email address. Select one from dropbox and click "Add".
Once the user added check/uncheck the "Read", "Update", "Delete", and/or "Manage" permissions checkboxes to add or remove bucket permissions to the added user.
To delete the users' permissions, click on the x-person icon. Only user-added permissions can be deleted. When deleting user-defined permissions, each of the permission will be deleted but not the user itself.
Folders can be shared with other users.
If changes were made to the storage location externally (for example, with external tools like GeoDrive , S3 Browser, Cyberduck, etc.), syncing will be required in order to bring those changes over to BCBox.
To do so, click on the sync action button ("circular double arrows" icon), and click "submit sync request".
When new files and versions in your storage location are synced into BCBox, they will show the date that they were synced as their creation date rather than the actual date they were created in object storage.
At this time, syncing is not automatic, so you'll have to manually do so every time files are added, updated, or deleted from the storage location outside BCBox.
Syncing does not happen right away; how long it takes will depend on various factors such as server load and the number of files updated. Once a sync request is processed, all changes will be visible in BCBox.
To view folder details, click on the "i"-shaped action button next to an existing folder. The bucket details view provides you with a general properties of the folder – folder name, source storage location id and who manages its access.
