You are on page 1of 70

Active Business Intelligence Portal

User manual

© DB Software Laboratory 2008

www.dbsoftlab.com
Active Business Intelligence Portal User Manual

Contents

Contents....................................................................................................................................... 2
1. Introduction ............................................................................................................................. 4
2. Requirements........................................................................................................................... 4
Active BI Portal Manager........................................................................................................ 4
Windows Based Server ........................................................................................................... 5
Unix/Linux Based Server ........................................................................................................ 5
3. Key features............................................................................................................................. 6
4. Active Business Intelligence Portal Architecture.................................................................... 8
5. Installation ............................................................................................................................... 9
6. Options .................................................................................................................................. 10
7. User Interface ........................................................................................................................ 12
Main window......................................................................................................................... 12
Outlook Bar ........................................................................................................................... 13
8. Connections. .......................................................................................................................... 14
Why it is necessary to have two different connections. ........................................................ 15
Understanding PHP DSN ...................................................................................................... 15
9. Menus .................................................................................................................................... 17
Creating new Menu ............................................................................................................... 18
Creating new Menu Item....................................................................................................... 19
Speeding up Menu creation................................................................................................... 20
10. Lookups ............................................................................................................................... 20
10. Lookups ............................................................................................................................... 21
SQL Builder .......................................................................................................................... 23
11. Links .................................................................................................................................... 24
12. Users .................................................................................................................................... 25
13. Groups ................................................................................................................................. 28
Access Rights. ....................................................................................................................... 30
14. SQL ..................................................................................................................................... 32
Screen Overview ................................................................................................................... 32
SQL Toolbar.......................................................................................................................... 33
Side toolbar............................................................................................................................ 33
15. Web Pages ........................................................................................................................... 34
Screen Overview ................................................................................................................... 34
Creating a New Web Page Using Wizard ............................................................................. 35
Toolbar Functions.................................................................................................................. 38
18. Reports................................................................................................................................. 39
Screen Overview ................................................................................................................... 39
Creating a New Report Page Using Wizard .......................................................................... 40
Report Structure .................................................................................................................... 46
Editing HTML Manually....................................................................................................... 47
Report HTML Example......................................................................................................... 48
Report Parameters page HTML Example ............................................................................. 49
Linking Reports together....................................................................................................... 50
Linking Reports using Wizard .............................................................................................. 51
19. Web Forms .......................................................................................................................... 53
Screen Overview ................................................................................................................... 53
Creating a New Web Form Using Wizard ............................................................................ 54
DB Software Laboratory
2 of 70
Active Business Intelligence Portal User Manual

Editing HTML Manually....................................................................................................... 63


Web Form HTML Example .................................................................................................. 64
List HTML Page Example .................................................................................................... 65
Web Forms Parameters page HTML Example ..................................................................... 65
20. Support Procedure ............................................................................................................... 67
21. License Agreement.............................................................................................................. 68

DB Software Laboratory
3 of 70
Active Business Intelligence Portal User Manual

1. Introduction

Active Business Intelligence Portal is business intelligence software that provides an


integrated solution for designing and deploying reports and web forms over the internet and
intranet.

2. Requirements

Active Business Intelligence Portal consists of two parts Active BI Portal Manager which
works on Windows only and server part which is collection of PHP scripts and can be run on
Windows, UNIX or Linux.

Below is the list of Software that must be installed before the installation of Active Business
Intelligence Portal:

Active BI Portal Manager

Software Version Notes


Microsoft Windows 98 or higher
MDAC 2.6 or higher Part of OS on W2K
and XP
Microsoft Jet 4.0 Service pack 5 or For MS Access
higher repository
MySql ODBC 3.51.12 or higher www.mysql.com For MySql repository
Driver
PostgreSql ODBC 8.01.01 or higher www.postgresql.com For PostgreSql
Driver repository
Firebird ODBC 1.02.00 or higher www.ibphenix.com For Interbase/FireFox
Driver repository
Oracle Client 7.3.4 or higher Provided by Oracle Only to connect to
Oracle repository
Internet Explorer v6

DB Software Laboratory
4 of 70
Active Business Intelligence Portal User Manual

Windows Based Server

Software Version Notes


Microsoft Windows NT 4,2000,XP or
2003
Internet Information Part of OS on W2K
Server or Apache and XP
web server
MS Access ODBC To connect to MS
driver Access databases
MySql ODBC 3.51.12 or higher www.mysql.com To connect to MySql
Driver databases
PostgreSql ODBC 8.01.01 or higher www.postgresql.com To connect to
Driver PostgreSql databases
Firebird ODBC 1.02.00 or higher www.ibphenix.com To connect to
Driver Interbase/FireFox
databases
Oracle Client 7.3.4 or higher Provided by Oracle To connect to Oracle
databases
PHP 4.3.4 or higher with www.php.net Required component
all database related
extensions
PEAR DB package pear.php.net Required component

Unix/Linux Based Server

Software Version Notes


Web Server which Required component
supports PHP.
(for example
Apache)
PHP 4.3.4 or higher with www.php.net Required component
all database related
extensions
PEAR DB package pear.php.net Required component

Note:
Depending on the Requirements you may or may not need to have all components installed

DB Software Laboratory
5 of 70
Active Business Intelligence Portal User Manual

3. Key features

This product features:


• Integrated Html Editor
• Integrated SQL Builder
• Comprehensive security management
• User definable menus
• Report Generation Wizard
• Web Forms Wizard
• Collection of predefined themes.
• Unlimited number of users
• Repository Creation Wizard
• Easy Repository switching
• Repository Import and Export
• Lookups
• Sql Editor

When running on Windows Active Business Intelligence Portal can use any ODBC source or
PHP Database extensions to report on such as

• MS Access
• Oracle
• MS Sql Server
• Interbase/Firebird
• MySQL
• PostgreSQL

Same when running on UNIX and Linux.

Active Business Intelligence Portal uses repository to store following information

• Users
• Groups
• Access Rights
• Menus
• Lookups
• Source Database Connections
• Links
• HTML Pages
• Reports
• Forms

DB Software Laboratory
6 of 70
Active Business Intelligence Portal User Manual

Repository Creation scripts are provided for following databases:

• MS Access
• Oracle
• MS Sql Server
• Interbase/Firebird
• MySQL
• PostgreSQL

Note:
Once installation is completed you may find all the scripts in C:\Program Files\DB Software
Laboratory\Active Business Intelligence Portal folder.

DB Software Laboratory
7 of 70
Active Business Intelligence Portal User Manual

4. Active Business Intelligence Portal Architecture

Web Server
IIS/Apache

Web Pages
Reports
Web Forms
Any Links
Database Menus

ODBC

End Users

Data Sources

Oracle, MS SQL Server.


MS ACCESS, MySQL,
PostgreSQL or Interbase

Portal
Manager

DB Software Laboratory
8 of 70
Active Business Intelligence Portal User Manual

5. Installation

Repository creation

Use wizard provided to create the repository

Web Server configuration and installation

Installation of PHP and pear is outside of scope of this document.

You may find PHP installation manual at

http://uk2.php.net/install

And Pear installation guide at

http://www.go-pear.org/manual/en/installation.php

You may also consider using XAMPP

http://www.apachefriends.org/en/xampp.html

XAMPP for Windows

By default this package installs all we need

Installation of Active Business Intelligence Portal in 5 easy steps

1. Install XAMPP for Windows


2. Install Active Business Intelligence Portal
3. Copy Portal Directory from
4. “C:\Program Files\DB Software Laboratory\Active Business Intelligence Portal” to
“C:\Program Files\xampp\htdocs”.
5. Launch Internet Explorer and go to http://localhost/Portal
6. You should be able to see Active Business Intelligence Portal Welcome Page

Changing the repository Connection

Default Repository is MS Access if you want to use different repository you must create it first
using wizard provided. Once repository is created open config.php file find a line starting with
$dsn= and enter appropriate connection string for the repository. For more information read
Understanding PHP DSN on page 15.

Note:

Config.php file is located in C:\Program Files\DB Software Laboratory\Active Business


Intelligence Portal\Portal directory
Default password for user Administrator is test
DB Software Laboratory
9 of 70
Active Business Intelligence Portal User Manual

6. Options

To change Active Business Intelligence Portal settings click System menu-> File-> Options.
Dialog box will appear.

Change Connection
properties

Delete Connection

Create new
Connection

DB Software Laboratory
10 of 70
Active Business Intelligence Portal User Manual

DB Software Laboratory
11 of 70
Active Business Intelligence Portal User Manual

7. User Interface

Main window
System Menu

Outlook Bar Status bar

DB Software Laboratory
12 of 70
Active Business Intelligence Portal User Manual

Outlook Bar

Active Business Intelligence Portal uses Outlook bar to provide the user with an easy access to
the main functions of application.

Below is a list of Outlook bar items with the short descriptions:

Connections Defines connections to Data Sources

Menus Defines Tree Menus

Lookups Defines lists of values which are used in Parameters forms


for Reports and Web Forms

Links Defines links to external web sites or documents

Users Defines list of Active Business Intelligence Portal Users

Groups Defines list of Active Business Intelligence Portal Groups of


Users and access rights to portal documents such as Web
Pages, Reports and forms.
SQL Scripts Provides functionality to run SQL statements against target
Data Source and quick way to browse and edit data

Web Pages List of Web pages together with HTML editor.

Reports List of Reports together with Reports Editor.

Forms List of Forms together with Reports Editor.

