Ingest¶

The purpose of the ingest workflow is to provide new media files to the playout. In the first step, each new file must be uploaded to the central ingest storage. After each successful upload, the corresponding file is automatically processed by Makalu (for more information, see section File processing). When this internal file processing is completed, the uploaded file is registered in Makalu and can be scheduled for playout. In the final step, each scheduled file (added to the rundown as part of a show in a playlist) is automatically transferred from the central ingest storage to the local playout storage. For more information, see section File transfer.

Uploading files¶

The ingest process starts with the file upload. For this purpose, Makalu includes the Asset Uploader app. With Makalu Asset Uploader you can either upload a new file to the system, which creates a completely new media asset, or you can assign the file to be uploaded to a placeholder asset that already exists in the system.

To upload a file, proceed as follows:

1. Open Makalu Asset Uploader by either:

   1. Opening the Makalu Automation detailed channel view and selecting the Asset Uploader tab or by

   2. Opening the Makalu Asset Uploader via the Makalu Hub.

   The Asset Uploader UI is opened.

   

2. Open the sidebar, by clicking the Folder icon on the right side.

   

3. Select the folder on the ingest storage to be used as the target for your upload, by clicking the corresponding folder icon or name.

   Notice

   Which folders are available in the list depends on your access permissions. Folders marked with a Lock icon cannot be selected as upload targets. By default, this applies to the top-level root folder.

   

   The folder is selected, and the sidebar is closed. The name of the selected folder is displayed above the upload list.

   

   Tip

   You can also create a new folder on the ingest storage, by using the Create new folder area in the target folder sidebar.

   

   When creating a new folder, the following restrictions apply to the folder path and name:

   • By default, you can only create subfolders in folders you are allowed to access:
     • Valid example (accessible subfolder): Clips/Example-Channel/New-example-folder/
     • Invalid example (inaccessible top-level folder): New-example-folder/
   • Do not use a leading slash but append a closing slash:
     • Valid example: folder/subfolder/
     • Invalid example: /folder/subfolder
   • Use only permitted characters, letters, and folder names:
     • Permitted characters are letters (a-z, A-Z), numbers (0-9), hyphen (-), and underscore (_)
     • Not permitted (system-reserved) top-level folder names are Live, live, Placeholder, and placeholder

   To create a new folder, proceed as follows:

   1. Enter a valid path and name for the new folder in the Folder name field.

   2. Click Create.

   The folder list is updated and you can select the newly created folder as the target.

4. (Optional) If you want to assign the file to be uploaded to an already existing placeholder asset, select a placeholder as follows:

   1. Click Assign to placeholder.

      A list of available placeholders is displayed.

      

   2. Use the Search field and/or the paging buttons to search for a specific placeholder.

   3. Select a placeholder.

   4. Click Ok.

      The list of placeholders is closed, and the name of the selected placeholder is displayed to the right of the Assign to file button.

      

5. To select the file to be uploaded, click Add file.

   The file selection window opens.

6. In the file selection window select one or more files and click Open.

   Notice

   If you selected a placeholder (to assign the uploaded file to) as described in the optional step three, you can only select a single file. If no placeholder is selected, you can select multiple files.

   Notice

   Depending on how the Makalu Asset Uploader is configured, only permitted file types can be selected and uploaded. It is possible to allow any file type or to restrict the permitted file types (for example, MP4 files only). In this case, only files of this type are displayed in the selection window.

   The selected files are added to the upload list and the upload starts automatically.

   

   Asset Uploader provides an optional feature, that (if enabled) checks if a file to be uploaded already exists in the selected target folder on the ingest storage. It can be used to avoid uploading the same file and overwriting it unnecessarily although the file was not changed. In this case, the selected file is not uploaded and a corresponding notice is displayed. The check can also be extended to only allow overwriting an existing file if its modification date has exceeded a certain age.

   

   Notice

   During the upload process the progress of each upload is displayed, including current upload speed, amount of uploaded data, and overall upload percentage. At the top right the number of file parts ("chunks") currently being uploaded is displayed. The upload speed is not limited. Asset Uploader will use the full upload bandwidth currently available on the client side.

   Notice

   While uploads are in progress, you can either pause, resume, or cancel individual or all uploads via the corresponding buttons on the right side in the Actions column and below the upload list.

   Warning

   Do not close your browser while uploads are in progress! Otherwise, your current upload progress will be lost.

   

After the file upload has been completed, the file processing starts automatically.

File processing¶

After each successful upload, the internal file processing is automatically triggered. When the file processing is completed, the uploaded files are registered in Makalu and can be scheduled for playout.

File processing includes the following sub-processes:

For more information, see sections Transfer and File processing.

Previewing uploaded files¶

For previewing uploaded files, Makalu includes the Asset Viewer app. It lists all uploaded and processed video files (assets) according to the directory structure in which they were uploaded to the ingest storage and registered in Makalu. Asset Viewer provides a preview for playable assets (incl. subtitles) in the Content tab and an overview of all available technical metadata of the asset in the Metadata tab, with the option to download the corresponding original file. Additionally, it also lists placeholder assets with basic metadata and the option to delete them.

To preview uploaded and processed files, proceed as follows:

1. Open the Makalu Hub as described in section Accessing the Makalu Hub.

2. In the app list in the left column, in section Assets select Media.

   The Asset Viewer is opened in the Media tab of the Makalu UI.

   

3. Use the folder tree on the left side to select the folder that contains the file to be previewed.

   Notice

   Which folders are available in the folder tree depends on your access permissions.

   All video files included in the selected folder are listed in the Parent Assets area.

   

4. Select the file to be previewed from the Parent Assets list.

   The selected file is opened in the preview player on the right side. Corresponding files are listed below in the Child Assets area.

   

5. Use the player controls to preview the file.

The preview playback is started.

Housekeeping¶

Within the scope of storage/file housekeeping, Makalu provides two workflows for deleting files that are no longer needed: automatic and manual housekeeping.

Both workflows include the following steps:

1. Removing the file internally from the Makalu system by removing all corresponding database entries

2. Deleting the file from the central ingest storage

3. Deleting the file from the local storage on playout nodes

In addition, folders can be deleted from the central ingest storage independently of files.

Automatic file housekeeping¶

Automatic file housekeeping deletes files on the central ingest storage automatically based on their expiry date and files on the local playout node storage based on their aging date. These time periods are configured globally and the actual expiry date is calculated individually for each uploaded file based on these settings. When the expiry date is reached, a configurable grace period starts. After the end of this period, the corresponding file is automatically deleted the next time the housekeeping process is executed.

It is possible to configure protected folders, that are excluded from housekeeping. Files uploaded to these folders are never automatically deleted, even if the global expiry date is reached.

Manual file housekeeping¶

Manual file housekeeping allows you to delete uploaded files at any time (regardless of the global expiry date) via Makalu Asset Viewer.

To delete a file manually, proceed as follows:

1. Open the Makalu Hub as described in section Accessing the Makalu Hub.

2. In the app list in the left column, in section Assets select Media.

   The Asset Viewer is opened in the Media tab of the Makalu UI.

   

3. Use the folder tree on the left side to select the folder that contains the file to be deleted.

   All video files included in the selected folder are listed in the Parent Assets area.

   

4. Select one or more files to be deleted from the Parent Assets list.

5. Click Delete selected.

   

6. Confirm the dialog by clicking Delete.

The selected files are deleted.

Instead of deleting a file immediately, you can also set the expiry date manually. As a result, the file is deleted at a later time when the expiry date and grace period have expired.

To set the expiry date manually, proceed as follows:

1. Repeat steps one to three as described under Manual housekeeping.

2. In the Parent Assets list click the expiry date of the corresponding file in the Expires column.

   A date picker is displayed.

   

3. Select the new expiry date.

The expiry date is updated.

Manual folder housekeeping¶

Manual folder housekeeping allows you to delete empty folders from the central ingest storage via Makalu Asset Uploader.

To delete a folder manually, proceed as follows:

1. Open Makalu Asset Uploader by either:

   1. Opening the Makalu Automation detailed channel view and selecting the Asset Uploader tab or by

   2. Opening the Makalu Asset Uploader via the Makalu Hub.

   The Asset Uploader UI is opened.

   

2. Open the sidebar, by clicking the Folder icon on the right side.

   

   The sidebar is expanded and all available folders are listed.

   Notice

   Which folders are available in the list depends on your access permissions.

   

3. Expand the folder list and select one or more empty folders to be deleted, by activating their checkboxes.

   Notice

   You can only select and delete empty folders. Folders are considered empty if they do not contain any files and/or only empty subfolders. They can be recognized by a yellow folder icon. Non-empty folders are recognizable by a white folder icon.

   

4. Click Delete selected.

   

   A confirmation dialog is displayed that lists all selected folders.

5. Confirm the dialog, by clicking Delete.

The selected folders are deleted.