This Section is only visible for the ‘Pro’ users. If you are a Guest user, you will not be able to view this section in your web application. Please proceed to the next section by clicking here
A successful login to the Avataar web app takes you to the Catalog Ingestion page. The Catalog Ingestion page within the Avataar web app offers a user-friendly interface for ingesting catalogs or individual 3D models seamlessly. By following the provided steps and adhering to best practices, you can efficiently upload your assets, empowering your users to explore and interact with your products within the Gemini ecosystem. There are two methods of catalog ingestion: “Download Template” and “Upload 3D Model”
Through the 'Download Template' option, you can download a sample file (.xlsx format) that will help you ingest your existing catalog in the Avataar platform
Fields in the ingestion template are explained below:
SKU ID: The product name is a unique identifier assigned to distinguish one product from another and is typically displayed in catalogs, online stores, and other product listings. For example, "XYZ Smartphone 2000" or "ABC Premium Laptop."
Product Name: The SKU (Stock Keeping Unit) ID is a unique alphanumeric code assigned to each product to track inventory and sales. It can include numbers, letters, or a combination of both. For example, "SKU12345" or "ABC001."
Capturable: This field is to determine if it is physically possible to capture a particular product through Avataar Capture App
Reference Images: You need to provide either a link to the product's PDP that includes images from various angles or a link to a drive folder containing manually taken images of the particular product
Mesh URL: This is an optional field where you can provide the link to the existing mesh (if any) of the product which should be downloadable
Category: This field refers to the classification or the grouping which the specific product belongs to based on its characteristics, features, or intended use. E.g. consumer electronics, furniture, toys, home decor, etc.
Sub category: This field refers to a further more specific classification of the product within a broader category. E.g. furniture category may include sofas, table, chair, bed, etc. as sub categories.
Length - This refers to the longest dimension of the product
Width - This refers to the the shorter dimension which is perpendicular to the length
Height - This refers to the vertical dimension of the product
Primary dimension: The primary dimension is the most important or significant dimension among the length, width, and height. It is usually the larger dimension that defines the primary aspect or orientation of the product.
Unit: Units of measurement determine the scale or size representation of the dimensions. Common units include inches (in), centimeters (cm), meters (m), millimeters (mm) and feet (ft). It is important to use consistent units throughout to avoid confusion.
Type: This field refers to the relationship between the variants of the same product. There are two types of products based on the variants:
Primary - This is a ‘parent’ product for which multiple variants are present in the form of different colors
Secondary - This is a variant (child) of a primary product present in the form of a different color
Primary SKU ID: This field refers to the SKU ID of the primary product if the product in question is a variant (secondary) product of another item.
All fields except links to reference images and existing mesh, are mandatory
Link to reference images is a must for existing meshes and for objects that are not capturable
The Capturable? Field should be set to ‘No’ if a link to existing meshes is provided
Users must ensure that the uploaded files contain accurate content or are modified by a later upload
Upload of a Catalog file should be validated, resulting in a successful upload or errors. It is also possible to upload several Catalog files.
Primary and Secondary SKU Ids should be configured to show the relationship between variants of the same objects
An SKU Id marked Secondary in one row should not be marked Primary in another row
SKU Ids may contain alphabets, numbers, and special characters
Dimensions should be in number format, no text allowed.
To ingest your catalog, you simply need to fill out the details in the downloaded file as per provided instructions and upload it through the 'Upload File' option
A successful upload will give you the output ‘Upload Successful’. (screenshot below)
If there are any problems with the upload format and it doesn't meet the ingestion criteria (invalid values, duplicate rows, etc.), you will receive an error message as shown below. The error message will specify the row number that requires correction
Upload 3D Model
The Upload 3D Model option in the Avataar web app allows users to upload their own 3D models along with associated textures into the catalog. The supported file formats include GLB, USDZ, PNG, and JPG. Additionally, this section covers the configuration options available for creating an engaging 3D/AR experience. All of the files can be uploaded together as a group.
Follow these steps to upload your 3D models and the textures into the catalog.
Click on the ‘Upload’ button in the Catalog Ingestion page, upload all the supported files from your system.
This will upload the selected files (Note: Both GLB and USDZ files must be uploaded) and bring up the panel that helps you to configure your 3D/AR experience. It has the following options:
Click on Product Information to add relevant information about the product such as the name, SKU, category, dimensions, etc. The following details must be provided under the Product Information section for each product.
Product Name: The product name is a unique identifier assigned to distinguish one product from another and is typically displayed in catalogs, online stores, and other product listings. For example, "XYZ Smartphone 2000" or "ABC Premium Laptop."
SKU id: The SKU (Stock Keeping Unit) ID is a unique alphanumeric code assigned to each product to track inventory and sales. It can include numbers, letters, or a combination of both. For example, "SKU12345" or "ABC001."
Product Category: This field refers to the classification or the grouping which the specific product belongs to based on its characteristics, features, or intended use. E.g. consumer electronics, furniture, toys, home decor, etc.
Product Sub-category: This field refers to a further more specific classification of the product within a broader category. E.g. furniture category may include sofas, table, chair, bed, etc. as sub categories.
Length, Width, and Height: These dimensions refer to the physical size or measurements of a product. They are typically specified in linear units such as inches, centimeters, or meters. Length represents the longest dimension, width represents the shorter dimension perpendicular to the length, and height represents the vertical dimension.
Units of measurement: Units of measurement determine the scale or size representation of the dimensions. Common units include inches (in), centimeters (cm), meters (m), millimeters (mm) and feet (ft). It is important to use consistent units throughout to avoid confusion.
Primary Dimension: The primary dimension is the most important or significant dimension among the length, width, and height. It is usually the larger dimension that defines the primary aspect or orientation of the product.
Click on Color Variants to see the following fields. This option is used to configure the different color variants of a product.
Color Name: The color name refers to the specific shade or hue assigned to a product. For example, "Ruby Red," or "Navy Blue."
Color SKU id: The color SKU ID is a unique identifier assigned to a specific color variant of a product. It helps differentiate products that have the same model or style but come in different colors.
Note: A PNG file must be uploaded as the color icon. This icon will appear in the final web experience. The upload option is available next to the label ‘Color1’.
Click on ‘Add Material’ to see the following options.
Select material: This drop down is used to choose a material to configure. For example, “Ceramic_mat”.
Select node: This option allows you to select the geometry node to configure. For example, “Vase_geo”.
Select map type: This option is used to select a texture map that must be configured. For example, “BaseMap”, “Normal”, “Roughness”, etc.
Select map file name: This option is used to select the appropriate texture map file. For example, “ceramic_mat_BaseColor.png”.
Then click on ‘Add Map’ to add the texture map. This maps the texture files that were uploaded during the earlier group selection.
Along similar lines, add the other texture maps such as normal, roughness, metalness etc. by choosing the map type and the corresponding map file name and then clicking on the ‘Add Map’ option.
Repeat the process of adding additional materials by clicking on ‘Add Material’ and going through the above process of selecting and uploading the appropriate maps.
Add Color: This option is used to configure additional colors.
This option in the Avataar web app allows users to set up interactive elements with simple animations, enhancing user engagement and enabling exploration of products within the 3D/AR experience. For example, "Open" and "Close" animations for a chest of drawers.
To configure interactive elements for the GLB file, follow these steps:
In a GLB file, the animations are already saved as clips. The following simple procedure will map these clips to the corresponding action type.
Choose ‘Open’ from the drop down menu. Then type ‘Open’ as the action type in the corresponding text field.
Choose ‘Close’ from the drop down menu. Then type ‘Close’ as the action type in the corresponding text field.
To configure interactive elements for the USDZ file, follow these steps:
Enter ‘Open’ as the action type in the first text field in the USDZ section. Then enter the clip duration in the corresponding text field as a percentage of the total number of frames.
Enter ‘Close’ as the action type in the first text field in the USDZ section. Then enter the clip duration in the corresponding text field as a percentage of the total number of frames.
For example, if 100 frames were used in total and open animation is 40 frames, then close animation will be 60 frames. In this case, ‘Open’ text field is 40% and the ‘Close’ text field is 60%. Only numerals to be entered.
This option is used to map the dimension material of the product. This dimension will appear beside the product in the web experience and it can be configured to be ON or OFF.
The following options are available under dimensions.
Select material: This drop down is used to choose the dimension material to configure. For example, “Dimension_mat”.
Select node: This option allows you to select the geometry node of the dimensions to configure. For example, “Dimension_geo”.
Click on this button to preview the 3D model as a web experience. The 3D model will load in the web browser and it can be interacted with. The following buttons are given here.
Color: This button shows the color variants of the product.
Interaction: This button triggers the ‘Open’ and ‘Close’ animation of the product.
Dimensions: This button toggles the visibility of the product’s dimensions.
After carefully reviewing the model, click on the ‘Submit’ button to convert the 3D model and the associated textures into a web experience link.
Supported File formats:
The following file formats are supported by the configurator.
GLB - GLB (GLTF Binary) is a file format used for 3D models and scenes in AR and VR applications. It is based on the glTF standard and offers compactness, complete 3D scene representation, real-time rendering with PBR, and interoperability across platforms.
USDZ - USDZ is a file format developed by Apple for AR applications, based on the USD (Universal Scene Description) format. It integrates with Apple's ARKit, supports lightweight and efficient file sizes, enables animation and interactivity, and offers compatibility with various Apple applications and devices.
PNG - PNG (Portable Network Graphics) is a widely used raster graphics file format known for its lossless compression, supporting sharp edges, solid colors, and transparency. It offers wide color support, including 24-bit RGB, 8-bit grayscale, and 48-bit truecolor, along with the ability to store metadata.
JPG - JPG, or JPEG (Joint Photographic Experts Group), is a common file format for digital images, particularly photographs. It employs lossy compression, resulting in smaller file sizes but some loss of image quality. JPG supports variable compression levels, full-color representation with 24-bit truecolor, and enjoys widespread compatibility across software and devices.