ALPHA CALENDAR PRO
USER GUIDE
Notes:
- If you are using alpha Calendar version 1.1.1 for compatibility with Flash Calendar 1.3 go to this Link
- you can also find help in the video tutorials section
Index
1. Installation
2. Setup and testing
3. Using Alpha Calendar Pro
4. Troubleshooting
5. Vesrion History
6. Ask Us Live
1. Installation
Notice: In this document we will call “Main Database“ to the database which contains the tables that you want to display on the calendar
- First unzip the Alpha Calendar’s Folder to the desired location
- The Alpha Calendar folder should contain the next folders:
- Alpha_Calendar: The actual application used to connect your alpha five applications with Flash Calendar Pro.
- Scheduling_app: Included tables for events, categories and locations that you can optionally use as your data source
IMPORTANT: If you have a registered full copy of Flash Calendar Professional’ you should go to your web project folder (under your webroot) and replace the files contained in the "Alpha_Calendar_WebFiles" folder with your full copy files.
1.1 Web Security Framework
(Skip this section if your security framework is deactivated)
For testing purposes, it’s recommended to first setup Alpha Calendar with Web Security Framework tuned off on the server
If the Web Security Framework is activated on the server you should follow these steps before you begin alpha calendar’s setup:
- Open your Main Database
- Go to Web Projects / A5w Pages
- Add all the A5W pages that are inside the *Alpha_Calendar Folder/Alpha_Calendar.WebProjects/Default.WebProyects folder by clicking the ‘add file’ option on the toolbar. IMPORTANT: Opening alpha calendar’s a5w pages on the Alpha Five WYSIWYNG editor will damage the contained JavaScript code permanently.
- Set the security for these pages to either ‘always allowed’ or ‘requires login’ depending on your needs by right clicking each a5w page and going to the ‘page security’ option.
- Go to 'security settings' (key icon on the web projects toolbar) then go to 'Page Security' / 'file types always allowed' and add the next file types to the list
- Go again to 'security settings' and re-publish all the security files.
*This is the directory where you placed the Alpha_Calendar folder.
2. Setup and testing
2.1 Running the setup
Open the Alpha Calendar Pro database located under the ‘alpha_calendar’ folder and follow the on-screen instructions or watch the video tutorials.
2.2 Notes about SQL connections and active tables
DO NOT use "named connections" when creating Active Link Tables for events, locations or categories. Use the "Ad hoc Connection String" option instead.
Using Time fields (Y) on a SQL table will cause errors when making an Active Link table, instead use Datetime fiels to represent time.
2.3 Transfering a setup from a test server to a production server when the production server does not have an Alpha Five Developmer License Installed.
If you need to run Alpha Calendar Pro in a server that does not have an copy of Alpha Five Developer installed you should follow the next steps to copy all the required files from your test machine to the production server (we will assume that the folder schema on the test machine is identical to that on the production server):
- In your test machine open alpha calendar and enter your License Key, a message will appear saying that the "License Key is incorrect" just ignore it.
- Do a "fast and simple" setup and test it to see if everything is working as needed
- Once the calendar is working correctly, go to "advanced complication" setup and enter your Production sever name and the port in which the production WAS is working ("80" for most cases)
- Re-Publish the files (you wont be able to test the calendar in your test machine any more, unless you change your setup again).
- Copy the next files to your production server webroot:
- The whole Alpha_Calendar Folder (see point 7)
- Copy the "DoNotDelete" file placed directly under your testing server a5webroot\ and place it directly on your Production server a5webroot\ (NOT your web project folder)
- Copy the whole "Alpha_Calendar_WebFiles" folder and all the files that start with "CL_" that are under that your web project folder e.g. "C:\\A5webroot\MyWebProject". Files:
- cl_calendar_50.a5w
- Alpha_Calendar_WebFiles folder
- If your main database is placed under eg. "C:\databases" in your test server then you main database needs to be placed in that same path on your production server ( eg. C:\databases on your production server)
- If Alpha_Calendar folder is placed under eg. "C:\databases" in your test server then you need to place Alpha_Calendar in that same path on your production server ( eg. "C:\databases" on your production server)
- Now Run Cl_test.a5w in your browser and the calendar should be working.
3. Using Alpha Calendar Pro
There are several ways to use alpha calendar pro within your application, we will explain the most common scenarios.
3.1 Events
3.1.1 Viewing events on the calendar
To view your events in the calendar you can display either of this a5w pages:
- cl_calendar_full.a5w (Full window)
- cl_calendar_75.a5w (75% of your window size)
- cl_calendar_50.a5w (50% of your window size)
Additionally you can include any of this pages on your own A5W page by using the xbasic function ‘A5W_Include()’ e.g. A5W_Include(“cl_calnedar_full.a5w”)
3.1.2 Adding/Editing events on the calendar
To add/edit events in the calendar you must create a grid that adds or edits records on the table you selected as your events source during the setup.
Additionally you can set the redirect "target page" on your grid to the page containing the calendar so when the user submits the grid they will be automatically redirected to the calendar page
3.2 Adding/Editing Locations and Categories
To add/edit Locations and Categories in the calendar you must create one grid for adding or editing locations and another grid for adding or editing catgories (the grids must add or edit the tables that you selected as your Locations or Categories source respectively during the setup).
3.3 Linking a specific event on the calendar to a grid for that event.
Suppose this:
URL to your Edit Event Grid a5w page: http://MyServer/MyWebProject/Edit_event.a5w
Event Id field name on your table: Event_id
- Go to your "Main Database" and open your events table in edit mode.
- Add a new field called "Link" (or your desired link name)
- Open the field rules and go to the "link" field
- Set the field as a calculated field
- write the next expression (remember our initial suppositions) "http://MyServer/MyWebProject/Edit_event.a5w?Event_id="+Event_id (no speces)
- go to your event edit grid
- In the Query(DBF) option go to "define arguments"
- Insert a new argument called event_id and set it to "get value from variable"
- set the variable field to Event_id
- Filter your grid by this expression Event_id=:Event_Id
- Open alpha Calendar Pro
- Go to setup
- In the event connection page (2nd page) select "Link" on the "URL" field, save and continue
- Publish the changes(last page of the setup)
- test it
- And there you have it
Additionally you can change the label of the "URL" field on the calendar to "edit event” (or your desired label name) in the "Customize your calendar" section on Alpha Calendar Pro
4. Troubleshooting
In the "Cl_Calendar_full.a5w" page I only get a blue frame, but where is the calendar?
- There should be at least 1 event on your events table scheduled between the date ranges you chose to display in the calendar, its recomended to add a test event scheduled for the current date.
- Make sure that the folder “Alpha_Calnedar_Webfiles” and all its files are located under the same folder as your web project (see 1. Installation) if not copy the folder and place it correctly.
- If your application is on the Internet go to the "advaced complication" setup and place your Domain name or IP adress in the "Server name" field (Do not use the computer name).
- Note: Each time you enter the "Fast and Simple" setup it will automatucally set the "server name" field to the computer name.
I get the next error (or a similar one):
"Script Error
Error:Script:CL_LOAD_EVENTS.A5W line:72
addin.run("Cl_Load_Events")
Read past end of file"
- Go to the "maintenance" section and click the "update indexes" button
I get the next error (or a similar one):
Script:OnInit line:8
tbl = table.open(tabla)
Error loading C:\AlphaFiveDB\AlphaCalendarPro_v1.0.8\Calendar_Tables\cl_locations_tbl.dbf
: The system cannot find the path specified.
C:\AlphaFiveDB\AlphaCalendarPro_v1.0.8\Calendar_Tables\cl_locations_tbl.dbf
- In the setup select the correct path to your tables (1st step of the setup)
- Setup your calendar before testing it (in the “setup your calendar” option)
- Publish Alpha Calendar files before testing (in the “test your calendar” option)
- Make sure that a file named “DoNotDelete” is placed under your webroot, if not try publishing again
I get the next error (or a similar one):
500 Internal Server Error
"Script Error
Error:Script:Cl_Load_Events line:151
No such field"
- One ore more fields that you mapped in the setup do not exist on the table you are connecting to.
- Go to the setup and make sure that all the fields on steps 2,3 and 4 (where you map fields for events, locations and categories) are ethier set to a one of the fields contained in the dropdown or set to "none" (yellow fields are requiered and can not be set to "none").
I get the next error (or a similar one):
500 Internal Server Error
"Script Error
Error:Script:Cl_Load_Events line:139
Argument is incorrect data type"
- In the setup when mapping fields in your tables to fields in the calendar make sure that you honor the field type mentioned between the “( )” e.g.
- Date_to(D): the "D" means that you have to choose a field with a Date type
- Title (C): The "C" means that you have to choose a field with a Character type
I get an error saying that the tables where encrypted using a different key
I get the next error (or a similar one), when trying to connect to an SQL Active Link Table:
Script:OnInit line:14
tbl = table.open(tabla)
Error loading C:\USMONSQL\cl_Patient.dbf : Unable to connect to backend database while opening local cache C:\DOCUME~1\ADMINI~1\LOCALS~1\Temp\$$45_DATA_cl_Patient.dbf for table cl_Patient.
Invalid syntax for connection string.
Must be formatted in one of the following ways:
name1 + chr(9) + value1 + crlf() + name2 + chr(9) + value2 + crlf() ... or
{name1='value1',name2='value2'...nameN='valueN'}
- DO NOT use "named connections" when creating Active Link Tables for events, locations or categories. Use the "Ad hoc Connection String" option instead.
- See part 2.2 on this documentation
I get errors trying to connect to a SQL active table
5. Version History
1.0.7
1.0.8
1.0.9
- If the field "Active" in Categories or Locations is set to "none" the default value will be set to "1" (active)
- Modifications to the License key registration code now supports more complex setups e.g. Licensing when the Alpha Calendar's setup is not being run on the server.
- Minor Bug Fixes
1.1.0
1.1.1
- This is the last version compatible with Flash Calendar Professional version 1.2 (Download)
- Session variables and page variables can now be used in the filter expression (the filter expression is set on the first page of the setup) e.g. "User="+quote(ssesion.user") .In this example the calendar will only display events for the logged user (there is no need for one calendars per user anymore).
- The labels of locations displayed in the calendar where auto-formatting to "first letter upper", this is now disabled and the labels will show as stored in your locations table.
- In some cases Gzip was interfering with the XML files by creating .xml.gzcache files preventing the calendar from updating correctly Alpha Calendar will now delete this files automaticaly.
- If you are using alpha Calendar version 1.1.1 for compatibility with Flash Calendar 1.3 go to this Link for documentation.
1.3.0 (21/OCT/2009)
- Partial Compatibility with Flash Calendar Professional version 1.3
- Do NOT download this version if you are using Flash Calendar Professional version 1.2.
- Events, Locations and Categories will all work correctly.
- Cutomized styles from the "Customize It" button are not yet compatible and will be ignored.
1.3.1 (22/OCT/2009)
- All Alpha Calendar Pro's features are now compatible with Flash Calendar Professional version 1.3
- Do NOT download this version if you are using Flash Calendar Professional version 1.2.
1.3.2 (23/OCT/2009)
- Version 1.3.1 was broken this is a fix of that version
- All Alpha Calendar Pro's features are now compatible with Flash Calendar Professional version 1.3
- Do NOT download this version if you are using Flash Calendar Professional version 1.2.
1.3.3 (26/OCT/2009)
- The error: "table is encrypted with a different key" that appeared when running the WAS from the main database was eliminated. (Download)
1.3.4 (02/NOV/2009)
- Greatly improved error handling messages
- The "Publish" and "Test" buttons on the setup where merged into a single "Publish and test" button
- The Alpha_Calendar_WebFiles folder will now be published automatically when pressing the "Publish and test" button
1.4.0 (03/NOV/2009)
- Alpha_Calendar_WebFiles folder was not being copied correctly, this has been fixed.
- New Feature: Auto Setup (Beta); easily setup your calendar to the default values by pressing a single button.
- (Downlaod)
1.4.1 (05/NOV/2009)
- The Filter expresion (Step 1 of the setup) now works for SQL tables too (Watch video)
- Auto Setup now works when the webroot is in a drive other than C:
- (Downlaod)
1.4.2 (09/DIC/2009)
- Flash Calendar Professional version was expiring even if a registered version was installed, now there is the option to set Flash Calendar's Version Key on the setup
- (Download)
6. Ask Us Live (Beta) :