Skip to main content

​
Working with Folders

The Folders section of the Data Catalog allows you to define and manage specific folders within your registered Object Stores. This provides a more granular level of organization for your unstructured data and is essential for setting up Vector Pipelines. Prerequisites: Before creating a Folder, you must have a corresponding Object Store registered in the Data Catalog. Refer to the Object Stores section for details.

​
Creating a Folder

  1. Navigate to Folders: From the Kosmoy Studio home page, click on the “Data Management” menu in the left-hand navigation bar, then select “Data Catalog” and then click on “Folders”.
  2. Add a New Folder: Click the ”+ ADD” button located in the upper right corner of the Folders section.
  3. Select Object Store: From the dropdown menu, select the pre-configured Object Store where you want to define the folder.
  4. Browse and Select Folder: Use the visual file browser to navigate the folder structure within the selected Object Store and choose the desired folder.
  5. Click “Next”.
  6. Name and Describe the Folder: Give your Folder a unique name and an optional description.
  7. Click “Review”: Review the Folder details.
  8. Click “Create”: Register the Folder in the Data Catalog.

​
Folder Cards

The Folders section displays each created Folder as a card. Each card shows:
  • Folder Icon: An icon representing a folder.
  • Folder Name: The name you assigned to the Folder.
  • Description: The description you provided for the Folder.
  • Object Store: The parent Object Store where the Folder is located.
  • Path: The path to the Folder within the Object Store
  • Edit Icon (Pencil): Click this icon to update the Folder’s name, description, or path (only if the Folder is not in use).
  • Delete Icon (Trash Bin): Click this icon to remove the Folder (only if the Folder is not in use).

​
Folder Usage Restrictions

You cannot edit or delete a Folder if it is currently referenced by other entities within Kosmoy Studio. This includes being used in:
  • Vector Pipelines
  • Any other Kosmoy Studio component that references Folders.
Before attempting to edit or delete a Folder, ensure it is not actively used in any of these areas.

​
Updating a Folder

You can update the name, description and even the selected folder of a registered Folder, provided it is not currently referenced by any other component.
  1. Navigate to Folders: Go to “Data Management” > “Data Catalog” > “Folders”.
  2. Locate the Folder Card: Find the card for the Folder you want to update.
  3. Click the Edit (Pencil) Icon: This will open the update dialog.
  4. Modify Folder Details: Update the Folder’s name, description, or browse to select a different folder within the same Object Store.
  5. Click “Save”: Save the changes.
If you attempt to edit a Folder that is currently in use, a warning banner will be displayed at the top of the screen, preventing the modification.

​
Removing a Folder

You can remove a registered Folder if it’s no longer needed. However, you cannot delete a Folder that is currently referenced by any other component.
  1. Navigate to Folders: Go to “Data Management” > “Data Catalog” > “Folders”.
  2. Locate the Folder Card: Find the card for the Folder you want to remove.
  3. Click the Delete (Trash Bin) Icon: This will trigger a confirmation prompt.
If you attempt to delete a Folder that is currently in use, a modal will appear, preventing the deletion and explaining that the Folder is in use.
  1. Confirm Deletion: Confirm that you want to delete the Folder.
Warning: Deleting a Folder is a permanent action and cannot be undone. Ensure that the Folder is not being referenced by any other component before proceeding.

​
Using Folders

Folders are primarily used when configuring Vector Pipelines in the Data Ingestion section. You need to specify a Folder within a registered Object Store as the source location for the documents that the pipeline will process.