Log In to iHub Site
Test Environment: https://ihub-uat.seko360.com/
Live Environment: https://ihub.seko360.com
Select Admin in the Header dropdown (for multiple Identities)
Service Providers Menu
Create Service Provider
A Service Provider refers to the internal or 3rd party service that your pipeline interacts with. This could be a database, an API, a cloud service, or any other external resource that your pipeline needs to communicate with to perform its tasks. The Service Provider is responsible for handling the requests and providing the necessary responses or data.
Click on Service Providers Menu → Service Provider Setup
Click “Create New” Button on the bottom of the right pane
Type the Name of the Service Provider
Click SAVE button
Create Credentials
Credentials, which include usernames, passwords, API keys, tokens, or other forms of authentication, are essential for accessing the Service Provider. For some Service Providers, a single set of credentials is used for all clients, as seen with iHub. In contrast, other Service Providers require unique credentials for each client, which are configured on the user’s site.
Click on Service Providers Menu → Credentials
Click “Create New” Button on the bottom of the right pane
Type the Name of the Credentials (for the Service Provider)
Select Authentication Type and Fill in details/data needed
Authentication details may vary depending on Credential Type:
*Generate Access Token or API keys for 3rd party apps like Shopify (Generic Http)
*Add service ID (Generic Http)
*Add username and password (Basic Http)
* Add connection string ( for SQL/database)
The list of Type options is hardcoded. Adding a new option requires development.
Click SAVE button
Create Endpoints
Endpoints are specific URLs or network addresses where the Service Provider can be accessed. They serve as entry points for the pipeline to interact with the external service.
HTTP endpoints are used to interact with web services over the HTTP or HTTPS protocols. These endpoints allow your pipeline to send and receive data through web requests, making them ideal for integrating with RESTful APIs, SOAP services, and other web-based services.
SQL endpoints are used to interact with SQL databases. These endpoints allow your pipeline to execute SQL queries, retrieve data, and perform database operations directly.
Click on Service Providers Menu → Endpoints
Click “Create New” Button on the bottom of the right pane
Type the Name of the Endpoint
Select Type Value (HTTP or SQL)
Select Provider
Type HOST (Domain for HTTP or Server endpoint for a SQL)
Select Default Credentials
Click SAVE button
Create Services
Services in pipelines are the specific functionalities or tasks that the pipeline performs using the Service Provider.
These can include data retrieval, data processing, API calls, database queries, and more. Each service is a distinct operation that the pipeline executes as part of its workflow.
Part I - Add Details
Click on Service Providers Menu → Services
Click “Create New” Button on the bottom of the right pane
Type the Name of the Service
Select Type Value (HTTP or SQL)
Select Service Provider
Select Direction (Inbound or Outbound)
Inbound direction refers to data coming into the system.
Outbound direction refers to data going out of the system.
Click SAVE button
Part II - Create Configuration Versions/Mapping
“Versions” Tab will be visible after completing details in Part I
Type Version Name
Select Type
Create Input and Output schema
Input schema specifies the structure of the data that a service or system expects to receive. It defines the required fields, data types, and any validation rules that the incoming data must adhere to.
Output schema defines the structure of the data that a service or system will produce and send back as a response. It ensures that the response data is formatted correctly and contains all the necessary information.
For HTTP Service type like Shopify, use webhooks or API calls in JSON format
(See Sample 1 & 1a)
Sample 1:
For SQL Service Type like Seko systems (DCM, TMS, WMS, DMS, PSMS) specify the list of fields you use as a source for SP parameters or the Service Definition (See Sample here)
Part III - Trigger Configuration
Click “Configure Task” or “Configure Trigger” button
Select Type
Select Credentials (optional) and Method (required)
Input Path where to send or receive Data
Toggle “Wait for Confirmation” to Yes or No
If toggled ‘Yes’, your request waits for the pipeline to complete to receive the result.
If toggled ‘No’, you receive an instant response and won’t wait for the pipeline to complete.
Click SAVE button to save configuration
Click SAVE button to save the version
Sample 1a
HTTP Type methods:
POST: Used to send data to a server to create or update a resource. Data is sent in the body of the request, not in the URL.
GET: It retrieves data from a server. Data is sent in the URL, often as query parameters
For SQL Service Type like Seko systems (DCM, TMS, WMS, DMS, PSMS) Add the Stored procedure parameters to call from the database (See Sample here)
Pipeline Templates Menu
Templates are pre-defined pipelines which follow the same structure that can be reused for different Clients. This reduces errors and saves time and effort, as you don’t have to start from scratch each time.
Create Pipeline Template
Click on Pipeline Templates Menu
Click “Create New” Button on the bottom of the right pane
Add Pipeline Name
Configure TRIGGER then click SAVE button
A trigger is a mechanism that initiates the execution of a pipeline based on specific events or conditions.
Configure PIPELINE then click SAVE button
Pipeline action steps are the individual tasks or actions that are executed as part of a pipeline. These steps define the specific operations that need to be performed, such as building code, running tests, deploying applications, or any other automated tasks.
SAVE the Template
See Also: https://seko.atlassian.net/wiki/x/OwDJsQ