practice optimizer® - sikka soft · practice optimizer® custom reports user guide sikka software...

Practice Optimizer®

Custom Reports

User Guide

Sikka Software Corporation 830 Hillview Court, Suite 290,

Milpitas, CA – 95035.

1 800 94 SIKKA

© 2004 - 2011 Sikka Software Corporation. All Rights Reserved.


© 2004 -2011 Sikka Software Corporation - 830 Hillview Court, Suite 290, Milpitas, CA – 95035. All Rights Reserved.

1 800 94 SIKKA

2

Custom Reports:

There are two features available in Custom Reports

● Build Your Own Query

● Custom Report Wizard

Build Your Own Query:

Build Your Own Query provides the user interface where you can see and

use all required tables and columns from the database. When using “Build

Your Own Query”, you get the ability to build your own queries and get all

the data needed.

To reach this feature, following is the path:

Go To Reports >> Custom Reports >> Build Your Own Query

Understanding „Build Your Own Query‟ user interface:

There are two user interfaces intended for novice and expert users

„Query Builder‟ for normal user

„Advanced User‟ for experts.

User can anytime switch between user types by simply clicking on „Main

Window‟ button and at top.



1 800 94 SIKKA

3

Query Builder:

In Build your own query, there are 4 panels as follows

Tables Shows names of all tables and containing

columns

Columns/

Grouping/

Sorting

All selected columns are displayed here

User can also add Grouping and Sorting

Conditions For Conditions

SQL Query Displays SQL Query built automatically

There are two ways to use Build Your Own Query:



1 800 94 SIKKA

4

Entering your own query or follow given procedure.

1. Adding Columns

2. Apply Grouping/Sorting

3. Add Conditions

4.

Adding Columns:

The following procedure is required to add columns:

1. In Columns Panel, Click on “[Click here to add new column]” button. It

will display a list of Tables.

2. Click on a table name. It will expand and show columns. 3. Click on Column name that you want. Newly added column has format

‘Actual Column Name’ As ‘Display Name’.

(By default Display name is same as that of column name)

4. Click on „Display Name‟ to edit it.

5. In Tables Panel, Select Columns Click on „Add To Columns‟

button icon to add multiple columns



1 800 94 SIKKA

5

Operations performed on Added Columns

1. Changing Selected Column:

6. From Columns panel, click on the „Actual Column Name‟ of the column

that you added previously. It will display a list of Tables and containing

columns.

7. Click on a table name. It will expand and show columns.

8. Click on Column name that you want.

2. Performing Operations on Columns:

9. Click on the icon at left side of column that you want to delete. It will

show options that can be performed on column.

10. Select required option.

3. Removing All Columns:

11. In Columns Panel, Click on „clear All Columns‟ button to remove all

added columns. It removes all selected columns.

4. Selecting Distinct/All:

12. In Columns Panel, Click on „all/distinct‟ button to switch between

distinct or all rows



1 800 94 SIKKA

6

Adding Grouping:

In Columns panel, click on „Grouping‟ button in right upper side to

open Grouping window. Click on [click here to add new group by field] to

add new Grouping column. Choose required column from drop down list.



1 800 94 SIKKA

7

Adding Sorting:

In Columns panel, click on „Sorting‟ button in right upper side to open

Sorting window. Click on [click here to add new sorting field] to add new

Sorting column. Choose required column from drop down list. In added list,

you can change sorting order from Ascending to Descending or delete

added sorting criteria.



1 800 94 SIKKA

8

Adding Conditions:

Following is the procedure to add columns to conditions

13. In Conditions Panel, click on “[Click here to add new condition]”

button. It will display a list of Tables with columns.


15. Click on Column name that you want. Newly added column has format

‘Actual Column Name’ Operator [Enter value].

(By default Operator is ‟starts with‟)

16. Click on „Operator‟ to edit it. Select required condition type from drop

down list. 17. Click on [Enter value] to edit value and hit enter key.

18. In Tables Panel, Select Columns Click on „Add To Conditions‟

button icon to add multiple conditions



1 800 94 SIKKA

9

Operations performed on Added Conditions

1. Changing Selected Column in Conditions:

1. From Conditions panel, click on the „Actual Column Name‟ of the

condition that you added previously. It will display a list of Tables and

containing columns.


3. Click on Column name that you want.

2. Performing operations on Conditions:

1. Click on the icon at left side of condition on which you want to perform

some task. It will show options that can be performed on column.

2. Select required option.

3. Changing between AND/OR:

In Conditions panel click on „all‟ to change between AND/OR.

Where all of the following

apply

Result is shown where all conditions are true.

(AND Operation)

Where any of the following

apply

Result is shown where any one condition is

true.

(OR Operation)

4. Removing All Conditions:

1. In Conditions Panel, Click on „Clear All conditions‟ button to remove all

added conditions.



1 800 94 SIKKA

10

Executing Query:

Whenever user performs any operation, SQL query is automatically

generated and showed in the „Build SQL‟ panel. Still if user wishes to

regenerate SQL query for columns and conditions that he applied, he can

click on „Refresh Query‟ button.

Click on „Show Result‟ button to display result.

Writing Own SQL Statements:

User can write his own SQL query in panel „Build SQL‟. And click on „Show

Result‟ button to display result. User is allowed to fire only ‟SELECT‟ type of

