In this article you will have access to:
- How to create a custom calendar Visualforce page tab
- URL parameters
- Component parameters
- JS functions (func parameter)
- JS API methods
- Calendar specific event handlers
- Display settings/user settings
- Special settings test cases
- Print parameters
- CA Lightning mobile extension/component properties
How to create a custom calendar Visualforce page tab
Create a custom calendar Visualforce page tab by predefining certain URL and component parameters from the table below. For a full overview of the steps, see the guide to creating custom Visualforce page tabs.
Copy and paste this template page code:
<apex:page showHeader="true" showChat="false" sidebar="false">
<div style="min-height:1000px;">
<SLCA2:calendar namespace="SLCA2"
calendar=""
enabled=""
createable=""
settings="[]"
userAdditionalSettings="{}"
view=""
date=""
filter="{}"
urlparams=""
css=""
readonly="{
edit : true,
create : true,
detail : true,
move : true,
hover : true,
contextEvent : true,
contextCalendar : true,
contextArea : true,
cloneSharing : true
}"
func="{}"
></SLCA2:calendar>
</div>
</apex:page>
URL parameters
Explanation of what URL parameters are, how they’re used, and relevant links.
Table1. URL Parameters | ||
Parameter | Description | Example |
site | Defines whether or not CalendarAnything shows on a public site. This means that connect.js is not usable and certain functionality that is not available to site users will be locked. | site=1 |
pv[1-10] | Filter value for dynamic filters. Each number is linked to a filter for one or more calendars. List of applied filters defined as “filter” parameters. | pv1=ABC&pv2={!User.UserID} |
ps(1-10) | The same as pv(1-10) but for Custom Group By (Swimlane and Day Grouping mode.) | ps1=AAA&ps2={!Contact.ID} |
calendar | Defines one or more calendars to load when CalendarAnything starts. You can use the calendar-friendly name instead of the ID. | calendar=Events |
cid | The same as “calendar.” Defining this disables the left panel. | cid=Event_Cal |
filter | Defines the list of calendars to apply dynamic filters (pv[1-10]) to. You can use Calendar ID or friendly name. | filter=Tasks |
sb | Display / hide left panel;: – 0 makes calendar sidebar visible (even if “cid=…” parameter is present in the URL). – 1 hides full calendar sidebar and displays collapsed calendar side bar. – 2 hides all calendar sidebars. | sb=0 |
hh | Maximize CalendarAnything to take all available space in the layout. | hh=1 |
ht | Disable CalendarAnything header panel. | ht=1 |
url | Set the default external URL for “event bar details” behavior. The URL can include the \[id\] substring; this will be replaced with the element ID at runtime. | url=/apex/detailpage/[id] |
v | Start mode views: – a: agenda – c: custom – d: day – g: gantt – da: agenda in day view – m: month – w: week – wa: agenda in week view – s: swimlane | v=a |
g_v | Gantt view mode: – hour – day – week – month – quarter | g_v=hour |
g_p | Gantt view period: number of months to display. Setting the period as “0” means there are no limits. | g_p=12 // one year; |
date | Start date | date=2013-11-30 |
l_ds | My Calendars button. Setting to “0” disables the button. | l_ds=0 |
l_p | Left button. Setting to “0” disables the button. | l_p=0 |
l_n | Right button. Setting to “0” disables the button. | l_n=0 |
l_t | Today button. Setting to “0” disables the button. | l_t = 0 |
c_t | Current Date title / button. Setting to “0” disables the button. | c_t=0 |
r_d | Day mode / button. Setting to “0” disables the button. | r_d=0 |
r_w | Week mode / button. Setting to “0” disables the button. | r_w=0 |
r_m | Month mode / button. Setting to “0” disables the button. | r_m=0 |
r_g | Gantt mode / button. Setting to “0” disables the button. | r_g=0 |
r_c | Custom mode / button. Setting to “0” disables the button. | r_c=0 |
r_a | Agenda mode / button. Setting to “0” disables the button. | r_a=0 |
r_s | Swimlane mode / button. Setting to “0” disables the button. | r_s=0 |
tz | Time Zone ID | tz=Asia/Shanghai |
restPrefix | Prefix for Subpages (like Community) | restPrefix=/somesubpage |
restV | API Version for REST Calls | restV=41.0 |
apexDescribe | Number of Objects Describes requests per one APEX execution | apexDescribe=20 |
Component parameters
Table 2. Component parameters | ||||
Parameter | Description | Example | ||
calendar | List of calendar IDs to display in the left panel. CA_ACCESSIBLE – means all calendars are available to the user. | calendar=”Event,Task” | ||
enabled | List of calendar IDs to enable. Comma delimited. Or JSON formatted parameters for calendars: {‘CALENDAR’ : [true|false|’default’]}; – ‘default’ – the first time it is loaded on that machine the calendar will be enabled but after that it will follow the user’s preferences. – true – enables the calendar even if user has disabled it previously. – false – disables the calendar even if user has enabled it previously. Calendar friendly name can be used. Also other predefined values are available: – CA_ALL means all visible calendars turn on – CA_SF means all standard calendars – CA_GROUP – all groups – CA_WEB – all web calendars – CA_ENABLED – default values from CA UI | enabled=”Event” enabled=”{ ‘Event’ : true, ‘Task’ : false, ‘Opportunity’ : ‘default’ }” | ||
createable | List of calendar IDs/friendly names availablein the QuickCreate dialogue. | createable=”Event,Task” | ||
namespace | CA NameSpace. Has to be set to SLCA2 | namespace=”SLCA2″ | ||
settings | JSON format visual settings. | settings=”{}” | ||
userAdditionalSettings | JSON format user settings. | userAdditionalSettings=”{‘noleft’:’true’, ‘maximize’ : ‘false’, ‘dayModeArea’:’1_9′}” | ||
view | Start view: month, day, agenda, week, custom, gantt, swimlane | view=”month” | ||
date | Start date | date=”2013-01-22″ | ||
filter | List of values for dynamic filters; JSON object that includes 2 keys: – filtersPV – PV0-9 filter values, STRING, splitted by “:.:” substring – filtersApplyTo – list of calendars that have to use filters criteria; STRING with splitted by comma IDs / Friendly Names | { ‘filtersPV’ : ‘ABC:.:123:.:012345678901234’,‘filtersApplyTo’ : ‘CALENDAR_ID1,CALENDAR_FRIENDLY2’ } | ||
urlparams | List of parameters described in Table 1 | urlparams=”l_p=0&v=m” | ||
css | Path to external CSS file that loads after CA starts. Can be used to override CA styles. | css=”/css/mystyles.css” | ||
readonly | Boolean / JSON settings to disable certain edit functionality. – true disables ALL interactive functionality, such as edit, creating events, calendars, etc. – false enables all interactive functionality. This is the default. – JSON parameters (key1 : BOOLEAN, key2 : BOOLEAN); – edit enables event editing – create adds new events – detail shows external details by double click – move – changes event bars – hover displays hover popup (internal CA details) – contextEvent shows context menu for event bars – contextCalendar hides or shows calendar context menu. If false, it also hides calendar groups and Web calendars sections if there are no calendars to display. – contextArea shows context menu for visible mode area – cloneSharing copies sharing rules for cloning calendar – contextCalendar displays Calendar Context Menu – contextFilter displays FilterSet Context Menu | readonly=”{ edit:false, move:true }” | ||
func | External API functions declaration. See detailed description. | func=”{ready:SomeFuncName}” |
JS functions (func parameter)
Table 3. JS Functions (function parameter) | ||||
Function | Parameters | Description | Example | |
ready | oAPI – link to current CA Object | Launches when CA finishes all startup procedures. | function(oAPI){ alert(‘CA started successfully!’) } | |
calendarToggle | sCalendar – calendar ID | event handler when user enables or disables a calendar in the left panel. Return false if you want to prevent action. | function(sCalendar, bMode) { if (sCalendar == ’01aAAA’) { return false; } } | |
bMode – true / false = enable / disable | ||||
eventHover | aEvents – List of events split by calendars; {CALENDARID : [EVENTID1, EVENTID2] …} | Fires when user clicks on the event bar (or starts hover popup). Return false to prevent action | ||
event – JS event | ||||
request | aAjaxParams – request parameters | Fires when a JS remoting request is sent to SF or a response is received from SF. | Use this to calculate some metrics | |
eventDetail | nEventId – ID of event | Fires when a user double clicks on an event bar or opens an external details URL. Return false to prevent action. | ||
event – JS event | ||||
eventEdit | sCalendar – calendar ID | Fires when user starts editing an event in the QuickCreate form. Return false to prevent action. | ||
sEvent – Item ID | ||||
eventEditCalendarSelect | params – JSON with new event data | Fires when a user opens the quick creation dialogue (calendar selection step). | ||
event – JS event | ||||
eventEditCalendarSelect | oPopup – link to DOM CA popup | Fires when a user starts calendar edit dialogue. | ||
calendarEdit | oPopup – link to DOM CA popup | Fires when user opens calendar edit form. | ||
externalLink | sEventID – ID of event | Fires when a user clicks on References in the hover popup. | ||
event – JS Event |
JS API methods
Table 4. JS API methods | |||
Method | Parameters | Description | |
calendarOn | sId – Calendar ID / Friendly Name | Toggles calendar on. Loads from server if necessary. | |
calendarOff | sId – Calendar ID / Friendly Name | Toggles calendar off. | |
getDate | Get current CA Date | ||
setDate | mDate – Date (mixed) | Changes CA Date. | |
getView | Returns current mode name. | ||
setView | sMode – Mode name | Toggles mode. | |
getDayData | dDay – date for request | Get Events for some date | |
setFunc | sName – function name | Sets a custom handler for certain CA events. Choose from the list of events described in Table 3. | |
fFunc – function description | |||
editEventDialogue | mCalendar – calendar id / friendly name | Starts Quick Creation dialogue for a calendar and event. If calendar is undefined – displays the calendar selection popup. | |
sEvent – event id | |||
oEvent – JS Event | |||
setCalendarProperties | sCalendar – calendar ID / Friendly Name | Sets special handlers for a specific calendar. See details in Table 5. | |
aProp – JSON property for calendar | |||
changeParams | aParams – JSON like parameters object | Sets user settings parameter at run time. | |
getParam | sName – String – parameter name | Get parameter value, null if not found. | |
getCalendarProperty | sCalendar – calendar Friendly Name / ID | Get some property of calendar | |
sProp – Property name | |||
setViewSettings | sView – name of the VIEW, like month,day .. aProperties – JSON format | Set some view special properties. | |
setCalendarFilter | sCalendar – calendar Friendly Name / ID | Set Calendar Quick Filter. | |
aFilters – List of Filters | |||
sRule – Custom Rule ([]) | |||
fFunc – Function to execute after setting | |||
getCalendars | aFilter – Criterias | Get the list of calendars by criteria. | |
setFiltersPanel | aParams – JSON: | Set FilterSet / Filter panels. | |
fields – list of fields like [‘common|createdby’, ‘event|subject’], objectname|fieldname, “common” – default object field | |||
id – some unique ID – String | |||
type – always “custom” | |||
criteria – Available criteria to choose: – name – field name (API field name) – oper – equal, contains, includes – operation type – object – name of the field`s object – text – text representation – used for Reference – value – value for filter | |||
addCalendarMenu | Add Calendar Context Menu Option sTitle – menu title fFunc(sId, evt) – function | ||
addEventMenu | Add Event Context Menu Option sTitle – menu title fFunc(sId, sCalendarId, evt) – function | ||
addAreaMenu | Add Area Context Menu Option sTitle – menu title fFunc(dDate, evt) – function | ||
addEventHoverButton | Add Custom Button to the Hover Event Detail Popup sTitle – button label fFunc(sId, evt) – function fShow(sId) – function to determine to show or to hide the button | ||
refresh | Refresh data | ||
Print current view |
Calendar specific event handlers
Table 5. Calendar specific event handlers | |||
Function | Parameters | Description | |
toggle | bMode – Enable or Disable | Fires when calendar becomes enabled / disabled | |
eventHover | aAll – JSON with calendars and their events | Fires when user clicks on the event bar for this calendar | |
event – JS Event | |||
eventEdit | eventId – Item ID | Fires when user tries to open QuickCreate dialogue for this calendar | |
event – JS Event |
Display settings/user settings
Table 6. Display settings / user settings syntax is: userAdditionalSettings=”{‘Non-BooleanParameterName’:’Value’,’BooleanParameterName’:true}” NOTE: API name for object or field should be lower case | |||
Parameter | Possible values | Description | |
size | small | middle | large | Size of event bars (height and font size) | |
gradient | on | off | Display event bars with gradient (requires more resources from browser) | |
mode | month | week | day | custom | agenda| gantt | swimlane | Starting mode | |
startWeekDay | 0-6 (from Sun to Sat) | Starting day of a week | |
showWeekEnds | 5 | 6 | 7 | Display weekends (5 – up to Friday, 6 – also Saturday, 7 – all week) 5 and 6 only available with startWeekDay=0 | |
monthWeeks | 0 | 6 | 0 – Auto height of week rows on month view , 6 – display 6 week rows | |
extendendRange | true | false | Query extended date range in month view – one month before and one month after | |
startHourPeriod | 0-23 | Start hour for timing area | |
stopHourPeriod | 0-23 | End of timing area | |
minMinutePeriod | 60 | 30 | 15 | 10 | 5 | Size of one cell in timing area | |
dayModeArea | 0_1 | 1_9 | 1_2 | 1_1 | 1_0 | Set the visibility and the size of timing area: Only timing | 10% day – 90% timing | 33% – 67% | 50% – 50% | only day | |
nonWorkingHoursDisplay | hide | show | paint | How to display non-working hours. | |
dayViewAdditionalFields | true | false | Display additional fields for Daily Area (Bottom; only for Grouping and Default mode) | |
customMode | manual | 2d | 3d | 4d | 5d | 6d | 7d | 2w | 3w | 4w | Custom view mode manual | several days | several weeks (rows) | |
customModeRows | 1 – 8 | Number of rows (customMode=manual is required.) | |
customModeCols | 1-14 | Number of cells (customMode=manual is required.) | |
customModeArea | 0_1 | 1_3 | 1_2 | 1_1 | 1_0 | Set the size of timing area: Time Only | 25% Day / 75% Hour | 33% Day / 67% Hour | 50% / 50% | All Day Only | |
ganttSplit | day | week | month | quarter | Starting mode of Gantt view | |
ganttPeriod | 0.1 | 0.7 | 1 | 3 | 6 | 12 | 36 | 120 | 0 | Gantt view period : number of months + all time ; 0.1 – one day, 0.7 – one week | |
ganttRespectHours | true | false | Respect working hours in Gantt view. | |
ganttMaxPrintItems | 0-3000 | Maximum number of events that are available for printing in Gantt View | |
ganttCollapseFullLine | true | false | Collapse Grouping One Line | |
ganttCollapseGroupingByDefault | true | false | Collapse Grouping by Default | |
ganttWideTitle | true | false | Open wide title by Default | |
logLevel | 0 | 1 | 2 | Show log events : None | Errors | All | |
cacheTime | 0 – 300 | Data caching time (seconds) | |
apiCache | 0 | 1 | 3 | 8 | 24 | 168 | lazy | API caching (hours / lazy – means postloading ) | |
showTitles | 0 | 1 | 2 | 3 | 4 | 0 – No Titles 1 – Compact (title only) 2 – Detailed (title start & end) 3 – Full Agenda (all fields defined in step 10) 4 – Detail Dialog (displays Details Dialog as if you clicked just on hover, can be annoying) | |
insideEdit | 0 | 1 | CA Labs parameter. | |
requestTimeout | 1 – 300 | Request timeout in seconds | |
showCreatingDates | true | false | When this is set to true the create dialog will always show the start/end date fields that are being used by that calendar. | |
showScrollButtons | true | false | Display scrolling buttons | |
loadLastPeriod | true | false | Load only the last selected period. When the user rapidly clicks on “prev” or “next” this will wait until the user stops clicking and only load the last period. | |
extendendRange | true | false | Query extended date ranges (for month view adds +- 1 month) | |
parallelRequests | 1-10 | Parallel requests to server; number of requests for events | |
swimlanePreset | true | false | Preset Swimlane value with Quick Creation; set value for assign to / owner id field | |
uiSearch | true | false | Display search field | |
swimlaneFieldLabels | true | false | Display agenda field labels in the Swimlane View | |
agendaFieldLabels | true | false | Display agenda field labels in the Agenda View / day + week “agenda” submode / print version / event titles | |
sf1FieldLabels | true | false | Display agenda field labels in the Salesforce Mobile App | |
swimlaneScrolling | true | false | Enable swimlane scrolling (changes date when getting to the end of the timeline) | |
swimlaneOneDayAllDay | true | false | If false – do not display “Allday” or Dates for only one day AllDay event | |
swimlaneCell | 25 | 50 | 100 | 200 | 300 | Swimlane cell width for day mode | |
agendaEmptyDays | true | false | Display empty days for the agenda view | |
useSFLookup | always | auto | never | Use SF UI lookups – always (before that – “true” ) means using the SF lookup in any case for all lookups fields – auto (before that – “false”) means using the SF lookup only for dependency fields – never – disable using the SF lookup for all cases (even for dependency fields) | |
weekViewAgenda | true | false | Enable the Agenda submode in the Week view | |
dayViewAgenda | default | agenda | grouping | Set submode in the Day view: – default – standard mode (old value – false); – agenda – agenda like style (old value – true); – grouping – swimlane like mode | |
hideNotify | “all” | “message” | Hide all (errors + notifications) or just notifications | |
confirmDelete | true | false | Asks user for deleting events | |
fastStart | true | false | Speed up the loading process – CA loads only visible calendars objects info in the beginning | |
addons | chatter | List of enabled addons separated by comma | |
agendaPrintCurrentMonth | true | false | Print current Month | |
agendaEmptyDays | true | false | Show Empty Days in Agenda View | |
agendaFieldLabels | true | false | Display field labels in Agenda view | |
swimlaneDefaultGroupBy | empty or some field or some UserList ID (18 chars) | Default Swimlane grouping field or user list view | |
swimlaneDefaultPeriod | day | hour | Default Swimlane period type | |
swimlaneDisplayStartEndDate | true | false | Display Date in the Datetime fields for viewed date | |
swimlaneShowWeekDay | true | false | Display Day of Week | |
acceptReminderDD | true | false | Requires implementation | |
barLabelTime | ‘no’ – no start / end, ‘start’ – start time only, ‘end’ – start + end | Add Start / End date – time on the event label | |
closehead | true | false | No display settings | |
closeleft | true | false | No display settings | |
customHourlyArea | String | Not used | |
eventStyle | String ’round’, ‘line’, ‘half’, ‘bulb’, ‘koso1’, ‘koso2’, ‘koso3’ | Different background image for event bars; No display settings | |
ganttPrintOldSchool | true | false | Print as HTML for IE; Not used | |
ganttShowUnvisible | true | false | Respect Working Hours in Gantt view | |
lang | String; ‘en’,’ru’,’uk’ | CA UI language | |
maximize | true | false | Turn on full screen mode; No display settings | |
monthDayMoreWidth | String; ‘1’ | Not used; always ‘1’ | |
noleft | true | false | No display settings | |
printAsImage | true | false | Print all views as Image | |
rememberTimeScroll | true | false | Always false; No display settings | |
showAdditionalFields | true | false | Show additional fields in the Calendar Edit form | |
swimlaneEnableGroupBy | true | false | Display Group by fields option | |
swimlaneEnablePresets | true | false | Display Custom Grouping option | |
swimlaneEnableListViews | true | false | Display User Listview option | |
multiContactsInEvent | true | false | Enable Multi Contacts Events | |
respectReminderDD | off | sf | ca | Support reminders for events: – off – disable reminder – sf – Salesforce reminders – ca – CA reminders | |
uiAdvancedSearch | true | false | Always false; Not used | |
uiSearch | true | false | Display search | |
uiToday | true | false | Display Today button | |
uiFilter | true | false | Display Filter Panel | |
uiFilterSets | true | false | Display Filter Sets panel | |
displayTimeZone | true | false | Display Time Zone selector | |
longClick | true | false | Enables Long click for dragging and droppingevents (quick creation / resizing / moving) | |
layoutTheme | default| lightning | Default or Lightning Layout | |
displayNewICAL | true | false | Enable new iCal / oAuth | |
uiMobileCACalendar | true | false | Enable using of CA Datepicker for Mobile Devices | |
autoHideHover | true | false | Auto Hide Event Details popup | |
fullDaySortBy | date | date_calendar | calendar_date | calendar_sorting | date_calendar_sorting | calendar_date_sort calendar_sort_date | Sort Day Details Popup Events: – By Date and Title – By Date, Calendar, and Title – By Calendar, Date, and Title – By Calendar, Sorting Field, and Title – By Date, Calendar, Sorting Field, and Title – By Calendar, Date, Sorting Field, and Title – By Calendar, Sorting Field, Date, and Title | |
uiCalendar | true | false | Not used; Show datepicker | |
swimlaneEnableGroups | true | false | Show Public Groups in Swimlane Selector | |
swimlaneGroupIncludeSubgroup | true | false | Load Subgroups users in Public Groups | |
swimlaneGroupIncludeRole | true | false | Load Roles users in Public Groups | |
swimlaneGroupHierarchy | true | false | Use Hierarchy in Public Groups | |
useSFTimeZone | true | false | Use Server TZ | |
nativeNumbers | true | false | Support Locale Number Fields | |
customSettingGroup | default | String | Reserved for Custom Settings Group | |
companyLogo | String | Print mode Logo (URL) | |
monthOnlyOne | true | false | Show only one month | |
monthExtendScroll | true | false | Extend period while scrolling in month view | |
monthShowMonth | true | false | Show Month names on cells | |
ganttShowStartWeek | true | false | Mark Start Week Day | |
newLoading | true | false | ||
qcAutoEnable | ‘auto’ | ‘off’ | ‘on’ | Enable Calendar after Quick Creation | |
agendaAutoOpen | true | false | Auto Open Fields in Lightning App | |
alwaysBrowserTab | true | false | In Lightning Open Records in New Browser Tab |
Special settings test cases
Table 7. Special Settings test cases | |||
Title: Log Events Show Summary: “Log Events Show” allows you to show/hide information about the performed actions and errors Preconditions: An Editable Calendar “Event” on the Event object with standard fields Start, End fields selected as Entry Start and Entry End is created. | |||
Order | Step Actions | Expected results | |
1 | Select Log Events Show=Off. Quick create 15 days event on “Event” calendar. | Event isn’t created. No error message is shown. | |
2 | Select Log Events Show=Off. Quick create one-day event on “Event” calendar. | Event is successfully created. No message is shown. | |
3 | Select Log Events Show=Errors. Quick create 15 days event on “Event” calendar. | Event isn’t created. The red error message in the top of the calendar page is shown, that says “Event duration can not be longer than 14 days.” Message disappears in a few seconds or can be closed with “x” button. | |
4 | Select Log Events Show=Errors. Quick create one-day event on “Event” calendar. | Event is successfully created. No message is shown. | |
5 | Select Log Events Show=Show All. Quick create 15 days event on “Event” calendar. | Event isn’t created. The red message in the top of the calendar page is shown, that says “Event duration can not be longer than 14 days.” Message disappears in a few seconds or can be closed with “x” button. | |
6 | Select Log Events Show=Show All. Quick create one-day event on “Event” calendar. | Event is successfully created. The green message “Event is created successfully” is shown. Message disappears in a few seconds or can be closed with “x” button. |
Print parameters
Table 8. Print Parameters | ||
Parameter | Possible values | Description |
emptyUsers | true | false | Users with no events |
onlyFirst | true | false | Not used |
maxItems | 0- | Max Events / Cell |
fontSize | 8-15 | Font Size |
emptyExtra | true | false | Display Selected Date Range |
oneLine | true | false | Truncate Title |
displayColor | true | false | Display Color Bars |
showTime | true | false | Display Time |
showCal | true | false | Display Calendar Name (Event Bar) |
printCal | true | false | Display Calendar Names (Header) |
printPeriod | true | false | Display Date Range |
printFS | true | false | Filter Set Names |
printAuthor | true | false | Display Author |
splitMonth | true | false | Split By Month |
showAddFields | true | false | Display Additional Fields |
Code
document.localStorage[''printSettings''] = '{'
+ '"emptyUsers" : false,'
+ '"onlyFirst" : false,'
+ '"maxItems" : 0,'
+ '"fontSize" : 12,'
+ '"emptyExtra" : false,'
+ '"oneLine" : false,'
+ '"displayColor" : false,'
+ '"showTime" : true,'
+ '"showCal" : true,'
+ '"showAddFields" : true,'
+ '"printCal" : false,'
+ '"printPeriod" : false,'
+ '"printFS" : false,'
+ '"printAuthor" : true,'
+ '"splitMonth" : false'
+ '}';
CA Lightning mobile extension/component properties
Table 9. CA Lightning Mobile Extension/Component properties syntax is: <design:attribute name=”name” label=”label” required=”true/false” default=”default value” description=”description text” /> JSON format example: {“Non-BooleanParameterName”:”value”} | |||||
attribute name | label | required | default | description | datasource |
view | Default View Mode | FALSE | The View Mode to display at startup. | Agenda,Week,DayGrouping,Day | |
calendar | Calendars Available to Enable | FALSE | Enter Calendar ID or SiteCalendar Name from Step 1 of Calendar Settings. Multiple calendars can be separated by commas. Leave blank to show user’s selected calendars and groups from Display Settings. | ||
enabled | Calendars to Enable at Startup | FALSE | Enabled calendars show records. Enter Calendar ID or SiteCalendar Name from Step 2 of Calendar Settings. Multiple calendars can be separated by commas. Leave blank to display the last set of enabled calendars. | ||
createable | Calendars Available for New Records | FALSE | Enter Calendar ID or SiteCalendar Name from Step 2 of Calendar Settings. Multiple calendars can be separated by commas. Leave blank to show user’s selected calendars and groups from Display Settings. | ||
height | Height | FALSE | 400 | Component height in pixels. | |
autohideDP | Auto Hide DatePicker | FALSE | TRUE | When checked, the date picker will dismiss when a date has been selected.When unchecked the date picker can be turned on or off as a mode. | |
recordFilterField | Record Dynamic Filter Field | FALSE | Record Dynamic Filter Field. | ||
showModeSelector | Display Mode Selector | FALSE | If checked, a selector will be displayed in the UI to allow switching to a mode other than the Default mode. | ||
showIcoCreate | Display Create New Record Icon | FALSE | If checked, the New Record icon will be displayed in the main UI. | ||
showIcoCalendars | Display Calendar Selector | FALSE | If checked, the Calendar Selector icon will be displayed in the main UI allowing you to enable calendars and groups. | ||
showIcoRefresh | Display Refresh Icon | FALSE | If checked, a refresh icon will be displayed. Clicking the refresh button will display the latest records for all enabled calendars. | ||
showIcoToday | Display Today Icon | FALSE | If checked, a home icon will display. Clicking the home icon will bring you to and display records for today’s date. | ||
useCAForm | Use CalendarAnything Create Forms | FALSE | If checked, will use a custom record create form based on Step 5 in Calendar Settings. Otherwise, will use standard new record layout for selected record type. | ||
qcEnabled | Enabled Calendars Only on Create | FALSE | If checked, will only display the currently selected set of calendars when creating new records. Otherwise, will display all calendars available to enable. | ||
userAdditionalSettings | Additional User Settings | FALSE | JSON format example: {“dayModeArea”:”0_1″} |