The Scoop™ for TBS PDF Owner`s Manual

The Scoop™ for TBS PDF Owner`s Manual
Owner’s Manual
Another fine product from:
655 N. LaGrange Rd., Suite 209
Frankfort, IL 60423-2913
800-746-9364
815-806-2130
This manual was produced using ComponentOne Doc-To-Help.™
Contents
Welcome
1
Introduction to The Scoop™..................................................................................................................1
Copyright and License.............................................................................................................................1
Getting Started
6
What You need to Have ..........................................................................................................................6
How to Install ............................................................................................................................................6
Installing from the Internet .....................................................................................................6
Installing from the CD .............................................................................................................6
When to reinstall and when not to reinstall..........................................................................6
Program Registration / Activation.........................................................................................................6
Why we make you use an activation code...........................................................................6
How to Activate The Scoop™ ...............................................................................................7
Using The Scoop™
8
Running The Scoop™ the First Time ...................................................................................................8
General Report Design Guidelines
10
The Report Expert ..................................................................................................................................10
Parts of a Report .....................................................................................................................................11
Bands........................................................................................................................................11
Fields and other Elements of the Report ............................................................................11
Report Elements......................................................................................................................13
The Report Editor Window...................................................................................................................14
Datasets – Where you get the information.........................................................................................17
Report Elements Described ..................................................................................................................20
Bands........................................................................................................................................20
SubDetail Band.......................................................................................................................21
Group Bands............................................................................................................................22
Child Bands.............................................................................................................................23
Data Fields...............................................................................................................................24
Labels .......................................................................................................................................25
Memos......................................................................................................................................26
Images ......................................................................................................................................26
Image from Data Field ...........................................................................................................26
Expressions..............................................................................................................................27
Shapes.......................................................................................................................................28
System Fields ..........................................................................................................................28
Rich Text Field .......................................................................................................................29
Rich Text from data field ......................................................................................................30
Advanced Concepts
Owner's Manual: The Scoop™ for TBS
31
Contents • iii
Introduction.............................................................................................................................................31
Field Formatting .....................................................................................................................................31
Expression Syntax..................................................................................................................................35
Scripting with The Scoop™ .................................................................................................................38
Syntax of The Scripting Language......................................................................................39
Variables in Event Scripts.....................................................................................................41
Script Expression Functions .................................................................................................42
Trouble-Shooting Guide
45
Introduction.............................................................................................................................................45
Figuring Things Out when There’s a Problem..................................................................................45
What to Check.........................................................................................................................45
Information to have ready for Technical Support .............................................................45
Warranty Procedure ...............................................................................................................45
Contacting Us for Support ....................................................................................................................46
Internet......................................................................................................................................46
FAX ..........................................................................................................................................46
Telephone Product Support *...............................................................................................46
iv • Contents
Glossary of Terms
49
Index
51
Owner's Manual: The Scoop™ for TBS
Welcome
Introduction to The Scoop™
Welcome to the User’s Manual for The Scoop™ by Man’s Best Friend Software.
The Scoop™ is designed to work with The Breeder’s Standard™, our dog pedigree
and kennel management flagship program.
What The Scoop™ gives you is pure power when it comes to reports. You can
easily create powerful reports, using any of the data stored in your licensed copy of
The Breeder’s Standard™.
The Scoop™ is designed to work with any of the following programs:
•
The Breeder’s Standard™ 2001
•
The Breeder’s Standard™ 2002
•
The Breeder’s Standard™ 2003
•
The Breeder’s Standard™ 2005
•
The Breeder’s Standard™ 2006
If you have the latest edition of The Breeder’s Standard™ 2006, you will find that
the newer data included in these programs, such as DNA information and
GreenShade™ will be available, if not, these fields will be blank and the tables will
not show up. If you upgrade your program to TBS 2006, this data will be available.
This manual is designed to tell you how to install and operate The Scoop™, and
gives you general guidelines on using The Scoop™ to create reports.
Man’s Best Friend Software does not train people in understanding how to set
up reports, basic or advanced reporting concepts or Structured Query
Language(SQL). You are expected to learn these things yourself, or to be
proficient in SQL before you try using it in The Scoop.
Copyright and License
This manual and the software discussed herein is Copyright © 2005 by Man's Best
Friend Software All Rights Reserved. No part of this manual or the software it
discusses may be duplicated for any reason or by any means, whether or not
mechanical, under any circumstance prohibited by law or the herein-captioned
license agreement. No employee (other than the Owner) of Man's Best Friend
Owner's Manual: The Scoop™ for TBS
Welcome • 1
Software is empowered to grant permission to copy contrary to this notice.
Unauthorized copying is a violation of Federal Copyright laws and will be
prosecuted accordingly.
The Software discussed in this manual is also governed by the terms of a license
agreement. No use of the software is permitted without complete agreement to all
terms set forth in the License. Opening the envelope containing the program
diskettes, or any other use of the software covered in this manual shall be deemed
complete acceptance of the license agreement covering the Software. A copy of the
License Agreement appears here in this manual, and also in the install program
which places The Scoop™ onto your computer, and you must indicate acceptance of
the agreement in order to install or use The Scoop™.
License Agreement
In consideration of the license purchase price of The Scoop™ software product (the “Software”), Man's
Best Friend Software (the “Company”) grants you a conditional, limited and non-exclusive license to use
the Software. IF YOU DO NOT AGREE TO ALL OF THE TERMS LISTED ON THIS LICENSE, DO
NOT OPEN THE ENVELOPE CONTAINING THE PROGRAM DISK(S) OR OTHERWISE INSTALL
OR USE THE SOFTWARE ON YOUR COMPUTER. OPENING THE ENVELOPE OR INSTALLING
ANY COPY OF THE SOFTWARE WILL BE CONSIDERED ABSOLUTE EVIDENCE THAT YOU
HAVE ACCEPTED EVERY TERM AND CONDITION OF THIS LICENSE WITHOUT OBJECTION
OR RESERVATION.
IF YOU DO NOT ACCEPT EVERY TERM AND CONDITION OF THIS LICENSE AS WRITTEN
HEREIN, YOUR LICENSE TO USE THE SOFTWARE IS REVOKED AND YOU MUST RETURN
THIS SOFTWARE, WITH THE ENVELOPE UNOPENED, TO THE POINT OF PURCHASE FOR A
FULL REFUND, LESS SHIPPPING FEES. THIS LICENSE IS A BINDING AGREEMENT, AND
CONTAINS LIMITATIONS OF LIABILITY AND IMPOSES OBLIGATIONS UPON YOU. READ
CAREFULLY BEFORE OPENING THE DISK ENVELOPE OR INSTALLING.
License Terms and Conditions
You acknowledge that the Software, manuals, this license, and all other materials are Copyright © 19912005 by Man's Best Friend Software. All Rights Reserved. You understand that ownership of the
Software itself at all times remains with the Company, and that this license grants you no ownership rights
whatsoever to the Software, either now or in the future. You also acknowledge and agree that such
copyright allows Company to require you to agree to all of the terms of this agreement, and you
voluntarily accept all of these terms. This license governs all aspects of the transaction between you and
Company, and not just the terms under which you may use the Software. This license supersedes any
license agreement that may bind you with respect to a previous version of the Software, or any other
Product we may produce, and the terms herein set forth govern your use of all versions of the software
from the time this license becomes effective.
You acknowledge that you have read all of the terms and conditions herein, and by opening the envelope
containing the program disk(s), you agree to them all. You agree that any of the following acts: 1)
Opening the envelope containing the program disk(s) with the Software; 2) Installing a full or trial copy of
the Program on any computer you own or have use of (whether or not that use is authorized); 3)
Receiving, either in written form or by electronic means, any codes capable of activating the program; or
4) placing and tendering payment for (whether or not the payment is negotiable for any reason), executes
this contract with the same force and effect as your signature witnessed by a Notary Public. In any dispute
that may arise, it shall be conclusive proof that you have read and assented to the entirety of this
agreement, of your own volition, if any of the acts mentioned in this paragraph have transpired.
You agree that this License is a binding contract, and you also agree to abide by every term and condition
herein. You agree that, in the event that you violate any term or condition contained herein, your license
will be permanently revoked (without any compensation due or owing to you) and that you will be liable
for any and all applicable damages set forth herein, plus any penalties or damages allowed by law.
You agree that this document represents the entire agreement between you and Company. You
acknowledge that no employee, agent, assign, dealer or distributor of the Company has the right to
change, add or delete any provisions of this license and expressly confess that any and all verbal or written
statements not in this license are not binding upon the Company in any way and are invalid and without
value. You understand and agree that this contract is the final arbiter of both Company’s and your rights
and responsibilities under this contract.
No modification to this contract shall be valid unless signed IN ORIGINAL by both you and the chief
executive officer or owner of Company, and witnessed by a Notary Public. Nothing in this clause shall be
interpreted to state that Company may not unilaterally alter this license for any future versions of the
Software, or that the terms of this agreement shall apply to any other product you buy from Company.
2 • Welcome
Owner's Manual: The Scoop™ for TBS
This Software is protected by a registration / activation code. The software will not function until and
unless this activation code is properly entered. However, the mere fact that you may have received
activation codes pursuant to a purchase and failed to enter them into the Software shall not transform any
sale into an evaluation or otherwise make this sale contingent or in any way not final.
This software is made fully active and permanent using registration code(s) provided to you by Company
upon payment of the purchase price in effect at the time, and your complete assent to these terms. You
agree that these codes are confidential, for your use only, and you shall never make them available to any
other party.
Once payment has been tendered to the Company for the Program, all sales are irrevocably final. If
registration code(s) have been provided to you, it shall be irrevocably deemed that you have used these
codes to activate the Program, and the sale may not be reversed for any reason.
You agree to load and/or use the registered version of Software on only one computer at a time. You are
allowed to have backup copies of the Software to protect yourself from data loss. Once purchased, you
may install the software and use the registration code(s) to activate it on up to three computers that you
own, lease or lawfully may install such software upon, provided that no more than one of these computers
shall be running the Software simultaneously.
You agree not to loan the registered Software to any party, nor may you rent, lease or sublease it to
anyone. You agree never to copy the registered software for the benefit of any other party for any reason.
You agree never to make any copies of the printed Manuals for any reason.
If you sell or give away the registered Software, you must destroy every backup copy of the Software, and
you agree to do so. You must notify the Company in writing within three (3) business days of such a sale
or transfer, and must provide the name and address of the actual purchaser or receiver of the Software.
Once you sell or transfer the Software, you may not buy back or receive back the Software for a period of
three (3) years, and you agree to this condition (However, you may of course purchase another copy of the
software from Company or any authorized dealer at any time). You may not use somebody else's copy of
the Software to access records or files made by your copy.
As soon as you sell the Software, you lose your license rights and all rights to use the Software. However,
clauses in the License which restrict you from infringing Company’s rights to its copyright, trade dress or
patents (granted or pending) still apply and you agree that these terms will survive your loss of rights
under this license, perpetually.
You may not sell give other otherwise transfer or provide the Software to any party which produces a
software product that competes with the Software, to any employee, agent, assign, owner, shareholder,
affiliate or any party with any kind of a relationship with such a person or company, or to any party which
contemplates producing a product that competes with the Software. These same restrictions apply to
parties who intend to produce any product or products which rely on the databases produced by the
Software for any function whatsoever.
You agree that you will not attempt to reverse-engineer or disassemble the Software or attempt to do so at
any time. You agree not to change any portion of the Software, including, but not limited to, icons, dialog
windows, error messages, menus, string tables and the serial number(s) as embedded in various portions
of the Software. You agree that such a change, in addition to being a material violation of this license
agreement, is a violation of Federal Copyright and Trade Secret laws, and constitutes a crime.
You understand that the software employs various devices and algorithms designed to prevent
infringements of Company’s copyright by preventing the illegal use or copying of the Software. You
agree not to remove, attempt to remove, defeat, attempt to defeat, circumvent, attempt to circumvent or
cause any party to attempt to remove or defeat or circumvent these mechanisms for any reason
whatsoever. You agree that any act in violation of this clause damages Company in an amount which is
impossible to determine, and therefore shall be responsible to pay Company, as liquidated damages, and
not as a penalty the sum of FIVE HUNDRED THOUSAND DOLLARS ($500,000.00) per offense for any
violation of this clause.
You agree that you will not disclose to any party the layout, contents or structure of the database files
created or used by the Software. You agree that you will not devise any program or programs, algorithm,
script or method that will convert the data in the databases of the Software to any format directly or
indirectly acceptable to any product that competes with the Software.
You agree that you will not create or offer for commercial sale any "add-on" product that uses these
databases for sale without the express advance written permission of the Company. Such permission may,
at Company's sole discretion, be in the form of a Developer's License, which you agree would at the sole
discretion of Company require the payment of additional fees.
You agree that Company has no obligation to issue you or any other party a Developer's License, and that
no part of this License Agreement shall serve to impose such an obligation upon the Company, or entitle
you to damages if Company refuses to grant a developer’s license.
You agree that, since it is impossible to determine the effect of any violation of the above terms, that you
will be liable for ONE HUNDRED THOUSAND DOLLARS ($100,000.00) for each individual violation
Owner's Manual: The Scoop™ for TBS
Welcome • 3
of the copy, lease and loan provisions above, all as liquidated damages and not as a penalty. You agree
that, if you violate this license in any way, that Company may at its sole discretion seek additional
penalties and damages as permitted by law.
If you are a corporation, you agree that any corporate indemnification, explicit or statutory, against any
and all officers, employees or owners of you (the corporation) is waived, and the person(s) opening the
envelope and/or using the software jointly and severally agree to be personally bound by this agreement.
You agree that any judgment or arbitration award obtained against you for violating this license is a
finding of fraud, confess such fraud, agree that such a judgment is fair, proper and not dischargeable or
modifiable in any proceeding under the United States Bankruptcy Code, and agree to waive the right to
notice, response or contest of any motion by Company or its attorneys to lift a stay so imposed against it.
You agree that you purchase this software "AS IS". You also agree that the only warranty provided is as
follows: for a period of not more than THIRTY (30) DAYS after you purchase the software, the program
disk(s) upon which the software is delivered to you will be free from defects in material or workmanship.
Your sole remedy in a warranty claim is replacement of the defective disk(s). This warranty is not
transferable and does not apply to software which is downloaded from the Internet.
You agree that report or any number produced by the Software is produced as an informational tool only.
Company does not represent that the Software is able to accurately predict the outcome of any mating, and
you acknowledge and agree that it is impossible to do so.
You agree to hold Company harmless as to the results of any mating in which you consult the Software or
reports generated therefrom in determining whether or not to actually effectuate the mating. If you use the
Software on the behalf of another party, or permit another party to use the Software while on your
computer, you agree to indemnify and hold Company harmless for the results obtained by that party.
NO OTHER WARRANTY IS PROVIDED. COMPANY DISCLAIMS ALL OTHER WARRANTIES,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. COMPANY IS NOT RESPONSIBLE FOR ANY INCIDENTIAL
OR CONSEQUENTIAL DAMAGES SUSTAINED BY YOU OR ANY OTHER PARTY AS A RESULT
OF USING OR POSSESSING THE SOFTWARE, EVEN OF COMPANY HAS BEEN NOTIFIED OF
THE POSSIBILITY OF SUCH DAMAGES.
THIS SOFTWARE IS BUSINESS SOFTWARE, USED IN THE BUSINESS OF MANAGING A
KENNEL. YOU AGREE THAT THIS SOFTWARE HAS ABSOLUTELY NO PERSONAL OR
HOUSEHOLD USE WHATSOEVER, AND THAT THE CONSUMER PROTECTION LAWS OF THE
UNITED STATES, OR OF ANY STATE, ARE INAPPLICABLE TO THIS TRANSACTION.
You waive and abandon any and all warranty rights under the law that may be available to you and exceed
the scope of the above warranty.
You agree that, in the event of a warranty claim not herein waived, or held non-waivable by an arbitrator
or court of law with proper jurisdiction to enforce this agreement, that Company's complete liability will
extend to no more than the actual price paid by you for the Software, EXCLUDING any shipping and
handling charge. You agree to hold Company harmless for any claim of any kind with respect to the
Software, its manual(s), warrant(ies) or operation.
You understand and agree that the availability and delivery of “support” is not included in the purchase
price of the program, and that any support services offered or rendered free of charge may be terminated
or made available only for a fee at any time.
“Support” includes, but is not limited to, assistance with installation, operational questions, problems
encountered by you in using the software, accuracy of the manual or the Software, or any other thing
which may cause you to seek aid from Company in the installation or use of the Software. Company is
free to change its policies regarding “support” at will, and you hold Company harmless for the effects of
such a policy change.
You agree that, in the event that any part of this license is declared by a court holding proper jurisdiction
under this agreement to be illegal or unenforceable, only that very part so declared shall be invalid, and
the rest of this license shall continue in full force and effect, as if the illegal or unenforceable clause were
never included therein.
You agree that this license and ALL of its terms shall binding upon your employees, successors, assigns,
or transferees.
You agree, if purchasing or otherwise receiving the Software from a party other than Company, that you
will be bound by all the terms herein. If you DO NOT AGREE, your license is revoked and you must
return the Software to the party from whom you purchased it. In that event, you agree to hold Company
harmless as to damages or compensation, inasmuch as full agreement to all the terms of this license is a
prerequisite condition of your permission to use this software.
You agree that this license shall be interpreted and enforced under the laws of the United States of
America and the State of Illinois, as appropriate, and without regard to conflict of law principles.
4 • Welcome
Owner's Manual: The Scoop™ for TBS
You agree that any action under this agreement may not be combined with the claims of other persons into
any sort of a combined or class action with any other party for any reason or cause whatsoever. This
prohibition applies to actions brought in arbitration or before a court of law. In the event that you
participate in a combined or class action against Company, you agree that Company is entitled to have
such an action dismissed, with prejudice, and shall receive its costs and reasonable attorney fees from all
putative class plaintiffs, jointly and severally.
ANY CLAIM OR DISPUTE UNDER THIS AGREEMENT THAT COMPANY MAY HAVE
AGAINST YOU, AND ANY CLAIM OR DISPUTE THAT YOU MAY HAVE AGAINST
COMPANY OR ANY OF ITS EMPLOYEES, OWNERS, OFFICERS OR
SHAREHOLDERS, WHETHER RELATED TO THE TRANS ACTIONS THAT THIS
LICENSE AGREEMENT GOVERNS, OR OTHERWISE, INCLUDING THE
ENFORCEABILITY OF THIS ARBITRATION AGREEMENT, WILL BE RESOLVED
EXCLUSIVELY AND FINALLY BY BINDING ARBITRATION under the Code of
Procedure of ARBITRATION-FORUM.COM (the “Code”) in effe ct at the time the claim is
filed. The Code is available at http://www.arbitration -forum.com or can be obtained by
calling 1-800-753-9448.
Notwithstanding any choice of law provision included in this User Agreement, this arbitration
agreement is subject to the Federal Arbitration Act (9 U.S.C. §§ 1-16) and the New York
Convention on the Enforcement of Arbitration Awards (9 U.S.C. §§ 201-208 or as codified in
the jurisdiction where enforcement of the award is sought). Hearings shall be held as provided
by the Code and if any In -person Hearing is required, it shall be held in Illinois, in the same
county where Company’s headquarters is located at the time the action is commenced. Each
party shall bear its own cost of any legal representation, discovery, or research required to
complete arbitration.
Notwithstanding any other language in this agreement, any party who receives an award from
the arbitrator, may, in order to secure the benefit of such an award, present the award in a
court of competent jurisdiction and obtain a judgment codifying its terms, andmay use the
persuasive power of the court to execute thereupon.
To the extent that the arbitration clause above does not apply, you agree that the only courts that may hear
and adjudicate civil actions under this agreement shall be the United States District Court for the Northern
District of Illinois, or the Illinois Circuit Court in the county of Company's principal place of business at
the time of the action, as appropriate to the jurisdiction of the question to be decided. You agree that, if
you bring an action in any other venue, Company may enter into said court, cause such action to be
dismissed, and may recover all of its costs, including reasonable attorney’s fees, from you.
You agree that any action against Company for any thing related to the Software or this license must be
brought within ONE (1) year after the date the Software was purchased from Company or such action
shall be forever barred, and Company agrees that any breach by you of this license not litigated within one
(1) year of its discovery by Company shall be likewise forever barred, with the exception of an
infringement of copyright, patent or trade dress, which shall be actionable solely according to the statutes
of limitations set by the laws of the United States of America for infringements in force at the time of the
infringement.
You agree that Company does not waive any rights it has herein by delaying enforcement of or not strictly
enforcing its rights herein against you or any other party.
Owner's Manual: The Scoop™ for TBS
Welcome • 5
Getting Started
What You need to Have
You need to have The Breeder’s Standard™ 2001 or later, installed
prior to using The Scoop™. If the program is not present, with its data
files, The Scoop™ will not run properly.
How to Install
Installing from the Internet
Once you download from the Internet, you will have a file to run. This
contains the installation program. You simply double click on the file
and follow the instructions from that point forward.
Installing from the CD
Our Program CDs contain all of our products, and a program runs
whenever you insert the CD into your computer. Choose to install
programs, and then when given the option, choose to run The Scoop’s
installer. Then simply follow the instructions from that point forward.
When to reinstall and when not to reinstall
The Scoop™, unlike our other programs, is a single executable file. Do
not reinstall the Scoop if you experience a problem unless told to do
so by our tech support department.
Program Registration / Activation
Why we make you use an activation code
We need to know who has which copies of the program. This helps us
to know who is buying the program, and allows us to keep your costs
low by preventing software piracy. The Software Publishers
6 • Getting Started
Owner's Manual: The Scoop™ for TBS
Association (SPA) estimates that over 50% of business PC software is
illegally-used, and over 65% of personal PC software is illegally-used.
This is stealing. Software companies cannot operate unless they are
paid for what they produce.
We could raise prices to cover our costs, but this penalizes our honest
customers by making them pay for the pirates’ copies of the software.
Instead of that, we keep our price low and make it nearly impossible to
illegally use The Scoop™. We plan to know everyone who buys our
program, and to make it so that any illegal copy of the software is
traceable, identifiable and practically unusable. This means that we’ll
be paid for our hard work, and in turn, you’ll be paying less for the
software and for technical support.
What This Means
In order to use The Scoop™, you are required to register the program.
How to Activate The Scoop™
The first time you run The Scoop™, it asks for your activation
information. If not, from the Main window, click the Activation
button. This will start up the Activation window.
The Activation window looks like this:
Figure: The Scoop(tm) Activation Window.
Fill in your name, control number and registration key as shown on
your packing list or registration email. The name is case sensitive. If
there is a 0 in the registration key it is ZERO, not Capital “o.”
Then click “Register” and you will be fully activated.
If you lose your registration number, and have to re-install the software,
call us and we will issue you a new one, provided you are legally
licensed to use the software.
Owner's Manual: The Scoop™ for TBS
Getting Started • 7
Using The Scoop™
Running The Scoop™ the First Time
After you activate The Scoop™, you’re ready to begin work. You can
click on the icon for The Scoop™:
…and begin to explore!
The Scoop™ Main Window
The Scoop™ has a main window that shows a listing of all of the
reports you have created in the program, along with their file names.
Reports produced by The Scoop™ have a file extension of RMX.
The Main Window of The Scoop looks like this:
Figure: The Scoop(tm), Main Window.
You can Click the Add button to create an all-new report. You can
click on one of the reports listed and the change button to work with an
existing report.
To get rid of a report you don’t want anymore, click on the report and
then the Delete button. The Scoop™ will make sure you really want to
8 • Using The Scoop™
Owner's Manual: The Scoop™ for TBS
delete the report by asking you, You must click the Yes button in order
to actually delete the report. Once deleted, the report is gone forever,
and The Scoop™ cannot retrieve it, nor can Man’s Best Friend
Software Technical Support.
If you don’t want to work with the report layout and you simply want
to print or preview the report, click that report in the list and then the
Print or Preview buttons.
Creating A New Report
When you choose to create a report, you are asked to give that report a
name. The way The Scoop™ does this is to pop up a window asking
you for the report name.
The Report name window looks like this:
Figure: New Report Name Popup
Type in a report name and click OK. You cannot click OK unless you
type in a non-blank report name. Clicking Cancel will stop The
Scoop™ from creating a new report layout.
Report File Names: The Scoop™ will not allow you to change
the file name of the report. It is generated by The Scoop, and
future plans require the file name to be fixed.
Owner's Manual: The Scoop™ for TBS
Using The Scoop™ • 9
General Report Design
Guidelines
The Report Expert
When you choose to add a report from the main window of The
Scoop™, the report expert will be shown, which you can use for fast
and easy creation of a first report design.
Figure: Report Expert, Page One
The report expert asks you which kind of report you want to create,
which dataset to use and how to layout the report. The needed report
elements will be added automatically to the report. After the expert has
finished you can continue editing the report to make it fit your needs.
If you select "New empty report" as the report type, a completely
empty report will be created and the report expert will exit. You must
then add all report bands and datasets manually.
10 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
Parts of a Report
Bands
The image below shows the first page of a sample report, which prints
country names, their capitals and their populations. This report can be
divided into several sections:
These sections are used for report designing and are called "Bands"; the
report is a so called "banded" report. For example there is a
"Footerband" for all text in the page footer and a "Titleband" for the
report title on the first page. The most important band is the
"Detailband". The detailband is printed once for each data record (for
each country in the above example), which results in a list of the data.
The detailband's layout is the same for each record, so it must be
created only once, for one record, with placeholders for each data field.
For every record the detailband is printed after the placeholders have
been replaced with the current record's data.
Fields and other Elements of the Report
Apart from report bands, which divide the report into logical sections, a
report consists of report elements placed on the report bands. These
elements define what exactly is printed on each band.
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 11
The two most important report elements are "Labels" and "Datafields".
Labels are used for printing text - for example a title - that has no
connection to a database. Datafields are placeholders for fields from a
dataset. Whenever a data field is to be printed, the report engine gets
the field content from the dataset and puts this text where you placed
the datafield.
Usually labels are add-ons for datafields, to make the report look better
and more understandable by not only listing data, but also showing
which kind of data is printed too.
The following picture shows the report definition for the above country
listing:
The following types of report elements are available when designing a
report:
12 • General Report Design Guidelines
•
Datafields to display text from a dataset
•
Labels to display fixed text
•
Systemfields (date, time, page number, ...)
•
Shapes (circle, rectangle, line)
•
Image (Windows bitmap file)
•
Image from a data field
•
Expression (calculated field, mathematical calculations,
...)
•
Memo (text with multiple lines)
Owner's Manual: The Scoop™ for TBS
•
RTF (Richtextformat = formatted text, only available with
32-bit applications)
•
RTF from a data field (only available with 32-bit
applications)
•
Chart (charts, graphs, ...)
Each report element has specific properties (font, color, ...), which you
can edit. This is further described in the chapters about the different
elements.
Report Elements
Adding Report Elements
Buttons for adding report elements to the report can be found on the left
side of the designer window:
Report Band
Child Band
Subdetail Band
Group Band
Label
Memo
Image/Bitmap
Shape
System Field
Data Field
Image from data field
Expression field
Richtext field
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 13
Richtext from data field
To add an element to the report you must click its button and then click
on the report where you want the element to be inserted. Of course you
can still move a report element to another position later.
When adding new report bands it doesn't matter where you click on the
report, because the position of each band is determined by its band type
(page header, title band, ...) automatically.
Changing Report Elements
The individual properties of a report element can be changed anytime
during report design. Select the desired element and either double-click
with the left mouse button, or press the right mouse button and choose
"Properties" from the popup menu. The property dialog for the selected
report element will open, which is the same dialog as the one that
shows up when inserting a new report element. The following picture
shows the property dialog for a label:
Edit the element properties to your needs and press the "OK" button to
close the dialog and accept your changes. If you press "Cancel", all
your changes are dropped and if you were inserting a new element, it
will not be added to the report.
Information about the different properties for each report element can
be found at the individual element descriptions.
The Report Editor Window
The Report Editor Windows is where you adjust the look and elements
of the report you are creating.
14 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
You have the design area, and the toolbar, to work with. You can use
the mouse, the keyboard, or a cominbation to manipulate the elements.
The Left-hand buttons
Please refer to the section Adding Report Elements on page 13 for
descriptions of the buttons and what they do.
The Toolbar
You can change many report element properties directly with the
toolbar instead of using the element's property dialog. Additionally you
can use it to modify multiple elements at once.
These buttons are for creating a new report, loading a
report file and saving a report.
Use these buttons to print the report or to view a preview of
the printout.
With these buttons report elements can be cut to, copied
to or pasted from the report designer's clipboard.
These buttons are used to set a report element to the
background or bring it in front of all other report elements, in case of
overlapping elements.
Report elements can
be arranged with these buttons. Some of the buttons are only enabled
when multiple ele ments are selected (for example to align the left
edges).
This part of the toolbar
shows the type of the currently selected report element and its main
property (text if it is a label, data field, band type, ...). You can edit this
property directly with the toolbar, without the need to open the
element's property dialog.
Here you can set font
and font styles of the selected report elements (font name, font size,
bold, underline, italic).
These buttons are for aligning text within a report
element. Text can be aligned left, right or centered. Of course this only
makes sense if the report element's size is bigger than its text, and if
"autosize" is deactivated.
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 15
With this button you can open a dialog to set the frame options
for the selected element.
Using the Mouse in the Report Editor
Select a report element
Report elements are selected by clicking them with the left mouse
button. A selection is shown with eight small black boxes around the
element:
Change the
size of an element
You can use the small boxes of a selected element to change its size. If
the mouse cursor is positioned over such a box, the cursor will change
to show in which direction the mouse can be moved while the left
mouse button is pressed down. The element will be resized
accordingly. Please note that for report bands only the height can be
changed, but the width is set to the report width automatically.
Select multiple elements (a)
You can select multiple elements by holding down the [Shift] key while
selecting them with the left mouse button. This way the previous
selection will remain when a new element is selected.
Select
multiple elements (b)
You can also select multiple elements by using a so-called "rubber
band". Hold down [Ctrl] together with the left mouse button and drag a
frame around the elements that you want to select. After releasing the
mouse button all elements within the frame are selected.
Move elements:
You can move report elements with the left mouse button. Hold down
the button, drag the element to the desired location and release the
mouse button. Report bands can not be moved because they are
positioned automatically according to their band type.
Move and resize elements regardless of the current grid
setting:
If you want to manipulate a report element regardless of the current
grid (menu item "View|Options") and move or resize by one pixel, then
hold down the [Shift] key while moving the mouse.
Edit element properties:
16 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
If you double-click a report element with the left mouse button, or if
you select "Edit" from the element's popup menu (which can be
accessed with the right button), a dialog will be shown where all
element properties can be edited.
Using the Keyboard when Editing
The report designer can be used with the mouse most of the time. Some
functions can also be accessed with the keyboard:
Enter:
Show the element's property form
Cursor keys:
Move a report element
Shift + Cursor keys:
Resize a report element
Del:
Delete a report element
Tab and Shift + Tab:
Select next or previous report element
Datasets – Where you get the information
Any report designed with The Scoop™ needs at least one dataset,
which supplies the data records for the report. You can define all
datasets and their relationships via the database setup (menu item
"Report|Datasets").
Note: The "Property" button shows a dialog with the settings of the
currently selected table or query. If the dialog elements in that dialog
are disabled, you are not allowed to change the dataset's settings.
This dialog window shows the main dataset for the report, which is the
dataset that the report runs through and prints all data records from.
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 17
Below the main report table this is a list of all datasets available to the
report. Currently there is only the country table, which is the main
dataset, but you can add more tables or queries that you can use in your
report too.
To add a table or query, use the corresponding button.
New table:
If you press this button the following dialog will be shown:
This is a common file open dialog where you can select the desired
table. Additionally you can use aliases instead of directory paths if
available.
New query:
The following dialog will open if you press the "New query" button:
Here you can supply a query in SQL language. If your query has
parameters, you can set their values with the "Parameter" button. If the
parameters should be retrieved from another dataset, select this table or
query in the "master" combobox.
18 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
Data fields:
If you select the "Fields" button, a list with all available fields of the
currently selected dataset will be shown.
Not
e: The buttons in this dialog are disabled if you are not allowed the edit
the dataset's fields.
You can remove (=hide) single fields from the dataset, so that they will
not be available in the report editor anymore, or you can edit a field's
properties:
A display label can be set for each data field, which is used as an alias
name in the report editor. This way you can have descriptive field
names even if your physical dataset has not, for example "CustNo" can
be replaced with "Customer".
Use the "format" edit line to format numerical fields (see Formatting of
numerical fields). "Precision" determines how many digits after the
decimal separator are displayed.
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 19
Report Elements Described
Bands
All standard report bands are added with the Bands button (see
Adding Report Elements on page 13). The band type is selected with
the band's property dialog.
The following band types are available:
•
Title: The title band will be printed on the first page of
the report as a report title.
•
Page header: The page header is printed at the top of
each report page
•
Column header: The column header is used with reports
that have multiple columns (can be set with
"Report|Options").
•
Detail: The detail band is the most important report band.
It is printed once for each data record from the main
report table.
•
Group footer: The group footer is printed at the end of a
group, before a new group starts. You can find mo re
information on groups at the chapter describing the group
band.
•
Summary: The summary band is printed at the end of the
report, after all data records have been printed.
•
Page footer: The page footer is printed at the bottom of
each report page.
The band properties for these bands are all set with the same property
dialog. The following options are available:
Type: Band type (see above)
Color:
This defines the background color of the report band.
Print:
20 • General Report Design Guidelines
•
not on first page: prints the band only on the second page
and following
•
not on last page: suppresses printing of the band on the
last report page
•
even page numbers only: only prints the band on even
page numbers
•
odd page numbers only: only prints the band on odd page
numbers
•
at bottom of page: moves the band to the bottom of the
page before printing it
•
force new page: starts a new page before printing the band
Owner's Manual: The Scoop™ for TBS
•
force new column: starts a new column before printing
when using reports with multiple columns
Only print band if expression is true:
An expression can be used to determine whether the band should be
printed or not. The expression must have a logical result of "true" or
"false". Press the button on the right side of the expression edit line to
use the expression expert.
Frame:
A frame or single frame lines can be drawn around the report band.
You can select which lines should be drawn, in which color, style and
width.
SubDetail Band
A subdetail band is a sort of detail band, but it is subordinate to
the real detail band. For example if you want to print a list of audio
CDs, and for each CD a title list should be printed, you would use a
detail band for printing the CD names and connect a subdetail band to
the titles dataset, so separate lists of titles are printed below each CD
name. Please note that in order to use such a connection you must
create a corresponding table connection (called "master-detailrelationship") as well by using the database setup.
The following options are available for the subdetail band:
Table:
This is the dataset that is used by the subdetail band.
Color:
This defines the background color of the report band.
Master:
The master is the table superior to the subdetail table. For each record
in the master table a subdetail list is printed.
Only print if Expression is True: An expression can be used to
determine whether the band should be printed or not. The expression
must have a logical result of "true" or "false". Press the button on the
right side of the expression edit line to use the expression expert.
Print
Owner's Manual: The Scoop™ for TBS
•
before master-detailband: prints the subdetail records
before printing their master record from the detail band
•
at bottom of page: moves the band to the bottom of the
page before printing it
•
print header/footer even if dataset is empty: header and
footer bands of the subdetail band will be printed even if
there are no subdetail data records to print
•
force new page: starts a new page before printing the band
General Report Design Guidelines • 21
•
force new column: starts a new column before printing
the band (when using reports with multiple columns)
Headerband:
This band is printed as a header before the subdetail data records are
printed.
Footerband:
This band is printed as a footer after the subdetail data records have
been printed.
Frame:
A frame or single frame lines can be drawn around the report band.
You can select which lines should be drawn, in which color, style and
width.
Group Bands
A group band is used to structure data into groups of data
records. For example if you want to print a list of addresses, you can
add some space before each new first letter starts and insert some
caption, or you can group addresses by city or state.
Internally groups are handled the following way: Before printing a data
record, the report engine checks if the expression result of the group
band is different from the last data record's expression result. If this is
the case, the group band will be printed, else it won't. This way data
can be grouped with great flexibility, because you can use the
expression for nearly any kind of calculation.
The following options are available:
Master:
Defines which is the master band for the group. This can be either the
detail band or a subdetail band. The group is checked each time the
master band is printed.
Color:
This defines the background color of the report band.
Expression:
This expression determines whether a group band is printed or not. The
band will be printed each time the result of the expression changes.
Print
•
at bottom of page: moves the band to the bottom of the
page before printing it
•
force new page: starts a new page before printing the band
•
force new column: starts a new column before printing
when using reports with multiple columns
Footerband:
22 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
This band is printed at the end of each group, before the next group
band is printed.
Frame:
A frame or single frame lines can be drawn around the report band.
You can select which lines should be drawn, in which color, style and
width.
Child Bands
A childband is a band which is attached to another report band
and which will always be printed below its parent band. This way you
can print an additional band after each detail band for example. The
advantage of using child bands instead of just resizing the parent band
to make room for more report elements is that there can be a page break
between a band and its child if needed, and the child band can be
printed independently from its parent band, even if the parent band is
not printed.
You must use child bands if you have report elements with
"Autostretch" set to true and you want to print element below such
auto-resizing fields. In this case place all the elements which should be
moved down automatically because of autostretching elements before
them on a child band.
The following options are available:
Parent Band:
The band to which the child band is attached
Color:
This defines the background color of the report band.
Print
•
not on first page: prints the band only on the second page
and following
•
even page numbers only: only prints the band on even
page numbers
•
odd page numbers only: only prints the band on odd page
numbers
•
at bottom of page: moves the band to the bottom of the
page before printing it
•
force new page: starts a new page before printing the band
•
force new column: starts a new column before printing
when using reports with multiple columns
Only print band if expression is true:
An expression can be used to determine whether the band should be
printed or not. The expression must have a result of "true" or "false".
Press the button on the right side of the expression edit line to use the
expression expert.
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 23
Frame:
A frame or single frame lines can be drawn around the report band.
You can select which lines should be drawn, in which color, style and
width.
Data Fields
A datafield displays data from a table or query. This can be
numerical data, characters or multiple lines of text.
The following options are available:
Data field:
Select the data field you want to print.
Alignment:
The report element's text can be aligned left, right or centered.
Format:
Numerical data fields can be formatted by setting a format definition.
Font:
Selects the font for the report element
Color:
Defines the background color for the report element (the font color can
be set with the "Font" button).
Automatic word-wrap:
Set this option if you want the text to wrap to the next line if it does not
fit into the given width (similar to a word processor software).
Transparent:
The report element's background will not be printed if this option is
activated. This way you can place text on top of an image for example,
without hiding the image under a white box with text.
Autosize width:
This option resizes the report element to make room for its complete
text. If "Autosize" is not set and the text is larger than the element size
then text will be clipped off.
Autostretch height:
This option is for report elements with multiple lines, e.g. memo fields.
The height of the elements will be stretched to make room for all lines.
If needed, the report band will be stretched too.
Suppress printing of repeated values
Activate this option if you do not want to print data fields with the
same values repeatedly. The report engine will only print the data field
for the first data record, and leave all following prints of this data field
empty if the field's content hasn't changed.
Suppress printing if value of datafield is 0
24 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
This option suppresses printing of numerical fields if their value equals
zero.
Reprint on new page
If you have activated "Suppress printing of repeated values", you can
use this option to reprint a field if a new page starts, even if it would be
suppressed normally because of equal values.
Reprint on new group
Same as "Reprint on new page" but for groups.
Labels
A label is for printing static text, i.e. text that is printed exactly
like it is displayed during report design.
The following options are available:
Text:
This is the text that should be printed. You can only type in one line of
text. Memos can be used for multi-line text.
Rotation:
Use this to rotate your text. Rotation can be set to anything between 0
and 360 degrees. 90 degree means displaying the text vertically for
example.
Font:
Selects the font for the report element
Color:
Defines the background color for the report element (the font color can
be set with the "Font" button).
Alignment:
The report element's text can be aligned left, right or centered.
Automatic word-wrap:
Set this option if you want the text to wrap to the next line if it does not
fit into the given width (similar to a word processor software).
Transparent:
The report element's background will not be printed if this option is
activated. This way you can place text on top of an image for example,
without hiding the image under a white box with text.
Autosize width:
This option resizes the report element to make room for its complete
text. If "Autosize" is not set and the text is larger than the element size,
text will be clipped off.
Autostretch height:
This option is for report elements with multiple lines, e.g. memo fields.
The height of the elements will be stretched to make room for all lines.
If needed, the report band will be stretched too.
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 25
Memos
A memo is used to print text that has more than one line. Just like
a label a memo displays text in one color and font. If you want to use
formatted text, you can use a Richtext field.
The following options are available:
Text:
This is the text that will be printed.
Font:
Selects the font for the report element.
Color:
Defines the background color for the report element (the font color can
be set with the "Font" button).
Alignment:
The report element's text can be aligned left, right or centered.
Automatic word-wrap:
Set this option if you want the text to wrap to the next line if it does not
fit into the given width (similar to a word processor software).
Autosize width:
This option resizes the report element to make room for its complete
text. If "Autosize" is not set and the text is larger than the element size,
text will be clipped off.
Autostretch height:
This option is for report elements with multiple lines, e.g. memo fields.
The height of the elements will be stretched to make room for all lines.
If needed, the report band will be stretched too.
Images
An image element is a bitmap from a BMP file that is inserted
into the report.
Use this to insert your kennel logo or other identifying field into the
Report Title or Page Header band to make your report look cooler.
Image from Data Field
(will be supported for Dog Pictures in late 2005 to early 2006)
While a datafield is for displaying text from a database record,
you can use this report element to display images that are stored in a
database.
The following options are available:
Datafield:
26 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
The field that contains the image (if there is no bitmap in this field,
nothing will be printed). If the datafield property is set to a database
field which is not of type "bitmap", the report engine will try to find a
bitmap file whose name equals that of the data field's content and load
it.
Stretch picture automatically:
Activate this option to stretch the picture so it fits exactly into the
report element's size, else the picture will be cut off if there is not
enough room, or space will be left empty if there is too much.
Center picture:
If the report element is bigger than the picture and the "Stretch" option
is not activated, the picture will be centered in the report element
instead of being placed in the top left corner.
Alignment:
Aligns the image on the report band.
Expressions
A calculated field (expression field) is used for displaying text or
data that is calculated by an expression or formula. You can do
numerical calculations, string manipulations, concatenate data fields
and much more.
Expression:
This expression is evaluated each time the calculated field is going to
be printed (See Expression Syntax on page 35).
Format:
Numerical fields can be formatted by setting a format definition.
Font:
Selects the font for the report element
Color:
Defines the background color for the report element (the font color can
be set with the "Font" button).
Master:
If your expression uses any aggregated functions, you must link the
"Master" property to the dataset that will be used to update the
expression. Each time a new data record from this dataset is selected
the expression will be recalculated.
Alignment:
The report element's text can be aligned left, right or centered.
Rotation:
Use this to rotate your text. Rotation can be set to anything between 0
and 360 degrees. 90 degree means displaying the text vertically for
example.
Autosize width:
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 27
This option resizes the report element to make room for its complete
text. If "Autosize" is not set and the text is larger than the element size,
text will be clipped off.
Autostretch height:
This option is for report elements with multiple lines, e.g. memo fields.
The height of the elements will be stretched to make room for all lines.
If needed, the report band will be stretched too.
Reset after print:
If you are using calculations like sums or counting of data record etc.,
you can use this option to reset the value of the calculation to zero after
the report element has been printed.
Automatic word-wrap:
Set this option if you want the text to wrap to the next line if it does not
fit into the given width (similar to a word processor software).
Transparent:
The report element's background will not be printed if this option is
activated. This way you can place text on top of an image for example,
without hiding the image under a white box with text.
Shapes
This report element can be used to draw (horizontal or vertical)
lines, circles and rectangles.
The following options are available:
Type:
Selects the shape, which can be a circle, rectangle, horizontal line,
vertical line or top/bottom and left/right lines.
Brush:
•
Style: different styles to fill a circle or rectangle
•
Color: the color that is used to fill the shape
•
Pen:
o
Width: line width of the shape
o
Mode: various line drawing modes
o
Style: solid, dotted or dashed lines
System Fields
This report element is used to display various system data like
current time or date, page number etc.
Available options:
Text:
28 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
This text will be displayed before the actual system data. For example
you can use the text "Report printed on: " when printing the current
date.
Type:
The type of system data to print. The following types are available:
•
Date: the current date when printing the report
•
Time: the current time when printing the report
•
Date/Time: the current date and time
•
Detail count: total number of data records
•
Detail number: number of the current data record
•
Page number: current page number of the printout
•
Report title: the report title which can be set via
"Report|Options"
Autosize width:
This option resizes the report element to make room for its complete
text. If "Autosize" is not set and the text is larger than the element size
it will be clipped off.
Transparent:
The report element's background will not be printed if this option is
activated. This way you can place text on top of an image for example,
without hiding the image under a white box with text.
Font:
Selects the font for the report element
Color:
Defines the background color for the report element (the font color can
be set with the "Font" button).
Rich Text Field
The richtext element is a report ele ment that can display multiline text with different fonts, colors and formatting. In the richtext
property dialog press the "Edit" button to show a text editor with
richtext editing capabilities.
Alignment:
sets the text alignment if no alignment has been set with the editor
Font:
sets the font if no font has been specified with the editor
Color:
sets the text color if no color has been set with the editor
Autostretch height:
Owner's Manual: The Scoop™ for TBS
General Report Design Guidelines • 29
This option is for report elements with multiple lines, e.g. memo fields.
The height of the elements will be stretched to make room for all lines.
If needed, the report band will be stretched too.
Rich Text from data field
(will be supported in late 2005 or early 2006)
This report element displays richtext from a data field. The
following options are available:
Data field:
Select the data field to use by the report element.
Alignment:
sets the text alignment if no alignment has been set with the editor
Font:
sets the font if no font has been specified with the editor
Color:
sets the text color if no color has been set with the editor
Autostretch height:
This option is for report elements with multiple lines, e.g. memo fields.
The height of the elements will be stretched to make room for all lines.
If needed, the report band will be stretched too.
30 • General Report Design Guidelines
Owner's Manual: The Scoop™ for TBS
Advanced Concepts
Introduction
In this chapter we will discuss the advanced functions available to you
via The Scoop™. This includes advanced data formatting, formulas,
SQL Queries and scripting.
This guide is intended to be a primer, and is not intended to be
comprehensive. We do not provide free tech support to teach you
to use SQL or the programming languages built into The Scoop™.
If you want to learn to do advanced things, you need to consult
with an expert and or take classes in programming and data
management.
We do mark all data accessed by The Scoop as “read only,” but
you are expected to ONLY use the SQL Select statement in the
Scoop. We do not warrant data integrity or the accuracy of any
report, since you determine both things by the way you use the
program.
Field Formatting
Numerical fields and date or time fields can be displayed in many
different ways. This can be controlled with format strings, which
represent the output formatting in a symbolical way.
Numerical fields:
Owner's Manual: The Scoop™ for TBS
Specifier
Represents
0
Digit place holder. If the
value being formatted has a
digit in the position where
the '0' appears in the format
string, that digit is copied to
the output string. Otherwise,
a '0' is stored in that position
in the output string.
#
Digit placeholder. If the
Advanced Concepts • 31
value being formatted has a
digit in the position where
the '#' appears in the format
string, that digit is copied to
the output string. Otherwise,
nothing is stored in that
position in the output string.
32 • Advanced Concepts
.
Decimal point. The first '.'
character in the format string
determines the location of
the decimal separator in the
formatted value; any
additional '.' characters are
ignored. The actual character
used as the decimal separator
in the output string is
specified in the Number
Format of the International
section in the Windows
Control Panel.
,
Thousand separator. If the
format string contains one or
more ',' characters, the output
will have thousand separators
inserted between each group
of three digits to the left of
the decimal point. The
placement and number of ','
characters in the format
string does not affect the
output, except to indicate that
thousand separators are
wanted. The actual character
used as the thousand
separator in the output is
specified in the Number
Format of the International
section in the Windows
Control Panel.
E+
Scientific notation. If any of
the strings 'E+', 'E-', 'e+', or
'e-' are contained in the
format string, the number is
formatted using scientific
notation. A group of up to
four '0' characters can
immediately follow the 'E+',
'E-', 'e+', or 'e-' to determine
the minimum number of
digits in the exponent. The
'E+' and 'e+' formats cause a
plus sign to be output for
positive exponents and a
minus sign to be output for
Owner's Manual: The Scoop™ for TBS
negative exponents. The 'E-'
and 'e-' formats output a sign
character only for negative
exponents.
'xx'/"xx'
Characters enclosed in single
or double quotes are output
as-is, and do not affect
formatting.
;
Separates sections for
positive, negative, and zero
numbers in the format string.
The locations of the leftmost '0' before the decimal point in the format
string and the rightmost '0' after the decimal point in the format string
determine the range of digits that are always present in the output
string.
The number being formatted is always rounded to as many decimal
places as there are digit placeholders ('0' or '#') to the right of the
decimal point. If the format string contains no decimal point, the value
being formatted is rounded to the nearest whole number.
If the number being formatted has more digits to the left of the decima l
separator than there are digit placeholders to the left of the '.' character
in the format string, the extra digits are output before the first digit
placeholder.
To allow different formats for positive, negative, and zero values, the
format string can contain between one and three sections separated by
semicolons.
•
One section: The format string applies to all values.
•
Two sections: The first section applies to positive values
and zeros, and the second section applies to negative
values.
•
Three sections: The first section applies to positive
values, the second applies to negative values, and the
third applies to zeros.
If the section for negative values or the section for zero values is
empty, that is if there is nothing between the semicolons that delimit
the section, the section for positive values is used instead.
If the section for positive values is empty, or if the entire format string
is empty, the value is formatted using general floating-point formatting
with 15 significant digits. General floating-point formatting is also used
if the value has more than 18 digits to the left of the decimal point and
the format string does not specify scientific notation.
Date/Time:
The following formatting options are available for date and time:
Owner's Manual: The Scoop™ for TBS
Specifier
Displays
c
Displays the date using the
format given by Windows'
default short date format ,
followed by the time using the
Advanced Concepts • 33
format given by the default
Windows long time format.
The time is not displayed if
the fractional part of the
DateTime value is zero.
34 • Advanced Concepts
d
Displays the day as a number
without a leading zero (1-31).
dd
Displays the day as a number
with a leading zero (01-31).
ddd
Displays the day as an
abbreviation (Sun-Sat).
dddd
Displays the day as a full
name (Sunday-Saturday).
ddddd
Displays the date in short
format
dddddd
Displays the date in long
format.
m
Displays the month as a
number without a leading zero
(1-12). If the m specifier
immediately follows an h or
hh specifier, the minute rather
than the month is displayed.
mm
Displays the month as a
number with a leading zero
(01-12). If the mm specifier
immediately follows an h or
hh specifier, the minute rather
than the month is displayed.
mmm
Displays the month as an
abbreviation (Jan-Dec).
mmmm
Displays the month as a full
name (January-December).
yy
Displays the year as a twodigit number (00-99).
yyy
Displays the year as a fourdigit number (0000-9999).
h
Displays the hour without a
leading zero (0-23).
hh
Displays the hour with a
leading zero (00-23).
n
Displays the minute without a
leading zero (0-59).
nn
Displays the minute with a
leading zero (00-59).
s
Displays the second without a
leading zero (0-59).
Owner's Manual: The Scoop™ for TBS
ss
Displays the second with a
leading zero (00-59).
t
Displays the time using in
short format.
tt
Displays the time in long
format.
am/pm
Uses the 12-hour clock for the
preceding h or hh specifier,
and displays 'am' for any hour
before noon, and 'pm' for any
hour after noon. The am/pm
specifier can use lower, upper,
or mixed case, and the result
is displayed accordingly.
a/p
Uses the 12-hour clock for the
preceding h or hh specifier,
and displays 'a' for any hour
before noon, and 'p' for any
hour after noon. The a/p
specifier can use lower, upper,
or mixed case, and the result
is displayed accordingly.
ampm
Uses the 12-hour clock for the
preceding h or hh specifier,
and displays the contents of
the TimeAMString global
variable for any hour before
noon, and the contents of the
TimePMString global variable
for any hour after noon.
/
Displays the date separator
character given by the
Windows country settings.
:
Displays the time separator
character given by the
Windows country settings.
'xx'/"xx"
Characters enclosed in single
or double quotes are displayed
as-is, and do not affect
formatting.
Format specifiers may be written in upper case as well as in lower case
letters--both produce the same result.
Expression Syntax
Expressions are used for calculating numerical values, strings or logical
values ("true" or "false"). There are various operators and functions
available for this, comparable to a programming language ("Pascal" in
this case), which can be used to do many kinds of calculations. You can
Owner's Manual: The Scoop™ for TBS
Advanced Concepts • 35
do operations with data fields, for example calculate the tax for a given
amount, or merge two data fields into one string. Please note that if the
expression is a property of a report band, the result of the expression
must be a logical value. Only the group band expects the result to be a
string or a number, just like the expression-field report-element.
Composing expressions
The expression evaluator is working with four data types: Strings,
Integer, Float and Boolean. Binary data and memo fields are not
supported in expressions. Below is a list of how database fields are
converted to report data types:
Data type
Field type
String
String fields, date and time
fields
Integer
SmallInt fields, byte fields,
integer fields
Float
Float fields, currency fields
Boolean
Boolean (logical) fields
Report expression syntax is very much like Object Pascal. Below is a
list of supported operators:
Operator
Description
+
Add
-
Subtract
*
Multiply
/
Divide
()
Parentheses
And
Logical AND
Or
Logical OR
Not
Logical NOT
=
Equal
<
Less than
>
Greater than
<=
Less than or equal
>=
Greater than or equal
<>
Not equal
The standard functions included are:
36 • Advanced Concepts
Function
Description
Date
Return current date as a
string
Time
Return current time as a
string
Owner's Manual: The Scoop™ for TBS
Str(Number)
Converts the numeric
argument to a string
Copy(Str,s,l)
Returns a substring of str
(starting from the s-th
character, returning a
maximum of l characters)
Int(Number)
Returns the integer part of a
number
Frac(Number)
Returns the fractional part of
a number
If (Expr, r1, r2)
Returns r1 or r2 depending
on the boolean expr
TypeOf(Expr)
Returns the data type of expr
Sqrt(Number)
Returns the square root of a
number
True
Logical value True
False
Logical value False
Sum(Expr)
Returns the sum of expr
Count
Returns the number of
entires
Min(Expr)
Returns the lowest value of
expr
Max(Expr)
Returns the highest value of
e xpr
Average(Expr)
Averages the expr
Using database fields in expressions
Any field in any table referenced in your report can be accessed in an
expression. Field names can be referenced either just by the field name
itself (e.g. Name) or by the table name followed by a dot and the field
name (e.g. Customers.Name). If you do not specify a table name the
report engine will search for the field in all available data sets and use
the first instance found.
The current version of the expression evaluator does not support field
names with embedded special characters like blank, "/", dot, dollar sign
and so on.
Using Strings in Expressions
Strings in expression should be put in single quotes. The following is a
valid expression:
"Computers are great!"
Maximum string length is 255 characters.
Expression Examples
Owner's Manual: The Scoop™ for TBS
Advanced Concepts • 37
Below are some examples of expressions:
Expression
Description
1
Integer constant, returns 1
1.5
Floating point constant,
returns 1.5
"Delphi"
String constant, returns
"Delphi" as a string
True
Logical constant, returns
True
1+2
Numeric calculation,
returns 3
2 * (3 + 2.5)
Numeric calculation,
returns 11
"Delphi" + " is great"
String calculation, returns
"Delphi is great"
Name
Returns the value of the
field Name if it exists
Customer.Name
Returns the value of the
field Name in the
Customer table
Name + " " + Contact
Adds the Name field, a
blank and the Contact field
AmountPaid * TaxRate / 100
Numeric field calculation
"Printed "+ Date
String calculation
"Total amount paid is " +
str(AmountPaid)
String calculation
if(AmountPaid > 5000,
"Large order", "Small order")
Returns "Large order" if
AmountPaid is greater than
5000, else "Small order"
if(CheckField, "X", " ")
Prints an X if CheckField
is True
Composing expressions visually
Expressions can be typed in directly to the corresponding edit line, or
you can press the button ".." to the right of the edit line to show the
expression builder dialog. You can then visually design your
expression with your mouse. If a used function has parameters, like
"Copy" or "Sum", another copy of the dialog will be opened to define
those parameters separately.
Scripting with The Scoop™
The Scoop™ comes with an integrated script language for creating
"BeforePrint" and "AfterPrint" event handlers at runtime. While you
can allow the end user to do this, the script language is probably more
useful for the developer itself. You can use it to design reports with
38 • Advanced Concepts
Owner's Manual: The Scoop™ for TBS
various special features without the need to write source code and to
have this hardcoded into your application.
As a simple example, lets say that you have a report printing a list of
numbers, some of which may be positive and some may be negative.
For this you can write a script for the detail band's "BeforePrint" event
at runtime from within the report editor (right-click on the band after
you have selected it and choose "Scripts" from the popup menu):
if (Amount>=0)
SetFontColor('AmountDBText',Black)
else
SetFontColor('AmountDBText',Red)
endif
The script language is based on The Scoop’s expression syntax,
extended with commands IF, ELSE, ENDIF, LOOP, ENDLOOP,
BREAK, EXIT and RETURN, i.e. you can use any expression function
in the script (and all script functionality is based on the various
functions available). Also you can use variables to store values.
Syntax of The Scripting Language
IF...ELSE...ENDIF:
IF (Condition)
:
ENDIF
Or…
IF (Condition)
:
ELSE
:
ENDIF
Note that between the "IF" and "(Condition)" there MUST be a blank.
Do not place commands on the same line as the IF statement, but only
on new lines.
"Condition" can be any expression returning TRUE or FALSE, e.g. "IF
(Weight>10)"
The lines below the IF statement until ENDIF or ELSE are the
commands to be executed if "Condition" evaluates to TRUE.
Examples:
IF (Amount*1.16>800)
OKBox('Warning: Amount including VAT is
larger than 800')
ENDIF
Owner's Manual: The Scoop™ for TBS
Advanced Concepts • 39
IF (YesNoBox('Print report now?'))
RETURN(TRUE)
ELSE
RETURN(FALSE)
ENDIF
LOOP...ENDLOOP
LOOP
:
ENDLOOP
You can place expression commands between LOOP and ENDLOOP,
and when reaching the ENDLOOP statement the script will start again
at the line below LOOP. You can exit the loop only by using the
BREAK or BREAKLOOP commands (see below).
Example:
SetVar('Temp',1);
LOOP
SetVar('Temp',GetVar('Temp')+1);
IF (GetVar('Temp')>10)
BREAKLOOP
ENDIF
ENDLOOP
BREAK
BREAK has no parameters, it just exits from the current IF or LOOP
block instantly, continuing with the commands following the ENDIF or
ENDLOOP statement. Note that in the above example break would
only exit from the IF statement, not from the loop.
BREAKLOOP
This is the same as BREAK, only that it exits from the current loop no
matter if BREAKLOOP is used from within one or more IF blocks.
EXIT
EXIT has no parameters. It just completely exits the script execution
instantly.
RETURN
Or…
RETURN(Expression)
RETURN sets the current scripts result (a result is needed for the
BeforePrint event: TRUE to confirm printing of the current band,
FALSE to skip printing the band). "Expression" must evaluate to
TRUE or FALSE.
Example:
40 • Advanced Concepts
Owner's Manual: The Scoop™ for TBS
RETURN(FALSE)
RETURN(Weight>10)
The second example would only print the band if the WEIGHT
datafield value is greater than 10.
Variables in Event Scripts
Variables are declared, set and get with functions. There are no
variables like in Pascal or C that can be used just by writing their name.
Variables are global, i.e. you can set a variable in one event handler
script and use it in another. You can even set a variable in one report
and use it in a second report executed afterwards. Variables are not
initialized to some value when a report is generated.
To set a variable, use the SETVAR function with variable name and
variable value as parameter. SETVAR automatically creates a new
variable if it doesn't exist, else it will overwrite the value of the given
variable.
SETVAR('Temp','This is a test string')
SETVAR('Num',1000)
SETVAR('Flag1',TRUE)
To get a variable value, use the GETVAR function with the variable
name as parameter. The result type of GETVAR depends on what kind
of variable (string, number, boolean) has been created/set with
SETVAR.
GETVAR('Temp')
IF (GETVAR('NUM')>0)
RETURN(FALSE)
EXIT
ENDIF
SETVAR('Num',GETVAR('Num')+1)
SetStringProp('QRLabel1',GETVAR('Temp')+' !!!')
To check if a variable exists (i.e. has been created with a first call of
SETVAR), use the VAREXIST function with the variable name as
parameter.
IF (VAREXISTS('Flag1'))
:
:
ENDIF
To delete a variable from memory, use the DELETEVAR function with
the variable name as parameter. VAREXISTS will return FALSE for
this variable afterwards.
DELETEVAR('Temp1')
Owner's Manual: The Scoop™ for TBS
Advanced Concepts • 41
Script Expression Functions
ElementExists(Name: String): Boolean
Checks if a report element with the given name exists.
Example:
ElementExists('Label1')
SetBoolProp(ComponentName, PropertyName,
PropertyValue)
Sets a boolean property for a component.
Example:
SetBoolProp('Childband1','Enabled',False)
SetBoolProp('MyShape','Enabled',True)
SetIntProp(ComponentName, PropertyName, PropertyValue)
Sets a numeric property for a component
Example:
SetIntProp('Band1',Height,200)
SetFloatProp(ComponentName, PropertyName,
PropertyValue)
Sets a floating point property for a component
SetStrProp(ComponentName, PropertyName,
PropertyValue)
Sets a string property for a component
Example: SetStrProp('Label1','Caption','This is a
test')
GetBoolProp(ComponentName, PropertyName,
PropertyValue): Boolean
Reads a boolean property from a component.
Example:
IF (GetBoolProp('DBText1','Enabled))
SetColor('DBText1',Black)
ENDIF
GetIntProp(ComponentName, PropertyName): Integer
Reads a numerical property from a component
Example:
SETVAR('LastBandHeight',GetIntProp('DetailBand'
,'Height'))
GetFloatProp(ComponentName, PropertyName): Float
Reads floating point property from a component
GetStrProp(ComponentName, PropertyName,): String
Reads a string property from a component
Example:
42 • Advanced Concepts
Owner's Manual: The Scoop™ for TBS
GetStrProp('Expr1','Caption')
OkBox(Text: String)
Shows a message dialog with the given text and an OK button
Example:
OkBox('Fasten your seat belts')
OkCancelBox(Text: String): Boolean
Shows a message dialog with the given text and both an OK button and
a CANCEL button. Returns TRUE if the OK button has been pressed,
FALSE otherwise.
Example:
IF (OkCancelBox('Print now?'))
Return(True)
ELSE
Return(False)
ENDIF
YesNoBox(Text: String): Boolean
Same as "OkCancelBox" but with "Yes" and "No" buttons.
InputBox(Title, Text, VariableName): Boolean
Shows an input dialog. The user must type in a value that is stored in
the given variable.
Example:
InputBox('Input start date','Start
date:','VDate')
SetColor(Name, Color)
Sets the (background) color of the given report element. The color
parameter is a numerical value (same as in Delphi), but the following
constants are available: Black, Maroon, Green, Olive, Navy, Purple,
Teal, Gray, Silver, Red, Lime, Blue, Fuchsia, Aqua, White. You can
also use the RGBCOLOR function (see below).
Example:
SetColor('Childband2',Yellow)
SetColor('Childband2',87123)
SetColor('Childband2', RGBColor(255,0,128))
RGBColor(Red, Green, Blue): Integer
This function creates a color value for use with SETCOLOR and
SETFONTCOLOR from red, green and blue parts.
Example:
RGBColor(64,0,0)
(is a dark red color)
SetFont(ComponentName, FontName)
Sets the font for a given component
Example:
Owner's Manual: The Scoop™ for TBS
Advanced Concepts • 43
SetFont('Label1','Arial')
SetFontColor(ComponentName, Color)
Sets the font color for a given component. Please see the description of
SETCOLOR above.
SetFontSize(ComponentName, Fontsize)
Sets the font size for a given component
Example:
SetFontSize('TitleLabel',24)
SetFontStyle(ComponentName, IsBold, IsItalic, IsUnderline,
IsStrikeout)
Sets the font style (bold, italic, underline and strikeout) for a given
component. Each style is a boolean parameter that must be set to TRUE
for activating it.
Example:
SetFontStyle(DBText1,true,false,false,false)
44 • Advanced Concepts
Owner's Manual: The Scoop™ for TBS
Trouble-Shooting Guide
Introduction
Every program will give someone a headache from time to time. The larger the
company providing the program the more quickly a response can be obtained.
This is business software for those in the business of breeding dogs. We pride
ourselves on having set up one of the more innovative and responsive support
mechanisms in this industry.
Figuring Things Out when There’s a Problem
What to Check
Try rebooting the computer if you get a goofy error or a GPF. First, write everything
down so you have it handy if you need to contact us for support.
Information to have ready for Technical Support
When you call or post a message to Man’s Best Friend Software, please have the
following information immediately available:
Your Control number, from the invoice and/or registration sheet;
The number (if any) and the full text of any message you’ve received Important!
Include the full text of any message you receive! These messages
contain vital information we need to solve problems!;
Exactly what you did to receive this message;
What happened if you followed the steps outlined in the manual (if there were steps)
to correct the problem?
This will greatly help us to quickly identify and resolve your problems.
Warranty Procedure
The Breeder’s Standard 2006™ program disks are warranted for thirty days from the
date you receive the program to be free from material defects. This is NOT a
money-back guarantee. If you cannot make your installation diskette work,
Owner's Manual: The Scoop™ for TBS
Trouble-Shooting Guide • 45
follow the procedure below for telephone support and call 888-820-0691. You will
not be charged for support time for the call.
If we determine that your diskette or CD has failed, we will send you a new one. If
we need the old one back, we’ll instruct you on how to ship it back to us, and give
you an authorization number for the return. DO NOT RETURN ANYTHING
WITHOUT A VALID RMA NUMBER! ALL UNAUTHORIZED RETURNS
ARE REFUSED!
Contacting Us for Support
Internet
Man’s Best Friend Software has one of the largest animal-related sites on the
Internet. On this site, we have product news, demos, patches, free utilities and
support information. Our World Wide Web address is:
http://www.mbfs.com
This is an ideal first-look support resource. If you need additional assistance, please
send Email to:
[email protected]
...which will get you technical aid, usually within one business day.
FAX
Our FAX is on line all the time at 815-806-2130. When FAXing, please send
complete details, including all message number, texts, etc., so we can assist you.
FAXes must have a return FAX number or an Internet Email address to be
responded to. You will not receive a voice call-back for a FAXed-in support
issue. No exceptions.
Telephone Product Support *
Man's Best Friend offers no-charge product support via voice telephone. This is a
costly service for us to offer, and we ask and expect you to utilize this manual, the
Internet site and other resources prior to tying up a person with a telephone support
request. This is important, since we will be unable to keep this service free if it is
not responsibly used.
Please do not call until you have all of the information that we need already in hand
(see “Information to have ready for Technical Support” on page 45). This will make
it possible for our support representative to give you assistance.
The USA number for product support is:
888-820-0691
The support number outside the USA is:
815-806-2130
Press 2 for support.
46 • Trouble-Shooting Guide
Owner's Manual: The Scoop™ for TBS
Support hours are Eastern time, 9AM-5PM, Monday-Friday. If you get a voice
mail, please leave a detailed message. You will receive a call back as soon as
possible. Please be courteous and polite. You may be frustrated, but the support
representative is not responsible for that. Our representatives are instructed to
decline support in the presence of boorish conduct, threats and the like.
* NOTE: We reserve the right to assess a fee for product support or to terminate it altogether.
The sale of any product does not include any product support, which is offered solely as an
accommodation. No sale is contingent upon any level of product support. See the license
agreement (Copyright and License on page 1).
Owner's Manual: The Scoop™ for TBS
Trouble-Shooting Guide • 47
Glossary of Terms
Band
A "Band" is a segment of a report. The Band holds the information that needs to be
printed. The band is repeated as required to do the report. A detail band is full of
records; a Page Header band prints at the top of each page.
Dataset
A dataset is a file of a certain kind of data. For The Scoop™, this may be the dog
file, or the breed codes file or another similar file.
SQL
SQL Stands for Structured Query Language. It is a way to write a sentence to tell a
computer how to give you a dataset made up of one or more fields from one or more
other datasets, how to select what is in the dataset, and in what order to give it to
you.
Report Expert
The Report Exp ert is a program that guides you through the initial tasks of creating a
report with The Scoop™.
File Extension
The three characters that appear after the last period [ . ] in a file name. In Windows,
the File extension can tell Windows what program to use to access the file.
Owner's Manual: The Scoop™ for TBS
Glossary of Terms • 49
T
tool bar 15
Index
W
Warranty Procedure: 45
What to Check: 45
A
Activate 6
activation 6
B
band 11, 14, 49
Band 20, 21, 23
Bands 11, 20, 22, 23
D
data field 13, 14, 17, 41
dataset 17, 49
E
Expression 35
F
Figuring Things Out when There's a Problem" 45, 46
Figuring Things Out when There's a Problem: 45
I
Introduction 45
R
report bands 10, 11, 14, 16, 20
Report Expert 10
S
scripting 31
Scripting 38
SQL 1, 18, 31
Support 45
Owner's Manual: The Scoop™ for TBS
Index • 51
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement