# Item Export - PhotoRobot User Support Manual This User Support Manual describes how to operate and troubleshoot local or cloud-based item export in PhotoRobot Controls App (CAPP). ## How to Export Items in PhotoRobot Controls App In PhotoRobot Controls App (further referred to as “CAPP”), users can export items to a local disk, or export items to the PhotoRobot Cloud. Use this PhotoRobot User Support Manual to operate and troubleshoot Item Export in CAPP, including: - Item Export Options - Output Formats - File Formatting - Filename Templates - Saving and Loading Configurations - Item Export to a Local Disk - Item Export to the Cloud ## Item Export (Local) ### Select Items for Export To select items for export from CAPP to a local drive, first open the **Project** where the items are stored. Inside a Project, 25 items display by default. Users can select individual items for export, or select all 25 entries on a page. To select all items within a project, click the **Select all entries** prompt, which displays next to the number of entries selected: After selecting items for export, the total number of items displays in the upper-right part of the page. Confirm that the total number of items is correct, and click **Export** to open the export window: ### Configure Export Options In the Export items menu, the top of the window displays all items to export. Then, the export settings are organized into steps, starting with choosing the local folder to save the exported files. ### Select Export Destination The first step in the Export menu is **Destination**. Check the Output folder* field to choose the local folder where exported files will be saved. ### Change Item Status Use the **Item status** step to optionally mark exported items as Exported when the job completes. It is also possible to tick on / off the option to not change the status of items that do not contain photos. ### Assign Image Metadata The **Image metadata** option enables the embedding of author, copyright, title, description, and keywords into exported image files. Tick the box next to Embed metadata in exported images to active or deactivate. Activation will allow for configuration of defaults in Settings, and provide a preview of the image metadata to attach. ### Add Gallery Options The **Gallery** step when exporting items functions to add HTML preview, SpinViewer data files, and thumbnail images alongside exported images. Tick the boxes next to each option to enable or disable them. It is also possible to enable Add extracted OCR data into data.json config. - **Add HTML preview** – Tick this box to generate an HTML preview next to exported items which users can click to inspect. - **Add data.json config for PhotoRobot SpinViewer** – Check this box to configure the main JSON configuration file. - Note: After configuration, double-check that the JSON syntax is valid. - **Export thumbnail images** – Export images with thumbnails. - **Add extracted OCR data into data.json config** – Include optical character recognition with exported items. ### Define Output Formats Finally, for each export, the user must select the **Output formats**. This step defines still, spin, preview, and retouch outputs for the export. Click the option **(+) Add output format** to choose the format to export: Spin (360 / 3D images), Still images, and Images for export. - **Spin (360 / 3D) images** – Export items as a product spin. - **Still images** – Export still images, such as an image gallery of 5 or 6 photos. - **Images for retouch** – Mark images for external retouching before final export. **Note:** When adding multiple outputs, users configure individual menu options for Spin (360 / 3D) images and for Still images, or for other output formats. Then, the **Folder filter** field allows you to leave folders empty for all folders of a defined type. Enter names to match folders across every exported item. ### Choose File Format to Export For each output, select which file format to download images in: **JPG**, **PNG**, **WebP**, or **TIFF**. There are additional options to adjust DPI, choose Background color, Change quality, and to download original or resized files. The Filename* field displays the exported filename. - **JPG** – The JPG file format is useful for its compatibility and size, although some data may be lost in transfer. This is due to JPG using lossy compression, which does not always result in a 1:1 representation of the original image. - **PNG** – The PNG file format uses lossless compression to download images in a 1:1 representation of the original file. PNG files can also be served on a transparent background, however file sizes are much larger than JPG and used very rarely on the web. - **WebP** – The WebP file format from Google is generally compatible everywhere, and it combines the properties of JPG and PNG into one format. WebP has superior lossy and lossless compression, files can have transparency, and images can be compressed to extremely small sizes. - **TIFF** – The TIFF file format is extremely uncommon, and only used in very special cases for compatibility on legacy systems. TIFF thus has limited support in CAPP, and is not recommended for item export. **Note: The recommended file formats are WebP and JPG.** Further, WebP is recommended over JPG, as WebP consistently requires less bits per pixel than JPG for the same SSIM index. Conversely, PNG file sizes are often too large for the web, and only used in special cases. Also, be aware that DPI is set to 72 by default. Adjusting DPI will have no effect on image resolution, so in the majority of cases it is recommended to keep the default setting. ### Set Background Color (Transparent JPG Files Only) If configuring a transparent JPG file for export, users can select a background color by clicking **Background color**: - **Note:** Background color options are available only for transparent JPG files. - **Change quality** options function for both JPG and WebP files. ### Change Quality (JPG, WebP) To adjust image quality on JPG or WebP files, check the **Change quality** box below file format selection: Change quality is measured on a 1 to 100 (lowest to highest level) scale, which affects file size and image quality at the same time. **Note:** For JPG and WebP files, the ideal quality levels exist in different ranges. It will thus be necessary to adjust this number depending on the file format, and its desired size versus its desired quality. - **Change quality (JPG)** - JPG compression is typically measured as a percentage of quality level. For example, an image of 100 quality has almost no loss, but at the same time has a larger file size. Conversely, an image with 1 quality is an extremely low quality image. In general, JPGs with a quality of 90 or higher are considered “high quality”, while 80 - 90 is “medium quality”, and 70 - 80 is “low quality”. - **Change quality (WebP)** - WebP ideal quality levels exist between the 50 - 80 quality range in most cases. If the quality value is 80 or more, there is often no discernible difference in image quality, while file sizes become larger. For values 50 and under, file sizes reduce only slightly, while image quality is severely damaged. ### Export Original or Resized Image For all file types, users can select to export items in original file size, or in a desired resized resolution: - **Original** - This is the default setting to keep the original image resolution. - **Resized** - Select to specify the maximum size in pixels of an image to export (example: 1200 resolution). ### Item Export File Naming The final step before item export is to choose a **Filename***. This step enables users to select or change variables for the image template: To access the help box, click **Show template variables** via the question-mark icon to the right of the input filename: Standard variables include: - **${projectName}** - **${itemName}** - **${barcode}** - **${trackingCode}** - **${folderName}** Variables for further explanation are: - **${rowAngle}** - This is the vertical angle from which the image has been shot. - **${turnAngle}** - This is the horizontal angle from which the image has been shot. - **${rowIndex}** - These are similar to row angles but use an index within the row (example: If there are 3 rows, the row index is from 001 to 003). - **${turnIndex}** - These are similar to turn angles but use an index within the turn (example: If a spin has 24 frames, the turn index is from 001 to 024). Templates can be further customized using variables: - **${label}** - Create a basic label for an item for export (example: front, back, side). - **${gs1}** - Configure advanced item labels according to [GS1 image standards](https://www.photorobot.com/blog/gs1-image-standards). - **${order}** - This is the index of the image within the folder. It is similar to the turn index. However, instead of a position within a row, this is a position within a folder (example: if there are 2 rows of 24 frames, the first row is indexed 1 to 24, the second from 25 to 48. - **${stopId}** - **${tag:key}** - This enables users to customize ***tags** for an item. **Tags** within a filename can function for example as a label for “Product A” versus “Product B”. In this case, a filename for Product A might be: ${projectName}**/** ${itemName}(**${tag:productid}** /${folderName}/${rowAngle}**_a** ${turnAngle}.jpg Additionally, **Custom formatting** options exist to further customize some variables, including: ${rowIndex}, ${turnIndex}, and ${order}. Customize these variables by appending the variable with the colon symbol followed by a value, for example: - **${turnIndex:2}** - Format turn index filenames to two-digit rather than the default three-digit numerical index (e.g. 01, 02, 03, etc). - **${rowIndex:2:0}** - Format row index filenames to a length of two, starting with zero (e.g. 00, 01, 02, etc). - **${order:4:20}** - Format order index to a length of four, starting at number 20 (e.g. 0020, 0021, 0022, etc). **( ! )** - **Duplicate path error:** If using r${rowAngle}_a${turnAngle} in a template and also exporting still images that share rows with the same angles, the user must specify ${order}in the template. This will avoid encountering a “Duplicate path error,” and should look as follows: ${order}_r${rowAngle}_a${turnAngle}. ### Save or Load Configurations Next, users can save an export template and its configurations, or load a template from their archive. To save or load an export template, access template options via the menu icon next to Export items at the top of the export menu: When saving, click **Save** to create a new template, add a name, and include tags or notes for future indexing or reference: ### Export Items to the Local Disk After configuring the export template with all required outputs, file formatting, and filename variables, click Export in the bottom right of the interface: On successful export, all items will transfer from CAPP to the path specified to your local disk. ## Item Export (to the Cloud) Item export to the cloud follows the same procedure as exporting items to a local disk, and provides the same functionality. 1. Users configure export options, outputs, file formats, and filename variables: **The only difference is that with Cloud-based item export, CAPP generates a link with a URL address to access the exported item.** 1. In the Exports tab, click **Get link** next to the item for export: 1. Click **Copy link** to save the URL address to the item for export: 1. Paste the link from your clipboard to a browser search bar to access the item for download. Generated links are stored and accessible for download for 7 days. 1. To download images, users must install the PhotoRobot File Manager app. Click **Download Mac installer** (also available for Windows) if not already using the app on your device. 1. Click **Download now** to select a target folder for item download, and click the final Download button underneath the item path: On successful download, PhotoRobot File Manager displays both downloads and uploads: - Click **Show in finder** to open the folder containing the exported images.