The Report Editor allows you to make changes to reports in Servant Keeper. To use the Report Editor, you must first select a report and click either the [Copy] or [Edit] buttons. The only report type that can be edited is "User Reports". Standard and Downloaded reports must first be copied before they can be changed using the editor. Changing reports in this way allows you to always have a copy of the original report as it was before any changes were made. A copied report can be used as a starting point for creating your own reports. The Report Editor is made up of the following parts:


Object Inspector Panel
Allows you to view and change settings related to the selected object in the report.
Report Tree Panel
Lists all of the objects currently used in the report. If a report has more than one page, each page will have its own tab that lists the objects currently used on that page. The Script tab allows you to write scripts that will be used to display information on the report.
Tool Bar
Contains iconic shortcuts to the more commonly used Report Editor features.
Report Design Workspace
Where you design the layout of the report by changing the order of existing data bands and even the order of the data fields and objects within a band.
Data Tree Panel
Allows you to select the fields that you want to appear in the report.



When you use the Report Editor for the first time, you can configure some defaults for the way the Report Design Workspace looks and works.



Page Settings


The Page Settings (or Page Options) section allows you to customize the page for a report. These settings can be accessed by double-clicking on a blank space in the Report Design Workspace. You can also access these options under the "File" menu in the Report Editor. The "Page Options" window has two tabs. In the Paper tab, you can choose settings related to the printing of a report.


To Change Page Options:

  1. In the Report Editor, click on the "File" tab.
  2. Select "Page Settings" from the drop-down menu. The "Page Options" window will appear.
  3. Change the settings as needed and click the [OK] button.

You can change the following options on the Page Options "Paper" tab:

  • Size: allows you to choose the paper size for the report.
  • Orientation: allows you to choose the page orientation (Portrait or Landscape).
  • Margins: allows you to set the margins for a report.
  • Paper Source: allows you to select the printer tray the report will print from when printing a report from the Report Editor.

The "Other Options" tab of the Page Options window is where you can set the number of columns in a report, options when working in the Report Design Workspace, and printing.

You can change the following options on the Page Options "Other Options" tab:

  • Columns: allows you to change the number and width of the columns on a page.
  • Print to Previous Page: allows you to print pages without starting a new page, instead, beginning in any blank space on the previous page.
  • Mirror Margins: allows you to switch the right and left margins of even numbered pages when previewing or printing a report.
  • Endless page width: allows you to automatically increase the page width when the report is run based on the number of data records on the page.
  • Endless page height: allows you to automatically increase the page height when the report is run based on the number of data records on the page.
  • Large height in design mode: this option only effects the page height when in design mode and allows you to increase the height of the Report Design Workspace. This option is helpful when editing a report that contains many bands. This option must be used when working with overlay bands.



Report Designer Options


The (Report Designer) Options section allows you to customize how the Report Design Workspace will look when editing reports.

To Change Report Designer Options:

  1. In the Report Editor, click on the "File" tab.
  2. Select "Options" from the drop-down menu. The "Report Designer Options" window will appear.
  3. Change the settings as needed and click the [OK] button.
  4. The [Restore defaults] button in the Report Designer Options window will allow you to change all settings back to the factory default settings.

In the Report Designer Options window, you can change any of the following options:

  • Change the units (Centimeters, Inches, or Pixels): this option allows you to choose the units of measure for the Report Design Workspace.
  • Grid spacing: allows you to change the size of the grid spacing in the Report Design Workspace.
  • Show Grid: allows you to show or hide the grid lines in the Report Design Workspace.
  • Align to Grid: allows you to choose whether or not to have options in the Report Design Workspace automatically align to the grid.
  • Show Ruler: allows you to choose to show/hide the ruler in the Report Design Workspace.
  • Show Object inspector: allows you to choose to show/hide the Object Inspector Panel.
  • Change the font type and size for the Code Editor window.
  • Change the font type and size for the Memo/Text Object Editor.
  • Set the color for the Report Design Workspace.
  • LCD grid color: increases the contrast of the grid lines to improve the visibility on LCD monitors.
  • Show editor after insert: when enabled, and an object is inserted in the Report Design Workspace, its editor will be displayed.
  • Show band captions: allows you to show/hide band captions. This option can help save space in the Report Design Workspace. When this options is unchecked, the band captions will not show in the Report Design Workspace.
  • Show drop-down fields list: controls whether the drop-down list is available inside text objects that are connected to data fields.
  • Free bands placement: disables the snapping of bands to the page. This option is disabled by default, meaning bands automatically group on the page according to their function.
  • Gap between bands: allows you to change the gap between bands on the page.



