Page History
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 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 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 using XSLT 2.0 files. | false |
| xsltFileName | Yes | - | No | The path of the XSL transform file to be used to format the output XML. 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 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 | ||||
|---|---|---|---|---|
| ||||
{
"type": "http listener",
"description": "http listener connection",
"properties": {
"Content": true,
"multipart": "file",
"fileHandler": "file",
"uploadDir": "/config/xsl",
"transform": true,
"xsltFileName": "/config/xsl/executor.xsl",
"saxonProcessor": false,
"outputMime": "text/xml",
"jobMime": false,
"headers": [
{
"headerName": "Connection",
"headerValue": "keep-alive"
},
{
"headerName": "Access-Control-Allow-Origin",
"headerValue": "*"
}
],
"maxUploadSize": 1000000,
"debugOutFile": ""
}
} |
Update Connection
Example
| Code Block | ||
|---|---|---|
| ||
{
"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 Seed
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| seed | Yes | - | No | Endpoint name | "submitFiles" |
| type | Yes | - | No | The value must be "http listener". | "http listener" |
| description | Yes | - | No | Name of the seed object. | "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 | ||||
|---|---|---|---|---|
| ||||
{
"type": "http listener",
"description": "http seed",
"connector": "05c3d9c2-db84-4679-ba27-e6567c025318",
"seed": "/mySeed",
"priority": "medium",
"checksum": "b49b56d39df5c5e9dee5d2e61f7bfa108744f427dc3e36f42855744929644a3b",
"crawl": {
"manager": "manager_192.168.0.133:50505//AAABhJrwkqU=",
"mode": "full",
"phase": "idle",
"state": "aborted",
"start": 1669046869073,
"end": 1669049038795
},
"connection": "8338cc3e-ebfa-43c0-a976-fa6125555754",
"properties": {
"seed": "/mySeed"
}
} |
Update Seed
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": "46d736ee-3879-4a9f-87d4-35f9821f06ec",
"type": "http listener",
"description": "http seed",
"connector": "05c3d9c2-db84-4679-ba27-e6567c025318",
"seed": "/mySeed",
"priority": "medium",
"checksum": "b49b56d39df5c5e9dee5d2e61f7bfa108744f427dc3e36f42855744929644a3b",
"crawl": {
"manager": "manager_192.168.0.133:50505//AAABhJrwkqU=",
"mode": "full",
"phase": "idle",
"state": "aborted",
"start": 1669046869073,
"end": 1669049038795
},
"connection": "8338cc3e-ebfa-43c0-a976-fa6125555754",
"properties": {
"seed": "/mySeed"
}
} |
Overview
Content Tools