HotWax Commerce sends data with external systems by sending data files over an SFTP server. Various data flows exist between HotWax and other systems. This document will help you assist the client with the issue of not seeing the files on the SFTP location and the common issues around SFTP.
To know about different data flows with the external systems and the SFTP locations where Hotwax kept the file, refer to this integration documentation.
To begin resolving the issue, we first need to determine the specific file the client is referring to. Typically, clients provide the name of the file they cannot locate or mention that a particular feed has not been placed at the SFTP.
To troubleshoot the issue, we'll need to access the SFTP server using the FileZilla application. If you haven't already, download FileZilla onto your machine using this link.
Once FileZilla is installed, follow these steps to log in to the SFTP server and inspect the data files:
Retrieve the SFTP user credentials from the OMS
Access the OMS and click on the hamburger menu.
Scroll down to the Settings section and click on it.
Find and click on the General option.
Scroll down the General Settings page to locate the FTP connection settings.
Copy down the SFTP user credentials.
Open FileZilla and use the obtained credentials to log in to the SFTP server.
Once logged in, navigate through the directories to locate the relevant feed based on the information provided by the client. You can use the integration document for the SFTP location. Here is an example of file path looks like: /home/{sftp-username}/netsuite/customer/export.
When a file is found in the SFTP archive folder, it indicates that the external system has successfully consumed the file. Communicate this to the client and attach the file and a screenshot for their reference. Files not successfully consumed by the external system will be in the failed folder.
There may be various reasons for files not being exported and placed by HotWax on the SFTP. The reasons should be as follows:
Failed Export Validations
The data may not pass the required export validations and therefore doesn't get placed at the location for the external system. In this case, contact the integration team for assistance.
Integration Platform Issue
The flow in Napita-integration platform which handles placing files on the SFTP, may not be running. Please check with the integration team to ensure the flow is running properly. Alternatively, you can follow these steps:
Right-click on the canvas of the processor group in Napita.
Check the status of the processor.
If the processor is enabled, you will see an option to Stop.
If the processor is not enabled, you will see an option to Start. These steps will help you determine whether the flow is currently enabled.
After exploring all possible reasons why the file isn't making it to the SFTP, and confirming it's not on our end, we can take the next step by kindly asking the client for their SFTP credentials to delve deeper. We can use the following templated reply:
Could you please share the SFTP credentials you're using so that we can trace the root cause of the issue?
This allows us to log in to the SFTP server with their credentials and identify the root cause of the issue. Sometimes, the problem arises because the credentials they are using are outdated, preventing them from accessing the files. In such cases, we can provide them with new credentials.
Additionally, there are instances where users are unable to upload or download files from the SFTP server due to insufficient permissions. To resolve this, we can contact the admin team to check and adjust the users' permissions as needed.
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
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
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.
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
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.
Adding a new data configuration in OMS enables users to specify how data is imported and exported.
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:
Config Id*
Description*
Import Service*
Import Path*
IMP_PROD_FETR
Import Product Features
importProductFeatures
<replace-path>
Click Add again to save the new configuration.
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:
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:
Enum Id
Enum Type Id
Enum Code
Description
JOB_IMP_PROD_FETR
PRODUCT_SYS_JOB
<optional>
Import product feature
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)
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.
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.
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.
The Entity SQL Processor in Web Tools interprets and executes SQL commands, improving viewing and management efficiency by providing users with the capability to execute SQL queries in the system.
Users must always use the `Select` query first, and then use subsequent queries to perform relevant actions. Furthermore, it is recommended to refrain from using `Delete` queries.
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.
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.
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.
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.
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, 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.
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.
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.
Create New button in Entity EngineGo 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.
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.
Ensure that the XML data adheres to the required format for successful import.