Page History
Create Workflow
Field | Required | Default | Multiple | Notes | Example | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| description | Yes | - | No | Name of the component application. | "Elastic Cache Lookup" | |||||||||
| properties | Yes | - | No | Configuration object | ||||||||||
| Elasticsearch Settings | Server url | textYes | - | No | Complete Url where the feeds are going to be send. | http://localhost:9200/bulk_ | ||||||||
| Authentication | No | alternativesNone | Yes | User with the permissions to read from the Elastic index specified. | none, basic, aws | |||||||||
| Index | Connection SettingsYes | - | No | The elastic index to use. | index_name | |||||||||
| Idle connection timeout | numberYes | 3600000 | No | Maximum time (in milliseconds) to keep an idle connection open. | 3600000 | |||||||||
| Max connections | numberYes | 100 | No | Maximum number of connections to be opened. | 100 | |||||||||
| Connections per target | numberYes | 10 | No | Maximum number of connections opened for the same target. | 10 | |||||||||
| Connection timeout | numberYes | 15000 | No | Maximum time (in milliseconds) to wait for the connection. | 15000 | |||||||||
| Socket timeout | numberYes | 15000 | No | Maximum time (in milliseconds) to wait for a socket response. | Connection throttling | boolean | false | Checkbox to choose the enable connection throttling.15000 | ||||||
| Throttling period | numberYes | 5000 | No | Time period (in milliseconds) to throttle the connection. | 5000 | |||||||||
| Max connections per period | numberYes | 500 | No | Maximum number of connections used during the throttling period. | 500 | |||||||||
| Maximum retries | numberYes | 3 | No | Maximum number of retries a failed document. | 3 | |||||||||
| Retry delay | numberYes | 5000 | No | Time (in milliseconds) to wait before a retry. | Cache | Use cache | alternatives | true | Results should be cached in memory. | Cache Eviction Policy | alternatives | size | How items should be selected for being deleted from the in-memory cache. | 5000 |
| Max number of entriesnumber | No | 1000 | No | Max total number of entries to keep in the cache. | 1000 | |||||||||
| Max Total Weight (MB) | numberNo | 500 | No | Specifies the maximum weight of entries the cache must contain. | 500 | |||||||||
| Time (min) | numberNo | 5 | No | Remove records that have been idle for an amount of time in minutes. | Lookup Fields5 | |||||||||
| Index lookup field | textYes | - | SpecifyNo | Elastic index field name for the lookup | ., | index_name | ||||||||
| Source lookup field | textYes | - | No | Specify field name from the incoming AspireObject for the lookup. Field availability will be searched first in 'doc' and then in 'doc.connectorSpecific' section. | myid | |||||||||
| Uppercase the source lookup field value | booleanNo | true | No | Convert the value of the source field into UPPERCASE value. | false | |||||||||
| Lookup output field | textYes | - | No | Output fields from the lookup will be placed under this configured object. | myidOutput | |||||||||
| Debug | booleanNo | false | No | Option if you want debug messages enabled. | false | |||||||||
| Hit size | numberNo | 1000 | No | Max mount of hits returned by the cache lookup. If -1 all hits will be returned. | 1000 |
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
"description": "<Connector Name> Credential",
"properties": {
}
} |
Update Connection
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
| description | No | - | No | Name of the connection object. | "My |
| 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 connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| properties | Yes | - | No | Configuration object | |
Example
| Code Block | ||
|---|---|---|
| ||
{
"id": "89d6632a-a296-426c-adb0-d442adcab4b0",
"description": "<Connector Name> Test Connector",
"properties": {
}
} |
Overview
Content Tools