Home Tab Tool Bar Functions


The "Home" tool bar contains all of your text and object editing, positioning, and alignment options.



Standard Tools

Icon
Name
Description

Save Report
Saves changes made to a report. Hot key combination "Ctrl+S".

Preview
Allows you to preview changes made to a report. Hot key combination "Ctrl+P".

Add New Page
Allows you to add a new page to a report.

Delete Page
Allows you to delete a page that has been added to a report.

Page Settings
Allows you to change the page size, margins, and settings for a report.


Clipboard Tools

Icon
Name
Description

Paste
Allows you to paste a copied item into a report.

Cut
Allows you to cut a selected object from a report.

Copy
Allows you to copy a selected object in a report.

Undo
Allows you to rollback a change made in a report.

Redo
Allows you to revert a rolled back change to its original state in a report.


Font Tools

Icon
Name
Description

Font Type
Shows the font of the selected "Text" object. This tool allows you to select from a drop-down list to change the font face of a selected object.

Font Size
Shows the font size of the selected "Text" object. This tool allows you to select from a drop-down list to change the font size of a selected object.

Bold
Allows you to bold a selected  "Text" object.

Italics
Allows you to italicize a selected "Text" object.

Underline
Allows you to underline a selected "Text" object.

Font Color
Allows you to choose the font color of a selected "Text" object.

Font Settings
Opens the "Font Settings" menu where you can choose additional font styles and effects.

Highlight
Opens a "Highlight Editor" dialogue that allows you to set a condition for highlighting an object in a report.


Text Alignment Tools

Icon
Name
Description

Text Rotation
Allows you to change the text rotation of an object in a report. The available rotation options are 0, 45, 90, 180, or 270.

Left Justify
Aligns the text to the left within the selected "Text" object's frame.

Center Justify
Aligns the text to the center within the selected "Text" object's frame.

Right Justify
Aligns the text to the right within the selected "Text" object's frame.

Block Justify
Aligns the text within the selected "Text" object's frame so that both the left and right sides of the text have a straight edge.

Align Top
Aligns the text to the top vertically within the selected "Text" object's frame.

Align Center
Aligns the text to the center vertically within the selected "Text" object's frame.

Align Bottom
Aligns the text to the bottom vertically within the selected "Text" object's frame.


Editing Tools

Icon
Name
Description

Find
Allows you to search for text within a report.

Replace
Allows you to find text within a report and replace it with different text.

Select All
Allows you to select all objects at the same time within a data band.


Object Alignment Tools

Icon
Name
Description

Align to Grid
Aligns the selected object to the grid.

Align Objects Left Edge
Aligns the left edge of all selected objects to the left edge of the first selected object.

Align Objects Horizontal Centers
Aligns the horizontal centers of all selected objects to the horizontal center of the first selected object.

Align Objects Right Edges
Aligns the right edge of all selected objects to the right edge of the first selected object.

Align Objects Top Edges
Aligns the top edge of all selected objects to the top edge of the first selected object.

Align Objects Vertical Centers
Aligns the vertical centers of all selected objects to the vertical center of the first selected object.

Align Objects Bottom Edges
Aligns the bottom edge of all selected objects to the bottom edge of the first selected object.

Space Objects Horizontally
Adjusts the space between selected objects equally in a horizontal direction.

Space Objects Vertically
Adjusts the space between selected objects equally in a vertical direction.

Center Horizontally
Allows you to individually center each object horizontally in a data band.

Center Vertically
Allows you to individually center each object vertically in a data band.

Size Objects Horizontally
Adjusts the size of objects horizontally to make them the same width as the first selected object.

Size Objects Vertically
Adjusts the size of objects vertically to make them the same height as the first selected object.



View Tab Tool Bar Functions


The "View" tool bar allows you to show or hide different elements of the report editor screen.


