Customers have two options for placing orders:

1. Self-Service Order Placement: Customers can browse the Shopify storefront, select products, provide shipping and payment details, and complete the order independently. Upon successful payment, customers receive an order confirmation email with a unique order ID and delivery information.

2. Assisted Order Placement: Customers can call a Customer Service Representative (CSR) for assistance. The CSR collects product details, creates a customer profile, and can add additional information like delivery dates or packaging statuses directly from the Shopify admin panel. Payment can be processed within Shopify or marked as paid if already completed externally.

HotWax Commerce periodically checks for new orders on Shopify, ensuring that users have access to the most up-to-date order information.

Furthermore, you can utilize features such as scheduled jobs for importing new orders and updating order statuses. The Job Manager app allows users to set up automated tasks, such as importing new orders at specified intervals and updating order statuses based on predefined parameters. This ensures that orders are processed promptly and accurately.

Step-by-Step Usage Instructions:

1. Setting Up Scheduled Job for Importing Orders:

   • Log in to your HotWax Commerce user account and navigate to the Job Manager app.

   • Select the Orders option from the menu, Navigate to the Import Orders job to create a new scheduled job for importing orders.

   • Configure the job settings, including the frequency of import (e.g., daily, hourly) and any specific parameters required for the import process.

   • Save the job settings to activate the scheduled import of orders from Shopify to HotWax Commerce.

2. Automatically Approving Orders:

   • Set up a scheduled job named Approved Orders within the Job Manager app.

   • Configure the job to check the approval status of Shopify orders based on parameters defined by Shopify Merchants.

   • Save the job settings to enable automatic approval of orders in HotWax Commerce.

3. Updating Orders:

   • Create a scheduled job for updating orders within the Job Manager app.

   • Configure the job settings to run at specified intervals to ensure that order information remains current.

   • Save the job settings to activate automatic updates for orders in HotWax Commerce.

For more information read here

This document outlines the guidelines and best practices for using Shopify, OMS Instances, and Launchpad Apps within Hotwax Commerce. These guidelines are designed to ensure data integrity, security, and optimal system performance.

Shopify

1. Order Creation: Do not create draft orders in the DEV-OMS or any Production Instance.

2. Webstore Usage: Never use your email address, credit card details, or phone number on the webstore. Use a fake address instead.

3. Shopify Data: Do not edit existing data on Shopify Shop and Product Store. If you create any Shopify Shop and Product Store, delete it carefully if necessary.

