Skip to main content

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

Elasticsearch Component - Advanced Scenarios

These are the actions, and parameters required for advanced use cases when using the Elasticsearch Mobile or Elasticsearch Web components.

Get Record by ID

Server_action.png GetRecordById (Server Action) Gets a specific record by ID.
Input.png ElasticsearchURL (Text) URL to access the Elasticsearch server.
Input.png RecordId (Text) ID of the record that you want to match. 
Output.png ElasticsearchRecord (ElasticsearchRecord structure) Records values returned from the Elasticsearch server.
Output.png Success (Boolean) Returns False whenever an error occurs.
Output.png ErrorMessage (Text) Returns the error message when an error occurs.

Delete Index

Server_action.png DeleteIndex (Server Action) Deletes an index, all the types inside it and its records.
Input.png ElasticsearchURL (Text) URL to access the Elasticsearch server.
Input.png Index (Text) First level of indexation. 
Output.png Success (Boolean) Returns False whenever an error occurs.
Output.png ErrorMessage (Text) Returns the error message when an error occurs.

Delete Record by ID

Server_action.png DeleteRecordById (Server Action) Deletes a specific record from the Elasticsearch server. Older versions of Elasticsearch may not support this.
Input.png ElasticsearchURL (Text) URL to access the Elasticsearch server.
Input.png RecordId (Text) ID of the record that you want to get data from. 
Output.png Success (Boolean) Returns False whenever an error occurs.
Output.png ErrorMessage (Text) Returns the error message when an error occurs.

Bulk Insert

Server_action.png BulkInsert (Server Action) Allows inserting multiple records.
Input.png ElasticsearchURL (Text) URL to access the Elasticsearch server.
Input.png Index (Text) First level of indexation. 
Input.png Type (Text) Second level of indexation.
Input.png ElasticsearchRecordList (ElasticsearchRecord structure list) List of record values to be stored in the Elasticsearch server.
Output.png Success (Boolean) Returns False whenever an error occurs.
Output.png RecordIdList (Text list) Returns a list of IDs that were inserted in the server.
Output.png ErrorMessage (Text) Returns the error message when an error occurs.

Bulk Update

Server_action.png BulkUpdate (Server Action) Allows updating multiple records.
Input.png ElasticsearchURL (Text) URL to access the Elasticsearch server.
Input.png ElasticsearchRecordList (ElasticsearchBulkRecord structure list) List of record values to be stored in the Elasticsearch server.
Output.png Success (Boolean) Returns False whenever an error occurs.
Output.png RecordIdList (Text list) Returns a list of IDs that were inserted in the server.
Output.png ErrorMessage (Text) Returns the error message when an error occurs.

 

  • Was this article helpful?