WebAsyst Administrator Guide

Table Of Contents

Overview
Running WebAsyst Administrator
Common Settings
Setting up MySQL Server
Working Database List
Login to your Working Database
Language List / Localization
SMS Control Panel
   Clickatell SMS Gateway

Overview

WebAsyst Administrator is the key tool which allows you to setup WebAsyst properties and manage your MySQL servers and working databases. With WebAsyst Administrator you can:

  1. Customize common WebAsyst settings
  2. Add and modify MySQL Servers
  3. Add and modify working database(s)
  4. Localize (translate) WebAsyst to other languages
  5. Tune SMS gateways to allow sending SMS messages from WebAsyst applications

 



Table Of Contents


Running WebAsyst Administrator

WebAsyst Administrator is a PHP script located in published subdirectory in your WebAsyst hierarchy like in a sample below:

http://[DOMAIN][/WEBASYST]/published/admin.php

Here [DOMAIN] is domain name or IP address of the server, and [/WEBASYST] is optional path to the directory where you have installed WebAsyst.



Table Of Contents


Common Settings

Common Settings section of WebAsyst Administrators allows you to customize certain parameters applicable to all WebAsyst database accounts created on the server.

Parameter Description
Session Timeout

Designates default HTML session timeout (in minutes) which is applicable by default to every new WebAsyst database created on your server. You can overwrite this parameter for every particular database. Re-login is required after timeout gets expired.

NOTE: If you leave this field blank, HTML session never expires.

Send Notifications

If set ON (default), WebAsyst will send email notifications to users, e.g. new issue assignment, folder update notifications etc…

Robot Email Address

Notification robot is a sender of anonymous emails associated with multiple system events, e.g. assignment, reminders etc.

NOTE: If you leave this field blank some recipient mail servers may consider notification messages as a spam and deny receiving.

HTTPS Port

Default value = 443. If your SSL is bound to another port, you must expressly specify it.

NOTE: If you don’t use SSL the value in this box does not matter.

Data Path

WebAsyst data directory path. [WBS_PATH]/data directory was created during the installation process.

You can use different data directory. Always use [WBS_PATH] clause to specify WebAsyst data directory relative to your WebAsyst root directory. If you want to use data directory out of WebAsyst root directory make sure that directory exists and provide absolute path to that directory.

NOTE: PHP user must have read/write rights in WebAsyst data directory.



Table Of Contents


Setting up MySQL Server

You can use WebAsyst with multiple MySQL Servers installed on your web server. On each MySQL Server you can install as many WebAsyst working databases as you need.

The benefit of using multiple MySQL Servers: For each server you may customize language settings to provide multi-lingual support for your WebAsyst content.

In the SQL Servers section of WebAsyst Administrator you can see the full list of MySQL Servers defined in your system. You must have at least one MySQL server configuration record. To add MySQL Server configuration record, click Add MySQL Server button and specify following parameters:

Parameter Description
Server Name

Create a name for MySQL server for further reference (e.g. MyServer).

NOTE: Server Name can not be modified later.

MySQL Host IP-address or name of the computer where MySQL server is installed. If MySQL server resides on the same computer as WebAsyst scripts then leave default value in this field: localhost.
WebAsyst Host IP-address or name of the computer where WebAsyst scripts are installed as it is visible from MySQL server. If MySQL server resides on the same computer as WebAsyst scripts then leave default value in this field: localhost.
Port

TCP/IP port number for MySQL server. If the port number is not given, the default value 3306 is used.

Languages

The list of User Interface (UI) languages defined in your system (English is default).

NOTE: To learn how to add new language refer to Language List / Localization section of this Guide.

My SQL User Name & Password Name and password of MySQL User as given by your MySQL Server administrator. If this user has administrative privileges on the server, you should choose “I am MySQL Administrator” option below. Otherwise you must use “I have NO administrative rights on this MySQL Server” option, which does not allow you to create new databases on the server.



Table Of Contents


Working Database List

With WebAsyst you can create as many working databases as you need. For a working database you can either use new or existing MySQL database. If you want to use existing database, we strongly recommend using empty database which does not contain previously created tables or other objects.

