# User Documentation # Ibexa User Documentation # Ibexa User Documentation ## How to start? [Go through the First steps](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/get_started/index.md) [Explore and manage as Administrator](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/administrator/index.md) [Create and publish as Content editor](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/editor/index.md) [Oversee sales operations as Store manager](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/shop_manager/index.md) ## The latest release is 5.0.9 The latest version of Ibexa DXP is 5.0.9. Take advantage of the newest features and enhancements. [Release notes](https://doc.ibexa.co/en/latest/release_notes/ibexa_dxp_v5.0/) ![The latest release](https://doc.ibexa.co/projects/userguide/en/latest/images/notification-latest-release.svg) ## The newest LTS Update is MCP Servers Set up MCP servers to help AI agents interact with Ibexa DXP. [Learn more about this LTS Update](https://doc.ibexa.co/en/5.0/ai/mcp/mcp_guide/) [Discover other LTS Updates](https://doc.ibexa.co/en/5.0/ibexa_products/editions/#lts-updates) ![LTS Update](https://doc.ibexa.co/projects/userguide/en/latest/images/notification-lts-update.svg) ## Notable changes in v5.0 - [AI Actions](https://doc.ibexa.co/en/5.0/release_notes/ibexa_dxp_v5.0/#ai-actions) - [Discounts](https://doc.ibexa.co/en/5.0/release_notes/ibexa_dxp_v5.0/#discounts) - [Tech stack upgrades](https://doc.ibexa.co/en/5.0/release_notes/ibexa_dxp_v5.0/#software-architecture-upgrades) - [Date and time attribute for product catalog](https://doc.ibexa.co/en/5.0/release_notes/ibexa_dxp_v5.0/#date-and-time-attribute) - [Symbol attribute for product catalog](https://doc.ibexa.co/en/5.0/release_notes/ibexa_dxp_v5.0/#symbol-attribute) - [Developer experience improvements](https://doc.ibexa.co/en/5.0/release_notes/ibexa_dxp_v5.0/#developer-experience) ## Most popular pages - [Site Factory](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/work_with_sites/index.md) - [Translations](https://doc.ibexa.co/projects/userguide/en/latest/content_management/translate_content/index.md) - [Editorial workflow](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/index.md) - [Search for content](https://doc.ibexa.co/projects/userguide/en/latest/search/index.md) ## Manage your DXP ### [Content](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_items/index.md) - [Manage content model](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/manage_content_model/index.md) - [Author content](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/author_content/index.md) - [Publish content](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/publish_content/index.md) - [Organize content](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/organize_content/index.md) ### [Product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/product_catalog/index.md) - [Manage products](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/manage_products/index.md) - [Create and edit products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_edit_product/index.md) - [Work with product variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md) - [Work with catalogs](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_catalogs/index.md) ### [Commerce](https://doc.ibexa.co/projects/userguide/en/latest/commerce/commerce/index.md) - [Work with orders](https://doc.ibexa.co/projects/userguide/en/latest/commerce/order_management/work_with_orders/index.md) - [Work with shipping methods](https://doc.ibexa.co/projects/userguide/en/latest/commerce/shipping_management/work_with_shipping_methods/index.md) - [Work with payment methods](https://doc.ibexa.co/projects/userguide/en/latest/commerce/payment/work_with_payment_methods/index.md) - [Work with discounts](https://doc.ibexa.co/projects/userguide/en/latest/commerce/discounts/work_with_discounts/index.md) ### [Customer](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/customer_portal/index.md) - [Manage Customer Portal account](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/customer_portal/index.md) - [Manage customers](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/manage_customers/index.md) - [Company self-registration](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/company_self_registration/index.md) - [Create and edit Customer Portal](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/build_customer_portal/index.md) # Getting started # Get started Get started with Ibexa DXP by logging in to the back office. Ibexa DXP consists of the technical platform for creating and managing online experiences, designed for developers and end-users alike. It includes a web framework, APIs and a content repository. It features a customizable user interface where you can work with the content, products, media, manage other functionalities, and administer the platform. Depending on the product edition, Ibexa DXP can provide advanced capabilities in such areas as: - [content management](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_management/index.md) - [product management](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/product_catalog/index.md) - [customer management](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/customer_management/index.md) > **Note: Installation** > > Only administrators can [install](https://doc.ibexa.co/en/5.0/getting_started/install_ibexa_dxp/) Ibexa DXP. They should provide you with the address of the installation. ## Access the back office To access the back office (or the user/editor interface), add `/admin` to the address provided by the administrator. For example, if your website's URL is `www.my-site.com`, you enter the editing interface through `www.my-site.com/admin`. If you're the administrator, use the login credentials that were set [during the installation process](https://doc.ibexa.co/en/5.0/getting_started/install_ibexa_dxp/#create-a-database). Otherwise, to log in, you must get your user credentials from the administrator, and enter them on the login screen. ![Login screen](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/login_form.png "Login screen") ### Onboarding When you log in to Ibexa DXP for the first time, interactive product tours may appear if the Integrated help [LTS update](https://doc.ibexa.co/en/5.0/ibexa_products/editions/#lts-updates) is configured in your installation. This in-app walkthroughs guide you through key features and help you get started quickly. You can complete each step of the onboarding tutorials, skip them entirely if you prefer to explore on your own, or restart them anytime from your [user settings](#user-settings) under the **Browsing** section. ### View and edit user profile If you're an editor, depending on the system configuration, you may be able to view and edit the user profile, which can contain the following information: - Avatar image - First and last name - Email - Department - Position - Location - Signature - Roles the user is assigned to - Recent activity > **Note: Note** > > To display the [recent activity](https://doc.ibexa.co/projects/userguide/en/latest/recent_activity/recent_activity/index.md) log, your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md) must have the **Activity Log / Read** permission. ![User profile](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/user_profile_preview.png "User profile") To access your user profile, in the upper-right corner of the screen, click your avatar icon. Then, from the drop-down menu, select **Profile**. To edit your user profile, in the **User profile** screen, in the **Summary** section, click **Edit**. You can now modify the following entries: - Avatar image - First and last name - Signature - Department > **Note: Note** > > The fields may differ depending on your system configuration. To edit your avatar, in the **Image** area, click **Upload file** or drag and drop your photo. If necessary, you can [edit the photo with the Image Editor](https://doc.ibexa.co/projects/userguide/en/latest/image_management/edit_images/index.md). After you finish, the avatar is uploaded and is visible in the back office. ![Edit avatar](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/user_profile_avatar.png "Edit avatar") > **Note: Note** > > If you don't set your own image, a default avatar with your initials is displayed. To save changes to the user profile, click **Update**. ### User settings You can access your user settings on the right side of the top bar: ![User preferences menu](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/user_preferences.png) Here you can [change your user password](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/get_started/#change-the-password) and define your user preferences, such as preferred timezone, short and full date, and time format, or back office language. #### Location | Setting | Description | | ------------------------------------- | ----------------------------------------------------------------------------------------- | | Default currency | Sets the default currency used in the back office. | | Toggle In-Context translation feature | Enables or disables integration with Crowdin to navigate the interface while translating. | | User Time Zone | Sets time zone in the back office. | | Short date and time format | Sets short date and time format used in the back office. | | Full date and time format | Sets full date and time format used in the back office. | | Language | Sets the default language used in the back office. | #### Content authoring | Setting | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ | | [Autosave draft every given period](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/#autosave) | Enables or disables autosaving drafts. | | Seconds till next draft autosave | Sets time period for next autosave. | | Enable character count in online editor | Enables or disables character count. | | Automatically open block settings in builders | Enables or disables the behavior of blocks used in builders. | #### Browsing | Setting | Description | | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | Number of items displayed in the table | Sets the number of items displayed in sub-items. | | Location preview | Enables or disables a thumbnail preview on the content tree. | | Help center | Enables or disables the [help center](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#help-center). (LTS Update) | | Product tour | Enables or disables the [product tour onboarding](#onboarding) walkthroughs. (LTS Update) | | Product tour scenarios settings | Separate setting for each available product tour scenario. Allows you to mark each scenario as completed or reset its progress. (LTS Update) | #### Mode | Setting | Description | | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | | Focus mode | Enables or disables the [focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#focus-mode). | #### Dashboard | Setting | Description | | ---------------- | --------------------------------------------------- | | Active dashboard | Sets which dashboard is displayed after you log in. | ### Change the password You can change your user [password](https://doc.ibexa.co/en/5.0/users/passwords/) at any time. To do it, first, access your user profile, and go to **Account settings** tab. Then, click **Change password**. ![Change password](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/change_password.png "Change password") Fill in all the required fields and click **Save and close** to save changes. Click **Discard** to reject your changes and return to the previous screen. ![Editing password](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/editing_password.png "Editing password") # User interface Take a quick tour of the back office. ## Top bar At the top of the main screen you can see a top bar. ![Top bar](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/top_bar_all.png "Top bar") Depending on your location within the back office, it can contain the following important features: A. Logo in the left corner, which is a direct link to the [dashboard](#dashboard) B. "Focus mode" badge which informs you that the [focus mode](#focus-mode) is on C. Global search field that allows you to [find content](https://doc.ibexa.co/projects/userguide/en/latest/search/search_for_content/index.md) by checking all searchable fields D. Drop-down that changes the site context ![Top bar with site context selector](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/top_bar.png "Top bar with site context selector") E. [Notification](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/notifications/index.md) icon that informs you about incoming assignments or requests, for example, when another user invites you to preview their work or when items are assigned for [your review](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/#review-queue) F. App switcher which includes links to official websites of the QNTM group ecosystem companies, world-class ad-tech and mar-tech solution providers ![App switcher](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/app_switcher.png "App switcher") G. User avatar with a drop-down menu with access to [user profile and settings](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/get_started/#view-and-edit-user-profile) > **Note: Site context** > > Changing the site context results in the [content tree](#content-tree) showing content items that belong to the selected website. The appearance of content items can also change if they use different designs or languages depending on the [SiteAccess](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/multisite/#siteaccess) settings. ## Dashboard The first screen that you see after logging in is [Dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard/index.md). It's the default dashboard and contains selected blocks. ![Dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard.png "Dashboard") You can customize the dashboard by changing the blocks and the layout. For more information, see [Work with dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/work_with_dashboard/index.md). ## Main menu The main menu allows you to move between important sections of the application. ![Main menu](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/side_menu.png "Main menu") You can adjust the size of the menu sidebar. To do this, click on the side edge of the panel, then drag and adjust to the desired size. You can also hide it by clicking the button in the down right corner. ![Main menu - adjust](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/menu_adjust.png "Adjust main menu or hide it") Depending on the product edition and your [permissions](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permission_system/index.md), the main menu may include, for example: - **Content**, which gives you access to the content repository. It lets you navigate the content tree, and, for example, create, edit, move, copy, or delete content. - (Experience, Commerce) **Site management**, which enables you to create and edit block-based pages and manage multiple websites. - **Product catalog**, which enables you to handle products presented on the website, including their specifications and pricing. - **Admin**, which is the administration panel where you can manage, for example, Users, Sections, or permissions. ## Content tree Content tree is the place where you can navigate through all the content items in your application. It is available in the back office and allows you to browse your content, move content items around, hide them, send them to trash, and perform other actions. ![Content tree in the menu](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/left_menu_tree.png "Content tree in the menu") For more information, see [Content tree](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/content_tree/content_tree/index.md). ## Content browser During your work with Ibexa DXP you might need to select content from the repository. This happens, for example, when you want to move or copy a content item, embed an image, or link two content items. In such cases, you use the **Content Browser**. To access the **Content Browser**, go to the **Content** tab and select **Content structure** or **Media**. Then, select a file you want to copy or move and click the corresponding button in the top right corner. The Content Browser window opens, and you can select the new destination of the selected file or its copy. ![Content Browser](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/udw.png "Content Browser") With the **Content Browser**, you can switch between the Grid, Panels and Tree views to navigate through the content of the website. Depending on your permissions, you might be able to see the regular content, media, forms, site skeletons, and user accounts. You can also use the **Content Browser** to search the repository for content, edit content, create bookmarks, and create new content when needed. > **Note: Note** > > If you have administrator permissions, you can also view and manage user accounts and site skeletons in the **Admin** tab. > > For more information about users and permissions, see [Users](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md). > > For more information about site skeletons, see [Site skeletons](https://doc.ibexa.co/en/5.0/multisite/site_factory/site_factory_configuration/#site-skeletons). ## Focus mode Focus mode helps editors focus on information that is only relevant to their line of work and omit technical details that would distract. It's enabled by default, after you log in. If you need access to certain settings or technical details, you can [disable the focus mode](#disable-focus-mode) at any time. - **Dark theme for content tree** : In areas where the content tree is displayed, for example, in **Content structure**, the tree is displayed on a dark background. ![Dark theme for content tree](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/FM_dark_content_tree.png "Dark theme for content tree") - **Content item view** : If you select a specific [SiteAccess](https://doc.ibexa.co/projects/userguide/en/latest/content_management/translate_content/#siteaccess) from the **Site context** drop-down list on the right side of the top bar and then browse content items in content tree, they're displayed in full view, with a limited set of actions available. To display the content item details view with more actions, click **Exit full view**. ![Content item in full view](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/FM_content_item_full_view.png "Content item in full view") > **Tip: Tip** > > Even when you're out of the full view or not in Focus mode, you can still preview the content item in the **View** tab. - **Different details view tabs** : In Focus mode, the tabs in content item's detail view are different than the ones visible when it's disabled. Additionally, they're displayed in different order to expose the ones that are more important from the editor's perspective. ![Content item tabs in Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/FM_less_ci_tabs.png "Content item tabs in Focus mode") - **Different columns available for selection** : You can decide which columns are displayed in the **Sub-items** table, to adjust the view to your use case. The list of columns available for selection is limited in Focus mode. ![Columns in Sub-items table](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/FM_subitems_column_list.png "Columns in Sub-items table") ### Disable Focus mode Focus mode is enabled by default when you first log into Ibexa DXP, but you can toggle it in two places: - in user settings ![Focus mode user setting](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/FM_user_settings.png "Focus mode user setting") - in the drop-down menu on the right side of the top bar ![Focus mode switch](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/FM_switch.png "Focus mode switch") ## Help center (LTS Update) If the Integrated help [LTS update](https://doc.ibexa.co/en/5.0/ibexa_products/editions/#lts-updates) has been configured in your application, you may notice that the ![Help center](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/about-info.png) icon appears at the bottom right of multiple screens. Click it to access documentation, trainings, and other relevant resources straight from the back office. Help center is also [another place](https://doc.ibexa.co/en/5.0/administration/admin_panel/system_information_admin_panel/) where you can check the Ibexa DXP version that you're on. ![Help center](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/help_center.png "Help center") Contents of the help center are contextual: - If you are an [editor](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/editor/index.md) or [store manager](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/shop_manager/index.md) working in a production environment, help center contains links to user documentation, release notes and product roadmap highlights. - If you are a developer whose task is to set up or extend the application, it additionally shows links to developer documentation, API references and the GraphQL console. Help center can be [customized](https://doc.ibexa.co/en/5.0/administration/back_office/customize_integrated_help/) to fit the needs of your organization, for example, to include links to your internal style guides. ### Disable help center Help center is enabled by default, but you can toggle it in [user settings](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/get_started/#browsing). ### Dismiss help icon It may happen that the help icon overlaps with other interface elements that you want to interact with. In such case, hover over the help icon and click the X icon to dismiss it. The help icon reappears when you reload the screen. ![Help obstructs UI](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/help_obstructs.png "Help obstructs UI") # Dashboard Get to know about dashboard. Dashboard is the first screen that you see after you log into Ibexa DXP. It provides users a quick overview about specific content to make better business decisions based on data and work more efficiently with a clear and effortless access to important information. Default dashboard in Ibexa Headless contains the following blocks: - [Review queue](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#review-queue-block) - [My content](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#my-content-block) - [Common content](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#common-content-block) ![Dashboard - Headless edition](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_headless.png "Default dashboard in Headless edition") You can return to the **Dashboard** screen from any other page by clicking the Ibexa logo on the left of the top bar, or the home icon in the main menu. ![Dashboard icon](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_icon.png) ## Customizable dashboard (Experience, Commerce) You can customize the dashboard depending on your needs. A customized dashboard contains a set of widgets selected by the user. Customization allows you to quickly visit the areas that are used more often and exclude those less important: - Selected widgets boost productivity by highlighting vital data and helping in decision making - Predefined and custom layouts improve visibility for efficient task and deadline management By default, dashboard in Ibexa Experience and Ibexa Commerce contains the following blocks: - [Quick actions](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#quick-actions-block) - [Recent activity](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#recent-activity-block) - [Ibexa News](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#ibexa-news-block) - [Review queue](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#review-queue-block) - [My content](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#my-content-block) - [Common content](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#common-content-block) ![Dashboard - Experience and Commerce edition](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard.png "Default dashboard in Experience and Commerce edition") For more information, see [Work with dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/work_with_dashboard/index.md). # Work with dashboard Work with dashboard. Editions: Experience You can work with dashboard: edit and customize it depending on your needs. ## Permissions To be able to customize a dashboard, you need the `dashboard/customize` policy. By default, all users belonging to the `Editors` user group have the `Dashboard` role assigned, so that they can edit, create, or delete a dashboard. If, by any reason, you want to narrow this permission, you can set up specific limitations. For more information about setting up a permission system, see [Work with permissions](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md). ## Customize dashboard To customize the dashboard, on the main page, click **Customize dashboard**. ![Customize dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/customize_dashboard.png "Customize dashboard") If the banner is closed, click the three dots icon, and use the **Customize dashboard** action. ![Customize dashboard - three dots icon](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/customize_dashboard_icon.png "Customize dashboard - three dots icon") This action opens an online editor - Dashboard Builder. ![Dashboard Builder](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_builder.png "Dashboard Builder") ### Dashboard Builder interface Dashboard Builder user interface consists of: A. Drop zone B. Dashboard blocks / Structure view toolbox C. Buttons: | Name | Icon | Use | | ---------------- | ---------------- | --------------------------------------------- | | Fields | Fields | Edit dashboard name. | | Switch layout | Switch layout | Switch layout for the dashboard. | | Undo | Undo | Undo latest change. | | Redo | Redo | Redo latest change. | | Structure view | Structure view | Access **Structure view** toolbox. | | Dashboard blocks | Dashboard blocks | Access **Dashboard blocks** toolbox. | | Side moving | Side moving | Move toolbox to the other side of the screen. | Dashboard Builder has two main toolboxes that you can use while creating a dashboard: - **Dashboard blocks** - consists of all available blocks that you can use by dragging them and dropping on a drop zone. ![Dashboard blocks](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_blocks_toolbox.png) - **Structure view** - shows a structure of your dashboard, including its division into zones and the blocks that they contain. ![Structure view](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_structure_view_toolbox.png) ### Choose layout For a new dashboard you can choose layout which defines the available zones and helps to organize the dashboard view. Applying a layout divides the dashboard into the defined zones. The zones are placeholders for blocks. To do it, click the **Switch layout** icon on the left side of the upper toolbar, then choose one from available layouts, and click **Submit**. ![Switch layout](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_switch_layout_window.png) ### Add blocks In Dashboard Builder, you can access the **Dashboard blocks** toolbox, which includes a set of blocks of content that you can add to the zones of the dashboard. > **Tip: Tip** > > For a list of available blocks and their detailed description, see [Dashboard block reference](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/index.md). Add a block by dragging it from the menu to an empty place on a zone. Don't worry about placing blocks in the proper place from the start. You can reorder them at any time by dragging and dropping them in the desired location. You can reorder blocks in a few ways: - drag and drop block in the desired location on a drop zone - use **Move up block** or **Move down block** option from the block toolbox - access the **Structure view** toolbox and use **Move up** or **Move down** option in the settings of the block When you add a new block to the drop zone, drop it in the blue highlighted area. Before you drop it, a bold line appears - it helps you see the position of the newly added block in relation to other, already added blocks. ![Drop zone line](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_blue_line.png) When you add a block by dragging it from **Dashboard blocks** toolbox into the drop zone, the block settings panel open immediately where you can configure all block properties. ![Block properties](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_block_properties.png) This is a default behavior. You can globally turn off automatic opening of the block settings panel in the user settings. First, access your user settings on the right side of the top bar: ![User settings](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/user_settings_builder.png "User settings") Then, go to **Preferences** tab, **Content authoring** section, and click **Edit**. Here, you can find **Automatically open block settings in builder** setting, which is enabled by default. To change this behavior, click on the arrow to see drop-down list and select `Disabled` option. ![Blocks settings](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/user_settings_blocks_builder.png "User settings - blocks settings") ### Work with blocks Each block has its special properties. You can access them by placing the cursor on a block in the drop zone and clicking the **Block settings** icon. ![Block settings - Dashboard Builder](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/block_settings_builder.png "Block settings - Dashboard Builder") Settings available for blocks are divided into two tabs: **Properties** and **Design**. The settings available on the **Properties** tab depend on to the block's content. For a description of these settings, see [Dashboard block reference](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/index.md). To save changes, click **Save and close**. You can also work with the block, for example, duplicate it, change its position, or delete it. When you hover over the block, the drop zone toolbar appears. Click the three dots icon to see more options. The following actions are available: - Move up block - allows you to change position of the block by moving it up - Move down block - allows you to change position of the block by moving it down - Block settings - allows you to access properties window - Duplicate - duplicates existing block with its settings - Refresh - refreshes preview of the block - Delete - deletes existing block ![Dashboard block settings](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/dashboard_block_actions.png "Dashboard block settings") ## Edit dashboard At any time you can edit an active customized dashboard. To do it, click the three dots icon in the top right corner, and then click **Edit...**. ![Edit dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/edit_active_dashboard.png "Edit dashboard") This action opens the Dashboard Builder that allows you to edit an active customized dashboard and publish its updated version. All the changes that you make are visible after you save them and go back to the dashboard. ## Save dashboard There are several options for saving work in the Dashboard Builder: | Option | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------------ | | Publish | [Publish](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/publish_content/index.md) the dashboard draft. | | Save draft | Save the dashboard draft. | | Delete draft | Delete the dashboard draft. | ## Select active dashboard When you create a new customized dashboard, you can choose, which dashboard is set as an active. To do it, access your user settings on the right side of the top bar. Then, go to **Preferences** tab, **Dashboard** section, and click **Edit**. Select the dashboard to be set as active, and click **Save**. ![Select active dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/select_active_dashboard.png "Select active dashboard") You can also select active dashboard and switch between default and customized dashboard in the main dashboard view. Click the three dots menu and use the **Switch to...** action. ![Switch between dashboards](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/switch_dashboard.png "Switch between dashboards") # Dashboard block reference Pick from a list of dynamic blocks to create a customized dashboard. The following blocks are provided with a clean installation of Ibexa DXP: | Block | Description | | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | [Common content](#common-content-block) | Displays a list of content items created by all members of the organization that the user belongs to. | | [Ibexa News](#ibexa-news-block) | Displays a list of recent blog posts or articles published at [ibexa.co blog](https://www.ibexa.co/blog) (product related). | | [My content](#my-content-block) | Displays a list of content items created by the user who is currently logged in. | | [Orders by status](#orders-by-status-block) | Displays a chart presenting orders and their status. | | [Products by category](#products-by-category-block) | Displays a chart presenting products by their category. | | [Products with lowest stock](#products-by-category-block) | Displays a table presenting products with the lowest stock. | | [Quick actions](#quick-actions-block) | Displays selected mostly used actions and shortcuts. | | [Recent activity](#recent-activity-block) | Displays a list of recent activity of all or selected users. | | [Recent orders](#recent-orders-block) | Displays a table presenting recent orders and their status. | | [Review queue](#review-queue-block) | Displays a list of content items which user or user group can review. | | [Top 10 clicked items](#top-10-clicked-items-block) | Displays a table presenting top 10 clicked items. | > **Note: Note** > > Before you add a block that involves products, product types, or product categories, make sure your that your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md) has the `Product/View` and `Product type/View` permission. ## Common content block Displays a list of content items created by all members of the organization that the user belongs to. It shows the following tabs: **Content**, **Scheduled**, **Media**. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. On the **Design** tab, in the **View** field, select the layout to be used to present a list of content and submit your changes. ## Ibexa News block (Experience, Commerce) Presents a list of recent blog posts or articles published at `ibexa.co` blog (product related). It includes title, image, publication date, and link to article details. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Number of news** - Set a maximum number of news to be displayed. Default = 7, minimum value = 1, and maximum = 10. On the **Design** tab, in the **View** field, select the layout to be used to present a list of news and submit your changes. ## My content block Displays a list of content items created by the user who is currently logged in. It shows the following tabs: **Drafts**, **My shared drafts**, **Drafts shared with me**, **Scheduled**, **Content**, **Media**, **Drafts to review**. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. On the **Design** tab, in the **View** field, select the layout to be used to present a list of content and submit your changes. ## Orders by status block (Commerce) Displays a chart presenting orders split by status, with their number and percentage. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Statuses** - Set the statuses of orders that should be included in the list. Default value = All. The list of statuses depends on configured [order workflow](https://doc.ibexa.co/en/latest/commerce/order_management/configure_order_management/) and can be customized. - **Time period** - Set the time period: All time, Last day, Last week, Last month. Default value = Last month. On the **Design** tab, in the **View** field, select the layout to be used to present a list of orders and submit your changes. ## Products by category block (Experience, Commerce) Displays a chart presenting the products split by category, together with the percentage. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Number of categories** - Set a maximum number of categories to be displayed. Default value = 10. - **Show uncategorized products** - If selected, displays uncategorized products in the chart. On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. This block is not supported when using [Quable](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md) as the source of product information. ## Products with lowest stock block (Experience, Commerce) Displays a table of products with the lowest stock. Products are sorted based on Stock value (sorted from lowest to highest stock). The table contains the following columns: Name, Image, Code, Category, Type, Variant, Stock. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Number of visible products** - Set a number of products to be displayed. Default value = 10, minimum value = 1, and maximum = 10. - **Stock threshold** - Set up the maximum stock value (only products with stock number greater than zero and less than the set maximum number are displayed). Default value = 10. On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. This block is not supported when using [Quable](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md) as the source of product information. ## Quick actions block (Experience, Commerce) Displays selected mostly used actions and shortcuts, for example, **Create content**. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Actions** - Select actions to be displayed as shortucts: Create content, Create form, Create product, Create catalog, Create company. Default value = All. On the **Design** tab, in the **View** field, select the layout to be used to present a list of quick actions and submit your changes. ## Recent activity block (Experience, Commerce) Displays a list of recent activity of all or selected users. It also includes a link to view all activities available in Admin tab. Recent activity block contains the following data: - action time - user reference (avatar, first and last name) with a link to the user profile (if available) - activity type with the context On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Users** - Select users whose recent actions should be visible. By default, activities of all users are configured. - **Activity area** - Choose an activity area to be displayed. Default value = All. - **Number of activities** - Set a maximum number of activity logs to be displayed. Minimum value = 1, and maximum = 10. On the **Design** tab, in the **View** field, select the layout to be used to present a list of content items for review and submit your changes. ## Recent orders block (Commerce) Displays a table presenting recent orders with the newest creation date/recently placed. Table contains following columns: Order ID, Company name, Customer name, Unique items, Total value, Status, Created. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Statuses** - Set the statuses of orders that should be included in the list: Pending, Processing, Cancelled, Completed. Default value = All. - **Number of orders** - Set a maximum number of orders to be displayed. Default value = 10. On the **Design** tab, in the **View** field, select the layout to be used to present a list of orders and submit your changes. ## Review queue block Displays a list of content items which user or user group can review. On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. On the **Design** tab, in the **View** field, select the layout to be used to present a list of content items for review and submit your changes. ## Top 10 clicked items block (Experience, Commerce) Requires [Ibexa Personalization](https://doc.ibexa.co/projects/userguide/en/latest/personalization/personalization/index.md) enabled. Displays a table presenting top 10 clicked items. Table contains following columns: Item clicked (including item name), Item type, Recommended (presenting number of recommendations of selected item), Clicked (presenting total number of clicks on selected item). On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Customer ID** - Select customer ID whose top 10 clicks are displayed. On the **Design** tab, in the **View** field, select the layout to be used to present a list of content items for review and submit your changes. # Content tree Learn about the content tree. Content tree is the place where you can navigate through all the content items in your application. If you want to browse your application's content items, in the main menu, go to the **Content** -> **Content structure**. The **Content tree** area is an expandable content menu of your website. ![Content tree in the menu](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/left_menu_tree.png "Content tree in the menu") The same tree structure is used in other areas of the Content menu, such as **Media** or **Forms**. Unique icons for each content type instantly show you what type of content you are selecting. To add custom icons to your content tree, follow the [configuration tutorial in developer documentation](https://doc.ibexa.co/en/5.0/administration/back_office/back_office_elements/custom_icons/#customize-content-type-icons). For more information about custom configuration, go to [Content tree](https://doc.ibexa.co/en/5.0/administration/back_office/content_tree/) in developer documentation. Within the content tree, hidden content is greyed out in the tree view. To simplify the content tree, big lists are collapsed and include a **Show more** icon. Click it to expand the branches of the tree. **Collapse all** option, which is available in the context menu, closes all expanded sections. ### Add folders You can organize the tree by creating additional folders and subfolders of the **Content structure**. A similar procedure applies to other areas of the system where the tree hierarchy is used. 1. Go to **Content** -> **Content structure**. 2. In the upper-right corner click **Create content**. 3. From the available content types, select **Folder**, and click **Create**. 4. Enter name for the new folder. 5. (Optional) Add folder description. 6. Click **Publish**. The newly created folder is now visible in the content tree. # Notifications Get to know about notifications. With real-time notifications you stay informed and can take appropriate actions immediately. Notifications inform you about incoming assignments or requests, for example, when: - another user invites you to preview their work - when items are assigned for [your review](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/#review-queue) - when another user requests that you [release a lock](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/work_with_versions/#release-locked-drafts) - when items are [sent to trash](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/copy_move_hide_content/#remove-content) ## Access notifications At the top of the main screen you can see a top bar. The top bar contains a notification icon. When you receive a new notification, a badge appears on the notification icon, with a number of notifications that require your attention, and a message appears on the screen to notify you of new notifications. ![New notification message](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/new_notification_message.png "New notification message") If you have already received notifications and didn't act on then, a number of notifications on the badge increases when you receive another one. ![Notification icon on the top bar](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/top_bar_with_notification_icon.png "Notification icon on the top bar") Click the notification icon to view a short list with the most recent notifications, arranged from newest to oldest. Here, you can click certain notifications in the short list to act on them, according to their originator's request. You can click the three dots icon on the right side of each individual notification and mark it as read or delete it. You can also click **Mark all as read** to mark all notifications as read. ![Short list of notifications](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/notifications_short_list.png "Short list of notifications") > **Note: Informative notifications** > > Some notifications are informative only, and do not require your action. An example could be an information that scheduled publication of a content item has been cancelled. ## View all notifications in Notifications screen The short list holds a limited number of notifications. You can see all the notifications that you have received in the **Notifications** screen. 1. In the top bar, click a notification icon. Then, at the bottom of the short list, click **View all notifications...**. Here, you can see a list of notifications, together with information about their status and arrival date and time. ![Notifications screen](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/notifications_screen.png "Notifications screen") > **Note: List pagination** > > The list can take more than one screen. If it is so, you can click the arrows and numbers at the bottom of the screen to navigate the list. 2. Narrow down the list of displayed notifications by selecting one or more of the following filters: - **Notification type**: for example, content item review request - **Status**: unread or read - **Date and time**: start and end of date range within which the notification was received ![Notification filters](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/notifications_filters.png "Notification filters") 3. Click **Apply** to confirm your choices. 4. To clear all the filters, click **Clear filters**. ### Act on notifications In the notification screen, you can act on the notification to fulfill the request of the originator. To act on a notification, find it in the notifications list and click an icon next to the notification's date and time. Depending on the context, the icon can be called differently, for example, **Go to content** or **Accept request**. ### Delete notifications or change their status You may want to change the status of multiple or individual notifications in the **Notifications** screen, or even delete them completely. 1. Use filters to find the notifications that you want to delete or change their status. 2. To toggle the status of an individual notification, find it in the notifications list and, in its line, next to the notifications date and time, click an envelope icon. 3. To delete multiple notifications at once or mark them as read, in the **Notifications** screen: - select checkboxes next to notifications that you want to process - at the top of the list, click **Mark as read** or **Delete**. ![Bulk action buttons](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/img/notifications_bulk_action_buttons.png "Bulk action buttons") # Content model management # Content model The Ibexa DXP content model relies on content items that are based on predefined content types. At the heart of Ibexa DXP is a repository that stores all content. In Ibexa DXP everything is a content item — not just the actual pages displayed in the website, but also all media (for example, images or videos) and user accounts. Ibexa DXP lets you customize and adapt the content model depending on your needs and the type of website you create. Depending on your organization, if you are an editor or a content creator, it's possible that the content model for your installation has already been created by your administrator or content manager. However, even a non-technical user can create or modify the content model through the editing interface. ## Content types A **content type** is comparable to a pattern or a template on which you base [content items](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_items/index.md). Whenever you create a new content item, you must choose its content type. The content type defines what fields are available in the content item. A content item may only contain the fields that are defined in the content type. Ibexa DXP allows you to create, edit, and delete content types and their fields. A clean installation contains a few basic content types. ## Content items versus content types A [content item](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_items/index.md) is an instance of a particular content type, in other words, a single object created based on a content type template. When a content item is created, it inherits the fields from its content type. However, the values of the fields (their "contents") are empty, and you need to fill them separately for each content item. The fields in a content type are only definitions. This means that they describe what fields of what kinds are present in a content item, but as a rule they do not provide these fields' values. As a consequence, all content items of the same content type share the same set of fields, but their field values are different. For example, you need to store book information. You create a new content type called "Book" and add to it fields, for example, Title, Author, Genre, or ISBN. Next, based on this content type, you can create any number of content items. You can then fill the empty fields with the information about each specific book: ![Content model diagram](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/content_model_diagram.png "Content model diagram") ## Fields and field types A field type defines what kind of data is stored in a field. For example, a field with a *TextLine* field type stores a single line of text, an *Image* field type stores an image file, and *Author* field type holds information about author details (like name and email). By default, the system comes with a large set of field types that cover the most common needs, for example, *Text line*, *Rich text*, *Email*, *Author list*, *Content relation*, *Map location*, or *Float*. ## Content model in summary **Content types:** - A content type defines fields that a content item is composed of. - Every field is modeled after a field type which defines the kind of data it contains. **Content items:** - A content item consists of a number of fields. - Every content item is based on a content type. **Fields and field types:** - Ibexa DXP comes with a collection of essential field types. - It's possible to extend the system by creating custom field types for special needs. > **Note: More information** > > For detailed information about the content model, see [Developer Documentation](https://doc.ibexa.co/en/5.0/content_management/content_model/#content-information). # Create and edit content types Create or edit content types by listing fields that make a content item. [Content types](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_model/#content-types) define what fields are available in [content items](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_items/index.md). To suit your specific needs, you can modify the default content types, or add custom ones. You can only create or modify content types when your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `ContentType/Create` or `ContentType/Update` permission. When you edit a content type, each content item based on this content type changes. For example, when you add or remove a field to the content type, the change is propagated to every content item of this type. > **Note: Note** > > Rules and templates for displaying content on the website are determined at the developer level. That is why content of a new content type that you create may not always display correctly or may cause errors. It's always best to discuss adding new content types with the administrator of your website, to make sure whether they need to add it to the configuration. > **Caution: Deleting content types** > > You can delete a content type only when there are no content items that belong to it. This also includes content items in the Trash. 1. In the left panel, go to **Content** -> **Content types**. Then select a content type group by clicking its name, for example, **Content**. > **Note: Note** > > If your application requires a more granular organization of content types, in this screen, you can create additional content type groups. ![Content type list](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/content_types.png "A list of content types") 2. If you're adding a new content type, on the content type group's detail screen, click **Create** and skip to step 4. 3. If you're modifying an existing content type, on the content type group's detail screen, click the **Edit** icon next to a name of the content type. ![Create or edit content type](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/create_edit_content_type.png "Create or edit content type") 4. In the **Global properties** area, fill in global content type properties. ![Editing a content type](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/content_type_general_properties.png "Editing a content type") Each content type has the following global properties: | Setting | Description | Use | | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | Name | A name of the content type. | Required | | Identifier | A unique identifier of the content type in the system. Up to 50 characters and can only consist of letters, numbers and underscores. | Required | | Description | Additional information that is displayed when a content item is created based on this type. | Optional | | Content name pattern | Rules for creating a name for the content item. | Optional | | URL alias name pattern | Rules for creating the URL alias for a content item. | Optional | | Container | When checked, content of this type can serve as a container in the content tree. | Optional | | Sort children by default by | Criterion by which children of this content are sorted in the tree. | Required if **Container** is checked | | Sort children by default in order | Order in which the children are sorted (ascending or descending). | Required if **Container** is checked | | Make content available even with missing translations | When checked, content of this Type is by default always available, even if it does not have a language version corresponding to the current SiteAccess. | Optional | > **Note: Rules for creating patterns** > > When populating the patterns, you can use a schema with attributes which correspond to the identifiers of fields that make up the content type. This way, when content items of this type are created, their names and URL aliases are generated according to the defined pattern. > > For example, if you enter `` as a value of the **Content name pattern** field, the resulting items are identified in the user interface by their short titles. 5. In the **Field definitions** area, [add or modify fields that constitute the content type](https://doc.ibexa.co/projects/userguide/en/latest/content_management/configure_ct_field_settings/index.md). 6. Optionally, [enable and configure SEO for the content type](https://doc.ibexa.co/projects/userguide/en/latest/search_engine_optimization/work_with_seo/index.md). 7. To save your changes: - Click **Save** and continue editing. - Click **Save and close** to close the window. 8. To discard your changes and close the window: - If you're creating a new content type, click **Discard**. - If you're updating an existing content type, click **Delete draft**. Once the content type details screen is displayed, you can navigate back to the content type list. > **Note: More information** > > For in-depth information about the content model, see [Developer Documentation](https://doc.ibexa.co/en/5.0/content_management/content_model/). # Configure content type fields Configure field settings in content types. When you work with a [content type](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_model/#content-types) to add or modify [fields](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_model/#fields-and-field-types), you must configure different settings that control the way Ibexa DXP treats the contents of each field. Apart from general settings, certain field types, for example, [landing page](#default-configuration-of-pages) and [content relation](#content-relation-settings) field types may have additional settings. You can only create or modify content types when your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `ContentType/Create` or `ContentType/Update` permission. 1. [Create or open a content type](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_types/index.md) for editing. 2. In the **Field definitions** area, find a section, for example, **Content**. 3. If your application requires a more granular organization of fields within a content type, click **+ Add** to add more sections. When you add a **Metadata** section, it's later presented as an additional tab in [content item](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_items/index.md) editing screen. You can use it, for example, for tags or product categories. When you add other sections, they're later presented as anchors in content item editing screen. All sections are later presented as headers on the content item details screen, the **View** tab. 4. Add, reorder or remove fields as required: - To add a field, from the **Field types** area, drag the required field tile to the section on the left. - To reorder fields, drag and drop them within the section or between sections on the left. - To remove fields from the section completely, click the **X** icon in the field's header. ![Adding a field](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/add_field.png "Adding a field") 5. Expand the header of a field that you want to modify, then [change its settings](#general-settings). 6. To save your changes: - Click **Save** and continue editing. - Click **Save and close** to close the window. 7. To discard your changes and close the window: - If you're creating a new content type, click **Discard**. - If you're updating an existing content type, click **Delete draft**. ## General settings Depending on their type, fields can have different combinations of the following general settings. | Setting | Description | Use | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | Name | A user-friendly name that describes the field, used in the interface. It can be up to 255 characters long and consist of letters, digits, spaces, and special characters. | Required | | Identifier | An identifier for system use in configuration files, templates, or PHP code. It can be up to 50 characters long and can only contain lowercase letters, digits and underscores. Also used in name patterns for the content type. | Required | | Description | A detailed description of the field. It's displayed next to it when the user edits the content item. | Optional | | Required | Indicates whether a value of the field is required for the content item to be saved or published. | Optional | | Searchable | Indicates whether a value of the field is included in the search. | Optional | | Translatable | Indicates whether a value of the field can be translated. | Optional | | Can be a thumbnail | Indicates whether the field can be a thumbnail. | Optional | ## Default configuration of pages The following settings control the behavior of content items of [page](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_pages/index.md) type. You modify them in the **Field definitions** section, the **Landing page** field. ### Block display You can define which page blocks are available to an editor in the page edit mode. You do it, for example, when a [developer creates a new block](https://doc.ibexa.co/en/5.0/content_management/pages/create_custom_page_block/) and you want to allow adding it to the page. Expand the **Select blocks** section and select page blocks that you want to be included in the page. ![Page blocks](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/select_page_blocks.png "Select page blocks") Now, only selected page blocks are available in the edit mode. ![Page blocks menu](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_blocks_toolbar_selected_blocks.png "Page blocks menu") > **Caution: Caution** > > When you deselect blocks, any related blocks that are included in the page hide as well. To publish the page, the editor has to remove these blocks from the page, too. ### Available page layouts You can decide which page layouts are available for an editor. Expand the **Select layouts** section, and define which layouts are available for this page. ![Layouts](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/select_layouts.png "Layouts") If you deselect a layout that is currently used on a page, the editor has to change the layout to be able to edit the page. ### Preferred editing mode You can set the editing mode that is launched when an editor starts editing the page. To do it, in the **Select Editor launch mode** section, select one of the available options. ![Editor launch mode](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/select_editor_mode.png "Select Editor launch mode") ## Content relation settings When you add or modify a **[Content relation](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#relation_field)** or **Content relation (multiple)** field in a content type, you can decide: - which content tree location opens in the [content browser](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#content-browser) when the user browses to a related content item - whether relations can be to content items of a specific type only, or any content type #### Relation starting location In the **Select starting Location** area, select from the available options: - **Default** - the starting location is automatically assigned to the default location in the tree of a created content item. - **Browse** - use to manually select the location from the content browser. - **Content location** - the starting location is the location of the content item that is edited by the user. For example, if the user edits the content item with the location `50`, it sets the starting location to this value with children under this location. - **Root default location** - use if you want the content browser to start at the defined location with only children available for selection. ![Select starting location](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/select_start_location.png "Selecting a starting location") #### Allowed content types In the **Allowed content types** area, expand the drop-down list and select from the available content types. No selection means that relations to all content types are allowed. # Content management # Content management Content management enables you to create, edit, and manage content items and content types. It also includes content translation and publication scheduling. Content management enables you to create, edit, and manage content items and content types. It also involves content translation and publication scheduling. ## Create and edit content - [Content items](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_items/): Content items are containers that Ibexa DXP uses to store content data. - [Create and edit content items](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/create_edit_content_items/): Create content for your website with different fields, rich text, tags, and then publish it. - [Create and edit pages](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/create_edit_pages/): Create multi-zone Pages with dynamic blocks. Use them as landing pages. - [Block reference](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/block_reference/): Pick from a list of dynamic page blocks to create landing pages. - [Preview content items](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/preview_content_items/): Preview content items of various types in many places of the back office. - [Work with forms](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/work_with_forms/): Use surveys, questionnaires, sign-up forms and other interactive forms to enrich your website. - [Translate content](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/translate_content/): Create multiple language versions of content items. ## Organize content and manage workflow - [Taxonomy](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/taxonomy/taxonomy/): Taxonomy is one of the ways classify content items with structured tags. - [Work with tags](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/taxonomy/work_with_tags/): Taxonomy is one of the ways classify content items with structured tags. - [Content versions](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_versions/): Learn about content item versions and the Autosave feature. - [Work with versions](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/workflow_management/work_with_versions/): Perform various tasks on content item versions, as part of editorial workflow or when comparing edits from different users. - [Editorial workflow](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/workflow_management/editorial_workflow/): Learn about editorial workflows that organize review flows for different content needs. - [View workflow list](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/workflow_management/view_workflow_list/): Review a list of workflows that are available in the installation. - [Copy, move or hide content](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_organization/copy_move_hide_content/): Copy, move, remove, or hide content item, either individually or in bulk. - [Classify content](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_organization/classify_content/): Use sections, bookmarks, or segments to classify the content of your website. - [Manage content locations and URL addresses](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_organization/manage_locations_urls/): Manage the content of your website by controlling locations and URLs. # Content items Content items are containers that Ibexa DXP uses to store content data. A content item is a single piece of content: an article, a blog post, an image, or a product. Each content item has general characteristics, such as name and identifier. It also contains [fields](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_model/#fields-and-field-types). These fields can differ depending on what kind of content you're dealing with. An *article* content item may consist of fields, for example, *title*, *name*, *author*, *body*, *image*, or *subscriber teaser*. A *product* content item may have, for example, *product name*, *category*, *price*, *size*, or *color*, as fields. In Ibexa DXP, you create content items based on templated called [content types](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_model/#content-types). ## Access content in the UI In the back office, you can view the content in your repository in several places, for example: - [Content structure](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#content-tree) - [Content browser](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#content-browser) - [User list](https://doc.ibexa.co/projects/userguide/en/latest/user_management/manage_users/index.md) - [Products list](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/manage_products/index.md) # Create and edit content items Create content for your website with different fields, rich text, tags, and then publish it. ## Create content items 1. Start creating a new content item in one of the following ways: - In the left panel, go to **Content** -> **Content structure**. Then select a parent content item and click **Create content**. The new content item becomes a child of the content item that you originally selected. - In the **Quick actions** block of the [Dashboard](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#dashboard) screen, click **Create content**. Then choose a location for the new item in [content browser](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#content-browser) and click **Create**. > **Tip: Tip** > > An alternative way of creating content items is to [drag one or more files](#upload-multiple-content-items) onto the **Sub-items** tab when viewing any content item in a [content tree](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#content-tree). 2. In a slide-out pane, make initial choices in the following fields, and click **Create**: - **Select a language** - from a drop-down list, select the base language for the content item. - **Select a content type** - use this field to narrow down the list of choices displayed below. Then select a content type to serve as a template for the content item. > **Note: Note** > > If you're using Ibexa Experience or Ibexa Commerce, the options include forms and pages. You then [build forms](https://doc.ibexa.co/projects/userguide/en/latest/content_management/work_with_forms/index.md) and [create pages](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_pages/index.md) in their respective specialist tools. 3. [Fill in the fields](#edit-new-or-existing-content-items) of the content item. 4. Click **Preview** to see how the content item could look to an end-user. > **Tip: Tip** > > A content item can look different on different [SiteAccesses](https://doc.ibexa.co/projects/userguide/en/latest/content_management/translate_content/#siteaccess). You can select a SiteAccess to preview with a drop-down in the preview screen. 5. To discard your changes and close the window, click **Delete draft**. 6. To save your changes: - Click **Save** to continue editing. - Click **Save and close** to close the window. 7. To send your changes to another editor [for review](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/index.md), click **Send to review**. 8. When the content item is ready for publication: - Click **Publish** to publish it immediately. - Click **Publish later** to set a specific publication date. For more information, see [Publish content](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/publish_content/index.md). > **Note: Versioning and autosave** > > Whenever you edit a content item, a [new version](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/index.md) is created in the repository. > > To help you preserve your work, Ibexa DXP saves drafts of content items automatically. For more information, see [Autosave](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/#autosave). ##### Upload multiple content items When you view the content item details in the content tree, you can upload files such as images, videos, or PDF documents. This way you can add multiple sub-items without editing the original content item. To do it, on the content item details screen, in the **Sub-items** tab, click **Upload** and choose all items that you want to upload. When a file is uploaded with multi-file upload, it's automatically stored in a field of the content item. > **Note: Note** > > The content type for the uploaded files is selected automatically by the system. ![Multi-file upload](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/multi_file_upload.png) ## Edit new or existing content items Each content item is based on a [content type](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_types/index.md). The content type defines what fields you have to fill in when creating a new item. It may also determine the layout or style in which this item is displayed. Fields marked with an asterisk (\*) are required. You can't save the content item without filling them in. Some fields, such as *Relation* field (which links two content items) or *Image* field, require you to select a different content item to link to. A *Location* field is a point on the map. You can type the place name, enter its coordinates, or select it on the map. > **Note: Note** > > When you create or edit a content item that contains an *Image* or an *Image asset* field, you can perform basic image editing functions in an [Image Editor](https://doc.ibexa.co/projects/userguide/en/latest/image_management/edit_images/index.md). ### Edit Rich Text fields To fill in Rich Text fields you use an online editor. Its options appear when you click inside the field box. ![Online editor menu](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/online_editor_menu.png "Online editor menu") You can choose from available options to edit and customize Rich Text field, for example, move up or down its elements, select heading style, add text elements, like superscript, block quote, or anchor. You can also add new elements to the field. To do it, choose one of the available elements: - Unordered list - Ordered list - Table - Embed - Embed product - Image - YouTube - X - Facebook ![Available Rich Text block elements](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/rich_text_block_elements.png "Available Rich Text block elements") Each of these elements can have its own settings, such as text formatting. The option bar also lets you reorder or remove any elements in the Rich Text field. #### Collaborative editing Rich Text fields allow multiple users to edit the content simultaneously thanks to the [Collaborative editing feature](https://doc.ibexa.co/projects/userguide/en/latest/content_management/collaborative_editing/index.md). When creating a new content item, the owner can invite other users, both internal and external, to collaborate on the content. Invited users can either edit the Rich Text fields or only preview the content (for example, for review purposes), depending on the access permissions granted. #### Edit embedded content items You can edit embedded content items without leaving current window. To do it, first insert selected content item in the Rich Text field. Then, click the three dots icon on the right side and click **Edit**. ![Edit embedded content item](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/edit_embedded_item_richtext.png "Edit embedded content item") If the content item has more than one translation available, you need to select the language. ![Edit embedded content item - select language](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/edit_embedded_item_language_richtext.png "Edit embedded content item - select language") This action opens a new browser tab with an editing screen of the selected content item. When you finish editing the item, click **Publish**. To see implemented changes refresh the browser page. This option is also available when you want to set up a [relation](https://doc.ibexa.co/projects/userguide/en/latest/content_management/configure_ct_field_settings/#content-relation-settings) with another content item. ![Edit embedded content item - set up a relation](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/edit_embedded_items_relation.png "Edit embedded content item - set up a relation") #### Embed products You can embed [products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) from the product catalog directly inside a Rich Text field. Use this feature when building landing pages or articles that reference specific products, for example, a blog post that highlights a new product launch. Two embed styles are available: - **Embed** embeds a product as a standalone element between paragraphs. - **Inline embed** embeds a product within a sentence or paragraph. #### Distraction free mode Distraction free mode expands the workspace to full screen and shows only editor toolbar. It's helpful when you need to work with longer texts that take more space and when you want to focus your attention on editing text. ![Distraction free mode](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/distraction_free_mode.png "Distraction free mode") To access distraction free mode, click **Distraction free mode** on the right side above the workspace. ![Access distraction free mode](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/access_distraction_free_mode.png "Access distraction free mode") To exit distraction free mode, click **Exit distraction free mode** or press Esc on the keyboard. ![Exit distraction mode](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/exit_distraction_free_mode.png "Exit distraction free mode") #### Anchors For longer texts, insert an anchor linking a fragment of text with another fragment or section to quickly jump through sections of an article. To create an anchor: 1. Click in the area to link to and select the anchor icon from the editor menu. 2. In the modal window, provide the name for the anchor. 3. Scroll to the fragment where you want to insert the link, and select the text to appear as a link. 4. In the modal window, click the **Link** button. This opens the window to create the link. 5. In the **Link to** box, enter the anchor name, and click **Save**. #### Images In image options you can select an image variation. Variations can include different sizing options and other filters that are applied to images. Available image variations must be configured at the developer level. See [Images](https://doc.ibexa.co/en/5.0/content_management/images/images/) for a technical guide on how to do this. #### Tables ![Table options in online editor](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/online_editor_table.png) In table options you can define the first row and/or column as headers, add or delete rows and columns in any part of the table, and also merge or split cells. #### Custom elements Your installation can also have custom elements available in the Rich Text field. Contact your website administrator about the details of using them. ### AI Assistant If [AI Actions](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/ai_actions/index.md) have been configured in your application, when writing content, the **Improve text** button is visible in the online editor's toolbox. If you have the required [permissions](https://doc.ibexa.co/en/5.0/permissions/policies/#ai-actions), you can request that the AI Assistant refines your text by using one of the defined actions. For example, you can highlight a passage and instruct the AI Assistant to extend the passage or adjust its tone to suit your needs. The **Go to AI actions** button can also visible to users with access to the **Admin UI**. By clicking it, you can quickly navigate to [AI actions configuration](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/index.md). ![Improve text button and AI actions](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_assistant_online_editor.png) The AI Assistant is also available when working with Text Line and Text Block fields, allowing you to use AI on the contents of these fields. ![Ai Assistant visible in Text Line field](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_assistant_textline.png) After you select an action, the AI Assistant modal appears, where you can observe the results of AI service's work. When response is displayed on the screen, depending on whether you are satisfied with the result, you can select one of the options: - **Replace** - replaces the source text with the output - **Insert below** - inserts the output text directly after the source passage (available only in the online editor) - **Try again** - makes another attempt at generating the output ![AI Assistant](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_assistant.png) > **Note: Lengthy processing of complex requests** > > Depending on the length of the source text and the complexity of request, processing may take a while. You may cancel the processing if it takes too long by clicking **Stop**. ### SeenThis! streaming > **Note: Note** > > This custom tag is in an opt-in bundle, to use it, install `ibexa/connector-seenthis` bundle first. Use SeenThis! tag to enable displaying of video with maximum quality regardless of connection and server integration. For more information, see [SeenThis! page block](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/#seenthis-block) documentation. ### Text formatting When you select a section of text, you get access to text formatting options such as bold or underline. Here you can also add a link to the text. You can link to an external website, or to another content item. When linking to content, you can select a [SiteAccess](https://doc.ibexa.co/projects/userguide/en/latest/content_management/translate_content/#siteaccess) from the drop-down to enable cross-website linking. This allows the link to work across different websites in a [multisite](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/multisite/index.md) setup. ![Selecting SiteAccess for cross-website linking](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/online_editor_link_siteaccess_picker.png "Selecting SiteAccess for cross-website linking") ### Add taxonomy entries To keep your content organized and searchable, you can add taxonomy entries to a content item while creating or editing it. For this feature to work as described, the content type must have a **Metadata** section, with a **Taxonomy Entry** field in it. 1. Switch to the **Meta** tab. 2. Click the **Select path** button. 3. In the pop-up window, select the tags you want to add. ![Selecting Taxonomy entries](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/taxonomy_select_taxonomy_entries.png "Selecting Taxonomy entries") > **Note: Taxonomy suggestions** > > If the [Taxonomy suggestions](https://doc.ibexa.co/en/5.0/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, instead of manually browsing the taxonomy tree and selecting tags one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant. > > ![Taxonomy entries suggested by the AI Assistant](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/taxonomy_suggestions_content.png "Taxonomy entries suggested by the AI Assistant") For more information, see [Assign tag to content from taxonomy tree](https://doc.ibexa.co/projects/userguide/en/latest/content_management/taxonomy/work_with_tags/#add-taxonomy-entry-assignment-field-to-content-type). # Create and edit pages Create multi-zone Pages with dynamic blocks. Use them as landing pages. Editions: Experience Page is a special content type. You can modify pages with a visual drag-and-drop editor, the [Page Builder](#page-builder-interface). Pages are divided into drop zones into which you can drop various dynamic blocks. By editing pages, you can customize the layout and content of your website. Whenever you edit a page, a [new version](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/index.md) is created in the repository. > **Tip: Tip** > > The page content type contains a *Landing page* field type which manages the zones and blocks. Any content item that has the *Landing page* field type behaves like a page. ## Create page 1. In the left panel, go to **Content** -> **Content structure**. Then select a parent content item and click **Create content**. 2. In a slide-out pane, make initial choices in the following fields, and click **Create**: - **Select a language** - from a drop-down list, select the base language for the content item. - **Select a content type** - use this field to narrow down the list of content type choices displayed below. Then select one of page type, for example, **Landing page**, and click the **Create** button. 3. In the [Page Builder toolbar](#page-builder-interface) click **Fields** and define the page's title and description. 4. Click **Switch layout** and select the layout. 5. [Edit the page](#edit-page). 6. To discard your changes and close the window, click **Delete draft**. 7. To save your changes, click **Save draft**. You can now navigate away from the Page by clicking the **Close** button. 8. When the page is ready for publication: - Click **Publish** to publish it immediately. - Click **Publish later** to set a specific publication date. For more information, see [Publish content](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/publish_content/index.md). > **Note: Autosave** > > To help you preserve your work, Ibexa DXP saves drafts of content items automatically. For more information, see [Autosave](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/#autosave). ## Edit page To edit an existing page, in the back office, from the content tree, choose the page that you want to edit, and click the **Edit** button. ### Page Builder interface Page Builder has a plain and intuitive interface. You can create pages without having advanced technical skills. ![Page Builder interface](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_builder_interface.png) Page Builder user interface consists of: A. Drop zone B. Page blocks / Structure view toolbox C. Settings toolbar (including Fields, Visibility and Schedule settings) D. Device mode toolbar (including Desktop, Tablet and Mobile mode) E. Buttons The following table presents buttons and provides a short description of their function: | Button | Description | | ------------------- | --------------------------------------------------------------------------------------------------------------------------- | | Fields button | Edit main details of the page, like title and description. | | Switch layouts | Switch between page layouts. | | Preview segments | Access preview of the page for a given segment. | | Timeline button | Access the timeline to preview how the page changes with time. You can also view the list of all upcoming scheduled events. | | View toggler | Toggle through to see how the page is rendered on different devices. | | Page blocks toolbox | Move Page blocks / Structure view toolbox to the other side of the screen. | | Undo | Undo latest change. | | Redo | Redo latest change. | Page Builder has two main views that you can use while creating a page: - **Page blocks** toolbox - consists of all available elements that you can use by dragging them and dropping on a drop zone. ![Page blocks toolbox](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_blocks_toolbox.png) - **Structure view** toolbox - shows a structure of your page, including their division into zones and the blocks that they contain. ![Structure view toolbox](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/structure_view.png) ### Work with layout [Layout](https://doc.ibexa.co/projects/userguide/en/latest/content_management/configure_ct_field_settings/#available-page-layouts) divides the page into the defined zones. The zones are placeholders for the blocks. The page layouts that an editor has access to are up to you to choose. The default, built-in Page layout has only one zone, but developers can create other layouts in configuration. For more information, see [Configure layout](https://doc.ibexa.co/en/latest/templating/render_content/render_page/#configure-layout). While editing, you can switch layout for your page. To do it, click **Switch layouts** button. ### Add blocks In Page Builder you can access a toolbox of **Page blocks** — a set of blocks of content that you can add to the zones of the page. Each block is unique in its function and enables you to customize the content appearing on the page. Add a block by dragging it from the toolbox to an empty place on a zone. Do not worry about placing blocks in the proper place from the start. You can reorder blocks later, in a few ways: - drag and drop block in the desired location on a drop zone - hover over the block and use 'Move up' and 'Move down' function in the settings of the block - access **Structure view** toolbox and use 'Move up' and 'Move down' function in the settings of the block ![Structure view toolbox - reorder blocks](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/structure_view_move.png) When you add a new block to the drop zone, drop it in the blue highlighted area. Before you drop it, a bold line appears - it helps you see the position of the newly added block in relation to other, already added blocks. ![Drop zone line](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/drop_zone_line.png) When you add a block by dragging it from **Page blocks** toolbox into the drop zone, the block settings panel open immediately where you can configure all block properties. ![Block properties](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/block_properties.png) This is a default behavior. You can globally turn off automatic opening of the block settings panel in the user settings. First, access your user settings on the right side of the top bar: ![User settings](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/user_settings.png "User settings") Then, go to **My preferences** tab, **Edit** section. Here, you can find `Automatically open block settings in builder` setting, which, by default, is set up to `enabled` value. To change this behavior, click on **Edit** icon, find the setting, and change its value to `disabled`. ![User settings - blocks](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/user_settings_blocks.png "User settings - blocks settings") Ibexa DXP comes with a set of ready-to-use page blocks, but [developers can add their own](https://doc.ibexa.co/en/5.0/content_management/pages/create_custom_page_block/). For a list of blocks available out of the box, see [Block reference](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/index.md). > **Note: Note** > > Before you add a block that involves products, product types, or product categories, make sure your that your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md) has the `Product/View` and `Product type/View` permission. > > Before you add a block that uses results derived from a [Personalization](https://doc.ibexa.co/projects/userguide/en/latest/personalization/personalization/index.md) scenario, for example, [Dynamic targeting](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/#dynamic-targeting-block) or [Recently added block](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/#recently-added-block), make sure that the scenario is [properly configured](https://doc.ibexa.co/projects/userguide/en/latest/personalization/configure_scenarios/index.md). You can work with the block, for example, duplicate it, change its position, or delete it. Hover over the block and the toolbar appears. Click the three dots icon to see more options. ![Block toolbar](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/block_settings_menu.png "Block toolbar") The following actions are available: - Move up block - allows you to change position of the block on the page by moving it up - Move down block - allows you to change position of the block on the page by moving it down - Block settings - allows you to access properties window - Copy - allows you to reuse a configured block across pages by using the Clipboard section. - Duplicate - duplicates existing block with its settings - Refresh - refreshes preview of the block - Delete - deletes existing block ![Block window - size adjustment](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/block_window_size_adjust.png "Block window - size adjustment") #### Copy blocks You can copy blocks to reuse them on other pages, or within the same one. When you copy a block, it gets saved in the "Clipboard" section of the Page Blocks toolbox. At this point you can continue working on the current page, or you can close it and open another one, where you want to reuse the block. You can drag and drop the block from clipboard to a drop zone, like any other block. Doing so puts an exact copy of the block on the page, with all its settings. The clipboard can store only one block at a time. Content of the clipboard is visible only to you, and preserves switching into a new session. ![The clipboard section containing a Code block](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_builder_page_blocks_clipboard.png "The clipboard section containing a Code block") #### Configure block settings Each kind of block has its special settings. You can access them by placing the cursor on the added block and clicking the **Block settings** icon. ![Block settings icon](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/block_settings_icon.png "Block settings icon") Settings available for blocks are divided into three tabs — **Basic**, **Design**, and **Scheduler**. The settings available on the **Basic** tab are tailored to the block's content. For a description of these settings, see [Block reference](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/index.md). The remaining tabs contain parameters common to all blocks provided with Ibexa DXP. Use them to modify the layout and visibility of a block. For more information, see [Scheduling publication](https://doc.ibexa.co/projects/userguide/en/latest/content_management/schedule_publishing/index.md). For your comfort, you can adjust the size of the block settings window. When you hover over the window frame, blue line appears. Click-and-drag the border to adjust the size. You cannot publish a page if you haven't set all the required settings of all blocks. > **Tip: Tip** > > Settings and function of custom-made blocks of content depend on their design. For details on adjusting and using them, contact your website administrator. After you change the block settings, click **Submit** to save the changes or **Discard** to cancel. #### Edit embedded items You can edit embedded content items without leaving Page Builder. To do it, first select content item that you want to insert in the block. Then, click the icon on the right side and click **Edit**. ![Edit embedded content item](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/edit_embedded_content_item.png "Edit embedded content item") This action opens a new tab in the browser with an editing screen of the selected content item. When you finish editing the item, click **Publish** and go back to Page Builder tab. All the content item details automatically update in the block window. If the content item has more than one translation available, you need to select the language. ![Edit embedded content item - select language](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/edit_item_select_language.png "Edit embedded content item - select language") This function is available for following blocks: - Banner - Collection - Content Scheduler - Embed - Gallery - Product collection - Targeting - Text ##### Distraction free mode While configuring blocks that include Rich Text section, for example, Text block, you can switch to distraction free mode. Distraction free mode expands the workspace to full screen and shows only editor toolbar. It's helpful when you need to work with longer texts that take more space and when you want to focus your attention on editing text. ![Distraction free mode](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/distraction_free_mode.png "Distraction free mode") To access distraction free mode, click **Distraction free mode** on the right side above the workspace. ![Access distraction free mode](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/access_distraction_free_mode_PB.png "Access distraction free mode") To exit distraction free mode, click **Exit distraction free mode** or press Esc on the keyboard. ![Exit distraction free mode](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/exit_distraction_free_mode.png "Exit distraction free mode") ## Save page There are several options for saving work on the page: | Option | Description | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | Close | Close the page without saving it. | | Send to review | Save the page and send it to review. | | Publish / Publish later | [Publish](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/publish_content/index.md) the page or schedule publishing for later. | | Save draft | Save the page draft\*. | | Delete draft | Delete the page draft. | - To help you preserve your work, system saves drafts of content items automatically. For more information, see [Autosave](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/#autosave). # Block reference Pick from a list of dynamic page blocks to create landing pages. Editions: Experience The following blocks are provided with a clean installation of Ibexa DXP: | Block | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [Banner](#banner-block) | Displays an image content item with a URL attached to it. | | [Bestsellers](#bestsellers-block) | Displays a list of products that were recently a bestseller. | | [Campaign](#campaign-block) | Displays a campaign selected from Ibexa Engage. | | [Catalog](#catalog-block) | Displays products from a specific catalog to a selected customer group. | | [Code](#code-block) | Enables you to place content on your page, for example, text, links, or images, using custom HTML. | | [Collection](#collection-block) | Displays a set of content items you select manually from the content structure. | | [Content List](#content-list-block) | Displays content items of a chosen content type (or types) that are contained in a selected folder. | | [Content Scheduler](https://doc.ibexa.co/projects/userguide/en/latest/content_management/schedule_publishing/#content-scheduler-block) | Displays content items at a pre-defined time. | | [Dynamic targeting](#dynamic-targeting-block) | Embeds recommended items based on the [Segment](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#segments) the user belongs to. | | [Embed](#embed-block) | Embeds a content item of any content type on the page. | | [Form](#form-block) | Embeds a Form content item that you select from the content structure. | | [Gallery](#gallery-block) | Displays all images contained in a selected folder. | | [Ibexa Connect](#ibexa-connect-block) | Retrieves and displays data from an Ibexa Connect webhook. | | [Last purchased](#last-purchased-block) | Displays a list of products that were recently purchased from the product catalog. | | [Last viewed](#last-viewed-block) | Displays a list of products from the product catalog that were recently viewed. | | [Orders](#orders-block) | Displays a list of orders associated with a particular company or individual customer. | | [Personalized](#personalized-block) | Displays a list of content items/products that are recommended to end users when specific scenarios are triggered. | | [Product collection](#product-collection-block) | Displays a list of specifically selected products. | | [Product embed](#product-embed) | Displays a specific product. | | [Recently added](#recently-added-block) | Displays a list of products that were recently added to the product catalog. | | [RSS](#rss-block) | Loads and displays news from RSS feeds (channels). | | [Sales representative](#sales-representative) | Loads and displays company's sales representative. | | [SeenThis!](#seenthis-block) | Displays video with exceeded standard video restrictions of 3.5MB. | | [Targeting](#targeting-block) | Embeds an content item based on the [segment](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#segments) the user belongs to. | | [Text](#text-block) | Enables you to add to the page a Rich Text block. | | [Video](#video-block) | Embeds a video into the page with standard playback controls. | - **Page blocks** toolbox - consists of all available elements that you can use by dragging them and dropping on a drop zone. ![Page blocks toolbox](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_blocks_toolbox.png) - **Structure view** toolbox - shows a structure of your page, including their division into zones and the blocks that they contain. ![Structure view toolbox](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/structure_view.png) ### Work with layout [Layout](https://doc.ibexa.co/projects/userguide/en/latest/content_management/configure_ct_field_settings/#available-page-layouts) divides the page into the defined zones. The zones are placeholders for the blocks. ## Block basics Handling blocks is straightforward, drag and drop them into the desired spot within the drop zone. There's no need to worry about getting their placement perfect initially, you can rearrange them whenever you need. ### Settings You have the ability to control individual blocks by accessing their settings. Click on the settings icon next to the block's name. ![Block settings](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/block_settings.png "Block settings") The settings include: - Move Up — change the block's position by shifting it upwards. - Move Down — change the block's position by shifting it downwards. - Configuration — access the configuration window. - Duplicate — create a copy of the block below the original, including its settings. - Refresh — update the block's preview. - Delete — remove the existing block. ### Design tab In the block configuration, on the **Design** tab, under the **View** field, you can select the layout for presenting a block. ### Scheduler tab In the block configuration, on the **Scheduler** tab, you can set a date for the block to be revealed or hidden. ## Standard blocks ### Banner block The banner block showcases an image linked to a specific URL. It can be used for creating visually appealing banners or promotional sections on websites that require linked images to direct users to specific pages or content. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Image** — Click **Select content**, browse the available content, and choose an image for display. - **URL** — Enter a URL that opens when users click on the banner block. ### Bestsellers block Displays products that were recently top sellers, to help users discover popular items quickly. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Personalization scenario** – Select "Bestsellers" to display popular products. - **Product types to be displayed** – Select the type of products to be displayed on the list. - **Limit** – Set the number of products to be displayed. On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. ### Campaign block Displays a campaign created and configured in [Ibexa Engage](https://doc.ibexa.co/projects/userguide/en/latest/ibexa_engage/ibexa_engage/index.md). On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the campaign. - **Campaign** – Select a campaign that you want to display on the page. The list contains only those campaigns from your Qualifio account, which are active or scheduled to launch in the future. ### Catalog block Shows products from a chosen catalog tailored for a particular group of customers, ensuring a personalized browsing experience. Before you configure this block, make sure that there are [catalogs](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_catalogs/index.md) that are defined and published in your product catalog. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Default catalog** – Select a catalog that is displayed to end-users who are anonymous or not part of any customer group assigned to specific catalogs. - **Set up customer group and catalog** — Add at least one assignment: add a row, then select a customer group and a matching catalog. - **Display limit** – Set the number of products to be displayed. On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. ### Code block Enables you to use custom HTML to add customized text, links, images, and more to your page. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Content** — Enter the HTML code for the content you want to display. ### Collection block Displays a collection of content items manually selected from the content structure, allowing you to feature specific content for promotional campaigns or highlight essential information on your website. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Location list** — Click **Select content**, browse the available content, and add to the collection content items of any content type you want. All selected content items appear in the **Selected items** box at the bottom of the window. When done selecting, click **Confirm**. ### Content List block Displays content items of specified content type from a selected folder, simplifying access to categorized information or targeted content presentation on your site. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Parent** — Click **Select content**, browse the content, and select a folder containing content items to display in the list. - **Limit** — Set the number of products to be displayed. - **Content types to be displayed** — Select content type(s) to be displayed. ### Dynamic targeting block Dynamic targeting block provides recommended items based on users related to the configured segments. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Select default scenario** — Select the default scenario for recommended items that should be rendered if the current user is not assigned to any segment. - **Setup segment and scenario matching priority rules** — Select a segment group, a segment identifier and Scenario that you want to display recommendations from. - **Display limit** — Set the number of products to be displayed. The rules are checked in order, so when a user belongs to more than one segment, the first rule applies. ![Dynamic targeting](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_builder_dynamic_targeting.png) ### Embed block Place any content item directly on the page. This function works across all content types seamlessly. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Content** — Click **Select content**, browse the content, and select a content item. ### Form block Place a selected form from the content structure onto the page. Integrate specific forms into your content to enhance client interaction. Completing the settings of the Form block requires at least one Form content item created. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Form** — Click **Select content**, browse the content, and select a Form content item to append it to the block. > **Caution: Known limitation** > > To display two or more identical forms on a single page, have your developer create multiple identical form blocks for your use. This prevents potential issues related to duplicate data submission. > > For more information about creating form blocks, see [Creating a newsletter form](https://doc.ibexa.co/en/5.0/content_management/pages/create_custom_page_block/) in Developer Documentation. ### Gallery block Presents a comprehensive visual array by displaying all images from your selected folder. On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Folder** — Click **Select content**, browse the content, and select a folder containing images to display. After submitting the settings, all images in the folder are shown in the Gallery block. Selecting a folder containing content items other than images results in displaying only a link to the folder where they're stored. ### Ibexa Connect block Access and showcase data retrieved from an Ibexa Connect webhook. Streamline information presentation for seamless insights and improved decision-making. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Webhook link** — Enter the link for the Ibexa Connect webhook. > **Caution: Using Ibexa Connect scenario block** > > For more information about using Ibexa Connect scenario block, see [Ibexa Connect scenario block](https://doc.ibexa.co/en/5.0/content_management/pages/ibexa_connect_scenario_block/) in Developer Documentation. ### Last purchased block Showcases a list of recently purchased products from the product catalog. Helps keep track of recent sales and improve product visibility. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Personalization scenario** – Select "Last purchased" to display products that were recently purchased from the product catalog by any user, or "Last purchased by user" to display products that were recently purchased by the current user. - **Product Types to be displayed** – Select the type of products to be displayed on the list. - **Limit** – Set the number of products to be displayed. ### Last viewed block Showcases a list of recently viewed products from the product catalog. Helps track and show recent product interests for quick access and informed decisions. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Personalization scenario** – Select "Last viewed" to display products that were recently viewed by any user, or "Last viewed by user" to display products that were recently viewed by the current user. - **Product Types to be displayed** – Select the type of products to be displayed on the list. - **Limit** – Set the number of products to be displayed. ### Orders block Showcases a list of orders linked to a specific company or individual customer. Helps track purchase history for streamlined customer service and personalized interactions. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Columns** — Select columns that should be displayed in the orders table. Some columns are preselected, for example, Order ID, Customer name, or Total value. - **Statuses** — Set the statuses of orders that should be included in the list. - **Number of orders** — Set the number of orders to be displayed. - **Sort order** — Set the sort order for the displayed orders. ### Personalized block Showcases recommended content items or products triggered by specific scenarios for end users. Enhances user experience by suggesting tailored options for various situations. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Select a scenario** – Select "Landing page" or "Top clicked". - **Select a content type to be displayed** – Select "Product". - **Display limit** – Set the number of products to be displayed. On the **Design** tab, in the **View** field, change the layout to "Products" and submit your changes. ### Product collection block Presents curated collections of items for easier exploration and discovery. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Product list** — Create a list of products. Either enter a comma-separated list of product codes and click **Add**, or click **Select products**, select products, and click **Confirm**. ### Product embed Presents a single product, allowing you to highlight its key features. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Product code** — Enter the product code and click **Add** or click **Select products**. Then, select a single product, and click **Confirm**. ### Recently added block Highlights recently added products from the product catalog. Quickly informs users about new additions for quicker distribution and popularizing added products. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Personalization Scenario** – Select "Recently added items" to display products that were recently added to the product catalog. - **Product Types to be displayed** – Select the type of products to be displayed on the list. - **Limit** – Set the number of products to be displayed. ### RSS block Imports and showcases news content from RSS feeds (channels), helping users stay informed with the latest updates and diverse news sources. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **URL** — Enter the URL for the RSS news feed. - **Limit** — Set the number of news items to be displayed. - **Offset** — Set the limit of featured news items to be displayed. ### Sales representative Imports and showcases sales representatives for the company in the Customer Portal. Gives users a way to connect with the team that handles their sales needs. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. On the **Design** tab, in the **View** field, select the layout to be used to present the Sales representative's details view and submit your changes. ### SeenThis! block Integration with [SeenThis!](https://seenthis.co/) service. SeenThis! block provides an adaptive streaming technology with no limitations as conventional streaming service. It allows to preserve the best video quality with minimum amount of data transfer. > **Note: Note** > > This page block is in an opt-in bundle, to use it, install `ibexa/connector-seenthis` bundle first. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Video ID** – Enter the ID of the video to be streamed. - **Tracker ID** – Enter the tracking code. - **Big play button** – Set to display a large play button. - **Autoplay** – Configure whether the video starts automatically. - **Muted** – Configure whether the video starts muted. - **Play button** – Set the number of products to be displayed. - **Mute button** – Set whether the mute button is displayed or not. - **Loop** – Set whether to play a video in a loop mode. - **Loop count** – Set the number of loop repetitions. - **Include audio** – Configure whether to include audio with the video. > **Note: Note** > > SeenThis! technology might be blocked by some ad blocker solutions. If you can't see the block once configured, check the ad blocker configuration. ### Targeting block Targeting block provides recommendation of content based on users related to the configured segments. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Select default content** — Click **Select content**, browse the content, and choose the default content item to display when no priority rules are valid. - **Setup segment and content matching priority rules** — Select a segment group and a segment, then click **Select content** and navigate to the content item that you want to display for the selected group. The rules are checked in order, so when a user belongs to more than one segment, the first rule applies. For example, consider the following configuration: | Segment | Content displayed | | --------- | ----------------- | | Segment A | Content 1 | | Segment B | Content 2 | | Segment C | Content 3 | To a user who belongs to **Segment A**, **Segment B**, and **Segment C**, **Content 1** is displayed, because the block evaluates rules from top to bottom and stops at the first match. Even though the user also belongs to **Segment B** and **Segment C**, those rules are never evaluated in this case. You can preview the page for each of the available segments: ![Previewing page for a given segment](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_builder_segment_preview.png) ### Text block Adds a Rich Text block to the page. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Content** — Enter a content, for example, text, images, or videos, with the online editor. For details, see [Editing Rich Text Fields](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#edit-rich-text-fields). > **Note: Use AI to improve text** > > If [AI Actions](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/ai_actions/index.md) have been configured in your application, the **Improve text** button is visible. If you have necessary permissions, you can click it to request that the AI Assistant performs specific tasks with your text. > > For more information, see [AI Assistant](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#ai-assistant). ### Video block Integrates a video into the page with standard playback controls. Helps enhance content variety and captivate audiences with seamless video viewing. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Video** — Click **Select content**, browse the content, and select a video to display in the block. On the **Properties** tab you can preview the selected video before adding it to the page. ## Recommendation blocks One of the elements of the Raptor integration is the addition of recommendation blocks. For more information, see [Recommendation blocks](https://doc.ibexa.co/projects/userguide/en/latest/recommendations/raptor_integration/raptor_recommendation_blocks/index.md). # Preview content items Preview content items of various types in many places of the back office. There are several places where you can see how the content item could look to an end-user. The system behaves differently depending on whether you're in [Focus Mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#focus-mode) or not and whether you selected a specific site from the **Site context** drop-down list in the top bar. - When you [edit a Page](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/index.md), the editor provides a visual experience. By clicking the following icons, you can switch between different Page views. | Icon | Description | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Preview segments | Access preview of the Page for a given [segment](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#segments). | | Timeline button | Access the timeline to preview how the Page changes with time. You can also view the list of all upcoming scheduled events. | - When you [edit a content item](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/index.md), click **Preview** - In the content item's details screen, click **Preview** > **Tip: Tip** > > In the content item preview screen, you can use a drop-down list to change site context by switching between [SiteAccesses](https://doc.ibexa.co/projects/userguide/en/latest/content_management/translate_content/#siteaccess). You can also toggle through different screen widths to see how the content item is rendered on different devices. ![View toggler](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/page_builder_toolbar_devicestoggler.png "View toggler") Additionally, if you select a specific SiteAccess from the **Site context** drop-down list in the top bar, three things happen: - when you hover over content items in the content tree, miniature previews appear - in Focus mode, when you browse content items in content tree, their full screen preview is displayed - if you [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode) or click **Exit full view**, the **View** tab appears in the content item's details view, where you can quickly preview the content item # Translate content Create multiple language versions of content items. The content on your website can be translated into different languages. Each content item can have different language versions. The version visible to a visitor depends on the way your installation is set up (see [SiteAccess concept](#edit-page-for-different-language-versions-of-a-website)). ## Add website languages You can only add translations in languages that have been set up for your website in the **Admin** panel. If your user [role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the right permissions, you can create a new language for the website. To do it, go to the **Admin** panel, open the **Languages** tab, and click **Add language**. Every new language must have a name and a language code written in the xxx-XX format, for example, eng-US, fre-FR, or nor-NO. After adding a language, you may have to reload the application to be able to use it. > **Caution: Caution** > > Depending on the way the website is set up, additional configuration may be necessary for the new translations to be displayed properly. Contact your administrator and inform them that you need to add a new language to the website. For more information, see [Developer Documentation on language versions](https://doc.ibexa.co/en/5.0/multisite/languages/languages/)). ## Add translations 1. In the left panel, go to **Content** -> **Content structure**. Then select a content item. 2. Go to **Translations** tab and click **+ Add**. 3. In the **Create a new translation** modal, select the source and target languages, then click **Create**. All the fields are then pre-filled with the values they have in the base translation. If you do not choose a base translation, the fields remain empty. While working, you can save your work and continue or click **Delete draft** to discard your changes. When done, you can save your work and close the window, publish the translated article immediately, or pick another publication date. Every time you add or edit a translation, a new version of the content item is created, the same way as when editing only one language. ![Adding a new translation](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/adding_translation.png "Adding a new translation") ### Automated translation If your application comes with a [properly configured automated translation feature](https://doc.ibexa.co/en/5.0/multisite/languages/automated_translations), you can have your content machine-translated into multiple languages by using external translation services like Google Translate and DeepL. To use it, in the **Create a new translation** modal, select the source and target languages and the **Use automatic translation with...** checkbox. If more than one service is configured, you can choose either of the available options. ![Automated translation](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/automated_translation.png "Automated translation") When you click **Create**, all the Fields are pre-filled with the values in target language, provided by the selected translation service. ## Translation comparison You can compare different versions of the translations of the content item. 1. [Disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode). 2. In the left panel, go to **Content** -> **Content structure**. Then select a content item. 3. Go to **Versions** tab and click the **Version compare** icon: ![Version Compare Icon](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/version_compare_icon.png). 4. In the **Comparing versions** screen, use the switcher in the top right corner, and click the split view: ![View switcher](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/view_switcher.png "View switcher") 5. From the drop-downs, select two different language versions of the same content item. The screen refreshes to display the side by side view of its fields. ![Compare translations screen](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/compare_translations.png "Compare translations screen") For more information, see [Work with versions](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/work_with_versions/#compare-versions). ## Edit page for different language versions of a website (Experience, Commerce) When you edit a page, a bar at the top of the screen lists the most recently used [SiteAccesses](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/multisite/#siteaccess) on your website. Use this bar to switch between the different versions and work on them. > **Note: SiteAccess concept** > > SiteAccesses are a means to present different versions of the website to different categories of users. You could treat SiteAccesses as different "entrance points" to your website. They allow you to show different content or design to visitors, for example, to serve different language versions to visitors from different countries. > > See [Work with websites](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/work_with_sites/index.md) for more information about setting up websites. # Work with forms Use surveys, questionnaires, sign-up forms and other interactive forms to enrich your website. Editions: Experience You can use forms to increase the functionality of the website by adding, for example, a survey, questionnaire, or sign-up form. You can then review the results gathered from website users, for example, to improve user experience. For more information about building and styling forms, see [Developer Documentation](https://doc.ibexa.co/en/5.0/content_management/forms/forms/). You can create a form with a visual drag-and-drop editor, the Form Builder. ## Create forms Editors can use the created form anywhere on the website. Forms can be used in page blocks, embedded in the online editor or even used as a field relation. The same form can be placed at multiple locations on the website. To create a form: 1. In the left panel, go to **Content** -> **Form** and click **Create content**. 2. In a slide-out pane, make initial choices in the following fields, and click **Create**: - **Select a language** - from a drop-down list, select the base language for the content item. - **Select a content type** - use this field to narrow down the list of content type choices displayed below. Then select **Form**, and click the **Create** button. ![Select form](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/select_form.png) 3. Provide the title and click **Build form**. ![Build form](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/build_form.png) 4. Drag (A) or click (B) on the type from the form fields toolbar. To create more complicated and detailed form, you can use more than one form field type. ![Drag form fields](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/drag_form_fields.png) 5. Click on the **Settings** icon to access form field settings. The settings differ depending on the type of field. ![Form settings](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/form_settings.png) **Button** is a special kind of field. You use it for submitting the form. You can choose one of a few options of what is shown to the user after filling in and submitting the form. ![Options of a Form submission button](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/form_builder_button.png) 6. Fill in necessary information and click **Submit**. 7. Click **Save** or **Close** to exit the Form Builder. 8. To discard your changes and close the window, click **Delete draft**. 9. To save your changes: - Click **Save** to continue editing. - Click **Save and close** to close the window. 10. To send your changes to another editor [for review](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/index.md), click **Send to review**. 11. When the form is ready for publication: - Click **Publish** to publish it immediately. - Click **Publish later** to set a specific publication date. For more information, see [Publish content](https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/publish_content/index.md). ## View results Once you publish a form and users start filling it in, you can preview the results in the **Submissions** tab in the content item view. Here you can view the details of each submission. You can also delete any submissions (for example if they were made while testing or contain spam). Click **Download submissions** icon to download all the submissions in a .CSV (comma-separated value) file. ![Form Builder submissions](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/form_builder_submissions.png) ## Use case - create newsletter In the following example, you can learn how to create a Newsletter form and use it with Page Builder. 1. Create a new content item in the chosen localization in the content tree and choose **Form** type. 2. Enter **Newsletter** as a title and click **Build** form. ![Build newsletter](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/build_newsletter.png) 3. From the **Basic form fields** toolbar choose: Single line input (two times), Email, Checkboxes and Button. ![Basic form fields](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/newsletter_fields.png) 4. Click on **Settings** icon and modify chosen form fields: - Single line input: **Name**: Name - Single line input #2: **Name**: Surname - Email: **Name**: Email address - Checkboxes: **Name**: Gender, **Options**: click **Add** button and add three values: Male, Female, Other. - Button: **Name**: Sign up!, **Action**: choose Show a message and in the **Message to display** field enter: Thank you! ![Newsletter settings](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/newsletter_settings.png) 5. Click **Save** button and then **Confirm**. 6. Now, you can use **a Newsletter** form on your page. Open your site with Page Builder and from the **Page blocks** toolbox choose **Form**. Drag it and drop on the zone. ![Add to page](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/newsletter_add_to_page.png) 7. Click **Block settings** icon and then, in the Form window click **Select content** button. Find your form in the content tree and choose it, then click **Confirm** and **Submit** buttons. ![Block settings](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/newsletter_button_submit.png) 8. Now, you can see a Newsletter form on your page. ![Newsletter form](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/newsletter_result.png) # Taxonomy Taxonomy is one of the ways classify content items with structured tags. With Tags, which can be understood as keywords, you can classify content: you create relationships between items to make it easier for website users to find the content they need, or browse and view content appropriate for them. Tag hierarchies (aka Taxonomies) are classifications of logical relationships between content items. In Ibexa DXP, you can create many taxonomies, each with a tree that contains many tags. ## Taxonomy tree Taxonomy tree is where you create a hierarchy of all tags and relationships between tags and content items. Working with the Taxonomy tree is similar to working with the content structure tree. ![Taxonomy tree and tag details](https://doc.ibexa.co/projects/userguide/en/latest/content_management/taxonomy/img/taxonomy_content_list.png "Taxonomy tree and tag details") For more information about setting up tags, see [Work with tags](https://doc.ibexa.co/projects/userguide/en/latest/content_management/taxonomy/work_with_tags/index.md). # Work with tags Taxonomy is one of the ways classify content items with structured tags. Once you have created content items that follow the structure defined within the content model, you can create [taxonomies](https://doc.ibexa.co/projects/userguide/en/latest/content_management/taxonomy/taxonomy/index.md) that consist of tags, to help users find the content they need. ## Add tag You can create tags in two ways: - create them directly in the taxonomy tree - click the **Create** button in the **Tags** section - To create a new tag in the taxonomy tree, in the left panel click **Content** -> **Tags**. - In the **Root** section, click the three dots icon on the level/place you want to add new tag and select **Add**. - Enter a unique name for the new tag. - Add the tag's identifier. - (Optional) Add tag description. - To set the parent category, click the **Select parent** button. - To save a new tag, click **Save**. Now, the tag is visible in the taxonomy tree. ### Add Taxonomy Entry Assignment field to content type Taxonomy is controlled and configured by the *Taxonomy Entry Assignment* field settings, so you can use multiple fields of this type with different taxonomies, for example, tags and product categories in the same content type. To be able to assign tags to a Content, first, you need to add a *Taxonomy Entry Assignment* field to the content type definition. 1. Go to **Content types** -> **Content**. 2. Click the **Edit** icon next to the content type you want to modify. 3. Go to **Field definitions** and from the available options, drag and drop the *Taxonomy Entry Assignment* to fields in the content type. 4. From the **Taxonomy** drop-down, select the taxonomy type you want to tag this content item with. Now, when you edit or create a content item of this type, in the tags section, you can add a tag by clicking **Select Taxonomy Entries**. See [Add taxonomy entries](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#add-taxonomy-entries). > **Caution: Duplicate taxonomy fields** > > Because tags are assigned per content item, not per field, you cannot use two *Taxonomy Entry Assignment* fields with the same taxonomy type in one content type. ### Add tag translation If you have more than one language version of your website, you can also translate tags that are used in the website into the target language. 1. Go to the **Tags** section. 2. Click a tag and go to the **Translations** tab. 3. Click **+Add new** and from the available languages, set the source and target language. 4. To finish, click **Create**. ### Delete tag You can delete tags directly from the taxonomy tree. Go to **Tags** section. 1. Click the three dots icon next to the tag you want to delete. 2. From the context menu, select **Delete**. ![Delete tag](https://doc.ibexa.co/projects/userguide/en/latest/content_management/taxonomy/img/taxonomy_delete_tag.png "Delete tag") ### View all content items with specific tag You can view a list of all content items which are tagged with the given tag. To do it, go to **Tags** section. In the taxonomy tree click the respective tag and go to the **Content** tab. ![Content list](https://doc.ibexa.co/projects/userguide/en/latest/content_management/taxonomy/img/taxonomy_content_list.png "Content list") # Content versions Learn about content item versions and the Autosave feature. ## Types of content versions In Ibexa DXP, content items can have more than one version. Versions can be of published, archived, or draft type. The **published version** is the version that is currently presented to the audience. Every content item can have only one published version at a time. Whenever you edit and publish a content item again, its previous published version becomes an **archived version**. It's not available to the visitor and you cannot edit it, but you can create new drafts based on any archived version. Finally, **drafts** are versions that haven't been published yet. There can be many drafts of the same content item. They can be created by the autosave feature, by the reviewer as part of the [editorial workflow](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/index.md), or when you save the work and close the content item editing screen. You can view all versions of a content item on the content item details screen. To do it, [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode), and go to this content item's **Versions** tab. ![All versions of a content item](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/content_item_versions.png "All versions of a content item") For more information, see [Editorial workflow](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/index.md) and [Work with versions](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/work_with_versions/index.md). ### Autosave While you edit a content item or product, Ibexa DXP saves your work automatically to help you preserve the progress in an event of a failure. To recover your work, [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode), go to this content item's **Versions** tab, and open the most recent draft. Alternatively, open the most recent draft of your work on the **My dashboard** page, the **Drafts** table. Autosave is enabled by default, and set to save a draft every 60 seconds. You can toggle autosave or change the time between saving attempts in **User settings**, by changing the values in the **Autosave draft** and **Autosave interval** fields. # Work with versions Perform various tasks on content item versions, as part of editorial workflow or when comparing edits from different users. In Ibexa DXP, content items can have one published [version](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/index.md), and several draft and archived versions. You can perform various tasks on content item versions, either to advance them through the workflow or compare edits from different users. ## Edit drafts If you're assigned to a draft version of a content item for [review](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/index.md), when you click the **Edit draft** icon in **My dashboard**, the **Review queue** table, you see the **Event(s)** timeline that lists all the transitions that this content has gone through. ![Events timeline](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/workflow_events_timeline.png) If draft locking is supported, you also see a message that confirms that the draft is now locked to you. ![Draft assignment message](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/lock_message.png) ## Release locked drafts If you're assigned to a draft version of a content item and have locked it for review, you can release the lock by closing the modal window, publishing the draft, or sending it to another reviewer. You can also do it in **My dashboard**, the **Review queue** table, by clicking the **Unlock** icon. If you're not assigned to the draft, depending on the permissions set for your role, in the **Review queue** table, you can either release the lock by clicking the **Unlock** icon, or request that the lock is released by the reviewer by clicking the **Request access** icon. ## Compare versions You can compare two versions of the same content item. To do it, [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode). Then, in the content item details screen, go to the **Versions** tab and click the **Version Compare** icon: ![Version Compare Icon](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/version_compare_icon.png). From the drop-down menus at the top of the screen, select the two versions that you want to compare. ![Versions](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/versions.png "Versions drop-down list") There are two options of the view: - Split - default, side by side view - Unified - single column view ![Version comparison in Unified view](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/unified_view.png "Version comparison in Unified view") When you compare two versions, the system highlights the changes: - yellow - content updated - blue - content added - red - content deleted ![Version comparison in Split view](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/split_view.png "Version comparison in Split view") You can also compare media field types such as images. ![Image comparison](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/image_comparison.png "Image comparison") > **Note: Note** > > Not all field types are available for comparison. You cannot preview the differences in the following field types: > > - Form > - Landing page > - User account # Editorial workflow Learn about editorial workflows that organize review flows for different content needs. With editorial workflow, you can pass content between different stages in a preconfigured flow. Typically, the stages correspond to different teams or departments that contribute to content and approve it. For example, you can pass content through stages of draft, design, and proofreading. > **Note: Note** > > Workflows are configured differently in each installation. In your workflows you can have different stages and transition between them. > > Contact your administrator or developer team to configure workflows. For more information, see [Developer Documentation](https://doc.ibexa.co/en/5.0/content_management/workflow/workflow/). ## Review queue You can view content items which are in different stages under review on **My dashboard** screen, in the **Review queue** table. The table only shows content items that your role has permissions to edit. If your installation is [configured to support draft locking](https://doc.ibexa.co/en/5.0/content_management/workflow/workflow/#draft-locking), the table also informs you whether any reviewers are assigned and have claimed their drafts for review. ![Review queue in the dashboard](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/dashboard_review_queue.png) In the Review queue table, you can access the draft for editing, review its history, unlock the draft, or request that a lock is released. For more information, see [Work with versions](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/work_with_versions/index.md). # View workflow list Review a list of workflows that are available in the installation. If you have Administrator permissions, you can view all configured workflows in the **Admin** panel by selecting **Workflow**. ![Workflow in Admin Panel](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/workflow_panel.png) You can preview a diagram of the workflow. ![Workflow diagram](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/workflow_diagram.png) You can also select a configured workflow to see all content items that are under review as part of this workflow. ![Content under review](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/img/workflow_content_under_review.png) For more information about configuring workflows, see [Developer Documentation](https://doc.ibexa.co/en/5.0/content_management/workflow/workflow/). # Copy, move or hide content Copy, move, remove, or hide content item, either individually or in bulk. ## Move or copy In content tree, you can move or copy existing content items by selecting an option at the top of the screen. You can also copy the whole subtree (a content item with all content under it in the structure). > **Note: Note** > > Copying very large subtrees may take too much time and server effort. That is why the system administrator may set a limit on how many content items can be copied at the same time. > > See [Copy subtree limit](https://doc.ibexa.co/en/5.0/administration/back_office/back_office_configuration/#copy-subtree-limit) in Developer Documentation on how to set this up. Copying creates a new content item. If you only want to have the same content item to another place in the content tree, add another location to it. ### Multi-file move In the content item's details screen, go to **Sub-items** tab, select multiple items, and click **Move**. ![Multi-file move](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/multi_file_move.png) Then choose a destination from the [content browser](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#content-browser) in the **Select destination** modal that opens up. After choosing and confirming new destination, all selected files are moved to it. ![Multi-file move](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/multi_file_move_location.png) ## Remove content You can remove content by clicking **Send to Trash** in the menu. If you remove a content item that has children (other content under it in the content tree), both this item and the children are removed. This also breaks the connection between the items, so you cannot restore them with the same structure. Notice that the content item is not removed completely. It's moved to Trash, which you can access from the left menu. In the Trash, you can search for content items and sort your search results based on different criteria. You can then select removed content items and restore them to their original locations or to new locations you choose. If the content item's parent has been removed, you need to select a new parent location. ![Warning before emptying the trash](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/empty_trash_warning.png "Warning before emptying the Trash") If a content item has more than one location, selecting **Send to Trash** removes the content item only from the current location. The content appears in Trash only once you have removed the last location. You can permanently remove a content item by checking it and clicking the trash icon. You can also permanently remove all content from the Trash by clicking **Empty Trash**. > **Caution: Warning** > > Emptying the Trash cannot be undone! ## Multi-file delete You have multiple ways to delete multiple items, for example: - in content tree, select multiple items, click the three dots menu, and select **Delete** - in content item's details screen, the **Sub-items** tab, select multiple items, and click **Delete** Confirm your choice in the pop-up window with the **Send to trash** button. All selected files are moved to trash. ![Multi-file delete](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/multi_file_delete.png) ### Hide content You can hide a content item by clicking **Hide** in the menu. ![Hide content icon](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/hide_content_icon.png) When you click **Hide**, you can choose to **Hide later** and select and date and time when the content item is hidden: ![Schedule hiding panel](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/schedule_hiding.png) A hidden content item is not shown in the frontend when using the default templates. It's also grayed out in the content tree. This is different from [hiding locations](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/manage_locations_urls/#hide-locations), because it affects the content item in all of its locations. > **Caution: Visibility and permissions** > > The [visibility switcher](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/manage_locations_urls/#hide-locations) is a convenient feature for withdrawing content from the frontend. It acts as a filter in the frontend by default. You can choose to respect it or ignore it in your code. It's not permission-based, and **doesn't restrict access to content**. Hidden content can be read through other means, like the REST API. > > If you need to restrict access to a given content item, you could create a role that grants read access for a given [**Section**](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#sections) or [**Object State**](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#object-states), and set a different section or object state for the given content. Or use other permission-based [**Limitations**](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md). # Classify content Use sections, bookmarks, or segments to classify the content of your website. To help you better organize content, Ibexa DXP comes equipped with a number of mechanisms that you can use. ## Sections You can divide your content tree into sections to better organize it. Sections let you decide which users can have access to which parts of the tree. To see which section a content item belongs to, [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode), and look at its **Technical details** tab. You can set up sections by navigating to **Content** -> **Sections**. A few sections are provided with each installation, and you can add new ones. ![List of Sections](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/sections.png "List of Sections") In the **Sections** tab, you can assign sections to content or delete them. You can only delete sections that do not contain any content. Each content item must belong to a section. By default, new content is placed in the same section as its parent. If you want to remove a content item from a section, you need to assign it to a different one. Access to sections can be restricted by [setting up proper permissions](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md). ## Object states You can assign specific object states to all content items in your website. To do it, [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode), go to the **Technical details** tab, and make necessary changes in the **Object state details** section. ![Object state details](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/object_state_details.png) > **Note: Note** > > The functioning of object states can be set up differently in each installation. Contact your website administrator for information on how to use the states in your case. ## Bookmarks You can bookmark any content item by clicking the star icon next to the content name. ![Bookmark icon](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/bookmark_icon.png) Bookmarks are stored per user. Click **Bookmarks** in the left menu to view a list of all of them. ![Bookmark screen](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/bookmarks.png) ## Segments (Experience, Commerce) With segments you can target content at specific groups of your users. You can use them to display different content to different page visitors. To do it, use the [Targeting block](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/#targeting-block). You can create and configure segments and segment groups in the **Admin** section of the back office. ![Segment groups](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/admin_panel_segment_groups.png "Segment groups") > **Note: Note** > > Assigning users to segments happens automatically according to rules set up by the administrator. Contact your website administrator for more information about your setup. # Manage content locations and URL addresses Manage the content of your website by controlling locations and URLs. ## Content locations A content item by itself does not have a place in the content tree and is not visible for a visitor of the website. To be available on the website, it has to be assigned a location ID. A new content item is automatically assigned a location when you publish it. A content item can have more than one location ID. In such a case you can find it in more than one place in the content tree. A single location can only have one content item in it. > **Tip: Example** > > You can use multiple locations for an Article about a local sports team's victory, which you can place in the tree both under Local News and Sports News. Even if a content item is placed in more than one location, one of the locations is always treated as the main one. To assign other locations to content, [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode), go to the content item's **Locations** tab and click **+ Add**. Then select the new parent from the content browser. ![Content with two locations](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/content_with_two_locations.png "Content with two locations") ### Hide locations You can manage the availability of content by hiding or revealing it. To do it, go to content item's **Locations** tab and use the Visibility switcher. Notice that this way only affects a *Location*, not the *Content item*. Even if you hide the content in one location, it remains visible in its other locations. You can also [hide the content item itself](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/copy_move_hide_content/#hide-content). When a location is hidden, all of its children (other content items that are under it in the tree) are also automatically hidden. They can only be revealed if the parent location is revealed as well. A hidden location is invisible for everyone viewing the website. If you're looking for a way to allow only some users to view parts of the content tree, use [Sections](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#sections) and combine them with [proper permissions](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permission_system/index.md). ### Swap locations You can swap two content items in their locations by going to the **Swap Locations** section in the **Location** tab and selecting a content item to swap with. > **Caution: Caution** > > Swapping locations republishes their respective URL aliases. This means that if the swapped content item was accessible by the URL that had a number at the end (added due to a name conflict), then after the swap the number is removed (if possible). The opposite case also applies. > > Swapping locations for content item with the same name and parent results in swapping their URL aliases. This means that if the content item was previously accessible by a URL without a number at the end, after the swap it's accessible by a URL with a number at the end (and the other way around). > > If at some point there were more than two content items with the same name under the same parent, then result of swapping such content items might not be obvious. The general rule is that the content item that previously had a higher number at the end of its URL alias have its URL alias republished first, resulting in the lowest nonconflicting number (or the lack of) at the end of its URL alias. The content item that previously had a lower number at the end of its URL alias have its URL alias republished second, resulting in the second lowest nonconflicting number at the end of its URL alias. ## URL management In your website, you can manage external URL addresses and URL wildcards. You do this in the back office, **Admin** tab, the **URL management** node. For more information about URL management, see [Developer Documentation.](https://doc.ibexa.co/en/5.0/content_management/url_management/url_management/). ### Link manager In your website you can link to external websites. To do it, use the URL field or embed links within Rich Text. You can view and update all external links that exist within the website, without having to modify and re-publish the individual content items. ![Link manager tab](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/Link_manager_sm.png) The **Link manager** tab shows a list of all links in the website. Click any item in the list to see its details and a list of content items that use this URL. ![Detail of a link in Link manager](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/link_manager_detail.png) You can change any link in the Link manager. It's then updated in every place where it's used, across all content items. The Link manager list also shows whether the link is alive or dead in the **Status** column. The **Last checked** column displays when the status was last verified. > **Note: Note** > > When you edit a link in the Link manager, you cannot change the URL address to one that already exists in the system. > > Once you save the link, it's automatically be marked as "Valid". ### URL aliases Each content item can have one or more URL aliases. They're additional URLs that can be used to access this content item. To add URL aliases, go to the **URL** tab, and click **+ Add** in the **Custom URL aliases for...** area. ![Add new URL alias](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/add_new_url.png) The URL alias must be unique for the whole installation, regardless of the language. ![Creating a new URL alias](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/create_new_url_alias.png) For each new alias, you can set the following options: - Language - the language of the content item that the alias redirects to. - Redirect to alias destination - when toggled on, the alias redirects to the content item's actual URL. - Place at the website root - when toggled, the alias is created in the root of the website. If this is toggled off, the alias is relative to the parent of the content item. - SiteAccess - when selected, the prefix of the respective SiteAccess is added to the alias path. ### URL wildcards With wildcards, you can replace a portion of the URL address for many content items at the same time, for example, to shorten the path, or to make the path meaningful for the readers. ![URL wildcards tab](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/URL_Wildcards_sm.png) The **URL wildcards** tab shows a list of all URL wildcard definitions that exist within the website, and contains all the information about each URL wildcard. You can delete or modify existing entries, or create new ones. ![Editing a URL wildcard definition](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/URL_wildcard_detail.png) For each URL wildcard definition, you set the wildcard pattern and the destination. Also, you decide whether the link should redirect users to the destination's original address. # Collaborative editing Learn about Collaborative editing feature and its capabilities. Collaborative editing is a feature that allows multiple users to work on the same content simultaneously - whether to preview, review, or edit it. By giving users access to preview the content before it's published, review and collaboration become much easier. An additional option here is the ability to copy a link to the content item, which allows to share it through communication channels. It improves collaboration with members of other teams, such as subject matter experts, compliance professionals, and sales representatives, to increase content quality. A more advanced part of the collaboration feature is the Real-time editing. Users can edit and review content in real time, making teamwork faster, more efficient, and streamlining the content review process. The system automatically tracks changes, allowing seamless collaboration within a single content item. ## Collaboration session When you create a new draft of content item you can invite other users to join a collaboration session. To invite collaborators, click the **Share** button, which creates a new collaboration session. ![Share button](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/share_button.png) Then, in a pop-up window, you can invite users to newly created session. You can only invite users with permissions to access the shared content. Users without permissions are grayed out and you can't select them and invite them to the session. You can invite two types of users: - **Internal** - by searching their name or email address. These users can either edit the content item or preview it, depending on your choice. Their account permissions determine whether they can invite additional users. ![Internal users - invitation](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/invite_internal_user.png) - **External** - by providing their email address in the field. They can only preview the content item (editing option isn't available, it's grayed out). ![External users - invitation](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/invite_external_user.png) To confirm the provided email address, press the **Enter** key on your keyboard. After inviting the user by clicking the **Invite** button, they appear in the *People with access* list. In the same pop-up window, you can change the type of access for specific user, for example, by granting them the ability to preview the content, or remove access. To do it, click the **Arrow symbol** and select the option from the list. ![Change access](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/change_access.png) Additionally, you can share a direct link to the collaborative session without specifying a particular user. To do it, click the **Copy link** button. Link is copied to the clipboard and you can share it with the users through communication channels. Use the **Link settings** button to control whether a user needs an account in the system to preview content using the direct link. After inviting users to a collaboration session, they receive a notification: - visible when clicking the **Notification** icon on the main dashboard (internal users) - by email (external users) ![Notification - internal user](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/internal_notification.png) Collaboration session begins when first invited user accepts the invitation and joins the session, and ends when the owner performs one of the action: - save and close - publish the content (including "Publish later" option) - delete content draft - discard - move the draft in the workflow - end collaboration session Users can also join a collaboration session using the **Join** button: - available in new tabs of the **My content** block on the dashboard - *My shared drafts* and *Drafts shared with me* - by accessing a content draft in the **Drafts** menu Each user can leave collaboration session anytime or rejoin it. ### Real-time collaboration Real-time collaboration is an advanced option of the Collaborative editing feature. It works by syncing changes in real time, so everyone can see updates instantly. Users can edit the content only if an administrator gives them the necessary permissions. These permissions must be set before the user is invited to the session, otherwise the **Edit** access option is unavailable (grayed out). While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it. ![Collaboration - users tags](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/users_tags.png) This allows other users in the same session, who are working the same content, to see what each person is editing in real time. You can see all users belonging to a given content item's collaboration session. Avatars of the users invited to collaboration session are visible at the top of the editing screen, also in distraction free mode. When you hover over the user avatar, the user’s first and last name is displayed. If you want to see all participants list, click at the avatars group. ![Participants list](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/participants_list.png) #### Real-time collaboration Terms of Service changes Real-Time Collaboration service is only available after accepting its Terms and Conditions. When Ibexa releases a new version of this document, you will see a notification in content edit forms that the new version must be accepted before the appointed deadline. If not done in that time, the Real-Time Collaboration service will be disabled until the latest Terms and Conditions are accepted. To proceed with accepting the new version, contact your Ibexa DXP implementation partner. ## Editing content item Collaborative editing is enabled in Rich Text fields. Other fields are disabled and can be only edited by the owner of the content item. Collaboration is available for the following content types containing Rich Text fields: - Article - Folder - Form - Custom content types There are two modes of the collaboration: - **Real-time (online)** - editing content at the same time with real-time tracking of the presence and changes of other users - **Asynchronous** - editing content independently > **Warning: Warning** > > Only the owner can publish content, save it, delete the draft, or publish it. Changes are automatically saved when the owner saves or publishes the content. Users can continue collaboration without the owner presence, but they cannot save, or publish changes. They can also leave collaboration session any time without losing data. ## Work with draft You can access created draft in **Content** -> **Drafts**. Here you can join your collaboration session, share with more users, edit given permissions, or delete the draft. ![Work with draft](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/work_with_draft.png) ## Dashboard blocks Collaborative editing feature brings two new tabs in **My content** dashboard block: - **My shared drafts** - displays all drafts with active collaborations and shared by the user. Includes following columns: Name, Content type, Modified language, Version, Modified, Shared with (lists all the users who received the invitation to the collaboration session). From this tab, you can perform following actions: Share, Join, Edit - **Drafts shared with me** - displays all drafts with active collaborations and shared with the user. Includes following columns: Name, Content type, Modified language, Version, Modified, Shared by (displays the user who invited to join the collaboration session). From this tab, you can perform following action: Join From the dashboard, you can share drafts or join collaboration session for selected content draft. ![Dashboard block - My content - new tabs](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/my_content_tabs.png) # AI Actions # AI Actions Learn how AI Actions can help editors by automating repetitive tasks. AI Actions is a set of capabilities that enhance the efficiency and creativity of content editors. The feature is included in Ibexa DXP by default but may require some [configuration](https://doc.ibexa.co/en/5.0/ai_actions/configure_ai_actions/) before you can use it. Once AI Actions are configured, content editors with `Action configuration/View` and `Action configuration/Execute` permissions have access to AI-driven tools. For example, they can [enhance or improve the text](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#ai-assistant) that they have written, or [generate alternative text](https://doc.ibexa.co/projects/userguide/en/latest/image_management/upload_images/#ai) for images. If you have the right permissions, you can decide what capabilities are available to the editors by enabling AI actions. You can also modify the parameters of individual AI actions, to control the creativity of the AI or the cost involved with using it. For more information, see [Work with AI actions](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/#edit-existing-ai-actions). # Work with AI actions Create new AI actions or modify existing ones to work faster and increase creativity. AI actions define what results are available to editors in AI-enabled areas, such as, for example, the AI Assistant. If AI Actions, including at least one service connector, have been configured in your application, and you have the required [permissions](https://doc.ibexa.co/en/5.0/permissions/policies/#ai-actions), including `Action configuration/Edit` and `Action configuration/Create`, you can reconfigure the existing AI actions, and create new ones. > **Note: Variations in AI action settings** > > The following description outlines the UI options displayed when either the default OpenAI connector or the Anthropic [LTS update](https://doc.ibexa.co/en/5.0/ibexa_products/editions/#lts-updates) is installed and configured. > > Response generation settings may vary depending on the AI service, model implementation, and action type, so the settings shown below might differ from those available in your installation. ## View AI actions With the right permissions, you can view all AI actions configured in the application by navigating to the Admin Panel and selecting **AI actions**. ![AI actions in Admin Panel](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_actions_list.png) You can narrow down the list of AI actions by filtering it by the status, either Enabled or Disabled, or by the type. Out of the box, there are two categories of AI actions present in the system: - **Refine text** - used by default in [online editor](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#ai-assistant) for refining text, for example: "Rewrite text in formal tone" - **Generate alternative text** - used by default in the [image asset editing screen](https://doc.ibexa.co/projects/userguide/en/latest/image_management/upload_images/#ai) to generate alternative text, for example: "Generate short alternative description of an image" It may happen that a set of sample AI actions has been [installed with the AI actions package](https://doc.ibexa.co/en/5.0/ai_actions/install_ai_actions/#install-sample-ai-action-configurations-optional), and there is already a number of existing AI actions that you can modify and clone. > **Note: Custom action types** > > In your specific case, the types available can be different, and your organization's development team can create custom AI action types. For more information, see [developer documentation](https://doc.ibexa.co/en/5.0/ai_actions/ai_actions/). ### View AI action details Navigate to the Admin Panel and select **AI actions**. In the **AI actions** list, click the name of an AI action to review its details. For example, in the **Properties** tab, you can see specific settings that modify the prompt that is sent to an AI service. ![AI action details](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_action_details.png) ## Edit existing AI actions You can modify the existing AI actions. 1. Navigate to the Admin Panel and select **AI actions**. 2. In the **AI actions** list, click the **Edit** icon next to a name of the AI action that you want to modify. 3. In the **Global properties** section, you can change the name and description of the AI action. You can also toggle the availability of the AI action between disabled and enabled. 4. In the **Settings** area, change the settings that modify the behavior of an AI service that executes an AI action, for example: - **Prompt** - modifies the default request by passing a verbal command, for example, "Make it short and formal." > **Note: Default request** > > The default request can be seen at the top of the settings area, on a light blue background. - **Model** - decides what AI service model is used to generate the response - **Max tokens** - sets a maximum number of "[words](https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them)" or [tokens](https://docs.claude.com/en/docs/about-claude/glossary#tokens) that can be used in a single request by both the request and the response - **Length of prompt output** - sets a maximum number of words of the generated result - **Temperature** - controls the randomness of the response. Takes a value between 0 and 2, but the usual range is between 0 and 1. The output is more random at higher temperatures. For more information, see the parameter's description in [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature) or [Anthropic's glossary](https://docs.claude.com/en/docs/about-claude/glossary#temperature) ![AI action options](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_action_options.png) 5. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. ## Create new AI actions You can create AI actions that perform actions of different types, using different models, or action handlers. > **Note: AI action models** > > Before you can work with AI actions, models must be configured and enabled by your organization's development team. If there are more AI service connectors available, you might be able to create AI actions that perform the same type of actions but use different models. For more information, see [developer documentation](https://doc.ibexa.co/en/5.0/ai_actions/ai_actions_guide/#model). 1. Navigate to the Admin Panel and select **AI actions**. 2. In the **AI actions** list, click **Create**. 3. In the slide-out pane, make initial choices in the following fields, and click **Create**: - **Language** - sets the base language for the AI action - **Action type** - sets an action type to serve as a template for the AI action, for example, **Refine text** - **Action handler** - sets the AI model used to process the requests resulting from this AI action 4. In the **Global properties** section, set the name and identifier of the AI action. 5. Optionally, provide a description of the AI action. 6. When ready, toggle the status of the AI action to enabled. 7. Make settings in the **Settings** area. For a list of available settings, see [Edit existing AI actions](#edit-existing-ai-actions). 8. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. ### Create AI actions that control taxonomy suggestions If the [Taxonomy suggestions](https://doc.ibexa.co/en/5.0/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice. 1. Navigate to the Admin Panel and select **AI actions**. 2. In the **AI actions** list, click **Create**. 3. In the slide-out pane, make initial choices in the following fields, and click **Create**: - **Language** - sets the base language for the AI action - **Action type** - sets an action type to serve as a template for the AI action, for example, **Suggest taxonomy** - **Action handler** - sets the AI model used to process the requests resulting from this AI action. Pick `taxonomy-text-to-taxonomy` 4. Make settings in the **Global properties** section, as described above. 5. Make settings in the **Settings** area: 1. Select a group of content types or product types that you want to pick types from. 2. Select the content types or product types in which you want to allow editors to use taxonomy suggestions. 3. Select source fields that contain values to be sent to an AI service for processing. 4. Select target fields (of **Taxonomy Entry Assignemnt** type) for which taxonomy entry suggestions are provided. ![Selecting source fields](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/taxonomy_source_fields.png "Selecting source fields") 6. Make optional settings, for example: - Define a maximum number of returned suggestions - Set the maximum number of tokens to be used by each call when generating suggestions 7. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. ### Create AI actions that use Ibexa Connect If your organization uses Ibexa Connect, you can build multi-step scenarios that define the logic needed to process your input data, for example, by merging the output of multiple AI services. One such example could be sending out a text for translation by one service, and then to another to make sure that the resulting translation is written in the right tone. > **Note: Ibexa Connect configuration required** > > To use AI actions that interface with Ibexa Connect, you must first [configure and initiate the connection](https://doc.ibexa.co/en/5.0/ai_actions/install_ai_actions/#configure-access-to-ibexa-connect), and [define templates](https://doc.ibexa.co/projects/connect/en/latest/scenarios/scenario_templates/#creating-templates) and/or [scenarios](https://doc.ibexa.co/projects/connect/en/latest/scenarios/creating_a_scenario/) in Ibexa Connect. 1. Navigate to the Admin Panel and select **AI actions**. 2. In the **AI actions** list, click **Create**. 3. In the slide-out pane, make choices like in [Create new AI actions](#create-new-ai-actions) but in the **Action handler** field, select the model that uses an Ibexa Connect scenario to process the request, for example `connect-image-to-text`, and then click **Create**. ![Ibexa Connect handler](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_action_connect_handler_selection.png) 4. In the **Global properties** area, set the required properties. 5. In the **Settings** area, select an existing scenario from a drop-down list. The list contains all scenarios that exist in Ibexa Connect. They may be incompatible with the selected action type and require adjustments on the Ibexa Connect side. 6. Optionally, if there are no scenarios for the selected action type, or you want to create a custom scenario, click **Create scenario based on template** and select a template from a drop-down list. If you do so, when you save the new AI action, a new scenario is automatically created. You must then fine-tune its settings in Ibexa Connect. ![Ibexa Connect scenario selection](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/img/ai_action_settings_connect.png) > **Note: Link to Ibexa Connect** > > Click **Go to Connect** to review all scenarios that exist in Ibexa Connect. 7. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. After you save the AI action, you can click its name in the AI actions list and see all the information, such as Scenario ID, webhook URL, or scenario label, which you may needed when working with scenarios in Ibexa Connect. ## Duplicate AI actions You can duplicate existing actions, for example, to create a variant version of an action with slightly different settings. To do so, in the **AI actions** list, click the **Duplicate** icon next to a name of the AI action that you want to duplicate. You can then modify the duplicated action (for example, change its name or fine-tine the instructions), enable it and save your changes. If you discard your changes, the duplicated action will appear on the actions list with status Disabled. # Product catalog # Product catalog Product catalog enables handling of products presented in the website and offered in the storefront, including their specifications and pricing. With Product catalog you can create, configure, and manage products that are offered in the Ibexa DXP-based website and/or storefront, including their specifications, attributes, assets, variants, and pricing. You can group products into categories and catalogs. Catalogs are collections of products selected with configurable filters. Categories let you organize products within product catalog and create relationships between them, for example, to help customers in searching for products. Product catalog's features are available from the left-hand menu. ![Product catalog in the menu](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/catalog_menu.png "Product catalog in the menu") You can use Ibexa DXP's built-in product management, or connect it to an external product information management (PIM) system. [Quable PIM integration](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md) allows you to use Quable as the source of product data, while using Ibexa DXP for marketing activities, [managing prices](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_prices/index.md), and [availability and stock](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_availability_and_stock/index.md). - [Quable PIM integration](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/quable_pim_integration/): Quable PIM integration allows you to use products managed in Quable as the source of product data in Ibexa DXP. - [Product types](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/product_types/): Product types contain a combination of Fields and attributes and serve as templates for different types of products. - [Create product types](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/create_product_types/): Build new product types or modify existing ones. - [Products](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/products/): Products are containers that aggregate information about the items you offer, for example, their specs, variants, or availability. - [Create and edit products](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/create_edit_product/): Create new products or modify existing ones. - [Work with catalogs](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/work_with_catalogs/): Catalogs allow creating filtered product lists for special purposes, for example, for B2B and B2C uses, for retailers and distributors or for different regions. - [Work with product categories](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/work_with_product_categories/): You can create a structure of tags that can be assigned to products to help categorize products, to assist visitors in searching. You create, manage and assign categories manually. # Quable PIM integration Quable PIM integration allows you to use products managed in Quable as the source of product data in Ibexa DXP. Ibexa DXP can be connected to [Quable](https://www.quable.com/en) as an external product information management (PIM) system. After the feature is [configured](https://doc.ibexa.co/en/5.0/product_catalog/quable/install_quable/), Quable becomes the central place for managing product data. All product information is maintained in Quable and automatically made available in Ibexa DXP. This allows teams to work with consistent product data in the Ibexa DXP interface, without duplicating or manually transferring information between systems. ## Work with Quable products When Quable is configured as the source of product information, you can use product data directly in Ibexa DXP. ### Browse and search products Products from Quable are available in Ibexa DXP and can be browsed and searched for using categories and filters. This makes it easier to find and work with the right products when creating content. ### Use products in content You can select and [embed products in content items](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#embed-products), for example when creating articles or promotional pages. Product data is always up to date and reflects the current state in Quable. ### Manage prices and availability [Product prices](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_prices/index.md) and [availability and stock](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_availability_and_stock/index.md) can be managed in Ibexa DXP. You can define pricing rules, such as [discounts](https://doc.ibexa.co/projects/userguide/en/latest/commerce/discounts/discounts/index.md) for specific regions or customer groups. ## Managing product data When Quable is the source of product information, product data is not managed in Ibexa DXP. The following actions must be performed in Quable: - creating, editing, or deleting products - updating product attributes and translations - managing product categories This ensures that product data remains consistent across all systems and channels. To learn more about the limitations of the integration with Quable, see [known limitations](https://doc.ibexa.co/en/5.0/product_catalog/quable/quable_guide/#known-limitations) in the developer documentation. # Product types Product types contain a combination of Fields and attributes and serve as templates for different types of products. Product types are templates that contain a combination of [fields](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_model/#fields-and-field-types) and [attributes](#attributes) which constitute a product definition. By default, product types contain such fields as name, specification, image, or category. You can modify them as required. You need different product types, because products of type "Laptops" contain different fields and attributes than those of type "White appliances". > **Note: Quable PIM integration** > > When [Quable is configured as the source of product information](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md), product types are defined from Quable and are read-only in Ibexa DXP. To add or modify product types, use the Quable back office. Changes are automatically reflected in Ibexa DXP. When you create a new product type, you can choose between two available product type flavors: Physical and Virtual: - Physical - tangible products. They can use measurement attributes. They require shipment in the online purchase process. Examples: heaters, laptops, phones. - Virtual - non-tangible items. They can be sold individually, or as part of a product bundle. They don't require shipment in the online process. Examples: memberships, services, warranties. A product type also defines both the attributes and VAT rates for all its products. When a product type is created, you can review its fields, attributes, and VAT rate settings on the product type's details screen, without having to open it for editing. ![VAT rates in product type's details view](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/vat_rates_product_details.png "VAT rates in product type's details view") If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `ProductType/Edit` permission, you can [modify product types and add individual attributes or attribute groups](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_product_types/index.md). ### Attributes Unlike text fields that can be formatted and are intended to be displayed, product attributes precisely list product properties or specifications. Attributes serve as criteria for filtering and searching for products. They can also be used to define product variants. Attribute types define what kind of information you can store in an attribute. Typical product attribute examples include dimensions, weight, color, or format. For more information, see [Work with product attributes](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_attributes/index.md). # Create product types Build new product types or modify existing ones. If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `ProductType/Edit` permission, you can modify product types and add individual attributes or attribute groups. > **Note: Quable PIM integration** > > When [Quable is configured as the source of product information](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md), product types are defined in Quable and cannot be created or modified in Ibexa DXP. Manage product types in the Quable back office instead. 1. In the left panel, go to **Product catalog** -> **Product Types** and click **Create**. ![Create new product type](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/create_new_product_type.png "Create new product type") 2. From the drop-down list choose "Physical" or "Virtual" type and click **Add**. ![Selecting a type of product type](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/virtual_product_type.png "Selecting a type of product type") 3. Fill in basic product information: name, identifier and description. ![Defining product type settings](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/create_product_type.png "Defining product type settings") Each product has a product code that must be unique. It identifies the product in the system. Product code can have up to 64 characters. It can contain only letters, numbers, underscores, and dashes. 4. Add fields that describe the product by dragging them from the **Field types** area to the **Field definitions** section, and then [configure them](https://doc.ibexa.co/projects/userguide/en/latest/content_management/configure_ct_field_settings/index.md). For the information that is intended to be displayed, use [TextLine](https://doc.ibexa.co/en/5.0/content_management/field_types/field_type_reference/textlinefield/) fields for short text, and [RichText](https://doc.ibexa.co/en/5.0/content_management/field_types/field_type_reference/richtextfield/) fields for longer text that may require formatting. 5. Add attributes by dragging them or their groups from the **Library** area to the **Attributes** section. Use attributes to store precise lists of product properties or specifications. When you define attributes for the product type, you can add or remove either whole attribute groups or individual attributes. ![Adding attributes to a product type](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/adding_attributes.png "Adding attributes to a product type") You can also remove whole groups, or single attributes from groups that you don't want to use for the given product type. Do this by clicking the **X** icon next to the group or attribute. For every attribute, you can select **Used for product variants**. Attributes that have this option are used to [automatically generate product variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/#generate-variants). 6. Below the **Attributes** section, in the **VAT rates** area, assign VAT rates that apply to all products of this type. ![Assigning VAT rates](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/vat_rates_product_type.png "Assigning VAT rates") > **Tip: Tip** > > When your website supports multiple regions, you can use the search field to find the right one. # Work with product attributes Create a structure of attributes that describe product characteristics and help search for products and filter them. Attributes describe physical, technical or other characteristics of a product. They're organized into attribute groups, and when you assign attributes to products, you can assign either whole groups, or individual attributes. You can use attributes to create multiple versions of one product, called [product variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md). Store visitors can use them to filter and search for products. Attribute types define what type of information you can store in an attribute. Available attribute types are: - Checkbox - represents a Boolean value - Date and time - represents a timestamp - Color - presented as a hex value - Float - represents a number with fractions - Integer - represents a number without fractions (a whole number) - Measurement (range) - measurement with a given unit and minimum/maximum values selectable per product type - Measurement (single) - measurement with a single value in given unit - Selection - one of a list of customizable options - Symbol - value of product's symbol attribute If the default list of attributes is not sufficient, ask your development team to [create a custom attribute type](https://doc.ibexa.co/en/5.0/product_catalog/create_custom_attribute_type/). > **Note: Attribute translations** > > Product attributes are not translatable. Unlike text fields used in content, product attribute values cannot differ between languages. Therefore, consider using attributes to store technical parameters and text fields for descriptive text intended to be displayed that may require translation. ## Create attribute groups Before you can proceed with creating attributes, you must first create at least one attribute group. With groups, you can organize attributes based on attribute type ("Physical", "Abstract"), product type ("Hardware", "Software'), or other criteria. 1. In the left panel, click **Product catalog** -> **Attribute groups** and click **Create**. 2. Fill in basic attribute name information: name and identifier. Each identifier must be unique. It can have up to 64 characters and contain only letters, numbers, underscores, and dashes. 3. Click **Create**. ## Create attributes 1. In the left panel, click **Product catalog** -> **Attributes** and click **Create**. ![Create new attribute](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/create_new_attribute.png "Create new attribute") 2. From the drop-down list, choose an attribute type and click **Add**. ![Attribute types](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/attribute_types.png "Attribute types") 3. Fill in basic attribute information: name and identifier. Each identifier must be unique. It can have up to 64 characters and contain only letters, numbers, underscores, and dashes. 4. Select an attribute group to which the attribute is assigned. After you assign an attribute to a group and save your changes, the assignment can't be changed. 5. Optionally, add a description for the attribute. 6. Depending on the attribute type selected, set the attribute parameters, for example: - For a measurement, select either of the measurement types and a base unit - For a selection, populate the **Options** list with label-value pairs - For integer, float and range, optionally, set a minimum and maximum value ![Measurement types](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/measurement_types.png "Measurement types") 7. Click **Save and close**. # Work with currencies Define currencies that the system uses for calculating product prices. Currencies are taken into account when calculating product price. You can configure currencies available in the system. To do it, in the left panel, go to **Product catalog** -> **Currencies**. ![Manage currencies](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/manage_currencies.png "Manage currencies") The system contains a list of different currencies. To use them in the catalog, edit and enable them. ![Enabling a currency](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/enable_currency.png "Enabling a currency") To create an additional currency, provide its code (for example, EUR, USD, or GBP) and the number of fractional digits, that is, the number of digits after the comma/period. For example, the configuration for the Swiss franc would be `CHF` with two fractional digits. # Products Products are containers that aggregate information about the items you offer, for example, their specs, variants, or availability. Products are instances of a particular [product type](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/product_types/index.md). A product is an object that's based on a product type template. It can have [variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md) that you build around [attributes](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_attributes/index.md). Products can be put in [catalogs](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_catalogs/index.md) and organized into [categories](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_categories/index.md). For each product and product variant, you can define its [availability](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_availability_and_stock/index.md), stock and [prices](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_prices/index.md). When you create or edit products, you can add [assets](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_assets/index.md) in a form of images. Assets can be assigned to the base product, and to one or more of its variants. Products can also be [embedded in content items](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#embed-products) and [landing pages](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/#product-embed) to showcase them within editorial content, such as articles and landing pages. > **Note: Quable PIM integration** > > When [Quable is configured as the source of product information](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md), creating and editing products in Ibexa DXP is not available. > > Product data is managed in the Quable back office, with the exception of [managing prices](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_prices/index.md) and [availability](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_availability_and_stock/index.md) which happen in Ibexa DXP. In addition, you can use Ibexa DXP to browse, search, filter, and embed Quable products in content items, including landing pages. For more information about creating products, see [Create product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_edit_product/#create-and-edit-products). ### Product completeness Before your customers can purchase products, the website [administrator must configure](https://doc.ibexa.co/en/5.0/product_catalog/enable_purchasing_products/) at least one region and one currency for the shop, and VAT rates for each of the regions. You must then set: - VAT rates for the product type - at least one price for the product - availability with positive or infinite stock for the product When you review product details, under the product name, you can see a progress bar with an approximate indication of how much of the product information you provided, and how much is still missing. ![Quick view of product completeness](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_completeness_bar.png "Quick view of product completeness") To find out in detail, which pieces of product information require your attention, go to the product view's **Completeness** tab. It lists all tasks required for product configuration, including: - content (such as images and descriptions) - attributes - assets - variants (if any of the attributes is enabled for variants) - availability - prices in different currencies - translations ![Product completeness screen](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_completeness.png "Product completeness screen") You can click the **Edit** button next to an unfinished task in the **Completeness** table to go directly to the screen where you can add the missing information. > **Note: Impact on availability** > > Product completeness does not impact product availability or visibility on the storefront. It is intended to help you ensure that product data is properly populated. As long as your product meets the pricing and stock requirements, it can be published and made available for purchase regardless of its completeness score. # Create and edit products Create new products or modify existing ones. [Products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/#products) are a specific kind of [content items](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_items/#content-items) that you use to present your offer in the website, including product specification, and pricing. Individual products are instances of [product types](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_product_types/#create-product-types). You can only create or modify products when your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `Product/Edit` permission. > **Note: Quable PIM integration** > > When [Quable is configured as the source of product information](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md), creating and editing products in Ibexa DXP is not available. Products are managed in the Quable back office and are automatically available in Ibexa DXP. You can still [manage prices](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_prices/index.md) and [availability](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_availability_and_stock/index.md) for Quable products in Ibexa DXP. To create a product, depending on how the product type is defined, you [may need to provide](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/#product-completeness) certain pieces of information in their respective [fields](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_model/#fields-and-field-types). You can create products using either manual or bulk method. Bulk method can be used only at the developer level. See [Products](https://doc.ibexa.co/en/5.0/product_catalog/product_api/#products) for a technical guide on how to do this. 1. Click **Product catalog** -> **Products**. 2. If you're adding a new product, click **Create** and skip to step 4. 3. If you're editing an existing product, in the **Category filter** tree, select a category to find your product more quickly. Then click the **Edit** button next to a name of the product item that you want to modify and skip to step 5. ![Products list with action buttons](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/edit_product.png "Products list with action buttons") 4. From their lists, select the language and the product type, and then click the **Add** button. ![Creating a new product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/create_new_product.png "Creating a new product") 5. Fill in or edit content fields of the product, for example, name, specification, and description. Fields marked with an asterisk (\*) are required. ![Editing product information](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/create_product.png "Editing product information") 6. In the Attributes section, define the product's attributes, for example, dimensions, resolution, or capacity. 7. If you're adding a new product, click the **Create** button. If you're editing an existing one, click the **Update** button. After you create a product, you can [add image assets to a product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_assets/index.md), [create variants to the main product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md), [define product prices](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_prices/index.md), [set the available quantity](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_availability_and_stock/index.md) and [classify products into different categories](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_categories/index.md). > **Note: Note** > > Feature availability may differ depending on the specifics of your installation. For in-depth information, see [Products](https://doc.ibexa.co/en/5.0/product_catalog/products/) in Developer Documentation. # Virtual products Virtual products are non-tangible items such as memberships, services, warranties. Virtual product is a special type of a [Product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md). Virtual products are non-tangible items such as memberships, services, warranties. They can be sold individually, or as part of a product bundle. Like physical products, virtual products can have their own [variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md), [assets](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_assets/index.md) or [attributes](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_attributes/index.md). You can also create catalogs from them, check their completeness and set [prices, availability, and stock](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_availability_and_stock/index.md). ## Create virtual product type If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `ProductType/Edit` permission, you can modify product types and add individual attributes or attribute groups. To create a virtual product, first, you have to create a virtual product type. 1. In the left panel, go to **Product catalog** -> **Product Types** and click **Create**. 2. From the drop-down list choose "Virtual" type and click **Add**. ![Creating virtual product type](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/virtual_product_type.png "Creating virtual product type") 3. Fill in basic product type information. 4. Add fields that describe the product by dragging them from the **Field types** area to a section on the left, and then [configure them](https://doc.ibexa.co/projects/userguide/en/latest/content_management/configure_ct_field_settings/index.md). 5. Add attributes by dragging them from the toolbox on the right. 6. Click **Save**. ## Create virtual product Virtual products are created in the same way as physical ones. To create a virtual product, follow the instruction in [Create and edit products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_edit_product/index.md). While creating a product, choose the virtual product type that you have created. ![Creating virtual product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/virtual_product.png "Creating virtual product") ## Virtual products purchase Virtual products don’t require shipment when they're purchased without other physical products. While purchasing a virtual product, you only have to fill in Billing address and select relevant payment method. ![Virtual product purchasing](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/virtual_product_purchase.png "Virtual product purchasing") # Work with product assets Add image assets to products or product variants. When you [create or edit products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_edit_product/index.md), you can add assets in a form of images. Assets can be assigned to the base product, and to one or more of its [variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md). To add assets to a product, in the product's **Assets** tab browse or drag and drop image files from disk, or select an existing image asset from library. ![Adding assets to a product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_assets.png "Adding assets to a product") You can assign assets to product variants by placing them in a collection. A collection corresponds to specific values of attributes and is automatically assigned to the variant or variants that have these attribute values. For example, a "desk" product can have multiple images as assets. You can group them into collections for specific desktop and frame colors, corresponding to variants. ![Product asset collection](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_assets_collections.png "Product asset collection") You can move assets between collections using drag and drop. ![Moving assets between collection with drag and drop](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/collection_dnd.png "Moving assets between collection with drag and drop") # Work with product variants Create multiple variants of one product, based on attributes such as size, color, technical specifications, and others. With product variants you can have multiple versions of one product, differing in some characteristics. Typical example would be a t-shirt in different sizes and colors, or the same model of laptop with different hard disk sizes. To use an [attribute](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_attributes/index.md) to create variants, mark the attribute as **Used for product variants** when you create a [product type](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_product_types/index.md). ![Product type definition with attributes used for variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_type_attr_used_for_variants.png "Product type definition with attributes used for variants") If a product has only one attribute that can be used for variants, you can create variants for this attribute. If a product has more than one such attribute, you can create variants for any combination of attribute values. For example, for a desk that has two top colors: `white` and `oak` and two frame colors: `black` and `grey`, you can create up to four variants: `white/black`, `white/grey`, `oak/black`, and `oak/grey`. ### Generate variants You can generate variants automatically based on the configured attributes. To generate variants: 1. Go to the **Variants** tab in product view and click **Generate variants**. ![Generating product variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_variants_generate.png "Generating product variants") 2. For each attribute listed, select the values you want to create variants for. 3. Confirm with **Generate variants**. You can now see a list of all possible variants for the selected attribute values. ### Delete variants You can delete any generated product variant. To do it, select one or more variants in the list and click the **Delete** button. ![Product variant list with option to delete a variant](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_variants_delete.png "Product variant list with option to delete a variant]") ### Manually create variants If needed, you can manually create any missing variants, including ones you previously deleted. To do this, click **Add** next to the variant list, enter a product code and select attribute values for the new variant. ### Manage variants You can set up product availability separately for each product variant. You can also set up prices per product variant. These new prices override prices set for the main product. If you do not define a price for a variant, the price of the main product is used. # Work with product prices Products can have a base price and custom prices defined per customer group and per currency. [Products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) and product [variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md) can have a base price and multiple custom prices. Prices can differ depending on [customer group](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/manage_customers/index.md) and [currency](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_currencies/index.md) and be applied according to the rules. With these basic price management features, you set up product prices manually. For a more refined price management tool that you can use when managing a store, see [Discounts](https://doc.ibexa.co/projects/userguide/en/latest/commerce/discounts/discounts/index.md). > **Note: Note** > > To set up product prices, your system must have at least one currency enabled. To set a price, navigate to the product's or product variant's **Prices** tab. Here you can see the existing prices for the selected [currency](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/manage_currencies/index.md). Select a currency in the drop-down menu to preview the price and click the **Edit** button to modify it. ![Prices tab](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_price.png "Prices tab") For each product or product variant you can set different prices for different customer groups. Next to the base price you can see the **Global Price rule** defined for this customer group, which is applied to the base price. However, you can also set a **Custom price rule** for this product. If you define it, the global price rule don't apply and the custom price rule is applied directly to the base price. You can preview the resulting price for this product and the given customer group in the **Custom price** field. ![Setting product prices](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/setting_product_price.png "Setting product prices") # Work with availability and stock Products can be made unavailable or available, either in certain quantity or with infinite stock. [Products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) can be unavailable or available, either in certain quantity or with infinite stock. Being available translates into being offered for purchase. You can control the product's availability, and the available stock. When setting stock, you can set the exact number of pieces, or indicate that stock is infinite, for example, for digital, downloadable products. If a product has [variants](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md), you must set availability and stock for each variant separately. ## Set product availability To control the availability and stock, in product or product variant view, go to **Availability** tab. ![Product availability](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_availability_tab.png "Product availability") Then, click **Create** to add availability to a product that doesn't have it, or **Edit** to modify existing availability settings. Use the **Available** switcher to indicate whether the product is currently available in the catalog. You can also set the exact number of products available in stock. Set the availability to **Infinite** if specific stock number is not tracked. You can use it, for example, for digital, downloadable products. ![Setting product availability and stock](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_availability.png "Setting product availability and stock") # Work with catalogs Catalogs allow creating filtered product lists for special purposes, for example, for B2B and B2C uses, for retailers and distributors or for different regions. You can create special catalogs, for example, to differentiate the offering that's presented to B2B and B2C users, retailers and distributors or different regions. ## Catalogs Catalogs are collections of [products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) selected using configurable filters. They're specific to each of your websites or storefronts, which means that they contain products that are presented or sold in a specific website. ![Catalog menu with a sample catalog](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/catalog.png "Catalog menu with a sample catalog") ## Create catalogs To create a catalog: 1. In the left panel, go to **Product catalog** -> **Catalogs** and click **Create**. 2. Enter the name and identifier for the catalog. 3. Select filters that decide which products are included in the catalog. 4. Click **Create**. ![Creating a new catalog](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/catalog_create.png "Creating a new catalog") After you create a catalog, it's in "Draft" status. To make the block available, for example, in page blocks, you must publish it. 1. In the **Catalogs** page, click the name of a catalog that you want to publish. 2. On the catalog details page, the upper right corner, click **Publish**. ### Catalog filters When you create a new catalog, all products are included in it by default. You can narrow down this selection by applying the following filters from the **Add filter** menu: - Category - Created (date when the product was created) - Availability - Code - Price (in selected currency, with the option to set minimum and maximum price) - Type - and additionally, filters based on all configured product attributes ![Adding filters to catalog](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/catalogs_filters.png "Adding filters to catalog") The **Products** section at the bottom of the catalog screen shows a preview of which products fit the current filters. The list is updated automatically when you add or modify filters. You can also remove selected filters there. You can view all products in a catalog in its **Products** tab: ![List of products in a catalog](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/catalogs_product_list.png "List of products in a catalog") ## Copy catalogs You can copy existing catalogs, for example to create a variant version of an offer with slightly differing filters. To do so, in the catalog's view screen click **Copy**. You can then modify the copied catalog (for example, change its name or fine-tine filters), and save the updated version. # Work with product categories You can create a structure of tags that can be assigned to products to help categorize products, to assist visitors in searching. You create, manage and assign categories manually. [Product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) categories are organized into a Category tree, which you can access from the **Product catalog** panel. The **Categories** screen is where you manually create a hierarchy of categories and manage category entries. ![Product category tree](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_categories.png "Product category tree") > **Note: Quable PIM integration** > > When [Quable is configured as the source of product information](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/quable_pim_integration/index.md), product categories are synchronized automatically from Quable product classifications into Ibexa DXP. You can't create or modify categories manually, and can't assign products to categories in Ibexa DXP. To change the category structure, update classifications in the Quable back office. ## Product categories With product categories you can organize products within product catalog and create relationships between them. One of the reasons for applying product categories is assisting visitors in searching for products. Each category can be assigned to multiple products, and each product can belong to multiple categories of different or similar character, for example: - Business Laptops - Windows OS Devices - Stock clearance You can enable the use of product categories, assign products to categories and vice versa, and define your own categories. ## Enable product categories Before you can assign categories to products, make sure that the *Taxonomy Entry Assignment* field is added and set as required in all the [product types](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/product_types/index.md) that define products from product catalog which you want to categorize. The field could be absent if product types were migrated from an older version of Ibexa DXP. Depending on your permissions, you might be able to verify the presence of the field and add the field yourself: 1. In the left panel, click **Product catalog** -> **Product Types** to open a list of available product types. 2. Click the **Edit** icon next to a name of the product type that you want to review. 3. In the **Editing Product Type** modal, check whether the **Field definitions** area contains the **Categories** field of *Taxonomy Entry Assignment* type. 1. If the field is present, click **Delete draft** and skip the remaining steps. 2. If the field is absent, drag and drop the *Taxonomy Entry Assignment* option from the **Field types** area to the **Field definitions** area. 3. Expand the **New field type** that you added and make the following settings: - Set a name for the field, for example, "Product category" - Select the **Required** checkbox - In the **Taxonomy** field, select the "Product categories" taxonomy type 4. Optionally, modify other product type settings as required. 5. To save your changes: - Click **Save** to continue editing. - Click **Save and close** to close the window. You can now add product categories and then create relationships between products and product categories. > **Caution: Duplicate taxonomy entry fields** > > In your product type, you may want to have both product categories and [tags](https://doc.ibexa.co/projects/userguide/en/latest/content_management/taxonomy/taxonomy/index.md) on the list of field definitions. Because tags are assigned per product item, not per field, when working with a product type, you cannot use two *Taxonomy Entry Assignment* fields with the same taxonomy type in one product type. ## Add product category to product category hierarchy Similarly to other items in Ibexa DXP, you add product categories either by clicking the **Create** button, or directly in the product category tree: 1. In the left panel, click **Product catalog** -> **Categories** to navigate to the product category tree. 2. To add a category using the **Create** button, in the category tree, select the category to which you want to add a child category. After the details of the selected category are loaded, click the **Create** button and skip to step 4. 3. To add a category directly in the category tree, click the three dots icon next to the category to which you want to add a child category. In the context menu, click **Add**. 4. In the product category editing modal, make the following settings: - Enter a unique identifier for the product category, for example, "HW_WIN". - Enter a unique name for the product category, "Devices with Windows". - Optionally, change the parent category of the currently edited category: In the **Parent** area, click the **Change path** button. Then, in the **Select parent** modal, select a category from the tree and click **Select parent**. - Click **Save** to save the product category. The newly created category can now be assigned to products. ## Modify product category assignments to products You can create or change product category relationships with products in two ways: either when you edit or create a product item, or when you edit a product category. > **Note: Note** > > Products must be of product type which is [enabled for categorization](#enable-product-categories). ### Assign product categories by editing product details 1. In the left panel, click **Product catalog** -> **Products** to navigate to the product list. 2. To create a new product item, click the **Create** button, select the product types with product categories enabled, and click **Add**. Then skip to step 4. 3. To edit an existing product item, click the **Edit** icon next to a name of the Product item that you want to modify. 4. In the product editing modal, go to the **Product category** area and click the **Select product categories** button. 5. In the pop-up window, select checkboxes next to product categories related with the product. 6. Click **Select** to close the pop-up window. 7. Optionally, modify other product information as required. 8. Click **Create** or **Update** to save your changes. ![Adding product categories](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_category_selection.png "Adding product categories") > **Note: Taxonomy suggestions** > > If the [Taxonomy suggestions](https://doc.ibexa.co/en/5.0/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, instead of manually browsing the product category tree and selecting categories one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant. > > ![Product categories suggested by the AI Assistant](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/taxonomy_suggestions_products.png "Product categories suggested by the AI Assistant") ### Assign products by editing product category details 1. In the left panel, click **Product catalog** -> **Categories** to navigate to the product category tree. 2. In the product category tree, select a category and go to the **Products** tab. 3. To assign products to the current category: 1. Click the **Assign** button. 2. In the content browser, select checkboxes next to products related with the category. 3. Click **Confirm** to confirm the selection. 4. To unassign products from the current category: 1. In the **Products** tab, select checkboxes next to products selected for removal. 2. Click the **Unassign** button ![Related products list](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/product_categories_product_list.png "Related products list") # Product page URLs You can create URL alias name pattern and custom URLs for the Products. Every [product item](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) has a system URL that is automatically generated. It's based on a pattern that combines fields and attributes to build the URL (URL alias name pattern). When you're creating new [product type](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/create_product_types/index.md) you can set up product URL alias name pattern. To do it, fill in all the necessary information, choose the attributes that you want to use in URL alias name pattern, copy their ID, and paste in the **URL alias name pattern** field using following pattern: --(...), then click **Save and close** button. Below you can see an example of URL alias name pattern: ![URL attributes](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/url_attributes.png "URL attributes") Now, you can see new URL alias name pattern in the product type's view. ![URL alias name pattern](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/url_alias_name_pattern.png "URL alias name pattern") ## Product Attributes identifiers Products have their own [attributes](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_attributes/index.md) to define product specification. The following attribute types can be used in URL alias name pattern field: - Checkbox - Color - Integer - Selection - Measurement (single) - Measurement (range) | Type | Returned value | Example | | -------------------- | ---------------------------------------- | ---------------- | | Checkbox | Label of the checkbox is checked | wireless | | Color | Hex code value | 8b0000 | | Integer | Integer | 26 | | Selection | Selected value with configured separator | children-infants | | Measurement (single) | Single value and unit | 256gb | | Measurement (range) | Value unit and minimum/maximum values | 20-25cm | You can use many attributes identifiers and fields identifiers in the URL alias pattern field. Having keyword-rich URLs also improves the product's visibility in search engine results and boosts the page's ranking in search results. ## Create custom URL You can create custom URL for each product. Customized URLs are memorable, help with SEO optimization and reduce bounce rates on the website. It improves the user experience - you can understand what the product is about by reading the link. To do it, follow the steps: 1. In the left panel, go to **Product catalog** -> **Products**. 2. Choose a product from the list. 3. Click on **URL** tab in the product's view. Here you can see both custom URL aliases and system URL. ![URL tab](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/url_tab.png "URL tab") 4. Click **Add new** button. 5. Provide custom URL in "URL" field and set up all necessary settings. ![Creating a custom URL](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/create_custom_url.png "Creating a custom URL") 6. Click **Create**. Now, in the **URL** tab in the product's view, you can see new custom URL for the product. ![Custom URL](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/custom_url.png "Custom URL") You can manage all the product URLs, both system and custom ones: create new and edit or delete existing ones. # Content publishing # Publish content instantly You can instantly publish a newly created content item or save its draft for editing. When you publish a content item, it's given a location ID and placed in the content tree. After you click **Publish**, the content item is validated and if any of the required fields aren't configured, you see a notification. Once the content item passes the validation, it's immediately available to the visitors. Instead of instantly publishing content items, you can also save them, discard changes by deleting the draft, or [publish later](https://doc.ibexa.co/projects/userguide/en/latest/content_management/schedule_publishing/#date-based-publishing). If you're creating a new content item, you can also [send it to review](https://doc.ibexa.co/projects/userguide/en/latest/content_management/workflow_management/editorial_workflow/index.md). All these options are available in the menu when you're in the edit mode. ![Publishing options](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/publishing_options.png "Publishing options") ### Publishing vs. saving Clicking **Save** doesn't immediately publish the content item. Instead, it saves the [new version](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_versions/index.md) of the content as a draft. You can then keep on editing the same content and save it again when needed, or click **Save and close** to close the window. > **Caution: Caution** > > Only selecting **Delete draft** removes the whole draft and all the work you have done on it. A discarded draft is removed instantly, not placed in the Trash, so it can't be restored. Once you leave the editor after saving your draft, you can return to modify it, or create a new draft. To edit an existing draft, [disable the Focus mode](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/#disable-focus-mode), go to this content item's **Versions** tab and click the edit icon in the proper line. When you select **Edit** in a content item that has one or more open drafts, you're asked which draft you want to continue working on. You also have the option to create a new draft based on the currently published version. You cannot edit an unpublished draft created by another user. # Schedule content publication You can schedule publication of content and Page blocks for specific time and date. You can schedule content to be published, revealed or hidden in the future. To do it, use one of the three options: - [Scheduler tab](#scheduler-tab) in any Page block's configuration - [Content Scheduler block](#content-scheduler-block) on a Page - [Publish later option](#date-based-publishing) when editing content ## Scheduler tab (Experience, Commerce) The **Scheduler** tab is available in the configuration of all Page blocks. You can use it to set the date and time when the block becomes visible and when it disappears from a Page. If you configure the reveal and/or hide dates for a Page block, you can then see the scheduled blocks (except for the Content Scheduler) in the calendar. This way you can see what content is planned to be available in the future. ![Schedule tab](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/schedule_tab.png) ## Content Scheduler block (Experience, Commerce) In the Content Scheduler block you can select content items to be displayed at a selected time. For each content item you can choose an airtime - a date and time in the future. At this time the content item becomes visible. The Content Scheduler block has a limit of content items. If the limit is filled and a new content item is displayed, the oldest item disappears from the block. ![Content Scheduler](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/content_scheduler.png) ## Date-based publishing When editing a content item, select **Publish later** in the menu on the right. ![Publish Later button in the menu](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/publish_later.png "Publish Later button in the menu") A **Future publication settings** window is displayed. Choose a date and time for the content publication. If you had planned a future publication date and enter the edit mode of the same content item, you also have a new option in the menu: **Discard publish later**. Use it to remove the previously selected publication date. ![Discard publish later button in the menu](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/discard_publish_date.png "Discard publish later button in the menu") You can also [reschedule or cancel planned publications](#reschedule-or-cancel-publication). To browse all the future events, use the [Calendar widget](#calendar-widget). ## Date-based hiding When your content item is published, you can schedule a date and time for the content to become hidden. To do this, go to the **Content** tab and select **Content structure** or **Media**. Then, navigate to the content item that you want to hide and click **Hide** in the menu. ![Hide content item modal window](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/img/schedule_hiding.png "Hide content item modal window") Once a content item is hidden, it's unavailable on the front page and inactive in the content tree. This change affects the content item in all of its [locations](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/manage_locations_urls/#content-locations). ## Timeline (Experience, Commerce) The timeline in page mode shows all changes that happen to the page in the future. You can use the slider to preview what the page looks like at a given time. Use the button on the right of the time to see a list of all upcoming changes. ![List of upcoming events in the timeline](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/timeline_list.png) ## Calendar widget The calendar widget enables you to view and perform actions on various events. Out of the box, it displays content items and Page blocks scheduled for future publication, but your page administrator can configure custom events. Therefore, the calendar can contain other events, for example, national holidays or important dates. To access the calendar widget, in the **Content Panel**, open the **Calendar** tab. ![Calendar widget](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/calendar_widget.png "Calendar widget") You can switch between different views to see events planned for a certain day, week, or month. You can also use [filters](#calendar-filters) to focus on certain events displayed in the calendar. > **Tip: Tip** > > If the number of events to display in a selected view exceeds the configured limit, some events remain hidden. To view the full list of events, click **Load More**. To access the calendar features, use the following buttons: | Button | Description | | --------------------- | ----------------------------------------------- | | Today button | Display the current day regardless of the view. | | Arrows | Navigate through months, weeks, or days. | | Toggle month/week/day | Switch between month, week, or day view. | | Toggle calendar/list | Switch between the calendar and list view. | ### Calendar filters With numerous events appearing in the calendar widget, you can make the view less cluttered by applying filters. You can filter by the events' type or modified language in all three views (month, week, and day). Access all available filters by clicking **Filters**. ![Viewing filters](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/calendar_widget_apply_filters.png "Viewing calendar filters") To apply filters, select or deselect entities from the **Types** or **Modified language** list. The calendar view refreshes automatically. ### Calendar toolbar The calendar widget toolbar displays events you select and gives you access to actions assigned to them. The available actions appear in the upper-right corner of the toolbar when you select an event. You can select multiple events of the same type and perform bulk actions on them, for example, [reschedule or cancel publication](#reschedule-or-cancel-publication). > **Note: Note** > > Actions available in the toolbar may vary depending on the custom configuration. For details, contact your page administrator. To select, click on all events of the same type you want to add to the toolbar list. ![Calendar widget toolbar](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/selection_action_bar.png "Calendar widget toolbar") ## Reschedule or cancel publication In case of publishable content items (for example, articles), you can change or cancel their planned publication by clicking **Reschedule** or **Cancel publication**. These buttons are available on the **My dashboard** screen, and in the Calendar widget. | Button | Description | | ----------------- | ------------------------------------------------- | | Reschedule button | Reschedule all selected events. | | Discard button | Cancel the future publication of selected events. | #### Reschedule or cancel in the dashboard To reschedule or cancel events with the dashboard, perform the following actions: 1. Open the **My dashboard** screen by clicking the logo in the left-upper corner. 2. In **My content** panel, view all your scheduled content items by clicking **My scheduled content**. 3. From **My future publications**, select all content items to have their publication time rescheduled or cancelled. 4. Using the buttons in the upper-right corner, perform one or both of the following actions: - To change the publication time, click **Reschedule**. In the **Reschedule** modal window, select the new date and click **Confirm date change**. - To cancel publication, click **Cancel publication**. In the modal window, confirm the cancellation by selecting **Cancel publication**. ![Reschedule or cancel with the dashboard](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/reschedule_cancel_dashboard.png "Rescheduling or cancelling with the dashboard") #### Reschedule or cancel in Calendar In the [Calendar widget](#calendar-widget), select all events to have their publication time rescheduled or cancelled. Using the toolbar buttons, perform one of the following actions: - To change the publication time, click **Reschedule**. In the **Reschedule publication** modal window, select the new date and click **Confirm rescheduling**. - To cancel event's publication, click **Cancel publication**. In the modal window, confirm the cancellation by clicking **Cancel publication**. # Image management # Upload and store images Upload images to Ibexa DXP to manage them. > **Note: Note** > > Some options may not be available depending on your configuration and permissions. ## Manage folders By default, uploaded files are stored in the Media root folder of the content tree. If you want to upload them to different location, navigate to the folder you want to upload to. You can also [create additional folders](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/content_tree/content_tree/#add-folders) and sub-folders to further organize your images. ## Add image to create an image asset 1. In the main menu, go to **Content** -> **Media** -> **Images**. 2. In the upper-right corner, click **Create content**. 3. From the available content types, select **Image** and click **Create**. 4. Provide image title and optionally, a description. 5. In the **Image** section, click **Upload file** and from the system browser, select an image. 6. In the **Alternative text** field, provide an alternative description intended for users with vision impairment. > **Note: Use AI to generate alternative text** > > If [AI Actions](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/ai_actions/index.md) have been configured in your application, the **Use AI** button is visible. If you have the required [permissions](https://doc.ibexa.co/en/5.0/permissions/policies/#ai-actions), you can click it to have the alternative text generated automagically. The **Go to AI actions** button can also visible to users with access to the **Admin UI**. By clicking it, you can quickly navigate to [AI actions configuration](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/index.md). ![Generate alternative text](https://doc.ibexa.co/projects/userguide/en/latest/image_management/img/alt_text_use_ai.png) 6. To find images using tags, in the **Tags** field, enter keywords. Tagging image assets helps keep the media library organized and enables searching images by tags in the DAM. 7. Click **Publish**. > **Note: Note** > > The maximum file size and file extension limitations may differ depending on your configuration. ## Edit image assets and images After you upload the image to create an image asset, you can adjust it according to your needs. For detailed instructions on how to edit images, see the [Edit images](https://doc.ibexa.co/projects/userguide/en/latest/image_management/edit_images/index.md). ## Copy, move or hide image assets To learn how to effectively manage image assets, see [Move assets between folders](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/copy_move_hide_content/index.md) section. ## Upload multiple images To upload multiple images and create many image assets, you can use multi-file upload. 1. In the Media section, go to the folder you want to upload to. 2. Go to the **Sub-items** tab and click **Upload**. 3. In the pop-up window, drag and drop files into the **Upload** area or click **Upload file** and select image files from the system browser. ## Add translations If you work with multiple languages and want to use searching by languages in DAM, you can add translations to image assets. You can replace the contents of all the fields that have values in the base language, for example, the description, or the alternative text. To see how to add translations, go to [translate content section](https://doc.ibexa.co/projects/userguide/en/latest/content_management/translate_content/#add-translations). # Edit images Edit images in the Image Editor to flip, crop and select a focal point. You can edit the image asset's properties. You can also edit the image itself with the Image Editor. > **Note: Editing tool availability** > > The editing tools are available when you work in the back office of your application, for example, to: > > - browse the Media root folder of the content tree > - add an image or an image asset to a content item by selecting it from a Content browser or an Image picker > - insert an image into a [Rich Text Field](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#edit-rich-text-fields) ## Edit image asset You can edit the image asset's properties, for example, to provide a different caption for the image, or change the alternative text for the image. To edit an existing image asset, in the back office, the main menu, go to **Content** -> **Media** -> **Images**, choose the image asset that you want to edit and click **Edit**. Here, you can: - Change the name and caption for the image. - Edit the image itself in [Image Editor](#edit-image-in-image-editor). - Change the alternative text, used by screen readers and in SEO. > **Note: Use AI to generate alternative text** > > If AI Actions have been configured in your application, the **Use AI** button is visible. If you have `Action configuration/View` and `Action configuration/Execute` permissions, you can click it to have the alternative text generated automagically. The **Go to AI actions** button can also visible to users with access to the **Admin UI**. By clicking it, you can quickly navigate to [AI actions configuration](https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/index.md). ![Generate alternative text](https://doc.ibexa.co/projects/userguide/en/latest/image_management/img/alt_text_use_ai.png) - Change the keywords assigned to the image. Tagging image assets helps keep the media library organized and enables searching images by tags in the DAM. ### Edit image in Image Editor When you edit the image asset, you can edit the image itself by using the Image Editor that enables: - image cropping - image flipping - setting a point of focus within an image Image Editor is available whenever you see the **Edit** icon on the preview. ![Image Editor icon](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/image_editor_icon.png) #### Flip With the Flip feature you mirror the image along a horizontal or vertical axis. Click either the **Horizontal** or **Vertical** button to flip an image. #### Crop With the Crop feature you can cut the image down to a desired aspect ratio and dimensions. You can either choose one of the preset aspect ratio options (square, vertical or horizontal rectangle, or widescreen), or click **Custom**. After you choose an aspect ratio, a grid appears on the preview. You can then resize the grid to mark an area of the image that you want to be visible. You can also enter the exact width and height values in the **Crop size** area. Click the tick icon to confirm the change or the **X** icon to cancel it and clear the preview. When you confirm the change, the preview refreshes to display a cropped image. > **Note: Saving changes** > > Confirming the crop operation doesn't mean that it has been saved. You must click **Save** to apply the changes to the original image. #### Focal point If your page contains an image that is larger that the current viewport, for example, when a user accesses the page from a mobile phone, you can select a point on the image that the view should focus on. This way, a responsive image can be cropped to fit the viewport, so the area that contains the selected point is always visible. > **Note: Note** > > Cropping to focal point is not automatic. The website's templates must be adapted for this to happen. See [Use focal point](https://doc.ibexa.co/en/5.0/templating/embed_and_list_content/render_images/#use-focal-point) in Developer Documentation for an example of implementing such cropping. Click the **Show point** button to see a target on the preview. Drag the target to a point on the image that you want to focus on. Click the **X** icon to restore the original position of the target. #### Undo changes Click the left or right arrow button to undo or redo the most recent change. Click **Reset image** to restore the original appearance of the image. ![Image Editor: Undo](https://doc.ibexa.co/projects/userguide/en/latest/content_management/img/image_editor_undo.png) #### Save changes Click **Save** to apply your edits to the original image and exit the Image Editor screen. # Search # Search for content Search through all content in the system and filter the results by different criteria. You can enter a search keyword and the application checks all the searchable fields and returns a list of search results that contain the keyword. ![Basic Search](https://doc.ibexa.co/projects/userguide/en/latest/search/img/basic_search.png) Everywhere in the back office, completion suggestions are proposed while you type in the search box. In addition to clicking in the search box, you can also move focus to it using the keyboard shortcut `Ctrl+/` on Windows/Linux, or `Cmd+/` on macOS. - If a suggestion is what you're looking for, to use it, click on it in the suggestion drop-down, or use `down` and `up` keys to highlight it, and then press the `Enter` key. - If no suggestion corresponds to your search, press the `Enter` key or click **View all results**. ![Suggestion drop-down](https://doc.ibexa.co/projects/userguide/en/latest/search/img/suggestion.png) On the results page, if several languages are available, you can select a language to search in at the top of the left **Filters** menu. The results contain content items that are translated into this language. The result list also shows which languages the content item is translated to. By default, the results are sorted by decreasing relevance. By selecting an option from a drop-down menu in the top right corner, you can sort them by name, publication date, or modification date. ![Sorting menu](https://doc.ibexa.co/projects/userguide/en/latest/search/img/sorting_menu.png) The search engine not only displays suggestions, but also supports spell checking. If you misspell a search phrase, the search engine suggests a related, accurate term. ![Spell checking](https://doc.ibexa.co/projects/userguide/en/latest/search/img/spell_checking.png) ## Filtered search Filtered search allows you to filter by: - Language (if more than one language available) - Content type - Modified date - Created date - Creator - Section - Subtree All new or custom content types, sections and languages are automatically added to the drop-down filter lists. Depending on the system configuration, a content item count can be indicated for content type and section filters. Select your filters, then click **Apply** to update the results. Click **Clear** to reset and remove all filters. # Search Engine Optimization SEO can help your content score higher in search results, which leads to greater visibility. Every time users search online, they're presented with a list of results, together with page title and a short summary. Based on this limited information they choose which link to follow. The more your page stands out, the more likely users are to pay you a visit. With Search Engine Optimization (SEO) tool, you can optimize your website for both visitors and search engines. SEO brings in more organic traffic and improves the website's visibility in Search Engines Results Pages (SERPs). It's a core feature of Digital Experience Platform. Additionally, SEO allows you to control the appearance of search results on SERPs, by providing the intended wording for the title, description, or keywords. ## Meta tags `Title`, `Description` and `Keywords` tags are displayed on SERPs. They also help the search engine figure out what the content is about and how high it should rank. A `Canonical` tag is used by the search engine's internal algorithm. After you define the tags for your content, they're rendered as part of the `` section of a web page, from where the search engine intercepts their values. - `Title` is displayed as a prominent heading in the search. You want to make it relevant and attractive for users to click on. It represents the title of the content item that you want to promote. - `Description` appears next to or below the title. Here you tell visitors what the content is about. Your goal is to optimize it for better visibility both on desktop and mobile. It represents a summary of your content item. - `Keywords` can help the search engine position the results. Keywords can be ideas and topics that define what your content is about. - `Canonical URL` tells search engines which copy of content is the original that should appear in search results. It prevents duplicates from competing against each other. Additionally, you can define social media-specific meta tags separately, to fine-tune the message that gets across to each of the platforms. If you fail to use this feature, the default meta tags are used to generate a social media snippet. For more information about SEO, see [Ibexa blog](https://www.ibexa.co/blog-archive/five-useful-seo-techniques-for-ez-platform-developers). # Work with SEO Enable search engine optimization and increase content visibility by defining meta tags. For the Search Engine Optimization (SEO) feature to help you optimize the searchability and visibility of your content, you must enable it first, and then, define the contents of individual tags. To do it, make sure you can [edit content types](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_types/index.md). ## Enable SEO 1. In the left panel, go to **Content** -> **Content types** and select a content type group by clicking its name, for example, **Content**. 2. [Create a new content type](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_types/index.md) or click the edit icon next to the content type that you want to modify. 3. Go to the **SEO** section and switch the **Enable SEO for this content type** toggle. 4. To save your changes, click **Save and close**, or **Save** to continue editing. ![SEO tags](https://doc.ibexa.co/projects/userguide/en/latest/search_engine_optimization/img/SEO_tags.png "SEO configuration") ## Define Meta tags When you edit the content type definition, in the **SEO** section, go to the **Meta tags** area, and provide values for the following meta tags: - **Title** - **Description** - **Keywords** - **Canonical** To learn more about the function of each of the tags, see [Meta tags](https://doc.ibexa.co/projects/userguide/en/latest/search_engine_optimization/seo/#meta-tags). When you populate the SEO fields, you can create patterns using a schema with attributes which correspond to identifiers of fields that make up the content type. As a result, SEO tags are filled in at content item generation phase with specific contents of such fields. For example, if you enter `.<format> - <author>` as a value of the **Title** tag, the search engine returns `Silmarillion. Illustrated edition - J.R.R. Tolkien`. You can also fine-tune the way your content is presented when linked from a social media platform by populating the social media-specific meta tags in the exact same way: fill in fields in the **OpenGraph** and **Twitter** sections with patterns to configure the Facebook and Twitter presentation respectively. ## Preview meta tags of content item You can preview what the actual SEO tags for a specific content item can look like when they're passed to a search engine or social media platform. 1. In content tree, navigate to the content item. 2. On the content item details screen, click the **SEO** tab. 3. Review the contents of the **resolved** fields. ![SEO tab in content item details](https://doc.ibexa.co/projects/userguide/en/latest/search_engine_optimization/img/SEO_tab.png)\` ## Override meta tags of content item When you want a specific content item to appear in search results differently than the other items of a specific content type, you can override the contents of SEO tags. You might want, for example, to add a shout out to the title after the author of content receives a literary prize. 1. In content tree, navigate to the content item, and click the **Edit** button. 2. Go to the **SEO** section and, in relevant fields, replace the patterns that originate from the [content type definition](#define-meta-tags). 3. **Publish** your changes, **Save and close** or **Delete draft** to return to the content tree. You can either use plain text or patterns, like in the case of content types. # Commerce # Commerce Use the Commerce solution to let end-users place orders for products and perform actions related to payment and shipping. Editions: Commerce Ibexa DXP provides a Commerce solution that consists of several modules. You can use them to create a unified and streamlined e-commerce platform. Modules interact with each other, for example, to decrease stock following a sale, reduce prices when the cart reaches a certain value, or cancel shipments and payments when orders are cancelled. The solution complements functionalities provided by the [product catalog](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) offering, and allows you to sell products through the website. With Commerce, you can build your own storefront from a set of generic components, which you can then customize to cover all aspects of the e-commerce experience. Out of the box, Commerce is configured to follow a specific workflow and support a certain number of processing method types, for example, flat rate, free shipping methods, and offline payment methods. Contact your administrator or development team about customization options. For more information, see [Developer Documentation](https://doc.ibexa.co/en/5.0/commerce/commerce/). The following diagram includes statuses and actions that may occur on the order's way along the fulfilment path. ![Order processing workflow](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/commerce_workflow.png "Order processing workflow") From the end-user perspective, once it's properly configured to grant the right permissions to [user roles](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md), the Commerce solution gives store managers control over the whole order fulfilment process, while allowing customers to monitor the progress of their transactions. Once the order is placed, users can interact with it by working with the following back office pages: - [Order management](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/order_management/order_management/): Order management module handles orders and allows managing orders in the system. - [Payment management](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/payment/payment_management/): Payment management module handles payment methods and payments, and allows interacting with them in the system. - [Shipping management](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/shipping_management/shipping_management/): Shipping management module handles shipping methods. - [Discounts](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/discounts/discounts/): Increase conversion and attract customers by offering them products at discounted prices. # Order management Order management module handles orders and allows managing orders in the system. Editions: Commerce The **Order management** module allows users to review order details, track order completion status, and cancel orders that are created when store customers purchase products. Depending on the permissions assigned to your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md), you might be able to track and manage orders placed by all the store customers, or only your own ones. With the back office **Orders** screen, you can search for orders and filter search results. ![Orders list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/order_list.png "Orders list") The **Order management** package interacts with other packages of the system, so that: - when store customers pass the checkout stage, stock is decreased and payment and shipment workflows are initiated - when store customers cancel their orders, the decreased stock is restored and payment and shipment are cancelled - [Work with orders](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/order_management/work_with_orders/): Review order information, change order status. # Work with orders Review order information, change order status. Editions: Commerce In Ibexa DXP, you can view a list of orders and modify their statuses on the **Orders** screen. By default, depending on your permissions, you can access your own orders, or all the orders that exist in the system. ## Filter orders in order list 1. In the left panel, go to **Commerce** -> **Orders**. 2. Narrow down the list of displayed orders in one of the following ways: - search for orders by typing part of customer or company name, or order identifier in the search box - filter orders by selecting one or more filters Available filters are: - Statuses - multiselect list of order statuses, by default: Pending, Processing, Completed, Cancelled > **Note: Order statuses** > > Order statuses visible in the **Status** filter field are defined in the [Order workflow](https://doc.ibexa.co/en/5.0/commerce/order_management/configure_order_management/#configure-order-processing-workflow). - Created - a range of dates between which the order was created - Client type - either B2B or B2C client - Order source - the store from which the order comes - Total value - a range of values that includes the total value of the order, in a selected currency - Currency - the currency in which the order was made ![Order list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/order_list.png) ## View order details To view the details of an order, click its line in the order list. On the order details screen, you can view more information about the order, such as customer, payment, and shipment details. ![Order detail view](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/order_detail_view.png) In the **Items** tab you can see a list of products included in the order. ![Viewing products included in the order](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/order_detail_items.png) The fields have the following meaning: - **Subtotal (net)** - a sum of all product prices without taxes - **Shipping cost** - a net cost of the selected shipping method - **Taxes** - a total value of all taxes, including those that apply to the selected shipping method and the products - **Total value (gross)** - a total value of the order, including all discounts, taxes, and service charges > **Note: Ordering virtual products** > > If the order includes only virtual products then the Shipment and Shipping address sections aren't available. Virtual products don't require shipment when they're the only product in a purchase. ## Change order status If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) includes the `Order/Update` permission, you can change the status of an existing order: confirm it if the order has "Pending" status, or complete it when it's in "Processing" status. With the `Order/Cancel` permission, you can cancel an existing order. > **Note: Canceling orders** > > When you create an order, stocks are reduced for the products on that order. When you cancel an order, the stocks are reverted back to their original values. # Shipping management Shipping management module handles shipping methods. Editions: Commerce Shipping processes are present in almost every e-commerce business. Ibexa DXP comes with a number of storefront and backend features to help users manage shipping. No two businesses are identical, and Ibexa ensures the flexibility that you need to configure shipping methods in a way that is optimal for your business and store customers. If the permissions assigned to your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md) allow, the **Shipping management** module enables you to define and manage shipping methods of different types on the **Shipping methods** screen. ![Shipping methods list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/shipping_methods_list.png "Shipping methods list") The **Shipping management** module interacts with other packages of the system, so that shipment processing is cancelled automatically when the customer cancels their order. - [Work with shipping methods](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/shipping_management/work_with_shipping_methods/): Define new shipping methods or modify existing ones. - [Work with shipments](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/shipping_management/work_with_shipments/): Work with shipments and view shipment details. # Work with shipments Work with shipments and view shipment details. Editions: Commerce In Ibexa DXP, on the **Shipments** screen, you can view a list of shipments and modify their statuses. You can access shipments for your own orders or all the shipments that exist in the system, depending on your permissions. ## View shipment status Each shipment has a status due to the stage it's currently at. Available statuses are: - Pending - Ready to ship - Shipped - Delivered - Cancelled ![Shipment list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/shipment_list.png) > **Note: Shipment statuses** > > Shipment statuses visible in the **Status** filter field are defined in the [Shipment workflow](https://doc.ibexa.co/en/5.0/commerce/shipping_management/configure_shipment/#configure-shipment-workflow). To view shipment status: 1. In the left panel, go to **Commerce** -> **Shipments**. 2. Narrow down the list of displayed shipments in one of the following ways: - search for shipments by typing part of order ID or identifier in the search box - filter shipments by selecting one or more filters ## Filter shipments in shipment list You can use filters to narrow down the list of shipments. Available filters are: - Shipping method - method used for the shipment - Status - shipment status - Created - a range of dates between which the shipment was created - Updated - a range of dates between which shipment status has last changed ![Shipment filters](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/shipment_filters.png) To filter the list, set one of the filters and click `Apply` button. You can also clear all chosen filters - to do it, click `Clear filters`. ## View shipment details To view the details of a shipment, click its line in the shipment list. On the shipment details screen, you can see an overview of the shipment's details. Shipment details include basic information about the shipment, customer details, shipping address, total value, order ID, and the date of the last update. ![Shipment detail view](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/shipment_detail_view.png) ## Change shipment status If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `Shipment/Edit` permission, you can change the status of an existing shipment: - "Pending" -> "Ready to ship" - click **Prepare** button, then click **Change** to confirm. - "Ready to ship" -> "Shipped" - click **Send** button, then click **Change** to confirm. - "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm. # Work with shipping methods Define new shipping methods or modify existing ones. Editions: Commerce If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) includes the `Shipping method/Create` permission, you can create shipping methods. With the `Shipping method/Edit` permission, you can modify existing ones. Shipping methods describe how goods can be shipped to a store customer, with different rates for different geographic locations. Example shipping methods are overnight delivery, self-pickup, or DHL. > **Note: Shipping method limitations** > > By default, you can only create shipping methods of 'Flat rate' and 'Free shipping' type. > > Shipping methods created in legacy Commerce cannot be migrated when you upgrade. You have to define them from scratch. "Flat rate" shipping means delivering goods at a fixed, predefined cost, regardless of the number, and type of items in the cart. ## Create new shipping method 1. In the left panel, go to **Commerce** -> **Shipping methods**, and click **Create**. 2. Select the language for the new shipping method, its type, and region that it applies to. 3. In the next screen provide information about the new shipping method. ![Creating a new shipping method](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/create_new_shipping_method.png) Details about shipping cost differ between shipping methods: - Flat rate requires setting a specific fixed cost for shipping, expressed as net value in a given currency. This value is then displayed during checkout and added to the total order amount when the store customer selects a specific shipping method. - Free shipping requires setting the minimum order value (in a given currency) above which the shipping is free. ![Configuring free shipping](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/free_shipping.png) 4. Toggle the **Availability** switch on, so that store customers can select this shipping method during checkout. 5. Click **Create** to save your changes. ## Edit existing shipping method 1. In the left panel, go to **Commerce** -> **Shipping methods**. ![Shipping methods list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/shipping_methods_list.png) 2. Use the search field and filters to find the shipping method that you intend to edit or delete. 3. Click the **Edit** button next to the method in the list. 4. Edit the necessary details. 5. Click **Update** to save your changes. ## Delete existing shipping method 1. In the left panel, go to **Commerce** -> **Shipping methods**. 2. Use the search field and filters to find the shipping method that you want to delete. 3. Select a box next to its name and click **Delete**. > **Note: Shipping methods for existing orders** > > You cannot delete a shipping method if it's active or if it's used by open orders. You must first deactivate the method that you want to delete by toggling the **Availability** switch off. ## Filter shipping methods 1. In the left panel, go to **Commerce** -> **Shipping methods**. 2. Narrow down the list of displayed shipping methods in one of the following ways: - search for shipping method by typing part of its name or identifier in the search box - filter shipping methods by selecting one or more filters Available filters are: - Method type - method of the shipping - Availability - shipping method availability: Active, Inactive - Region - region that the shipping method applies to 3. Click **Apply** to confirm. # Payment management Payment management module handles payment methods and payments, and allows interacting with them in the system. Editions: Commerce The **Payment management** module allows users to track the status of payments for orders placed by store customers. On the back office **Payments** screen, you can search for payments, filter the search results, and review payment details. Depending on configuration and permissions, you may also be allowed to cancel payments. If the permissions assigned to your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md) allow, you may also have access to the **Payment methods** screen, where you define, enable, or disable offline payment methods. ![Payments list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/payment_list.png "Payments list") The **Payment management** module interacts with other packages of the system, so that payment processing is cancelled automatically when you cancel your order. - [Work with payments](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/payment/work_with_payments/): Review payment information, change payment status. - [Work with payment methods](https://doc.ibexa.co/projects/userguide/en/5.0/commerce/payment/work_with_payment_methods/): Define new payment methods or modify existing ones. # Work with payments Review payment information, change payment status. Editions: Commerce In Ibexa DXP, you can view a list of payments and modify their statuses on the **Payments** screen. By default, depending on your permissions, you can access payments for your own orders, or all the payments that exist in the system. ## Filter payments in payment list 1. In the left panel, go to **Commerce** -> **Payments**. 2. Narrow down the list of displayed payments in one of the following ways: - search for payments by typing part of order ID or identifier in the search box - filter payments by selecting one or more filters Available filters are: - Payment method - method used for the payment - Status - payment status, by default: Pending, Failed, Paid, Cancelled > **Note: Payment statuses** > > Payment statuses visible in the **Status** filter field are defined in the [Payment workflow](https://doc.ibexa.co/en/5.0/commerce/payment/configure_payment/#default-payment-workflow-configuration). - Created - a range of dates between which the payment was created - Updated - a range of dates between which payment status has last changed ![Payment list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/payment_list.png) ## View payment details To view the details of a payment, click its line in the payment list. On the payment details screen, you can view a summary of information about the payment. Payment details include information about the payment method used, total value and current status of the payment. ![Payment detail view](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/payment_detail_view.png) ## Change payment details If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) includes the `Payment/Edit` permission, you can change the status of an existing payment: confirm it if the payment has "Pending" status. # Work with payment methods Define new payment methods or modify existing ones. Editions: Commerce If your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md) has the `Payment method/Create` permission, you can create payment methods. With the `Payment method/Edit` permission, you can modify existing ones. Payment methods describe the way store customers pay for their orders during the checkout process. > **Note: Payment method limitations** > > By default, you can only create payment methods of `Offline` type. If your organization needs other payment method types, contact your administrator or development team about [creating a custom payment method type](https://doc.ibexa.co/en/5.0/commerce/payment/extend_payment/#define-custom-payment-method-type). > > Payment methods created in legacy Commerce cannot be migrated when you upgrade. You have to define them from scratch. ## Create new payment method 1. In the left panel, go to **Commerce** -> **Payment methods**, and click **Create**. 2. Select the language for the new payment method and its type. ![New payment method](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/img/new_payment_method.png) 3. In the next screen provide information about the new payment method. ![Creating a new payment method](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/create_new_payment_method.png) 4. Toggle the **Availability** switch on, so that store customers can select this shipping method during checkout. 5. Click **Create** to save your changes. ## Edit existing payment method 1. In the left panel, go to **Commerce** -> **Payment methods**. ![Payment methods list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/payment_methods_list.png) 2. Use the search field and filters to find the payment method that you want to edit. 3. Click the **Edit** button next to the method in the list. 4. Edit the necessary details. 5. Click **Update** to save your changes. ## Delete existing payment method 1. In the left panel, go to **Commerce** -> **Payment methods**. 2. Use the search field and filters to find the payment method that you want to delete. 3. Select a box next to its name and click **Delete**. > **Note: Payment methods for existing orders** > > You cannot delete a payment method if it's active or if it's used by unpaid orders. You must first deactivate the method that you want to delete by toggling the **Availability** switch off. ## Filter payment methods 1. In the left panel, go to **Commerce** -> **Payment methods**. 2. Narrow down the list of displayed payment methods in one of the following ways: - search for payment method by typing part of its name or identifier in the search box - filter payment methods by selecting one or more filters Available filters are: - Method type - method of the payment - Availability - payment method availability: Active, Inactive 3. Click **Apply** to confirm. # Discounts Increase conversion and attract customers by offering them products at discounted prices. Editions: Commerce Discounts help store managers improve stock rotation, increase customer attachment or invite new customers, by offering reductions of prices on all or selected products, either at catalog or cart level. ![Cart with discount](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discount_cart.png) Depending on the permissions assigned to your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permissions_and_users/index.md), you might be able to view existing discounts or define new ones to shape the pricing policy of your store. For example, you can create time-limited offers on selected products, ones that apply only to specified regions, currencies, products or customers, or reward your newsletter subscribers with special discount codes. ### Interaction with other modules The **Discounts** module interacts with other parts of the system, so that store customers can: - in the product catalog, see base prices of products together with prices reduced according to active catalog discounts - in the cart, see prices reduced according to catalog and/or cart discounts, apply discount codes, and observe as prices change when various cart discount conditions are met - at checkout, see a total value of all applied discounts and prices reduced as a result of those discounts For more information about discounts, see [Work with discounts](https://doc.ibexa.co/projects/userguide/en/latest/commerce/discounts/work_with_discounts/index.md). # Work with discounts Create and edit discounts, toggle discount status. Editions: Commerce In Ibexa DXP, on the **Discounts** screen, you can either view a list of discounts, or update existing discounts and create new ones depending on permissions assigned to your [user role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md). ## View discount information in discounts list 1. In the left panel, go to **Commerce** -> **Discounts**. Here, you can see a list of discounts, together with information about their validity period, status, type, and their authors. 2. Narrow down the list of displayed discounts in one of the following ways: - search for a discount by typing in a part of its name or identifier in the search field - filter discounts by selecting one or more of the following filters: - **Discount type**: applicable to catalog or cart products - **Status**: active, inactive or disabled - **Created**: start and end of date range within which the discount was created - **Validity period**: start and end of date range within which the discount is in force ![Discount filters](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discount_filters.png) 3. Click **Apply** to confirm your choices. 4. To clear all the filters, click **Clear filters**. ### Instantly disable discount When working with discounts it may happen that a discount has been created or enabled in error and you notice that it has negative impact on your business. To disable the offending discount, find it in the discount list and, in its line, click the **Disable** icon. ![Discount filters](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discount_disable_icon.png) ### View discount details To view the details of a discount, click its line in the discount list. On the discount details screen, you can see an overview of the discount's details. Discount details include basic information about the discount: - validity period and value of the discount - region and currency that the discount applies to - whether the discount applies to all customers or a selected customer group, - whether any conditions apply ![Discount detail view](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discount_detail_view.png) On other tabs within this screen you can see: - products subject to the discount - users who have authored or modified the discount - translations created for the discount ### Add translations If your store supports multiple languages and you want different discount names and/or descriptions to appear to customers from different markets, while [viewing discount details](#view-discount-details), you can go to the **Translations** tab and [add translations](https://doc.ibexa.co/projects/userguide/en/latest/content_management/translate_content/#add-translations). ## Create new discount When you create discounts, you must first decide whether they apply to all [products](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) from the catalog, or the products that the customer has put into their cart. You are then taken through a series of steps, where you define the discount, for example, decide if it applies to selected [customer groups](https://doc.ibexa.co/en/5.0/users/customer_groups/) and specific products. Cart discount applicability can be further limited by setting a number of conditions, such as: - a number of products in the cart - total purchase value - a discount code > **Note: Navigating through the steps** > > When you define discount details, you can go back to change your choices. To do it, click a step header at the top of the screen. > > ![Discount creator steps](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discount_creator_headers.png) 1. In the left panel, go to **Commerce** -> **Discounts**, and click **Create**. 2. Select whether the discount applies to catalog or cart products and the discount's type. Choose **Fixed amount** to deduct a specific amount of money from the base price of the product, or **Percentage** to calculate the deducted amount based on a specific percent value. ![New discount](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/new_discount.png) 3. In the **General properties** screen, provide general information about the new discount: 1. In the **Global properties** area, provide an internal name of the discount and set the validity period. Toggle the **Permanent discount** on to make the discount valid until you manually disable it. 2. Then, select discount priority to help the system choose between discounts to apply when calculating the final price. > **Note: Only one discount at a time** > > When two or more discounts could be applied to the base price of the product, the system uses only one, based on a number of rules. For example, cart discounts surpass catalog discounts. > > For more information, see [the product guide](https://doc.ibexa.co/en/5.0/discounts/discounts_guide/#discounts-priority). 3. If your store supports multiple markets, you can select a region that the discount applies to. 4. If you are creating a fixed-amount discount, select a currency of the discount. ![Creating a new discount](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/create_new_discount.png) 1. In the **Promotion information** area, provide a name and description of the promotional campaign, as they should be shown to customers. ![Adding information about the promotion](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discounts_promo_info.png) 1. Click **Next** to go to the next screen. 4. In the **Target group** screen, select customers that the new discount is targeted at. You can choose everyone, or select one or more customer groups. ![Customer selection](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discounts_select_customers.png) 5. In the **Products** screen, select products that the discount applies to. You can choose between: - all products from the catalog, for example, to clear stock before the end of year - products from a specific category, for example, promotional gadgets for company partners - specific products or even product variants, to activate slow-moving inventory In the latter case, you select products by using a Product picker, where you can use search and filters to pinpoint the exact product or product variant that you want the discount to apply to. ![Product picker](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/product_picker.png) 6. If you are creating a cart discount, in the **Conditions** screen, you can set the conditions that limit the discount's availability to customers who have: - added to cart no less than a specific number of certain items - added products to a cart for no less than a specified total value - entered a specified discount code If you set the discount code, you can set the number of times that the code can be used: - by a certain customer - in total, by all customers ![Cart discount conditions](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/cart_discount_conditions.png) 7. In the **Discount value** screen, if you are creating a percentage-based discount, in **Customer gets discount value**, enter a percent value that the system uses to calculate the amount deducted from the base price of the product. Otherwise, enter a monetary value to be deducted from the base price. 8. In the **Summary** screen, review the details of the discount that you are creating, and click **Save and close** to save the discount. Depending on the settings, you may see a warning message. ![Discount summary screen notice](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discounts_summary_notice.png) ## Edit existing discount You may find that an existing discount needs to be modified, for example, to change its validity period or target group. 1. In the left panel, go to **Commerce** -> **Discounts**. ![Discounts list](https://doc.ibexa.co/projects/userguide/en/latest/commerce/img/discount_list.png) 2. Use the search field and filters to find the discount that you want to edit. 3. Click the **Edit** button next to the discount in the list. 4. Edit the necessary details as described in [Create new discount](#create-new-discount). 5. **Save and close** to save your changes. ## Delete existing discount When there are too many discounts in the system, you may want to delete historic, unused ones. You can only delete disabled discounts. 1. In the left panel, go to **Commerce** -> **Discounts**. 2. Use the search field and filters to find the discount that you want to delete. 3. If the discount that you want to delete is not disabled, use the **Disable** icon to [disable it](#instantly-disable-discount). 4. Select a box next to the discount's name and click **Delete**. # Recommendations # Recommendation block reference Recommendation Page Builder blocks - Raptor integration. Editions: Experience The [Raptor](https://www.raptorservices.com/) integration add-on introduces a set of recommendation blocks. These blocks are available in [Page Builder](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_pages/#page-builder-interface) and can be configured to control their behavior and output. ![Recommendation blocks](https://doc.ibexa.co/projects/userguide/en/latest/recommendations/raptor_integration/img/recommendation_blocks.png) Each recommendation block corresponds to a specific Raptor module. You can configure it in the [Raptor Control Panel](https://controlpanel.raptorsmartadvisor.com/) where parameters and settings can be modified. ![Raptor module](https://doc.ibexa.co/projects/userguide/en/latest/recommendations/raptor_integration/img/raptor_module.png) In Page Builder, only the required parameters for each block can be configured. Additional, optional settings are available through the **Go to advanced settings in Raptor** link. It redirects to the respective module configuration in the Raptor Control Panel, where these settings can be adjusted and saved. ![Advanced settings](https://doc.ibexa.co/projects/userguide/en/latest/recommendations/raptor_integration/img/advanced_settings.png) Raptor recommendations can be added to a landing page by using blocks that belong to the following categories: ## Recommendations: Content The following blocks can be used to present content recommendations: | Block | Description | | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | [Content that has been seen along with the item category](#content-that-has-been-seen-along-with-the-item-category-block) | Displays content frequently viewed together with items from the same category. | | [Items associated with the given Content](#items-associated-with-the-given-content-block) | Generates a list of complementary and relevant products that customers often view with a given content. | | [Merchandising content sorted by personal preferences and popularity](#merchandising-content-sorted-by-personal-preferences-and-popularity) | Sorts merchandising content by personal preferences and popularity. | | [Most popular content](#most-popular-content-block) | Highlights the most frequently viewed content. | | [Other customers have also seen this content](#other-customers-have-also-seen-this-content-block) | Displays content viewed by other users with similar behavior. | | [Personalized content recommendations](#personalized-content-recommendations-block) | Provides personalized content recommendations based on user behavior and preferences. | | [User's content history](#users-content-history-block) | Compiles either a chronological list of recent interacted content or a list of most interacted content while the user is browsing. | ### Content that has been seen along with the item category block Shows content that is often viewed together with items in the same category. Helps users discover related content. This block uses the [GetContentBasedOnProductCategoryWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetContentBasedOnProductCategoryWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Product category** - Select product category. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ### Items associated with the given Content block Generates a list of complementary and relevant products that customers often view with a given content. Increases average visits on products to increase the average order value. This block uses the [GetItemsBasedOnContentWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetItemsBasedOnContentWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Select content for recommendations (optional)** - Choose content to show associated products for. Leave empty to use current page content. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ### Merchandising content sorted by personal preferences and popularity Uses merchandising content and sorts it by personal preferences and popularity. Gives better control over recommendations while keeping content relevant to each customer. This block uses the [GetMerchandisingContentWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetMerchandisingContentWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **FeedID** - Enter an identifier of the Feed. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ### Most popular content block Highlights the most trending or popular content that is most frequently viewed by users across the website. It helps identify popular and relevant content items. This block uses the [GetPopularContentWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPopularContentWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ### Other customers have also seen this content block Highlights content viewed by other users with similar behavior. Usually applied on the content page, returns content that is often viewed together with the given content. It increases the engagement of the customers by helping identify related and relevant content. This block uses the [GetSimilarContentWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetSimilarContentWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Select content for recommendations** - Select content to be used for recommendations. This content is used as the basis for recommendations, allowing Raptor to suggest similar or related items. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ### Personalized content recommendations block Generates complementary, personalized content tailored to each user based on their behavior and preferences. Increases relevance and engagement through personalized suggestions. This block uses the [GetUserContentRecommendationsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserContentRecommendationsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ### User's content history block Compiles either a chronological list of recent interacted content or a list of most interacted content while the user is browsing on your site. This block uses the [GetUserContentHistoryWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserContentHistoryWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ## Recommendations: Product The following blocks can be used to display product suggestions based on visitors’ browsing history: | Block | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | [Items of Customized Feeds sorted by personal preferences and popularity or trendiness](#items-of-customized-feeds-sorted-by-personal-preferences-and-popularity-or-trendiness) | Sorts Customized Feeds items using preferences, popularity, and trends. | | [Most popular products](#most-popular-products-block) | Presents trending and highly popular products. | | [Most popular products in category](#most-popular-products-in-category-block) | Highlights products that are most popular in the category. | | [Other customers have also seen](#other-customers-have-also-seen-block) | Shows products also viewed by other customers. | ### Items of Customized Feeds sorted by personal preferences and popularity or trendiness Uses items from Customized Feeds and sorts them based on user preferences, popularity, and current trends. Helps customers discover more relevant content and enhances the overall customer experience. This block uses the [GetMerchandisingItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetMerchandisingItemsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **FeedID** - Enter an identifier of the Feed. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. ### Most popular products block Presents products that are currently trending and widely popular among users. Its behavior is defined by the calculation type, interaction type, and aggregation period. Helps quickly identify top-performing and popular items. This block uses the [GetPopularItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPopularItemsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. ### Most popular products in category block Displays the most popular products within a selected category. Its behavior is defined by the interaction type and aggregation period. Helps identify the most popular items within a specific category. This block uses the [GetPopularItemsInCategoryWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPopularItemsInCategoryWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Product category** - Select product category. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. ### Other customers have also seen block Shows products viewed by users with similar behavior. Usually applied on the product page, returns items that are often viewed together with the given product. Enhances user experience by suggesting related products. This block uses the [GetSimilarItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetSimilarItemsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Product code** - Enter a product code to be used as a base product or select the base product from the Product catalog. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. ## Recommendations: Commerce The following blocks can be used to show recommendations based on visitors purchase history (buy and basket events): | Block | Description | | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | [Other customers have also purchased](#other-customers-have-also-purchased-block) | Displays items purchased by other customers who bought the same product. | | [The Personal Shopping Assistant](#the-personal-shopping-assistant-block) | Assists users by suggesting relevant products in real time based on their activity. | | [The Personal Shopping Assistant (additional sales)](#the-personal-shopping-assistant-additional-sales-block) | Encourages additional purchases by suggesting complementary items. | | [The Personal Shopping Assistant (conversion)](#the-personal-shopping-assistant-conversion-block) | Helps users discover better product matches through recommendations. | | [User's item history](#users-item-history-block) | Displays the user’s item history or current basket, sorted by recent or top items. | ### Other customers have also purchased block Suggests products commonly bought together. Helps users find related products to encourage additional purchases. This block uses the [GetPIMRelatedItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPIMRelatedItemsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Product code** - Enter a product code to be used as a base product or select the base product from the Product catalog. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. ### The Personal Shopping Assistant block Provides real-time product recommendations based on user behavior. The web personal shopping assistant recommends items at each step of the customer journey, with a short-term focus. It helps users discover relevant items while browsing by providing personalized recommendations based on their current behavior. This block uses the [GetUserItemRecommendationsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserItemRecommendationsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Product (optional)** - Add or select base product. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. ### The Personal Shopping Assistant (additional sales) block Encourages users to purchase additional products. It offers complementary cross-selling at every stage of the customer journey, increasing the overall value of the sale. This block uses the [GetUserCrossSellingItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserCrossSellingItemsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. ### The Personal Shopping Assistant (conversion) block Guides users to the right product using similar product recommendations. This module suggests items based on user actions, helping them explore the product assortment and discover alternatives. It improves product fit and engagement. This block uses the [GetUserLookAlikeItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserLookAlikeItemsWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. ### User's item history block Shows the user’s past or current basket items, sorted by recent activity or top items. Makes it easier to find and review previously viewed or added products. This module can be configured to return recently viewed items, most interacted items, or items currently in the basket. This block uses the [GetUserItemHistoryWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserItemHistoryWeb) Raptor recommendation strategy. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. - **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. - **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. Toggle the **Show only available items** option on to display only products that are currently in stock. > **Tip: Tip** > > For a list of all blocks available in Page Builder, see [Block reference](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/index.md). # Ibexa Engage # Ibexa Engage Use Ibexa Engage to engage audiences and collect valuable data. Ibexa Engage is a data collection tool. It gives you the ability to use the [Qualifio](https://qualifio.com/) tools to engage your audiences. You can use interactive content to build relationships and collect important data, for example, a list of recent orders, or personal information about customers. ## Request access To use Ibexa Engage, you must make arrangements with Ibexa to define the initial configuration, and then get and set up a user account. 1. On the left menu panel, go to **Ibexa Engage**. 2. On the left panel, go to **Ibexa Engage**. 3. On the welcome page, provide the required information: - First and last name - Email address 4. Accept **Terms and Conditions**, and then click **Send request**. ![Welcome page - form](https://doc.ibexa.co/projects/userguide/en/latest/ibexa_engage/img/welcome_page_form.png "Welcome page - form") Ibexa team creates the user account and provides you with its details. An invitation link is sent during the setup process. Once the registration and configuration process is completed, the welcome page displays information about campaign tools available with Ibexa Engage and a link to [Qualifio documentation](https://support.qualifio.com/hc/en-us/categories/202280638-Campaigns) where you can get information about creating and managing campaigns. ![Welcome page - active account](https://doc.ibexa.co/projects/userguide/en/latest/ibexa_engage/img/welcome_page_activated.png "Welcome page - active account") Click the **Manage campaigns in Qualifio** button to open a Qualifio page, where you can create and manage campaigns. ![Qualifio Manager](https://doc.ibexa.co/projects/userguide/en/latest/ibexa_engage/img/qualifio_manager.png "Qualifio Manager - campaign list") ## Campaign A campaign is a set of different concepts, grouped into steps, and open to configuration. You can use a campaign to interact with viewers, boost ad impressions, or gather cookies from targeted audiences. Campaign can contain elements like a welcome screen, a form step, an interaction element, or an exit screen. You can use Qualifio's existing templates and interactive elements, such as quizzes, pools, and forms, to create visually appealing, customized campaigns. You can also configure the backgrounds, themes, or designs, and set up a specific time frame for each campaign. Each campaign comes with a unique ID - string of numbers, that the platform automatically defines during the creation of campaign. Campaign ID is a reference to the campaign in the applications, services and data connections. There are two types of campaigns: - **Anonymous** - engages with the audience, increases the advertising impressions, or collects cookies of personalized audiences. - **Identified** - gathers information about the user who fills out an identification form. ## Publication channel Every campaign includes at least one publication channel, which you can choose from the three options the platform offers: - **Widget/iframe** - uses a JavaScript code or an HTML iframe from Qualifio. Additionally, you can use oEmbed, Facebook Instant articles, and AMP technologies to publish iframes. You need to manually paste the code into your website or CMS. - **Minisite** - uses a unique URL from Qualifio that hosts the campaign. This URL points to your subdomain. - **Mobile** - uses a link from Qualifio to integrate a campaign that is optimized for mobile usage. > **Note: Note** > > By default, every type of publication channel is responsive and compatible with all mobile devices. ## Work with campaigns You can create, configure, and manage campaigns with [Qualifio Engage](https://developers.qualifio.com/docs/engage/). To access the Qualifio Manager page and create or manage campaigns, click the **Manage campaigns in Qualifio** button under the **Ibexa Engage** menu. To display your campaign on the website, use one of the available tools - Campaign block or Campaign custom tag. For more information about creating and managing campaigns, see [Qualifio Engage documentation](https://support.qualifio.com/hc/en-us/categories/202280638-Qualifio-Engage). ### Campaign block To promote your campaign, you can add a [Campaign block](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/#campaign-block) to a page in Page Builder. In the block's settings, you can select a campaign that you want to display from a drop-down list. This list includes all campaigns available on user's Qualifio account which are active or scheduled to launch in the future. You can set the dimensions of the field in which the campaign is displayed. To do it, insert width and height values in the proper fields. If size fields are blank, the system sets default template values. It's recommended to adjust them for better results. ![Campaign block](https://doc.ibexa.co/projects/userguide/en/latest/ibexa_engage/img/campaign_block.png "Campaign block") ### Campaign custom tag You can embed a campaign within the [Rich Text field](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_content_items/#edit-rich-text-fields) by using a Campaign custom tag. To do it, insert **Campaign** content item in the Rich Text Field and choose campaign from the drop-down list. This list includes all campaigns available on user's Qualifio account which are active or scheduled to launch in the future. You can set the dimensions of the field in which the campaign is displayed. To do it, select units, and provide width and height values in the proper fields. If size fields are blank, the system sets default template values. It's recommended to adjust them for better results. ![Campaign custom tag](https://doc.ibexa.co/projects/userguide/en/latest/ibexa_engage/img/campaign_custom_tag.png "Campaign custom tag") # DAM # Ibexa DAM DAM module interface for uploading and managing image assets. Editions: Headless Digital Asset Management is a platform dedicated to editors. It enables storing in central location, organizing, distributing, and sharing media assets across many channels. Ibexa DAM image picker is developed to work with any web browser that supports modern standards. The minimum screen resolution is 1366 x 768. List of supported web browsers: - Mozilla® Firefox® most recent stable version (recommended) - Google Chrome™ most recent stable version (recommended) - Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop and tablet - Apple® Safari® most recent stable version, desktop and tablet ## View modes The main window is available in two display versions: grid and list view. To change the view mode, in the upper-right corner, click **View** and select the view you need. ### Grid view Grid view contains image preview, file format, and image size. ### List view List view contains a thumbnail, title, format, size, dimensions, creation, and update date. ### Sorting You can sort image assets by alphabetical order or by the creation date. To sort image assets, in the upper-right corner, click **Date** and select the sorting method you need. ## Search assets ### Keyword search The search option allows to find image assets using a word or phrase. To use it, in the upper part of the screen, click the **Search** field. Enter a search keyword. The platform searches assets for matches based on the keyword, including file title. ### Filter by attributes With filtering by attributes, you can narrow search results to the following attributes: - language - format - file size - orientation - dimensions - tags (this filter is available only when image assets have tags assigned to) - date of creation To use it, in the right-side panel select attributes and click the **Apply** button. You can combine searches by all types of filtering: keyword search and attributes filter. > **Note: Search engine support** > > Filtering works only when Ibexa uses `solr` or `elasticsearch` search engine. Legacy Search Engine (LSE) isn't supported. ### Navigation Assets are organized and stored in folders. The folder structure serves as another option for filtering assets. To navigate through folders, go to left-side panel **Folders**, and in the folders tree view, click folder you want to open. > **Note: Note** > > Filtering by attribues and folders is complimentary, it means you have to use these two methods at once to get search results. ### Insert images To insert an image asset into the HTML editor, find the image with search options, or manually locate the asset in the folder. Next, click the image thumbnail. The selected item is marked with a red dot in the upper-left corner. To confirm the selection, in the bottom toolbar, click **Insert**. You can only select one image at a time. To deselect the image, click the thumbnail again. # Customer management # Customer management Customer management allows you to manage and view accounts for customers and organizations in your system, as well as create customer portals and allows for company self-registration. Customer management allows you to manage and view accounts for customers and organizations in your system, as well as create customer portals and allow for company self-registration. - [Customer Portal account](https://doc.ibexa.co/projects/userguide/en/5.0/customer_management/customer_portal/): Customer Portal allows your clients to create and manage business account for their company. - [Create and edit Customer Portal](https://doc.ibexa.co/projects/userguide/en/5.0/customer_management/build_customer_portal/): Use Page Builder to create and edit a Customer Portal. - [Customer management](https://doc.ibexa.co/projects/userguide/en/5.0/customer_management/manage_customers/): You can manage and view customers and organizations' accounts in your system, including their web store activities such as orders. - [Company self-registration](https://doc.ibexa.co/projects/userguide/en/5.0/customer_management/company_self_registration/): A prospective buyer can apply to create a company account on a seller's website. # Customer Portal account Customer Portal allows your clients to create and manage business account for their company. Editions: Experience If you represent a company that uses a business partner's Ibexa DXP instance, Customer Portal allows you to create and manage your business account. With this feature, you can edit your organization information, invite and view members and check your order history. ![Customer Portal Dashboard](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_dashboard_customer_portal.png) To access Customer Portal follow this link `<yourdomain>/corporate/login` and log in to your business account. In the dashboard, you can find a sales representative of your company and a brief summary of your order history. For a detailed list of your order history, go to **Pending Order** and **Past Orders** sections. ## Manage members To view and manage members of your company, go to the **Members** section. There you can: - change the status of each member, cannot be performed on logged-in users - change their role - edit their basic information ![List of members](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_members_portal.png) To invite new members to your organization, select **Invite members**. Then, in a pop-up window, fill out email addresses one by one, or use drag and drop to upload a file with a list of emails. Assign a role to each new member of your team from a drop-down list. Click **Send** to send out invitation emails. ![Invite members](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_invite_members_portal.png) Invited users then receive an email message with a registration link. With it, they can register and create their account in the Customer Portal. In the **Invitation** tab, you can find a list of all invitations, registration links and the option to re-send invitations, if needed. ![List of invitations](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_invitations_list_portal.png) ## Address book If you want to add a new shipping address or change the default one, you can do it in the **Address Book** section. ![Address book](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_address_book_portal.png) # Create and edit Customer Portal Use Page Builder to create and edit a Customer Portal. Editions: Experience To create and edit a Customer Portal with Page Builder, you need to first set it up in configuration. For detailed instructions on how to do it, go to [Create Customer Portal](https://doc.ibexa.co/en/5.0/customer_management/cp_page_builder/). The Customer Portal creation and edition are based on Page Builder and work on the same principles. If you're unfamiliar with how Page Builder works, see [Create and edit Pages](https://doc.ibexa.co/projects/userguide/en/latest/content_management/create_edit_pages/index.md). ## Create Customer Portal To create a new Customer Portal, go to **Content** and from the menu select **Content structure**. There, navigate to the root folder for your Customer Portals. If you don't have one, you can add it yourself. Remember to specify its `location_id` in the configuration, you can find it under **Technical details**. For more information, see [Configure Page Builder access to Customer Portal](https://doc.ibexa.co/en/5.0/customer_management/cp_page_builder/#configure-page-builder-access-to-customer-portal). Inside a root folder you can select **Create content** from the right-side toolbar. On the list of content items, you can see two possibilities: **Customer Portal** and **Customer Portal Page**. ![Create content tab](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_portal_vs_page.png) The first one is a container for your Customer Portal pages (this is not a root folder), and the second one represents the actual page. It's recommended to use Customer Portal containers to divide and store your portal pages. If your project requires it, the Customer Portal containers can also be defined as root folders in the configuration. First, select **Customer Portal** and name it appropriately. Next, navigate to the newly added container and create **Customer Portal Page**. ![Customer Portal container](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_folder_for_portals.png) In the **Page creation** box, you should see the Customer Portal layout where you can add dedicated Customer Portal block, Sales Representative, or choose from selection of blocks available to your Ibexa DXP version. For a list of blocks available out of the box, see [Block reference](https://doc.ibexa.co/projects/userguide/en/latest/content_management/block_reference/index.md). ![Page Builder view](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_page_builder.png) If provided ready-to-use Page blocks aren't sufficient, you can [add your own blocks](https://doc.ibexa.co/en/5.0/content_management/pages/create_custom_page_block/). Before you publish or save the Customer Portal page, edit its title and description in the field view, you can find it in the top toolbar on the left side. If you're ready to publish the Customer Portal page, click **Publish** in the top right corner. You can also save it as a draft, even if some required fields aren't filled in. To do it, click **Save draft**. ## Add multiple pages You can have multiple Customer Portal pages available in one Customer Portal by adding them under one Customer Portal container. If company members have sufficient `content/read` policies and have the portal assigned to their customer group, they can see the changes in the left menu. ![Multiple pages in one portal](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_multiple_pages.png) You can manipulate the order of pages in a menu by assigning priority to them in the **Customer Portal** container under **View**->**Sub-items**. ![Assigning page priority](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_page_priority.png) ## Grant permissions Company members need to have the following permissions to be able to see custom Customer Portals: - `user/login` to `custom_portal` SiteAccess - `content/read` to selected Customer Portals ![Customer Portal permissions](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_permissions.png) If members of the company don't have sufficient permissions for any Customer Portal, they're transferred to the default Customer Portal view. > **Note: Note** > > Customer Portal is only available to users that are members of the company. Even if a user has all sufficient permissions but is not a member of a company, they cannot see the Customer Portal. Customer Portal must also be assigned to the company's Customer Group. To learn more see, [assigning portals to Customer Groups](https://doc.ibexa.co/en/5.0/customer_management/cp_page_builder/#assign-portal-to-customer-group). # Customer management You can manage and view customers and organizations' accounts in your system, including their web store activities such as orders. Editions: Experience In the back office, you can manage members of your team, customers and organizations' accounts in your system, including their web store activities such as orders. ## Create new company To create a new company, go to **Customers** -> **Companies** section. There you can view a list of companies you have access to, you can also edit them or create a new one by selecting **Create** button in the top right corner. ![Companies section](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_companies_section_back_office.png) To create a new company, you need to provide: - name - tax ID - customer group - sales representative - billing address Optionally, you can add a website and other contact details. ![Create a new company account](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_create_company_back_office.png) ## Manage company Companies can be managed from the back office in the **Customers** -> **Companies** section. Each company has its own profile where you can find: - summary with basic information and order history - company profile with billing information and contact person - list of members and pending invitations - address book with multiple shipping addresses ![Company profile in the back office](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_company_profile_back_office.png) From there, you can edit the company information, invite members, manage their roles, and edit their basic information. You can also add members to a team from existing pool of users. The Contact Person in the company has to be a member of that company. ![Add Contact Person](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_contact_person_back_office.png) ### Admin Panel You can also manage companies from **Admin** in the left menu. There, in the **Corporate** section, you can find a list of members, billing addresses and technical details regarding the organization such as visibility, IDs, or relations. You can manage companies information, activate, deactivate members, and change their personal information. Logged-in users cannot be deactivated. ![Corporate back office](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_admin_company_view.png) In the **Roles** section, you can define policies for each user group, for example, a company buyer. You can also set up policies for every user who has a business account by editing a **Corporate Access** role. > **Caution: Warning** > > Do not remove any policies from the **Corporate Access** role, the proper behaviour of business accounts depends on them. ## Invite members To invite other members to the organization, go to **Customers** -> **Companies** -> Select your company -> **Invitations**. ![Invite members from the back office](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_invitations_back_office.png) There, you can find a list of all invitations, copy their registration links and re-send the invitation emails. To invite new members to the company, select **Invite member**. ![Invite members from the Customer Portal](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_invite_members_portal.png) Then, in a pop-up window fill out email addresses one by one, or use drag and drop to upload a file with a list of emails. You also have to assign a role to each new member from a drop-down list. Click **Send** to send out invitations. Invited users receive an email message with a registration link. With it, they can register and create their account in [the Customer Portal](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/customer_portal/index.md). ![Register in Customer Portal](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_register_account_portal.png) # Company self-registration A prospective buyer can apply to create a company account on a seller's website. Editions: Experience Self-registration allows your business customers to take charge and apply for a business account on your website by themselves. The application is not approved automatically, it has to go through the approval process in the back office. If it's accepted, the business partner receives an invitation link to the Customer Portal, where they can set up their team and manage their account. ## Submitting application Potential business partners need to fill in an application form to apply for a company account under this link: `<yourdomain>/corporate/customer-portal/register` They need to provide their basic information, contact information and billing address to submit an application. ![Company self-registration](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_self_registration.png) ## Application approval The application then goes through an approval process in the back office. To see a list of pending applications, go to **Customers** -> **Applications**. There you can edit them or check their current status. ![List of applications](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_applications_list.png) Each application can be either edited, approved, rejected, or put on hold. Applications with status reject and on hold remain on the list for future reference. Accepted ones move to **Customers** -> **Companies** section. ![Application](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_application.png) If you decide to approve a business partner's application, you need to specify its sales representative and a customer group. If you cannot see sales representatives, you need to go to **Admin** -> **Users** and add them under a **Sales rep** group before approval. Follow the same procedure with a customer group, it can be set up in **Product catalog** -> **Customer Groups**. ![Application approval](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/img/cp_approving_application.png) Finally, the invitation link is sent back to the applier to finish the registration process and give them access to the [Customer Portal](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/customer_portal/index.md). Application is moved to **Customers** -> **Companies** section and the company is created with "Active" status. From there, you can manage the company and resend an invitation link if needed. For more information on managing companies in the back office, see [Customer management documentation](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/manage_customers/#manage-company). # Website organization # Multisite Learn about the Multisite feature that enables you to have several websites within one installation. Developers or administrators with access to Ibexa DXP installation directory can configure the product to enable hosting multiple websites in one installation. It takes several lines of code to set up an instance that supports, for example, multiple brands or languages. This way, you can let both users and end-users who come from different departments or countries access the same assets or resources. For example, promotional graphics can be used on both a public website and a partner portal, while product specifications can be accessed from storefronts for different markets. The same applies to any content stored in the repository. Once multisite support is enabled, you can use Site Factory to create separate websites. ## SiteAccess In Ibexa DXP, a website definition is called SiteAccess. Once a website is created, website configuration, content language version, page design, content presentation, URL aliases, and more, can be configured per SiteAccess. These settings are then used by the application when users access the site through a specific address. For in-depth information, see [Multisite](https://doc.ibexa.co/en/5.0/multisite/multisite/) in Developer Documentation. # Work with websites Use Site Factory to easily create multiple websites, with different designs and subsets of content, based on common skeletons. Editions: Experience If multisite support is enabled for your instance of Ibexa DXP, you can use Site Factory to create and manage multiple websites from one place. These websites can, for example, be in different languages, or customized for different audiences, and still be kept in the repository of your installation. To be able to use it, the Site Factory has to be enabled and configured by the administrator. For more information, see Developer Documentation on [Site Factory](https://doc.ibexa.co/en/5.0/multisite/site_factory/site_factory/). ## Create a website To access Site Factory, in the left panel, click the **Site Management** icon and then **Sites**. If Site Factory is enabled, and you have sufficient permissions, you should see the **Create** button. Click it to access the **Creating New Site** modal. ![Site Factory icon](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/img/site_factory_icon.png) Here, you can create an entirely new website or a different language version of an already existing website. First, select a name, a predefined design, and a Parent location for your website. ![Create a new website - step one](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/img/site_factory_new_site_step_1.png) If the design defines a Site skeleton, you can choose if you want to copy the entire content structure of the design with a toggle. To preview the Site skeleton architecture, click **Site management**, and then **Site skeletons**. Next, you can decide if the website goes live after creation or is offline with the Status switcher. In this section you also define the SiteAccess URL addresses with their main languages, fallback languages, and optional paths for the website. > **Note: Path limitation** > > The path can be only one directory deep. Do not use paths that have more than one element, for example, `/en/articles`. For more information about SiteAccesses, see [Multisite](https://doc.ibexa.co/en/5.0/multisite/multisite/). ![Create a new website - step two](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/img/site_factory_new_site_step_2.png) If all required fields are filled out, click **Save and close** to create new website and add it to the website list in the **Site management** area. > **Note: Note** > > A SiteAccess that you create in Site Factory is always treated with lower priority than a SiteAccess defined by the administrator as part of [configuration](https://doc.ibexa.co/en/5.0/multisite/multisite_configuration/#siteaccess-configuration). For example, if you create a website that uses the `fr` path in Site Factory, and the administrator defines a French website manually in configuration files, your website is ignored by the system. You can see all the details of created website. To do it, go to **Site management** -> **Sites** and click the three dots icon next to the website name. Then, select **Site details**. ![Site details](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/img/site_details.png) ## Edit an existing website To edit the website, click the three dots icon that is situated next to the website name, and select **Site settings**. Here, you can edit all the elements you selected during creation of the website: - name - design - visibility - URL - language ## Delete an existing website To enable deleting a website you have to change the website status to offline. Live websites cannot be deleted. Next, select the **Delete** icon and confirm your choice. ![Site list](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/img/site_factory_site_list.png) # Permissions and users # Permission system Use the permission system to fine-tune the access control. An overview of the permission system in Ibexa DXP is best presented with an example. ### Example permission system Let us assume you're managing a newspaper website. Your crew consists of an editor-in-chief and several editors responsible for particular sections of the paper, for example, general news, local news, or sports. You also have contributors who occasionally add new articles. You want to give the editor-in-chief access to most parts of your website, but the individual editors only work with their own sections. To the contributors you want to give the permissions to create new content, but not to modify or delete the existing content. To have this setup, you need to create a number of different roles: Editor-in-Chief, different Editor(s), and Contributor. ![Editor role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/img/role_details.png "Editor role") Even if you plan on having only one editor-in-chief, it's good practice to create a user group to contain this user, and assign a role to it instead of assigning permissions directly to the user. ![User groups](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/img/user_groups.png "User groups") To each of these roles you need to assign proper policies, giving them the right to perform certain actions. The Editor-in-Chief role would have the most policies (although you may want to reserve some more advanced permissions only for system administrators). Regular Editors need policies allowing them to create, modify, and delete content. Contributors can be given policies permitting them to only create content. If you want to prohibit Editors from accessing content in newspaper sections other than their own, you can add limitations to their policies. This means that instead of one Editor, you need to have separate roles for each editor profile, for example, Local Editor or Sports Editor. All of these roles have the same policies, but to each policy you need to assign a limitation which would mean that the permission covers only one Section (for example, Sports Section or Local News Section) that the editor works in. Aside from policies that define access to content items, there are also many other policy types concerned with administrating the system. They cover actions, for example, activating new users, creating Sections, or modifying content types. For more information about setting up a permission system, see [Work with permissions](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/index.md). # Work with permissions Modify role settings to control access to different areas of the application. You can view and modify all [permissions](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permission_system/index.md) by clicking **Roles** in the **Admin** panel. ## Create a new role 1. Go to **Admin** -> **Roles** and click **Create**. 2. Provide a name and click **Save and close** to see a list of policies that the role has. 3. Click **+ Add**, select a policy from the list and click **Save and close**. You then may have an option to add limitations to the policy. The available limitations depend on the chosen policy. You can then return to a list of policies by clicking **Save and close** or **Discard**. ![Details of a role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/img/role_details.png "Details of a role") ## Assign a role to users 1. Go to **Admin** -> **Roles** and select a role. 2. Go to the **Assignments** tab and click **Assign to Users/Groups**. 3. Choose users and/or groups to be assigned to this role. 4. In the **Limitatons** area, select additional limitations if necessary. 5. To discard your changes and close the window, click **Discard**. 6. To save your changes, click **Save and close**. ![Users assigned to role](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/img/users_assigned.png "Users assigned to role") > **Note: Note** > > A user or user group may be assigned multiple roles. For a list of available permissions and limitations, see [Permissions](https://doc.ibexa.co/en/5.0/permissions/permissions/). # Manage users You can view and manage user accounts in your system. Users in Ibexa DXP are treated the same way as other content items. They're organized in groups, which helps you manage them and their permissions. You can view all user groups and Users in the **Admin** panel by selecting **Users**. Here, you can manage users, their relations, roles, and policies. As you can see, the interface is the same as when working with regular content items. > **Caution: Caution** > > If you are creating a new user group, remember to [exclude it in product tour configuration](https://doc.ibexa.co/en/5.0/administration/back_office/configure_product_tour#user-group-restrictions) if necessary. ![Users section](https://doc.ibexa.co/projects/userguide/en/latest/user_management/img/users_section.png) > **Caution: Caution** > > Be careful not to delete an existing user account. If you do this, content created by this user can be broken and the application can face malfunction. ## Register as a user In most cases it's the administrator who invites users to log into the application. You can still access the registration form for the website by adding `/register` to the address, for example: `www.my-site.com/register`. By default, new users created in this way are placed in the Guest accounts group. ## Invite users To invite users, go to **Admin** -> **Users** and click **Invite members** in the top right corner. ![Inviting users](https://doc.ibexa.co/projects/userguide/en/latest/user_management/img/users_invitation.png) To send invitations, fill out email addresses one by one, or use drag and drop to upload a file with an email list, then click **Send**. Invited users then receive an email message with a registration link. With it, they can register and create their account in the frontend as customers or in the back office as members of the team. # Recent activity log Monitor recent activity logged actions. Editions: Experience Ibexa DXP logs various operations on the repository and in the application. If you have **Setup / Administrate** and **Activity Log / Read** [permissions](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/permission_system/index.md), you can review the most recent activity log in the back office, **Admin** -> **Recent activity**. ![Recent activity](https://doc.ibexa.co/projects/userguide/en/latest/recent_activity/img/recent_activity.png "Recent activity") By default, actions on the following items are displayed: - [Content](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_items/index.md) - [Location](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/manage_locations_urls/#content-locations) - [Product](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/products/index.md) - [Product variant](https://doc.ibexa.co/projects/userguide/en/latest/product_catalog/work_with_product_variants/index.md) - [Site](https://doc.ibexa.co/projects/userguide/en/latest/website_organization/work_with_sites/index.md) > **Note: Note** > > If your implementation requires that other actions are logged, see [custom log entry Developer Documentation](https://doc.ibexa.co/en/5.0/administration/recent_activity/recent_activity/#add-custom-activity-log-entries). > > By default, log entries are kept for 30 days. This time can be modified through configuration. For more information, see [Developer Documentation](https://doc.ibexa.co/en/5.0/administration/recent_activity/recent_activity/#configuration-and-cronjob). Log entries are grouped by date, then by logical bond (like web request, or migration file). Each activity log entry shows: - when the action was performed, - who performed it (avatar, first name, last name), - the action itself as a verb, - and the item the action was performed on. Depending on the system configuration, activity logs may also be shown: - on the dashboard with the [Recent activity block](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard/dashboard_block_reference/#recent-activity-block) - within the [user profile](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/get_started/#view-and-edit-user-profile) ## Filter activities You can filter the activities to: - follow the activity of selected users or user group, - narrow the results to selected item types, or actions. To do it, on the right side, in the **Filters** menu, choose selected filters, and click the **Apply** button. Click the **Clear** button to reset all the filters. The following example shows, how to narrow the results by selecting **Action** and **Time** filters. With these settings, activity list displays only `Publish` actions from `Last week` time period. ![Published last week](https://doc.ibexa.co/projects/userguide/en/latest/recent_activity/img/recent_activity_filters.png "Published last week filter set") # User paths # Time to explore Browse a list of topics that bring you closer to understanding Ibexa DXP. Whether you're a new or seasoned user of Ibexa DXP, feel free to browse a list of topics that bring you closer to understanding the product. - [Get started](https://doc.ibexa.co/projects/userguide/en/5.0/getting_started/get_started/): Get started with Ibexa DXP by logging in to the back office. - [User interface](https://doc.ibexa.co/projects/userguide/en/5.0/getting_started/discover_ui/): Take a quick tour of the back office. - [Search for content](https://doc.ibexa.co/projects/userguide/en/5.0/search/search_for_content/): Search through all content in the system and filter the results by different criteria. - [Manage content model](https://doc.ibexa.co/projects/userguide/en/5.0/persona_paths/manage_content_model/): Learn about the content model, content types and fields. - [Author content](https://doc.ibexa.co/projects/userguide/en/5.0/persona_paths/author_content/): Add and modify various content items, such as pages, articles, forms, or media. - [Organize content](https://doc.ibexa.co/projects/userguide/en/5.0/persona_paths/organize_content/): Organize the content of your website by copying or moving content items, controlling locations and URLs and classifying content. - [Taxonomy](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/taxonomy/taxonomy/): Taxonomy is one of the ways classify content items with structured tags. - [Personalization](https://doc.ibexa.co/projects/userguide/en/5.0/personalization/personalization/): Use the Personalization service to get recommendation for users based on their behavior and on the scenarios you configure. - [Configure personalization](https://doc.ibexa.co/projects/userguide/en/5.0/personalization/configure_personalization/): Configure your Personalization service by setting up models and scenarios which define which content items are recommended. - [Search Engine Optimization](https://doc.ibexa.co/projects/userguide/en/5.0/search_engine_optimization/seo/): SEO can help your content score higher in search results, which leads to greater visibility. - [Products](https://doc.ibexa.co/projects/userguide/en/5.0/product_catalog/products/): Products are containers that aggregate information about the items you offer, for example, their specs, variants, or availability. - [Manage products](https://doc.ibexa.co/projects/userguide/en/5.0/persona_paths/manage_products/): Add and configure products in your catalog, set up their attributes and define availability and stock. - [Customer Portal account](https://doc.ibexa.co/projects/userguide/en/5.0/customer_management/customer_portal/): Customer Portal allows your clients to create and manage business account for their company. - [Multisite](https://doc.ibexa.co/projects/userguide/en/5.0/website_organization/multisite/): Learn about the Multisite feature that enables you to have several websites within one installation. - [Manage permissions and users](https://doc.ibexa.co/projects/userguide/en/5.0/permission_management/permissions_and_users/): Register users and use permission system to give them access to various parts of the system. # Application administrator role Discover administrative tasks that you can perform in the back office. When you perform administrative duties for your organization, you often are responsible for the configuration and maintenance of Ibexa DXP-based application, and solving architectural challenges and performance problems. In Ibexa DXP, most of such tasks are done outside of the UI. It's described in detail in [Developer Documentation](https://doc.ibexa.co/en/5.0). However, certain things can be done in the back office. ## What would you like to do today? - [Work with websites](https://doc.ibexa.co/projects/userguide/en/5.0/website_organization/work_with_sites/): Use Site Factory to easily create multiple websites, with different designs and subsets of content, based on common skeletons. - [Manage permissions and users](https://doc.ibexa.co/projects/userguide/en/5.0/permission_management/permissions_and_users/): Register users and use permission system to give them access to various parts of the system. - [Manage content model](https://doc.ibexa.co/projects/userguide/en/5.0/persona_paths/manage_content_model/): Learn about the content model, content types and fields. - [View workflow list](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/workflow_management/view_workflow_list/): Review a list of workflows that are available in the installation. # Manage permissions and users Register users and use permission system to give them access to various parts of the system. With the permission system of Ibexa DXP you can control which users have access to which parts of the system, editorial features, and content items that make the website. - [Permission system](https://doc.ibexa.co/projects/userguide/en/5.0/permission_management/permission_system/): Use the permission system to fine-tune the access control. - [Work with permissions](https://doc.ibexa.co/projects/userguide/en/5.0/permission_management/work_with_permissions/): Modify role settings to control access to different areas of the application. - [Manage users](https://doc.ibexa.co/projects/userguide/en/5.0/user_management/manage_users/): You can view and manage user accounts in your system. # Manage content model Learn about the content model, content types and fields. If you have Administrator permissions, you can develop a content model that is used in your Ibexa DXP installation. Learn more and create or modify content types. \[Content model The Ibexa DXP content model relies on content items that are based on predefined content types.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/content_model/) \[Create and edit content types Create or edit content types by listing fields that make a content item.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/create_edit_content_types/) # Content editor role Learn about creating and managing content. Whether you work as a marketing manager for a corporation, feed content to a portal with book reviews or publish posts on your own blog page, in the Ibexa DXP universe you're perceived as a content editor. Your actual tasks may vary depending on your position, but there are similarities that are characteristic to your role. Users who work as content editors can be tasked with the following responsibilities: - Create new content for existing websites, specific campaigns, and events - Upload and edit content items (for example, blog posts, articles, or media) - Create engaging and memorable landing pages - Maintain editorial calendars and communicate deliverable deadlines across the organization ## What would you like to do today? \[Content model The Ibexa DXP content model relies on content items that are based on predefined content types.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/content_model/) \[Create and edit content types Create or edit content types by listing fields that make a content item.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/create_edit_content_types/) \[Author content Add and modify various content items, such as pages, articles, forms, or media.\](//doc.ibexa.co/projects/userguide/en/5.0/persona_paths/author_content/) \[Work with tags Taxonomy is one of the ways classify content items with structured tags.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/taxonomy/work_with_tags/) \[Publish content Make content accessible to the audience.\](//doc.ibexa.co/projects/userguide/en/5.0/persona_paths/publish_content/) \[Organize content Organize the content of your website by copying or moving content items, controlling locations and URLs and classifying content.\](//doc.ibexa.co/projects/userguide/en/5.0/persona_paths/organize_content/) # Author content Add and modify various content items, such as pages, articles, forms, or media. In Ibexa DXP you store content data in content items. Learn to add and modify various content items, so that you can then show them to the audience. \[Content items Content items are containers that Ibexa DXP uses to store content data.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/content_items/) \[Create and edit content items Create content for your website with different fields, rich text, tags, and then publish it.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/create_edit_content_items/) \[Create and edit pages Create multi-zone Pages with dynamic blocks. Use them as landing pages.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/create_edit_pages/) \[Work with forms Use surveys, questionnaires, sign-up forms and other interactive forms to enrich your website.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/work_with_forms/) \[Translate content Create multiple language versions of content items.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/translate_content/) \[Edit images Edit images in the Image Editor to flip, crop and select a focal point.\](//doc.ibexa.co/projects/userguide/en/5.0/image_management/edit_images/) \[Copy, move or hide content Copy, move, remove, or hide content item, either individually or in bulk.\](//doc.ibexa.co/projects/userguide/en/5.0/content_management/content_organization/copy_move_hide_content/) # Publish content Make content accessible to the audience. Once you're done editing the content, make it immediately accessible or schedule publication for later. - [Publish content instantly](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/publish_instantly/): You can instantly publish a newly created content item or save its draft for editing. - [Schedule content publication](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/schedule_publishing/): You can schedule publication of content and Page blocks for specific time and date. # Organize content Organize the content of your website by copying or moving content items, controlling locations and URLs and classifying content. In Ibexa DXP you store content data in content items. Learn to add and modify various content items, so that you can then show them to the audience. - [Copy, move or hide content](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_organization/copy_move_hide_content/): Copy, move, remove, or hide content item, either individually or in bulk. - [Classify content](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_organization/classify_content/): Use sections, bookmarks, or segments to classify the content of your website. - [Manage content locations and URL addresses](https://doc.ibexa.co/projects/userguide/en/5.0/content_management/content_organization/manage_locations_urls/): Manage the content of your website by controlling locations and URLs. # Store manager role Perform tasks related to running an online store. When you run an online store, it's important that you maintain the right turnover of stock while winning new customers and retaining existing ones, and ultimately, bringing profit to the company. In Ibexa DXP, it means that you must focus on many things, including the following responsibilities: - Create and maintain product information (for example, descriptions, tech specifications, or media) - Maintain product pricing and shipping cost information - Manage shipping and payment methods - Manage and track orders ## What would you like to do today? \[Products Products are containers that aggregate information about the items you offer, for example, their specs, variants, or availability.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/products/) \[Manage products Add and configure products in your catalog, set up their attributes and define availability and stock.\](//doc.ibexa.co/projects/userguide/en/5.0/persona_paths/manage_products/) \[Work with currencies Define currencies that the system uses for calculating product prices.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/manage_currencies/) \[Work with product prices Products can have a base price and custom prices defined per customer group and per currency.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/manage_prices/) \[Customer management You can manage and view customers and organizations' accounts in your system, including their web store activities such as orders.\](//doc.ibexa.co/projects/userguide/en/5.0/customer_management/manage_customers/) \[Work with shipping methods Define new shipping methods or modify existing ones.\](//doc.ibexa.co/projects/userguide/en/5.0/commerce/shipping_management/work_with_shipping_methods/) \[Work with payment methods Define new payment methods or modify existing ones.\](//doc.ibexa.co/projects/userguide/en/5.0/commerce/payment/work_with_payment_methods/) \[Work with orders Review order information, change order status.\](//doc.ibexa.co/projects/userguide/en/5.0/commerce/order_management/work_with_orders/) \[Work with payments Review payment information, change payment status.\](//doc.ibexa.co/projects/userguide/en/5.0/commerce/payment/work_with_payments/) # Manage products Add and configure products in your catalog, set up their attributes and define availability and stock. In Ibexa DXP you store aggregate product information in product catalog. Learn to add, categorize and organize products, so that you have control over your stock and customers can easily browse your catalogs. \[Create product types Build new product types or modify existing ones.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/create_product_types/) \[Work with product attributes Create a structure of attributes that describe product characteristics and help search for products and filter them.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/work_with_product_attributes/) \[Create and edit products Create new products or modify existing ones.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/create_edit_product/) \[Work with product assets Add image assets to products or product variants.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/work_with_product_assets/) \[Work with product categories You can create a structure of tags that can be assigned to products to help categorize products, to assist visitors in searching. You create, manage and assign categories manually.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/work_with_product_categories/) \[Work with product variants Create multiple variants of one product, based on attributes such as size, color, technical specifications, and others.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/work_with_product_variants/) \[Work with product prices Products can have a base price and custom prices defined per customer group and per currency.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/manage_prices/) \[Work with availability and stock Products can be made unavailable or available, either in certain quantity or with infinite stock.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/manage_availability_and_stock/) \[Work with catalogs Catalogs allow creating filtered product lists for special purposes, for example, for B2B and B2C uses, for retailers and distributors or for different regions.\](//doc.ibexa.co/projects/userguide/en/5.0/product_catalog/work_with_catalogs/)