ElasticSearch Connector for Azure Data Factory (SSIS) How to Make Generic API Request
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- ODBC PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Make Generic API Request in SSIS
-
Begin with opening Visual Studio and Create a New Project.
-
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled ElasticSearch Connector from Popular Connector List or press Search Online radio button to download ElasticSearch Connector. Once downloaded simply use it in the configuration:
ElasticSearch -
Now it's time to configure authentication. Firstly, configure authentication settings in ElasticSearch service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:
ElasticSearch authentication
For Local / Hosted Instance by you
- Get your userid / password and enter on the connection UI
For Managed Instance (By Bonsai search)
If your instance is hosted by bonsai then perform these steps to get your credentials for API call- Go to https://app.bonsai.io/clusters/{your-instance-id}/tokens
- Copy Access Key and Access Secret and enter on the connection UI. Click Test connection.
- If your Cluster has no data you can generate sample data by visiting this URL and click Add Sample Data https://{your-cluster-id}.apps.bonsaisearch.net/app/home#/tutorial_directory
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Basic Authentication (UserId/Password) [Http]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ElasticSearchBasic Authentication (UserId/Password) [Http]http://localhost:9200Optional Parameters User Name (or Access Key) Password (or Access Secret) Ignore certificate related errors ElasticSearch authentication
No instructions available.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Windows Authentication (No Password) [Http]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ElasticSearchWindows Authentication (No Password) [Http]http://localhost:9200Optional Parameters Ignore certificate related errors -
Select Generic Table (Bulk Read / Write) table from the dropdown and hit Preview Data:
API Source - ElasticSearchRead / write ElasticSearch data inside your app; perform many ElasticSearch operations without coding, just use easy to use high performance API Connector for ElasticSearchElasticSearchGeneric Table (Bulk Read / Write)Required Parameters HTTP - Url or File Path Fill-in the parameter... HTTP - Request Method Fill-in the parameter... Optional Parameters HTTP - Request Body HTTP - Is MultiPart Body (Pass File data/Mixed Key/value) HTTP - Request Format (Content-Type) ApplicationJson HTTP - Headers (e.g. hdr1:aaa || hdr2:bbb) Accept: */* || Cache-Control: no-cache Parser - Response Format (Default=Json) Default Parser - Filter (e.g. $.rows[*] ) Parser - Encoding Parser - CharacterSet Download - Enable reading binary data False Download - File overwrite mode AlwaysOverwrite Download - Save file path Download - Enable raw output mode as single row False Download - Raw output data RowTemplate {Status:'Downloaded'} Download - Request Timeout (Milliseconds) General - Enable Custom Search/Replace General - SearchFor (e.g. (\d)-(\d)--regex) General - ReplaceWith (e.g. $1-***) General - File Compression Type General - Date Format General - Enable Big Number Handling False General - Wait time (Ms) - Helps to slow down pagination (Use for throttling) 0 JSON/XML - ExcludedProperties (e.g. meta,info) JSON/XML - Flatten Small Array (Not preferred for more than 10 items) JSON/XML - Max Array Items To Flatten 10 JSON/XML - Array Transform Type JSON/XML - Array Transform Column Name Filter JSON/XML - Array Transform Row Value Filter JSON/XML - Array Transform Enable Custom Columns JSON/XML - Enable Pivot Transform JSON/XML - Array Transform Custom Columns JSON/XML - Pivot Path Replace With JSON/XML - Enable Pivot Path Search Replace False JSON/XML - Pivot Path Search For JSON/XML - Include Pivot Path False JSON/XML - Throw Error When No Match for Filter False JSON/XML - Parent Column Prefix JSON/XML - Include Parent When Child Null False Pagination - Mode Pagination - Attribute Name (e.g. page) Pagination - Increment By (e.g. 100) 1 Pagination - Expression for Next URL (e.g. $.nextUrl) Pagination - Wait time after each request (milliseconds) 0 Pagination - Max Rows Expr Pagination - Max Pages Expr Pagination - Max Rows DataPath Expr Pagination - Max Pages 0 Pagination - End Rules Pagination - Next URL Suffix Pagination - Next URL End Indicator Pagination - Stop Indicator Expr Pagination - Current Page Pagination - End Strategy Type DetectBasedOnRecordCount Pagination - Stop based on this Response StatusCode Pagination - When EndStrategy Condition Equals True Pagination - Max Response Bytes 0 Pagination - Min Response Bytes 0 Pagination - Error String Match Pagination - Enable Page Token in Body False Pagination - Placeholders (e.g. {page}) Pagination - Has Different NextPage Info False Pagination - First Page Body Part Pagination - Next Page Body Part Csv - Column Delimiter , Csv - Has Header Row True Csv - Throw error when column count mismatch False Csv - Throw error when no record found False Csv - Allow comments (i.e. line starts with # treat as comment and skip line) False Csv - Comment Character # Csv - Skip rows 0 Csv - Ignore Blank Lines True Csv - Skip Empty Records False Csv - Skip Header Comment Rows 0 Csv - Trim Headers False Csv - Trim Fields False Csv - Ignore Quotes False Csv - Treat Any Blank Value As Null False Xml - ElementsToTreatAsArray -
That's it! We are done! Just in a few clicks we configured the call to ElasticSearch using ElasticSearch Connector.
You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
More actions supported by ElasticSearch Connector
Learn how to perform other actions directly in Azure Data Factory (SSIS) with these how-to guides:
- Count documents
- Create Index
- Delete documents
- Delete Index
- Get document by ID from Index or Alias
- Get documents from Index or Alias
- Get Index or Alias metadata
- Insert documents
- List aliases
- List indexes
- Search / Query documents
- Update documents
- Upsert documents
- Make Generic API Request (Bulk Write)