Enable SimpCon Push XML Producer
Overview
The SimpCon Push XML Producer Extension Template provides a framework for developing extensions that receive XML-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 be configured to limit 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 |
Store authentication credentials securely. Do not include credentials in source code repositories.
How the extension works
This application is a Simplified Connector designed to run as an extension instance in the Integrated AIOps platform.
The extension performs the following actions:
- Receives XML-formatted records 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.
Results
The extension runs as a containerized application and uses Kubernetes liveness and readiness probes to report runtime health status.
Deployment
The extension is intended for deployment and configuration through the Integrated Artificial Intelligence for IT Operations user interface for a specific Organizational Unit (OU) or Compute Zone.
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 session.
- Navigate to the extension directory.
Build the docker image
Start the container
Run the container and provide the required environment variables.
Monitor the container
View running containers
View 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.