Quick Start Guide
A step by step manual that will get you started with the DCKAP Integrator application.
This Quick Start Guide will help you get started with DCKAP Integrator and discuss the steps involved in setting up a Project in DCKAP Integrator and how to create new Integration pipes and schedule the data synchronization.
You can create a new account through the registration page, to monitor and manage Integration transactions.
Following are the details required to register yourself in the DCKAP Integrator application:
- First name and Last name of account holder
- Email address of account holder
Once registered, an email with the activation link will be sent to the email address provided. Click on the link and activate your account to get started.
A new feature in DCKAP Integrator also allows Project Owners to send Project invitations to DCKAP Integrator as well as non-DCKAP Integrator users, enabling them to access Projects straight away. DCKAP Integrator users can manage invitations in one of the following ways:
a) Clicking on the Invitations icon in the left menu bar
b) Clicking on the Project Invite link from the Invitation email
Once you activate your account, you will be redirected to the DCKAP Integrator projects page which is also the home page of the DCKAP Integrator application.
The analytics page provides you with high-level insights about different metrics of projects managed under that user account.
The following Project metrics can be viewed on the dashboard:
- Timeline: Allows the user to change the timeline of data displayed on the DCKAP Integrator dashboard.
- Total Records Processed: Number of API calls made to other systems
- Success Rate: Percentage of records processed successfully
- New Customers: Number of new customers over the selected time period
- New Orders: Number of new orders in the selected timeframe
- Traffic graph - Customers & Orders: A graphical representation that shows how many new customers and orders have been synchronized within the selected time frame.
- Project Filter: By selecting a project from the drop-down list in the top left corner, the dashboard screen displays metrics for that particular project.
Users can manage their account configuration settings from here.
Click on Account Settings from the drop-down list in the top right corner.
These settings will be applicable to all the projects the user has access to:
- Override Project Timezones : If yes, all the date and time are displayed in the chosen timezone below.
- Timezone: Manage all date related information in the product in the selected timezone.
- Allow Force Login: To allow DCKAP Integrator Admin to login to your account.
Once the options are chosen, click on Save Configuration to save the settings.
This page allows the user to update the password of the account in which they have currently logged in. The user can simply enter the existing password, followed by the new password and press the update button.
This page allows the user to update the account information provided during the user registration.
All projects are displayed as individual cards with details - project name and project owner name. Click anywhere on the project card to navigate to the project space, where the user can access, edit and create different features (Integrations, Systems, Flows and so on) of the project.
The Projects page is considered the epicenter of the integration process, where users can create, edit and view all the projects they have access to.
Clicking on this icon from the Dashboard will take users to the Projects page which consists of a list of all the projects that they have created or have been given access to.
At first glance, it provides an outline of basic information about a project in tabular form, such as Project Name, Project Description and Created by.
Users can also do the following from the Projects list:
- Manage Button: To navigate to the Project space, where the user can access, edit and create different aspects (Integrations, Credentials, Flows and so on) of the project. More information about building and managing a project can be found here.
- Transfer Ownership: To make another user the "Project Owner" of that Project.
Every DCKAP Integrator project is made up of integration units called Pipes. These units, in turn, contain flows and mapping configurations.
Click on the project to go to the Integrations page which is the hub of the project. From here users can edit and play with the development of the project as needed.
The following icons are available on the left side of this page:
- Integrations: Quick access to all integration units (pipes) and also to create new integrations, to synchronize data transfer, view logs, and edit integrations
- Credentials: View, edit and add system credentials
- Logs: View high-level and detailed log messages, and results of the sync process
- Project Settings: Edit project settings such as timezone, dashboard settings, email notifications, and other notification settings
- Advanced: Developer related modules to build Flows and manage APIs
The Systems page is where users can add, edit, and maintain systems with its APIs and credentials for a project. These APIs will be used in building Flows and Integration pipes.
The individual platforms that DCKAP Integrator directly connects to, or connects using APIs are known as systems. For example, ERP is a system. These systems need to be configured in DCKAP Integrator in order to be able to communicate with them (read, write, and update data).
- Add New: This button allows the user to set up a new system in this account for integration. Enter the following details:
The Integrations section is where users will configure and set up pipes. Every pipe contains a name and credentials, is linked with a Flow, and may or may not have a Mapping configuration.
What is a Pipe?
Simply put, 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 should be mapped with a Flow to carry out the underlying integration logic.
Data synchronization will be handled periodically at certain configured time intervals.
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.
The URL can be got by clicking on the COPY URL button in the Integrations page.
The pipes are displayed either as a Grid or a table.
Integrations in Grid view
Integrations in List view
In the Integrations page, the following information is present in grid/tabular form:
- 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 / Dynamic
- Sync status: Displays the time at which the last sync was performed and if the sync was complete or not
- Sync Now or 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 or results of the data synchronization
- Enable/Disable Autopilot Mode: To enable or disable Autopilot mode (Only for Batch type Integration).
For Dynamic pipe, scheduling is disabled.
Enable/Disable Console Logs: To enable or disable console logs for this Integration
- Auto Pilot Mode and Scheduler: 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.
From the Integrations page, click on the Add New button in the top left section of the page. This is where users will Add a new Pipe by defining the Mapping and Modifier functionalities.
Step 1: Enter a suitable name for the pipe.
Example: Customer Update, Create Order, Fetch Subscription Details
Step 2: Choose the type of Integration: Batch or Dynamic.
Step 3: Choose Credentials (Systems to Integrate) from the drop-down list.
Step 4: Once the credentials are selected, the Flows with API calls to the systems (Credentials) selected will be displayed in grid format on the right side. Choose a Flow from the grid.
Step 5: When the Flow is selected, the Mapping nodes associated with the Flow are available to the user to configure.
Once the Flow is selected, the associated Mapping nodes are available to the user, i.e., if it has been added in the Flow. Clicking Configure on the Mapping card, opens a Mapping window where the user can map and modify data as required.
Mapping is used to steer data from source to destination systems. Here, the source and destination fields listed on either side. These fields are taken from the API Manager - Source and Response fields respectively. In addition to these fields, the user can add custom fields as needed. Users can drag and drop the fields to be mapped as shown below:
DCKAP Integrator will have a detailed record of each of the transactions happening between the two systems. Each record will have information about the entity ID, Status, Message and the Steps which will vary based on the type of transaction. For failed transactions, the Messages tab will show the reason for error for the respective transaction, which can be customized according to the business requirements for easy troubleshooting.
Click below for a detailed procedure on how to create Integration Pipes
For details about Project and User Invitations, click below: