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:

  1. Navigate to Modules → Analytics → Reports.
  2. Select the required Report type.
  3. Choose the Date Range.
  4. Select the required Key (if applicable).
  5. 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

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

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

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.

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

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

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

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.

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

  1. Navigate to Messages → Broadcast.
  2. Enter the Title.
  3. Select a Product (if required).
  4. Enter the Message.
  5. 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

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

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:

  1. Navigate to Modules → Videos → Add Video.
  2. Enter the required video details.
  3. Upload the video file.
  4. 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

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

Best Practices

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

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:

  1. Navigate to Modules → Videos.
  2. Select the video you want to edit.
  3. Update the required information.
  4. 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

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

Best Practices

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.

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:

Upload Files

To upload a new file:

  1. Navigate to Files → Add Files.
  2. Click the upload area or drag and drop the file.
  3. Select the required file from your device.
  4. Wait for the upload to complete.
  5. 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

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.

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:

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:

Best Practices

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.

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:

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:

Edit an Image

To modify an existing image:

  1. Navigate to Files → Images.
  2. Select the desired image.
  3. Update the required information.
  4. 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:

  1. Open the required image.
  2. Click Delete.
  3. 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:

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

How to Manage Images

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

Best Practices

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.

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:

  1. Navigate to Files → Animation.
  2. Click the upload area or drag and drop the animation file.
  3. Select the required file from your device.
  4. 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:

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:

How to Upload an Animation

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

Best Practices

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."

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:

  1. Navigate to Files → Add Files.
  2. Drag and drop the video file into the upload area or click Drop files or click here.
  3. Select the required video file.
  4. 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:

Edit Video

To modify an uploaded video:

  1. Navigate to Files → Video.
  2. Open the required video.
  3. Update the required information.
  4. 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:

  1. Open the required video.
  2. Click Delete.
  3. 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:

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

How to Manage Videos

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

Best Practices

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.

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:

  1. Navigate to Files → Add Files.
  2. Drag and drop the audio file into the upload area or click Drop files or click here.
  3. Select the required audio file.
  4. 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:

  1. Navigate to Files → Audio.
  2. Open the required audio file.
  3. Update the Title, if required.
  4. Change the Status.
  5. 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:

  1. Open the required audio.
  2. Click Delete.
  3. Confirm the deletion.

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

Manage Audio Files

Administrators can:

Best Practices

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.

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:

  1. Navigate to Files → Add Files.
  2. Drag and drop the font file into the upload area or click Drop files or click here.
  3. Select the required font file.
  4. 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:

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

Edit Font

To modify an uploaded font:

  1. Navigate to Files → Font.
  2. Select the required font.
  3. Update the Title, if required.
  4. 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:

  1. Open the required font.
  2. Click Delete.
  3. 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

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.

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:

  1. Navigate to Files → Add Files.
  2. Drag and drop the 3D file into the upload area or click Drop files or click here.
  3. Select the required 3D file.
  4. 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:

  1. Navigate to Files → 3D.
  2. Open the required 3D file.
  3. Update the Title, if required.
  4. Change the Status.
  5. 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:

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

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

Manage 3D Files

Administrators can:

Best Practices

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.

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:

  1. Navigate to Files → Add Files.
  2. Drag and drop the PDF file into the upload area or click Drop files or click here.
  3. Select the required PDF file.
  4. 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:

  1. Navigate to Files → PDF.
  2. Open the required PDF file.
  3. Update the Title, if required.
  4. Change the Status.
  5. 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:

  1. Open the required PDF file.
  2. Click Delete.
  3. Confirm the deletion.

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

Manage PDF Files

Administrators can:

Best Practices

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.

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:

  1. Navigate to Files → Add Files.
  2. Drag and drop the document into the upload area or click Drop files or click here.
  3. Select the required document from your device.
  4. 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:

  1. Navigate to Files → Document.
  2. Open the required document.
  3. Update the Title, if required.
  4. Change the Status.
  5. 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:

  1. Open the required document.
  2. Click Delete.
  3. Confirm the deletion.

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

Manage Documents

Administrators can:

Best Practices

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.

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:

  1. Log in to the VirtuBox Business backend.
  2. Go to Modules -> Forms module.
  3. 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.

2. Description

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

Enter a title for the footer section of the form.

Enter a message to be displayed in the footer section.

5. Submit Button

Enter the label for the form submission button.

6. Show Title

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

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

Saving the Form

After entering the required information:

  1. Review the configured form details.
  2. 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.

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:

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

The Forms page also provides the following options:

Form Creation Workflow

Creating a form involves the following steps:

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

Step 1: Create a New Form

To create a new form:

  1. Navigate to the Forms module.
  2. Click Add New Form.
  3. 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. —
  1. Configure the required fields.
  2. 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:

  1. Open the Forms module.
  2. Select the form you want to configure.
  3. Open the Form Info page.
  4. Click Add New Page.
  5. 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
  1. 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:

  1. Open the Form Info page.
  2. Select the page where you want to add a question.
  3. Click Add New Question.
  4. 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.

  1. Configure the question settings.
  2. 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:

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:

Steps to Publish Changes

  1. Open the required form from the Forms module.
  2. Make the necessary changes to the form, pages, or questions.
  3. Save the changes where applicable.
  4. Click the Make Live button on the Form Info page.
  5. 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:

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

Important Notes

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:

  1. Navigate to the Forms module.
  2. Click on the Form Responses button.
  3. 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:

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:

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

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:

  1. Navigate to Scripts → Script Info.
  2. Click Add Script.
  3. Enter the Title.
  4. Enter a unique Slug.
  5. Write or paste the required code in the Editor.
  6. Preview the script if required.
  7. 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:

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

For example:

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:

Best Practices

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.

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:

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:

