ElasticSearch Connector for O11 - Documentation (O11)

Stable version 1.0.0 (Compatible with OutSystems 11)

Uploaded

on 17 Mar (yesterday)

OutSystems Labs

0.0

(0 ratings)

Documentation

1.0.0

In your Outsystems 11 module, add a reference to "Elastic Search connector" (ElasticSearch_IS) and include the references to the features listed below.

In the site properties of module ElasticSearch_IS, you will have to configure the following site properties:

- "Elastic Search API Key": (Created in Kibana in your Elastic Search Deployment)

- "Elastic Search URL": (Also copied from the main screen in Kibana in your Elastic Search Deployment)

- Remaining site properties are defaults unless for debugging. ("DEBUG")

For improved setup tips with screen and numerous code examples utilizing the complete feature set detailed below, refer to the companion application "Elastic Search Sandbox."

Index Management:
- GetListOfIndexes: Retrieves a list of indices, with an optional name prefix filter.
- CreateIndex: Inserts a new index (indice) into Elasticsearch.
- IndexAliasAdd: Assigns an alias to an existing index.
- IndexAliasRemove: Removes an existing alias from an index.
- ReindexData: Copies data from a source index to a newly created index, initiating an asynchronous task.
- GetTaskStatusByID: Retrieves the status of a specific asynchronous task using its ID (returned by `ReindexData`).
- DeleteTaskByID: Deletes and cancels a specific asynchronous task using its ID (returned by `ReindexData`).
- DeleteIndex: Deletes an index, its configurations, and its associated records (documents).
Data Upload to Index:
- BulkInsert: Inserts multiple records simultaneously (in bulk) into an index.
CRUD Operations for Index Records:
- CreateRecord: Inserts a new record (document) into an index and returns the ID of the record created.
- CreateRecordById: Inserts a new record (document) into an index with a specified ID.
- GetRecordById: Retrieves a specific record (document) by its ID.
- UpdateRecordById: Updates a specific record (document) by its ID on the Elasticsearch server.
- DeleteRecordById: Deletes a specific record (document) from the Elasticsearch server using its ID.
High-Performance Search (Similarity and Fuzzy):
- GetRecordsByQuery: Retrieves a list of records based on a single search query.
- GetRecordsByMQueries: Retrieves a list of records from a set of queries executed in a batch (multiple searches on request).
Similarity Scoring:
- StoreFunctionScoreScript: Sends and stores a custom function score script to Elasticsearch. This script can be referenced in DSL Search Queries to override the default similarity score and return custom results in the `_score` tag of each record, ranking similarity between the search query and the returned results.

ODC for Professional Services

Paulo Ribeiropaulo.cunha.ribeiro@outsystems.com

Profile

Change password

Dark theme: On

Logout

See documentation

Support

Give feedbac

In your Outsystems 11 module, add a reference to "Elastic Search connector" (ElasticSearch_IS) and include the references to the features listed below.

In the site properties of module ElasticSearch_IS, you will have to configure the following site properties:

- "Elastic Search API Key": (Created in Kibana in your Elastic Search Deployment)

- "Elastic Search URL": (Also copied from the main screen in Kibana in your Elastic Search Deployment)

- Remaining site properties are defaults unless for debugging. ("DEBUG")

For improved setup tips with screen and numerous code examples utilizing the complete feature set detailed below, refer to the companion application "Elastic Search Sandbox."

Index Management:
- GetListOfIndexes: Retrieves a list of indices, with an optional name prefix filter.
- CreateIndex: Inserts a new index (indice) into Elasticsearch.
- IndexAliasAdd: Assigns an alias to an existing index.
- IndexAliasRemove: Removes an existing alias from an index.
- ReindexData: Copies data from a source index to a newly created index, initiating an asynchronous task.
- GetTaskStatusByID: Retrieves the status of a specific asynchronous task using its ID (returned by `ReindexData`).
- DeleteTaskByID: Deletes and cancels a specific asynchronous task using its ID (returned by `ReindexData`).
- DeleteIndex: Deletes an index, its configurations, and its associated records (documents).
Data Upload to Index:
- BulkInsert: Inserts multiple records simultaneously (in bulk) into an index.
CRUD Operations for Index Records:
- CreateRecord: Inserts a new record (document) into an index and returns the ID of the record created.
- CreateRecordById: Inserts a new record (document) into an index with a specified ID.
- GetRecordById: Retrieves a specific record (document) by its ID.
- UpdateRecordById: Updates a specific record (document) by its ID on the Elasticsearch server.
- DeleteRecordById: Deletes a specific record (document) from the Elasticsearch server using its ID.
High-Performance Search (Similarity and Fuzzy):
- GetRecordsByQuery: Retrieves a list of records based on a single search query.
- GetRecordsByMQueries: Retrieves a list of records from a set of queries executed in a batch (multiple searches on request).
Similarity Scoring:
- StoreFunctionScoreScript: Sends and stores a custom function score script to Elasticsearch. This script can be referenced in DSL Search Queries to override the default similarity score and return custom results in the `_score` tag of each record, ranking similarity between the search query and the returned results.

In your Outsystems 11 module, add a reference to "Elastic Search connector" (ElasticSearch_IS) and include the references to the features listed below.

In the site properties of module ElasticSearch_IS, you will have to configure the following site properties:

- "Elastic Search API Key": (Created in Kibana in your Elastic Search Deployment)

- "Elastic Search URL": (Also copied from the main screen in Kibana in your Elastic Search Deployment)

- Remaining site properties are defaults unless for debugging. ("DEBUG")

For improved setup tips with screen and numerous code examples utilizing the complete feature set detailed below, refer to the companion application "Elastic Search Sandbox."

Index Management:
- GetListOfIndexes: Retrieves a list of indices, with an optional name prefix filter.
- CreateIndex: Inserts a new index (indice) into Elasticsearch.
- IndexAliasAdd: Assigns an alias to an existing index.
- IndexAliasRemove: Removes an existing alias from an index.
- ReindexData: Copies data from a source index to a newly created index, initiating an asynchronous task.
- GetTaskStatusByID: Retrieves the status of a specific asynchronous task using its ID (returned by `ReindexData`).
- DeleteTaskByID: Deletes and cancels a specific asynchronous task using its ID (returned by `ReindexData`).
- DeleteIndex: Deletes an index, its configurations, and its associated records (documents).
Data Upload to Index:
- BulkInsert: Inserts multiple records simultaneously (in bulk) into an index.
CRUD Operations for Index Records:
- CreateRecord: Inserts a new record (document) into an index and returns the ID of the record created.
- CreateRecordById: Inserts a new record (document) into an index with a specified ID.
- GetRecordById: Retrieves a specific record (document) by its ID.
- UpdateRecordById: Updates a specific record (document) by its ID on the Elasticsearch server.
- DeleteRecordById: Deletes a specific record (document) from the Elasticsearch server using its ID.
High-Performance Search (Similarity and Fuzzy):
- GetRecordsByQuery: Retrieves a list of records based on a single search query.
- GetRecordsByMQueries: Retrieves a list of records from a set of queries executed in a batch (multiple searches on request).
Similarity Scoring:
- StoreFunctionScoreScript: Sends and stores a custom function score script to Elasticsearch. This script can be referenced in DSL Search Queries to override the default similarity score and return custom results in the `_score` tag of each record, ranking similarity between the search query and the returned results.