This article contains the following sections:

• Click to Vidyo
• Business Reporting
• Vidyo Server

 

Troubleshooting the Vidyo solution involves identifying the missing or wrong configuration in the Vidyo adapter and any of the Genesys components.

Click to Vidyo

The Click to Vidyo use case depends on the Genesys routing configuration. Therefore, any routing issues will cause Click to Vidyo to stop working appropriately.
 

Communication and Settings Overview

• The widgets must be able to talk to the Genesys Vidyo Server (check errors in the browser console logs).
• The Genesys Vidyo Server must be able to create the ORS Session and Vidyo interaction (check the Genesys Vidyo Server logs, INX, and ORS).
• The ORS must get the interaction data from IXN server (ORS logs).
• The ORS must execute the routing script from the web server (ORS and web container logs).
• The ORS must talk to the URS and instruct it to perform routing (send routing expression, ORS, and URS logs).
• The URS must be able to perform a target selection.
• The IXN server talks to the WDE.
• The WDE must be configured with the Vidyo channel.
• The agent must be able to use Vidyo.
• The WDE must have access to VidyoPortal.
• The agent must have a registered VidyoPortal user account.

Log Records Overview

Browser Console

The Genesys Vidyo Server responds with the ORS Session ID to the widget console 00T6JV3QNSCR51ESG41AHG5AES000003.

Vidyo Server Logs

When the Create Interaction request is received by the Vidyo Server, the Session ID is created and the following occurs:

• The Session ID can be found in the Genesys Vidyo server logs as follows: a1681ddd-3657-48f2-8110-f1f8e2f826eb.
• The Create ORS Session request is sent.
• The ORS session is created with orsSessionId=00T6JV3QNSCR51ESG41AHG5AES000003.
  
  

When the ORS Session is created in the ORS orsSessionId and is returned to the Vidyo Server, the following occurs:

• The ORS Session is mapped to the Genesys Vidyo Server ID as follows: a1681ddd-3657-48f2-8110-f1f8e2f826eb.
• The Vidyo Server creates the Genesys Interaction in IXN as follows:
  • a1681ddd-3657-48f2-8110-f1f8e2f826eb (the interaction is created with ixnID=01QGKTJSP9WBX001 and the Interaction ID is visible in the ORS, URS, and IXN logs).

The following IDs can be used to track interactions across all components:

• Genesys Vidyo Server Session ID: a1681ddd-3657-48f2-8110-f1f8e2f826eb
• ORS Session ID: 00T6JV3QNSCR51ESG41AHG5AES000003
• IXN Interaction ID: 01QGKTJSP9WBX001

 

Summary of All IDs Created for Click to Vidyo Session

Verify that each ID is created for the Click to Vidyo Session:

• Genesys Vidyo Server Session ID – verify that the ORS session and Genesys Interaction is created (Vidyo Server log)
• ORS Session ID – verify that the ORS routing strategy is executed from the web container (ORS server logs)
• IXN interaction ID – verify that the interaction records exist in the URS logs
  • The IXN server log contains all records based on the Interaction ID.
  • The IXN server logs shows all communication between the WDE and IXN.
  • The IXN server sends events with the Interaction ID to all reporting engines.
    
    

Where to Look for Interactions that Were Created but Not Delivered

1. Obtain the ORS logs by executing the following routing script:
   
   key[01QGKTJSP9WBX001]/value[00T6JV3QNSCR51ESG41AHG5AES000003]
   Processing GET request, URL: (routing script URL defined during install)
   Creating URS virtual interaction, {ORSURS:3} CreateVirtualCall: <<                refID      27           tenant
   'Environment'     call         '01QGKTJSP9WBX001'     context               '{"MediaType":"vidyo","ThisLocation":111,"UserData
   
   
2. Look for the 01QGKTJSP9WBX001 ID in the URS.
   
   
3. Check the URS logs (only if the interaction exists in the ORS).
   
   You should see the following:
   

   Call created in URS, RLIB: received from 19(ors) message RequestCreateVCall(1000000002) refid(1)  7               tenant(1000000006)        'Environment'     callid(1000000000)           '01QGKTJSP9WBX001'               args(1000000003)            '{"MediaType":"vidyo","ThisLocation":111,"UserData“

   Target agent selected – HERE IS TARGETS – string will be found in URS and it is surrounded by event with interaction ID,

   HERE IS TARGETS

   TARGETS: ?:(vidyo>1)@stat.GA - (URS asks Stat server for available target to perform routing, (vidyo>1)@stat.GA is expression specified at Vidyo Server service definition)
   
   

4. Verify that the routing results shows what happened (only if the interaction exists in the URS).
   
   Here is an example of a successful target selection:
   

   _M_I_007502aac19c2002 [17:0b] VQ 7fa9744c7a68 TRG "?:(vidyo>1)"(7fa9744c7888) #1, (2-1 Components): SELECT ANY by stat <NONE>(random  0)    _

   M_I_007502aac19c2002 [17:0b] VQ 7fa9744c7a68 TRG "?:(vidyo>1)"(7fa9744c7888) Cmp #1 002: logged out

   _M_I_ [10:0a] object 1:vidyo_001|Environment| is not blocked   

   _M_I_007502aac19c2002 [10:0c] tenant Environment Agent 001: dn 001 (m 38) is ignored: other dn type(cfg)   

   _M_I_007502aac19c2002 [10:0c] tenant Environment Agent 001: dn 001(m 54, ready since 1504869617) is OK   

   _M_I_007502aac19c2002 [17:0b] VQ 7fa9744c7a68 TRG "?:(vidyo>1)"(7fa9744c7888) Cmp #2 001: statvalue: (0)0, 1.73843526828e-07(N) the best   

   _M_I_007502aac19c2002 [17:0b] VQ 7fa9744c7a68 TRG "?:(vidyo>1)"(7fa9744c7888): Cmp 001 SELECTED (0 0)   

   _M_I_007502aac19c2002 [17:0e] VQ 7fa9744c7a68 TRG "?:(vidyo>1)"(7fa9744c7888): statvalue: (0)0, 1.73843526828e-07(N) the best   

   _M_I_007502aac19c2002 [17:0e] VQ 7fa9744c7a68 (vq "vq_vidyo" id=2): TRG "?:(vidyo>1)"(7fa9744c7888) SELECTED   

   _M_I_007502aac19c2002 [01:0d] attempt to route (1)    _J_I_007502aac19c2002 [0E:19] check call routing states (vq 7fa9744ca9e0): s=0 d=0 t=0 h=(0 0 0) r=0 i=0 x=0 b=0 - true

The numbers in red are agent employee IDs and they are followed by decisions made from the routing engine. These numbers can be found in the Genesys Person object config. If they are not routed, then there must be some communication issue between the WDE and IXN servers. Call delivery is always performed by the IXN server.

Common Root Causes for Interactions That Are Not Delivered

• The agent is not ready for a Vidyo call.
• The agent is not in the target selection list (invalid skill or agent group).
• The agent is not assigned with a capacity rule.
• The agent capacity is full (the other Vidyo interaction is at the agent desk).
• The interaction is not delivered to the URS.
• The ORS is not able to talk to the URS.
  • This requires URS http port configuration.
• The ORS is not able to talk to the IXN.
  • The Interaction server connection is missing in the ORS.
  • The Ors is not configured to process IXN server interactions (mcr-pull-by-this-node).
  • The ORS is not able to execute routing script.
    • The connection to the web container is down.
    • The routing script is not accessible.
    • The ORS node is not configured properly.
    • The interaction not delivered to the ORS (no interaction is created).
  • The Genesys Vidyo Server cannot talk to the ORS.
    • The ORS http port is not configured.

If communication between ORS and the Genesys Vidyo Server is failing, the error will be shown in the browser console and Genesys Vidyo Server logs.

 

Vidyo Interaction Routing Issue Example  

When the Vidyo server is successfully deployed and web widgets are able to submit requests to it, the interaction routing with ORS and URS should successfully start. It is possible to check whether the request submit Vidyo interaction was successfully submitted in the Web Widget browser console and browser UI. After a successful request submit, the sample widget will display the following:

The Cick-To-Vidyo button is grayed out and disabled, and the Cancel button is enabled. The request was sent to the Vidyo server and the Vidyo server was able to establish a session with ORS.

If the Cancel button is not appearing or disappears immediately, then communication from Web Widgets to the Vidyo server is not working properly or the Vidyo server to ORS and IXN channel is not working correctly.

Web Widgets to Vidyo Server 

The Vidyo server URL must be reachable from the Websocket server. The server is opening the http and https ports. The port configuration can be found in the web widget sample Javascript.

For the websocket sample, an initialization script must be executed. If it is not accessible, the websocket connection will not open.

Verify the Vidyo server connection by opening the Javascript file in the browser.

Websocket

http://appsrv6:7060/webclient_websocket/js/ve4gclick.js

Rest

Compile the Vidyo server URL from http://<server>:<port>/VidyoServer/scripts/vidyo.min.js. The URL must be reachable from the browser where Web Widgets are running.

If communication between the Vidyo server and Web Widgets is working, the Console log contains the records. Request to make the Vidyo interaction is submitted to ORS, websocket:

The request to make the Vidyo interaction is submitted to ORS, REST:

The request was submitted to ORS and the ORS responded with id and ors sessionid. From now on, the ORS session ID is used as reference to the Vidyo request.

Vidyo Server to Genesys ORS and IXN

The Sample widget UI will respond with error into console log “dialing-error”.

The REST example shows Callback execution completed; therefore, there is an issue between the Vidyo server and Genesys.

For Websocket, the installation screen shows the same situation:



If this is the case, you must check the Genesys configuration.

Common Genesys Configuration Issues

 

Ensure that these Genesys components are running:

• Orchestration server
• Universal routing server
• Interaction server

Check the configuration of the components in the following subsections.

Vidyo Server

The Vidyo server must be connected to the ORS, IXN, and SCS server as shown in the following screenshot:

Default ORS XML routing must be configured in service.click-to-vidyo and accessible by ORS.

Orchestration Server

The server must be configured to route eServices interaction. For a detailed description, see the Genesys Deployment Guide at https://docs.genesys.com/Documentation/OS/latest/Deployment/eServices.

The screenshots below shows an example configuration.

Orchestration server connections:

Orchestration server http port:

Orchestration server options:

mcr-pull-by-this-node



parse-start-params=false

Orchestration Server Cluster

Setting the ORS cluster is mandatory for ORS releases starting from 8.1.400.64. For detailed information, see the Genesys Documentation at https://docs.genesys.com/Documentation/OS/8.1.4/Deployment/General#Configuring_an_ORS_Cluster

A sample cluster configuration is shown below.

Orchestration Routing Scripts

The Orchestration server executes routing scripts defined by the enhanced routing object in the Genesys configuration. The routing script must point to the scxml file accessible from ORS.

A sample configuration is:

When the scxml script is not accessible, the routing of the Vidyo interaction will not occur.

Universal Routing Server

To enable URS routing of ORS initiated sessions, you must enable http configuration of URS. The http port must be configured at the URS application.

Make sure to restart all Genesys components including the Vidyo server after the changes to the configuration are made.

Browser Console Exception

The Vidyo server must always respond with success or an error message about the routing of the interaction.

If there is no agent available to pick the call, the response must be:

This exception is returned from the Vidyo server by design and means that communication between the Vidyo server and ORS works fine. The routing script was executed and callback to the Vidyo server works.

The “com.genesys.ps.vidyo.service.impl.ORSServiceImpl$OrsErrorException: agent.wait.timeout” means routing to an agent was not successful in the specified timeout.

Timeout is set at service.click-to-vidyo option of Vidyo server _agent_reserve_timeout.

If this is the case, you must check the URS logs and find why the interaction is not delivered. The URS logs must contain:

• Record and “vidyo” interaction. Search for string “vidyo”.
• Interaction ID of Vidyo interaction
  
  • Open VidyoServer log and search for “Created interaction with ixnID=”.
  • Copy interaction ID and search URS log.

Example Vidyo Server log:

Example ORS log:

Example URS log:

Create VCall from ORS



Search for Targets



Target Selection Timeout

 

No Response to Vidyo Server

This status means there is an issue in execution of the ORS routing scripts. The ORS logs need to be checked for errors related to IPD_default_defaultWorkflow.scxml and IPD_default_vidyo_RouteToAgent.scxml.

ORS must be able to access and execute these scripts after the session is created and after the Vidyo server request and interaction from the interaction server is pulled. The IPD_default_defaultWorkflow.scxml is executed after the request from the Vidyo server is processed, and IPD_default_vidyo_RouteToAgent.scxml is executed after the interaction created by the Vidyo server is pulled from the interaction server.

The response to the Vidyo server is expected in timeout _agent_reserve_timeout from IPD_default_vidyo_RouteToAgent.scxml execution.

Business Reporting

The Genesys interaction-based reporting is used for Vidyo business reporting. The WDE creates an outbound Vidyo interaction for reporting purposes and attaches business data to this interaction before it is stopped.

Creating an Outbound Vidyo Interaction 

To create an outbound Vidyo interaction, the WDE sends a request submit interaction to the interaction server as follows:

2018-04-27T18:23:17.602 Trc 26015 Received message 'RequestSubmit' ('101') from client 'WDE_Vidyo_irobot' - Proxy:25:34, message attributes:

                  attr_itx_type [str] = "Outbound"

                  attr_itx_subtype [str] = "OutboundNew"

                  attr_media_type [str] = "vidyo"

                  attr_queue [str] = "VidyoOut"

                  attr_prxy_client_id [int] = 26

                  attr_tenant_id [int] = 1

                  attr_prnt_itx_id [str] = "01QGK0ATVBUPX013"

                  attr_user_data [list, size (unpacked)=1070] =

                     'parentMediaType' [str] = "vidyo"

                     'parentInteractionId' [str] = "01QGK0ATVBUPX013"

                     'firstName' [str] = "<customer-name-if present>"

                     'guestLinkURL' [str] = "http://<ors-ip>:<ors-port>/scxml/session/<ors-sessionid>/event/guestLink"

                     'vQueue' [str] = "vq_vidyo"

                     'aTimeout' [str] = "30"

                     'CustomerSegment' [str] = "default"

                     'IW_BundleUid' [str] = "5261f656-3fad-4a2c-ba0c-561b210039ac"

                     'IW_CaseUid' [str] = "242800c1-4057-43c1-9bc9-63e2a6f2d7a3"

                     'customer_segment' [str] = "vidyo"

                     'GuestLink' [str] = "https://<portal-uri>/join/<meeting-room-id>"

                  attr_ref_id [int] = 17

The interaction contains userdata “attr_user_data [list, size (unpacked)=1070]” copied from the parent interaction based on the settings vidyo.outbound-userdata-map and vidyo.outbound-userdata-map-prefix.

The interaction server responds with the event acknowledgment containing, interactionId.

2018-04-27T18:23:17.606 Trc 26019 Sending message 'EventAck' ('125') to client 'vidyo_001' - Agent application:26:34 through proxy 'WDE_Vidyo_irobot' - Proxy:25:34, message attributes:

                  attr_ref_id [int] = 17

                  attr_prxy_client_id [int] = 26

                  attr_extension [list, size (unpacked)=38] =

                     'InteractionId' [str] = "01QGK0ATVBUPX014"

If there is an issue, the interaction server will respond with an event error.

2018-05-02T13:54:56.215 Trc 26015 Received message 'RequestSubmit' ('101') from client 'WDE_Vidyo_irobot' - Proxy:9:29, message attributes:

                  attr_itx_type [str] = "Outbound"

                  attr_itx_subtype [str] = "OutboundNew"

                  attr_media_type [str] = "vidyo"

                  attr_queue [str] = "TestOutVidyo"

                  attr_prxy_client_id [int] = 10

                  attr_tenant_id [int] = 1

                  attr_prnt_itx_id [str] = "01QGKTATW6KG0000"

                  attr_user_data [list, size (unpacked)=1134] =

                     'parentMediaType' [str] = "vidyo"

                     'parentInteractionId' [str] = "01QGKTATW6KG0000"

                     'firstName' [str] = "Chloe"

                     'guestLinkURL' [str] = "http://192.168.2.129:7015/scxml/session/024GMFL6VSDEJ0TJG41AHG5AES000001/event/guestLink"

                     'vQueue' [str] = "vq_vidyo"

                     'aTimeout' [str] = "30"

                     'CustomerSegment' [str] = "default"

                     'IW_BundleUid' [str] = "31e24fed-d3eb-43f3-81ad-ee75d53e5eb7"

                     'IW_CaseUid' [str] = "e4b5822f-63ee-466c-9dd6-a0cdff9a69f6"

                     'IW_OwnerId' [int] = 101

                     'customer_segment' [str] = "vidyo"

                     'GuestLink' [str] = "https://genesys.alpha.vidyo.com/join/aelusrEq"

                  attr_ref_id [int] = 15

2018-05-02T13:54:56.215 Trc 26019 Sending message 'EventError' ('126') to client 'vidyo_001' - Agent application:10:29 through proxy 'WDE_Vidyo_irobot' - Proxy:9:29, message attributes:

                  attr_ref_id [int] = 15

                  attr_prxy_client_id [int] = 10

                  attr_error_code [int] = 91

                  attr_error_desc [str] = "Cannot resolve queue for submit"

When an error occurs, the interaction is not created and the business reporting data will not be available. The Vidyo session operation progresses normally, and the WDE will write a report to the logs.

Outbound Vidyo Interaction Not Created

Information about the outbound Vidyo session can be found at the WDE and interaction server logs.

Example WDE Logs:

The “DEBUG idyo.VidyoIxnManager - send request 'RequestSubmit'” is a record in the WDE logs that shows the moment when the WDE asks for the interaction server to create the Vidyo session. The request details are listed as well. 

DEBUG idyo.VidyoIxnManager - send request 'RequestSubmit' ('101')

message attributes:

attr_itx_type [str] = "Outbound"

attr_itx_subtype [str] = "OutboundNew"

attr_media_type [str] = "vidyo"

attr_queue [str] = "TestOutVidyo"

attr_prxy_client_id [int] = 15

attr_tenant_id [int] = 1