View Tool Bar Tools

Icon
Name
Description

Show Grid
Allows you to choose to show or hide the grid in the Report Design Workspace.

Align to Grid
Allows you to toggle on/off object auto grid alignment when moving objects in the Report Design Workspace.

Rulers
Allows you to toggle on/off the rulers in the Report Design Workspace.

Object Inspector
Allows you to toggle on/off the Object Inspector Panel.

Class Reference
Allows you to toggle on/off the Class Reference tab in the Database Tree Panel.

Report Script
Allows you to toggle on/off the Report Script tab in the Report Tree Panel.

Script Snippets
Allows you to select and use scripts in a report.



Insert Tab Tool Bar Functions


The "Insert" tab contains objects and items that can be used in a report.


Insert Tab Tools

Icon
Name
Description

Object Selection Tool
Allows you to use your mouse cursor to select objects, move objects in the report, and modify object size.

Hand Tool
Allows you to drag and move the entire report page. This tool is useful when using the Report Design Workspace in a high zoom mode.

Edit Text Tool
Allows in-place editing of a "Text" object. Holding the left mouse button and moving the cursor creates and sizes a new "Text" object and opens its editor.

Zoom Tool
Allows you to left-click to zoom in or right-click to zoom out. Holding the left mouse button while dragging zooms in to a selected area.


Insert Tab Report Items

Icon
Name
Description

Insert Band
Allows you to add another band object to a report. Bands are responsible for positioning objects on a page.

Insert Sub-Report
Allows you to insert a sub-report design page within the host page.

Picture
Allows you to insert a picture into the Report Design Workspace.

Text Field
Inserts a text object into the Report Design Workspace.

Shapes
Allows you to draw geometrical shapes in a report.

Barcode
Displays data as one of several barcode types including QR, UPC, 128, and more.

Rich Text
Inserts a Rich Text object into the Report Design Workspace.

System Text
Inserts system text like date, time, page numbers, and more into a report.



Format Tool Bar


The "Format" tab allows you to insert a frame into the Report Design Workspace.


Border Tools

Icon
Name
Description

Top Line
Allows you to toggle on/off the top frame line of a "Text" object.

Bottom Line
Allows you to toggle on/off the bottom frame line of a "Text" object.

Left Line
Allows you to toggle on/off the left frame line of a "Text" object.

Right Line
Allows you to toggle on/off the right frame line of a "Text" object.

No Frame Lines
Sets all four frame lines of a "Text" object on.

No Frame
Sets all four frame lines of a "Text" object off.

Frame Editor
Opens the Frame Editor window where you can set frame line style, width, color, and more.


Border Style Tools

Icon
Name
Description

Border Color
Allows you to change the color of the frame around a "Text" object.

Border Width
Allows you to change the width of the frame lines around a "Text" object.

Fill Color
Allows you to change the background color of a "Text" object.

Fill Style
Allows you to change the background style of a "Text" object including patterns, color gradients, and opacity.



The Report Editor Workspace


The Report Editor Workspace is where you make the changes to your Servant Keeper reports. The workspace is made up of several parts, so it is important to familiarize yourself with the different sections.


Report Design Workspace

The Report Design Workspace is where you will do the bulk of the editing of a report. It displays all of the objects that make up your report. In the Report Design Workspace, you can change the placement of objects by clicking and dragging the object to its new location. Using the keyboard shortcut <Ctrl>+<↑>, <↓>, <←>, or <→> will allow you to position objects in the Report Design Workspace with precision.



