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
  • Purpose
  • Preconditions
  • Flowchart
  • Steps to create a Pipe
  • Steps to perform data synchronization
  • A. Batch pipes
  • B. Dynamic pipes

Was this helpful?

  1. Tutorials

Create a new Integration Pipe

Develop a new Integration Pipe and schedule your data synchronization using DCKAP Integrator

PreviousAPI and MappingNextCreate a new Flow

Last updated 1 year ago

Was this helpful?

Purpose

An Integration pipe is a framework that carries out the data synchronization end-to-end. It consists of the synchronization schedule, mapping and modifier configurations, and data flow logic between the systems to be integrated.

Preconditions

In order to successfully create an Integration Pipe, certain prerequisites need to be fulfilled:

1. Add a Project

The Projects page is considered the epicenter of the integration process, where users can create, edit and access all the projects that they have access to.

A new project can be added by clicking on Projects icon from the Dashboard and then the Add New button in the Projects page. For more information click on Adding Projects, click below:

2. Add Systems / Credentials

After a Project is added, click on the Manage button. The Project console now opens where you can manage Integrations and Credentials, and other project settings.

Click on the Credentials icon, and add the system credentials as described below:

3. Create Flows

A Flow is a set of statements written in the form of pseudo code to satisfy the business logic of the integration. It forms the neural schema of the integration. Users can choose from already pre-written Flows (available for commonly used Integrations) or they can create a custom flow as per their requirement.

Every Flow contains API calls to the respective systems from which the data needs to be accessed. These systems are later reflected while configuring the Pipe.

More details on how to write a Flow can be found below:

Flowchart

Steps to create a Pipe

  1. Go to the Integrations Page by clicking on Projects > Integrations

2. Click on Add New

The Add Pipe page will open.

3. Enter the following details:

  • A Suitable Pipe Name

  • Select Batch/Dynamic - Batch: Scheduled, Dynamic: Real-time call to the system

  • Select Credentials - Systems to be integrated

4. Once the Credentials are selected, the Flows which contain API calls to the systems selected in 3c will appear in a Grid format on the right side.

5. Select the required Flow by clicking on the Use button

6. Once Flow is selected, the Mapping nodes will be displayed

7. Click on Configure under Mappings

9. After the Mapping configuration is complete, click on Back.

10. Click on the Save button to save all the pipe configurations. The Pipe will now be displayed in the Integrations page.

11. For Batch type pipe, the synchronization can be scheduled to be automatically run - Automode

Steps to perform data synchronization

A. Batch pipes

Batch type pipes are those which carry out the synchronization on a schedule. It can either be scheduled to run:

  • Manually as needed by the user by hitting the Sync Now button

  • Automatically at periodic time intervals (AUTOPILOT MODE)

Steps to Schedule in Autopilot Mode:

  1. Click on the Scheduler link under the Pipe name

The Pipe Scheduler Dialog box opens.

  1. Here click on the Toggle On/Off button to turn On Autopilot Mode

  2. Next, select the synchronization frequency, i.e., the time interval at which the data sync should occur.

Examples:

  • Synchronize Every 5 minutes

  • Synchronize at 02:00 pm on every Sunday

  • Synchronize at 09:00 pm on the 18th of every month

B. Dynamic pipes

Dynamic type pipes are those that are called dynamically (in real-time) using an API call from any system through DCKAP Integrator. Click on Copy URL and use it in any system to fetch/post data.

8. The Mapping configuration page will open. Here you can drag and drop the various source and destination fields and setup the Mapping node. The data can also be formatted using the Modifier functions. For more information on Mapping and Modifiers, click .

Credentials
Flows & Handlers
here