IssueManager 3.0
IssueManager Enhanced 3.0
VCalendar

News 
Patches available in Downloads 9/5/2006

Subscribe
for notifications about new releases
(of all our apps)
Email


Wordpress themes


Design awesome Wordpress
themes & professional
Website templates.
www.Artisteer.com

User's Manual

Introduction

VCalendar (Virtual Calendar) is a web-based application for posting and maintaining events and schedules online, in calendar format.

The data is stored in a database centrally on a web server and users need just a web browser to access the VCalendar. No local software needs to be installed on the client machine and all web browsers available are supported.

The application itself can be installed virtually on a compatible web server, whether it is internal within a corporate LAN, or externally, hosted by a web hosting company. The distribution does not include any custom components and full source code is available for examination and customization.

Additionally, you may add your own logo in the header. VCalendar contains several predefined CSS (Cascading Style Sheets) styles, which can changes the general look and the scheme of the application dynamically.

Access/Security

VCalendar does not re quire a password to view the public events.

VCalendar requires the User Login for adding events and viewing private event and it is configured with 2 default users and 3 security levels, as shown below.

Default Login Default Password Security Level
user user 10 - User
admin   100 - Administrator

In the user administration section VCalendar displays User Types: Non-confirmed user, User and Administrator, which are just a sample data and can be modified within the application code. VCalendar uses numeric Security Levels (1, 10 and 100) as follows:

  • Security Level 1:
    This security level denotes that the user is registered but its registration is not confirmed.  The confirmation can be done via email or by the administrator (it is specified in admin/config).
  • Security Level 10:
    This security level allows viewing the private events, adding events, etc. The additional permissions are specified in admin/Permissions.
  • Security Level 100:
    This is the highest security level available only to administrators and allows them to modify and delete users, configure system settings, and modify existing events, etc.

VCalendar Reference Manual

This Reference Manual explains the functionalities of the VCalendar along with the field-wise descriptions and screen shots.

The entire application is divided into seven modules namely:

  1. Calendar. The Calendar has four views:
    1. Yearly
    2. Monthly
    3. Weekly
    4. Daily

    Additionally the user can activate the Calendar Preview. The user is able to switch between the VCalendar views.

  2. Search events. Search allows the user to find events using some criteria.
  3. Add event. Add event allows adding a new event.
  4. Profile. The Profile displays profile details of the currently logged in user. The user details and password can be changed there. Also the user is able to see all own events there.
  5. Registration. The Registration allows a new user to register in the system.
  6. Login/Logout. The VCalendar has a Login/Logout facility to maintain secure access to the application. Also the user can retrieve the forgotten password there.
  7. Administration. The Administration screen lists all the activities that are available for application administrators. This screen helps the administrator to navigate to the required section by clicking on respective links.

Login

The Login screen allows users to access the application by providing their user name and password.

Users provide their logins and passwords and enter them in the respectively named fields. Once login and password are validated, user is redirected to the Month calendar.

Remind Password

The Remind Password screen allows users to get a new password application by providing their login or email.

If the login or email exists then the new password will be sent to this email.

Registration

The registration screen allows the user to register in the system for adding events and viewing the private events. There are three new user confirmation options:

  • without confirmation,
  • email confirmation,
  • and confirmation by the administrator (please see the Administration part documentation).

Property Description
Login Specify the login used to access the system. Login must be unique within application and existing logins will be detected.
Password Specify the password used to access the system. It can contain only alphanumeric symbols and cannot be shorter than 3 characters.
Confirm password Re-enter the password for confirmation.
First Name Specify the first name of the user.
Last Name Specify the last name of the user.
Email Specify the user’s email address used to send the confirmation emails.

Calendar Snapshot

The Calendar Snapshot is used to quick view of month events.

The Calendar Snapshot can always show the current month or can show the month of the main Calendar.  In the second case the navigator to the neighbor months can be activated.

By default the Calendar Snapshot is shown in the week and day views but it can be also activated in the month view.  The events are not displayed directly in the Calendar. The dates with events are displayed in bold.  When the cursor is over the date with events the box with event titles is displayed.

If the user clicks on the date the calendar is switched to the Daily View for the selected day. If the user clicks on the (Weekly View) icon in the right column of the Calendar Snapshoot the calendar switches to the Weekly View.

The parameters of the Calendar Snapshot and displaying of the (Weekly View) icon is set in the Configuration section.

Monthly View

The Monthly View is the default page of the system. It also may also be accessed from any place in the system by clicking on "Month" link in the top navigation menu.

The Monthly View displays all events for the selected month. The current month is displayed by default. The user can click on the event link to see the full info. The event can be shown in the pop-up window or in the same browser window. This option is set in the Configuration section of VCalendar.

If the user clicks on the day number the calendar is switched to the Daily View for the selected day. If the user clicks on the (Weekly view) icon in the right column of the Calendar Snapshoot the calendar switches to the Weekly View. If the user has rights to add events then in the right corner of each date cell the user will se the  (Add Event) icon which allows adding events to the current day.

