DCKAP Integrator
Getting StartedIntegrator StatusRoadmapRelease Notes
  • Overview
    • Enterprise Integration Platform
    • What is DCKAP Integrator?
    • Integrator Architecture
    • Integrator Security
  • GETTING STARTED
    • Quick Start Guide
    • New User Registration
      • Available Plans
    • Integrator Dashboard
    • Analytics
  • User Guide
    • The Basics
    • Account Management
      • User Groups
      • Account Settings
      • Two-Factor Authentication
    • Projects
      • Add New Project
      • Managing Projects
      • Transfer Project Ownership
    • API Access Keys
    • Project Invitations
    • Help and Support
      • Raise a Ticket
      • Visibility and Collaborators
      • Help and Support - A Quick Overview
    • Exchange
  • PROJECT MANAGER
    • Integrations
      • Add New Pipe
      • Flows and Handlers
      • Mapping and Modifiers
      • Advanced Modifiers
      • Advanced Scheduler
    • Workflows
      • Flow Builder
      • Snippets
      • Actions
        • API Call
        • Console
        • Decision
        • Loop
        • Detail Logger
        • Error Logger
        • Code Runner
        • Formatter
        • Notification
        • Snippet
        • Return
        • Sleep
      • Mock Data
      • FAQs
    • Systems
      • Credentials
      • API Manager
        • API Components
        • Test API
      • Private Systems
      • Authentication Types
        • OAuth 2.0
    • Logs
    • Project Settings
    • Project Analytics
    • Advanced
      • Flows
    • Project Documents
  • TECHNICAL GUIDE
    • Flows & Handlers
      • Add New Flow
      • Simulator
      • Flows: Best Practices
      • Flows: Use Cases
      • Timezone Converter Handler
      • Supported Timezones
    • API and Mapping
  • Tutorials
    • Create a new Integration Pipe
    • Create a new Flow
    • How to Map data?
    • Working with Modifiers
    • Managing User Groups
    • How to use DCKAP Integrator Dynamic URL's?
  • API Documentation
    • Quick Start
    • Projects API
    • Credentials API
    • Templates API
    • Posting and Reading XML data via DCKAP Integrator
    • Commonly used APIs
  • Others
    • Product Roadmap
      • Past Roadmaps
    • Release Notes
      • 4.4.0 April 29, 2025
      • 4.3.0 February 25, 2025
      • 4.2.0 December 19, 2024
      • 4.0.0 August 29, 2024
      • 3.4.8 May 27, 2024
      • 3.4.7 March 14, 2024
      • 3.4.6 January 4, 2024
      • 3.4.5 October 18, 2023
      • 3.4.4 May 16, 2023
      • 3.4.3 March 1, 2023
      • 3.4.2 December 20, 2022
      • 3.4.1 October 4, 2022
      • 3.4.0 August 10, 2022
      • 3.3.6 July 20, 2022
      • 3.3.5a June 23, 2022
      • 3.3.5 May 26, 2022
      • 3.3.4 March 31, 2022
      • 3.3.3 Feb 4, 2022
      • 3.3.2 November 24, 2021
      • 3.3.1 October 22, 2021
      • 3.3.0 August 28, 2021
      • 3.2.7 June 18, 2021
      • 3.2.6 May 11, 2021
      • 3.2.3 and 3.2.4 March 8, 2021
      • 3.2.2 Dec 24, 2020
      • 3.2.1 Nov 12, 2020
      • 3.2.0 - October 7, 2020
      • 3.1.10 - September 16, 2020
      • 3.1.9 - September 3, 2020
      • 3.1.8 - August 15, 2020
      • 3.1.7 - July 19, 2020
      • 3.1.6 - June 21, 2020
      • 3.1.5 - May 15, 2020
      • 3.1.4 - April 27, 2020
      • 3.1.3.0 - April 20, 2020
      • 3.1.3 - April 8, 2020
      • 3.1.2 - March 26, 2020
      • 3.1.1 - March 13, 2020
      • 3.1.0 - March 10, 2020
Powered by GitBook
On this page
  • What is a Pipe?
  • Pipe Types
  • Manage Pipes
  • Auto Pilot Mode and Scheduler

Was this helpful?

  1. PROJECT MANAGER

Integrations

The Integrations section is where users will configure and set up pipes. Every pipe contains a name and system credentials, is linked with a Flow, and may or may not have a Mapping configuration.

PreviousExchangeNextAdd New Pipe

Last updated 7 months ago

Was this helpful?

What is a Pipe?

A Pipe is a single integration unit, i.e., the sub-unit of every system integration, responsible for synchronizing all entities (Customers, Orders, Products, etc.). Each pipe is mapped to a Flow to carry out the underlying integration logic.

For a quick video explainer of What are Pipes?,

Pipe Types

Data synchronization will be handled periodically at certain configured time intervals. This is the most commonly used Pipe type since it offers optimum performance.

Example: Every 2 hours

Data synchronization is done in real-time using an API call from any system through DCKAP Integrator. For example, services like Pricing may be configured as a Dynamic Pipe to fetch the prices in real-time.

Use the following URL to run all your dynamic services in integrator.dckap.com:

This URL can also be got by clicking on the COPY URL button in the Integrations page.

During a dynamic call to V3 or lightning, 400 and 401 Status codes will be returned for a disabled pipe and invalid credentials respectively.

For all other errors, 200 Status code will be returned.

During dynamic calls, it is possible to authorize DCKAP Integrator by using access_token, jwt_token in headers/params.

Examples:

http://lightning.dckap.com/v1/dynamic/listener/<id>?access_token=<token>

http://lightning.dckap.com/v1/dynamic/listener/<id>?token=<jwt_token>

Manage Pipes

The pipes are displayed either as a Grid or a table.

In the Integrations page, the following information is present in grid/tabular form:

Field Name

Sample

Description

Status

Enables or disables the working of a pipe, used especially during scheduled synchronization

Pipe Name

Displays the name of Integration Pipe

Systems

Systems connected in the pipe

Type of Integration

  • Batch: When the data synchronization is done periodically

  • Dynamic: When the data synchronization is done in real-time using an API call to the system

Sync status

Displays the time at which the last sync was performed and if the sync was complete or not

Sync Now &

Copy URL button

For Batch type Integration ⇒ Start the integration process by manually clicking on the Sync Now button.

For Dynamic type Integration ⇒ Copy URL and share across different systems to access data from the system

View Logs

To view Logs of this pipe

Enable/Disable Autopilot Mode

Only for Batch type Integration. To enable or disable Autopilot mode.

For Dynamic pipe, scheduling is disabled.

Enable/Disable Console Logs

To enable or disable console logs for this Integration

Auto Pilot Mode and Scheduler

For a Dynamic pipe, the ability to schedule is disabled

Batch

Dynamic

Batch

Dynamic

The Sync process for Batch type integration can be automated by scheduling it. This is done by clicking on the Enable Auto Mode link present just below the pipe name or clicking the icon and then editing the synchronization time. The Minimum Interval Period for scheduling is 5 minutes

https://lightning.dckap.com/v1/dynamic/listener/{pipe_id}
click here.
Integrations displayed as a Grid
Integrations displayed as a List