The Elastic Cache Lookup component can be configured using the Aspire workflow section. It requires the following entities to be created.

Below are the examples of how to configure the component.

Easy Heading Free

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

Create Workflow

NOTE: Some options in the following table collapse or are displayed only when selecting other options, such as a checkbox or selects.

alternativesConnection SettingstextSpecify .

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 URL where the feeds are going to will be sendsent.	http://localhost:9200/bulk_
	Authentication	No	None	Yes	User with the permissions to read from the Elastic index specified.	none, basic, aws
	Index		Yes	-	No	The elastic index to crawl. Index name limitations: 1) Lowercase only. 2) Cannot include \\, \/, ?, \", <, >, \|, (space character), ,, # 3) Cannot start with -, _, + 4)	[{"index":"index1"}]
Idle connection timeoutnumber	Yes	3600000	No	Maximum time (in milliseconds) to keep an idle connection open.	3600000
Max connectionsnumber	Yes	100	No	Maximum number of connections to be opened.	100
Connections per targetnumber	Yes	10	No	Maximum number of connections opened for the same target.	10
Connection timeoutnumber	Yes	15000	No	Maximum time (in milliseconds) to wait for the connection.	15000
Socket timeoutnumber	Yes	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 periodnumber	Yes	5000	No	Time period (in milliseconds) to throttle the connection.	5000
Max connections per periodnumber	Yes	500	No	Maximum number of connections used during the throttling period.	500
Maximum retriesnumber	Yes	3	No	Maximum number of retries for a failed document.	3
Retry delaynumber	Yes	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)number	No	500	No	Specifies the maximum weight of entries the cache must contain.	500
Time (min)number	No	5	No	Remove records that have been idle for an amount of time in minutes.	Lookup Fields5
Index lookup field	Yes	-	No	Elastic index field name for the lookup	,	[{"index":"index1"}]
Source lookup fieldtext	Yes	-	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 valueboolean	No	true	No	Convert the value of the source field into UPPERCASE value.	FALSE
Lookup output fieldtext	Yes	-	No	Output fields from the lookup will be placed under this configured object.	myidOutput
Debugboolean	No	false	No	Option if you want debug messages enabled.	FALSE
Hit sizenumber	No	1000	No	Max mount of hits returned by the cache lookup. If -1 all hits will be returned.	1000

Example

NOTE: The following structure is not ordered by the sections of the component configuration, as found on the Elastic Cache Lookup App Bundle page

Code Block

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

{
    "description": "Elastic Cache Lookup",
    "properties": {
	 	"url": "http://localhost:9200",
        "authType": "none",
        "index": "index_name",
		"idleConnectionTimeout": 3600000,
        "maxConnections": 100,
        "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
"maxConnectionsPerRoute": 10,
        "connectionTimeout": 15000,
        "socketTimeout": 15000,
        "useThrottling": false,
        "maxRetries": 3,
        "descriptionretryWaitTime": "<Connector Name> Credential5000,
		"cache": true,
        "eviction": "size",
        "propertiesevictionMaxSize": {1000,
		"esIndexLookupField": "indexName",
        "sourceLookupField": "myid",
        "sourceLookupFieldToUpperCase": false,
        "lookupOutputField": "myidOutput",
        "debug": false,
        "size": 1000       
	}
}

Update

Connection

Workflow

Field	Required	Default	Multiple	Notes	Example
iddescription	Yes	-	No	Id Name of the connection to update	"89d6632a-a296-426c-adb0-d442adcab4b0",
description	No	-	No	Name of the connection object.	"MyImage RemovedConnection"
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

properties	Yes	-	No	Configuration object
component application.	"Elastic Cache Lookup"
properties	Yes	-	No	Configuration object
Server url	Yes	-	No	Complete URL where the feeds will be sent.	http://localhost:9200/bulk_
Authentication	No	None	Yes	User with the permissions to read from the Elastic index specified.	none, basic, aws
Index	Yes	-	No	The elastic index to crawl. Index name limitations: 1) Lowercase only. 2) Cannot include \\, \/, ?, \", <, >, \|, (space character), ,, # 3) Cannot start with -, _, + 4)	[{"index":"index1"}]
Idle connection timeout	Yes	3600000	No	Maximum time (in milliseconds) to keep an idle connection open.	3600000
Max connections	Yes	100	No	Maximum number of connections to be opened.	100
Connections per target	Yes	10	No	Maximum number of connections opened for the same target.	10
Connection timeout	Yes	15000	No	Maximum time (in milliseconds) to wait for the connection.	15000
Socket timeout	Yes	15000	No	Maximum time (in milliseconds) to wait for a socket response.	15000
Throttling period	Yes	5000	No	Time (in milliseconds) to throttle the connection.	5000
Max connections per period	Yes	500	No	Maximum number of connections used during the throttling period.	500
Maximum retries	Yes	3	No	Maximum number of retries for a failed document.	3
Retry delay	Yes	5000	No	Time (in milliseconds) to wait before a retry.	5000
Max number of entries	No	1000	No	Max total number of entries to keep in the cache.	1000
Max Total Weight (MB)	No	500	No	Specifies the maximum weight of entries the cache must contain.	500
Time (min)	No	5	No	Remove records that have been idle for an amount of time in minutes.	5
Index lookup field	Yes	-	No	Elastic index field name for the lookup,	[{"index":"index1"}]
Source lookup field	Yes	-	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	No	true	No	Convert the value of the source field into UPPERCASE value.	TRUE
Lookup output field	Yes	-	No	Output fields from the lookup will be placed under this configured object.	myidOutput
Debug	No	false	No	Option if you want debug messages enabled.	TRUE
Hit size	No	1000	No	Max mount of hits returned by the cache lookup. If -1 all hits will be returned.	1000

Example

Code Block

theme	RDark

{
    "description": "Elastic Cache Lookup",
    "properties": {
	 	"url": "http://localhost:9200",
        "authType": "none",
        "index": "index_name",
		"idleConnectionTimeout": 3600000,
        "maxConnections": 100,
        "maxConnectionsPerRoute": 10,
        "connectionTimeout": 15000,
        "socketTimeout": 15000,
        "useThrottling": true,
        "maxRetries": 3,
        "retryWaitTime": 5000,
		"cache": true,
        "eviction": "size",
        "evictionMaxSize": 1000,
		"esIndexLookupField": "indexName",
        "sourceLookupField": "myid",
        "sourceLookupFieldToUpperCase": true,
        "lookupOutputField": "myidOutput",

Code Block

theme	RDark

{
    "id": "89d6632a-a296-426c-adb0-d442adcab4b0",
    "description": "<Connector Name> Test Connector",
    "properties": {
        "debug": true,
        "size": 1000       
	}
}

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Create Workflow

Example

Update

Workflow

Example

Example

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

Create Workflow

Example

Update

Workflow

Example

Example