Skip to main content

Concept Definitions

Project: Represents each brand to be integrated.

Integration Flow: Represents each integration process enabling all relevant activities (data reading, data conversion, data writing, etc.) to be executed end-to-end.

Flow Name: Represents the user-specified name for each Integration Flow. (Flow names must be unique with a maximum length of 20 characters.)

Integration Type: Represents specifying which direction the integration flows will take (where data will be received and where it will be forwarded). There are two integration types in the application: “Inbound” and “Outbound.”

Inbound (Integration Type): The integration type to be used if the data reading query of the integration is thrown through the Akinon Integrator application.

Outbound (Integration Type): The integration type to be used if the integration data is to be posted to the Akinon Integrator application at periods to be determined on the ERP.

Schedule: (Valid for “Inbound” integration only.) Determines the timing of the data reading query to be thrown within the integration. There are three different timing options in the application: “Repeat Every,” “Cron Driven” and “Triggered By.”

Repeat Every (Schedule): Used to set a timer that will repeat at a fixed interval. (E.g. once every 2 seconds, every 3 minutes, every 5 hours, or once in 7 days)

Cron Driven (Schedule): Used to set a timer that will repeat more than once and at various intervals. (e.g. every day at 12:00 and 18:00, every hour between 09:00 and 18:00)

Triggered By (Schedule): Used to set up a timer that is triggered by the schedule of a different flow.

Alarm Condition: It is the area where the necessary conditions are defined to give a warning if the performance of the integration flow goes beyond the determined limits. There are two different performance metrics used to determine the warning conditions in the application: “Error Rate” and “Avr. Flow Time.”

Error Rate (Alarm Condition): Calculated based on the ratio of faulty transactions in all integration flows (running within the relevant time period) to the total number of transactions.

Avr. Flow Time (Alarm Condition): Calculated based on the average time elapsed between the start-end times of all integration flows (running within the relevant time period).

Alarm Type: It is the area where the necessary conditions are defined to give a warning if the performance of the integration flow goes beyond the determined limits. There are two different performance metrics used to determine the warning conditions in the application: “Error Rate” and “Avr. Flow Time.”

Alarm Date: It represents the date of occurrence if the performance of the integration flow goes beyond the determined limits.

Alarm Description: Displays the percentage or duration for exceeded integration flow performance depending on the selected time period of the relevant alarm type.

Last Run Time: Displays the last run date and time that the relevant integration flow worked.

Last 5 Flow Exec. Status: Displays the last five execution statuses of the integration flow.

Success Rate: Displays the ratio of successful transactions in the relevant integration flow to the total number of transactions within the selected time period.

Average Process Flow Time: Shows the run time of the relevant integration flow within the selected time period.

Total Error Count: Displays the total number of failed transactions in the relevant integration flow within the selected time period.

Partner Role: User role that has the authority to view and make changes to all fields within the Akinon Integrator application.

Project Role: User role authorized by the partner user for designated projects in the Akinon Integrator application to view and alter particular pages.

Viewer Role: User role authorized by the partner user for designated projects in the Akinon Integrator application. This role is permitted to view certain pages but cannot alter any page in the application.

Log: Records processed in detail for each operation of the integration flow.

Operator Name: Represents the user triggering the integration flow. It is displayed as Operator Name: System for flows that run automatically within certain time periods. It is displayed as the relevant username for flows triggered manually by the user on the test screens.

Run Time: Represents the run time of a flow.

Status: Represents the latest status (success, waiting, failed) of a flow.

Process-Based Status: Represents the latest status of each sub-flow within a flow. Green: Success, Red: Failed, Orange: Waiting

Transaction-Based Error: Represents the ratio of faulty transactions in the total number of transactions of a flow. Even if flow is completed end-to-end, some relevant transactions may not be completed due to errors in different sub-flows. Accordingly, the number of faulty transactions is displayed separately in successfully completed flows.

Last Run Status: Represents the latest run status (success, waiting, failed) of each integration flow.

Last Run Execution ID: Represents the last run execution ID of each integration flow.

Flow Type: Represents integration types. There are thirteen integration types in the application;

1- Omnitron Login (Flow Type):

Integration flow type used to grant authentication on the client’s Omnitron system.

  • Omnitron Login (Flow Activity Settings):
    • URL : Represents the URL of the user’s Omnitron.
    • Username : Represents the name of the user’s Omnitron User.
    • Password: Represents to the password of the user’s Omnitron User.

2- Login (Flow Type):

Integration flow type used to grant authentication on the client’s ERP/Remote system or Omnitron.

  • Login (Flow Activity Settings)
  • Login Type (bscauth):
    • URL : Represents the URL of the user’s ERP/Remote system or Omnitron.
    • Username : Represents the name of the user’s ERP/Remote system or Omnitron User.
    • Password: Represents to the password of the user’s ERP/Remote system or Omnitron User.
  • Login Type (jwtauth):
    • URL : Represents the URL of the user’s ERP/Remote system or Omnitron.
    • Username : Represents the name of the user’s ERP/Remote system or Omnitron User.
    • Password: Represents to the password of the user’s ERP/Remote system or Omnitron User.
    • Header Key: Authentication key to be added to the header in requests to be sent (e.g.: Authentication)
    • Token Path : The path of the Token key in the returned response. (e.g.: \$.Token , \$.Bearer, \$.Key)
    • Token Prefix: Token key. (e.g.: Token, Baerer, Key)
  • Login Type (outh2):
    • Grant Type:
      • Authorization Code:
        • Code: Authorization code given by ERP/Remote system.
      • Password Grant:
        • Basic Auth Username: If this field is filled, username will be sent in the header as Base64 encoded.
        • Basic Auth Password: If this field is filled, password will be sent in the header as Base64 encoded.
      • Client Credentials: Client ID and Client Secret are being used as mandatory fields.
    • Send payload with form data: If it is selected as True, "application/x-www-form-urlencoded" will be used, If it is selected as False, it will use "application/json" as Content-type header parameter.
    • URL : Represents the URL of the user’s ERP/Remote system or Omnitron.
    • Client ID: Client ID given by ERP/Remote system.
    • Client Secret: Client Secret given by ERP/Remote system.
    • Scope(Optional): Scope parameter given by ERP/Remote system.
    • State(Optional): State parameter given by ERP/Remote system.
    • Username: Represents the name of the user’s ERP/Remote system or Omnitron User.
    • Password: Represents to the password of the user’s ERP/Remote system or Omnitron User.

3- Price (Flow Type):

