Calendar - Technical

Root > 3. Customisation

 

 

    Follow WiredContact on Twitter
 
Summary - The Calendar can display as much or as little data as you desire. If the content below is not readily understood please submit a ticket describing what you want to achieve and we will assist you.

Technical 
The calendar function displays activities and parent information for those activities (typically from the wce_activity and wce_contact tables).

The default activity table is wce_activity, but other tables may be used. See <#adminhelp file=dbActivityParams.html label="dbActivityParams"> for more information about using other tables with the Calendar.

The Calendar has 2 main parts - the main template and the Detail <#adminhelp file=WiredContactSections.html Label="Sections">, divided into a <#day> section, a <#week> section, and a <#Month> section.

Main
The Main template includes all of the tags that aren't associated with the actual records that will be displayed. This includes icons that when clicked would give you different calendar types (day, week, month), mini calendars for selecting date ranges. Here are the Calendar function tags:

  • <#adminhelp file=StandardTemplateTags.html Label="Standard Tags"> including <#params and <#date
  • <#SELECTUSER...> - when clicked, brings up the Select User dialog to specify which user(s) to show items for
  • <#User count=[number to show]> - displays the users for the current view, up to the count. Any user after the Count is shown by "...". The default count is 3.
  • <#UserLegend> - when more than one user is being shown on the calendar, displays the legend of user icons. Default user icons are colored squares that are selected based on the user's position in the list of users. You can specify images for user icons by adding the CalImage label in the <#adminhelp file=UserCustomSettings.html label="User Custom Settings">.
  • <#limits value="sql limit" debug> - this tag allows you to put some hard limits on what items to show in the calendar. For example, if you did not want to show activities with a type of "Holiday" when the date was prior to today, you would use:
     
    <#limits value="Not((atype='holiday') and (starttime < <#date format=sql>))">
     
    If you use the Debug parameter - the "WiredContact Errors.log" file will show the details of the actual SQL statement used so you can adjust your parameters.
  • <#Calendar...> - this tag is where the <#adminhelp file=WiredContactDetailSections.html Label="Detail Sections"> (<#day>, <#week>, <#Month>) will be placed - showing the activity items for the calendar function.
    Additional Parameters:
    • WeekInterval=x where x is the number of minutes shown per slot in the Week Calendar. The default is 30.
    • DayInterval=x where x is the number of minutes shown per slot in the day Calendar. The default is 30.
    • TimelessFirst - show Timeless activities at the top of the calendar.
    • Type=[d|w|m] - when first shown, the default calendar type - d=Day, w=Week, m=Month.
    • Start=x - where x is the hour the calendar starts (Day and Week). If this value is blank then the value from the Admin...Site Settings is used.
    • Hours=x where x is the number of hours to show per day (Day and Week). If this value is blank then the value from the Admin...Site Settings is used.
    • Days=x where x is the number of days to show on a week calendar, the default is 7
    • WeekStart=x where x is 0 for Sunday, and 1 for Monday.
    • WeekStartFormat=[text] - where the text is the formatting mask for the title of the week calendar. The default is: "Week of "mmmm dd, yyyy
    • WeekStopFormat=[text] - where the text is the formatting mask for the end of the title of the week calendar. The default is ""
    • WeekdayFormat=[text] - where the text is the formatting mask for the title of each day on the week calendar. The default is 'dddd"<br>"mmmm d'
    • DayFormat=[text] - where the text is the formatting mask for the title of the day calendar. The default is: mmmm dd, yyyy
    • Debug - includes debug information in the "WiredContact Errors.log" file
    • Styntax - shows the syntax of the day/week/month sections used.
    • ScheduleUser=[userid] - specifies the default user to schedule with when scheduling from the calendar - the default is the logged in user.
    • ScheduleEntity=[entityid] - specifies the default Entity to schedule with when scheduling from the calendar. If a value is used, it must be the uniqueid of the entity you wish to schedule with.

Detail Sections
See the <#adminhelp file=WiredContactDetailSections.html label="Detail Sections"> help file for more information. Here are the default sections for Day, Week, and Month calendars if no sections are specified in the template. If you want to customize the sections, copy and paste into your template. The field=EntityNameField references refer to the Name fields identified in the <#admin file=TableDefaults.html label="Table Defaults"> for the table specified.

Day Sections:
<#day>
<#icon type=typeimage border=0><#icon type=usericon><#parent blank="[blank]" link=yes field=EntityNameField> - Re: <#field field=subject>
<#clear title=Clr src=reload> <#reschedule title=Resched src=reload>
<#/day>
<#daycontinue>
  (cont) <#parent field=EntityName2Field>, <#parent blank="[blank]" link=yes field=EntityNameField>
<#/daycontinue>

Week Section:
<#week>
<#icon type=typeimage border=0 link=parent title="<#parent field=EntityName2Field> - Re: <#field field=subject>"><#icon type=usericon>
<#/week>

Month Section:
<#month>
<#icon type=typeimage border=0 link=parent title="<#parent field=EntityName2Field> - Re: <#field field=subject>">
<#icon type=usericon><span class="<#field field=atype>"><#field field=subject link=yes></span><br>
<#/month>

<#adminhelp file=PortalFunction.html label=Portal>/<#adminhelp file=LeadFunction.html label=Lead> Function Calendar Default Sections:

  • The Detail Sections differ slightly when using the Lead/Portal function to display the Calendar. Use the <#Calendar syntax ...> parameter to see the default sections in the error log when using the Calendar.
  • If using a Calendar Template with the Portal function - be sure to specify the <#Dynamic> tag in the template.
  • Additional Parameters for Portal Calendar:
    • RecordManager="[WiredContact User]" - specify the record manager to show activities for.
    • Contact="[Contact Name]" - specify the contact field value from the parent table to show activities for. If using the Recordmanager parameter - place this parameter after RecordManager.
    • Andor=[and|or] - when both RecordManager and Contact are specified, indicate whether to use an "and" search, or an "or" search. An "and" search yields fewer results.

Using the Calendar function with other tables
You may use the Calendar function with other tables if you specify alternate default fields via the <#adminhelp file=dbActivityParams.html label="Activity Defaults">.

User guide for Calendar Training-Course-Calendar.pdf
 
An online user guide is here https://wiredcontact.co.uk/Manual/

Add Feedback