This is an old revision of the document!
There are a lot of option you can set by changing the values of pre-defined system variables.
navigate to the configuration folder of the client where you want to change the settings.
Set the color theme of the grid editing area and the admin area. The theme determines the colors and the background images.
Set the color thema of the administration and configuration pages.
define('COLOR_THEME', 'VEGA');
define('COLOR_THEME_ADMIN', 'SALVA');
Valid values for the themename can be found on the system constants page (→ link)
Name of a .png - file that is displayed as logo.
Name of the product. Shown on the upper left corner in the top menu bar. May be adapted to your needs.
// ---
// colors and form dimension for admin pages
// ---
define('COLOR_INACTIV_TEXT', '#FF0040');
define('COLOR_INACTIV_BACKGROUND', '#E6E6E6');
define('FORMSIZE_ADMINPAGE_SMALL', '600');
define('FORMSIZE_ADMINPAGE_MEDIUM', '800');
define('FORMSIZE_ADMINPAGE_LARGE', '1200');
define('CAPTION_ADMINPAGE_OPEN_TAG', '<h2>');
define('CAPTION_ADMINPAGE_CLOSE_TAG', '</h2>');
// ---
// page headers
// configurable settings:
//
// COMPANY_LOGO use small .png image with your companies logo
// PRODUCT_NAME default "niota" - you can rename it to your needs
// CLAIM default ".fascinating.logical" - you can rename it to your needs
// INSTALLATION_NAME default "niota+Version" - can be use as $installation replacement parameter in stored procedure calls / callable objects scripts
//
// ---
define('COMPANY_LOGO', 'pbv_logo.png');
define('PRODUCT_NAME', 'niota');
define('CLAIM', '.featuring PBV Vertragsumschreibung ');
define('INSTALLATION_NAME', 'niota');
// ---
// grid area
//
// GRID_AREA_LANGUAGE
// de GERMAND/DEUTSCH
// en ENGLISH/ENGLISCH
// FEEDBACK_MSG_DELAY delay time of hide grid editing feedback message (milliseconds)
// DEFAULT_PAGE_SIZE_GRID the number of rows on user grid pages
// DEFAULT_PAGE_SIZE_ADMIN the number of rows on admin pages
// 10, 20, 30, 50, 100, -1 (all rows)
//
// ---
define('GRID_AREA_LANGUAGE', 'en');
define('SYSTEM_LANGUAGE', 'en');
define('DEFAULT_PAGE_SIZE_GRID', 50);
define('DEFAULT_PAGE_SIZE_ADMIN', 50);
define('FEEDBACK_MSG_DELAY', 5000);
// ---
// widths of combo - boxes in user grid pages
// configurable settings:
//
// PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH width of lookup combo during grid editing
// PHPGRID_EDIT_FORM_DEFAULT_WIDTH width of default edit form
// WIDTH_TABLE_SELECTOR width of table selector drop down list
// WIDTH_FILTER_CONNECTION width of connection filter drop down list
// WIDTH_FILTER_CATEGORY width of category filter drop down list
//
// ---
define('PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH', 300);
define('PHPGRID_EDIT_FORM_DEFAULT_WIDTH', 500);
define('WIDTH_TABLE_SELECTOR', '320px');
define('WIDTH_FILTER_CONNECTION', '150px');
define('WIDTH_FILTER_CATEGORY', '150px');
// ---
// content of table selector combo-box in user grid pages
// configurable settings:
//
// SHOW_TABLE_SELECTOR_BY_DEFAULT true/false (show / hide table selector)
// DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN pattern and list of pattern-variables to build the table list (
// DEFAULT_CATALOG_ORDER_BY order by clause of catalog list (SQL syntax qualified with "g."
// pattern for combo box in main grid page
// %cat_id% : catalog id
// %inst_name% : instance name
// %conn_name% : connection name
// %conn_disp_name% : connection display name
// %obj% : the catalog object name (table or view name)
// %desc% : description (not recommended, can be too long)
// %obj_cat% : object category
//
// ---
define('SHOW_TABLE_SELECTOR_BY_DEFAULT', true);
define('DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN', '%desc%');
define('DEFAULT_CATALOG_ORDER_BY', 'g.conn_name, g.object, g.instance_name');
Switch to turn on custom formatting files or to turn it of completely.
true - apply custom formatting (generic, database level, table level)false - switch of all custom formattingRoot folder of custom format files - this path is relative to the client root folder.
Switch to toggle if formatter files are allocated by the name of the catalog object or not.
true - format objects by names is active
CUSTOM_FORMAT_FOLDER + / + FORMATFOLDER_SUBFOLDER_CONNECTION folder is the root of the formatter files.
Connection subfolders are mandatory!!!
This folder is also root folder for the database formatter files (arranged by connection)!!!
The simple table name is the name of the formatter file e.g. for table dbo.T_CURRENCY the formatter file is T_CURRENCY.php
false - format objects by catalog ID is active
CUSTOM_FORMAT_FOLDER + / + FORMATFOLDER_SUBFOLDER_CATALOG_ID folder is the root of the formatter files.
The catalog id of an object is the name of the formatter file. E.g. for table dbo.T_CURRENCY the formatter file could be 202.php
Subfolder of CUSTOM_FORMAT_FOLDER where generic format files are located
Subfolder of CUSTOM_FORMAT_FOLDER where format files are located when formatter files are named like the catalog id. (if CUSTOM_FORMATTING_BY_CATALOG_NAME = false)
Subfolder of CUSTOM_FORMAT_FOLDER for menu item images and own icons and background images
Subfolder of CUSTOM_FORMAT_FOLDER for format folders on connectionlevel (if CUSTOM_FORMATTING_BY_CATALOG_NAME = true)
Format file name in folder CUSTOM_FORMAT_SUBFOLDER_GENERAL as overall format file. Applied always as first formatter
* ''true'' - on tablename level or/and catalog id level a formatter file with a language code of the activated language is applied as well
e.g. T_CURRENCY_en.php or 202_en.php
define('APPLY_CUSTOM_FORMATTING', true);
define('CUSTOM_FORMATTING_BY_CATALOG_NAME', true);
define('CUSTOM_FORMAT_FOLDER', 'formattings');
define('CUSTOM_FORMAT_SUBFOLDER_GENERAL', 'general');
define('CUSTOM_FORMAT_SUBFOLDER_CATALOG_ID', 'catalog_id');
define('CUSTOM_FORMAT_SUBFOLDER_CONNECTION', 'connection');
define('CUSTOM_FORMAT_SUBFOLDER_IMAGES', 'images');
define('CUSTOM_FORMAT_FILE_GENERAL', 'my_format_all.php');
define('CUSTOM_FORMAT_FILE_SPLIT_BY_LANGUAGE', true);
// ---
// help and info settings
// configurable settings:
//
// CUSTOM_HELP_FILE_SPLIT_BY_LANGUAGE true/false does the default login_help.html exist on language level or not (login_help_en.html or login_help.html)
// HELP_CUSTOM_FILE_GRID URL to own help pages - called from grid editing
// HELP_CUSTOM_FILE_ADMIN URL to own help pages - called from admin pages
//
// URLs for help pages may contain placeholders
// $documentRoot - document root direcotry of Apache
// $confFolder - substituted as 'conf'
// $clientFolder - current client folder
// $niotaRoot - path part which strats at Apache's document root and ends at 'niota' folder
// $customFormatFolder - substituted as 'formattings'
// $languageCode - en / de
// $tableName - current catalog-object-instance object name.
// $adminPage - references for 'option key' (ok) in the page URL of the current admin page. Only for 'HELP_CUSTOM_FILE_ADMIN'
//
// Important! If you use proxy then do not use the variable $documentRoot - it will resolves the IP address/DNS
// of the source machine! Instead you can define absoulte path from the document root.
// E.g. #1: "/niota/conf/my-folder/my-help.html" ==> refers to file
// 'C://Apache24/htdocs/niota/conf/my-folder/my-help.html' or
// '/var/www/htdocs/niota/conf/my-folder/my-help.html'
//
// E.g. #2: $niotaRoot/$confFolder/$clientFolder/$customFormatFolder/webhelp/my-help.html ==> refers to file
// 'C://Apache24/htdocs/niota/conf/my-cilent/formattings/webhelp/my-help.html' or
// '/var/www/htdocs/niota/conf/my-cilent/formattings/webhelp/my-hlep.html'
//
// see some further samples below:
//
// define('HELP_CUSTOM_FILE_GRID', '$documentRoot/$niotaRoot/$customFormatFolder/webhelp/$languageCode/$tableName.html');
// define('HELP_CUSTOM_FILE_GRID', 'http://www.niota.at');
// define('HELP_CUSTOM_FILE_ADMIN', '$documentRoot/$niotaRoot/$customFormatFolder/webhelp/$languageCode/$adminPage.html');
// define('HELP_CUSTOM_FILE_ADMIN', 'http://www.niota.at');
//
// ---
define ('CUSTOM_HELP_FILE_SPLIT_BY_LANGUAGE', true);
define('HELP_CUSTOM_FILE_GRID', '$niotaRoot/$confFolder/$customFormatFolder/webhelp/$languageCode/$installation/$userName.html');
//define('HELP_CUSTOM_FILE_GRID', 'http://www.niota.at');
//define('HELP_CUSTOM_FILE_ADMIN', '$niotaRoot/$confFolder/$customFormatFolder/webhelp/$languageCode/$adminPage.html');
define('HELP_CUSTOM_FILE_ADMIN', 'http://www.niota.at');
//define('HELP_CUSTOM_FILE_ADMIN', '$niotaRoot/$confFolder/$customFormatFolder/webhelp/$languageCode/$adminPage.html');
// ---
// END OF GENERAL FORMAT OPTIONS
// ---
// ---
// DEPRECATED FORMAT OPTIONS --- WILL BE REMOVED IN ONE OF THE NEXT RELEASES
// ---
define('CUSTOM_WEB_DOCS_IN_LANG_FOLDER', true);