Skip to content
Znuny Logo Znuny Community Docs

OpenTicketAI connector for Znuny admins

Product: OpenTicketAI for Znuny. This page is the Znuny admin hook.

Generic Interface connector

Section titled “Generic Interface connector”

OpenTicketAIConnector provisions a restricted API agent (default login open_ticket_ai) and the REST webservice OpenTicketAI. Set OpenTicketAIConnector::AgentPassword in System Configuration before install. Catalogue operations are in Extend the Generic Interface.

Kernel/System/OpenTicketAIConnector/ZnunySetup.pm
my $Password = $ConfigObject->Get('OpenTicketAIConnector::AgentPassword') || '';
if ( !$Password ) {
    $LogObject->Log(
        Priority => 'error',
        Message  => 'OpenTicketAIConnector: set OpenTicketAIConnector::AgentPassword in System Configuration before install.',
    );
}

Discover OpenTicketAI for Znuny

Integrate AI-driven ticket classification and intelligent routing into Znuny — while retaining 100% on-premise data security.

Learn more about OpenTicketAI

Frequently asked questions

Does OpenTicketAI replace existing Znuny automation or classification features?

No, OpenTicketAI is designed to complement Znuny's existing automation capabilities rather than replace them. It integrates seamlessly with Znuny primarily through the Generic Interface, focusing on enhancing ticket classification. The OpenTicketAIConnector module provisions a dedicated, restricted API agent (with a default login of open_ticket_ai) and a specific REST webservice named OpenTicketAI. This setup allows OpenTicketAI to interact with Znuny for classification purposes, leveraging Znuny's robust framework while adding specialized AI-driven insights. It's crucial to set the OpenTicketAIConnector::AgentPassword in System Configuration before installing the package to ensure proper and secure functioning.

Quellen

Where can I find the official product documentation for OpenTicketAI for Znuny?

The comprehensive product documentation for OpenTicketAI, including details about its models, Studio, and overall solution for Znuny, is available on the official OpenTicketAI website. This resource provides in-depth information for users and administrators looking to understand the full capabilities and configuration of the integration. It covers everything from initial setup to advanced usage scenarios, ensuring that you have all the necessary information to effectively deploy and manage OpenTicketAI within your Znuny environment.

Quellen

Which SysConfig key is essential to configure before installing the OpenTicketAIConnector package?

Before proceeding with the installation of the OpenTicketAIConnector package, it is absolutely essential to set the OpenTicketAIConnector::AgentPassword key within Znuny's System Configuration. This pre-installation step is critical because the connector module is responsible for provisioning a restricted API agent (default login open_ticket_ai) and a dedicated REST webservice named OpenTicketAI. Without a pre-defined password, the system cannot securely establish these components, leading to an installation error and preventing the connector from functioning correctly. The password ensures the security of the API agent that OpenTicketAI uses to interact with your Znuny instance.

Quellen

What specific components does the OpenTicketAIConnector module introduce into Znuny?

The OpenTicketAIConnector module, upon proper installation and configuration, provisions two key components within your Znuny instance. Firstly, it creates a restricted API agent, which by default uses the login open_ticket_ai. This agent is specifically designed for secure programmatic interaction with Znuny. Secondly, it sets up a dedicated REST webservice, also named OpenTicketAI. This webservice acts as the communication channel, allowing the external OpenTicketAI system to send and receive data, primarily for ticket classification and other integrated functionalities. Both components are fundamental for the seamless operation of the OpenTicketAI integration.

Quellen

How does OpenTicketAI integrate with Znuny's backend for ticket processing?

OpenTicketAI integrates with Znuny's backend primarily through the powerful Generic Interface. This integration leverages a REST webservice, specifically the OpenTicketAI webservice provisioned by the OpenTicketAIConnector module. The Generic Interface acts as a flexible framework for external systems to interact with Znuny, allowing OpenTicketAI to send ticket data for analysis and receive classification results. This method ensures a standardized and robust way for the AI system to complement Znuny's ticket processing workflow, particularly in areas like automated ticket classification, without directly altering core Znuny functionalities.

Quellen

What is the consequence of not setting `OpenTicketAIConnector::AgentPassword` before installing the connector?

If the OpenTicketAIConnector::AgentPassword is not configured in System Configuration prior to the installation of the OpenTicketAIConnector package, the installation process will encounter a critical error. The provided code snippet from Kernel/System/OpenTicketAIConnector/ZnunySetup.pm explicitly checks for this password, and if it's missing, an error message will be logged with Priority => 'error', stating: "OpenTicketAIConnector: set OpenTicketAIConnector::AgentPassword in System Configuration before install." This means the connector will not be able to properly provision the restricted API agent and the REST webservice, rendering the OpenTicketAI integration non-functional and preventing secure communication between OpenTicketAI and your Znuny instance.

Quellen