IN THIS ARTICLE
Asset Processor Interface
Asset Processor launches with Open 3D Engine (O3DE) and runs as a background process. It monitors scan directories and creates and manages the job queue for asset processing jobs. With Asset Processor, you can see the results of asset processing jobs and troubleshoot asset processing issues. To view the Asset Processor interface, right-click the Asset Processor icon in the system tray and select Show.
The Asset Processor UI has several tabs you can use to view the status of asset processing jobs, and get details about specific jobs and assets.
- A: The status line in the upper left displays information about process activity, including the number of active jobs and remaining jobs.
- B: Performance metrics are displayed in the upper right including the time spent on the last scan, the time spent on the last analysis, and the time spent processing assets.
- C: Choose the help icon to visit this documentation.
- D: The project, engine root, and the port used by Asset Processor to communicate with other processes are displayed below the status line.
- E: The buttons on the left select the tab to display in the Asset Processor UI. Refer to Asset Processor tabs below for more information.
- F: The information Asset Processer displays is dependent on the selected Asset Processor tab. Refer to Asset Processor tabs below for more information.
- G: Activate to display additional context details, if available.
The buttons on the left of the Asset Processor Interface (labeled E in the Asset Processor UI image above) select which tab to display (labeled F in the Asset Processor UI image above).
In the Jobs tab, the Asset Status pane displays the complete list of asset process jobs, the status of the jobs, and job details such as the deployment platform. The Event Log Details pane displays the event log details for the asset selected in the Asset Status pane.
Jobs for critical assets are processed before non-critical assets. Critical assets are required so that the engine can function and are marked as critical by their Asset Builders.
Asset processor supports job escalation for assets that are referenced before they have been processed. When you first launch O3DE Editor, it waits until all critical assets have processed, then O3DE Editor opens. Asset Processor continues processing non-critical assets in the background. If your interactions with O3DE Editor reference an asset that has not been processed, the job for the referenced asset is escalated so that the asset can be processed and loaded quickly.
The Asset Status list can be sorted by status, source asset path, completion time, deployment platform, or job key. Right-click any list item to access the source or the product asset, or view the logs for the process job.
Jobs in the Asset Status list display the statuses below:
- Pending - The job has been created, but has not run.
- Processing - The job is in progress.
- Completed - Warning - The job has completed but has emitted a warning.
- Completed - Error - The job has completed and has emitted an error.
- Completed - The job has completed successfully with no warnings or errors.
- Failed - The job has failed and has emitted an error.
It’s possible for a job to emit a combination of warnings and errors.
Completed with warnings produces a valid product asset, but might have some data substituted. Suppose a job is processing a
.fbx file that produces several mesh product assets, and that a
.assetinfo sidecar file specifies to process the meshes with custom normals. If the meshes in the
.fbx file do not have custom normals, the Asset Builder generates normals instead. Valid product assets are produced, but several warnings are emitted because custom normals could not be found for the mesh assets.
Completed with errors produces a valid product asset, but has incomplete data. Errors happen when data required for the product asset is missing or cannot be produced. Using the example above, suppose the
.assetinfo specifies tangents should be generated for the mesh product assets, but the Asset Builder fails to produce the tangents. The end result is a valid product asset that does not contain all the requested data.
Failed with errors does not produce a product asset.
Note:The most common reason for failure is that the Asset Builder has crashed. When an Asset Builder crashes, Asset Processor logs the job failure with an error and continues processing assets from the jobs list. When Asset Processor is restarted, it attempts to reprocess any failed jobs. Alternatively, you can locate individual source assets in the Assets tab, right-click on the asset, and select Reprocess File to re-run the process job.
The circumstances that cause an Asset Builder to complete a job with warnings or errors, or fail with errors, are left to the implementation of the Asset Builder, but should follow the guidance above.
The Asset Status list can be filtered by entering keywords and regular expressions in the filter box. The regular expressions (regex) are standard
std::regex in extended format. The
std::regex rules apply.
The example below searches for all files ending with .png. The asterisk (
*) indicates any character 0 or more times.
The example below uses regex to search for any files under an
Actors subdirectory. The dot plus (
.+) indicates any character 1 or more times.
You can view all assets with a particular status with either of the methods below.
Type the status keyword (for example,
failed) in the filter box.
Choose the filter icon and select the status types to display.
Filters that you apply remain active until you remove them.
You can perform actions on each row in the Asset Status table. Right-click on the row to expose a context menu with the following actions:
|Show in Asset Browser||Highlights the asset in O3DE Editor’s Asset Browser, if O3DE Editor is open.|
|Open in Explorer||Opens the asset in the system file browser.|
|Copy||Copies the asset name.|
|Open log file||Opens the most recent log file for the asset, if one exists.|
|Open folder with log file||Opens the directory containing the log file for the asset.|
The Event Log Details table displays asset processing information for the asset selected in the Asset Status table. This table provides an activity log that shows how the asset was processed and any errors or warnings generated during processing.
The Status column displays icons for the following message types:
- Information - Additional supporting messages are available about the processing of the asset.
- Warning - Additional supporting messages are available about a potential processing issue for this asset.
- Error - The location of the asset and the specific error generated by attempting to process that asset.
The Source column indicates the subsystem that generated the message (such as Asset Builder) or a generic type, such as Warning or Error.
The Message column displays information related to the processing details of the selected asset.
Note:The Message column occasionally prefixes Errors with E: and warnings with W:.
The Event Log Details table also features a context menu to copy details to the clipboard. Right-click on the row to expose a context menu with the following actions:
|Copy Line||Copy the selected line of the log.|
|Copy Line With Details||Copy the selected line and any related details that appear in the Event Log Line Details table.|
|Copy All||Copy all log lines and any hidden details for each item.|
The Context Details option in the lower right enables the Event Log Line Details table. It displays any additional information about the selected line in the Event Log Details table. The details and additional information are generally useful only when debugging issues with a particular asset.
The Event Log Line Details table also features a context menu to copy details to the clipboard. Right-click on the row to expose a context menu with the following actions:
|Copy Selected Key||Copy the text in the Key column of the selected row.|
|Copy Selected Value||Copy the text in the Value column of the selected row.|
|Copy All Values||Copy all keys and values in the table.|
In the Assets tab, the tabbed pane on the left displays either the Source Assets tree from the scan directories, or the Product Assets tree from the Asset Cache. You can browse either tree for specific assets, or use the search bar to find assets by name or ID. When an asset is selected, information about the asset is displayed on the right of the interface.
Note:The directory tree displayed in the tab is from the Asset Database, not the files on disk. It only displays assets that have been processed. Files on disk that are ignored by Asset Processer do not appear in the directory tree.
You can browse source assets in the scan directories to view IDs and dependency information for each asset. You can also browse product assets in the Asset Cache and view IDs, last process time, job key, deployment platform, and dependency information for each asset. A search bar is available in both tabs to filter the list of assets that are displayed. Search matches partial file names, and regex is supported.
With an asset selected, you can right-click and select from several actions such as view the source asset, view the job, open the asset location in a file manager, copy the asset path, and reprocess the asset.
On the left, the Source Assets list displays all the source assets that match the current search filter. When the search is empty, all source assets are displayed.
When an asset is selected in the Source Assets list, information about the asset is displayed in the panes on the right.
|Asset Information||Detailed information about the selected asset including the name of the asset, the scan directory path, and the Universally Unique Identifier (UUID) associated with the asset.|
|Products||The product assets that are produced from the source asset.|
|Outgoing Source Dependencies||The list of source assets that require an output from this source asset.|
|Incoming Source Dependencies||The list of source assets that must have completed their process jobs before this source asset can be processed.|
Note:Choose the Open icon next to a product asset name to open that asset in the Product Assets tab.
On the left, the Product Assets list displays all the product assets that match the current search filter. When the search is empty, all product assets are displayed.
When an asset is selected in the Product Assets list, information about the asset is displayed in the panes on the right.
|Asset Information||Information for the product asset including the asset UUID, the last time the product was generated, the type of job that generated the asset, which platform the asset was produced for, and which source asset is the primary input for the product.|
|Outgoing Product Dependencies||The list of product assets that depend on this product asset.|
| Outgoing Unmet Path Product Dependencies1 | The list of product assets that are hardcoded paths to be loaded by the O3DE runtime. |
| Incoming Product Dependencies | The list of product assets that this product asset depends on. |
| Missing Product Dependencies | Detect missing product dependencies. |
Note:1Because these products aren’t necessarily generated by Asset Processor, they’re placed into a separate category of dependencies.
The Logs tab displays logs for Asset Processor itself, not for process jobs. If you are having issues with a specific process job, start debugging with the logs for the job found in the Jobs tab. The type of errors displayed in the Logs tab are often related issues with managing the process jobs, maintaining the Asset Cache, and writing log information for process jobs.
The Logs tab has a single pane with three default tabs that display Debug, Messages, or Warnings/Errors Only. You can also add custom tabs to display any combination of information.
This is a legacy mode that is not currently used by O3DE.
In the Connections view, a single pane displays the current connections, and offers tools to add, remove, and manage connections. This view displays connections to Asset Builders, O3DE Editor, and development and deployment platforms being served by the Asset Processor. You can add approved connections in Allowed Listed Connections and add disapproved connections in Rejected Connections.
In the Active Connections table’s Enabled column, automatic connections are labeled as
Auto. This means that it’s a connection that the Asset Processor created. One example of such a connection is Asset Builder connections. User-created connections show a check box. If you select the check box, the Asset Processor continually attempts to reconnect to those connections. You can use these custom connections for specialized cases, such as when connecting to mobile devices outside of a company’s internal network.
You can edit a connection with the steps below.
- Left-click the desired connection in the connection list to select it.
- Choose Edit Connection in the upper-right to open the Edit Connection dialog.
In the Tools view, you can activate Faster Scanning Mode, and initiate a full scan of available source assets.
Faster Scanning Mode detects source asset file changes using the timestamp of the file, and performs a series of quick checks to determine whether to process a source asset. When Fast Scanning Mode is disabled, file hashes are used to detect changes, which increases source asset analysis time.
Initiating a full scan checks all of the scan directories and processes any source assets that need to be processed. You can initiate a full scan to attempt to reprocess jobs that might have failed due to an Asset Builder crash.
Copyright © 2022 Open 3D Engine Contributors
Documentation Distributed under CC BY 4.0.
The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.