| Electronic Manual - EasyData/SQL
© AtomicSoft - www.atomicsoft.com |
| Table of contents | |||||||||||||||||
Smart
tip: This handbook is also designed to be printed... set your
printer's page orientation to landscape format, so there is enough space
to place hand-written notes on the left and right margin easily.
|
| Installation and configuration | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Directory structure... | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
The software can be installed at any place that allows the execution of CGI software: Most server systems provides a special directory called "cgi-bin" where you have to install the application, while others are not limited to a particular location. On a common environment, we recommend to create a new sub-directory within the existing "cgi-bin" folder to separate the software from other already installed products. Required "template.en" directory: Inside the directory you desired for installation, please create a new sub-directory called "template.en". It's used to hold the content of "template.en" directory delivered with your software package. Adjust path to Perl: Open all program files (*.pl and *.cgi) in a text editor and change the first line "#!/usr/bin/perl" that it reflects the correct path to Perl 5 (or higher version) on your system. This is required to let your server know where the Perl interpreter is located. Usage note: On most systems, /usr/bin/perl is already the default path to Perl and so no modifications are required. Smart
tip: Our installation helper install.cgi
makes it easier... just call it from the command line or via your web browsing
software (change path to Perl within this script before) and it will modify
all program files at once.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| File transfer to the server... | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Upload all files to the created directories. If a ftp client is used, ensure to set the "ASCII transfer mode" for file submissions. Detailed file table:
Scheme:
[filename | suggested place to upload (short description); file permission]:
Important
notes: Please double-check file permissions and transfer mode,
otherwise the software may not work as intended. Depending upon the server
configuration, different file permissions than the ones stated above may
be necessary.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Modules installation... | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Installing module: Unix, regular method
Installing module: Unix, CPAN.pm Perl comes with a very handy module called CPAN.pm that automates the process of downloading and installing a Perl module. You can load the CPAN.pm shell with the following command:
perl -MCPAN -e shell This also requires that you are root. The first time that you run the CPAN shell, you will need to make some configurations. It's usually OK to select all the defaults.
To find a particular module, use the
cpan> i /DBI/ CPAN.pm will go out to the CPAN mirror that you selected, download the list of modules, and tell you which ones match the search word. To install a module, type:
cpan> install DBI CPAN.pm takes care of the whole process. It downloads the compressed file, unpacks it, builds it, and installs it all for you, unless there is a problem with the installation process. If there are other modules on which this module relies, it will also download and install those.
Installing module: Windows, PPM ActiveState Perl comes with a command-line tool called PPM - the Perl Package Manager - that simplifies the process of installing Perl modules on NT. To get into the PPM, go to a DOS prompt, and type
ppm You should now see a prompt that looks like:
PPM>
at which you can type commands. There are a large number of commands that
can be used, type
To search for a module, use the
search DBI The search should, by default, be case-insensitive, although you can configure this. This will return a list of all the modules that matched this search, and the file that the module is contained in. You can then install the module with the install command
install DBI PPM will take care of downloading and installing the module for you.
More information |
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Configuration... | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
After you have uploaded all files, you may wish to start the admin panel first time to initialize the system parameters. In order to do so, please call admin.cgi with your favorite web browsing software:
Before you proceed, it is highly recommended to set an administration password. After this is done, access to the admin panel is granted only by using "admin" as login together with the chosen password. Now click on the button "Edit system parameters" and configure the shown parameters according your needs. Usage note: Since all parameters are automatically filled with correct values, modifications on your side may not be required. Directories and files:
* Technical note: The software tries to create this directory at a web-accessible place (certain cgi-bin locations doesn't allow to deliver multimedia content). If you experience problems in content delivery, please move it manually to a suited location. Platform specific settings:
URLs:
Database setup:
Various parameters:
After you have verified all
settings carefully, click on the button "Save parameters" to take over
modifications to the system. It is also possible to bring back previous
values with the "Let the script restore defaults" button.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Database creation and maintenance | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Create a new database (table)... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
First of all, call the admin panel and go to the part "Create new table". Now just follow these steps:
After this is done, just click on the "Create new table" button in order to create the new database. By the way: You can add and remove system fields manually later at any time; so if you are unsure about an optional setting described above, just leave it empty and read more about below in this manual. * What exactly is a record owner ? Each record can have an assigned e-mail address as well as a password (optional). In this way, people are able to modify their owned records. Additionally, the mailing utility allows sending of e-mails to all registered record owners. Why is there an ID field in each table ? This field is required for some internal functions of EasyData (mainly used to distinguish records); so you can commonly ignore it. If you like, you may also rename its label, hide it when showing records or even make it editable by users. Technical
note: Since each record must have a unique ID field value, this
field is of autoincrement type by default.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Create table fields... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Choose the desired table and select "Restructure table". Alternatively click on "Restructure" in the upper right corner of the screen. If you just created a table, this screen appears automatically. Go to "New field name", type in the desired name and select the data type. In order to finish action, click on "Create new field". There are also various system
fields available, required for advanced features. Type in the field names
exactly as they appear in the following list to enable the concerned feature
(refer to following chapters for details):
After a field was created
successfully, the screen "Field properties" appears (see next part of this
chapter).
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Edit or remove existing fields... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Select the desired table and choose "Restructure table" from admin panel. Alternatively you can click on "Restructure" in the upper right corner of the screen. How to delete a field: Look for the field you wish to remove from the table and click on "Delete". However, please note that once a field is removed, all related content will get lost and cannot be recovered. By the way: All table parameters are automatically updated and the concerned field becomes removed from these settings. How to change sorting of fields: Look for the field you wish to move around and click on either "move up" or "move down" to change the field's position. Technical note: Sorting of fields takes effect only to various admin panel screens. Use "Table parameters and layout" settings to change the default field order for the web-frontend. How to edit a field: Look for the field you wish
to modify and click either on "Edit" or the field name. Now the screen
"Field properties" appears. Depending of the selected field, you can modify
these options:
Important
notes: If you edit a system field, some of the settings above
may be not available for selection. Don't touch pre-filled settings for
system fields; you may negatively affect their behavior.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Table indexes... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Index on a non-key table field(s) is called secondary index. Secondary indexes are not created automatically. Indexes on the relevant columns is the most important thing in getting queries on your database to run fast. Searching and sorting on an indexed field is performed much faster. This doesn't mean that you should index all fields. Please read the documentation on your SQL server software to find out more about indexes. Select the desired table and choose "Restructure table" from admin panel. Alternatively you can click on "Restructure" in the upper right corner of the screen. Use the "Edit secondary indexes" dialog form to create secondary index(es). You can remove secondary index using the same dialog form. How to create a new index:
Now click on the button "Create new index". How to delete an index: Select existing index and click on the button "Delete".
Usage
note: "Delete secondary index" option appears if you have at least one secondary index.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Category handling... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Usage note: Before you can use categories, ensure that the system field _category is available within your table. From admin panel, select the desired table and choose "Edit table categories". Alternatively you can click on "Categories" in the upper right corner of the screen. How to create a new category: Type in a category name and short description (optional; can be displayed when browsing by categories). Now click either on the button "Add new top-level category" to create a new main category or "Add new category inside current category" to add a sub-category within the currently selected category. How to edit a category: Click on the ID of the category
you wish to modify:
In order to take over the changes to the system, click on the button "Save". Helpful hint: Since categories are sorted alphabetically by their IDs (category codes), changing their displayed default order is very easy by altering the concerned category codes according your desired arrangement. How to delete a category: Select the ID of the category you wish to remove and then click on the appropriate deletion button to remove the concerned category from the table (please be careful when doing so; once deleted, categories cannot be recovered). Important note: Records related to removed categories are re-assigned to the concerned upper level category. Category trees - overview: EasyData comes with a feature allowing website developers to implement an interactive JavaScript-powered category tree to websites in just a few minutes. Ideally suited for easy database navigation on category-based tables. Each tree is built with graphical elements and can be individualized to allow highest flexibility. It is also based upon an own template (treeview.htm), so even surrounding HTML elements are possible. Category trees - website implementation: Call treeview.cgi
to display a table's tree:
Implementation by using SSI-tags: Example: <!--#include
virtual="/cgi-bin/ed/treeview.cgi?tbl=TABLE"-->
Technical note: Remove all HTML initializing tags from template treeview.htm (mainly <HTML> and <HEAD>) to avoid display errors caused when inserting the category tree codes into an existing webpage via SSI. Important note: In order to use category trees, at least the permission "Search" is required for anonymous users. Category trees - available settings: Choose the desired table and select "Restructure table". Alternatively click on "Restructure" in the upper right corner of the screen. If you just created a table, this screen appears automatically. Now click on the button "Edit treeview parameters". Layout options:
Drawing icons:
Folder/leaf icons:
Root category:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Moderated user actions... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
If this feature is active, administrator can approve (or decline) changes submitted by users (mainly additions, modifications or deletions of records). Enable moderated modifications by configuring the appropriate fields on the screen "Table parameters". Important note: It is strongly recommended to enable this feature, if you allow people adding their own records. Otherwise you have no control about the database content. Enable moderation mode: Check fields "Make additions
moderated" and/or "Make modifications moderated" during table creation
or go to "Change table parameters and layout" and modify "Permissions"
according your needs.
Usage note: For more details about permissions and user groups, please take a look at the next chapter. How to moderate actions: From admin panel (you must be logged in as admin), select the desired table and choose "Moderate table". Alternatively you can click on "Moderate" in the upper right corner of the screen. Now you see a list containing all queued requests. Each request can be approved or declined by selecting the concerned radio button. Select "Hold" and the concerned record will be still kept in moderation queue. After you moderated all requests, click on the button at the end of this screen to take over your decisions to the system. How to edit records in moderation queue: If you wish to modify records
that are currently in moderation queue, mark the button "Remind to update"
when approving the concerned records. Now the moderation result screen
allows you to edit them right away (new browser window opens).
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Table maintenance... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Select the desired table and choose "Restructure table" from admin panel. Alternatively you can click on "Restructure" in the upper right corner of the screen. How to remove a table (be very careful): Go to "Delete table" and then click on "Delete files". You can either remove parts of this table or the entire database structure. How to clear selected table files (be very careful): Go to "Empty table", select the appropriate files you wish to clear and then click on "Clear data" to carry out this action. How to rename a table: Go to "Rename table" and
specify the new name. Click on "Rename" to take over the changes to the
system.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| View, add, clone, update and delete records... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Go to the admin panel, select the desired table and go to "View/Add/Update/Delete records". On the following screen, you may browse through all categories, search for records, add new ones, remove, update or clone existing records and do all other database administration tasks (see menu on the upper right corner of the screen). Technical note 1: When updating records (admin only), all fields are shown regardless of the "Visible fields" settings at the "Table parameters" screen for convenience reasons (however other screens in admin panel considers these preferences). Technical
note 2: Cloning a record means to take over all field values
from an existing record to a new one showing the "Update record" screen.
It is not possible to clone fields of type "image", "binary", "memo", "htmlmemo"
and "uploadmemo".
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Search requests statistics... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
The search requests statistics shows how people are using your database regarding search queries. All search queries are logged and then presented in a comprehensive graphical report searchable by date/time and sorted by usage frequency. You can use these statistics for various marketing and performance analysis (e.g. most popular search queries, behavior of the users when doing search operations) or just for your personal interest. How to enable search requests logging ? Go to the screen "Table layout
parameters", "Search requests logging":
Sending of statistics
via e-mail: See also "Table layout parameters" screen, but now part
"Table automatic maintenance":
How to access the statistics ? Click on "Search stats" available in the upper left corner of the screen to access the statistics of the currently active table. Search requests statistics
form:
Smart tip 1: The generated reports can be printed easily: Depending upon the used paper size, you may need to set the printer's page orientation to landscape format. In this case, there is also space for placing hand-written notes at the margins. Smart
tip 2: Since EasyData doesn't use image files to create bar
graphs, you can simply copy the report to a disk and carry it to other
computers, still keeping the layout (reports are generated in HTML language).
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Advanced features in detail | ||||||||||||||||||||||||||||||||||||||||||
| User managed record modifications (record owner)... | ||||||||||||||||||||||||||||||||||||||||||
|
How to enable managed records: As mentioned in the previous chapter, users can be assigned to records they added to a table. By using this feature, record owners are able to modify or delete their owned records online and even prolong the life of them (if expiration feature is active). In order to enable managed records, just ensure that you have the system field _email (e-mail address) within your table. Higher security will be achieved by adding another system field called _pwd, which contains a user determinable password. Registered users are required to log in by using the login screen of EasyData providing their e-mail address and password. Usage note: Alternatively to _email, also the field _login can be used. While _email needs to contain an e-mail address, the _login field may hold any content (e.g. alphanumerical values). If both fields are available, _login has a higher priority. Configure the password reminder utility: If a record owner forgot
the password, it can be re-send automatically by the system at request.
In order to configure this utility, please go to the "Table parameters"
screen:
Important note: Since the admin password is saved encrypted for higher security, it cannot be restored. See chapter "Helpful hints and technical reference" about information on how to reset the admin password. Technical
note: For this feature, the system field _email
is required.
|
||||||||||||||||||||||||||||||||||||||||||
| Set user permissions and limitations... | ||||||||||||||||||||||||||||||||||||||||||
|
Available types of users: Anonymous users are
not logged in and just work with the system (e.g. searching or browsing
a database).
Set permissions for anonymous
users:
Set permissions for registered
users (record owners):
Set permissions for (registered
users') owned records:
Enable moderation for
record comments:
Enable "flood" prevention
(anonymous and registered users):
|
||||||||||||||||||||||||||||||||||||||||||
| Voting and comments... | ||||||||||||||||||||||||||||||||||||||||||
|
How to enable voting and/or comments for a table: Add system field _rating
to the table to allow user ratings. Optionally add system field
_votes
to count number of ratings.
Helpful hint: During table creation, mark "Include user feedback fields" to allow rating as well as comments; so you don't have to add the system fields above manually. Voting and comments settings: Select the desired table
and choose "Change table parameters and layout" from admin panel. Go to
the part "Voting and comment parameters".
Technical note: Admin can remove unwanted comments by editing the field _comments_data of the concerned record. Helpful hint: It is also possible to make comments moderated. Please refer to "Set user permissions and limitations" above. Voting and comments web-frontend: Please refer to the chapter "Web-frontend and template management" for more details. Technical
note: The default maximum size for _rating
field is five characters. Since it is in float data type, digits are chopped
off if field size exceeds the maximum size (however admin can adjust field
properties).
|
||||||||||||||||||||||||||||||||||||||||||
| Record time management... | ||||||||||||||||||||||||||||||||||||||||||
|
General information: EasyData provides the ability to schedule the appearance and disappearance of records. In case of removements, notification messages may be sent before and records are able to be prolonged by their concerned owners. There are several ways to set appearance dates, expiration dates and periods (e.g. based upon record creation date or last record update, for the entire table or unique for each record). Pre-requisites for automatic record appearance and expiration: 1. Maintenance interval: Ensure that a maintenance interval is specified. See screen "Table parameters", "Table automatic maintenance". Recommended range: 3.600 to 43.200 seconds (1 to 12 hours). 2. Record owner: If you wish to allow record owners to prolong the life of their assigned record(s), the system fields _email (alternatively _login) and _pwd are required (password field is optional). Appearance... table-wide appearance date (valid for all new records): Add system field _effective_since and type in the following string as "Default value" setting at "Field properties" screen:
<x>: Number of days counted from record creation till appearance. Usage note: This string is a special command, only valid for the above particular application. Technical note: Until appearance date, the record exists but is not allowed being shown when searching or browsing the table. While for the admin such records are always visible, registered users can update them only by using a direct link. Appearance... individual appearance date for each unique record - absolute date: Add the system field _effective_since which contains the date of first desired appearance (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS). It must be filled during record addition; leave field empty to make the record available immediately. Appearance... individual appearance date for each unique record - relative date: Same procedure as done for a table-wide appearance date, but don't set a default value for _effective_since, just use "Appears in <x> days" individually for each created record. Expiration... table-wide expiration date (valid for all records): Ensure that either the system
field _add_datetime
or _update_datetime
is present for the concerned table - based upon these date/time stamps,
the expiration dates are calculated:
Helpful hint: _update_datetime should be used, if you wish to allow record owners to prolong life of their records. At "Table automatic maintenance"
(see "Table parameters" screen), you'll find the record expiration settings:
If you activated the setting
"Allow record life be prolonged", notification mails are sent out to record
owners with instructions on how to prolong the life of concerned record:
If you wish to notify the
record owner as soon as a record is removed, fill out also these settings:
Expiration... individual expiration of each unique record - absolute date: Add the system field _expires which contains the date of expiration (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS). This field must be filled during record addition; leave it empty to disable expiration for a particular record. Important note: Setting an expiration time (see above) is required also here to determine a maximum applicable time frame; you may wish to set the expiration time parameter to a high value, like 3.650 days (about ten years). Helpful hint: If you allow record owners to prolong the life of their assigned records, ensure that the system field _expires is accessible for updates (see "Table parameters", "Record update mode - visible fields"). Expiration... individual expiration of each unique record - relative date: Alternatively to the date input described before, simply type in this as "Default value" setting for the field _expires:
<x>: Number of days counted from record creation till expiration. Usage note: This string is a special command, only valid for the above particular application. Expiration... combination of table wide and individual expiration dates: If _expires
and one date/time stamp as well as an expiration time exists, then the
expiration date in _expires
applies.
Expiration... Templates (warning / notification mails): Please refer to the chapter
"Web-frontend and template management" for more details.
|
||||||||||||||||||||||||||||||||||||||||||
| Images / Binaries / Memos... | ||||||||||||||||||||||||||||||||||||||||||
|
You can have multiple image fields as well as binary fields and memos in each table. Just create a table field and set its data type to "image", "binary" or a memo one. Depending on your selection, the concerned field has a specific behavior:
By using the parameter "Max. size" at "Field properties", you can specify the maximum file size in bytes allowed for uploads. Setting a file size limitation is strongly recommended, if you want to enable public record additions or modifications. Important
note: It is not possible to perform search operations upon these
fields' content.
|
||||||||||||||||||||||||||||||||||||||||||
| Temporarily blocking of records... | ||||||||||||||||||||||||||||||||||||||||||
|
An existing record can be blocked, which means that it cannot be found during table browsing or search operations. In order to enable this feature, you must have the system field _blocked in your table. How to block a record: Search for the concerned record to block, click on "Update" (can be found in the upper right corner of the screen) and then just check the appropriate button (edit control of the field _blocked). How to unblock a record: Search for the concerned
record to unblock, click on "Update" (can be found in the upper right corner
of the screen) and then just uncheck the appropriate button (edit control
of the field _blocked).
|
||||||||||||||||||||||||||||||||||||||||||
| Send out mailings... | ||||||||||||||||||||||||||||||||||||||||||
|
In order to create a mailing, select the desired table and choose "Send out mailings" from admin panel. Alternatively you can click on "Mailings" in the upper right corner of the screen. You can send out mailings either to all record owners of a selected table (recipients filter set to "Send to all") or just mail such people who have allowed you to do so (recipients filter set to "Send to subscribed users only"). Mark "Do not send duplicate e-mails" in order to send only one single mail, even a particular address is found multiple times. Custom recipients filter: You can specify a search query that filters only recipients matching particular criteria. It is possible to use any field available in the table this mailing is intended for. Click on "view filter results" to get a listing of all selected records. For example: income>=3000
AND education="high"
Usage note: For more details about how to perform search operations, please refer to "Searching of databases (tables)" below. Personalized mailings: Personalized mailings contain
an individual "To:" field for each recipient. In addition, you can include
fields from the concerned table (format: <!--$FIELDNAME-->)
which are replaced by appropriate content.
Sample personalized mailing:
Technical note: If "Do not send duplicate e-mails" is marked, a recipient with multiple records receives mail for the first found record only (and so will just see content of table fields for this specific record). Quick mailings: Quick mailings are used to
send identical messages to all recipients (faster processing). However
the usage of personalized elements is not possible (included table tags
are removed automatically).
Intelligent mail content delivery: The most powerful feature is the delivery of intelligent message parts based on a record's content and "if/then/else" conditions. So a mailing can be written absolutely targeted, which leads to higher response rates and increased user convenience. Important note: This works only with "Personalized" mailing method. "Quick" mailings will ignore intelligent message parts. Each "intelligent message
part" has the following structure:
Usage notes: "if" and "endif" tags are required, while the "else" part is optional. Recurrent tags are not allowed. <expression> can contain
these operators:
Format of field values: $fieldname (field names are handled case-sensitive). Sample applications:
Usage notes: Second sample does not have an "else" tag, which means that a false result will lead into not displaying anything. Should a field value be unavailable (spelling error, non-existing field), then the argument is considered as being empty. Technical note: It is also possible to use HTML and client-sided scripts (like JavaScript) within intelligent message parts. How to perform a test of personalized and intelligent mailings: In order to let the system process a sample message, click on the button "Send test message to admin". The system then generates a mailing, which is sent to the administrator under real life conditions. And these default values
are used: Numerical = 0; date/time related fields = actual date/time; URLs
= http://test.<fieldname>/; e-mail addresses = test@<fieldname>.test;
fields in general = test-<fieldname>.
|
||||||||||||||||||||||||||||||||||||||||||
| Searching of databases (tables)... | ||||||||||||||||||||||||||||||||||||||||||
|
Supported search operators:
Usage note: All search types can be combined together for powerful complex search operations. Create advanced search forms for online usage: Please refer to the chapter
"Web-frontend and template management" for more details. Please also take
a look at this chapter to find out how to search multiple tables at a time.
|
||||||||||||||||||||||||||||||||||||||||||
| Re-randomization... | ||||||||||||||||||||||||||||||||||||||||||
|
What exactly is re-randomization ? When browsing categories or viewing search results, all shown records are presented in a given order. However in some cases, you may wish to achieve a random order (e.g. to provide a fair rotation of records). The re-randomization feature allows to fill one or more table fields with random numerical values; these fields can be used for sorting records by chance. Each table maintenance, the field values are refreshed and so also records are sorted differently. Pre-requisites for re-randomization feature: Maintenance interval: Ensure that a maintenance interval is specified. Please see screen "Table parameters", "Table automatic maintenance". Recommended range: 3.600 to 43.200 seconds (1 to 12 hours). Create a "randomizable"
field:
|
||||||||||||||||||||||||||||||||||||||||||
| Sorting by record popularity... | ||||||||||||||||||||||||||||||||||||||||||
|
What is meant with "popularity" ? Popularity refers to the number of times, a particular record is shown in detailed entry view mode. How to count the popularity of records ? Add the system field _views_number to your table. Its numerical content is automatically handled by EasyData and becomes increased by 1 each time a record is shown detailed (as higher the value, as more popular the record). How to sort search results by popularity ? When wishing to sort records by popularity, just ensure that _views_number is added to all "Sort records" parameters at the "Table parameters" screen. Usage
note: You can also show the field's content (e.g. color it with
"Display mask" parameter when it exceeds a given number to attract users)
or embed it into search forms - there are many more types of usage than
just sorting.
|
||||||||||||||||||||||||||||||||||||||||||
| Bookmarking records... | ||||||||||||||||||||||||||||||||||||||||||
|
What exactly is record bookmarking ? Each time a user browses through a table, it is possible to bookmark records (a cookie is set on user's computer containing the table name and record ID) for finding them later again easily. It is possible to bookmark as many records as desired. How to enable record bookmarking ? You just need to add the system field _addbookmark to the concerned table. This will lead that the necessary links and screen elements are created automatically allowing records being bookmarked, bookmarked ones viewed and unbookmarked. Each bookmark will kept stored for seven days to allow later visits without losing already found information. View set bookmarks: Click on "Bookmarks" available in the upper left corner of the screen to see a list with all bookmarked records of the actual table. In order to remove a bookmark, uncheck "Keep bookmark" of the concerned record and click on "Refresh bookmarks". Usage
notes: Records are shown as specified for table browsing mode
(as first column, a "Keep bookmark" button is shown). All bookmarks are
alive for about seven days before they will be removed automatically.
|
||||||||||||||||||||||||||||||||||||||||||
| Sending records via e-mail... | ||||||||||||||||||||||||||||||||||||||||||
|
EasyData provides the ability to send records via e-mail. This allows users to forward records very convenient to other people (or putting them into their own mailboxes, of course). How to enable sending of records via e-mail: Please select the desired
table and choose "Change table parameters and layout" from admin panel.
Go to the part "'Send records by e-mail' feature".
Technical
notes: Any applying field formatting (defined in display masks)
is ignored (plain text message is sent). Binary, memo and image typed fields
are shown as links to their respective files.
|
||||||||||||||||||||||||||||||||||||||||||
| Automatic backup generation... | ||||||||||||||||||||||||||||||||||||||||||
|
What exactly is backup generation ? EasyData is able to generate backups of its data files automatically to allow restoring them later. Generated backup files (extension .bak?) are located within the "data" directory. Pre-requisites for generating backups: Maintenance interval: Ensure that a maintenance interval is specified. Please see screen "Table parameters", "Table automatic maintenance". Recommended range: 3.600 to 43.200 seconds (1 to 12 hours). Important note: The backup update period must be longer than the specified maintenance interval. Enable / disable backup generation: Select the desired table and choose "Change table parameters and layout" from admin panel. Alternatively you can click on "Restructure" in the upper right corner of the screen and then click on "Edit table parameters". Go to the part "Table automatic
maintenance" to find the appropriate settings:
Technical notes: In order to disable the backup feature, set "Number of backup files" to 0 or leave it empty. New backups are not generated for unchanged files (since backup already exists). Recommended backup settings: Maintenance interval = 3.600;
number of backup files = 4; backup file #1 update period = 6
<TABLENAME>.bak1
holds 0 to 6 hours old database content.
<TABLENAME>: Name of the table, concerned backup file belongs to. Retrieve data from backup: If your SQL server crashed or your data was damaged, you may restore a corrupted data from EasyData backup file. Import latest error-free backup copy into SQL table (data import/export described in the "Database import and export tools" chapter). Format of backup file is "Tab-delimited text file, without field names". Please ensure first, that the chosen backup contains really the information you wish to bring back. Helpful
hint: It is recommended to store backups also on tapes or other
storage devices (ask your system admin for details); in case of a physical
server damage, you are able to recover the backups in this way.
|
||||||||||||||||||||||||||||||||||||||||||
| Database import and export tools... | ||||||||||||||||||||||||||||||||||||||||||
|
In order to import or export data, click on the button "Import / export data" available on the main admin menu. Import data into database: Click at the button "Start
data import..." to begin reading in an existing 3rd-party database.
Click on the button "Import data" to start the importing process. After it is finished successfully, please check the read in data for consistency first. Before importing data into existing table, it is also recommended to export data from original SQL table to have a backup copy. Technical note: Data formats "... with field names" requires that the first line of the importable file holds the names of the fields. Alternatively, default names are chosen you can rename later at any time. Importing already uploaded source files: This feature is useful especially when trying to import huge databases, because the file size allowed to read in through the admin panel may be limited by your server or webbrowsing software... Just place the source file into the directory data/import.tmp. Now go to the admin panel, click on "Import / export data" and select the concerned file from the list (see parameter "Determine data file being uploaded"). Export data from database: Select the appropriate source
table and click on "Continue..." to go to the next screen.
Now click on "Export data" to start the exporting process. A "save file" dialog is shown by your web browsing software to store the exported data file on your computer. Advantages of the "EasyData exchange format": The "EasyData exchange format" is a tab-delimited text-based format also storing binary field content, like images or software files together with the textual data (URL-encoded). Where possible, this format should be used for data import and export tasks to ensure best results when handling non-textual contents (all other supported formats cannot handle binary fields). Technical note: If you are a programmer interested in implementing our exchange format into your own applications, please let us know. We are able to provide you with additional information upon request. Helpful hint: Should you wish to manually back up an entire database or to carry an existing one over to an other EasyData installation, you may decide to create a "table package" as described more closer in the following. Table packages - overview: A table package contains an entire database (the table and all related elements) in one single file (TABLENAME.ede). So table packages are ideally suited for carrying an entire database to an other server or for generating manual backups. Download table package:
Now click on "Download table" to save the table package. A "save file" dialog is shown by your web browsing software. Upload table package:
Now click on "Upload table" to copy the table package to the server. Technical note 1: Should there already exist a table with equal name, EasyData chooses a new name for the uploaded table (may be changed later at "Restructure table" screen). Technical
note 2: The choices "Use internal GZIP compression" respectively
"Use internal GZIP decompression" for table package down- and uploads are
only available, if there is the Perl module "Compress::Zlib" installed.
|
||||||||||||||||||||||||||||||||||||||||||
| Web-frontend and template management | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
With EasyData it's a matter of just minutes to create new databases and bring them online. We provide the following three ways to access data online and to work with the powerful web-frontend: Important note: Ensure that you are logged out as admin, otherwise you may see a slightly different web-frontend. 1. Pre-defined web-frontend (default template scheme): This is the easiest way,
because you just need to add the following URLs as links to your website
to allow people working with your tables (depending upon the set configuration).
It's a matter of course, that the default template scheme can be customized (color and font schemes) according your needs achieving a similar layout as the one of your business website... Go to the admin menu, click on the button "Edit templates" and search for "main template" labelled entries. These contains various layout settings taking effect to all sub-templates connected with the concerned main template. 2. Full set of freely configurable templates: Beside of just customizing color and font schemes with style sheet commands, you can create your own set of templates or re-write the standard ones (they are a good basis for your own templates). Each template is written in HTML and contains special tags which will be replaced by appropriate content. There's nothing you cannot customize, however you should have a familiar understanding of EasyData and HTML programming. 3. Integration of EasyData with HTML based forms: Another method is to write
own webpages and use HTML based forms to call EasyData. Available for selected
actions like searching databases and adding new records. They can be also
used in combination with templates.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Adjust table parameters... | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Choose the desired table and select "Change table parameters and layout" from main admin menu. Table layout parameters:
* These are required (and important) fields; double-check them for containing correct values. Search layout parameters:
* These are required (and important) fields; double-check them for correct values. Categories list layout:
Behavior:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||