# VXP - Visual Experience Platform

Welcome to the VXP Documentation! This guide is designed to help you get started with The Visual Experience Platform and make the most out of its modules and features.

## What is the VXP ?

The VXP is a platform to support the creation, management, optimization and delivery of visual experiences relying on visual assets, such as images, videos and documents.

It brings together 4 modules into 1 scalable and flexible platform for digital teams and IT teams to use via a web console ([VXP Hub](/vxp-visual-experience-platform/the-vxp)) or an API ([headless](/developers-headless/headless-dam)):

* [Digital Asset Management (DAM)](/digital-asset-management-dam/library): **manage** a library of visual assets in one single source-of-truth for both digital teams and developers.
* [Visual AI](/visual-ai/visual-ai): **automate** manual content workflows with AI-powered enrichment, moderation, and generative AI to streamline processes.
* [Portals](/portals/welcome): **publish** design guidelines and galleries to multiple stakeholders using a no-code portal builder.
* [Dynamic Media Optimization (DMO)](/dynamic-media-optimization-dmo/welcome): **optimize** images and videos with smart transformations and **accelerate** delivery over multi-CDN.

The platform follows [MACH principles](https://machalliance.org/mach-principles) and is built in a composable way to simplify the integration into an existing stack of solutions, such as your PIM, CMS or e-commerce platform.

<figure><img src="/files/ZAhfZ2Rioc466lhtJt4B" alt=""><figcaption><p>The 4 modules of the VXP</p></figcaption></figure>

## Platform overview <a href="#platform-overview" id="platform-overview"></a>

Start using the [Library](/digital-asset-management-dam/library) to upload your first files, such as images and videos, via simple drag and drop, CSV import or API upload. Streamline team collaboration around marketing and product assets.&#x20;

Enrich files with tags as well as [metadata](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/metadata) to turn them into assets and organise them into static [folders](/digital-asset-management-dam/library/folders) or dynamic [collections](/digital-asset-management-dam/library/collections). Leverage [Visual AI](/visual-ai/welcome) to automatically tag, describe and categorize assets.

Publish media galleries on responsive and multi-lingual [Portals](/portals/welcome), built via our easy-to-use and templated no-code CMS.

Dynamically generate [variations](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/variations) of assets to ensure optimal size and crop for each specific channel. Leverage the DAM Studio to create marketing banners at scale with dynamic images and text.

Speed up delivery by utilizing modern compression formats such as WebP, AVIF, and WebM, alongside Content Delivery Networks (CDNs), to enhance web page performance and improve core web vitals.

Finally, get access to [analytics](/vxp-visual-experience-platform/settings/project/analytics) and insights about the platform's user adoption, insights about your asset's performance and help drive decision on which asset to use and where.

## Business examples <a href="#platform-overview" id="platform-overview"></a>

### Manage and optimize large volumes of e-commerce or real estate product assets

> **Modules**: DAM, Visual AI, DMO\
> **Target users**: developers and e-commerce team

### Create large volumes of promotional marketing banners from existing assets and derive social media variations

> **Modules**: DAM\
> **Target users**: studio team, marketers

### Create a brand portal to publish brand guidelines

> **Modules**: DAM, Portals\
> **Target users**: branding team

### Build a multi-tenant and scalable content backend for your SaaS application and leverage AI-powered visual search to find assets by text prompts

> **Modules**: DAM, Portals\
> **Target users**: branding team

If you need further assistance, please check our [knowledge-base](https://scaleflex.zendesk.com/hc/en-us) or contact our Customer Experience team at <support@scaleflex.com><br>


# The VXP

The Visual Experience Platform is your environment that hosts all modules you use with Scaleflex.

In this section, you will learn about the basics of the VXP, which include:\
\- [Your VXP token](/vxp-visual-experience-platform/the-vxp/token)\
\- [Account and Project settings options](/vxp-visual-experience-platform/settings)


# Token

The provided token is a key concept to understand when working with Scaleflex DAM. Your token identifies as your tenant, which is used for and known as a project.

Each new Scaleflex DAM account comes with a token for a project. Each token combines a storage container to store assets and a CDN distribution to deliver optimized assets over CDN worldwide.\
An account can have multiple tokens to suit different projects within an organisation, which is called multi-tenancy.&#x20;

Whether you use one or multiple tokens for your projects, Scaleflex DAM's multi-tenancy allows you to manage all use cases across various tokens or projects through a unified interface.

<figure><img src="/files/q0VJWIHtWZ5CQjNxtHGO" alt=""><figcaption></figcaption></figure>

### Company-wide vs project-wide users <a href="#company-wide-vs-project-wide-users" id="company-wide-vs-project-wide-users"></a>

Users can be created at the company level or project level.&#x20;

A hierarchy can be created within each token or project, and users and teams can be given access permissions to single or multiple tokens.

* Company-level: grants access to all projects
* Project-level: grants access to a project or selected projects, but not all within the company

{% hint style="info" %}
Some system settings are company-specific, while others are project-specific.

As a simple rule, all Organisation settings are linked to the company, while all other settings, such as Project or Development, are project-specific.
{% endhint %}


# Settings

The settings within the VXP platform are your control centre; use this section to understand how to set up your account, manage users or billing, and apply brand identity to your platform.

Within this section, you will learn about the following sections found within the Settings menu:\
\- [My Account](/vxp-visual-experience-platform/settings/my-account)\
\- [Organisation](/vxp-visual-experience-platform/settings/organisation)\
\- [Project](/vxp-visual-experience-platform/settings/project)


# My Account

The Account section within Settings consist of two parts: Profile and Support. Use these pages to understand how to set up your account and use Support.

Continue to the next page to learn about setting up your Profile.


# Profile

Control panel where users can manage profile information, login and security settings

<figure><img src="/files/9Ta0QQs1RBKxwozdmmmF" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="374">Section</th><th>Fields</th></tr></thead><tbody><tr><td>Personal information</td><td><ul><li>First name</li><li>Last name</li><li>Display name</li><li>Location</li><li>Bio</li><li>Profile image</li></ul></td></tr><tr><td>Login Settings</td><td><ul><li>Email address</li><li>Password with <strong>Edit password</strong> button</li></ul></td></tr><tr><td>Multi-factor authentication</td><td><ul><li>Session timeout</li><li>Multi-factor authentication (MFA)</li><li>Verify logins by email</li><li>Verify logins with SMS</li></ul></td></tr></tbody></table>


# Support

Use the Support page to log a bug or make inquiry directly to the Scaleflex CX team.

The Support window will display your logged ticket history to the Customer Experience team.\
\
The following information will be displayed: <br>

|            |                                                        |
| ---------- | ------------------------------------------------------ |
| Ticket ID  | Number of Ticket request                               |
| Title      | Title of created ticket                                |
| Updated at | Date and time of last comment or action made on ticket |
| Updated by | Name of user that last updated the ticket              |
| Message    | Preview of message sent within ticket                  |
| Status     | Current status of the ticket                           |

<figure><img src="/files/9zqC1PzG3fNzNG9zMFQj" alt=""><figcaption></figcaption></figure>

In addition, you can make a direct request to the Support  team by clicking the + Send request button. &#x20;

When clicking the + Send request button, a form will appear. You can provide a title, message, and any attachments to the request. <br>

{% hint style="info" %}
When logging a bug, we recommend attaching screenshots or videos of the issue so the Support team can better understand and reproduce the issue.&#x20;
{% endhint %}

<figure><img src="/files/kOpdzqH3mbQ2GurSpSeG" alt=""><figcaption></figcaption></figure>


# Organisation

The Organisation section with Settings is where you can set the general details, view billing, and manage users and teams.

You can jump to the following sections to learn more.&#x20;

* [General Organisation Settings](/vxp-visual-experience-platform/settings/organisation/general)
* [Billing](/vxp-visual-experience-platform/settings/organisation/billing)
* [Users](/vxp-visual-experience-platform/settings/organisation/users)
* [Teams](/vxp-visual-experience-platform/settings/organisation/teams)


# General

This page contains company-wide settings that are applied to all projects.

<figure><img src="/files/guknLfsxXi8nph3mllaj" alt=""><figcaption></figcaption></figure>

### **Basics** <a href="#basics" id="basics"></a>

This page section contains information about the company:

| Setting          | Description                                                                                                                                                                   |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Company name     | The company name displayed in the upper left corner of the Asset Hub, unless a project logo has been uploaded under Branding                                                  |
| Default language | <p>When a language is selected, it will be shown by default to all users.</p><p>Please note that each user can change it individually through the settings in My Account.</p> |
| Session Timeout  | This is the default session timeout, which logs out the user after a certain amount of time after the last activity was made.                                                 |
|                  |                                                                                                                                                                               |

### **Access management** <a href="#access-management" id="access-management"></a>

In this section, the company-wide security settings can be specified.

| Setting                     | Description                                                                                                                                                                                                      |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Multi-factor authentication | Enable or disable MFA for the entire company. The MFA code will be sent via their phone or email. Please note that MFA is bypassed if SSO is enabled.                                                            |
| Single sign-on (SSO)        | Configure SAMLv2-based SSO to enable users to access the Asset Hub using SSO via an Identity Provider (IdP). You will still need to create the users in Scaleflex DAM before they will be able to login via SSO. |
| SCIM Provisioning           | Configure SCIM (System for Cross-domain Identity Management) provisioning to provision users and teams automatically from your identity provider such as Okta or Microsoft EntraID.                              |

#### SSO

{% hint style="info" %}
Configure SSO so that users can log in with their corporate credentials (such as Active Directory, Okta, or Azure AD / Entra ID) into Scaleflex DAM.

An Identity Provider supporting SAMLv2 is required.
{% endhint %}

To configure SAMLv2-based SSO, click on the **Add SSO connection** button. Any Identity Provider supporting the SAMLv2 protocol is supported.

{% tabs %}
{% tab title="Step 1" %}

<figure><img src="/files/a90mC0Ln5bgIoSgvHCQ6" alt="" width="375"><figcaption><p>You can copy the ACS URL and EntityID or download the SP metadata XML</p></figcaption></figure>
{% endtab %}

{% tab title="Step 2" %}

<figure><img src="/files/FoyXLmK9QpEch8JySdTt" alt="" width="375"><figcaption><p>Enter the SSO application details from your IDP in the corresponding fields</p></figcaption></figure>
{% endtab %}

{% tab title="Step 3" %}

<figure><img src="/files/VYnFPceXAH6MZSO250ZV" alt="" width="375"><figcaption><p>Enter the email domain which will trigger the SSO process</p></figcaption></figure>
{% endtab %}
{% endtabs %}

After saving the SSO connection, every user attempting to log in with an email address from the domain configured in Step 3 will be redirected to the configured Identity Provider and automatically logged into the Asset Hub if an active SAMLv2 session is enabled.

#### SCIM provisioning

Prerequisites:

* Active SAML SSO configuration in DAM.
* Administrator access to your Identity Provider (IdP) (e.g., Okta, Microsoft Entra ID).

{% hint style="info" %}
SAML SSO is required for enabling SCIM provisioning as users will not have a local password in the VXP and will authenticate against your organization's identity provider.
{% endhint %}

Once SSO is configured, a SCIM token can be generated to set up SCIM (System for Cross-domain Identity Management) provisioning and automatically manage the users' and teams' lifecycle from your identity provider, such as Okta, EntraID or any other IAM solution supporting SCIM. Team memberships are also synced in this way and you can assign a default user profile to each team. Click on *Generate* to generate a SCIM token and use it to configure SCIM with your identity provider.

<figure><img src="/files/wWWvw6fR9jL6frVOiYp5" alt=""><figcaption><p>Generate the SCIM token</p></figcaption></figure>

{% hint style="warning" %}
Generating a SCIM token will override any previously generated SCIM token and you will need to update it in your identity provider for SCIM to continue working.
{% endhint %}

Use the SCIM token and <https://hub.scaleflex.com/api/scim/v2> as SCIM 2.0 base URL / endpoint to configure SCIM provisioning with Scaleflex:

**Okta**

<figure><img src="/files/CyU5eBWKivN2aj9RXi3k" alt=""><figcaption></figcaption></figure>

**Microsoft EntraID**

<figure><img src="/files/1OuAJ1rZZwZP1WvuYaCm" alt=""><figcaption></figcaption></figure>

Once the connection is successfully configured, the following steps are recommended:

1. Create groups in your Identity Provider (IdP) for each target user profile (e.g., *VXP Viewer*, *VXP Contributor, etc*).
2. Push the groups to VXP to automatically generate matching SCIM Teams.
3. Map the team to a project and a user profile (custom user profiles are supported) in the VXP

<figure><img src="/files/JTZpSS3QZ5KJy1Jz4KLs" alt=""><figcaption></figcaption></figure>

4. Add users to the group in the identity provider
5. Users will be automatically created in the VXP. They receive a welcome email to activate their account.

**Notes:**

* Company-level teams are not supported - it's one team <> one project.
* *VXP Owner* and *VXP Administrator* are company-level profiles which cannot be assigned to project-level users. Thus, these profiles are not available for SCIM team mappings and users with such roles should be created directly in DAM.
* Moving a user from a group to another in the identity provider will automatically be reflected in the team membership and user profile in the VXP for this user
* Editing SCIM teams and users in the VXP is not available: the source of truth for user and team attributes is always the identity provider
* SCIM users / teams can co-exist with local VXP users and teams
* Un-assigning or deactivating a user in the identity provider will remove the user from the corresponding VXP team(s) and set them as *inactive*. However, the user is still not deleted.
* If a user is a member of multiple groups / teams assigned to different profiles, they will be assigned to the user profile having the largest set of permissions
* SCIM teams can be used as part of [accesses](https://docs.scaleflex.com/digital-asset-management-dam/library/folders#downloading-the-folders-content) to manage folder and asset access centrally from your identity provider through SCIM

#### Terms and conditions (T & Cs) <a href="#terms-and-conditions-ts-and-cs" id="terms-and-conditions-ts-and-cs"></a>

| Setting                                                        | Description                                                                                                                                                                                                |
| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Prompt new users to accept the company's T & Cs on first login | Enable or disable the requirement for users to accept the customizable T\&Cs upon first login                                                                                                              |
| T & Cs text                                                    | The custom text or HTML to display to users on their first login. Supports multiple languages.                                                                                                             |
| Force all users to accept the new T & Cs                       | Modifying the content of the Ts & Cs will create a new version. Enabling this setting will force users who have already accepted the previous version to accept the updated version upon their next login. |


# Billing

Manage your billing information and plan and view your invoices within the Billing section of the VXP platform.

The Billing page within Settings consists of three sections:&#x20;

* [Payment](/vxp-visual-experience-platform/settings/organisation/billing/payment)
* [Invoices ](/vxp-visual-experience-platform/settings/organisation/billing/invoices)
* [Plan](/vxp-visual-experience-platform/settings/organisation/billing/plan)
* Visual Operations Credits Usage


# Payment

<figure><img src="/files/2wQRhe3H0R97tlEPH7Fr" alt=""><figcaption></figcaption></figure>

#### **Billing information** <a href="#billing-information" id="billing-information"></a>

| Setting         | Description                                                           |
| --------------- | --------------------------------------------------------------------- |
| Invoice email   | Add contacts who should receive copies of the invoices.               |
| Billing address | Specify (or update) a billing address and contact email for invoicing |

#### Payment details <a href="#payment-details" id="payment-details"></a>

List of available payment methods for making payments on your invoices. You can only choose one option.

| Setting                       | Description                                                                                                                                                                                         |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Payment method: Card          | Once "CARD" is selected, you will be required to enter your card details, which will be used to make payments.                                                                                      |
| Payment method: Bank (manual) | Once "Bank (manual)" is selected, you will receive invoices by email based on your billing frequency (by default: monthly) and will have to pay via bank transfer on the designated account (IBAN). |
| Payment method: Direct debit  | Once "Direct debit" is selected, you must enter your IBAN, which will be used to make automatic bank payments.                                                                                      |

#### Usage Alert Notifications (Service)

When enabled, the platform will automatically send three usage alert notifications:

* When any component of your plan reaches **85% of its allocated allowance**
* When usage reaches **100% of the allocated allowance**
* When usage exceeds **125% of the allocated allowance**

These notifications are automatially sent by email to all users assigned the **Owner**, **Admin**, and **Accountant** roles within the company account.

In complement, external emails (without DAM account) can be added to the list of default recipients.


# Invoices

The invoice page shows all your paid and pending invoices. You can download them for your records and future reference.

<figure><img src="/files/Ul6Og4vJ2woqQQy7mRvN" alt=""><figcaption></figcaption></figure>


# Plan

The Plan page provides an overview of your current plan which details what is included and the add-on features that you can purchase.

<figure><img src="/files/qQ5FUHFR3b1DPCL8p90s" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/2Z5tmPeryeQacqH0Mz5T" alt=""><figcaption></figcaption></figure>


# Visual Operations Credits Usage

updated: 28.11.2025

{% hint style="info" %}
**Disclaimer:** The information contained in this table is accurate and valid at the time of publication. Credit unit allocations may change as model usage evolves or as third-party pricing is updated. These figures do not constitute a binding commitment. We recommend contacting our Sales team for any plan-specific or Enterprise Agreement–related guidance, including any intent to incorporate this credit unit table into your commercial terms.
{% endhint %}

Each Visual Operation involves a call to a video processing or AI API. Credits are valid for use over a 12-month period. Payments for credits will follow the same schedule as your subscription, keeping everything simple and aligned.

*\*Alternative AI models may be made available following customer assessment and mutual agreement. Credit consumption per operation may differ accordingly.*

<table data-full-width="true"><thead><tr><th width="117.72442626953125">Visual Operation Family<select><option value="KwLadoFUuz0Q" label="Enrichment" color="blue"></option><option value="eWga9prgxqnc" label="Processing" color="blue"></option><option value="2h6JloNmjQgs" label="Edition" color="blue"></option></select></th><th width="402.2352294921875">Visual Operation Name</th><th data-type="checkbox">Alternative model(s) available?*</th><th>Hosting</th><th>Credits / operation (default model)</th><th>Multi-lingual translations available (*cost factor)?</th></tr></thead><tbody><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Image description - Long</td><td>false</td><td>EU</td><td>3</td><td>yes (*0.6)</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Image description - Short (Smart Alt Tex)</td><td>false</td><td>EU</td><td>2</td><td>yes (*0.6)</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Image description - Micro</td><td>false</td><td>EU</td><td>1</td><td>yes (*0.6)</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Image tagging</td><td>true</td><td>EU</td><td>2</td><td>yes</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Video description - Long</td><td>false</td><td>EU</td><td>3 + 0.33 * secs</td><td>yes (*0.6)</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Video description - Short</td><td>false</td><td>EU</td><td>2 + 0.33 * secs</td><td>yes (*0.6)</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Video description - Micro</td><td>false</td><td>EU</td><td>1 + 0.33 * secs</td><td>yes (*0.6)</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Video tagging</td><td>false</td><td>EU</td><td>2 + 0.33 * secs</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Video embedding (vectorisation)</td><td>false</td><td>EU</td><td>0.4 * secs</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Brand detection</td><td>true</td><td>USA (GDPR)</td><td>71</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Car plate number recognition</td><td>false</td><td>EU</td><td>2</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Face count</td><td>true</td><td>USA (GDPR)</td><td>16</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>OCR (text in image)</td><td>false</td><td>EU</td><td>6</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Image visual matcher</td><td>false</td><td>EU</td><td>3</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Image authenticity detection</td><td>false</td><td>EU</td><td>1</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Image quality assessment</td><td>false</td><td>EU</td><td>1</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Not Suitable For Work (NSFW)</td><td>true</td><td>EU</td><td>1</td><td>N/A</td></tr><tr><td><span data-option="KwLadoFUuz0Q">Enrichment</span></td><td>Object classifier (product, room, scene, sport)</td><td>false</td><td>EU</td><td>1</td><td>N/A</td></tr><tr><td><span data-option="eWga9prgxqnc">Processing</span></td><td>Video transcoding and compression - above 2160p (/sec)</td><td>false</td><td>EU</td><td>16</td><td>N/A</td></tr><tr><td><span data-option="eWga9prgxqnc">Processing</span></td><td>Video transcoding and compression - QHD video input 2160p (/sec)</td><td>false</td><td>EU</td><td>8</td><td>N/A</td></tr><tr><td><span data-option="eWga9prgxqnc">Processing</span></td><td>Video transcoding and compression - Full HD video input 1080p (/sec)</td><td>false</td><td>EU</td><td>4</td><td>N/A</td></tr><tr><td><span data-option="eWga9prgxqnc">Processing</span></td><td>Video transcoding and compression - HD video input 720p (/sec)</td><td>false</td><td>EU</td><td>2</td><td>N/A</td></tr><tr><td><span data-option="eWga9prgxqnc">Processing</span></td><td>Video transcoding and compression - SD video input 360p (/sec)</td><td>false</td><td>EU</td><td>1</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Background removal</td><td>true</td><td>USA (GDPR)</td><td>200</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Car plate blurring</td><td>false</td><td>EU</td><td>1</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Product shadowing</td><td>false</td><td>USA (GDPR)</td><td>1000</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Background expand</td><td>false</td><td>USA (GDPR)</td><td>1000</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Image quality improver: relight, enhance, upscale</td><td>false</td><td>USA (GDPR)</td><td>1000</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Object remover</td><td>true</td><td>EU</td><td>600</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Object replacer</td><td>true</td><td>EU</td><td>600</td><td>N/A</td></tr><tr><td><span data-option="2h6JloNmjQgs">Edition</span></td><td>Image artifacts remover</td><td>false</td><td>EU</td><td>10</td><td>N/A</td></tr></tbody></table>


# Users

View your Users and manage levels with the DAM through the Users section.

Within these pages you will learn about:

* [Users](/vxp-visual-experience-platform/settings/organisation/users/users) - managing and inviting users onto your DAM
* [Custom Levels](/vxp-visual-experience-platform/settings/organisation/users/custom-levels) - viewing available user levels and creating custom levels for your DAM


# Users

By managing User Profiles and attributes effectively, your team can maintain secure, streamlined access to DAM, ensuring the right people have the right tools to succeed.

## Purpose of the User Levels <a href="#invite-new-users" id="invite-new-users"></a>

The User Levels define what a user can and can not do within the company/project. The permissions these levels provide, are about Project Management. For Assets Management, please refer to the [Gallery Roles.](/digital-asset-management-dam/settings/storage/listing#default-gallery-role)

## Invite new users <a href="#invite-new-users" id="invite-new-users"></a>

You can invite new users to the DAM through the [**Invite Users**](https://hub.filerobot.com/settings/organisation/users/people) modal.

{% hint style="info" %}
In case multiple users (tens or hundreds) need to be invited in bulk, please [contact the Support team](https://www.scaleflex.com/contact-us) and provide a CSV file containing information about the email address, requested user level and the project access (global or only for specific tokens).
{% endhint %}

You can create users at the company level, granting access to all projects within the company or providing access to one or multiple projects at the project level.

### **User level**

In the DAM, a “user level” determines what a user can see and do within the platform.

{% hint style="info" %}
The user levels *Owner* and *Administrator* are only available for company-wide users as they have access to company-related information such as Billing or Organisation
{% endhint %}

| User level                       | Available menu                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| VXP Owner (company only)         | Only 1 user can be the Owner of the company. It has access to **all DAM pages & System Settings.** Also **-** to **all assets and folders stored in DAM,** no matter who created them and what are the visibility permissions.                                                                                                                                                                                                                                                                                                          |
| VXP Administrator (company only) | There could be multiple users with this User Level. They have **the same visibility and privileges** as the Owner. The only difference is that the Admins can not create other Admins or promote a new Owner.                                                                                                                                                                                                                                                                                                                           |
| VXP Accountant                   | This User Level has access only to the [Billing](/vxp-visual-experience-platform/settings/organisation/billing) section.                                                                                                                                                                                                                                                                                                                                                                                                                |
| VXP Manager                      | <p>The Managers have access to <strong>all DAM pages & System Settings except</strong> <a href="/pages/LV9TXA5oHZjgefGkhs7y">Billing</a> <strong>and</strong> <a href="/pages/thAADLp57GXjcCcJv3T1">Company</a> <strong>settings.</strong> <br>Limitations:</p><ul><li>Company-wide <em>Managers</em> can only manage users with lower levels than <em>Manager</em> in all company's projects.</li><li>Project-level <em>Managers</em> can only manage users with lower levels or raise another Manager in their own project.</li></ul> |
| VXP Developper                   | <p>The Developers have access to <strong>all DAM pages</strong> and the following menus from <strong>System settings:</strong></p><ul><li><p>DAM</p><ul><li>Metadata</li><li>Storage</li><li>Automations</li></ul></li><li>DMO</li></ul>                                                                                                                                                                                                                                                                                                |
| VXP Contributor                  | <p>The Contributors have no access to any <strong>System Settings.</strong></p><p>They can only see:</p><ul><li>Home</li><li>DAM (All pages except Labels page)</li></ul>                                                                                                                                                                                                                                                                                                                                                               |
| VXP Viewer                       | <p>The Viewers have no access to any <strong>System Settings.</strong> </p><p>They have restricted permissions for viewing and sharing data within in the DAM.<br>They can only see: </p><ul><li>Home</li><li>DAM (Assets, Folders, My favorites, and Sharebox only)</li></ul>                                                                                                                                                                                                                                                          |

### **Custom levels**

In addition to the standard level mentioned above, VXP administrators can create up to 5 custom levels and define which pages and menus will be available for each.

{% hint style="info" %}
Custom **company** levels are only available for company-wide users as they can have access to company-related information such as Billing or Company
{% endhint %}

{% hint style="info" %}
Custom **project** levels are available for company-level and project-level users (they don't have access to company-related information)
{% endhint %}

## User invitation flow

{% hint style="info" %}
Users can only invite lower-level users, except project-level VXP *Managers*, who can also invite other *Managers*.
{% endhint %}

<figure><img src="/files/7vnKBdkqQiChkVRVUUxM" alt="" width="375"><figcaption></figcaption></figure>

To invite new users:

1. Click **+ Invite Users** (single or bulk invites supported).
2. Fill in these details:
   1. Email address.
   2. Profile (User level).
   3. Access scope (entire company or specific projects).
3. Click “Send” to send the email invitation.

If the invitation is still not accepted, it will be visible with status "Pending". If it remains in this status, you have the following options:

* Resend the invite to remind the recipient.
* Cancel and re-invite if the email address was incorrect.

Once accepted, the invited user receives status "Active".

## Managing existing users <a href="#managing-existing-users" id="managing-existing-users"></a>

A user can only manage lower-level users, e.g. a VXP *Viewer* cannot manage a VXP *Manager*.

The following attributes are available for editing:

* User level
* Active or inactive status
* Access scope

{% hint style="warning" %}
Review user access quarterly to ensure permissions are up-to-date. Deactivate users who no longer need access to prevent security risks.
{% endhint %}

## Manage User Attributes

By default the users have email address and name. For the purpose of your project you can add additional attributes.

You need to go to the [People](https://hub.filerobot.com/settings/organisation/users/people) tab and to click on the `...` icon. Then to select "Manage User Attributes"

<figure><img src="/files/2Je1ATUsDvpdGVcu5EUk" alt=""><figcaption></figcaption></figure>

In the pop-up window that will open, you can check the current list of User Attributes.

New attributes can be added when you click on the `+ Add field` button. There are two data types which you can select for the new field:

* **Text** - the attribute value will be a simple text. This is applicable for fields that may have an unlimited number of unique values (for example, "Personal Address")
* **Select-one** - it appears as a drop-down list with predefined values where you can choose only 1 of them. This type is useful for fields where you would like to restrict the users to what values to fill in (for example, "Region", "Job Position", etc)

If you want to Edit or Delete an existing attribute, please click on the `...` icon next to the attribute name.&#x20;

{% hint style="info" %}
System attributes cannot be edited or deleted. They are marked with a lock icon - "First Name", "Last Name" and "Email".
{% endhint %}


# Custom Levels

The Roles page displays all current User Levels (roles) and their permissions within Scaleflex DAM.

## Creating Custom Levels

Custom levels allow you to tailor user permissions to your specific needs.

To create a custom level:

1. Click the **+ Add Profile** button.
2. Choose the scope:
   1. **Company**: Apply across all projects within the organization.
   2. **Project**: Apply only within a specific project.
3. Name the level.
4. Select the permissions you want to assign (e.g., managing users, approving assets, editing settings).

{% hint style="info" %}
You can create up to **five custom levels.**
{% endhint %}

The permissions are divided into several categories:

* Home - allows access to the settings for the Home page
* Top menu - allows access to the [DMO](/dynamic-media-optimization-dmo/welcome), [Portals](/portals/welcome) and [Analytics](/vxp-visual-experience-platform/settings/project/analytics) sections
* DAM - allows access to the [DAM](/digital-asset-management-dam/library) Gallery menu
* DMO - allows access to the [DMO](/dynamic-media-optimization-dmo/welcome) settings.
* Settings/ Organization - controls on the [Organization](/vxp-visual-experience-platform/settings/organisation) settings
* Settings/ Project - controls on the [Project](/vxp-visual-experience-platform/settings/project) settings
* Settings/ DAM - controls on the [DAM](/digital-asset-management-dam/settings) settings
* Settings/ DMO - controls on the [D](/dynamic-media-optimization-dmo/welcome)[MO](/dynamic-media-optimization-dmo/welcome) settings

Users with custom levels can edit the access of other users with standard levels, if they have the corresponding permission in their custom level (Settings/Organization => Users (read) => Users (write) )

<figure><img src="/files/WqWthNFAXOLV8xQdYQNx" alt=""><figcaption></figcaption></figure>

### Duplicate existing level

If you want to modify an existing level (e.g., enrich or limit one of the default VXP levels), you can duplicate it and adjust its permissions.

For that purpose you need to click on the `...` icon next to the corresponding role.&#x20;

The default company levels can not be deleted.

<figure><img src="/files/trvpWGpPG2HgcPXAycTJ" alt=""><figcaption></figcaption></figure>


# Teams

Scaleflex DAM allows you to group users in teams for easier role and permission management.

The settings for Team management are located at [*Settings > Organisation > Teams*](https://hub.filerobot.com/settings/organisation/teams).

Users with Manager, Admin and Owner [User levels](/vxp-visual-experience-platform/settings/organisation/users/users) have access to them.

<figure><img src="/files/PQBb1UvCB64ZR219Rc0i" alt=""><figcaption></figcaption></figure>

## Create a new Team

To create a new team, you can use the + *Add Team* button.

Give your team a meaningful name, choose the project(token) where it should apply, add a description, and upload an avatar.

{% hint style="info" %}
The new Team apply only to the selected project and can be used only in that project.
{% endhint %}

<figure><img src="/files/B58KcHTICTzCpzGoVXQn" alt="" width="375"><figcaption></figcaption></figure>

## Manage a Team

After a Team is created, you can find it in the list of existing teams. Click the `...` icon at the most-right part of the screen and choose "Manage".

<figure><img src="/files/3iEUSV9uiny5KHINAy5N" alt="" width="375"><figcaption></figcaption></figure>

Now, you can add team members from the list of existing users in the selected project. If the user hasn’t been invited to the project, or their invitation is pending, they cannot be added to a team.&#x20;

You can select and delete team members, which removes them from the Team, but their account will remain active in the project.

## Edit a Team's description

If you select option "Edit" from the `...` menu, you can rename the Team, modify its Avatar and Description.

## Delete a Team

Choosing option "Delete" from the `...` menu allows you to delete a team. The users who were part of this team will remain active in the current project.

## Best practises for Team Management:

* Use descriptive team names to reflect their purpose.
* Regularly review team memberships to keep them current and relevant.
* Before deleting a team, review its access or tasks to avoid workflow disruptions.


# Project

The Project section under Settings is where you will find the options to include brand identity, view your subscription, and apply analytics, and manage your access.

You can jump to the following sections to learn more.&#x20;

* [Branding](/vxp-visual-experience-platform/settings/project/branding)
* [Subscription](/vxp-visual-experience-platform/settings/project/subscription)
* [Analytics](/vxp-visual-experience-platform/settings/project/analytics)
* [Access](/vxp-visual-experience-platform/settings/project/access)


# Branding

Customize Scaleflex DAM's branding to match your brand preferences

<figure><img src="/files/c3meeJ8pYXIwkMonoITW" alt=""><figcaption></figcaption></figure>

### Project Name

Use this section to name your project. The name will be displayed at the top right corner of the DAM.&#x20;

### &#x20;Login page <a href="#login-page" id="login-page"></a>

This section allows you to customize the login page of your project

| Setting               | Description                                                                                                              |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Login page layout     | Select the layout of the login page                                                                                      |
| Background cover type | Select the background of the login page: color or an image                                                               |
| Cover                 | Select a background image if you have selected the image option or the main color, if you have selected the color option |

### Logo <a href="#logo" id="logo"></a>

| Setting      | Description                                                                                                                                             |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| company logo | Upload a project (or company) logo to be displayed on the top-left corner of the Asset Hub. You can add logos that accomodate to Light and Dark themes. |
| Favicon      | Upload a custom favicon to replace the default Scaleflex DAM favicon.                                                                                   |

### Theme <a href="#basic" id="basic"></a>

| Setting               | Description                                                             |
| --------------------- | ----------------------------------------------------------------------- |
| Theme                 | Select between Dark, Light and Custom theme.                            |
| Color                 | Add your own color-hex code to override the Asset Hub's default colour. |
| Default number format | Set the format for the thousands and decimal separators in numbers      |

### Email templates <a href="#basic" id="basic"></a>

You can customize the email templates to match sent to users when following events occur:

| Event category | Event types                                                                                                                                                 |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Hub login      | <ul><li>Invite user (Hub)</li><li>Lost password</li><li>Login MFA</li></ul>                                                                                 |
| Sharing        | <ul><li>Invite to Sharebox / Airbox</li></ul>                                                                                                               |
| Portals        | <ul><li>User self-registration</li><li>Invite user (Portals)</li><li>Confirm user</li><li>Validate user</li><li>Reject user</li><li>Portal update</li></ul> |

Clone the default email template and adapt the HTML as well as the plain text version of the email to meet your brand guidelines as well as messaging. You can also translate the templates in your organisation's language.


# Email Templates

Customize your email templates to include your logo, tailor the messaging to match your company's branding, or change the language to suit your users.

Email templates allow you to customize your messaging and branding to suit your audience better. These are the emails your users receive when they are invited to the Hub, request a password reset, are invited to a Sharebox or Airbox, or register for Portals.

You can find the email templates at the bottom of the **Branding** page in **Settings**.

{% hint style="info" %}
Note: Only users with the **Manager**, **Administrator**, or **Owner** role can access this page.
{% endhint %}

Click the three-dot menu on the right side of an email template to **View** or **Clone** the template.

<figure><img src="/files/C0EU3h76J1Gt57FFay9T" alt=""><figcaption></figcaption></figure>

When viewing an email template, you can:

* Preview the template layout.
* Edit the content.
* Change the logo.
* Send a test email.

When editing content in **Plain Text** mode, you can insert available variables that reference dynamic values such as the user's name, project name, date, and other relevant information.

<figure><img src="/files/V265oQcbYjB49AKq3ViU" alt=""><figcaption></figcaption></figure>


# Subscription

This section summarizes the Subscription page seen in the Settings bar.

The Subscription page lets you view and manage your current Scaleflex DAM subscription.&#x20;

In addition, you can view additional optional modules and services that Scaleflex provides.

<figure><img src="/files/f1erQnfTFtEWNt8yS504" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/8SSlgplOX0Phm5NTHKCx" alt=""><figcaption></figcaption></figure>


# Analytics

Enable standard dashboards to control usage and assets delivery.


# Standard Dashboards

DAM Standard Dashboard

{% hint style="info" %}
Dashboards visibility is managed in *Settings -> Project->*&#x41;nalytic&#x73;*->Standard Dashboard*
{% endhint %}

### **Introduction**

The **Standard Dashboards Configuration** section allows users to enable or disable various pre-built dashboards that help monitor and manage key asset delivery and usage areas. These dashboards provide insights into different aspects of the system, including CDN performance, optimization, storage, and more.\ <br>

| Dashboard Name     | Description                                                                         | State            | Purpose                                                                                      |
| ------------------ | ----------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------- |
| **Users & Teams**  | Provides insights into user activity, levels, and team management.                  | Enabled/Disabled | Monitor and manage user levels, team activities, and access levels.                          |
| **CDN & Delivery** | Monitors CDN performance and asset delivery.                                        | Enabled/Disabled | Track CDN efficiency and asset delivery speed and accuracy.                                  |
| **Delivery**       | Offers delivery-specific data like response times and geographical distribution.    | Enabled/Disabled | Analyze delivery metrics and ensure assets are served optimally to different regions.        |
| **Cache & CDN**    | Displays cache behavior and CDN optimization details.                               | Enabled/Disabled | Ensure proper caching strategies and CDN utilization to optimize performance.                |
| **Optimization**   | Tracks optimization metrics, including image conversions and asset size reductions. | Enabled/Disabled | Monitor the effectiveness of image and file optimization efforts to improve load times.      |
| **Top-ranking**    | Displays rankings for top-performing assets based on key performance metrics.       | Enabled/Disabled | Identify high-performing assets based on load times, views, and other important factors.     |
| **Webhooks**       | Provides insights into webhook activity and triggered events.                       | Enabled/Disabled | Track webhook usage and any events triggered by the webhooks.                                |
| **Storage**        | Monitors storage usage for assets, detailing the consumption of resources.          | Enabled/Disabled | Track storage utilization and get insights into which assets consume the most storage space. |

#### Example Workflow

* **Enable or Disable Dashboards**: Toggle switches are available for each dashboard.
  * **Enabled**: The dashboard is active and providing insights.
  * **Disabled**: The dashboard is inactive.


# Multi tenants

DAM Multi Tenants Dashboard

### Introduction

Purpose:

The Multi-Tenants Dashboard is designed to provide a comprehensive overview of traffic, image cache data and allowances for individual customers. This dashboard offers a granular view of customer usage per token.

#### &#x20;Filters

| Filter     | Description                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Tokens     | <p>Values: Tokens owned by the same company<br>Default value: All Tokens<br>Purpose: Specify tokens to view stats accordingly.</p>         |
| Date range | <p>Values: Date ranges with format DD/MM/YYYY<br>Default value: Last 30 days</p><p>Purpose: specify the time frame of the viewed stats</p> |

\
Graphs

| Graph name                                 | Description                                                                                                                 |
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
| Traffic & Image Cache allowances per token | It shows the current plan, storage allowance and Traffic allowance per token                                                |
| Traffic & Image Cache per token            | It shows the Number of Requests, Traffic, Maximum Cache value and Average Cache value per token for the selected time frame |
| Total Requests / Period                    | It shows total number of requests for the selected time frame and tokens.                                                   |
| Total Traffic / Period                     | It shows total CDN traffic for the selected time frame and tokens.                                                          |
| Total Image Cache / Period                 | It shows total image Cache for the selected time frame and tokens.                                                          |
| Global Traffic per day                     | It shows the total CDN traffic for a specific set of tokens, aggregated by day. for the selected time frame and tokens.     |
| Global Image Cache per day                 | It shows the total image cache for a specific set of tokens, aggregated by day. for the selected time frame and tokens.     |

&#x20;\ <br>


# User Dashboard

DAM users

### Introduction

Purpose:

The DAM Users Dashboard is designed to provide a comprehensive overview of user activity within the VXP (Visual Experience Platform). This dashboard offers valuable insights into user engagement, team dynamics, and overall system usage.

#### Filters

| Filter     | Description                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Date range | <p>Values: Date ranges with format DD/MM/YYYY<br>Default value: Last 30 days</p><p>Purpose: specify the time frame of the viewed stats</p> |

#### Graphs

| Graph name                               | Description                                                                                        |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------- |
| <p>Invited (activated) users</p><p> </p> | It shows the number of activated users per token for the selected time frame                       |
| Users logged in today                    | It shows the number of users logged in per token for the selected time frame                       |
| Invited (pending) users                  | It shows the number of pending users per token for the selected time frame                         |
| Number of teams with users               | It shows the number of activated users per token for the selected time frame                       |
| Most active users                        | It shows users with the most logins for the selected time frame and token.                         |
| Number of unique users logged-In per day | It shows number of unique users logged-in aggregated by day for the selected time frame and token. |
| Users per team                           | It shows the users per team. for the selected time frame and token.                                |


# DAM Storage

### Introduction

Purpose:

The DAM Storage Dashboard is designed to provide a comprehensive overview of storage usage and asset management within the VXP (Visual Experience Platform). This dashboard offers valuable insights into storage consumption, asset growth, and folder organization.

#### Filters

| Filter     | Description                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Date range | <p>Values: Date ranges with format DD/MM/YYYY<br>Default value: Last 30 days</p><p>Purpose: specify the time frame of the viewed stats</p> |

#### Graphs

| Graph name                                     | Description                                                                                 |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
| Current storage used                           | It shows the Current storage consumed per token                                             |
| Current number of assets                       | It shows the Current assets stored per token                                                |
| Current number of folders                      | It shows the Current number of folders per token                                            |
| Evolution of storage per period                | It shows storage evolution per day for the selected time frame and tokens.                  |
| Evolution of folders & assets count per period | It shows folders and assets count evolution per day for the selected time frame and tokens. |
| Number of files per directory                  | It shows Number of assets per folder, for the selected time frame and tokens.               |


# Workflows Monitoring

DAM Workflows Monitoring

### Introduction

Purpose:

The Workflows Dashboard is designed to provide a comprehensive overview of webhook and workflow activity within the VXP (Visual Experience Platform). This dashboard offers insights into event processing, task status, and overall workflow performance.

#### Filters

| Filter     | Description                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Date range | <p>Values: Date ranges with format DD/MM/YYYY<br>Default value: Last 30 days</p><p>Purpose: specify the time frame of the viewed stats</p> |

#### Graphs

| Graph name               | Description                                                                                                                                                                         |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Events per status        | It shows the number of events per status aggregated by time per token for the selected time frame                                                                                   |
| Events per assets        | It shows the number of events that have occurred per asset, providing insights into the workload associated with individual assets per token for the selected time frame            |
| Event throughput per day | It shows the throughput of events per day, offering information on the overall efficiency and capacity of the workflow system per token for the selected time frame                 |
| Active tasks             | It shows the status of active tasks within the workflow system, allowing for real-time monitoring and identification of potential bottlenecks per token for the selected time frame |
| Events history           | It shows access to the log history of events, enabling detailed troubleshooting and analysis of workflow behavior.                                                                  |


# Traffic Origin

Dam Traffic Origin

### Introduction

Purpose:

The Traffic Origin Dashboard is designed to provide a comprehensive overview of incoming requests to the VXP (Visual Experience Platform). This dashboard offers insights into the sources of traffic, referrer usage patterns, and overall request volume.

#### Filters

| Filter     | Description                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Date range | <p>Values: Date ranges with format DD/MM/YYYY<br>Default value: Last 30 days</p><p>Purpose: specify the time frame of the viewed stats</p> |

#### Graphs

| Graph name                          | Description                                                                                                                                                                                                                                                                |
| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Referrers overview / period         | <p>This table presents a comprehensive overview of incoming requests, describing the percentage distribution based on whether they are accompanied by referrers or are without referrers.</p><p>Also, it shows the daily Traffic and requests for the selected period.</p> |
| Top 10 referrers / period           | This table presents the top 10 Referrers requested for the selected period, broken down by the referrer domain, Also, it shows the daily Traffic and requests for the selected period, and the total number of requests for each referrer domain.                          |
| Top 10 referrer URLs (last 30 days) | This table displays the top requested Referrers in the last 30 days only also the associated traffic for each referrer.                                                                                                                                                    |


# Caching (Volumetry)

DAM Caching(Volumetry)

### Introduction

Purpose:

The Caching Dashboard is designed to provide a comprehensive overview of image cache data and edge requests. This dashboard offers a granular view of token usage.

#### Filters

| Filter     | Description                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Date range | <p>Values: Date ranges with format DD/MM/YYYY<br>Default value: Last 30 days</p><p>Purpose: specify the time frame of the viewed stats</p> |

#### &#x20;Graphs

| Graph name                              | Description                                                                          |
| --------------------------------------- | ------------------------------------------------------------------------------------ |
| Daily Image Cache                       | This graph shows the total value of the image cache per day                          |
| Cache average / period                  | This graph shows the average value of the image cache for the selected timeframe     |
| Cache minimum / period                  | This graph shows the minimum value of the image cache for the selected timeframe     |
| Cache maximum / period                  | This graph shows the maximum value of the image cache for the selected timeframe     |
| Daily Edge Requests                     | This graph shows the total number of edge requests per day in the selected timeframe |
| Requests total / period                 | This graph shows the total number of edge requests in the selected timeframe         |
| Average / day                           | This graph shows the average number of edge requests in the selected timeframe       |
| Peak (10-min burst)                     | This graph shows the peak number of edge requests in the selected timeframe          |
| Originals / Variants (Transformations)  | This graph allows to compare the number of original requests and their variants.     |
| Formats: Original vs Variants           | Number of Originals and Variants per format in the selected timeframe                |
| Daily Image Cache Originals vs Variants | This graph allows to compare the image cache of originals and their variants         |


# CDN performance

DAM CDN performance

### Introduction

Purpose:

The CDN performance Dashboard is designed to provide a comprehensive overview of CDN traffic data. This dashboard offers a granular view of token usage.

### Filters

| Filter     | Description                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Date range | <p>Values: Date ranges with format DD/MM/YYYY<br>Default value: Last 30 days</p><p>Purpose: specify the time frame of the viewed stats</p> |

### Graphs

| Graph name                     | Description                                                                                                 |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| Daily Request Count            | This graph shows you the total requests per day aggregated by cache type (HIT/MISS) in the specified period |
| HIT/MISS over period           | This graph shows total requests aggregated by cache type (HIT/MISS) in the specified period                 |
| Daily CDN Traffic              | This graph shows you the total traffic per day in the specified period                                      |
| Daily Traffic average / period | This graph shows you the average traffic in the specified period                                            |
| Daily Traffic peak / period    | This graph shows you the peak traffic in the specified period                                               |
| Total Traffic / period         | This graph shows you the total traffic in the specified period                                              |

&#x20;


# Custom Dashboard

DAM User Can request Custom Dashboard

{% hint style="info" %}
The Custom Dashboard is managed in *Settings -> Project->*&#x41;nalytic&#x73;*->Custom Dashboard Menu.*
{% endhint %}

### Introduction

Purpose:

The **Custom Dashboard Creation** page allows users to enable custom dashboards to gain insights about their assets. The interface offers input fields for creating a new dashboard, which includes providing specific identifiers and a quick seal.\ <br>

<figure><img src="/files/1XApmyOuJHnaf0WtGQSI" alt=""><figcaption></figcaption></figure>

**Features**

1. **Add Dashboard Button**: Users can add a new dashboard by clicking the "+ Add dashboard" button, which reveals input fields for configuration.
2. **Dashboard Input Fields**: Users must complete four key fields to create a dashboard successfully:
   * **Dashboard Name**: The display name of the dashboard.
   * **Page Identifier**: A unique identifier for the dashboard page.
   * **Dashboard Identifier**: A unique ID for the dashboard itself.
   * **Quick Seal**: A quick-access identifier for the dashboard.
3. **Save and Cancel**: Users can save the dashboard or cancel the creation process using the respective buttons after filling in the fields.


# Access

You will find the "access" page by going to Settings > Project > Access (page). From here, you will be able to manage access to your project, through API keys, custom security templates or OAuth2.


# API keys

Manage API keys for headless applications

{% hint style="info" %}
API keys allow to call of the Scaleflex DAM file management API and are suited for backend or headless applications where no user context is needed and where the key is not exposed to the browser
{% endhint %}

### Create new API keys <a href="#create-new-api-keys" id="create-new-api-keys"></a>

Authentication against the Scaleflex API is done with an API Secret Key, available under [Settings > Project > Access (page) > API keys (tab)](https://hub.scaleflex.com/settings/project/access/api-keys).

New API keys can be created with the *+Add key* button. On click, the user will be requested to:

* Enter the API key description so it can be easily identified
* Select the permissions to be attached with the API key (multi-selection from the permissions list) -- these define what the user will be able to do with the assets

#### **Permissions**

| API Permission             | Description                          |
| -------------------------- | ------------------------------------ |
| `OBJECTS_LIST`             | List assets                          |
| `OBJECTS_FETCH`            | Fetch assets                         |
| `FILE_UPLOAD`              | Upload file                          |
| `FILE_META_CREATE`         | Create file metadata                 |
| `FILE_META_CHANGE`         | Update file metadata                 |
| `FILE_RENAME`              | Rename file                          |
| `FILE_MOVE`                | Move file                            |
| `FILE_DELETE`              | Delete file                          |
| `FILE_SET_VISIBILITY`      | Set file visibility                  |
| `FILE_LABEL_CHANGE`        | Update file labels                   |
| `FILE_IMAGE_EDITOR`        | Edit file                            |
| `DIR_CREATE`               | Create directory                     |
| `DIR_RENAME`               | Rename directory                     |
| `DIR_META_CHANGE`          | Create and update directory metadata |
| `DIR_MOVE`                 | Move directory                       |
| `DIR_DELETE`               | Delete directory                     |
| `DIR_SET_VISIBILITY`       | Set dir visibility                   |
| `CONFIG_CHANGE`            | Change container configuration       |
| `CONFIG_LIST`              | List container configuration         |
| `FILE_PRODUCT_CHANGE`      | Change product information           |
| `FILE_PROCESS_AUTOTAGGING` | Perform autotagging                  |
| `COLLECTIONS_LIST`         | List collections                     |
| `COLLECTIONS_MANAGE`       | Manage collections                   |
| `LABELS_LIST`              | View labels                          |
| `LABEL_MANAGE`             | Manage labels                        |
| `OBJECTS_SHARE_MANAGE`     | Manage sharebox                      |
| `OBJECTS_AIRBOX_MANAGE`    | Manage airbox                        |
| `OBJECTS_APPROVAL_MANAGE`  | Manage approval                      |
| `OBJECTS_APPROVAL_VOTE`    | Approve/Reject assets                |
| `ACCESS_READ`              | View accesses                        |
| `ACCESS_MANAGE`            | Manage accesses                      |

### Manage Existing API Keys <a href="#manage-existing-api-keys" id="manage-existing-api-keys"></a>

Existing API keys can be managed individually or in bulk for status (Active <> Deactivate).&#x20;

| Setting     | Description                                                                                                                                                       |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Description | To identify the API keys                                                                                                                                          |
| Secret key  | The API key value. To be kept secret                                                                                                                              |
| Created at  | The API key creation date                                                                                                                                         |
| Active      | <p>The API key status that can be toggled from activated to deactivated using the ... options</p><p>Note:  If used, deactivated API keys will return an error</p> |
| Copy        | Copy the secret key in the clipboard for easy integration                                                                                                         |


# Security templates

Security templates let you control how and from where your assets can be accessed.

The Security templates ensure that only authorized users or apps can upload, download, or list files, with optional limits like time, IP address, or session length.

They are used to generate **SASS Keys**, which are ***temporary*** API access keys with configurable permissions and restrictions. Please refer to our [official API documentation](https://developers.scaleflex.com/#cdc2db95-6e17-4694-b850-12320f0f2f34) for steps on generating a SASS Key.

{% hint style="info" %}
The Security template's Secret Key cannot be used directly in API calls — generate a SASS Key first.
{% endhint %}

The Security Templates are accessible from [Settings > Project > Access (page) > Security template (tab)](https://hub.filerobot.com/settings/project/access/security-templates).

### Create a security template <a href="#create-a-security-template" id="create-a-security-template"></a>

Security Templates can be created with the *+Add Template* button by entering the following information

#### **Description**

Used to identify the security template

#### **Permissions**

Used to define what users can / can't do with the assets. Permissions are selected from the list:

| API Permission             | Description                          |
| -------------------------- | ------------------------------------ |
| `OBJECTS_LIST`             | List assets                          |
| `OBJECTS_FETCH`            | Fetch assets                         |
| `FILE_UPLOAD`              | Upload file                          |
| `FILE_META_CREATE`         | Create file metadata                 |
| `FILE_META_CHANGE`         | Update file metadata                 |
| `FILE_RENAME`              | Rename file                          |
| `FILE_MOVE`                | Move file                            |
| `FILE_DELETE`              | Delete file                          |
| `FILE_SET_VISIBILITY`      | Set file visibility                  |
| `FILE_LABEL_CHANGE`        | Update file labels                   |
| `FILE_IMAGE_EDITOR`        | Edit file                            |
| `DIR_CREATE`               | Create directory                     |
| `DIR_RENAME`               | Rename directory                     |
| `DIR_META_CHANGE`          | Create and update directory metadata |
| `DIR_MOVE`                 | Move directory                       |
| `DIR_DELETE`               | Delete directory                     |
| `DIR_SET_VISIBILITY`       | Set directory visibility             |
| `CONFIG_CHANGE`            | Change container configuration       |
| `CONFIG_LIST`              | List container configuration         |
| `FILE_PRODUCT_CHANGE`      | Change product information           |
| `FILE_PROCESS_AUTOTAGGING` | Perform autotagging                  |
| `COLLECTIONS_LIST`         | List collections                     |
| `COLLECTIONS_MANAGE`       | Manage collections                   |
| `LABELS_LIST`              | View labels                          |
| `LABEL_MANAGE`             | Manage labels                        |
| `OBJECTS_SHARE_MANAGE`     | Manage sharebox                      |
| `OBJECTS_AIRBOX_MANAGE`    | Manage airbox                        |
| `OBJECTS_APPROVAL_MANAGE`  | Manage approval                      |
| `OBJECTS_APPROVAL_VOTE`    | Approve/Reject assets                |
| `ACCESS_READ`              | View accesses                        |
| `ACCESS_MANAGE`            | Manage accesses                      |

#### **Upload limits** <a href="#manage-existing-api-keys" id="manage-existing-api-keys"></a>

These settings set limits on the Upload API.

| Setting                                     | Description                                                                                                                       | Default         |
| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| Limit per min (`limit_per_min`)             | Set the maximum uploads per minute with the key                                                                                   | Unlimited       |
| Limit per source IP (`limit_per_source_ip`) | Maximum number of uploads allowed by IP by the key                                                                                | Unlimited       |
| Directory scope (`dir_scope`)               | Directories where the key is allowed to upload. If you want to allow all subdirectories of a /folder, set the value to /folder/\* | All directories |

\
**Restrict IP limitation**

It restricts API calls based on IP address ranges and/or countries.

<table><thead><tr><th width="264">Setting</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td>Whitelist IP ranges (<code>whitelist_ip_ranges</code>)</td><td>IP addresses allowed to perform requests using this SecurityTemplate</td><td>No restrictions</td></tr><tr><td>Whitelist countries (<code>whitelist_countries</code>)</td><td>If the IP address is detected to come from these countries, they are allowed to make requests to the system</td><td>All countries are allowed</td></tr></tbody></table>

#### **Key Validity**

This setting allows to set the validity period of the key, for example to match the user's session length in your authenticated application

| Setting               | Description                            | Default             |
| --------------------- | -------------------------------------- | ------------------- |
| `expiration_duration` | time in seconds before the key expires | 1200 s (20 minutes) |

#### **Listing Limits**

Directories where the key is allowed to list elements.&#x20;

| Setting           | Description                                                                                                                                       | Default         |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| `directory_scope` | Directories where the key is allowed to list and search assets. If you want to allow all subdirectories of a /folder, set the value to /folder/\* | All directories |

### Manage existing Security templates <a href="#manage-existing-security-templates" id="manage-existing-security-templates"></a>

Once created, the Security templates can be activated, deactivated, or deleted. Bulk actions are available for managing multiple templates at once.

| User level  | Description                                                                                            |
| ----------- | ------------------------------------------------------------------------------------------------------ |
| Description | To identify the Security template                                                                      |
| Secret key  | The Security Template value. To be kept secret                                                         |
| Created at  | The Security Template creation date                                                                    |
| Scope       | Used to limit the scope. Value "project" by default.                                                   |
| Active      | The Security template status that can be toggled from activated to deactivated using the `...` options |
| Copy        | Copy the secret key in the clipboard for easy reuse                                                    |


# OAuth2

OAuth2 allows external websites or applications to access resources hosted by Hub on behalf of a user.

OAuth2 authentication is a more secure and complex authentication method that allows users to grant limited access to their resources without exposing their credentials.

{% hint style="info" %}

* Only users with **admin** or **owner** levels (roles) have access to the OAuth2 page in Settings
  {% endhint %}

|                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                          |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| OAuth 2 login URL  | Read only input field which providing a link to Hub OAuth2 login page and could be used on external website.                                                                                                                                                                                                                                                                                                                                                                                                                |                          |
| Service Name       | Input field to add name of the service which will appears on *OAuth2 login page.*                                                                                                                                                                                                                                                                                                                                                                                                                                           |                          |
| Communication Type | <p>Section where the communication type can be selected to define how the Hub will interact (sending session data) with an external section.<br><br>There are two options: <br></p><ul><li><strong>Post message</strong> - a common way for OAuth2 login when data is sent by <code>window\.opener.postMessage(JSON.stringify(data))</code></li><li><strong>Redirect</strong> - communication type to send session\_uuid in URL via redirect <em>(e.g. <https://redirect.com/oauth2/success?session_uuid=…>)</em></li></ul> |                          |
| Example            | <p>Section to simplify integration</p><ul><li>Code block content is different based on selected <em>Communication type (Post message                                                                                                                                                                                                                                                                                                                                                                                        | Redirect)</em></li></ul> |


# Library

This documentation section is dedicated exclusively to Scaleflex DAM. You can access the DAM directly from the top left menu in your VXP hub, to the right of the "home" tab, you will see the "DAM" tab. Once you've clicked on it, you will find yourself within Scaleflex's Digital Asset Management portal.

&#x20;

<figure><img src="/files/DKemmXueubXA101bE63p" alt=""><figcaption></figcaption></figure>


# Assets

DAM Assets Management

### Upload assets

Upload assets in bulk from your local computer or various external sources.<br>

### Overview

The Uploader lets you upload assets in the DAM from a variety of sources:

* Your device's storage, camera or screen
* Web links
* Third-party sources include Google Drive, Dropbox, Instagram, and many others.

You can drag & drop, copy & paste or browse to the file's location to select it for upload:

<figure><img src="/files/p5TdbwskoXN07R17SBhR" alt=""><figcaption><p>Multiple source uploading made easy</p></figcaption></figure>

### Transform assets during upload

You can transform your assets as part of the upload process.

<table><thead><tr><th width="295">File type</th><th>Available operations</th></tr></thead><tbody><tr><td><code>images</code></td><td><ul><li><em>Resize</em> - set the maximum width and height for the image to be resized after upload.</li><li><em>Edit image</em> - crop; adjust the brightness, contrast and other attributes; add filters; draw on the image; or add watermarks. </li></ul></td></tr><tr><td><code>videos</code></td><td><ul><li>You can change the resolution automatically or to fit a specific device type (desktop, mobile, tablet, etc.)</li><li><em>Transcode</em> - generate HLC manifest files for adaptive streaming. </li></ul></td></tr><tr><td><code>any type</code></td><td><ul><li><em>Rename</em> - by clicking once on the filename or selecting <em>Rename</em> from the context menu</li><li><em>Manage details</em> - by choosing the <em>Manage</em> option from the context menu.</li><li><em>Add metadata</em> - by pressing the <em>Fill metadata</em> button.</li><li><em>Remove</em> the file - cancel upload of the file</li><li><em>Add more files</em> for upload</li></ul></td></tr></tbody></table>

<figure><img src="/files/m6mzgZVhdRg10VwZ2IMu" alt=""><figcaption></figcaption></figure>

### Monitoring upload progress <a href="#monitoring-upload-progress" id="monitoring-upload-progress"></a>

Once you click the *Upload* button, a progress icon is shown on each asset, as well as an overall *Progress bar* underneath the *Upload modal*, showing the cumulative progress of all assets:\ <br>

<figure><img src="/files/hf7oWL1BsCv4tIwGMB1F" alt=""><figcaption></figcaption></figure>

### Upload results <a href="#upload-results" id="upload-results"></a>

There are three possible end states and relevant actions:<br>

| State                                                                                      | Asset highlighting                                                                                                                                                                                                                                                                                                                                         | Available actions                                                                                                                                                            |
| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Successfully uploaded*                                                                    | ![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FoDUCufL8EPRHWp32YITK%252Fimage.png%3Falt%3Dmedia%26token%3D326c1eb1-0e67-44da-8f5c-c2f302470b83\&width=300\&dpr=4\&quality=100\&sign=c037f544\&sv=1) | <ul><li>See Manage assets to continue</li></ul>                                                                                                                              |
| *Failed to upload*                                                                         | ![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F8m1PobJQUvgvovstxuJV%252Fimage.png%3Falt%3Dmedia%26token%3D3f1b2ba3-f297-451f-b4ad-4b13d05f0d8a\&width=300\&dpr=4\&quality=100\&sign=802a1842\&sv=1) | <ul><li><strong>Remove</strong> the file</li><li><strong>Retry the upload</strong></li></ul>                                                                                 |
| *Duplicate detected* (*see* Storage *for possible system policies on duplicate detection*) | ![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F4sj9k5nax5hZPWr6cjWW%252Fimage.png%3Falt%3Dmedia%26token%3D233e3376-8bc4-4a68-87ba-8c4fd01da06b\&width=300\&dpr=4\&quality=100\&sign=8b1c318d\&sv=1) | <ul><li><strong>Remove</strong> the file</li><li><strong>Show file location</strong> (only available if the <em>Duplicate policy</em> is set to <em>Override</em>)</li></ul> |


# Asset Details window

View and manage your asset through the Asset Details window.

<figure><img src="/files/JTqUtj3nxji2jfqgR8PP" alt=""><figcaption></figcaption></figure>

The Asset Details window allows you to peruse and edit all the information pertaining to the asset, modify the media (if it's in a supported format), publish the asset and more.

All the information about the asset is organised in vertical tabs:

|                                                                                                                   |
| ----------------------------------------------------------------------------------------------------------------- |
| [General](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/general)       |
| [Metadata](/digital-asset-management-dam/settings/metadata)                                                       |
| [Variations](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/variations) |
| [Comments](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/comments)     |
| [Approvals](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/approvals)   |
| [History](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/history)       |

All the available actions are at the top:

|                                                                                                                                                  |
| ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Regional settings](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/regional-settings)                           |
| [Context menu (`...`button)](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/context-menu-...-button)            |
| [Add to my favorites (❤ button)](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/add-to-my-favorites-heart-icon) |
| [Edit media (image, video, etc)](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/edit-media-image-video-etc)     |
| [Publish / Share](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/share)                                         |


# Asset actions

You can perform the following actions from the Asset Details window:

|                                                                                                                                                  |
| ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Regional settings](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/regional-settings)                           |
| [Context menu (`...`button)](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/context-menu-...-button)            |
| [Add to my favorites (❤ button)](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/add-to-my-favorites-heart-icon) |
| [Edit media (image, video, etc)](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/edit-media-image-video-etc)     |
| [Publish / Share](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/share)                                         |


# Regional settings

Regional settings allow you to view the asset information for a particular region / locale - whether it be language, currency or anything else that is configured in the Metadata settings.

If Metadata <mark style="color:blue;">Variants</mark> are configured for your project, you can view the asset according to a selected locale - including language, currency or anything else that is configured.

{% hint style="info" %}
For example, if a project uses English and French metadata or tags in each language, you can use this setting to view the information corresponding to the selected language.&#x20;
{% endhint %}

<figure><img src="/files/hUMhohAPsOXp0wotL7kI" alt=""><figcaption></figcaption></figure>


# Context menu ("..." button)

Use the context menu to perform various actions on an asset in the Asset Details window.

Next to the Regional settings, you will find three dots '...' button with which you can access a menu of actions you can perform on the asset:

| Action                                       | Definition                                                                                                                                                                                 |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Download                                     | Download the asset in its original form, as a transformed image with different resolutions and file types, or export its metadata or CDN link in a CSV file.                               |
| Share                                        | Publish the asset to enable public CDN links, share it via [Sharebox](/digital-asset-management-dam/library/sharebox) or Embed the link in a webpage and manage access for users and teams |
| + Add to                                     | Add the asset to My favorites list or to the Download cart                                                                                                                                 |
| Labels                                       | Attach labels to categorize and group assets, making them easier to organize and find later.                                                                                               |
| Edit media (image / video / design template) | Use the built-in Editor to adjust or enhance the media asset directly within the platform.                                                                                                 |
| Comments                                     | Access the comments to make a note on the asset.                                                                                                                                           |
| More actions                                 | Locate where the asset is stored within the DAM or manage its approval status for team workflows.                                                                                          |
| Rename                                       | Change the name of the asset                                                                                                                                                               |
| Move to                                      | Move the asset to another folder in the DAM                                                                                                                                                |
| Delete                                       | Remove the asset from the DAM                                                                                                                                                              |

<figure><img src="/files/tnX054wj4k2ymRlPYvld" alt=""><figcaption></figcaption></figure>


# Add to My favorites (heart icon)

Save assets to My favorites for quick access later.

Click the heart icon in the top menu of the asset window to add an asset to your personal [**My Favorites**](/digital-asset-management-dam/library/my-favorites) list.

{% hint style="info" %}
My Favorites are unique to each user and are not shared with the entire company. This helps you keep track of assets that are important to you.
{% endhint %}

<figure><img src="/files/XEqL6OskHg4b6l1Az59u" alt=""><figcaption></figcaption></figure>


# Edit media (image, video, etc)

Leverage the Scaleflex Media Editors to edit images, videos and more directly in the browser

In Scaleflex DAM you can manipulate your media files to get them just right for your needs.

Browse the relevant media subpage to learn more:

* [Edit image](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/edit-media-image-video-etc/edit-image)
* [Edit video](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/edit-media-image-video-etc/edit-video)
* [Edit design template ](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/edit-media-image-video-etc/edit-design-template-coming-soon)
* [Edit assets metadata via CSV](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/edit-media-image-video-etc/edit-assets-metadata-via-csv)


# Edit image

Leverage the in-built Image Editor to adjust or enhance your image asset directly within the platform

If you have an image asset (jpg, png, webm, etc) you can modify it with the in-built Image Editor in a multitude of ways, including cropping, resizing, applying filters or watermarks, and so on. You can save the results as a new version of the main image or as an entirely new asset.

### Edit image

Click the **Edit image** button from the context menu or in the Asset Details window to open it in the Image Editor.

<div><figure><img src="/files/1PUmHx43ybzrzMi4IXj5" alt=""><figcaption></figcaption></figure> <figure><img src="/files/JTqUtj3nxji2jfqgR8PP" alt=""><figcaption></figcaption></figure></div>

The Image Editor is a feature-rich inline image editor that supports the most commonly used image editing function of image editing software:

<figure><img src="/files/OUmRSCDRjG1xFEKEs3tQ" alt=""><figcaption></figcaption></figure>

| Feature   | Available Options                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Adjust    | <ul><li><em>Custom</em> - choose from predefined crop sizes, including common formats for social media banners, logos, and more</li><li><em>Rotate</em> - option to rotate the image per 90 degrees</li><li><em>Flip X</em> - flip the image horizontally</li><li><em>Flip Y</em> - flip the image vertically</li></ul>                                                                                                                                                                                            |
| Resize    | Manually set your image's width and height or drag to resize using your mouse.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Finetune  | <p></p><ul><li><em>Brightness</em>—Control how light or dark your image appears.</li><li><em>Contrast</em> - Increase or decrease the contrast between light and dark areas.</li><li><em>HSV</em>—Adjust the color (Hue), intensity (Saturation), and brightness (Value) of your image to create the desired look.</li><li><em>Blur</em> - Soften the focus for a smoother look.</li><li><em>Warmth</em>—Balance the temperature of your image between warmer (red/yellow) or cooler (blue/green) tones.</li></ul> |
| Filters   | Select from more than 40 filters to enhance your images.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Watermark | <ul><li><em>Add watermark</em> - add an already uploaded watermark image to your asset</li><li><em>Upload watermark</em> - choose an image to be applied as a watermark</li><li><em>Add as text</em> - create a watermark of your choice, applying it as a free text to your image</li></ul>                                                                                                                                                                                                                       |
| Annotate  | Sketching tool                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |


# Edit video

The **Edit video** feature allows you to modify video files directly within the Asset Details window or via the "right click" menu in the Library.&#x20;

Just like with images, you can adjust basic properties and trim content, then save the modified output as a `new version` or a `new file`.

In order to make surgical edits or quicker ones, you can modify the play speed from 0.25x to 2x, by selecting it in the bottom right corner as shown below *(note that this setting is valid for the player only and is not modifying the actual output video speed)*.

<figure><img src="/files/5pTKDJJWgzttNf19fNAW" alt="" width="148"><figcaption></figcaption></figure>

Operations overview:

1. Adjust
   1. Reframe (standard ratio and social media presets)
   2. Rotate (angle in degrees)
   3. Flip X (letf/right) and Y (top/bottom)

<div><figure><img src="/files/HoXDVyQhz3Aeaa3k1LDD" alt=""><figcaption><p>Flipping the orientation</p></figcaption></figure> <figure><img src="/files/e8LEOjBmteRQKttq3ERE" alt=""><figcaption><p>Making an IG post frame</p></figcaption></figure></div>

2. Trim
   1. Modify start & end
   2. Split (cut from middle of the video)

<figure><img src="/files/MSRtUMJoxPtJmajJSJSb" alt=""><figcaption><p>Splitting allows to save independent clips</p></figcaption></figure>

3. Resize
   1. Width & height
   2. Aspect ratio lock - whether to keep the aspect ratio when changing any dimension

<figure><img src="/files/3cjqPXa60th97RKkAo5j" alt=""><figcaption></figcaption></figure>


# Edit design template (coming soon)

Coming before end of 2025!


# Edit assets metadata via CSV

Update metadata for multiple files at once by uploading a CSV. Learn how to structure your file, which fields are supported, and how to validate changes before applying them.

## Overview

This feature allows you to update the metadata of multiple files in bulk by importing a CSV file. It is useful when you need to edit tags, titles, descriptions, or custom fields across many files quickly.

### When to use this feature

Editing metadata via CSV is useful in the following cases:

* bulk metadata assignment after upload of multiple files
* correction of any metadata mistakes across multiple assets
* renaming multiple files
* moving multiple files to a new folder as an alternative to the standard "Move" action from the context menu

### Prerequisites

* a software tool for editing CSV files (Excel, Google Sheets, Numbers, etc)
* [Gallery permission](/digital-asset-management-dam/library/folders#steps-for-managing-folder-access) to edit the assets metadata in the relevant folder
* get to know [the project's metadata structure](https://hub.scaleflex.com/settings/dam/metadata/assets)
* read the section about [the accepted format of the values](#structure-of-the-csv-file)
* before editing metadata, review your team's metadata guidelines to ensure consistent usage of tags, titles, and values
* (optional) get a text editing tool that allows you to open the CSV file as a simple text file - it is useful for troubleshooting purposes in case of any unexpected issues in the CSV processing

### CSV format requirements

The CSV (Comma-Separated Values) file is a format that may contain comma (`,`), semi-colon (`;`) or pipe (`|`) as a column separator.

{% hint style="warning" %}
The "Edit via CSV" feature works when comma is used as a delimiter.
{% endhint %}

Some software tools for editing CSV files tend to overwrite the default column separator. It means that the initial file might be downloaded as comma-separated, but after saving the changes, the tool may convert it to a semicolon-separated file. These files may cause issues. DAM will likely reject them during upload.

Steps how to troubleshoot such problems, if they appear on your device, are described in [What to do if the updated CSV is semi-colon separated and DAM doesn't accept it?](#what-to-do-if-the-updated-csv-is-semi-colon-separated-and-dam-doesnt-accept-it)

## How to edit metadata via CSV

### Step 1: Download the initial CSV file

First, you need to select the files that require editing. They can be:

* the content of a specific folder - in this case, go to Folders view and navigate to the target folder. Then open the context menu and choose "Edit files via CSV"
* the files uploaded in a specific period, files that contain a specific value in a metadata field, files with a specific label, My favourites, etc - in this case, apply the corresponding filters in the Assets view in order to get only the files that require changes. Scroll to the bottom of the page to load all results. For large volumes of  results (50+), lazy loading may be triggered, so you need to scroll to the very end of the results set. Click on "Select all visible files" and then choose option "Bulk edit via CSV"

Once the files are selected, download the CSV file containing their existing metadata.

<figure><img src="/files/2Uqt43ZW9Kj4GjlaKMxt" alt="" width="188"><figcaption></figcaption></figure>

### Structure of the CSV file

<details>

<summary>System metadata fields</summary>

<table><thead><tr><th width="119.6197509765625">Field</th><th width="281.701171875">Description</th><th>Editable?</th></tr></thead><tbody><tr><td>Item type</td><td>Information if the record describes a FILE or a FOLDER</td><td>Non-editable</td></tr><tr><td>Path</td><td>File location in DAM.</td><td><p>Editing the folder path will move the file.</p><p>Editing the filename will rename it.<br><br>Caution: Renaming or moving files may affect links, embeds, or published content that rely on the original location or filename.</p></td></tr><tr><td>CDN Link</td><td>The CDN link where you can access the optimised, publicly available version of this file (no CDN link for Private assets and Folders).</td><td>Non-editable</td></tr><tr><td>Mime type </td><td>The MIME type of the file (jpeg, png, pdf, txt, etc).</td><td>Non-editable</td></tr><tr><td>Size</td><td>The asset's size in bytes</td><td>Non-editable</td></tr><tr><td>SHA1</td><td>The sha1 value of the asset. A unique identifier for the asset content.</td><td>Non-editable</td></tr><tr><td>UUID</td><td>The unique identifier of the asset in DAM.</td><td>Non-editable</td></tr><tr><td>Created at</td><td>The date when the file has been uploaded. In <code>yyyy-MM-dd hh:mm:ss</code> format.</td><td>Non-editable</td></tr><tr><td>Updated at</td><td>The date when the file has been edited for last time. In <code>yyyy-MM-dd hh:mm:ss</code> format.</td><td>Non-editable</td></tr><tr><td>Visibility</td><td><p>It could be:</p><ul><li> <code>inherited</code> - sharing the same visibility settings as the ones of the parent folder.</li><li><code>public</code> - visible to everyone. </li><li><code>private</code> - restricted access. </li></ul></td><td>Editable.<br>Caution is advised to avoid exposing protected data or disrupting public asset delivery.</td></tr></tbody></table>

</details>

<details>

<summary>General metadata fields</summary>

| Field       | Description                              | Editable? |
| ----------- | ---------------------------------------- | --------- |
| Title       | Title of the file(if any)                | Editable  |
| Description | Description of the file content (if any) | Editable  |

{% hint style="info" %}
[If Regional variants are enabled for your project and it has several Languages](https://hub.scaleflex.com/settings/dam/metadata/assets), each of these fields will appear in a separate column for each of the configured languages.
{% endhint %}

<figure><img src="/files/mntmQhP0GWwJSsona6AR" alt="" width="563"><figcaption></figcaption></figure>

</details>

<details>

<summary>Custom metadata fields</summary>

The next part of the CSV consists of [a list of custom metadata fields and their language variations (if any)](https://hub.scaleflex.com/settings/dam/metadata/assets). The custom metadata fields are specific to every project.

{% hint style="warning" %}
When editing metadata in multiple languages, make sure each language-specific column contains relevant, localized content. Empty values in one language will not copy from another automatically.
{% endhint %}

</details>

## Step 2: Modify the CSV file

As a general rule, it is good to review [the metadata structure of your project](https://hub.scaleflex.com/settings/dam/metadata/assets) so to know what kind of values are expected in every field.

In case some metadata field is set with "Regional Variant: Languages", there will be a dedicated column for every language configured for the project.

<details>

<summary>Accepted values for the custom metadata fields</summary>

* Short/Long text type - use plain text without line breaks and new line symbols to avoid CSV parsing issues.
* Numbers - only whole numbers are accepted. No decimal values like `123.00`
* Booleans - accepts only `true` or `false`&#x20;
* List (single select) - only existing values are accepted. Invalid values will be replaced with "-" (none).
* List (multiple select) - several values can be provided, separated by `;` In the same way, like the rule for the Single-select lists, the value should already exist in the metadata structure.&#x20;
* Date - should be supplied in format yyyy-MM-dd
* Tags - this kind of field accepts new values that may not currently exist in the project metadata structure. Supply the tag values separated by `;`

{% hint style="warning" %}
As a good practice, always check if there is an existing variant for the tag value, so not to create duplicated tags and inconsistency in the project (for example, to have assets tagged with `winter-campaign`  and another set of assets tagged with `WinterCampaign` )
{% endhint %}

</details>

## Step 3:  Upload the updated CSV to apply metadata changes

## Metadata validation

Even if you modify some of the non-editable fields, DAM will not reflect the changes.

If you submit an invalid list option for the Single-select and Multi-select List custom fields, the CSV will be uploaded, but the value in these fields will become `-`  (none)

Empty cells will not replace an existing metadata value in DAM.

Change in the folder's path of the asset would result in moving the file to the new location (and eventually creating a new folder if it does not already exist in the Folders structure)

A change in the filename would result in renaming the file.

The updated CSV can be renamed; however, its first line (the Headers row) should always remain unchanged.

Up to 50 000 assets can be updated in a single CSV file.

{% hint style="warning" %}
As a general rule, before attempting bulk edit of hundreds or thousands of metadata values and files, test the changes using a CSV with 1-2 records only. Inspect the results and ensure the updated metadata values match your intentions.  \
This approach would protect you from inadvertently modifying a very large number of assets in a non-desired way.
{% endhint %}

## Troubleshooting common issues during CSV edit

{% hint style="warning" %}
Always save the edited CSV file as a new document and keep the original version of the downloaded CSV. In that way, if some mistake happens and some assets are unintentionally edited, you have a back-up and you can always upload the initial CSV and restore the initial metadata structure.
{% endhint %}

<details>

<summary>What to do if the updated CSV is semi-colon separated and DAM doesn't accept it?</summary>

In order to verify what the column separator of the file that your software tool is creating is, you can open the edited version with any text-editing tool that will show the CSV content as simple text. In that way, you can inspect what is the delimiter of your file.

If your CSV-editing tool is creating semi-colon separated files on Save, you need to modify the way your laptop is showing the Numbers format.

For Windows:

1. Open Windows regional settings.
2. Inspect the Numbers variant set for your device and set it to show the decimal numbers with a dot (`.`).&#x20;

For Mac:

1. Open "System settings" -> "Language & Region"
2. Set the "Number format" to `1234567.89` (to use dot, not comma)

</details>

<details>

<summary>Some metadata fields are not updated</summary>

1. [Check](#structure-of-the-csv-file) if the metadata field is editable or not
2. For custom metadata fields that are Single-select or Multi-select type, open the [Metadata structure](https://hub.scaleflex.com/settings/dam/metadata/assets) of the project -> find the problematic field and click on "Edit"
3. Then, inspect if the non-updated value is in the list of existing values.
4. If not, please create it and save the changes.
5. After updating the field values, re-upload the CSV file.

<figure><img src="/files/qR07gpPbtckQbcegTzHI" alt=""><figcaption></figcaption></figure>

</details>


# Share

Use the share menu from the Asset Window as a quick way to share assets.

You can Publish or Unpublish your asset from this menu and manage its visibility.&#x20;

In addition, this menu provides options to share your asset through[Sharebox](/digital-asset-management-dam/library/sharebox), a CDN link, or embed in website.&#x20;

<figure><img src="/files/CdDQYXA3yt2BkNLekAGM" alt=""><figcaption></figcaption></figure>


# Asset information tabs

All available asset details are organised in different categories, grouped in tabs:&#x20;

|                                                                                                                   |
| ----------------------------------------------------------------------------------------------------------------- |
| [General](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/general)       |
| [Metadata](/digital-asset-management-dam/settings/metadata)                                                       |
| [Variations](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/variations) |
| [Comments](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/comments)     |
| [Approvals](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/approvals)   |
| [History](/digital-asset-management-dam/library/assets/asset-details-window/asset-information-tabs/history)       |


# General

The first information seen when viewing an asset through the Asset window, this provides the overall basic information of the asset.

<figure><img src="/files/eCCCQkHmEkhhTEnoJ9Ci" alt=""><figcaption></figcaption></figure>

The General Information tab provides the following information about the current asset you are viewing:&#x20;

<table><thead><tr><th width="222.29296875">Tab</th><th>Description</th></tr></thead><tbody><tr><td>Type</td><td>This displays the format of the asset</td></tr><tr><td>Size</td><td>This displays the file's weight, in MBs.</td></tr><tr><td>Resolution</td><td>The dimensions of the asset -width &#x26; height.</td></tr><tr><td>Location</td><td>Location of asset within the DAM</td></tr><tr><td>Labels</td><td>Displays if any labels are attached to the asset</td></tr><tr><td>Focus point</td><td>Sets a gravity (focus) target for image cropping</td></tr><tr><td>Orientation</td><td>Displays in which orientation the asset is in (landscape/portrait)</td></tr><tr><td>Visibility</td><td>If the asset is public or private</td></tr><tr><td>Main colors</td><td>This displays the main colors seen within the asset</td></tr><tr><td>Dominant color</td><td>This displays the most dominant color spotted within the asset</td></tr><tr><td>Created at</td><td>Creation date of the asset within the DAM</td></tr><tr><td>Created by</td><td>The user who created the asset in the DAM</td></tr><tr><td>Modified at</td><td>Last date when the asset was edited or its metadata has been changed.</td></tr><tr><td>Expiry date</td><td>The date when the asset expires (in the context of the business use-case of the project)</td></tr><tr><td>Approval status</td><td>The asset's status in the Approval workflow</td></tr><tr><td>UUID</td><td>The file UUID</td></tr><tr><td>Name</td><td>Defines the name of the image.</td></tr><tr><td>Title</td><td>Defines the title of the image .</td></tr><tr><td>Description</td><td>The user can describe the image description.</td></tr><tr><td>Tags</td><td>The user can create tags, generate AI-suggested automated tags, and, at that same time delete all the tags using clear all button.</td></tr></tbody></table>


# Metadata

The asset's custom defined or embedded metadata

The Metadata tab holds information about the asset's custom defined or embedded metadata and is organised in 2 relevant sub-tabs.

## Custom-defined metadata

You can create and customize metadata fields to fit your needs. These fields are categorised and apply to all assets within a specific Scaleflex DAM project (token). If you manage multiple projects, each can have its own unique metadata structure.

The Custom metadata fields are visible in the asset management modal, tab **Metadata -> Custom**.

[<mark style="color:blue;">See Managing metadata.</mark><br>](/digital-asset-management-dam/settings/metadata/metadata-configuration)

<figure><img src="/files/YPOyAeldYMAOvxZzoQD0" alt=""><figcaption></figcaption></figure>

## Embedded metadata

Embedded metadata is stored within the asset itself and remains with it when the file is shared or downloaded. Various software tools can access and read this metadata. Examples of embedded metadata include GPS coordinates, the author's name, camera details, and more.&#x20;

Scaleflex DAM can extract embedded metadata, even from custom namespaces (e.g. model name, product category), and map them to fields in the [**Custom metadata**](#custom-defined-metadata) section.

To enable embedded metadata extraction:

1. Go to **Settings > DAM > Automations**.
2. Enable the **Extract embedded metadata** post-process.

<figure><img src="/files/VrQsCEUVzkVkXxWB69ty" alt=""><figcaption></figcaption></figure>

Once enabled and saved, embedded metadata will be automatically extracted upon file upload and displayed in the **Metadata -> Embedded** tab of the asset management modal.

<figure><img src="/files/rWHRo6PbcfcCH8BNWnKP" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
To use embedded metadata for search or collection grouping, [contact our support team](https://scaleflex.zendesk.com/hc/en-gb/requests/new) to enable the mapping between embedded and custom metadata.
{% endhint %}


# Variations

Variations are dynamically generated transformations of an origin asset.

{% hint style="info" %}
Transformations are dynamic file changes that are applied via URL query string parameters. Examples:

* change of the file format (JPG -> WebP; MP4 -> WebM)
* resizing (crop, fit, trim, padding)
* applying filters (grayscale, brightness, background color)
* adding a watermark
* generative AI (plate blurring; background removal; background expanding; etc)
* video transformations (compression; transcoding)
  {% endhint %}

Transformations are not saved as separate files in the DAM storage. They are created by the processing servers on-the-fly when a user requests the asset (e.g opening some image URL in the browser).

If you frequently use the same transformations, you can save them as Variations for faster reuse.

{% hint style="info" %}
A Variation is a saved transformation which allows faster access and convenience when you need to download it or to copy its CDN link.
{% endhint %}

### Use cases where Variations are applicable

* Generate multiple resizings of an image, dedicated for different channels or marketplaces
* Collect optimized versions of a file in one place, without duplicating the original and managing several copies of the same content.
* Standardize output formats and ensure all teams work with the same file content

#### Creating a variation for a single image <a href="#creating-transformation-for-a-single-image-via-the-image-editor" id="creating-transformation-for-a-single-image-via-the-image-editor"></a>

1. Select a file and double-click it to open the asset management window
2. Go to the **Variations** tab.
3. Click the **+ Add variation** button to create a new variation using the [Image Editor.](/dynamic-media-optimization-dmo/transformations/image-optimization)

<figure><img src="/files/2DbPAP50Wq3BOSexuLYM" alt=""><figcaption></figcaption></figure>

After saving the variation, it will appear in the **Variations** tab. You can hover over the variation to either download it or copy an optimized CDN link for easy sharing.

If a file has multiple variations, you can download them in bulk.&#x20;

### Setting Presets

Presets is a special DAM feature which allows to create Variations automatically when a file is uploaded. In that way, you can create standard outputs for all uploaded files.

See the [Presets](https://docs.scaleflex.com/dynamic-media-optimization-dmo/settings/delivery/url-format#presets) configuration section for setup details.


# Comments

Comments with annotations

Image annotations allow you to communicate with fellow contributors and discuss the features of the assets. Comments and annotations are timestamped and are available to all users with editing privileges.

## Adding comments and annotations

The comment section is accessible from the context menu and the assets management modal of each file.

<figure><img src="/files/4mLK6Ef4GVojIim0g9Nx" alt=""><figcaption></figcaption></figure>

In the comments section, you can:

* View all comments for an asset.
* Sort or filter comments.
* Like or dislike comments.
* Mark comments as "Resolved."
* Start a new discussion from a comment.

[<br>](https://docs.scaleflex.com/filerobot-documentation/collaborative-dam/the-filerobot-asset-hub/collaborate-with-assets/users-and-teams)


# Approvals

Manage asset's approval status

The Approvals feature lets you gather structured feedback and decisions from stakeholders through a voting process. It ensures alignment and reduces errors, particularly for campaigns and projects with multiple contributors.

## Key usecases

* Reviewing designs for marketing campaigns.
* Approving edited images before publishing.
* Gaining consensus for social media posts or web assets.
* Streamlining multi-department approvals for promotional materials.

Any asset can be submitted for an approval. "Approval" can adopt whatever definition your project needs, e.g. "Approval for website use".&#x20;

## Pre-requisites

Approvals must first be enabled for your project, which can be done by any [user](/vxp-visual-experience-platform/settings/organisation/users/custom-levels) having access to [Settings > DAM > Automations > Workflows](https://hub.filerobot.com/settings/dam/automations/workflows):

<figure><img src="/files/xZ0yLJ2gFR18D8ESX2CL" alt=""><figcaption></figcaption></figure>

## Approval statuses

An asset, requested for an approval, can have these statuses:

<table><thead><tr><th width="263"></th><th></th></tr></thead><tbody><tr><td><code>Pending</code></td><td>Waiting for votes</td></tr><tr><td><code>Approved</code> </td><td>The asset has passed approval criteria and is fit for use*</td></tr><tr><td><code>Rejected</code></td><td>The asset has failed the approval criteria and is not fit for use*</td></tr><tr><td><code>Cancelled</code></td><td>When a Requester (or user with the necessary permission) has explicitly cancelled the request</td></tr><tr><td><code>Reset</code></td><td>When someone has edited the file and created a new version during an active approval request</td></tr></tbody></table>

\*see [Approval vote outcome](#approval-vote-outcome) section below

## Approval vote outcome

An approval request is considered:

* **Approved**: When all approvers vote positively.
* **Rejected**: When at least one approver votes negatively or [the request Due date expires](#due-date-expiration).

If an asset is rejected, the requester can review comments, make adjustments, and submit a new approval request.

{% hint style="info" %}
There can be only one active (pending) approval request per asset, however, once completed, another one may be requested.
{% endhint %}

## Due date expiration

If an approval is not approved by the due date, the approval is **automatically rejected**.

## Requesting an approval

An approval can be requested in several ways:

1. From the Context menu > More actions > **Manage approval**

   <figure><img src="/files/zmcDXDit5Yt5u6hosWcT" alt="" width="248"><figcaption></figcaption></figure>
2. From the Library sidebar - expand the **Approval status** section and click the **Manage approval** link

   <figure><img src="/files/IRW0uvJCw40xJezZ3Xqp" alt="" width="375"><figcaption></figcaption></figure>
3. From the Asset details window - go to the **Approvals tab** and click **Request approval**.

<figure><img src="/files/k02CEH2GZLozzOvN09HC" alt="" width="375"><figcaption></figcaption></figure>

### Steps to request approval:

1. Click the **Request approval** button to open the **Request approval** modal.
2. Complete the following fields:
   * **Selecting approvers**: Choose one or more approvers. Users without asset access are muted and cannot be selected. At least one approver is required to enable the **Send request** button.
   * **Adding an optional message**: Provide additional context for the approvers (eg. "*Please review this image for use in next month’s newsletter").*
   * **Setting a due date**: Set a realistic deadline for the review process. The local time is auto-detected.
3. Once the **Send request** button is clicked, all approvers receive an alert.

<div align="center"><figure><img src="/files/EIVshL2yRI6hoHAZOwlB" alt="" width="375"><figcaption></figcaption></figure></div>

## Voting on approval request

Approvers will get a notification when they are asked to vote on a request. An approver can click on the link in the notification or navigate manually to the asset. Once in Asset details window > Approvals tab:

1. Click on the **View and approve** link
2. Then choose to either **Approve** or **Reject** the asset
3. You can leave comments when voting, in this way providing immediate feedback like: "*Please adjust the font size in the banner."*

<div><figure><img src="/files/IG2QF2Uydw0awdAKx7un" alt=""><figcaption></figcaption></figure> <figure><img src="/files/f5xPxb2myWhWiiV9xjZ1" alt=""><figcaption></figcaption></figure></div>

## Manage approval request

Active requests can be modified by the original requester or [anyone with the necessary permissions](/digital-asset-management-dam/settings/storage/listing#default-gallery-role) (if not listed as an approver).&#x20;

### How to manage an approval request

* Open the **Approvals tab** in the Asset details window.
* Click **Manage approval** to view details.
* Make changes as needed:
  * **Cancel**: Notify approvers and stop the approval process.
  * **Edit**: Modify approvers, due dates, or messages.

{% hint style="info" %}
At least one approver must remain, and the due date must be in the future.
{% endhint %}

<div align="center"><figure><img src="/files/n4Pbo5cujnUy0QuuhG9v" alt="" width="375"><figcaption></figcaption></figure> <figure><img src="/files/cwLoOqTQQT9yHyjn2bqb" alt="" width="375"><figcaption></figcaption></figure></div>

## Viewing approval details and history

### Regular users:

Regular users can view approval details but cannot take action or leave comments.

### Where to view approval statuses:

The approval status is displayed in the following locations:\
\
1\. **Asset thumbnails -** Approval status is displayed on the top-right corner (not clickable).

<figure><img src="/files/DgzAFx5smqAJJb57WT4S" alt=""><figcaption></figcaption></figure>

2\. **Library sidebar -** a field in the General tab shows the approval status. Hovering over it displays a summary tile.

<figure><img src="/files/Gc8yjxvhQ3uAveEY2jTu" alt=""><figcaption></figcaption></figure>

3. **Approvals tab -** Provides a detailed history of all approval requests.

<figure><img src="/files/9TsmKXOwOwesuPngZ58c" alt=""><figcaption></figcaption></figure>

### Approval history

1. Open the **Approvals tab** in the Asset details window.
2. Click **History** to view previous approval requests.
3. Select the file version from the left panel and click **View details** for more information.

<div><figure><img src="/files/pLJhCNHLCp8IA1Qh2Xgc" alt=""><figcaption></figcaption></figure> <figure><img src="/files/PAn0RF8XQYDxLiqr7Ybf" alt=""><figcaption></figcaption></figure></div>

## Best practises for using Approvals:

* Use clear messages to explain the purpose of the approval.
* Set realistic due dates to allow stakeholders enough time to vote.
* Regularly review approval history for process insights.


# History

View the history of actions and changes performed onto an asset.

The History tab within the Asset Window will display the whole history of the asset since its inception.&#x20;

You can view all its versions along their creation timestamps, and you can click to expand any version to see all actions have been done to it, by whom and when:

<div data-full-width="true"><figure><img src="/files/fbb9rslssrAias0dQMht" alt=""><figcaption></figcaption></figure></div>

<figure><img src="/files/UITH2ehjmZjQCDpqdr2P" alt=""><figcaption></figcaption></figure>


# Folders

DAM Folder Management

## Folders view  <a href="#folders-view" id="folders-view"></a>

In the DAM, you can organize your assets by folders. This view is available in the left panel of the Library under the name "Folders":<br>

<figure><img src="/files/DFTQcd7xD1ZW8tZGL2wr" alt=""><figcaption></figcaption></figure>

It consists of a navigation panel where the folders and their sub-folders are hierarchically ordered and an expanded view where you can preview the content of the current folder. It is available in a Grid view or a List. The view is controlled by the following icon:

<figure><img src="/files/17Oxne6jdlJpTYgbrhma" alt=""><figcaption></figcaption></figure>

### Getting folder details <a href="#getting-folder-details" id="getting-folder-details"></a>

If you select a single folder and then click on the " Info" icon at the top right part of the page, you will open a panel showing the folder's details:<br>

<figure><img src="/files/Z5RCUn1XSbkpgVLu6vTW" alt=""><figcaption></figcaption></figure>

## Creating a new folder

You can use the button at the top right part of the page to create a new folder. The new folder will be created as a sub-folder of your current folder's location.

{% hint style="info" %}
Please note that "/" is treated as a special symbol in the folder name. If you specify "Media/Images", the system will create a folder "Media" and a sub-folder "Images" inside it.
{% endhint %}

## Managing folder access <a href="#downloading-the-folders-content" id="downloading-the-folders-content"></a>

Folder access settings ensure the right users have the appropriate permissions to view, edit, or manage assets, enhancing security and organization.

This feature is available for users with a Manager, Admin or Owner [User Level](/vxp-visual-experience-platform/settings/organisation/users/users#user-level).

### Steps for managing folder access:

* Navigate to the folder you want to manage.
* Click the **...** icon next to the folder name.
* Select **Share > Manage access** from the dropdown menu.

<figure><img src="/files/ajkdHOwicL6BLa78j0Ob" alt=""><figcaption></figcaption></figure>

* In the pop-up window, review the following details:
  * **Folder Owner:** The user who created the folder.
  * **Default Visibility:** Predefined access for users without explicit permissions. See [Gallery roles](/digital-asset-management-dam/settings/storage/listing#default-gallery-role).
  * **Current Access Mode:** Determines if settings are inherited or overridden.
  * **People with Access:** A custom list of users or teams with specific permissions.
* To add users or teams, select **Override** from the Access Mode dropdown and click on the **Add Users** button that will appear in the **People with access** sectio&#x6E;**.**

<figure><img src="/files/htJHuDDmaY4c2iRqELhp" alt="" width="375"><figcaption></figcaption></figure>

{% hint style="info" %}
In order to be added, the users and the teams should be already existing in the DAM [Users](https://hub.filerobot.com/settings/organisation/users/people) and [Teams](https://hub.filerobot.com/settings/organisation/teams) lists.
{% endhint %}

<figure><img src="/files/E6eJxa5Ikzz61tvpnmiu" alt="" width="375"><figcaption></figcaption></figure>

{% hint style="info" %}
You can not assign to the users a Gallery role lower than the [default Gallery role](/digital-asset-management-dam/settings/storage/listing#default-gallery-role) which is set for the Project.
{% endhint %}

{% hint style="warning" %}
The company Owner, Administrators and folder owner have unrestricted access to view and edit the folder, no matter the permissions.
{% endhint %}

## Downloading the folder's content <a href="#downloading-the-folders-content" id="downloading-the-folders-content"></a>

### **Downloading assets**

If you select a folder and open its context menu, you can download its content as Original files. The same action is available from the navigation bar and the download icon at the top right corner of the selected folder. The content is exported as a ZIP archive.

### **Exporting a list of files as CSV**

This option is useful when getting details about the folder's content.

Please select the folder, open the context menu, and choose "Download-> Export list of files (CSV)." At this step, you can choose to export the file details of the entire project or only the files placed directly in the selected folder or the folder + its nested sub-folders.

The information that is exported in the CSV contains:

* Item Type
* &#x20;Path CDN link&#x20;
* mime-type size&#x20;
* SHA1&#x20;
* file uuid&#x20;
* creation date&#x20;
* update date&#x20;
* visibility settings

{% hint style="warning" %}
The maximum number of exported records(lines) is 50 000.
{% endhint %}

## Searching folders

If you know the name of the folder in which you are interested, you can jump directly into it using the small Search folders box:

<figure><img src="/files/La4yiAfW8MdfvI4Jy5U6" alt="" width="304"><figcaption></figcaption></figure>

You can also perform actions such as downloading folders, sharing them, editing via CSV, moving folders to different locations, and deleting folders directly while searching for the desired folder.<br>

<figure><img src="/files/lcrwBJznqnfcnX5e1WgD" alt=""><figcaption></figcaption></figure>

If you know that some file is located in a specific folder, you can use the main Search box to specify this folder and then apply additional search criteria in order to find the files you are interested in:\ <br>

<figure><img src="/files/5UyEWCip5g1rPjv7YVM0" alt="" width="375"><figcaption></figcaption></figure>


# Collections

A collection is a group of related assets defined by metadata.

The main difference between grouping assets via Folders, Labels, My favourites vs Collections is that the membership of assets to a group is *dynamic* when using collections. This means that assets are automatically added or removed from a collection based on their technical properties and metadata values.

{% hint style="info" %}
Example: A collection of *Cars* may contain all assets tagged with `#car` or having "Car" as a value in the metadata field "Vehicle type".
{% endhint %}

## Collections view <a href="#collections-view" id="collections-view"></a>

You can access the Collections view from the main menu on the Library page.

<figure><img src="/files/p4LK2oSocOnPg0NUJQCc" alt=""><figcaption></figcaption></figure>

### Collections sub-menu

<figure><img src="/files/eladpndolOjRUCUr0mKi" alt=""><figcaption></figcaption></figure>

In the collections list, the collections submenu has the following options:

* **Name**: sort by name ascending or descending
* “**Sort” icon**: if the collections are currently sorted by name ascending, then this will sort them descending and vice-versa
* **“Planet” icon**: allows to select the metadata/tags language
* **Refresh**: refreshes the collections list
* **"Info" icon**: if an asset is selected, provide additional details for it
* "**Cart icon**": a collection of downloaded assets.

## Managing collections <a href="#managing-collections" id="managing-collections"></a>

### Add a new collection <a href="#add-a-new-collection" id="add-a-new-collection"></a>

You can do this by clicking on the button `+ Add collection`. A pop-up configuration panel will appear, prompting you to specify the collection’s name and settings.

<figure><img src="/files/6Mo8f8ve8AyOhLbpN6hQ" alt=""><figcaption></figcaption></figure>

* **Name** - Please specify a meaningful collection name
* **Access** - by default it is Company. Only users with access to DAM Hub can see these assets.
* **Groups-** The groups contain a list of pre-defined collection criteria that can be combined together.

### Edit collections <a href="#edit-collections" id="edit-collections"></a>

Click on the "Settings" icon in the left panel of the page to open the Configuration window, which allows you to manage your collections.

<figure><img src="/files/UJCs7ViBltOHs1nOUZpF" alt="" width="308"><figcaption></figcaption></figure>

That will open the "Manage collections" window where you can Search, Add new collections, Edit the current configuration or Delete existing collections.<br>

<figure><img src="/files/nx5Cg1onPhNWsLQqWwrs" alt=""><figcaption></figcaption></figure>


# Labels

Labels are used for categorizing and describing items, allowing for flexible grouping and easy Search. One asset can have multiple labels.

## **Difference between Labels, Tags, and Collections**

*Labels* allow users to organise their assets in a more structured and permanent way than *Tags*. Unlike the dynamic Collections whose assets change through applicable filters, they are static and are similar in principle to the labels on physical products (drinks, foods, clothes).

Users can still modify a given label and/or change which assets fall under it.

The system also allows users to view and search the labels and their applicable assets.

## Labels View

The Labels page can be accessed from the DAM sidebar menu.

<figure><img src="/files/sLu26kourqLfThpIRVCV" alt=""><figcaption></figcaption></figure>

## Managing labels <a href="#managing-labels" id="managing-labels"></a>

### Creating labels <a href="#creating-labels" id="creating-labels"></a>

You can create named, colour-coded labels by clicking on `+ Add label` button. This allows you to list and place all assets assigned to a specific label in a single view.

<figure><img src="/files/G9DTN0DIIGDpzFsFnkIK" alt="" width="305"><figcaption></figcaption></figure>

* **Title** - please choose a meaningful name for your new label
* **Colour selector** - choose a color by clicking a pre-defined color or by entering an RGB code manually.
* **Pinned** - if this checkbox is marked, then the new label will appear on the top of the labels list. On *Sort* the system will sort first the Pinned labels and then will show the other ones.

### Editing labels <a href="#editing-labels" id="editing-labels"></a>

To manage labels, click the 'Settings' icon in the left panel. This opens the Configuration window.<br>

<figure><img src="/files/OPMEr5iOc28SXnkr1zyk" alt="" width="302"><figcaption></figcaption></figure>

That will open the "Manage labels" window where you have options to Search, Add new labels, Edit the current configuration or Delete existing labels.

<figure><img src="/files/v77ya1sGo3FvcBaQRTjk" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
If you want to delete a label, it is a good practice to ensure that the number of the current assets assigned to it, is "0".
{% endhint %}

### Attaching a label to an asset

Right-click on an asset (or multiple selected assets) and choose the *'Manage' > 'Labels'* submenu to search for and apply a label.

<figure><img src="/files/G2M2QPCoPCMnv6FTICcm" alt=""><figcaption></figcaption></figure>

If no exact match is found during the search, the user can create a new label and apply it to the asset immediately.\ <br>

<figure><img src="/files/D6o5ztZMHtGFhzbYowBy" alt="" width="220"><figcaption></figcaption></figure>

### Detach a label from an asset

This function is available on the Labels page when selecting a file and opening its context menu:

<figure><img src="/files/rQl1D9TY2rgyrD10tz0H" alt=""><figcaption></figcaption></figure>

The user can select multiple files too and use the `...` icon in the Navigation bar in order to access the same option.

In both cases, the user should have a Developer, Manager, Admin, or Owner User Level to detach a label.

## Searching labels

### Searching for an asset by a specific label <a href="#searching-for-an-asset-by-a-specific-label" id="searching-for-an-asset-by-a-specific-label"></a>

You can search by specific search criteria inside the pool of all assets assigned to a specific label, using the main Search box:<br>

<figure><img src="/files/7FUtCcJD9Yhf7VFN0pli" alt=""><figcaption></figcaption></figure>

### Searching for a Specific Label

If you are interested in finding all assets assigned to a specific label, you can search for this label's name in the Search box at the left panel and then click on the result.

<figure><img src="/files/HFirXLaPx2JuQbaACRGI" alt=""><figcaption></figcaption></figure>


# Products

DAM Products Management

## Overview

The Product feature helps you organize and quickly find files by grouping them using specific product references. Once enabled, users can add two new metadata fields—**Product Reference** and **Product Position**—to their assets.

Marking assets with Product References makes it easy to locate materials for seasonal promotions or product launches.

<figure><img src="/files/uYfXxGMYgqDzZg9QEryH" alt=""><figcaption></figcaption></figure>

## Enabling Products

To enable this feature, navigate to [**Settings > DAM > Library > Featured Components**](https://hub.filerobot.com/settings/dam/library/featured-components) and turn on the **Products** feature to automatically add the **Product Reference** and **Product Position** fields.

<figure><img src="/files/l7lO3Tv8JTIswKNck4YO" alt=""><figcaption></figcaption></figure>

## Creating and Deleting Products

A product will appear in the **Products** view only if at least one asset has this Product as assigned in its **Product reference** field.

Products are automatically removed from the **Products** view when no assets are associated with them.

## Assigning Product Metadata to Assets

To add Product metadata to an asset:

1. Select the asset
2. Open the Details view
3. Go to *Metadata > Custom*
4. Click the Edit button
5. Add or update the **Product reference** and **Product position** fields.
6. Save the changes.

{% hint style="info" %}
You can configure an uploader script to [assign product metadata](https://developers.scaleflex.com/#2dd93fbb-e4db-4859-ac2f-c97849a201ca) during upload automatically.
{% endhint %}

**Product Reference** identifies the specific product to which the asset is related. \
**Product Position** specifies the order in which assets appear within a product group. For example, it determines the sequence of images in a promotional campaign.

### Removing Product metadata from an Asset

To detach product metadata from an asset:

1. Select the asset and open the **Details view**.
2. Navigate to **Metadata > Custom**.
3. Click the **Edit** button.
4. Clear the **Product reference** and **Product position** fields.
5. Save the changes.

##

## Using the Products view

The list of Products can be found at **Menu > Products** (the Product view).&#x20;

All users can see the products in this View, as long as it is [enabled from the configuration settings](/digital-asset-management-dam/library/products#enabling-products) and there are assets associated with the products.

The **Product Position** value of an asset determines the order of the files in the detailed view when a Product is selected.

<figure><img src="/files/TYBabbRq1HFdpdf3Hovu" alt=""><figcaption></figcaption></figure>

## Searching for products

### Product Filter

Use the **Products** filter in the search bar to find assets:

* **Search by single reference:** Enter one product reference to retrieve its associated assets

<figure><img src="/files/Qaon0L1tff5eDuX8H9U8" alt=""><figcaption><p>Single Product_reference serach</p></figcaption></figure>

* **Bulk reference search:** Use the **Add List** option in the filter to paste multiple references (one per line). The system will automatically format the input and display results for all referenced products.

<figure><img src="/files/BUiOeGekGOuyGa3moVkd" alt=""><figcaption><p>Bulk Product reference search</p></figcaption></figure>

<figure><img src="/files/60ZpuE5zroInGKcpflqE" alt=""><figcaption><p>Exact result</p></figcaption></figure>


# My favorites

"My Favorites" are typically used to quickly access frequently visited assets. They provide a way to create a personalized flat list of preferred items for easy access.

Users can mark assets as favorites and view / search these assets under the **My favorites** submenu for quick access. Each asset can be marked as favorite or not and each user can access their list of favorite assets via **Menu > My favorites**:

<figure><img src="/files/0IQpCh0M1rml7tpW9oVR" alt=""><figcaption></figcaption></figure>

## Adding assets to My favorites list <a href="#adding-assets-to-my-favorites-list" id="adding-assets-to-my-favorites-list"></a>

The user can add an asset to My favorites list by simply clicking on the heart icon at the bottom right corner of the asset:

<figure><img src="/files/Zs2s3lpbFlhVNO8BDKh9" alt=""><figcaption></figcaption></figure>

An asset whose icon is colored in purple is already added to this list, while an asset whose icon is in grey is not part of My favorites.

Users can add multiple assets in bulk to My favorites list by selecting them and then opening *`...` -> Add to -> My favorites* in the Navigation bar:

<figure><img src="/files/F7Lmgapdl4PtTvKqtWUn" alt=""><figcaption></figcaption></figure>

In the same way, an asset or a group of assets that are already added to My favorites list can be removed from there.


# Help

The Help section located at the end of the top-right menu provides information to users that need further assistance in operating the DAM.

<figure><img src="/files/OgMKWTJMKxwNNYoEtAqQ" alt=""><figcaption></figcaption></figure>

When clicking the Help box in the menu, an additional menu appears:&#x20;

| About               | Displays the current version of Scaleflex DAM and Copyright information.              |
| ------------------- | ------------------------------------------------------------------------------------- |
| Documentation       | Provides access to the Scaleflex documentation                                        |
| Release Notes       | Access the release notes to see the recent releases and updates made on Scaleflex DAM |
| Help/Knowledge base | Another source of information, this accesses the Scaleflex knowledge base             |
| Request Support     | Make a direct request or report a bug to the Support team.                            |


# Sharebox

Learn how to securely share DAM assets with external agencies and partners. Manage downloads, set expiration dates, and simplify your distribution workflow without requiring user logins.

Sharebox allows you to share assets with third parties without access to Scaleflex DAM.

<figure><img src="/files/rXcWqlsEda1pnblJlsxy" alt=""><figcaption></figcaption></figure>

### Creating a Sharebox

To create a Sharebox, select the assets you would like to share and open the Share Assets modal in the top bar or the context menu `...` *Share* > *Via Sharebox*.

Each Sharebox can optionally be password-protected, have an activation and expiration date, and provide options to disable or enable asset downloads. Additionally, you can invite users by email to access the Sharebox.

<figure><img src="/files/5aaDEhmLCYD18XAVO8ZK" alt=""><figcaption></figcaption></figure>

## Preview, Edit and Delete Sharebox Instances

To Preview, Edit, or Delete a Sharebox instance, go to the 'Sharebox' section in the left menu of your Library.

Then select a Sharebox item and click on the `...` menu. You can also change the password, activation date, or expiration date inside this modal.

{% hint style="warning" %}
These settings are used to manage the Sharebox ***configuration***. \
Editing the ***shared assets*** must be done through the [Asset view](/digital-asset-management-dam/library/assets/asset-details-window/asset-actions/edit-media-image-video-etc).
{% endhint %}

{% hint style="success" %}
Sharing an entire folder allows dynamic update of the Sharebox content - when you add/edit/delete files from this folder, the changes are immediately reflected in the Sharebox.
{% endhint %}

<figure><img src="/files/Rt1ulce6eJdg5t5fdkiZ" alt=""><figcaption></figcaption></figure>

### Copy Sharebox link and Share via Email <a href="#copy-airbox-link-and-share-via-email" id="copy-airbox-link-and-share-via-email"></a>

Hover over any Sharebox to reveal options to copy its link or send it via email.

<figure><img src="/files/Qh7wdcf3dTEh1Nm8tIhG" alt=""><figcaption></figcaption></figure>

### Filtering options <a href="#filtering-options" id="filtering-options"></a>

You can filter only specific Sharebox instances which match your business needs:

* Total - shows all existing Shareboxes in the project.
* Active - shows all currently active Shareboxes. This category includes Shareboxes without an expiration period and Shareboxes whose expiration period is not near future.
* Protected - Shareboxes with password-protected access
* Scheduled- Shareboxes that are not yet active
* Expired - shows Shareboxes which can no longer be used.(their validity is over)

### Sharebox page Views <a href="#airbox-page-views" id="airbox-page-views"></a>

The sharebox page supports two types of views, each dedicated to serving specific business needs.

#### List view <a href="#list-view" id="list-view"></a>

This view orders the Sharebox records in a table-like structure, having columns with details about the Shareboxes. It is best for managing multiple Shareboxes and comparing their details.

The user can choose sorting order and the level of detail of the shown information.

<figure><img src="/files/ti4t4CkUvxwBfpnu703Q" alt=""><figcaption></figcaption></figure>

#### Grid view <a href="#grid-view" id="grid-view"></a>

This view shows the Sharebox instances as a grid of elements where the main focus is the individual Sharebox. Best for quick visual browsing or filtering by creator.

<figure><img src="/files/PFqW8Ge3SnQMHHOT6Saz" alt=""><figcaption></figcaption></figure>


# Airbox

Third-party asset upload

Airbox enables non-registered users to upload files through public links, offering a simple way to collect files. You can set optional activation and expiration dates and password protection for each Airbox instance. Additionally, you can invite users via email, set upload limitations, and receive notifications when assets are uploaded.

Use Airboxes to:

* Collect files from external partners
* Receive campaign assets from agencies
* Gather user-generated content

<figure><img src="/files/qlaRJ9IS8r8D2VvlziOu" alt=""><figcaption></figcaption></figure>

## Creating an Airbox

To create an Airbox instance:

* Select **Airbox** from the left menu in your Scaleflex DAM library.
* Click on + Add airbox.
* Enter a meaningful title and description for the new Airbox.
* Select the target folder in Scaleflex DAM where uploaded files will be stored.  If the selected folder is already in use by another active Airbox, an alert will notify you. Choose a unique folder to avoid conflicts.

Optional settings:

* Set start and expiration dates.
* Enable password protection.
* Set limitations per file size, total number of uploaded assets, etc.
* Choose who will receive notifications when files are uploaded to the Airbox.
* Set which file metadata fields to be filled in on upload.

<figure><img src="/files/283c5QlLYW6KJYSP53GC" alt=""><figcaption></figcaption></figure>

## Uploading files via an Airbox

When a user opens the Airbox link, they would be able to upload files from their local device, via a URL link, to take a screen capture or to use the device camera.&#x20;

{% hint style="info" %}
Airbox process flow:

Users open the link → upload files → optionally rename and add metadata → submit.
{% endhint %}

Users uploading through the same Airbox link cannot see each other’s files.

## Preview, Edit and Delete Airbox Instances

To Preview, Edit or Delete an Airbox, go to the '***Airbox***' section in the left menu of your Library.

Then select an Airbox item and click on the `...` menu.

<figure><img src="/files/Dfmm1imXRls6c9b5wpMo" alt=""><figcaption></figcaption></figure>

## Copy Airbox link and Share via Email

Hover over an Airbox to reveal options to copy its link or send it via email.

<figure><img src="/files/TCm5ZbLmeJNXrqf2mU6N" alt=""><figcaption></figcaption></figure>

## Filtering options

You can filter only specific Airbox instances which match your business needs:

* Total - shows all existing Airboxes in the project
* Active - shows all currently active Airboxes where users can upload data. This category includes Airboxes without an expiration period and Airboxes whose expiration period is far away in the future.
* Protected - Airboxes with password-protected access
* Expiring - Airboxes that will expire soon
* Expired - shows Airboxes which can no longer be used for uploads (their validity is over)

## Airbox page Views

The airbox page supports two types of views, each dedicated to serving specific business needs.

### List view

This view orders the Airbox records in a table-like structure, having columns with details about the Airboxes. It is best for managing multiple Airboxes and comparing their details.

The user can choose sorting order and the level of detail of the shown information.

<figure><img src="/files/EvCzlB8SjTKm9gIg1Xm5" alt=""><figcaption></figcaption></figure>

### Grid view

This view shows the Airbox instances as a grid of elements where the main focus is the individual Airbox. Best for quick visual browsing or filtering by creator.

<figure><img src="/files/aJTghCuZssAXkDLKkLTX" alt=""><figcaption></figcaption></figure>


# Search and Filters

Use the Search bar to quickly find assets by keywords, metadata, or filters - even across large libraries.

## Search

The search bar allows users to use a simple search with keywords that will find and display the most relevant assets found.

### **Simple keywords search**

It is the search triggered by default when you use the main text bar, and looks for the entered keyword in title, description, filename, tags, along with all custom metadata.&#x20;

Sorted by relevance (sorting adjustable afterwards).&#x20;

{% hint style="info" %}
Relevance is based on how closely the keyword matches fields like title, filename, tags, and metadata.
{% endhint %}

In the search keyword, any non-alphanumeric character is taken as a separator (eg "-" or "\_") and the operation between those sub-keywords is AND.

When you combine search with [filters](#filter), only assets that match both your keyword and selected filters will be shown.

The results returned by this search are divided into 2 sections, in order:

* Exact: all complete sequences of alphanumeric characters (at least) are matched.
* Partial/Fuzzy (aka extended): truncated sequence of alphanumeric characters, including small variations (e.g. typo), provided relevance is above a threshold (70% by default).

{% hint style="info" %}

* **Exact results**: exact keyword match (e.g. “banner”)
* **Partial/Fuzzy results**: similar matches (e.g. “banners”, “baner”)
  {% endhint %}

## Filter

### By timestamp

| ![](/files/x9uCTVfi7T5NHEubknDS) | <p><br>Assets can be filtered by their creation or last modification date using pre-defined or custom time frames</p> |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------- |

### By file format

| ![](/files/UUZ4BAGZLtaYUDnuwNla) | With the format filter, user can choose from a list of asset types or file formats depending on the content of the DAM container |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |

### By filesize

| ![](/files/lTE8LDJzpfULFY5ajmbj) | Filtering by filesize by entering a size range |
| -------------------------------- | ---------------------------------------------- |

### By tags

| ![](/files/bJjuVr8meYWigRJkSpet) | This option allows user to filter by selecting one or more tags in the container |
| -------------------------------- | -------------------------------------------------------------------------------- |

### By metadata

| ![](/files/vS2uI1sb0hN37tEU6GsB) | The metadata filter allows user to select multiple metadata fields as well as multiple values for each field and apply them as filters |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |

### By image info and content

| ![](/files/NXrqDuo1G9UHrfrtO1n0) | <p>The image group of filters lets user filter by image dimensions/resolution, contents, color or aspect ratio. </p><p>Some of these filters produce results only if a corresponding <a href="/pages/GR5ILkx89PcnqmpusrOP#post-process-list">postprocess</a> is active for the project and all available files are passed through it.</p> |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### By Product Reference

<table data-header-hidden><thead><tr><th width="382"></th><th></th></tr></thead><tbody><tr><td><img src="/files/go4PiFlwjrdxDWnCLDlb" alt="" data-size="original"></td><td><p>Allows users to filter results based on the product_ref field. Supports filtering by multiple product values at once.</p><p>Users must go to the Preferences section under the Project tab and toggle the Products Filter setting to enable this filter. Once enabled, the "Products" filter will be available for use in the search bar.</p></td></tr></tbody></table>

{% hint style="warning" %}
Search results depend on how well metadata (titles, tags, descriptions) is filled in. Missing or inconsistent metadata may lead to incomplete results.
{% endhint %}

### Pin your Searches

You can pin frequently used searches to save time. This allows you to quickly access and reuse the same search criteria later.

<figure><img src="/files/znlMx0Vm5M9R2dFZNtfd" alt=""><figcaption></figcaption></figure>


# Faceted Search

Faceted navigation available in DAM products (Widget, Hub and Portal)

### What is faceted navigation (aka faceted search) ? <a href="#what-is-faceted-navigation" id="what-is-faceted-navigation"></a>

At its core, faceted navigation utilizes a faceted classification system to organize information. This system categorizes items based on multiple, independent attributes called facets. Each added facet acts as new filtering layer.

* **Concept:** Faceted navigation falls under the umbrella of parametric search techniques. Instead of relying solely on keyword matching in a traditional search, it allows users to filter based on pre-defined parameters (facets) associated with the asset. This enables a more nuanced, smarter search experience.
* **Technology:** Faceted navigation relies on efficient data structures and algorithms to handle large datasets and filter combinations. In essence, the system needs to quickly identify items that match all selected facet criteria. Search engines like Solr or Elastic Search are popular choices for implementing faceted navigation due to their ability to handle complex filtering operations.
* **Benefits:** The technical aspects of faceted navigation translate into several benefits:
  * **Drill-down refinement:** Users can progressively narrow down results by applying multiple facet filters, leading to a precise subset of assets.
  * **Faceted exploration:** Faceted browsing allows users to explore different categories and discover new assets they might not have found through a simple keyword search.
  * **Improved efficiency:** By filtering irrelevant options, faceted navigation reduces the number of results a user needs to sift through, saving them time and effort.

### How does faceted navigation work in DAM? <a href="#how-does-faceted-navigation-work-in-filerobot" id="how-does-faceted-navigation-work-in-filerobot"></a>

Faceted navigation is applied for 4 types of attributes (as of May 8th, 2024)

* Date (Uploaded and Created date)
* Metadata Single-select
* Metadata Multi-select
* Metadata Boolean

→ Faceted navigation is only available in the "Assets" view (ie. not in the Folder view)

→ Faceted navigation section is built as a side bar at the left side of the UI, replacing entirely the filter bar (shown below, that will then be hidden) in the Assets view.

<figure><img src="/files/k4fQJ7Xd5jfSszvRyNYM" alt=""><figcaption></figcaption></figure>

### Activation of faceted navigation <a href="#the-dynamic-of-faceted-navigation" id="the-dynamic-of-faceted-navigation"></a>

This type of navigation is activated at a *{token}* level, and is a global setting for all users, that can be found at the DAM-> Library -> [Interface customization  ](https://hub.filerobot.com/settings/dam/library/interface-customization)page.

<figure><img src="/files/Qhraj3bSfCQgiSUYtr15" alt=""><figcaption><p>Faceted search activation </p></figcaption></figure>

### The dynamic of faceted navigation <a href="#the-dynamic-of-faceted-navigation" id="the-dynamic-of-faceted-navigation"></a>

Within a metadata, the operator between 2 values or more is set to `OR`

Between 2 metadata or more, the operator is set to `AND`

**In details:**

* Within a metadata

-> For multi-select, we provide 2 operators: `AND` and `OR`

Let assume we are calling query `HAS` (equal to `IS` but for multi-select we call it `HAS` just for gramatical purpose)

We will have 2 options

1. Metadata `HAS` a `AND` b -> expected results are files which have both values a and b, file that contains only a or b won't be returned
2. Metadata `HAS` a `OR` b -> expected results are files which has either a or b, file that contains both of the values will be returned also&#x20;

**➡️ This option cover the 1st option -> within a multi-select metadata, we will choose `HAS-OR` operator to cover more file results**

-> For single-select, it will always be `OR` when users click in more than one answers as one file can not contain more than one value.

* For 2 metadata or more

For faceted search, it is an AND operator between multiple metadata as the answers will be more specific and this is the main idea for faceted navigation: trimming down the most correct answers

#### Example: <a href="#example" id="example"></a>

a. Multi-select metadata "colour" with value: “red”, “white”, “black”

When "red" and "white" are searched for -> expected answers are:

* Files that contain value red only
* Files that contain value white only
* Files that contain both value red and white

b. Single-select metadata "size" with value: “35”, “36”, “37”

When “35” and “36” are searched for -> expected answers are:

* files that contain 35 value only
* files that contain 36 value only

&#x20;

c. Now, combining the two previous examples

When “red”, “white”, “35”, “36” are searched for -> expected answers have to use `AND` operator to encompass the 2 metadata constraints, so answers will be assets that contain:

* red and 35,
* red and 36,
* white and 35,
* white and 36,
* red and white and 35,
* red and white and 36

→ Refining searches further is leading to more accurate and relevant results.


# Plugins & Connectors

Third-party product integration

In ecosystem integration, seamless connectivity facilitates communication and interaction between third-party components.

This introductory guide aims to clarify the distinctions among the two main types of software connections: plugins and connectors (*aka* applications).

#### 1. Plugins <a href="#id-1.-plugins" id="id-1.-plugins"></a>

* Plugins are software components designed to extend the functionality of a more extensive application. They allow developers to add specific features or behaviours to an existing software system without modifying its core codebase. Plugins are **usually loaded dynamically at runtime**, making adding or removing them easier without affecting the main application's stability.
* Plugins provide a modular approach to integration, enabling third-party developers to seamlessly integrate DAM into the host application/software. Simply use our  Media Asset Widget to replace or complement the media gallery used by the third-party software/tool.

#### 2. Connectors (Applications) <a href="#id-2.-connectors-applications" id="id-2.-connectors-applications"></a>

* Applications, also known as standalone connectors or adapters, are complete and self-contained entities designed to perform specific tasks or provide a range of functionalities to users. Unlike plugins and libraries, applications are intended to be independent and **tightly integrated**.
* Our applications have user interfaces (UI) and may interact independently with other applications or services. They will always perform a range of additional functions, such as programmatic **synchronisation** and similar advanced features.

In summary, plugins extend the functionality of existing applications with a more passive role, while applications/connectors facilitate interoperability and seamless synchronisation between different systems by being placed in between them and actively intervening.

A manual integration will always be possible using our Media Asset Widget, whose code/package is linked in this documentation.


# Plugins

We offer a list of Scaleflex's DAM most popular plugins with brief descriptions on how to set them up.

You will in general need at least 2 information fr the basic setup of a plugin:

* Your "TOKEN" (aka Project identifier), located there:

<figure><img src="/files/q0VJWIHtWZ5CQjNxtHGO" alt=""><figcaption></figcaption></figure>

* Your "SEC\_TEMPLATE" (Security template), located there:&#x20;

<figure><img src="/files/6CRqbTIg5ufH2E18duof" alt=""><figcaption></figcaption></figure>


# Adobe Creative Cloud

The DAM Adobe CC embeds the Media Asset Widget (MAW) plugin inside the following supported Adobe applications:

* Adobe Photoshop
* Adobe Illustrator
* Adobe InDesign

There are no more copy-pasting media assets from your local drive to DAM; everything happens within your Creative Cloud application.

#### Installation <a href="#od_dd8f1277" id="od_dd8f1277"></a>

**Step 1.** [Download](https://scaleflex.cloudimg.io/v7/plugins/filerobot-adobe-extension/1.0.0-beta.0/filerobot-adobe-extension.zip?vh=80412f\&func=proxy) the extension files from the link and unzip them.

*(use the following in your browser if you can't download from the above URL link)*

<https://scaleflex.cloudimg.io/v7/plugins/filerobot-adobe-extension/1.0.0-beta.0/filerobot-adobe-extension.zip?func=proxy>

**Step 2.** Copy the unzipped folder content into the folder for your Creative Cloud version:

* If you have Photoshop CC 2014, CC 2015, CC 2015.5, CC 2017 or above:
  * Mac OS: `/Library/Application Support/Adobe/CEP/extensions/`
  * Windows x64: `C:/Program Files (x86)/Common Files/Adobe/CEP/extensions/`
* If you have Photoshop CC:
  * Mac OS: `/Library/Application Support/Adobe/CEPServiceManager4/extensions/`
  * Windows x64: `C:/Program Files (x86)/Common Files/Adobe/CEPServiceManager4/extensions/`

*You have to create the folder if it does not already exist.*

**Step 3.** Restart Photoshop, and you will find the DAM widget/extension in Window > Extensions > extension\_name.

#### Usage <a href="#od_9dbea5be" id="od_9dbea5be"></a>

First, you need to log in to your DAM account from the Widget.

Then, you can select the Company and Project you would like to access (for multi-project DAM accounts).

You can browse your container and its folder structure directly from the widget, use the search and sort functions, and create folders.

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FRWpwgSYpHcOLwt6APORk%252Fcc1.jpeg%3Falt%3Dmedia%26token%3D78759a44-97ec-47e3-bd9e-63f6dee02b2e\&width=768\&dpr=4\&quality=100\&sign=9249862c\&sv=1)

You can upload images from Photoshop directly to your DAM container. Downloaded images from DAM can be inserted as a new file or layer in an existing Photoshop project.

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FC6bNKdr7w3x8D7VCzIvD%252Fcc2.jpeg%3Falt%3Dmedia%26token%3Dd2c7d6f5-6902-48c0-a5aa-a332d17bb14e\&width=768\&dpr=4\&quality=100\&sign=c525af94\&sv=1)


# Adobe Commerce (Magento)

DAM Magento Plugin

The DAM Plugin is an extension which adds Asset Management to the Magento Admin (Product Images, Tinymce 4 WYSWYG) and shows it on the Front-end (Product listing page, Product detail page, Minicart, Cart Page, and Checkout Page).

There are 3 simple steps for enabling the plugin on your Magento 2 website:

* Obtain a DAM token (request it [here](https://www.scaleflex.com/en/contact-us));
* Install the DAM module for Magento 2;
* Add your security configuration parameters to access your DAM library.

Please note that the plugin will make some changes in the Admin section.

Currently, the plugin only supports the Text Component in Page Builder; other components will be supported in future versions.

* TinyMCE Image (Insert/Edit) default function will be disabled. You can change the image size by scaling (drag and drop function) or delete it and add a new one with the size you like;
* The plugin will disable the default upload function in Product Edit Page. Instead, every asset will be managed by DAM (single source of truth).
* The plugin works well with the Magento Luma default theme. If you use a different theme, please check the manual integration below to get the product images.

### Installation <a href="#od_ca85a6dc" id="od_ca85a6dc"></a>

#### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

You can [register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have a DAM account.

#### **Step 2. Install the DAM module for Magento 2** <a href="#od_932af73c" id="od_932af73c"></a>

**Prerequisites**

DAM supports Open Source and Commerce Edition from version 2 onwards.

If you have a question or need assistance, feel free to [contact our support](https://www.scaleflex.com/contact-us).

**Install with Composer**

To be able to install the module by Composer, you need to get a copy of the module on the Magento Marketplace, or directly from [Github](https://github.com/scaleflex/magento-filerobot). Then, unzip the source code to *app/code* folder.

Enable and install the following modules in Magento:

`php bin/magento module:enable Scaleflex_Filerobot php bin/magento setup:upgrade php bin/magento setup:static-content:deploy`

#### Step 3. Add your security configuration parameters <a href="#od_e8e7f8f5" id="od_e8e7f8f5"></a>

**Configuration**

Once the steps listed above are completed, you need to enter your DAM token and security template into the DAM module configuration in the Magento admin interface: *Stores* > *Configuration* > DAM *By Scaleflex* > *DAM integration*.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2Fopendocs-global.api.airstore.io%2Fv1%2Fget%2Ff7e09d14-71c3-5ac3-a962-da8a27250000&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=fbbd88c0&#x26;sv=1" alt=""><figcaption></figcaption></figure>

If your token and security template id is verified, please activate the module by selecting Yes in the DAM Enable dropdown then save again.

After all is done, you will be asked to flush your Magento cache.

You will not be able to activate the plugin until the token and security template id are correct.

**Configuration options**

* **DAM Token:** Your DAM token from the Asset Hub interface;
* **Security Template Identifier:** Security template ID, found in the *Project > Access > Security templates (tab)*  menu;
* **DAM upload directory:** This is the top storage folder for your assets. The default value is `/magento`.

Please create the folder in DAM first to prevent an error. If you want to change it, you need to check if the folder exists in your DAM container.

### Usage <a href="#od_73a6ef4f" id="od_73a6ef4f"></a>

#### TinyMCE <a href="#od_2f915a68" id="od_2f915a68"></a>

Please click on Icon DAM on TinyMCE:

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2Fopendocs-global.api.airstore.io%2Fv1%2Fget%2F8e766a9a-3d39-55a1-aa7f-c1b60ab50000\&width=768\&dpr=4\&quality=100\&sign=5bf02541\&sv=1)

Then choose which images you want to insert -> transform:

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FDCH44dWbK0n56sJDbT5y%252F1.png%3Falt%3Dmedia%26token%3Dc2eec18a-0a9c-432c-8fb1-633d23b23efa\&width=768\&dpr=4\&quality=100\&sign=775a1709\&sv=1)

You will be able to select and insert one or more images:

If you want to change the image size, please choose one image at time and click *Insert*. After that, you will be able to set the desired image dimensions.

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FgzPBdVBP7C7pRYLU59au%252F2.png%3Falt%3Dmedia%26token%3D45b41ed6-fe86-4a82-a454-1898047748f9\&width=768\&dpr=4\&quality=100\&sign=655a1965\&sv=1)

If you want to change the dimensions of an already inserted image, you can use Tinymce Image size drag and drop.

#### Product Images <a href="#od_fe416eef" id="od_fe416eef"></a>

Go to Product Edit Page in Images and Video Tab, then click Image Manager. Then you can use the file manager like TinyMCE above.

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2Fopendocs-global.api.airstore.io%2Fv1%2Fget%2F916f38e3-8b48-5fca-aa6a-e3edd2350000\&width=768\&dpr=4\&quality=100\&sign=98d8a036\&sv=1)


# Canva

DAM Canva

{% hint style="info" %}
Note: If you are looking to access your media directly from within Canva, you should use the Canva app described [here](/digital-asset-management-dam/plugins-and-connectors/connectors/canva-app)
{% endhint %}

The Canva plugin allows you to create using all the power of Canva and any existing templates and designs you have saved, transporting your final render into your DAM library.

Follow the below steps:

* Click the Upload button (1), and select the Canva option (2)

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FJH6ZwGprjnPqLREznc0G%252FCanva%2520upload%2520option.png%3Falt%3Dmedia%26token%3Dd11ad972-7f16-4adf-b7c1-175b955be444\&width=768\&dpr=4\&quality=100\&sign=caae4236\&sv=1)

* Then login using your usual credentials in Canva and create at will
* Finally, click the "Publish" button (3) on the top right corner of the Canva interface

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FKypro12OYh05l92cXUJj%252Fcanva%2520publish.png%3Falt%3Dmedia%26token%3Db5b4369e-df44-4346-bb11-f0b17cec8bf9\&width=768\&dpr=4\&quality=100\&sign=b3398975\&sv=1)

* This will import your creation as a regular asset, added to the current folder with a simple click on "upload" (4)  If you need any pre-upload transformations you could set them to execute from the "Settings" side panel

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FWFmrBJCNwADNL6lkGC91%252FCanva%2520final%2520step.png%3Falt%3Dmedia%26token%3Dedae3e08-4be0-4ccd-8c9a-e928080da857\&width=768\&dpr=4\&quality=100\&sign=f73cd102\&sv=1)


# Chrome Asset Picker extension

The **DAM Asset Picker** extension seamlessly integrates your Scaleflex Digital Asset Management (DAM) library into your daily workflow. It allows you to select and upload assets directly from your DAM to any website, bypassing the need to download files to your local computer first.

### Overview

Key capabilities:

* **Universal Interception**: Automatically detects file upload buttons on websites.
* **Direct Integration**: Select assets directly from your Scaleflex DAM.
* **Flexible Authentication**: rigorous security with OAuth 2.0 or Security Templates.
* **Smart Filtering**: Customize which sites the extension interacts with.

### Prerequisites

To use this extension, ensure you have:

1. A **Google Chrome** browser (version 88 or later).
2. An active **Scaleflex DAM** account.
3. *\[Optional]* Your **DAM Token** & **Security Template ID** if using the Security Template authentication.

***

### Installation

1. Open the **Chrome Web Store**.
2. Search for **"Scaleflex DAM Asset Picker"** (or click [here](https://chromewebstore.google.com/detail/scaleflex-asset-picker/ncljemkjljnjmkeddpecohlhnnhekmpk)).
3. Click **Add to Chrome**.
4. Confirm the installation by clicking **Add extension** in the pop-up.

<figure><img src="/files/7VcG0BIPlZTo07xXbrh0" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Tip**: For quick access, pin the extension to your toolbar! Click the puzzle icon in Chrome's toolbar, then click the pin icon next to "DAM Asset Picker".
{% endhint %}

***

### Setup & Configuration

To use the extension, you need to connect it to your Scaleflex DAM account.

#### 1. Access Settings

Click the **DAM Asset Picker icon** in your toolbar and select **Settings**.

<figure><img src="/files/8EyGCjyxUefXpoXJZcXX" alt=""><figcaption></figcaption></figure>

Note that even if Connected, you can prevent the DAM Asset Picker to open by Globally Disabling it with the button accessible in that toolbar.

#### 2. General Preferences

Customize how the extension behaves in the **General Preferences** tab.

* **Preferred Language**: Choose the language for the DAM interface (default: Auto from browser).
* **Root Folder**: Specify a default folder to open in the DAM widget (e.g., `/marketing/assets`).
* **Excluded Domains**: Add websites where you *do not* want the extension to appear (e.g., your company's internal tools). Separate domains with commas.

<figure><img src="/files/AEubYuJLzRjQtfRSsUe3" alt=""><figcaption></figcaption></figure>

#### 3. Authentication

Navigate to the **Authentication** tab in the settings page. You have two ways to connect:

<figure><img src="/files/O71abN9hSpAup0K8EpPs" alt=""><figcaption></figcaption></figure>

**Option A: OAuth 2.0 (Recommended)**

This is the easiest and most secure method.

1. Click **Login to DAM with OAuth**.
2. A new window will open asking you to log in to your Scaleflex account.\*
3. Grant permissions to the extension.
4. Once successful, the status will change to **Connected** (green dot in tab).

*Note: the Scaleflex DAM OAuth 2.0 flow is a standard flow and does not require any additional configuration. It will allow you to connect using a secure email/password combination as well as various social accounts (Google, LinkedIn, etc.).*

**Option B: Security Template**

Use this if you need to restrict access to a specific scope or do not want to use user credentials.

1. Enter your **DAM Project Token**.
2. Enter your **Security Template ID**.
3. Click **Save & Validate**.

#### Options for the DAM library

<figure><img src="/files/P6iwE8ju4duAMIRhzgQd" alt=""><figcaption></figcaption></figure>

You can set your **preferred default options** when opening the Asset Picker, like:

* default sorting
* possibility to select and insert more than 1 asset
* view type (grid or list)

***

### Connection Status

The extension displays your connection status in two places:

#### Browser Toolbar

Hover over the DAM Asset Picker icon in your toolbar to see the current status:

* **"Asset Picker - Not configured"** - Open Settings to set up authentication.
* **"Asset Picker - OAuth connection"** - You're logged in and ready to use the extension.
* **"Asset Picker - Security Template"** - Using Security Template authentication.
* **"DAM session expiring soon"** - Your session will expire soon. Click to renew.
* **"DAM session expired"** - Please log in again to continue.

#### Popup Window

Click the extension icon to see a detailed status view:

* **Green dot** - Connected and ready.
* **Orange dot** - Session expiring soon (within 5 minutes).
* **Red dot** - Session expired or not configured.

#### Session Management

When using **OAuth authentication**, your session is automatically renewed in the background every 55 minutes. If automatic renewal fails (e.g., due to network issues), you'll see the "Session expired" status. Simply click the extension icon and log in again to refresh your session if it expired.

When using **Security Template**, your session is automatically created every time you open the widget, using the saved credentials you provided in settings.

### Using the Extension

#### Uploading Files

1. Navigate to any website with a file upload feature (e.g., Slack, File converter, WordPress, etc.).
2. Click the **Upload** or **Attach File** button on the website.
3. The extension will intercept the click and show you a choice:

   * **Local File**: Opens your computer's standard file browser.
   * **DAM Library**: Opens the Scaleflex DAM widget.

   ![](/files/vS7e828ywIX0nj9paiqR)
4. Select **DAM Library**.
5. Browse or search for your asset in the modal window.
6. Select the file and click **Insert**.
7. The file will be automatically uploaded to the website as if it came from your computer.

<figure><img src="/files/HYwDFNBrS8bHZyqXZm1k" alt=""><figcaption></figcaption></figure>

#### Drag & Drop Support

You can also use drag and drop zones to upload files from the DAM!

1. Place your pointer over a supported drop zone on a website.
2. The extension will highlight the drop zone.
3. Click the zone to trigger the upload choice menu.

***

### Troubleshooting

* **Extension not appearing on click?** Ensure you are not on an **Excluded Domain**. Check your settings to verify, and that the page offers a standard "upload" button (it might not catch a custom javascript based upload).
* **Login failing?** If using **OAuth**, ensure your browser allows pop-ups for the authentication window. If using **Security Templates**, verify that your Token and Template ID are correct and the template is active in your DAM dashboard.
* **Widget not loading?** Check your internet connection. If the issue persists, try reloading the page or reconnecting your account in the Settings. And if still not working, try to disable the extension and then enable it again. Finally, look for other extensions that might be conflicting with the DAM Asset Picker (pop up blockers, etc.).


# Contentful

The Contentful DAM App allows users to seamlessly integrate and manage digital assets (images, videos, and documents) from Scaleflex DAM within the Contentful CMS. With support for multiple file types

## Description:

The features of the Contentful DAM App include:

* **Asset Manager Widget:** Manage and insert assets directly within the Contentful content editor, streamlining the asset handling process.
* **Multiple File Type Support:** Supports a variety of file types, including images, videos, and documents.
* **Metadata configuration:**
  * Asset metadata from Scaleflex DAM will show on your Rest/GraphQL response
  * You can choose which attributes will be saved in Contentful content field
* Configuration for limited file types and maximum file count

## Installation <a href="#od_4941c597" id="od_4941c597"></a>

### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

1. [Register for a demo](https://www.scaleflex.com/request-a-demo) if you don't already have a DAM account.
2. Sign up to Contentful.

Contentful is 100% Cloud Native, so you have to sign up for a hosted CMS at [https://be.contentful.com](https://be.contentful.com/) and you will get a link to your space:

```
https://app.contentful.com/spaces/{Your Space ID}/home
```

### Step 1. Install from Contentful Marketplace <a href="#od_c5ae8232" id="od_c5ae8232"></a>

**There are 2 ways:**

* To install the Contentful DAM App, visit the [Contentful Marketplace](https://www.contentful.com/marketplace/app/scaleflex-filerobot/) and click 'Install'. Follow the prompts to complete the installation.

[![](https://www.ctfstatic.com/button/install-small.svg)](https://app.contentful.com/deeplink?link=apps\&id=7jJoGTAjjjTZqedusaIU7M)

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FebgI3VxBH1tKTHMul16l%252Fimage.png%3Falt%3Dmedia%26token%3D6aa2b271-02a1-4bb8-83e7-54718fa314be&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=3ba1df83&#x26;sv=1" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/o2MQsZ2M9NrYm1khtjQc" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/u8BqwnjnHqsTfCQjA0lK" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/KVjcESHVeepjG7kjnIet" alt=""><figcaption></figcaption></figure>

### Step 2. Configure the app <a href="#od_b9b03603" id="od_b9b03603"></a>

<figure><img src="/files/nFVS1uvgenDQfgxDNlkE" alt=""><figcaption></figcaption></figure>

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FSeOX4WIOWujsLu3kX1gU%252Fimage.png%3Falt%3Dmedia%26token%3D16dd6dbd-852f-4183-a00a-883114026f8b&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=1390ac5e&#x26;sv=1" alt=""><figcaption></figcaption></figure>

**Configuration keys(\* = required):**

* **Token\*:** This is the Scaleflex DAM token found in the Asset Hub interface, which allows the app to connect to your DAM account
* **Security Template\*:** Found in the *Project > Access > Security Templates* tab, this key is required for secure access
* **Asset directory:** Defines the top-level folder for storing assets. The default is the root directory (/).

{% hint style="info" %}
*You can quickly validate your token and security template by clicking **"Validate Scaleflex DAM Setting"***
{% endhint %}

* **Limit:** The max number of files that can be added to a single field
* **Attributes:** A string containing information (JSON attributes) that you want to store in a Contentful field, separated by commas. For example: meta, info.
* **Limit Type(s):** String type, acceptable values: any or all of the following: 'image', 'video', 'audio', 'application', 'application/zip', 'application/x-zip-compressed', 'application/vnd.rar', 'application/x-rar-compressed', separated by commas.

{% hint style="info" %}
Please refresh your browser (Ctrl + F5)  each time you change the settings so they take effect.
{% endhint %}

## Usage <a href="#od_da860408" id="od_da860408"></a>

### Field Setting <a href="#field-setting" id="field-setting"></a>

* In any content model, create a new **JSON Object** Field

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FSMrQu8MAqljmRxWkIptE%252Fimage.png%3Falt%3Dmedia%26token%3D7efc1b4d-277a-4ef8-94ab-8d4077f9ad31&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=9f8ba050&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* In Appearance section, choose Scaleflex DAM

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FreLVat521BDuo6bmXmG9%252Fimage.png%3Falt%3Dmedia%26token%3Dc7f8adfe-50a5-4c71-8715-c3db50258238&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=65d02982&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Content Editor <a href="#content-editor" id="content-editor"></a>

* In any Scaleflex DAM Field, to insert assets from DAM to content, click on Asset Manager

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FOpHqS2lODn6PQRvphZQ3%252Fimage.png%3Falt%3Dmedia%26token%3D2f09f77f-1644-4c73-83db-205ef75c9a93\&width=768\&dpr=4\&quality=100\&sign=7f397bea\&sv=1)

* An Asset Dialog will appear:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FB4OvbDiI8sgeXKuL4JgW%252Fimage.png%3Falt%3Dmedia%26token%3D69d13356-6c02-4935-af91-2b4fefae7396&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=77b632c8&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Select one or more assets you want to add to the field.
* Click "Insert" on the top right corner of the opened Dialog
* You have 2 options:
  * Insert as original
  * Insert as transformed (change the image format or size before inserting)
* After inserted, assets will appear like below:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FYJ23iCKDvAqbFQQuehE6%252Fimage.png%3Falt%3Dmedia%26token%3D7a422f26-bd37-42a2-99cc-13a00a1ca5d0&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=d12d887d&#x26;sv=1" alt=""><figcaption></figcaption></figure>

**You can:**

* Reorder assets position by drag and drop

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FKF9pv21eG0gfPHjMBFxV%252Fimage.png%3Falt%3Dmedia%26token%3D04451264-9c7c-4331-892b-19da2c99a81e&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=1e2b39e6&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* You can delete unwanted asset(one by one - click on the 3 dots icon `...` then select "**Delete"**) or click "**Clear all***"* to remove all selected assets

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252Fqa8vPt4k6kAIYyNu1H2l%252Fimage.png%3Falt%3Dmedia%26token%3D37f2247b-527f-45a1-89b0-745464e68ca2&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=db71f59c&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* If any changes are done from the Hub, please use **"Refresh Assets"** button so to update Contentful

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FHVUYe7tNQo8A2PUk24oR%252Fimage.png%3Falt%3Dmedia%26token%3D60162937-dd2d-45e8-849d-7b57c933941c&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=30827701&#x26;sv=1" alt=""><figcaption></figcaption></figure>

## JSON format <a href="#od_f9476583" id="od_f9476583"></a>

The following is an example of how metadata for inserted assets is stored in JSON format within Contentful.

```
[
    {
        "url": "https://try.filerobot.com/Widget_demo_folder/%24R202RV2-AiiacoEg.jpg",
        "id": "2a9de85c-406a-5101-9ab5-7b6259250005",
        "name": "$R202RV2-AiiacoEg.jpg",
        "extension": "jpg",
        "type": "image/jpeg",
        "attributes": {
            "meta": {
                "boolean": true,
                "creator": "Hiep",
                "date": "2024-09-11",
                "dc_description": "dc description test",
                "description": {
                    "en": "neweded"
                },
                "multi_select": [
                    "Blue",
                    "Green",
                    "Yellow"
                ],
                "price": {
                    "default": "12"
                },
                "product_id": {
                    "default": "IIHHYTTD22"
                },
                "sport": "Sport test",
                "test": "None",
                "test-multi-select": [
                    "Test 2",
                    "Test 1"
                ],
                "test-price": {
                    "eur": "20"
                },
                "testsd": "2024-09-10",
                "title": {
                    "en": "testssssss"
                }
            }
        }
    }
]
```


# Contentstack

DAM Contentstack App

The features of the DAM Contentstack App include:

* **Asset Manager Widget** in Contentstack Content Management;
* **Multiple file type support**;
* **Metadata sync**: asset metadata from DAM will show on your Rest/GraphQL response.

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

1. [Register for a demo](https://www.scaleflex.com/request-a-demo) if you don't already have a DAM account.
2. Sign up to Contentstack.

## Installation <a href="#od_c5ae8232" id="od_c5ae8232"></a>

### Step 1. Install from Contentstack Marketplace <a href="#od_c5ae8232" id="od_c5ae8232"></a>

* Go to the Marketplace on your dashboard and search "Scaleflex"

<figure><img src="/files/E9MqRnIxRqt76i0gpESW" alt=""><figcaption></figcaption></figure>

* Then click on "Filerobot By Scaleflex" and install the application

<figure><img src="/files/oLYUKEtD63YJVPnepUfY" alt=""><figcaption></figcaption></figure>

### Step 2. Configure the app <a href="#od_b9b03603" id="od_b9b03603"></a>

<figure><img src="/files/5n6l1yz20FvhKkaD3FWY" alt=""><figcaption></figcaption></figure>

* **Security Template Identifier:** Found in the *Project > Access > Security Templates* tab, this key is required for secure access
* **Token:** Your DAM token from the Asset Hub interface
* **Attributes:** Fill in the attribute you want to get in the response. **Ex:** meta, info, tags,...

## Usage <a href="#od_da860408" id="od_da860408"></a>

1. Custom Field
2. JSON Rich Text Editor

### 1. Custom Field <a href="#od_c5ae8232-1" id="od_c5ae8232-1"></a>

Step 1. On Content Type Menu\
&#x20;![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FBWEIFlr4zi8nGMh7BgC8%252Fimage.png%3Falt%3Dmedia%26token%3D0e653795-9cb8-4b9e-acb3-55bf361ff353\&width=300\&dpr=4\&quality=100\&sign=10ee709d\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FoNITw1dMPvV81LPsIHz4%252Fimage.png%3Falt%3Dmedia%26token%3D63897222-a3f2-4853-b526-524ad9d3a4c9\&width=300\&dpr=4\&quality=100\&sign=7a691397\&sv=1)

Step 2. Select Scaleflex Filerobot

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FsA1DSInG59fDYtcBqOBr%252Fimage.png%3Falt%3Dmedia%26token%3Db75bfd59-2f50-4e7f-a4b6-9472a3774ea1\&width=300\&dpr=4\&quality=100\&sign=ff57db49\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252Fe3crI6kuktigecnWX9Vz%252Fimage.png%3Falt%3Dmedia%26token%3Db1c0b2ac-101f-4c62-85bc-3799600b5651\&width=300\&dpr=4\&quality=100\&sign=2084287d\&sv=1)\
&#x20;Step 3. Save and Close

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FUBM9gQhiusdA9ZzYb2rA%252Fimage.png%3Falt%3Dmedia%26token%3D42fd685c-347d-4b42-b20a-b2fde148ed5c&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=ee13239c&#x26;sv=1" alt=""><figcaption></figcaption></figure>

Step 4. On Your Entry, open "Scaleflex DAM" and choose an image

<figure><img src="/files/4q0qMZDZabFNZHQoEios" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/iHCX5yCjFByPL8be1dda" alt=""><figcaption></figcaption></figure>

Step 5. Publish

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FCy0DE2S4RrHMn4laFLeJ%252Fimage.png%3Falt%3Dmedia%26token%3D506e6937-4bd3-4b3f-9d90-e6cff06ef811&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=e082fc23&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### 2. JSON Rich Text Editor <a href="#od_c5ae8232-2" id="od_c5ae8232-2"></a>

Step 1. On the Content Type Menu \
\
![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F8HPT1kIYEix9Y5f0Zwfw%252Fimage.png%3Falt%3Dmedia%26token%3Dc7e978f7-daeb-444d-bff2-53935468b582\&width=300\&dpr=4\&quality=100\&sign=3a2322c3\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252Fb6Z24vtvltIRiXHHdNHV%252Fimage.png%3Falt%3Dmedia%26token%3D877ff741-65a2-4568-9fd4-d8624c08116f\&width=300\&dpr=4\&quality=100\&sign=112b831\&sv=1)

\
Step 2. Select Scaleflex DAM\
&#x20;![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FIs83pzc9rffkVfb1dmXn%252Fimage.png%3Falt%3Dmedia%26token%3D7b9ea356-fb66-4c2a-8e15-00ca7b93851f\&width=300\&dpr=4\&quality=100\&sign=d7f86cd2\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FTEWavbkLdzs3mduRDmOu%252Fimage.png%3Falt%3Dmedia%26token%3D77dd0a71-4473-4e7a-8811-44ff8ba54be2\&width=300\&dpr=4\&quality=100\&sign=e8addb84\&sv=1)

Step 3. Save and Close

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FmY6OnCfC2qxl5eowovDP%252Fimage.png%3Falt%3Dmedia%26token%3Da1cf55b1-6cf4-459f-b5d8-1093b1fc7247&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a4f59840&#x26;sv=1" alt=""><figcaption></figcaption></figure>

Step 4. In your editor, open "Scaleflex DAM" and choose an image

<figure><img src="/files/gy8kkSqO6XFsaOHurVxN" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/CGHxbSXOq3A3o7aVETR1" alt=""><figcaption></figcaption></figure>

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FWXvsEUE23uGHjmGoYlMZ%252Fimage.png%3Falt%3Dmedia%26token%3D8ddb29eb-386e-4938-b946-9c665e55d4cc&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=b43a6a00&#x26;sv=1" alt=""><figcaption></figcaption></figure>

## JSON format <a href="#od_f9476583" id="od_f9476583"></a>

1. Custom Field

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FXKnWvZqnTHTRCa7mYDTu%252Fimage.png%3Falt%3Dmedia%26token%3D33a7a8d5-0670-4776-b9af-6b0bf4365038&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=2015e97b&#x26;sv=1" alt=""><figcaption></figcaption></figure>

1. JSON Rich Text Editor

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FJYGCians7VaK1XmNscfI%252Fimage.png%3Falt%3Dmedia%26token%3D20efe071-2fef-487a-bb83-f96b516eee01&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=b0557cd9&#x26;sv=1" alt=""><figcaption></figcaption></figure>


# Directus

Scaleflex DAM x Directus extension

## Installation <a href="#od_1e92263f" id="od_1e92263f"></a>

### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

* [Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have a Scaleflex DAM account.
* Need to add a config CONTENT SECURITY POLICY to your **.env** file

```
CONTENT_SECURITY_POLICY_USE_DEFAULTS: true
CONTENT_SECURITY_POLICY_DIRECTIVES__SCRIPT_SRC: "'self','unsafe-eval',*.scaleflex.com,cdn.tiny.cloud"
CONTENT_SECURITY_POLICY_DIRECTIVES__IMG_SRC: "'self',data:,blob:,https://raw.githubusercontent.com,https://avatars.githubusercontent.com,*.filerobot.com,*.tinymce.com"
CONTENT_SECURITY_POLICY_DIRECTIVES__MEDIA_SRC: "'self', *.filerobot.com"
```

### Step 1: Install the extension via Marketplace or via NPM

**Marketplace:**

<figure><img src="/files/KOlyflCI9OihXXEqCsfk" alt=""><figcaption></figcaption></figure>

**NPM Install:**

```
npm i @plugins_sfx/directus-extension-scaleflex-dam
```

### Step 2: Active the Scaleflex DAM extension

Click on **"Settings"** on the left menu and after that click **"Extensions"** on the sub-menu.

<figure><img src="/files/ii2duUxlrtaMMAvG7Wna" alt=""><figcaption></figcaption></figure>

### Step 3: Show the extension on the left menu

Click **"Settings"** on the left menu and then click **"Settings"** on the sub-menu.

Scroll to block **Modules** and check two items **"Scaleflex DAM Settings"** and **"Scaleflex DAM"**

<figure><img src="/files/3yuXSFXXN8Ldv97Cg5xC" alt=""><figcaption></figcaption></figure>

### Step 4: Fill in your configuration

<figure><img src="/files/2fdJDQPlSsT8PRZysXBl" alt=""><figcaption></figcaption></figure>

* **Token:** Enter your Scaleflex DAM token here (eg: abcdefgh).
* **Security Template:** To load the Scaleflex DAM Widget, you must create a Security Template in your Scaleflex DAM Hub.
* **Root directory:** The directory in your Scaleflex DAM account, where the files will be stored.
* **TinyMCE Key:** API key required for TinyMCE when using it with DAM, Here’s a guide on how to get the key: [How to get tinymce cloud up in less than 5 minute](https://www.tiny.cloud/blog/how-to-get-tinymce-cloud-up-in-less-than-5-minutes/)

**Advanced Configuration**

* **CNAME:** Enter the CNAME as configured in your Scaleflex DAM Hub interface, once validated and the SSL certificate accepted. (Or leave blank if none). **Note:** To use the CNAME, you need to add your domain to the environment variable `CONTENT_SECURITY_POLICY_DIRECTIVES__IMG_SRC` and `CONTENT_SECURITY_POLICY_DIRECTIVES__MEDIA_SRC` in your Directus instance.
  * **Example value**: assets.yourdomain.com
* **Limit:** The maximum number of files that can be added to a single field, default: 0 (unlimited).
* **Attributes:** Attribute from Scaleflex DAM asset that you want to include in the Client response.
* **Limit Type:** File types are limited when using the Widget.

## How to use the Scaleflex DAM field?

### 1. Field Interface

{% tabs %}
{% tab title="1. Field interface" %}
When create new field with DAM Assets please choose Scaleflex DAM

<figure><img src="/files/Xj7Vk8A5Pz8CfwadLKUt" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="2. Configuration" %}
There are some configurations:

Please aware that these configuration will override default configuration in Setting Page.

| Config         | Explain                                                                                  | Example |
| -------------- | ---------------------------------------------------------------------------------------- | ------- |
| **Limit**      | The maximum number of files that can be added to a single field, default: 0 (unlimited). |         |
| **Attributes** | Attribute from Scaleflex DAM asset that you want to include in Client response.          |         |
| **Limit Type** | File types are limited when using Widget.                                                |         |
| {% endtab %}   |                                                                                          |         |

{% tab title="3. Display" %}

{% endtab %}
{% endtabs %}

**1/** Create a new field **"Scaleflex DAM"**

<figure><img src="/files/BI239rAGG1hN15bhcu3k" alt=""><figcaption></figcaption></figure>

**2/** Select your display type

On the list fields, select the new field just created. On the tab **"Display"**, choose **"DAM Assets"**.

<figure><img src="/files/L71VKXEujlFsfXvw3CaF" alt=""><figcaption></figcaption></figure>

**3/** Go to your content Model and you will see the new field just created. Click on **"Browse Assets"** to select the assets in **Scaleflex DAM**

<figure><img src="/files/hWksLcGzkXPm9Z1BnWjV" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/oMvwBv45pHMnQdnykENR" alt=""><figcaption></figcaption></figure>

The result displayed after adding the assets

<figure><img src="/files/zgUi7bZuqY1bq8sY7skA" alt=""><figcaption></figcaption></figure>

You can modify the image by clicking on **"Show variants"** to resize or crop the image.

<div><figure><img src="/files/8u80o850kxHdYkexk4tI" alt=""><figcaption></figcaption></figure> <figure><img src="/files/UCi2jbLHcJPyL0GFmgJO" alt=""><figcaption></figcaption></figure></div>

In the list of items

<figure><img src="/files/f6EKQSIGI6mOxcv0IAPW" alt=""><figcaption></figcaption></figure>

## Advanced Configuration Display

You can set the limit asset showing in the list of items.

In the **Field Settings**, click on the tab **"Display"** and choose **DAM Assets**. Input the limit items you want to show in the list.

<figure><img src="/files/jdh3tavUUoLn4DVuPx0f" alt=""><figcaption></figcaption></figure>

And the last thing, you can configure your variants asset in the tab **"Interface"**. For example:&#x20;

```
{
    "variants": [
        {
            "code": "desktop",
            "name": "Desktop",
            "preset": {
                "width": "200",
                "height": "400"
            }
        },
        {
            "code": "tablet",
            "name": "Tablet",
            "preset": {
                "width": "100",
                "height": "200"
            }
        }
    ]
}
```

## Using TinyMCE Editor with Scaleflex DAM

**1/** Create a new field **"WYSIWYG with Scaleflex DAM"**

<figure><img src="/files/9lmDSmJV8SFftNoXpwhM" alt=""><figcaption></figcaption></figure>

**2/** Using the editor, click on the button "DAM" to add the asset to your content.

Support image, video, and audio.

<div><figure><img src="/files/tCkQSXzCXmcVCwQdtMx8" alt=""><figcaption></figcaption></figure> <figure><img src="/files/yKT0Vlmz0kpUZ8QUi8Tm" alt=""><figcaption></figcaption></figure></div>


# Drupal

DAM Drupal module

### Installation <a href="#od_1e92263f" id="od_1e92263f"></a>

#### Step 1. Download and install <a href="#step-1.-download-and-install" id="step-1.-download-and-install"></a>

**Download from Github**

* Step 1: Download the latest version from <https://www.drupal.org/project/filerobot_by_scaleflex/releases>;
* Step 2: Extract the zip file in `/modules`;
* Step 3: In the Drual admin, navigate to *Extend* / find *Filerobot* *by Scaleflex* / *Install*

**Install with Packagist**

* Step 1: Run `composer require 'drupal/filerobot_by_scaleflex:^1.0'`
* Step 2: In the Drupal admin, navigate to *Extend* / find *Filerobot by Scaleflex* / *Install*

![](https://store.filerobot.com/opendocs-global/project_test/11e27277731a6427e8a2407eb54d3de6b8e98ced6d5470370d44b54297aaeea2.png)

#### Step 2. Configure <a href="#od_ebdb8e0c" id="od_ebdb8e0c"></a>

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FhbG2iSyn0ea3GJ8fdcv0%252Fconfiguration-module.png%3Falt%3Dmedia%26token%3D4bf65817-cc25-4839-a82a-b53e0b114f55\&width=768\&dpr=4\&quality=100\&sign=2ee2c012\&sv=1)

* **Activation**: You can enable or disable the module;
* **Token**: Your token from the DAM;
* **CNAME**: If you have a CNAME configure in DAM, you can enter it in this field;
* **Security Template Identifier:** To load the DAM Widget or DAM Image Editor, you need to create a [Security Template](/vxp-visual-experience-platform/settings/project/access/security-templates) in your DAM Asset Hub first. This will grant your Drupal instance the necessary credentials to access your storage;
* **DAM upload directory:** The directory in your DAM account where the files will be stored.

### Action needed when updating a Media Image <a href="#od_c050f4be" id="od_c050f4be"></a>

You need to click the *Update widget* to load the image after choosing the image from the DAM widget.

<figure><img src="https://store.filerobot.com/opendocs-global/1f3add16630c3b71dca093adb62dec852755120b10914d7ececf344b074b363d.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://store.filerobot.com/opendocs-global/a990fbeac8e85f2c32ea64d704e3c598b442e269a7780a1da710faa95a46cd9c.png" alt=""><figcaption></figcaption></figure>


# Opencart

DAM Opencart plugin

The DAM Plugin is an extension which adds Asset Management to Opencart.

There are 3 simple steps for enabling the DAM plugin on your Opencart admin:

* Obtain a DAM token (request it [here](https://www.scaleflex.com/request-a-demo));
* Install the DAM module for Opencart;
* Add your security configuration parameters to access your DAM library.

### **Limitations** <a href="#limitations" id="limitations"></a>

Currently, the plugin supports the default WYSIWYG editor from Opencart - Summernote, but the native "Image resize" function is disabled. You can change the image size by removing the previous one then add it with new dimensions (a dedicated function will be added in the next version).

### Installation <a href="#od_a4f55725" id="od_a4f55725"></a>

#### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

[Register for a demo](https://www.scaleflex.com/request-a-demo) if you don't already have a DAM account.

#### Step 1: Upload the plugin <a href="#step-1-upload-the-plugin" id="step-1-upload-the-plugin"></a>

* Upload the `admin` folder in `upload/admin` to your Opencart source code.
* Login to the Admin Dashboard, navigate to *Extensions/Installers* and upload the `scaleflex_filerobot.ocmod.zip` file. Then, go to *Modification* and click *Reload* to update the installer.

#### Step 2: Configure and activate the plugin <a href="#step-2-configure-and-activate-the-plugin" id="step-2-configure-and-activate-the-plugin"></a>

Navigate to *Extensions/Extensions*, choose *Modules* from the drop-down menu, select *DAM* and update all configurations.

* **DAM Token:** Your DAM token from the Asset Hub interface;
* **Security Template Identifier:** Security template ID, found in the *Project > Access > Security templates*;
* **DAM upload directory:** This is the top storage folder for your assets.

{% hint style="info" %}
*Please create the folder in DAM first to prevent error.*
{% endhint %}

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FpHakvBI9oUWxytpzUtpM%252Fo1.png%3Falt%3Dmedia%26token%3D3b3a28a6-908e-46ff-a426-738daa6a0ee2&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=32d941a5&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Usage <a href="#od_687683f1" id="od_687683f1"></a>

You need to enable the extension in order to use DAM in all pages.

#### **Step 1: Open MAW (Media Asset Widget)** <a href="#step-1-open-fmaw-filerobot-media-asset-widget" id="step-1-open-fmaw-filerobot-media-asset-widget"></a>

With Summernote:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FyE3mFHCGmDZOviA4m4dv%252Fo2.png%3Falt%3Dmedia%26token%3D8231a340-62a4-4a5b-913a-2f01edf6c88d&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a8229265&#x26;sv=1" alt=""><figcaption></figcaption></figure>

With Image field:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FUT4N2rDfxVQhFlQlEF3s%252Fo3.png%3Falt%3Dmedia%26token%3D86d27841-7554-4a16-a449-2705bf6eeb7b&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=1f8f7ab7&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### **Step 2: Choose the image(s), then click insert button** <a href="#step-2-choose-the-image-s-then-click-insert-button" id="step-2-choose-the-image-s-then-click-insert-button"></a>

If you are on Summernote: You can select multiple images for insertion.

If you are in an Image Field: You should select only one. If you selected multiple items, it will use the last one, as Opencart's Image Field inserts only one image at a time.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FYrxlmLB1CISXRV6hYsnW%252Fo4.png%3Falt%3Dmedia%26token%3De63af51e-f212-47b6-aae5-c7b7196fcc5e&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=39186b26&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Developer's den <a href="#od_f8f03ba2" id="od_f8f03ba2"></a>

This extension is 100% compatible with the default theme.

If you use another theme (stock or custom), you should verify that the image is indeed from DAM before returning data to the view. An examples for banners would be:

```
foreach ($banner_images as $key => $value) {
    foreach ($value as $banner_image) {
                if (strpos($banner_image['image'], 'filerobot')) { // Check if image URL contain "filerobot"
                    $data['banner_images'][$key][] = array(
                        'title'      => $banner_image['title'],
                        'link'       => $banner_image['link'],
                        'image'      => $banner_image['image'],
                        'thumb'      => $banner_image['image'] . '&width=100&height=100', // return with dimensions
                        'sort_order' => $banner_image['sort_order']
                    );
                } else {
                    if (is_file(DIR_IMAGE . $banner_image['image'])) {
                        $image = $banner_image['image'];
                        $thumb = $banner_image['image'];
                    } else {
                        $image = '';
                        $thumb = 'no_image.png';
                    }

                    $data['banner_images'][$key][] = array(
                        'title'      => $banner_image['title'],
                        'link'       => $banner_image['link'],
                        'image'      => $image,
                        'thumb'      => $this->model_tool_image->resize($thumb, 100, 100),
                        'sort_order' => $banner_image['sort_order']
                );
  }
}
```


# Opencart (v4)

DAM x Opencart v4 plugin

The DAM Plugin is an extension which adds Asset Management to Opencart.

There are 3 simple steps for enabling the DAM plugin on your Opencart admin:

* Obtain a DAM token (request it [here](https://www.scaleflex.com/request-a-demo));
* Install the DAM module for Opencart;
* Add your security configuration parameters to access your DAM library.

### Installation <a href="#od_a4f55725" id="od_a4f55725"></a>

#### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

[Register for a demo](https://www.scaleflex.com/request-a-demo) if you don't already have a DAM account.

#### Step 1: Upload the plugin <a href="#step-1-upload-the-plugin" id="step-1-upload-the-plugin"></a>

* Login to **Admin Dashboard**
* Go to Extensions > Installer and upload the file **filerobot.ocmod.zip**
* Install DAM plugin

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FXNamemFRHGrLgJG9j8De%252Fimage.png%3Falt%3Dmedia%26token%3Daf9f3dbc-5a9e-44eb-b396-76195c07bcf9\&width=768\&dpr=4\&quality=100\&sign=76798cf4\&sv=1)

#### Step 2: Configure and activate the plugin <a href="#step-2-configure-and-activate-the-plugin" id="step-2-configure-and-activate-the-plugin"></a>

Navigate to *Extensions/Extensions*, choose *Modules* from the drop-down menu, select *Filerobot* and update all configurations.

* **DAM Token:** Your DAM token from the Asset Hub interface;
* **Security Template Identifier:** Security template ID, found in the *Project > Access > Security templates* tab;
* **DAM upload directory:** This is the top storage folder for your assets.

{% hint style="info" %}
*Please create the folder in DAM first to prevent errors.*
{% endhint %}

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FGZwBos1eXGr0KSQ7TrWL%252Fimage.png%3Falt%3Dmedia%26token%3Da0944f3d-2354-4416-94bd-74ac062034ce&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=76b78dd7&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Usage <a href="#od_687683f1" id="od_687683f1"></a>

You need to enable the extension in order to use DAM in all pages.

#### **Step 1: Open MAW (Media Asset Widget)** <a href="#step-1-open-fmaw-filerobot-media-asset-widget" id="step-1-open-fmaw-filerobot-media-asset-widget"></a>

With Ckeditor:

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FPoJbnmxH9FpnkQeeHJ26%252Fimage.png%3Falt%3Dmedia%26token%3Dc3f5a5d3-114f-4372-bc34-c2a9b88e02ff\&width=768\&dpr=4\&quality=100\&sign=c56d35fd\&sv=1)

With Image field:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FlRhzTsj1mz7f3GxW7KmD%252Fimage.png%3Falt%3Dmedia%26token%3D57d10454-3254-4156-9fb2-f09deeb9259f&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=902f6dc1&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### **Step 2: Choose the image(s), then click insert button** <a href="#step-2-choose-the-image-s-then-click-insert-button" id="step-2-choose-the-image-s-then-click-insert-button"></a>

If you are on Ckeditor: You can select multiple images for insertion.

If you are in an Image Field: You should select only one. If you selected multiple items, it will use the last one, as Opencart's Image Field inserts only one image at a time.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FlXT76GMWmc7v3q93CMIe%252Fimage.png%3Falt%3Dmedia%26token%3D9cabf541-7fa5-4291-a07b-dac46e08a798&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=9a7274a5&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Developer's den <a href="#od_f8f03ba2" id="od_f8f03ba2"></a>

This extension is 100% compatible with the default theme.

If you use another theme (stock or custom), you should verify that the image is indeed from DAM before returning data to the view. An examples for banners would be:

Copy

```
foreach ($banner_images as $key => $value) {
    foreach ($value as $banner_image) {
                if (strpos($banner_image['image'], 'filerobot')) { // Check if image URL contain "filerobot"
                    $data['banner_images'][$key][] = array(
                        'title'      => $banner_image['title'],
                        'link'       => $banner_image['link'],
                        'image'      => $banner_image['image'],
                        'thumb'      => $banner_image['image'] . '&width=100&height=100', // return with dimensions
                        'sort_order' => $banner_image['sort_order']
                    );
                } else {
                    if (is_file(DIR_IMAGE . $banner_image['image'])) {
                        $image = $banner_image['image'];
                        $thumb = $banner_image['image'];
                    } else {
                        $image = '';
                        $thumb = 'no_image.png';
                    }

                    $data['banner_images'][$key][] = array(
                        'title'      => $banner_image['title'],
                        'link'       => $banner_image['link'],
                        'image'      => $image,
                        'thumb'      => $this->model_tool_image->resize($thumb, 100, 100),
                        'sort_order' => $banner_image['sort_order']
                );
  }
}
```


# Prestashop

DAM Prestashop plugin

### **Known limitations** <a href="#known-limitations" id="known-limitations"></a>

* Supports the default versions of Product Media and TinyMCE (and not other TinyMCE Plugins);
* Supports Prestashop from version 1.7.8.7 onwards.

### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

[Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have a DAM account.

### Installation <a href="#od_c6f89f9d" id="od_c6f89f9d"></a>

#### Step 1. <a href="#step-1" id="step-1"></a>

**- Download the DAM module**

* Step 1:  [Download Latest release of Module](https://github.com/scaleflex/prestashop-filerobot-plugin/releases)
* Step 2: Unzip the file and change the folder name to "DAM"
* Step 3: Zip the file with the name "DAM.zip"
* Step 4: In Admin go to Modules/Module Manager -> Upload the Zipped file

**- From the Marketplace**

* Step 1: In Admin go to Modules/Module Catalog and search for "Filerobot by Scaleflex"
* Step 2: Click "Install"

**3. Configuration**

* Step 3: Go to Modules/Module Manager -> Other Section -> Click on Configure on "Filerobot by Scaleflex"

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FXeeaFMjTLjyKFkKe6AOV%252Fp1.png%3Falt%3Dmedia%26token%3D1c377912-acc3-4833-b17b-c07d3d084ba0&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=d066987e&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Step 4: Update the configuration (credentials) and activate the Module, then your site is ready to go.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FEdQR0YbXGZP7VlnCLBQn%252Fp2.png%3Falt%3Dmedia%26token%3D09219adf-589a-4af1-9537-e51e98d50345&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=2bae15df&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* **Activation**: Enable/Disable the module
* **Token**: Your DAM Token
* **Security template identifier**: Your DAM security template (in *Project > Access > Security templates* tab)
* **DAM upload directory**: The directory where you want to store/manage assets

**4. User guide**

**Product media**

* Go to Catalog/Product -> Click `+` button in Product Images

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FcZLn3lqnTYGWsppLrZh4%252Fp3.png%3Falt%3Dmedia%26token%3D13b307f0-938a-4d49-acf2-edb6942ddc14&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=398c30c1&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Choose images and click `Insert`

**Product WYSIWYG**

* Click the `image` icon on WYSIWYG
* Then it is the same as for a Product Media click `Insert` after choosing your image(s)

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F7JsLTeo26IqNO8O4GWs3%252Fp4.png%3Falt%3Dmedia%26token%3Dcec51c24-2fd4-4965-b366-5f7085dd0c9f&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a2ee4af5&#x26;sv=1" alt=""><figcaption></figcaption></figure>


# Shopware

DAM Shopware module

## Installation <a href="#od_1e92263f" id="od_1e92263f"></a>

### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

[Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have a DAM account.

### Download and install the module <a href="#step-1.-download-and-install-the-module" id="step-1.-download-and-install-the-module"></a>

#### **Install from Github**

* Step 1:  [Download Latest release of Module](https://github.com/scaleflex/shopware-filerobot-plugin/releases)
* Step 2: Rename the Zip file with the name *DAM.zip*
* Step 3: In Admin go to *Extensions* / *My extensions* / *Upload extension*

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FXKzuVtRzrTEGJLOxLwE4%252Fs1.png%3Falt%3Dmedia%26token%3D873f6bd4-a775-4cb4-bb17-f4c040c28507&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=17d9a637&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### **Install from Shopware Store**

* Step 1: In Admin go to *Extensions* / *Store* / *Catalog* and search for "Filerobot by Scaleflex":

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FaTaLDZNbFMb70PQ13Vqz%252Fs2.png%3Falt%3Dmedia%26token%3D68823b3d-a56e-46ff-864a-2bceaec120bd&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=4613a062&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Step 2: Select the extension and choose *Add extension:*

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F9kQPXeAtIlaXP00fSZ8t%252Fs3.png%3Falt%3Dmedia%26token%3D82a62352-398b-44c0-a2ae-4bd9d574b368&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=74dc5848&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Step 3: Go to *Extensions* / *My extensions* / *Filerobot by Scaleflex - Digital Asset Management, Media Optimisation and Acceleration* / choose *Configuration:*

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252Fzs41ZKqLMxy8kOqkDgEw%252Fs4.png%3Falt%3Dmedia%26token%3D3980f70f-123f-4f04-854d-ddae380df6aa&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=5e361dda&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Step 4: Update the configuration and activate the Module and your site is ready to go:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F5wA8pdWqVjopeWFCBLPa%252Fs5.png%3Falt%3Dmedia%26token%3D18f41e4d-7488-4587-9dfd-7cfb4be62a0e&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=3dc44af9&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Configure <a href="#od_ebdb8e0c" id="od_ebdb8e0c"></a>

* **Admin access key ID:** Need to generate in "Setting" to call API in Admin Dashboard;
* **Admin secret access key:** Need to generate in "Setting" to call API in Admin Dashboard;
* **Folder Id:** This key will auto-generate when the plugin is activated;
* **Activation**: Enable/Disable the module;
* **Token**: Please enter your DAM token here;
* **CNAME**: Enter the CNAME as per the configuration in your DAM Asset Hub interface, once validated and the SSL certificate is accepted. (Or leave blank if none);
* **Security Template Identifier:** To load the DAM Widget or DAM Image Editor, you need to create a [Security Template](/vxp-visual-experience-platform/settings/project/access/security-templates) in your DAM Asset Hub first in order for your Shopware instantiation of the DAM Widget to obtain proper credentials and access your storage;
* **DAM upload directory:** The directory in your DAM account where the files will be stored.

The step to get **"Admin access key ID"** and **"Admin secret access key"**:<br>

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FiXX4qh9zPhxJgc9OlhwZ%252Fs6.png%3Falt%3Dmedia%26token%3D90d49a0d-988c-4b35-ac32-8e150252817e&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a2df77ab&#x26;sv=1" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/L318gnh5bjaVt2CI5xWf" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/YqnKdZADqqMyo8nwAnb0" alt=""><figcaption></figcaption></figure>


# Storyblok

DAM Storyblok App

### Installation <a href="#od_4941c597" id="od_4941c597"></a>

#### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

1. [Register for a demo](https://www.scaleflex.com/request-a-demo) if you don't already have a DAM account.
2. Sign up to Storyblok.

#### Step 1. Installation <a href="#od_c5ae8232" id="od_c5ae8232"></a>

You can find the Scaleflex DAM in the [Storyblok Marketplace](https://www.storyblok.com/apps/external/scaleflex-dam), clicking the Visit Website button will link to this page containing all instructions.

Note that *requesting an installation delegation* can be done via our [contact form](https://www.scaleflex.com/contact-us) or our support email <hello@scaleflex.com>, and finally using our regular [support page](https://scaleflex.zendesk.com/hc/en-gb/requests/new).

Make sure you complete, in any case, **each of the following steps fully**:

1. Send us the *installation delegation request*, including
   * Your Storyblok "Space ID" (find it in the settings, in General / Space)
   * Your preference of installation type ( Field Plugin, or App level -default- )
2. Add (invite) our Plugins Installation team to your Space
   * Use <register@scaleflex.com> (you can remove this user once the installation is completed)
   * with "Admin" role (otherwise the installation is not possible)

Our support team will contact you back to confirm the installation date and make sure you have everything configured properly to start using the Scaleflex DAM plugin.

Once this is done, you will be able to find the new block in your "Block Library" under the name "DAM" and be ready to go!

Depending on your level of support and onboarding plan, a CSM can assist you for the next steps: setup and configuration.

#### Step 2. Setup & configuration <a href="#od_b9b03603" id="od_b9b03603"></a>

You have 3 required configuration items to take from the Asset hub: **Token** (the unique project or library identifier), **Security Template** (this will be used as the secret for authentication), **Directory** (where you want Storyblok's assets to be stored and retrieved from, usually a dedicated sub-directory; note that this field must be comprised under the directory limit of the Security Template you have selected) And there are optional fields: **limit, attributes**

You can add as many blocks containing the DAM field type as needed. There is no limit on the number of blocks you can include.

1. Go to **Block Library** -> **New Block**
2. Enter any Technical Name you want, Select **Nestable Block** -> click "**Add Block**"
3. In the side modal "Edit \[Technical Name]" that appeared, enter any name as Field (eg. DAM\_Asset), then select the **type of field as plugin** -> click "**Add**"

   <figure><img src="/files/OK8vHFVBFfrTXueiIIGr" alt=""><figcaption></figcaption></figure>
4. Click on the field just added (in the "General" section below), then scroll down to the Plugin Options, then choose "filerobot-storyblok" in the Custom Type drop-down. Add the 3 configuration keys you gathered from the DAM and set up like below:
   * **token** = Token from DAM (aka project identification code)
   * **secTemplate** = Security template from DAM
   * **rootDir** = Base directory (also in the security template configuration)
   * **cname** (optional) = Custom CNAME; check your CNAME configuration in Hub [here](https://hub.scaleflex.com/settings/dmo/delivery/cname)
   * **limit** (optional) = number of files you can show when choosing on DAM Asset
   * **attributes** (optional) = add more data on API Response Structure (ex: meta, tags, owner)
     * if "meta" is used, then all custom metadata will be sent along the asset's URL in the json,
     * if "meta\[key1, key2, ...]" is used, only the metadata(s) specified in the list will be sent.
   * **limitType** (optional) = File Type Filtering ( ex: image, video, audio, application, application/zip, application/x-zip-compressed, application/vnd.rar, application/x-rar-compressed )
   * **forceFilters** (optional) = Advanced search metadata filters (<mark style="color:red;">feel free to contact us to confirm your use case so our support can provide the exact setting, adapted to your requirement</mark>)\
     Eg.. if you want to show only assets that have `expired_date` metadata field greater or equal today: you can use \[{"key": "`expired_date`", "value": \["$CURRENT\_DATE..", "EMPTY"]}]
   * **assetPickerConfig** (optional) = A JSON string to customize the asset picker (ex, {"enableAISearch": false, "transformations": false}). Defaults: multiSelect, showMetadata, rememberLastTab, rememberLastFolder, and rememberLastView are all true. Read the documentation [here](https://scaleflex.github.io/asset-picker/#/docs/configuration)

     **Attention:** when "enableAISearch": true, it will allow users to run AI searches in the library. It is available on the assumption that a Visual AI package is part of your subscription and that you have previously activated image embedding on your library and for uploads, and that you have enough AI credits to run some specific AI requests (eg, find similar). Please contact your administrator and our support team if you are unsure.

<figure><img src="/files/xvMf3FwrAnLXMYkSvdph" alt=""><figcaption><p>Example Config</p></figcaption></figure>

Example for **assetPickerConfig:**\
**Note:** If you want to use the cdn\_permalink, you need to put the value **"url"** into the **attributes** key

```
{
  "transformations": false
  "enableAISearch": true,
  "apiFields": [
    "cdn_permalink" // To use the CDN permalink if your token supported
  ],
  // To apply your filters into the block, it can be metadata or file type
  "forcedFilters": {
    "type": {
      "values": [
        "image"
      ]
    },
    "authorized_for_external_usage": {
      "values": [
        "true"
      ]
    }
  }
}
```

\
Note: Show complete Metadata work if the token has the relevant permission. The list project configuration default shows the title and description.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FZebZP6cGfQPNpQhmA0zf%252Funnamed%2520%281%29.png%3Falt%3Dmedia%26token%3Dcc9c9f14-db0c-4b5a-80e0-2b54df24fcf5&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=fc8ef92c&#x26;sv=1" alt=""><figcaption></figcaption></figure>

Below are the 3 configuration steps illustrated:

New BlockNew Field TypeField Required SettingsField Optional Settings

Add New Block

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FBVz8PcnWllQ9A5h7i56h%252FScreenshot%25202024-05-29%2520at%252010.43.38.png%3Falt%3Dmedia%26token%3D4cb28077-1071-48db-9455-a81bee140e5d&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=e917c113&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### User guide <a href="#user-guide" id="user-guide"></a>

1. In any Content, type Edit Page
2. Click Add Block, Choose the Block contain the DAM Field you want to add to the Page:

{% tabs %}
{% tab title="Add Block" %}

<figure><img src="/files/cZyMUnWiKIyOA03OmKKQ" alt="" width="375"><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Insert Block Type"DAM"" %}

<figure><img src="/files/BnTwXuVgeP1cPzuaajaa" alt="" width="375"><figcaption></figcaption></figure>
{% endtab %}

{% tab title=" Result" %}
&#x20;

<figure><img src="/files/cwl1hCn0TjBCE3DubSRX" alt="" width="375"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

It is now possible to interact with your DAM library assets directly from Storyblok:

| # | Action            | How to                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| - | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1 | Add Assets        | 1/ Click Add Assets 2/ Asset picker modal: Choose any asset(s) you want to insert 3/ On top of the modal: Click Insert ![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FmxeuQoCCg33ktDRZoFpl%252Fimage.png%3Falt%3Dmedia%26token%3D74c1ae95-208e-415f-a583-6bbfad9db896\&width=300\&dpr=4\&quality=100\&sign=2652b984\&sv=1) 4/ Result ![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FxOW6bANQU4PgvKS1EBZY%252Fimage.png%3Falt%3Dmedia%26token%3Dd954dc86-93bc-4d4f-a7b5-a6b6de155a39\&width=300\&dpr=4\&quality=100\&sign=87083fca\&sv=1) |
| 2 | Reorder           | Drag and drop to sort assets                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| 3 | Remove Asset      | On each added Asset -> Click the *Bin* icon to remove one Item                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| 4 | Remove all Assets | To remove (delete) all Assets, click the red "Remove all assets" in the top right corner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

### API Response Structure <a href="#api-response-structure" id="api-response-structure"></a>

```
[
  {
    "uuid": "2a9de85c-406a-5101-9ab5-7b6259250001",
    "name": "$R202RV2-AiiacoEg.jpg",
    "cdn": "https://try.filerobot.com/Widget_demo_folder/%24R202RV2-AiiacoEg.jpg",
    "extension": "jpg",
    "source": "filerobot",
    "type": "image/jpeg"
  },
  {
    "uuid": "c83ca796-00e5-5c08-b87c-cd6ecee50000",
    "name": "012871.tif",
    "cdn": "https://try.filerobot.com/Widget_demo_folder/012871.tif",
    "extension": "tif",
    "source": "filerobot",
    "type": "image/tiff"
  }
]
```

### API Response Structure Have Add Attributes Option <a href="#api-response-structure-have-add-attributes-option" id="api-response-structure-have-add-attributes-option"></a>

```
[
  {
    "uuid": "2a9de85c-406a-5101-9ab5-7b6259250002_0",
    "name": "$R202RV2-AiiacoEg.jpg",
    "cdn": "https://try.filerobot.com/Widget_demo_folder/%24R202RV2-AiiacoEg.jpg",
    "extension": "jpg",
    "source": "filerobot",
    "type": "image/jpeg",
    "attributes": {
      "meta": {
        "boolean": null,
        "date": "",
        "description": {
          "en": "neweded"
        },
        "malt_id": "",
        "multi_select": null,
        "number": "",
        "price": {
          "default": "12"
        },
        "product_id": {},
        "sales_tags": {},
        "select_one": null,
        "shouldbedeleted": "",
        "sku": "",
        "sport": "",
        "test": "",
        "test-multi-select": null,
        "test-price": {},
        "title": {
          "en": "testssssss"
        }
      },
      "tags": {}
    }
  },
  {
    "uuid": "c83ca796-00e5-5c08-b87c-cd6ecee50000_1",
    "name": "012871.tif",
    "cdn": "https://try.filerobot.com/Widget_demo_folder/012871.tif",
    "extension": "tif",
    "source": "filerobot",
    "type": "image/tiff",
    "attributes": {
      "meta": {
        "boolean": null,
        "date": null,
        "description": {
          "en": "s"
        },
        "malt_id": null,
        "multi_select": null,
        "number": null,
        "price": {
          "default": "2000"
        },
        "product_id": {
          "default": "HJUUIISS"
        },
        "sales_tags": {
          "default": [
            "best",
            "hot"
          ]
        },
        "select_one": null,
        "shouldbedeleted": null,
        "sku": "ddss-2",
        "sport": null,
        "test": null,
        "test-multi-select": null,
        "test-price": {},
        "title": {
          "en": "đ"
        }
      },
      "tags": {
        "en": [
          {
            "label": "test",
            "sid": "#tgb84ea"
          },
          {
            "label": "tags",
            "sid": "#tgc4915"
          }
        ],
        "fr": [
          {
            "label": "~ test",
            "sid": "#tgb84ea"
          },
          {
            "label": "~ tags",
            "sid": "#tgc4915"
          }
        ],
        "ru": [
          {
            "label": "~ test",
            "sid": "#tgb84ea"
          },
          {
            "label": "~ tags",
            "sid": "#tgc4915"
          }
        ]
      }
    }
  }
]
```


# Strapi

DAM x Strapi plugin

To get Scaleflex DAM integrated you will need to set up these 2 components:

1. Scaleflex DAM plugin: <https://github.com/scaleflex/strapi-plugin-filerobot/blob/v4/README.md>;
2. DAM upload-provider: <https://github.com/scaleflex/strapi-provider-upload-filerobot/blob/v4/README.md>.

*Benefits*:

* All your media will be hosted on Scaleflex DAM;
* You have the option to synchronize all your existing media to Scaleflex DAM;
* You will have access to the Media Asset Widget (MAW), where you can upload media to Scaleflex DAM and select media from Scaleflex DAM.
* Additional workflows or enrichments can be performed from the DAM UI

### Installation <a href="#od_ccade214" id="od_ccade214"></a>

#### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

[Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have a Scaleflex DAM account.

#### Step 1. Get the plugin <a href="#od_ccade214-1" id="od_ccade214-1"></a>

Install the Scaleflex DAM plugin and you should see *Scaleflex DAM* in the left menu.

The following options are available to you:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F5KCSxnAo2PPeIoQY8aoO%252F1.png%3Falt%3Dmedia%26token%3D906bbc1e-1a0f-402a-9f5c-4b41a6c26a99&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=c908a1c0&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Step 2. Get the upload provider <a href="#od_4d8b6919" id="od_4d8b6919"></a>

Then, install the DAM upload provider. Every media you upload will have DAM URLs:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FeBJaSkQ9I7grm2DjRo3E%252Fst2.png%3Falt%3Dmedia%26token%3D77be2ed4-006d-4ad4-bf5a-f5e6dc10e505&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=f3b0364d&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Usage <a href="#od_35d2ac6f" id="od_35d2ac6f"></a>

#### Asset Manager <a href="#od_cc6b993f" id="od_cc6b993f"></a>

Upload media to Scaleflex DAM:

<figure><img src="/files/ilKlFErqeWTcQP1pP3X7" alt=""><figcaption></figcaption></figure>

Select media from Scaleflex DAM:

<figure><img src="/files/PTatJpntLozWJzQsFfvK" alt=""><figcaption></figcaption></figure>

#### Synchronization <a href="#od_f7d253e8" id="od_f7d253e8"></a>

1. Beginning with 2 local images

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FlXrgAfpORyd2bdDqagOm%252F7.png%3Falt%3Dmedia%26token%3D1e91dd4c-009f-47f3-afd4-766c25ac148e&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=1b56a15&#x26;sv=1" alt=""><figcaption></figcaption></figure>

2. And 10 images on Scaleflex DAM

<figure><img src="/files/VoT7Nh9rQtm3fw1gSZ1m" alt=""><figcaption></figcaption></figure>

3. Synchronize

**Note:** Please don't close the browser tab until the sync process is done.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FVZIVMmHM3RjHU4r328BJ%252F3.png%3Falt%3Dmedia%26token%3Ddb0e9c8d-8a28-4051-94fb-2c4e721300e1&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=fced77a9&#x26;sv=1" alt=""><figcaption></figcaption></figure>

4. Results

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FZU32T9zESuo8qDifz5IG%252F4.png%3Falt%3Dmedia%26token%3D0d4bf198-2ba9-4b07-952a-a02b9cb284ee&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=52822060&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Custom Field (Scaleflex Asset) <a href="#od_f7d253e8" id="od_f7d253e8"></a>

In the **Content-Type Builder**, select the button **"Add another field"** and go to the tab **"Custom"**

<figure><img src="/files/okm93kAgdrWxQe4Ydg6K" alt=""><figcaption></figcaption></figure>

Select **Scaleflex Asset**, fill in the name of the content type

<figure><img src="/files/no7p2xvSyu6le8ZZcP3U" alt=""><figcaption></figcaption></figure>

Basic Setting:

* **Allowed file type:** Restrict which type of assets can be selected

Advanced Settings:

<figure><img src="/files/ZOPXnposLiquphOM7rP1" alt=""><figcaption></figcaption></figure>

* **Stored attributes:** To store the data you want to get in the widget, e.g meta, info, tags, hash
* **Max assets:** Maximum number of assets to select (e.g. 1 for thumbnail, 10 for gallery). Leave empty for no limit.

In the content, you will see the new content type like this:

<figure><img src="/files/PFNe6rjZ8boTWdexqHTD" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/2huvbPrik2ce2ew9WEzj" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/O5qIEHeC4jnDmm5foJbN" alt=""><figcaption></figcaption></figure>


# Sylius

DAM Sylius plugin

### Installation <a href="#od_c9a26491" id="od_c9a26491"></a>

#### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

[Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have a DAM account.

#### Step 1: Download <a href="#od_c9a26491-1" id="od_c9a26491-1"></a>

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

```
 composer require scaleflex/sylius-filerobot-plugin
```

This command requires you to have Composer [installed globally](https://getcomposer.org/doc/00-intro.md), as explained in the installation chapter of the Composer documentation.

#### Step 2: Enable the plugin <a href="#od_89b10974" id="od_89b10974"></a>

Then, enable the plugin by adding it to the list of registered plugins/bundles in config/bundles.php file of your project:

```
<?php
# config/bundles.php

return [
    // ...
    Scaleflex\SyliusFilerobotPlugin\ScaleflexSyliusFilerobotPlugin::class => ['all' => true],
];
```

#### Step 3: Configure <a href="#od_0eb6b2f0" id="od_0eb6b2f0"></a>

To configure the DAM Sylius plugin, the following components need to be updated:

**1. DB Schema**

Copy

```
bin/console doctrine:migration:diff
bin/console doctrine:migration:migrate
bin/console cache:clear
```

**2. Admin route**

Create file in `config/routes/scaleflex_sylius_filerobot.yaml` with the following content:

Copy

```
# config/routes/scaleflex_sylius_filerobot.yaml

scaleflex_sylius_filerobot:
  resource: "@ScaleflexSyliusFilerobotPlugin/Resources/config/routing.yaml"
```

**3. Product media tab form**

Change form theme `{% form_theme form '@ScaleflexSyliusFilerobotPlugin/Admin/Form/imagesTheme.html.twig' %}` in your `templates/bundles/SyliusAdminBundle/Product/Tab/_media.html.twig`

Copy

```
{% form_theme form '@ScaleflexSyliusFilerobotPlugin/Admin/Form/imagesTheme.html.twig' %}

<div class="ui tab" data-tab="media">
  <h3 class="ui top attached header">{{ 'sylius.ui.media'|trans }}</h3>

  <div class="ui attached segment">
    {{ form_row(form.images, {'label': false}) }}

    {{ sylius_template_event(['sylius.admin.product.' ~ action ~ '.tab_media', 'sylius.admin.product.tab_media'], {'form': form}) }}
  </div>
</div>
```

**4. Product grid thumbnail**

Change grid thumbnail column template

```
# config/package/_sylius.yaml

sylius_grid:
  grids:
    sylius_admin_product:
      fields:
        image:
          options:
            template: "@ScaleflexSyliusFilerobotPlugin/Admin/Product/Grid/Field/image.html.twig"
```

**5. Script**

```
# config/package/sylius_ui.yaml

sylius_ui:
  events:
    sylius.admin.layout.javascripts:
      blocks:
        filerobot_script: '@ScaleflexSyliusFilerobotPlugin\Admin\filerobotScript.html.twig'
```

**6. Config filter**

Create a file `config/packages/scaleflex_filerobot.yaml` and add content bellow

```
# config/packages/scaleflex_filerobot.yaml

imports:
  - { resource: "@ScaleflexSyliusFilerobotPlugin/Resources/config/filters.yaml"}
```

**7. Update configuration in Admin**

Navigate to *Configuration* / *Scaleflex DAM*

<figure><img src="https://opendocs-global.airstore.io/project_test/c45bcb98c06c86e206993a429e75d45d359d48237073843d507509b93ef3c623.png" alt=""><figcaption></figcaption></figure>

You can enable the plugin only if both token and security template id are correct.

* **Activation**: Enable/Disable the plugin
* **DAM Token**: Your DAM token, unique DAM Project and gallery identifier
* **Security Template Identifier:** Your security template ID, found in the "Access > Security templates" section of your DAM admin
* **DAM upload directory**: (sub)folder path to your asset's gallery, eg. /my\_sylius\_folder

### Developer's den <a href="#od_589d765c" id="od_589d765c"></a>

The DAM plugin offers various Twig methods and filters to assist developers:

* `is_filerobot(image_path)`: Twig function which checks if an image is stored in DAM ;
* `image_path|filerobot('sylius_shop_product_thumbnail')`: A resizing Twig filter; More filters can be added in in `config/package/scaleflex_filerobot.yaml`.

```
  scaleflex_sylius_filerobot:
    filters:
      custom_size: { width: 120, height: 120 }
```

and in Twig

```
  image_path|filerobot('custom_size')
```

We have some default size follow Sylius default, you can override it in filter config ab

```
  scaleflex_sylius_filerobot:
    filters:
      sylius_admin_product_large_thumbnail: { width: 550, height: 412 }
      sylius_admin_product_small_thumbnail: { width: 150, height: 112 }
      sylius_admin_product_tiny_thumbnail: { width: 64, height: 64 }
      sylius_admin_product_thumbnail: { width: 50, height: 50 }
      sylius_shop_product_tiny_thumbnail: { width: 64, height: 64 }
      sylius_shop_product_small_thumbnail: { width: 150, height: 112 }
      sylius_shop_product_thumbnail: { width: 260, height: 260 }
      sylius_shop_product_large_thumbnail: { width: 550, height: 412 }
      sylius_small: { width: 120, height: 120 }
```

* If you use Scaleflex DAM on existing File you have to check the path is filerobot or not, if not use the default way

**Example with Sylius default**

* `templates/bundles/SyliusShopBundle/Product/_mainImage.html.twig`

```
{% if product.imagesByType('thumbnail') is not empty %}
    {% if is_filerobot(product.imagesByType('thumbnail').first.path) %}
        {% set path = product.imagesByType('thumbnail').first.path|filerobot('sylius_shop_product_thumbnail') %}
    {% else %}
        {% set path = product.imagesByType('thumbnail').first.path|imagine_filter(filter|default('sylius_shop_product_thumbnail')) %}
    {% endif %}
{% elseif product.images.first %}
    {% if is_filerobot(product.images.first.path) %}
        {% set path = product.images.first.path|filerobot('sylius_shop_product_thumbnail') %}
    {% else %}
        {% set path = product.images.first.path|imagine_filter(filter|default('sylius_shop_product_thumbnail')) %}
    {% endif %}
{% else %}
    {% set path = asset('assets/shop/img/200x200.png') %}
{% endif %}

<img src="{{ path }}" {{ sylius_test_html_attribute('main-image') }} alt="{{ product.name }}" class="ui bordered image" />
```

* `templates/bundles/SyliusShopBundle/Product/Show/_mainImage.html.twig`:

```
{% if product.imagesByType('main') is not empty %}
    {% set source_path = product.imagesByType('main').first.path %}
    {% if not is_filerobot(source_path) %}
        {% set original_path = source_path|imagine_filter('sylius_shop_product_original') %}
        {% set path = source_path|imagine_filter(filter|default('sylius_shop_product_large_thumbnail')) %}
    {% else %}
        {% set original_path = source_path|filerobot('sylius_shop_product_original') %}
        {% set path = source_path|filerobot('sylius_shop_product_large_thumbnail') %}
    {% endif %}
{% elseif product.images.first %}
    {% set source_path = product.images.first.path %}
    {% if not is_filerobot(source_path) %}
        {% set original_path = source_path|imagine_filter('sylius_shop_product_original') %}
        {% set path = source_path|imagine_filter(filter|default('sylius_shop_product_large_thumbnail')) %}
    {% else %}
        {% set original_path = source_path|filerobot('sylius_shop_product_original') %}
        {% set path = source_path|filerobot('sylius_shop_product_large_thumbnail') %}
    {% endif %}
{% else %}
    {% set original_path = asset('assets/shop/img/400x300.png') %}
    {% set path = original_path %}
{% endif %}

<div data-product-image="{{ path }}" data-product-link="{{ original_path }}"></div>
<a href="{{ original_path }}" class="ui fluid image" data-lightbox="sylius-product-image">
    <img src="{{ path }}" id="main-image" alt="{{ product.name }}" {{ sylius_test_html_attribute('main-image') }} />
</a>
{% if product.images|length > 1 %}
<div class="ui divider"></div>

{{ sylius_template_event('sylius.shop.product.show.before_thumbnails', {'product': product}) }}

<div class="ui small images">
    {% for image in product.images %}
    {% set path = image.path is not null ? (is_filerobot(image.path) ? image.path|filerobot('sylius_shop_product_small_thumbnail') : image.path|imagine_filter('sylius_shop_product_small_thumbnail')) : asset('assets/shop/img/200x200.png') %}
    <div class="ui image">
    {% if product.isConfigurable() and product.enabledVariants|length > 0 %}
        {% include '@SyliusShop/Product/Show/_imageVariants.html.twig' %}
    {% endif %}
        <a href="{{ is_filerobot(image.path) ? image.path|filerobot('sylius_shop_product_original') : image.path|imagine_filter('sylius_shop_product_original') }}" data-lightbox="sylius-product-image">
            <img src="{{ path }}" data-large-thumbnail="{{ is_filerobot(image.path) ? image.path|filerobot('sylius_shop_product_large_thumbnail') : image.path|imagine_filter('sylius_shop_product_large_thumbnail') }}" alt="{{ product.name }}" />
        </a>
    </div>
    {% endfor %}
</div>
{% endif %}
```


# Uniform CMS

{% hint style="info" %}
Please note that this plugin is directly developed and maintained by the [Uniform](https://www.uniform.dev/) team.
{% endhint %}

***

This integration allows business users to build personalized landing pages and applications by repurposing content from your Scaleflex DAM digital asset management system. It also enables developers to use their preferred front-end tools to build these applications.

#### Add Uniform integration <a href="#add-uniform-integration" id="add-uniform-integration"></a>

Make assets housed in Scaleflex DAM available to the [Uniform asset library](https://docs.uniform.app/docs/guides/composition/manage-assets/asset-library) by adding this integration.

**Get connection settings**

1. Log into Scaleflex DAM Hub.
2. Note **Container Id** string to the left from your account icon at the top right corner. You will need this value in the next section.
3. Click on the **Settings** icon top right corner of the screen.
4. Scroll to the tab **Project** section.
5. Click on **Access** ink.
6. Create a new template in the Security templates tab if not created yet.
7. Note the **Secret Key** of your template. You will need this value in the next section.<br>

**Add integration**

1. In Uniform, open your project.
2. Navigate to the **Integrations** tab.
3. Scroll to the section **Browse Integrations**.
4. Click **Scaleflex DAM**.
5. Click **Add to project**.

add-project

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F08laJO1ISrXFpYcXWvqe%252Funi1.webp%3Falt%3Dmedia%26token%3D8ae495e8-937a-4e38-84ce-d1f74be54e37&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=4a24b511&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Enter the required values:

  | Uniform setting               | Value                                                                                                                         |
  | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
  | Container Id                  | Your DAM container id (aka token).                                                                                            |
  | Security templates secret key | Security templates are meant to be used by frontend applications calling the  DAM API directly or via the Media Asset Widget. |
* Click **Save**.

  <figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FlweRLUtekzsTNnD6xFb7%252Funi2.webp%3Falt%3Dmedia%26token%3D0e6211a0-a5f3-48d2-9628-94744511a7bf&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=58a1c334&#x26;sv=1" alt=""><figcaption><p>settings-saved</p></figcaption></figure>

After you install the Scaleflex DAM integration, new asset library becomes available.

#### Use Scaleflex DAM asset library <a href="#use-scaleflex-filerobot-asset-library" id="use-scaleflex-filerobot-asset-library"></a>

You can manage your Scaleflex DAM assets from inside Uniform. Uniform leverages its Media Widget to provide access to your library throughout your project.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FNRMUetQInVWbcfHmHf4Q%252Funi3.webp%3Falt%3Dmedia%26token%3D593048d9-cb16-4d35-96a3-78a7431c8f4b&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=8c5f5c8f&#x26;sv=1" alt=""><figcaption><p>scaleflex-filerobot-global-asset-library-location</p></figcaption></figure>

#### Use Scaleflex DAM assets in Uniform Canvas <a href="#use-scaleflex-filerobot-assets-in-uniform-canvas" id="use-scaleflex-filerobot-assets-in-uniform-canvas"></a>

You can insert assets directly into your Uniform [Canvas components](https://docs.uniform.app/docs/guides/models/components) using [asset parameters](https://docs.uniform.app/docs/guides/models/components/parameters#asset).

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FgqttVBhOVAWnNjvmd4aE%252Funi4.webp%3Falt%3Dmedia%26token%3D4ecb30f3-f64e-479a-88d3-ba08b6ec89cc&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=60c1edc1&#x26;sv=1" alt=""><figcaption><p>scaleflex-filerobot-canvas-editor-asset-parameter</p></figcaption></figure>

<br>


# WordPress - VXP

The WordPress VXP plugin: All-in-One Digital Asset Management and Cloudimage Acceleration.

### Overview

The **WordPress VXP** **plugin** is a powerful WordPress addition designed to help businesses efficiently manage and optimize their digital assets.\
Integrating Scaleflex two key products in one - **Digital Asset Management (DAM)** and **Cloudimage (Digital Media Optimization)** - it enables you to store, organize, deliver, and optimize images, videos, and other digital resources directly from within WordPress.

* **DAM (Digital Asset Management):** Seamlessly organize, search, and control all your digital assets, ensuring brand consistency and boosting team collaboration.
* **Cloudimage (Digital Media Optimization):** Automatically optimize images and videos for size and loading speed, enhancing user experience and improving website performance.

### Prerequisites

To use this plugin, ensure you have a Scaleflex DAM account ([register for a demo](https://www.scaleflex.com/request-a-demo) if not already) or a Cloudimage account ([register to get direct access](https://www.cloudimage.io/registration) if not already).

### Installation

{% hint style="info" %}
For installation instructions related to the Cloudimage version, please refer to [that documentation](https://docs.cloudimage.io/implementation/cms-plugins/wordpress) instead.
{% endhint %}

* Log in to your WordPress admin panel.
* *On the Admin sidebar, navigate to Plugins > Add New*
* *Enter "Scaleflex VXP" in the search field and then install the plugin*
* Once installed, click Activate.

<figure><img src="/files/vROVVB5cjFIzkjp8lInX" alt=""><figcaption></figcaption></figure>

* Navigate to the settings page.
* Select **"Digital Asset Management (DAM)"**.

<figure><img src="/files/L2lgVhojcTntPeUv4XOq" alt=""><figcaption></figcaption></figure>

* Fill in the plugin settings page with the required authentication details
  * **Token:** Your token from the DAM
  * **Security Template:** A key for obtaining time-limited access tokens (used for API interaction). See: [Security templates](/vxp-visual-experience-platform/settings/project/access/security-templates). Behind the scenes, the code would use the Security Template Identifier to obtain a SASS (the “limited-time password”). The SASS would then be used in the auth header for interacting with the Filerobot API (<https://developers.scaleflex.com/>)&#x20;
  * **Base folder in the DAM to synchronise assets to / from:** Choose the folder where uploaded assets should be stored in the DAM platform.

<figure><img src="/files/jsbq4KBgkTtHh6Fe8DmS" alt=""><figcaption></figcaption></figure>

### Setup

<figure><img src="/files/gtTWk3d5wS7KcnvGJoNX" alt=""><figcaption></figcaption></figure>

With **Scaleflex DAM**, we have two modes of visualization:

* **DAM-Native:** Compatibility with every version of WordPress and easy to use with other plugins
* **DAM-Widget:** Supports Gutenberg (with classic blocks), Classic Editor, Yoast SEO, WooCommerce, and Advanced Custom Fields. Any other Editor or plugin using media should be validated before use.

#### **Advanced Settings**

**Storage location:** Where assets will be stored. In any case, WordPress will use optimized asset links from the DAM to display and accelerate assets in WordPress.

* **DAM Only:** activating the plugin uploads existing WordPress assets to the DAM; new assets are stored only in the DAM and require manual syncing after deactivation.
* **DAM and WordPress:** assets are duplicated between WordPress and the DAM; deactivating the plugin relinks URLs to local WordPress storage.
* **Maximum asset weight**: in order to prevent timeouts or save space on the WordPress server, you can limit the weight of assets that will be also saved to the WordPress server. Limiting the size will also make larger files unavailable in your posts or pages if you remove the Scaleflex plugin.

**Synchronize all assets from DAM to WordPress:**

Once enabled, the feature pulls DAM assets directly from the Scaleflex DAM into WordPress (without DAM metadata), simply making assets available and searchable by their `name`.

Still, a DAM metadata needs mandatorily to be selected to synchronize the attachment ID from WordPress to DAM in order to maintain unicity in WordPress database.

If you don't have any, please create one at: <https://hub.scaleflex.com/settings/dam/metadata/assets>

This custom metadata should be of type `number` and should not be edited by DAM users. The selector will pre-filter the available metadata for that purpose.

<figure><img src="/files/ODcC9AqTtV3tGQhg9K0F" alt=""><figcaption></figcaption></figure>

#### Metadata and Webhook Configuration

You can enable this option if you want to use metadata in your project or synchronize the asset when you have a new upload from DAM.

Once enabled, the feature pulls DAM metadata directly from the Scaleflex DAM into WordPress (both default and custom metadata), also enabling advanced search and description capabilities.

New assets uploaded to the DAM (from the specified base folder) will be automatically synced to WordPress via Webhook, this time regardless of whether they are used in pages or posts.

You can select to synchronize the relevant DAM metadata you want with Title, Description, Caption, and Alternative Text (ALT) as standard WordPress metadata.

For this to happen, the only metadata needed for the WordPress to pull each and all of the DAM Asset's metadata is the `file UUID` .

<figure><img src="/files/bmaupRn1yT7qbbU1fjrj" alt=""><figcaption></figcaption></figure>

**Example for Webhook URL:**&#x20;

```
https://yourdomain.com/wp-json/sfxvxp/dam/v1/webhook/listen-data
```

<figure><img src="/files/HTARcN7KDTGDd1Nbu2D3" alt=""><figcaption></figcaption></figure>

**🔐 IMPORTANT — Application Password Required**

To ensure that the webhook works correctly, you **must** use a **WordPress Application Password** for authentication.

Application Passwords allow secure REST API access without exposing your main account password and prevent unauthorized webhook calls.

**How to Create an Application Password in WordPress**

* Step 1: Go to **Users > Profile** (or “Your Profile”).
* Step 2: Scroll down to the **Application Passwords** section.
* Step 3: Enter a name for the new password, for example:&#x20;

```
SFXVXP Webhook
```

* Step 4: Click **Add Application Password**. WordPress will generate a password — **copy and store it safely**, as you will need it when configuring the [webhook in the DAM settings](https://hub.scaleflex.com/settings/dam/automations/webhooks).

<figure><img src="/files/z2MVsjtH33JHOkegPDXu" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/875wyAAQNpEvacc3p9j3" alt=""><figcaption></figcaption></figure>

* Step 5: Make sure your "Permalink" setting is of the correct type&#x20;

{% hint style="info" %}
If the webhook request returns **404 Not Found**, this could be the root cause
{% endhint %}

Go to **WordPress → Settings → Permalinks →** select any other than "Plain" and save

<figure><img src="/files/lXxeKA7F6vAp4GYs4VPg" alt=""><figcaption></figcaption></figure>

### What this plugin brings

For example, before DAM is installed and activated, you have these 2 images on your WordPress CMS and these 2 images on your DAM platform:

<figure><img src="/files/zRQnsalZ123ESpmTxT31" alt=""><figcaption></figcaption></figure>

At this point, the images' URLs still have WordPress CMS URLs

After you install, activate, and configure DAM, you can see the notification at the top to confirm if you entered the correct credentials.

<figure><img src="/files/g4PnlL5tcd6sZNvxwkM1" alt=""><figcaption></figcaption></figure>

Then the synchronization will run in the background and upload your current asset into **Scaleflex DAM.**

You can check the progress synchronization at the "Report" page

<figure><img src="/files/DeqcpqYdzqf10z5tLI6G" alt=""><figcaption></figcaption></figure>

Now you can see that all the images' URLs have become DAM URLs

<figure><img src="/files/jpfMNFeGidIpBYyZrmza" alt=""><figcaption></figcaption></figure>

**The next major feature that Scaleflex DAM brings is the Media Asset Widget as Media Library**

Here you can upload your media assets to the DAM platform (instead of WordPress local library)

**Note:** This feature supports natively Gutenberg, Classic Editor, Yoast SEO, WooCommerce, and Advanced Custom Fields (with others to be added soon).

<figure><img src="/files/j1LYKmXbcbaclvHLuXg6" alt=""><figcaption></figcaption></figure>

**Anywhere the Media Asset Manager is called by an editor, a Scaleflex DAM media tab will be visible.**

<figure><img src="/files/ifznBneeHWP4HErMJyon" alt=""><figcaption></figcaption></figure>

### **Deactivation**

When you deactivate the plugin, all media assets that have been synchronized to the DAM will not be available anymore as "CDN links".

You have two options when deactivating the plugin, and what happens next will be depending on the one chosen:

1. Delete all plugin data

* this option revoves all configuration parameters and CDN links from the Wordpress database
* if you selected for `storage` "DAM only":&#x20;
  * all articles (and other posts) will then have broken images unless they are manually replaced
* if you selected for `storage` "DAM and Wordpress":
  * a background process will map and assign all available local media to articles (and other posts)

2. Keep all plugin data

* this option simply removes the plugin from the active ones, and does not modify the articles links

<figure><img src="/files/s87xBvlFBIYKvWDL2C4x" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Please note:** When using the "**Storage location"** with the option **"DAM only"**, you need to manually synchronize back to WordPress each of your DAM asset **after** deactivation.
{% endhint %}


# Connectors

You will find here the list of Scaleflex's most popular connectors with a brief descriptions on how to set them up.&#x20;

If a connector is not in the documented list, feel free to reach out to our Support team who will know if it is in the making or if we have it on our rich roadmap.

You will in general need at least 2 information for the basic setup of a connector:

* Your "TOKEN" (aka Project identifier), located there:

<figure><img src="/files/q0VJWIHtWZ5CQjNxtHGO" alt=""><figcaption></figcaption></figure>

* Your "SEC\_TEMPLATE" (Security template), located there:&#x20;

<figure><img src="/files/6CRqbTIg5ufH2E18duof" alt=""><figcaption></figcaption></figure>


# Akeneo PIM

Scaleflex DAM (VXP) Akeneo App

## Installation & Activation

### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

* You need an active DAM account. [Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have one.
* Your Akeneo plan needs to be the *Enterprise Edition*.

### Activation

1. &#x20;**Activation by App (EE Version)**

* Log in to your Akeneo instance
* Go to **Connect - App store**, search by name: "Scaleflex", App name: "Scaleflex DAM (Visual Experience Platform)"

1. **Activation by Data source(CE Version)**

Prepare credentials by going to the Akeneo instance, and go to Connect / Connection settings&#x20;

* Create
  * Label: any
  * Code: any
  * Flow type: Data source
* Then you will be redirected to this page. <mark style="color:red;">**Please add a Role and Group to this Data source**</mark>

<figure><img src="/files/VZ6F6PL5mFZdLa5xbmjB" alt=""><figcaption><p>Data Source setting</p></figcaption></figure>

* Save this information to use in the next step

Go to Settings / Automation / Integrations or use this link: <https://hub.scaleflex.com/settings/dam/automations/integrations>

* Click on "Add Connetor" and select "Akeneo PIM"

<figure><img src="/files/ZQrL2sjoCCtV8YA1451L" alt=""><figcaption></figcaption></figure>

* Fill in your data to complete the configuration connector

<figure><img src="/files/ZmJfEjp0MhFL8WZBJeCT" alt=""><figcaption></figcaption></figure>

### Set up Your Integration

Follow the steps to complete the integration

<figure><img src="/files/oH46c1okSELJkWzE7pQ5" alt=""><figcaption></figcaption></figure>

* **HUB API Key:** In Hub, go to Settings > Access > API Keys to get one.  (<https://hub.scaleflex.com/settings/project/access/api-keys>)
* **Field Mappings:**

  <figure><img src="/files/Du5o2PxQlCbuJljRIUgB" alt=""><figcaption></figcaption></figure>

**Recommend:** Go to the Hub and create the default metadata to use for Akeneo Mapping.

Example:

<figure><img src="/files/IM7iLHpgk567ukX82ECR" alt=""><figcaption></figcaption></figure>

With the option "Separate Product & Asset settings" enabled. You need to select the metadata used for Product and Asset

<figure><img src="/files/5nwmxakawC2VJUKAxIWy" alt=""><figcaption></figcaption></figure>

Lastly, regarding the option "Use product.ref for Product SKU". To use it, please verify that the Product setting is enabled in HUB. In Hub, go to Settings > Interface > Enable "Products" (<https://hub.scaleflex.com/settings/dam/library/featured-components>)

### Webhook Configuration

To sync from DAM to PIM by Metadata, you have to copy and add to the new Webhook Setting at: <https://hub.scaleflex.com/settings/dam/automations/webhooks>

Please follow these configurations:

<figure><img src="/files/GzTlI4mOW3SmfowlvvAW" alt=""><figcaption></figcaption></figure>

### Sync Configuration&#x20;

1. **Asset**

Go to Settings > On tab "Attribute Sync"

On this screen, you can select the attribute you want to sync the asset from DAM to PIM

<figure><img src="/files/QU7GPzxxP8FERXMhxDpM" alt=""><figcaption></figcaption></figure>

2. **Mapping Metadata**

* **DAM Field:** Select the metadata field on DAM to map with PIM
* **Target Type:** Choose mapping target Product/Asset
* **PIM Attribute:** Select the metadata field on PIM to map with DAM
* **Direction:** Choose the way you want to sync
  * DAM to PIM
  * PIM to DAM (Support only for EE version)
  * Bidirectional (Support only for EE version)

<figure><img src="/files/NY7NiYqnSfqLQOSNCm9i" alt=""><figcaption></figcaption></figure>

**Requirement:** You need to create a new variant for Akeneo at <https://hub.scaleflex.com/settings/dam/metadata/configuration>. And follow the instructions in **Settings** > **Metadata** > **DAM Variants** to set up the option and value for your variant.

<figure><img src="/files/Snt78dFwwl4byAhbeBmd" alt=""><figcaption></figcaption></figure>

Copy the value of **Name** for **Label** and **API Key** for **API Key**

<figure><img src="/files/WMmpvnBSHahgWJQNEbN3" alt=""><figcaption></figcaption></figure>

3. **Presets**

To use **Presets,** you need to select the field metadata on the tab **General.**

<figure><img src="/files/CcCApow24nHS1hO673PA" alt=""><figcaption></figcaption></figure>

3. **PIM to DAM (Event Platform)**

Please be aware that this feature is supported only for the Akneo EE version.

And make sure you have already permitted the Event Platform

<figure><img src="/files/4mibrCzuDOA9mV6CqqeE" alt=""><figcaption></figcaption></figure>

With this option enabled, when you change the field already mapped in PIM, it will sync the data change back to DAM


# Akeneo PIM

## Introduction

There are 2 versions(sync way) in Akeneo App:

* Metadata version: Which is new support sync assets and product by metadata.
* UI version: Setting and Support sync by UI

<table><thead><tr><th>Feature</th><th width="207.140625">Field Type Support</th><th width="117.6484375" data-type="checkbox">Metadata</th><th width="92.93359375" data-type="checkbox">UI</th><th data-type="checkbox">Scope/Channel</th><th width="90.69140625" data-type="checkbox">Locale</th></tr></thead><tbody><tr><td>Product</td><td><ul><li>Image Field(Binary)</li><li>Text </li></ul></td><td>true</td><td>true</td><td>true</td><td>true</td></tr><tr><td>Asset Manager*</td><td><ul><li>Media Type</li></ul></td><td>true</td><td>true</td><td>true</td><td>true</td></tr><tr><td>Entity Reference*</td><td><ul><li>Image(Binary)</li><li>Text</li></ul></td><td>false</td><td>true</td><td>true</td><td>true</td></tr></tbody></table>

\* Available only in the SaaS (Enterprise) version

**Metadata version support Bi-Direction Sync(DAM to PIM, PIM to DAM)**

<table><thead><tr><th width="157.48046875">Attribute type</th><th width="122.3671875" data-type="checkbox">Support</th><th>Field condition(Chanel/Locale)</th></tr></thead><tbody><tr><td>Text / Textarea</td><td>true</td><td><ul><li>No Chanel / No Locale</li><li>Locale support(Use Variant in DAM)</li><li>Attribute code and Metadata Key MUST MATCH in both system</li></ul></td></tr><tr><td>Single Select</td><td>true</td><td><ul><li>No Chanel / No Locale</li><li>Attribute code and Metadata Key MUST MATCH in both system</li><li>Options value must be the same in both system</li></ul></td></tr><tr><td>Multiple Select</td><td>true</td><td><ul><li>No Chanel / No Locale</li><li>Attribute code and Metadata Key MUST MATCH in both system</li><li>Options value must be the same in both system</li></ul></td></tr></tbody></table>

## Installation options

Depending on your Akeneo version you will install our Connector/App in a differnt way:

* [Community version (CE)](/digital-asset-management-dam/plugins-and-connectors/connectors/akeneo-pim-1/akeneo-enterprise-pim-app)
* [Enterprise version (EE)](/digital-asset-management-dam/plugins-and-connectors/connectors/akeneo-pim-1/akeneo-community-pim-connector)


# Akeneo Community PIM Connector

Scaleflex DAM (VXP) Akeneo Connector

## Installation & Activation

### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

* You need an active DAM account. [Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have one;
* Akeneo instance

### Activation by Data source(CE Version)

Prepare crendentials by go to Akeneo instance go to Connect / Connection settings&#x20;

* Create
  * Label: any
  * Code: any
  * Flow type: Data source
* Then you will be redirect to this page, <mark style="color:red;">**please add a Role and Group to this Data source**</mark>

  <figure><img src="/files/VZ6F6PL5mFZdLa5xbmjB" alt=""><figcaption><p>Data Source setting</p></figcaption></figure>
* Save these information to use in next step

Go to Setting / Automation / Integrations or use this link: <https://hub.scaleflex.com/settings/dam/automations/integrations>

* Click on Enable Akeneo community

<figure><img src="/files/iTeOLyxGh2YUUeK0C1XA" alt=""><figcaption><p>Welcome Page</p></figcaption></figure>

* Enter credentials from Akeneo, then Validate and Save Change

<figure><img src="/files/X3U1blDFYc6Xf2tW5y2p" alt=""><figcaption></figcaption></figure>

* After validated, you can change your credentials in **Credentials Tab**

## Configurations

Go to Setting / Automation / Integrations or use this link: <https://hub.scaleflex.com/settings/dam/automations/integrations>

There are 2 sections:

### General Setting

<figure><img src="/files/pBYYoRQfXaITMpkVNKY9" alt=""><figcaption></figcaption></figure>

#### Default Configuration

* Enable / Disable: If disabled, you cannot use the Akeneo sync feature on DAM
* Default size: Default image size will be used if there are no configs related to each asset
* Image resize technique:
  * Crop: Cut image part to resize
  * Fit: Keep all content in image, and make image fit the size
* Addition subfix URL: append a suffix to asset URLs to enable transformations,  read more here: [Transformations](/dynamic-media-optimization-dmo/transformations/image-optimization/operations)
* Please click "Save" to update the configuration

#### Image resize setting

**How does it work?**

* Can be duplicated
* Priority: Bottom to top, and it will apply the first one match the setting, check example bellow.

*Example:*&#x20;

An Asset with these information:

* Scope: commerce / Locale: en\_US / Family: filerobotmedia
* Will try to match setting following the steps below:
  * First try: Type: Asset / Family: filerobotmedia / Scope: commerce / Locale: en\_US
  * Second try: Type: Asset / Family: All Items / Scope: commerce / Locale: en\_US
  * Third try: Type: Global / Scope: commerce / Locale: en\_US
  * Use size and image resize technique from Default configuration above

**Flow guide**

* Select type, there are 4 types:
  * Global: Affects all assets including entity and asset
  * Asset: Asset Family
  * Entity: Entity Reference
  * Product
* Choose family, we can choose **"All items"**, this will be affected all Families in selected type
* Scope and locale

<table><thead><tr><th width="225.3828125">Setting in DAM</th><th>Akeneo attribute</th></tr></thead><tbody><tr><td>No Scope + No Locale</td><td><ul><li>Value per locale: False </li><li>Value per channel: False</li></ul></td></tr><tr><td>Scope + No Locale</td><td><ul><li>Value per locale: False </li><li>Value per channel: True</li></ul></td></tr><tr><td>No Scope + Locale</td><td><ul><li>Value per locale: True </li><li>Value per channel: False</li></ul></td></tr><tr><td>Scope + Locale</td><td><ul><li>Value per locale: True </li><li>Value per channel: True</li></ul></td></tr></tbody></table>

* Image resize technique: Fit or Crop
* Size: Must follow format: width x  height, example: **300x400**
* Addition subfix URL: append a suffix to asset URLs to enable transformations,

### Sync Setting

<figure><img src="/files/NbTg8qE00w5EtSCzN8gG" alt=""><figcaption></figcaption></figure>

#### PIM to DAM

<figure><img src="/files/OE5zKlNV5F650LjFuIh0" alt=""><figcaption></figcaption></figure>

To enable PIM to DAM sync: When we update some attribute(check supported field type above) in a PIM record(Asset, Product), it will update the mapped metadata in DAM.

* Go to Access to get an API Key: <https://hub.scaleflex.com/settings/project/access/api-keys>, please select All

<figure><img src="/files/swgOMKplVNdWbbNoaV8x" alt=""><figcaption></figcaption></figure>

* Copy API Key and paste into Api key
* Enable the Toggle button
* Save changes

#### Metadata setting

To sync from DAM to PIM by Metadata you have to copy and add to new Webhook Setting at: <https://hub.scaleflex.com/settings/dam/automations/webhooks>

<figure><img src="/files/vBJ0LLIL3gnFonGRkf9Q" alt=""><figcaption></figcaption></figure>

Please follow these configurations:

<figure><img src="/files/8LpxoOI2ibbZgBLEzk8i" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="205.359375">Metadata</th><th width="392.11328125">Description</th><th width="262.6015625">Type in DAM</th></tr></thead><tbody><tr><td>Scope</td><td>Asset metadata scope/channel attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems.<br><br>You can use "Sync scope options" to add all scopes/channels from PIM to DAM Metadata field options</td><td>Multiple select</td></tr><tr><td>Locale</td><td>Asset metadata locale attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems.<br><br>You can use "Sync locale options" to add all locale from PIM to DAM Metadata field options</td><td>Multiple select</td></tr><tr><td>Product /Family</td><td>Product family attributes must be synchronized between DAM and PIM, using a select-one field with identical predefined options in both systems.<br><br>To get all options family from PIM you can use Sync family option feature, read bellow.<br><br>You can use "Sync family options" to add all families from PIM to DAM Metadata field options.</td><td>Select one</td></tr><tr><td>Product/Default PIM Product Attribute</td><td>This is the default attribute to which assets will sync if no specific setting is defined in the Product Attribute Mapping.</td><td>N/A</td></tr><tr><td>Product / Product Code</td><td><p>Product code metadata identifies the specific products to be updated during the synchronization process. Use a text field.<br><br>If you use Product reference instead Metadata. Please first Enable Product in DAM / Library / Feature Components</p><p></p><div><figure><img src="/files/N6lOK18omxEovfG1szM8" alt=""><figcaption></figcaption></figure></div></td><td>Text</td></tr><tr><td>Product / Product model code</td><td>Product model code metadata identifies the specific products to be updated during the synchronization process. Use a text field.</td><td>Text</td></tr></tbody></table>

**Sync family options**

You have to provide a valid API Key in PIM to DAM section to enable this feature.

<figure><img src="/files/nlJ4eMcMYLvqIIIdW93Y" alt=""><figcaption><p>Sync family options</p></figcaption></figure>

#### Main attribute setting

This mapping determines which asset attributes will be synchronized based on the product family.

* Select Family
* You can set Default attribute options in case all family have the same field. If you don't declare mapping for specific family, this attribute will be use by default.
* Select attribute belong to Family
* You can Edit and Delete

{% hint style="info" %}
You can have 2 main attributes for one Family, each Family can have only one main attribute.
{% endhint %}

<figure><img src="/files/MoNXL9mibBTaKbITYCJu" alt=""><figcaption></figcaption></figure>

## Synchronization&#x20;

### Metadata version

* Go to any asset, at Metadata section click Edit

* Enter family and code metadata which same in setting page

  * If you use Product Reference Component, Enter code on Product Section on top of Metadata tab

  <figure><img src="/files/eth1HqblcPmpH5D0ubjP" alt=""><figcaption></figcaption></figure>

* Click save

<figure><img src="/files/9nfUwH8yZb0QZtLZy8yZ" alt=""><figcaption><p>Edit Asset Metadata</p></figcaption></figure>

If PIM to DAM enabled, any update attribute(supported types) in Akeneo will update in DAM

* It only update asset metadata when change attribute value in PIM if that asset is synced to an Asset or Product in PIM.
* If one asset synced to multiple assets, products, the last one win.

### UI version

* Right click on any asset / More action / Sync to Akeneo

<figure><img src="/files/igoxrXUYvdku9yGHOKiz" alt=""><figcaption></figcaption></figure>

* Choose Family or Entity, Product
* Choose attribute
* There are 4 cases that can happen:
  * Value per channel and value per locale are both false: Can sync without choose scopes or locales
  * Value per locale is true, value per channel is false: Must choose at least one locale
  * Value per locale is false, value per channel is true: Must choose at least one scope
  * Value per channel and value per locale are both true: Must choose at least one scope and locale

{% hint style="info" %}
Product Code must exist in Akeneo, for Asset and Entity it does not required, if not exist it will create a new one.
{% endhint %}


# Akeneo Enterprise PIM App

Scaleflex DAM (VXP) Akeneo App

## Installation & Activation

### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

* You need an active DAM account. [Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have one;
* Your Akeneo plan needs to be *Enterprise Edition*.

### Activation by App(EE Version)

* Log in to your Akeneo instance
* Go to **Connect - App store**, search by name: "Scaleflex", App name: "Scaleflex DAM (Visual Experience Platform)"

<figure><img src="/files/MwZYsmtGi16tpEfIiclV" alt=""><figcaption><p>Scaleflex App</p></figcaption></figure>

* Click *Connect*: You will be redirected to the Asset Hub where to select which token you want to use for your Akeneo instance
  * Each token can be used for only one Akeneo Instance
  * Multiple Akeneo instances can use the same token

<figure><img src="/files/zlMqKeGGM5q7AQKuSj65" alt=""><figcaption><p>Select one Token to use with Akeneo</p></figcaption></figure>

* After selecting your token and clicking Active, you will be redirected back to Akeneo, **please grant all permission to Akeneo app**
  * **Check on EVENT PLATFORM**

<figure><img src="/files/L2iaoefIJRkixmPEdhd6" alt=""><figcaption></figcaption></figure>

* When activation done, you will be redrect to DAM Hub. You can choose go to Setting Page, or discover the DAM Hub.

## Configurations

Go to Setting / Automation / Integrations or use this link: <https://hub.scaleflex.com/settings/dam/automations/integrations>

There are 2 sections:

### General Setting

<figure><img src="/files/K2pOsx7Z6N61dFrzoi6T" alt=""><figcaption></figcaption></figure>

#### Default Configuration

* Enable / Disable: If disabled, you cannot use the Akeneo sync feature on DAM
* Default size: Default image size will be used if there are no configs related to each asset
* Image resize technique:
  * Crop: Cut image part to resize
  * Fit: Keep all content in image, and make image fit the size
* Addition subfix URL: append a suffix to asset URLs to enable transformations,  read more here: [Transformations](/dynamic-media-optimization-dmo/transformations/image-optimization/operations)
* Please click "Save changes" to update the configuration

#### Image resize setting

**How does it work?**

* Can be duplicated
* Priority: Bottom to top, and it will apply the first one match the setting, check example bellow.

*Example:*&#x20;

An Asset with these information:

* Scope: commerce / Locale: en\_US / Family: filerobotmedia
* Will try to match setting following the steps below:
  * First try: Type: Asset / Family: filerobotmedia / Scope: commerce / Locale: en\_US
  * Second try: Type: Asset / Family: All Items / Scope: commerce / Locale: en\_US
  * Third try: Type: Global / Scope: commerce / Locale: en\_US
  * Use size and image resize technique from Default configuration above

**Flow guide**

* Select type, there are 4 types:
  * Global: Affects all assets including entity and asset
  * Asset: Asset Family
  * Entity: Entity Reference
  * Product
* Choose family, we can choose **"All items"**, this will be affected all Families in selected type
* Scope and locale

<table><thead><tr><th width="225.3828125">Setting in DAM</th><th>Akeneo attribute</th></tr></thead><tbody><tr><td>No Scope + No Locale</td><td><ul><li>Value per locale: False </li><li>Value per channel: False</li></ul></td></tr><tr><td>Scope + No Locale</td><td><ul><li>Value per locale: False </li><li>Value per channel: True</li></ul></td></tr><tr><td>No Scope + Locale</td><td><ul><li>Value per locale: True </li><li>Value per channel: False</li></ul></td></tr><tr><td>Scope + Locale</td><td><ul><li>Value per locale: True </li><li>Value per channel: True</li></ul></td></tr></tbody></table>

* Image resize technique: Fit or Crop
* Size: Must follow format: width x  height, example: **300x400**
* **Addition subfix URL:** append a suffix to asset URLs to enable transformations,

### Sync Setting

<figure><img src="/files/FITwFlqKBV9UAjJCzrpL" alt=""><figcaption></figcaption></figure>

#### PIM to DAM

To enable PIM to DAM sync: When we update some attribute(check supported field type above) in a PIM record(Asset, Product), it will update the mapped metadata in DAM.

* Go to Access to get an API Key: <https://hub.scaleflex.com/settings/project/access/api-keys>, please select All

<figure><img src="/files/swgOMKplVNdWbbNoaV8x" alt=""><figcaption></figcaption></figure>

* Copy API Key and paste into Api key
* Enable the Toggle button
* Save changes

#### Metadata setting

To sync from DAM to PIM by Metadata you have to copy and add to new Webhook Setting at: <https://hub.scaleflex.com/settings/dam/automations/webhooks>

<figure><img src="/files/vBJ0LLIL3gnFonGRkf9Q" alt=""><figcaption></figcaption></figure>

Please follow these configurations:

<figure><img src="/files/8LpxoOI2ibbZgBLEzk8i" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th>Metadata</th><th width="392.11328125">Description</th><th>Type in DAM</th></tr></thead><tbody><tr><td>Scope</td><td>Asset metadata scope/channel attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems.<br><br>You can use "Sync scope options" to add all scopes/channels from PIM to DAM Metadata field options</td><td>Multiple select</td></tr><tr><td>Locale</td><td>Asset metadata locale attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems.<br><br>You can use "Sync locale options" to add all locale from PIM to DAM Metadata field options</td><td>Multiple select</td></tr><tr><td>Product /Family</td><td>Product family attributes must be synchronized between DAM and PIM, using a select-one field with identical predefined options in both systems.<br><br>To get all options family from PIM you can use Sync family option feature, read bellow.<br><br>You can use "Sync family options" to add all families from PIM to DAM Metadata field options.</td><td>Select one</td></tr><tr><td>Product/Default PIM Product Attribute</td><td>This is the default attribute to which assets will sync if no specific setting is defined in the Product Attribute Mapping.</td><td>N/A </td></tr><tr><td>Product / Product Code</td><td><p>Product code metadata identifies the specific products to be updated during the synchronization process. Use a text field.<br><br>If you use Product reference instead Metadata. Please first Enable Product in DAM / Library / Feature Components</p><p></p><div><figure><img src="/files/N6lOK18omxEovfG1szM8" alt=""><figcaption></figcaption></figure></div></td><td>Text</td></tr><tr><td>Product / Product model code</td><td>Product model code metadata identifies the specific products to be updated during the synchronization process. Use a text field.</td><td>Text</td></tr><tr><td>Asset / Family</td><td><p>Asset family attributes must be synchronized between DAM and PIM, using a select-one field with identical predefined options in both systems.</p><p><br>You can use "Sync family options" to add all families from PIM to DAM Metadata field options.</p></td><td>Select one</td></tr><tr><td>Asset/Default PIM Asset Attribute</td><td>This is the default attribute to which assets will sync if no specific setting is defined in the Asset Attribute Mapping.</td><td>N/A</td></tr><tr><td>Asset / Asset Code</td><td>Asset code metadata identifies the specific products to be updated during the synchronization process. Use a text field.<br><br>To get all options family from PIM you can use Sync family option feature, read bellow.</td><td>Text</td></tr></tbody></table>

**Sync family options**

You have to provide a valid API Key in PIM to DAM section to enable this feature.

<figure><img src="/files/nlJ4eMcMYLvqIIIdW93Y" alt=""><figcaption><p>Sync family options</p></figcaption></figure>

#### Main attribute setting(Same for Product and Asset)

To see these tabs, you have to enable feature on Metadata section

<figure><img src="/files/2AZ2iv1rwI4F6IZykpmP" alt=""><figcaption><p>Enable Product</p></figcaption></figure>

This mapping determines which asset attributes will be synchronized based on the product family.

* Select Family
* You can set Default attribute options in case all family have the same field. If you don't declare mapping for specific family, this attribute will be use by default.
* Select attribute belong to Family
* You can Edit and Delete

{% hint style="info" %}
You can have 2 main attributes for one Family, each Family can have only one main attribute.
{% endhint %}

<figure><img src="/files/MoNXL9mibBTaKbITYCJu" alt=""><figcaption></figcaption></figure>

## Synchronization&#x20;

### Metadata version

* Go to any asset, at Metadata section click Edit

* Enter family and code metadata which same in setting page

  * If you use Product Reference Component, Enter code on Product Section on top of Metadata tab

  <figure><img src="/files/eth1HqblcPmpH5D0ubjP" alt=""><figcaption></figcaption></figure>

* Click save

<figure><img src="/files/9nfUwH8yZb0QZtLZy8yZ" alt=""><figcaption><p>Edit Asset Metadata</p></figcaption></figure>

If PIM to DAM enabled, any update attribute(supported types) in Akeneo will update in DAM

* It only update asset metadata when change attribute value in PIM if that asset is synced to an Asset or Product in PIM.
* If one asset synced to multiple assets, products, the last one win.

### UI version

* Right click on any asset / More action / Sync to Akeneo

<figure><img src="/files/igoxrXUYvdku9yGHOKiz" alt=""><figcaption></figcaption></figure>

* Choose Family or Entity, Product
* Choose attribute
* There are 4 cases that can happen:
  * Value per channel and value per locale are both false: Can sync without choose scopes or locales
  * Value per locale is true, value per channel is false: Must choose at least one locale
  * Value per locale is false, value per channel is true: Must choose at least one scope
  * Value per channel and value per locale are both true: Must choose at least one scope and locale

{% hint style="info" %}
Product Code must exist in Akeneo, for Asset and Entity it does not required, if not exist it will create a new one.
{% endhint %}


# Canva App

Scaleflex DAM x Canva

{% hint style="info" %}
Note: if you are looking to edit an image with Canva from within the Scaleflex DAM, you should use the native Canva plugin described [here](/digital-asset-management-dam/plugins-and-connectors/plugins/canva)
{% endhint %}

### To connect and access your DAM media: <a href="#od_117c69a2" id="od_117c69a2"></a>

[*Register for a demo*](https://www.scaleflex.com/en/request-a-demo) *if you don't already have a Scaleflex DAM account.*

#### **Step 1: Log into your Canva account**

You can either use the web client or the desktop Canva application

#### **Step 2: Add the "Scaleflex DAM" app**

On the left Menu sidebar, navigate to "*Apps".*

Enter "Scaleflex" in the search field, and click the app to open/use it.

Choose the project you want to use the app with (existing or new),

#### **Step 3: Log into the Scaleflex DAM**

Click the "Connect" button to open the authentication modal of the Scaleflex DAM, and enter:

* **Project identifier**: aka the "token" from Scaleflex DAM, that can be found on the top right menu of the VXP interface, or communicated by your administrator.
* **Security Identifier**: aka the "sec template" from Scaleflex DAM, that will be used to obtain a “limited-time access”. See the [Security Templates documentation](https://docs.scaleflex.com/vxp-visual-experience-platform/settings/project/access/security-templates) for more details.
* **Upload directory**: The "root" folder from where you will load your digital assets on the Scaleflex DAM platform (has to be consistant with and allowed by the "security identifier" settings)

### Features <a href="#od_5ebfccc6" id="od_5ebfccc6"></a>

Navigate, browse, and search for your Scaleflex DAM image and video assets for your Canva designs.

Drag and drop to add the image/video to your design.

<figure><img src="/files/k2jjrafGEjb4HTlMWjCp" alt=""><figcaption></figcaption></figure>


# CI-Hub

CI-Hub allows you to easily open and modify assets stored in the Scaleflex DAM using Office365, Google, Figma, and Adobe software. It also allows to add a seamless integration of your Scaleflex DAM library as an extension of your own personal computer storage with the CI-Hub Drive connector, that adds a Cloud-connected "additional drive" to your Windows Explorer or Apple Finder.

A complete list of the compatible software tools for use with CI-Hub can be found [here](https://ci-hub.com/all-applications).

## Prerequisites:

In order to access your DAM assets in the programs mentioned above, you must have:

* an active user account in Scaleflex DAM
* an active licence registered in CI-Hub (ask your administrator or point of contact)
* an access (account or licence) to the software you wish to use for asset modification
* installed the corresponding CI-Hub integration (aka. add-on, extension) for that software.

*Please check* [*this page*](https://ci-hub.com/hubfs/CIhub-2023/CI%20HUB%20Connector%20v2.3.pdf) *for detailed instructions for your software.*

### Steps to open an asset via CI-Hub in a third party software:

1. Open the CI-Hub integration panel in the desired software and click the "**Login**" button
2. Use your CI-Hub credentials on the page "**Sign in to CI HUB**" and switch back to the application
3. Validate your Scaleflex DAM connection and authenticate
   1. \[first time] Add a connection to Scaleflex (the \[+] icon on the right) and connect using your DAM credentials on the dedicated page, select your Project identifier to connect to
   2. \[following times] Reload your connection to Scaleflex (the "refresh" icon at the bottom)

*Please note: When you log into your Scaleflex DAM account, and select the project you wish to grant access to via CI-Hub, you must use the name shown in the top right of the Scaleflex DAM interface (in parenthesis after the projet's name).*

### Functionalities:

The CI-Hub connector allows you to preview files available in DAM, then to select them for export  and open them in your preferred software tool. You may modify the content within that tool and then upload the new version of the file back to Scaleflex DAM. The upload is not automatic and occurs only after the user selects this option.

The connector allows you to search for files and inspect their metadata as well.

### Additional notes:

* Some types of files cannot be opened in certain software. This is a limitation of the software itself and it comes from the "specialisation" of what it is doing. For example, video files cannot be opened using the CI-Hub connector for Adobe Photoshop, nor can Excel sheets be opened using the connector for InDesign.
* The Gallery Role and User Level permissions in Scaleflex DAM may affect the number of files accessible via CI-Hub, as well as the actions that can be applied to them. For example, if a folder is hidden from a specific user in Scaleflex DAM, its content will also be unavailable for that user in CI-Hub. Also, if the user does not have a permission to upload new files in Scaleflex DAM, it may result in a failure to upload the modified file version back to DAM after editing within the specified software.
* Some software tools have file size limitations when importing assets from DAM. Known use cases are:
  * The integration with Google Slides that does not allow assets bigger than 8MBs. In such cases, a solution could be to open the file in PowerPoint or in some of the products of Adobe.
  * Figma allows images with dimensions up to 4096x4096px to be imported.
* The process of uploading the edited version back to DAM depends on the filename of the new file and the configuration of your [Scaleflex DAM storage](https://hub.filerobot.com/settings/dam/storage/upload). If you choose the same filename and folder as the existing asset, be aware that if DAM Storage is set to 'New version,' the file will be uploaded on the top of the existing asset. If it is set to 'Overwrite,' the new file will replace the previous version, and ***the older file will be lost***. If it is set to 'Refuse upload,' you will need to change the filename to import the new file back to the Scaleflex DAM.
* The CI-Hub connector needs to actively be connected to Scaleflex DAM in order to fetch the assets content from the Storage; you therefore need to be online and have a steady internet connection.


# Commercetools FaaS App

DAM Commercetools connector app

### Installation <a href="#od_ef51fe98" id="od_ef51fe98"></a>

#### Prerequisites <a href="#od_ef51fe98-1" id="od_ef51fe98-1"></a>

* Nginx
* PM2
* Nodejs > v16.10.0
* Certbot

#### Step 1. Download and install <a href="#od_1e92263f" id="od_1e92263f"></a>

To install the DAM module, please follow the steps below:

* 1\.  [Download Latest release of the Module](https://github.com/scaleflex/commercetools-filerobot-plugin/releases)
* 2\. Upload and unzip to the server at your domain path (Ex: /var/www/public\_html/)
* 3\. Configuration Commercetools & DAM plugin **(Read** [**2. Configuration**](#od_ebdb8e0c)**)**
* 4\. Go to the source folder and run "**npm install**", "**npm run build**" (this command will build and create a folder **public**)
* 5\. Go to the folder **public** and run "**pm2 serve --spa**".
* 6\. Config your domain, port you will run with Nginx and create SSL with Certbot [(Read here)](https://tecadmin.net/how-to-generate-lets-encrypt-ssl-using-certbot/) For example, config with port 8080:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F0Y9bUE0Ws3Vp09Y6ixWt%252Fct1.png%3Falt%3Dmedia%26token%3D56aa5580-e726-4b00-b1f2-a2c88947edcc&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=7ad33493&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Step 2. Configure <a href="#od_ebdb8e0c" id="od_ebdb8e0c"></a>

* Get the **applicationId** and **entryPointUriPath** of Commercetools [(Read here)](https://docs.commercetools.com/custom-applications/development/going-to-production#assigning-the-application-id)

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FzqJ9pfQwApudAMti9bxm%252Fct2.png%3Falt%3Dmedia%26token%3D11ab7bcc-074c-4089-943c-db4f27249525\&width=768\&dpr=4\&quality=100\&sign=203b0cbb\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FifMNGsmYZRDBe0zgxC9n%252Fct3.png%3Falt%3Dmedia%26token%3D37051dac-7d40-4ae5-8d66-c2278c1d8bf7\&width=768\&dpr=4\&quality=100\&sign=57d18036\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F3mp1hpXFUsLEC7dmARZg%252Fct4.png%3Falt%3Dmedia%26token%3Df5cc186e-1576-4171-90c5-73af37f27cee\&width=768\&dpr=4\&quality=100\&sign=f32bed10\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FwRrod7XFb8Qmqfq1s62n%252F1.png%3Falt%3Dmedia%26token%3D6c61916b-2564-4cfd-a3ae-ae5d03cf95f7\&width=768\&dpr=4\&quality=100\&sign=3f28784d\&sv=1)

Configure the DAM module as follow:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FtyldFSrdskHCq2eW9AuI%252Fct8.png%3Falt%3Dmedia%26token%3Da105f3a3-f8a1-43b5-a500-428f5fddbb83&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=aa2b8798&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* For Commercetools project:
  * Clone file **custom-application-config.example.mjs** and rename to **custom-application-config.mjs**
  * Input your Commercetools configuration
  * Set your **entryPointUriPath** at **src/constants.js**
* For the DAM module:
  * Clone file **filerobot-config.json.example** in folder "**src"** and rename to **filerobot-config.json**
  * Input your DAM token, SEC, upload directory, and any other options as fitting.

### User Guide <a href="#od_ef51fe98-2" id="od_ef51fe98-2"></a>

#### Access Scaleflex DAM <a href="#access-scaleflex-dam" id="access-scaleflex-dam"></a>

In left-menu, select **Scaleflex DAM** > **Products**

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FS7JDhSywZtByHv51RKhg%252F2.png%3Falt%3Dmedia%26token%3D07cf6967-3f31-410d-bd60-b9e6673630dd&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=aedf94a8&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Upload/Update Product Images <a href="#upload-update-product-images" id="upload-update-product-images"></a>

In this page select your product variant need to upload/update image

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FBzSismUNUltmji8ALdpw%252F3.png%3Falt%3Dmedia%26token%3Dfb543f81-50f2-4ba9-964f-3af7294fc710&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=d5fcd352&#x26;sv=1" alt=""><figcaption></figcaption></figure>

To add new image, click on "Add Image" in view page Variant Detail

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FBiVPkGd2NL46X5jsmyTD%252F4.png%3Falt%3Dmedia%26token%3Dd9500770-9b90-450e-87b0-8cfdbdca282b&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=b750a60c&#x26;sv=1" alt=""><figcaption></figcaption></figure>

Select an image on the widget and click on "Insert" button to add the image.

**Note:** You can select multiple images.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F24vMsC1mmqN0EzsKi2Bz%252F5.png%3Falt%3Dmedia%26token%3Dd46307b8-ac2b-4b9c-84a8-b5c8b160a552&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=6f23c54&#x26;sv=1" alt=""><figcaption></figcaption></figure>


# Hygraph app

Integrate Hygraph with DAM by Scaleflex to bring in and manage your digital assets seamlessly from the DAM as the Single Source of Truth.

With this application, users can upload, store, edit, manage, optimize, enrich and automate their media assets right within their Hygraph UI, saving time and better enhancing their workflow.

Publish your Media Assets directly from within Hygraph with the Media Asset Widget:

* `As Original`: This option is available for all assets. Adds them to the content entry as is, as a preview or downloadable element.
* `As Transformation`: This option is only available for image assets. It lets you modify the image format, quality, size, and even to crop part of it.

*This integration is developed and maintained by our partner Hygraph.*

Useful resources:

* General information: [LINK](https://hygraph.com/marketplace/apps/hygraph-scaleflex-filerobot-app)
* Installation guide: [LINK](https://hygraph.com/docs/integrations/connect-scaleflex-filerobot)
* Hygraph community (slack): [LINK](https://hygraph-community.slack.com/)

[<br>](https://docs.scaleflex.com/filerobot-documentation/headless-dam-and-api/plugins-and-connectors/connectors/commercetools-faas-app)


# Kontent.ai

#### Installation <a href="#od_d213f5ca" id="od_d213f5ca"></a>

1. Have a Kontent CMS setup. <https://kontent.ai/>
2. Add custom element

Content model (left hand side) > Create new > Custom element (right hand side). You will then have the below view.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FV3nimJLeFXOLGJLNv2Xv%252FKontent_custom_element.png%3Falt%3Dmedia%26token%3D8b0a594d-880f-4884-ad0b-bcf7faacd3ed&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=ffd90988&#x26;sv=1" alt=""><figcaption></figcaption></figure>

\*\*Hosted code URL: <https://scaleflex.cloudimg.io/v7/plugins/filerobot-kontent/filerobot-custom-element.html?func=proxy>

**Parameters:**

```
{
    "token": "token",
    "secTemplate": "your_security_template",
    "dir": "/base_directory"
}
```

*note: "dir" element is optional, by default will go to the root folder of your library. Do not add "/" at the end of the directory string.*

1. Create new content with this Custom Element

Content & asset (left hand side) > Create new > Chose type: Your\_Type\_Name. Chose and add some images, publish. You will then have the below view.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FPm9fBBl1hfQpawk5pkSp%252FK2.png%3Falt%3Dmedia%26token%3De4c76961-0c40-4d38-87d0-1d4d6d5258f7&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=ba0f02ee&#x26;sv=1" alt=""><figcaption></figcaption></figure>

The images below are the images added in from the Widget into a Kontent content-item. When they are added, they will have DAM-URLs (instead of their Strapi CMS URLs).

#### Previewing <a href="#od_7791d727" id="od_7791d727"></a>

Tutorial: <https://kontent.ai/learn/tutorials/develop-apps/build-strong-foundation/set-up-preview/>

Go to **Settings > API Keys**. For this, you will need your **Project ID**. You may also need your **API Key** (depends on what you want to do, but for simple things Project ID is enough).

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F3yWcVAT9VshUcrJQxl9U%252FK3.png%3Falt%3Dmedia%26token%3Ddf6d8cd9-400a-4f6e-911b-5c98b39d83b1&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=437e3637&#x26;sv=1" alt=""><figcaption></figcaption></figure>

Write a **client app** that utilizes the **Delivery API**

*Recall that Kontent have 3 sets of APIs that you can interact with*

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FaG9492jCM5IdlZBCwMV3%252FK4.png%3Falt%3Dmedia%26token%3D246f64d0-5c1e-4293-9f3f-3a2881e30fd4&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=57c5babf&#x26;sv=1" alt=""><figcaption></figcaption></figure>

*Delivery APIs in plain HTTPS form can be downloaded from* [*https://kontent.ai/learn/tutorials/develop-apps/get-started/postman-collection/*](https://kontent.ai/learn/tutorials/develop-apps/get-started/postman-collection/) *and imported into POSTMAN*

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FxDcoDt2SyX2ZBRRfkdKv%252FK5.png%3Falt%3Dmedia%26token%3D2626c674-598a-4619-bd58-bb656fe9a07a&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=8f478a13&#x26;sv=1" alt=""><figcaption></figcaption></figure>

For the 3 content items that come out of the box, Kontent already have an **example client app**, which we can **imitate**.

* This example app was made by using React JS <https://github.com/kontent-ai/sample-app-react>
* Hosted on various Github Pages.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FODySP974EauGcFoQ9ukk%252FK6.png%3Falt%3Dmedia%26token%3D60aadaa6-5193-454d-b1d8-b478d52b85fc&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=ba05b29a&#x26;sv=1" alt=""><figcaption></figcaption></figure>

After writing and hosting your client app, go to **Settings > Preview URLs** and **define your Preview URL formats**.

See how Kontent defined their preview URLs for their example app:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252Fqnyups0iuAsXPxmrZGaE%252FK7.png%3Falt%3Dmedia%26token%3D4b7fd9b0-68b9-4942-a5b6-cba174a40163&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=7711f24a&#x26;sv=1" alt=""><figcaption></figcaption></figure>

`Codename`, `URLSlug` & `ItemId` are obtained as follows:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FOUoV6xxyViU6mg2gvLoM%252FK8.png%3Falt%3Dmedia%26token%3D058bce09-31f3-4588-be16-64ecacd779c4&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=fcd6d23f&#x26;sv=1" alt=""><figcaption></figcaption></figure>

Once you done all the above, you can preview by clicking **Preview:**

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FvPaNKhiG5rt03rPbUgqi%252FK9.png%3Falt%3Dmedia%26token%3Dea832172-8068-4313-99c9-d2993128904a&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=6378d261&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Support <a href="#od_dd36effa" id="od_dd36effa"></a>

* <https://kontent.ai/community/> or <https://kontent.ai/discord>
* <https://scaleflex.zendesk.com/hc/en-gb/requests/new> or <hello@scaleflex.com>


# OneTeg

OneTeg is a no-code integration platform as a service (iPaaS) content and data exchange solution. It allows for easy integration between the Scaleflex DAM and other systems that can run on the Cloud or On-Prem, to solve the complexities of content unification and data synchronization while providing user-driven flows for a simplified integration across platforms.

A complete list of the compatible third party software connected to Scaleflex DAM can be found [here](https://oneteg.com/connectors/scaleflex-integrations/).

## Prerequisites:

In order to access your DAM assets in the programs mentioned above, you must have:

* an active user account in Scaleflex DAM
* an active licence registered in OneTeg (ask your administrator or point of contact)

### Steps to setup a workflow connecting Scaleflex DAM and a third party:

1. Connect to your OneTeg Dashboard
2. Define the Scaleflex connection {your\_company}.oneteg.com/en/connections
3. Open the Workflow builder: {your\_company}.oneteg.com/en/flows
4. Click the \[+] icon on the top right corner to add a workflow
5. Build using the block editor (drag & drop, configure elements individuallly)
6. Save

### Functionalities:

Full headless access to the Scaleflex DAM library and functions (ref below).

{% content-ref url="/pages/Ux2dgK3ADDi4nlD5Hi9Y" %}
[Headless DAM](/developers-headless/headless-dam)
{% endcontent-ref %}

### Additional notes:

* Connection configuration: you will need to use an API key ( find it there <https://hub.filerobot.com/settings/project/access/api-keys> )

<figure><img src="/files/nsZdBU2mZuTIddDX3oHv" alt="" width="324"><figcaption><p>Scaleflex DAM connection setup</p></figcaption></figure>

* *Exemple of workflows*

*Library of flows:*

<figure><img src="/files/DMSYFG7GFSqpZtj3bUGX" alt=""><figcaption></figcaption></figure>

*Details and setting of a flow*

<figure><img src="/files/pjrOIQnUooFpdp8V1gMD" alt=""><figcaption></figcaption></figure>


# Pabbly Connect

DAM Pabbly integration

Pabbly connects more than 800+ software products for seamless real-time data transfer. Their simple integration platform allows anyone to seamlessly integrate DAM with other applications to automate workflows.

### Installation <a href="#od_9f68ca2c" id="od_9f68ca2c"></a>

#### **Prerequisites** <a href="#prerequisites" id="prerequisites"></a>

You can [request for demo](https://www.scaleflex.com/en/request-a-demo) if you don't have a DAM Account.

#### **Step 1: Login to both products** <a href="#step-1-login-to-both-products" id="step-1-login-to-both-products"></a>

After logging in DAM, you need to login to Pabbly Connect.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FqFjBlX4qjTCB9xGxqf7v%252Fas1.png%3Falt%3Dmedia%26token%3D48cc842f-1382-4e27-88d0-c9142981d1e4&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=da41d6ca&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### **Step 2: Create Action or Trigger in Workflow** <a href="#step-2-create-action-or-trigger-in-workflow" id="step-2-create-action-or-trigger-in-workflow"></a>

In the *Actions* seaction, search for *Filerobot by Scaleflex*.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FB1B2tm1BPUybIsbJL9jk%252Fas2.png%3Falt%3Dmedia%26token%3D2d2515f7-4521-4e2c-9426-b5ddff4393fa&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=8cd42270&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### **Step 3: Set up Action Event or Trigger Event** <a href="#step-3-set-up-action-event-or-trigger-event" id="step-3-set-up-action-event-or-trigger-event"></a>

Choose *Action Event* or *Trigger Event* from the drop down input and confirm with *Connect*:

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F6BD34M4NMG2iUzoYWSGB%252Fas3.png%3Falt%3Dmedia%26token%3D86da5c71-1705-46d1-94e9-58b840f7704c&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=d6b8d6a7&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### **Step 4: Configure Token and API key** <a href="#step-4-configure-token-and-api-key" id="step-4-configure-token-and-api-key"></a>

You can find your token and the API key in DAM Asset Hub: *Developers* / *API Secret Keys*.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FFjSL5S0unRwJdhAzZoMy%252Fas4.png%3Falt%3Dmedia%26token%3D07906850-f14c-40ae-9dc0-6eaf652140ea&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=3cd5447b&#x26;sv=1" alt=""><figcaption></figcaption></figure>

Once you save your Token and API key, you don't need to enter it again for another action event by selecting "Select Existing Connection" option.

### Usage <a href="#usage" id="usage"></a>

#### Available Trigger Events <a href="#od_33344ea7" id="od_33344ea7"></a>

Triggers are events that occur in DAM and that events data are sent to Pabbly. DAM Pabbly connector has the following triggers:

| Trigger Name | Description                                                                 |
| ------------ | --------------------------------------------------------------------------- |
| File Upload  | It is fired when a new file is uploaded to Filerobot.File details are sent. |

#### Available Actions <a href="#od_33344ea7-1" id="od_33344ea7-1"></a>

DAM Pabbly connector has the following actions and corresponding inputs:

| Action Name   | Description                               | Inputs                      |
| ------------- | ----------------------------------------- | --------------------------- |
| File Upload   | Used to upload remote hosted files to DAM | Origin File Url,File name   |
| File Delete   | Delete file from DAM                      | File UUID                   |
| File Rename   | Used to rename file.                      | File UUID,File new name     |
| Folder Create | Create new folder in DAM.                 | Folder path                 |
| Folder Delete | Delete folder in DAM                      | Folder UUID                 |
| Folder Rename | Rename folder in DAM                      | Folder UUID,Folder new name |
| Folder List   | Lists all folders details                 | (*N.A.)*                    |


# Prismic

Prismic Headless CMS integration

Instead of using the `/list` endpoint ([API documentation](https://developers.scaleflex.com/#43bfc74c-fd29-46be-83bf-b1e7bc8556e2)), this API supports Prismic's format directly.

This endpoint lists the assets with the following settings:

* 50 elements per pages
* ordered by last\_update

### Endpoint <a href="#od_7a4c8eea" id="od_7a4c8eea"></a>

**GET** {API\_SECRET\_KEY}@api.filerobot.com/{TOKEN}/integration/prismic/assets

| Property         | Description                                                                                                           |
| ---------------- | --------------------------------------------------------------------------------------------------------------------- |
| API\_SECRET\_KEY | can be generated in the Asset hub ([documentation](/vxp-visual-experience-platform/settings/project/access/api-keys)) |
| TOKEN            | your DAM token                                                                                                        |

### GET Parameters <a href="#od_fa47c38d" id="od_fa47c38d"></a>

| Parameter | Description                                                |
| --------- | ---------------------------------------------------------- |
| folder    | the path to the folder you would like to list default: `/` |
| page      | the result page number, starting from 1 default: `1`       |

### Examples <a href="#od_595cf1b4" id="od_595cf1b4"></a>

#### Request <a href="#od_d554c3ad" id="od_d554c3ad"></a>

Copy-paste the cURL request in your Terminal to see the API in action.

```
curl 'https://aecb26ec-f78f-4aec-a9f6-0fbaf38346b4@api.filerobot.com/fdocs/integration/prismic/assets?folder=/demo'
curl 'https://aecb26ec-f78f-4aec-a9f6-0fbaf38346b4@api.filerobot.com/fdocs/integration/prismic/assets?folder=/&page_num=4'
```

#### Response <a href="#od_00a53c18" id="od_00a53c18"></a>

The response format will look like this:

```
{
    "results_size": 81,
    "results": [
        {
            "id": "0de50f0c-d5dd-5a8c-ae96-9b8b32e500",
            "title": "c998f98fc77e833b3487b6e70dcbe0c7e62e7469cf1c572996d49e6c469e94.jpg",
            "description": "Some description colorful prismic_files",
            "image_url": "https://frtoksmp.filerobot.com/prismic_files/c998f98fce833b3487b6e70dcbe0c7e62e748969cf1c572996d49e6c469e94.jpg?vh=6aeec9&w=100&h=100&func=fit",
            "last_update": 1603813143000,
            "blob": {
                "name": "c998f98fc77e833b3487b6e70dcbe0c7e62e7469cf1c572996d49e6c469e94.jpg",
                "url": "https://frtoksmp.filerobot.com//prismic_files/c998f98fc77e833b3487b6e70dcbe0c7e62e7469cf1c572996d49e6c469e94.jpg?vh=6aeec9",
                "type": "image/jpeg",
                "size": 377727,
                "info": {
                    "img_h": 1000,
                    "img_w": 803,
                    "img_type": "JPEG"
                },
                "meta": {
                    "test key2": null,
                    "test key3": null,
                    "qa_tags": null
                    "tags": [
                        "colorful"
                    ],
                    "search": "Some description colorful prismic_files",
                    "description": "Some description"
                },
                "blurhash": null,
                "created_at": "2020-10-27T15:37:25Z",
                "modified_at": "2020-10-27T15:39:03Z"
            }
        },
        ...
    ]
}
```

Where:

* **results\_size** is the total counting of the listing result; and could be easily understood as the sum of `size(results)` of all pages, while each page contains a maximum of 50 files.
* **image\_url** is fixed to be resized to `100x100`
* **description** would be returned as a concatenation from `blob->meta->search` and `blob->meta->tags` and the parsed list of directories and sub-directories. In case the file doesn't have this field (and is at the root folder), it defaults to `No description for this file is available`.


# Shopify / Shopify plus app

DAM Shopify app

### Installation <a href="#installation" id="installation"></a>

* The DAM x Shopify App can be installed from the [Shopify App Store](https://apps.shopify.com/filerobot-by-scaleflex).
* [Create a support request](https://scaleflex.zendesk.com/hc/en-gb/requests/new) to be helped adding the App to your store.

#### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

* Have a DAM account, with the DAM App installed. If you don't have an account yet, please [contact us](https://www.scaleflex.com/request-a-demo) to get one;
* Create the Security Template Identifier (SEC) to use the app (Settings > Access > Security templates tab > [Add template](/vxp-visual-experience-platform/settings/project/access/security-templates))
* You need to  have a store on Shopify.

#### Step 1. Install and configure <a href="#step-1.-install-and-configure" id="step-1.-install-and-configure"></a>

In Shopify, open the DAM app in the **Apps** menu item and click the button “Configuration”

* Fill-in your DAM token, CNAME (not required), Security Template Identifier (SEC), Upload Directory (not required, the default will be "/"), and press “Save”

#### Step 2. Add DAM Snippets <a href="#step-2.-add-filerobot-snippets" id="step-2.-add-filerobot-snippets"></a>

* Add DAM snippets to your theme: In modal Configuration, click the button “Update Snippets” to update or create new DAM snippets in your theme store.

#### Step 3. Install DAM Webhooks <a href="#step-3.-install-filerobot-webhooks" id="step-3.-install-filerobot-webhooks"></a>

* Add product webhooks for actions create/update/delete, that will check and update images from DAM Hub when the user has a permission to create/update/delete.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F2VkvJF7fIe8dpvpx1IUl%252Fscreenshot_1695917113.png%3Falt%3Dmedia%26token%3Ddd90d87c-cadf-4706-b316-942a56b943c1&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=360c9c4f&#x26;sv=1" alt=""><figcaption></figcaption></figure>

### Usage <a href="#usage" id="usage"></a>

#### Upload your Shopify product media to DAM <a href="#upload-your-shopify-product-media-to-filerobot" id="upload-your-shopify-product-media-to-filerobot"></a>

* In Shopify, open the DAM app from the **Apps** menu item.
* Click the button “Sync All Product Media”. The process will run in the background for a few minutes depending on the number of images in your store. It will download all product images from Shopify and store them in your DAM Library.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FtW2uPJPQWMoYd92buMur%252Fimage2.png%3Falt%3Dmedia%26token%3D82796ceb-c6ee-4d6f-8779-ec728a67c4e8&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=b1d886fe&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Sync media from DAM Hub to Shopify: <a href="#sync-media-from-filerobot-hub-to-shopify" id="sync-media-from-filerobot-hub-to-shopify"></a>

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FqE9S0BUe5jbP8t5eTbun%252Fimage.png%3Falt%3Dmedia%26token%3Debc144b3-3722-4197-992e-cc49cb09461b&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=d996d002&#x26;sv=1" alt=""><figcaption></figcaption></figure>

* Fill in your product name.  Then press "**Sync**":

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FrIerr90QLcbCAR4Hmy78%252Fimage.png%3Falt%3Dmedia%26token%3D8cac2118-2995-49cd-8aa7-3fddd8003883&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=40dffe62&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Display images on your site <a href="#display-images-on-your-site" id="display-images-on-your-site"></a>

You can add DAM images to your website by editing your theme's code.

The following snippets provide the functionality to display images on your website:

* **filerobot-image-tag.liquid:** Builds an image tag with multiple sources to render product images on your website lazily, applying transformations.
* **filerobot-product-media.liquid:** Uses filerobot-image-tag to render product images on your website, with optional transformations.
* **filerobot-url.liquid:** This will help you build a DAM URL to deliver an image on your website with any transformations that you want to apply.

You can use these snippets in your theme's code, referencing them in other snippets or sections.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252F6SxY7hqxLPbrbiEv97jY%252Fimage1.png%3Falt%3Dmedia%26token%3Db3309c0e-1905-4163-bf14-41efb0a21edb&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=e976a346&#x26;sv=1" alt=""><figcaption></figcaption></figure>

#### Display any DAM image on pages <a href="#display-any-filerobot-image-on-pages" id="display-any-filerobot-image-on-pages"></a>

You can use **filerobot-image-tag.liquid** or **filerobot-url.liquid** to display DAM image on your page

* First you will need to assign variable `fr_metafields`:

  Example:

```
{%- assign fr_metafields = product.metafields.filerobot_galleries -%}
```

* To render image tag

  Example:

```
{% render 'filerobot-image-tag', media: media.preview_image, metafields: fr_metafields, class: '', width: 1100, height: 1100, sizes: '(min-width: 750px) calc(100vw - 22rem), 1100px', media_id: media.id %}
```

* To get DAM image url

  Example:

```
<img src="{%- render filerobot-url', media: media.preview_image, metafields: fr_metafields, optimizer: '?grey=1&width=500&height=500' -%}">
```

Note: Read more about attribute optimizer following this [LINK](/dynamic-media-optimization-dmo/transformations/image-optimization)

#### Import multiple images to the product using CSV <a href="#import-multiple-images-to-the-product-using-csv" id="import-multiple-images-to-the-product-using-csv"></a>

**Require:**

* Configuration of your application in Shopify
* Installing the Product Webhook

To import multiple images you need to follow the document of Shopify: <https://help.shopify.com/en/manual/products/import-export/using-csv#adding-multiple-product-images>

Copy the image URL in the Hub and paste the URL to the column **Image Src** in the CSV file. After that, you can use the function "Import" on the **Products** page to update the product with your CSV file.

Example file:

[3KBproducts\_example.csv](https://3586816136-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl0Yvbyw1t10jWRzoi0FW%2Fuploads%2F2XotxKSut0s6ZOu7VAYn%2Fproducts_example.csv?alt=media\&token=2897dbe1-8fef-4720-98f1-fe844ea1a6bd)

When Shopify import is done, the DAM webhook will convert the image links from Shopify CDN to DAM CDN link.


# Zapier automation

DAM Zapier integration

Zapier connects over 3,000 different tools, applications, and services you need to manage your business. Their simple integration platform allows anyone to seamlessly integrate DAM with other applications to automate workflows.

The **DAM integration** allows t&#x6F;**:**

* Setup a trigger when a new file is uploaded to DAM (useful for setting up notifications, transforming uploaded files or using other tools)
* Upload new files to DAM
* Transform files in DAM (this is done by adding [transformation functions](/dynamic-media-optimization-dmo/welcome) to the file CDN link)
* Search for existing files and folders
* Create folders

### **Installation** <a href="#installation" id="installation"></a>

Start a new **Zap** and add a tool to start the trigger with. It can be DAM or any other tool. DAM can either start the Zap or execute the actions for the trigger coming from other tools, as shown in the example below.

![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FiqhT1iPZd342WCef2Agf%252Fz1.webp%3Falt%3Dmedia%26token%3D0ee0ccf3-68b2-4e70-b572-3aca255ee534\&width=768\&dpr=4\&quality=100\&sign=81e675b2\&sv=1)![](https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FnEPZkvRz4m2tQYmm4Web%252Fz2.webp%3Falt%3Dmedia%26token%3D650eca2c-0770-40d8-bf82-087ac2456025\&width=768\&dpr=4\&quality=100\&sign=3081348d\&sv=1)

Once the DAM trigger/action is added, you will be asked to **"Choose account"** to connect to DAM.

New browser window will pop up asking for authentication details to DAM Asset Hub.

<figure><img src="https://docs.scaleflex.com/~gitbook/image?url=https%3A%2F%2F3586816136-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Fl0Yvbyw1t10jWRzoi0FW%252Fuploads%252FOjJlNb1W3DhgieeflTX2%252Fz3.webp%3Falt%3Dmedia%26token%3D958813f1-0afa-4cb9-8b45-bc740ee1f991&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a4e90667&#x26;sv=1" alt=""><figcaption></figcaption></figure>

DAM **Token** can be found in the DAM Asset Hub project selector and next to the project title. While DAM **API Secret Key** is available in  Settings > Access > Security templates (tab) menu in the DAM Asset Hub. Make sure the API Secret Key has the minimum required permission for the actions of the Zap.

Once done, you have successfully connected your DAM account to your Zapier account.

After the account is successfully configured and authenticated, you will be able to **set up the triggers and actions for execution**.

When selecting the **Folder Path**, if you leave it as a default option, it will only do actions on the Root folder of your DAM account. When looking for a specific folder, you can add the folder path manually or use the search function for exiting folders in the Root folder path.




---

[Next Page](/llms-full.txt/1)