Backend A1

This indicates the amount of storage currently consumed by your account. Out of the total 50 MB allocated storage space, only 0.0 MB has been used, leaving sufficient space for additional products, images, videos, and other content.

Products Added

0 / 20

This metric shows the number of products that have been created in the system. Currently, 0 products have been added out of the maximum limit of 20 products allowed for this account.

Published Products

0 / 4

Published products are those that are visible and accessible to end users. Out of the 4 products created, 0 products have been published successfully and 0 product remains unpublished or in draft status.

Published Categories

0 / 2

Categories help organize products into logical groups for easier navigation and management. All 2 available categories have been published and are currently active.

Published Videos

0 / 0

This section displays the number of videos that have been published. Currently, no video content has been uploaded or published under this account.

Summary

The account is utilizing minimal storage space and has successfully published most of its available content. Product categories are fully published, while one product remains unpublished. No video content has been added at this time.

Dashboard

Disk Usage (Mb)

Disk Usage

The Disk Usage section provides a detailed overview of storage consumption across categories and products. It helps administrators monitor how much disk space is being utilized by uploaded assets such as logos, banners, images, and other media files.

Home Disk Usage

Home Disk Usage represents the total storage consumed across all categories, products, and associated media assets within the account.

Disk Space Used: 0 MB

Since no media files have been uploaded in this example, the total disk usage remains 0 MB.

Categories Disk Usage

The Categories Disk Usage table displays the storage utilized by category-related assets.

Category	Logo Disk Usage (MB)	Banner Disk Usage (MB)
Category 1	NA	NA
Category 2	NA	NA
Category 3	NA	NA

Field Description

Category: Name of the category.
Logo Disk Usage (MB): Storage consumed by the category logo.
Banner Disk Usage (MB): Storage consumed by the category banner image.
Total Disk Usage (MB): Combined storage used by category assets.
Full Disk Usage (MB): Total storage associated with the category.

Example

In this sample scenario, Category 1, Category 2, and Category 3 have been created without any uploaded logos or banners. As a result, all disk usage values remain 0 MB.

Product(s) Disk Usage

The Product Disk Usage table displays the storage utilized by individual products and their associated assets.

Product	Logo Disk Usage (MB)	Banner Disk Usage (MB)
Product 1	NA	NA
Product 2	NA	NA
Product 3	NA	NA
Product 4	NA	NA

Field Description

Product: Name of the product.
Logo Disk Usage (MB): Storage consumed by the product logo.
Banner Disk Usage (MB): Storage consumed by the product banner image.
Total Disk Usage (MB): Combined storage used by all product assets.

Example

In this sample scenario, Product 1 through Product 4 have been created without any uploaded logos, banners, or media files. Therefore, all products display a disk usage value of 0 MB.

Disk Usage Summary

Metric	Value
Total Disk Space Used	0 MB
Categories Using Storage	0
Products Using Storage	0
Uploaded Logos	0
Uploaded Banners	0

Overview

The Disk Usage module enables administrators to track storage consumption across categories and products. In this example, no media assets have been uploaded, resulting in zero disk space utilization across all sections. This indicates that the full storage allocation remains available for future content uploads.

Dashboard

Do you Know

How to Add a Logo and Banner Image in the App?

Learn how to upload and configure the application logo and banner image to enhance your organization's branding and visual identity.

How to Change the Default Color of the Top Navigation Bar?

Learn how to customize the top navigation bar color to match your organization's branding and improve the application's visual appearance.

How to Add a New Page?

Learn how to create a new page, configure its settings, and manage its content within the application.

How to Create a Group?

Learn how to create a new group, assign members, and manage permissions for better collaboration and access control.

My App

Info

My App Settings

The My App Settings section allows administrators to configure the basic information and default behavior of the application. These settings help customize the application identity, user experience, and regional preferences.

Basic Information

Configure the general details of your application.

Field	Description
Title	Enter the application title. Maximum length is 255 characters.
About Us	Add a short description about your organization or application. Maximum length is 5000 characters.
Enquiry Auto Reply	Define the automatic response message sent after an enquiry is submitted. Maximum length is 500 characters.

Regional Settings

Set the default localization preferences for the application.

Setting	Description
Currency	Select the default currency used across the application.
Language	Choose the default application language.
Timezone	Configure the timezone for date and time-related operations.

Display Settings

Customize the visual behavior of the application.

Setting	Description
Slide Transition	Select the default transition effect for banners and slides displayed in the application.

Content Visibility

Configure how the content appears within the application.

Setting	Description
Searchable	Enable this option to make the content searchable within the application.
Published	Enable this option to make the content visible and accessible to end users.

Note:
To ensure the content is searchable and visible to users, both Searchable and Published options should be enabled before saving the settings.

Important:
After making any changes, click Save to apply the updated configuration.

My App

Files

My App Settings

The Files section allows administrators to upload and manage branding assets used throughout the application. These assets help maintain a consistent and professional appearance across the application.

Logo

The Logo represents your application's brand identity and is displayed across various sections of the application.

Field	Description
Logo	Upload or replace the application logo.

How to Upload the Logo

Navigate to My App Settings → Files.
Under Logo, click the upload area or drag and drop the image.
Select the desired logo image.
Click Save to apply the changes.

Note:
Use a high-quality logo with a transparent background (if applicable) for the best visual appearance.

Field	Description
Banner Images	Upload a banner image for the application. Only one banner is allowed per catalog.

Requirement	Value
Maximum Banner Limit	1 Banner per Catalog
Minimum Image Size	10 × 10 px
Maximum Image Size	4000 × 4000 px

How to Upload the Banner

Navigate to My App Settings → Files.
Under Banner Images, click the upload area or drag and drop the image.
Select the desired banner image.
Click Save to apply the changes.

Note:
Only one banner can be uploaded per catalog. Uploading a new banner may replace the existing one.

Important:
After uploading or replacing the Logo or Banner, click Save to make the changes available in the application.

My App

Content

My App Settings

The Content section allows administrators to configure the content displayed within the application. Here, you can assign a form that has already been created in the Modules section.

Forms

The Forms option is used to select an existing form and link it to the application.

Field	Description
Forms	Select a form from the list of forms that have been created in the Modules section.

How to Assign a Form

Navigate to My App Settings → Content.
Under Forms, open the dropdown list.
Select the required form that was previously created in Modules.
Click Submit to save the selected form.

Note:
Only forms that have already been created in the Modules section will be available for selection.

Important:
After selecting a form, click Submit to associate it with the application.

My App

Settings

My App Settings

The Settings section allows administrators to configure the application's appearance, branding, user interface, and additional application settings. These configurations help customize the overall experience for both kiosk and application users.

Important:
After modifying any setting in this section, click Submit to save and apply the changes.

Style

The Style section allows you to customize the application's theme, layout, fonts, and various visual components.

1. My App Style

The My App Style section is used to configure the application's color scheme.

Setting	Description
Theme Text Color	Sets the default text color used throughout the application.
Theme Background Color	Defines the primary background color of the application.
Theme Screen Color	Configures the background color for application screens.
Heading Text Color	Sets the color for headings and section titles.
Content Text Color	Defines the text color used for content.
Content Background Color	Sets the background color behind the content area.
Content Background Opacity	Adjusts the transparency of the content background.

Note:
All colors are selected using their respective Color Code.

Important:
After configuring the required colors, click Submit to save the changes.

2. Kiosk Style

The Kiosk Style section allows administrators to customize the layout and visibility of different sections displayed on the kiosk.

Product Content Section

Configure how the product content is displayed on the kiosk.

Full View Horizontal #1

Setting	Description
Center	Displays the primary content in the center section.
Right Visibility	Show or Hide the right-side section.
Right Mode	Select the display mode (e.g., Banners).
Right Ratio	Configure the display ratio (Example: 9:16).
Left Visibility	Show or Hide the left-side section.
Left Mode	Select the display mode for the left section.
Left Ratio	Configure the display ratio for the left section.

Full View Vertical #1

Setting	Description
Package	Select how packages are displayed.
Grid	Configure the number of items displayed in the grid.
Scroll	Select the scrolling direction (Vertical/Horizontal).

Note:
Configure these settings according to your kiosk display requirements.

Important:
Click Submit after updating the kiosk layout.

3. Fonts

The Fonts section allows administrators to upload or select fonts used throughout the application.

Font	Description
Regular Font	Default font used for normal text.
Bold Font	Font used for bold text.
Italic Font	Font used for italic text.
Bold Italic Font	Font used for bold italic text.

Important:
Click Submit after updating font settings.

4. Headings

The Headings section allows administrators to customize the default labels displayed across the application.

My App

Field	Description
View All Heading	Label displayed for the "View All" option.
Kiosk Cart Heading	Heading displayed on the kiosk cart page.
Website About Us	Heading used for the website's About Us section.

Field	Description
Category Heading	Heading displayed for categories.
Product Heading	Heading displayed for products.
Video	Heading displayed for videos.

Product

Field	Description
Package Heading	Heading displayed for packages.
Description Heading	Heading displayed for descriptions.
Specifications Heading	Heading displayed for specifications.
Resource Heading	Heading displayed for resources.
Video Heading	Heading displayed for videos.
Map Heading	Heading displayed for maps.
Form Heading	Heading displayed for forms.
Image Heading	Heading displayed for images.
Script Heading	Heading displayed for scripts.

Important:
Click Submit after updating the headings.

5. Contact

The Contact section stores the application's contact information.

Field	Description
Mobile Number	Primary contact number displayed in the application.
Calling Hours	Business hours during which users can contact you.
Email	Primary support or business email address.

Important:
Click Submit after updating the contact information.

Supported platforms include:

Facebook
Twitter
Google
LinkedIn
YouTube
Pinterest
Instagram
Tumblr
Digg

Note:
Enter the appropriate profile URL for each platform.

Important:
Click Submit after updating the social links.

7. Address

The Address section allows administrators to manage branch or office locations.

Click Add Address to create a new branch.

Address Details

Field	Description
Address Title	Name of the branch or office.
Country	Select the country.
State	Select the state.
City	Enter the city name.
Pin Code	Enter the postal code.
Address 1	Primary street address.
Address 2	Apartment, suite, building, floor, etc. (Optional).
Mobile Number 1	Primary contact number.
Mobile Number 2	Secondary contact number (Optional).
Calling Hours	Business hours.
Email	Branch email address.

Note:
Google Maps integration may be available for selecting the location.

Important:
Click Submit after adding or editing an address.

8. Order

The Order section allows administrators to configure the default business note displayed during the ordering process.

Field	Description
Business Note	Enter a default note (Maximum 500 characters).

Important:
Click Submit after updating the business note.

9. CTA (Call To Action)

The CTA section allows administrators to configure Call-To-Action buttons used throughout the application.

Setting	Description
Enable CTA for Categories	Enable or disable CTA buttons for categories.
Enable CTA for Products	Enable or disable CTA buttons for products.
Background Color	Select the CTA button background color.
Icon Color	Select the CTA icon color.

Important:
Click Submit after updating CTA settings.

10. SEO

The SEO section helps improve the application's visibility on search engines.

Field	Description
SEO Title	Enter the SEO title (Maximum 70 characters).
SEO Description	Enter the SEO description (Maximum 160 characters).
SEO Keywords	Enter comma-separated SEO keywords (Maximum 160 characters).

Note:
Separate multiple keywords using commas.

Important:
Click Submit after updating SEO settings.

11. Resource Configuration

The Resource Configuration section allows administrators to customize the action button displayed for resources.

Setting	Description
Action Button Text	Enter the text displayed on the resource action button (Maximum 10 characters).
Action Button Text Color	Select the button text color.
Action Button Background Color	Select the button background color.
Server	Configure the server used for resource access.

Important:
Click Submit after updating the resource configuration.

12. App Download Bar

The App Download Bar section controls the application's download banner.

If the Enterprise Mobile App feature is not included in your current pricing plan, the following message will be displayed:

Permission Alert!
Oops! Your pricing plan does not include the Enterprise Mobile App feature.
Talk to Sales to upgrade your plan.

Note:
This feature is available only for supported subscription plans.

Final Note

Important:
Any changes made under Style, Kiosk Style, Fonts, Headings, Contact, Social, Address, Order, CTA, SEO, Resource Configuration, or App Download Bar will not be applied until you click the Submit button.

Pages

Overview

The Categories section allows administrators to organize pages into a structured hierarchy. Categories make it easier to manage, navigate, and display related pages within the application.

Note:
A default Root category is available in the system and acts as the top-level parent for all categories.

Create a New Category

To create a new category:

Navigate to Pages → Categories.
Click Add New Category.
Fill in the required details.
Click Create to add the category.

Category Fields

Field	Description
Title	Enter the name of the category. Maximum 255 characters.
Parent Category	Select the parent category under which the new category will be created. By default, Root (/) is available.
Description	Enter a brief description of the category (Optional).

After a category is created, it is displayed in the Categories table.

The table contains the following information:

Column	Description
Parent Category	Displays the parent category of the current category.
Title	Displays the category name.
Status	Indicates whether the category is Visible or hidden.
Modified At	Displays the date and time when the category was last updated.

Additional features available on this page include:

Search to quickly find a category.
Entries to control the number of records displayed per page.

Default Root Category

The application includes a default Root category.

The Root category serves as the top-level category.
New categories can be created directly under Root or under any existing parent category.
Organizing categories under appropriate parent categories helps maintain a clear and structured hierarchy.

Best Practice:
Use meaningful and descriptive category names to keep the page structure organized and easy to manage.

Pages

Products

Overview

The Products section allows administrators to create and manage products that are displayed within the application. Each product can be assigned to one or more categories, making it easier to organize and present content.

Create a New Product

To create a new product:

Navigate to Pages → Products.
Click Add New Product.
Fill in the required product details.
Click Create to save the product.

Product Fields

Field	Description
Title	Enter the product name. Maximum 255 characters.
Select Categories	Select one or more categories to which the product belongs.
Description	Enter a brief description of the product (Optional).

Note:
Products can only be assigned to categories that have already been created in the Categories section.

Product List

After a product is created, it appears in the Products table.

The table includes the following information:

Column	Description
Title	Displays the product name.
Status	Indicates whether the product is Visible or hidden.
Modified At	Displays the date and time of the last modification.
Action	Provides options to manage the selected product.

Additional features available on this page include:

Search to quickly locate a product.
Entries to control the number of products displayed per page.

Best Practice

Create the required Categories before adding products.
Use clear and descriptive product titles for easier management.
Assign products to the appropriate categories to maintain a well-organized content structure.

Pages

Languages

Overview

The Language section allows administrators to manage and customize the text displayed throughout the application. It provides a centralized location for translating system labels, buttons, messages, and other interface elements into different languages.

Base Language

The Base Language is the default language used by the application. It contains all predefined system text that can be translated into the desired language.

Language Details

Field	Description
Title	Enter the name of the language. Maximum 64 characters.
System Translation	Displays all default system labels and messages available for translation.

System Translation

The System Translation section contains all default application text used throughout the system.

Examples include:

Account
Home
Categories
Products
Cart
Search
Maps
Forms
Resources
Images
Videos
Submit
Cancel
Confirm
Update
Delete
Loading...
Error Messages
Validation Messages
Order Messages
Printer Messages
Navigation Labels
Notifications
System Alerts

For each system label:

The left side displays the original system text.
The right side allows administrators to enter the translated text for the selected language.

Note:
Only the translated value should be modified. The original system keys remain unchanged.

Custom Translation

The Custom Translation section allows administrators to create translations for custom labels that are not included in the default system translations.

Field	Description
Key	Enter the unique identifier for the custom text.
Translated Text	Enter the translated value that will be displayed in the application.

Use Custom Translation when additional application text needs to be localized without modifying the default system translations.

How to Configure a Language

Navigate to Pages → Language.
Enter the Language Title.
Translate the required values under System Translation.
Add any additional translations under Custom Translation, if required.
Click Submit to save the language configuration.

Best Practices

Translate only the values on the right side of the translation fields.
Keep translations clear, consistent, and user-friendly.
Use Custom Translation only for application-specific text that is not available in the default system translation.
Review all translated content before publishing to ensure accuracy.

Important:
Any changes made to System Translation or Custom Translation will not be applied until you click the Update button.

VirtuApp

Note: VirtuApp has been migrated to the new VirtuBox console Backend.

Please refer to the VirtuApp A2 for VirtuApp configuration and management process

VirtuKiosk

VirtuKiosks

Overview

The VirtuKiosks module allows users to register and manage kiosks in the VirtuBox Business Backend. To associate a kiosk with the backend, users must enter the kiosk code and configure the required kiosk details.

Accessing VirtuKiosks

To access the VirtuKiosks module:

Log in to the VirtuBox Business Backend.
Go to Leftside Bar → VirtuKiosk → VirtuKiosks.
The VirtuKiosks page displays the available kiosk information.

Add Kiosk

The Add Kiosk feature allows users to register a new kiosk by entering its kiosk code, title, and theme.

Adding a New Kiosk

To add a new kiosk:

Navigate to Home → VirtuKiosk → VirtuKiosks.
Click Add Kiosk.
Enter the required kiosk details.

Kiosk Configuration

Field	Description	Limit
Kiosk Code	Enter the unique kiosk code associated with the kiosk.	Maximum 8 characters
Kiosk Title	Enter a title to identify the kiosk.	Maximum 64 characters
Kiosk Theme	Select the appropriate kiosk orientation.	Horizontal / Vertical

Kiosk Theme

The Kiosk Theme option allows users to select the kiosk's display orientation.

Kiosk Horizontal: Configures the kiosk for horizontal display orientation.
Kiosk Vertical: Configures the kiosk for vertical display orientation.

Enter the kiosk code generated or provided by the VirtuKiosk device.
Enter the kiosk title.
Select the appropriate kiosk theme.
Save the kiosk configuration.

Note: The kiosk code is required to associate the VirtuKiosk device with the VirtuBox Business Backend and enable map management for the registered kiosk.

Kiosk Status

The VirtuKiosks page categorizes kiosks into two status groups:

Status	Description
Live	Displays kiosks registered under the Live category.
Trial	Displays kiosks registered under the Trial category.

The page also displays the total number of kiosks available under each category.

Note: The kiosk code must be entered correctly to ensure that the appropriate kiosk is registered and associated with the backend.

VirtuKiosk

Kiosk (Old)

Overview

The Kiosks section provides a centralized dashboard for managing all registered kiosks. It allows administrators to monitor kiosk status, view device information, manage kiosk configurations, and track hardware and application details in real time.

Navigate to VirtuKiosk → Kiosks to manage kiosks.

Kiosk Dashboard

The dashboard displays a summary of all available kiosks and their current status.

Available information includes:

Search – Find kiosks by name or code.
Online Time – Filter kiosks based on their online status.
Available Live Kiosk – Displays the total number of kiosks currently connected.
Add Kiosk – Register a new kiosk in the system.

Kiosk Information

Selecting a kiosk displays detailed information about the device.

The following information is available:

Field	Description
Kiosk Name	Displays the kiosk name.
Resolution	Screen resolution of the kiosk device.
Screen Density	Device DPI information.
Status	Displays the current kiosk status (Online, Offline, Casual, etc.).
Last Active	Shows the last communication time with the server.
Battery Level	Displays the current battery percentage (if supported).
Device Model	Displays the kiosk hardware model.

Media Information

The Media Information section displays the content currently synchronized with the kiosk.

Available details include:

Images
Videos

This helps administrators verify whether all required media files have been downloaded successfully.

Device Information

The Device Information section displays the hardware specifications of the kiosk.

Available details include:

Information	Description
RAM	Total available system memory.
ROM	Total internal storage.
Cache	Cache storage information.

Application Information

Displays the versions of applications installed on the kiosk.

Available details include:

VirtuKiosk Version
KioskTool Version
Google Mobile Services (GMS) Version

This information helps administrators verify that the kiosk is running the correct software versions.

Default Configuration

The kiosk also displays the currently applied default configurations, including:

Screensaver
Slide Interval
Map View
Map Track
Home Content (Mode)
Kiosk Theme

These settings help administrators verify the kiosk's active configuration without opening the configuration page.

Kiosk Information Panel

Selecting Kiosks Info provides additional details about the selected kiosk, allowing administrators to review its configuration, status, and device information.

Manage Kiosks

Administrators can:

Register new kiosks.
Search for kiosks.
Monitor kiosk status.
View device specifications.
Check synchronized media.
Verify application versions.
Review default kiosk configurations.
Access detailed kiosk information.

Best Practices

Regularly monitor kiosk connectivity and status.
Ensure kiosks are running the latest application versions.
Verify media synchronization after publishing new content.
Review hardware information when troubleshooting device issues.
Keep kiosk configurations updated for optimal performance.

Important:
The Kiosks dashboard provides a complete overview of every registered kiosk, including its status, hardware details, installed applications, synchronized media, and active configuration. Regular monitoring helps ensure kiosks remain operational and up to date.

VirtuKiosk

Kiosk (Settings)

Overview

