Introduction
VIDIZMO provides various integration apps for different purposes, including the AWS Export App. This app lets you export specific files of your Portal content to an assigned AWS S3 Bucket. To use this app, you need to configure it with your AWS S3 bucket credentials and define the export activity you want to conduct on your Portal. This article will guide you on performing the export activity on your Portal according to your app's configuration.
If you want to learn about the concepts behind the Export App, refer to Understanding the Functionality of the AWS Export App
Pre-requisites
- You need to have the AWS Export app already configured before any export activity can be performed. Refer to Configuring the AWS Export App in VIDIZMO for the procedure.
- Ensure that you have an active AWS account with permission to create and manage an S3 bucket.
- You also need a designated S3 Bucket to contain your Exported content. Click Create an Amazon S3 Bucket for a guide on creating one. For additional information, visit Creating a Bucket.
Activating Automatic Content Export
If you have enabled Automatic Export on your AWS Export App’s settings, the application will carry out the export activity on the Portal content that matches your defined Export Criteria. During the export activity, the specified Content Files are exported to the destination S3 Bucket. The application also considers your Export Preference for the automatic export activity.
When "Already Present" is selected, the application performs the export activity on all existing and future Portal content once. If "Export After Enable" is selected, the automatic export activity only applies to content that's added after the Export App has been enabled from the Integration Apps page. Click here for more information regarding Export Preference.
1. To enable Automatic Export on your Portal, you need to activate the AWS Export App from the Integration Apps screen by turning the toggle on.
Note: There is a 30 second timer between toggling the Export App on or off.
2. Once the application is enabled, it initializes a continuous workflow that runs and monitors content that meets the defined export criteria. You can determine if the Export App is active with this continuous workflow via "Sync Process", it can have the following status:
a. Pending: Indicates that the export workflow is about to begin.
b. Running: Indicates that the workflow for the export activity is running.
c. Finished: Indicates that the workflow for the export activity is finished.
d. Cancelling: Indicates that the workflow has received the input to stop.
e. Cancelled: Indicates that the workflow for the export activity has stopped.
3. The "Last Sync Attempt" is a scheduled check that specifies the date and time when the application last retrieved the "Sync Process" status of the export workflow.
4. Lastly, if an error was encountered in the automatic export activity, then you can click the "Error Details" text to open a window that provides the details.
Automatic Export is particularly useful for automating the export of content files of Portal content that’s added and then automatically processed by other VIDIZMO applications.
For example, you can use the VIDIZMO Audio Indexer to automatically process and generate Insights for audio files added via Ingestion App. The processing creates timed data files, which contain information regarding the generated Insights. You can use the Automatic Export capability of the AWS Export App to move these timed data files to a designated S3 Bucket.
Performing Manual Content Export
Once the AWS Export App is enabled, you can perform a manual or on-demand export on content that’s present in your Portal Library. A manual export can be performed regardless of the Automatic Export being on or off. The AWS Export App will also only export the content files that are selected in its Export Criteria..
Note: If the content you have selected for manual export does not have a content file that is selected in the AWS Export App, then an entry will be created in the Export Log but it will have "No File Found" in its details. Make sure that you process your content for the content files before exporting.
1. Navigate to your Portal's Library and look for the content you want to export.
2. Select Export from the overflow menu of any Portal content to export its files to the destination S3 Bucket.
3. You can also export multiple content by selecting them and then clicking the "Export" button on the header menu.
4. The system will ask the user for confirmation, so click confirm to proceed. The user must confirm to allow the export app to perform its function. Once the user clicks Confirm, the system queue the Export Activity for the selected Content and an entry will be added to the Export Activity Log.
Export Details in the App Activity Logs
You can track the progress of your current export activity and access the logs of previous activities from the Export App you added on the Integration Apps page. The logs added here correspond to the content undergoing (or that has undergone) a manual or automatic export activity.
If automatic export is enabled in the AWS Export App, the App Activity Logs Page is populated with entries (or logs) of the Portal content matching the export criteria defined in the application. If automatic export is turned off, and the user exports content manually, the entry for that specific content only appears when the user clicks the “Export” button.
As the logs are added, their information, such as the progress, will be shown and updated accordingly.
1. Click the "Activity Logs" to navigate there and see the details of all export activity on your Portal.
2. On the Activity Logs Page, you have several options to perform a variety of actions and searches. Use the search bar to perform a basic search of the logs.
3. Click the "Search" icon to reveal more options for advanced search. You can use these options to create search criteria for the logs you want specifically.
4. Specify a Start Date to view all export activity logs added after that date.
5. Specify an End Date to view all export activity logs added before that date. You can use both "Start Date" and "End Date" to set a time period and view all the export activity logs in that period.
6. Add Portal users to bring logs of manual export activity that they initiated or carried out. A log created via an Automatic Export activity has "System" as a user, while the logs created via Manual Export have the name of the user.
a. Processing indicates that the export activity is currently in progress.
b. Completed indicates that the export activity is completed.
c. Failed indicates that the export activity could not be completed. Logs with this status have an Errors icon under the Details column.
d. Content Not Found indicates that the export activity could not be completed because the relevant content files were not found or could not be retrieved.
8. Enter the name of the application(s) added to the Integration App page to bring logs specific to them. Currently only AWS Export App is available.
9. Click the Apply button to bring the logs according to the search criteria you have created.
10. Use the Refresh button to refresh the Activity Logs page and see the latest entries.
11. Clicking the "Errors" icon on a log with the status "Failed" or "Completed with Error" opens a modal that tells you which files failed and what error was encountered.
12. In the Details column, you can track the progress of exporting Portal content in terms of the number of content files. The column displays the number of files that have been exported, the number of files left to export, and the overall total number of files that need to be exported to complete the activity.
To learn more about the App Activity Logs, such as the Columns or how the activities are logged, visit: Understanding App Activity Logs