Creating the Connector Package

Introduction

The connector package is zip file containing configuration files related to Cutsom Connectors. These configuration files has their own specific format. The intent of this document is to describe the contents of connector package and format of the configuration files to be placed in package zip.

Contents of Connector Package

The connector package zip contains below files

• Image file for Connector.
• XML and JSON Layouts for Trigger and Action entities.
• Triggers And Actions Text file.
• Lookup configuration file.

Follow the below steps to create Connector package

1. Identify the Entities for Connector
   1. Refer the Connector documentation to know about what entities are available in it. For example for an CRM App the entities can be Lead, Contact or Customer etc.
   2. Make list of entities and endpoints that you want to integrate with.
   3. Make list of attributes (fields) for each entity.
2. Create XML and JSON Layout Files for each entity.
   
   1. For Each entity 
      1. Create EntityResponse.xml file and EntityResponse.json file.
      2. Create EntityRequest.xml file and EntityRequest.json file.
      3. For example: for entity Lead create file LeadResponse.xml and LeadRequest.xml
      4. Edit the above created xml and JSON files in Text editor

      5. Paste the below sample XML in xml file.
         Entity Layout Expand source

      6. Add the entity name as a tag in this xml file. For exmaple for Entity Lead see below xml
         Entity Layout

         <Root>     <leads>     </leads> </Root>

      7. Enter the attributes of this entity as individual elements in this xml and save this file.
         Entity Layout Expand source

      8. Paste below json into JSON file.
         Entity Layout Expand source

      9. Add the entity name as a children in this json file. For exmaple for Entity Lead see below json
         Entity Layout Expand source

      10. Enter the attributes of this entity as individual elements in this json file and save this file.
          Entity Layout Expand source

   2. Now we should have below files ready (if we have 3 entities Lead, Contact and Customer )
      1. LeadResponse.xml
      2. LeadRequest.xml
      3. ContactResponse.xml
      4. ContactRequest.xml
      5. CustomerResponse.xml
      6. CustomerRequest.xml
      7. LeadResponse.json
      8. LeadRequest.json
      9. ContactResponse.json
      10. ContactRequest.json
      11. CustomerResponse.json
      12. CustomerRequest.json
          
          
3. Create Triggers and Actions File.
   1. Create a new Text file named triggersAndActions.txt and edit it in Text editor.

   2. Paste below JSON data in this text file. This JSON data is sample data having no Triggers and actions in it.
      Triggers and Actions JSON Expand source

   3. For each entity identified in Step 1, create a Trigger object as shown below. The below JSON shows Trigger object for Entity "Lead"
      Trigger Expand source

   4. Add the Trigger Object to triggers field in triggersAndActions.txt. By adding a trigger the file would look like as shown below
      Triggers and Actions JSON Expand source

   5. Create New Trigger objects for each Entity and add to triggers field. Below JSON shows triggersAndActions.txt file with two Triggers.
      Triggers and Actions JSON Expand source

   6. For each entity identified in Step 1, create a Action object as shown below. The below JSON shows Action object for Entity "Lead"
      Triggers and Actions JSON Expand source

   7. Add the Action Object to actions field in triggersAndActions.txt. By adding a action the file would look like as shown below
      Triggers and Actions JSON Expand source

   8. Create New Action objects for each Entity and add to actions field. Below JSON shows triggersAndActions.txt file with two actions.
      Triggers and Actions JSON Expand source

   9. Add URL for each Trigger and Action defined in this file. 
      1. Define key value pairs for each trigger and Action.
      2. The key should be Trigger or Action value defined in triggers or actions field.
      3. The value should be the complete URL endpoint to be hit for this particular trigger or action.
      4. Define a special Key Value pair for account Testing. The key should be "testaccount" and value should be the url to test the Connectivity with connector account
      
      Triggers and Actions JSON Expand source
   10. Add method for each Trigger and Action defined in this file. 
       1. Define key value pairs for each trigger and Action.
       2. The key should be Trigger or Action value defined in triggers or actions field.
       3. The value should be the complete http method to be used to hit url for this particular trigger or action.
       4. Define a special Key Value pair for account Testing. The key should be "testaccount" and value should be the http method to be used to hit to test the Connectivity with connector account
       
       Triggers and Actions JSON Expand source
   11. Save this file. triggersAndActionsJson.txt file is ready.
       
       
4. Create Lookup file.
   1. Create a xml file named lookupConfiguration.xml

   2. Paste below content into it
      Lookup Configuration Expand source

   3. Add Each entity in Columns tag as shown below
      Lookup Configuration Expand source

   4. Add attributes for each entity as shown below
      Lookup Configuration Expand source

   5. Add Operators for each field Type and apiField type
      Lookup Configuration Expand source

   6. Lookup Configuration file is ready.
5. Download Image File.
   

   1. You can download the connector Image file from respective Connector Provider.

   2. The image file should be in PNG format. 

   3. The name of the image can be any valid name.

6. Zip the individual files in a zip file. See the Zip Contents below