This is an internal document and is for Sestek employees only, and will not be accessible if shared with other parties.
In order for the Puzzel integration to work, Puzzel Producer and Conversation Consumer services should be deployed to the desired environment.
On this page, it is explained how Knovvu Analytics works integrated with Puzzel, the technical details and the required deployment steps in details
Puzzel Services
1. Puzzel Producer
One of the services written for Knovvu Analytics-Puzzel integration is Puzzel Producer. Puzzel Producer's main task is to find all the calls starting from the requested date (Migration Start Date) until today and transmit them to the consumer. For current calls, it keeps receiving them two hours behind.
Puzzel Producer Deployment
Puzzel Producer is designed to run separately for each tenant, so when deploying this service, it must be associated with a tenant through the information on the settings page.
When deploying Puzzel Producer, the customer's tenant name should be entered as the variation name. The variant name should be the same as the tenant name, but completely in lowercase letters to avoid receiving errors due to the Regex rules. The number of replicas should be 1, so that the same event is not received more than once.
- Variation slug should be tenant name in small letters.
- Replica should be 1.
2. Conversation Consumer
The other service written is Conversation Consumer and its task is to receive the metadata and recordings of calls from RabbitMq via APIs and save them to Knovvu Analytics.
Conversation Consumer Deployment
Conversation Consumer is not tenant-based like Puzzel Producer and is integration-type independent. This means that the same service can be used for different marketplace integrations as well as for all customers from different tenants. Therefore, the variation name of the Conversation Consumer is not important. And the number of replicas is increased according to the need.
When should a new Conversation Consumer deployed?
When the calls pile up in the RabbitMq queue, and cannot be processed, a new Conversation Consumer should be deployed. This is done by increasing the number of replicas.
Deployment scenarios will vary for each marketplace integration domain. Managing the variant name or the number of replicas of Producer-Consumers in this way is unique to Puzzel.
Puzzel Integrations Configuration Steps
In the Puzzel-Knovvu Analytics integration, recordings and metadata of the calls in Puzzel are downloaded from FTP and imported into Knovvu Analytics.
Therefore, in order to perform the steps described in the rest of the document, the customer must first be given an FTP username and password by Puzzel.
In order to complete the installation, the customer must have the FTP username and password provided by Puzzel.
In order for a customer to use the Puzzel integration, this integration must be defined for the customer's tenant.
As the first step, the admin needs to login to the desired environment as a host and enable the Puzzel feature for the tenants who will use this integration.
- Login as host.
- Enter the Tenants page under the Saas menu as seen below.
- Next to the desired tenant's name, click on the Actions button and then Features.
- Puzzel Integration feature can be seen on the opened page and shoul be enabled here.
- After these steps are completed on the admin side, you should login as the tenant.
- Enter the Settings page under the Administration menu. The information that needs to be entered for the Puzzel integration to work can be seen below in the Puzzel Integration tab.
This information is the customer's Puzzel information and will be transmitted by the customer.
Once these steps are completed, the admin needs to login as host and assign the service to the tenant.
7. Login as host.
8. Enter the Integration page under the Administration menu as seen below.
- All services in the environment can be seen on this page. By clicking on the PuzzelProducer, the user must enter the service whose status is waiting for configuration. The tenant ID of the customer should be entered.
- After clicking on Save, the waiting for configuration status of the service will be switched to running. Puzzel integration is ready to be used by the customer.