4. Draft Orders: Always add a shipping address when creating draft orders and Valid customer names and avoid using any special characters in the mail like (#$%&*).

5. Webstore URL: Double-check the webstore URL; it usually includes a "sandbox" for UAT instances.

OMS

1. Login Credentials: Use only your credentials. Avoid using hotwax.user credentials. If your user is not created, create the user first and then use those credentials to perform any changes in OMS.

2. Dummy Data: Do not create any dummy data on the dev or demo instance, such as using random or test as customer name or facility as any person name.

3. Documentation: Ensure you read the documentation before using any application.

4. Web Tools: Carefully access web tools. Do not edit or delete any data unless instructed.

5. SQL Queries: Do not write any SELECT or ALTER queries in the SQL entity processor.

6. CSV Format: Double-check the CSV format before uploading it in any instance.

7. Inventory Recording: When recording inventory from the UI, always use "no variance."

8. Order Processing: Avoid manually brokering, approving, or importing any order.

9. UAT Instances: Do not edit any client orders, such as approving, brokering, or fulfilling them manually.

10. Testing: Do not use Demo OMS for Testing Purposes. Always use Dev Oms for testing.

Launchpad Apps

1. Login Credentials: Use only your credentials. Avoid using hotwax.user credentials.

2. Job Execution: Do not run any job continuously. Run the job, wait approximately 5 minutes to see updated changes, then proceed. Run the bulk import job only after running any job for create or import jobs.

3. Job Management: Do not disable any job unless explicitly told so. If you did then reschedule it again.

4. User Creation: Ensure there are no spaces in the username when creating any user.

5. Security Groups: Do not create or edit any security group permissions.

6. Parking: Do not archive any parking.

7. Facility Creation: Do not create any facility unless instructed. Ensure proper naming conventions are followed, avoiding the use of your name as a facility name.

8. User Permissions: When creating any user, add the user to the product store and facility with the appropriate permissions.

9. Order Routing: Do not change the status of any brokering runs.

Additional Guidelines

Use the production instance with extreme care. Do not edit any existing data. Access production web tools only if necessary; otherwise, avoid using them. Do not run SQL queries on the production instance unless explicitly instructed to do so. { % endhint %}

These ChatGPT prompts are designed to enhance the communication and support capabilities of HotWax Commerce. By providing structured guidelines for creating social media posts, blog entries, product updates, user manuals, and troubleshooting documents, the prompts ensure clear, concise, and professional messaging tailored to the needs of eCommerce businesses. They help HotWax Commerce effectively convey the benefits of their Order Management System, keep users informed about new features and updates, and provide comprehensive support, ultimately improving user experience and operational efficiency.

LinkedIn Post Prompt

Craft a compelling LinkedIn post tailored for an audience involved in eCommerce businesses in 200 words. The style should be informative, concise, and solution-focused. Maintain a professional tone, demonstrating expertise in the field, while keeping the content accessible. Highlight recent updates, product releases, or industry insights relevant to the HotWax Commerce Order Management System. Use clear and actionable language, and if applicable, include relevant industry terms and buzzwords for credibility. Avoid excessive excitement, buzzwords, and adjectives, and ensure each post emphasizes the practical benefits of the information shared. Conclude with a clear call-to-action, encouraging readers to explore further details or visit relevant pages.

Blog Prompt

Create a blog post on a topic related to the topic, with a focus on making the content accessible to a general audience. Incorporate insights on the topic, while keeping the tone professional and free of jargon. Discuss the challenges and solutions related to the topic, and include real-world examples of anecdotes to illustrate key points. Aim for a well-structured and engaging post with a length of around 1500-2000 words. Feel free to explore different aspects of the topic, ensuring the content remains relevant and informative for readers with varying levels of expertise in the field.

Product Updates Prompt

Develop a product update that emphasizes the recent enhancements or features introduced in the HotWax Commerce platform. Highlight the significance of the update in simplifying tasks, improving user experience, or addressing specific challenges faced by users. Ensure that the context behind the update, the problem it resolves, and the solution are provided clearly and concisely with the same flow. Emphasize the benefits gained by users and how the update enhances overall efficiency or functionality within the system.

User Manual Prompt

Feature Overview and Contextual Insights

Explain the significance, benefits, and relevance of the feature within the HotWax Commerce platform. Illustrate its importance in users' tasks and how it contributes to their workflow efficiency.

Step-by-Step Usage Instructions

Offer clear and concise step-by-step guidance on how users can access and effectively utilize this feature within the HotWax Commerce interface. Ensure each step is easy to follow and includes context on why this step is crucial and the typical user who would employ it.

Specific Error Handling (if applicable)

Include guidance on how to address and resolve potential errors or issues relevant to this feature. If specific errors commonly occur during the usage of this feature, provide troubleshooting steps or solutions.

Conclusion

Summarize the overall significance of the feature, highlighting its positive impact on users' tasks and the enhancements it brings to their workflow efficiency within HotWax Commerce.

Troubleshooting Document Prompt

Create a detailed troubleshooting document to resolve issues between HotWax Commerce and Shopify or other relevant platforms. Ensure the document is clear, concise, and solution-focused, adhering to a professional tone. The document should start with a title clearly stating the issue being addressed and an objective briefly describing the purpose and desired outcome. Set up the context first and then list specific scenarios for the issue. For each scenario, outline step-by-step processes to diagnose and resolve the issue, using subheadings to organize steps logically. Detailed instructions on how to verify if the issue exists and the initial checks to perform, including steps for checking both HotWax Commerce and Shopify (or the relevant platform). Provide clear instructions on actions to take within HotWax Commerce, including navigation to relevant sections. Explain how to identify errors, provide guidance on common issues and their fixes, and include steps for rectifying errors in Shopify (or the relevant platform) and re-running jobs if necessary. Offer instructions to diagnose technical errors and suggest tools or methods non-technical users can employ to understand error messages. Add relevant examples wherever possible.

RetailWire Post Prompt

• You are the CEO of HotWax Commerce, an IT/Software company that offers omnichannel order management solutions to retail brands across the globe. Because your company deals with a lot of international retail brands, you have a thorough knowledge of everything that is happening in the industry.

• As a retail expert, you regularly share your opinions on various online forums where various experts share their views on certain topics.

• On one of those forums, the topic was: (Content of the article)

• Now, as a retail expert, you're required to answer the following question: (Question asked in the article)

Note 1: Answer the question in 130 words in very simple English without using any jargon or buzzwords.

Note 2: Make it a personal answer, so use words like "In my opinion" or "I think".

Upon receiving order details from the HotWax Commerce, the designated fulfillment center facility is promptly notified, initiating the next phase of the order fulfillment process. Store associates efficiently receive the order instructions in the fulfillment app, ensuring seamless communication and coordination, where the regular orders will move to the fulfillment app and customers who have opted for the BOPIS will move to the BOPIS app.

Subsequently, the ordered items meticulously go for Pick, Pack and Shipping.

Pick

Navigate to the Open Orders page to view all pending orders sent to this facility for fulfillment. You'll find the total number of queued orders prominently displayed at the top of the page, giving you an immediate overview of the workload.

Orders are listed in a First In, First Out sequence, but you can apply service level agreement based on shipping methods to prioritize fulfillment. To generate a picklist, simply click on the Print Picksheet function.

If you need to assign a new picker to the orders, Navigate to the user management app and create a new user and there we can find an option of show as a picker and can add the user as the picker.

To reprint the picklist, go to the "In Progress" tab and click on the Print Picklist button located at the bottom right corner of the page. If you need to change the assigned picker, you can do so on the same page by selecting the "Edit Picker" button next to the "Print Picklist" button.

Store managers have the additional option to generate a QR code by clicking on the GENERATE QR CODE button located in the bottom-left corner. Pickers can scan this QR code with their mobile devices to access their picklist directly. Pickers can pick the orders assigned to them in the picking app.

Pack

This happens in the in-progress tab, once orders are picked and ready to pack, store associates can select boxes in which the order items will be packed and generate the packing slip and shipping label.

Steps to pack the order items in the shipping boxes:

1. Navigate to the specific order details within the In Progress tab of the Fulfillment App.

2. Within the order details section, locate and click on the Add Boxes option.

3. Add the required number of boxes corresponding to the order items, ensuring adequate packaging space without excess boxes. Store associates can choose to pack multiple order items into one box, reducing shipping costs and environmental impact.

4. Upon adding boxes, store associates can further specify box types for individual order items. Click on the select box option against the order item and navigate through the dropdown menu to select the appropriate option corresponding to each item's size and packaging requirements.

5. After appropriately packing all items and selecting box types click Pack to update the shipping carrier for shipping label generation with the least shipping charges for the selected boxes.

Ship

When the order is ready to ship, the packed orders are transferred to the shipping area where carrier partners can pick the orders for delivery.

Steps to Ship Orders:

1. Go to the Completed tab, you can see all the orders on a FIFO basis.

2. Click Ship Orders function at the top to mark the orders as shipped in bulk. If Ship Packed Orders is enabled, all packed orders will be shipped. Enable the isTrackingRequired setting on shipping methods that should not be automatically be shipped unless they have tracking codes.

In the event that the packing slip or shipping label is damaged after packing an order, it can be regenerated from the completed tab.

This document explains how to handle orders from when they're first created on Shopify to updating their fulfillment status.

When orders are packed and shipped in HotWax Commerce, the fulfillment status is promptly updated. This real-time synchronization ensures that Shopify receives accurate updates on order statuses, automatically marking them as Fulfilled. This feature is vital for maintaining transparency and providing customers with real-time visibility into their order status. It also streamlines workflow efficiency by automating the fulfillment process and reducing manual tasks.

Step-by-Step Usage Instructions:

Accessing the Job Manager App:

1. Log in to your HotWax Commerce admin dashboard.

2. Navigate to the Apps section and select Job Manager.

Navigating to the Orders Section:

1. Once in the Job Manager app, locate the menu and click on Orders.

Scheduling the Completed Job:

1. In the Orders section, you'll find a list of orders awaiting fulfillment.

2. Select the orders that have been successfully packed and shipped.

3. Look for the option to schedule a job, typically labeled Scheduled Jobs or similar.

Selecting the Completed Job:

1. Within the scheduled jobs options, locate and select the Completed job.

2. This action triggers the fulfillment status update for the selected orders.

Confirming the Action:

1. Double-check the selected orders to ensure accuracy.

2. Confirm the scheduling of the Completed job.

Reviewing the Fulfillment Status Update:

1. After scheduling the job, verify that the fulfillment status has been updated successfully.

2. Check for any tracking information associated with the order, if available.

Verification in Shopify:

1. Log in to your Shopify admin dashboard.

2. Navigate to the orders section or dashboard where order statuses are displayed.

Observing the Order Status Update:

1. In Shopify, locate the recently fulfilled orders.

2. Confirm that the order status has been automatically updated to Fulfilled.

In HotWax Commerce, two types of services handle data processing: Order Management System (OMS) jobs and NiFi jobs. Understanding the runtime and scheduled frequency of these jobs is crucial for maintaining smooth operations.

Checking OMS Job Frequencies

OMS jobs manage core functions such as product, order and inventory data imports and exports. When these jobs do not run as scheduled, it can disrupt operations and cause data inconsistencies.

1. Verify Job Existence:

   • Navigate to the Job Manager app in HotWax Commerce.

   • Go to the relevant page (e.g., Orders, Inventory).

   • Locate the job by its name and description.

2. Check Job Schedule:

   • Identify the schedule of the job listed against its name.

   • Click on the job card to view job details.

3. Review Job History:

   • Click on the history text to ensure the job is running at the scheduled frequency.

Checking Napita Job Frequencies

Napita jobs manage data flows and data transformations between HotWax Commerce and External Systems. When these jobs do not run as scheduled, it can affect data synchronization and integration.

1. Open Relevant Napita Instance:

   • Access the Napita instance associated with your HotWax Commerce OMS.

2. Navigate to Parent Processor Group:

   • Find the parent processor group for your OMS instance.

   • Drill down through the processor groups to locate relevant processors.

3. Locate Relevant Processor Groups:

   • Enter the processor groups until you find the relevant processors with flowfiles.

4. Check Processor Scheduling:

   • Identify the first processor with the scheduling expression.

   • Note the cron-driven expression for the first processor.

5. Convert and Verify Cron Expression:

   • Use a cron expression generator or ChatGPT to convert the cron format and verify the schedule.

6. Review Processor Settings:

   • Ensure each processor is set to the correct schedule.

   • Verify that subsequent processord are time-driven and have the appropriate schedule after concurrent tasks.

Common Issues and Fixes:

• Incorrect Cron Expression:

  • Verify and correct the cron expression using a converter tool.

  • Ensure the expression matches the desired schedule.

• Processor Scheduling Errors:

  • Check each processor's scheduling settings.

  • Adjust schedules to ensure proper timing and concurrency.

By following this guide, you should be able to diagnose and resolve job frequency issues within HotWax Commerce, ensuring smooth and efficient data processing.

The ability to create and manage spaces and collections within GitBook is essential for organizing and maintaining documentation. This feature allows users to structure their content efficiently, ensuring that related information is grouped logically. For users who need to manage extensive documentation, such as developers, technical writers, and project managers, this feature is crucial. It ensures that their work is well-organized, easily accessible, and synchronized with source code repositories like GitHub, enhancing workflow efficiency.

Step-by-Step Usage Instructions

1. Log in to your GitBook account: Ensure you are logged into your GitBook account to access your documentation projects.

2. View Existing Collections and Spaces: In the left-hand menu, you will see all the existing collections and spaces within GitBook. This step allows you to understand the current structure and decide where new spaces or collections should be added.

3. Add a New Space or Collection: Click on the Add button next to "Spaces" for expanding your documentation by either creating new content areas (spaces) or grouping related spaces (collections).

4. Create a Space: Provide a Title for your new space. Start writing content by adding pages if you plan to create documentation directly within GitBook.

5. Configure GitHub Sync: Click on the Configure button at the top right. Synchronizing with GitHub ensures that your documentation is always up-to-date with the latest changes in your codebase.

6. Enable GitHub Sync: Click on GitHub Sync or Gitlab Sync and confirm the action. Enabling synchronization ensures that your GitBook content is in sync with your GitHub or Gitlab repository.

7. Authenticate GitHub Sync: Select the space and click on Connect with GitHub to authenticate. This step links your GitHub account with GitBook, allowing for seamless integration.

8. Specify Sync Path: Add the correct path by selecting the account, repository, branch, and directory (if any). Use the format ./folder1/folder2 for directories. Ensuring the correct path is crucial for accurate synchronization of your content.

9. Commit Message Template (Optional): Select a template for commit messages or pull request reviews if required. Using a consistent template helps maintain clarity and uniformity in your version history.

10. Select Sync Direction: Choose whether you want to sync from GitHub to Gitbook (if you write content on GitHub) or from Gitbook to GitHub (if you write content on GitBook). This determines the direction of the synchronization process based on your workflow.

11. Initiate Synchronization: Click on Sync and wait for the synchronization to complete. This final step ensures that your documentation is synchronized and up-to-date.

12. Verify Synced Pages: The pages will appear as per the summary if you are syncing from GitHub to GitBook. Verifying the synchronized pages ensures that the content is accurately updated and organized.

13. Share and Publish the Space: Once the content is available on GitBook, click on the Share button. Sharing allows others to access your documentation, enhancing collaboration and information dissemination.

14. Navigate to Publish to the Web: Navigate to the Publish to the Web button and turn the toggle on for Publish Space to the Web. Publishing to the web makes your documentation publicly accessible.

15. Customize and Save the URL: A custom URL will appear, which you can change as per your preference and save the URL link. A customized URL ensures that your documentation is easily accessible and memorable for users.

16. Access the Published Pages: The GitHub pages will now appear on the web with the custom URL you set. This final step ensures that your documentation is publicly available and can be accessed by anyone with the URL.

By following these steps, users can efficiently create, manage, and publish their documentation within GitBook, ensuring a streamlined and organized workflow.

In HotWax Commerce, jobs are pivotal for executing various operations like data importing or exporting. Each job comprises two essential components: service and runtime. The service component determines which service will execute the job operation, while the runtime component configures job details such as scheduling and frequency. Services are stored in the service engine, while runtime data resides in a separate entity known as runtimedata. The combinations of runtime and service are stored in the jobsandbox entity, which creates a draft job for every scheduled job, serving as a benchmark copy for new job runs.

One of the issues encountered in HotWax Commerce Job Management is the occurrence of runtime configuration errors, disrupting the scheduling and execution of jobs. These errors stem from the corruption of runtime data, resulting in incorrect job configurations and subsequent failures during execution.

Troubleshooting Steps:

1. Access Webtools: Navigate to the webtools section of your specific HotWax Commerce instance.

2. Open Entityengine: Within webtools, locate and click on entityengine.

3. Find Jobsandbox Entity: In the entityengine menu, locate the jobsandbox entity.

4. Search for Job: Use the search functionality within the jobsandbox entity to find the job with the relevant jobid. Set its status as service_draft.

5. View Job Details: Once you've located the job, you'll see a table displaying various details, including the runtime ID of the job.

6. Navigate to Runtimedata: Return to the entityengine menu and search for the runtimedata entity.

7. Check XML Content: Within the runtimedata entity, locate the entry corresponding to the runtime id of the job. Check the XML content associated with it.

8. Modify XML Data: Using appropriate tools, extract the XML data and remove any extraneous content or rich formatting. You can utilize generative AI tools like ChatGPT for this purpose.

9. Update Runtime XML: Paste the refined XML data back into the runtimeid field of the job entry within the jobsandbox entity.

10. Save Changes: Confirm the changes and save the updated runtime data.

11. Schedule the Job: With the runtime data corrected, you can now successfully schedule the job without encountering any runtime configuration errors.

By following these steps, users can efficiently rectify runtime configuration errors within the HotWax Commerce platform, ensuring uninterrupted job scheduling and smooth workflow operation.

Napita is a data integration tool designed to automate data flow between systems in real-time. It provides an intuitive interface for designing, controlling, and monitoring data flows, making it ideal for simple data ingestion tasks and complex data transformation scenarios. HotWax Commerce OMS relies on Napita as a pivotal component for seamless communication with external systems like Netsuite ERP, enabling smooth data exchange and integration within the ecosystem.

Schedule Processors

Discover how to effectively manage Napita's Processors' operations using the Scheduling tab, influencing data flow within the platform.

The Scheduling tab within the Processor Configuration dialog in Napita offers crucial settings for managing how a Processor operates, impacting the flow of data within the platform. Let's break down its significance and provide step-by-step instructions on how users can utilize this feature effectively.

Step-by-Step Usage Instructions:

Accessing the Scheduling Tab:

1. Right-click on the Processor within Napita.

2. Select the Configure option from the context menu. Alternatively, double-click on the Processor.

3. Navigate to the Scheduling tab within the Configuration dialog.

Step-by-Step Usage Instructions:

Accessing the Scheduling Tab:

• Right-click on the Processor within Napita.

• Select the Configure option from the context menu. Alternatively, double-click on the Processor.

• Navigate to the Scheduling tab within the Configuration dialog.

Selecting Scheduling Strategy:

• Choose a scheduling strategy based on processing needs:

  • Time Driven: Timer Driven scheduling, operates by scheduling the Processor to execute at regular intervals. This straightforward approach is suitable for tasks requiring periodic processing, such as batch data updates or routine maintenance activities. Users can configure the timing of execution using the Run Schedule option, defining the frequency at which the Processor operates based on predefined intervals.

  • Event Driven: For scenarios demanding real-time responsiveness and dynamic processing, the Event Driven scheduling mode presents an experimental yet intriguing option. In this mode, the Processor is triggered to run by specific events, typically initiated when FlowFiles enter connections linked to the Processor. While offering potential benefits in terms of real-time data handling, users should exercise caution with this mode, as its experimental nature means it may not be supported by all Processors and could introduce unpredictability into production environments.

  • CRON Driven: The CRON Driven scheduling mode provides the utmost flexibility, enabling users to define precise scheduling patterns using CRON expressions. This approach is particularly well-suited for complex scheduling requirements where specific timing and periodicity are essential. With CRON expressions, users can specify intricate schedules, encompassing various time intervals and patterns for Processor execution. However, it's important to note that the CRON Driven mode introduces increased configuration complexity compared to the other scheduling strategies, requiring users to understand the intricacies of CRON syntax. You can check cron expressions here.

Configuring Concurrent Tasks:

• Determine the number of threads the Processor will use simultaneously with the Concurrent Tasks option.

• Increasing this value can enhance data processing speed but may impact system resources.

Defining Run Schedule:

• Specify how often the Processor should run:

  • For Timer-driven strategy: define a time duration (e.g., 1 second, 5 minutes).

  • For CRON-driven strategy: refer to CRON expression format for scheduling details.

Managing Execution:

• Choose between All Nodes or Primary Node for Processor execution.

  • All Nodes schedules the Processor on every node in the cluster, while Primary Node limits it to the primary node only.

Adjusting Run Duration:

• Slide the Run Duration slider to balance between lower latency and higher throughput.

• Prioritize lower latency for quicker processing or higher throughput for more efficient resource utilization.

Applying Changes:

• After configuring settings, click Apply to implement changes or Cancel to discard them.

PreviousView and Manage ProcessorsNextFlow Definitions

Last updated 14 days ago

Problem:

Support requests occasionally arise where orders remain stuck in a store’s queue, even after being fulfilled by the store itself or another facility.

Error Identification:

These issues are typically reported by stores to the customer support team. The team then escalates the issue to HotWax support for resolution, as the affected orders remain in the store queue despite being fulfilled. Consequently, the store continues to see these orders in their queue, even when there are no active orders assigned to them.

Cause Analysis:

Orders become stuck because they are repeatedly rejected and reassigned (re-brokered) to the same facility.

Solution:

1. Log in to WebTools and navigate to the Service Engine.

2. Search for the service: deleteSolrDocumentByQuery.

3. Schedule the service with the following parameters:

   • coreName: enterpriseSearch

   • query: docType:OISGIR AND orderId:[HcOrderId] AND orderItemSeqId:[orderItemSeqId]

   Note: Replace orderId and orderItemSeqId with the relevant values for the specific order you are addressing.

4. Execute the service.

This will delete the OISGIR Solr document and remove the order from the store’s queue.

DataFlow Manager (DFM)

In NiFi, a DFM has the authority to manage the flow of data. This includes tasks like adding, removing, and modifying various components within the data flow.

Canvas

In NiFi, the canvas refers to the graphical interface where DataFlow Managers (DFMs) design and visualize their dataflows. It's the workspace where components are added, connected, and configured to create data processing pipelines.

Component

Components in NiFi are the building blocks used to construct dataflows on the canvas. These include Processors, Ports, Connections, Process Groups, Remote Process Groups, Funnels, and others. Each component serves a specific function within the data flow and can be configured to tailor its behavior according to the data processing requirements.

FlowFile

A FlowFile in NiFi represents a piece of data. It consists of two main parts: FlowFile Attributes, which provide context or metadata about the data, and FlowFile Content, which is the actual data being processed.

Attributes

In NiFi, attributes provide metadata or contextual information about the data being processed. Each FlowFile in NiFi carries a set of attributes along with its content. These attributes are key-value pairs that describe various characteristics of the data. Common attributes include UUID (a unique identifier for the FlowFile), filename (a human-readable name for the data file), and path (a hierarchical value indicating the storage location). Attributes play a crucial role in routing, transformation, and decision-making within the data flow.

Processor

Processors are components responsible for performing actions on FlowFiles, such as listening for incoming data, transforming it, or routing it to different destinations.

Relationship

Each Processor in NiFi has Relationships associated with it, indicating the possible outcomes of processing a FlowFile. These relationships determine where the FlowFile should be routed next.

Connection

Connections in NiFi link components together, allowing the flow of data between them. Each connection has one or more Relationships, and it includes a FlowFile Queue to manage the data being transferred.

Controller Service

Controller Services provide reusable configurations or resources for other components in NiFi. For example, the StandardSSLContextService can be used to configure SSL settings across multiple processors.

Reporting Task

Reporting Tasks in NiFi generate background reports on various aspects of the data flow, providing insights into system performance and activity.

Parameter Provider

Parameter Providers supply external parameters to Parameter Contexts in NiFi, allowing for dynamic configuration of components.

Funnel

A Funnel component in NiFi merges data from multiple Connections into a single stream, simplifying the data.

Process Group

Process Groups allow for the organization and abstraction of components within the data flow. They enable DFMs to manage complex dataflows more effectively.

Port

Ports in NiFi provide connectivity between Process Groups and other components in the data flow, facilitating data exchange.

Remote Process Group

Remote Process Groups enable the transfer of data between different instances of NiFi, useful for distributed data processing scenarios.

Bulletin

Bulletins provide real-time monitoring and feedback on the status of components within NiFi, helping DFMs identify issues or concerns.

Template

Templates in NiFi allow DFMs to save and reuse portions of the data flow, streamlining the development process and promoting code reuse.

flow.xml.gz

The flow.xml.gz file stores the configuration of the dataflow in NiFi. It is automatically updated as changes are made and can be used for rollback purposes if needed.

Within the HotWax Commerce platform, the Order Brokering feature plays a crucial role in optimizing the fulfillment facility for orders. By automatically analyzing order priorities and determining the most suitable fulfillment location based on factors like proximity and inventory availability, this feature significantly enhances workflow efficiency and order management capabilities.

Step-by-Step Usage Instructions:

• Log in to your HotWax Commerce launchpad.

• Navigate to the Apps section and locate the Job Manager app.

• Within the Job Manager app, locate and click on the Brokering option from the menu.

• Click on the tab labeled Create New Brokering Tab to access the brokering options for new orders.

• A new window will open displaying details of the Order Brokering process, including runtime and scheduling options.

• Review the order details, including SLA (service level agreement), and fulfillment criteria.

• Once we have reviewed the details, click on the save changes button to initiate the brokering process for the approved orders, the scheduled job will run, use the run now feature if you want to run the brokering engine only once.

By following these steps, users can effectively utilize the Order Brokering feature within the HotWax Commerce interface, optimizing order fulfillment processes and enhancing workflow efficiency.

View and Manage Processors

Learn how managing processors in Napita streamlines dataflows. Organize them in groups for efficient monitoring and modification.

The ability to view and manage processors within the Napita platform is crucial for users engaged in managing complex dataflows and ensuring the smooth processing of data between various systems. Processors, as components in Napita, play a vital role in tasks like data ingestion, transformation, and routing. They act as workers, handling incoming data and performing actions on it based on defined configurations.

Organizing processors within process groups and parent process groups offers users a structured approach to managing their data workflows. This feature enhances efficiency by allowing users to easily locate, monitor, and modify processors as needed within Napita. By providing a clear overview of the processors involved in specific functions, users can quickly identify areas for optimization or troubleshooting.

Understanding the hierarchy of processors within process groups and parent process groups is essential for users to grasp the overall dataflow architecture within NiFi. It helps them comprehend how data moves through different stages of processing and where specific actions are performed. This visibility is invaluable for maintaining data integrity and ensuring the reliability of the overall system.

Locate processors

1. Access Napita Interface: Begin by accessing the Napita interface, where processors are managed. This is typically done through a web browser by entering the URL of your Napita instance.

2. Locate Parent Processor Group: Within Napita, navigate to the parent processor group associated with the instance you're managing. These groups are often named according to their function or the systems they interact with. For example, you may find a parent processor group named demo-oms for managing data flows related to the demo-oms instance.

3. Navigate Through Hierarchy: Double-click on the parent processor group to explore its contents. Inside, you'll find process groups organized based on specific functions or tasks, such as data ingestion, transformation, or routing.

4. Identify Relevant Process Group: Locate the process group that corresponds to the specific function or task you want to manage. For instance, if you're interested in monitoring flow for approved orders, look for the process group labeled Approved Orders Flow.

5. View Processors: Double-click on the identified process group to view all the processors contained within it. Processors are represented as individual components responsible for performing various tasks on data as it flows through the NiFi system.

Manage Processors

The feature to manage Process Groups within Napita is integral for users orchestrating complex data workflows. By offering a multitude of options through the context menu, users gain control over the configuration, monitoring, and optimization of their data pipelines.

Step-by-Step Usage Instructions:

1. Access Process Group Options:

   • Right-click on the desired Process Group within Napita to open the context menu.

2. Configure:

   • Choose this option to establish or modify the configuration of the Process Group, enabling customization according to specific business requirements.

3. Variables:

   • Select this option to create or configure variables within Napita, providing flexibility in managing dynamic data processing scenarios.

4. Enter Group:

   • Use this option to enter the Process Group and access its contents for configuration or monitoring purposes.

5. Start/Stop:

   • Start or stop the Process Group based on operational requirements, ensuring efficient resource utilization and workflow execution.

6. Run Once

   • Execute a selected Processor exactly once, based on configured execution settings. However, this only works with Timer-driven and CRON-driven scheduling strategies.

7. Enable/Disable:

   • Enable or disable all processors within the Process Group to control data processing activities and optimize system performance.

8. View Status History:

   • Open a graphical representation of the Process Group's statistical information over time, aiding in performance monitoring and troubleshooting.

9. View Connections:

   • Navigate to upstream or downstream connections to visualize and analyze data flow within the Process Group, facilitating troubleshooting and optimization efforts.

10. Center in View:

    • Center the view of the canvas on the selected Process Group for improved visibility and navigation within the interface.

11. Group:

    • Create a new Process Group containing the selected Process Group and any other components selected on the canvas, facilitating organizational management of data workflows.

12. Download Flow Definition:

    • Download the flow definition of the Process Group as a JSON file, enabling backup, restoration, and version control of configurations.

13. Create Template:

    • Generate a template from the selected Process Group, allowing for reuse and standardization of data processing workflows.

14. Copy:

    • Copy the selected Process Group to the clipboard for duplication or relocation within the canvas, providing flexibility in designing data workflows.

15. Empty All Queues:

    • Remove all FlowFiles from all queues within the selected Process Group, facilitating maintenance and resource optimization.

16. Delete:

    • Permanently delete the selected Process Group, enabling users to clean up outdated or unnecessary components from the system.

PreviousGlossaryNextSchedule Processors

Last updated 14 days ago

Verify Processor Properties

Learn how to configure and verify crucial properties like Database Connection Pooling (DBCP) and Secure File Transfer Protocol (SFTP) for efficient data handling in Napita.

Processors are components designed to execute tasks on data within a system's dataflows. They handle tasks like data ingestion, transformation, routing, and interaction. Properties within processors are settings dictating how a processor operates and handles data. These settings allow users to customize processor behavior, including parameters like database connections (DBCP), SFTP details, etc.

Users configure these properties through Napita during processor setup. Verifying processor properties during creation ensures that entered values are acceptable. While additional properties may need configuration based on specific requirements, database connection (DBCP) and SFTP properties are mandatory for processor execution. If a property's value is invalid, the processor cannot be executed or utilized until the value is verified.

Database Connection Pooling (DBCP)

Database Connection Pooling (DBCP) within Napita is crucial for efficient management and reuse of database connections. By implementing DBCP, users can enhance workflow efficiency, particularly when using processors like ExecuteSQLRecord and QueryDatabaseTableRecord.

This feature reduces the overhead of creating new database connections for each operation, optimizing resource utilization and improving performance. DBCP streamlines database operations by managing and sharing connections among different processors, reducing the time and resources needed for connection establishment.

Verifying the DBCP service at the parent level ensures consistency and validity of connection properties across different processors, minimizing errors or inconsistencies in the database configuration.

Step-by-Step Usage Instructions:

1. Access Processor Configuration: Right-click on the desired processor (e.g., ExecuteSQLRecord or QueryDatabaseTableRecord) and select Configure to open the Configure Processor window.

2. Select Database Pooling Service: Within the configuration window, specify the Database Pooling Service in settings related to database connections.

3. Choose Service from Dropdown: Select the appropriate Database Connection Pooling service from the dropdown menu to manage and reuse database connections efficiently.

4. Verify Properties: After selecting the Database Pooling Service, verify associated properties, by clicking the Verify Properties button to ensure the correctness of specified values, identifying potential issues or inconsistencies in the database configuration.

Secure File Transfer Protocol

The SFTP (Secure File Transfer Protocol) service in Napita facilitates secure file transfer between the platform and remote servers. By using SFTP, users can exchange files securely with external systems, ensuring data integrity and confidentiality. SFTP enables seamless and secure file transfer operations within the HotWax Commerce. Whether retrieving files from remote servers or uploading files securely, SFTP provides a reliable method for data exchange with external systems. This is relevant for integrating HotWax Commerce with other systems or performing data exchange operations with external partners. Verifying SFTP properties confirms that connection details are correctly configured, preventing data corruption or loss during file transfers.

Step-by-Step Usage Instructions:

1. Access Processor Configuration: Right-click on the processor associated with SFTP operations (e.g., GetSFTP or PutSFTP) and select Configure to open the Configure Processor window.

2. Enter SFTP Properties: Locate the fields for SFTP properties in the configuration window, including Hostname, Port, Username, Password, and Remote Path. Input relevant values for each property based on file transfer requirements.

3. Verify Properties: Once necessary SFTP credentials are entered, verify properties by clicking on the Verify Properties button to ensure correct and valid configuration.

The Bulletin feature in Napita provides users with real-time notifications about the status and events occurring within the data flow. This feature significantly enhances users' ability to track the health and performance of their data pipelines, enabling them to promptly address any issues or concerns.

Significance and Benefits:

1. Real-time Monitoring: The Bulletin feature offers users immediate visibility into events and issues happening within their data flow, allowing for proactive monitoring and management.

2. Enhanced Visibility: By displaying bulletins at both the component and system levels, users gain comprehensive insights into the status and health of their data flow, empowering them to make informed decisions.

3. Troubleshooting Assistance: Bulletins provide valuable context and information about warnings, errors, and other noteworthy events, facilitating efficient troubleshooting and problem resolution.

4. Customizable Alert Levels: Users can configure the bulletin level to suit their monitoring needs, ensuring they receive notifications for events of specific severity levels, such as warnings and errors.

Step-by-Step Usage Instructions:

1. Accessing Bulletin Settings:

   • Navigate to the Processor Configuration dialog by selecting the desired processor.

   • Click on the Settings tab within the Processor Configuration dialog.

2. Configuring Bulletin Level:

   • Scroll down to locate the Bulletin level option.

   • Choose the desired bulletin level (e.g., DEBUG, INFO, WARN, ERROR) based on your monitoring requirements.

   • This setting determines the minimum severity level of bulletins that will be displayed in the User Interface.

3. Monitoring Bulletins:

   • Observe the bulletin icons displayed on components in Napita

   • Hover over the icon with your mouse to view a tooltip providing details such as the time, severity, message, and node (if clustered) associated with the bulletin.

4. Viewing System-Level Bulletins:

   • Check the Status bar near the top of the page for system-level bulletins.

   • Hover over the system-level bulletin icon to view relevant information.

5. Accessing the Bulletin Board Page:

   • Open the Global Menu.

   • Select the Bulletin Board Page to view and filter bulletins from all components.

By following these steps, users can effectively utilize the Bulletin feature within Napita to monitor their data flow and ensure smooth operation.

With the Bulletin feature, Napita users can maintain the reliability, performance, and efficiency of their data pipelines by staying informed about critical events and taking proactive measures to address them.

In Napita a queue acts as a temporary storage buffer that facilitates the seamless transfer of data between processors within a data flow. As data moves from one processor to another, it is temporarily stored in these queues, allowing for efficient management of data flow and ensuring smooth processing. While queues offer several advantages, they may occasionally require maintenance to ensure the integrity and efficiency of the data flow. One common scenario that necessitates attention is when a processor fails due to a corrupted file present in the queue. For example, consider a data flow scenario where files are retrieved from an SFTP location from one processor and further processed by subsequent processors. If a file retrieved from the SFTP location have invalid file format, it can prevent the subsequent processor from executing successfully. In such instances, simply changing the invalid file on the SFTP location may not suffice, as the processor will still attempt to process the previous file, resulting in repeated failures. To address this issue effectively, it becomes essential to empty the queue containing the invalid file and replace it with a valid file from the data source. By doing so, the data flow can resume its operation with the latest and valid data, ensuring accurate processing and preventing further disruptions.

Resolution Steps:

Identify the Queue: Determine which queue in your data flow is holding the invalid file. This queue is typically located between the processor that retrieved the file and the subsequent processor that failed to execute.

Empty the Queue:

1. Right-click on the queue located before the failing processor.

2. Select the "Empty Queue" option to remove the corrupted file from the queue.

Re-run the Processor:

1. Right-click on the processor located prior to the emptied queue.

2. Choose the "Run Once" option to execute the processor again and list a new file from the source (e.g., SFTP location).

3. This action ensures that the latest file is listed in the queue for processing.

Verify Queue Contents:

1. To verify that the queue is now holding the correct file, right-click on the queue.

2. Select the "List Queues" option. This will display all files currently listed in the queue.

3. Click on the eye icon next to the file name to view and verify the data of the latest file.

Process the File:

1. After confirming that the correct file is in the queue, right-click on the subsequent processor that processes the file and click on Run Once button.

2. Ensure that the file is successfully processed by monitoring the processor's status and logs.

Schedule Processors:

1. Once the file is successfully processed, you can schedule the processors in your Napita flow as needed.

2. Verify that the data flow is functioning as expected by monitoring subsequent data processing steps.

By following these troubleshooting steps, you can effectively manage queues in Napita and ensure smooth data processing within your workflows, addressing issues such as Invalid files promptly and efficiently.

Hotwax Commerce uses two platforms for bug reporting: GitHub (primarily for front-end issues) and ClickUp (for all other issues). Here’s a detailed guide on how to use each platform:

GitHub

1. Log in to your GitHub account.

2. Navigate to your repository.

3. Go to the "Issues" section.

4. Click on the "New issue" button in the top right corner.

Issue Template

Title:

• Short and accurate.

Description:

• Include various elements based on the tag.

For "Bug" label:

## Note
Include important information.

## Current Behavior
Describe the current behavior here.

## Expected Behavior
Describe the expected behavior here.

## Steps to Reproduce
List the steps to reproduce the issue here.

## Environment Details
Provide details such as:
- Browser: Google Chrome, 126
- OS: Ubuntu 22.04 LTS
- Code Version: 2.23.0

## Additional Information
Add any relevant information like screenshots, videos, jam links, etc.

Additional Settings:

• Labels: As per the requirements.

Label Descriptions:

• bug: Indicates an unexpected problem or unintended behavior.

• documentation: Indicates a need for improvements or additions to documentation.

• duplicate: Indicates similar issues, pull requests, or discussions.

• enhancement: Indicates new feature requests.

• good first issue: Indicates a good issue for first-time contributors.

• help wanted: Indicates that a maintainer wants help on an issue or pull request.

• invalid: Indicates that an issue, pull request, or discussion is no longer relevant.

• question: Indicates that an issue, pull request, or discussion needs more information.

• wontfix: Indicates that work won't continue on an issue, pull request, or discussion.

Description Structure Based on Label:

For "Enhancement" label:

• Current Behavior: Describe the current state of the feature.

• Objective of Proposal or Motivation for Adding/Enhancing the Feature: Explain the purpose or need for the enhancement.

• Acceptance Criteria: Define the criteria for considering the enhancement complete.

• Impact: Describe the impact of the enhancement.

• Additional Information: Provide any additional information relevant to the enhancement.

Projects:

• Choose Priority, Size, Milestones, Expected Go Live Date, Severity.

Milestones:

• Use milestones to track progress on groups of issues or pull requests in a repository.

Development:

• Link a branch or pull request by selecting a repository.

ClickUp

ClickUp is generally used for issues other than front-end issues like backend, documentation, etc.

Steps to Create an Issue in ClickUp:

1. Log in to ClickUp.

2. Navigate to Your Workspace:

   • Select the workspace (e.g., Hotwax Commerce).

3. Go to Your Space, Folder, and List:

   • Select the relevant space, folder, and list where the task will be added.
4. Create a Task:

   • Click on the “Add Task” button.

5. Fill in Task Details:

   • Title: Clear and concise title.

   • Description: Detailed description of the task.
6. Choose the Task Location:

   • Specify space, folder, and list (e.g., "Product Management" space, "Documentation" folder, and "Backlog" list).
7. Select Task Type:

   • Define the task type (e.g., task, milestone, bug, report).
8. Additional Options:

   • Status: Set the task status as open.

   • Assignee: Assign the task to the relevant person.

   • Due Date: Set a deadline.

   • Priority: Indicate priority (e.g., Low, Medium, High).

   • Tags: Add relevant tags.

9. Create Sub-tasks:

   • If necessary, create sub-tasks.

10. Create the Task:

    • Click on the “Create Task” button to finalize.

Jam

• Jam can be used for reporting issues directly in various applications like GitHub, Clickup, Jira, GitLab,etc. For more details on using Jam, refer to Jam's documentation.

• Using clear and structured issue templates significantly improves the quality of bug reports and feature requests, making it easier for the team to address and prioritize them effectively.

Using Jam for Github:

• Steps to create issues using Jam:

  1. Open plugins/extensions in your browser.

  2. Select the option (e.g., capture Screenshot, Record tab, Record Desktop, Instant replay).

  3. Reproduce the issue or bug with a screen recording.

  4. Authorize the GitHub integration from Jam.
  5. Add details like Issue Title, description, issue info (repository, assignees, labels, milestone).

  6. Click on the "Create issue" button to be redirected to the issue tab.

Using Jam for ClickUp:

• Jam can be integrated with ClickUp for direct issue creation.

• Steps to integrate Jam with ClickUp:

  • Authorize the ClickUp integration from Jam.

  • Follow the similar steps as described for GitHub issues using Jam.

HotWax Commerce uses Napita to transform and export data. If the SQL query in NiFi (Napita) is incorrect, it can result in exporting data that does not meet the client's requirements. This SOP will guide you through the steps to identify and rectify such issues.

Steps to Diagnose and Resolve Data Export Discrepancies

Verify the Discrepancy

1. Access the Exported Data:

   • Navigate to the location where the exported data is stored (e.g., SFTP location).

   • Download and review the exported data file.

2. Compare with Required Data:

   • Obtain the data requirements from the client.

   • Compare the exported data against the required data specifications to identify discrepancies.

Initial Checks

1. Check the Last Sync:

   • Verify the last sync time to ensure that the latest data has been exported.

2. Review Recent Changes:

   • Check for any recent changes in the data requirements or the Napita setup.

Navigate to Napita Instance

1. Access NiFi:

   • Log in to Napita Instance

2. Locate the Relevant Process Groups:

   • Identify the parent process groups related to the data export.

   • Drill down to the relevant root process groups where the data transformation occurs.

Diagnose the SQL Query

1. Stop the Processors:

   • Right-click on the Napita canvas.

   • Stop the processors to prevent further data export during troubleshooting.

2. Access Parameters:

   • Select the parameters option to open a new module with all existing parameters of the group.

3. Search for the SQL Query:

   • Look for the parameter named source.sql.query.

4. Review and Modify the SQL Query:

   • Study the current SQL query to understand its logic.

   • Modify the SQL query as per the client’s data requirements.

Validate the Changes

1. Run the Processors:

   • Run the processors once to generate a new data export.

   • Check the results in the SFTP location.

2. Verify the Data:

   • Compare the newly exported data with the required data specifications.

   • Ensure that the data now matches the client's requirements.

6. Schedule the Processors

Steps:

1. Resume Processors:

   • Monitor the first few exports to ensure continued accuracy.

Data Provenance

Discover how Napita's Data Provenance feature enables users to monitor, troubleshoot, and optimize dataflows by tracking the journey of data objects in real-time.

View Data Provenance

Napita's Data Provenance feature is a critical tool for users involved in monitoring and troubleshooting dataflows. It provides detailed information about the journey of data objects (FlowFiles) as they move through the system, enabling users to track, analyze, and understand data transformations, routing decisions, and processing events in real-time. By offering insights into data lineage, event details, and attribute modifications, Data Provenance empowers users to ensure dataflow compliance, optimize performance, and swiftly identify and resolve issues.

Step-by-Step Usage Instructions:

1. Access Data Provenance Page:

   • Right-click on the desired dataflow within Napita.

   • Select the View Data Provenance option from the menu.

2. Explore Data Provenance Information:

   • In the Data Provenance dialog window, review the most recent Data Provenance information available.

   • Utilize search and filter options to locate specific items or events within the dataflow.

3. View Event Details:

   • Click the View Details icon (i) for each event to open a dialog window with three tabs: Details, Attributes, and Content.

   • Review event details on the Details tab, including event type, timestamp, component, and associated FlowFile UUIDs.

4. Analyze Attributes:

   • Navigate to the Attributes tab to view the attributes present on the FlowFile at the time of the event.

   • Optionally, select the Only show modified checkbox to display only the attributes that were modified as a result of the processing event.

Replay FlowFiles

Replaying FlowFiles in Napita empowers users to inspect, troubleshoot, and validate data processing within their workflows. Whether it's verifying the correctness of data transformations or testing configuration changes, the ability to replay FlowFiles provides users with a powerful tool for ensuring the reliability and efficiency of their dataflow.

Step-by-Step Usage Instructions:

Access FlowFile Details:

1. Right-click on the desired processor within Napita

2. Select the View Details option from the context menu.

Navigate to Content Tab:

1. In the View Details dialog window, navigate to the Content tab.

Replay FlowFile:

1. Review information about the FlowFile's content, such as its location and size.

2. Click the Submit button to replay the FlowFile at its current point in the flow.

3. Optionally, click the Download button to download a copy of the FlowFile's content.

Replay Last Event from Processor:

1. Right-click on the desired Processor within Napita

2. Select the Replay last event option from the context menu.

3. Choose whether to replay the last event from just the Primary Node or from all nodes.

Last updated 14 days ago

Flow Definitions

Learn how to efficiently manage and reuse data flow designs in Napita using Flow Definitions.

Flow Definitions are akin to Templates, referring to reusable data flow components and configurations for saving and reusing in various instances. They enable users to create reusable flow templates, which can be shared, imported, and customized across different Napita instances, fostering consistency, standardization, and reuse of data flow designs.

Users can customize imported Flow Definitions by adjusting parameter values, modifying connections, or adding components to meet specific requirements. The existing flows can be used both in the same instance or in altogether a new instance

Reusing Flow Definitions in Same Instance

Export Flow:

1. In Napita, you can download the flow definition by right-clicking on the processor desired for other instances and selecting 'Download Flow Definition'. A JSON file containing the flow definition will be downloaded.

2. Ensure downloading without external services, as their defined schemas for controller services may not suit all flow definitions. For instance, DB connection details are external services differing for clients. Hence, such details should not be saved in flow templates.

Import Flow Definition:

Once the flow definition is downloaded, import it into the processor for reuse in other instances.

1. Navigate to the parent process group where you want to create a new processor.

2. Drag Process Group from the menu to the canvas.

3. Click the Browse icon, upload the file, and provide appropriate naming as per the required process flow.

Create Parameter Context

When creating a processor using the flow definition within the same file, it is important to create a new parameter context for the new flow. If the parameter context remains the same, any changes in the parameter will be reflected in the source flow file. To avoid this, follow these steps:

1. Right-click on the Canvas and Select Configure to edit the processor configuration. Locate 'Process Group Parameter Context' in the General Tab:

2. Switch to the General tab. Here, you'll find the option labeled as Process Group Parameter Context.

3. Click on the dropdown menu next to "Process Group Parameter Context." Scroll down to the bottom of the list where you'll find the option to "Create New Parameter Context." Choose this option to create a new parameter context for the flow.

4. Add the Name of the Parameter Context. Choose a descriptive name that reflects the purpose or function of the flow to maintain clarity and organization.

5. Click on Apply to Save the Parameter Context:

This ensures that any modifications made to parameters within this flow will be isolated to its specific context, preventing unintended effects on other parts of the system.

Inherit Parameter Context

Parameter contexts manage dynamic values shared across processors or components within a data flow, containing details from the original flow definition. When transferring the flow definition between instances, replace the parent parameter context with the correct parent processor's parameter context for inheritance. Follow these steps:

1. Right-click on the processor's canvas.

2. Select parameter from the options.

3. Navigate to the Inheritance tab and remove the parameter contexts of the source processor.

4. Select the desired parameter context from the left.

5. Click Apply to save the inheritance of the parameter context.

Verify Parameter Context

Once the parameter context is inherited, you can verify through the following steps:

1. Right-click on the canvas and select Parameter from the options.

2. Navigate to the Parameters tab, where all the parameters of that processor are listed. Parameters with the edit icon belong to that processor, while parameters with an arrow icon belong to the parent processor.

3. Click on the arrow icon for any parameter. This action will lead you to the parameter context of the parent parameter.

4. Navigate to the settings page to verify that the correct parameter context is inherited.

Add Process Group Parameters

While most parameters are inherited from the parent processor groups, some parameters are specific to process groups. The following parameters need to be added to the processors:

• Destination Path: This specifies the path for the flowfile where SFTP files will be placed. The destination path property needs to be further added in the remote path of the flow that puts the file in SFTP. Click on configure and add the remote path name.

• Feed File Name with Prefix: Here, a meaningful file name with a prefix such as time needs to be added for easy identification.

• Source SQL Query: This parameter contains the SQL query required for the processor to perform its action.

• Date Time Format: Specifies the date time format for the files. It's crucial for accurate representation.

• File Name Extension: Select whether the file is .csv or .json to ensure compatibility with other systems and accurate file reading.

To configure the file name, locate the processor named Update file name. Right-click and select the configure option. Go to properties and enter the query in the filename field.

Select Database Connection Pooling Service (DBCP service)

The Database Connection Pooling (DBCP) service enables efficient and reliable connections to relational databases. It essentially acts as a pool manager for database connections, allowing processors to reuse existing connections instead of creating new ones for each operation. DBCP services are not part of the parameters; therefore, Configure properties and select the DBCP service from the dropdown menu.

Set Record Writer

The Record Writers service facilitates writing data records to various data storage systems or destinations in a structured format. Since default controller services are removed when downloading flow definitions, configure the record writer property through the following steps:

1. Right-click on the processor and select Configure.

2. Navigate to the property Record writer.

3. Select the appropriate record writer from the dropdown menu.

4. Configure the record writer service by clicking the arrow against the service. Click on the settings icon to configure the service.

5. Navigate to the properties tab and update the service as per your requirements.

Services can only be updated once disabled. Be cautious as disabling the service affects all associated processors. Once the services are updated, right-click on the canvas and select enable all controller services to enable the services.

Verify DBCP and SFTP

Execute the Flow

Once all settings are set up and verified, run the processor to verify:

1. Right-click on the canvas of the processor group, then click on Start. All flows will start processing.

2. If you want to run each flow manually, right-click on the flow file.

3. Click on Run Once, and repeat the same for each flow file.

Proper documentation is essential for any GitHub repository as it provides clear instructions, context, and information about the project.

Overview

This guide outlines three methods for adding documentation to a GitHub repository: using the GitHub UI, GitHub Desktop, and Git Bash/Terminal. Each method caters to different levels of familiarity with Git and GitHub, ensuring that users can choose the approach that best suits their needs.

Using GitHub UI

The GitHub UI is a highly accessible and straightforward method for adding documentation. It requires no additional software and allows users to perform tasks from any web browser. This method is ideal for users unfamiliar with Git commands, offering a simple, streamlined process for managing repositories.

Steps:

1. Fork the Repository (if needed):

   • Go to the repository page on GitHub.

   • Click Fork at the top right to create a copy in your account.

2. Create a Branch:

   • Go to your repository.

   • Click on the Branch: main dropdown.

   • Type a new branch name and click Create branch.
3. Add Your Documentation:

   • Navigate to the directory where you want to add the file.

   • Click Add file > Create a new file.

   • Name your file with the .md extension and add your content in markdown format.

4. Commit Changes:

   • On the main page of the repository, above the file list, click Commits.

   • Choose the option to commit directly to the new branch.

   • Click Commit new file.
5. Open a Pull Request:

• Go to the Pull Requests tab.

• Click New pull request.

• Select your new branch as the source branch and your main branch as the destination branch.

• Click Create pull request, enter a title and description, and submit the pull request.

Using GitHub Desktop

GitHub Desktop offers a user-friendly graphical interface that simplifies Git operations, making it particularly accessible for beginners. Its visual representation of changes (diffs) and built-in tools for merging conflicts provide a clear and intuitive workflow, reducing the learning curve associated with Git commands.

Steps:

1. Install GitHub Desktop:

   • Download and install GitHub Desktop from the GitHub Desktop website.

   • Follow the installation instructions and sign in with your GitHub credentials.

2. Clone the Repository:

   • Open GitHub Desktop.

   • Go to File > Clone Repository.

   • Select the repository you want to clone and click Clone. Also You can directly open GitHub Desktop from Github.
3. Create a Branch:

   • Go to the Current Branch dropdown at the top.

   • Click on New Branch.

   • Enter a name for your new branch and click Create Branch.
4. Add Your Documentation:

   • Navigate to the repository directory on your local machine.

   • Create a new Markdown file (.md) and add your content.
5. Stage and Commit Changes:

   • Go back to GitHub Desktop.

   • You should see your new file listed under Changes.

   • Write a commit message in the Summary field.

   • Click Commit to <branch_name>.
6. Push Changes:

   • Click Push Origin to push your committed changes to the remote repository.

   • Create a pull request through the GitHub web interface.

Using Git Bash/Terminal

Using Git Bash/Terminal provides precise control over all Git operations, making it ideal for advanced users who need flexibility and efficiency in their workflows. This method is also highly efficient, as it allows experienced users to perform actions quickly without the need to switch contexts or use additional tools.

Steps:

1. Clone the Repository:

   • You have two methods to get your repository on your local system:

   • Direct Cloning:

   • HTTPS: git clone https://github.com/username/repository.git

   • Replace username and repository with your GitHub username and the repository name you want to clone.

   • Forking the Repository:

   • Fork the repository to your personal GitHub account.

   • Clone your fork using the method above.

2. Create a Branch:

   • Open your Integrated Development Environment (IDE) or terminal.

   • Navigate to your project directory.

   • Create a new branch: git branch <branch_name>

   • Switch to the new branch: git checkout -b <branch_name>

3. Add Your Documentation:

   • Create a new file with a .md extension, for example, README.md or documentation.md.

   • Add your content to the file.

4. Stage and Commit Changes:

   • Add all changes to the staging area: git add .

   • Commit your changes with a message: git commit -m "Add documentation"

5. Push Changes:

   • Push your committed changes to the branch on the remote repository: git push origin <branch_name>

   • Create a pull request through the GitHub web interface.

For more detailed instructions on using Git Bash/Terminal, refer to GitHub's official guides.

1. Document Structure

1.1. Title and Headers

• All Titles and Headers should be written in “Title Case”

• Title: Use a clear, concise title that accurately reflects the content.

• Headers: Use hierarchical headers (H1, H2, H3) to organize content. Make headers descriptive so that they help readers navigate the document.

Learn more about Gitbook Headings

# for Heading 1 ## for Heading 2 ### for Heading 3

1.2. Table of Contents

• The TOC should list all major sections and subsections.

• Use headings to create a clear structure. This helps users with screen readers navigate the document.

• When documenting on GitBook, TOC is indexed on the right side. Make sure to use the correct heading levels. Use H1 for title, H2 for main sections, and H3 for subsections.

For example: GitBook Headings will appear on right side of documentation as TOC

1.3. Sections and Subsections

• Meta Description: Add meta description with the following format on the top of the page:

---

description:>- HotWax Commerce's BOPIS fulfillment app enables retailers to efficiently manage Buy Online Pick-Up In Store (BOPIS) functionality and handover store pick-up orders to customers.

---

• Introduction: Brief overview of the document's purpose.

• Main Content: Detailed information, instructions, and guidelines.

• Conclusion: Summary of key points and any additional resources.

2. Formatting

2.1. Text Formatting

• Bold: Use bold to highlight important terms or phrases.

• Code: Use monospace font for code snippets, commands, and file names.

2.2. Lists

1. Numbered Lists: Use for ordered lists or steps in a process.

• Bulleted Lists: Use for unordered lists.

2.3. Links

• Internal Links: Use relative URLs for links within the same documentation.

• External Links: Open external links in a new tab.

2.4. Tables

• Use tables to present data clearly.

2.5. Images and Media

• Images: Add images directly from the bottom of the GitHub markdown. Use high-quality images. Provide alternative text for accessibility.

• Images Names: All images should be named in a specific format which is lowercase and words should be separated by a hyphen ( - ), such as images-name

• Videos: Embed drive videos where necessary and properly caption them. Copy the public-view Google Drive video link and use the following format to embed drive videos:

{% embed url ="(Google Drive URL)" %} caption {%endembed%}

2.6. Quotation

• Double Quotes: Use “double quotations” when using any title, such as when documenting order status: “Created”, or “Approved”.

• Backticks: Use backticks ( ` ) for highlighting actions. Such as when documenting a `job name`, `application`, or `button` which will be shown as job name, application, button.

3. Writing Style

3.1. Clarity and Conciseness

• Use clear and concise language. Avoid jargon and technical terms where possible. Provide definitions and examples where necessary.

• Content should flow naturally, shouldn’t feel heavy, or fluffy.

• Abbreviations

  • Write abbreviations in full the first time they appear, followed by the abbreviation in parentheses. Use only the abbreviation thereafter.

  • Example: Buy Online Return In Store (BORIS).

3.2. Words Not To Use Repeatedly

• Words that look like they were AI-generated should not be used repeatedly. Minimize the use of overly dramatic adjectives such as seamless, ensure, ensuring, crucial, essential, critical, game-changer, streamlined, comprehensive.

3.3. Active Voice

• Use active voice instead of passive voice.

• Example: “Install the app” instead of “The app should be installed.”

3.4. Consistency

• Use Markdown formatting. Learn more about Markdown here.

• Maintain consistency in terminology, tone, and style throughout the document. You can refer to ChatGPT Prompts for consistency in the documents when using ChatGPT.

• Use different types of hints to draw your reader’s attention to specific pieces of important information. Here’s markdown for different types of hints:

{% hint style="info" %} Add your content here { % endhint %}

{% hint style="success" %} Add your content here { % endhint %}

{% hint style="warning" %} Add your content here { % endhint %}

{%hint style="danger" %} Add your content here { % endhint %}

This markdown will look like this for hints:

3.5. Technical Content

• Use Annotations: With annotations, you can add extra context to your words without breaking the reader’s train of thought. You can use them to explain the meaning of a word, insert extra information, and more. Readers can hover over the annotated text to show the annotation above the text.

• Create an Annotation: To create an annotation, select the text you would like to annotate and click the Annotate option in the context menu. Once you’ve written your annotation, click outside of it to continue writing in the text block.

4. Accessibility

4.1. Alt Text

• Provide descriptive alt text for images.

• All media should be accessible to readers.

5. Review and Maintenance

5.1. Regular Updates

• Review and update documentation regularly to maintain accuracy.

5.2. Feedback

• Encourage feedback from users to improve the documentation.

6. Common Nomenclature for Consistency

6.1. HotWax Apps

• BOPIS App

• Fulfillment App

• Pre-Orders App

• Available to Promise App

• Job Manager App

• Order Routing App

• Receiving App

• Cycle Count App

• Picking App

• Import App

• Users App

• Facilities App

• Company App

When writing the full name of an app, such as the Fulfillment App, "A" in "App" should be capitalized.

6.2. Systems

• HotWax Commerce

• Shopify (We write e-commerce as “eCommerce”)

• Shopify POS

• NetSuite

• RetailPro

• EasyPost

If the time zone settings for the instance’s server and scheduled jobs do not match, it can lead to data time discrepancies between Hotwax Commerce and Shopify. For example, let’s say a customer placed an order on Shopify today, but after importing, when you look at the Hotwax Commerce Sales Orders page, the order date appears as yesterday. The reason behind this discrepancy is the mismatched time zone between the Hotwax Commerce instance and the scheduling time zone of the Import Orders job.

Steps to Diagnose and Resolve the Issue

Verify the Discrepancies

1. Check the Time Zones in the Job Sandbox Entity:

   • Visit: https://{instance}.hotwax.io/webtools/control/FindGeneric?entityName=JobSandbox

   • Ensure the Recurrence time zone in the Job Sandbox entity matches the instance’s Server time zone.

2. Check the Instance’s Server Time Zone:

   • Navigate to: Hotwax Commerce OMS > Dashboard > About
   • Verify the instance’s Server time zone.

Adjust the Time Zone for the Job

1. Open the Job Manager Application:

   • From the launchpad, open the Job Manager application in Hotwax Commerce.

2. Navigate to Settings:

   • Click on Settings within the Job Manager.
3. Change the Selected Time Zone(If required):

   • Navigate the App section within the settings.
   • Identify the two time zones:

     • Browser Time Zone

     • Selected Time Zone

   • Adjust the Selected Time Zone to match the instance's Server time zone (if necessary).
4. Save Changes to the Job (Using JOB_IMP_ORD as an Example):

   • Navigate to Orders in the left menu.
   • Go to New Order under the import section inside Orders.
   • Inside the Import Order box, find and click on SAVE CHANGES at the bottom right of the same job.

By following these steps, you can correct the time zone settings and resolve the time mismatch issue between Shopify and Hotwax Commerce. This will ensure that data is consistent and accurate across both platforms, enhancing the reliability of order management system.

In Hotwax Commerce, client feature requests are logged and tracked in Jira within the HotWax OMS/Shopify POS Migration project, ensuring a structured workflow from request to development for continuous platform improvement and client satisfaction.

Approach:

Requesting Feature through Jira:

1. Login to Jira using your credentials.

2. Navigate to Projects on the navbar.
3. Select the project where clients demand features or enhancements (e.g., HotWax OMS/Shopify POS Migration project).

4. Use the Kanban board such as the POSSOMS Board.

5. Utilize options like search, users, and filters (e.g., epic, type).

6. Click on the epic filter and select the HotWax Enhancements/Feature Requests epic.

Processing the Request:

1. Pick up the issue from the Backlog and move it to Select for Development.

3. Add the link of the internally created ticket to the corresponding Jira issue.

4. Move the issue from Select for Development to In Progress.

This streamlined process ensures that feature requests are tracked, managed, and developed efficiently, integrating both Jira and internal tools like ClickUp and GitHub.

Problem:

Duplicate products may appear on the View Sales Order page due to the same variant product ID being associated with two different parent product IDs. This issue causes confusion in the sales order management process.

As it may result in an item being shipped twice because it appears multiple times on the View Sales Order page. Additionally, the support team encountered difficulties canceling the item, as it does not exist in the database.

Error Identification

The merchandising team and support team have identified the issue.

Cause Analysis

Product Identifier Change: Recently, the product identifier was transitioned from using the original Product ID to a Barcode-based identifier. This change caused issues when the parent product handles or URL endpoints were updated. Specifically, a new parent product was created, and the existing variants were incorrectly linked to both the old and new parent products.

Process Explanation:

• For barcode and SKU identifiers, the system prepends the handle name with a "V_" prefix and uses this value as the internal name for the parent product.

• When the parent product's URL endpoint is updated, it no longer matches the internal name stored in the system.

• Consequently, when the updated parent product JSON is processed, the system checks for an existing handle of the same name. If no match is found, a new parent product is created, leading to the duplication issue.

This mismatch between the updated handle and the stored internal name causes the system to treat the updated product as a new entity, resulting in multiple associations for the same variants. As a result, products appear multiple times on the View Sales Order page.

Solution:

1. Identify Duplicate Products:

• Navigate to the View Sales Order page and identify the duplicate products.

• Note down the hcProductId associated with the variant product showing duplicates.

2. Query Product Associations:

Run the following SQL query to return the multiple parent product associations linked to the same variant product ID:

SELECT * FROM PRODUCT_ASSOC 
WHERE PRODUCT_ID_TO = '${productId}';

From this query, identify the duplicate parent product associations for the same variant product ID.

3. Delete Old Parent Product Associations:

It is recommended to delete the association with the parent product that was created first, as the latest parent product will have the revised name and updated details. Run a MySQL delete query using the PRODUCT_ID and PRODUCT_ID_TO values retrieved from the previous step. This ensures that only one parent product association is removed.

DELETE FROM PRODUCT_ASSOC 
WHERE PRODUCT_ID = 'your_parent_product_id' 
AND PRODUCT_ID_TO = 'your_variant_product_id';

4. Verify Changes:

After performing the deletions, check the View Sales Order page to ensure that the duplicate products no longer appear.

The order status discrepancy between the find Order page and vieworder page is likely due to an issue with Solr indexing, which can occur if the Solr instance is down when the order status is updated.

Steps to Resolve

1. Access WebTools

1. Go to the WebTools for your OMS instance using the provided sample link: https://{instanceName}.hotwax.io/webtools/control/ServiceList

2. Run Service to update order indexing on Find Order page.

To index the updated status of the order when the solr is down or by any reason the indexing is not done on the find order page we need to run createOrdersIndexFromStatus service.

1. Locate the service: createOrdersIndexFromStatus.

2. In the service input parameters, set the following:

   • statusFromDate: Specify the start date/time for the range.

   • statusToDate: Specify the end date/time for the range.

   • persist : false.

3. Execute the service.

3. Run the Service to create orderItemShipGroup reservation

If you want to create a reservation in the order item ship group inventory reservation entity, you need to run the createOISGIRIndexes service

1. Locate the service: createOISGIRIndexes.

2. In the service input parameters, set the following:

   • reservedDateFrom: Specify the start date/time for the range.

   • reservedDateTo: Specify the end date/time for the range.

   • persist: false.

3. Execute the service.

4. Verify Indexing in OMS

1. In the OMS application, go to the Find Order section.

2. Use the previously noted order ID to search for the order.

3. Confirm the order appears with the updated status.

   • Check if the status changes are indexed correctly.

   • Verify that no errors occurred during the process.

Retailers operating globally often receive payments in the customer's local currency, which differs from the retailer's base currency (Shopify shop currency). The Multi-Currency Order and Return Management feature by HotWax Commerce significantly enhances operational efficiency and financial clarity for retailers dealing with international transactions. By automating currency conversion and reconciliation, retailers can manage global sales more effectively, ensuring accurate financial reporting and simplified accounting processes. This feature not only improves the day-to-day operations of retailers but also enhances the overall customer experience, making it a valuable addition to the HotWax Commerce platform.

Here’s how this feature works in HotWax Commerce:

1. Accurate Currency Representation:

In HotWax Commerce, the createUpdateOrder is used to import orders from Shopify. When an order is imported, the presentmentCurrencyUom field in the OrderHeader entity is populated with the currency in which the customer made the payment (e.g., MXN for Mexico). This ensures that all transaction details accurately reflect the customer's local currency, enhancing transparency.

1. Detailed Payment Preferences:

During the order creation process, OrderPaymentPreference saves the payment preference currency and conversion rate. For example, if the payment preference currency is USD, the converted amount is stored in the currentPaymentAmount field, while the original amount paid in the local currency (e.g., MXN) is saved in the presentmentAmount field. This detailed record helps in maintaining clear financial records and simplifies financial reconciliation.

1. Fallback Mechanism for Exchange Rates:

If the exchange rate is missing during order import, the system uses the UomConversion to check for conversion details in the Order Management System (OMS). This ensures that even in the absence of an immediate exchange rate, the order can still be processed correctly, minimizing disruptions in workflow.

1. ERP Sync:

During ERP synchronization, the system retrieves the converted order amount from the OrderPaymentPreference entity, where it was stored during the order creation process. This converted amount, already in the retailer’s base currency, is synchronized with the ERP system. Additionally, the exchange rate used for the conversion is stored in the OrderPaymentPreference entity, ensuring accurate financial records.

1. Order Header Currency Maintenance:

The order header is updated and uses the customer's currency (e.g., MXN) instead of the product store currency. This maintains the integrity of the original transaction details and provides accurate data for both the customer and the retailer.

1. Enhanced Financial Reporting: For financial reporting and accounting, the feature provides a dual view capability, showing both the original payment currency and the base currency equivalent. The order detail page in HotWax Commerce displays the converted amount, local amount, and conversion rate in the order payment preference section. This dual reporting capability aids in better financial analysis and reporting, crucial for businesses with international transactions.

The automation of currency conversion and detailed recording of payment preferences simplify accounting processes. Retailers can easily reconcile their accounts and generate accurate financial reports.

This Standard Operating Procedure (SOP) outlines the steps required to create a new variance reason in HotWax Commerce, for retailers to record variances in the cycle count app.

Steps to Create a New Variance Reason

Login to the Webtools

1. Open your web browser.

2. Navigate to the HotWax Commerce Webtools login page.

3. Enter your credentials (username and password).

4. Click the Login button to access the Webtools dashboard.

Navigate to the Import/Export Section

1. Once logged in, locate the Webtools section on the dashboard.

2. Click on the Import/Export button.

Access XML Data Import

1. In the Import/Export section, find and click on the XML Data Import button.

Prepare Data for Import

1. Scroll down to the bottom of the page to locate the input box under the Import File button.

2. Enter the XML data in the input box. Use the sample data provided as a template

   Copy

   <Enumeration description="New Variance Reason Description" enumId="NEW_VARIANCE_REASON_ID" enumName="New Variance Reason Name" enumTypeId="IID_REASON"/>

3. Make sure to enter the data between the <entity-engine-xml> tags. The complete structure should look like this:

   Copy

   <entity-engine-xml>
       <Enumeration description="New Variance Reason Description" enumId="NEW_VARIANCE_REASON_ID" enumName="New Variance Reason Name" enumTypeId="IID_REASON"/>
   </entity-engine-xml>

Modify the XML Data

1. Replace the enumId, enumName, and description values with the new variance reason details. For example

   Copy

   <Enumeration description="CS refund" enumId="CS_REFUND" enumName="CS refund" enumTypeId="IID_REASON"/>

2. Ensure the new details accurately reflect the specific variance reason you intend to create.

Import the XML Data

1. After entering the modified data in the input box, double-check for accuracy.

2. Click the Import Text button to import the data into the system.

Verify the New Variance Reason

1. After importing the data, verify that the new variance reason has been successfully created.

2. Go to the Enumeration entity in Webtools to ensure the new variance reason appears as expected.

Conclusion

Following these steps, you can create a new variance reason in HotWax Commerce for recording variances through the cycle count app. Ensure all data entered is accurate and double-check each step to prevent errors during the import process. For any issues or further assistance, please contact the support team.

Purpose

This SOP outlines the steps required to configure and manage SFTP Retry for Fetch SFTP and Put SFTP processors in Apache NiFi, ensuring adherence to best practices. URL: https://napita.hotwax.io/nifi/

Configuration for the SFTP Processor

1. Access the SFTP Processor

• Navigate to Apache NiFi > Processor Group > Fetch/Put SFTP Processor.

2. Configuration for Fetch SFTP Processor

• Set the comms.failure relationship to Retry. Configure the following values:

  • Number of Retry Attempts: 2

  • Retry Back Off Policy: Penalize

  • Retry Back Off Duration: 10 min (default)

  • Penalty Duration: 30 sec (default)

Add a Funnel:

• Add a funnel to the Fetch SFTP Processor.

• Redirect the following relationships to the funnel:

  • comms.failure

  • permission.denied

  • not.found

• Name the connected relationship: SFTP Fetch Fail.

3. Configuration for Put SFTP Processor

• Set the [failure, reject] relationship to Retry. Configure the following values:

  • Number of Retry Attempts: 2

  • Retry Back Off Policy: Penalize

  • Retry Back Off Duration: 10 min (default)

  • Penalty Duration: 30 sec (default)

Add a Funnel:

• Add a funnel to the Put SFTP Processor.

• Redirect the following relationships to the funnel:

  • failure

  • reject

• Name the connected relationship: SFTP Put Fail.

---

Resolution Steps

When the SFTP Processor Starts Working:

Redirect Funnel Relationships:

1. Access the SFTP processor where the files are queued.

2. Redirect the funnel relationships (SFTP Fetch Fail or SFTP Put Fail) back to the original processor by connecting the funnel to the respective processor.

   • This will create a loop to re-run the failures.

3. Process all the queued files.

4. Perform this action for both the Fetch and Put SFTP processors as applicable

Validate:

• Ensure the queued files are correctly processed after redirection.

Monitoring and Verification

1. Check Queued Files for Clients

Navigate to Summary:

• Click on the hamburger icon in NiFi's main navigation bar.

• Select Summary.

Open the Summary Window:

• A new pop-up window titled "NiFi Summary" will appear.

• Go to the Connections tab.

Locate Relationships:

• Search for the relationships "SFTP Fetch Fail" or "SFTP Put Fail" in the list.

• Select By Name.

• Sort the Queue (Size) column in descending order by clicking the column header.

Redirect to Processor:

• Click on the Arrow Icon corresponding to the desired relationship to directly navigate to the associated processor.

• Review the queued files for the processor and follow the resolution steps mentioned above to ensure proper processing.

Key Notes

Consistency:

• Ensure all relationship names and funnel configurations strictly adhere to the specified formats:

  • SFTP Fetch Fail

  • SFTP Put Fail

Regular Monitoring:

• Check for queued files periodically to prevent bottlenecks in data flow.

HotWax Commerce automates pre-order and back-order management by leveraging purchase orders (POs), aiding in the automatic listing and de-listing of products, which is beneficial for retailers with extensive catalogs. POs provide crucial details about item specifics and upcoming inventory arrivals. Retailers can integrate their ERP systems with HotWax Commerce for automatic PO synchronization or use the Import App to manually import PO CSV files.

To know more about how the pre-order process is automated in HotWax refer to this .

In HotWax, we have two relevant entities:

Product Category: Defines different types of product categories (e.g., shop-tops, shop-outerwear, shop-bottoms). The PREORDER_CAT category is used to manage pre-order products.

Product Category Member: Tracks the members or products in a category. When a new product is added to the PREORDER_CAT category, a record is created in this entity. The presell catalog synchronization job synchronizes pre-order products to Shopify whenever a product is added to the PREORDER_CAT category. Here's an overview of the process and some key points to understand:

Downloading Products from Shopify to Hotwax Commerce

• Hotwax Commerce downloads products from the parent Shopify store.

• These downloaded products are initially not associated with any child shops within Hotwax Commerce.

Associating Products with Child Shops

• A separate job, known as the Associate products with sub-catalog job, is responsible for associating these downloaded products with various child shops. This step is crucial for ensuring that the products are associated with the child shops.

Importing Purchase Orders

• There are instances where purchase orders for these downloaded products are imported into Hotwax Commerce before the products get associated with the child shops.

• This means that the products exist in Hotwax Commerce, but their association with the child shops is pending.

Adding Products to PREORDER_CAT Category

• Auto Refresh Pre-sell Catalog job automatically manages adding or removing pre-sell products from the HotWax Pre-order/Backorder category.

Presell Synchronization Job Execution

• The presell synchronization job is triggered to sync these pre-order products back to Shopify. When there is a new product added in the pre-order category then a record will be created in the product category member entity.

• This job successfully synchronizes the products to the parent Shopify store. However, it fails to synchronize these products to the child shops because they have not yet been associated with the child shops in Hotwax Commerce.

Product Category Member Entity

• If a product record is created in the Product Category Member entity, the presell synchronization job will not reconsider the product unless there is an update to the record.

• This means that even if the product is later associated with the child shops, the synchronization job won't attempt to sync it again unless a change is made to the Product Category Member record.

Troubleshooting Steps

1. Login to Webtools - Access the HotWax Commerce webtools.

2. Search for the Product Category Member Entity - Go to the Entity Engine and search for the Product Category Member entity.

3. Enter the Product ID - Input the product ID of the pre-order product that failed to sync to the Shopify child shop.

4. Update the Record - Click on the view icon next to the record and edit the entry by updating any small detail in the comments field (e.g., adding a full stop).

Updating the record will make the product eligible for the sync job again, ensuring it gets picked up and synchronized with Shopify. By following these steps, we can troubleshoot and resolve issues where pre-order products fail to sync to Shopify due to missing child shop associations.

In HotWax Commerce, "POS orders" are downloaded as fulfilled from Shopify. Occasionally, an order is downloaded into the OMS before it is marked fulfilled in Shopify. Retailers must refresh these orders to update their status, ensuring the fulfilled version of the order is downloaded while cancelling the older version.

Orders may fail to refresh due to missing shipping addresses, triggering this error: Could not complete the createOrderContactMech process: The following required parameter is missing: [createOrderContactMech.contactMechId].

Follow these steps to resolve these errors:

Troubleshooting Steps

Step 1: Cancel the Order

1. Log in to OMS: Use your username and password to log in to Hotwax Commerce OMS.

2. Navigate to Sales Orders: Click the hamburger navbar icon if the left slider is not visible. Go to Sales Orders under Order Management in the left slider.

3. Identify the Order: Find the order exhibiting the error. Open the order by clicking on its ID.

4. Cancel the Order: On the order page, click the Cancel button at the top.

Step 2: Remove the Order ID from Entities

1. Access Webtools’ Entity Engine: Use the link: https://{instance}.hotwax.io/webtools/control/entitymaint.

2. Remove the Order from Entities:

   • Open the OrderItem entity and remove the order.

     • Open the OrderItem entity; a form will open.
     • Search for the order using the orderID (enter the orderID in the orderID field of the form).
     • Hit Enter or click on the search button below the form.

     • Click on the view option at the start of the orderID under the Search result.
     • Click on the Delete this value button at the top of the view under the view value.
     • Repeat the above steps for each order item.

3. Remove from OrderHeader and OrderIdentification:

   • Open the OrderHeader entity and remove the same order.

   • Open OrderIdentification and remove the externalId value.

Step 3: Re-import the Order by ID in OMS

1. Log in to OMS: Use your username and password to log in to Hotwax Commerce OMS.

2. Navigate to Import Section:

   • Go to MDM > EXIM in the left slider.

   • Navigate to Shopify Jobs and select Import Shopify Order under the Order Management tab.

3. Re-import the Order:

   • Enter the details of the order, including the Shopify Order ID.

   • Run the job by clicking the Run button.

4. Verify Successful Import:

   • To verify the order's successful import, go to MDM > EXIM.

   • Navigate to Shopify Jobs and click on Shopify Order MDM under the MDM tab.

Following these steps will resolve the "POS Order Refresh Failure" issue by addressing the root cause—missing shipping details from unfulfilled Shopify orders. This guide provides a structured approach to diagnosing and rectifying the issue, ensuring minimal disruption to your order management process.

Web Tools are a resource for backend and development teams, providing functionalities for data management, log viewing, data import/export, job execution, and more within an Order Management System (OMS) instance.

Accessing Web Tools is straightforward. Users can conveniently navigate to the following URL in their web browsers: https://user-instance.hotwax.io/webtools. For example, for demo-oms, the corresponding URL would be https://demo-oms.hotwax.io/webtools.

Upon reaching the Web Tools portal, users are prompted to log in using their credentials.

Entity Engine

The Entity Engine in HotWax Commerce Web Tools is essential for viewing and managing data. It offers a platform for handling entities within the system, particularly benefiting backend and development teams by enabling efficient data management.

Entity Engine is accessible through the Entity Engine button on the second row of tabs on the main web tools page. Alternatively, users can also find a list of Entity Engine Tools directly on the web tools main page.

• Click on the Entity Engine button to be redirected to the Entity Data Maintenance page.

• Use filters such as Group Name and Entity Name to find specific records.

• An alphabetical list of all entities is also displayed on this page.

• Click on the name of a specific entity to view its dataset.

• Explore functions and filters to search data within the entity.

• For a comprehensive view of all records of an entity, click the Search button.

• Utilize the View Relations option to explore relationships with other entities. For example, if we consider the entity ‘Facility’, we can see that it is related to entities ‘FacilityGroup’, ‘ProductStore’, ‘Party’ and so on.

Entity SQL Processor

The Entity SQL Processor in Web Tools interprets and executes SQL commands, improving data viewing and management efficiency by providing users with the capability to execute SQL queries in the system.

• Navigate to the Entity Engine page within Web Tools. Click on Entity SQL Processor within the Entity Engine page. Alternatively, users can find the Entity SQL Processor option under Entity Engine Tools on the main Web Tools page and click on it.

• This opens the Entity SQL Processor page.

• Change the group to 'org.apache.ofbiz’.

• Input the required SQL query in the SQL command field.

• If required, use the Limit Rows function to limit the number of results displayed.

• Click on Send to initiate the execution of the SQL query.

The search results are presented in chronologically descending order, providing users with the output of the executed SQL command.

Service Engine

The Service Engine is a useful component for running and managing services within the OMS. This functionality provides users with a platform for searching, running, and scheduling various jobs and services.

Service Engine is accessible through the Service Engine button on the second row of tabs on the main web tools page. Alternatively, users can also find a list of Service Engine Tools on the web tools main page.

• Clicking the Service Engine button directs users to the Service Reference page.

• An alphabetical list of all the services is available on this page. Use the alphabets displayed at the top of the page to quickly locate a service by its name.

• Click on a specific service to open a dedicated page containing details, in parameters, and out parameters of the selected service.

• Depending on the requirements, users can run or schedule a service or job.

Job List

The Job List tab assists users to view and manage jobs associated with the OMS instance. This functionality provides users with a comprehensive view of the job details and their current status, allowing for efficient tracking and management of various tasks within the OMS environment.

The search functionality allows users to find specific jobs by selecting a function from the drop-down menu and entering relevant data. This feature streamlines the process of locating specific jobs within the OMS instance. The search results obtained with this action are displayed below, and the users can click on any particular job to view its details.

Users can also click on the Find button to view a complete list of all jobs within the OMS instance.

Schedule a Job

The Schedule Job tab is a feature that enables users to manage and automate the execution of specific jobs or services within the system.

• Clicking on the Schedule Job tab, directs the users to a page where they can schedule a specific job or service.

• Here, users can input details such as date, time, frequency, and more to schedule a job at a specific time and set intervals for repetition.

• Additionally, users have the option to check the Run As System checkbox to execute the job as a system.

Reader

A Reader is a type of plugin that allows users to import data from various integrations that clients use for automation, and more.

• Clicking on the XML Data Import Readers button within the Import/Export tab redirects the users to the XML Import to DataSource(s) page.

• Users should input 'ext-name', where 'name' represents the name of the integration from which data needs to be imported in the Enter Readers field.

• Clicking on the Import button initiates the data import process into the designated data sources. The Results section displays file names and a summary of the import process, allowing users to quickly verify the success of the operation.

Logs

Logs, accessible through the Logging button on the second row of tabs in Web Tools, provides users with a location for viewing logs of various actions being performed within the OMS instance.

Users can use 'Command+F' or 'Ctrl+F' within the logs to locate specific logs.

Error logs are highlighted in red and enclosed within a red box, making them easily identifiable.

Facility

The Facilities page enables users to view, search, and manage both physical and virtual facilities associated with the OMS instance.

• Click on the Facility button located on the first row of tabs. This action opens the Facilities page. Once on the Facilities page, options are available for searching specific facilities.

• In the search section, use the drop-down menu to select a specific function and enter relevant data to filter the facilities.

• Click the Find button to initiate the search based on the selected function and entered data. The search results will be displayed below.

• If you click the Find button without selecting any function or entering data, an alphabetical list of all facilities is displayed as a result.

• Click on any facility to view the Edit Facility page.

• On the Edit Facility page, users can update the details about the selected facility as needed.

Import Data

There are two methods for adding data into an entity. One approach involves navigating to the entity using the Entity Engine and utilizing the Create New button to input data directly into the entity. Alternatively, data can be imported using XML.

Using the Create New button in Entity Engine

• Go to the Entity Engine and select the specific entity where you want to enter data.

• Click on the Create New button.

• Fill in the relevant fields with the data you want to input.

• After entering the data, click on the Create button to create the dataset for the selected entity.

• The system will create the relevant dataset and redirect you to the View Value page for the newly created data.

• At the bottom of the View Value page, find the Entity XML Representation section. Here, you can view the XML format for the dataset.

Importing XML Data

After obtaining the XML data format, users can import the data directly from the XML Import to DataSource(s) page using these steps:

• Click on Import/Export and select the XML Data Import button to access the XML Import to DataSource(s) page.

• In the Complete XML document field on the page, insert the data in the correct XML format. The data has to be placed between the <entity-engine-xml> and </entity-engine-xml> tags.

• Once the XML data is inserted, click on the Import Text button to initiate the data import process.

Tathya is a data exploration and visualization platform that lets users connect to various data sources, explore data, and create interactive dashboards.

Tathya itself doesn't have a storage layer to store your data but instead pairs with your existing SQL-speaking database or data store. So, to be able to query and visualize data from Tathya, you first need to add the connection credentials of your database.

Setup your database

Login into Tathya with your credentials, now on the homepage go to the top right corner, go to settings and click on the "Data" menu to access the data source configuration.

In the "Data" menu, select "Databases" to manage your database connections. Click on the "+" button to initiate the setup process.

From the resulting modal “connect a database”, select the type of database you are connecting to (e.g., MySQL, PostgreSQL, SQLite).

We usually use the MySQL database type, once selected in the next step you have to enter the essential connection details and credentials to establish a connection with the MySQL server.

The required MySQL credentials includes the following fields:

Host

The "host" refers to the network address or hostname of the MySQL server where your database or data source is located. It is the address that Tathya will use to reach the database.

Port

The "port" is a specific endpoint on the host machine. The port number is essential for Tathya to know where to communicate with the database service.

Database Name

The “database name” is the name of the specific MySQL database you want to connect to.

Username and Password

The “username and password” are associated with the account you want to use for the connection.

Display Name

The “display name” is how the database will display in Tathya.

Choose a descriptive name for the connection. For example, if a project were named Wasatch Ski, the display name should be “Wasatch Ski OMS”

Now that you’ve configured a data source, you can create specific charts or slices that you want exposed in Tathya for querying.

Prerequisites:

Ensure you have access to Tathya and the necessary permissions to use SQL Lab.

Import Jobs

Discover how to create import jobs and manage data flow with HotWax Commerce's Data Manager Configurations.

This guide provides step-by-step instructions for creating a job through HotWax Commerce's Data Manager Configurations. It includes a guide on accessing and adding configurations, connecting with the SFTP server, and creating jobs using the webtools.

Access SFTP

Finding the SFTP credentials in OMS

• Log in to your HotWax commerce instance with your user credentials

• Navigate to the hamburger menu

• Select Settings

• Click on the General page and navigate to the FTP Connection Settings section

• Copy the SFTP credentials from there i.e, host, username, port, and password

Connecting the SFTP server

To connect to the SFTP server and manage data transfer, you can utilize FTP software such as FileZilla. Here's how to proceed:

Download and Install FileZilla: If you haven't already, download and install FileZilla from the official website.

Accessing SFTP with FileZilla:

• Open FileZilla.

• Click on "File" in the top menu, then select "Site Manager."

• Click on "New Site" and enter a name for the connection.

• Input the Host, Username, Port, and Password obtained from the HotWax Commerce settings into the corresponding fields in FileZilla.

• Click "Connect" to establish the connection.

• Navigating Remote Site:

  • After connecting, you'll see the Remote Site section in FileZilla.

  • Navigate through the directory to locate or create the path where your data will be transferred.

• Copying the Path:

  • Once you've found or created the desired path, right-click on it and select "Copy."

  • This copied path will be needed for configuring data transfers in subsequent steps.

Finding the Service via web tools

This step is only essential if you are unsure about the service that will be used to import data

• Navigate to the webtools of the HotWax Commerce instance (https://<instance-name>.hotwax.io/webtools) in your browser (Replace the <instance-name> with the required instance name)

• Login to Webtools via your credentials for that instance.

• Click on Service Engine and search to find the relevant service. For Example:

  • Let's say we want to use a service involved in importing the features of the product

  • Then you can search for the relevant keywords like import or product to find the relevant service

  • Copy the relevant service name

Add Data Configurations

The OMS Data Manager Configurations page provides a way to effectively manage the flow of data in and out of OMS. In this guide, you'll find step-by-step instructions for adding and editing configurations, as well as integrating SFTP details into the configurations.

Add a New Configuration for Importing Data

Adding a new data configuration in OMS enables users to specify how data is imported and exported.

Steps:

• Navigate to the settings section in the hamburger menu of HotWax Commerce

• Click on Data Manager Configurations to open the configurations page

• Click the Add button on the Configurations page.

• In the modal that appears, provide information for fields such as Config ID*, Description*, Import Service* (enter the service here that was copied above), Import Path* (enter the SFTP path that was created above), Export Content ID, Export Service, Export Path, File Name Pattern, and Multi-threading. (To learn more about these fields click here)

Required fields marked with (*) : Config ID* (enter the name according to requirement), Description* (enter a small description about this), Import Service* (enter the service here that was copied above), Import Path* (enter the SFTP path that was created above)

Example:

• Click Add again to save the new configuration.

Creating a Job

HotWax Commerce’s Job Manager App lets you view, schedule, and update job workflows running in HotWax Commerce's Order Management System for orders, products, inventory, and more operations.

To create and view a new job within HotWax Commerce's Job Manager Application, you'll need to access the webtools of your instance and set up the job details as follows:

Steps:

• Log in to the webtools of your HotWax Commerce instance using your credentials.

• Click on Entity Engine and search to find the EnumType entity. Filter the result for the Parent Type Id field as ‘SYSTEM_JOB’.

• Look for the corresponding Enum Type ID field that resembles your service. From the example above we will take the Enum Type Id as ‘PRODUCT_SYS_JOB’. Since we are using the service for importing product features.

• Search for the Enumeration entity in the entity engine and click on the Create New button to create a new record with the required fields Enum Id, Enum Type Id, Description, and Enum Name. Enum Id (enter the enumeration id), Enum Type Id (enter the id that we searched in the above point), Description (enter relevant description), and Enum Name (enter relevant enum name).

  • For example:

• Search for the Runtime Data entity in the entity engine and click on the Create New button to create a new record with the fields Runtime Data Id, and Runtime Info. The Runtime Data ID (create a new ID here), and Runtime Info

  • The XML Structure for Runtime Info field (Replace the ENTER_HERE with the configId that was created in the data manager config)

<?xml version="1.0" encoding="UTF-8"?> <ofbiz-ser> <map-HashMap> <map-Entry> <map-Key> <std-String value="configId"/> </map-Key> <map-Value> <std-String value="ENTER_HERE"/> </map-Value> </map-Entry> <map-Entry> <map-Key> <std-String value="propertyResource"/> </map-Key> <map-Value> <std-String value="FTP_CONFIG"/> </map-Value> </map-Entry> </map-HashMap> </ofbiz-ser>

• Search for the Job Sandbox entity in the entity engine and click on the Create New button to create a new record with the fields

  • Job ID (create a relevant ID)

  • Job Name (create a relevant job name for the above id)

  • Pool Id (enter “pool”)

  • Status Id (enter “SERVICE_DRAFT”)

  • Parent Job ID (optional)

  • Service Name (enter “ftpImportFile”)

  • Run As User (enter “system”)

  • Runtime Data ID (enter the ID from the runtime entity that was created above)

  • Max Recurrence Count (enter “-1”)

  • System Job Enum Id (enter the Enum Id from the Enumeration entity that we created above)

• Go to the Job Manager application via Launchpad. Select the category of the job on the left side panel to find that particular job. The job will be visible in the ‘miscellaneous’ section of the job category.

This document contains a step by step guide that will walk you through the process of configuring a new database, creating charts, dashboards, configuring automated alerts & reports, listing users, and assigning them roles in Tathya.

• Database Configuration

• Charts Creation

• Understanding Dashboards

• Configuring Alerts & Reports

• Creating Roles

• Creating User

The Shopify POS (Point of Sale) app is a mobile application developed by Shopify that allows retailers to sell products in-store. It integrates seamlessly with the Shopify online store, providing a unified platform to manage both online and offline sales.

We do not have access to Shopify POS initially; we need to obtain this access from the client for testing purposes. When an order is placed in the Shopify POS app, there are multiple scenarios to consider and various ways this will reflect in the (OMS).

How to Access the Shopify POS App

For iOS (iPhone and iPad):

1. Open the App Store:

   • Find and open the App Store on your iPhone or iPad.

2. Search for Shopify POS:

   • Use the search bar to find the "Shopify POS" app.

3. Download and Install:

   • Tap the download icon or "Get" button to download and install the app on your device.

4. Open the App:

   • Once installed, open the Shopify POS app from your home screen.

For Android:

1. Open Google Play Store:

   • Find and open the Google Play Store on your Android device.

2. Search for Shopify POS:

   • Use the search bar to find the "Shopify POS" app.

3. Download and Install:

   • Tap "Install" to download and install the app on your device.

4. Open the App:

   • Once installed, open the Shopify POS app from your app drawer or home screen.

Setting Up the Shopify POS App

1. Enter Your Shopify Account Credentials to Log In:

   • Begin by entering your email address.

   • Then, enter your password.

2. Receive the Authorization Code:

   • After entering your email and password, you will receive an authorization code for verification.

3. Google Authentication App Required:

   • To receive the authorization code, you must have the Google Authentication app installed.

   • Ensure that the app is logged in with the same email address you entered in step 1.

4. Select Store:

   • After successfully entering the authorization code, you will be prompted to select a location.

   • Choose your Retail Store from the list.

5. Select a Location:

   • Choose a location from the available options.

6. Allow App Permissions:

   • Grant permissions for location services, cameras, notifications, and Bluetooth.

Hint:

• Stay Updated: Ensure your app is always updated to the latest version for the best performance and features.

By following these steps, you will successfully log in.

After the initial login, you must enter a PIN for subsequent logins. The client provides this PIN, and each time you want to log in, you need to enter it to access your Shopify POS.

Additionally, here is the link for how to place an order on Shopify POS: Shopify POS Help Center

For detailed guidance and troubleshooting, you can refer to the Shopify POS Help Center or contact Shopify support.

Introduction

A draft order in Shopify is an order created manually by CSRs or store admins. This is useful in various scenarios, such as when a customer wants to place an order over the phone or in person.

This usually occurs when customers directly contact a CSR to place a new eCommerce order on their behalf or request to cancel a previous order and get a new one placed as a replacement.

HotWax Internals

Draft orders are created to test order flow from Shopify to HotWax OMS.

Steps to Create Draft Orders

1. Login to Your Shopify Admin

• Open your web browser and navigate to Shopify Admin.

• Enter your credentials to log in to the Shopify admin interface.

2. Accessing the Orders Page

• Once logged in, you'll land on the homepage.

• Navigate to the Orders page to view the complete list of placed orders.

3. Start Creating a Draft Order

• Click on the Create Order button located at the top-right corner.

• This action will open a new window for order creation.

4. Product Selection

• Use the product search bar to find products quickly.

• Alternatively, browse products by clicking the Browse button and select based on:

  • Popular Products

  • Collections

  • Product Type

  • Tags

  • Vendors

5. Customer Information

• In the right section under the Customer bar, use the search bar to find an existing customer.

6. Additional Details

(This step is optional.)

• Include notes in the designated section at the top right.

• CSRs can use this section to provide insights into the reasons behind the draft order creation.

7. Payment Collection

Shopify offers multiple payment options:

Payment Options

Mark as Paid

• Click the Collect Payment dropdown button (bottom-right) to proceed.

• Click on Mark as paid

Cash on Delivery (COD)

• Click Payment due later to set payment terms, such as:

  • Due on receipt

  • Due on fulfillment

  • Within 7, 15, 30, 45, 60, or 90 days

  • On a fixed date

Credit Card Payments

• When entering credit card details, a pop-up will prompt you to enter the customer’s card information.

• Use the following test card details:

  Copy

  Card Number: 1  
  Expiry: 03/26  
  CVV: 123  

8. Creating the Order

• Click the Create Order button at the bottom right to confirm and place the order.

Dashboards in Tathya are practical spaces where you can organize and interpret your data. They have the unique capability to tell a story by combining different types of charts to form a narrative.

If you're starting from scratch, you can craft a new dashboard with a set of charts to visualize your information. Alternatively, if you already have charts that tell a story, you can assemble them into a dashboard for a consolidated view.

Prerequisites:

Ensure that you have access to the necessary data sources and have individual slices (charts or visualizations) already created in Tathya.

Configuration Options for Dashboards

• Save Chart to an Existing Dashboard Or Create a New Dashboard

• Add Charts to a New Dashboard

• Add Charts When Editing a Dashboard

• Creating a New Chart from an Empty Dashboard

In Tathya, it's essential to grant access to charts to other users to facilitate seamless collaboration and editing processes. Moreover, granting access allows users to add the chart to dashboards without encountering visibility issues. Here's how to grant access:

1. Navigate to the charts section within Tathya.

2. Find the specific chart you wish to grant access to.

3. Go to the chart and locate the "Actions" section, located on the right-hand side.

4. Click on the "Edit" option within the actions menu.

5. A popup window will appear, providing various options for chart management. Navigate to the "Access" tab within this popup.

6. In the "Access" tab, you'll find a section where you can add relevant users who are allowed to alter the chart.

7. Enter the names or usernames of the users you wish to grant access to. This list should include individuals who may need to edit the chart or add it to dashboards.

8. Once you've added the relevant users, save your changes. This ensures that the specified users have the necessary permissions to edit the chart and include it in dashboards.

Once you have established the connection, you can check the “Advance” tab to access additional settings. These allow you to fine-tune various aspects of the database connection.

The two important configurations here are SQL Lab and Performance:

SQL lab

Enable “Expose database in SQL Lab” to make the database available in SQL Lab and Enable “Allow this database to be explored” to allow database exploration and interaction.

Performance

Set the CHART CACHE TIMEOUT. This is a configuration parameter related to how Tathya caches (stores temporarily) the results of chart queries. Caching is a technique used to improve performance by storing and reusing previously fetched data.

Save the configured settings to establish the connection between Tathya and your MySQL database.

Now, proceed to click on the "Test Connection" button to ensure that Tathya can successfully connect to your MySQL database. Address any issues that arise.

Once the test is successful, click "Save" to confirm the configuration and finalize the setup.

Now, you can use the configured MySQL database for data exploration in Tathya.

To effectively navigate through the SQL Lab interface in Tathya and execute SQL queries, follow these steps for selecting the database and schema.

Navigation in SQL Lab

In the top navigation menu, locate and click on the SQL Lab option. This action will direct you to the SQL Lab interface designed for crafting and executing SQL queries.

In SQL Lab, Tathya provides dropdown menus where you can choose the desired database and schema before writing and executing your SQL queries. This step is crucial for accurately pinpointing the location of your data and ensuring that your queries fetch information from the correct database and schema.

Executing SQL Queries

Utilize various clauses such as SELECT, FROM, WHERE, GROUP BY, and others to shape the logic of your SQL query.

Based on the output you desire, insert the query here and click the Run Query button to execute the query.

How SQL Queries Create a Dataset

Upon executing the SQL query, Tathya sends the query to the connected database. The database parses the query, breaking it down into its structural components, checking for syntax errors, and understanding the logical flow.

Result Set Interpretation

Post successful parsing, the database retrieves a result set—a table of data that matches the specified criteria. Tathya then automatically interprets the structure of this result set, analyzing the columns and their data types.

Dynamic Dataset Creation

​​Leveraging the information obtained from the parsed result set, Tathya dynamically generates a dataset. This dataset mirrors the structure of the result set, capturing the columns and their data types.

Column Mapping

Each column in the result set is mapped to a corresponding field in the dataset. This mapping ensures that the dataset accurately represents the data retrieved by the SQL query.

Dataset Validation

Ensure the dataset returned aligns with your expectations. This is the dataset that will be used to create the chart.

Now, navigate to Save and then select “Save dataset” from the dropdown menu, so that you can use the same dataset to create multiple charts in future.

Creating a Chart

Once satisfied with the derived output, click on Create Chart.

Scenarios for Chart Creation

1. Creating Chart for Specific Queries

The ability to create charts based on specific queries within Tathya empowers users to derive actionable insights from their data. By allowing users to visualize specific subsets of data, this feature enhances decision-making processes and enables users to identify trends, patterns, and anomalies efficiently.

Step-by-Step Usage Instructions:

1. Access SQL Lab: Log in to Tathya and navigate to the SQL Lab feature.

2. Craft SQL Query: Select the database for which you want to create the Query. Write an SQL query with a WHERE clause specifying the desired criteria. For example, to create a chart showing orders created in the past hour:

   Copy

   SELECT *
   FROM order_header oh
   WHERE oh.ENTRY_DATE >= NOW() - INTERVAL 1 HOUR;

3. Execute Query: Click the Run Query button to execute the SQL query and generate the dataset.

4. Save Dataset: Once the dataset is generated, save it by following the prompted steps. This will open a new page with options to customize the dataset.

5. Add Chart Details: Enter a descriptive name for the chart, select the desired chart type, and configure additional settings as needed.

6. Create Chart: Click on the Create Chart button to generate the chart based on the dataset created from the specific query.

2. Creating Chart When Specific Subset is Not Available

Creating charts in Tathya without specific queries is essential for flexible data analysis. This feature allows users to prepare for future data scenarios by initially including all available data, even when subsets may not exist at the time of dataset creation.

Step-by-Step Usage Instructions:

1. Access SQL Lab: Navigate to the SQL Lab within Tathya.

2. Craft General SQL Query: Select the database and write a general SQL query to retrieve all available data without specific conditions. For example:

   Copy

   SELECT *
   FROM order_header oh;

3. Execute Query: Click the Run Query button to execute the SQL query and generate the dataset containing all available data.

4. Save Dataset: Once the dataset is generated, save it by clicking on the save button. This will open a new page with options to customize the dataset.

5. Create Chart: Proceed to create a chart from the dataset to visualize the overall data trends.

6. Unlock Dataset: Click on the options icon against the dataset's name to open a new form. Unlock the dataset by clicking on the lock icon to make changes.

7. Add WHERE Clause: If necessary, add a WHERE clause to the SQL query to filter the dataset based on specific criteria whenever there is data that follows the WHERE clause. For example:

   Copy

   WHERE oh.ENTRY_DATE >= NOW() - INTERVAL 1 HOUR;

8. Save Dataset: Save the dataset by clicking on the save button to retain the modifications made.

9. Update Chart: After saving the dataset, update the chart to reflect the changes made to the dataset and visualize the updated insights.

3. Creating Chart with Empty Dataset

Creating datasets with empty data is crucial in Tathya. It prepares charts for future data arrivals, enabling users to proactively set up their analytics. By allowing users to create charts with empty datasets, this feature fosters adaptability to changing data conditions.

Step-by-Step Usage Instructions:

1. Create Empty Dataset: Open SQL Lab and create an SQL query that returns no data.

2. Save Dataset: Once the query is selected or created, click on the Save Dataset button to save the empty dataset.

3. Redirect to Chart: After saving the dataset, you will be redirected to the chart creation page automatically.

4. Name the Chart: Provide a descriptive name for the chart to identify its purpose or intended data source.

5. Custom SQL: Under Custom SQL, paste the names of columns one by one to define the dataset structure accurately.

6. Save Chart: Click on the save chart button to save the chart configuration for future use.

View your Created Chart

You will now be redirected to the “Main Chart Panel” where your chart is ready to view.

Data Visualization

Navigate to the "data" tab. This is where you can transform the query results into a visual representation.

Here you will encounter two options under the "Data" tab, specifically under the "QUERY MODE" section: "Aggregate" and "Raw Records." These options determine how the data is processed and presented in the resulting chart. Let's delve into each option:

Aggregate Mode Aggregate mode is used when you want to perform aggregate functions (e.g., COUNT, SUM, AVG) on your dataset. It is suitable for summarizing and visualizing data at a higher level.

• Aggregation Functions Allows you to apply aggregation functions to your selected columns. For example, you can count the number of records, calculate the sum of a numeric column, or find the average.

Aggregate mode is commonly used when creating charts like bar charts, pie charts, or line charts where you want to visualize summarized information.

Raw Records Mode Raw Records mode is used when you want to retrieve individual, unaggregated records from your dataset. It provides a detailed view of each record.

• No Aggregation Functions Does not require the use of aggregation functions. The query retrieves raw, unprocessed records from the specified columns.

Raw Records mode is useful when you need a detailed, record-level view of the data. It's suitable for creating charts that display individual data points without summarization.

How the Raw Mode works:

• Column Names The column names in your SQL query result set become the headers or fields in the table. Each column in the result set is mapped to a corresponding column in the visualization.

• Data Types Tathya attempts to infer the data types of each column based on the values in the result set. This helps in appropriately formatting and displaying the data.

• Automatic Table Creation When you execute the query in "Raw Records" mode, Tathya automatically creates a table or chart with the mapped columns, displaying the individual records retrieved by the query.

• Dynamic Mapping The mapping is dynamic, meaning that if your SQL query result set structure changes (e.g., adding or removing columns), Tathya adjusts the mapping accordingly when you execute the query.

• No Aggregation Since "Raw Records" mode is focused on displaying individual records without aggregation, each row in the result set is treated as a separate data point.

Configure Additional Chart Settings

You also have additional configurable options such as Filters, Ordering, and Row Limit.

• Filters Filters allow you to narrow down the rows displayed in your result set based on specific conditions. You can filter the data to show only rows that meet certain criteria.

• Ordering Ordering allows you to sort the result set based on one or more columns. You can specify the order (ascending or descending) for each column.

• Row Limit Row Limit allows you to control the number of rows displayed in the result set. This is particularly useful when dealing with large datasets, allowing you to view a manageable subset of the data.

Optimizing Queries for Specific Results

In your SQL queries, you can write specific details and conditions to retrieve data that matches your requirements without the need for additional filters in the chart.

For example, you can use the WHERE clause in your SQL queries to filter data at the database level before it even reaches Tathya. This can be more efficient as it reduces the amount of data transferred between the database and Tathya.

Similarly, you can use ORDER BY in your SQL queries to specify the sorting order of the results, and LIMIT to control the number of rows returned.

Writing precise and optimized SQL queries can streamline the data retrieval process, ensuring that the results align with your expectations without relying heavily on post-processing in the visualization chart.

Adjust other settings such as colors, labels, and tooltips as needed from the “Customize” option, present right next to the data tab.

For example, if you choose a Line Chart, specify the columns you want on the x-axis and y-axis. the date might be on the x-axis, and total sales on the y-axis.

Once you have made the required modifications, click on “Update chart”.

Save and Share your Chart

In the top-left corner, give your chart a descriptive name for easy identification within Tathya.

Navigate to the top-right corner and click on the "SAVE" button. A Save Chart panel will appear with the Chart Name field auto-populated.

After saving, find your chart in the Charts tab for quick access.

HotWax Commerce facilitates the exchange of data between systems, but errors can occur during import/export processes, potentially leading to inaccuracies. To address this, the platform provides LogInsights reports, which are stored in Solr-index core. By leveraging the powerful indexing capabilities of Solr, HotWax Commerce enables efficient data retrieval and analysis, supporting performance monitoring, troubleshooting, and reporting activities. These reports offer insights derived from system logs, allowing users to easily identify any data transfer failures.

LogInSight charts can be set with the following steps:

LogInsights Core Creation for a Specific Instance

The logInsights core within HotWax Commerce provides users with valuable insights derived from system logs, facilitating the generation of superset reports. This feature is crucial for users who need to analyze system performance, troubleshoot issues, and make informed decisions based on data-driven insights.

Steps to set LogInsight Core:

1. Accessing the Search Admin Page:

   • Navigate to the hamburger menu in the HotWax Commerce interface for the specific instance.

   • Click on Search Admin to access the page for managing Solr indexing.

2. Managing Solr Cores with Core Operations:

   • Within the Search Admin page, locate the Core Operations section.

   • This feature allows users to effectively manage Solr cores, ensuring optimal performance and organization of indexed data.

3. Refreshing the logInsights Core:

   • Identify the logInsights core within the list of Solr cores.

   • Click on the Refresh Core button associated with the logInsights core.

   • This action updates the Solr index with the latest data from system logs, ensuring synchronization with any recent changes or updates.