Companywebcast API Wiki

Table of Contents [Hide/Show]


Edit

Basic principals

Cwc.Downloader allows customers and partners to download all binaries and metadata from archived webcasts, and store them locally. Source is included in the application's zip file, and is licensed under Creative Commons. This allows you to freely use and modify the code for your own needs.

Cwc.Downloader is a command line utility for Windows that requires the .Net runtime version 2.0 to be available on the local machine. When you run CwcDownloader.exe, it will look at Default.xml and then run based on the configuration settings it finds in that file.

The configuration file allows the user to indicate which types of files to download, and where to store them. You can create multiple configuration files, and then run Cwc.Downloader based on one specific configuration.

It works like this; when you run :

CwcDownloader.exe

Cwc.Downloader will run based on Default.xml. If you create additional configuration files, for example "AlternateConfig.xml", you would then run CwcDownloader like this :

CwcDownloader.exe AlternateConfig.xml

The general idea is that you create configuration files based on your particular needs, and then add them to Windows Task Scheduler to run at intervals.

Typical scenario's are:

  • Download all binaries and meta data of webcasts so you can archive them locally
  • Download only the meta data so you can integrate it with your search application



Edit

Configuring Cwc.Downloader

This is what Default.xml looks like when you unzip it:

<?xml version="1.0" encoding="utf-8"?>
<DownloadConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Username>testuser</Username>
  <Password>0123456789</Password>
  <RetrieveWebcastAttachments>false</RetrieveWebcastAttachments>
  <RetrieveWebcastStreams>false</RetrieveWebcastStreams>
  <RetrieveTopicAttachments>false</RetrieveTopicAttachments>
  <RetrieveSlideAttachments>false</RetrieveSlideAttachments>
  <ExportWebcastXML>true</ExportWebcastXML>
  <ReplaceIfExists>false</ReplaceIfExists>
  <FilePath>c:\Cwc.Downloader.inc</FilePath>
  <CustomerName xsi:nil="true" />
  <PeriodFrom xsi:nil="true" />
  <PeriodTo xsi:nil="true" />
  <DaysAgoFromTodayPeriodFrom xsi:nil="true" />
  <DaysAgoFromTodayPeriodTo xsi:nil="true" />
  <UseProxyMode>false</UseProxyMode>
</DownloadConfig>

  • Username
Enter the username that has been provided to you by Company Webcast specifically for consuming the Meta Service
  • Password
Enter the password that has been provided to you by Company Webcast specifically for consuming the Meta Service
  • RetrieveWebcastAttachments
A Boolean (true / false). Set to true if you want to download attachments that exist on the Webcast level. Typically this consists of mp3 conversions of a webcast and PDF and Swf conversions of Powerpoint presentations.
  • RetrieveWebcastStreams
A Boolean (true / false). Set to true if you want to download the Windows Media files of the Webcasts you are downloading.
  • RetrieveTopicAttachments
A Boolean (true / false). Set to true if you want to download attachments that exist on the Topic level. Typically this consists of mp3 conversions of a Topic, as well as any documents that may have been included with a Topic.
  • RetrieveSlideAttachments
A Boolean (true / false). Set to true if you want to download attachments that exist on the Slide level. Typically this consists of bitmap and swf conversions of a single Powerpoint slide.
  • ExportWebcastXML
A Boolean (true / false). Set to true if you want to export XML files that contain all meta data related to a Webcast.
  • ReplaceIfExists
A Boolean (true / false). Set to true if you want Cwc.Downloader to replace files that already exist on the file system with the same name.
  • FilePath
A string. Enter the path where you want Cwc.Downloader to save the files.
  • CustomerName
A string. Leave this empty for most scenario's, it only has value if you Meta Service account has access to multiple customers.
  • PeriodFrom
A DateTime. This indicates the start date from which you want to download Webcast data. You can leave this empty if you want to download everything from the very first webcast in the system.
  • PeriodTo
A DateTime. This indicates the end date to which you want to download Webcast data. You can leave this empty if you want to download everything up to right now.
  • DaysAgoFromTodayPeriodFrom
An Integer. This behaves the same as PeriodFrom, but allows you to offset the start date relative to right now. So if you enter 10 here, Cwc.Downloader will fetch Webcasts that are 10 days old and newer.
  • DaysAgoFromTodayPeriodTo
An Integer. This behaves the same as PeriodTo, but allows you to offset the end date relative to right now. So if you enter 10 here, Cwc.Downloader will fetch Webcasts that are 10 days old and older.
  • UseProxyMode
A Boolean (true / false). Ignore this for now.



Edit

Download Cwc.Downloader

Get Cwc.Downloader here.