The Kiosk Settings section allows administrators to customize the overall behavior, appearance, navigation, and user experience of the kiosk. It provides configuration options for screensavers, search results, status indicators, navigation, content layout, map behavior, and animations.

Navigate to VirtuKiosk → Kiosk Settings to configure these settings.

Screensaver Settings

The Screensaver Settings control how the kiosk behaves when it is idle.

Available options include:

Setting	Description
Screensaver Text	Displays custom text on the screensaver.
Screensaver Mode	Select the screensaver display mode.
Screensaver Action	Defines the action performed when the screensaver is active.

Search Configuration

Configure how search results are displayed within the kiosk.

Setting	Description
Search Result Count (Live)	Number of search results displayed while typing.
Search Result Count (Detail)	Number of detailed search results displayed after searching.

Offline Status

The Offline Status section displays a notification when the kiosk loses its internet connection.

Available options include:

Offline Status Display
Offline Status Text
Text Color
Background Color
Background Color Alpha
Position
Text Size

Administrators can customize the appearance and position of the offline notification.

Printer Status

The Printer Status section controls the notification displayed when the kiosk printer is unavailable.

Available options include:

Printer Status Display
Printer Status Text
Text Color
Background Color
Background Color Alpha
Position
Text Size

This helps users identify when the printer is disconnected.

Available options include:

Map
Facility Points Display
Facility Action
Items Sort By
Filterable
Filterable Minimum Count

These settings determine how navigation items are displayed and interacted with.

Item Grid Configuration

Configure the appearance of categories and products displayed in the kiosk.

Available options include:

Items Grid Mode
Items Grid Count
Items Grid Image Ratio
Items Grid Text Font

Administrators can display items in either List View or Grid View depending on the selected configuration.

Main Content

The Main Content section controls the appearance of content cards displayed on the kiosk.

Available configuration includes:

Card

Margin
- Top
- Right
- Bottom
- Left
Padding
- Top
- Right
- Bottom
- Left
Radius
Elevation

Content

Margin
Padding

These settings allow administrators to customize spacing and card appearance.

Image Configuration

Configure image-related display settings.

Available options include:

Search Icon Size
Search Icon Visibility
Search Icon Position

These settings control the visibility and placement of the search icon.

Map Configuration

Configure the kiosk map behavior.

Available options include:

Map Pin Action
Map Menu Visibility
Navigation Bar Visibility

These settings determine how users interact with the kiosk map.

Animation Settings

Customize animation effects throughout the kiosk interface.

Available options include:

Category Click Animation
Floating Button Click Animation

Animations improve the overall user experience by providing smooth visual transitions.

Manage Kiosk Settings

Administrators can:

Configure screensaver behavior.
Customize search results.
Display offline status notifications.
Configure printer status messages.
Customize navigation settings.
Configure item grid layout.
Manage content spacing.
Configure map behavior.
Customize interface animations.

Best Practices

Configure search results according to the kiosk screen size.
Keep offline and printer notifications visible for better user awareness.
Use appropriate grid layouts for improved readability.
Test navigation settings before deployment.
Review animation settings to ensure a smooth user experience.

Important:
The Kiosk Settings section controls the overall behavior and appearance of the kiosk interface. After updating any configuration, click Submit to save the changes. It is recommended to test the kiosk after making configuration updates to ensure all settings are applied correctly.

VirtuKiosk

Kiosk (Assets)

Overview

The Kiosk Assets section allows administrators to upload and manage images used throughout the kiosk interface. These assets include icons, backgrounds, logos, map markers, and banners that define the visual appearance of the kiosk.

Navigate to VirtuKiosk → Kiosk Assets to configure kiosk assets.

Upload Kiosk Assets

Administrators can upload various graphical assets by using the Drag & Drop area or clicking to browse files.

Most icon assets require a 1:1 aspect ratio, while backgrounds and banners support larger image dimensions.

Kiosk Icons

The following icons can be configured:

Asset	Description
Kiosk Home Icon	Displays the Home button icon.
Kiosk Search Icon	Displays the Search button icon.
Kiosk Cart Icon	Displays the Cart button icon.
Order Receipt Logo	Logo printed on order receipts.

Requirements

Image Aspect Ratio: 1:1
Image Size: 10 × 10 px to 4000 × 4000 px

Background Images

Administrators can upload background images for different kiosk screens.

Available backgrounds include:

Kiosk Cart Background
Kiosk Order Background
Category Background
Product Background

Requirements

Only 1 image is allowed for each background.
Image Size: 10 × 10 px to 4000 × 4000 px

Map Assets

The following assets are used within the kiosk map interface:

Asset	Description
Map Footstep Icon	Displays navigation footsteps on the map.
Map Pin Active Icon	Indicates the currently selected destination.
Map Pin Inactive Icon	Displays inactive map locations.
Map Pin Kiosk Icon	Represents the kiosk location on the map.
Map Home Icon	Displays the Home location on the map.

Requirements

Image Aspect Ratio: 1:1
Image Size: 10 × 10 px to 4000 × 4000 px

Administrators can upload promotional banners displayed on different kiosk screens.

Kiosk Screensaver Banners

Displayed during the kiosk screensaver.
Maximum 8 images can be uploaded.

Kiosk Home Banners

Displayed on the kiosk home screen.
Maximum 8 images can be uploaded.

Requirements

Image Size: 10 × 10 px to 4000 × 4000 px

Manage Kiosk Assets

Administrators can:

Upload kiosk icons.
Configure order receipt logo.
Upload screen backgrounds.
Configure map icons.
Upload screensaver banners.
Upload home screen banners.
Replace existing assets whenever required.

Best Practices

Use high-quality images for all assets.
Maintain a 1:1 aspect ratio for icon images.
Use optimized image sizes for better kiosk performance.
Follow the upload limits for banners and backgrounds.
Preview assets before deploying them to production.

Important:
Kiosk Assets control the overall appearance of the kiosk interface. After uploading or updating assets, click Submit to save the changes. Ensure all images meet the recommended size and aspect ratio requirements for the best display experience.

VirtuKiosk

Kiosk Flash Banner

Overview

The Kiosk Flash Banners section allows administrators to configure promotional banners that appear at different positions on the kiosk screen. Flash banners can be used to display advertisements, announcements, promotional offers, or branding content while customers interact with the kiosk.

Navigate to VirtuKiosk → Kiosk Flash Banners to manage flash banner configurations.

Add Kiosk Flash Banner Configuration

To create a new flash banner configuration:

Navigate to VirtuKiosk → Kiosk Flash Banners.
Click Add New Kiosk Flash Banners Configuration.
Configure the required banner settings.
Upload banner images for the desired positions.
Click Submit to save the configuration.

The following settings are available:

Setting	Description
Size	Defines the display size of the flash banners.
Available On	Select where the banners will be displayed (e.g., Both layouts).
Position	Choose the location where the banner should appear.
Mode	Select the banner display mode (Banner).

Flash banners can be displayed at the following positions on the kiosk screen:

Leaderboard Top
Leaderboard Bottom
Skyscraper Left
Skyscraper Right

Each position can have its own set of banner images.

Administrators can upload banner images using the Drag & Drop area or by clicking to browse files.

The following upload rules apply:

A maximum of 4 images can be uploaded for each banner position.
Supported image dimensions must be between 10 × 10 px and 4000 × 4000 px.

Separate upload sections are available for:

Leaderboard Top
Leaderboard Bottom
Skyscraper Left
Skyscraper Right

Manage Flash Banners

Administrators can:

Create new flash banner configurations.
Upload banner images.
Configure banner positions.
Adjust banner size.
Edit existing configurations.
Delete unused banner configurations.

Best Practices

Use high-quality banner images for better visibility.
Maintain consistent banner dimensions across all positions.
Avoid uploading more than four images per banner position.
Preview banners on the kiosk before deployment.
Update promotional banners regularly to keep content fresh.

Important:
Flash Banners are displayed at predefined positions on the kiosk interface. Configure the required position, upload the banner images, and save the configuration to display promotional content on the kiosk.

VirtuKiosk

Kiosk Floating Button

Overview

The Kiosk Floating Buttons section allows administrators to create and manage floating action buttons displayed on the kiosk interface. These buttons provide quick access to frequently used features and can be positioned anywhere on the screen by configuring their X and Y coordinates.

Navigate to VirtuKiosk → Kiosk Floating Buttons to manage floating buttons.

Add Floating Button

To create a new floating button:

Navigate to VirtuKiosk → Kiosk Floating Buttons.
Click Add Floating Button.
Select the required Button Type.
Configure the X and Y position.
Click Submit to save the button.

Floating Button Types

The following floating button types are available:

Button Type	Description
Logo	Displays the company or application logo as a floating button.
Facility	Opens the configured facility or services section.
Home	Navigates directly to the kiosk home screen.
Search	Opens the product search interface.
Cart	Opens the shopping cart.
Dynamic Cart	Displays a dynamic cart button based on the current cart status.
Dynamic QR	Displays a QR Code dynamically for supported workflows.
Dynamic TryOn	Opens the TryOn feature for supported fashion products.

Button Position

Each floating button can be positioned anywhere on the kiosk screen.

Setting	Description
X (%)	Defines the horizontal position of the floating button.
Y (%)	Defines the vertical position of the floating button.

The position is configured using percentage values, allowing the button to be placed anywhere on the screen.

Manage Floating Buttons

Administrators can:

Add new floating buttons.
Select different button types.
Configure button positions.
Edit existing floating buttons.
Delete unused floating buttons.

Best Practices

Position buttons where they are easily accessible without blocking important content.
Use only the required floating buttons to maintain a clean interface.
Test button placement on the target kiosk screen before deployment.
Verify that each button performs the intended action.

Important:
Floating Buttons provide quick access to important kiosk features. Configure the Button Type and adjust the X and Y position to place the button at the desired location on the kiosk interface.

VirtuKiosk

Kiosk Screensavers

Overview

The Kiosk Screensavers section allows administrators to create and manage custom screensavers for kiosks. These screensavers can be assigned to kiosks and displayed when the kiosk remains idle for the configured screensaver duration.

Navigate to VirtuKiosk → Kiosk Screensavers to manage kiosk screensavers.

Add Kiosk Screensaver

To create a new kiosk screensaver:

Navigate to VirtuKiosk → Kiosk Screensavers.
Click Add Screensaver.
Enter a Title for the screensaver.
Click Submit to save the screensaver.

Once created, the screensaver becomes available for selection in the Kiosk Default Configuration.

Screensaver Details

The following information is maintained for each screensaver:

Field	Description
Title	Name of the kiosk screensaver.

Manage Kiosk Screensavers

Administrators can:

Add new kiosk screensavers.
View all available screensavers.
Edit existing screensavers.
Delete screensavers that are no longer required.
Assign screensavers to kiosk configurations.

Best Practices

Use meaningful titles for easy identification.
Create separate screensavers for different kiosk themes or campaigns.
Remove unused screensavers to keep the list organized.
Verify the screensaver before assigning it to a kiosk.

Important:
After creating a screensaver, it can be selected from the Kiosk Default Configuration page and used as the default screensaver for supported kiosks.

VirtuKiosk

Kiosk Default Config

Overview

The Kiosk Default Configuration section allows administrators to define the default behavior and appearance of kiosks. Separate configuration panels are available for Horizontal and Vertical kiosk layouts, enabling each orientation to have its own independent settings.

These configurations control the kiosk's screensaver, home content, products, categories, map behavior, printer settings, Smart Scale, and other default options.

Navigate to VirtuKiosk → Kiosk Default Config to manage these settings.

Horizontal Configuration

The Horizontal Configuration is used to configure kiosks operating in Landscape (Horizontal) mode. All settings applied in this section affect only horizontal kiosks.

Screensaver Configuration

Configure the kiosk screensaver using the following options:

Setting	Description
Screensaver Time (Minutes)	Defines the idle time before the screensaver is displayed.
Slide Interval (Seconds)	Sets the time interval between screensaver slides.
Screensaver Image Scale	Select how screensaver images should be displayed (e.g., Fit).
Kiosk Screensaver	Select the default screensaver for the kiosk.

If no screensaver content is selected, all available content will be merged automatically.

Map Configuration

Configure the default map behavior.

Available settings include:

Map View Rotation (°)
Map Track Rotation (°)

These options determine how the kiosk map is displayed.

Content Configuration

Configure the default content that appears on the kiosk.

Available options include:

Kiosk Root Category
Screensaver Product
Screensaver Video
Screensaver Content
Home Content (Mode)
Home Product
Home Category

If nothing is selected, the kiosk automatically displays all available content.

Printer Configuration

Configure printer functionality.

Printer – Enable or disable receipt printing.

By default:

Printer: Off

Smart Scale

The Smart Scale option automatically adjusts content according to the kiosk's display size.

Kiosk Attributes

Configure additional kiosk-specific attributes required for the horizontal layout.

Vertical Configuration

The Vertical Configuration is used to configure kiosks operating in Portrait (Vertical) mode.

The available settings are similar to the Horizontal configuration but are applied independently for vertical kiosks.

Screensaver Configuration

Configure screensaver settings for vertical kiosks.

Available options:

Setting	Description
Screensaver Time (Minutes)	Sets the idle time before the screensaver starts.
Slide Interval (Seconds)	Defines the interval between screensaver slides.
Screensaver Image Scale	Select the preferred image scaling mode.
Kiosk Screensaver	Choose the default screensaver.

If no screensaver content is selected, all available content will be merged automatically.

Map Configuration

Configure the default map settings.

Available options:

Map View Rotation (°)
Map Track Rotation (°)

Content Configuration

Configure the default content displayed on the kiosk.

Available options include:

Kiosk Root Category
Screensaver Product
Screensaver Video
Screensaver Content
Home Content (Mode)
Home Product
Home Category

If no content is selected, the kiosk automatically displays all available content.

Printer Configuration

Enable or disable printer support.

By default:

Printer: Off

Smart Scale

Automatically adjusts the kiosk content according to the display size for a better viewing experience.

Kiosk Attributes

Configure additional kiosk-specific settings for vertical kiosks.

Manage Kiosk Default Configuration

Administrators can:

Configure Horizontal kiosk settings.
Configure Vertical kiosk settings.
Set screensaver behavior.
Configure map rotation.
Select home screen content.
Configure root categories.
Select featured products.
Enable or disable printer support.
Configure Smart Scale.
Manage kiosk attributes.

Best Practices

Configure the correct settings for both kiosk orientations.
Verify the root category before deployment.
Select appropriate home content for users.
Test screensaver timing and transitions.
Enable printer functionality only when required.
Review all settings before saving the configuration.

Important:
The Horizontal and Vertical configurations are managed independently. Any changes made to one layout do not affect the other. After completing the required configuration, click Submit to save the settings.

VirtuKiosk

Kiosk Image Size

Overview

The Image Dimensions section allows administrators to configure the spacing and display margins for different screens of the kiosk interface. These settings help control how content is positioned on the screen by adjusting the top, bottom, left, and right dimensions.

Navigate to Settings → Image Dimensions to configure kiosk screen dimensions.

Kiosk Configuration

Select the appropriate kiosk configuration before applying dimension settings.

Example:

Theme

Kiosk Horizontal
Kiosk Vertical

& Many more options given in the theme you can choose

The available configuration may vary depending on the selected kiosk theme.

Screen Dimensions

Administrators can configure the following dimensions for each screen:

Setting	Description
Top	Sets the top spacing of the screen content.
Bottom	Sets the bottom spacing of the screen content.
Left	Sets the left spacing of the screen content.
Right	Sets the right spacing of the screen content.
Available For	Choose whether the configuration applies to Both orientations or a specific layout.

All values are configured as percentages (%), allowing flexible positioning across different screen sizes.

Available Screens

Dimension settings can be configured separately for:

Screensaver
Home
Content

This allows each screen to have its own layout and spacing configuration.

Manage Image Dimensions

Administrators can:

Configure screen margins.
Adjust top, bottom, left, and right spacing.
Apply settings to supported kiosk layouts.
Customize dimensions for individual screens.

Best Practices

Preview the layout after changing dimension values.
Use balanced spacing for a clean user interface.
Apply consistent dimensions across screens where possible.
Test the layout on the target kiosk display before deployment.

Important:
Changes made in the Image Dimensions section affect the positioning of content displayed on the kiosk screens. After updating the values, save the configuration to apply the new layout.

VirtuKiosk

Heat Map

Overview

The Kiosk Status section provides a real-time overview of all registered kiosks. It displays the current connection status, activity, and location of each kiosk, allowing administrators to monitor kiosk availability from a single dashboard.

Navigate to VirtuKiosk → Kiosks to view kiosk status.

Kiosk Status

Each kiosk card displays important information, including:

Kiosk Name
Mapped Account
Connection Status
Last Online Time
Kiosk Type
Activity Status

Example:

Status: Casual (Inactive for 2–8 hours)
Online: Jul 23, 2026 11:47 AM

Status Categories

The dashboard categorizes kiosks based on their current status:

Online – Kiosk is connected and actively communicating with the server.
Offline – Kiosk is currently disconnected.
Casual – Kiosk has been inactive for a short period (for example, 2–8 hours).
Unmapped – Kiosk has not been mapped to any account.

These categories help administrators quickly identify the operational state of each kiosk.

Search Kiosks

Kiosk Location Map

Selecting a kiosk opens its Location Map, allowing administrators to view the kiosk's geographical location.

The map helps administrators:

View the kiosk's current location.
Verify where the kiosk is installed.
Identify the kiosk on an interactive map.
Monitor kiosk deployment across different locations.

Manage Kiosks

Administrators can:

View real-time kiosk status.
Monitor online and offline kiosks.
Check the last online timestamp.
View kiosk locations on the map.
Search for specific kiosks.
Identify unmapped kiosks.

Best Practices

Regularly monitor kiosk status to ensure uninterrupted operation.
Review offline or casual kiosks for connectivity issues.
Verify kiosk locations using the map when deploying or troubleshooting devices.
Ensure every kiosk is properly mapped to the correct account.

Important:
The Kiosk Status dashboard provides a real-time overview of kiosk connectivity and activity. Clicking on a kiosk opens its Location Map, making it easy to verify the kiosk's installation location and monitor its operational status.

VirtuKiosk

Web Assets

Overview

The Web Assets section allows administrators to register and manage external web asset URLs that can be used within the VirtuKiosk application. These assets may include web pages, hosted content, web applications, or other online resources that need to be accessed from the kiosk.

Navigate to VirtuKiosk → Web Assets to manage web asset URLs.

Web Assets

The Web Assets page displays all configured web asset URLs.

If no web asset has been added, the system displays:

No Web Assets found. Please add a web asset first.

Add Web Asset

To add a new web asset:

Navigate to VirtuKiosk → Web Assets.
Click Add Web Asset.
Enter the required Web Asset URL.
Save the configuration.

Once added, the web asset becomes available for use within supported kiosk features.

Web Asset Details

The following information is maintained for each web asset:

Field	Description
URL	Displays the configured web asset URL.
Web Asset URL	The external web address used by the kiosk.

Manage Web Assets

Administrators can:

Add new web assets.
View configured web asset URLs.
Edit existing web assets.
Delete web assets that are no longer required.

Best Practices

Use valid and accessible HTTPS URLs whenever possible.
Verify the URL before saving.
Remove outdated or unused web assets.
Ensure hosted web content is accessible from the kiosk.

Important:
Web Assets allow administrators to configure external web URLs that can be accessed by the kiosk. Make sure the provided URL is valid and reachable before saving the configuration.

VirtuKiosk

Kiosk Uptime

Overview

The Uptimes Report section provides administrators with the uptime status and heartbeat information for all registered kiosks. It helps monitor kiosk availability, connection status, and overall operational health over a selected time period.

Navigate to VirtuKiosk → Uptimes to view kiosk uptime reports.

Uptimes Report

The Uptimes Report displays the uptime details of all kiosks based on the selected filters.

Administrators can filter the report using:

Date Range
Kiosk

This makes it easier to analyze uptime information for a specific kiosk or a selected period.

Report Details

The report contains the following information:

Column	Description
Kiosk ID	Unique identifier assigned to the kiosk.
Title	Name of the kiosk.
City	Location where the kiosk is installed.
Event Date	Date on which the uptime record was generated.
First Heartbeat	Timestamp of the first heartbeat received from the kiosk.
Last Heartbeat	Timestamp of the most recent heartbeat received.
Uptime	Total uptime duration of the kiosk during the selected period.
Sessions	Number of kiosk sessions recorded.

Filters

The following filters are available to customize the report:

Date Range – Select a predefined or custom date range.
Kiosk – View uptime data for a specific kiosk or All kiosks.

Search Report

Use the Search field to quickly find a kiosk by its Kiosk ID, Title, or City.

The Show Entries option allows administrators to control the number of records displayed on each page.

Manage Uptime Reports

Administrators can:

Monitor kiosk availability.
View heartbeat information.
Track kiosk uptime.
Analyze kiosk sessions.
Filter reports by kiosk and date range.
Search for specific kiosk records.

Best Practices