Best Practices

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

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:

Search Responses

The Search field allows administrators to quickly find responses using:

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

Manage Script Responses

Administrators can:

Best Practices

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.

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:

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:

Best Practices

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.

Navigation (Navigation)

Overview

The Navigation module is used to configure and manage maps, products, kiosks, facilities, tracks, shapes, and connectors required for navigation.

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

The Navigation module contains the following sections:

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

Navigation Path

Modules -> Navigation → Product

Product Mapping Process:

  1. Open the Navigation module.
  2. Select the Product tab.
  3. Select the required product from the product list.
  4. Select the required Map.
  5. Select the required Shape, if applicable.
  6. Select or define the required Map Point.
  7. Verify the mapping details.
  8. Click Submit.
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 Path

Navigation → Kiosk
Kiosk Mapping Process
  1. Open the Navigation module.
  2. Select the Kiosk tab.
  3. Select the required kiosk.
  4. Select the required Map.
  5. Select the required Map Point.
  6. Select the appropriate Shape, if applicable.
  7. Verify the mapping details.
  8. Save/Update the map

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 Path

Navigation → Connector

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

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:

Navigation Path

Navigation → Facility

Add Facility Type

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

Process:
  1. Open the Facility
  2. Click Add Facility Type.
  3. Enter the required Type.
  4. Enable Published if the facility type should be published.
  5. 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

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.

Navigation Path:

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
  1. Navigate to the Map Layout section.
  2. Select Add / Delete Track.
  3. Select the required Start Point.
  4. Select a different End Point.
  5. Verify the selected points.
  6. 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

Verify the Track

After creating the track, verify the following:

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:

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:

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:

12.1 Title

Enter a meaningful name for the shape.

Examples:

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:

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

3D Navigation provides separate configurations for active and inactive shapes.

Active Shape

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

Possible settings include:

Inactive Shape

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

Possible settings include:

Example Configuration

14. Bulk Configuration

The Shape section provides Bulk Configuration.

The available options include:

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:

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

  1. Select the map.
  2. Open Bulk Configuration.
  3. Select Custom.
  4. Apply the required changes.
  5. 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:

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

Global Configuration Flow

  1. Open Bulk Configuration.
  2. Select Global.
  3. Apply the required changes.
  4. 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:

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:

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:

The Map Layout is used for:

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.

Navigation (Navigation verify)

1. Overview

The Navigation Verify module is used to verify navigation configurations across maps, map points, tracks, and connectors. It displays verification results and provides information about connected point groups for each map.

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

2. Navigation Verify Page

Navigation Path: Business Backend → Navigation Verify

The Navigation Verify page contains two main sections:

  1. Verification Result
  2. 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

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

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

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

4.4 Example

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

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

[152664] (277, 130)

Where:

5. How to Verify Navigation

Follow these steps to review the navigation verification results:

  1. Open the VirtuBox Business backend.
  2. Navigate to Navigation Verify.
  3. Review the Verification Result table.
  4. Identify maps displaying a Failed status.
  5. Note the map name, map group, and number of point groups.
  6. Navigate to the Connected Points section.
  7. Expand the relevant point groups.
  8. Review the point identifiers and coordinates.
  9. Investigate the relevant map, point, track, connector, or other navigation configurations.
  10. 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:

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

8. Conclusion

The Navigation Verify module provides an overview of navigation verification results and connected point groups. Users can review map statuses, inspect point details, and investigate potential configuration issues to help maintain accurate and reliable navigation.

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.

  1. Select the required date range.
  2. 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:

If no orders are available, the system displays:

No orders to show.

Best Practices

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.

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:

  1. Select the required Date Range.
  2. Choose the appropriate order status (e.g., All, Payment Success, Payment Failed, or Payment Cash).
  3. 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:

If no package data is available, the system displays:

No Packages to show.

Best Practices

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."

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:

If no inventory data is available, the system displays:

No data available in table.

Best Practices

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."

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:

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 (No)

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

Administrators can customize:

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:

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:

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

Offline

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

Features

Manage Order Settings

Administrators can:

Best Practices

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.

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:

  1. Navigate to Modules → Vendors.
  2. Click Add New Vendor.
  3. Enter the Title of the vendor.
  4. 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:

Best Practices

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.

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:

  1. Navigate to Modules → Taxes.
  2. Click Add New Tax.
  3. Enter the Title of the tax.
  4. Configure the required tax details.
  5. 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:

Best Practices

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.

Order (Coupon Dashboard)

Orders(Issue Voucher)

Orders(Coupons)

Orders(Membership)

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:

  1. Navigate to Modules → Schedulers → Add.
  2. Select the Type of scheduler.
  3. Choose the required Category or supported item.
  4. Configure the scheduler action.
  5. Select the Start Date & Time.
  6. Select the End Date & Time (if required).
  7. 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:

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:

Best Practices

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.

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:

Best Practices

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."

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:

Manage Inactive Schedulers

Administrators can:

Best Practices

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.

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:

Best Practices

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."

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:

  1. Navigate to Modules → Reference Groups.
  2. Click Add.
  3. Enter the Title for the Reference Group.
  4. 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:

Best Practices

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.

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:

  1. Navigate to Modules → Compare Groups.
  2. Click Add Compare Groups.
  3. Enter a Group Name.
  4. 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:

Manage Compare Groups

Administrators can:

Best Practices

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.

Others (Featured Products)

Overview

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:

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:

  1. The user selects a supported Fashion Product.
  2. The user captures a Selfie using the kiosk or application.
  3. The system processes the image using the Try-On engine.
  4. The selected garment is digitally applied to the user's image.
  5. 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:

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.

Note:
Only authorized users can configure or enable the Try-On feature.

Best Practices

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.