Introduction  

 

The AWS S3 Export App provides users with a convenient and efficient solution for exporting content files from their Portal to a designated S3 bucket. When configuring the application, you can create an export criteria by selecting your preferred content types, along with their respective file types. The application also provides you with additional features, such as a toggle for automatic export, to enhance the content exporting activities on your VIDIZMO Portal. 

  

To learn about the concepts behind the configurations, visit: Understanding the Functionality of the AWS Export App.

 

Pre-requisites

  • Ensure that you have an active AWS account with permission to create and manage an S3 bucket. 


Creating the AWS S3 Export App  


    1. Use the Action Menu at the top left to go into Portal Settings.



    2. Select Apps and go into Integration Apps. 

    3. Click the “Add New Apps” button to open the App Catalog. 



    4. Use the “Add“ button to create an AWS Export App. Unlike other integration apps, Only one instance can be created for this application.



    5. Once the AWS Export App is added, use the gear icon to go into its configuration.




Configuring the AWS S3 Export App  

 

To export content files, you must configure the application with your AWS S3 bucket credentials, preferred export criteria, and additional settings that determine how the export activity is carried out on your Portal.  

  

AWS Credentials  

 

    1. Enter the Access Key for your AWS Account.

    2. Enter the secret key for your AWS Account. The Secret key is mandatory for authenticating the user.

    3. Select the AWS Region of your S3 Bucket and where S3 services are available.

    4. Select the Access type of your Destination S3 bucket.

    5. Provide the name of the Destination S3 bucket where the content files will be exported.


Note: Ensure that the Access Type you select in the AWS Export App is the same as the Access Type of the S3 Bucket you have provided under Destination Bucket.



Defining Export Criteria 

  1. Choose whether to turn Automatic Export on or off. Enabling this allows you to create a criteria for Portal content that will undergo automatic export activity and select a post-export action.
  2. To begin, select a field. Status and Publishing status are already defined as required fields for the criteria. Some of the options (properties and attributes) available here may vary based on the VIDIZMO Package you are using, what applications are enabled, and whether if any custom attributes are defined by the user. For example, the "Redacted" option only appears if you have Redaction as part of your VIDIZMO package. Media Culture only appears if you have configured and enabled the AWS Indexer App, and Categories only appear in EVCM packages, while Folders and Cases only appear in a DEMS package.
  3. Add the values for the respective field. The options displayed here depend on the selected field. For instance, if you select "Formats" as a field, the input corresponding to it displays a drop-down menu containing format types such as "Audio" or "Document." You can add these format types as values for the selected field. Here are the following ways the values can be taken an input.
    1. Radio Button: Gives the user a "Yes" or "No" option to select as an input. It determines if the field specified by the user is True for the content, or not. The following fields have this option:
      1. Clipped
      2. Locked
      3. Redacted
      4. Featured
      5. AI Processed
      6. Transcoded
      7. Transcribed
    2. Drop-down Menu: Offers the user a list of options that they can select (or unselect) from. The fields available for this option are:
      1. Status
      2. Publishing Status
      3. Formats: Selecting Folder, Case or Category as values will remove other format types (such as Document, Video, Audio) from the Formats field, and vice versa.
      4. Tags
      5. Folder
      6. Category
    3. Text Input: Allows the user to enter a value for the respective field manually. Here is how you enter the values for these fields:
      1. Author Name: Enter the name of a user as a value
      2. Keyword: Enter a term of any length to search for relevant Portal content. Keyword can include values like: Title, Description, Tags or Uploader Name. 
      3. Size: Enter a number as a value for the file size.
      4. Media Culture: Enter the Media Culture attribute as the value (e.g. en-US, zh-TW). These are generated when Portal Content is processed by the AWS Indexer.
      5. Mime Type: Enter the Mime Type of the content you want to export. You can find the Mime Type by checking Media Info or Evidence Info.
      6. Content ID: Enter the ID of the Portal Content you want to specifically target for Export Activity. One way of finding the Content ID is to hover the Settings button and then checking the URL at the bottom left or right of your Browser window. An example of content ID:

                    https://portalname.domain.co/library/mashup/1262956/settings

      7. App Status: Enter either "Exported" or "Not Exported" to target Portal content with this status.
      8. Drive System ID: Enter the path of the Portal Content that was ingested from an S3 Bucket. 

  4. Use the plus button to add additional rows to further refine your content selection.
  5. To remove or delete a row, click the "Remove" button next to it.
  6. Choose the Export Preference for your Portal. 
    1. Select "Already Present" to allow automatic exporting of past and new content (content that is created or added) on the Portal that meets the defined criteria.
    2. Select "Export After Enable" to only allow the automatic exporting of content added after the Export App is enabled and that meets the export criteria.
  7. Select the Content files or file types of the Portal content which meets the criteria. These files will be exported to the destination S3 Bucket.
    1. Original Content: Export the raw or base content file.
    2. Supporting Files: Export the supporting files for the original content. In VIDIZMO, these files are generated via ingestion or an indexing activity by the AWS Indexer.
    3. Audio PCM Files: Export the Audio PCM files which are generated when an audio or video goes PCM generation activity. These files have .dat extension.
    4. Timed Data Files: Export the time data files that are generated after an AI processing activity, like detection. The extension for timed data files are usually .json.
    5. Transcoded Files: Export the renditions of the original content that are created after transcoding. Extensions for transcoded files are usually m3u8 and .ts.

    6. Thumbnails and Preview Thumbnail: Export the preview and custom thumbnails of the original content. Thumbnails usually have a .png or .jpg extension.

    7. Closed Caption: Export the files created after processing an audio or video file for transcription. The extension for Closed Caption files is .vtt.


Note: The options to select Content files will be available regardless of "Automatic Export" being on or off. 


Configuring Post Export Action

 

When Automatic Export is enabled, the Post Export becomes available in the application’s settings.

  1. Choose a Post Export action for all content that undergoes an automatic export activity. 
    1. Select "Leave as it is" to retain the status of the Portal content that underwent an Export Activity.
    2. Select "Delete and Move to Recycle Bin" to move the Exported content to your Portal's Recycle Bin.
  2. Click Save Changes to finalize all configurations.



Once the changes are saved, you can perform the export activity on your VIDIZMO Portal according to your configurations. To learn how to carry out these export activities, visit How to Export Content Files using the AWS Export App.