Documente Academic
Documente Profesional
Documente Cultură
Tutorial
In this tutorial you will learn how to create a business domain, and generate some reports.
This tutorial is based on the popular Microsoft Access demonstration database: Northwind.
All the concepts behind Ariacom Business Reports® are described in the Product Description document.
The last version of the product is available at http://www.ariacom.com.
Additional information can be found at the Ariacom Business Reports Forum.
Requirements To complete this tutorial, you must first install Ariacom Business Reports®
Free available from http://www.ariacom.com/brfree.exe. This setup
installs also the Microsoft Access demonstration database
Northwind.mdb.
Tutorial Scenario The database contains the sales data for a fictitious company called
Northwind Traders, which imports and exports speciality foods from all
around the world. The management department wants to draw up reports
and statistics on the product sales. The tutorial has three sections:
Business Domain Creation
Business Report Creation
Advanced Features
Northwind Database Basically, the Northwind database involves Products, Orders, Customers
and Employees. See the Entity-Relationship Diagram below for more
information on the Northwind database.
In this section, you will learn how to create your first Business Domain.
A business domain is a set of data used to edit and execute reports. It is an abstraction layer for the
database, turning raw data in Dimensions and Elements (Business Entities). It contains the following
information:
1. target database description (table description, report elements, report types and templates),
2. users, security and public folders,
3. translations for multilingual support,
A business domain is stored in a dedicated (*.bdo) file or directly into a database (SQLServer or Oracle
only).
Start the tutorial by using the Business Domain Wizard
The Business Domain Tutorial has now been created and contains four tables.
Continue to Define foreign keys.
Foreign keys define relationships between tables of your database (e.g. a supplier has several products,
an order has several order details).
They consist of a simple SQL join that is applied when 2 tables are used for a query.
1. If you are not already using the Business Domain Manager, go to the "Start" menu, point to
"Programs, Ariacom Business Reports" and then click "Business Domain Manager",
2. On the "File" menu, click "Open" and browse to the "Tutorial.bdo" file, then click "Open",
3. The "Domain login dialog box" appears,
4. In the "User Name box", type "su" (the administrator user name) and click "OK". The business
domain is open,
5. In the left tree view, expand the node "Tutorial/Metadata/Databases/Database of
Tutorial/Tables/Order Details" and select the node "Foreign Keys",
12. Create a new join for the "Order Details" table with the parent table "Products" and the Join
Clause ""Order Details".ProductID=Products.ProductID"
13. Create a new join for the "Products" table with the parent table "Suppliers" and the Join Clause
"Products.SupplierID=Suppliers.SupplierID"
14. On the "File" menu, click "Save" (or Ctrl+S) and save the "Tutorial.bdo" file on the disk.
The joins have now been defined between the Order, Order Details, Products and Suppliers tables.
Continue to Define Enumerated Lists
6. Right-click "Enumerated lists" and then select "New enumerated list". A new enumerated
list appears in the right panel,
7. In the "Enumerated list name" box, type "Product Categories",
8. Check the "List is loaded dynamically from the database" box,
9. Check the "List refreshed upon database connection" box,
10. In the "SQL Statement for dynamic list" box, type the following SQL statement:
11. In the "Display format for retrieved values" box, type "%2s",
12. Click "Show/Edit Values" and check the display values of the product categories. Click "OK",
14. In the "Definition" tab, select "Product Categories" in the "Enumerated list" list,
15. Uncheck the "Element is nullable" box,
16. Select the "Format" tab. In the "Element Name box", type "Product Category"
17. On the "File" menu, click "Save" (or Ctrl+S) and save the "Tutorial.bdo" file on the disk.
An enumerated list has been created for the product categories.
Continue to Define and Create Dimension Elements
An element describes a column in a table and how it is displayed in the report result.
Steps to define dimension elements are listed below:
If you are not already using the Business Domain Manager, go to the "Start" menu, point to
"Programs, Ariacom Business Reports" and then click "Business Domain Manager",
On the "File" menu, click "Open" and browse to the "Tutorial.bdo" file then click "Open",
In the "User Name" box, type "su" and click "OK". The business domain is open,
Right-click "Elements" and then select "New element". The "Select Column" dialog box appears,
Check "User defined column" and then click "OK",
The "Select Report Types" dialog box appears,
Check "Default Report Type" and then click "OK". The new element detail appears in the right
panel,
In the "Column Name" box, type
DatePart('yyyy',[OrderDate],1,0)
Element Definition
On the "File" menu, click "Save" (or Ctrl+S) and save the "Tutorial.bdo" file on the disk.
A new element representing the order years has been created.
Continue to Define and Create Measure Elements
"$ "#,##0.##
23. On the "File" menu, click "Save" (or Ctrl+S) and save the "Tutorial.bdo" file on the disk.
Two measures representing the Quantities and the Amounts have been defined.
Continue to Create Output Devices
Output devices allow generating reports in folders, sending reports via emails or FAX, to printers, or FTP
servers.
1. On the "Start" menu, point to "Programs, Ariacom Business Reports" and then click
"Business Domain Manager",
2. On the "File" menu, click "Open" and browse to the "Tutorial.bdo" file then click "Open",
3. The "Domain login" dialog box appears,
4. In the "User Name" box, type "su" and click "OK". The business domain is open,
5. In the left tree view, expand the node "Tutorial" and select the node "Output Devices",
10. If you have an Email server (SMTP), right-click "Output Devices" and then select "New Output
Device",
11. The "Add New Output Device" dialog box appears,
12. In the "Device Type" list, select "Email" then click "OK". A new output device appears in the right
panel,
13. In the "Name" box, type "EMail",
14. In the "SMTP Server" box, type the SMTP server name of your company,
15. In the "Sender Email Address" box, type a generic email address that will be used to send
reports,
16. On the "File" menu, click "Save" (or Ctrl+S) and save the "Tutorial.bdo" file on the disk.
A report type defines a set of the elements (e.g. a report type named "Orders" can be created to
contain only elements concerning orders and customers).
When a report is created with a given report type, only elements contained in the report type are
available in the report.
Functional rights can be applied to report types (e.g. only sales department can create reports of type
"Orders").
1. On the "Start" menu, point to" Programs, Ariacom Business Reports" and then click
"Business Domain Manager",
2. On the "File" menu, click "Open" and browse to the "Tutorial.bdo" file then click "Open",
3. The "Domain Login" dialog box appears,
4. In the "User Name" box, type "su" and click "OK". The business domain is open,
5. In the left tree view, expand the node "Tutorial/Metadata/Report Types" and select the node
"Default Report Type". The "Report Type Detail" appears in the right panel,
6. Right-click "Report Types" node and then select "New Report Type",
7. An information dialog box appears, about "Free SQL Reports". Click "No". A new report type detail
appears in the right panel,
12. The Products report type contains elements of the "Products" and "Suppliers" categories,
13. On the "File" menu, click "Save" (or Ctrl+S) and save the "Tutorial.bdo" file on the disk.
A new report type for product elements has been added to the business domain.
Continue to Report Creation.
Reports creation
In this section you will learn how to create and execute reports based on the Business Domain previously
created.
Reports or report definitions are stored in ("*.bre") files or directly in a database containing the
business domain repository.
Once executed, the user obtains a report result.
A report is composed of:
A title,
A report type. This defines which report elements are available to define the report,
A report template to define the report result format,
Before reading further, please note that the "Report Editor" is composed by 4 panels, in order from
left to right and top to bottom:
The Available Elements panel (top left)
See the image below to locate each panel and each container.
5. Click on the "New Report" icon (top-left in the toolbar ), type "Ins",
6. The "Report Editor" dialog appears,
7. In the "Report Name" box, type "Product sales" and click "Next",
8. In the Available Elements panel, expand the "Orders" node, then drag the "Order Year" element
and drop it in the "Page" container of the Selected Elements panel,
9. In the Available Elements panel, expand the "Products" node, then drag the "Product
Category" element and drop it in the Column container of the Selected Elements panel,
10. Right-click "Product Category" in the Selected Elements panel and then select "Sort
Ascending",
11. In the Available Elements panel, expand the "Suppliers" node, then drag the "Country" element
The Selected Elements panel should now look like the previous image.
16. Click Close. The Report Editor dialog appears. Let's improve the report by adding the totals for rows
and columns:
17. Double-click "Sum of Amount" in the Selected Elements panel,
18. Options for the "Sum of Amount" dialog appear,
19. In the "show total sum" list, select "For rows and columns". Click "OK",
20. Click "Execute". Check that the total sum have been added for each row and column of the data
table,
21. Click "Close",
22. The "Report Editor" dialog appears,
23. Click "Save".
The report is saved in the repository, and the "Product Sales" report is displayed in the file list.
A first analytic report on sales has been created.
Continue to Add charts to the report.
Selected restrictions
Output Definition
11. Click "Execute", an information dialog box appears. The report is generated in the folder specified
by the output device,
12. Click "OK",
13. On the right of the "Schedule Name" box, click "New",
14. The "Edit Schedule" dialog box appears,
15. In the "Schedule Name" box, type "Schedule1",
16. In the "Schedule Type" group box, select "Regularly", information for the schedule appears,
17. In the "Schedule Regularly" group box, type "1" in the "Every … minutes" box,
Edit Schedule
Even if Business Reports is very powerful in avoiding the use of SQL statements, you may sometimes need
to use SQL statements.
Reports of type Free SQL allows the end-user to enter directly his SQL statements.
1. On the "Start" menu, point to "Programs, Ariacom Business Reports" and then click
"Report Manager",
2. In the left tree view, expand the node "Tutorial",
3. The "Domain Login" dialog box appears,
4. In the "User Name" box, type "su" and click "OK",
5. Select the node "Published",
6. Click on the "New Report" icon (top-left in the toolbar ), type "Ins", the "Report
Editor" dialog appears,
7. In the "Report Type" list select "Free SQL Report" type,
8. In the "Report Name" box, type "Employee Search" and click "Next",
9. In the Select "SQL Statement" box, type the following SQL statement:
15. Click "Execute", the report is executed and a restriction on the "Employee Name" is prompted,
16. Type "an", and a list of employees containing "an" in their name is displayed,
If the Ariacom Business Reports Excel Add-In is installed, an Excel document can be used to contain
several Business Reports.
Note that a demonstration Excel document "AddInDemonstationReport.xls" containing several
business reports can be found in your installation directory.
1. Open a new or an existing Excel document,
2. Select the cell on which the new report will be inserted,
3. In the "Ariacom" menu, click on "Edit report",
4. The "Domain Login" dialog box appears,
5. Select the "Tutorial" Business Domain
6. In the User Name box, type "su" and click "OK",
7. An information dialog box appears to create a new report at the current cell. Click "Yes", the
"Report Editor" dialog appears,
8. In the Available Elements panel, expand the "Orders" node, then drag the "Order Year" element
and drop it in the "Page" container of the Selected Elements panel,
9. In the Available Elements panel, expand the "Products" node, then drag the "Product
Category" element and drop it in the Column container of the Selected Elements panel,
10. Right-click "Product Category" in the Selected Elements panel and then select "Sort
Ascending",
11. In the Available Elements panel, expand the "Suppliers" node, then drag the "Country" element
and drop it in the "Row" container of the Selected Elements panel,
12. Right-click "Country" in the Selected Elements panel and then select "Sort Ascending",
13. In the Available Elements panel, expand the "Order Details" node, then drag the "Amount"
element and drop it in the "Data" container of the Selected Elements panel,
The Selected Elements panel should now look like the previous image.
Selected restrictions
Advanced Features
This section describes the use of advanced features of Ariacom Business Reports:
1. Drill-Down - Going deeper into data aggregations.
2. User Management - Using functional rights and restrictions at run-time.
3. Cascade Report - running another report from an element.
4. Publish reports on the Web using the Web Report Server.
10. On the "File" menu, click "Save" and save the "Tutorial.bdo" file on the disk,
11. Type "F6" to open the "Report Manager",
12. Click on the "Published" node. The list of files appears,
13. Double Click on the "Product Sales" report,
14. In the report result, click on one of the blue triangles of a given category.
The (same) report is executed again, but product categories have been changed to product names, and a
restriction is placed on a product category. This is a way to go deeper in the aggregation.
A drill navigation has been defined between product categories and names.
Continue to Add a new user and define security
Steps to add a new user and define security are listed below:
1. On the "Start" menu, point to "Programs, Ariacom Business Reports" and then click
"Business Domain Manager",
2. On the "File" menu, click "Open" and browse to the "Tutorial.bdo" file then click "Open",
3. The "Domain Login" dialog box appears,
4. In the "User Name" box, type "su" and click "OK", the business domain is open,
5. In the left tree view, expand the nodes "Tutorial/Security/User Groups" and select the node
"Guests", the user group detail appears in the right panel,
6. Right-click "Guests" node and then select "New user", the user detail appears in the right panel,
7. In the "User Name" box, type "smith",
8. Click "Rights per Folder",
9. The "Right Selection" dialog box appears,
10. Check the boxes "Personal/Edit" and "Published/Execute" then click "OK",
20. The Selected Restrictions panel contains restrictions on the product categories,
21. Click "Done",
22. On the "File" menu, click "Save" and save the "Tutorial.bdo" file on the disk,
23. On the "Start" menu, point to "Programs, Ariacom Business Reports" and then click
"Report Manager",
24. Expand the "Tutorial" node,
25. The "Domain Login" dialog box appears,
26. In the "User Name" box, type "smith" and click "OK",
27. Click on the "Published" node and execute the "Product Sales" report, the report is executed
with security restrictions and cannot be edited,
28. Click on the "smith (personal)" node
29. Create a new report: only the "Products" report type is proposed and the report outputs and
schedules cannot be created.
A new user has been added to the domain:
The user has the right to execute reports of type "Statistics",
The user has the right to execute and edit reports of type "Products",
The user has the right to execute and edit reports in his "Personal" folder and to execute reports in
the "Published" folder.
The user can get information only on the products of the categories "Beverages, Condiments,
Confections" (security restrictions are applied dynamically).
Continue to Create a cascade report for suppliers (master-detail consultation)
5. Click on the "New Report" icon (top-left in the toolbar ), type "Ins",
6. In the "Report Name" box, type "Supplier Details" and click "Next",
7. In the Available Elements panel, expand the "Suppliers" node, then drag the "CompanyName,
ContactTitle, ContactName, Phone, Fax elements" and drop them in the Page container
of the Selected Elements panel,
8. In the Available Elements panel, expand the "Suppliers" node, then drag the "Address, City,
Country, Region, PostalCode" elements and drop them in the Row container of the Selected
Elements panel,
9. Click "SupplierID" in the Available Elements panel,
10. Check the "Prompt at Run-Time" box for "SupplierID" in the Restrictions panel,
11. Click ">". The Selected Restrictions panel contains the restriction "SupplierID=?",
12. Click "Next". The Report Options panel is displayed,
13. Check the "Hide table of contents" box,
14. Check the "Hide report restrictions" box,
15. Check the "Hide security restrictions" box,
16. Click "Execute". The "Enter Run-Time Restrictions" dialog box appears,
17. In the "SupplierID" box, type "10". Click "OK". Details of a supplier are then displayed,
18. Click "Close". The Report Editor dialog appears,
19. Click "Save". The report is saved in the repository.
7. In the left tree view, expand the nodes "Tutorial/Published" and double click on "Supplier
Details" in the list,
15. On the "File" menu, click "Save" and save the "Tutorial.bdo" file on the disk,
16. Type "F6" to open the "Report Manager",
17. Select the node "Published",
18. Click on the "New Report" icon (top-left in the toolbar ), type "Ins",
19. In the "Report Name" box, type "Test Cascade" and click "Next",
20. In the Available Elements panel, expand the "Suppliers" node, then drag the "Company Name"
element and drop it in the Row container of the Selected Elements panel,
21. Click "Execute". The list of supplier's company names is displayed in the report,
22. Click on a company name in the list. The "Supplier Details" report is executed with the selected
restriction,
23. Click "Close" then "Save". Cascade report can be executed when the supplier company name
element is selected in a report.
In case of problems, please consult the Install Guide for more information.
Additional information can also be found at the Ariacom Business Reports Forum (Forum
General/Installation).