Installation and Configuration

Telligent Professional Services Extensions

Telligent Professional Services Extensions
Group to contain all documentation and information regarding professional services extensions and add-on modules.

Telligent Event Calendar Documentation

Installation and Configuration

Telligent Event Calendar Documentation

Telligent Event Calendar v1.6 is only compatible with Telligent Enterprise 2.6 and Telligent Community 5.6. In the same respect, versions of the Telligent Event Calendar prior to 1.6 are not compatible with Telligent Community 5.6 or Telligent Enterprise 2.6. If you wish to take advantage of the features available in Telligent Event Calendar 1.6 then you must upgrade to to either Telligent Enterprise 2.6 or Telligent Community 5.6.

This installation guide only applies to v1.6 of the Telligent Event Calendar. For older versions please contact us.

Installing Web Files

***It is recommended, that you backup. your entire web directory before performing any installs.

  1. Copy the contents of /Web to your web installation directory.  The /Web folder contents of the installation package mirrors the Telligent Community/Enterprise web structure.
  2. If you do not have a communityserver_override.config, rename the file communityserver_override.config.sample to communityserver_override.config.  If you already have a communityserver_override.config file. merge the contents of communityserver_override.config.sample into your communityserver_override.config file, then remove communityserver_override.config.sample.
  3. If you do not have a siteurls_override.config, rename the file siteurls_override.config.sample to siteurls_override.config.  If you already have a siteurls_override.config file. merge the contents of siteurls_override.config.sample into your siteurls_override.config file, then remove siteurls_override.config.sample.
  4. Merge the contents of /Web/Languages/en-US/ControlPanelResources.xml.sample into your ControlPanelResources.xml, then remove ControlPanelResources.xml.sample.
  5. The calendar comes with styles for the “fjij” theme(Telligent Community) and “evolution2” (Telligent Enterprise).  If you use a custom theme, these steps may not apply.  In order to finish the installation of some theme components you must follow the following steps(For the next steps, “ThemeName” will refer to either “fiji” or “evolution2” depending on your current product and theme).
    1.  
      1. For all themes, merge the <MarkupTranslations /> from the theme.config.sample file to the following files according to the instructions in that file.  If the <MarkupTranslations /> node of the theme.config file in your Blog and Group themes is set to inherit="true", then it is not necessary to add these to those theme.config files.
      2. In the theme.config file, you must add reference to the css file for the calendar. By default when you copied the web files, calendar.css was added to YourWebFolder/Themes/ThemeName/Css/calendar.css. To add the css reference, find in the above files the <PageHeader /> node that adds the reference to screen.css.  Copy the entire screen.css link and paste directly below it, then rename screen.css to calendar.css.  Here is an example <PageHeader /> for “Fiji”.  “evolution2” would be identical except the word evolution2 would replace the word fiji. If the <PageHeader /> node of the theme.config file in your Blog and Group themes is set to inherit="true", then it is not necessary to add this to those theme.config files.
        <PageHeader inherit="true">
        <Markup>
        <![CDATA[
        <meta http-equiv="X-UA-Compatible" content="IE=7" />
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
        <link rel="shortcut icon" type="image/ico" href="~/themes/fiji/favicon.ico" />
        <link type="text/css" rel="stylesheet" href="~/themes/fiji/css/screen.css" media="screen,print" />
        <link type="text/css" rel="stylesheet" href="~/themes/fiji/css/calendar.css" media="screen,print" />
        ]]>
        </Markup>
        </PageHeader>

Installing SQL Files

***It is recommended that you do a full database backup before installing SQL.

The installation package contains a folder called /SqlScripts which contains the necessary SQL files. The SQL files are pre-pended with a version number.  This version should match the assembly version of Telligent.Services.Calendar.dll in /Web/bin.  Always make sure these values match before applying.

  1. Execute 1.0.0.0000_Schema.sql on your Telligent product database, where 1.0.0.0000 is the version of the calendar you are installing.
  2. Execute 1.0.0.0000_Procedures.sql on your Telligent product database, where 1.0.0.0000 is the version of the calendar you are installing.

Group Application Navigation

In order to support navigation for the Telligent Event Calendar you need to replace the standard Group Application Navigation widget on every page necessary with the Event Calendar- Group Application Navigation widget.  This adds the calendar tab to the standard tabs.

Installing Tasks and Search

In order for search to function, you must install the content handlers.  To do so, in the directory you installed the Telligent Job Scheduler, locate the tasks.config file and edit it.  Find the CommunityServer.Search.Tasks.SearchIndexingContentHandlerTask and after the default handlers add the calendar and event content handlers as illustrated below, where XX is the next sequential number.

 

    <job schedule="0 */2 * * * ? *" type="CommunityServer.Search.Tasks.SearchIndexingContentHandlerTask, CommunityServer.Search">
<settings>
<add key="documentsPerRun" value="100" />
...(Default Content Handlers)...
<add key="handler-XX" value="Telligent.Services.Calendar.Search.CalendarContentHandler, Telligent.Services.Calendar" />
<add key="handler-XX" value="Telligent.Services.Calendar.Search.CalendarEventContentHandler, Telligent.Services.Calendar" />
</settings>
</job>

Locate the Tasks folder in the Calendar installation package and copy the remaining jobs into the node of your Job Scheduler's tasks.config file.

You will also need to copy the following files from the installation package to their respective places in the installation directory or the job scheduler service:(note: * means all, e.g. *.dll means all files with the extension of .dll)

  • Copy Web/bin/*.dll to the root of the Job Scheduler installation(same location as the .exe file).
  • Copy Web/Modules/*.config to the Modules folder in the Job Scheduler installation.
  • Copy All files and folders from Web/Languages to the same folder in the Job Scheduler installation.
  • If there is not already a file communityserver_override.config file in the Job Scheduler installation directory, copy the Web/communityserver_override.config.sample file to the Job Scheduler installation renaming it to communityserver_override.config.  If it already exists, merge the contents of these files as you did when installing the web files.
  • If there is not already a file siteurls_override.config file in the Job Scheduler installation directory, copy the Web/siteurls_override.config.sample file to the Job Scheduler installation renaming it to siteurls_override.config.  If it already exists, merge the contents of these files as you did when installing the web files.

 

Restart your Job Scheduler Service.

If you are running the Job Scheduler with Database Persistence

This doesn't apply if you are using the Quartz RamJobStore.

You must clear the database state for the Search Indexing job or it will not recognize the new calendar content handlers. Stop the job Scheduler service and run the following SQL on your database to do so:

DELETE FROM QRTZ_TRIGGERS WHERE TRIGGER_NAME='CommunityServer.Search.Tasks.SearchIndexingContentHandlerTask, CommunityServer.Search'
DELETE FROM QRTZ_JOB_DETAILS WHERE JOB_NAME = 'CommunityServer.Search.Tasks.SearchIndexingContentHandlerTask, CommunityServer.Search'

Restart your Job Scheduler Service.


Installing The Calendar With a Custom Theme

In the scenario where you are not using either "fiji" for Telligent Community or "evolution2" for Telligent Enterprise, you will have to make some adjustments in terms of how things get installed.

  1. Complete the full installation above as directed.
  2. Now you must copy all the theme items:
    • For Telligent Community:  In the installation package, make a copy of the  "fiji"  directory under /Web/Themes.  Rename that copy to the same name as your theme and copy it to your installation's Theme(~/Themes) folder.  Then add the markup translations for "fiji"  from the theme.config.sample file to all of your custom theme theme.config files.  *NOTE: Depending on how extensive your theme is in terms of  styling, these markup translations may not be necessary.  Use your own discretion.
    • For Telligent Enterprise: In the installation package, make a copy of the  "evolution2"  directory under /Web/Themes.  Rename that copy to the same name as your theme and copy it to your installation's Theme(~/Themes) folder.  Then add the markup translations for "evolution2"  from the theme.config.sample file to all of your custom theme theme.config files.  *NOTE: Depending on how extensive your theme is in terms of styling, these markup translations may not be necessary.  Use your own discretion.
  3. In each of the theme.config files for your custom theme, add a reference to the ThemesName/Css/calendar.css file in the section where ThemeName is the name of your custom theme.
  4. You will have to manually add widgets where necessary.  The table below should help you in determining what widgets should go where.

*** The Event Calendar- Group Application Navigation widget should go on every group page.  The Event Calendar-Calendar Breadcrumb widget should go on every calendar based page.

Url
'~' denotes the group url path (e.g. http://site/group-name/subgroup-name/...)
Widgets
~/c/default.aspx
  • Event Calendar-Calendar List
  • Event Calendar- Calendar Options
~/c/[0-9].aspx
(where [0-9] is the numeric calendar id. You will need to add a calendar first
  • Event Calendar-Calendar
  • Event Calendar-Calendar Events
  • Event Calendar- Calendar Options
~/c/add.aspx
(also covers edit)
  • Event Calendar-Add/Edit Calendar
~/c/[0-9]/e/add.aspx
(where [0-9] is the numeric calendar id. Also covers edit. You need a calendar to access this page)
  • Event Calendar-Add/Edit Event
~/c/e/[0-9].aspx
(where [0-9] is the numeric event id. You need an event to access this page)
  • Event Calendar-Event
  • Event Calendar - Event Options
  • Event Calendar- Event Feedback Form
  • Event Calendar - Comment List
  • Event Calendar - Add Edit Registration
~/c/e/[0-9]/registered.aspx
(where [0-9] is the numeric event id. You need an event with a registration option set to access this page)
  • Event Calendar-Event Registration List

Upgrading From a Previous Version

Always verify the version you are running is upgradeable to the latest version.

  1. Follow the steps described in Installing SQL Files.
  2. If you have made changes to any resource files, merge them together using a popular tool such as WinMerge.
  3. Merge the contents of communityserver_override.config.sample with your communityserver_override.config file.  Be sure to remove all the overrides for Tasks and Threads.
  4. Merge the contents of siteurls_override.config.sample with your siteurls_override.config file.
  5. Merge the contents of the theme.config.sample with your theme.config file.
  6. Copy the /Web folder from the installation directory over your installation omitting *.sample files.
  7. Follow the steps for installing Tasks and Search.

 

Comments
  • Please include some screenshots on the widget steps the explanation is not clear.

  • Also on the database persistence, we should tell how to know if you are using database persistence and how to tell if we are using the Quartz RamJobStore.  Is this OOTB for the Job Scheduler or something you would need to configure special?