Connector Designer Dashboard

Connector Designer Dashboard

The role of a connector designer is to create a blueprint for a connector that meets specific requirements, including its architecture, interfaces, and data. The designer works systematically to ensure the connector definition aligns with your business needs. You can use the Connector Designer wizard to define your connector, which allows you to specify global artifacts such as call URLs, headers, queries, and parameters. Additionally, you can set up definitions for OAuth servers, API calls, and API documentation. Creating these definitions helps streamline the integration of your connector with others.

The Connector Designer wizard is available to define the connector. Make sure you have all the necessary information before starting the wizard. The entire process is divided into several steps. To create the connector definition in Connector Designer, you need to complete all four steps. While completing all four steps at once is recommended, it is not required. You can do each step separately. The connector will tell you which step to do first.

Navigate to the Connector Designer Module

Info
Navigation: Design > Connector Designer
This section describes how to navigate to the Connector Designer screen from any other screen.
  1. Click on the Connector Designer menu as shown on the screen. It will navigate you to the Connector Designer Dashboard.
  2. The Dashboard is the main screen that provides an overview of the Connector's cards. To help you navigate the screen with ease, here's a detailed description of each section:
    1. The Group Menu Bar is located on the left side of the screen. It displays a list of available groups, enabling you to access the Group menu with ease. The Group menu allows you to organize and categorize your content according to your specific requirements.
    2. The Menu Item Bar is located next to the Group Menu Bar. It displays a list of menu items based on the selected group menu. This bar is designed to help you quickly access the content you need.
    3. The Header is located at the top of the screen. It displays the screen name, language selector, Bell icon, and user profile. The screen name helps you identify the current screen, the language selector allows you to choose your preferred language, the Bell icon notifies you of any updates, and the user profile lets you access your account settings.
    4. The Action Area is located below the Header. It provides the Breadcrumbs, which help you track your current location on the screen. The Action Area also contains the action icons that enable you to perform various tasks, such as adding new content or editing existing content.
    5. The Content Area is located below the Action Area. This is where all the content gets displayed. The content can be presented in various forms, such as cards, tables, or graphs, depending on the type of information being viewed.


Connector List

When you open the Connector Designer screen, you'll see a complete list of all configured connectors. Each connector appears as a card displaying key information, such as the connector's authentication type, related APIs, and components. This layout helps you quickly identify which connector needs your attention and enables you to manage them efficiently.
  1. The list of Connector cards will appear on the Connector Designer dashboard screen. 
  2. If the user is new and hasn't created any connectors yet, the screen will be blank with the Add button displayed.

Connector Card

The card provides you with an overview of the connector. You can view the following information on the card:
  1. The connector card is designed to provide you with a clear view of your connector's status and options.
  2. At the top right corner of the card, a menu icon provides access to various workarounds, including edit, favorite, deactivate, delete, and more. This allows you to perform any necessary actions on your connector easily. 
  3. You may notice a warning or alert icon on the top left of the card. This icon serves as a quick indicator of any issues or problems with the connector. If everything is running smoothly, this icon won't appear. 
  4. In the center of the card, you'll find the connector logo. If you haven't configured a logo, a default connector logo will be displayed in its place. The logo is a visual representation of your connector, making it easy to identify at a glance. 
  5. Below the logo, you can see the name of the connector configured by your admin or business partner.
  6. The connector version is also mentioned on the card. 
  7. The type of authentication used for a particle connector is also displayed below the connector version.
  8. At the bottom of the card, you can view API and Component details:
    1. APIs: This section displays the number of APIs associated with your connector. If you have not added any connectors yet, it will show '0'. Upon clicking on the section, you will be directed to the API section, where you can view the list of APIs and modify them if required.
    2. Components: This section shows the number of components used for a particular connector. If you have not configured any component yet, it will display '0'. Upon clicking on the section, you will be directed to the Component section, where you can view and modify the list of components if required.
  9. To access a detailed overview of the connector, click on any part of the connector card. Once you have clicked on the card, you will be directed to the connector detail screen, which provides an in-depth analysis of the connector.

