Enable SimpCon Push JSON Producer
Overview
The SimpCon Push JSON Producer Extension Template provides a framework for developing extensions that receive JSON-formatted records from an external source system and publish the records to a Kafka topic through Data Streaming Services. The extension requires details about the external source system, including the system URL and authentication credentials. Optional filters, such as assignment groups and domain-separated company names, can restrict the records processed by the extension.
Platform service interactions
The extension transforms incoming requests and forwards them to the following Data Streaming Service topic:
Configure the extension
The following environment variables must be passed to the container:
Variable | Default | Comments |
|---|---|---|
DX_EXT_EXTENSION_USER (string) | | Mandatory Bridge Username used for Basic Authentication |
DX_EXT_EXTENSION_PW (string) | | Mandatory Bridge Password used for Basic Authentication |
DX_EXT_SOURCE_QUERY_URL (string) | | Mandatory SMT URL to query for ticket state |
DX_EXT_SOURCE_USER (string) | | Mandatory SMT Username used for Basic Authentication |
DX_EXT_SOURCE_PW (string) | | Mandatory SMT Password used for Basic Authentication |
DX_ENV_ENVIRONMENT (string) | | Mandatory The type of environment the extension is running in: LOCAL, DEV, or PROD |
DX_ENV_OU_KEY (string) | | Mandatory OU Tenant Key |
DX_ENV_OU_BAC_ID (string) | | Mandatory BAC id of the client |
DX_ENV_OU_ES_INSTANCE (string) | | Mandatory The Elasticearch instance the messages are supposed to go to on the Consumer side |
DX_EXT_CDI_TOOL_SOURCE (string) | | Mandatory Client Tool Mapping value |
DX_EXT_CDI_CUSTOMERCODE (string) | | Mandatory Client Tool Mapping value |
How the extension works
The application is a Simplified Connector Producer designed to run as an extension instance in the Integrated Artificial Intelligence for IT Operations platform.
The extension performs the following actions:
- Receives records in JSON format from an external source system.
- Transforms the incoming requests.
- Publishes the transformed records to a Data Streaming Service Kafka topic.
- The extension runs as a container in a Kubernetes environment.
Deploy the extension
Deploy and configure the extension through the Integrated Artificial Intelligence for IT Operations user interface. The extension supports deployment to individual OUs and Compute Zones within the platform.
Local execution is intended only for developers who are familiar with the extension codebase.
Run the extension locally
Build the container image
- Open a terminal.
- Go to the extension directory.
Build the docker image
Start the container
Run the following command and replace the placeholder values with the appropriate configuration:
Monitor the container
View running containers
View the container logs
Troubleshoot the container
Identify the container ID
Open a shell session in the container
Support
The Extensions Development Team owns and maintains this extension.