Introduction

Catalyst File Store provides cloud storage solutions to store, manage, and organize your application files and user data files. The files can be images, videos, text files, document files, spreadsheets, or other formats. Catalyst provides storage for all file formats and helps you categorize them in folders. Some examples of application files that you may want to store are application icon images, user profile pictures, and user documents. You can also download these files from the File Store to your local machine.

You can create multiple folders and store each of the related files in a folder. You can also set permissions for folders and define the access level granted for each of the user roles to each folder. Catalyst does not allow you to create sub-folders within your folders.

SDK and API documentation

You can upload and delete files directly from the console, or by using the SDKs. Catalyst also provides APIs to perform File Store operations. For more information and code samples on working in these programming environments, refer to these help pages:

• File Store - Java SDK
• File Store - Node.js SDK
• File Store - Web SDK
• File Store - API Documentation

Key Features of Catalyst File Store

• Enables you to organize and store all the files related to the application in one repository in the cloud
• Can store files of all types and formats, and of any size that is within the storage limits
• Allows you to create, update, delete folders and their contents automatically using API calls
• Other components can read and write files and folders into File Store using functions
• Can automatically modify the file contents based on the execution results of the other components
• Access to the files is defined by the user roles of the end users
• Metrics displays the following usage information of File Store: Total Space Utilization, Number of Files in each Folder, and File Size in each Folder

Working with Files and Folders

You can create folders, set access permissions for folders, upload files, rename folders, delete files and folders, and download files from the console. When a folder is created, a unique Folder ID is created for it. Similarly, whenever a file is uploaded to a folder, a unique File ID is created automatically for it. A file or a folder can be referred to by its ID number when working with the SDKs.

Creating a Folder

To create a folder in Catalyst:

1. Navigate to Develop > File Store.
2. In the Folders page, click Create Folder.
   
3. Enter the folder name in the Create Folder pop-up window. Enable the PII/ePHI Validator if the folder is going to contain sensitive user data.
   
   Note: The Personal Identifiable Information (PII)/Electronic Protected Health Validator (ePHI) indicates sensitive user data that needs to be stored and managed in compliance with all relevant data and privacy protection laws, such as HIPAA and GDPR guidelines. Examples of such sensitive data include Identifiable Health Information (IIHI), personal and contact information such as name, address, and telephone numbers, medical history and information including Medical Record Number (MRN) and Medicare Beneficiary Identifier (MBI), identity information such as Social Security Number and vehicle identifiers and any other user data that falls under this scope. You must enable the PII/ePHI validator for folders that contain sensitive user data.
   If this validator is enabled for a folder, Catalyst account admins and project members with the necessary permissions will be able to view all activities performed in these folders, in the Application Logs section of Audit Logs in the console. The activities include creation or deletion of files in a folder where the PII/EPHI validator has been enabled in the File Store.
4. Click Create

   

The folder is now created and a unique Folder ID is assigned to the folder. You can view the folder in the Folders page, which lists all the folders in the File Store, along with their properties like Folder Name, ID, PII/ePHI validator status, Created By, and Created Date. You can now upload files to this folder.

Uploading a File to a Folder

To upload a file to a folder in Catalyst:

1. Navigate to Develop > File Store.
2. In the Folder page, click the name of the folder you need to upload the file to.
3. In the folder's page, click Upload File.
   
4. In the pop-up window, select the files to upload from your system.
   
5. Click Open. The file will now be uploaded to the folder. You will be able to view the upload status at the bottom of the page.

   

The file will now be uploaded to the folder. The File ID is created automatically for the file once it is uploaded. You can view the file in the folder page, which lists all the files in the folder and some of their properties including File Name, ID, Created By, Created Date, and Size.

You can search for a file in the folder using the Search Files search bar.

Setting Permissions for a Folder

As discussed in the introduction, you can set permissions for a folder and define the access level granted to each user role for each folder. The three access permissions are:

• Download: The user roles with the Download permission enabled for a folder can download the entire folder or the folder's contents to their computers.
• Upload: The user roles with the Upload permission enabled for a folder can upload files into the folder from their computers.
• Delete: The user roles with the Delete permission enabled for a folder can delete the entire folder or folder's contents.

To set permissions for a folder in Catalyst:

1. Navigate to Develop > File Store.
2. In the Folder page, click on the ellipsis icon for the folder you wish to set permissions for and click Permissions.
   
3. In the Permissions pop-up window, click the check boxes to enable or disable Download, Upload, and Delete permissions for each user role.
   
4. Click Save to save the changes.

The users can now access the folder based on the permissions that are set for their user role.

Editing a Folder

To rename a folder in Catalyst:

1. Navigate to Develop > File Store.
2. In the Folder page, click the ellipsis icon corresponding to the folder that you wish to edit and click Edit.
   
3. Make the necessary changes and press Update.
   

The folder has now been edited.

Deleting Files and Folders

You can delete a file or a folder from the File Store permanently.

To delete a folder from the File Store:

1. Navigate to Develop > File Store.
2. In the Folder page, click the ellipsis icon for the folder you wish to delete and click Delete.
   
3. In the Delete Folder confirmation pop-up, click Yes, Proceed.
   

The folder is now deleted permanently from the File Store.

To delete a file from a folder in the File Store:

1. Navigate to Develop > File Store.
2. Click on the folder which contains the file to be deleted.
3. In the folder's page, click the ellipsis icon for the file you wish to delete and click Delete.
   
4. In the Delete File confirmation pop-up, click Yes, Proceed.
   

The file is now deleted permanently from the File Store.

Downloading a File from a Folder

To download a file from the File Store to your computer:

1. Navigate to Develop > File Store.
2. Click on the folder which contains the file to download.
3. In the folder, click the ellipsis icon for the file you wish to download and click Download.
   
   Choose where you want the file to be saved on your computer and click Save.

   

The file will now be downloaded to your computer.