Skip to end of banner
Go to start of banner

Webex

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Cisco Webex is an app-centric, cloud-based service that provides a complete collaboration suite for teams to create, meet, message, call, care, white board, and share, regardless of whether they’re together or apart—in one continuous workstream before, during, and after meetings. It is built to help teams work seamlessly. It is simple, secure, complete, and open, and provides a space for people to work better. The core capabilities of Cisco Webex are Meetings, Messaging, and Calling. The Cisco Webex platform, app-centric design, hybrid services, and architecture of Cisco Webex create a unique and differentiated service.  For more information on the solution, refer to Cisco Webex.

Cisco Webex Meetings provides a Messaging API that VFC is able to use to retrieve content from Webex Rooms.

The Webex Import Source uses the Webex Messaging API to list and download available recordings, query and add participants prior to ingest.

Separate recordings are created for each recorded Webex user.  Each recording contains details of all meeting participants.


For a general description of Verba Import sources, please refer to Import sources.

Recording is supported for the following modalities only:

  • MP4 Video


1. Prerequisites

Two components, a Cisco Webex integration application and a VFC Import Source are required.

Firewall access must be arranged as two way internet communication is required between the Import Source and Webex.  The Import Source server and port number is specified in the Webex Integration redirect URI.  It is fully configurable and can be over HTTP or secured via TLS over HTTP.

2. Create a Cisco Webex Integration

To create a Webex integration, a Webex account backed by Cisco Webex Common Identity (CI) is required. If no Webex account is available, sign up. If you're using Webex Meetings, your site will must be on Common Identity.  Typically, the user creating the API Integration needs to be the Compliance Officer on Webex.  Navigate to https://developer.webex.com/my-apps and press the Create a new app button.  Then press the Create an integration button to create an OAuth Integration.


Configuration Item

Description

Value
Mobile SDK
(Webex iOS or Android SDK 3.0+)
No
Integration NameName of your integration as it will appear in Webex.VFC WebEx Meetings Ingestion
IconUpload your own or select from our defaults. Must be exactly 512x512px in JPEG or PNG format.Use VFC Logo provided.
App Hub DescriptionWhat does your app do, how does it benefit users, how do users get started? Does your app require a non-Webex account? If your app is not free or has additional features for paid users, please note that and link to pricing information. 1024 character limit.

VFC WebEx Meetings Ingestion. 

(Note the application will not be shared on the app hub at present.)

Redirect URI(s)

One or more URIs that a user will be redirected to when completing an OAuth grant flow.


http://<VFC Hostname>:<VFC Port>/Webex/RedirectURI/OAuth

VFC Hostname is the name of the VFC server

VFC Port is the port opened in the customer firewall for Webex access.

Make a note of this value as it is also required when configuring the VFC Webex import source.

Scopes

Scopes define the level of access that your integration requires.

Select the following 3 scopes:

    • meeting:recordings_read
    • meeting:recordings_write
    • meeting:participants_read


Once all the integration values have been entered, press the Add Integration button.  Make a note of the two important values shown, Client Id and Client Secret.  They are required during the next step, configuration of the VFC Webex Import Source.


3. Create a WebEx Import Source

Follow the steps in VFC to create a new Import source:

Step 1 - Open the VFC Web interface then select Data > Import Sources from the top menu

Step 2 - Click on the Add New Import Source link on the top right.

Step 3 - Complete the configuration according to the requirements in the following table

Configuration Item

Description

Value
NameName your Import Source. This name will identify the source across the system.Recommended to include the import source type and purpose.
TypeImport Source typeSelect WebEx (not Cisco Spark) from the Import Type drop-down
Webex Integration Client Id

Client Id value obtained during previous step of Webex creation integration.

Example:

M2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL0MzNWI4NmM0

ATg2Nzc3NmQxNzhiMjg1OGIwMTMzNTdiODJiMTFkZjVlNmM1N

GhiZTlkOGNjNzYyMDcyMTU3M2Mz

Webex Integration Client Secret

Mandatory Port Number of ACR CRS (Central Replay Server)

Example:

0c2e71a7f2628596ad856a9e6ab7efddead07d6b272dc2a2ef3f9fc4cf74d0b7

TLS Certificate File or ThumbprintOptional certificate file / certificate thumbprint used for the ACR connection.
TLS Key File

Optional file system location where the certificate key is stored.


TLS Key Password

Specify the password for the file that contains the certificate keys.


TLS Trust List

Certificate chain (or Chain of Trust) is made up of a list of certificates that start from a server's certificate and terminate with the root certificate. If your server's certificate is to be trusted, its signature has to be traceable back to its root CA.


ACR API User

Mandatory ACR user that must be created with API permission before this Import Source is used.


ACR API PasswordMandatory ACR user password that is set the first time the Import Source is used. N.B. The ACR API user must not have a password set when it is created, instead the import source ACR API Password will be set and used automatically.
ACR Layout NameMandatory ACR search layout name created before this Import Souce is used.
ACR TimezoneMandatory. Set to the timezone of the ACR CRS, in case it is in a different timezone from the ingesting VFC server.
Recording Import Batch Size (minutes)

Mandatory. Every time the Import Source is run by the Data Management Policy, it attempts to retrieve ACR recordings within this time range, progressing the batch via the recording start and end timestamp.

While a larger batch size retrieves more records, it must not exceed the duration of the timeslot available for processing.


Recording Start TimestampMandatory. Start timestamp of the first ACR recording to be migrated.
Recording End TimestampMandatory. Timestamp of the last ACR recording to be migrated.


Step 4 - Click Save to save the settings

Import Policy Configuration

Follow the steps below to configure the Data Import action:

Step 1 - In the Verba web interface, navigate to Data > Data Management Policies

Step 2 - Click on the Add New Data Management Policy button at the top-right corner of the page

Step 3 - For the action, select Data Import

Step 4 - Under Available Import Sources, select the Import Source that you created, then click on the Add button just below the text field

Step 5 - Configure the policy details, based on the information that is shown in the configuration items summary table below

Step 6 - Set up how frequently the Import should be run in the Scheduling section

Step 7 - Click on Save


Configuration Parameter Name

Description

Enable Recording RulesSpecifies if all data should be processed in the imported data set or just the records of the recorded users as configured in Verba
Execute Only on Selected Servers

If enabled, a specific server can be chosen that will run this policy

Types of alerts raised by the ACR Import Source

Alert Message

Explanation

Could not parse configuration of sourceProblem with Import Source configuration setting.

Unexpected problem with underlying VFC database/filesystem

Could not connect to database or write file to local disc, check firewall and disc permissions.

Failure to process Call Metadata

Unexpected or unavailable ACR call metadata values.
Failure to communicate with ACRFirewall or network configuration problem.
No more ACR recordings availableBatch start time exceeds the last ACR recording timestamp.
Detected no recorded parties in a recordingNo recording owner found in customer custom metadata.
Failed to retrieve media from ACRMedia unavailable or download interrupted.
Unable to find expected ACR call metadataEither standard or ACR extended call metadata could not be extracted.
Could not obtain time zone offsetsTimezone offsets could not be extracted from the VFC database.

Migration Status Reporting

No report files are generated, however at the end of each batch, a notification alert is raised containing details of recordings migrated from ACR into VFC.

ACR metadata

The system captures the following metadata specific to ACR recordings. These fields are available through the standard and the ACR specific custom metadata template.

Metadata Field

Description

Template

Available

Start DateStart date of the conversationStandardYes
Start TimeStart time on the conversationStandardYes
End DateEnd date of the conversationStandardYes
End TimeEnd time of the conversationStandardYes
DurationLength of the conversationStandardYes
UserName of the recorded userStandardYes
FromSubscriber / Third Party Phone numberStandardYes
From InfoUser / contact nameStandardYes
ToSubscriber / Third Party phone numberStandardYes
To InfoUser / contact nameStandardYes
DirectionDirection of the call from the system perspective, requires configuring internal number/domain patternsStandardYes
Direction (User)Direction of the call from the recorded user perspectiveStandardYes
From (Verba)Verba user name associated with the From NumberStandardYes
To (Verba)Verba user name associated with the To numberStandardYes
LocationHostname of the recording serverStandardYes
End CauseNormal, Hold, Transfer, Conference, Device Change, From Terminated, To TerminatedStandardNo
Audio CodecAudio codec of the recorded streamsStandardNo
Video codecVideo codec of the recorded streamsStandardNo
Platform Call IDUnique conversation identifier received from the recorded platformStandardYes
Silence RatioRatio of silence in the conversationStandardNo
Talkover RatioTalkover ratio of the conversationStandardNo
Longest SilenceLength of the longest silence present in the conversationStandardNo
User ID / Agent IDUser IDStandardYes
From DeviceDevice ID of the calling partyStandardNo
To DeviceDevice ID of the called partyStandardNo
Dialed NumberOriginal dialed numberStandardNo
From IPIP address associated with the calling partyStandardNo
To IPIP address associated with the called partyStandardNo
From Proxy IPIP address of the proxy server associated with the caller partyStandardNo
To Proxy IPIP address of the proxy server associated with the called partyStandardNo
Source PlatformACRStandardYes
Conversation TypeVoiceStandardYes
Forward ReasonForward reason for the conversation (e.g. forwarded, transferred, team call, delegated, etc.) StandardNo
Recording failedIndicates if the recording has failed and the metadata was imported during CDR reconciliationStandardNo
Media LengthLength of the media file related to the conversation in hhh:mm:ss formatStandardNo
Media ErrorShows the media processing errors during recordingStandardNo
Voice QualityOverall voice quality check score for the conversationStandardNo
Record TypeStandardStandardYes
2N SourceIn case of duplicate (2N) recording, records are marked as primary or secondaryStandardNo
UDFsAll standard ACR User Defined FieldsACRYes
AgentsCustomer custom metadataACRYes
ServicesCustomer custom metadataACRYes
SkillsCustomer custom metadataACRYes
Other PartiesCustomer custom metadataACRYes
FingerprintCustomer custom metadataACRYes
  • No labels