Regularly monitor uptime reports to ensure kiosks remain online.
Review heartbeat timestamps to identify communication issues.
Investigate kiosks with low uptime or missing heartbeat records.
Use date filters to analyze kiosk performance over specific periods.

Important:
The Uptimes Report helps administrators monitor the operational status of kiosks by recording heartbeat activity, uptime duration, and session information. Regularly reviewing this report helps identify offline kiosks and maintain reliable kiosk performance.

VirtuKiosk

Services (Browse for Photo Print)

Overview

The Browsers section allows administrators to manage and register browsers that are used with VirtuKiosk. Each browser can be associated with a kiosk using unique browser and kiosk codes, enabling the application to identify and communicate with the correct browser instance.

Navigate to VirtuKiosk → Browsers to manage browser configurations.

Browser List

The Browsers page displays all registered browsers in a tabular format.

The table includes the following information:

Column	Description
Kiosk	Displays the associated kiosk name.
Kiosk Code	Unique code assigned to the kiosk.
Browser	Displays the registered browser name.
Browser Code	Unique identifier assigned to the browser.

If no browser has been registered, the system displays:

No Browser found. Please add a browser first.

Manage Browsers

Administrators can:

View all registered browsers.
Associate browsers with kiosks.
Verify kiosk and browser codes.
Manage browser configurations for supported kiosks.

Search Browsers

Use the available search and filter options to quickly locate a registered browser or kiosk.

Best Practices

Register each browser with the correct kiosk.
Verify that the Kiosk Code and Browser Code are correctly configured.
Remove or update browser configurations whenever necessary.
Keep browser information up to date for smooth kiosk operation.

Important:
A browser must be registered before it can be associated with a kiosk. Once configured, the browser can be used for supported VirtuKiosk operations and communication.

VirtuWeb

Note: VirtuWeb has been migrated to the new VirtuBox Console Backend.

Please refer to the VirtuBox A2 for VirtuWeb Configuration & Management process.

Modules

Anaytics (Report)

Overview

The Analytics Reports section provides administrators with insights into application data by generating reports based on selected filters. Reports can be used to analyze application activity for a specific time period and report type.

Generate a Report

To generate a report:

Navigate to Modules → Analytics → Reports.
Select the required Report type.
Choose the Date Range.
Select the required Key (if applicable).
The report data will be displayed automatically based on the selected filters.

Report Filters

Field	Description
Report For	Select the type of report you want to generate.
Date Range	Select the start and end dates for the report.
Keys	Select the required key or parameter for the selected report type, if available.

Report Results

After applying the filters, the report displays the available analytics data for the selected criteria.

If no records are available, the following message will be displayed:

No data available

This indicates that no analytics data exists for the selected report type, date range, or key.

Best Practices

Select the appropriate Report type before choosing other filters.
Use the correct Date Range to retrieve accurate analytics data.
Verify that data exists for the selected period if the report displays No data available.

Important:
Reports are generated based on the selected filters and the analytics data available within the system.

Modules

Analytics (All Reports)

Default Reports

The Default Reports section provides predefined analytical reports that help administrators monitor kiosk activity, orders, script executions, and form submissions. Each report can be viewed for its predefined date range and filtered by kiosk account.

Note:
All reports are generated based on the selected Date Range and Kiosk Account. If no records are available, the report will display No data available.

1. Account Report

The Account Report provides an overview of account activity, visitor statistics, orders, and responses collected during the selected date range.

Available Filters

Filter	Description
Date Range	Select the reporting period.
Account Timezone	Displays data according to the selected account timezone.
Select Kiosk Type	Select one or more kiosk accounts to generate the report.

Summary Cards

The report displays the following statistics:

Metric	Description
Total Orders	Total number of orders placed.
Total Script Responses	Total script responses received.
Total Form Responses	Total form submissions received.
Total	Combined total of all available responses.

Report Sections

Account Status

Displays the current status of the selected kiosk account.

Kiosk Visitors

Provides visitor statistics for the selected kiosk.

Visitors Interest Report

The report includes:

Column	Description
Created At (Date)	Date of activity.
Total Orders	Number of orders placed.
Total Script Responses	Number of script responses.
Total Form Responses	Number of form submissions.
Total	Combined total for the selected date.

Weekly Visitors

Displays visitor activity in a weekly graphical format for better trend analysis.

2. Orders Report

The Orders Report provides detailed insights into orders, package sales, product sales, and account transactions.

Available Filters

Filter	Description
Date Range	Select the reporting period.
Account Timezone	Displays report data according to the account timezone.
Select Kiosk Type	Select the kiosk account for analysis.

Report Sections

Order Status Count

Displays the total number of orders grouped by their current status.

Kiosk Orders

Displays order statistics for the selected kiosk.

Hourly Orders

Shows the hourly distribution of orders.

Packages Sales Report

Column	Description
Package Title	Name of the package.
Package Price	Price of the package.
Total Quantity	Total quantity sold.
Total Price	Total sales amount.

Product Sales Report

Column	Description
Product Title	Name of the product.
Total Quantity	Quantity sold.
Total Price	Total sales amount.

Account Sales

Column	Description
Created At (Date)	Transaction date.
Total Paid Amount	Successfully paid amount.
Total Unpaid Amount	Pending or unpaid amount.
Total Transaction	Total number of transactions.

Account Orders Hourly Report

Displays order activity for every hour of the selected period.

3. Orders Monthly Report

The Orders Monthly Report provides long-term transaction and order analytics for the selected kiosk account.

Available Filters

Filter	Description
Date Range	Select the reporting period.
Account Timezone	Displays report data based on the selected timezone.
Select Kiosk Type	Select the kiosk account to analyze.

Summary Cards

Metric	Description
Total Orders	Total number of orders.
Total Transactions	Overall transaction count.
Total Failed Transactions	Number of failed transactions.
Total Success Transactions	Number of successful transactions.

Account Monthly Orders

Displays monthly order statistics for the selected kiosk.

Kiosk Monthly Transactions

Column	Description
Kiosk	Kiosk account name.
Created At (Month)	Reporting month.
Total Paid Transactions	Successful paid transactions.
Total Unpaid Transactions	Pending or unpaid transactions.
Total Transactions	Overall monthly transactions.

Monthly Orders Status

Displays the monthly order trend using graphical visualization.

4. Script Responses Report

The Script Responses Report provides analytics related to scripts executed within the application.

Available Filters

Filter	Description
Date Range	Select the reporting period.
Account Timezone	Displays report data according to the selected timezone.
Select Kiosk Type	Select the kiosk account.

Report Sections

Script Responses - Bar Chart

Displays the total number of responses received for each script.

Kiosk Responses - Bar Chart

Displays script responses grouped by kiosk.

Script Responses Report

Column	Description
Script	Script name.
Total Responses	Number of responses received.

Kiosk Responses Report

Column	Description
Kiosk	Kiosk name.
Total Responses	Total responses generated.

Hourly Responses - Bar Chart

Displays script responses on an hourly basis.

Kiosk Scripts Responses

Column	Description
Kiosk	Kiosk account.
Script	Script name.
Total Responses	Total responses received.

Hourly Responses Report

Column	Description
Submitted At (Hour)	Hour of submission.
Total Responses	Number of responses during that hour.

Day Wise Responses - Line Chart

Displays script responses for each day of the week.

Day Wise Responses Report

Column	Description
Submitted At (Day)	Day of the week.
Total Responses	Total responses received.

5. Form Responses Report

The Form Responses Report provides detailed analytics for forms submitted by users through the application.

Available Filters

Filter	Description
Date Range	Select the reporting period.
Account Timezone	Displays report data according to the selected timezone.
Select Kiosk Type	Select the kiosk account.

Report Sections

Form Responses - Bar Chart

Displays the total responses received for each form.

Kiosk Responses - Bar Chart

Displays form responses grouped by kiosk.

Form Responses Report

Column	Description
Form ID	Identifier of the submitted form.
Total Responses	Number of responses received.

Kiosk Responses Report

Column	Description
Kiosk	Kiosk account.
Total Responses	Total form responses received.

Hourly Responses - Bar Chart

Displays form responses received every hour.

Kiosk Forms Responses

Column	Description
Kiosk	Kiosk account.
Form ID	Submitted form identifier.
Total Responses	Number of responses received.

Hourly Responses Report

Column	Description
Submitted At (Hour)	Hour of submission.
Total Responses	Responses received during that hour.

Day Wise Responses - Line Chart

Displays form submissions throughout the week.

Day Wise Responses Report

Column	Description
Submitted At (Day)	Day of the week.
Total Responses	Total responses received on that day.

Best Practices

Select the correct Date Range before analyzing reports.
Filter reports using the appropriate Kiosk Account for accurate analytics.
Review graphical charts alongside tabular reports for better trend analysis.
If a report displays No data available, verify that activity exists for the selected filters.

Important:
All analytics are generated from the data available in the selected Date Range and Kiosk Account. Reports are updated automatically as new data is collected.

Modules

Messages (Enquiry)

Overview

The Enquiry section allows administrators to view and manage enquiries submitted by users through the application. It provides filtering options to quickly locate enquiries based on status, date, and sorting preferences.

Inbox

The Inbox displays all enquiries received from users.

If no enquiries have been submitted, the following message is displayed:

Data Not Found

Filters

Administrators can use filters to quickly find specific enquiries.

Filter	Description
Order	Sort enquiries in Ascending or Descending order based on their creation date.
Status	Filter enquiries based on their current status.
Date Range	Display enquiries submitted within a selected date range.

After selecting the desired filters, click Apply to view the filtered results.

To remove all applied filters and restore the default view, click Clear.

Enquiry List

The Inbox displays all enquiries matching the selected filters.

Depending on the available data, the list contains enquiry details submitted by users.

If no enquiry matches the selected filters, the following message is displayed:

Data Not Found

Best Practices

Use the Status filter to quickly locate enquiries based on their current state.
Apply a Date Range to view enquiries received during a specific period.
Sort enquiries using the Order option for easier navigation.
Click Clear to reset all filters before performing a new search.

Important:
The enquiry list is updated according to the selected filters. If no matching records are available, the system displays Data Not Found.

Modules

Messages (Notifications)

Overview

The Notifications section allows administrators to view and manage all notifications generated by the application. Notifications include order updates, system alerts, and other important events associated with user activities.

Inbox

The Inbox displays all notifications in chronological order. Each notification contains information about the recipient, notification message, current status, and the date and time it was generated.

Filters

Use the available filters to quickly locate specific notifications.

Filter	Description
Order	Sort notifications in Ascending or Descending order.
Status	Filter notifications based on their current workflow status.
Date Range	Display notifications within a selected time period.

After selecting the required filters, click Apply to display the filtered notifications.

Click Clear to remove all applied filters and restore the default view.

Order Filter

The Order filter allows you to sort notifications based on their creation date.

Available options include:

Option	Description
Ascending	Displays the oldest notifications first.
Descending	Displays the latest notifications first.

Status Filter

The Status filter allows administrators to filter notifications according to their current workflow status.

Available status options may include:

Status	Description
NA	Displays notifications regardless of their current status.
New	Newly generated notifications awaiting review.
Open	Notifications that are currently active or being processed.
Acknowledged	Notifications that have been acknowledged by an administrator.
User Acknowledged	Notifications acknowledged by the end user.
Closed	Notifications that have been resolved and closed.
Reopened	Notifications that have been reopened for further action.

Note:
The available status options may vary depending on the application's notification workflow.

Date Range Filter

The Date Range filter provides multiple predefined options for quickly viewing notifications from a specific period.

Option	Description
Today	Displays notifications generated today.
Yesterday	Displays notifications generated yesterday.
Last 7 Days	Displays notifications from the previous seven days.
Last 30 Days	Displays notifications from the previous thirty days.
This Month	Displays notifications generated during the current month.
Last Month	Displays notifications generated during the previous month.
Custom Range	Allows you to manually select a start and end date.

Notification List

The Inbox displays all notifications matching the selected filters.

Each notification contains the following information:

Column	Description
Recipient	Name of the user who received the notification.
Notification	Displays the notification message, such as an order update or system alert.
Status	Indicates the current workflow status of the notification.
Created At	Displays the date and time when the notification was generated.

Example Notification

Recipient	Notification	Status	Created At
XYZ	Your Order [ID: 111111]	New	yyyy-mm-dd hh:mm:ss

Best Practices

Use the Order filter to quickly switch between the latest and oldest notifications.
Apply the Status filter to locate notifications based on their current workflow status.
Use the Date Range filter to analyze notifications from a specific period.
Select Custom Range when searching between two specific dates.
Click Clear to remove all applied filters before performing a new search.
Use multiple filters together for more accurate search results.

Important:
The notification list is updated according to the selected Order, Status, and Date Range filters. Any new notifications generated by the system will automatically appear in the Inbox.

Modules

Messages (Broadcast)

Overview

The Broadcast section allows administrators to create and send broadcast messages to users. It can be used to share announcements, promotional updates, important notifications, or product-related information. All previously sent broadcasts are available in the Broadcast History section.

Broadcast Message

The Broadcast Message form is used to create a new broadcast.

Broadcast Fields

Field	Description
Title	Enter the title of the broadcast message. Maximum 255 characters.
Product	Select the product associated with the broadcast message (Optional).
Message	Enter the broadcast message to be sent. Maximum 5000 characters.

How to Create a Broadcast

Navigate to Messages → Broadcast.
Enter the Title.
Select a Product (if required).
Enter the Message.
Click Submit to send the broadcast.

Note:
If no product is selected, the broadcast can be sent as a general announcement.

Broadcast History

The Broadcast History section displays all previously sent broadcast messages.

If no broadcasts have been sent, the following message is displayed:

Data Not Found

Filters

Use the available filters to quickly locate broadcast messages.

Filter	Description
Order	Sort broadcast records in Ascending or Descending order.
Status	Filter broadcasts based on their current workflow status.
Date Range	Display broadcasts sent during a selected time period.

After selecting the required filters, click Apply to display the filtered records.

Click Clear to remove all applied filters.

Order Filter

The Order filter controls how broadcast records are displayed.

Option	Description
Ascending	Displays the oldest broadcasts first.
Descending	Displays the latest broadcasts first.

Status Filter

The Status filter allows administrators to filter broadcast messages based on their workflow status.

Available status options may include:

Status	Description
NA	Displays all broadcast messages regardless of status.
New	Newly created broadcast messages.
Open	Broadcasts that are currently active.
Acknowledged	Broadcasts acknowledged by administrators.
User Acknowledged	Broadcasts acknowledged by users.
Closed	Broadcasts that have been completed or closed.
Reopened	Previously closed broadcasts that have been reopened.

Note:
Available status options may vary depending on the application configuration.

Date Range Filter

Use the Date Range filter to display broadcast history for a specific period.

Available options include:

Option	Description
Today	Displays broadcasts sent today.
Yesterday	Displays broadcasts sent yesterday.
Last 7 Days	Displays broadcasts sent during the previous seven days.
Last 30 Days	Displays broadcasts sent during the previous thirty days.
This Month	Displays broadcasts sent during the current month.
Last Month	Displays broadcasts sent during the previous month.
Custom Range	Allows administrators to manually select a start and end date.

Best Practices

Use a clear and descriptive Title for every broadcast.
Keep the Message concise and informative.
Associate the broadcast with a Product whenever the announcement is product-specific.
Use the available filters to quickly locate previous broadcast messages.
Review the Broadcast History before creating duplicate announcements.

Important:
After entering the required information, click Submit to send the broadcast message. All sent broadcasts will be recorded in the Broadcast History section.

Modules

Videos (Add Videos)

Overview

The Add Video section allows administrators to upload videos that can be displayed within the application. Each video can include a title, description, and the associated video file.

Add a New Video

To upload a new video:

Navigate to Modules → Videos → Add Video.
Enter the required video details.
Upload the video file.
Click Submit to save the video.

Video Fields

Field	Description
Video Title	Enter the title of the video. Maximum 255 characters.
Description	Enter a brief description of the video. Maximum 5000 characters.
Video File	Upload the video file that will be displayed in the application.

How to Upload a Video

Enter the Video Title.
Add a Description (optional but recommended).
Click Choose File and select the desired video from your device.
Verify all entered information.
Click Submit to upload and save the video.

Best Practices

Use a clear and descriptive Video Title.
Add a meaningful Description to help users understand the video's content.
Ensure the selected video file is correct before uploading.
Keep video content relevant to the associated application or product.

Important:
The video will not be uploaded or saved until you click the Submit button.

Modules

Videos (Video)

Overview

The Videos section allows administrators to view, edit, and manage all uploaded videos. Administrators can update video information, assign products and categories, and control the visibility and playback settings of each video.

Edit Video

To modify an existing video:

Navigate to Modules → Videos.
Select the video you want to edit.
Update the required information.
Click Submit to save the changes.

Video Details

Field	Description
Video Title	Enter or update the video title. Maximum 255 characters.
Description	Enter or modify the video description. Maximum 5000 characters.
Select Products	Associate the video with one or more products.
Select Category	Assign the video to the appropriate category.

Video Management Options

The following actions are available for each uploaded video:

Option	Description
Published	Makes the video visible within the application.
Unpublished	Hides the video from the application without deleting it.
Muted	Plays the video without audio.
Unmuted	Enables audio playback for the video.
Delete	Permanently removes the selected video from the application.

How to Edit a Video

Open Modules → Videos.
Select the required video.
Update the Video Title or Description, if needed.
Select the appropriate Products.
Assign the required Category.
Configure the required video options such as Published, Muted, or Unmuted.
Click Submit to save the changes.

Best Practices

Use descriptive video titles for easier identification.
Assign videos to the correct Products and Categories for better organization.
Publish videos only after verifying their content.
Use the Mute option when videos should play without audio in kiosk environments.
Delete videos only when they are no longer required.

Important:
Any modifications made to a video, including product assignment, category selection, publish status, or audio settings, will not be applied until you click the Submit button.

Modules

Files (Add Files)

Overview

The Add Files section allows administrators to upload and manage various types of media and resource files used throughout the application. These files can be associated with products, categories, pages, and other application content.

Supported file types include:

Images
Videos
3D Files
Documents
PDF Files
Fonts
Animations

Upload Files

To upload a new file:

Navigate to Files → Add Files.
Click the upload area or drag and drop the file.
Select the required file from your device.
Wait for the upload to complete.
Click Submit to save the uploaded file.

Supported File Types

File Type	Description
Image	Upload images used for products, banners, galleries, and other visual content.
Video	Upload video files to be used within the application.
3D	Upload supported 3D models for interactive content.
Document	Upload documents such as Word files or other supported document formats.
PDF	Upload PDF files for brochures, manuals, catalogs, or other downloadable resources.
Font	Upload custom fonts for application styling.
Animation	Upload animation files used within the application.

Image Requirements

For image uploads, the following size restrictions apply:

Requirement	Value
Minimum Image Size	10 × 10 px
Maximum Image Size	4000 × 4000 px

Note:
Image files must be within the supported dimensions to ensure successful upload.

Best Practices

Upload high-quality files for the best user experience.
Use meaningful file names for easier identification and management.
Verify the selected file before uploading.
Ensure uploaded files are appropriate for their intended use within the application.

Important:
After selecting or dragging and dropping the required files, click Submit to complete the upload process. Files will not be available in the application until they have been successfully uploaded.

Modules

Files (Files)

Overview

The Files List section provides a centralized view of all uploaded files available in the application. It allows administrators to search, monitor, and manage uploaded media and documents from a single location.

The list displays important information about each uploaded file, including its type, size, dimensions, usage, publish status, and last modification date.

Files List

Navigate to Modules → Files to view all uploaded files.

The page includes the following features:

View all uploaded files.
Search files by title.
Display a specific number of records per page.
Monitor file usage across the application.
Manage published and unpublished files.

Files Information

Each uploaded file displays the following details:

Column	Description
#	Serial number of the record.
ID	Unique system-generated identifier for the file.
Title	Name of the uploaded file.
Type	Displays the file type (Image, Video, 3D, Document, PDF, etc.).
Extension (Ext)	File extension such as jpeg, png, mp4, pdf, etc.
Size (MB)	Displays the file size in megabytes.
Pixel	Displays the image resolution (for image files only).
Packages	Indicates the number of packages where the file is currently being used.
Media Files	Displays how many media records are associated with the uploaded file.
Published	Indicates whether the file is currently published and available in the application.
Modified	Displays the date and time when the file was last updated.

Search Files

The Search option allows administrators to quickly locate uploaded files by entering the file name or relevant keywords.

Entries

Use the Show Entries option to control how many records are displayed on a single page (e.g., 10, 25, 50, or 100 entries).

File Management

Administrators can manage uploaded files directly from the Files List.

Depending on the file type and system configuration, available actions may include:

View file details
Edit file information
Publish / Unpublish files
Delete files
Monitor package usage
View associated media files

Best Practices

Use descriptive file names for easy identification.
Regularly review unused files to keep the file library organized.
Verify file size and dimensions before publishing.
Publish files only after confirming they are ready for use.
Use the Search feature to quickly locate uploaded files in large collections.

