The HTTP Listener Connector can be configured using the Rest API. It requires the following entities to be created:

Connection
Connector
Seed

Below are the examples of how to create the Connection, the Seed, the Credential. For the General Connector Configuration, please check refer to this page.

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Create Connection

-

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "http listener".	"http listener"
description	Yes	-	No	Name of the connection object.	"http listener connection"
properties	Yes	-	No	Configuration object
Content	No	false	No	Set this parameter to true if you will be POST-ing XML/JSON data to the HTTP Feeder. This XML/JSON data will be set as an input stream attached to the job published by the feeder.	"shared.example.com"
multipart	Yes	"disabled"	No	Enable multi-part multipart form submission, which allows for uploading files to the HTTP server through HTML forms, as well as other input elements.	"file"
filehandler	No	"stream"	No	Specify the type of file handler to use for posted files. The stream (default) handler will attach an InputStream to the file stream to the job, and subsequent stages can access the data using the Standards.Basic.getContentStream(Job j) method in the package com.accenture.aspire.framework. The file handler will upload the file to the specified directory (see below). No input stream is attached to the job for the file handler. See above for more details and restrictions.	"file"
uploadDir	Yes	-	No	Specify the location where files from multi-part multipart forms will be uploaded when using the file handler.	/upload
transform	No	false	No	Set on true if you want to use processor to transform xml XML using XSLT 2.0 files.	false
xsltFileName	Yes	-	No	The path of the XSL transform file to be used to format the output xmlXML. Path names will be relative to Aspire Home.	/config/xsl/executor.xsl
saxonProcessor	No	false	No	Set on true if you want to use SAXON Processors to transform using XSLT 2.0 files.	true	outputMime	Yes	No	Specifies the mime type which the HTTP feeder will report back to the HTTP client. Change this to "text/html" if your transform creates HTML which should be shown by a browser.	text/xml
jobMime	No	false	No	Specifies the mime type which the HTTP feeder will report back to the HTTP client. Takes mime type from Job.	true
headers	No	-	Yes	The configuration of the http HTTP headers.
maxUploadSize	No	10 MB	No	Specifies max size of uploaded file	10 MB
debugOutFile	No	-	No	Specify the location where the XSLT processed output will be written to. This is used for debugging the transforms.	/debug/debug_output.txt

Example

Code Block

theme	RDark
title	POST aspire/_api/connections

{
            "type":  "http listener",
            "description": "http listener connection "http listener connection",
            "properties":  {
                "Content": true true,
                "multipart":  "file",
                "fileHandler":  "file",
                "uploadDir":  "/config/xsl",
                "transform": true true,
                "xsltFileName":  "/config/xsl/executor.xsl",
                "saxonProcessor": false,
                "outputMime": "text/xml",
                "jobMime": false,
                 false,
                "headers":  [
                    {
                        "headerName":  "Connection",
                        "headerValue":  "keep-alive"
                    },
                    {
                        "headerName":  "Access-Control-Allow-Origin",
                        "headerValue":  "*"
                    }
                ],
                "maxUploadSize": 1000000 1000000,
                "debugOutFile":  ""
            }
}

Update Connection

Example

Code Block

title	aspire/_api/connections/8d611d98-e106-42bb-9f82-081edf9b006c

{
            "id": "8d611d98-e106-42bb-9f82-081edf9b006c",
            "type": "http listener",
            "description": "http listener connection",
            "properties": {
                "Content": true,
                "multipart": "disabled",
                "transform": true,
                "xsltFileName": "/config/xsl/executor.xsl",
                "saxonProcessor": true,
                "outputMime": "text/xml",
                "jobMime": false,
                "headers": [
                    {
                        "headerName": "Connection",
                        "headerValue": "keep-alive"
                    },
                    {
                        "headerName": "Access-Control-Allow-Origin",
                        "headerValue": "*"
                    }
                ],
                "maxUploadSize": 1000000,
                "debugOutFile": ""
            }
        }

Create Connector

For the creation of the Connector object using the Rest API, check please refer to this page

Update Connector

For the update of the Connector object using the Rest API, check please refer to this page

Create Seed

Field	Required	Default	Multiple	Notes	Example
seed	Yes	-	No	Path to the element to be crawled, can be a directory or a file.	Endpoint name	"submitFiles"myDirectory/levelTwo"
type	Yes	-	No	The value must be "filesystemhttp listener".	"smbhttp listener"
description	Yes	-	No	Name of the seed object.	"MySMB"
seedFile	No	false	No	If checked, the path will be processed as a file instead of a directory. WARNING: The crawler will only process the seed and then will stop.	true /false
http listener seed"
connector	Yes	-	No	The ID of the connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection	Yes	-	No	The ID of the connection to be used with this seed. The connection type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
workflows	No	[ ]	Yes	The IDs of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this seed will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
tags	No	[ ]	Yes	The tags of the seed. These can be used to filter the seed.	["tag1", "tag2"]

Example

Code Block

theme	RDark
title	POST aspire/_api/seeds