attr_prnt_itx_id [str] = "01QGKTATW6KG0002"

attr_user_data [bstr] = [output suppressed]

attr_ref_id [int] = 17

The Event Error in the WDE logs:

“ERROR idyo.VidyoIxnManager - Interaction  Cannot be submitted Cannot resolve queue for submit”

 

Example Interaction Server Logs:

Request Submit from WDE:

Trc 26015 Received message 'RequestSubmit' ('101') from client 'WDE_Vidyo_irobot' - Proxy:9:29, message attributes:

                  attr_itx_type [str] = "Outbound"

                  attr_itx_subtype [str] = "OutboundNew"

                  attr_media_type [str] = "vidyo"

                  attr_queue [str] = "TestOutVidyo"

                  attr_prxy_client_id [int] = 10

                  attr_tenant_id [int] = 1

                  attr_prnt_itx_id [str] = "01QGKTATW6KG0000"

                  attr_user_data [list, size (unpacked)=1134] =

                     'parentMediaType' [str] = "vidyo"

                     'parentInteractionId' [str] = "01QGKTATW6KG0000"

                     'firstName' [str] = "Chloe"

                     'guestLinkURL' [str] = "http://192.168.2.129:7015/scxml/session/024GMFL6VSDEJ0TJG41AHG5AES000001/event/guestLink"

                     'vQueue' [str] = "vq_vidyo"

                     'aTimeout' [str] = "30"

                     'CustomerSegment' [str] = "default"

                     'IW_BundleUid' [str] = "31e24fed-d3eb-43f3-81ad-ee75d53e5eb7"

                     'IW_CaseUid' [str] = "e4b5822f-63ee-466c-9dd6-a0cdff9a69f6"

                     'IW_OwnerId' [int] = 101

                     'customer_segment' [str] = "vidyo"

                     'GuestLink' [str] = "https://genesys.alpha.vidyo.com/join/aelusrEq"

                  attr_ref_id [int] = 15

Interaction Server Error:

Trc 23102 Cannot resolve queue for submit while processing request 'RequestSubmit' from client 10:29, reference id: 15

Example Event Error Sent to Client:

Trc 26019 Sending message 'EventError' ('126') to client 'vidyo_001' - Agent application:10:29 through proxy 'WDE_Vidyo_irobot' - Proxy:9:29, message attributes:

                  attr_ref_id [int] = 15

                  attr_prxy_client_id [int] = 10

                  attr_error_code [int] = 91

                  attr_error_desc [str] = "Cannot resolve queue for submit"

 

In a successful case, a request submit is followed by multiple interaction server events.

Example of Successful Server Events:

Trc 26015 Received message 'RequestSubmit' ('101') from client 'WDE_Vidyo_irobot' - Proxy:18:29, message attributes:

                  attr_itx_type [str] = "Outbound"

                  attr_itx_subtype [str] = "OutboundNew"

                  attr_media_type [str] = "vidyo"

                  attr_queue [str] = "VidyoOut"

                  attr_prxy_client_id [int] = 19

                  attr_tenant_id [int] = 1

                  attr_prnt_itx_id [str] = "01QGKTATW6KG0004"

                  attr_user_data [list, size (unpacked)=1134] =

                     'parentMediaType' [str] = "vidyo"

                     'parentInteractionId' [str] = "01QGKTATW6KG0004"

                     'firstName' [str] = "Chloe"

                     'guestLinkURL' [str] = "http://192.168.2.129:7015/scxml/session/024GMFL6VSDEJ0TJG41AHG5AES000005/event/guestLink"

                     'vQueue' [str] = "vq_vidyo"

                     'aTimeout' [str] = "30"

                     'CustomerSegment' [str] = "default"

                     'IW_BundleUid' [str] = "839038f9-b8c5-4bfc-b168-f1abfcb1bb94"

                     'IW_CaseUid' [str] = "006aae7e-7981-479c-8ad4-6b1e49719eb2"

                     'IW_OwnerId' [int] = 101

                     'customer_segment' [str] = "vidyo"

                     'GuestLink' [str] = "https://genesys.alpha.vidyo.com/join/CeEP4ttZ"

                  attr_ref_id [int] = 17

Is followed by 'EventInteractionSubmitted' for reporting engines:

Trc 26020 Distributing message 'EventInteractionSubmitted' ('160'), message attributes:

                  attr_extension [list, size (unpacked)=46] =

                     'ReportingEventSequenceNumber' [str] = "206602358"

                  attr_actor_type [int] = 2 [AGENT]

                  attr_actor_tenant_id [int] = 1

                  attr_actor_place_id [str] = "vidyo_001"

                  attr_actor_agent_id [str] = "001"

                  attr_event_time [str] = "2018-05-02T12:28:01Z"

                  attr_itx_id [str] = "01QGKTATW6KG0005"

                  attr_itx_type [str] = "Outbound"

                  attr_itx_subtype [str] = "OutboundNew"

                  attr_itx_prnt_itx_id [str] = "01QGKTATW6KG0004"

                  attr_itx_tenant_id [int] = 1

                  attr_itx_queue [str] = "VidyoOut"

                  attr_itx_media_type [str] = "vidyo"

                  attr_itx_submitted_by [str] = "vidyo_001"

                  attr_itx_state [int] = 3 [HANDLING]

                  attr_itx_is_online [int] = 0

                  attr_itx_is_locked [int] = 0

                  attr_itx_received_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_submitted_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_delivered_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_placed_in_queue_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_moved_to_queue_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_submit_seq [str] = "206602357"

                  attr_itx_user_data [list, size (unpacked)=462] =

                     'parentMediaType' [str] = "vidyo"

                     'parentInteractionId' [str] = "01QGKTATW6KG0004"

                     'firstName' [str] = "Chloe"

                     'guestLinkURL' [str] = "http://192.168.2.129:7015/scxml/session/024GMFL6VSDEJ0TJG41AHG5AES000005/event/guestLink"

                     'vQueue' [str] = "vq_vidyo"

                     'aTimeout' [str] = "30"

                     'CustomerSegment' [str] = "default"

                     'IW_BundleUid' [str] = "839038f9-b8c5-4bfc-b168-f1abfcb1bb94"

                     'IW_CaseUid' [str] = "006aae7e-7981-479c-8ad4-6b1e49719eb2"

                     'IW_OwnerId' [int] = 101

                     'customer_segment' [str] = "vidyo"

                     'GuestLink' [str] = "https://genesys.alpha.vidyo.com/join/CeEP4ttZ"

                  attr_itx_is_held [int] = 0

                  attr_itx_assigned_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_assigned_to [str] = "001"

and by 'EventPartyAdded' for reporting engines:

Trc 26020 Distributing message 'EventPartyAdded' ('132'), message attributes:

                  attr_extension [list, size (unpacked)=46] =

                     'ReportingEventSequenceNumber' [str] = "206602359"

                  attr_actor_type [int] = 2 [AGENT]

                  attr_actor_tenant_id [int] = 1

                  attr_actor_place_id [str] = "vidyo_001"

                  attr_actor_agent_id [str] = "001"

                  attr_event_time [str] = "2018-05-02T12:28:01Z"

                  attr_reason [int] = 0

                  attr_reason_system_name [str] = "Create"

                  attr_reason_desc [str] = "New interaction submitted by agent"

                  attr_party_type [int] = 2 [AGENT]

                  attr_tenant_id [int] = 1

                  attr_place_id [str] = "vidyo_001"

                  attr_agent_id [str] = "001"

                  attr_itx_id [str] = "01QGKTATW6KG0005"

                  attr_itx_type [str] = "Outbound"

                  attr_itx_subtype [str] = "OutboundNew"

                  attr_itx_prnt_itx_id [str] = "01QGKTATW6KG0004"

                  attr_itx_tenant_id [int] = 1

                  attr_itx_queue [str] = "VidyoOut"

                  attr_itx_media_type [str] = "vidyo"

                  attr_itx_submitted_by [str] = "vidyo_001"

                  attr_itx_state [int] = 3 [HANDLING]

                  attr_itx_is_online [int] = 0

                  attr_itx_is_locked [int] = 0

                  attr_itx_received_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_submitted_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_delivered_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_placed_in_queue_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_moved_to_queue_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_submit_seq [str] = "206602357"

                  attr_itx_user_data [list, size (unpacked)=462] =

                     'parentMediaType' [str] = "vidyo"

                     'parentInteractionId' [str] = "01QGKTATW6KG0004"

                     'firstName' [str] = "Chloe"

                     'guestLinkURL' [str] = "http://192.168.2.129:7015/scxml/session/024GMFL6VSDEJ0TJG41AHG5AES000005/event/guestLink"

                     'vQueue' [str] = "vq_vidyo"

                     'aTimeout' [str] = "30"

                     'CustomerSegment' [str] = "default"

                     'IW_BundleUid' [str] = "839038f9-b8c5-4bfc-b168-f1abfcb1bb94"

                     'IW_CaseUid' [str] = "006aae7e-7981-479c-8ad4-6b1e49719eb2"

                     'IW_OwnerId' [int] = 101

                     'customer_segment' [str] = "vidyo"

                     'GuestLink' [str] = "https://genesys.alpha.vidyo.com/join/CeEP4ttZ"

                  attr_itx_is_held [int] = 0

                  attr_itx_assigned_at [str] = "2018-05-02T12:28:01Z"

                  attr_itx_assigned_to [str] = "001"

                  attr_operation [int] = 6 [CREATE]

and the 'EventAck' is sent to WDE:

Trc 26019 Sending message 'EventAck' ('125') to client 'vidyo_001' - Agent application:19:29 through proxy 'WDE_Vidyo_irobot' - Proxy:18:29, message attributes:

                  attr_ref_id [int] = 17

                  attr_prxy_client_id [int] = 19

                  attr_extension [list, size (unpacked)=38] =

                     'InteractionId' [str] = "01QGKTATW6KG0005"

WDE extracts the “InteractionId” and stores it for future business data reporting and interaction handling.

 

Business Data Not Attached to the Interaction

The business data about each participant is collected when the participant is active in the session. The reporting is based on the event, “VIDYO_CLIENT_OUT_EVENT_PARTICIPANTS_CHANGED”. In this case, the WDE from participant URI checking determines whether the participant joined or left the session.

Participant Processing Steps:

1. Join detected – create record with participant URI in WDE memory.
   
   
2. Handle data for share, mute/unmute actions and store it internally
   
   
3. Left Detected – update outbound vidyo interaction with participant user data.

The update interaction data happens when the participant leave, due to the number of requests distributed towards the interaction server from the WDE. All the data is distributed into one package.

Example Participant Joining Session

WDE Participant Joined:

DEBUG o.VidyoClientHandler - VidyoClientOutEvent message VIDYO_CLIENT_OUT_EVENT_PARTICIPANTS_CHANGED VidyoSessionStatus=ACTIVE VidyoAgentStatus=SIGNED_IN

…

DEBUG o.VidyoClientHandler - Update Interaction with participant Information

DEBUG idyo.VidyoIxnManager - UpdateParticipantInformation start participants count 1 interaction 01QGKTATW6KG0005

…

DEBUG idyo.VidyoIxnManager - Interaction 01QGKTATW6KG0005 New participant I Robot URI scip:CsAPI1525219691-669-951c60bcec18c868-75f1f856462236a2;transport=TLS joined sessionParties count 1

WDE Participant Left:

DEBUG o.VidyoClientHandler - VidyoClientOutEvent message VIDYO_CLIENT_OUT_EVENT_PARTICIPANTS_CHANGED VidyoSessionStatus=ENDING VidyoAgentStatus=SIGNED_IN

…

DEBUG idyo.VidyoIxnManager - UpdateParticipantInformation start participants count 1 interaction 01QGKTATW6KG0005

DEBUG idyo.VidyoIxnManager - Interaction 01QGKTATW6KG0005 Detect Participant left session

DEBUG idyo.VidyoIxnManager - Interaction 01QGKTATW6KG0005 Session Party left detected Chloe%20Varnet joined at 05/02/2018 11:29:05 left at 05/02/2018 11:45:52

DEBUG idyo.VidyoIxnManager - send request 'RequestChangeProperties' ('103')

message attributes:

attr_itx_id [str] = "01QGKTATW6KG0005"

attr_added_prop [bstr] = KVList:

                  'vidyo-session-party-1' [lst] = KVList:

                                    'joined' [str] = "2018-05-02T11:29:05.010Z"

                                    'left' [str] = "2018-05-02T11:45:52.907Z"

                                    'name' [str] = "Chloe%20Varnet"

 

attr_prxy_client_id [int] = 19

attr_ref_id [int] = 18
 

The request change properties with all the data inside is distributed to the interaction server as a single request. In case of an error, the interaction server responds with an event error to the WDE. To map to the event request use the following: reference id “attr_ref_id [int]”. The event error is logged into the interaction server logs and the out of the box behavior is the WDE opening a toaster window on the event error.

Vidyo Server

Vidyo Server Service Wrapper

Starting with version 18.3, you can install Vidyo server without using the nssm service wrapper. The new service wrapper allows administrator to use logs to debug service.

Starting and Stopping the Vidyo Server Using Windows Services

After installation of the Vidyo server is successful, the service is listed in Windows services. (For deployment information, see the Deploying VidyoEngage for Genesys article.)



You can start and stop the service using the the Start and Stop buttons.

Debugging the Start and Stop Process

Setting the service logger allows the user to see details of the startup procedure. Locate the log file and check if the Vidyo server Java process startup was successful.

Startup

The startup sequence starts with:

DEBUG   VidyoServerService - VidyoServerService Start ---------------- OnStart launched read config file

And ends with:

DEBUG   VidyoServerService - VidyoServerService Start ---------------- OnStart finished, adminport=<configured-admin-port>

If the startup was successful, the operating system will assign a process ID that can be found in logs:

DEBUG   VidyoServerService - Process is running under ID=15976.

The process can be found based on ID as shown in the example screenshot below. The service is running under the SYSTEM account:

Stop

The stop sequence starts with:

DEBUG   VidyoServerService - VidyoServerService Stop ---------------- OnStop launched

And ends with:

DEBUG   VidyoServerService - VidyoServerService Stop ---------------- OnStop finished gracefullShutdownOK=<result>

<result> can be True or False based on whether the shutdown was successful or not.

The shutdown procedure tries to connect to the admin port and send the shutdown request.

DEBUG   VidyoServerService - connect to Vidyo Server admin port IP=127.0.0.1 port=6543

The shutdown request may look like this:

DEBUG   VidyoServerService - Request shutdown sent to Vidyo Server {"Time":"2018-06-13:17:36:02","Reference":0,"Client":"VidyoServer","Message":"RequestShutDown","MessageId":1}

If it fails, it is not getting an answer from the Vidyo server, or it is not able to connect to the admin port, the running process is killed and the graceful shutdown procedure is stopped.

When the Vidyo server receives the shutdown message and starts the shutdown procedure, a similar message is sent to service stop.

DEBUG   VidyoServerService - Response to Shutdown message from server {"time":"2018-06-13 15:36:02","reference":0,"result":1,"message":"ShutdownInitiated"}

The Windows service starts a countdown in a loop where it checks the process ID. If the process ID is not found in running processes anymore, a graceful shutdown is finished successfully.

If the process is not stopped in 30 seconds, the graceful shutdown fails and the service will kill the VidyoServer process.

STOP VidyoServer from the GA is Giving an Access Denied Error

Windows

Make sure that the section start_stop and start_command/stop_command points to the correct Windows service. If the Windows service is not found, it can’t be properly stopped.

Linux

Make sure that the start_command and stop_command scripts are configured correctly and can be executed from the location where the Genesys LCA is deployed. The LCA does execution of those commands. If LCA can’t access the Vidyo scripts, the denied access error is published.

Vidyo Server Status Is Not Reported Properly in the Genesys Administrator

The Genesys LCA reports Vidyo server status based on command line attributes used to start the application. The reported status must match the configuration of the Vidyo server in the Genesys Administrator. If there is an SCS or LCA restart, the Vidyo server status may not be reported if the configuration of the application object and startup attributes do not match. The temporary solution is to restart the Vidyo server and it will report its status on reconnect proactively. Another solution is to fix configuration of the Vidyo server application object.

Windows

The Vidyo server running as a Windows service is executing command line attributes extended for options defined in the service configuration file. Locate the service startup logs and find “Vidyo Server startup=”. Set the Genesys application object Server Info -> Working Directory, Command Line and Command Line Attributes accordingly.

Example:

Service startup log:

DEBUG   VidyoServerService - Vidyo Server startup=c:\Java\jdk1.8.0_121\bin\java.exe  -jar VidyoServer-18.3.0.101.jar --servicename=VidyoServer1
 

Genesys Administrator Server info:

• Working Directory= c:\Java\jdk1.8.0_121\bin\
• Command Line=Java.exe
• Command Line Attributes= -jar VidyoServer-18.3.0.101.jar --servicename=VidyoServer1

For a Vidyo server started from the startup.bat file, open the batch file and fill the values stored in that file into the Genesys Administrator Vidyo Server application object.

Example:

Startup.bat:

start c:\Java\jdk1.8.0_121\bin\java -Dfile.encoding=UTF-8 -jar VidyoServer-18.4.0.101.jar

Genesys Administrator Server info:

• Working Directory= c:\Java\jdk1.8.0_121\bin\
• Command Line=Java.exe
• Command Line Attributes= -jar -Dfile.encoding=UTF-8 VidyoServer-18.4.0.101.jar
  
  

Linux

In a Linux environment, use the same procedure as for the Windows bat file and file command line arguments from the startup.sh file.

Example:

Startup.sh:

/usr/java/jdk1.8.0_121/bin/java -jar /opt/genesys/bin/vidyo/vidyo-server/VidyoServer-18.4.0.101.jar &

Genesys Administrator Server info:

• Working Directory=/usr/java/jdk1.8.0_121/bin
• Command Line=./java
• Command Line Attributes=-jar /opt/genesys/bin/vidyo/vidyo-server/VidyoServer-18.4.0.101.jar

For Linux installations, it is possible to verify the service command line by command ps –ef | grep VidyoServer. Command line attributes are mentioned in the process details.