Skip to main content

Startup Extensions

Startup Extensions structured way to register services, manage middleware, and handle application startup configurations, dependency injections, app settings. These extensions help register custom libraries, handle HTTP requests/responses, and execute startup configurations in an organized manner.

Middlewares​

Middleware is a pipeline component that processes HTTP requests and responses. It is used for:

  • Authentication & Authorization
  • Logging & Monitoring
  • Error Handling
  • Routing & Redirection

How Middleware Works​

Middleware follows a request-response pipeline, where each component:

  • Processes the request before passing it to the next component.
  • Processes the response before sending it to the client.
  • Short-circuits the pipeline (stops further execution if needed).

Create a Middleware​

Step 1: Add Middleware​

  1. Right-click Middlewares in the Startup Extension and select Add.
  2. Configure the required properties in the Properties Panel.

Step 2: Configure Middleware Properties​

PropertyDescriptionComments
Name*Unique name for the middleware.No spaces or special characters (except _).
OrderExecution order in the pipeline.Middleware runs sequentially.
DescriptionSummary of the middleware.Optional.
Is ActiveEnables or disables middleware.Default is Yes.

Step 3: Design Middleware Logic​

  1. The Middleware Designer Canvas appears with default Start & Stop constructs.
  2. From the ribbon, drag and drop necessary constructs (e.g., If, Log, Initialize).
  3. Configure the constructs to define the logic.

Step 4: Save and Deploy Middleware​

  1. Click Save to confirm changes.
  2. A "Middleware added successfully" message appears.

Structure of Middleware​

Middleware consists of variables for managing request and response data.

Adding Variables to Middleware​

  1. Right-click Variables and select Add.
  2. Configure the following Parameter Properties. A success message appears upon successfully adding variables.
PropertyDescriptionComments
Parameter Name*Name of the variable.No spaces or special characters (except _).
Is ArraySpecifies if the variable is an array.Default is No.
Data Type*Select the data type.Mandatory.

Constructs Available in Middleware​

Middleware logic can use the following constructs:

  • Logic Constructs: If, Switch, While, Foreach, Continue, Return
  • Initialization & Logging: Initialize, Log
  • Code Execution: C# Snippet
  • Middleware-Specific Constructs: Middleware, Add JSON to Configuration

Services​

A Startup Extension Services is used to configure services, dependency injection, and application startup behaviour.

Step 1: Add a Startup Extension​

  1. Right-click Services in the Startup Extension section.
  2. Select Add and configure properties.

Step 2: Configure Startup Extension Properties​

PropertyDescriptionComments
Name*Unique name for the startup extension.No spaces or special characters (except _).
OrderDefines execution order.Services execute in sequence.
DescriptionSummary of the startup extension.Optional.
Is ActiveEnables or disables the service.Default is Yes.

Step 3: Design Startup Extension Logic​

  1. The Startup Extension Designer Canvas appears with Start & Stop constructs.
  2. Drag and drop constructs from the ribbon to configure the flow.
  3. Define dependency injection, service registration, and configurations.

Step 4: Save and Deploy the Extension​

  1. Click Save to finalize changes.
  2. A "Startup Extension added successfully" message appears.

Structure of a Service​

Startup Extensions contain variables used for service configuration.

Adding Variables to a Startup Extension​

  1. Right-click Variables and select Add.
  2. Configure Parameter Properties as required.
PropertyDescriptionComments
Parameter Name*Name of the variable.No spaces or special characters (except _).
Is ArraySpecifies if the variable is an array.Default is No.
Data Type*Select the data type.Mandatory.

Available Constructs​

Startup Extensions use the following constructs:

  • Logic Constructs: If, Switch, While, Foreach, Continue, Return
  • Initialization & Logging: Initialize, Log
  • Code Execution: C# Snippet, Call Library Function
  • Service Configuration: Register Service, Add JSON to Configuration