queries. He can refer database structure from Tables panel.

Note: Do not click on „Refresh Query‟ button. It may clear your SQL

statements.



1 800 94 SIKKA

11

Advanced User Interface

In Advanced User interface, user can write his own queries and get result

by clicking on „Show Result‟ button.



1 800 94 SIKKA

12

Save Query:

User can save queries from either „Query Builder‟ or „Advanced User

interface‟. Give report a name and enter description about report and click

on Save button. User can view his saved reports by clicking on ‟Saved

Queries‟ button at top right corner.



1 800 94 SIKKA

13

User can perform following tasks on saved queries.

● Delete saved query

● Display result of saved report

● Edit query



1 800 94 SIKKA

14

Editing Saved Queries:

In „Options‟ column, click on „Edit‟ button. It will open „Advanced User'

interface. Make your changes and click on „Save Now‟ button to save

changes. Otherwise you can discard by clicking on „Discard Changes‟

button.



1 800 94 SIKKA

15

General Error Messages and Meanings:

Following table gives explanation of various error messages appearing in

„Build Your Own Query‟.

Sr. No. Error Message Meaning

1 Unable to connect database Application could not load your

data.

2 Error: Please Select at least one column You are attempting to add 0

columns

3 Error: Select columns and/or conditions OR Enter your own

query

Query is empty

4 Error: Enter proper value for condition Condition must have some value

5 Error: A fatal Error occurred Tables not found

6 Please enter query first. Attempting to view result for null

query

7 Only SELECT Queries are allowed. No permissions to alter database.

8 A Fatal error occurred. Result cannot be displayed Tables not found

9 An Error occurred while loading Build your own query.

Please reload application

Connection lost with Server



1 800 94 SIKKA

16

Custom Report Wizard:

„Custom Report Wizard‟ gives you freedom to generate a patient based

report of user choice. User can select desired columns and apply conditions

from various categories that user wants.

You can reach to Custom Report Wizard as follows.

Go To Reports >> Custom Reports >> Custom Report Wizard

Understanding „Custom Report Wizard‟ user interface

In Custom Report Wizard, user can perform following three options.

Create New

Report

User can create a new report based on conditions of

his choice.

Run Existing

report

Shows saved reports. User can perform tasks like

display result, delete, saved report or schedule it.

Schedule report Displays scheduled reports or User can schedule new

report.

There is a Recent Reports panel in right side where recently saved reports

are displayed.



1 800 94 SIKKA

17

2. Creating New Report:

To start with building own report you have to follow a three step process

Step1: Select Task

Click on „Create New Report‟ to build a new report on welcome window of

wizard.

Step2: Select Fields

In this step, user can add columns to his report. In left side, there are

various categories in which interrelated columns are grouped and are

displayed in right side panel accordingly. The yellow panel in bottom shows

selected fields.

● Click on required category. It will display columns.

● From Columns, Select desired columns. As user goes on selecting

columns (fields), selected fields get added in panel at bottom side.



1 800 94 SIKKA

18

● Click on „Next‟ button to proceed.

● User can clear all selected columns by clicking on button „Clear All

Fields‟.

Note: Adding Special Columns - In „Others‟ category, if user selects fields

like Transaction Details/Appointment Details/Payment Details/Treatment

Plan Details, a separate tab gets added in result for each selection.

Step3: Select Conditions

User can apply his conditions in this step. If you don‟t want to add any

condition, you can directly click on „Show Result‟ button to display data. To

apply conditions, follow procedure given below.

● Select AND/OR (Try various combinations of conditions to understand this better). ● Select Category from dropdown list ● Select appropriate field (changes according to selected category) on which you want

to apply condition ● Choose condition type (changes according to selected field).



1 800 94 SIKKA

19

● Enter/Choose value for the field ● Click on ‘Apply Condition’ button.

User can repeat the above procedure to add more conditions.

Following are some operations that user can perform on added conditions

● Click on icon in condition to delete added condition. ● User can uncheck the checkbox in ‘Select’ column if he wants to keep condition but

doesn’t want this condition to be considered in current query. ● ‘Show/Hide My Query’ button display the Custom Query built for added fields and

conditions. ● By clicking on ‘Clear All Conditions’, user can remove all added conditions. ● Click on ‘Show Result’ button to display Results.

Note: Adding Practice ID Condition – Choose Category „Others‟, Select field

„Practice ID‟ and select required practices from dropdown list. Click on

„Apply Condition‟ button.



1 800 94 SIKKA

20

Save / Schedule Report:

From Step 3 Click on „Save Report‟ or „Schedule Report‟ to store report for

future use. Give report a name and enter description about report. For

scheduling, select checkbox „I want to schedule my custom report‟ and

enter proper parameters. And Click on Save/ Schedule button.

User can view his saved reports by going from Step 1 to „Run Existing

Report‟.

He can perform following tasks.

● Delete saved report

● Display result of saved report

● Schedule report



1 800 94 SIKKA

21



1 800 94 SIKKA

22

User can view his scheduled reports by going from Step 1 to „Schedule

Report‟.

He can perform following tasks.

● Delete scheduled report

● Display result of scheduled report

● Update Schedule

practice optimizer® - sikka soft · practice optimizer® custom reports user guide sikka software...

Documents