The menu icon is provided on the top-right corner of the tile. The menu expands when the mouse hovers over the menu icon, displaying multiple options. You can click on any of the options. The following options are available in the menu:
  1. Favorite: To create a list of favorite connectors, utilize the Start icon provided. Upon marking it as a favorite connector, it will appear at the top of the list in alphabetical order. The remaining connector cards will then be arranged in alphabetical order.
  2. Edit: This option permits modifying connector details, including the name, logo, and authentication, among others. This feature offers the opportunity to refine and optimize connector functionality as organizational needs evolve.
  3. Delete: The delete option allows you to remove a connector that is no longer needed. However, this feature is controlled by the roles and rights feature. The availability of this feature depends on your role and permissions, which are determined by the organizational hierarchy and structure.

Action Area

The following icons are provided in the action area of the screen.
Help
This feature facilitates the display of help content pertinent to the current screen. It is designed to provide users with relevant and informative assistance in navigating the interface.

  1. A search option is provided in the action area of the screen.
  2. It allows you to find a particular connector by name.
  3. Click on the search  and type the connector name in the search field.
  4. As you type, the result will be immediately displayed for you.

Filter

  1. A filter option is provided in the action area of the screen.
  2. You can easily search for a specific connector by its name, status, or connector designer.
  3. You can enable the filter by clicking on the filter icon provided in the action area.
  4. The connector designer filter provides the following filters:
    1. Connectivity Type: This filter allows you to view connectors based on their connectivity types.  
    2. Authentication Method: This filter allows you to view connectors based on their authentication method types.  
    3. Status: This filter lets you view connectors based on their status.  
  5. Apply the filter, and click the Show Result button; the result will be displayed immediately.
  6. Use the Reset button to clear the filter search. When you click the Reset button, all applied filters will be reset to their default settings.
  7. To close the filter, click the 'X' icon on the filter tab.

Connector Details

  1. To view the connector details, click anywhere on the card to view details.
  2. Once clicked, the connector details screen will appear, showing the connector details.
  3. The widget provides a comprehensive overview of the connector, highlighting key details at a glance. The connector’s logo is prominently displayed, along with their name and title, serving as quick identifiers. At the bottom of the widget, you'll see the connector's version, authentication type, and diploma status.

Edit Button with Menu Options

The Edit button serves two functions: it provides editing capabilities for your project and offers customization options. Next to the Edit button, a drop-down is provided with multiple options. You can access several options by clicking the drop-down menu next to the Edit button. The same options are also offered on the project card menu. The following are the available options:
  1. Favorite: To create a list of favorite connectors, utilize the Start icon provided. 
  2. Edit: This option permits modifying connector details.
  3. Delete: The delete option allows you to remove a connector that is no longer needed. 


    • Related Articles

    • Automation Dashboard

      Overview Automation is crucial in executing complex, multi-step workflows with minimal reliance on human intervention. Its primary objectives encompass the simplification of processes, the enhancement of operational efficiency, and the mitigation of ...

    • Edit Connector Components

      This section provides the steps to edit the connectivity details of an existing connector. To start the edit mode, you need to click on the Edit button on the Connector Designer Details screen. Step 1: Start Editing Mode Option 1: Accessing an Edit ...

    • Overview of the Design Module

      Overview The Design module is a comprehensive platform that empowers you to craft your own connectors and automation processes. This unified environment is specifically designed to facilitate the creation of automated workflows and the development of ...

    • Add/Remove Component

      This section provides the steps to add or remove the component of the connector. To add or remove the component, you need to start the edit mode. Step 1 - Start Editing Mode Option 1 - Accessing an Edit option using a context menu Click or hover the ...

    • Know Your Flow Editor

      Overview Flow Editor is a visual tool for creating, organizing, and controlling workflows that link various systems, applications, and data sources. It offers a drag-and-drop feature with pre-made flow units to define data movement, integration ...