Integration Guide
Welcome to the Onebeat Cloud data integration tutorial! In this guide, you will learn how to input and output data to and from Onebeat Cloud using 4 different methods: CSV files, API (JSON), ‘Digger’ - access to ERP (read/write) directly or using a smart connector, DiggerX - access to ERP with middle-man. Each method has its own benefits and may be more suitable for certain use cases.
Clients can choose different input and output methods, depending on their needs and preferences. For example, a client may choose to use CSV files for input and direct access to their ERP system for output, or vice versa. It is up to the client to decide which method is the most suitable for their use case.
Onebeat Cloud takes security very seriously and has high security standards in place to protect client data. All data transfer methods, including CSVs, API, and direct access to ERP systems, are secured using industry-standard encryption techniques to ensure the confidentiality and integrity of the data. The client can have confidence that their data is safe when using Onebeat Cloud.
Inputting Data
- Ease of use: CSVs can be created and edited using a simple spreadsheet program like Microsoft Excel or Google Sheets.
- Compatibility: Most software systems can export data as a CSV, making it a widely supported option.
To use this method, the client will need to adjust their data to fit the structure of the Onebeat Cloud data model. They can do this by mapping the columns in their ERP to the corresponding fields in the Onebeat Cloud data model.
The client will have to create an automation on his side to extract and upload these CSV files on a daily basis into a dedicated Amazon AWS S3 service.
See Required DataAnother option for integrating data into Onebeat Cloud is through the use of an API that returns data in JSON format. The benefits of this method include:
- Updated: An API allows the client to send the most up-to-date data in their system.
- Integrity: Data integrity is ensured by performing data validation in real time.
- Secure data transfer: An API can be secured using various authentication methods to ensure that only authorized users have access to the data.
To use this method, we’ll provide the client with the relevant API endpoints and any necessary authentication credentials. The client will need to adjust their data to fit the structure of the Onebeat Cloud data model.
The client will have to create an automation on his side to extract and upload these CSV files on a daily basis into a dedicated Amazon AWS S3 service.
See Required DataFor clients who use an ERP system, Onebeat Cloud can directly access their system to retrieve data. The benefits of this method include:
- Ease of use: The client does not need to do any extra work to get their data into Onebeat Cloud.
- Real-time data: Onebeat Cloud can access the most up-to-date data in the client's ERP system.
- Secure data transfer: Onebeat Cloud can access the data in a read-only mode, so the client's data is secure.
To use this method, the client will need to provide Onebeat Cloud with access to their ERP system and any necessary authentication credentials, along-side any DB/API queries to retrieve the data directly from the ERP system.
Similar to the previous method, Onebeat Cloud can also access the client's ERP system using a smart connector. The benefits of this method include:
- Ease of use: The client does not need to do any extra work to get their data into Onebeat Cloud.
- Real-time data: Onebeat Cloud can access the most up-to-date data in the client's ERP system.
- Secure data transfer: Onebeat Cloud can access the data in a read-only mode, so the client's data is secure.
- Customizability: The smart connector allows the client to specify the data they want to retrieve from their ERP system and how it should be structured.
To use this method, the client will need to provide Onebeat Cloud with access to their ERP system and any necessary authentication credentials. They will also need to specify the data they want to retrieve and how it should be structured. Onebeat Cloud will then use the smart connector to retrieve the data from the ERP system.
DiggerX is an application that can be installed on multiple OS’s like Windows, Linux, Mac and more. The app, using config files, accepts SQL queries and creates a web server with an endpoint per query. This allows Onebeat cloud to get the client’s data on a daily basis from their ERP, without the need of full access to their systems. The benefits of this method include:
- Ease of use: The client does not need to do any extra work to get their data into Onebeat Cloud.
- Real-time data: Onebeat Cloud can access the most up-to-date data in the client's ERP system.
- Secure data transfer: Onebeat Cloud can access only the data the clients choose to expose, in a read-only mode, so the client's data is secure.
Output Options
Onbeat’s smart engine generates picking lists and execution recommendations for replenishment, store transfers, Initial allocation and more.
Output Structure
Onebeat Cloud offers the same 4 options for outputting data as it does for integrating data: CSVs, API (json), access to ERP (read-write) directly or using a smart connector.
CSV files are a simple way to output data from Onebeat Cloud. The benefits of this method include:
- Ease of use: CSVs can be opened and edited using a simple spreadsheet program like Microsoft Excel or Google Sheets.
- Compatibility: Most software systems can import data from a CSV, making it a widely supported option.
To use this method, the client will need to adjust their data to fit the structure of the Onebeat Cloud data model. They can do this by mapping the columns in their ERP to the corresponding fields in the Onebeat Cloud data model.
Clients will need to set up a connection to Amazon AWS S3 service (Amazon Simple Storage Service) in order to manually download the output files from there, or they can develop their own automation process to retrieve the files.
An API is a way to output data from Onebeat Cloud in a structured format, such as JSON. The benefits of this method include:
- Real-time data: The client can access the most up-to-date data in Onebeat Cloud through the API.
- Customizability: The client can use the API to request specific data or filter the data in a particular way.
- Secure data transfer: An API can be secured using various authentication methods to ensure that only authorized users have access to the data.
To use this method, we’ll provide the client with the relevant API endpoints and any necessary authentication credentials. The client will need to adjust their data to fit the structure of the Onebeat Cloud data model.
For clients who use an ERP system, Onebeat Cloud can directly output data to their system. The benefits of this method include:
- Ease of use: The client does not need to do any extra work to get their data into their ERP system.
- Real-time data: The client's ERP system will have the most up-to-date data from Onebeat Cloud.
- Secure data transfer: Onebeat Cloud can output the data in a read-only mode, so the client's data is secure.
To use this method, the client will need to provide Onebeat Cloud with access to their ERP system and any necessary authentication credentials, along-side any DB/API queries to retrieve the data directly from the ERP system.
Similar to the previous method, Onebeat Cloud can also output data to the client's ERP system using a smart connector. The benefits of this method include:
- Ease of use: The client does not need to do any extra work to get their data into their ERP system.
- Real-time data: The client's ERP system will have the most up-to-date data from Onebeat Cloud.
- Secure data transfer: Onebeat Cloud can output the data in a read-only mode, so the client's data is secure.
- Customizability: The smart connector allows the client to specify the data they want to output to their ERP system and how it should be structured.
To use this method, the client will need to provide Onebeat Cloud with access to their ERP system and any necessary authentication credentials, along-side any DB/API queries to retrieve the data directly from the ERP system.
Required Data
CSV & APIAll required parameters, include information needed by the client, API keys, example of post request to our API to upload the data and others will be available and explained in the cloud system interface.
In order to run all of the algorithms, we require certain data to be present. We divide the required data into five different structures: Locations, SKUs, Transactions, Inventory-Status, and Policies & Constraints.
All of this data is essential for running our algorithms and ensuring that your business operations are efficient.
Download Data Structure