DB Software Laboratory
13 of 70
Active Business Intelligence Portal User Manual

8. Connections.

In order to generate Reports and Web Forms Active Business Intelligence Portal must be able
to connect various Data sources.

To create a new connection Click Outlook Bar-> Portal Management-> Connections->Plus


Icon.

• Dialog box will appear.


• In the Name Text Box type in a new name for the connection you are about to create
• Select a ODBC DSN Name from the Drop Down List
• Fill in Username/Password for the database you wish to connect to

a. You may use ODBC admin to create/modify ODBC data sources.

DB Software Laboratory
14 of 70
Active Business Intelligence Portal User Manual

• Click Test to ensure the details you have provided are correct
• Fill in PHP Dsn appropriate for the data source
• Click OK to close the Connection Properties Window

Why it is necessary to have two different connections.


It is necessary because Active Business Intelligence Portal Manager and PHP Portal Scripts
are using different ways to access data source data. Active Business Intelligence Portal
Manager can be run on Windows PC only when PHP Portal Scripts can be run on Windows
and Unix/Linux as well.

Understanding PHP DSN

Description
To connect to a database through PEAR::DB, you have to create a valid DSN - data source
name. This DSN consists in the following parts:

phptype: Database backend used in PHP (i.e. mysql , odbc etc.)


dbsyntax: Database used with regards to SQL syntax etc.
protocol: Communication protocol to use ( i.e. tcp, unix etc.)
hostspec: Host specification (hostname[:port])
database: Database to use on the DBMS server
username: User name for login
password: Password for login
proto_opts: Maybe used with protocol

The format of the supplied DSN is in its fullest form:


phptype(dbsyntax)://username:password@protocol+hostspec/database

Most variations are allowed:


phptype://username:password@protocol+hostspec:110//usr/db_file.db
phptype://username:password@hostspec/database_name
phptype://username:password@hostspec
phptype://username@hostspec
phptype://hostspec/database
phptype://hostspec
phptype(dbsyntax)
phptype

The currently supported database backends are: mysql -> MySQL


pgsql -> PostgreSQL
ibase -> InterBase
msql -> Mini SQL
mssql -> Microsoft SQL Server
oci8 -> Oracle 7/8/8i
odbc -> ODBC (Open Database Connectivity)
sybase -> SyBase
DB Software Laboratory
15 of 70
Active Business Intelligence Portal User Manual

ifx -> Informix


fbsql -> FrontBase

With an up-to-date version of DB, you can use a second DSN format
phptype(syntax)://user:pass@protocol(proto_opts)/database

Example 1: Connect to database through a socket

mysql://user@unix(/path/to/socket)/pear

Example 2: Connect to database on a non standard port

pgsql://user:pass@word@tcp(localhost:5555)/pear

Note:
User may change connection or directory properties at any time by double clicking on it.

DB Software Laboratory
16 of 70
Active Business Intelligence Portal User Manual

9. Menus

Every Portal user has a menu assigned. List of items accessible by the user is defined by its
access rights. Every menu consists of a root folder subfolders and items such as links, html
pages, reports and web forms.
Menu
List of Menus

DB Software Laboratory
17 of 70
Active Business Intelligence Portal User Manual

Creating new Menu

• To create a new Menu click Pop up menu-> Add.


• Fill in Menu Name you are about to create.
• Click OK to finish creation of Menu.

DB Software Laboratory
18 of 70
Active Business Intelligence Portal User Manual

Creating new Menu Item

• To create a new Menu Item click Pop up menu-> Add.


• Choose appropitate Item Type from Radio Group
• Fill in Item Name or choose it from drop down box.
• Click OK to finish creation of Menu Item.

DB Software Laboratory
19 of 70
Active Business Intelligence Portal User Manual

Speeding up Menu creation.

It is also possible to use drug and drop for menu design and creation.

List of folders
List of documents

DB Software Laboratory
20 of 70
Active Business Intelligence Portal User Manual

10. Lookups

Lookup is an object which represents list of values. Lookups are used for web forms and
parameters pages design.

Lookup

Lookup in Active Business Intelligence Portal is an SQL statement with two fields’ code and
description. First field is code second is description.

Select cities.CityId,
cities.City from cities
Order by 2

• To create a new Lookup click Outlook bar Lookups and than click Add.
• Dialog box will appear
• Fill in Lookup Name you are about to create.
• Select appropriate connection from the drop down box
• Click on SQL tab
• Type in SQL text or use SQL builder to design it
• Click OK to finish creation of a Lookup.

DB Software Laboratory
21 of 70
Active Business Intelligence Portal User Manual

SQL Builder

DB Software Laboratory
22 of 70
Active Business Intelligence Portal User Manual

SQL Builder

Sql Builder screen provides user with a quick way of editing/creating sql select statements.

