HomeWiki
HomeWiki
  1. Datapump
  • Back to home
  • 2. Connectivity
  • Introduction
  • Custom Script
  • Playground
  • Database Explorer
  • Log Stream
  • Direct Communication
  • Softone
    • Getting Started
  • Datapump
    • Getting Started
    • Crons
    • Legacy Windows Support
    • SDK
      • DB
        • _executeQuery
        • _executeStoreProcedure
        • _executeInsertQuery
        • _executeInsertQueriesInTransaction
      • Import
        • _productsImport
        • _categoriesImport
        • _brandsImport
        • _attributesImport
        • _attributeSetsImport
        • _unitsImport
        • _quantityImport
        • _customersImport
        • _contactsImport
        • _callsImport
        • _eventsImport
        • _tasksImport
        • _ordersImport
        • _usersImport
        • _customerSourceTagsImport
        • _productSourceTagsImport
      • Log
        • _logDebug
        • _logInfo
        • _logWarn
        • _logError
      • Web Requests
        • _httpGetJson
        • _httpPostJson
        • _httpPutJson
        • _httpDeleteJson
        • _httpPatchJson
      • Variables
        • _saveVariable
        • _getVariable
        • _deleteVariable
      • Blob
        • _blobConnect
        • _blobExists
        • _blobGet
        • _blobFind
      • Utils
        • _encodeBase64
        • _sleep
        • _getLastSyncDate
        • _updateLastSyncDate
        • _resetLastSyncDate
  1. Datapump

Getting Started

Datapump: Getting Started Guide#

Introduction#

Datapump is a robust tool designed to act as a bridge between your on-premise server and the Shopranos Platform. By installing Datapump on your local server, you can seamlessly integrate and access your internal resources, including local databases, internal APIs, and file systems. Datapump also enables automated and real-time data exchanges between Shopranos and your ERP system. This guide will help you get started with Datapump, from installation to configuration and usage.

Key Features of Datapump#

Access Local Resources: Connect to local databases, internal APIs, and file systems from your on-premise server.
JavaScript Integration: Write custom JavaScript code to control and automate tasks.
Web Requests: Make HTTP requests to local or external services.
File Operations: Upload files to blob storage or generate files locally.
Scheduled Imports: Automate the import of product catalogs (e.g., products, brands, categories, attributes, customers) via cron jobs.
Real-Time Interactions: Handle real-time queries from Shopranos, such as retrieving pricing, placing orders in your local ERP, or retrieving customer transactions and balances.
ERP Prototypes: Predefined scripts available for ERPs such as Capital, Atlantis, SAP Business One, and Regate, with the flexibility to write custom scripts.

Prerequisites#

Before starting, ensure you have the following:
1.
On-Premise Server: Datapump must be installed on a server within your network.
2.
Access to Local Resources: Ensure your server can access local databases, internal APIs, and file systems.
3.
Shopranos Platform Account: You need access to the Shopranos Platform to utilize Datapump's features.
4.
ERP Connector: A connector must be created on the Shopranos Platform to link your ERP system with Datapump.

Installation#

1. Create a Connector in Shopranos#

1.
Log in to the Shopranos Platform.
2.
Navigate to the Connectors section.
3.
Start the connector creation wizard and select the ERP system of your choice (e.g., Capital, Atlantis, SAP Business One, Regate).
4.
Complete the wizard to generate a certificate.

2. Install Datapump#

1.
Download Datapump: Obtain the Datapump installation package from the Shopranos Platform.
2.
Install Datapump:
Extract the installation files to a directory on your on-premise server.
Place the generated certificate (datapump.cert) in the Certificate folder located in the same directory as datapump.exe.

3. Establish Connection#

1.
Run datapump.exe to start Datapump. This will establish a connection between your on-premise server and the Shopranos Platform.
2.
Verify the connection in the Shopranos Platform. Once the connection is established, Datapump is ready for use.

Running Datapump#

1. Development and Testing#

To run Datapump for development or testing purposes, simply execute datapump.exe. This will open a console displaying log information. The console will automatically close after 1 hour.

2. Running in Production#

To run Datapump in a production environment, you must install it as a service:
1.
Open a command line with administrator privileges.
2.
Run the following command to install Datapump as a service:
3.
To uninstall Datapump as a service, use the following command:

Environment Management#

Staging and Production Environments#

Datapump supports both staging and production environments:
Staging Environment: Any changes made to the Datapump JavaScript code are automatically placed in the staging environment. You can test these changes using the Shopranos Playground.
Production Environment: Once you are satisfied with your changes in the staging environment, you can publish them to the production environment.

Conclusion#

Datapump is a versatile tool that enables seamless integration between your on-premise server and the Shopranos Platform. Whether you are automating product imports, handling real-time queries, or testing your scripts in a staging environment, Datapump provides the flexibility and power you need.
This guide should help you get started with Datapump, making it easier to integrate and manage your data with Shopranos.
Modified at 2024-08-23 06:43:03
Previous
Getting Started
Next
Crons
Built with