The navigator at the bottom allows switching between the neighbor months or years. The icons at the right bottom of the navigator row allow switching to the Yearly - , Monthly - , or  Weekly -  views relatively to the current date.

Yearly View

The current year may be accessed from any place in the system by clicking "Year" in the top navigation menu.

The Yearly View displays dates with events for the whole year.  To make the year display convenient for viewing the events are not shown. The dates with events are shown in bold. When the cursor is over the date with events the box with event titles is displayed.

If the user clicks on the Month’s name link the calendar will switch to the Month View. If the user clicks on the  (Weekly View) icon in the right side column of any month the calendar will switch to the Weekly View for the selected week of the selected month. The display of the (Weekly View) icon is set in the Configuration section. If the user clicks on the date link the calendar will switch to the Daily View.

The navigator below allows selecting any year.

Weekly View

The current week may be accessed from any place in the system by clicking "Week" in the top navigation menu.

The Weekly View displays events from the selected week. If the user clicks on the event link the detailed event info will be opened.  The event can be shown in the in the pop-up window or in the same browser window. This parameter is specified in the Configuration section.

If the user clicks on the date link the calendar is switched to the Daily View. If the user has rights to add events then the clicking on the  (Add Event) icon will add event to the current day.

The navigator below allows selecting any week of the current year.  The icons at the right bottom of the navigator row allow switching to the Yearly - , Monthly - , or Weekly -  views relatively to the current date.

Daily View

The today's events may be accessed from any place in the system by clicking "Day" in the top navigaton menu. The Day View displays events of the specified day.

If the user clicks on the event link the detailed event info will be opened. The event can be shown in the in the pop-up window or in the same browser window. This parameter is specified in the Configuration section. If the user has rights to add events then the clicking on the  (Add Event) icon will add an event to the current day.

The navigator below will allow selecting any week of the current year. The icons at the right bottom of the navigator row allow switching to the Yearly - , Monthly - , or Weekly -  views relatively to the current date.

Search

The Search function allows users to find events that match specified criteria.

Users can also perform search action based on: title, category and bounding dates.

Profile

The Profile page provides the details of the currently logged in user. The Profile contains 3 sections:

  1. Profile info
  2. Change Password
  3. My Events

Profile Info

The Profile Info provides the details of the currently logged in user. This screen helps the user update own profile details.

Property Description
Login Displays the login name assigned to the current user. It cannot be updated.
First Name Displays the first name of the user. The user may update this field.
Last Name Displays the last name of the user. The user may update this field.
Email Denotes email address of the user. The user may update this field.

Change Password

The Change Password section allows user to change own password.

Property Description
Current password Specify the current user password.
New password Specify a new password to access the system.
Confirm New password Re-enter the password for confirmation.

My Events

The My Events section allows users to maintain personal events.

Add Event

If users have rights to add/edit events the (Add Event) icon will be shown for the date in Calendar Views. Clicking on this icon will add an event to the current day.

The Add New event screen presets the user a form to define a new event.

The user provides the following data:

Property Description
Category Select the event category. It is used for classification of the calendar events.
Event Title Specify the event title. This title will be shown in calendar views.
Event Description Specify the brief description of the event.
Event time Specify the time of the event.
Event time end Specify the ending time of the event.
All day event Select this option if the event does not have specified time limits, i.e. it continues during the whole day or the time constraints are not specified.  Time for such events is not shown in the Calendar Views.
Date Specify the date of the event.
Recurrence
Recurrence Check this box to create recurring event entries in your calendar.
Every Specify how often the event added:
  1. on the regular basis (every day, every week or every Monday)
  2. with a specified delay, for example every second day, etc.
End by Specify the last date of the event.

Additional Fields

The event can also contain Custom Fields such as Location, Fee, URL ant others. The activation and setting of those fields in performed in the Administration in the Custom Fields section.

Edit Event

If users have rights to add/edit events clicking on the day number link in Calendar Views will open the Edit event screen used for updating event parameters.

All modified fields are identical to the Add Event section, Please see above.

For recurrent events, the user can check the box to apply changes to all recurrent events.

View Event

View Event is used to see the full event information. The details are shown each time event title link is clicked in any calendar view.

Additional fields are shown on this screen only if they were filled when adding or updating. If the current user has rights to edit this particular event the "Edit event" link will be shown.

VCalendar Administration

The Administration part has the modules of the application:

  1. Users
  2. Categories
  3. Configuration
  4. Messages
  5. Permissions
  6. Email Templates
  7. Custom Fields

Translations

The lists in all screens except Users and Configuration have the column with Translation button for each record. Clicking on this button raises the pop-up window with a form for editing text in all available languages.

The following demonstrates the Category translations:

Users

The User section allows new users to be added and existing ones to be modified or deleted.

Column Name Description
Login Displays the user login.
First name Displays the user first name.
Last name Displays the user last name.
Email Displays the email address corresponding to the user.
Security Level Displays the security level assigned to the user.
Date Add Displays the user addition or registration date.
Active Displays the status of the user, i.e. whether the user has the right to log in.

Clicking on the Add New link opens the Add New User screen. Clicking on the Login link opens the Edit screen for the selected user.

Add/Edit User

The Add New User screen is used for adding new, updating or deleting existing users.

Property Description
Login Specify the login of the user to be added. The login has to be unique. This field cannot be updated.
Password Specify the password of the user.
Security Level Select the security level of the user. It can take any of the following values:

 

  1. Non-Confirmed user
  2. User
  3. Administrator
First Name Specify the first name of the user.
Last Name Specify the last name of the user.
Email Specify the Email address of the user.
Active Specifies the status of the user. Specifies whether the user has the right to log in.

Categories

The categories screen allows the user to add new, modify or delete existing categories. Clicking on any of the links under the priority list opens the Add/Edit Category screen.

Property Description
Name Displays the category name.
Icon The category may have an icon which will be shown near events of this category in the calendar.

 

Configuration

The Configuration screen is used to modify the settings of the currently running application instance.

Property Description
Calendar Snapshot mode Specified the behavior of the Calendar Snapshot. Options:
  1. Don’t show at all
  2. Show current month
  3. Show selected month
Show Calendar Snapshot in views Specifies views in which the Calendar Snapshot is shown: Month, Weekly and Daily or only on Weekly and Daily.
Display the week icon in the Calendar Snapshot Specifies if the week icon if shown in a separate column. This icon is used for accessing the Weekly View.
Display the navigator in the Calendar Snapshot Specifies if the navigator is shown below. The navigator is used to switching between neighbor months at the bottom of the Calendar Snapshot.  If Calendar Snapshot mode is set to Current month the navigator is not shown.
Display the week icon in the year calendar Specifies if the week icon if shown in a separate column in the Yearly View. This icon is used for accessing of the Weekly View.
Open the pop-up window for the events If checked the events will be opened in a pop-up window otherwise in the same browser window.
Allow users to select a style Specifies if the user will be able to change the Style using the list box in the Header Menu.
Allow users to select a language Specifies if the user will be able to change the translation of VCalendar using the list box in the Header Menu.
Registration type Specifies the Registration confirmation type. Options:
  1. Registration without a confirmation.  The user is granted with an access to VCalendar right after the registration.
  2. New registration confirmed by E-Mail. The user is sent an email with the authorization code to confirm registration.
  3. New user addition requires the administrator approval. The registration is confirmed by the administrator.
E-Mail to be shown in the From field The Email address to be used as From address for notifying users.
SMTP Server name Specify the SMTP Server name used for sending confirmation emails.
SMTP Server port Specify the SMTP Server port used for sending confirmation emails.
Email sending mode In ASP, specify the component for sending emails: CDO or CDONTS.
Default Style Specify the style used by default.
Default Language Specify the translation used by default.
Menu type Specify the menu type. Options:
  1. None.
  2. Vertical. The menu will be shown to the left under the Calendar Snapshot.
  3. Horizontal. The menu will be shown at the top of all pages.
Page header Text and/or HTML which will be displayed in the page header.
Page footer Text and/or HTML which will be displayed in the page footer.

Messages

The Messages screen displays the service messages shown to the user after certain operations, for example after registration, password change, etc.

Edit Message

The edit screen allows the administrator to update the messages presented to users.

Property Description
Type Displays the message type. This field cannot be updated.
Description Specify the description of the message. The description is not accessible by users and shown only on the Message screen for information.
Value The contents of the message presented to the user. The field can contain the HTML tags and specific fields for substituting application variables.

Permissions

The Permissions screen is used to specify the access levellevels required to perform event operations.

There are the following 3 sections:

  1. General permissions specify those who have rights to add new events.
  2. Public events permissions specify those who have rights to update/delete public events.
  3. Private events permissions specify those who have rights to access private events.

Email Templates

VCalendar uses predefined Email Templates which presented in this section. Those are the templates of email messages sent to user after certain operations, for example after the registration, password change, etc. The Email Template use the predefined tags of the following type: {user_login}, {user_name}, etc.

Edit Email Templates

The Edit Email Templates screen allows the administrator to update an email template.

Property Description
Type Displays the template type. This field cannot be updated.
Description Displays the template description. The description is not accessible by users and shown on the Email Templates screen for information.
From Specify the email address used as the From address for notifying users. If the value is not specified the Configuration value will be used.
Subject Specify the message subject.
Body Specify the message body.

Custom Fields

The administrator is able to rename or hide/disable the following fields: Location, Cost and URL.

The administrator is able also to utilize up to 9 additional custom fields: 3 text fields, 3 text areas and 3 checkbox fields.

The Custom Field screen is used to customize the fields that are used in the events. Using this screen, the administrator can modify an existing custom field or enable additional ones.

The existing custom fields are displayed below the Field Name column. Clicking on each of these links helps the user to modify the currently selected custom field.

Property Description
Field Name Displays the currently selected custom field. This field cannot be updated.
Field Label Displays the label specified for the custom field. This field can be updated.
Active Specifies the status of the custom field in the Issue List screen. This can either be enabled or disabled.
[print] Revised: 7/4/2006
   Visit our sponsors:
Visual PHP and Web Development, Web Reporting