integration service description

content/en/docs/services/integration-service/_index.md

@@ -0,0 +1,4 @@
+---
+title: 'Integration Service'
+weight: 60
+---

content/en/docs/services/integration-service/features.md

@@ -0,0 +1,25 @@
+---
+title: 'Features'
+description: 'What features does the Integration Service provide?'
+date: '2024-06-14'
+categories: [events, iot, integration]
+keywords: [event streaming, integration service, plgd hub]
+weight: 3
+---
+
+### Planned Features
+
+- **☐ Event Stream Management:** Seamlessly stream events from the plgd hub to a wide range of external services. Configure rules to control which events are transmitted and where they are sent.
+
+- **☐ Advanced Filtration Mechanism:** Enhance event filtering with options including:
+   - **Device ID:** Filter events based on the unique identifier of the originating device.
+   - **Href:** Utilize the href attribute for event selection.
+   - **Resource Types:** Specify resource types to target events relevant to particular data types.
+   - **Event Type:** Differentiate events based on their type.
+   - **Content Filtering:** Apply jq expressions for advanced content-based filtering.
+
+- **☐ Supported Target Services:**
+   - **HTTP:** Integrate with web services and APIs via HTTP endpoints.
+   - **NATS:** Use the NATS messaging system for distributed event streaming.
+
+- **☐ Dynamic Target Parameters:** Define target parameters using templates with placeholders to dynamically populate values from event content, ensuring accurate data delivery to external services.

content/en/docs/services/integration-service/integration-service.md

@@ -0,0 +1,47 @@
+---
+title: 'Integration Service'
+description: 'What is Integration service?'
+date: '2024-06-14'
+lastmod: '2024-06-14'
+categories: [events, iot, integration]
+keywords: [event streaming, integration service]
+weight: 1
+---
+
+{{< note >}}
+
+Planned feature.
+
+{{< /note >}}
+
+The Integration Service is a key component of the plgd hub, designed to streamline the flow of event data to various external services. This service enhances connectivity and interoperability by allowing users to define and manage the transmission of events based on specific content and criteria.
+
+#### Key Features
+
+1. **Event Stream Management:**
+   - Seamlessly stream events from the plgd hub to a wide range of external services.
+   - Utilize configurable rules to control which events are transmitted and where they are sent.
+
+2. **Advanced Filtration Mechanism:**
+   - **Device ID:** Filter events based on the unique identifier of the originating device.
+   - **Href:** Utilize the href attribute to refine event selection.
+   - **Resource Types:** Specify resource types to target events relevant to particular data types.
+   - **Event Type:** Differentiate events based on their type to ensure precise data routing.
+   - **Content Filtering:** Apply jq expressions for advanced content-based filtering to fine-tune the events being sent.
+
+3. **Supported Target Services:**
+   - **HTTP:** Send events to HTTP endpoints for integration with web services and APIs.
+   - **NATS:** Use the NATS messaging system for distributed and scalable event streaming.
+
+4. **Dynamic Target Parameters:**
+   - Define target parameters using templates.
+   - Incorporate placeholders within templates to dynamically populate values from the event content, ensuring accurate and contextually relevant data delivery.
+
+#### Benefits
+
+- **Customizable Event Routing:** Tailor the event routing rules to meet specific application needs, ensuring only relevant data reaches the target services.
+- **Scalability:** Integrate with multiple external services and scale event handling as your system grows.
+- **Enhanced Data Control:** Maintain granular control over data flow with robust filtering options, enhancing both security and efficiency.
+- **Flexibility:** The template-based approach for target parameters ensures flexibility and adaptability to various external service requirements.
+
+The Integration Service is an essential tool for developers and system integrators looking to enhance their event-driven architectures with precise, rule-based event streaming capabilities.