Integration flow type used to transfer the price information of the products in the client’s ERP system to Omnitron.

  • Price (Flow Activity Settings)
    • Omnitron Query String : Represents the parameters used to throw requests to the client’s ERP system.
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
    • Productization Settings :
      • Page item limit from Omnitron: It defines how many object should be retrieved from Omnitron.
      • Fetch prices after productization date limit: Date limit. For example; If "2" is entered as value, The request will be triggered again in 2 days for those products which don't have prices.
    • ERP Type : ERP type selection.
  • Read Data From ERP (Flow Activity Settings)
    • Price API URL: The URL used to redirect to the price service on the client’s ERP system. (e.g. http://example.com/api/price)
    • HTTP Method: Represents the method used to redirect to the client’s ERP system. (e.g. GET/POST)
    • Omnitron Price ID: Represents the Price List ID on the client’s Omnitron.
    • Extra Params: Additional query params values for the URL entered in the requests to be thrown. (e.g. cahnnel=shop&trasnfer=1)
    • Modified Date Key: The value of the date parameter thrown to receive the changes made since the last successful request. (e.g. modified_date__gt, modified_date, modified )
    • Price List Key: Represents the parameter value of the Price List ID on the client’s Omnitron. (e.g. pricelist=1, price_list=1, price_List=1)
    • Pagination Settings:
      • Pagination Enabled: When this parameter is selected as True following fields will be shown.
        • Infinite pagination mode: If it is selected, it starts sending request infinitely. If it doesn't get any response, it will stop sending requests.
        • Limit per page: Defines that how many data will be retrieved for each requested page.
        • Limit querystring key: The key to define limit while sending request
        • Page querystring key: The key to define page while sending request
        • Step Size: Defines how many page should be skipped between pages. Default value is 1.
        • Path for data in response as JsonPath: It defines which path should be used to get required data.
        • Path for total record count in response as JsonPath: It defines which path has the information of record count.
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.

4- Stock (Flow Type):

Integration flow type used to transfer the stock information of the products in the client’s ERP system to Omnitron.

  • Stok (Flow Activity Settings)
    • Omnitron Query String : Represents the parameters used to throw requests to the client’s ERP system.
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
    • Productization Settings :
      • Page item limit from Omnitron: It defines how many object should be retrieved from Omnitron.
      • Fetch stocks after productization date limit: Date limit. For example; If "2" is entered as value, The request will be triggered again in 2 days for those products.
    • ERP Type : ERP type selection.
  • Read Data from ERP (Flow Activity Settings)
    • Omnitron Stock ID: Represents the Stock List ID on the client’s Omnitron.
    • Extra Params: Additional query params values for the URL entered in the requests to be thrown. (e.g. cahnnel=shop&trasnfer=1)
    • Modified Date Key: The value of the date parameter thrown to receive the changes made since the last successful request. (e.g. modified_date__gt, modified_date, modified )
    • Stok List Key: Represents the parameter value of the Stock List ID on the client’s Omnitron. (e.g. stocklist=1, stock_list=1, stock_List=1)
    • HTTP Method: Represents the method used to redirect to the client’s ERP system. (e.g. GET/POST)
    • EndPoint URL: Represents the URL information regarding the client’s ERP system.
    • Pagination Settings:
      • Pagination Enabled:When this parameter is selected as True following fields will be shown.
      • Step Size: Defines how many page should be skipped between pages. Default value is 1.
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.

5- Product (Flow Type):

Integration flow type used to transfer the product information of the products in the client’s ERP system to Omnitron.

  • Product (Flow Activity Settings)
    • Omnitron Query String : Represents the parameters used to throw requests to the client’s ERP system.
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
    • Language : Language selection.
    • ERP Type : ERP type selection.
  • Read Data from ERP (Flow Activity Settings)
    • Extra Params: Additional query params values for the URL entered in the requests to be thrown. (e.g. cahnnel=shop&trasnfer=1)
    • Modified Date Key: The value of the date parameter thrown to receive the changes made since the last successful request. (e.g. modified_date__gt, modified_date, modified )
    • Product API URL: Represents the URL information regarding the client’s ERP system.
    • Request Method: Represents the method used to redirect to the client’s ERP system. (e.g. GET/POST)
    • ERP Timeout Settings : Timeout values of the ERP is being selected with this parameter.
    • Pagination Settings :
      • Pagination Enabled :When this parameter is selected as True following fields will be shown.
      • Step Size : Defines how many page should be skipped between pages. Default value is 1.
  • Script & Post-Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
    • Post-Script : Represents the code block used to change or transform the response derived from the Omnitron.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.
    • Will the Pre-Products Be Used?: Will the pool of pending products be used?

6- Order (Flow Type):

Integration flow type used to send order information from the client’s Shop site to the client’s ERP.

  • Order (Flow Activity Settings)
    • Omnitron Query String : Represents the parameters used to throw requests to the client’s ERP system.
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
  • Read Data From ERP (Flow Activity Settings)
    • Omnitron Channel : If the order location changes based on the sales channel on Omnitron, an order writing flow can be created for each sales channel. The value here represents the ID of the sales channel on Omnitron.
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.
  • Query Check Order (Flow Activity Settings)
    • Query URL: URL information used for querying the current order on the ERP system.
  • Write Data to Omnitron (Flow Activity Settings)
    • ERP Order Create API URL: URL information used for the purpose of writing existing orders to the ERP system.

7- Order Cancel (Flow Type):

Integration flow type used to send cancellation/refund requests from the client’s Shop site to the client’s ERP.

  • Order Cancel (Flow Activity Settings)
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
  • Get Data from ERP (Flow Activity Settings)
    • Cancel Status : Fetches waiting, confirmed and completed cancellations/refunds from Omnitron.
    • Cancel Type : Fetches the cancellation type from Omnitron (cancellation/refund).
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.
  • Write Data to Omnitron (Flow Activity Settings)
    • Next Status : Represents the next status of the cancellation/refund registration upon successful reporting of the request.
    • Cancellation API URL : URL information used for writing the canceled order information to the ERP system.
    • Method : Represents the method used to redirect to the client’s ERP system. (e.g. POST)

8- Order Status (Flow Type):

Integration flow type used for the purpose of querying the order status between ERP and Omnitron.

  • Order Status (Flow Activity Settings)
    • Omnitron Query String : Represents the parameters used to throw requests to the client’s ERP system.
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
    • ERP Type : ERP type selection.
  • Read Data from ERP (Flow Activity Settings)
    • Extra Params: Additional query params values for the URL entered in the requests to be thrown. (e.g. cahnnel=shop&trasnfer=1)
    • Modified Date Key: The value of the date parameter thrown to receive the changes made since the last successful request. (e.g. modified_date__gt, modified_date, modified )
    • ERP Domain URL: Represents the URL information regarding the client’s ERP system.
    • HTTP Method: Represents the method used to redirect to the client’s ERP system. (e.g. GET/POST)
    • ERP Timeout Settings : Timeout values of the ERP is being selected with this parameter.
    • Pagination Settings :
      • Pagination Enabled :When this parameter is selected as True following fields will be shown.
      • Step Size : Defines how many page should be skipped between pages. Default value is 1.
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.
  • Write Data to Omnitron (Flow Activity Settings)
    • Omnitron Domain URL: Represents the URL of the user’s Omnitron.

9- ImageS3 (Flow Type):

Integration flow type used for sending product images from the ERP to Omnitron using Amazon services.

  • ImageS3 (Flow Activity Settings)
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
    • Productization Settings :
      • Fetch items after productization date limit : Date limit. For example; If "2" is entered as value, The request will be triggered again in 2 days for those products.
      • Page item limit from Omnitron : It defines how many object should be retrieved from Omnitron.
    • S3 Bucket :
      • Access Key : Credential information.
      • Prefix : If prefix should be used while assigning the images, this parameter will be used as prefix.
      • Bucket Name : S3 Bucket name value
      • Secret Key : Credential information.
      • S3 URL : S3 URL information
    • Filename template : It defines that images should assign the products based on what. For example, if the images will be assigned based on SKU, value should be {sku}, if it is Base code, value should be {base_code}
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.

10- Image (Flow Type):

Integration flow type used for sending product images from the ERP to Omnitron.

  • Image (Flow Activity Settings)
    • Omnitron Query String : Represents the parameters used to throw requests to the client’s ERP system.
    • Omnitron Domain URL : Represents the URL of the user’s Omnitron.
    • Productization Settings :
      • Fetch items after productization date limit :Date limit. For example; If "2" is entered as value, The request will be triggered again in 2 days for those products.
      • Page item limit from Omnitron : It defines how many object should be retrieved from Omnitron.
    • Filename template :It defines that images should assign the products based on what. For example, if the images will be assigned based on SKU, value should be {sku}, if it is Base code, value should be {base_code}
  • Read Data from ERP (Flow Activity Settings)
    • Price API URL: The URL used to redirect to the price service on the client’s ERP system. (e.g. http://example.com/api/ımages)
    • Modified Parameter Key: The value of the date parameter thrown to receive the changes made since the last successful request. (e.g. modified_date__gt, modified_date, modified )
    • HTTP Method: Represents the method used to redirect to the client’s ERP system. (e.g. GET/POST)
    • Pagination Settings :
      • Pagination Enabled :When this parameter is selected as True following fields will be shown.
      • Step Size : Defines how many page should be skipped between pages. Default value is 1.
      • Limit querystring key : The key to define limit while sending request
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.

11- OMS Stock (Flow Type):

Integration flow type used for retrieving physical stocks from the ERP to OMS.

  • OMS Stock (Flow Activity Settings)
    • Outbound Request Url : The URL which will be requested.
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.

12- Retail Store (Flow Type):

Integration flow type used for getting data such as store ID, branch, address, etc. from the ERP in physical shops and writing it to Omnitron.

  • Retail Store (Flow Activity Settings)
    • Query Setting : Represents the parameters used to throw requests to the client’s ERP system.
    • Domain URL : Represents the URL of the user’s Omnitron.
    • Outbound Request URL : The URL which will be requested.
  • Script (Flow Activity Settings)
    • Script : Represents the code block used to change or transform the data derived from the ERP.
  • Mapping (Flow Activity Settings)
    • Mapping: Represents the code block to be written using the Jolt Transformation method for the purpose of enabling Omnitron to recognize the data derived from the ERP.

13- Generic Proxy (Flow Type):

Integration flow type used for which integration processes are defined without discriminating data (price, product, order, etc.) to meet the integration requirements that existing flows cannot meet.

  • GenericProxy (Flow Activity Settings)
    • Outbound Request URL : The URL which will be requested.
    • Remote URL : Represents the URL of the user’s ERP/Remote system or Omnitron.
    • Http Method : Represents the method used to redirect to the client’s ERP system. (e.g. GET/POST)
  • Preprocessing script (Flow Activity Settings)
    • Allows manipulating data using scripts before sending it to ERP.
  • Premapping (Flow Activity Settings)
    • Allows manipulating data using Jolt UI before sending it to ERP.
  • Postprocessing Script(Flow Activity Settings)
    • This feature is used after the ERP request is sent, to manipulate the incoming data with a script and send it anywhere or to update something in the Omnitron.
  • Postmapping(Flow Activity Settings)
    • This feature is used after the ERP request is sent, to manipulate the incoming data with Jolt UI and send it anywhere or to update something in the Omnitron.