DB Software Laboratory
23 of 70
Active Business Intelligence Portal User Manual

11. Links
Link is an object which represents URL link to an external web site or document.

• To create a new Link click Outlook bar Links and than click Add.
• Dialog box will appear
• Fill in Link Name you are about to create.
• Fill in URL
• Click OK to finish creation of a Link.

DB Software Laboratory
24 of 70
Active Business Intelligence Portal User Manual

12. Users

Active Business Intelligence Portal uses roles based security model. Every portal user must be
a member at list one of the users groups and have menu assigned. Combination of group
access rights and user group membership defines list of documents user can get access to.

• To create a new User click Outlook bar Users and than click Add.
• Dialog box will appear
• Fill in User Name you are about to create.
• Specify if user login is disabled
• Fill in user password and confirm password
• Select a User Menu from drop down box
• Click Advanced tab and fill in additional information about user
DB Software Laboratory
25 of 70
Active Business Intelligence Portal User Manual

• Click OK to finish creation of an User.

Note:
All Fields on Advanced tab are not mandatory.

DB Software Laboratory
26 of 70
Active Business Intelligence Portal User Manual

Once user is created it is possible to modify Group membership.

DB Software Laboratory
27 of 70
Active Business Intelligence Portal User Manual

13. Groups
Active Business Intelligence Portal uses roles based security model. Every portal user must be
a member at list one of the users groups and have menu assigned. Combination of group
access rights and user group membership defines list of documents user can get access to.

• To create a new Group click Outlook bar -> Groups and than click Add.
• Dialog box will appear
• Fill in Group Name you are about to create
• Click OK to finish creation of an Group

DB Software Laboratory
28 of 70
Active Business Intelligence Portal User Manual

Once Group is created it is possible to modify list of Group members.

DB Software Laboratory
29 of 70
Active Business Intelligence Portal User Manual

Access Rights.

Access rights tabs defines list of objects available for group members.

Permission Comment
No Access Blocks access to the objects regardless of group membership
View Group members can view the objects
Insert Group members can insert records using the Web form object
Update Group members can update records using the Web form object
Delete Group members can delete records using the Web form object

Hint:
To add several objects hold ctrl or shift key and select objects using mouse.

DB Software Laboratory
30 of 70
Active Business Intelligence Portal User Manual

DB Software Laboratory
31 of 70
Active Business Intelligence Portal User Manual

14. SQL

SQL Screen is a tool to run a free hand SQL or SQL scripts.

Screen Overview

SQL Toolbar Connections List SQL Window SQL Builder

List of available SQL Execution LOG


tables for Data Grid

DB Software Laboratory
32 of 70
Active Business Intelligence Portal User Manual

SQL Toolbar

1 2 3 4

1. Show/hide SQL Statement


2. Show/hide connection panel
3. Show/hide log panel
4. Show/hide system tables

Side toolbar

1. Previous SQL Statement


2. Next SQL Statement
3. Select SQL Statement to execute

DB Software Laboratory
33 of 70
Active Business Intelligence Portal User Manual

15. Web Pages

Screen Overview

Toolbar
List of Documents

Editor
HTML Editor
Status bar

DB Software Laboratory
34 of 70
Active Business Intelligence Portal User Manual

Creating a New Web Page Using Wizard

• To create a new Web Page click Outlook bar -> Web Pages and than click Add.

• Wizard Screen will appear


• Click next to continue

DB Software Laboratory
35 of 70
Active Business Intelligence Portal User Manual

• Fill in HTML Page Name


• Click next to continue

• Fill in Comments
• Click next to continue

DB Software Laboratory
36 of 70
Active Business Intelligence Portal User Manual

• Click finish to complete HTML Page creation process

DB Software Laboratory
37 of 70
Active Business Intelligence Portal User Manual

Toolbar Functions

1 2 3 4 5 6 7 8 9 10 11 12

13 14 15 16 17 18 19 20 21 22 23 24 25 26

27 28 29 30 31

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

1. Open Wizard (Properties Dialog) 26. Insert Break


2. Load Web Page from the Disk 27. Font
3. Save Web Page to the Repository 28. Font Size
4. Save Web Page to the Disk 29. Bold
5. Find 30. Italic
6. Print Document 31. Underline
7. Print Preview 32. Remove Bullets/Numbering
8. Cut 33. Formatting Numbers
9. Copy 34. Formatting Bullets
10. Paste 35. Remove Align
11. Undo 36. Align Left
12. Redo 37. Align Centred
13. Insert Table 38. Align Right
14. Table Properties 39. Justify
15. Split Cells 40. Insert Horizontal Line
16. Merge Cells 41. Insert Link
17. Add Cell 42. Insert Picture
18. Add Row 43. Background Colour
19. Add Column 44. Font Colour
20. Delete Cell
21. Delete Row
22. Delete Column
23. Insert Form Object such as Edit box,
Drop down box etc
24. Insert Comment
25. Insert HTML

