TeleFlowRelay

TeleFlowRelay

From TeleFlow

Jump to: navigation, search

Contents

Overview

TeleFlowRelay is an open source website environment which can be used to deploy an solution which incorporates client and user management as well as application deployment.

With TeleFlowRelay (TFR), websites can be provided which allows users to create their own client databases, and then invite other users to join. Each client then has its own separate database which is selected when users for that client log in.

TFR was written to provide a means for TeleFlow Applications to be deployed and managed within an organisation or in a hosted environment. The environment includes provisions and examples for AJAX development as well as functions that enable social networking and integration with related environments such as twitter and facebook.

TeleFlowRelay can be used for anything from a simple web service right up to a comprehensive, multi client, integrated communications environment

Although this solution has become very encompassing of functions needed to support multiple clients in a secure environment, it is essentially a continuation of the TeleFlow product to draw it closer to websites. We selected "PHP Login System" by jpmaster77 to aid with the user login environment, and have extended it since. The database environment provided by PHP Login System was incorporated into TeleFlowRelay's, and then TeleFlow applications were made available to create a web and voice deployment environment.

  • This framework is designed as a programmer's aid to handle user sign up and site admin
  • It is not intended as a CMS, but more as a means to deploy applications by
  • Its initial code was based on jpmaster77's PHP login system:

http://evolt.org/PHP-Login-System-with-Admin-Features

  • We have rewritten, updated and added many additional functions
  • PHP, CSS, JS and jQuery are combined in the readily modifiable templates
  • Twitter, social media, and media management code has also been added
  • We have included an AJAX with jQuery tutorial
  • Please use this product for your application under GPL3 or MIT licenses
  • Improvements are greatly appreciated, as there are still rough patches
  • Forum support for users of PHP-Login and TFR can be found here:

http://teleflow.org/phpbb/viewforum.php?f=25


Features

The TeleFlowRelay web and database environment provides the following features:

  • Client Sign Up with User Invite
  • Standard (optional) email invite and authentication process
  • Separate client databases for each client (with encrypted authentication)
  • Operates on Apache/IIS with MySQL/SQLServer
  • Simple installation system
  • Quick set up for jQuery and several interface components
  • Separate language file for changing text globaly and supporting additional languages
  • Template approach to programming ensures developers arent hindered
  • AJAX components for modern interface development
  • UTC time management provides ability to support clients in more than one time zone
  • Provides templates and guidelines for developing voice and web applications using PHP
  • Easily re-brandable by updating CSS and graphics in "LocalSettings_*" files
  • Integrated logging system
  • Optional IP locking system for highly secure environments
  • Auto logout for idle users or extended sessions
  • Tracking of resource usage with built in billing reports
  • jQuery used increasingly within custom applications (code examples available)
  • Support for managing and playing MP3 recordings etc
  • Optional and programmable menuing system
  • Telephone applications ready to deploy
  • Credit card purchasing portal and processing application (using PayPal)
  • Twitter (and soon facebook) interface
  • Media Manager solution for distribution of media files to multiple systems
  • Simple affiliate application
  • User to user conversations system

Installation

  • Ensure you have your web environment deployed and PHP is running with MySQL. We have had great success with XAMPP for both Linux and Windows. For hints and tips on installation, refer to TeleFlowRelay Web Services Installation
  • Unzip the framework into your web home directory

Note: It is important to start with a home directory, or much of the javascript will not work correctly. If you choose to install to another directory, this can be easily rectified at a later time by changing basic settings.

  • Ensure PEAR for PHP is installed. This is needed for its encryption class for security. If you do not have it installed, we have included it as a zip file in the TeleFlowRelay download. Unzip it so that this file is found:
eg: WINDOWS: C:\xampp\php\PEAR\Crypt\Blowfish.php

or

eg: LINUX: /opt/lampp/lib/php/Crypt/Blowfish.php
  • For now, we have coded "root" and blank password in the LocalSettings_Database.php file. If you have created a specific user, change the details here before moving to the next step.
  • Follow the step by step instructions. To start the whole process over, simply drop the TeleFlowRelay (TFRelay_*) databases from your database server.


Security Provisions

Multi-client database security is a primary aspect of this environment. For detailed information on this subject, please refer to TeleFlowRelay Security


Technical Descriptions

The following section provides information on management functionality or additional solutions found in the web foundation.

Media Management Environment

TeleFlowRelay includes a content creation management environment. This system will manage any recordings provided by users of a TeleFlowRelay system. Recordings may include, but are not limited to: dictations, voice messages, TwitYax, and call recordings. Essentially, the notion is that any time spent by a user to record a message is evaluated by the time the user spent recording the call by the value of each time unit. Accordingly, all recordings can be managed, forwarded, stored, and possibly value added by transcriptions and crowd sourcing, by having the Media Management Environment process the recording. For commercial related ventures and for statistical purposes, by virtue that all media is handled using the same mechanism, billing and reports can readily be generated using standard routines.

Directory Structure

For the directory structure and file layout for TeleFlowRelay installations, reference TeleFlowRelay Structure

Database Dictionary

TeleFlowRelay has a comprehensive database to managing clients their users, and media that they create. With this database environment, you should be able to add your applications into the solution. If you are would like to see additional standard databases provided by TFR, please provide us with the create scripts and database description, and assuming there is general need for it, we will add it to the installation environment. If the table is non-general in nature additional downloads for TFR will soon become available.

For the TFR Database Dictionary, refer to the following PDF documents:


Tutorials

The TeleFlowRelay web foundation also includes a tutorial for AJAX. More tutorial applications will occur as later releases become available for social networking.

The "Bar Code Tutorial" is a portion of an actual website that is used to sell UPC bar code licenses worldwide. It is an ideal starting point because it does not involve database, and shows how working with a class to generate graphics on the server side can affect change on the client end.

For detailed information on how to program AJAX applications, see: TeleFlowRelay AJAX Tutorial

Retrieved from "http://teleflow.org/wiki/index.php5?title=TeleFlowRelay"