In the Working Database List section of WebAsyst Administrator you can see the full list of your working databases. You must have at least one working database to work with WebAsyst applications.

To add working database, click Add Database button and specify following parameters:

Parameter Description
Database Server Select MySQL Server which you have added on the previous step of the installation process.
Create new database Use this option if you have rights to create database on the selected server. If you use this option you must create unique name for your new database. Database Name can not be modified later.

Use existing database

Use this option if you want to install WebAsyst into existing empty database.

NOTE: This is usual option for virtual hosting where you can create database only by use of stand-alone tools given by ISP, e.g. PHP MyAdmin or CPanel.

MySQL User Name & Password Name and password of MySQL User as given by your MySQL Server administrator. If this user has administrative privileges on the server, you can create new database. Otherwise you must use existing MySQL database as described above.
Database Name If you have chosen "Create new database" option then create a unique name for your new database. Otherwise, enter the name of existing database.
Database Key

Enter optional unique nickname (alias) to identify your database (e.g. MyWebAsyst or MyDatabase). Create Database Key which you can easily remember. This database key will be used in your login URL and on your WebAsyst Login page.

NOTE: If you leave this field blank Database Key will be automatically generated from the Database Name (first 16 characters will be used). Once created Database Key can not be modified later

Expire Date Database login will be prohibited after this date.
DB Size Limit Enter maximum on-disk space in MB allowed for database (including file attachments). Leave blank to ignore limitation.
Date Format Choose how you want date values to appear on your WebAsyst pages: e.g. mm/dd/yyyy or dd.mm.yyyy etc.
User Count Limit Limit total amount of users for current database.
Recipients Limit Maximum number of email recepients that you may enter in Send Email form in the Contact Manager application.
Default Encoding Specify encoding that will be used when default English language is selected. When selecting other languages, Encoding specified for corresponding language in Localization section will be used.
Administrator Language & Password Select database administrator interface language and enter login password. Use this password with ADMINISTRATOR login name to access your WebAsyst working database with administrative privileges.
Company Used as a title for your database. Could be a name of the company who owns this database or your nickname.
First Name First name of the first user who will be able to login this database. This user will be added in the User List of this database.
Last Name Last name of the first user who will be able to login this database. This user will be added in the User List of this database.
Email Enter Email address of the first user whose name has been entered above.
NOTE: Specify valid email in this field to receive login instructions. Used also as an email for administrative login – can be modified later.
Login Name & Password Create a login name and password for the first user to login this database.
Enable SMS Turn ON this option if you want to enable SMS messaging from this database. You must have SMS module(s) installed and configured. Refer to SMS Control Panel section for details.
Gateway Select SMS Gateway provider if you have SMS function enabled.
Recipients Limit Maximum number of SMS recepients that you may enter in Send SMS form in the Contact Manager application.
Applications Turn ON applications you want to install in the database.

NOTE: Once you have entered and saved working database properties, new entry appears in your Database List. Database itself will be physically created on your server only after you login this database.

 



Table Of Contents


Login to your Working Database

In the bottom of Working Database List page you can see a login URL to any of your working databases like in a sample below:

http://[DOMAIN][/WEBASYST]/published/login.php

Here [DOMAIN] is domain name or IP address of the server, and [/WEBASYST] is optional path to the directory where you have installed WebAsyst.

To login your working database for the first time you must use the Username and Password which you have specified in the Database Owner Information on the Add Database page as described above.

NOTE: You can also login your working database as Administrator. The primary purpose of Administrator is to create accounts for other users and customize their access rights. Please do not confuse Administrator account with WebAsyst Administrator tools described in this document.



Table Of Contents


Language List / Localization

All WebAsyst user interface elements (e.g. page titles, field labels, button names, messages, notes etc…; hereafter called localization strings) are stored in special files on the WebAsyst server. In the Language List / Localization section of the WebAsyst Administrator you can add/delete/modify languages and tool to edit localization strings for each language.

To add new language click Add Language button and specify following parameters:

Parameter Description
ID Language Identifier, e.g. ENG – for English, GER – German etc.
Name Language name, e.g. English, German…
Encoding Enter character set coding used with this language, e.g. iso-8859-1 is default encoding for English