In the Report Design Workspace, you will notice that the information is laid out in several boxes known as data bands. A band serves as a container for the data in the report. The Report Editor uses bands to hold the objects they contain at a specific location on the page. There are several types of band available and some bands can be placed either horizontally or vertically in a report. Below are some common data bands you will see when editing reports in Servant Keeper.

  • Report Title: Displays information at the top of the first page of a report. You can use the TitleBeforeHeader property in the Object Inspector to determine whether the Report Title appears before or after the Page Header.
  • Page Header: Displays information at the top of each page.
  • Page Footer: Displays information at the bottom of each page.
  • Header: This band can be placed either horizontally or vertically on a page. If this band is used in a report, the header will appear on the first page or column of the report only, by default.
  • Footer: This band can be placed either horizontally or vertically on a page. If this band is used in a report, the footer will appear on the first page or column of the report only, by default.
  • Master Data: This band can be placed either horizontally or vertically on a page. It displays information in the body of the report. The Master Data band must be linked to a dataset using the Select Dataset tool. This band can contain the fields and information from the Servant Keeper database that you want to display on the report.
  • Detail Data: This band can be placed either horizontally or vertically on a page. It displays information in the body of the report. The Detail Data band must be linked to a dataset using the Select Dataset tool. Detail bands must always be placed below a Master band.
  • Group Header: This band can be placed either horizontally or vertically on a page. The Group Header band allows you to group bands together and is helpful when you want to group information and do calculations in a report.
  • Group Footer: This band can be placed either horizontally or vertically on a page. If this band is used in a report, the Group Footer will appear printed at the end of every group.
  • Child: This band can be placed either horizontally or vertically on a page. The Child band can be connected to any band, including another child band. It is printed immediately after its parent.
  • Column Header: This band is used when printing a multi-columned report (when the number of columns indicated in the page setup is more than one). It is printed at the top of every column after the Page Header band.
  • Column Footer: Printed at the bottom of every column, before the Page Footer band.
  • Overlay: This band is used to place images and/or objects you want to be on the entire page of the report. For example: background images or watermarks.


Object Inspector Panel

The Object Inspector Panel is where you can control the properties for the bands and objects that are used in a report. The object inspector is made up of two tabs. The Properties tab controls the different property options available for the selected band or object. The Events tab controls events that run a procedure in a script for an object.


Some common properties in the object inspector are:

  • Align: Allows you to change the alignment of an object relative to the band or page.
  • Auto Width: Allows you to choose whether or not an object will set its width automatically. When this option is enabled, it allows the object width to grow or shrink based on the data.
  • Shift Mode: Allows you to chose whether an object will shift downward if an object above it (with the stretch property enabled) stretches down into the area of the object below it.
  • Stretch Mode: Allows you to choose whether an object will stretch downward based on the data it contains.
  • Word Wrap: Allows you to choose whether or note the text in an object will wrap when it reaches the object right margin.
  • Visible: Allows you to choose whether or not an object is visible. When this option is disabled, the object will not show when previewing or printing the report.
  • Printable: Allows you to choose whether or not an object will print.

Many of these properties can also be accessed by right-clicking on an object in the Report Design Workspace.



Report Tree Panel

The Report Tree Panel is made up of two tabs. The Page1 tab allows you to view a list of all the bands and objects used in the first page of the report. Depending on the report and how it is being customized, there may be more tabs with the title Page# at the top. When you click on an item in the Page# tab in the Report Tree Panel, the item will be selected in the Report Design Workspace. Using the Report Tree to select the object you want to work with in the Report Design Workspace can be especially helpful when editing a report that contains many objects.



The Script tab displays the Script Editor and shows the script that is used in the report. The Script Editor can be used to write script to control various aspects of a report. The Script Editor allows you to write script in the following languages: Pascal script, C++ script, Basic script, and JScript. The scripts that are contained in any copied report from Servant Keeper are written in Pascal.



Data Tree Panel

The Data Tree Panel is made up of several tabs. The Database Fields tab is the primary tab that you will use in the panel. The Database Fields tab contains the Data Dictionary fields and all the data fields that are available to be used in a report.


The Database Fields tab is made up of four sections:

  • DataDictionaryData section is used if you want to show the Servant Keeper field names in a report.
  • FamilyMemberData section allows you to drag and drop Individual Profile data into a report.
  • FamilyProfileData section allows you to drag and drop Family Profile data into a report.
  • OrganizationData section allows you to include church/organization information.


The Report Variable tab allows you to see the list of variables that are used in the report. The Report Functions tab displays a list of available functions that can be used in a report. The Class Reference tab is turned off, by default, but when it is enabled it gives you a list of the procedures that you can use when using the Script Editor. The Script Snippets tab gives you a list of code snippets that you can click, drag, and drop into the Script Editor. The Script Snippets tab can save you time when writing script for a report. When you click on a script snippet, a brief description of the use or purpose for the code displays at the bottom of the tab.