DB Software Laboratory
38 of 70
Active Business Intelligence Portal User Manual

18. Reports.

Screen Overview

Toolbar

List of available fields Report Editor


HTML Editor

DB Software Laboratory
39 of 70
Active Business Intelligence Portal User Manual

Creating a New Report Page Using Wizard


In this example we will be creating a report which represents customers’ sales grouped by city
and country for specified month. See SQL below.

Select countries.Country,
cities.City,
customers.CompanyName,
customers.ContactName,
Sum (sales. Amount) As Sales
From countries,cities,customers,sales,months
where
countries.CountryId = cities.CountryId and
cities.CityId = customers.CityId and
customers.CustomerID = sales.CustomerID and
months.MonthId = sales.MonthID and
months.Month=:Month Parameters must start with ‘:’

• To create a new Report click Outlook bar -> Reports and than click Add.

DB Software Laboratory
40 of 70
Active Business Intelligence Portal User Manual

• Wizard Screen will appear


• Click next to continue

• Fill in Report Name and select appropriate connection


• Click next to continue

DB Software Laboratory
41 of 70
Active Business Intelligence Portal User Manual

• Enter SQL for report or alternatevely use SQL builder to generate it


• Click next to continue

• Enter labels for columns and select appropriate formats


• Click next to continue

DB Software Laboratory
42 of 70
Active Business Intelligence Portal User Manual

• Enter descriptions for parameters and select appropriate lookups if necessary


• Click next to continue

• Select fields for report groupping


• Click next to continue

DB Software Laboratory
43 of 70
Active Business Intelligence Portal User Manual

• Select functions for calculattions


• Click next to continue

• Change report appereance by changing state of check boxes on the right


• Click next to continue

DB Software Laboratory
44 of 70
Active Business Intelligence Portal User Manual

• Fill in report comments


• Click next to continue

• Click finish to complete report creation process

DB Software Laboratory
45 of 70
Active Business Intelligence Portal User Manual

Report Structure

Group Header Rows Header


Text before Report Rows Data

Report Level Calculations


Text after Report Group Footer

DB Software Laboratory
46 of 70
Active Business Intelligence Portal User Manual

Editing HTML Manually

While editing html manually keep in mind information below.

Reports

• FN[FieldName] – Field Name


• FD[FieldName] - Field Data
• Calc[FieldName,FunctionName] - Calculation
• <!-- rs --> - Report Start
• <!-- re --> - Report End
• <!-- hs --> - Report header start
• <!-- he --> - Report header end
• <!-- ghs0 --> - Group header start
• <!-- ghe0 --> - Group header end
• <!-- rhs --> - Rows header start
• <!-- rhe --> - Rows header end
• <!-- ds --> - Report data start
• <!-- de --> - Report data end
• <!-- gfs0 --> - Group footer start
• <!-- gfe0 --> - Group footer end
• <!-- ss --> - Report summary start
• <!-- se --> - Report summary end
• <!-- fs --> - Report footer start
• <!-- fe --> - Report footer end

Parameters Page

• <!-- rfs --> - Report form Start


• <!-- rfe --> - Report form End
• Every report parameters page must have <!-- DOCUMENT_ID --> after <form
name="document_parameters" method="get">
• Every lookup must have <!-- ld1002 --> after </select> tag. Where 1002 is lookup id

DB Software Laboratory
47 of 70
Active Business Intelligence Portal User Manual

Report HTML Example

<body><!-- rs --><br /><br />


<table class="report" cellspacing="1" cellpadding="1" align="center" border="1">
<tbody><!-- hs -->
<tr class="reportheader">
<td colspan="80">Reports Header</td>
</tr><!-- he --><!-- ghs0 -->
<tr class="groupheader">
<td colspan="80">FN[Country]:FD[Country]</td>
</tr><!-- ghe0 --><!-- rhs -->
<tr class="rowsheader">
<td>FN[City]</td>
<td>FN[CompanyName]</td>
<td>FN[ContactName]</td>
<td align="right">FN[Sales]</td>
</tr><!-- rhe --><!-- ds -->
<tr class="rowsdata">
<td>FD[City]</td>
<td>FD[CompanyName]</td>
<td>FD[ContactName]</td>
<td align="right">FD[Sales]</td>
</tr><!-- de --><!-- gfs0 -->
<tr class="groupfooter">
<td>&nbsp;</td>
<td></td>
<td></td>
<td align="right">Calc[Sales,SUM]</td>
</tr><!-- gfe0 --><!-- ss -->
<tr class="summary">
<td></td>
<td></td>
<td></td>
<td align="right">Calc[Sales,SUM]</td>
</tr><!-- se --><!-- fs -->
<tr class="reportfooter">
<td colspan="80">Reports Footer</td>
</tr><!-- fe -->
</tbody>
</table><br /><br /><!-- re -->

DB Software Laboratory
48 of 70
Active Business Intelligence Portal User Manual

Report Parameters page HTML Example

<body><!-- rfs --><br /><br />


<form name="document_parameters" method="get"><!-- DOCUMENT_ID -->
<table class="report" cellspacing="1" cellpadding="1" align="center" border="1">
<tbody>
<tr>
<td>Month</td>
<td><select name="Month"></select><!-- ld1002 --></td>
</tr>
<tr>
<td><input style="width: 83px; height: 24px" onclick="submitdata()" type="submit"
size="55" value="OK" name="btnSubmit" /></td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
</form><!-- rfe -->
</body>

DB Software Laboratory
49 of 70
Active Business Intelligence Portal User Manual

Linking Reports together

Example below demonstrates ability of Active Business Intelligence Portal link reports
together. First report represents list of sales by county. When user clicks on Country name it
will bring sales by city for specific country, clicking on city name will bring customers sales
for that city.

DB Software Laboratory
50 of 70
Active Business Intelligence Portal User Manual

Linking Reports using Wizard

• To create a link between Reports click Link Document button

• Wizard Screen will appear


• Click next to continue

DB Software Laboratory
51 of 70
Active Business Intelligence Portal User Manual

• Select Report you want to link to from drop down box


• It is also possible to link on report to several reports
• Click next to continue

• Map columns to parameters


• Click Finish to complete linking reports

DB Software Laboratory
52 of 70
Active Business Intelligence Portal User Manual

19. Web Forms

Screen Overview
List of available fields Toolbar

HTML Editor Form Editor

DB Software Laboratory
53 of 70
Active Business Intelligence Portal User Manual

Creating a New Web Form Using Wizard


In this example we will be creating a Web Form for editing list of customers online.

• To create a new Web Form click Outlook bar -> Forms and than click Add.
• Wizard Screen will appear
• Click next to continue

DB Software Laboratory
54 of 70
Active Business Intelligence Portal User Manual

• Fill in Web Form Name and select appropriate connection


• Click next to continue

• Select Base Table Name from Drop Down box


• Check Generate SQL Automatically
• Click next to continue

DB Software Laboratory
55 of 70
Active Business Intelligence Portal User Manual

• Select fields which are part of primary key for table they will be used for SQL
generation later
• Fill in/Update fields’ Labels
• Select appropriate formats
• Select Lookups for fields if necessary
• Click next to continue

• Modify generated sql if necessary


• Click next to continue

DB Software Laboratory
56 of 70
Active Business Intelligence Portal User Manual

• Modify generated sql if necessary


• Click next to continue

• Modify generated sql if necessary


• Click next to continue

DB Software Laboratory
57 of 70
Active Business Intelligence Portal User Manual

• Modify generated sql if necessary


• Click next to continue

• Enter descriptions for parameters and select appropriate lookups if necessary


• Click next to continue

DB Software Laboratory
58 of 70
Active Business Intelligence Portal User Manual

• This screen represents Web form Page Preview


• Click next to continue

• This screen represents Record List Page Preview


• Click next to continue

DB Software Laboratory
59 of 70
Active Business Intelligence Portal User Manual

• This screen represents Parameters Page Preview


• Click next to continue

• Fill in comments
• Click next to continue

DB Software Laboratory
60 of 70
Active Business Intelligence Portal User Manual

• Click finish to complete Web Form Creation Process

• Result of Web Form Creation Process

DB Software Laboratory
61 of 70
Active Business Intelligence Portal User Manual

List of customers in Web Browser

Editing Data

DB Software Laboratory
62 of 70
Active Business Intelligence Portal User Manual

Editing HTML Manually

While editing html manually keep in mind information below.

Form Page

• <!-- wfs --> - Web form start


• <!-- wfe --> - Web form End
• Every web form must have <!-- DOCUMENT_ID --> before </form> tag
• Every lookup must have <!-- ld1002 --> after </select> tag. Where 1002 is lookup id
• Every input object must have same name as an existing field in select statement

Records List Page

• FN[FieldName] – Field Name


• FD[FieldName] - Field Data
• <!-- rs --> - List Start
• <!-- re --> - List End
• <!-- hs --> - List header start
• <!-- he --> - List header end
• <!-- rhs --> - List header start
• <!-- rhe --> - List header end
• <!-- ds --> - List data start
• <!-- de --> - List data end
• <!-- fs --> List footer start
• <!-- fe --> List footer end
• <!-- fe --> List footer end
• Use <a href="?document=1114&_ACTION=ADD_DATA">Add</a> to add record
• Use <a href="?document=1114&_ACTION=DELETE_DATA<-- pk -->">Delete</a>
to delete records
• Use <a href="?document=1114&_ACTION=EDIT_DATA<-- urlrec -->">Edit</a> to
edit records

Parameters Page

• <!-- rfs --> - Report form Start


• <!-- rfe --> - Report form End
• Every report parameters page must have <!-- DOCUMENT_ID --> after <form
name="document_parameters" method="get">
• Every lookup must have <!-- ld1002 --> after </select> tag. Where 1002 is lookup id

DB Software Laboratory
63 of 70
Active Business Intelligence Portal User Manual

Web Form HTML Example


<body><!-- wfs --><br /><br />
<form name="web_form" method="get">
<table class="report" cellspacing="1" cellpadding="1" align="center" border="1">
<tbody>
<tr>
<td>ID:</td>
<td><input style="width: 129px; height: 22px" size="16" value=""
name="CustomerID" /></td></tr>
<tr>
<td>Company Name:</td>
<td><input style="width: 265px; height: 22px" size="34" value=""
name="CompanyName" /></td></tr>
<tr>
<td>Title:</td>
<td><input value="" name="ContactTitle" /></td>
</tr>
<tr>
<td>Contact Name:</td>
<td><input style="width: 263px; height: 22px" size="33" value=""
name="ContactName" /></td></tr>
<tr><td>Address:</td>
<td><textarea name="Address" rows="3" cols="30"></textarea></td>
</tr>
<tr><td>City:</td>
<td><select style="width: 262px" name="CityId"></select><!-- ld1005 --></td>
</tr>
<tr><td>Postal Code:</td>
<td><input value="" name="PostalCode" /></td>
</tr>
<tr><td>Phone:</td>
<td><input value="" name="Phone" /></td>
</tr>
<tr><td>Fax:</td>
<td><input value="" name="Fax" /></td>
</tr><tr>
<td><input style="width: 83px; height: 24px" onclick="submitWFdata()"
type="submit" size="55" value="Save" name="btnSubmit" /></td>
<td></td>
</tr>
</tbody>
</table><!-- DOCUMENT_ID -->
</form><br /><br /><br /><!-- wfe -->
</body>

DB Software Laboratory
64 of 70
Active Business Intelligence Portal User Manual

List HTML Page Example

<body><!-- rs --><br /><br />


<table class="report" cellspacing="1" cellpadding="1" align="center" border="1">
<tbody><!-- hs --><!-- he --><!-- rhs -->
<tr class="rowsheader">
<td><a href="?document=1114&_ACTION=ADD_DATA">Add</a></td>
<td>&nbsp;</td>
<td>FN[CompanyName]</td>
<td>FN[ContactTitle]</td>
<td>FN[ContactName]</td>
<td>FN[Address]</td>
<td>FN[City]</td>
<td>FN[PostalCode]</td>
<td>FN[Phone]</td>
<td>FN[Fax]</td>
</tr><!-- rhe --><!-- ds -->
<tr class="rowsdata">
<td><a href="about:blank?document=1114&_ACTION=DELETE_DATA<-- pk --
>">Delete</a></td>
<td><a href="about:blank?document=1114&_ACTION=EDIT_DATA<-- urlrec --
>">Edit</a></td>
<td>FD[CompanyName]</td>
<td>FD[ContactTitle]</td>
<td>FD[ContactName]</td>
<td>FD[Address]</td>
<td>FD[City]</td>
<td>FD[PostalCode]</td>
<td>FD[Phone]</td>
<td>FD[Fax]</td>
</tr><!-- de --><!-- fs --><!-- fe -->
</tbody>
</table><br /><br />&nbsp; <!-- re -->
</body>

Web Forms Parameters page HTML Example

Same as Report Parameters page HTML Example

DB Software Laboratory
65 of 70
Active Business Intelligence Portal User Manual

20. Importing and Exporting Data

There are several ways to import export data from Active Business Intelligence Portal
User may Export entire Repository by clicking tools-> Export Repository. Format is
transportable between different databases. For example user may Export Repository from
testing environment such as MS access an import it into Live environment which is Oracle.

User may also import HTML documents from a directory. In this case file names will became
HTML Document name in Active Business Intelligence Portal Repository. This feather makes
it easier to load previously created HTML pages. It is also possible to save all Documents into
specified directory. This works with Reports and Web Forms as well. It will create separate
files for Report HTML Page, Parameters HTML page etc. and for all sql scripts.

DB Software Laboratory
66 of 70
Active Business Intelligence Portal User Manual

21. Support Procedure

Should you require any support please send the following information to
support@dbsoftlab.com

1. Version number
2. Example of data
3. Script to create table
4. Database version
5. Operation system version
6. Repository
7. Description of the problem

DB Software Laboratory
67 of 70
Active Business Intelligence Portal User Manual

22. License Agreement


Active Business Intelligence Portal by
DB Software Laboratory
www.dbsoftlab.com
info@dbsoftlab.com

END-USER LICENSE AGREEMENT FOR THIS SOFTWARE


IMPORTANT - READ CAREFULLY:

This End-User License Agreement ("EULA") is a legal agreement between you (either
an individual or a single entity) and DB Software Laboratory for the SOFTWARE
PRODUCT identified above, which includes computer software and may include
associated media, printed materials, and "online" or electronic documentation. By
installing, copying, or otherwise using the SOFTWARE PRODUCT, you agree to be
bound by the terms of this EULA. If you do not agree to the terms of this EULA, you
may be subject to civil liability if you install and use this SOFTWARE PRODUCT.

SOFTWARE PRODUCT LICENSE

The SOFTWARE PRODUCT is protected by copyright laws and international


copyright treaties, as well as other intellectual property laws and treaties.

The SOFTWARE PRODUCT is licensed, not sold.

INSTALLATION AND USAGE

Once SOFTWARE PRODUCT is installed you may use it for 30 days. After evaluation
period ends, you have to purchase a license or stop using the SOFTWARE
PRODUCT.

If this is an EVALUATION VERSION of the SOFTWARE PRODUCT, you may copy


and distribute an unlimited number of copies of the SOFTWARE PRODUCT; provided
that each copy shall be a true and complete copy, including all copyright and
trademark notices, and shall be accompanied by a copy of this EULA.

If this is a REGISTERED VERSION of the SOFTWARE PRODUCT, you may install


and use it for your personal use only. You may not reproduce or distribute the
SOFTWARE PRODUCT for use by others.

DB Software Laboratory
68 of 70
Active Business Intelligence Portal User Manual

LICENSING

There are two types of licenses available

1. A single computer usage license. The user purchases one license to use the
SOFTWARE PRODUCT on one computer.

2. A SITE usage license. The user purchases a single usage license, authorising the
use of SOFTWARE PRODUCT, by the purchaser, the purchaser's
employees or accredited agents, on an unlimited number of computers at the same
physical site location. This site location would normally be defined as a single
building, but could be considered to be a number of buildings within the same,
general, geographical location, such as an industrial estate or small town.

OTHER RIGHTS AND LIMITATIONS

You may not reverse engineer, decompile, or disassemble the SOFTWARE


PRODUCT, except and only to the extent that such activity is expressly permitted by
applicable law notwithstanding this limitation. Any such unauthorized use shall result
in immediate and automatic termination of this license and may result in criminal
and/or civil prosecution. All rights not expressly granted here are reserved by DB
Software Laboratory.

The SOFTWARE PRODUCT is licensed as a single product. Its component parts may
not be separated for use on more than one computer.

You may permanently transfer all of your rights under this EULA, provided the
recipient agrees to the terms of this EULA.

SEVERABILITY

In the event of invalidity of any provision of this license, the parties agree that such
invalidity shall not affect the validity of the remaining portions of this license.

COPYRIGHT

The SOFTWARE PRODUCT is protected by copyright laws and international treaty


provisions. All title and copyrights related to the SOFTWARE PRODUCT (including
but not limited to any images, photographs, animations, video, audio, music, text, and
"applets" incorporated into the SOFTWARE PRODUCT), the accompanying printed
materials, and any copies of the SOFTWARE PRODUCT are owned by DB Software
Laboratory.

MISCELLANEOUS

Should you have any questions concerning this EULA, or if you desire to contact the
author of this Software for any reason, please contact DB Software Laboratory (see
contact information at the top of this EULA).

DB Software Laboratory
69 of 70
Active Business Intelligence Portal User Manual

LIMITED WARRANTY

DB Software Laboratory expressly disclaims any warranty for the SOFTWARE


PRODUCT. The SOFTWARE PRODUCT and any related documentation is provided
"as is" without warranty of any kind, either express or implied, including, without
limitation, the implied warranties or merchantability, fitness for a particular purpose, or
no infringement. The entire risk arising out of use or performance of the SOFTWARE
PRODUCT remains with you.

In no event shall DB Software Laboratory be liable for any damages whatsoever or


refund any money (including, without limitation, damages for loss of business profits,
business interruption, loss of business information, or any other pecuniary loss)
arising out of the use of or inability to use this product, even if DB Software
Laboratory has been advised of the possibility of such damages. Because some
states/jurisdictions do not allow the exclusion or limitation of liability for consequential
or incidental damages, the above limitation may not apply to you.

ENTIRE AGREEMENT

This is the entire agreement between you and DB Software Laboratory which
supersedes any prior agreement or understanding, whether written or oral, relating to
the subject matter of this license.

Thank you for using the Active Business Intelligence Portal.


DB Software Laboratory
www.dbsoftlab.com
info@dbsoftlab.com

DB Software Laboratory
70 of 70

You might also like