Localization strings, can be imported from another language existing in your system or from external file. When you add new language you can import all localization strings from English (it’s default language) and edit them later – translate in your native language.

For every entry in the Language List you can modify properties (Name and Encoding parameters as above) and edit localization strings. To edit strings click Edit link.

To import/export strings from/to TAB-separated file, click Import or Export link in the Language List. Valid import/export file must have following fields separated by tabs:

Application ID, e.g. PM, IT...
String ID, e.g. app_name_long...
String Group, e.g. Common, Project Manager…
String Description, e.g. "Save button title in the Add User form"
String Value, e.g. "Save"

NOTE: You can not edit or import strings for English language.

 



Table Of Contents


SMS Control Panel

Some WebAsyst applications have SMS messaging feature, e.g. Contact Manager allows you to send SMS directly to the mobile phones of selected contacts. To enable SMS messaging feature you must have SMS Gateway properly installed and configured in your system.

WebAsyst has a built-in module that implement SMS messaging via SMS service provider: Clickatell SMS Gateway (http://www.clickatell.com). To be able to send SMS messages from WebAsyst installed on your server, you must have an account with Clickatell. To create an account, please refer to the gateway provider website mentioned above.

Once you have an account with Clickatell, click Modify button in the list of modules shown in the SMS Control Panel section of your WebAsyst Administrator. To configure module, click Enable button to activate module, and follow further instructions for configuring Clickatell SMS Gateway.

In the list of modules you can see Dummy SMS Gateway. It’s for developers only. Use this module if you need to disable actual SMS messaging when you modify WebAsyst sources or for testing purposes.

 



Table Of Contents


Clickatell SMS Gateway

In order to use the Clickatell gateway you need a Clickatell account and at least one registered connection (API sub-product instance) between WebAsyst application and Clickatell gateway. To create Clickatell account please refer to http://www.clickatell.com/

While configuring Clickatell gateway for your WebAsyst installation you have to enter certain parameters shown in the table below. These parameters should be supplied to you by Clickatell after you create account with them.

Parameter Description
Username:  The username you specified when creating Clickatell account.
Password:  Your account password.
URL:  Clickatell gateway base URL where all messages are being sent. Usually http://api.clickatell.com
API ID:  Issued by Clickatell upon creating your account. A single account may have multiple API IDs associated with it.
Unicode:  If enabled, converts your text to Unicode [UCS-2 encoding]. See http://www.unicode.org/ for details. To enable Unicode you must mbstrings PHP extension installed on your server.
Delivery Queue:  Delivers the message through one of three queues assigned to each client account. Messages in the highest priority queue will be delivered first.
Sender Address:

The from address that appears on the recipient’s handset (mobile phone) when he/she receives SMS. There are two options for this parameter:

  • Company Name – this is the name of company (owner of WebAsyst database) specified for every WebAsyst database installed on your server, it appears in the left top corner of the main WebAsyst screen.
  • Custom – allows you to set a unified Sender name for all WebAsyst databases installed on your server. This unified name should be specified in the “Custom Sender Address” field below.
Custom Sender Address: A unified Sender name used in conjunction with Custom option of the Sender Address property as described above.
One Credit Price (USD):

Clickatell charges for each SMS in Credits. Generally 1 SMS Message will cost you 1 SMS credit. In some instances however, the destination network may charge 2 or more credits to deliver your message. One Clickatell Credit is equal approximately 0.05 USD (at the moment of writing this document; please refer to Glickatell website for up-to-date information).

Every time WebAsyst sends SMS, a receipt from Clickatell comes back with an actual cost of SMS measured in Credits. WebAsyst then multiples “One Credit Price” value by the amount of Credits to calculate Actual Charge for SMS. This Actual Charge is then used to update Available Balance and in SMS Billing History reports.

Reserve Charge (USD): Actual Charge is updated every time when receipt is confirmed from gateway provider. However, receipt sometimes is not available immediately. In such a case a Reserve Charge amount approximating the Actual Charge is calculated when SMS is sent to reduce Available Balance in SMS accounts.

To learn more about configuring Clickatell gateway refer to original documentation available at http://www.clickatell.com/



Table Of Contents