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.
...
Configuration Item | Description | Value |
---|---|---|
Mobile SDK | (Webex iOS or Android SDK 3.0+) | No |
Integration Name | Name of your integration as it will appear in Webex. | VFC WebEx Meetings Ingestion |
Icon | Upload your own or select from our defaults. Must be exactly 512x512px in JPEG or PNG format. | Use VFC Logo provided. |
App Hub Description | What 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(s)://<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. The port number cannot be 443 as this is already used by the VFC Web Application. |
Scopes | Scopes define the level of access that your integration requires. | Select the following 3 scopes:
|
...
Configuration Item | Description | Value |
---|---|---|
Name | Mandatory. Name your Import Source. This name will identify the source across the system. | Recommended to include the import source type and purpose. |
Type | Mandatory. Import Source type | Select WebEx (not Cisco Spark) from the Import Type drop-down |
Webex Integration Client Id | Mandatory. Client Id value obtained during previous step of Webex creation integration. Used during OAuth authentication. | Example: M2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL0MzNWI4NmM0 ATg2Nzc3NmQxNzhiMjg1OGIwMTMzNTdiODJiMTFkZjVlNmM1N GhiZTlkOGNjNzYyMDcyMTU3M2Mz |
Webex Integration Client Secret | Mandatory. Client Secret value obtained during previous step of Webex creation integration. Used during OAuth authentication. | Example: 0c2e71a7f2628596ad856a9e6ab7efddead07d6b272dc2a2ef3f9fc4cf74d0b7 |
Webex Integration Redirect URI | Mandatory. URI called by Webex during authentication process. Same value used during configuration of the Webex integration. | http(s)://<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. The port number cannot be 443 as this is already used by the VFC Web Application. Must be exactly the same value used to configure the Webex Integration Redirect URI. Note case sensitivity and port restrictions. |
Forward Proxy Address | Optional. IP address or FQDN of the forward proxy. When defined, the system will connect through a forward proxy. | |
Forward Proxy Port | Optional. The port of the forward proxy. | |
Forward Proxy Username | Optional. Username for basic authentication for the forward proxy server. | |
Forward Proxy Password | Optional. Password for basic authentication for the forward proxy server. | |
Compliance Site URL | Optional. Compliance Officer's Webex site from which to retrieve recordings. If not specified, the user's default site will be used. | Example: <company name>.webex.com or normally leave blank. |
TLS Certificate File or Thumbprint | Optional. Certificate file / certificate thumbprint used for the Webex connection. | The default VFC CA Certificate can be used for HTTPS/TLS communications between Webex and the VFC Import Source by setting HTTPS in the Redirect URI and leaving all of these TLS settings empty: TLS Certificate File or Thumbprint TLS Key File TLS Key Password TLS Trust List |
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. | |
Transcode Video to Audio | Optional. Store audio-only version of recording. | Select required audio codec. |
Recording Timezone | Mandatory. VFC Server timezone. | Example: GMT +09:00 - Japan |
Webex Recording Start Timestamp | Mandatory. Timestamp of the earliest WebEx recording to be ingested. This can be a timestamp in the past, e.g., 2020, if historic Webex content is required to be ingested. The Import Source will gradually catchup with real-time as it is run by successive Data Management Policies, but will take longer to catch up depending on the number of historic recordings, the Maximum Recording Length and Availability Delay. In the case of mass historical ingest, it is recommended to set the Maximum Recording Length to a large number, e.g., 999 and reduce the Availability Delay to a small number, e.g., 10 minutes. Once the ingestion has caught up, adjust each of these parameters to their correct operational values. | Example: 2023.01.29 07:00:00 |
Webex Maximum Recording Length (minutes) | Mandatory. Maximum length of Webex content to be ingested. Content exceeding the maximum length may not be ingested or an alert generated. | Example: 60 |
Webex Availability Delay (minutes) | Mandatory. Maximum time the import source waits for a Webex meeting to become available for ingestion. If the meeting is not available after this time, it may not be ingested or an alert generated. | Example: 6030 |
On Completion Delete Recordings Stored in Webex | Optional. Allows VFC to become the single repository for Webex content. The recording deleted from Webex cannot be recovered, so this setting must be set with great care. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer. Only recordings of meetings hosted by the authenticated user can be deleted. | Tick to delete recordings from Webex immediately after VFC ingestion or leave unticked to have recordings both in Webex and in VFC. |
Authentication Keep-Alive (minutes) | Mandatory. Webex Authentication cannot be completed unless the VFC Import Source is running because it depends on an OAuth HTTP(S) callback from Webex to the Import Source. This is why the VFC Import Source must be saved and an Active Data Management Policy created. The callback provides VFC with an Access Token that Webex content ingestion depends upon. The Authentication Keep-Alive setting is a temporary configuration value which ensures the installation engineer has enough time to press the Authenticate Now button and authenticate with Webex before the VFC Import Source terminates inline with the VFC Data Management Policy. Once the engineer has completed Webex authentication, the Authentication Keep-Alive must be reduced to zero because the Access Token has been obtained and saved locally on the server where the VFC Import Source is run. When the Authentication Keep-Alive value is changed, the Import Service must be restarted. If the Authentication Keep-Alive is not set to zero and the import source is custom scheduled, it will not increment the Webex time boundary sliding window, so after the initial ingestion, no further content will be ingested. The Access Token is securely encrypted. This value can be changed at any time during production hours. The updated value will be used the next time the Data Management Policy runs the Import Source. | Example: 99 - During initial installation 2 - If a periodic check of the VFC Webex Token/Authentication status web page is required during production. 0 - During normal operation to avoid delay in completing processing of the Import Source. The value can be updated at any time if an adhoc check is required. |
Webex | Mandatory. Do not press this button until an active Data Management Policy has been created. Until the VFC Import Source has been saved with settings for all of the above values and an active Data Management Policy created, this button will not authenticate the VFC Import Source with Webex and content will not be ingested. Once authenticate now has been pressed, it should not be used except on the very rare occasion the integration has not been running for along time and the Webex Access Token has expired. | N/A |
...
http(s)://<VFC Hostname>:<VFC Port>
VFC Hostname is the name of the VFC server
VFC Port is the port opened in the customer firewall for Webex access.
7. Configure Users in VFC
...
In the event of failure to ingest Webex content, resilience is provided by the retry buffer. This contains VFC CDR files in XML format that failed to be ingested and must be retried. The Webex import source automatically adds a batch of up to 25 of these files to the current ingestion each time it runs. Once added, the XML file is removed from the retry buffer, but will automatically be re-added should the ingestion fail again. If the CDR is successfully ingested, it will appear in the ingestion status report alongside the other content. Files can be manually added or removed to the retry buffer if required for troubleshooting purposes. Retry buffer capability also enables the import source to track real-time as it enables historic failures to be retried.
Alternatively, if the Verba Import Service is required to be stopped for reasons of troubleshooting or maintenance, the manual procedure below must be used:
Step 1 - In the Verba web interface, disable the Data Management Policy associated with the Webex Import Source
Step 2 - Open windows explorer and navigate to Program Files\Verba\work\cdrimport\webex\laststate\policyId_importSourceId
Step 3 - Open the policyId_importSourceId.cursor file in notepad - it is one line and will look similar to:
c84f2f698fc9d64d64ed161d87b00c25_I_251182078220051266_19d0243a-9fd0-11d1-ac11-13453884b96c;2023.02.02 07:00:00.000
Step 4 - Set the timestamp to a date and time before the failure ensuring this timestamp plus the import batch duration and the recording lag is less than the current timestamp and then save the file.
Step 5 - Re-enable the Data Management Policy associated with the Webex Import Source
...
Folder Location | Purpose |
---|---|
Program Files\Verba\work\cdrimport\webex\work\policyId_importSourceId | Encrypted Token storage, temporary Webex content download. |
Program Files\Verba\work\cdrimport\webex\laststate\policyId_importSourceId | Cursor file containing current import status so that import source can be stopped and restarted from previous Webex Recording Start Timestamp value. The cursor file also contains the meeting identifier of the last ingested Webex content for monitoring and troubleshooting purposes. |
Program Files\Verba\work\cdrimport\webex\retryBuffer\policyId_importSourceId | Contains VFC CDR files in XML format that failed to be ingested and must be retried. The Webex import source automatically adds a batch of up to 25 of these files to the current ingestion each time it runs. Once added, the XML file is removed from the retry buffer, but will automatically be re-added should the ingestion fail again. If the CDR is successfully ingested, it will appear in the ingestion status report alongside the other content. Files can be manually added or removed to the retry buffer if required for troubleshooting purposes. Retry buffer capability also enables the import source to track real-time as it enables historic failures to be retried. |
11. Types of alerts raised by the Webex Import Source
...