DySE::Calendars Script : Documentation

  

Home > DySE::Calendars > Documentation

  

Updated: 29-Mar-2008

DySE::Calendars Script Documentation

Browse DySE::Calendars Script Documentation
 

Introduction

The DySE::Calendars script (make.pl) is a Perl script program that works in conjunction with the generic DySE™ viewer script (view.pl) to display products offered by Calendars.com. The DySE::Calendars script and the DySE™ viewer script run on your web server.

When you run the DySE::Calendars script (make.pl), it downloads and processes the product datafeed file from Calendars.com and creates a products database file. When a user visits your website, the DySE™ viewer script (view.pl) is run and it displays product pages, category pages, or the home page.

A live example website that uses DySE::Calendars is Great-Calendars.com

Installation

  1. Affiliate of Calendars.com:

    To use DySE::Calendars, you must be an affiliate of Calendars.com at Performics.com or at CJ.com.

    If you are already an affiliate then skip down to Step 2 "Datafeed" below. Otherwise, sign up with Calendars.com at one of these affiliate networks (if you have no preference, we recommend Performics.com):

  2. Datafeed:

    You must manually obtain the Calendars.com datafeed. Unlike other DySE scripts, the DySE::Calendars script will not automatically download the datafeed for you.

    Note: If you are signed up with Calednars.com at Performics.com (or plan to be) then you must obtain the datafeed file from Performics.com. Otherwise, if you are signed up with Calendars.com at CJ.com (or plan to be) then you must obtain the datafeed file from CJ.com. The two datafeeds contain different affiliate links; therefore, you must use the corresponding datafeed.

    Note: DySE::Calendars auto-detects whether you are using the datafeed file from Perofrmics.com or from CJ.com. And it also auto-detects whether the file is CSV, tab-delimited, or bar-delimited. XML format is not supported.

    Obtain the Calendars.com datafeed:

    • Performics.com:
      Performics.com does not charge for datafeeds. Click here for details on how to contact Performics.com and ask to receive the Calendars.com datafeed. The datafeed can be sent to an email or FTP account set-up by you. For the format, we recommend that you select "uncompressed text (.txt)" since DySE::Calendars.com expects the datafeed file to be named datafeed.txt (an uncompressed text file). Note: You will need the datafeed file before you can request a key file.

    • CJ.com:
      Contact CJ.com and ask for a "Product Catalog (Data Feed)" subscription to be set up for your CJ.com account. See CJ.com's "Scheduled Data Transfer Guide". We recommend:

      • Client FTP (so the datafeed is uploaded to your server).
      • Comma-delimeted (CSV) format

    Note: It is up to you to unzip/gunzip the datafeed file received from Performics.com/CJ.com and to rename the uncompressed datafeed to datafeed.txt. DySE::Calendars does not work with compressed files.

    When you install DySE::Calendars, you will end up with directory cgi-bin/dyse/calendars/ in which you will need to create a directory called data that is to contain the datafeed file datafeed.txt

  3. Yearly License:

    Without a DySE::Calendars key file, DySE::Calendars runs in demo mode. If you want to try out DySE::Calendars in demo mode, then skip down to step 5 "Configuration" below. Then later on, you can purchase a license and obtain a key.

    To request a DySE::Calendars key file, you must have a currently valid yearly license. To purhcase a new license or a renewal license, click here.

  4. Key file:

    To request a DySE::Calendars key file, click here.

    After we have processed your key request, we will email your DySE::Calendars key file to you.

    In the mean time, you can continue with the installation so you can do customization and experiment with DySE::Calendars. Then later on when you receive your key you can install your key.

  5. Configuration: (optional)

    Depending upon what day of the year you run the DySE::Calendars make.pl, calendars can be included from: the current year and/or the next year. Note: Previous year calendars are never included (e.g.: After 31-Dec-2007, the 2007 calendars are not included).

    The default configuration is:

    • Current year calendars are included if tody is August 31st or earlier (i.e.: the 8th month or before).
    • Next year calendars are included if today is July 1st or later (i.e.: the 7th month or after).

    If you want to change when the current year calendars and/or the next year calendars are included, then you should read the "Configuration" section below after you have completed the installation.

  6. Installation:

    For detailed instructions on how to install and use DySE::Calendars make.pl and the DySE™ view.pl, click here.

Configuration (optional)

Ths section is optional. You only need to read it if you want to change when the current year calendars and/or the next year calendars are included.

Do the following steps to change when the current year calendars and/or the next year calendars are included:

  1. Create a text file called make-ini.txt that contains the following configuration variable setting:

    data.year.current  8
    data.year.next  7

    The data.year.current specifies the maximum month to include current year calendars. Current year calendars are included if this month or less. The special value "0" (the number zero) means do not include current year calendars. For example, 8 (the number eight) means include current year calendars if today is August 31st or earlier (the 8th month or earlier).

    The data.year.next specifies the minimum month to include next year calendars. Next year calendars are included if this month or greater. The special "0" (the number zero) means do not include next year calendars. For example, 7 means include next year calendars if today is July 1st or after (the 7th month or after).

  2. Upload make-ini.txt to the same directory where make.pl is located.

  3. Delete the *.db files in the /cgi-bin/dyse/calendars/data/ directory.

  4. Run make.pl as you normally would.

Sample Template Sets

The following are live examples of the sample template sets that are included with the DySE::Calendars script.


Great-Calendars.com
(templates "set1")

  


Great-Calendars.com
(templates "set2")


Great-Calendars.com
(templates "set3")

  


Great-Calendars.com
(templates "set4")


Great-Calendars.com
(templates "set5")

  


Great-Calendars.com
(templates "set6")

http://www.c3scripts.com/calendars/