### MCP Initialize Request Example

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/ml-and-ai-actions/service-mcp-requests.md

Example of an MCP Initialize Request payload.

```json
{
    "jsonrpc": "2.0",
    "method": "initialize"
}
```

--------------------------------

### Register User Example

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/gateway-actions/authenticate/README.md

Example JSON payload for registering a user. The 'auth' element contains username and password.

```json
{
    "auth": {
        "username": "user",
        "password": "pass"
    }
}
```

--------------------------------

### Example Deployment Definition

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/deployment-packages/defining-a-deployment.md

An example deployment definition that can be imported directly into the deployment screen. This JSON file outlines a complete deployment configuration.

```json
{
  "name": "example-deployment",
  "status": "active",
  "description": "An example deployment definition",
  "deploymentTask": {
    "name": "example-task",
    "serviceEndpoint": "http://example.com/jenkins/job/example-job"
  },
  "runners": [
    {
      "name": "example-runner",
      "class": "com.example.runners.ExampleRunner",
      "runner": "example-runner-config",
      "deploymentVersion": 1,
      "disabled": false
    }
  ],
  "parameters": {
    "namespace": "default",
    "pool": "default-pool"
  },
  "contents": {
    "build.gradle:dependencies": "implementation (group:'com.rierino.custom', name: 'siddhi', version:\"${rierinoVersion}\")\nimplementation (group:'com.rierino.processors', name: 'vault', version:\"${rierinoVersion}\")",
    "application.properties": "spring.application.name=example-app\nserver.port=8080",
    "preinit.sh": "echo 'Running pre-init script'",
    "postinit.sh": "echo 'Running post-init script'",
    "prerun.sh": "echo 'Running pre-run script'",
    "extra.sh": "echo 'Running extra container script'"
  }
}
```

--------------------------------

### Create Deployment for Example Runners

Source: https://github.com/mineozmen/docs/blob/main/examples/in-depth-exercise/to-do-list-runner.md

Defines a Kubernetes deployment for the 'Example Runners'. Adjust parameters like version, namespace, and pool to match your environment.

```text
Deployment ID: example-0001
Name: Example Runners
Status: ACTIVE
Description (optional): Deployment package for execution of example runners
Runners
  Name: todo
  Class: CRUD Runner
  Element: todo-0001
  Deployment Version: 1
```

```text
rierinoVersion: ENTER YOUR VERSION
template: spring
namespace: admin-backend
pool: admin-node-pool
```

--------------------------------

### Kafka System Configuration Examples

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/systems-integrations/other-systems.md

Examples of Kafka system configuration parameters, including binary data format, key and message class definitions, and producer/consumer specific settings.

```properties
binary=true
```

```properties
key.class=java.lang.String
```

```properties
msg.class=java.lang.String
```

```properties
msg.class.inner=java.lang.String
```

```properties
bootstrap.servers=localhost:9092
```

```properties
batch.size=1
```

```properties
samza.factory=org.apache.samza.system.kafka.KafkaSystemFactory
```

```properties
auto.offset.reset=earliest
```

```properties
acks=0
```

```properties
parameter.output.backupSystem=kafka_backup
```

```properties
parameter.output.backupStream=journal_backup
```

--------------------------------

### Table Column Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/indirect-widgets.md

An example of a table column configuration, defining a column for 'ID' with the path 'id'.

```json
[{ "path": "id", "title": "ID" }]
```

--------------------------------

### MCP Tool Listing Request Example

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/ml-and-ai-actions/service-mcp-requests.md

Example of an MCP Tool Listing Request payload.

```json
{
    "jsonrpc": "2.0",
    "method": "tools/list"
}
```

--------------------------------

### Read Data Configuration Example

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/read-data.md

This snippet shows a configuration for a 'Read Data' action, specifying a default and an example value for history.

```json
{
  "default": "none",
  "example": "history"
}
```

--------------------------------

### Example Dependencies for Gradle

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/deployment-packages/defining-a-deployment.md

Includes example dependencies for Gradle, such as for Siddhi event handlers and Vault KV Loaders. Ensure the 'rierinoVersion' is correctly defined for the deployment.

```gradle
//For Siddhi event handler
implementation (group:'com.rierino.custom', name: 'siddhi', version:"${rierinoVersion}")
//For Vault KV Loader
implementation (group:'com.rierino.processors', name: 'vault', version:"${rierinoVersion}")
```

--------------------------------

### Get/GetRT Action Example Input and Event Metadata

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/specialized-actions/calculate-real-time-metrics.md

Provides an example of the input payload and the corresponding event metadata configuration for the Get/GetRT action.

```json
{
    "parameters": {
        "id": "path-1"
    }
}
```

--------------------------------

### GetQuery Action Example Input and Event Metadata

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/query-data.md

Demonstrates a sample input payload and the corresponding event metadata configuration for the GetQuery action. This example shows how to pass search parameters and specify output details.

```json
{
    "parameters": {
        "search": "test"
    }
}
```

--------------------------------

### StartTask Example

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/orchestrate-user-task.md

This snippet demonstrates how to initiate a user task with a product ID and a brief description.

```json
{
    "productId": "product-1",
    "brief": "Image and video creation with summer vibes"
}
```

--------------------------------

### Email System Configuration Examples

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/systems-integrations/other-systems.md

Examples of Email system configuration parameters, including Jakarta Mail settings and Rierino OAuth2Auth authentication settings.

```properties
mail.store.protocol=imap
```

--------------------------------

### Example Query Manager Definition

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/query-and-search-sources/README.md

This JSON defines an example configuration for a query manager. It can be imported on the Element screen within the Rierino system.

```json
{
  "manager": "com.rierino.query.manager.MongoQueryManager",
  "retriesPerStep": 3,
  "backoffSteps": "10,20,30",
  "logDetail": "never",
  "telemetry": {
    "enabled": false
  }
}
```

--------------------------------

### Example Action Definition

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/additional-elements/actions.md

This JSON defines an example action that can be imported into an element screen. It specifies the handler and metadata overrides for the action.

```json
{
  "type": "action",
  "name": "CallRestUSA",
  "handler": "http_default",
  "mapping": {
    "meta": {
      "domain": {
        "override": "product"
      },
      "action": {
        "override": "Get"
      }
    }
  }
}
```

--------------------------------

### Example Handler Definition

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/execution-handlers/README.md

This JSON defines an example handler, which can be imported and configured within the Rierino element screen. It illustrates the structure for specifying handler configurations.

```json
{
  "handler": {
    "class": "com.rierino.handler.ReadEventHandler",
    "parameter": {
      "query.state": "query"
    }
  }
}
```

--------------------------------

### MCP Tool Call Request Example

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/ml-and-ai-actions/service-mcp-requests.md

Example of an MCP Tool Call Request payload, including method, name, and arguments.

```json
{
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
        "name": "Hello",
        "arguments": {}
    }
}
```

--------------------------------

### Example Input for GetQuery/GetQueryRT Action

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/specialized-actions/calculate-real-time-metrics.md

Demonstrates the input payload structure for the GetQuery/GetQueryRT action, including parameters like category.

```json
{
    "parameters": {
        "category": "cat-1"
    }
}
```

--------------------------------

### Media Editor Rename Pattern Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/value-widgets.md

Example of a JMESPath pattern used for automatically renaming uploaded files.

```text
join('', [ file.name.split('.')[0], now(), '.', file.name.split(.)[-1] ])
```

--------------------------------

### Table Column Configuration Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/array-widgets.md

Defines the UI structure for table columns, specifying the path, widget, and any additional properties for each column. This example shows a 'name' column using TextEditor and an 'image' column using the img widget.

```json
[
{"path":"name", "widget":"TextEditor", "props": {}},
{"path":"image", "widget":"img"}
]
```

--------------------------------

### CDC Batch Configuration Example

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/systems-integrations/other-systems.md

This JSON file provides an example configuration for CDC batch processing. It outlines the necessary settings for connecting to a database or similar system to capture changes.

```json
{
  "systems": {
    "$alias": {
      "consumer": {
        "manager": "com.rierino.state.cdc.MongoCDCManager",
        "dlq": {
          "suffix": "_fail",
          "enrich": true
        },
        "offset": {
          "type": "long"
        },
        "pollMs": 5000,
        "asPulse": false,
        "manager": {
          "parameter": {
            "ignoreTerminate": true,
            "onResumeFail": "FATAL",
            "onRecordFail": "FATAL",
            "ignoreResume": true,
            "resumeReset": "NEWEST",
            "disableReconnect": true,
            "retriesPerStep": 3
          }
        }
      }
    }
  }
}
```

--------------------------------

### Configure System Member (mongo_master)

Source: https://github.com/mineozmen/docs/blob/main/examples/in-depth-exercise/to-do-list-runner.md

Sets up the MongoDB system element for master collections. Ensure the 'system-mongo_master-0001' element is installed.

```text
Element: system-mongo_master-0001
Member Type: OPERATION
Alias: mongo_master
Description (optional): MongoDB system for master collections
```

--------------------------------

### Saga Step Configuration (Start to Event)

Source: https://github.com/mineozmen/docs/blob/main/examples/in-depth-exercise/to-do-list-query.md

Configures the link between 'Start' and 'Event' steps in a Saga. Setting the 'stream' to 'local' ensures that the gateway executes the step directly without delegating to a remote runner.

```json
{
  "from": "Start",
  "to": "Event",
  "stream": "local"
}
```

--------------------------------

### Example MongoDB System Definition

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/systems-integrations/data-systems.md

This JSON defines the configuration for connecting to a MongoDB system. It can be imported directly into the element screen.

```json
{
  "name": "mongo",
  "type": "mongo",
  "uri": "mongodb://localhost:27017",
  "database": "master"
}
```

--------------------------------

### Example Stream Definition

Source: https://github.com/mineozmen/docs/blob/main/devops/microservices/building-blocks/data-and-event-streams/README.md

This JSON defines a stream configuration, including system mapping and metadata overrides. It can be imported on the Element Screen.

```json
{
  "system": "kafka_default",
  "parameter.ignoreOffset": true,
  "meta.action.default": "Get",
  "meta.domain.override": "product"
}
```

--------------------------------

### Custom CDC Manager Implementation

Source: https://github.com/mineozmen/docs/blob/main/devops/pro-code/custom-cdc-managers.md

Implement a custom CDC manager by extending the CDCManager class. This example shows the basic structure including the constructor and the start, tryNext, and close methods.

```java
public class MyCDCManager extends CDCManager{

  /** 
   * Constructor with provided "alias", as well as its configurations.
   * Note: CDCManagers are not necessarily managed by EventRunners,
   * which is why they don't have access to them.
   */
  public MyCDCManager(String name, Map<String, String> config) {
    super(name, config);
  }
  
  /** 
   * Function called at the beginning of CDC loop, typically used for
   * establishing connection and applying offet alignment.
   */
  @Override
  public void start() throws HotException {
  }
   
  /** 
   * Function called on each loop iteration, for receiving the next
   * record. If no new records are received, the loop sleeps for poll
   * period.
   */
  @Override
  public CDCRecord tryNext() throws HotException {
  }
   
  /** 
   * Function called at the end for closing CDC loop.
   */
  @Override
  public void close() throws IOException {
  }

}
```

--------------------------------

### TextToArrayEditor JSON Schema with Delimiter Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/value-widgets.md

Defines the schema for the TextToArrayEditor widget, including a property for specifying the delimiter with an example.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TextToArrayEditor widget properties",
  "type": "object",
  "properties": {
    "props": {
      "type": "object",
      "properties": {
        "delimiter": {
          "type": "string",
          "description": "Delimiter to use for joining text values",
          "default": ",",
          "examples": [";"]
        }
      }
    }
  }
}
```

--------------------------------

### Related Object Editor Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/indirect-widgets.md

An example of a related object editor configuration using a 'TextFilter' widget for the 'name' path.

```json
[{ "path": "name", "widget": "TextFilter" }]
```

--------------------------------

### Mermaid Diagram Template Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/object-widgets.md

Example of a Handlebars template used to produce mermaid diagram contents. This defines a simple flowchart.

```html
<p>flowchart TD<br>A[Start] --> B{Decision}<br>B --> C[Next]</p>
```

--------------------------------

### Generate GUID

Source: https://github.com/mineozmen/docs/blob/main/extensions/jmespath-extensions.md

Generates a globally unique identifier (GUID). This function creates a unique string suitable for various identification purposes.

```APIDOC
## guid() -> string

### Description
Creates and returns a globally unique ID string.

### Returns
A globally unique ID string.
```

--------------------------------

### Create a Source

Source: https://github.com/mineozmen/docs/blob/main/examples/in-depth-exercise/to-do-list-ui.md

Configure a Source to map UI CRUD traffic to your gateway channel endpoint. This decouples UI screens from physical endpoints.

```text
Source ID: todo
Source Name: Todo
Source Status: ACTIVE
Action: default
URL: request/todo_crud/todo
```

--------------------------------

### Create an App

Source: https://github.com/mineozmen/docs/blob/main/examples/in-depth-exercise/to-do-list-ui.md

Define a new application in the Rierino Admin UI. This involves setting an App ID, name, status, and configuring menu paths.

```text
App ID: example
App Name: Example
App Status: ACTIVE
Description (optional): Application dedicated to list of examples.
Home Image: /image/configuration.png
Home Title: Example Navigator
Home Description: Everything you need to manage your example services.
Label: Todo
Icon: rules
Path: /common/todo
```

--------------------------------

### JsoupValidator Example

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/defining-a-saga.md

Example of configuring a JsoupValidator to detect unsafe HTML content within string schema types. The 'safelist' property can be set to 'relaxed' or other predefined levels.

```json
"x-validation":{
    "safeHtml": {
        "validator": "com.rierino.handler.util.jsonschema.JsoupValidator",
        "scope":{
            "type": "string"
        },
        "props": { 
            "safelist": "relaxed"
         }
    }
}
```

--------------------------------

### Example Action Function Configuration

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/components.md

This JSON configuration defines properties for adding a new action component. It specifies the function name ('alert'), the display title ('Alert'), and the icon name ('Alert'). The registered window function will be called with action properties.

```json
{
  "fn": "alert",
  "title": "Alert",
  "icon": "Alert"
}
```

--------------------------------

### Example Input for Run Scripts Action

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/custom-code-actions/run-scripts.md

Illustrates the expected input JSON structure for the Process/ProcessScript action. This data is processed by the specified dynamic handler and action.

```json
{
    "product": {
        "id": "product-1",
        "data": {
            "name": "Test Product"
        }
    }
}
```

--------------------------------

### Read Data Get Action - Event Meta JSON Schema

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/read-data.md

Defines the structure for event metadata when using the 'Read Data Get' action. Specifies fields like domain, input element, and output element for data retrieval.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Read Data Get action eventMeta fields",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "definition": "Name of the state manager to read data from",
          "example": "product"
        },
        "inputElement": {
          "type": "string",
          "definition": "Json path for the input in request event payload",
          "example": "parameters"
        },
        "outputElement": {
          "type": "string",
          "definition": "Json path for the output in response event payload",
          "example": "product"
        }
      }
    }
  }
}
```

--------------------------------

### Read Data Get Action - Event Meta Parameters JSON Schema

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/read-data.md

Details the parameters for the 'Read Data Get' action's event metadata, including output pattern, ID path, and version type. Use this to customize how data is read and returned.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Read Data Get action eventMeta.parameters",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "outputPattern": {
              "type": "string",
              "definition": "JMESPath pattern to apply on data output, before returning response",
              "example": "{id:id, name:data.name, description:data.description}"
            },
            "idPath": {
              "type": "string",
              "definition": "Json path for the id field in input element",
              "default": "id",
              "example": "product.id"
            },
            "idValue": {
              "type": ["string", "integer"],
              "definition": "Static ID to read instead of idPath value",
              "example": 1234
            },
            "fields": {
              "type": "string",
              "definition": "Comma separated list of fields to keep in response",
              "example": "data.name,data.description"
            },
            "form": {
              "type": "string",
              "definition": "Form of response to produce (i.e. full=including custom data fields)",
              "example": "full"
            },
            "customizeBy": {
              "type": "string",
              "definition": "Comma separated list of customizations to apply to data",
              "example": "luxury,tech_savvy"
            },
            "versionType": {
              "type": "string",
              "definition": "Type of version data to return (history, snapshot, none)",
              "default": "none",
              "example": "history"
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Create UI AI Assistant

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/menus/rai-menu-actions.md

Allows creation of new UI entries. Uses GPT_ASSISTANT_UI environment variable for assistant ID.

```APIDOC
## POST /api/[type]/assistant

### Description
Creates a new UI AI assistant.

### Method
POST

### Endpoint
/api/[type]/assistant

### Parameters
#### Query Parameters
- **type** (string) - Required - The type of the entry to create (e.g., 'ui').

### Request Body
This endpoint does not explicitly define a request body in the provided text, but implies it's used for AI interactions.

### Response
#### Success Response (200)
Details about the created assistant are not specified.

#### Response Example
No example provided.
```

--------------------------------

### ProceedTask Event Metadata - Parameters

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/orchestrate-user-task.md

Configures the parameters for the ProceedTask action, including input/output patterns, task ID path, and enrichment path for process progression.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "inputPattern": {
              "type": "string",
              "description": "JMESPath pattern to apply on data input",
              "example": "{data: newData}"
            },
            "outputPattern": {
              "type": "string",
              "description": "JMESPath pattern to apply on enrich data output, before returning response",
              "example": "{stored: oldData}"
            },
            "taskIdPath": {
              "type": "string",
              "description": "Json path which defines id for proceeding the process",
              "default": "[requestId]:[sagaStepId][runnerPartition]",
              "example": "id"
            },
            "enrichPath": {
              "type": "string",
              "description": "Json path to use for enriching proceeded process event data",
              "example": "newData"
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### ObjectTableArrayEditor Editor Icon Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/array-widgets.md

Sets the icon to be displayed alongside the title on the object editor.

```string
edit
```

--------------------------------

### ObjectTableArrayEditor Editor Title Example

Source: https://github.com/mineozmen/docs/blob/main/design/user-interface/uis/widgets/array-widgets.md

Sets the title text to be displayed on the object editor when editing a row.

```string
Details
```

--------------------------------

### Create Custom Role Handler

Source: https://github.com/mineozmen/docs/blob/main/devops/pro-code/custom-handlers.md

Example of creating a custom role handler by extending the RoleHandler class. It shows how to map role names to functions that process RoleData.

```java
package com.example.handler;

import java.util.Map;

import com.rierino.core.message.RoleData;
import com.rierino.core.util.HotException;
import com.rierino.runner.EventRunner;
import com.rierino.handler.RoleHandler;

public class MyRoleHandler extends RoleHandler{

    {
        /**
         * roleMap acts similar to actionMap, providing
         * mapping of role names to class functions
         * that can consume RoleData.
         */
        roleMap.put("MyRole", this::myRole);
    }

    /** 
     * Constructor with same structure as EventHandler constructor
     */
    public MyRoleHandler(String name, EventRunner runner, Map<String, String> config) {
        super(name, runner, config);
    }
    
    /**
     * Data processing function that is mapped to "MyRole" in roleMap, processing
     * an input role data and returning a collection of produced data.
     * Event runner orchestrates forwarding of produced outputs to the right
     * stream, based on its element configurations (e.g. forwarding to a Kafka topic).
     * The function can simply throw a HotException for errors, 
     * which is automatically handled to return an event with failed status.
     * Within the function, other runner elements (such as state managers)
     * can be accessed for accessing configuration details.
     */
    public Collection<RoleData> myRole(RoleData roleData) throws HotException{
        //TODO: utilize roleData to produce and return a collection of roleData
    }

}
```

--------------------------------

### Read Data Event Step Configuration

Source: https://github.com/mineozmen/docs/blob/main/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/read-data.md

Example configuration for the 'read-data' event step. This action is used to fetch data within a Saga's event flow.

```json
{
    "id": "given-id"
}

```