...
add the following Licenses and Permissions
Webex Licenses | Webex Administrator roles |
|---|---|
Basic Messaging | Organizational: Read-only administrator |
Basic Space Meetings | Services: Webex Read-only Administrator |
Webex Meetings |
Webex Integration Account
...
Permissions in test_mate Webex API v2.5.17
...
Webex Permission enabled
...
Scope
...
☑
...
meeting:schedules_read
...
☑
...
meeting:schedules_write
...
☑
...
meeting:recordings_read
...
☑
...
meeting:recordings_write
...
meeting:preferences_read
...
meeting:preferences_write
...
☑
...
meeting:controls_read
...
☑
...
meeting:controls_write
...
☑
...
meeting:participants_read
...
☑
...
meeting:participants_write
...
☑
...
meeting:admin_participants_read
...
spark-admin:telephony_config_read
...
spark-admin:telephony_config_write
...
☑
...
meeting:admin_schedule_read
...
☑
...
meeting:admin_schedule_write
...
meeting:admin_recordings_read
...
meeting:admin_recordings_write
...
☑
...
meeting:admin_transcripts_read
...
meeting:admin_preferences_write
...
meeting:admin_preferences_read
...
spark-compliance:meetings_read
...
☑
...
meeting:transcripts_read
...
spark-compliance:meetings_write
...
☑
...
spark-admin:workspace_locations_read
...
spark-admin:workspace_locations_write
...
spark-admin:workspace_metrics_read
...
spark-admin:broadworks_billing_reports_read
...
spark-admin:broadworks_billing_reports_write
...
spark:allFull
...
☑
...
spark:calls_read
...
☑
...
spark:devices_read
...
spark:devices_write
...
spark:memberships_read
...
spark:memberships_write
...
spark:messages_read
...
spark:messages_write
...
☑
...
spark:organizations_read
...
☑
...
spark:people_read
...
spark:people_write
...
☑
...
spark:places_read
...
spark:places_write
...
☑
...
spark:rooms_read
...
spark:rooms_write
...
spark:team_memberships_read
...
spark:team_memberships_write
...
spark:teams_read
...
spark:teams_write
...
☑
...
spark:xapi_statuses
...
☑
...
spark:xapi_commands
...
☑
...
spark:xsi
...
spark-admin:devices_read
...
spark-admin:devices_write
...
☑
...
spark-admin:licenses_read
...
☑
...
spark-admin:organizations_read
...
spark-admin:organizations_write
...
☑
...
spark-admin:people_read
...
spark-admin:people_write
...
☑
...
spark-admin:places_read
...
spark-admin:places_write
...
☑
...
spark-admin:resource_group_memberships_read
...
spark-admin:resource_group_memberships_write
...
☑
...
spark-admin:resource_groups_read
...
☑
...
spark-admin:roles_read
...
☑
...
spark-admin:call_qualities_read
...
☑
...
spark-admin:workspaces_read
...
spark-admin:workspaces_write
...
☑
...
spark-admin:xsi
...
☑
...
spark-compliance:events_read
...
☑
...
spark-compliance:memberships_read
...
spark-compliance:memberships_write
...
☑
...
spark-compliance:messages_read
...
spark-compliance:messages_write
...
☑
...
spark-compliance:rooms_read
...
spark-compliance:rooms_write
...
☑
...
spark-compliance:team_memberships_read
...
spark-compliance:team_memberships_write
...
☑
...
24 - Note that new scopes may be added by Cisco
| Note |
|---|
Yarnman Powered by Photon ( V 2.6.2 and higher )has a different set of scopes and configuration , Refer to https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2918973483/Yarnman+Photon+Interfaces Below is a reference only for previous versions for webex permissions. |
Webex Permission enabled | Scope |
|---|---|
☑ | meeting:schedules_read |
☑ | meeting:schedules_write |
☑ | meeting:recordings_read |
☑ | meeting:recordings_write |
☑ | meeting:controls_read |
☑ | meeting:controls_write |
☑ | meeting:participants_read |
☑ | meeting:participants_write |
☑ | meeting:admin_participants_read |
☑ | meeting:admin_schedule_read |
☑ | meeting:admin_schedule_write |
☑ | meeting:admin_transcripts_read |
☑ | meeting:transcripts_read |
☑ | spark-admin:workspace_locations_read |
☑ | spark:calls_read |
☑ | spark:devices_read |
☑ | spark:organizations_read |
☑ | spark:people_read |
☑ | spark:places_read |
☑ | spark:rooms_read |
☑ | spark:xapi_statuses |
☑ | spark:xapi_commands |
☑ |
|
☑ | spark-admin:licenses_read |
☑ | spark-admin:organizations_read |
☑ | spark-admin:people_read |
☑ | spark-admin:places_read |
☑ | spark-admin:resource_group_memberships_read |
☑ | spark-admin:resource_groups_read |
☑ | spark-admin:roles_read |
☑ | spark-admin: |
call_ |
qualities_read |
☑ |
spark-admin: |
workspaces_ |
read |
☑ |
spark-compliance: |
events_ |
read | |
☑ | spark-compliance: |
memberships_read |
spark:calls_write
☑ | spark- |
compliance:messages_read | |
☑ | spark- |
compliance: |
rooms_ |
read | |
☑ | spark- |
compliance: |
team_ |
memberships_ |
read | |
☑ | spark- |
compliance: |
teams_read | |
☑ | spark-admin:broadworks_ |
enterprises_read |
☑ |
identity: |
placeonetimepassword_ |
create |
☑ |
Identity: |
one_time_ |
password |
☑ |
spark-compliance: |
webhooks_read | |
☑ | spark-admin:wholesale_billing_ |
reports_ |
read | |
☑ | spark-admin: |
hybrid_ |
clusters_read | |
☑ | spark-admin: |
hybrid_ |
connectors_ |
read | |
☑ | spark-admin: |
identity:tokens_write
broadworks_subscribers_read |
identity:tokens_read
☑ | analytics:read_all |
☑ | audit:events_read |
Webex Edge for Devices
Required for non-cloud registered devices.
...
https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps
Microsoft Graph | Type |
|---|---|
Calendars.Read | Application |
Calendars.ReadWrite | Application |
OnlineMeetingArtifact.Read.All | Application |
OnlineMeetings.Read.All | Application |
OnlineMeetings.ReadWrite.All | Application |
User.Read.All | Application |
CallRecords.Read.All | Application |
Create a Client Secret ID with the duration timeframe per your security standards.
| Info |
|---|
Please note the Client Secret ID Value, as it won't be shown again. |
| Note |
|---|
The application registration can be restricted to specific user mailboxes using the following process https://docs.microsoft.com/en-us/graph/auth-limit-mailbox-access |
Webex interface setup
Log in to Yarnman, open Administration App-> Interfaces.
...
Define meeting settings as required, followed by either Save Only to run the test later or Save & Run to execute the test now.
Static Meeting Settings
Setting | Description |
|---|---|
Name | Name of the test plan. |
Destination | sip URI or PhoneNumber. |
Force Existing Call Teardown | test_mate will end any active calls on the endpoints before executing the test plan. |
Mute Devices During Test | test_mate will signal to Mute the Microphone on the endpoint during the test. |
Pause Before MeetingID (secs) | The number of seconds test_mate waits before sending DTMF digits for the MeetingID after the call Connects. |
Pause Before PIN (secs) | The number of seconds test_mate waits before sending DTMF digits for the Pin after the call Connects. |
Webex Account / Interface | Select the Webex account/interface used to control the endpoints. |
Endpoints Find Endpoints | Launches endpoint selector window. |
Endpoints Sync Webex Now | Synchronises endpoints for any new or removed endpoints. |
Endpoint Quality Monitoring | Enable or Disable Quality monitoring. |
Packet Statistics Wait (secs) | the number of seconds the call is left connected to allow statistics to be collected |
Test Content Sharing | TBC |
Schedule Test Run | TBC |
Scheduled Calendar invite Test Plan
...
Scheduled Common Meeting Settings
Setting | Description |
|---|---|
Name | Name of the test plan. |
Meeting Name | The subject of the meeting (displayed in the calendar invite) |
Meeting Method | Select the meeting integration to be used, e.g. Microsoft Teams with CVI. |
Meeting Location | Depending on the integration, the location field within the meeting invite may be required to have a specific format/value. |
Force Existing Call Teardown | test_mate will end any active calls on the endpoints before executing the test plan. |
Mute Devices During Test | test_mate will signal to Mute the Microphone on the endpoint during the test. |
Removing Meeting After Test | After the test plan has been completed, remove the calendar invite. This is useful to remove any room reservations and clean up the calendar. |
Meeting Create Then Start Pause (secs) | The number of seconds test_mate waits before creating the meeting invite when the test is executed. |
Max Waiting Time For Device Acceptance (secs) | The number of seconds test_mate for meeting rooms to accept the invite. |
Calendar Check Polling Interval For Acceptance (secs) | The number of seconds test_mate checks in each interval to accept the calendar invite. |
Max Waiting Time For Meeting Body Update (secs) | The number of seconds test_mate waits for the meeting to be updated with the SIP URI details required to make the video call. |
Polling Interval For Meeting Body Update (secs) | The number of seconds test_mate checks for the SIP URI details in each interval. |
Pause Before PIN (secs) | The number of seconds test_mate waits before sending DTMF digits for the Pin after the call Connects. |
Wait Before Loading Webex Meeting (secs) | The number of seconds test_mate waits before validating each endpoint has joined the meeting and being admitted (if supported by the meeting type) successfully. |
Webex XAPI Request Pause After Error (secs) | Test_mate waits for the number of seconds test_mate waits after receiving a Xapi error to an endpoint command. |
Webex XAPI Request Retries After Error | The maximum number of retries test_mate attempts to a Xapi command. |
Microsoft Graph Interface | Select the Microsoft graph application registration user. |
Calendar User | Selects the Calendar user to schedule meetings for testing. |
Webex Account / Interface | Select the Webex account/interface used to control the endpoints. |
Endpoints Find Endpoints | Launches endpoint selector window. |
Endpoints Sync Webex Now | Synchronises endpoints for any new or removed endpoints. |
Endpoint Quality Monitoring | Enable or Disable Quality monitoring. |
Packet Statistics Wait (secs) | the number of seconds the call is left connected to allow statistics to be collected |
Test Content Sharing | TBC |
Schedule Test Run | TBC |
Cisco CVI / Microsoft Teams meeting
Endpoints are available to make a call.
Apply specific meeting settings (e.g. mute endpoints before calling).
Creates an online meeting via the Microsoft Graph interface (simulates an end-user creating the meeting in outlook).
Endpoints have accepted or declined the meeting in their calendar.
Dials the CVI bridge number that is dynamically generated with the online meeting.
Joins all endpoints to the call and confirms they have connected.
Collects meeting participants and meeting qualities if available from the provider.
Disconnect the endpoints
Any other after meetings tasks (e.g. Delete meeting invite).
...
Setting | Description |
|---|---|
Collect Attendance Reports | Collects meeting qualities if available from the provider. |
Wait After Meeting For Attendance Reports (secs) | Number of seconds test_mate waits before retrieving stats from the provider. |
...
Cisco Webex using @meet @webex
Endpoints are available to make a call.
Apply specific meeting settings (e.g. mute endpoints before calling).
Creates a regular meeting (e.g. without selecting teams) via the Microsoft Graph interface (simulates an end-user creating the meeting in outlook).
Endpoints have accepted or declined the meeting in their calendar.
Dials the Webex @webex or @meet details dynamically generated by Webex parsing the location field.
Joins all endpoints to the call and confirms they have connected.
Collects meeting participants and meeting qualities if available from the provider.
Disconnect the endpoints
Any other after meetings tasks (e.g. Delete meeting invite).
...
Setting | Description |
|---|---|
Location @meet | @meet is a keyword that triggers a Webex integration within the calendaring service, which uses the Webex personal meeting room for the invite. |
Location @webex | @webex creates a one-time meeting with associated Webex space for the invite. |
Collect Webex Stats Report | Collects meeting qualities if available from the provider. |
Wait After Meeting For Webex Stats (secs) | Number of seconds test_mate waits before retrieving stats from the provider. |
refer to the following link for the Microsoft Webex location integration https://help.webex.com/en-us/article/nwtulzs/Webex-App-%7C-Schedule-a-meeting-using-@webex-or-@meet
...
Refer to the following for further information.
Webex Call routing
Cloud Registered
Video calls will route within Webex as normal
Webex Call routing -
...
SIP
Video calls will route via the existing signalling path, e.g. via an expressway to the internet to Webex.
...