Important:
The Files List provides a complete overview of all uploaded files. Any changes made to a file, such as editing details or changing its publish status, should be saved using the available action before they are reflected throughout the application.

Modules

Files (Image)

Overview

The Images section serves as a centralized media library where administrators can view, manage, edit, and organize all uploaded image files. Images uploaded here can be reused across multiple modules within the application, including Products, Categories, Banners, Resources, Forms, and other supported sections.

Administrators can browse uploaded images, modify image details, control their visibility, or permanently remove images when they are no longer required.

Image Library

Navigate to Modules → Images to access the image library.

All uploaded images are displayed as thumbnail cards, making it easy to identify files visually.

Each image card displays:

Image Preview
File Name
File Extension
File Type

Example:

File Name	Extension	Type
image 1.jpeg	JPEG	Image
image 2 .jpeg	JPEG	Image

Browse Images

The Images page provides a quick overview of all uploaded image files.

Administrators can:

Browse image thumbnails.
Identify images using their file names.
View image type and extension.
Open any image for editing.
Manage images from a single location.

Edit an Image

To modify an existing image:

Navigate to Files → Images.
Select the desired image.
Update the required information.
Click Submit to save the changes.

Image Details

The Edit Image page contains the following fields:

Field	Description
Title	Displays or updates the name of the uploaded image.
Status	Controls whether the image is available for use within the application.

Image Status

Administrators can control the visibility of an image using the Status option.

Status	Description
Published	Makes the image available throughout the application. Published images can be selected in supported modules such as Products, Categories, Banners, Resources, Forms, and other content sections.
Unpublished	Hides the image from the application while keeping it stored in the media library. The image can be published again whenever required.

Delete an Image

If an image is no longer required, it can be permanently removed.

To delete an image:

Open the required image.
Click Delete.
Confirm the deletion.

Warning:
Deleting an image permanently removes it from the media library. If the image is already being used within Products, Categories, Banners, Resources, or any other module, it may no longer be displayed in those sections.

Image Usage

Uploaded images can be used across various modules of the application, including:

Products
Categories
Banners
Resources
Forms
Pages
Galleries
Other supported modules

Publishing an image makes it available for selection wherever image resources are supported.

How to Manage Images

Navigate to Files → Images.
Browse the available image library.
Select an image to open the Edit Image page.
Update the Title, if required.
Change the Status to Published or Unpublished.
Click Submit to save the changes.
Use Delete if the image is no longer required.

Best Practices

Use descriptive image titles for easier identification.
Upload high-quality images for the best display experience.
Publish images only after verifying they are ready for use.
Use the Unpublished option instead of deleting images that may be required later.
Delete images only after confirming they are not being used in other modules.
Organize uploaded images to keep the media library clean and easy to manage.

Important:
Any changes made to an image, including updating its Title or changing its Status, will not be saved until you click the Submit button. Images can also be permanently removed using the Delete option when they are no longer needed.

Modules

Files (Animation)

Overview

The Animation section allows administrators to upload and manage animation files that can be used throughout the application. Animation files help enhance the user experience by adding dynamic visual effects to supported modules.

Administrators can upload new animation files, browse existing animations, edit their details, and manage their availability within the application.

Add Animation

To upload a new animation file:

Navigate to Files → Animation.
Click the upload area or drag and drop the animation file.
Select the required file from your device.
Click Submit to complete the upload.

If no file is selected, the following message is displayed:

Please add a file first.

Upload Animation

The upload page contains the following option:

Field	Description
Add Files	Drag and drop the animation file or click the upload area to browse files from your device.

Supported Upload

Animation files can be uploaded by:

Dragging and dropping the file into the upload area.
Clicking Drop files or click here and selecting the file manually.

Image Size Requirement

If the uploaded animation contains image assets, the supported image dimensions are:

Requirement	Value
Minimum Size	10 × 10 px
Maximum Size	4000 × 4000 px

Animation Library

After uploading, animation files become available in the Animation library, where administrators can manage and reuse them throughout the application.

Depending on the application configuration, administrators can:

View uploaded animations.
Edit animation information.
Publish or Unpublish animations.
Delete animations.
Reuse animations across supported modules.

How to Upload an Animation

Navigate to Files → Animation.
Click Drop files or click here.
Select the required animation file.
Verify the selected file.
Click Submit to upload and save the animation.

Best Practices

Upload only supported animation files.
Use meaningful file names for easier identification.
Verify the selected file before uploading.
Keep animation files optimized for better application performance.
Remove unused animations to keep the media library organized.

Important:
Animation files are not uploaded until you click the Submit button. If no file is selected, the system displays "Please add a file first."

Modules

Files (Video)

Overview

The Video section allows administrators to upload, view, edit, and manage all video files available in the application. Uploaded videos can be associated with products and categories, making them easily accessible across supported modules.

Administrators can also control the visibility of videos by publishing or unpublishing them and remove videos that are no longer required.

Video Library

Navigate to Files → Video to access the video library.

All uploaded videos are displayed in a list with their file name, extension, and file type for easy identification.

Example:

File Name	Extension	Type
Video YYYY-MM-DD...	MP4	Video

Add Video

To upload a new video:

Navigate to Files → Add Files.
Drag and drop the video file into the upload area or click Drop files or click here.
Select the required video file.
Click Submit to upload the video.

If no file is selected, the system displays:

Please add a file first.

Upload Methods

You can upload a video by:

Dragging and dropping the video file.
Clicking Drop files or click here and selecting a file from your device.

Edit Video

To modify an uploaded video:

Navigate to Files → Video.
Open the required video.
Update the required information.
Click Update to save the changes.

Video Details

The Edit Video page contains the following fields:

Field	Description
Title	Displays or updates the video title.
Description	Add or modify the video description.
Select Products	Associate the video with one or more products. The selected product IDs or names will be displayed after mapping.
Select Category	Assign the video to one or more categories. The selected category IDs or names will be displayed after mapping.
Status	Control whether the video is available within the application.

Video Status

The visibility of a video is managed using the Status option.

Status	Description
Published	Makes the video available throughout the application.
Unpublished	Hides the video while keeping it stored in the media library.

Delete Video

Administrators can permanently remove videos that are no longer required.

To delete a video:

Open the required video.
Click Delete.
Confirm the deletion.

Warning:
Deleting a video permanently removes it from the media library. If the video is mapped to products or categories, it will no longer be available in those locations.

Video Mapping

Videos can be linked to application content for better organization.

Supported mappings include:

Products
Categories

Once a product or category is selected, the associated mapping (ID or Name) is displayed on the edit page.

How to Manage Videos

Navigate to Files → Video.
Browse the available videos.
Select a video to open the Edit Video page.
Update the Title or Description, if required.
Map the video to the desired Product and Category.
Set the Status to Published or Unpublished.
Click Update to save the changes.
Use Delete if the video is no longer required.

Best Practices

Use meaningful video titles for easy identification.
Add a clear description to explain the video's purpose.
Map videos to the correct products and categories.
Publish videos only after verifying their content.
Use Unpublished instead of deleting videos that may be required in the future.
Delete videos only after confirming they are no longer used anywhere in the application.

Important:
Any modifications made to a video, including updating its details, changing its status, or mapping it to products and categories, will not be applied until you click the Update button.

Modules

Files (Audio)

Overview

The Audio section allows administrators to upload, view, edit, and manage audio files within the application. Uploaded audio files can be used wherever audio content is supported.

Administrators can publish, unpublish, edit, or delete audio files as required.

Audio Library

Navigate to Files → Audio to access the Audio library.

All uploaded audio files are displayed in a list, making it easy to identify and manage them.

Add Audio

To upload a new audio file:

Navigate to Files → Add Files.
Drag and drop the audio file into the upload area or click Drop files or click here.
Select the required audio file.
Click Submit to upload the file.

If no file is selected, the system displays:

Please add a file first.

Edit Audio

To modify an uploaded audio file:

Navigate to Files → Audio.
Open the required audio file.
Update the Title, if required.
Change the Status.
Click Update to save the changes.

Audio Details

The Edit Audio page contains the following fields:

Field	Description
Title	Displays or updates the audio file name.
Status	Controls the visibility of the audio file within the application.

Audio Status

The visibility of an audio file is controlled using the Status option.

Status	Description
Published	Makes the audio file available for use within the application.
Unpublished	Hides the audio file while keeping it stored in the media library.

Delete Audio

Administrators can permanently remove audio files that are no longer required.

To delete an audio file:

Open the required audio.
Click Delete.
Confirm the deletion.

Warning:
Deleting an audio file permanently removes it from the application and it cannot be recovered.

Manage Audio Files

Administrators can:

Upload audio files.
View uploaded audio files.
Edit audio details.
Publish or Unpublish audio files.
Delete audio files.

Best Practices

Use meaningful audio file names for easy identification.
Publish audio files only after verifying the content.
Use Unpublished instead of deleting files that may be required later.
Remove unused audio files to keep the media library organized.

Important:
Any changes made to an audio file, including updating its Title or changing its Status, will not be saved until you click the Update button.

Modules

Files (Font)

Overview

The Font section allows administrators to upload and manage custom font files used within the application. These fonts are primarily used to customize the appearance of text displayed on the Kiosk, ensuring it matches the desired branding and design requirements.

Custom fonts can be used for headings, product names, category titles, buttons, and other supported text elements.

Font Library

Navigate to Files → Font to access the Font library.

All uploaded font files are available here and can be used wherever custom fonts are supported.

Add Font

To upload a new font:

Navigate to Files → Add Files.
Drag and drop the font file into the upload area or click Drop files or click here.
Select the required font file.
Click Submit to upload the font.

If no file is selected, the system displays:

Please add a file first.

Font Usage

Uploaded fonts are primarily used to customize text displayed on the Kiosk.

Fonts can be applied to supported text elements such as:

Headings
Product Names
Category Titles
Buttons
Labels
Other supported text components

Once the font is uploaded, it becomes available for selection in the Kiosk Font Settings.

Edit Font

To modify an uploaded font:

Navigate to Files → Font.
Select the required font.
Update the Title, if required.
Click Update to save the changes.

Font Details

The Edit Font page contains the following field:

Field	Description
Title	Displays or updates the name of the uploaded font.

Delete Font

Administrators can permanently remove fonts that are no longer required.

To delete a font:

Open the required font.
Click Delete.
Confirm the deletion.

Warning:
Deleting a font may affect the appearance of Kiosk content that is currently using that font.

How Fonts Work

When a custom font is required for the Kiosk, administrators must first upload the corresponding font file in the Font section.

After uploading, the font becomes available in the Kiosk Font Settings, where it can be assigned to different text styles such as Regular, Bold, Italic, and Bold Italic.

This allows organizations to maintain consistent branding and customize the overall appearance of the Kiosk interface.

Best Practices

Upload supported font file formats.
Use meaningful font names for easy identification.
Verify the font appearance before applying it to the Kiosk.
Keep only the required fonts in the library to maintain better organization.

Important:
After uploading or editing a font, click the Update button to save the changes. The uploaded font can then be selected from the Kiosk Font Settings and applied to supported text elements.

Modules

Files (3d)

Overview

The 3D section allows administrators to upload, view, edit, and manage 3D model files within the application. These files can be used to provide an interactive 3D viewing experience for supported products.

Administrators can publish, unpublish, edit, or delete 3D files as required.

3D Library

Navigate to Files → 3D to access the 3D library.

All uploaded 3D files are displayed in a list, making them easy to identify and manage.

Add 3D File

To upload a new 3D file:

Navigate to Files → Add Files.
Drag and drop the 3D file into the upload area or click Drop files or click here.
Select the required 3D file.
Click Submit to upload the file.

If no file is selected, the system displays:

Please add a file first.

Edit 3D File

To modify an uploaded 3D file:

Navigate to Files → 3D.
Open the required 3D file.
Update the Title, if required.
Change the Status.
Click Update to save the changes.

3D File Details

The Edit 3D File page contains the following fields:

Field	Description
Title	Displays or updates the name of the 3D file.
Status	Controls whether the 3D file is available within the application.

3D File Status

The visibility of a 3D file is managed using the Status option.

Status	Description
Published	Makes the 3D file available for use within the application.
Unpublished	Hides the 3D file while keeping it stored in the media library.

Delete 3D File

Administrators can permanently remove 3D files that are no longer required.

To delete a 3D file:

Open the required 3D file.
Click Delete.
Confirm the deletion.

Warning:
Deleting a 3D file permanently removes it from the application and it cannot be recovered.

Manage 3D Files

Administrators can:

Upload 3D files.
View uploaded 3D files.
Edit file details.
Publish or Unpublish 3D files.
Delete 3D files.

Best Practices

Upload supported and optimized 3D models for better performance.
Use meaningful file names for easier identification.
Publish 3D files only after verifying the model.
Use Unpublished instead of deleting files that may be required later.
Remove unused 3D files to keep the media library organized.

Important:
Any changes made to a 3D file, including updating its Title or changing its Status, will not be saved until you click the Update button.

Modules

Files (Pdf)

Overview

The PDF section allows administrators to upload, view, edit, and manage PDF files within the application. PDF files can be used for catalogs, brochures, manuals, technical documents, user guides, and other downloadable resources.

Administrators can publish, unpublish, edit, or delete PDF files as required.

PDF Library

Navigate to Files → PDF to access the PDF library.

All uploaded PDF files are displayed in a list, making them easy to identify and manage.

Add PDF

To upload a new PDF file:

Navigate to Files → Add Files.
Drag and drop the PDF file into the upload area or click Drop files or click here.
Select the required PDF file.
Click Submit to upload the file.

If no file is selected, the system displays:

Please add a file first.

Edit PDF

To modify an uploaded PDF file:

Navigate to Files → PDF.
Open the required PDF file.
Update the Title, if required.
Change the Status.
Click Update to save the changes.

PDF Details

The Edit PDF page contains the following fields:

Field	Description
Title	Displays or updates the name of the PDF file.
Status	Controls whether the PDF file is available within the application.

PDF Status

The visibility of a PDF file is managed using the Status option.

Status	Description
Published	Makes the PDF file available for use within the application.
Unpublished	Hides the PDF file while keeping it stored in the media library.

Delete PDF

Administrators can permanently remove PDF files that are no longer required.

To delete a PDF file:

Open the required PDF file.
Click Delete.
Confirm the deletion.

Warning:
Deleting a PDF file permanently removes it from the application and cannot be recovered.

Manage PDF Files

Administrators can:

Upload PDF files.
View uploaded PDF files.
Edit PDF details.
Publish or Unpublish PDF files.
Delete PDF files.

Best Practices

Upload clear and properly formatted PDF documents.
Use meaningful file names for easy identification.
Publish PDF files only after verifying their content.
Use Unpublished instead of deleting files that may be required later.
Remove outdated or unused PDF files to keep the media library organized.

Important:
Any changes made to a PDF file, including updating its Title or changing its Status, will not be saved until you click the Update button.

Modules

Files (Document)

Overview

The Document section allows administrators to upload, view, edit, and manage document files within the application. Document files can be used for manuals, user guides, brochures, reports, technical documents, and other supported file types.

Administrators can publish, unpublish, edit, or delete document files as required.

Document Library

Navigate to Files → Document to access the Document library.

All uploaded document files are displayed in a list, making them easy to identify and manage.

Add Document

To upload a new document:

Navigate to Files → Add Files.
Drag and drop the document into the upload area or click Drop files or click here.
Select the required document from your device.
Click Submit to upload the document.

If no document is selected, the system displays:

Please add a file first.

Edit Document

To modify an uploaded document:

Navigate to Files → Document.
Open the required document.
Update the Title, if required.
Change the Status.
Click Update to save the changes.

Document Details

The Edit Document page contains the following fields:

Field	Description
Title	Displays or updates the name of the document.
Status	Controls whether the document is available within the application.

Document Status

The visibility of a document is managed using the Status option.

Status	Description
Published	Makes the document available for use throughout the application.
Unpublished	Hides the document while keeping it stored in the Document library.

Delete Document

Administrators can permanently remove documents that are no longer required.

To delete a document:

Open the required document.
Click Delete.
Confirm the deletion.

Warning:
Deleting a document permanently removes it from the application and cannot be recovered.

Manage Documents

Administrators can:

Upload document files.
View uploaded documents.
Edit document details.
Publish or Unpublish documents.
Delete documents.

Best Practices

Upload only supported document formats.
Use meaningful document titles for easy identification.
Publish documents only after verifying their content.
Use Unpublished instead of deleting documents that may be required in the future.
Remove outdated or unused documents to keep the document library organized.

Important:
Any changes made to a document, including updating its Title or changing its Status, will not be saved until you click the Update button.

Modules

Form (Add Form)

Overview

The Add Form feature allows users to create a new form by configuring its title, description, footer details, and submit button. Users can also control whether the form title is displayed.

Accessing the New Form

To access the New Form page:

Log in to the VirtuBox Business backend.
Go to Modules -> Forms module.
Click on Add Form to open the form creation page.

Form Configuration

The New Form page provides the following configuration fields:

Field	Description	Character Limit
Title	Enter the title of the form.	500
Description	Provide a description or additional information about the form.	5,000
Footer Title	Enter the title to be displayed in the form footer.	500
Footer Message	Enter a message or additional information to be displayed in the footer.	5,000
Submit Button	Specify the text to be displayed on the form submission button.	50
Show Title	Enable or disable the display of the form title.	—

Configuration Details

1. Title

Enter a suitable title for the form.

Maximum Length: 500 characters.

2. Description

Provide a description of the form to explain its purpose or provide instructions to users.

Maximum Length: 5,000 characters.

Enter a title for the footer section of the form.

Maximum Length: 500 characters.

4. Footer Message

Enter a message to be displayed in the footer section.

Maximum Length: 5,000 characters.

5. Submit Button

Enter the label for the form submission button.

Maximum Length: 50 characters.

6. Show Title

The Show Title checkbox controls whether the form title is displayed.

Enabled: The form title is displayed.
Disabled: The form title is hidden.

Default Behavior: The Show Title checkbox is enabled by default.

Saving the Form

After entering the required information:

Review the configured form details.
Click the Save button to save the form.

Note: Ensure that all required fields are completed and the entered information meets the specified character limits before saving.

Modules

Form (Forms)

Overview

The Forms module in VirtuBox Business allows users to create and manage customized forms by organizing them into pages and adding different types of questions.

The form creation process follows a structured workflow:

Create Form → Add Page → Add Questions → Publish Changes Using Make Live

Important: Whenever any changes are made to an existing form, users must click the Make Live button to ensure that the latest changes are reflected in the live form.

Accessing the Forms Module

To access the Forms module:

Log in to the VirtuBox Business backend.
Navigate to the Modules -> Forms module.
The Forms page displays a list of available forms.
Click Add New Form to create a new form.

The Forms page also provides the following options:

Add New Form: Create a new form.
Form Responses: View submitted form responses.
Form Products: Manage product associations with forms.

Form Creation Workflow

Creating a form involves the following steps:

Create a new form.
Add one or more pages to the form.
Add questions to each page.
Configure the question types and settings.
Publish the changes using the Make Live option.

Step 1: Create a New Form

To create a new form:

Navigate to the Forms module.
Click Add New Form.
Enter the required form details.

Form Configuration

Field	Description	Character Limit
Title	Enter the title of the form.	500
Description	Provide a description or instructions for the form.	5,000
Footer Title	Enter a title for the footer section.	500
Footer Message	Enter a message to be displayed in the footer.	5,000
Submit Button	Specify the label for the submission button.	50
Show Title	Enable or disable the display of the form title.	—

Configure the required fields.
Click Save to create the form.

After successfully creating the form, it will be available in the Forms list.

Step 2: Add a Page to the Form

Once the form has been created, users can organize its content into separate pages.

To add a new page:

Open the Forms module.
Select the form you want to configure.
Open the Form Info page.
Click Add New Page.
Enter the page details.

Page Configuration

Field	Description	Character Limit
Title	Enter the title of the page.	500
Description	Provide a description or instructions for the page.	5,000

Click Save to create the page.

Note: Pages help organize questions into separate sections within a form.

Step 3: Add Questions to a Page

After creating a page, users can add questions to collect information from end users.

To add a new question:

Open the Form Info page.
Select the page where you want to add a question.
Click Add New Question.
Configure the question details.

Question Configuration

Field	Description
Question	Enter the question or label to be displayed to the user.
Description	Provide additional information or instructions for the question.
Page	Select the page to which the question belongs.
Required	Mark the question as mandatory or optional.
Type	Select the appropriate question type.
Config	Configure additional settings based on the selected question type.
Thermal Printer	Displays thermal printer compatibility information based on the selected question type.

Question Types

The Type field allows users to select different types of questions based on the information they want to collect.

Note: The available configuration options may vary depending on the selected question type.

Configure the question settings.
Click Save to add the question to the selected page.

Repeat this process to add multiple questions to the form.

Step 4: Manage Form Pages and Questions

After creating pages and adding questions, users can manage the form structure from the Form Info page.

The Form Info page provides options to:

Add new pages.
Add new questions.
Edit existing pages and questions.
Preview the form in draft mode.
View the form in live mode.
Access form responses.
Manage form response files.
Configure form templates.
Publish the latest changes using Make Live.

Step 5: Make the Form Live

The Make Live option is used to publish the latest form changes so that they are reflected in the live version of the form.

When to Use Make Live

Users must click Make Live whenever changes are made to the form, including:

Updating the form title or description.
Adding or editing pages.
Adding, editing, or removing questions.
Modifying question configurations.
Updating other form-related settings.

Steps to Publish Changes

Open the required form from the Forms module.
Make the necessary changes to the form, pages, or questions.
Save the changes where applicable.
Click the Make Live button on the Form Info page.
Confirm the action if prompted.

Important: Saving changes alone may not update the live version of the form. Always click Make Live after making changes to ensure that the updated content is reflected in the live form.

Form Structure

The form follows a hierarchical structure:

Form
- Form Details
- Page 1
  - Question 1
  - Question 2
  - Question 3
- Page 2
  - Question 1
  - Question 2
- Additional Pages and Questions

This structure allows users to organize form content efficiently and create a clear experience for end users.

Important Notes

A form must be created before pages can be added.
Pages must be created before questions can be assigned to them.
Questions can be configured using different question types.
Changes made to a form, its pages, or its questions must be published using Make Live.
Always verify the live form after publishing changes to ensure that the updated content is displayed correctly.

Modules

Form (Form responses)

Overview

The Form Responses feature allows users to view and manage the responses submitted by end users through the created forms.

Accessing Form Responses

To access form responses:

Navigate to the Forms module.
Click on the Form Responses button.
The Form Responses page displays a list of submitted responses.

Form Responses Information

The Form Responses page provides the following details:

Field	Description
#	Displays the serial number of the response.
Response ID	Displays the unique ID assigned to each response.
Response Code	Displays the unique response code associated with the submission.
Form	Displays the name of the form through which the response was submitted.
Version ID	Displays the version ID of the form used for the submission.
Source	Displays the source from which the response was submitted, such as the Kiosk App Android.
Time	Displays the time elapsed since the response was submitted.
Type	Displays the response type, such as Live.
Action	Provides options to view and manage individual responses.

Response Actions

The Action column provides options to perform operations on individual form responses, such as:

View: View the details of the submitted response.
Response Details: Access the submitted response information.
Download: Download response-related files, where applicable.

Note: The available actions may vary depending on the response and the permissions assigned to the user.

Viewing Submitted Responses

To view a submitted response:

Open the Form Responses page.
Locate the required response from the list.
Click the relevant action icon in the Action column.
Review the submitted response details.

Modules

Script (Add Script)

Overview

The Script Info section allows administrators to create, manage, and configure custom scripts within the application. Scripts can be used to add custom functionality, execute JavaScript code, integrate third-party services, or extend the application's behavior wherever script support is available.

Add Script

To create a new script:

Navigate to Scripts → Script Info.
Click Add Script.
Enter the Title.
Enter a unique Slug.
Write or paste the required code in the Editor.
Preview the script if required.
Click Submit to save the script.

If no script is added, the system displays:

Please add a script first.

Script Details

The following fields are available while creating a script:

Field	Description
Title	Enter a unique and meaningful name for the script.
Slug	Enter a unique identifier used to reference the script.
Preview	Displays a preview of the script before saving.
Editor	Code editor used to write or modify the script.
Code	Displays the script content.
Script	Contains the custom script or JavaScript code to be executed.

Script Mapping

After creating a script, administrators can associate it with specific application content.

A script can be mapped to:

Categories
Products
Packages (where supported)

Mapping ensures that the script executes only for the selected content instead of affecting the entire application.

For example:

A script mapped to a Category will execute only when that category is accessed.
A script mapped to a Product will execute only for the selected product.

This provides better control over where and how custom scripts are applied.

Code Copy to Editor

The Code Copy to Editor option allows administrators to quickly copy the generated or existing script into the editor for further modification.

This helps simplify editing without manually copying and pasting the code.

Submit

After completing the script configuration and mapping, click Submit to save the script.

Once submitted, the script becomes available for use within the selected Categories, Products, or other supported modules.

Manage Scripts

Administrators can:

Create new scripts.
Edit existing scripts.
Preview script content.
Write custom JavaScript code.
Copy code into the editor.
Map scripts to Categories and Products.
Update or remove script mappings.
Save scripts for use within the application.

Best Practices

Use meaningful script titles.
Keep the Slug unique for every script.
Test scripts before deploying them in production.
Map scripts only to the required Categories or Products.
Review the script code before saving.
Update scripts carefully to avoid affecting dependent features.

Important:
A script is saved only after clicking the Submit button. Before saving, verify the script code and ensure it is mapped to the correct Category or Product. You can use the Code Copy to Editor option to quickly copy and modify existing code before submission.

Modules

Script (Scripts)

Overview

The Scripts section displays all the scripts that have been created within the application. From this page, administrators can view, organize, edit, and manage existing scripts.

It serves as the central location for managing all custom scripts used throughout the application.

Scripts List

Navigate to Modules → Scripts → Scripts to view all available scripts.

Each script is displayed in a tabular format with its basic information.

Script Details

The Scripts list contains the following information:

Column	Description
#	Serial number of the script.
Title	Displays the name of the script.
Modified At	Shows when the script was last updated.
Action	Provides options to manage the selected script.

Script Actions

Using the Action menu, administrators can:

View script details.
Edit existing scripts.
Update script information.
Manage script configurations.
Delete scripts, if no longer required.

Set Rank

The Set Rank option allows administrators to define the execution or display order of scripts.

Scripts with a higher priority or lower rank value can be arranged to execute before others, depending on the application configuration.

Search Scripts

Use the Search field to quickly locate a specific script by its title.

The Show Entries option allows administrators to control the number of scripts displayed on a single page.

Manage Scripts

Administrators can:

View all available scripts.
Search for specific scripts.
Edit existing scripts.
Delete unused scripts.
Organize scripts using the Set Rank option.

Best Practices

Use meaningful script titles for easy identification.
Keep scripts organized using Set Rank.
Remove unused scripts to maintain a clean environment.
Review scripts before editing or deleting them.

Important:
All scripts created through the Script Info section are listed here. From this page, administrators can manage, organize, and update scripts whenever required.

Modules

Script (Script Responses)

Overview

The Script Responses (Live) section displays all responses generated by scripts in real time. Whenever a script is executed from the Kiosk or another supported source, its response is automatically recorded and made available for monitoring.

This section helps administrators track script execution, verify response details, analyze generated data, and troubleshoot script-related issues.

Script Responses

Navigate to Modules → Scripts → Script Responses (Live) to view all recorded script responses.

Each response contains important execution details and provides quick access to the complete response information.

Response Details

The Script Responses table displays the following information:

Column	Description
#	Serial number of the response.
Response ID	Unique identifier generated for each script response.
Response Code	Unique code generated after successful execution.
Script	Name of the executed script.
Source	Displays the source from which the script was executed (e.g., Kiosk App Android).
Time	Indicates when the response was received.
Action	Provides options to view or download the response.

View Script Response

Clicking the View/Open option from the Action menu opens the complete response details for the selected script.

The response page contains the following information:

Field	Description
Script Title	Displays the name of the executed script.
Script Published At	Shows the date and time when the script was published.
Response ID	Unique identifier assigned to the response.
Response Code	Generated response code for the execution.
Response Receiving Time	Time when the application received the response.
Response Submission Time	Time when the response was submitted by the source.
Response Source	Displays the platform or device that executed the script (e.g., Kiosk App Android).
Script Response	Displays all response data in Key–Value format for easy analysis and debugging.

Response Actions

Using the Action menu, administrators can:

View complete response details.
Open the response information page.
Download the response for reporting or troubleshooting.

Search Responses

The Search field allows administrators to quickly find responses using:

Response ID
Response Code
Script Name

The Show Entries option controls the number of records displayed on each page.

Manage Script Responses

Administrators can:

Monitor live script executions.
View complete response information.
Verify response codes.
Review execution timestamps.
Check the response source.
Analyze Key–Value response data.
Download response records for future reference.

Best Practices

Regularly review script responses to ensure scripts are executing successfully.
Verify the Response Source while troubleshooting.
Compare the Receiving Time and Submission Time for execution analysis.
Use downloaded responses for debugging or reporting purposes.
Monitor the Key–Value response data to validate script output.

Important:
Every successful script execution generates a unique Response ID and Response Code. Selecting a response from the list opens detailed execution information, including publication details, timestamps, source, and the complete Key–Value response data. Response records can also be downloaded directly from the Action menu for further analysis or documentation.

Modules

Script (Script Logs)

Overview

The Scripts Logs section records all activities related to script execution within the application. Whenever a script is executed, the system automatically generates a log containing execution details, making it easier to monitor script behavior and troubleshoot issues.

This section is useful for tracking script activity, verifying successful executions, and identifying errors if any occur.

Scripts Logs

Navigate to Modules → Scripts → Scripts Logs to view all script execution logs.

Each log represents an individual execution of a script and contains important runtime information.

Log Information

The Scripts Logs page displays execution details such as:

Script Name
Execution Status
Execution Time
Response Details
Source
Log Timestamp

The available information may vary depending on the executed script.

Search Logs

Use the Search field to quickly locate a specific log using the script name or other available details.

The Show Entries option allows administrators to control the number of log records displayed on a single page.

Manage Script Logs

Administrators can:

View script execution logs.
Monitor script activity.
Verify successful executions.
Review execution history.
Analyze script behavior for troubleshooting.

Best Practices

Regularly review script logs to ensure scripts are running correctly.
Monitor execution history to identify unexpected behavior.
Use logs to troubleshoot script-related issues.
Keep track of script executions after making updates or configuration changes.

Important:
The Scripts Logs section maintains the execution history of all scripts. It helps administrators monitor script activity, verify successful executions, and troubleshoot issues by reviewing the generated logs.

Modules

Navigation (Navigation)

Overview

It allows existing products and kiosks to be placed on a map and provides the required navigation structure between different locations.

Map - Used for add particular map.
Product - Used for mapping products in map.
Kiosk - Used for mapping kiosk in map.
Connector - Used to connect by using Escalators, Pillars etc.
Facility - Used for add facilites like washroom etc
Track - used to add track from one place to another.
Shape - Used to Add Shape for 3d Navigation.
Config - Used for Global Settings

Product

The Product section is used to map existing products onto the selected map.

Products must already be created in the system before they can be mapped.

Purpose

Product Mapping is used to display products at their respective locations on the map.

For example:

Existing Product
      ↓
Select Map
      ↓
Select Shape / Map Point
      ↓
Submit
      ↓
Product displayed on Map

Modules -> Navigation → Product

Product Mapping Process:

Note: Product Mapping does not create a new product. It maps an already-created product to a location on the selected map.

Kiosk

The Kiosk section works similarly to Product Mapping.

The difference is that instead of mapping a product, an existing Kiosk is mapped to the selected map.

Purpose

Kiosk Mapping is used to display the kiosk at its appropriate location on the navigation map.

Navigation → Kiosk

Kiosk Mapping Process

The kiosk will then be associated with the selected location on the map.

Connector

The Connector section is used to connect different navigation locations and entities.

Connectors can be used when navigation needs to move from one location to another through a specific facility or route.

Navigation → Connector

Available Connector Types The Connector section can contain connector types such as:

Pillar
Elevator (Lift)
Escalator
Ramp
Staircase
Emergency Staircase
Gate

Purpose

Connectors can represent real-world connections between different locations.

For example:

Location A
    ↓
Elevator
    ↓
Location B

Facility

The Facility section is used to create and manage facilities that are available on the map.

Facilities can represent different physical facilities or areas that users may need to navigate to.

The Facility configuration is performed in two stages:

Add Facility Type
Add Facility

Navigation → Facility

Add Facility Type

Before creating a facility, the required Facility Type must be created.

Process:

Open the Facility
Click Add Facility Type.
Enter the required Type.
Enable Published if the facility type should be published.
Upload the Facility Logo, if required.

Example

Type: Stairs
Published: Enabled
Facility Logo: Uploaded

After submission, the facility type will be available for creating facilities.

Add Facility

Once the Facility Type has been created, a facility can be added.

Process

Open the Facility tab.
Click Add Facility.
Select the required Type.
Enter the Name of the facility.
Select the required Map.
Define the Map Point.
Select the required Shape, if applicable.
Enable Published if required.
Click Submit.

Facility Structure

Facility Type
      ↓
Facility
      ↓
Map
      ↓
Map Point / Shape

Example

Type: Stairs
Name: Stairs
Map: Akshit-Map 1
Map Point: X,Y
Shape: Selected Shape

Important: 
The Facility Type should be created before adding a Facility.

Track Configuration

The Track section is used to create navigation paths between two points on a map. It is an important part of configuring navigation in VirtuKiosk.

Modules → Navigation → Track

Add Points Before Creating a Track

Before creating a track, you must first add the required points to the map.

Navigate to the Map Layout section, where the following options are available:

Add Point: Adds a new point to the map.
Move Point: Moves an existing point to another location.
Delete Point: Removes an existing point from the map.
Add / Delete Track: Allows you to create or delete a track between points.

Steps to Add Points

Go to the Track section in navigation modules. Select Add Point. Click on the required locations on the map to create points. Repeat the process until all required points have been added. Verify that the points are positioned correctly.

Important: Add the required points before proceeding with track creation.

Create a Track

After adding the required points, create a track by defining its Start Point and End Point.

Steps to Create a Track

Navigate to the Map Layout section. Select Add / Delete Track. Select the required Start Point. Select a different End Point. Verify the selected points. Click Submit to save the track. 9.3 Track Information

The Track section displays the following information:

Field Description Map Name The name of the map associated with the track. Start Point The coordinates of the point where the track begins. End Point The coordinates of the point where the track ends. 9.4 Track Validation

The Start Point and End Point must be different. The system does not allow a track to be submitted when both points have the same coordinates.

If both points are identical, the following validation message is displayed:

Start and End Point must be different Validation Checklist Ensure that the Start Point is selected correctly. Ensure that the End Point is different from the Start Point. Verify that both points belong to the intended map. Confirm that the track is saved successfully. 9.5 Verify the Track

After creating the track, verify the following:

The track is associated with the correct map. The Start Point and End Point are correct. The selected points are different. The track configuration is saved successfully. The navigation path behaves as expected.

Important: Always add the required points before creating a track. Correctly defining the Start Point and End Point helps ensure that the navigation path is configured properly.

Steps to Create a Track

Navigate to the Map Layout section.
Select Add / Delete Track.
Select the required Start Point.
Select a different End Point.
Verify the selected points.
Click Submit to save the track.

9.3 Track Information

The Track section displays the following information:

Field	Description
Map Name	The name of the map associated with the track.
Start Point	The coordinates of the point where the track begins.
End Point	The coordinates of the point where the track ends.

Track Validation

The Start Point and End Point must be different. The system does not allow a track to be submitted when both points have the same coordinates.

If both points are identical, the following validation message is displayed:

Start and End Point must be different

Validation Checklist

Ensure that the Start Point is selected correctly.
Ensure that the End Point is different from the Start Point.
Verify that both points belong to the intended map.
Confirm that the track is saved successfully.

Verify the Track

After creating the track, verify the following:

The track is associated with the correct map.
The Start Point and End Point are correct.
The selected points are different.
The track configuration is saved successfully.
The navigation path behaves as expected.

Important: Always add the required points before creating a track. Correctly defining the Start Point and End Point helps ensure that the navigation path is configured properly.

10. Shape Configuration

Navigate to:

Modules → Navigation → Shape

Shapes are used to define specific areas or navigation regions on the map.

They are especially important for 3D Navigation because a shape can be configured with 3D-related properties such as:

Logo
3D Pin
GLB Model
3D Pin Rotation
3D Pin Scale
Active Color
Inactive Color
Active Height
Inactive Height

11. Creating a Shape

Navigate to:

Modules → Navigation → Shape

Use the map layout drawing functionality.

Select:

Map Layout → Draw

Add the required points around the area that needs to be converted into a shape.

11.1 Add Shape Points

Click on the map to add points.

For example:

Point 1
Point 2
Point 3
Point 4

The points define the boundary of the shape.

A minimum of 3 points should be used to create a proper closed shape.

11.2 Close Shape

After adding the required points, select:

Close Shape

This completes the shape boundary.

Important: Draw and Close Shape should not be treated as simultaneous actions. Complete the required drawing first and then close the shape.

11.3 Undo

If an incorrect point is added, use:

Undo

to remove the most recent drawing action.

11.4 Duplicate Shape

Existing shapes can be duplicated when a similar shape is required.

Select:

Duplicate

Then modify the duplicated shape as required.

This can save time when multiple shapes have similar configurations.

12. Shape Configuration for 3D Navigation

After creating a shape, configure its 3D properties.

The shape can contain the following configurations:

Title
Logo
Pin 3D
3D Pin Rotation
3D Pin Scale
Active Color
Inactive Color
Active Height
Inactive Height

12.1 Title

Enter a meaningful name for the shape.

Examples:

ATM Area
Gate Area
Entrance
Information Desk

12.2 Logo

Select the required logo image.

The logo should first be uploaded through:

Modules → Files

After uploading the file, it can be selected in the Shape configuration.

12.3 Pin 3D

The Pin 3D option is used for the 3D representation of the shape or navigation point.

Select the appropriate 3D asset.

12.4 3D Pin Rotation

Configure the rotation of the 3D pin according to the required direction.

Examples:

Rotation: 0°
Rotation: 90°
Rotation: 180°
Rotation: 270°

12.5 3D Pin Scale

Configure the size of the 3D pin.

The scale should be selected according to the map and visual requirements.

13. Active and Inactive Shape Configuration

Active Shape

The active configuration controls the appearance of a selected or active navigation area.

Possible settings include:

Active Color
Active Height

Inactive Shape

The inactive configuration controls the appearance of shapes that are not currently selected.

Possible settings include:

Inactive Color
Inactive Height

Example Configuration

Active Color: Required Color
Active Height: Required Height
Inactive Color: Required Color
Inactive Height: Required Height

14. Bulk Configuration

The Shape section provides Bulk Configuration.

The available options include:

Select One
Custom
Global

These options determine where the configuration changes will be applied.

14.1 Custom Configuration

Select:

Bulk Configuration → Custom

The Custom configuration applies the selected changes only to the current map.

Example

Suppose there are three maps:

Map 1
Map 2
Map 3

If Custom configuration is applied to Map 1, the changes will affect Map 1 only.

They will not automatically affect Map 2 or Map 3.

Custom Configuration Flow

Select the map.
Open Bulk Configuration.
Select Custom.
Apply the required changes.
Verify that the changes apply to the current map only.

15. Global Configuration

Select:

Bulk Configuration → Global

The Global configuration applies the selected changes across all available maps.

Example

Suppose the system contains four maps:

Map 1
Map 2
Map 3
Map 4

If Global configuration is applied, the changes will be applied across all four maps.

Global Configuration Flow

Open Bulk Configuration.
Select Global.
Apply the required changes.
Verify that the changes apply to all maps.

Important: Use Global carefully because the configuration can affect multiple maps.

16. Custom vs. Global Configuration

Configuration	Scope
Custom	Applies changes to the selected/current map only
Global	Applies changes to all maps

Example

Suppose you have three maps:

Map A
Map B
Map C

If you change the shape color using Custom, only the selected map will be affected.

If you use Global, the same configuration will be applied across Map A, Map B, and Map C.

17. Important Shape Configuration Considerations

When configuring multiple shapes, verify whether the required change is:

Specific to one map
Required across all maps

Use Custom when the change is required only for a particular map.

Use Global when the same configuration should be applied to all maps.

This helps avoid unnecessarily modifying other maps.

18. Map Layout

The Map Layout provides the main working area for configuring navigation data.

The available controls include:

Add Point
Move Point
Delete Point
Add / Delete Track

The Map Layout is used for:

Adding map points
Moving points
Deleting points
Creating tracks
Defining navigation paths
Creating shape boundaries

19. Map Layout Options

Add Point

Used to create a new point on the map.

Add Point → Click on Map

Move Point

Used to change the position of an existing map point.

Move Point → Select Point → Move to Required Location

Delete Point

Used to remove an existing map point.

Delete Point → Select Point

Add / Delete Track

Used to create or remove tracks between map points.

Add / Delete Track

This functionality is especially important for navigation routes.

Modules

Navigation (Navigation verify)

1. Overview

This module helps users identify navigation configuration issues and inspect point connectivity.

Verification Result
Connected Points

3. Verification Result

The Verification Result section displays the results of the navigation verification process for configured maps.

3.1 Available Fields

Field	Description
#	Displays the serial number of the map entry.
Name	Displays the name of the map being verified.
Map Group	Displays the map group identifier associated with the map.
Point Groups	Displays the number of point groups associated with the map.
Normalization	Displays the normalization of Path i.e, which path is time saving value applied to the map, such as `1 (default)`.
Status	Displays the verification result, such as Passed or Failed.

3.2 Verification Status

Passed: Indicates that the map has passed the verification process.
Failed: Indicates that the map has failed the verification process and requires further investigation.

3.3 Example

Map Name	Map Group	Point Groups	Normalization	Status
Layout Map	0	3	1 (default)	Failed
Convenience Map Another	1	1	1 (default)	Failed
Event-Layout	2	3	1 (default)	Failed

The table supports column sorting. Use the horizontal scrollbar to view additional columns when necessary.

4. Connected Points

The Connected Points section displays the point groups associated with each map. Users can expand or collapse individual groups to inspect their point information.

4.1 Available Information

Map Name: Identifies the map associated with the point group.
Point Group Number: Identifies the group, such as Point Group #0, Point Group #1, or Point Group #2.
Point Identifier: Displays the unique identifier associated with a point.
Coordinates: Displays the coordinates recorded for the point.
Point Count: Displays the number of points associated with the group, where indicated.

4.2 Point Group Colors

Point group headings may appear in different colors, such as green and red.

The exact meaning of these colors should be confirmed against the application's verification rules.

4.3 Expanding and Collapsing Point Groups

Navigate to the Connected Points section.
Locate the required map and point group.
Click the + icon to expand a collapsed group.
Review the displayed point identifiers and coordinates.
Click the − icon to collapse an expanded group.

4.4 Example

For the Layout Map, the following point groups are displayed:

Layout Map [Point Group #0]
Layout Map [Point Group #1]
Layout Map [Point Group #2]

An expanded point group may display a point entry in the following format:

[152664] (277, 130)

Where:

152664 represents the point identifier.
277, 130 represents the displayed point coordinates.

5. How to Verify Navigation

Follow these steps to review the navigation verification results:

Open the VirtuBox Business backend.
Navigate to Navigation Verify.
Review the Verification Result table.
Identify maps displaying a Failed status.
Note the map name, map group, and number of point groups.
Navigate to the Connected Points section.
Expand the relevant point groups.
Review the point identifiers and coordinates.
Investigate the relevant map, point, track, connector, or other navigation configurations.
Run the verification process again after correcting any identified issues.

6. Troubleshooting

If a map displays a Failed status, use the following checklist to investigate the issue:

Verify that the map configuration is correct.
Review the point groups associated with the map.
Check whether the required points are configured correctly.
Review the relevant tracks and connectors.
Check point coordinates and connectivity where applicable.
Re-run the verification process after making corrections.

Note: The Verification Result table alone may not identify the exact cause of a failure. Further investigation of the relevant navigation configuration may be required.

7. Key Benefits

Provides a centralized overview of navigation verification results.
Helps identify maps that require investigation.
Displays map groups and associated point groups.
Allows users to inspect connected points and their coordinates.
Supports troubleshooting of navigation configuration and connectivity issues.

8. Conclusion

Modules

Order (Order)

Overview

The Order section allows administrators to view, filter, manage, and export all customer orders placed through the application or Kiosk. It provides complete visibility into order details, payment status, and order history.

Export Orders

Administrators can export orders by selecting an Export Date Range.

Select the required date range.
Click Export to download the order data.

This helps generate reports for a specific period.

Payment Status

Orders can be filtered based on their payment status.

Available payment statuses include:

Status	Description
Payment Success	Displays orders with successful payments.
Payment Cash	Displays orders paid using the Cash payment method.
Payment Failed	Displays orders where the payment was unsuccessful.
Payment Pending	Displays orders with pending payments awaiting completion.

Administrators can use these filters to quickly view orders based on their payment status.

Filters

The Filters section helps narrow down the order list.

Available filter options include:

Filter	Description
Order By	Sort orders by a selected field (e.g., Created At).
Order	Display records in Ascending or Descending order.
Source	Filter orders based on their source.
Date Range	Display orders within a selected date range.

Use Apply to apply the selected filters or Clear to reset all filters.

Manage Orders

The Manage Orders section displays all orders matching the selected filters.

Administrators can:

View customer orders.
Search and filter orders.
Check payment status.
Export order data.
Monitor order history.

If no orders are available, the system displays:

No orders to show.

Best Practices

Use the Payment Status filters to monitor successful, failed, cash, and pending payments.
Apply Date Range filters to generate reports for specific periods.
Export orders regularly for reporting and record keeping.
Review failed or pending payments to ensure timely resolution.

Important:
The order list is displayed based on the selected filters. To view specific orders, select the appropriate Payment Status, Date Range, or other filter options, then click Apply.

Modules

Order (Order Report)

Overview

The Orders Report section provides a summarized view of customer orders for a selected date range. It helps administrators analyze order activity, package quantities, and total sales within a specific period.

Generate Orders Report

To generate an order report:

Select the required Date Range.
Choose the appropriate order status (e.g., All, Payment Success, Payment Failed, or Payment Cash).
The system automatically displays the report based on the selected filters.

Report Summary

The report displays the following summary information:

Metric	Description
Total Orders	Displays the total number of orders for the selected period.
Total Packages Quantity	Shows the total quantity of packages ordered.
Total Amount	Displays the total value of all orders.

Packages Detail

The Packages Detail section displays package-wise order information for the selected report.

Administrators can:

View ordered packages.
Analyze package quantities.
Review package sales within the selected date range.

If no package data is available, the system displays:

No Packages to show.

Best Practices

Select the appropriate Date Range before reviewing reports.
Use payment status filters to analyze specific order types.
Monitor package sales to identify popular products.
Review reports regularly to track business performance.

Important:
The Orders Report displays data only for the selected Date Range and applied filters. If no orders are available, all summary values will remain 0, and the Packages Detail section will display "No Packages to show."

Modules

Order (Stock Report)

Overview

The Stock Report section provides a centralized view of the inventory available for accessible packages. It helps administrators monitor product stock levels, package information, vendor details, and pricing from a single location.

This report is useful for tracking inventory availability and managing stock efficiently.

Stock Report

Navigate to Modules → Stock Report to view the current inventory details.

The report displays all accessible packages along with their associated product and stock information.

Stock Details

The report contains the following information:

Column	Description
Product	Displays the name of the product.
Package	Displays the associated package.
Vendor	Shows the vendor assigned to the package.
Price	Displays the package price.
Stock	Shows the current available stock quantity.

Search Stock

Use the Search field to quickly find a specific product, package, or vendor.

The Show Entries option allows administrators to control the number of records displayed on a single page.

Manage Stock Report

Administrators can:

View available product stock.
Monitor package inventory.
Check vendor information.
Review package pricing.
Search for specific stock records.

If no inventory data is available, the system displays:

No data available in table.

Best Practices

Regularly monitor stock availability.
Review stock levels to avoid inventory shortages.
Verify vendor and package information before updating inventory.
Use the Search option to quickly locate specific products or packages.

Important:
The Stock Report displays inventory information only for accessible packages. If no stock records are available, the report will display "No data available in table."

Modules

Order (Order Settings)

Overview

The Order Settings section allows administrators to configure the complete ordering experience on the Kiosk. It includes receipt customization, cart button settings, user profile configuration, dynamic cart behavior, order configuration, and payment modes. These settings help customize how customers place orders and complete payments.

Order Receipt

The Order Receipt section controls the layout and appearance of the receipt displayed after an order is placed. Administrators can configure what information appears on the receipt, including product details, package details, and item information.

Available Settings

Setting	Description
Order Receipt	Select the receipt display mode (e.g., Full).
Product	Show or hide product details on the receipt.
Package	Show or hide package details on the receipt.
Item	Show or hide ordered items on the receipt.

Print Receipt Button

The Print Receipt Button allows administrators to customize the receipt confirmation screen shown after an order is placed.

The following settings are available:

Print Receipt
Header Text
Header Size
Header Color
Button (Yes) Text
Button (Yes) Color
Button (Yes) Background
Button (Yes) Size
Button (Yes) Radius
Button (No) Text
Button (No) Color
Button (No) Background
Button (No) Size
Button (No) Radius
Card Color
Card Border

These options help customize the appearance of the receipt interface.

Header Text

The Header Text is displayed at the top of the receipt. Administrators can enable or disable it and customize its size and color.

Button (Yes)

This button is displayed when users choose to print their receipt.

Administrators can customize:

Button Text
Text Color
Background Color
Font Size
Border Radius

Button (No)

This button is displayed when users do not want to print the receipt.

Administrators can customize:

Button Text
Text Color
Background Color
Font Size
Border Radius

Card Color

Defines the background color of the receipt card displayed on the Kiosk.

Card Border

Defines the border color of the receipt card.

Product Cart Button

The Product Cart Button controls how the cart button appears while customers browse products.

Administrators can configure:

Setting	Description
Mode	Select the display mode (e.g., Full Cart).
Text	Enable or disable button text.
Button Text	Customize the button label.
Size	Set the button text size.
Text Color	Configure the button text color.
BG Color	Configure the button background color.
Animation	Apply animation effects to the button.

Add to Cart

The Add to Cart text is displayed when a customer adds a product to the shopping cart. This text can be customized according to business requirements.

Remove from Cart

The Remove from Cart text is displayed when a product is removed from the shopping cart. Administrators can modify this label as required.

User Profile

The User Profile section allows administrators to choose which customer information should be collected before placing an order.

Supported fields include:

Name
Phone Number
Email Address
Address
Custom Profile Fields

These details help identify customers and process orders efficiently.

Dynamic Cart Button

The Dynamic Cart Button allows administrators to customize the text displayed on the cart button.

Available options include:

Field	Description
Empty Cart Text	Text displayed when the cart is empty.
Open Cart Text	Text displayed when items are added to the cart.

Order Configuration

The Order Configuration section contains additional ordering options.

Available settings include:

Package Code
Get Package Code
Package Campaign

These settings can be configured according to business requirements.

Payment Mode

The application supports two order modes:

Kiosk

The Kiosk mode allows customers to place and pay for their orders directly through the Kiosk.

Features

Supports Pay Online.
Customers can complete payments directly on the Kiosk.
A receipt can be printed after successful payment.
The receipt indicates that the payment has been completed successfully.

Offline

The Offline mode supports Cash on Counter / Cash on Delivery.

Features

Customers can place orders without making an online payment.
Payment is collected at the billing counter.
A receipt is generated after placing the order.
The receipt clearly displays whether the payment is Pending, Paid Online, or Cash on Counter, making it easy for staff to verify the payment status.

Manage Order Settings

Administrators can:

Configure Order Receipt settings.
Customize the Print Receipt screen.
Configure Product Cart Button settings.
Manage User Profile fields.
Customize Dynamic Cart Button labels.
Configure Package Codes and Campaigns.
Enable Online or Offline payment modes.

Best Practices

Configure receipt settings before deploying the Kiosk.
Keep button labels simple and user-friendly.
Collect only the necessary customer information.
Verify payment modes before making the Kiosk live.
Test both Online and Offline ordering workflows.
Ensure the receipt printer is properly configured.

Important:
The application supports both Kiosk (Pay Online) and Offline (Cash on Counter) ordering modes. Customers can either complete payment directly through the Kiosk or pay at the billing counter. The printed receipt clearly indicates the payment status, helping staff verify whether the payment is Pending, Paid Online, or Cash on Counter. After making any changes, click the Submit button to save the configuration.

Modules

Order (Vendors)

Overview

The Vendors section allows administrators to create and manage vendor information within the application. Vendors can be associated with products and packages to help organize inventory and supplier-related data.

Add New Vendor

To create a new vendor:

Navigate to Modules → Vendors.
Click Add New Vendor.
Enter the Title of the vendor.
Click Submit to save the vendor.

After successful creation, the system displays the following confirmation message:

Add: Success!
Vendor Added Successfully.

Vendor Details

The following field is available while creating a vendor:

Field	Description
Title	Enter a unique and meaningful name for the vendor.

Vendors List

After a vendor is created, it appears in the Vendors list.

The list contains the following information:

Column	Description
Title	Displays the name of the vendor.
Products	Shows the number of products associated with the vendor.
Packages	Shows the number of packages associated with the vendor.

Manage Vendors

Administrators can:

Add new vendors.
View all available vendors.
Associate vendors with products.
Associate vendors with packages.
Update or remove vendor information when required.

Best Practices

Use meaningful vendor names for easy identification.
Create separate vendor entries for different suppliers.
Verify vendor details before associating them with products or packages.
Remove unused vendor entries to keep the vendor list organized.

Important:
A vendor is created only after entering the required Title and clicking the Submit button. Once saved, it becomes available for association with products and packages.

Modules

Order (Taxes)

Overview

The Taxes section allows administrators to create and manage tax entries that can be applied to packages and orders within the application.

Tax configurations help calculate the applicable tax amount during the ordering process and can be associated with specific packages as required.

Add New Tax

To create a new tax:

Navigate to Modules → Taxes.
Click Add New Tax.
Enter the Title of the tax.
Configure the required tax details.
Click Submit to save the tax.

After successful creation, the system displays the following confirmation message:

Add: Success!
Tax Added Successfully.

Tax Details

The following field is available while creating a tax:

Field	Description
Title	Enter a unique and meaningful name for the tax (e.g., GST, VAT, Service Tax).

Taxes List

After a tax is created, it appears in the Taxes list.

The list contains the following information:

Column	Description
Title	Displays the name of the configured tax.
Tax Rate	Displays the configured tax percentage or rate.
Packages	Shows the number of packages associated with the tax.

Manage Taxes

Administrators can:

Add new tax configurations.
View all available taxes.
Associate taxes with packages.
Modify existing tax information.
Remove unused tax configurations if required.

Best Practices

Use meaningful and descriptive tax names.
Configure the correct tax rate before assigning it to packages.
Verify tax settings before making them available for orders.
Regularly review tax configurations to ensure they remain up to date.

Important:
A tax is created only after entering the required details and clicking the Submit button. Once saved, it becomes available for assignment to applicable packages.

Modules

Order (Coupon Dashboard)

Modules

Orders(Issue Voucher)

Modules

Orders(Coupons)

Modules

Orders(Membership)

Modules

Scheduler (Add Scheduler)

Overview

The Add Scheduler section allows administrators to automate various actions within the application. A scheduler can be configured to execute a specific action at a predefined date and time without requiring manual intervention.

Schedulers are commonly used to automatically Enable or Disable application content, categories, products, packages, and other supported modules.

Add Schedule

To create a new scheduler:

Navigate to Modules → Schedulers → Add.
Select the Type of scheduler.
Choose the required Category or supported item.
Configure the scheduler action.
Select the Start Date & Time.
Select the End Date & Time (if required).
Click Submit to save the scheduler.

Scheduler Configuration

The Add Scheduler page contains the following options:

Field	Description
Type	Select the type of scheduler to be created.
Category	Select the category or item on which the scheduler will perform the action.
Start Date & Time	Specifies when the scheduler should begin executing.
End Date & Time	Specifies when the scheduled action should end.

Scheduler Actions

The scheduler supports the following actions:

Enable

Automatically enables the selected content, making it available according to the configured schedule.

Disable

Automatically disables the selected content after the scheduled time.

Reverse Action

The Reverse Action option automatically performs the opposite action once the scheduled duration is completed.

For example:

If the scheduler Enables a category, the Reverse Action will automatically Disable it after the configured end time.
Similarly, if the scheduler Disables a category, the Reverse Action can automatically Enable it again.

Schedule Type

Administrators can choose how the scheduler should execute.

Single Schedule

Executes the configured action only once at the specified date and time.

Double Schedule

Allows administrators to configure both a Start and End schedule, enabling automatic execution of an action followed by its reverse action if configured.

Manage Schedulers

Administrators can:

Create new schedulers.
Schedule automatic Enable or Disable actions.
Configure Reverse Actions.
Set Start and End execution times.
Automate repetitive tasks without manual intervention.

Best Practices

Verify the selected category before creating a scheduler.
Double-check the Start and End date/time.
Use Reverse Action when content needs to be automatically restored.
Use Single Schedule for one-time tasks.
Use Double Schedule for temporary activations or deactivations.

Important:
After configuring the scheduler, click the Submit button to save it. Once the scheduled time is reached, the configured action will be executed automatically. If Reverse Action is enabled, the system will automatically perform the opposite action at the scheduled end time.

Modules

Scheduler (Active Scheduler)

Overview

The Active Schedulers section displays all schedulers that are currently enabled and running in the application. Active schedulers automatically execute their configured tasks based on the defined schedule and perform the assigned actions without manual intervention.

This section helps administrators monitor all active scheduled jobs and track their execution status.

Active Schedulers

Navigate to Modules → Schedulers to view all active scheduler configurations.

Only schedulers with an Active status are listed in this section.

Scheduler Details

Each active scheduler contains the following information:

Column	Description
ID	Unique identifier of the scheduler.
Schedule	Displays the configured execution date, time, or schedule.
Type	Indicates the type of scheduler task.
Item	Displays the associated module or content.
Action	Shows the action performed by the scheduler.
Log Count	Displays the total number of execution logs generated by the scheduler.

Search Active Schedulers

The Search field allows administrators to quickly locate a specific scheduler.

The Show Entries option controls the number of scheduler records displayed on a single page.

Manage Active Schedulers

Administrators can:

View all active schedulers.
Monitor scheduled tasks.
Review scheduler execution details.
Check the execution log count.
Verify that scheduled actions are running successfully.

Best Practices

Regularly monitor active schedulers to ensure scheduled tasks execute on time.
Review the Log Count to confirm successful scheduler executions.
Keep only the required schedulers active.
Verify scheduler configurations after making any updates.

Important:
Only Active Schedulers are executed by the system according to their configured schedule. Every successful execution generates a log entry, which can be viewed in the Scheduler Log section. If no active schedulers are configured, the page will display "No data available in table."

Modules

Scheduler (Inactive Scheduler)

Overview

The Inactive Schedulers section displays all schedulers that are currently disabled or inactive. These schedulers are not executed by the system until they are enabled again.

This page helps administrators identify scheduled tasks that are temporarily unavailable or intentionally disabled.

Inactive Schedulers

Navigate to Modules → Inactive Schedulers to view all inactive scheduler configurations.

Only schedulers with an Inactive status are displayed in this section.

Inactive Scheduler Details

The list provides information about inactive schedulers, allowing administrators to review their current status and configuration.

Typical information includes:

Scheduler Name
Status
Scheduled Task
Last Modified Date
Available Actions

Manage Inactive Schedulers

Administrators can:

View all inactive schedulers.
Review scheduler configurations.
Identify disabled scheduled tasks.
Enable schedulers when required.
Monitor inactive scheduler records for maintenance purposes.

Best Practices

Periodically review inactive schedulers.
Enable only the schedulers that are required.
Remove or update obsolete scheduler configurations.
Verify scheduler settings before reactivating them.

Important:
Schedulers listed in the Inactive Schedulers section will not execute until they are enabled. Only active schedulers are processed by the system according to their configured schedule.

Modules

Scheduler (Scheduler Logs)

Overview

The Scheduler Log section records the execution history of all scheduled tasks configured within the application. Whenever a scheduler runs, the system automatically generates a log entry, allowing administrators to monitor and verify scheduled activities.

This helps in tracking successful executions and troubleshooting scheduled operations when required.

Scheduler Logs

Navigate to Modules → Scheduler Log to view all scheduler activity.

The page displays a chronological list of executed scheduler events.

Scheduler Log Details

Each log entry contains the following information:

Column	Description
ID	Unique identifier of the scheduler log.
Log Time	Date and time when the scheduler was executed.
Type	Displays the type of scheduled task performed.
Item	Shows the item or module associated with the scheduler.
Action	Displays the action performed during execution.
Log ID	Unique reference ID generated for the scheduler event.

Search Scheduler Logs

Use the Search field to quickly find a specific scheduler log based on the available information.

The Show Entries option allows administrators to control the number of log records displayed on a single page.

Manage Scheduler Logs

Administrators can:

View the execution history of scheduled tasks.
Monitor scheduler activity.
Verify whether scheduled jobs have executed successfully.
Search for specific log entries for troubleshooting.

Best Practices

Review Scheduler Logs regularly to verify scheduled tasks.
Monitor logs after creating or modifying a scheduler.
Use the Search option to quickly locate specific log entries.
Investigate missing or failed scheduler executions when expected logs are not generated.

Important:
Every time a scheduler is executed, the system automatically creates a corresponding log entry in the Scheduler Log section. If no scheduler has been executed, the page will display "No data available in table."

Modules

Others (Reference Groups)

Overview

The Reference Groups section allows administrators to create and manage groups that can be used to organize and categorize reference data within the application.

Reference Groups help keep related references structured, making them easier to manage and reuse wherever they are required.

Add a Reference Group

To create a new Reference Group:

Navigate to Modules → Reference Groups.
Click Add.
Enter the Title for the Reference Group.
Click Submit to create the group.

Upon successful creation, the system displays a confirmation message.

Example:

Add: Success!
Reference Group [Akshit] Added successfully.

Reference Group Details

The following field is required while creating a Reference Group:

Field	Description
Title	Enter a unique and meaningful name for the Reference Group.

Reference Groups List

After creating a Reference Group, it appears in the Reference Groups list.

The list displays:

Column	Description
Title	Displays the name of the created Reference Group.

Example:

Title
XYZ

Manage Reference Groups

Administrators can:

Create new Reference Groups.
View all existing Reference Groups.
Organize reference data using meaningful group names.
Maintain a structured list of references for future use.

Best Practices

Use descriptive and unique titles for Reference Groups.
Create separate groups for different types of reference data.
Keep group names consistent for better organization.
Review existing groups before creating new ones to avoid duplicates.

Important:
A Reference Group is created only after entering a valid Title and clicking the Submit button. Once added successfully, it will appear in the Reference Groups list.

Modules

Others (Compare Groups)

Overview

The Compare Groups section allows administrators to create and manage groups that can be used to compare similar products within the application. Products assigned to the same Compare Group can be displayed together for comparison, making it easier for users to evaluate different options.

Add a Compare Group

To create a new Compare Group:

Navigate to Modules → Compare Groups.
Click Add Compare Groups.
Enter a Group Name.
Click Submit to save the group.

After successful creation, the system displays a confirmation message.

Example:

Add: Success!
Compare Group Added successfully.

Compare Group Details

The following field is required while creating a Compare Group:

Field	Description
Group Name	Enter a unique and meaningful name for the Compare Group.

Compare Groups List

Once a Compare Group has been created, it appears in the Compare Groups list.

The list contains the following information:

Column	Description
Group Name	Displays the name of the Compare Group.
Action	Provides options to manage the Compare Group, such as Edit or Delete (depending on user permissions).

Example:

Group Name
G1
G2

Search Compare Groups

Use the Search field to quickly locate a Compare Group by entering its name.

Show Entries

The Show Entries option allows administrators to control how many Compare Groups are displayed on a single page.

Common options include:

10 Entries
25 Entries
50 Entries
100 Entries

Manage Compare Groups

Administrators can:

Create new Compare Groups.
View all existing Compare Groups.
Search Compare Groups.
Edit Compare Group names (if permitted).
Delete Compare Groups (if no longer required).

Best Practices

Use short, meaningful, and unique group names.
Create separate Compare Groups for different product categories.
Avoid duplicate group names to maintain better organization.
Review existing groups before creating new ones.
Delete unused Compare Groups to keep the list organized.

Important:
A Compare Group is created only after entering a valid Group Name and clicking the Submit button. Once saved successfully, it will appear in the Compare Groups list and can be used while configuring products for comparison.

Modules

Others (Featured Products)

Overview

The Featured Products section allows administrators to manage products that should be highlighted within the application. Featured products receive greater visibility, making them easier for users to discover.

Featured Products

The page is divided into two sections:

Section	Description
Available Featured Products	Displays all products currently marked as Featured.
Unavailable Featured Products	Displays products that are not marked as Featured but can be added when required.

Manage Featured Products

Administrators can:

View available featured products.
Add products to the Featured list.
Remove products from the Featured list.
Organize products based on business requirements.

Note:
Featured Products help promote important or popular products by making them more visible within the application.

Modules

TryOn (TryOn Settings)

Overview

The TryOn Settings section allows administrators to configure the Virtual Try-On experience for fashion products. This feature enables users to virtually wear selected garments by capturing a selfie, providing an interactive and engaging shopping experience.

Note:
The Try-On feature is specifically designed for supported Fashion Products.

How Try-On Works

The Virtual Try-On feature works as follows:

The user selects a supported Fashion Product.
The user captures a Selfie using the kiosk or application.
The system processes the image using the Try-On engine.
The selected garment is digitally applied to the user's image.
The generated Try-On image can be shared with the user.

Enable Try-On

The Try-On feature must be enabled from two different locations before it becomes available.

1. Product / Package Configuration

Enable Try-On for the required Fashion Product from the Product Package configuration.

2. TryOn Settings

Enable and configure the required settings from:

Modules → TryOn Settings

Important:
The Try-On feature will function only after it has been enabled from both the Product Package and the TryOn Settings module.

Product TryOn Button

The Product TryOn Button controls the appearance of the Try-On button displayed on supported products.

The following options are available:

Setting	Description
Mode	Select the display mode of the Try-On button (e.g., Full).
Text	Enable or disable button text.
Button Text	Customize the text displayed on the button.
Size	Set the font size of the button text.
Text Color	Select the text color using a color code.
Background Color	Select the button background color using a color code.
Animation	Configure button animation, if required.

TryOn Button Labels

Customize the button labels displayed during the Try-On process.

Field	Description
Add to TryOn	Text displayed when adding a product to the Try-On list.
Remove from TryOn	Text displayed when removing a product from the Try-On list.
Empty TryOn Text	Message displayed when no Try-On products are selected.
Open TryOn Text	Text displayed for opening the Try-On interface.

User Profile

The User Profile section defines the information collected before generating a Try-On image.

Available fields include:

Name
Phone Number
Email Address

Important:
The Phone Number field must remain enabled and mandatory. Without a valid phone number, the generated Try-On image cannot be sent via WhatsApp.

Access Permission

The Try-On Settings module is a restricted feature.

Access is not available to all users.
Try-On functionality must be enabled by the authorized administrator.
If the feature is not available in your account, contact Ashish to request access and enablement.

Note:
Only authorized users can configure or enable the Try-On feature.

Best Practices

Enable Try-On only for supported Fashion Products.
Ensure the feature is enabled in both Product Package and TryOn Settings.
Keep the Phone Number field enabled to support WhatsApp image delivery.
Use clear and consistent button labels for a better user experience.
Verify button colors and animations to match your application's theme before saving.

Important:
Any changes made within TryOn Settings will not take effect until you click the Submit button. Ensure all required settings are configured correctly before saving.

Bulk Actions

Product (Import/Export)

Overview

The Import/Export section allows users to manage catalog and product data by importing and exporting information in bulk. This section provides two different architectures for managing data:

New Architecture
Old Architecture

Users can switch between both architectures based on the requirement.

Home → Import/Export

New Architecture

The New Architecture provides updated import/export functionality for managing catalog data. Users can export the complete catalog, import catalog data through Excel files, and upload product images.

Export Catalog

The Export Catalog option allows users to export complete catalog data into an Excel file.

Steps:

Open the New tab.
Click on Export Catalog.
The catalog data will be exported successfully.

Import Catalog

The Import Catalog option allows users to import catalog data using an Excel file.

Steps:

Open the New tab.
Click on Import Catalog.
Click on Select Excel File.
Choose the required Excel file from the system.
Upload the file to import catalog data.

Upload Products Images

The Upload Products Images option allows users to upload product images related to imported catalog data.

Steps:

Select the required image files.
Upload images using:
- Drag and drop option (Drop files here)
- File selection option
Wait until all images are uploaded successfully.

Details displayed:

Field	Description
Pending Image to upload	Displays the number of images pending for upload.
Upload Products Images	Allows users to upload product images.
Server	Displays server upload information.

Old Architecture

The Old Architecture provides the previous import/export functionality for managing product data. Users can export products and import product information using Excel files.

Export Products

The Export Products option allows users to export existing product data.

Steps:

Open the Old tab.
Click on Export Products.
Product data will be exported into a file.

Import Products

The Import Products option allows users to import product data using an Excel file.

Steps:

Open the Old tab.
Click on Import Products.
Click on Select Excel File.
Choose the required Excel file.
Upload the selected file to import product data.

File Upload

Both architectures provide a Select Excel File option for importing data.

Steps:

Click on Select Excel File.
Choose the required Excel file from the system.
Verify the selected file.
Upload the file to complete the import process.

Available Actions

New Architecture

Export Catalog: Export complete catalog data.
Import Catalog: Import catalog data through Excel files.
Select Excel File: Choose an Excel file for importing catalog data.
Upload Products Images: Upload product images after import.

Old Architecture

Export Products: Export product information.
Import Products: Import product information through Excel files.
Select Excel File: Choose an Excel file for importing product data.

Bulk Actions

Product (Rank Management)

Overview

The Import/Export Rank Management section allows users to manage and maintain the ranking order of different product-related sections such as Specifications, Packages, and Resources. Users can check, apply, save, import, and export ranks to control the display order.

Home → Import/Export Rank Management

Rank Management

The Rank Management page allows users to manage ranks for product-related data. This section helps maintain the correct ordering of Specifications, Packages, and Resources.

Users should verify existing ranks before assigning ranks from the product section, as duplicate or conflicting ranks may affect the display order.

Manage Ranks

To manage ranks:

Open the Import/Export Rank Management section.
Select the required section:
- Specifications
- Packages
- Resources
Check whether any rank is already assigned.
Verify that there are no duplicate or conflicting ranks.
Update the rank details if required.
Click on Apply Rank to apply the updated ranking order.
Click on Save Rank to save the changes permanently.

Note: Before selecting ranks from the Product section, always check this section to ensure that no existing rank conflicts are present.

Available Actions

Specifications: Allows users to manage ranks for product specifications.
Packages: Allows users to manage ranks for product packages.
Resources: Allows users to manage ranks for product resources.
Apply Rank: Applies the selected ranking order.
Save Rank: Saves the updated rank configuration.

Rank Management Importance

Maintaining proper ranks ensures that product-related information is displayed in the correct order. Duplicate or incorrect ranks may cause conflicts when ranks are also assigned from the Product section.

Bulk Actions

Product (App Images)

Overview

The Manage Images section allows users to manage and modify images used in the application. Users can view image details, select images, and perform actions such as changing fill color, scaling down images, and deleting images.

Bulk Actions → App Images

App Images

The App Images page displays all available images used in the application along with details such as model name, reference, image resolution, and file size.

Users can select one or multiple images and perform available actions to manage image properties.

Manage App Images

To manage app images:

Open the Images section.
View the available images from the list.
Select the required image(s).
Choose an action from the Choose an Action dropdown.
Apply the required changes.
Save or confirm the action to apply the updates.

Image List

The App Images page contains the following details:

Field	Description
#	Displays the image sequence number.
Model	Displays the image model or image identifier.
Reference	Displays the reference name associated with the image.
Image	Displays the image details.
Pixels	Displays the image resolution.
Bytes	Displays the image file size.

Available Actions

Fill Color

The Fill Color option allows users to add or adjust fill color around selected images.

Available options:

Top: Adds fill space at the top of the image.
Bottom: Adds fill space at the bottom of the image.
Left: Adds fill space on the left side of the image.
Right: Adds fill space on the right side of the image.

Scale Down

The Scale Down option allows users to reduce the image size while maintaining its proportions.

Steps:

Select the required image(s).
Choose Scale Down from the action dropdown.
Enter the required Image Bound (Scale proportionally) value.
Apply the action.

Example:

Image Bound (Scale proportionally): 800 x 800 px

The image will be resized proportionally according to the selected dimensions.

Delete

The Delete option allows users to remove selected images from the application.

Steps:

Select the image(s) to delete.
Choose Delete from the action dropdown.
Confirm the deletion action.

Note: Deleted images cannot be restored after confirmation.

Selected Images

The selected image count is displayed as:

Total Selected Images: Displays the number of images selected for performing actions.

Selected Images URLs

The Selected Images URLs section displays the URLs of selected images, which can be used for reference or further usage.

Available Actions

Search: Allows users to search for a specific image.
Show Entries: Allows users to select the number of records displayed in the list.
Select Images: Allows users to select one or multiple images.
Fill Color: Allows users to customize image fill areas.
Scale Down: Allows users to resize images proportionally.
Delete: Allows users to remove selected images.
Selected Images URLs: Displays URLs of selected images.

Example App Images

#	Model	Reference	Image	Pixels	Bytes
1	CatalogLogo-5191	Demo Account	512 x 512 px (39 KB)	262144	39140

Bulk Actions

Product (App resources)

Overview

The Manage Resources section allows users to manage and maintain app resources linked with products. Users can add and manage resource details such as product name, resource information, URL, and availability status.

Home → Manage App → Resources

App Resources

The App Resources page displays all available resources associated with products. Users can manage product-related resources that can be accessed through the application.

Manage App Resources

To manage app resources:

Open the Resources section.
View the available resource list.
Add or update resource details as required.
Save the changes after adding or updating resource information.

The resources added here will be available for the respective products in the application.

App Resources List

The App Resources page contains the following details:

Field	Description
Product	Displays the product associated with the resource.
Resource	Displays the name or details of the resource.
URL	Displays the resource URL or link.
Available	Shows whether the resource is available or active.

Available Actions

Search: Allows users to search for a specific resource.
Show Entries: Allows users to select the number of records displayed in the list.
Add/Update: Allows users to add new resources or modify existing resource details.
Save: Saves the added or updated resource information.

Resource Availability

The Available status indicates whether the resource is accessible for the associated product in the application.

If the resource is available, it will be displayed and accessible.
If the resource is unavailable, it will not be shown in the application.

Resource List Example

Product	Resource	URL	Available
No data available

Bulk Actions

Product (Product Datasets)

Overview

The Product Datasets section allows users to manage product data by importing and exporting product datasets. Users can export existing product data, upload updated datasets, and manage product information efficiently.

Home → Manage Products → Datasets

Product Datasets

The Product Datasets page displays all available catalog products along with options to view, export, choose files, import, and delete product datasets. This section helps users manage product information in bulk using dataset files.

Manage Product Datasets

To manage product datasets:

Open the Product Datasets section.
Find the required product from the list.
Use the available options according to the requirement.

View Product Dataset

Click on the View option for the required product.
The available product dataset details will be displayed.

Export Product Dataset

Click on the Export option for the required product.
The product dataset will be exported into a file.
The exported file can be used for reviewing or updating product information.

Import Product Dataset

To import a product dataset:

Click on the Choose File option.
Select the required dataset file from your system.
Verify that the selected file is correct.
Click on the Import option.
The selected dataset file will be uploaded and imported for the respective product.

Note: Always select the correct dataset file before importing. The product data will be updated only after the import process is completed successfully.

Delete Product Dataset

To delete a product dataset:

Click on the Delete option for the required product.
Confirm the deletion action.
The selected product dataset will be removed.

Product Datasets List

The Product Datasets page contains the following details:

Field	Description
Title	Displays the product name.
View	Allows users to view available product dataset details.
Export	Allows users to export the product dataset file.
File	Provides an option to choose and upload a dataset file from the system.
Import	Allows users to import the selected product dataset file.
Delete	Allows users to delete the product dataset.

Available Actions

Search: Allows users to search for a specific product.
Show Entries: Allows users to select the number of records displayed in the list.
View: Allows users to check product dataset details.
Choose File: Allows users to select the required dataset file from the system.
Export: Downloads the existing product dataset file.
Import: Uploads and applies the selected dataset file for the product.
Delete: Removes the selected product dataset.

Example Product Datasets

Title	File
Burger King	No file chosen
Burrito	No file chosen
Chole Bhature	No file chosen
Miniso	No file chosen
Mr. DIY	No file chosen
Namaste London	No file chosen
Pantaloons	No file chosen
Rasmalai	No file chosen
Reliance Trends	No file chosen
Taco Bell	No file chosen

Bulk Actions

Product (Product Headings)

Overview

The Product Headings section allows users to manage and organize product-related content. Users can assign different content sections such as video, package details, description, specifications, resources, maps, forms, images, and scripts for catalog products.

Home → Manage Products → Headings

Product Headings

The Product Headings page displays all available catalog products along with their assigned content sections. Users can manage which information should be displayed for each product.

Manage Product Heading

To manage product heading details:

Open the Product Headings section.
Find the required product from the list.
Click on the Edit option.
Select or update the required product content sections:
- Video
- Package
- Description
- Specification
- Resource
- Map
- Form
- Image
- Script
After making the required changes, click on the Save button to apply the updates.

Note: Saving the changes after editing is required to ensure that the updated product heading details are applied successfully.

Product Headings List

The Product Headings page contains the following details:

Field	Description
Title	Displays the product name.
Video	Displays whether a video is assigned to the product.
Package	Displays package-related information assigned to the product.
Description	Displays the product description section.
Specification	Displays product specifications.
Resource	Displays available resources related to the product.
Map	Displays map-related information assigned to the product.
Form	Displays forms linked with the product.
Image	Displays product images.
Script	Displays scripts assigned to the product.
Update	Allows users to edit and update product heading details.

Available Actions

Search: Allows users to search for a specific product.
Show Entries: Allows users to select the number of records displayed in the list.
Edit: Allows users to modify product heading sections.
Save: Saves and applies the updated product heading details after editing.

Example Product Headings

Title	Video	Package	Description	Specification	Resource	Map	Form	Image	Script
Burger King	VIDEO	PACKAGE	DESCRIPTION	SPECIFICATION	RESOURCE	MAP	FORM	IMAGE	SCRIPT
Burrito
Chole Bhature
Miniso
Mr. DIY
Namaste London
Pantaloons
Rasmalai
Reliance Trends
Taco Bell

Bulk Actions

Product (Product Seo)

Overview

The Catalog Products SEO section allows users to manage search engine optimization details for catalog products. Users can add and update SEO information such as SEO title, description, and keywords for individual products to improve product visibility and search performance.

Home → Manage Products → SEO

Catalog Products SEO

The Catalog Products SEO page displays all available products along with their SEO details. Users can optimize each product by adding relevant SEO information.

Manage Product SEO

To add or update SEO details for a product:

Open the Catalog Products SEO section.
Find the required product from the list.
Click on the Edit option.
Add or update the following details:
- SEO Title: Add a relevant title for the product.
- SEO Description: Add a brief description related to the product.
- SEO Keywords: Add relevant keywords for better search visibility.
Click on Save to save the updated SEO details.

After clicking Save, the updated SEO information will be applied to the selected product.

Catalog Products SEO List

The Catalog Products SEO page contains the following details:

Field	Description
Title	Displays the product name.
SEO Title	Displays the SEO title assigned to the product.
SEO Description	Displays the SEO description assigned to the product.
SEO Keywords	Displays the keywords added for the product.
Update	Allows users to edit and update SEO details.

Available Actions

Search: Allows users to search for a specific product.
Show Entries: Allows users to select the number of records displayed in the list.
Edit: Allows users to modify SEO details of a product.
Save: Saves and applies the updated SEO information after editing.

Example Catalog Products SEO

Title	SEO Title	SEO Description	SEO Keywords
Burger King	title	description	keyword
Burrito
Chole Bhature
Miniso
Mr. DIY
Namaste London
Pantaloons
Rasmalai
Reliance Trends
Taco Bell

Bulk Actions

Category (Category Headings)

Overview

The Category Headings section allows users to manage and organize catalog categories. Users can create and manage category headings by assigning videos, sub-categories, and products to make the catalog structure more organized and easier to navigate.

Home → Manage Categories → Category Headings

Category Headings

The Category Headings page displays all available catalog categories along with their assigned videos, categories, and products. Users can manage category-related content from this section.

Manage Category Heading

To manage a category heading:

Open the Category Headings section.
Find the required category from the list.
Click on the Edit/Update option.
Add or modify the required details such as:
- Video
- Categories
- Products
Save the changes.

The assigned videos, categories, and products will be displayed under the selected category heading in the catalog.

Category Headings List

The Category Headings page contains the following details:

Field	Description
Title	Displays the name of the category heading.
Video	Shows the video assigned to the category heading.
Category	Displays the categories linked with the heading.
Product	Displays the products linked with the heading.
Update	Allows users to edit and update category heading details.

Available Actions

Search: Allows users to search for a specific category heading.
Show Entries: Allows users to select the number of records displayed in the list.
Edit/Update: Allows users to modify category heading details and assign videos, categories, or products.

Example Category Headings (you can add Video, Category & Product)

Title	Video	Category	Product
Kids
Mens	VIDEO	CATEGORIES	PRODUCTS
Restaurant
root

Bulk Actions

Category (Category Seo)

Overview

The SEO section allows users to manage search engine optimization details for catalog categories. Users can add and update SEO-related information such as SEO title, description, and keywords for better search visibility of categories.

Home → Manage Categories → SEO

Category SEO

The Category SEO page displays all available catalog categories along with their SEO details. Users can optimize each category by adding relevant SEO information.

Manage Category SEO

To add or update SEO details for a category:

Open the SEO section.
Find the required category from the list.
Click on the Edit option.
Add or update the following details:
- SEO Title: Add a relevant title for the category.
- SEO Description: Add a short description explaining the category.
- SEO Keywords: Add relevant keywords related to the category.
Click on Save to save the updated SEO details.

After clicking Save, the changes will be applied to the selected category.

Category SEO List

The SEO page contains the following details:

Field	Description
Title	Displays the category name.
SEO Title	Displays the SEO title assigned to the category.
SEO Description	Displays the SEO description assigned to the category.
SEO Keywords	Displays the keywords added for the category.
Update	Allows users to edit and update SEO details.

Available Actions

Search: Allows users to search for a specific category.
Show Entries: Allows users to select the number of records displayed in the list.
Edit: Allows users to modify SEO details of a category.
Save: Saves and applies the updated SEO information after editing.

Example Category SEO

Title	SEO Title	SEO Description	SEO Keywords
Kids	title	description	keyword
Mens
Restaurant
root

Bulk Actions

Others (Compare Groups)

Overview

The Compare Groups section allows users to create and manage comparison groups for products. Products can be assigned to a specific compare group, which helps customers compare similar products easily on the catalog.

Home → Manage Products → Compare Groups

Compare Groups

The Compare Groups page displays all available products and their assigned comparison groups. Users can manage product comparison categories by adding products to suitable compare groups.

Add Products to Compare Group

To add products to a compare group:

Open the Compare Groups section.
Find the required product from the list.
Click on the Edit option.
Assign the appropriate Compare Group to the product.
Save the changes.

Once a product is assigned to a compare group, it will be grouped with similar products and can be compared on the catalog.

Compare Groups List

The Compare Groups page contains the following details:

Field	Description
Title	Displays the product name.
Compare Group	Shows the assigned comparison group for the product.
Update	Allows users to edit and update the compare group details.

Available Actions

Search: Allows users to search for a specific product or compare group.
Show Entries: Allows users to select the number of records displayed in the list.
Edit/Update: Allows users to assign, modify, or update a product's compare group.

Example Compare Groups

Title	Compare Group
Burger King
Burrito	None
Chole Bhature
Miniso
Mr. DIY
Namaste London
Pantaloons
Rasmalai
Reliance Trends
Taco Bell

Organize

Organize (App sections)

Overview

The Catalog Sections module allows administrators to organize and customize the catalog layout within the application. It provides flexibility to control the display order of catalog sections, configure default layouts, and manage how product information is presented to users.

Catalog Section Order

The Catalog Section Order defines the sequence in which catalog sections appear within the application. Administrators can rearrange these sections to improve navigation and highlight important content.

Available Sections

Section	Description
Catalog Home	Main landing page of the product catalog.
Favourite	Displays products marked as favourites by users.
Featured	Displays featured or promoted products.
Root Categories	Displays all top-level product categories.
Root Products	Displays products available at the root level.
Recently Viewed	Displays recently viewed products.
Recently Updated	Displays recently modified products.
Recently Ordered	Displays products recently ordered by users.
Recently Enquired	Displays recently enquired products.
Recently Added	Displays newly added products.
Category	Displays category-specific information.
Products	Displays products within the selected category.
Categories	Displays child categories.
Videos	Displays product videos.
Maps	Displays location and navigation information.
Images	Displays product image gallery.
Forms	Displays custom forms associated with products.
Packages	Displays available product packages.
Description	Displays detailed product description.
Datasets	Displays additional product datasets.
Specifications	Displays technical specifications.
Resources	Displays downloadable resources and documents.
Scripts	Displays custom scripts configured for the product.
Reference Products	Displays related or recommended products.
Reference Categories	Displays related categories.

Update: Catalog sections can be reordered to customize the browsing experience based on business requirements.

Catalog Home Section

The Catalog Home Section controls which sections are displayed on the application's catalog home page.

Available Sections

Root Categories
Root Products
Recently Viewed
Recently Updated
Recently Ordered
Recently Enquired
Recently Added

Update: Administrators can enable or disable individual sections to customize the catalog home page.

Catalog Section Reset

The Catalog Section Reset option restores all catalog section settings to their default configuration.

Update: Resetting the configuration will restore the default section order and layout.

Image Configuration

The Image Configuration section controls how application logos and banners are displayed.

Setting	Description
Logo with Banner Position	Defines the position of the application logo relative to the banner image.

Update: Image configuration ensures a consistent appearance across the application.

Specification Configuration

The Specification Configuration section controls the alignment and display style of specification keys and values.

Key Configuration

Property	Value
Alignment	Left
Vertical Alignment	Center
Style	Normal

Value Configuration

Property	Value
Alignment	Left
Vertical Alignment	Center
Style	Bold

Update: Specification settings improve the readability of product specifications.

Package Configuration

The Package Configuration section defines the appearance of package information displayed within product pages.

Key Configuration

Property	Value
Alignment	Left
Vertical Alignment	Center
Style	Normal

Value Configuration

Property	Value
Alignment	Left
Vertical Alignment	Center
Style	Bold

Update: Package configuration provides a consistent layout for package details across all products.

Best Practices

Organize catalog sections based on user requirements.
Place frequently accessed sections near the top of the catalog.
Keep the Catalog Home page clean by displaying only relevant sections.
Maintain consistent alignment and styling for specifications and package information.
Review the catalog layout periodically to improve the overall user experience.

Update: Following these practices helps create a well-structured and easy-to-navigate product catalog.

Organize

Organize (App Contents)

Overview

The Sort Catalog Contents feature allows administrators to automatically sort all products and categories within the catalog. This helps maintain a consistent and organized catalog structure by arranging items alphabetically based on their names.

Sort Catalog Contents

The Sort Catalog Contents option reorganizes the entire catalog by sorting all available products and categories according to their names.

Important: This operation applies to the complete catalog and replaces any custom ordering that was previously configured.

Alert

⚠️ Warning

Performing this action will sort all products and categories alphabetically by their names.

Any manual or custom ordering configured previously will be removed.

This operation affects the entire catalog.

Once the sorting process is completed, the previous order cannot be restored automatically.

Update: Use this feature only when you want to standardize the catalog order across the entire application.

Best Practices

Verify the existing catalog order before performing the sorting operation.
Use this feature only when alphabetical ordering is required.
Avoid running this action if custom product or category ordering is currently in use.
Inform other administrators before applying the changes, as the operation affects the complete catalog.

Update: Following these recommendations helps prevent accidental changes to the catalog structure and ensures a consistent browsing experience.

Settings

Settings (Notifications)

Overview

The Catalog Notification section allows users to manage email notifications for different catalog events. Users can add notification email addresses, configure event-based notifications, and enable or disable notification status as required.

Home → Settings → Notification

Catalog Notification

The Catalog Notification page allows users to:

Add new notification email addresses.
View all configured email accounts.
Assign email addresses to notification events.
Enable or disable notifications for specific events.

Add Notification Email

To add a new notification email:

Enter the Name.
Enter the Email address.
Click on Save.

The newly added email will be available for notification events.

Email List

The Emails section displays all configured notification email addresses.

The list contains the following details:

Field	Description
Name	Displays the user's name.
Email	Displays the notification email address.
Verified	Indicates whether the email has been verified.
Used	Shows whether the email is currently being used.
Remove	Allows users to remove the email from the notification list.

Note: The default notification email is used unless another email is configured.

Global Notification

The Global Notification section allows users to configure notifications for different catalog events.

Available notification events include:

Message – Sends notifications for all messages.
Order – Sends notifications for all orders.
Form – Sends notifications for submitted forms.
Script – Sends notifications related to scripts.

Each event contains the following details:

Field	Description
Event	Displays the notification event.
Event Detail	Describes the notification event.
Email	Displays the email assigned to receive notifications.
Update	Allows users to modify the assigned email.
Status	Allows users to enable or disable notifications for the selected event.

Manage Notifications

To update notification settings:

Open the Catalog Notification section.
Select the required notification event.
Update the assigned email if required.
Enable or disable the Status according to your requirement.
Save the changes.

Available Actions

Add New Email: Adds a new notification email.
Save: Saves the entered email details.
Update: Updates the email assigned to a notification event.
Status: Enables or disables notifications for the selected event.
Remove: Removes an email from the notification list.
Enable/Disable: Controls whether notifications are sent for a specific event.

Settings

Settings (Services)

Overview

The Services section allows administrators to configure external services required by the application, such as SMS Gateway, SMTP, and Payment Gateway. These settings enable communication services, email notifications, and online payment processing.

Navigate to Settings → Services to configure these services.

SMS Gateway

The SMS Gateway is used to send SMS notifications, OTPs, and other text messages from the application.

Available SMS Gateways

Twilio
FoxGlove

Select the required SMS provider and configure it according to your account credentials.

SMTP Configuration

The SMTP section is used to configure email services for sending system-generated emails such as notifications, enquiries, password resets, and other email communications.

Configure the following fields:

Field	Description
Host	Enter the SMTP server host address.
Port	Specify the SMTP server port number.
Username	Enter the SMTP account username.
Password	Enter the SMTP account password.
Encryption	Select the encryption type (e.g., SSL/TLS).
From	Specify the sender email address.
From Name	Enter the sender name displayed in outgoing emails.

Payment Gateway

The Payment Gateway section allows administrators to configure online payment services for the application.

Available Payment Gateway

Easebuzz UPI

Select the preferred payment gateway to enable online payment functionality for supported kiosk orders.

Manage Services

Administrators can:

Configure an SMS Gateway.
Configure SMTP email settings.
Configure the Payment Gateway.
Update service credentials whenever required.

Best Practices

Verify all service credentials before saving.
Use valid SMTP credentials to ensure successful email delivery.
Configure the correct SMS Gateway before enabling SMS features.
Verify the Payment Gateway configuration before accepting online payments.

Important:
After configuring the required services, click the Submit button to save the changes. Ensure that all credentials and service settings are correct before enabling them in the application.

Settings

Settings (Credentials)

Overview

The Credentials section allows administrators to securely store and manage application credentials in the form of Key–Value pairs. These credentials can be used by different modules and integrations within the application.

Navigate to Settings → Credentials to manage credentials.

Add New Credential

To create a new credential:

Navigate to Settings → Credentials.
Click New Credential.
Enter the required Key.
Enter the corresponding Value.
Save the credential.

Each credential is stored as a Key = Value pair for easy management and retrieval.

Credential Details

Field	Description
Key	A unique identifier used to reference the credential.
Value	The corresponding value associated with the key.

Manage Credentials

Administrators can:

Add new credentials.
View existing credentials.
Update credential values.
Delete credentials that are no longer required.

Best Practices

Use unique and meaningful key names.
Store only valid configuration values.
Update credentials whenever service configurations change.
Remove unused credentials to keep the configuration organized.

Important:
Credentials are stored as Key–Value pairs and may be used by different application modules or third-party integrations. Ensure that the correct values are entered before saving.

Settings

Settings (Codes)

Overview

The Codes section allows administrators to configure the format used for generating unique codes across different modules of the application. These codes help identify records such as Orders, Form Responses, Script Responses, and TryOn Sessions in a consistent and organized manner.

Navigate to Settings → Codes to configure code generation settings.

Code Configuration

Administrators can configure the following settings:

Timezone
Default Prefix
Default Digits
Order Prefix
Order Digits
Form Response Prefix
Form Response Digits
Script Response Prefix
Script Response Digits
TryOn User Prefix
TryOn User Digits
TryOn Session Prefix
TryOn Session Digits

Each module can have its own unique prefix and digit length to generate easily identifiable codes.

Timezone

Select the appropriate Timezone for the application.

The selected timezone is used while generating date and time-based codes.

Default Code

The Default Code configuration is used for general-purpose code generation.

Configure:

Default Prefix
Pattern
Default Digits

Example Pattern:

[PREFIX]/[YYYY]/[MM]/[DD]/NNNN

Example Output:

DEF/2026/07/23/0001

Order Code

Configure the code format for customer orders.

Fields:

Order Prefix
Pattern
Order Digits

Example Output:

ORD/2026/07/23/0001

Form Response Code

Used to generate unique identifiers for submitted forms.

Fields:

Form Response Prefix
Pattern
Form Response Digits

Example Output:

FORM/2026/07/23/0001

Script Response Code

Used to generate unique codes whenever a script response is recorded.

Fields:

Script Response Prefix
Pattern
Script Response Digits

Example Output:

RESP/2026/07/23/0001

TryOn User Code

Generates a unique identifier for each TryOn user.

Fields:

TryOn User Prefix
Pattern
TryOn User Digits

Example Output:

TRYUSER/2026/07/23/0001

TryOn Session Code

Generates a unique code for every TryOn session.

Fields:

TryOn Session Prefix
Pattern
TryOn Session Digits

Example Output:

TRYON/2026/07/23/0001

Pattern Placeholders

The following placeholders can be used while creating custom code patterns.

Placeholder	Description	Example
[PREFIX]	Uses the configured prefix for the selected module.	ORD
[YYYY]	Four-digit year.	2026
[MM]	Two-digit month.	07
[DD]	Two-digit day.	23
[H]	Two-digit hour (24-hour format).	14
[M]	Two-digit minute.	35
[S]	Two-digit second.	48

Manage Code Settings

Administrators can:

Configure prefixes for different modules.
Define custom code generation patterns.
Set the number of auto-generated digits.
Configure timezone for date-based code generation.
Maintain unique identifiers across the application.

Best Practices

Use meaningful prefixes for each module.
Configure different prefixes for different record types.
Keep digit lengths consistent for better readability.
Avoid using duplicate prefixes across modules.
Verify the generated pattern before saving changes.

Important:
Every module can have its own Prefix, Pattern, and Digit Length. The application automatically generates unique codes based on these settings, ensuring that records such as Orders, Form Responses, Script Responses, and TryOn Sessions remain unique and easy to identify.

Settings

Settings (Developers)

Overview

The Developers section provides API credentials required for integrating the application with external systems, custom applications, or third-party services. It allows administrators and developers to securely access the application's APIs using generated authentication credentials.

Navigate to Settings → Developers to manage API credentials.

API Credentials

The API Credentials section contains the authentication details required for API access.

The following credentials are available:

Field	Description
API Key	A unique key used to identify and authenticate API requests.
API Token	A secure authentication token used to authorize API access.

These credentials are required when connecting external applications or services with the platform.

Generate API Token

Click Generate API Token to create a new API token.

A newly generated token can be used for secure API authentication. If an existing token is regenerated, the previous token may no longer be valid.

Manage API Credentials

Administrators can:

View the existing API Key.
Generate a new API Token.
Use API credentials for application integrations.
Authenticate API requests securely.

Best Practices

Keep API credentials confidential.
Do not share API Keys or API Tokens publicly.
Regenerate the API Token if it is compromised.
Use API credentials only in trusted applications and integrations.

Important:
The API Key and API Token are used to authenticate API requests. After generating a new API Token, ensure that all integrated applications are updated with the latest credentials.

Accounts

Accounts (Info)

Overview

The Account Information section provides an overview of the application account, including ownership details, account validity, resource limits, and supported platforms. This information helps administrators verify account status and available resources.

Account Details

The following details identify the application account and its subscription period.

Property	Value
App ID	XXXX
Owner	XYZ User
Email	xyz@example.com
Hash	XXXXXXXXX
Start Date	DD MMM YYYY
Expiry Date	DD MMM YYYY

Note: The Hash is a unique identifier associated with the application account and may be used in application-specific URLs or integrations.

Account Quota

The Account Quota defines the maximum resources allocated to the application.

Property	Value
Product Limit	XX
Kiosk Limit	XX
Disk Space	XX MB / XX GB

Description

Product Limit – Maximum number of products that can be created within the application.
Kiosk Limit – Maximum number of kiosks that can be linked to the account.
Disk Space – Total storage allocated for application data, images, and other uploaded files.

Channels

The Channels section displays the platforms that are enabled for the application.

Platform	Status
Enterprise	Yes / No
Android	Enabled / Disabled
iOS	Enabled / Disabled
Website	Open Dashboard

Description

Enterprise – Indicates whether enterprise features are enabled.
Android – Shows if Android devices are supported.
iOS – Shows if iOS devices are supported.
Website – Provides direct access to the application's web dashboard.

Additional Information

Verify the Start Date and Expiry Date to ensure the subscription is active.
Monitor the available Product, Kiosk, and Disk Space limits to avoid reaching account capacity.
Use the Dashboard link to manage products, kiosks, users, and application settings.

Accounts

Accounts (Permissions)

Overview

The App Permissions section allows administrators to control which features and modules are available for an application. Permissions can be enabled or disabled based on business requirements and the platforms being used.

Organize App Permissions

Permissions are categorized into different channels to simplify feature management across supported platforms.

Available Channels

Channel	Description
Website	Enables features for the web application.
Mobile	Enables features for Android and iOS applications.
Kiosk	Enables features for kiosk devices and interactive displays.

Available Permissions

The following permissions can be configured for the application.

Permission	Description
Call to Action (CTA)	Enables interactive call-to-action buttons and promotional actions.
Compare Products	Allows users to compare multiple products side by side.
Custom Forms	Enables customizable forms for collecting user information and feedback.
Kiosk	Grants access to kiosk-related functionality and configurations.
Kiosk Flash Banner	Displays promotional banners or announcements on the kiosk home screen.
Kiosk Group	Allows kiosks to be organized and managed as groups.
Kiosk Order	Enables ordering functionality directly from the kiosk.
Map and Navigation	Provides interactive maps and navigation features.
Order	Enables product ordering and order management features.
Reference Products / Categories	Displays related or recommended products and categories.
Resource	Allows management of downloadable resources, documents, and media files.
Script	Enables custom scripts for additional functionality and integrations.
Video	Allows video content to be displayed within the application.
TryOn	Enables the virtual Try-On experience for supported products.

Managing Permissions

Administrators can enable or disable individual permissions depending on the application's requirements. Changes take effect after saving the configuration and may require the application to refresh or synchronize.

Best Practices

Enable only the permissions required for your application.
Disable unused modules to improve usability and simplify navigation.
Review permissions regularly when adding new features or updating application requirements.
Verify platform compatibility before enabling channel-specific features.

Accounts

Accounts (User and Access)

Overview

The Users and Access section is used to manage all users associated with the application. Administrators can add new users, assign roles, monitor account status, and control access permissions.

User Management

This page displays a list of all registered users along with their account information and access details.

Available Information

Field	Description
Email	Email address used to sign in to the application.
Name	Full name of the user.
Role	Assigned user role (e.g., Admin, Editor, Viewer).
Expiry	Date until which the user's account remains active.
Status	Current account status (e.g., Active, Inactive, Pending Verification).
Action	Available actions such as Edit, Delete, or Manage User.

User List

The following table represents a sample user list.

Email	Name	Role	Expiry	Status
xyz.user@example.com	XYZ User	Admin	DD MMM YYYY	Active
abc.user@example.com	ABC User	Editor	DD MMM YYYY	Active

Note: The number of displayed entries can be adjusted using the Show Entries option, while the Search bar allows administrators to quickly locate users.

Available Actions

Administrators can perform the following actions from the Users and Access page:

Add User – Invite a new user to the application.
Edit User – Update user details and assigned roles.
Delete User – Remove a user from the application.
Assign Role – Change the user's permission level.
Activate / Deactivate – Enable or disable user access.

User Roles

Depending on the application configuration, users may be assigned different roles.

Role	Description
Admin	Full access to all application features and settings.
Editor	Can manage content and application data but has limited administrative access.
Viewer	Read-only access to application data and reports.

Best Practices

Assign the Admin role only to trusted users.
Review user accounts regularly and remove inactive users.
Set appropriate account expiry dates for temporary users.
Ensure users verify their email address before granting full access.
Periodically audit user roles to maintain application security.

Log out

Accounts -> Logout

Overview

The Logout option allows administrators to securely sign out of the currently active account. Once logged out, access to the application is restricted until the user logs in again.

Logout

To log out of your account:

Navigate to Modules → Logout.
Click the Logout option.
Confirm the action (if prompted).

After logging out, you will be redirected to the Login page.

After logout, users can sign in again using one of the following methods:

Login Method	Description
Phone Number	Log in using a registered mobile number and the required verification process.
Google Account (Gmail)	Log in using a registered Google account for quick and secure access.

Best Practices

Always log out after completing your work, especially when using a shared device.
Ensure you log in with the correct registered Phone Number or Google account.
Keep your login credentials secure to prevent unauthorized access.

Note:
After logging out, you must log in again using either your Phone Number or Google (Gmail) account to continue accessing the application.

Backend A1

Dashboard

Dashboard Stats

Disk Space Used (MB)

Products Added

Published Products

Published Categories

Published Videos

Summary

Disk Usage (Mb)

Disk Usage

Home Disk Usage

Categories Disk Usage

Field Description

Example

Product(s) Disk Usage

Field Description

Example

Disk Usage Summary

Overview

Do you Know

How to Add a Logo and Banner Image in the App?

How to Change the Default Color of the Top Navigation Bar?

How to Add a New Page?

How to Create a Group?

My App

Info

My App Settings

Basic Information

Regional Settings

Display Settings

Content Visibility

Files

My App Settings

Logo

How to Upload the Logo

Banner

Banner Requirements

How to Upload the Banner

Content

My App Settings

Forms

How to Assign a Form

Settings

My App Settings

Style

1. My App Style

2. Kiosk Style

Product Content Section

Full View Horizontal #1

Full View Vertical #1

3. Fonts

4. Headings

My App

Category

Product

5. Contact

6. Social

7. Address

Address Details

8. Order

9. CTA (Call To Action)

10. SEO

11. Resource Configuration

12. App Download Bar

Final Note

Pages

Categories

Overview

Create a New Category

Category Fields

Category List

Default Root Category

Products

Overview

Create a New Product

Product Fields

Product List

Best Practice

Languages