HCL Commerce Version 9.1.12.0 or later

Create a custom connector using Ingest

This lesson creates a connector with the name custom. Rename custom with your required connector name.

About this task

To create a connector in the Ingest service, use the following API:
http://ElasticSearchHostname/IP:30800/swagger-ui/index.html?url=/v3/api-docs&validatorUrl=#/Create%20Connector%20Configuration/createConnector
Note: If you are connecting to the database for the production or live environment, replace AUTH with LIVE in the code.

Procedure

  1. In the Swagger user interface, select Connector Configuration > POST: /connectors API.
  2. Click Try it out.
  3. For the API body, use the following code.
    {
    
        "name": "custom.cas",
        "description": "This is the connector for the custom processing using CAS Index Model",
        "pipes": [
            {
                "name": "_Template-Schema-CAS"
            },
            {
                "name": "_Template-DatabaseETL-CAS",
                "properties": [
                    {
                        "name": "Database Driver Location(s)",
                        "value": "${AUTH_JDBC_DRIVER_LOCATION}",
                        "scope": {
                            "name": "Database Connection Pool",
                            "type": "CONTROLLER_SERVICE"
                        }
                    },
                    {
                        "name": "Database Driver Class Name ",
                        "value": "${AUTH_JDBC_DRIVER_CLASSNAME}",
                        "scope": {
                            "name": "Database Connection Pool",
                            "type": "CONTROLLER_SERVICE"
                        }
                    },
                    {
                        "name": "Database Connection URL",
                        "value": "${AUTH_JDBC_URL}",
                        "scope": {
                            "name": "Database Connection Pool",
                            "type": "CONTROLLER_SERVICE"
                        }
                    },
                    {
                        "name": "Database User",
                        "value": "${AUTH_JDBC_USER_NAME}",
                        "scope": {
                            "name": "Database Connection Pool",
                            "type": "CONTROLLER_SERVICE"
                        }
                    },
                    {
                        "name": "Password",
                        "value": "${AUTH_JDBC_USER_PASSWORD}",
                        "scope": {
                            "name": "Database Connection Pool",
                            "type": "CONTROLLER_SERVICE"
                        }
                    }
                ]
            },
            {
                "name": "Terminal"
            }
        ] 
    
    }
  4. Click Execute.

Results

The response from Swagger will resemble the following: