TeleFlowRelay Structure

From TeleFlow

Contents 1 TeleFlowRelay Directory Structure 1.1 Root Level 1.2 Application Level 1.3 TeleFlowRelay PHP and Web components 1.4 TeleFlowRelay Transfer System 1.5 Website Specific 1.6 XML Standard Files 1.7 Graphics 1.8 Standard Includes 1.9 Standard Email System 1.10 Other Components

TeleFlowRelay Directory Structure

The TeleFlowRelay (TFR) directory structure should be identical on every TFR computer (TeleFlow Server or Web Server) it is installed on, if you are providing many installations. If you are installing a single server, then naming is entirely at your discretion. The notion is to ensure that the folders are going to be referenced in documentation and programming using standard naming. Although the web servers and TeleFlow servers may or may not run the same code, at all times, the code shall be identical on both types of systems. This will ensure that only one install and update mechanism is required for all types of applications.

In addition, where media files are created using TeleFlow (Wav files), they will be transferred to the identical location on other web and TeleFlow servers. This will also make it easy to understand how files move through the system, even if they start out as Wav files, and end up being transferred to the final destination (eg: Web Server) as an Mp3 file.

Root Level

For the purposes of documentation and general procedure, all installations should fall in the named folder of:

• C:\TeleFlowRelay

All web callable files will be located in the "localhost" (see DocumentRoot in httpd.conf), directed file of:

• C:\TeleFlowRelay\www

This may not be possible for hosted web servers, and if that is the case, you will need to amend your installation to account for the different location. In these instances, refer to the LocalSettings_*.php files which would normally be located in:

• C:\TeleFlowRelay

Also set outside the reach of web applications is the library directory:

• C:\TeleFlowRelay\library

Application Level

All files are to be placed in their logical locations based on whether the file is "system" required, or created by "client" applications. The latter would include TeleFlow application files, the Wav files that they in turn create.

Top-level applications are created here:

• C:\TeleFlowRelay

NOTE: Top-level applications are grouped in directories with a leading underscore in the name. EG. _CallTransfer. All top-level applications are those that make up the TeleFlow Relay foundation. While any other applications will be part of a product or will be custom client applications, these foundation applications are the launching point or managers for all other applications.

NOTE: This section also includes TeleFlow telephony applications which may be considered superfluous information to installations that are strictly web.

TeleFlow applications are to be created here:

• C:\TeleFlowRelay\ClientApps
• C:\TeleFlowRelay\DemoApps
• C:\TeleFlowRelay\LiveApps
• C:\TeleFlowRelay\TestApps

These locations are general in nature, but assume that the system owner will be responsible for DemoApps, LiveApps and TestApps, whereas if the owner opens the environment up for general client access, those apps would be published in ClientApps. LiveApps would contain the name of the application as a subfolder

• C:\TeleFlowRelay\LiveApps\TwitYax
• C:\TeleFlowRelay\LiveApps\MedicalRelay

TeleFlow media created by client TeleFlow applications are to be created here:

• C:\TeleFlowRelay\Media
• C:\TeleFlowRelay\Media\client_nnnnn

Note: nnnnn represents the 5 digit client number that is created by the TeleFlowRelay client creation environment.

• C:\TeleFlowRelay\Media\client_nnnnn\TwitYax
• C:\TeleFlowRelay\Media\client_nnnnn\MedicalRelay

Note: Additional folders (eg: TwitYax, MedicalRelay) will be created automatically by the media management environment which is called via XML requests from within the TeleFlow and web applications.

• C:\TeleFlowRelay\Media\client_nnnnn\appname\yyyymmdd

Note: To easily identify the age of files and to keep the directories to a manageable number of files, yyyymmdd (eg: 20091007) will be created at the time the new file was requested to be created be the media file system. However, if the TeleFlow application, or custom code creates a different directory structure (eg: Volumn0001), that is also acceptable.

Other directories that are created, or standard include:

• C:\TeleFlowRelay\Log (for all types of log files)
• C:\TeleFlowRelay\cr_temporary_files (used by the media file transfer system for FTP scripts which contain passwords etc)

TeleFlowRelay PHP and Web components

Within the web (www) folder, the following folders perform various processes:

• C:\TeleFlowRelay\www\cr_log_files (log files created by XML requests and responses)
• C:\TeleFlowRelay\www\cr_sql_statements (SQL statements used by TFR to perform table creation)

Client requested or uploaded files are created in:

• C:\TeleFlowRelay\www\cr_client_documents\client_nnnnn

Note: nnnnn represents the 5 digit client number that is created by the TeleFlowRelay client creation environment. These files could include reports, or data files that are required for loading into a system. This folder is referenced in programs such as cr_filereview.php and cr_fileupload.php

TeleFlowRelay Transfer System

The transfer system utilises the following folders. Certain PHP files must be installed as a Command File Service in order to watch for recordings which occur from a TeleFlow Server computer, which are then converted and transferred to their destination.

• C:\TeleFlowRelay\www\cr_transfer_system

The following folders include software for transferring files to destination computers. Note that there is a TeleFlowRelay Transfer system which uses HTTP post to MIME encode recordings for delivery to the the destination. This method provides an entirely encapsulated means of transferring files between TeleFlowRelay computers.

• C:\TeleFlowRelay\www\cr_transfer_system\curl
• C:\TeleFlowRelay\www\cr_transfer_system\ftp

The following folders include programs needed to convert files to other recording formats

• C:\TeleFlowRelay\www\cr_transfer_system\lame
• C:\TeleFlowRelay\www\cr_transfer_system\libsndfile
• C:\TeleFlowRelay\www\cr_transfer_system\sox

Website Specific

Because javascript must be referenced specifically in relation to the web site's root, the library_js must be at the web's root level:

• C:\TeleFlowRelay\www\library_js

Media files that are created by TeleFlow (or other processes) may be copied, or created to

• C:\TeleFlowRelay\www\cr_client_media\client_nnnnn
• C:\TeleFlowRelay\www\cr_client_media\client_nnnnn\TwitYax

Note: nnnnn represents the 5 digit client number that is created by the TeleFlowRelay client creation environment. These files could include Wav files that were originally transferred and deposited to:

• C:\TeleFlowRelay\Media\client_nnnnn (see above)
• C:\TeleFlowRelay\Media\client_nnnnn\TwitYax (see above)
• C:\TeleFlowRelay\Media\client_nnnnn\appname\yyyymmdd (see above)

Note: In these cases, a manager program may copy files into the www\cr_client_media folder so that the web page can serve them. These files, served once, can be presumed to be "linked", and therefore permanent. The files located in the Media folder may or may not ever be processed, and therefore can be removed at some point.

XML Standard Files

These files are required for TeleFlow and Web applications to share like information

• C:\TeleFlowRelay\LocalSettings_Host.xml
• C:\TeleFlowRelay\library\tf_steps_eng.xml

Other XML files are generally log files. Please note that these files should be relocated to:

• C:\TeleFlowRelay\Log

Examples of XML files that may be encountered include:

• C:\TeleFlowRelay\www\open_dictation\log\xml_dictations_2009-06-17_21-01-04_request.xml
• C:\TeleFlowRelay\www\open_dictation\log\xml_dictations_2009-06-17_21-01-04_response.xml

Graphics

Most graphics and related files for all applications installed on a TeleFlowRelay system should be located in these folders:

• C:\TeleFlowRelay\www\images
• C:\TeleFlowRelay\www\images\screenshots

Standard Includes

All standard includes for web page management and standard database calls are found in this folder

• C:\TeleFlowRelay\www\include

Standard Email System

Swift Emailer is a robust little system which is licensed correctly, and fits in well with TeleFlowRelay.

• C:\TeleFlowRelay\www\swift_emailer

Other Components

oAuth is an authentication environment which enables TFR websites to use trusted user login's from Twitter or facebook. This provides your service a means to post user created content back to their social networking website.

• C:\TeleFlowRelay\www\oauth

PayPal classes can be used to accept credit cards, or PayPal account payments. A payment systems is built into TFR, but there is not currently a shopping cart system.

• C:\TeleFlowRelay\www\paypal