{
            
            "type": "smbhttp listener",
     "seed       "description": "myDirectory/levelTwohttp seed",
            "connector": "82f7f0a405c3d9c2-8d28db84-47ce4679-8c9dba27-e3ca414b0d31e6567c025318",
    "description        "seed": "FileSystem_Test_Seed/mySeed",
            "throttlePolicypriority": "6b8b5f23-fc77-47a1-9b58-106577162e7bmedium",
            "routingPolicieschecksum": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],"b49b56d39df5c5e9dee5d2e61f7bfa108744f427dc3e36f42855744929644a3b",
            "crawl": {
    "connection            "manager": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
manager_192.168.0.133:50505//AAABhJrwkqU=",
                "workflowsmode": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"full",
                "tagsphase": ["tag1idle",
 "tag2"],
               "state": "aborted",
         "properties       "start": {
1669046869073,
                "seedFileend": false1669049038795
            }
}

Update Seed

FieldRequiredDefaultMultipleNotesExampleidYes-NoID of the seed to update."2f287669-d163-4e35-ad17-6bbfe9df3778"seedNo-NoThe subdirectory to crawl. This value will be appended to the URL of the connection."myDirectory/levelTwo"descriptionNo-NoName of the seed object."MySMB"seedFileNofalseNoIf checked, the path will be processed as a file instead of a directory. WARNING: The crawler will only process the seed and then will stop.true /falseconnectorNo-NoThe ID of the connector to be used with this seed. The connector type must match the seed type."82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"connectionNo-NoThe ID of the connection to be used with this seed. The connection type must match the seed type."602d3700-28dd-4a6a-8b51-e4a663fe9ee6"workflowsNo[ ]YesThe IDs of the workflows that will be executed for the documents crawled.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]workflows.addNo[ ]YesThe IDs of the workflows to add.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]workflows.removeNo[ ]YesThe IDs of the workflows to remove.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]throttlePolicyNo-NoID of the throttle policy that applies to this connection object."f5587cee-9116-4011-b3a9-6b235b333a1b"routingPoliciesNo[ ]YesThe IDs of the routing policies that this seed will use.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]routingPolicies.addNo[ ]YesThe IDs of the routingPolicies to add.["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]routingPolicies.removeNo[ ]YesThe IDs of the routingPolicies to remove.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"]tagsNo[ ]YesThe tags of the seed. These can be used to filter the seed["tag1", "tag3"]tags.addNo[ ]YesThe tags to add["tag4"]tags.removeNo[ ]YesThe tags to remove["tag2"]

,
            "connection": "8338cc3e-ebfa-43c0-a976-fa6125555754",
            "properties": {
                "seed": "/mySeed"
            }
}

Update Seed

Example

Code Block

theme	RDark
title	PUT aspire/_api/seeds/2f28766946d736ee-d1633879-4e354a9f-ad1787d4-6bbfe9df377835f9821f06ec

{
            "id": "2f28766946d736ee-d1633879-4e354a9f-ad1787d4-6bbfe9df377835f9821f06ec",
            "type": "smbhttp listener",
            "seeddescription": "myDirectory/levelTwohttp seed",
            "connector": "82f7f0a405c3d9c2-8d28db84-47ce4679-8c9dba27-e3ca414b0d31e6567c025318",
       "description": "FileSystem_Test_Seed",
    "throttlePolicyseed": "6b8b5f23-fc77-47a1-9b58-106577162e7b/mySeed",
      "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
    "connectionpriority": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6medium",
    "workflows        "checksum": ["b255e950-1dac-46dc-8f86-1238b2fbdf27"b49b56d39df5c5e9dee5d2e61f7bfa108744f427dc3e36f42855744929644a3b", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],

      "tags": ["tag", "tag2"],
    "propertiescrawl": {
         "seedFile": false
       }
}

Create Credential

FieldRequiredDefaultMultipleNotesExampletypeYes-NoThe value must be "smb"."smb"descriptionYes-NoName of the credential object."smbCredential"domainNo-NoDomain of the account that will crawl the shared directory. If the user is a local account leave blank"WORKGROUP"usernameYes-NoAccount user"admin"passwordYes-NoAccount password"234dfc22re!?"

Example

Code Block

theme	RDark
title	POST aspire/_api/credentials

{
    "type": "smb"manager": "manager_192.168.0.133:50505//AAABhJrwkqU=",
                "mode": "full",
    "description            "phase": "SMB snapshotidle",
       "properties": {
        "usernamestate": "testaborted",
        "password        "start": "test1"1669046869073,
                "domainend":"WORKGROUP" 1669049038795
            }
}

Update Credential

FieldRequiredDefaultMultipleNotesExampletypeYes-NoThe value must be "smb"."smb"descriptionYes-NoName of the credential object."smbCredential"domainNo-NoDomain of the account that will crawl the shared directory. If the user is a local account leave blank"WORKGROUP"usernameYes-NoAccount user"admin"passwordNo-NoAccount password"234dfc22re!?"

Example

Code Block

theme	RDark
title	PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065

{
,
            "typeconnection": "smb8338cc3e-ebfa-43c0-a976-fa6125555754",
      "description": "SMB snapshot",
    "properties": {
        "username": "test",
        "passwordseed": "test1/mySeed",
        "domain":"WORKGROUP"
    }
}

Page tree

Versions Compared

Old Version 6

New Version Current

Key

Create Connection

Example

Update Connection

Example

Create Connector

Update Connector

Create Seed

Example

Update Seed

Update Seed

Example

Create Credential

Example

Update Credential

Example

Page tree

Page History

Versions Compared

Old Version 6

New Version Current

Key

Create Connection

Example

Update Connection

Example

Create Connector

Update Connector

Create Seed

Example

Update Seed

Update Seed

Example

Create Credential

Example

Update Credential

Example