Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Trademarks
All FutureVision and USFlashMap.com logos in this document are trademarks of
FutureVision Web Solutions.
1 Introduction
Thank you for choosing Flash CalendarPro, the most innovative flash calendar available
on the web!
We encourage you to read this guide carefully in order to get the full benefit of all the
features and uses of our product.
Our team hopes you will enjoy the product and will recommend it to others. Please send
your suggestions for product improvements or cooperation at
http://www.usflashmap.com/contact/
This instruction manual will provide an overview of product features and will navigate you
through the installation and customization processes. The document is organized as
follows:
Personal and Corporate collaboration and event scheduling software like Microsoft
Outlook/SharePoint or Apple iCal do not provide appropriate web solutions and support for
communities and social networks. At the same time, companies that do take advantage of
today’s interactive web technologies, such as Web 2.0, Ajax or Flex, concentrate mostly on
custom projects and do not produce any powerful calendar software, concentrating mostly
on simple solutions. And this is where we see our niche.
Our challenge is to become #1 calendar software provider for web users (as a service)
and software developers (as a framework and box product) for three major needs:
share time-related rich media content online;
improve team collaboration in corporate intranets and other multi-user web
environments;
obtain an advanced calendar instrument for Flash and Flex projects.
• Personal Calendar. Use CalendarPro on your blog, personal website to imprint the
most memorable events in your life: trips, birthdays, anniversaries, etc. Use the
repeat feature to record them for the next 10 years.
• Business Calendar. Use Calendar Pro as an informing tool to publish your schedule
and timetables (meetings, gym sessions, concerts, studies at university, etc)
• Corporate Calendar. You can use CalendarPro on your intranet as a planning tool
to manage projects, set deadlines and show milestones, etc. Every company
member can have their own login to the administrative mode and modify events,
or have only resticted access to events management.
• Scheduling Calendar. You can intgrate the calendar with your scheduling services
and allow calendar viewers choose the most appropriate timeline for an
appointment and save the appointment summary directly on the website.
Flash CalendarPro Features
Flash CalendarPro is a feature-rich online calendar that offers a wide range of possibilities. It
provides many standard calendar features, as well as advanced ones that help you manage
your events and collaborate with others. Following is a summary table with most important
Flash CalendarPro features.
Integrate
Flash CalendarPro is a web-based calendar that can be added to any web page, blog, CRM, CMS, etc.
Moreover, a wide range of data listings (XML, Database, JS API, Flash API) allows almost any kind of
integration.
* JS API and Flash API coming soon
Customize
Flash CalendarPro has a highly customizable user interface that allows to:
modify color scheme of all graphic elements;
adjust calendar size with no image quality loss;
create custom event categories and locations;
fill in fields for custom event details;
choose among numerous calendar views (Day, Week, Month, Year. List, Search)
etc.
Currently you can add images of any size or format to event details. We also plan to include audio files
support, such as MP3 player on top of standard event descriptions in the next version. CalendarPro
should become more integrated with other rich media content sources. Soundtrack support and sound
schemes are going to be a part of the application in the next releases.
Collaborate
Flash CalendarPro may be left "public" to allow access by anyone or "private" to limit access to yourself
for editing events. Moreover, Calendar Pro is multi-user compliant. It may be available to registered or
unregistered users.
CalendarPro application has a built-in search module to help users find events they are looking for
faster. Search engine is combined with List View, and allows adding additional filters based on the
time range (all events, upcoming events only, today, this week and this month).
Sync
Your website users can add events from Flash CalendarPro application to their desktop time
management applications, such as Microsoft® Office Outlook, Mac iCal and other, that support iCal
format.
Local events can include time zones, which are also passed together with event details. The choice
between the local time zone and the original time zone of the events is up to every particular user.
Navigate
Once all events are loaded into the calendar, all actions are performed on the same HTML page or
flash movie stage. You may change active time period, navigate months, click tabs - and everything
still changes in runtime. Calendar layout changes immediately. There is no need to reload the page,
simply wait for the new content being generated on the server and loaded for preview on the webpage.
Besides, it does not require excessive server CPU load as well.
Thus, it is one of the advantages over other HTML calendars or scheduling solutions for websites or
intranet systems with ASP or PHP server-side backend.
Print
Flash CalendarPro print option offers true vector quality when committing online calendar to hard
copy.
Print View is available in the following formats: Year, Month, Week, Day and Custom Date Range.
Each view includes the time grid and the list of upcoming events /events in this time period. Print
layout is not designed to one size and changes dynamically based on the paper format you select for
your printer: A4, Letter or Legal.
How it Works
We’ve done our best to make a useful Flash Calendar that would be simple to use both by
end users and calendar administrators. Thus, Flash CalendarPro can run on most
operation systems in most browsers with Flash Player 8 and higher, enabling the widest
audience possible. Administrators, on the other hand, will be surprised at how easy they
can manage such a powerful application on their website.
CalendarPro application consists of three constituents:
• Public CalendarPro;
• Configuration and data files (or dynamic data source: DB Connector, API);
• Administrative Mode to manage events.
The scheme above demonstrates two major files of data source (for calendar settings and
events): one in XML format and another one either in XML or some other data storage
format. Configuring Flash CalendarPro and updating events from the DB (or manually)
requires understanding the structure and parameters of these content sources. Further
chapters of this manual will provide you with an overview of all possible configuration
options and explain how to redefine URL of configuration and data files.
Scripting Language
Action Script 2.0
Flash Platform
Adobe Flash Player version 8 or higher
SWF Package Installation
Flash Calendar installation doesn’t require any specific skills and knowledge. All you need
to know is how to upload calendar files to your server and to be aware of some basics in
HTML.
Prior to installing the calendar to your website we suggest that you testdrive it locally.
You can evaluate the 14-Day Free Trial version before purchasing the product.
Product Deliverables
The following table provides a brief description of Flash CalendarPro folders and files:
bin
documentation Product documentation including installation and usage
instructions
First of all you need to upload the calendar folder online to your web server. You can use
any FTP client if you are working on a static website. If you are using some CMS (such as
WordPress, Drupal, Webblogs, etc) use their uploading system.
Prior to installing the calendar using some CMS, make sure the files will be
saved in one rigid location.
Since CalendarPro folder includes admin mode setup files, we suggest that you
put the folder in a location where it would be comfortable for you to edit events
leaving the website structure intact.
Once you finish uploading, open the same index.html webpage with the sample
calendar in your Internet browser
www.yourwebsite.com/calendarPro_swf/index.html
If you receive the same calendar page in your browser, everything is OK. In case you are
getting some errors, please refer to the Troubleshooting Section of this manual.
You can also put a relative path to calendar SWF file. In thi case make sure
you specify the correct “base” parameter.
Administrative Mode enables editing events. However, the flash application cannot save the changes
directly, and requires server-side scripts to save the file.
Due to the usage of server side scripts , administrative mode works only online.
3.1. Set/Check Permissions for events XML file and temporary folders.
All files you uploaded on the website have default permissions (attributes), which allow
the admin mode to start working immediatelly. However, on some websites the files are
read-only by default. In this case, in order to allow the server-side script to update your
events, you need to change permissions for the following objects:
• for events.xml file to 777 (or “write for all”).
• for admin/backups folder to 777 (including content inside)
for admin/logs folder to 777 (including content inside)
Note: Product package includes ASP and PHP scripts to enable saving changes when
editing in admin mode (.JSP and .CFM versions are available on demand). Before using
the Administrative Mode, you need to find out what scripting language is supported for
your website. Usually this information is available in website hosting plan description.
You can evaluate the 14-Day Free Trial version before purchasing the product.
The following table provides a brief description of Flash CalendarPro folders and files:
bin
documentation Product documentation including installation and usage
instructions
Calendar package includes a sample Flash file with Flash CalendarPro installed. To test
the sample calendar used as MXP:
a) open calendarPro.fla with Macromedia Flash 8 or higher;
b) compile the movie (Ctrl + Enter)
If you receive a similar calendar page in your player, everything is OK. In case you are
getting some errors, please refer to the Troubleshooting Section of this manual.
Step 1. Upload Calendar Files Online
First of all you need to upload the calendar folder online to your web server. You can use
any FTP client.
Since CalendarPro folder includes admin mode setup files, we suggest that you
put the folder in a location where it would be comfortable for you to edit events
leaving the website structure intact.
We suggest that you insert Calendar Pro MXP into your Flash Movie using “attach”
method.
To insert the calendar into your Flash movie, follow these steps:
3. Insert ActionsScript code to a place where you need the calendar to appear and
specify the paths to Flash CalendarPro configuration files:
2) Set appropriate permissions (details provided in Set/Check Permissions for events XML
file and temporary folders section of this manual).
3) Specify the path to update script and set “true” for the usage of the admin mode:
_root.initCalendar("sampleFiles/settings.xml", "sampleFiles/events.xml", "admin/update.php", true);
4 Event Management
After you setup Administrative Mode, you can make the changes in your calendar
http://www.yourwebsite.com/calendarPro_business/admin/index.php
Additionally, you can use the HTML editing mode. The list of the supported HTML tags is
supplied in this document.
Upload Images
Images help to visualize an event and provide a more professional look to your calendar.
Flash CalendarPro uses the standard way of uploading images:
1. You choose the image on your hard-drive
2. The calendar uploads the image to Images folder on your server
You can also modify the existing events. Once you open the dialog box with event details,
you can modify all the event parameters. Additionally, you can erase the event by clicking
“Delete” button in the left bottom corner of the dialog box.
To delete all default events in the calendar which are supplied in the purchased
package, delete all the data between the tags <data><events></events></data> in
events.xml on your server
If you need to change the day of the existing event or shift it to some other time, you
might find it useful to drag an event from one day to another on Month View and from one
time range to another on Day View.
Moreover, you can extend or reduce the time range of the event. Simply click on the border of it
and drag.
All major parameters, such as color gamma, fonts, text labels and behavior options can be
adjusted to match the environment look and feel (website, flash movie or corporate
intranet area) in a single file. Settings.XML file includes all configurable graphic
interface parameters and behavior options. Content of the styles XML file fits the industry
XML standard.
Attribute Description
<defaultEventColors>0x0066CC, These are default event colors which are used when you
0x7AC903,0xF99D17,0xB021EF,0 first create an event
x3AD6D5</defaultEventColors>
<pageBackgroundColor> Specifies page background color
Usage:
<pageBackgroundColor>0xD1FFA3</pageBackgroundColor>
<headingBackgroundColor> Specifies heading background color
Usage:
<headingBackgroundColor>0xD1FFA3</headingBackgroundC
olor>
<backgroundColor> Specifies background color for the calendar controls: Year,
Month, Week, Day, Search control elements and the small
calendar, categories and legend components.
Usage:
<backgroundColor>0xff0000</backgroundColor>
<backgroundColor2> Specifies background color for the calendar body
background and a couple of other elements (non-working
time and days on the month controls).
Usage:
<backgroundColor2>0x000000</backgroundColor2>
<shadowColor> Specifies RGB color for shadow effects.
Usage:
<shadowColor>0x000000</shadowColor>
<darkShadowColor> Specifies RGB color for bevel effects (used in the scroller
components, tabs, etc).
Usage:
<darkShadowColor>0x000000</darkShadowColor>
<shadowAlpha> Specifies transparency for alpha and alpha 2 elements.
<shadowAlpha2> Valid range [0-100]. 100 = fully transparent.
Usage:
<shadowAlpha>60</shadowAlpha>
<shadowAlpha2>16</shadowAlpha2>
<activeColor> Specifies color of active elements.
<activeColor2>
Usage:
<activeColor>0x6ec2ff</activeColor>
<activeColor2>0x9b9b9b</activeColor2>
Usage:
<hintColor>0xFCFFCB</hintColor>
<controlBackgroundColor> Set sthe background color for the element controls.
Usage:
<controlBackgroundColor>0xB5E593</controlBackgroundCol
or>
<controlForegroundColor> Set the foreground color for the element controls
Usage:
<controlForegroundColor>0x2b2f26</controlForegroundCol
or>
<highlightColor> Sets the color for highlight element (semi-transparent
layer over buttons and other pseudo 3D elements).
Usage:
<highlightColor>0x0000ff</highlightColor>
<defaultTextColor>
Usage:
<mandatoryTextColor> <mandatoryColor>0xFF0000</mandatoryColor>
<eventTitleColor>0xFFFFFF</eve
ntTitleColor>
Usage:
<initialView>3</initialView>
<initialDate> Specifies active calendar date in MM/DD/YYYY format. This attribute
is often used together with <initialView> attribute. Default value =
today.
If the initial view mode is set to ‘Month’ or ‘Year’, the user will jump
to the month or year of the initial date correspondingly. The example
below illustrates how to set April 2008 as a default month:
Usage:
<initialView>3</initialView>
<initialDate>04/01/2008</initialDate>
<showEventDetails> Allows opening event details on calendar load. Valid value = existing
event id.
Usage:
<showEventDetails>322544624</showEventDetails>
<highlightEvent> Specifies event ID to highlight on calendar load. Date of this event is
used as an initial date.
Usage:
<highlightEvent>3452345234</highlightEvent>
Attribute Description
<toolTipMode> Set the tooltip format for events with the help of
<toolTipSizeX /> <toolTipMode> tag. Valid values are:
<toolTipSizeY /> 1 – title;
2 – image;
3 – do not show tooltip;
4 – title + description (by default).
Note, when the tooltip mode is set as ‘image’, the maximum
image size can be set with the help of <toolTipSizeX> and
<toolTipSizeY> tags. By default, the image is displayed in its
full size.
Usage:
<toolTipMode>2</toolTipMode>
<legendToolTipMode> Specifies the tooltip mode for the legend:
0 – disabled (by default);
1 – enabled.
Note: The tooltip content is defined from <alt> tag in the
Category/Locations item. If the <alt> tag is missing, the tooltip
content is defined from the <title> tag.
Usage:
<legendDesignType>2</legendDesignType>
<dayViewEventOverAction> Specifies whether to display the tooltips in Day View when the
user points to the specific event with the help of
<dayViewEventOverAction> tag. Valid values are:
0 – display the tooltip (default);
1 – do not display the tooltip.
Usage:
<dayViewEventOverAction >1</dayViewEventOverAction>
<dayViewEventReleaseAction> Select the object the user jumps to when clicking the event in
Day. View with the help of <dayViewEventReleaseAction> tag.
Valid values are:
0 – detailed popup window is displayed (default);
1 – a user jumps to the URL that is specified in events.XML
file.
Usage:
<weekViewEventOverAction >1</weekViewEventOverAction>
<weekViewEventReleaseAction>2 Select the object the user jumps to when clicking the event in
</weekViewEventReleaseAction> Day. View with the help of <weekViewEventReleaseAction> tag.
Valid values are:
0 – no action is performed
1 – detailed popup window is displayed (default);
<monthViewEventReleaseAction> Specify whether to display the tooltips in Month View when the
Attribute Description
Usage:
<popupAnimationEnabled>0</popupAnimationEnabled>
Attribute Description
<searchEnabled> Enable/Disable the search input field
Valid values are:
0 – disable search;
1 – enable search (by default).
Usage:
<searchEnabled>1<searchEnabled>
<showOneDayEventBackgroundOn Show/hide the background of one day event on Month View.
MonthView>0</showOneDayEven Valid values are:
tBackgroundOnMonthView> 0 – don’t show (by default);
1 – show
Usage:
<showOneDayEventBackgroundOnMonthView>0</showOneDayEve
ntBackgroundOnMonthView>
<browseForImageEnabled>1</bro Enable/Disable image upload for an event in the admin mode.
wseForImageEnabled> Valid values are:
0 – disable image upload;
1 – enable image upload (by default).
Usage:
<browseForImageEnabled>1</browseForImageEnabled>
<editCategoryEnabled>1</editCa Enable/disabl category editting in the admin mode.
tegoryEnabled> 0 – disable category editting;
1 – enable category editting (by default).
Usage:
<editCategoryEnabled>1</editCategoryEnabled>
<viewEnabled>1,1,1,1,1</viewEn Show/hide view tabs in the calendar: Year, Month, Week, Day,
abled> List.
to 6 – rounded corners
Side Panel Options
<sortCategories> Specify the sorting order for the legend component accordingly.
<sortLocations> Valid values are:
<sortListOptions> 0 – no sort (default behavior), the order remains the same as
indicated in the Legend.XML file;
1 – sorted in the ascending order;
2 – sorted in the descending order.
Usage:
<sortCategories>1</sortCategories>
<sortLocations>1</sortLocations>
<sortListOptions>0</sortListOptions>
<hideEmptyCategories> Defines if the categories and locations with no events are visible
in the legend component
Usage:
<hideEmptyCategories>true</hideEmptyCategories>
Calendar Component:
Usage:
<showCalendarCategories>1</showCalendarCategories>
<legendDesignType> Specify the type of colorizing items in the categories/locations
panel.
Parameters include:
0 – each category/location color matches its own background
color, which is specified in legend.XML file (by default);
1 – the color of the categories/locations matches the
background of the checkboxes next to them;
2 – the color of the categories/locations matches the foreground
of the checkboxes next to them.
Usage:
<legendDesignType>2</legendDesignType>
Modify Time and Date Properties
<leadSundayStyle> Set the order of weekdays (start week from
Monday or Sunday)
Valid values are:
true – weeks in the calendar start from Sunday;
false – weeks in the calendar start from
Monday.
<dayViewHours> Defines working schedule visualization
<dayStart>
<workingDayStart>
<workingDayEnd>
<dayEnd>
<weekendShowWorkHours>
</dayViewHours>
<dayStart> Specifies the day start time. Use integer values
in 0-24 range. By default the value 0 is set.
Usage:
<dayStart>9</dayStart>
Usage:
<workingDayStart>10</workingDayStart>
(working time is highlighted from 10:00AM)
Usage:
<workingDayEnd>18</workingDayEnd>
Usage:
<dayEnd>22</dayEnd>
(means day grid is limited to 10:00PM. Events
that finish later that 10:00PM are cropped on
the day grid).
Usage:
<weekendShowWorkHours>
true</weekendShowWorkHours>
<timeFormat> Defines time format
<halfDaySuffixes>AM,PM</half
DaySuffixes>
<time>hh:MM HD</time>
<date>ww, mon dd, yyyy</date>
<dateTime>ww, mon dd, yyyy -
hh:MM HD</dateTime>
……………………………………..
……………………………………..
……………………………………..
<dateYearHeader>yyyy</dateYearHeader>
</timeFormat>
<halfDaySuffixes> Defines text captions for AM/PM labels.
Usage:
<halfDaySuffixes>am,pm</halfDaySuffixes>
<time> Specify the time template (used for event).
Usage:
<time>hh:MMHD </time>
You can use the following variables in your
format expression:
"hh" – 12 hours format with leading zero (i.e.
01, 02);
"h" – 12 hours format without leading zero (i.e.
1, 2);
"HD" – suffix AM/PM and switch to AM/PM
mode;
"HH" – 24 hours format with leading zero (i.e.
01, 02)
"H" – 24 hours format without leading zero (i.e.
1, 2);
"MM" – minutes with leading zero (i.e. 01-59);
"M" – minutes without leading zero (i.e. 1-59);
"SS" – seconds with leading zero (i.e. 01-59);
"S" – seconds without leading zero (i.e. 1-59).
Usage:
<date>ww, mon dd, yyyy</date>
Usage:
<dateShort>mon dd, yyyy</dateShort>
Usage:
<dateTime>ww, mon dd, yyyy, hh:MMHD
</dateTime>
<dateDig>mm/dd/yyyy</dateDig> Event date format in the edit form of the
admin mode
Example:
24h mode AM/PM Mode
<time>HH:MM </time> <time>hh:MM
<dateTime>ww, mon dd, HD</time>
yyyy - HH:MM <dateTime>ww, mon
</dateTime> dd, yyyy - hh:MM
<dateTimeShort>mon dd, HD</dateTime>
yyyy - <dateTimeShort>mon
HH:MM</dateTimeShort> dd, yyyy - hh:MM
HD</dateTimeShort>
Option Description
<iCalExportEnabled> Enable iCal export by using the <iCalExportEnabled> tag in
settings.XML file.
Example:
<iCalExportEnabled>1</iCalExportEnabled>
Example:
<iCalExportEnabled>0</iCalExportEnabled>
Option Description
<viewMenuLabels> Specifies view labels.
Usage:
<viewMenuLabels>Year,Month,Week,Day,List</
viewMenuLabels>
<createEventTooltipText> Specifies text to create new event in Admin Mode
Usage:
<createEventTooltipText>Click to create new
event</createEventTooltipText>
<monthOfYearFull> Specifies text captions for full and short month names.
<monthOfYear>
<daysOfWeek3> Usage:
<daysOfWeek> <monthOfYearFull>January,February,March,April,May,Jun
e,July,August,September,October,November,December</
monthOfYearFull>
<monthOfYear>Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,
Nov,Dec</monthOfYear>
<daysOfWeek3>Sunday,Monday,Tuesday,Wednesday,Thurs
day,Friday,Saturday</daysOfWeek3>
<daysOfWeek>S,M,T,W,T,F,S</daysOfWeek>
Choose Fonts & Text Styles
You can change the types of fonts used in different calendar parts and tags. There are 6
font types you can modify:
1. default text
2. headings
3. large text fonts
4. xLarge text fonts
5. small text fonts
6. small text fonts used by default
Following is the description of the tags that specify these text formats:
Tag Description
<size> The font size of the element. The recommended values
for the input vary from 10 to 16 in order to fit the
calendar interface.
<font> The font that will be used to draw the text. The calendar
supports basic fonts (including Arial, Tahoma, Verdana,
Courier, etc.). If you want to add your own fonts, they
must be embedded into flash while the component is
compiled. This ability requires the calendar installation
package with source files or MXP component.
<bold> Specifies whether the text is bold or not. The supported
options are:
true – the text is bold;
false – the text is not bold.
All events are specified within <events> tag. Every event is determined by a set of tags.
Below is their description:
Tag Description Type
<title> The title of the event. Mandatory
Usage:
<title>Single Test Event</title>
<date> Specifies the date, to which the event is assigned in Mandatory
MM/DD/YYYY format. Default event duration is one day.
Usage:
<date>01/01/2009</date>
<date_to> Specifies the end date for the event with duration more than Optional
one day.
Usage:
<date>01/01/2009</date>
<date_to>01/10/2007</date_to>
<time> Specifies event start time in 24h format. An event is Optional
considered all day long <time> attribute is not specified.
Usage:
<time>18:30</time>
<time_to> Specifies the end time for the specific event. Default event Optional
Usage:
<time_to>21:30</time_to>
<event_id> The unique identifier of the event. Optional
If several events have the same id, the events will not be
displayed.
If event identifier is missing, it will be generated and stored
automatically next time the user edits events in
Administrative Mode.
Usage:
<event_id>4239076023249</event_id>
<category> Category nameThe identifier of the category the event is Optional
linked to.
<location> The name of the location the event is linked to. Optional
<recursive freq= /> Specifies whether the event repeats on the regular basis or Optional
not. The supported options are:
yearly – the event is repeated each year;
<recursive freq=”yearly” />
monthly – the event is repeated each month;
<recursive freq=”monthly” />
weekly – the event is repeated each week.
<recursive freq=”weekly” />
<recursive_to> Specifies the finish date for the recursive event. By default, Optional
the recursive event is not limited in time.
Usage:
<event>
<title>Lunch with Peter</title>
<time>13:00</time>
<date>01/01/2008</date>
<recursive freq=”weekly” />
<recursive_to>07/01/2010</recursive_to>
</event>
<description> The event description, which is displayed on the detailed view Optional
that appears after the user clicks the event in the calendar.
You can use HTML tags in the description to add text
formatting, images and other standard elements.
Usage:
<title>Martin Luther King Day</title>
<description><![CDATA[The third Monday in January, observed
in the United States in commemoration of the birthday of
Martin Luther King, Jr.</br><i>Find out more on
answers.com</i>]]></description>
Usage:
<image>img/some.jpg</image>
<image>http://www.yoursite/img/some.jpg</image>
Usage:
<url>http://www.answers.com/topic/independence-
day</url>
<target> Specifies where to open the target URL: Optional
_self - the target URL will open in the same frame as it was
clicked. This is a default attribute;
_blank - the target URL will open in a new window;
“xxx”, where xxx is the name of your frameset - the target
URL will open in the specified frame as it was clicked.
Though Flash CalendarPro does not have the 2nd time zone and works with local time on
every PC, it is possible to carry event timezone when exporting event to iCal file and then
importing to your desktop organizer.
Time zone is set to event via location attribute (green), if it is linked to a timezone
(yellow).
...
</timezones>
List of 55 global Time Zones is already included in Events.XML file for your
convenience. It is compliant with MS Office and Mac iCal organizers and includes
standard and daylight saving time offsets (time offset and switch timestamp).
If you edit Time Zones, make sure TZID tag is compliant with Microsoft Outlook
time zone list.
FlashVars must be specified twice in <param> and <embed> tags for different web
browser types.
Use URL encoding to set variables via FlashVars (‘%20’ for SPACE, ‘%26’ for ‘&’
and so on).
FlashVars must be specified twice in <param> and <embed> tags for different web
browsers.
Use URL encoding to set variables via FlashVars (‘%20’ for SPACE, ‘%26’ for ‘&’
and so on).
Flash CalendarPro cannot read events from your database directly. Usually
there is a middle layer, a script that is used to retrieve events from the database
and possibly push the updated events back.
Databases and platforms are always different. USFlashMap does not provide
ready-made solutions to export events from your database. Instead, we provide all
necessary descriptions for your webmasters or developers to implement the
integration.
You may also contact USFlashMap.com team, provide information about your
system and request integration services.
Static Method
Read-only integration (or Asynchronous Integration) is a one-way integration, when events
from your database or another data source are exported to the calendar XML file and
published on the website / extranet. Flash Calendar Application can be configured to read
from the script directly, instead of retrieving the XML file.
Static method is used to export events and update (overwrite) events.XML files. Update
can be scheduled or take place on demand, depending on your needs.
You can change URL to events.xml in MXP (component parameters) or in HTML via
FlashVars. This gives you a possibility to specify which calendar should be used on the
page, or create several pages for different calendars.
Sample HTML code illustrates how eventsUrl is pushed via FlashVars parameter:
<object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000"
codebase="http://fpdownload.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=8,0,0
,0" width="787" height="512" align="middle">
<param name="FlashVars" value="eventsUrl=john.xml" /><param name="allowScriptAccess"
value="always"/><param name="movie"
value="http://www.yourdomain.com/calendarPro_business/calendarPro.swf" /><param
name="quality" value="high" /><param name="scale" value="noscale" /><param
name="bgcolor" value="#D1FFA3" /><param name="base" value="." /><embed
FlashVars="eventsUrl=john.xml" allowScriptAccess="always"
src="http://www.yourdomain.com/calendarPro_business/calendarPro.swf" quality="high" base="."
scale="noscale" bgcolor="#D1FFA3" width="787" height="512" align="middle"
type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"
/>
</object>
Dynamic Method
Instead of reading events from static XML file(s), Flash CalendarPro can be configured to
read events from the server-side script directly. This feature enables retrieving data for a
specific user or event, adding parameter to your script (userID, sessionID, etc.)
*Note: Dynamic method requires knowledge of server-side scripting, XML, and DB (if it is
the data source).
Similar to the static Method, script URL is defined via FlashVars in HTML code. HTML page
can be generated dynamically, and the parameter eventsURL is mapped for any user.
Sample index.html code:
Use URL encoding to pass ‘&’ and other characters in eventsURL parameter
Read-Write Integration
Read-Write (or Full Integration) uses the same approach for reading events as in Read-Only
Mode (Dynamical Method) plus you need to configure server-side scripts to save events
back to the database.
It is a combination of reading events and saving events with two different scripts (or one
script but read-and-write modes). This type of integration is often required to show events
from the database filtered by user. In this case you need to create a script that would grab
events form the DB by user, and then format them in XML for the calendar. On top of that,
it is possible to pass new updated events back to the saver script and push back to the
database.
1) Calendar calls the server-side script URL with the parameters to read events;
2) The server-side script retrieves events from the data source and returns formatted
events XML content back to CalendarPro;
3) When making changes, CalendarPro calls a saver script URL with parameters, and
simultaneously submits events via POST method;
4) The server-side script saves changes to the database or other source.
Product packages include several saving scripts (ASP, PHP, etc). These may serve
as samples to see how to receive events.xml content from the CalendarPro
application.
Chad Vanuatu
Seychelles
Guinea
Rwanda Monaco
Haiti
Belgium Suriname
Netherlands
Italiano (Italian)
Italy Sovereign Military Order of
Malta
Switzerland Croatia (Istria)
San Marino Slovenia
Colombia Honduras
Spain Bolivia
Argentina El Salvador
Venezuela Nicaragua
Paraguay
Peru
Costa Rica
Chile
Uruguay
Ecuador
Panama
Guatemala
Cuba Equatorial Guinea
Українська (Ukrainian)
Ukraine
Русский (Russian) Abkhazia (Georgia)
Russia
Belarus South Ossetia (Georgia)
Kazakhstan
Moldova
Kyrgyzstan
Gagauzia
Polski (Polish)
Poland
Greenland
Svenska (Swedish)
Sweden (de facto) Estonia (only in Noarootsi)
Finland
Česky (Czech)
Czech Republic
(Japanese)
Japan
日本語
( עבריתHebrew) Israel
Íslenska (Icelandic)
Iceland
When editing settings.xml file, make sure you save the file and keep UTF-8
encoding. To make sure UTF-8 encoding remains when you save the file, try “Save
As” option and see the suggested encoding.
7 Appendixes
Appendix A: Troubleshooting
CalendarPro works fine on my PC, but not when I upload it to my web server.
1. Check whether all product files are uploaded to the server (SWF, XML, etc.).
2. Check HTML code of the page. Path to SWF file might be set up incorrectly (if you
made some changes locally)
My CalendarPro works fine on my website online, but it returns error when trying to
create new or modify existing event in Administrative Mode.
1. Make sure you followed necessary steps to Configure Server-Side Backend for the
Administrative Mode
2. Your website hosting provider does not allow unexpected POST data
Why doesn’t CalendarPro recognize the latest changes I made to events file?
Your browser is likely to be using a previously cached version of calendar files instead of
reading the latest version. This often happens to flash content.
1. Clear the cache in your web browser. If you’re using a Meta tag in your html page to
control caching, you might have to delete it.
2. Try with / without www in the URL (browser often refers as to a different domain).
3. Try to run the calendar in a different browser and on a different PC
Administrative mode does not apply changes. It does not save changes.
Administrative area is not correctly configured. Possible reasons:
1. Server script URL to save the changes is not specified in styles.xml file.
2. Required permissions for events.xml file are not set. Follow the steps described
in the Configure Server-side Backend for the Administrative Mode section.
3. Server configuration does not allow server-side script to receive events via POST
method and save the file.
When using the calendar as MXP in my Flash movie, I get a black background.
There are other third party components that override CalendarPro variables or other
elements. Macromedia components on the scene (such as list or grid) may also cause such
troubles.
1. Try using alternative components.
2. This problem does not take place when you compile CalendarPro package with the
source codes (OEM license).
Tag Description
Anchor tag (<a>) The <a> tag creates a hyperlink and supports the following
attributes:
href - Specifies the URL of the page to load in the browser. The
URL can absolute or relative to the location of the SWF file that is
loading the page.
target - Specifies the name of the target window to load the page
into.
For example, the following HTML snippet creates the link “Go
home,” which opens www.macromedia.com in a new browser
window.
<a href=”../home.htm” target=”_blank”>Go home</a>
You can also define a:link, a:hover, and a:active styles for
anchor tags by using style sheets.
Bold tag (<b>) The <b> tag renders text as bold. A bold typeface must be
available for the font used to display the text.
<b>This is bold text.</b>
Break tag (<br>) The <br> tag creates a line break in the text field, as shown in this
example:
One line of text<br>Another line of text<br>
Font tag (<font>) The <font> tag specifies a font or list of fonts to display the text.
The font tag supports the following attributes:
color - Only hexadecimal color (#FFFFFF) values are supported.
For example, the following HTML code creates red text.
<font color=”#FF0000”>This is red text</font>
face - Specifies the name of the font to use. Alternate fonts can
be specified in a comma delimted list following the primary font. If
the primary font is not installed on the playback system, or isn’t
embedded in the SWF file, then Flash Player will work through the
list until it finds a supported font.
Example:
<font face=”Times, Times New Roman”>This is either Times or
Times New Roman..</font>
size - Specifies the size of the font, in pixels. You can also use
relative point sizes (+2 or -4).
<font size=”24” color=”#0000FF”>This is green, 24-point
text</font>
Image tag (<img>) The <img> tag lets you embed external JPEG files, SWF files, and
movie clips inside text fields. Text automatically flows around
images you embed in text fields. This tag is supported only in
dynamic and input text fields that are multiline and wrap their
text.
In the Flash authoring environment, select a text field on the Stage
and then, in the Property inspector, select Multiline from the Text
Type pop-up menu.
Italic tag (<i>) The <i> tag displays the tagged text in italics. An italic typeface
must be available for the font used.
That is very <i>interesting</i>.
The above code would render as follows:
That is very interesting.
List item tag The <li> tag places a bullet in front of the text that it encloses.
(<li>) Grocery list:
<li>Apples</li>
<li>Oranges</li>
<li>Lemons</li>
The above code would render as follows:
Grocery list:
Apples
Oranges
Lemons
Paragraph tag The <p> tag creates a new paragraph. It supports the following
(<p>) attributes:
align - Specifies alignment of text within the paragraph; valid
values are left, right, and center.
The following example uses the align attribute to align text on
the right side of a text field.
textField.htmlText = “<p align=’right’>This text is aligned on the
right side of the text field</p>”;
The following example uses the class attribute to assign a text
style class to a <p> tag.
var myStyleSheet = new TextField.StyleSheet();
myStyleSheet.secreateTextField(“test”, 10, 0,0, 300,100);
createTextField(“test”, 10, 0,0, 300,100);
test.styleSheet = myStyleSheet;
test.htmlText = “<p class=’body’>This is some body-styled
text.</p>.”;
Span tag (<span>) The <span> tag is available only for use with CSS text styles. It
supports the following attribute:
class - Specifies a CSS style class
Bug Fixes
If you find a bug, please send us a report from your support version. It will be added to the
known bug list and will be fixed within the next product build. Usually new product build is
available 1-2 times a month. Thanks for your assistance!
Support
Flash CalendarPro comes with a short readme and user manual that describes most of the
problematic issues that may take place. Prior to contact support, please make sure your PC
and Website hosting meets product requirements and you follow all the steps from
installation guidelines.
Every product comes with 2 hours of support via CRM ticketing system or chat. If you are
still unable to find a solution for technical problem or did not find an answer to your
question – feel free to submit Support Ticket.
If you have any problems with the server-side scripts (admin mode) – please make sure you
attach the following to your ticket:
1. URL to the website page with the case, so we can check online immediately;
2. Description of your software (OS, Browser version, Flash player version) so we are
able to reproduce the case;
3. Provide temporary access information to your website hosting so our technical
support can log-in to the server and study the environment.
Please also note the time difference. Support department is located in Europe, +2GMT. We
also have holidays and day off ☺
Will you need more support or communication via email / video chat – we provide
advanced support packages with faster turnaround time and communication channels at
additional cost.
Product Customization
If you require additional features developed or modification to the existing functionality of
the software, feel free to contact us regarding product customization.
How it works:
• Customer contacts us with customization request
• USFlashMap engineers make preliminary estimate to determine the following:
o if requested feature is possible to implement
o time/cost it may take. Cost of work performed is based on the actual
company hourly rate ($30/hour).
• Customer purchases product license. If required feature changes core product
functionality and cannot be implemented as a branch, customer must to obtain
OEM license to keep the source codes with modification for future needs.
Upon obtaining product license, USFlashMap customer care manager provides a more
accurate estimate, scope of work, contract and invoice* (required for budgets over
$1,000).
*Usually USFlashMap requires upfront payment for customization requests less than one
week of time or $1,000 equivalent.
Plug-in Delivery
• Plug-in is available in two versions for different hosting platform options
o PHP 5.0
o ASP.Net 2.0 framework
• Delivery time: 3-5 business days
• Plug-in cost: $500
Import Events from Microsoft Excel File Plug-In
Alternatively to CSV files, in many cases MS Excel file with events could be used to import
events into Flash CalendarPro application. MS Excel file import package includes the
following:
• Password protected access
• File upload function
Upload .XML file onto your web server.
• Versions Backup
Provide versions history list and restore option
• Installation Script
Detects hosting server technology (PHP or ASP) and verifies file permissions
• Adjustable Configuration Parameters
Need to specify alternative column titles for tabulated data (if different from
suggested) and adjust field parameters:
o Time (am/pm or 24h);
o Date template (yyyy/mm/dd format);
o Output file location (Events XML file by default).
Plug-in Delivery
• Plug-in is available in two versions for different hosting platform options
o PHP 5.0
o ASP.Net 2.0 framework
• Delivery time: 3-5 business days
• Plug-in cost: $500
Plug-in Delivery
• Plug-in is available in two versions for different hosting platform options
o MySQL 4.1+, PHP 5.0
o MS SQL, .Net 2.0 framework
• Delivery time: 7 business days
• Plug-in cost: $750.00
* Price may vary based on your existing DB. Please contact USFlashMap in advance
so our technical support team could check your DB / hosting server for the amount
of integration efforts required.
Event Submission Approval Plug-In
Approval of the new events plug-in enables publicity or authorized personnel to add events
that require approval prior to be added to the public calendar.
Plug-in consists of two components: Submission page(s) and Email sender.
Submission Page(s)
1. Guest User Submission Page
a. Guest submission page is open for public; no login/password is required.
b. Guest user can see all available events and add new for further approval. Until
approval such events are not visible in the public calendar.
c. Guest users can not edit already submitted events.
2. Registered User Submission Page
a. Password protected with user ID/password
b. Registered users see all public events and can add new events. User becomes
an author of this event and may edit it in the future.
c. Registered user enters email to receive notification when event status is
changed.
d. Editing personal approved event requires approval as well. Approved event with
modified details becomes pending again and is temporary removed from the
public calendar until approved.
3. Administrator Page is executed by CalendarPro in Administrative Mode.
a. Administrator can see all events, including events with status “pending”
(waiting for approval).
b. Pending events include specific icon or color mark to distinguish from already
approved events.
c. Administrator can change event status in Event Details window (Pending,
Approved, Disapproved). Based on calendar configuration, disapproved events
can be deleted at all, to avoid enormous number of events stored in the
database or events XML file.
Email Sender
Email is sent to recipients in the following cases:
• New event added for approval (to administrator);
• Approved event details changed or event deleted by author (to administrator);
• Event approved status changed (to author);
• Event details changed or event deleted by administrator (to author).
Configuration Settings
• user_editApprovedEvent (1/0)
Enables author change event details or remove events after approval;
• emailSenderURL
Turns email sender On/Off and specifies script URL;
• admin_dragPendingEvent (1/0)
Enables Administrator drag pending events (change time settings without opening
event details window);
Plug-in Delivery
• Available for PHP 5.0 and ASP.NET hosting servers.
• Delivery time: 7 business days
• Plug-in cost: $750.00
• Using third party content management system for your website can make adding
registered user page impossible because Login/Password authorization may not be
available). Guest submission does not have any authorization requirements and will
work everywhere.
9 Document Preview
The information in this document has been carefully checked and is believed to be
accurate. However, USFlashMap.com assumes no responsibility for any technical
inaccuracies or typographical errors that may be contained herein. In no event will be
USFlashMap.com held responsible for direct, indirect, special, incidental, consequential or
any other loss or damage caused by errors, omissions, misprints or misinterpretation of the
information found in this publication, even if advised of the possibility of such damages.
USFlashMap.com expressly disclaims any and all liability to any person, in respect of
anything done or omitted, and the consequences if anything done or omitted, by any such
person in reliance on the contents of this publication.
Change Record
Date Author Version Change Reference
4.05.2008 Yaroslav Kuntsevych 1.1 Document created form v1.1 functional
specification
30.08.2009 Inna Shmun 1.30 Manual Update with regard to product upgrade
13.09.2009 Yaroslav Kuntsevych 1.31 Visuals for Installation and other sections
24.09.2009 Inna Shmun 1.33 Application of the final version with regard to
the comments