| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Click on Settings Menu → Pipeline Groups
Click “Create New” Button on the bottom of the right pane
Type the Name of the Service Provider
Click SAVE button
...
Part II - Notifications
“Notifications” Tab will be visible after completing details in Part I
Add Email address where to receive notifications (success or failure)
Add Data items (e.g. order ID, SKU, etc) to include into notifications.
The syntax for referencing ‘data items’ should be: { $.trigger.data.abc.def },
where abc.def are the object properties in the request body.
e.g. Name: SKU Data path: {$.trigger.data.inventory_item_id}
Click SAVE button
...
Add Client Credentials
Some Service Providers requires unique credentials for each client which are configured based on credential Type.
...
| Info |
|---|
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) |
Click SAVE button
Create Client 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.
Click on Settings Menu → Endpoints
If this menu is not visible, zoom out the window to see all sub-menus is SETTINGS
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
...
Add Service Provider Credentials
Click on Settings Menu → Service Provider Credentials
If this menu is not visible, zoom out the window to see all sub-menus is SETTINGS
Click Create New + icon
Select Service Provider
Select Endpoint
Select Credentials
Click SAVE button
...
Set Up Client Task Group (optional)
Task Group is a template of action steps that can be used in creating pipelines for easier configuration.
Once Task Group is created, it will become one of the Task Type or Action Step option in creating Pipeline.
Click on Settings Menu → Task Groups
Task Group Menu is only available for Admin account
Click “Create New” Button on the bottom of the right pane
Type the Name of the Task Group and Click SAVE button
Configure Pipeline by clicking the Pipeline Edit field
Add Pipeline Action Steps
Click SAVE button
Click EXPORT Button to Export a Task Group in .json file
Click IMPORT Button to copy file
...
Set Up Pipelines
Part I - Pipeline Details
...
Toggle “IsActive” to enable (YES) and disable (NO) a Pipeline
Click SAVE button
Select Pipeline Group (optional)
Configure TRIGGER then SAVE
Configure PIPELINE then SAVE
Scriban is a scripting languange and a versatile tool for creating dynamic messages and content in applications.
Here is a Scriban Tutorial.
SEE More Examples here: https://seko.atlassian.net/wiki/pages/resumedraft.action?draftId=2982740027&draftShareId=a39bb7ab-7821-4545-90a9-087806cdeee0
Import and Export a Pipeline
Enable user to export/import pipelines from one client to another and from one environment (UAT → Live) to another.
Click IMPORT Button and select a file to import
...
tClick EXPORT Button to Export a Pipeline in .json file
...
Part II - Pipeline Variables
...
Client variables are accessible across all pipelines for a client, allowing shared values between multiple pipelines.
Fill in Variable Name and Value. Specify the requirements based on the pipeline’s function.
Click SAVE button
Repeat steps if needed
Part III - Notifications (optional)
“Notifications” Tab will be visible after completing details in Part II
Add Email address where to receive notifications (success or failure)
Add Data items (e.g. order ID, SKU, etc) to include into notifications.
The syntax for referencing ‘data items’ should be: { $.trigger.data.abc.def },
where abc.def are the object properties in the request body.
e.g. Name: SKU object: inventory_item_id
Data path: {$.trigger.data.inventory_item_id}
...
Click on Pipeline Runs Menu to Monitor History and execution of Pipelines
Use search Filters and click “APPLY” button
Click “VIEW” button to Check errors and View details of activity
Activity will show Green
if successful or Red X if failed
...