opro japan co., ltd. - intramart · table of contents user’s guide – opro x designer i table of...

OPRO JAPAN CO., LTD.

User’s Guide

OPRO X Designer

O P R O X S E R V E R

User’s Guide OPRO X Designer

© OPRO Japan Co., Ltd.

6F, Shibashin Mita Bldg, 3-43-15, Shiba,

Minato-ku, Tokyo 105-0014

Japan.

URL: http://www.opro.net/en Phone +81-3-5765-6510 Fax +81-3-5765-6560

http://www.opro.net/en

Table of Contents

User’s Guide – OPRO X Designer

i

Table of Contents

Table of Contents...........................................................................i

About This Document ..................................................................ix

1.Introduction, Installation & Un-installation ...........................11 1.1 Checking System Requirements ..................................................................12

1.1.1 Hardware Requirements ............................................................................................ 12 1.1.2 Software Requirements............................................................................................... 12

1.2 Installing OXD ..............................................................................................13 1.2.1 File Extracting Dialog ................................................................................................. 13 1.2.2 Welcome Dialog......................................................................................................... 14 1.2.3 License Agreement Dialog ......................................................................................... 14 1.2.4 Customer Information Dialog..................................................................................... 15 1.2.5 Destination Folder Dialog .......................................................................................... 16 1.2.6 Ready to Install the Program Dialog......................................................................... 17 1.2.7 Installing OPRO X Designer Dialog .......................................................................... 17 1.2.8 Setup Complete Dialog.............................................................................................. 18

1.3 Uninstalling OXD .........................................................................................18 1.3.1 Obtaining Windows Control Panel........................................................................... 18 1.3.2 Selecting Add/Remove Programs Dialog ................................................................ 19 1.3.3 Add/Remove Programs Dialog................................................................................. 19 1.3.4 Add/Remove Programs Dialog Box ......................................................................... 20 1.3.5 Completing the OPRO X Designer Un-installation Process..................................... 20

2. Getting Started .............................................................22

3. Introduction to OXS......................................................24

4. OXD Components ........................................................27 4.1 Template .......................................................................................................27 4.2 Layout............................................................................................................27 4.3 Components .................................................................................................27

4.3.1 Standard Components ............................................................................................... 27 4.3.2 Additional Components.............................................................................................. 29 4.3.3 Form Components....................................................................................................... 31 4.3.4 Data Access Components .......................................................................................... 34 4.3.5 Security Components.................................................................................................. 35

Table of Contents


ii

4.3.6 Wizard Components...................................................................................................37

5. OXD Interface .............................................................. 39 5.1 Command/Functional Area........................................................................ 39

5.1.1 Main Menu ..................................................................................................................39 5.1.1.1 File Menu ...............................................................................................................39 5.1.1.1 Edit Menu...............................................................................................................44 5.1.1.1 View Menu ............................................................................................................46 5.1.1.1 Components Menu ...............................................................................................47 5.1.1.1 Options Menu .......................................................................................................48 5.1.1.1 Window Menu......................................................................................................58 5.1.1.1 Help Menu.............................................................................................................59

5.1.2 Tool Bars.......................................................................................................................59 5.1.1.1 File Tools ................................................................................................................59 5.1.1.1 Edit Tools................................................................................................................60 5.1.1.1 Help Tools..............................................................................................................60 5.1.1.1 Align and Size Tools.............................................................................................61 5.1.1.1 Front or Back Tools ...............................................................................................61

5.2 Component Properties................................................................................. 62 5.2.1 Overall Detailed Description......................................................................................62

5.2.1.1 General..................................................................................................................62 5.2.1.2 Font .........................................................................................................................63 5.2.1.3 Custom ...................................................................................................................63 5.2.1.4 Hyperlink................................................................................................................63 5.2.1.5 Data / URL Data ...................................................................................................63 5.2.1.6 Number Formats ...................................................................................................64

5.2.2 Standard Component Properties ...............................................................................65 5.2.2.1 Label.......................................................................................................................65 5.2.2.2 Image .....................................................................................................................66 5.2.2.3 Shape.....................................................................................................................67 5.2.2.4 Line .........................................................................................................................68 5.2.2.5 Date Time...............................................................................................................69 5.2.2.6 Page Number........................................................................................................72 5.2.2.7 Total Page Number ..............................................................................................79 5.2.2.8 Table.......................................................................................................................85 5.2.2.9 URLLabel ................................................................................................................86 5.2.2.10 URLImage...............................................................................................................87

5.2.3 Additional Component Properties..............................................................................89 5.2.3.1 URLExecute ............................................................................................................89 5.2.3.2 BarCode.................................................................................................................89 5.2.3.3 Graph.....................................................................................................................90 5.2.3.4 Chart.......................................................................................................................91 5.2.3.5 OCCS.....................................................................................................................92 5.2.3.6 SATO Label ...........................................................................................................93

5.2.4 Form Components .......................................................................................................93

Table of Contents


iii

5.2.4.1 InterfaceGroup ..................................................................................................... 93 5.2.4.2 Text......................................................................................................................... 94 5.2.4.3 Password ............................................................................................................... 94 5.2.4.4 Memo .................................................................................................................... 95 5.2.4.5 Dropdown ............................................................................................................. 95 5.2.4.6 List........................................................................................................................... 96 5.2.4.7 Check..................................................................................................................... 96 5.2.4.8 Radio ..................................................................................................................... 96 5.2.4.9 File.......................................................................................................................... 97 5.2.4.10 Submit .................................................................................................................... 97 5.2.4.11 Reset....................................................................................................................... 98 5.2.4.12 OFD I/O ............................................................................................................... 98 5.2.4.13 Invisible.................................................................................................................. 99 5.2.4.14 URLText.................................................................................................................. 99 5.2.4.15 URLMemo............................................................................................................100 5.2.4.16 URLDropDown....................................................................................................101 5.2.4.17 URLList..................................................................................................................103 5.2.4.18 URLInvisible .........................................................................................................104 5.2.4.19 DatasetDropDown .............................................................................................105 5.2.4.20 DatasetList ...........................................................................................................105

5.2.5 Data Access Component Properties .......................................................................105 5.2.5.1 Dataset ................................................................................................................105 5.2.5.2 TextDataset .........................................................................................................118 5.2.5.3 URLTextDataset...................................................................................................123 5.2.5.4 DatasetTable.......................................................................................................125 5.2.5.5 HorizontalDatasetTable.....................................................................................127 5.2.5.6 DatasetTable Container.....................................................................................130 5.2.5.7 AggregateFunction.............................................................................................130 5.2.5.8 DBExecute ...........................................................................................................131

5.2.6 Security.......................................................................................................................132 5.2.6.1 Document Security .............................................................................................132 5.2.6.2 Digital Signature.................................................................................................133 5.2.6.3 MistyGuard SignedPDF.....................................................................................136 5.2.6.4 VeriSign Digital Signature .................................................................................137 5.2.6.5 DocuWorks Signature........................................................................................137 5.2.6.6 TimeStamp...........................................................................................................138

5.2.7 Wizards .....................................................................................................................138 5.2.7.1 DatasetTable Wizard.........................................................................................138 5.2.7.2 SubReport Wizard .............................................................................................141 5.2.7.3 Graph Wizard....................................................................................................143 5.2.7.4 Dataset Change Wizard ...................................................................................147

5.2.8 Layout Properties.......................................................................................................149 5.2.9 Template Properties ..................................................................................................150

5.3 Editable/Report Area ............................................................................... 151 5.3.1 Explorer Tab ..............................................................................................................153 5.3.2 Property Tab ..............................................................................................................154

Table of Contents


iv

6. OXD Help ...........................................................................155

7. OPRO X Designer Tutorial.................................................156 7.1 Checking whether OXS is Installed Properly ..........................................156 7.2 Preparing a Simple Template Containing a DatasetTable ....................157 7.3 How to use Conditional Format ...............................................................161 7.4 Displaying data on the document ............................................................168

7.4.1 Directly displaying data on the document .............................................................168 7.4.2 Using a DatasetTable component ..........................................................................169 7.4.3 Using a DatasetTableContainer with a DatasetTable ..........................................169

7.5 Using headers and footers in the document ...........................................169 7.6 Using Expression Builder ..........................................................................170 7.7 Using Condition Builder ............................................................................170 7.8 Using Group By Editor ..............................................................................171 7.9 Using Order By Editor...............................................................................171 7.10 Using SubReports ......................................................................................172 7.11 Using AggregateFunction .........................................................................173

Expressions and Conditions for Visual Query Builder.........175 A.1 Expressions.................................................................................................175

A.1.1 {USERINPUT} .................................................................................................................175 A.1.2 Add Operator................................................................................................................175 A.1.3 Subtract Operator .........................................................................................................175 A.1.4 Multiply Operator .........................................................................................................176 A.1.5 Divide Operator ............................................................................................................176 A.1.6 Concatenation Operator..............................................................................................177 A.1.7 Text Value (Constant)....................................................................................................177 A.1.8 SUBSTRING () ...............................................................................................................177 A.1.9 LOWER() ........................................................................................................................178 A.1.10 UPPER() ........................................................................................................................178 A.1.11 SUM() ..........................................................................................................................179 A.1.12 MAX()...........................................................................................................................179 A.1.13 MIN() ...........................................................................................................................180 A.1.14 AVG()...........................................................................................................................180 A.1.15 COUNT().....................................................................................................................180 A.1.16 ABS ()...........................................................................................................................181 A.1.17 DISTINCT ().................................................................................................................181

B.2 Conditions ..................................................................................................182 B.2.1 {USERINPUT} ............................................................................................................182 B.2.2 Mathematical Operators .........................................................................................182

B.2.2.1 Add Operator .................................................................................................... 182 B.2.2.2 Subtract Operator.............................................................................................. 183

Table of Contents


v

B.2.2.3 Multiply Operator ..............................................................................................183 B.2.2.4 Divide Operator .................................................................................................183

B.2.3 Text Value (Constant) ...............................................................................................184 B.2.4 Conditional Operators .............................................................................................184

B.2.4.1 Equals Operator.................................................................................................184 B.2.4.2 Greater than Operator ......................................................................................185 B.2.4.3 Greater than or Equal Operator ......................................................................185 B.2.4.4 Less than Operator.............................................................................................186 B.2.4.5 Less than or Equal Operator .............................................................................186 B.2.4.6 Not Equal Operator...........................................................................................187

B.2.5 Logical Operators .....................................................................................................187 B.2.5.1 “AND” Operator................................................................................................187 B.2.5.2 “OR” Operator...................................................................................................188 B.2.5.3 “NOT” Operator................................................................................................188 A.2.5.4 “LIKE” Operator .................................................................................................188 A.2.5.6 Open and Close brackets .................................................................................189 A.2.5.6 Open and Close brackets .................................................................................189

Expressions and Conditions for Text Query Builder............ 190 B.1 Expressions ................................................................................................ 190

B.1.1 {USERINPUT}..................................................................................................................190 B.1.2 Mathamatical and Character Operators ...............................................................190 B.1.2 1 Sum Operator .............................................................................................................190 B.1.2 2 Subtract Operator ......................................................................................................190 B.1.2 3 Product Operator .......................................................................................................191 B.1.2.4 Quotient Operator .....................................................................................................191 B.1.2 5 Concatenate Operator ..............................................................................................191 B.1.2 6 Quotation of text string (Constant) ...........................................................................191 B.1.2 7.Quotation of field name (Constant)..........................................................................191 B.1.3 String Functions .........................................................................................................192 B.1.3 1 LEN()............................................................................................................................192 B.1.3.2 ISEMPTY() ...................................................................................................................192 B.1.3.3 MID() ...........................................................................................................................192 B.1.3.4 LEFT()............................................................................................................................192 B.1.3 5.RIGHT()........................................................................................................................193 B.1.3 6.LENB()..........................................................................................................................193 B.1.3.7 SUBSTRINGB() ...........................................................................................................193 B.1.3 8 MIDB().........................................................................................................................194 B.1.3 9.LEFTB() .........................................................................................................................194 B.1.3 10.RIGHTB()...................................................................................................................194 B.1.3 11.CONTAINS() ...........................................................................................................194 B.1.3 12 STARTSWITH() .........................................................................................................195 B.1.3 13 ENDSWITH()............................................................................................................195 B.1.3 14 SEARCH() .................................................................................................................195 B.1.3.15 SUBSTITUTE() ...........................................................................................................195

Table of Contents


vi

B.1.3 16.FIND() .......................................................................................................................196 B.1.3 17.REPLACEALL () .........................................................................................................196 B.1.3 18.REPLACEFIRST() .......................................................................................................196 B.1.3 19.CONCATANATE() ..................................................................................................196 B.1.3 20 REPT ().......................................................................................................................197 B.1.3 21.TRIM () ......................................................................................................................197 B.1.3 22.LOWER () .................................................................................................................197 B.1.3 23.UPPER() .....................................................................................................................197 B.1.3 24.CHAR() .....................................................................................................................197 B.1.3 25.SUBSTRING () .........................................................................................................198 B.1.4 Conditional Branching Functions ............................................................................198 B.1.4 1 IF()................................................................................................................................198 B.1.5 Numeric Functions ....................................................................................................199 B.1.5 1.ISNUMBER () .............................................................................................................199 B.1.5 2 CEILING () ..................................................................................................................199 B.1.5 3 FLOOR ().....................................................................................................................199 B.1.5 4 ROUND ()...................................................................................................................199 B.1.5 5 ROUNDEVEN ()......................................................................................................... 200 B.1.5 6.ABS () ..........................................................................................................................200 B.1.5 7.SIGN () .......................................................................................................................201 B.1.5 8.MOD () .......................................................................................................................201 B.1.5 9.POWER () ...................................................................................................................201 B.1.5 10.SQRT () .....................................................................................................................201 B.1.5 11.EXP()..........................................................................................................................201 B.1.5 12.LN () ..........................................................................................................................202 B.1.5 13.LOG ().......................................................................................................................202 B.1.5 14.TO_NUMBER ().......................................................................................................202 B.1.5 15.FORMAT_NUMBER ()............................................................................................202 B.1.6 Date Time Functions..................................................................................................203 B.1.6 1.ISDATE()......................................................................................................................203 B.1.6 2 YEAR () ........................................................................................................................203 B.1.6 3 MONTH() ...................................................................................................................203 B.1.6 4 DAY()...........................................................................................................................203 B.1.6 5 HOUR () ......................................................................................................................204 B.1.6 6 MINUTE () ..................................................................................................................204 B.1.6 7 SECOND()..................................................................................................................204 B.1.6 8 TO_DATE() .................................................................................................................204 B.1.6 9.FORMAT_DATE ()...................................................................................................... 205 B.1.6 10.NOW () ....................................................................................................................205 B.1.6 11.TODAY()...................................................................................................................205 B.1.7. Conditional Operators .............................................................................................205 B.1.7 1.Equals Operator.........................................................................................................205 B.1.7 2.Greater than Operator .............................................................................................. 206 B.1.7 3.Greater than or Equal Operator ..............................................................................206 B.1.7 4.Less than Operator.....................................................................................................206 B.1.7 5.Less than or Equal Operator .....................................................................................206

Table of Contents


vii

B.1.7 6.Not Equal to Operator ..............................................................................................207 B.1.8.Logical Operators ..........................................................................................................207 B.1.8 1. “AND” Operator.......................................................................................................207 B.1.8 2. “OR” Operator..........................................................................................................207 B.1.8 3. “NOT” Operator.......................................................................................................207

Acronyms................................................................................. 208

About This Document

User’s Guide – OPRO X Designer ix

About This Document

This document contains a detailed description of the OPRO X Designer (OXD) for OPRO X Server (OXS). It describes the functional aspects while giving an overall introduction to OXD.

This document would be useful especially for the Template Designers who use the OXD to design Templates, and also to any other user who may need to understand the functionalities of the OXD.

A basic knowledge of the OXS architecture and its components are required to understand and make full use of this document. (A basic introduction to OXS is provided in Chapter 3 of this document.)

The conventions used in this document are simple to follow. The words in bold and italic will highlight a particular option in the OXD and the topic would be discussed in detail where appropriate. In this document, Template is also referred as Document Template. The document has been broken down into several chapters for easy reading and quick referencing, thereby making it easier for the user to read through the document. Date: February 2010.

Chapter 2– Getting Started

User’s Guide – OPRO X Designer 11

1.Introduction, Installation & Un-installation

Introduction

The OPRO X Designer (OXD) is a versatile tool that allows the user to develop various types of Document Templates within the OXS.

The user is given the freedom of getting information for Document Templates from various sources such as the databases connected to the OXS and various service modules of the OXS with a click of a button. The OXD is one of the designer’s end tools of the OXS.

The OXD comes with OPRO File Manager Service Administrator (OFMSA). OFMSA is a management console used to administer the OPRO File Manager Service (OFMS). OFMSA can be used to create directories, open, upload or download files.

The OXD is a complete and a unique tool that makes document creation the simplest activity imaginable.

The new OPRO X Designer supports XP Visual Style. All the Windows controls that are included in the OPRO X Designer application (Buttons, Dropdown Menus, Edit Boxes, Spinner Controls, etc) take the appearance and the shape of Windows XP based controls in a Windows XP environment. As an example, the New Template dialog of the OPRO X Designer will be as follows in a Windows XP environment.

Figure 1.1 Figure 1.2 New Template Dialog in Windows 2000 Enviornment New Template Dialog in Windows XP Enviornment

The functionality of the OXD shall be discussed in this document, to the level of operational aspects.

Chapter 1



1.1 Checking System Requirements

Before setting up OXD, you need to check the hardware and software requirements of your machine. Completing a quick, successful installation depends on the local system satisfying the software dependencies and space requirements for the software. This section describes the requirements for installing OXD. Verify that the system meets the necessary requirements before starting the installation. 1.1.1 Hardware Requirements

Hardware Requirements Memory A minimum of 256 MB RAM is required. CPU & Processor Intel Pentium III, 500 MHz Hard Disk Space A minimum of 90 MB hard disk space is required.

Table 1.1 –Hardware Requirements

1.1.2 Software Requirements

Software Requirements

Operating System

Windows NT4.0 (Server/ Workstation) (SP4 or higher), Windows 2000(Server/ Professional) (SP1 or higher) Windows XP Professional, Windows 2003, Windows Vista and Windows 7.

Table 1.2 – Software Requirements



The following illustrations describe the step-by-step instructions provided during the installation. The actual screens may vary according to your machine's environment and the OXD release or the version that you will install.

Note

1.2 Installing OXD

If your machine satisfies the system requirements described in the previous section you can start the OXD installation. Execute SETUP.exe that comes with the OXD installation. It is recommended to exit from all applications before executing the OXD setup.

1.2.1 File Extracting Dialog

Figure 1.3 - File Extracting Dialog

Wait until the setup extracts files to a temporary location (Windows Temp directory) and displays the Welcome dialog.



1.2.2 Welcome Dialog

When you get the Welcome dialog, click on the Next button to continue with the OXD installation.

Figure 1.4 - Welcome Dialog

1.2.3 License Agreement Dialog

This dialog shows the license agreement. In order to view the full license agreement, use the Page Down key or the horizontal scroll bar. Click I accept the terms in the license agreement, if you agree with the terms in the license agreement. Thereafter click on the Next button to continue with the OXD installation. The license agreement can be also printed through the Print button.

Figure 1.5 – License Agreement Dialog



1.2.4 Customer Information Dialog

The setup automatically takes the customer information from the operating system when they are available. You may edit this information if necessary and click on the Next button to continue with the OXD installation. Anyone who uses this computer (all users) option allows installing OXD for all the users. Only for me option allows installing OXD application only for the person who is currently logged into the computer and executing the OXD installation.

Figure 1.6 - Customer Information Dialog



1.2.5 Destination Folder Dialog

Setup copies files by creating a folder OPRO and a sub folder OPRO X Designer in your Program Files folder. This is the default installation path for OXD. You may change the default location if necessary, by clicking on the Change button.

Figure 1.7 - Destination Folder Dialog

Figure 1.8 – Change Current Destination Folder Dialog When changing the destination from the Change Current Destination Folder dialog, you can select an existing folder from the Look in drop down or type in the full path of the destination folder in the Folder name text field. You can create a new folder through the New Folder button.



1.2.6 Ready to Install the Program Dialog

When the setup is ready to copy files into your machine, Ready to Install the Program dialog displays the collected information. To change these information click on the Back button. To install OXD, click on the Next button.

Figure 1.9 – Ready to Install the Program Dialog 1.2.7 Installing OPRO X Designer Dialog

When the OXD installation is copying files, this dialog will display the progress of copying the files to the specified destination folder. The Setup Complete dialog will be displayed after copying all the files for the OXD application.

Figure 1.10 – Installing OPRO X Designer Dialog



Before uninstalling OXD, make sure that you have closed the OXD application.

Note

1.2.8 Setup Complete Dialog

After completing the OXD installation successfully, you will get a InstallShield Wizard Completed dialog. Please click on the Finish button in order to complete and exit from the OXD installation.

Figure 1.11 – Setup Complete Dialog

1.3 Uninstalling OXD

This section describes the procedure to uninstall OXD from your machine. You can uninstall OXD through the Add/Remove Programs option available in the Control Panel.

1.3.1 Obtaining Windows Control Panel

To obtain Windows Control Panel proceed to the Windows Start menu and click Start Settings Control Panel.



Figure 1.13 – Selecting Windows Control Panel

1.3.2 Selecting Add/Remove Programs Dialog

Double click on the Add/Remove Programs option available in the Windows Control Panel to obtain the Add/Remove Programs dialog.

Figure 1.14 – Selecting Add/Remove Programs option

1.3.3 Add/Remove Programs Dialog

The Add/Remove Programs dialog will be displayed which shows the installed programs in your machine. Thereafter, select OPRO X Designer from the program listing of the Add/Remove Programs dialog and click on the Remove button.



Figure 1.15 – Selecting the OPRO X Designer from the listing and Clicking on the Remove Button

1.3.4 Add/Remove Programs Dialog Box

Add/Remove Programs dialog box will be displayed prompting for the confirmation to delete files, which are in the folder where OXD has been installed. Click on the Yes button to confirm deletion and proceed with the OXD Un-installation process. Click on the No button to stop uninstalling OXD.

Figure 1.16 – Add/Remove Programs Dialog Box

1.3.5 Completing the OPRO X Designer Un-installation Process

After clicking on the Yes button on the Add/Remove Programs dialog box, the OXD Un-installation process will begin automatically. Here a dialog will be displayed, which shows the status of the OXD Un-installation process.



Sometimes when uninstalling OXD, the OXD Un-installation process will prompt for the removal of .dll files through the Remove Shared File? dialog. Click on the Yes button to remove such files, which are in the folder where OXD has been installed.

Note

Figure 1.17 – OPRO X Designer Un-installation Progress



2. Getting Started After installing OXD, the user can execute the OPRO X Designer application. Select OPRO X Designer from the Programs menu of the Windows Start menu. When OXD is loaded for the first time, OXD will display the following dialog, requesting the user to enter the Serial Number.

Figure 2.1 – OXD Serial Key Input Dialog Box Please enter a valid Serial number provided with OXD and click on the OK button. With a valid Serial key, you can enjoy the most powerful features of OXD. If you click on the Cancel button, the OXD application will be executed as a trial version, where the option to save a Template will be disabled. In order to obtain previews of the Templates that have been designed and to request Documents from OXS, you need to connect to the OXS via a CGI or a Servlet. Furthermore, to generate an HTML download page, you need to specify the default-en.html file path. To add these settings and to configure OXD, please go to the Options menu and select Environment Options. The Environment Options dialog will be displayed (Refer figure 2.2). To specify the CGI/ Servlet URL path, please go to the General tab and add the path of the CGI/Servlet to the OXS dropdown menu. If you are connecting via a Proxy server, assign the Proxy Address and the Port via the Internet Options dialog, which can be obtained by clicking the Settings button. To specify the HTML template, which is used to generate an HTML download page, select

the path of the default-en.html file by clicking on the browse button ( ). The default-en.html file will be provided with the OXD installation, which is located in the GenHtml folder of the OXD directory.

Chapter 2



You can also choose the default format for the preview output. You can select formats ranging from OPR (OPRO Print Report), PDF, HTML or XDW (DocuWorks Document). The default format is OPR. Click on the OK button to apply all the changes, which were done. The Environment Options dialog box will close once the changes made are permanent. Refer section 5.1.1.5 to carryout further configurations to the OXD application.

Figure 2.2 – Environment Options Dialog

Chapter 3 – Introduction to OXS


3. Introduction to OXS OPRO X Server (OXS) controls multiple databases as data sources on the network (Intranet/Internet) and provides outputs in various formats to the client. They are:

• OPR (OPRO Print Report, opened and printed using OPRO X Browser) • OXR (OPRO XML Report) • PDF (Portable Document Format) • XML (Extensible Markup Language) • ODP (OPRO Direct Print) • XDW (DocuWorks Document) • HTML (Hyper Text Markup Language) • CSV (Comma Separated Value)

OPRO X Server generates Documents in OPR and OXR formats that can be viewed and printed via OPRO X Browser. OXR is the decompressed version of OPR file format, which is an instance of XML, encoded in UTF-8. The Documents, which are generated by the HTML format, can be effectively browsed via a web browser such as the Internet Explorer or the Netscape Navigator. PDF documents can be viewed through the Adobe Acrobat Reader. The OPRO X Server generates .ODP files when there is a request to print the Document via the Direct to Print function. ODP is a unique file format, which enables the OPRO X Browser (hereafter referred to as OXB) to print the generated Document via the default printer installed at the OXB client’s side without opening the Document in OXB. The OPRO X Server generates DocuWorks Documents (.XDW), which can be viewed through Fuji Xerox document viewers like DocuWorks Viewer. In order to generate DocuWorks Documents through OXS, the DocuWorks Desk 5.0 application should be installed in the machine that runs OXS. OXS consists of execution services, a development service, development tools, Servlet and a CGI application. OXS is the main execution service, which has the overall control on other included services. OPRO Data Connection Service (one of the included services, hereafter referred to as the ODCS) is used to connect to various databases to retrieve information and presents this

Chapter 3

Chapter 3 – Introduction to OXS


information to other modules of OXS. This service also acts as a converter of ANSI SQL to database specific SQL. OPRO Document Data Service (ODDS) is another service, which generate documents using the Templates designed by the OPRO X Designer. The OPRO Data Transfer Service (ODTS) is mainly responsible for forwarding database query results in CSV format and XML format. These queries can be created by saving a dataset component as an OPRO Query Maker (.oqm) file in OXD. OPRO File Manager Service (OFMS) is a secured centralized file repository, which can be used to store and retrieve files from a remote location by the applications of OXS. OPRO Schema Manager Service (OSMS) is the development service that provides database information such as database name, table name, view name and field information, which are requested by the development tools.

Chapter 5– OXD Interface


4. OXD Components

4.1 Template

Template is the basic container, which can be used to generate Documents frameworks. A Template contains multiple layouts. Various components, which are provided with the OXD, can be placed on these layouts. A Template is saved as an OPRO X Designer Template (.oxt) file.

4.2 Layout

Layout is the place where all the components provided with the OXD are placed and arranged. Layout represents a paper and it has all the paper properties. A Template can have multiple layouts.

4.3 Components

The OXD components are found on the OXD component palette. These components are divided into six groups and are placed in six tabs, namely, Standard, Additional, Form, Data Access, Security and Wizards.

4.3.1 Standard Components

The Standard components are found on the Standard tab of the components palette. The standard components in the OXD are as follows (They are further discussed later in the document under OXD Interface – section 5.2.1).

• Label: The Label component ( ) is used to display text in a Layout.

• Image: The Image component ( ) is used to insert an image into a Layout. The supported Image types are;

o JPEG Image File (.jpg, .jpeg)

o Bitmap Image File (.bmp)

o Portable Network Graphics Image File (.png)

Chapter 4



o GIF Image File (.gif)

o Tagged Image File Format (.tiff)

The images can be loaded as a file, a URL or from a scanner.

• Shape: The Shape component ( ) is used to display a geometric shape in a layout. Following shapes can be displayed using this component.

1. Rectangle

2. RoundRect (Rectangle with curved edges)

3. Ellipse

• Line: The Line component ( ) is used to insert a line of the selected style into the selected layout. The line types, which this component supports, are Solid, Dash, Dot, DashDot and DashDotDot.

• Date Time: The Date Time component ( ) is used to display the Document generation date, time or both.

• Page Number: The Page Number component ( ) is used to display the page numbers of a generated Document. The page numbers will dynamically increase with the design and the volume of data obtained from a Database.

• Total Page Number: The Total Page Number component ( ) is used to display the total number of pages for a Layout, Template or for a Document. A Layout, Template or a Document can contain one or more pages. Total Page Number component helps to display the total amount of pages for a Layout Cycle, Template Cycle or the Document Cycle (Refer section 5.2.2.7).



• Table: The Table component ( ) will allow the user to design tables with the use of bands and columns. The Table component is ideal to represent data manually in a tabular form. Since this is a container type component (that is, a component which can have child components), with the use of Alt key and the left mouse button you can select each Column of a Band (Bands and Columns) within the Table component. If you want to select the entire Band component of that Column component, press the Esc key.

• URLLabel: The URLLabel component ( ) is used to display text retrieved through a URL address or from a file local to OXS.

• URLImage: The URLImage component ( ) is used to insert an Image into the Layout through a specified URL address or from a file local to OXS. The supported Image types are;

o JPEG Image File (.jpg, .jpeg)

o Bitmap Image File (.bmp)

o Portable Network Graphics Image File (.png)

o GIF Image File (.gif)

o Tagged Image File Format (.tiff).

4.3.2 Additional Components

These components are found in the Additional Tab in the OXD Component Palette.

• URLExecute: The URLExecute component ( ) is used to execute applications hosted externally during the report generation time. (E.g. if you want to call an external Java Servlet (JSP) to obtain data from an external web application before/after creating the Document, you have to insert an URL execute component.).

Even though you can add a large number of bands and columns, the number of bands or columns will limit the performance of your computer.

Note



• BarCode: The BarCode component ( ) is used to insert static, request and database type data as BarCodes into the Template. The Barcode is simply a set of symbols used to represent alphanumeric information. The input value is converted to a BarCode image and it is displayed on the Template. Use of the BarCode becomes more meaningful when the user requests a BarCode from the server and when the generated BarCode image is loaded into the Template. If the type is Static, user can view the Barcode image at the design time itself (Please note that for Static BarCode, the image is not saved in the Template (.oxt) file. User has to request the image again once the Template is re-opened if required.).

• Graph: The Graph component ( ) is used to provide a visual representation of data on a Document Template using database values or static data. When the user selects the Type as Static, he/she has to enter values in the given grid. When user selects the Type as Database, user has to select the corresponding table fields for X, Y (Series), Points respectively.

• Chart: The Chart component ( ) is very similar to the Graph component and used to provide a visual representation of data on a Document Template using database values or static data. When the user selects the Type as Static, he/she has to enter values in the given grid. When user selects the Type as Database, user has to select the corresponding table fields for X, Y (Series), Points respectively. Chart component has advanced features such as better color and font options and advanced chart operations.

• OCCS: The OCCS component ( ) is used to retrieve files such as sound, dynamic images and even static binary data in the OPRO Content Control Service (OCCS). OCCS will store and retrieve Images (*.png; *.gif; *.jpg; *.jpeg; *.bmp; *.ico; *.emf; *.wmf, *.tiff), Audio (*.mp3; *.m3u; .wav; *.wma; *.rm; *.rmi; *.au; *.midi; *.aif; *.aiff) and Video (*.dat; *.mpg; *.mpeg; *.mpa; *.mp2; *.m1v; *.mov; *.avi) files. User must have the OCCS Administrator to add these files to the OCCS.

Current version of OXD (Version 2) only allows loading image files from OCCS. There also is an URL address embedded to the images in most of the cases.

Note



• SATO Label: The SATO Label component ( ) enables the OXD user to print Barcodes and text through a high-speed thermal SATO Barcode Label printers using the device fonts printer. SATO Label component can be used with OXB and OIPS. In order to print the values in the Barcode format, Barcode type of font has to be selected. It should be noted that the actual Barcode can only be seen after it has been printed through a Barcode printer and it cannot be seen during design time, in preview or by printing through a normal printer.

4.3.3 Form Components

The Form components are found in the Form Tab of the components palette. Please note that all the Form components (except InterfaceGroup component and the OFD I/O component) must be placed within an InterfaceGroup component.

• InterfaceGroup: The InterfaceGroup component ( ) allows the OXD user to place form controls on it and makes it behave like an e-Form when the Template is being previewed. In other words this basically behaves as a container to produce an electronic form.

PDF does not support using InterfaceGroup in DatasetTable's GroupBand or DataBand. PDF will display only the first group of the InterfaceGroup.

Note

The PDF Document containing an InterfaceGroup, which contains fonts that are not PDF base 14 fonts, can be viewed only using Acrobat 5 or above versions.

Note

InterfaceGroup components in the Form tab will not support EUDC fonts for PDF.

Note



• Text: The Text component ( ) is used to place a standard Windows control on a generated eForm, which can be used to enter text.

• Password: The Password component ( ) is used to place a standard Windows control, which enables the generated eForm to contain a password field. The password will be displayed as * characters instead of any entered text.

• Memo: The Memo component ( ) is used to place a standard Windows control, which allows the user to enter multi-line text into a generated eForm. It will also allow the user to enter a large amount of data into an eForm.

• Dropdown: The Dropdown component ( ) is used to place a standard Windows control, which allows the user to select an item from the pull down list on the generated eForm. The selected item will be displayed in the Dropdown menu. During design time, items in the Dropdown menu cannot be selected.

• List: The List component ( ) is used to place a standard Windows control with a scrollable list of items on a generated eForm. It will allow the user to select multiple items from the list available on the generated eForm.

• Check: The Check component ( ) is used to place a standard Windows control on a generated eForm, which provides the user to select an option where the user can click on the check box to select or to deselect an option. A check box is usually associated with a Yes/No field.

• Radio: The Radio button component ( ) is used to place a standard Windows control on a generated eForm, which provides a set of mutually exclusive options to the user. Only a single Radio button in a group can be selected at any time. When the user selects a Radio button, the previously selected Radio button becomes unselected.

• Submit: The Submit button component ( ) is used to place a standard Windows push button, which can be used to submit information entered into a generated eForm.



• Reset: The Reset button component ( ) is used to place a standard Windows push button, which can be used to clear the values entered into a generated eForm.

• Invisible: The Invisible component ( ) is used to send hidden information to the OPRO X Server.

• URLText: The URLText component ( ) is used to place a standard Windows control on a generated eForm, which allows the user to load text from a specified URL or from a text file local to OXS.

• URLMemo: The URLMemo component ( ) is used to place a standard Windows control on a generated eForm, which allows the user to load multi line text from a specified URL or from a text file local to OXS.

• URLDropDown: The URLDropDown component ( ) is used to place a standard Windows control, which allows the user to select an item from the pull down list, where the list of items can be loaded from a specified URL or from a text file local to OXS.

• URLList: The URLList component ( ) is used to place a standard Windows control, which allows the user to select multiple items from the list, where the list of items can be loaded from a specified URL or from a text file local to OXS.

• URLInvisible: The URLInvisible component ( ) is used to send hidden information to the OPRO X Server, which can be loaded from a URL or from a text file local to OXS.

• File: The File component ( ) is used to upload files, which contains a text box and a browse button. When this component is placed on an InterfaceGroup, it will display a message when URL-encoded option is selected, in the InterfaceGroup. A Submit component should be used to submit a request.

• OFD I/O: The OFD I/O component ( ) is used to allow the user to Save or Load form data. When the template is previewed in PDF or HTML, this functionality will be ignored.



• DatasetDropDown: The DatasetDropDown component ( ) is used to place a standard Windows control, which allows the user to select an item from the pull down list, where the list of items can be loaded from a Dataset.

• DatasetList: The DatasetList component ( ) is used to display the list of items, which can be loaded from a Dataset.

4.3.4 Data Access Components

• Dataset: The Dataset provides an encapsulation of a database. The

Dataset component ( ) is used to access data in a database. This provides direct access to every record and every field in a selected a Database through the Query Builder. The database, which is used to connect, can be of MS ACCESS, LOTUS, SYBASE, POSTGRESQL, ORACLE, SQL, MYSQL, DB2, DB2native, CACHE, OPROXML, and INFOMIX. The selected (filtered) fields/expression can also be dragged into the Template, DatasetTable or HorizontalDatasetTable.

• TextDataset: The TextDataset component ( ) is similar to the Dataset component, but the data is not loaded through a database. Instead, data will be loaded from a text/CSV file, which acts as a Dataset. The TextDataset component supports text/CSV files, which has data in the Unicode form. Data, which in UTF-16 little endian or Shift_JIS encoding form, are supported by the TextDataset component.

• URLTextDataset: The URLTextDataset component ( ) is very much similar to the TextDataset component, where no database is involved. The URLTextDataset enables the loading of data from a text/CSV file, which is in a specified URL path. The URLTextDataset component supports text/CSV files, which has data in the Unicode form. Data, which in UTF-16 little endian, UTF-16 big endian, UTF-8 or Shift_JIS encoding form are supported by the URLTextDataset component.

• DatasetTable: The DatasetTable component ( ) is similar to the Table component, which allows users to design with the use of bands and columns. However this component has the ability of linking database fields. Furthermore, the user can place another



DatasetTable inside the Parent DatasetTable, which makes it possible to create sub reports.

• HorizontalDatasetTable: The HorizontalDatasetTable component ( ) is similar to a DatasetTable component, however the data bands grow horizontally. That is, when the database returns multiple results, the new rows containing them will be added horizontally. In other words the table will grow left to right.

• DatasetTableContainer: The DatasetTableContainer component ( ) is a container where the user can place more than one DatasetTable and align them inside the container.

• Aggregate Function: The Aggregate Function component ( ) is used to find the aggregation of a selected database field. Since this is a database component, the user is unable to see the result at the design stage. Aggregate functions like SUM, MAX, MIN, AVG and COUNT are supported and component functions only in group bands and report header/footer bands.

• DBExecute: The DBExecute component ( ) is capable of executing database scripts. The scripts specified for a particular database can be triggered to execute before or after the document creation. It allows specifying number of scripts for a component.

4.3.5 Security Components

• Document Security: The Document Security component ( ) adds password protection to the document. There are two passwords that can be associated with the document. One is the User Password, which will only grant the permissions that were ticked in the Permissions area of the Active Component tab, when creating the document. The other is the Master Password. If the Master Password was entered it gives full access to the document.

• Digital Signature: The Digital Signature component ( ) is used to authenticate the validity of a Document Template. The Digital Signature component allows the creator of the Document Template to authenticate the document by adding a unique signature onto the Document Template. If the document is modified in anyway after it has been created, the signature will be invalid. There are two other instances where the document cannot



be guaranteed upon; when the Digital Signature has not been activated or when the signature has expired. User (who places the signature) has to login in order to authenticate, when placing Digital Signature component. A new User profile should be created when logging in as a new user.

• MistyGuard SignedPDF: The MistyGuard SignedPDF component ( ) is used to place MistyGuard Digital signatures in the PDF output documents. Author of the document has to login to an initialized and certified slot when placing MistyGuard SignedPDF component. Out of the thirty-two possible slots, only the initialized and certified slots are usable for signing documents.

• VeriSign Digital Signature: The VeriSign Digital Signature component ( ) allows the usage of a digital signature from a third-party digital signature vendor called VeriSign, for more stringent e-signing requirements. A Digital ID is needed to send secure messages. It provides the means of proving ones identity on the Internet. A digital ID can be obtained from VeriSign Inc. The Extension of the digital ID is .pfx (MSIE)/. p12(Netscape) can get VeriSign Digital ID from http://digitalid.verisign.com.

• DocuWorks Signature: The DocuWorks Signature component ( ) is used to electronically sign a DocuWorks document. The security encryption is based on the Public Key Infrastructure.

• TimeStamp: The TimeStamp component ( ) is used to provide verification and content authenticity of the Document being generated by the OPRO X Server. The TimeStamp component provides a time-stamp, which is essential to guarantee that the Document existed at a point-in-time and that; the contents have not changed since that time.

A PDF output document containing a Digital Signature can be viewed only using Acrobat 5.x versions or above.

Note

For the functioning of the MistyGuard SignedPDF component, you have to obtain the necessary serial key(s) from the OXS Service Administrator or from the vendor.

Note

http://digitalid.verisign.com/



The TimeStamp component is essential in the following situations.

• Evidence of the existence - The TimeStamp component guarantees that the generated Document existed at a point-in-time.

• Proof of delivery - The use of the TimeStamp component proves that the transmitted Document has reached the recipient, as well as that the recipient has received the Document. This is known as the Delivery Evidence, which is equivalent to registered mail, as we know in the paper post services. This contributes to avoid repudiation threat.

4.3.6 Wizard Components

• DatasetTable Wizard: The DatasetTable Wizard ( ) allows creating a Document Template containing DatasetTables without creating them manually.

• SubReport Wizard: The SubReport Wizard ( ) allows creating sub reports without creating them manually.

• Graph Wizard: The Graph Wizard ( ) helps to create graphs with step-by-step guidance, which eases the user from creating it manually.

• Dataset Change Wizard: The Dataset Change Wizard component ( ) is used to change from one Dataset (used in components’ properties) into another Dataset. In other words, the properties of all components, which correspond to the first Dataset, are changed to the second Dataset. The wizard is capable of not only changing Dataset, but also changing between Dataset, TextDataset and URLTextDataset.

The wizards are a set of powerful tools that have been incorporated into the OXD. The above wizards have been provided to assist the user to create complex reports without any inconvenience and with the least amount of effort.

Chapter 7 OPRO X Designer Tutorial


5. OXD Interface

Let us now take a closer look at the OXD interface, its menus and icons. Please note that the Component Palette will not be discussed since it has been explained in the previous chapter of this document.

5.1 Command/Functional Area

Figure 5.1- Command/Functional Area

5.1.1 Main Menu

First, we shall go through the sub menus of the Main Menu in OXD to further understand its functionality.

5.1.1.1 File Menu

Figure 5.2 – File Menu

Chapter 5



This menu contains the following file related commands.

• New Template ( ): Opens a new template within the OXD application. When New Template option is selected from the file menu, the New Template dialog will be displayed.

Figure 5.3 – New Template Dialog

With the help of the New Template dialog box, the user can change the properties of each new layout. Multiple Layouts can also be added using the Add button and each of these layouts can have different property values assigned. The user can disable the New Template dialog box by checking the provided (Don’t show this dialog again) option. The users also can enable/disable New Template dialog box by checking/un checking the New Template Dialog option in the Environment Options dialog box (Environment Options dialog box can be obtained using the Environment Options option in the Options menu).

• Based on Present Template…: This creates form Templates when a result Template is given and vise-versa.



Figure 5.4 – Template Wizard Dialog

The Template Wizard is a simple converter, which allows the user to create a form Template from a result Template (or vise versa), with minimum user interaction.

A form Template contains an InterfaceGroup and form components such as Text, Memo, DropDown, List, Check, Radio, Submit Reset, etc, which can be used to generate a result Template.

A result Template should contain request type Labels or Datasets with user-input which can be used to generate a form Template. There must be at least a minimum of one request type Label or a Dataset with user-input for this section of the wizard to function.

When generating a form Template from a given result Template the user is required to specify the configuration required for the form in the form Template. He/she should carryout the necessary configurations provided in next few steps provided in the Template Wizard dialog box. The relevant basic components (i.e., Invisible components for TP, FM, ES parameters and Submit and Reset buttons) are created apart from the newly converted components.

• Add Layout: Inserts a Layout to the currently selected Template.

The Template should be saved before executing the Template Wizard. At least one of the components, which is used in the result Template should have Request as Data type or the component should be a form component.

Note



• Rename Layout: Allows the user to rename the currently selected Layout.

• Remove Layout: Removes the currently selected Layout from the Template.

• Open Template ( ): Opens an existing Template (*.oxt file). From Local option allows opening a Template located in your local hard drive. From OFMS option allows opening a Template stored in the OFMS (OPRO File Manager Server).

• Reopen Template: Reopens a Template, which was recently opened.

• Close Template ( ): Closes the currently active Template.

• Close All Templates: Closes all the Templates.

• Save Template ( ): Saves the current working Template to the local hard drive.

• Save Template As ( ): Saves the current working Template. To Local option allows saving the Template in your local hard drive. To OFMS option allows saving the Template into OFMS (Saving to OFMS will be discussed later).

• Save All Templates ( ): Saves all the Templates, which are currently opened, to the local hard drive.

• Preview ( ): This will allow the user to bring up an on screen preview of the active Template. In order to preview the Template the user has to select the preview format (OPR - OPRO Print Report, PDF, HTML and XDW) and also should specify the CGI/Servlet path for OXS in Environment Options. (Some Document Templates may not support HTML format).

OPR is a report format developed by OPRO. User should have the OPRO X Browser installed in the computer to browse an OPR file.

Note



• Exit ( ): Terminates the OPRO X Designer application.

The PDF output document containing Unicode fonts can be viewed only using Acrobat 5.x versions or above.

Note



5.1.1.1 Edit Menu

Figure 5.5 – Edit Menu

This menu contains commands, which facilitates editing of Templates.

• Undo ( ): Removes the final change done on the Template.

• Redo ( ): Applies the last change, which was undone.

• Cut ( ): Removes the selected component from the Template and copies it to the clipboard.

• Copy ( ): Keeps the selected component in the Template and copies it to the clipboard.

• Paste ( ): Pastes items from the clipboard to the Template.

• Paste Pointer ( ): If the Paste Pointer option is selected while a component is copied, the mouse pointer will change to indicate such. Thereafter the component will be pasted wherever the pointer is clicked. A right click will offer two options. Copy Here will make a copy of the component. Selecting a component, right clicking and



dragging to the required point and clicking Move Here will move the component. Cancel will deselect this option.

• Format Painter: Copies the common properties of the component clicked before selecting this option to the component that is clicked later.

• Delete ( ): Deletes the selected components from the Template.

• Quick Delete: Similar to the Delete function, but the deletion cannot be undone, using the Undo function.

• Select All: Selects all the components in the Template.

• Align: Aligns two or more component in various ways (Left, Right, Center, Bottom and so on).

• Size: Used to set the relative size of 2 more components (Same Width, Height etc).

• Bring to Front ( ): Brings the selected component on top of the others.

• Send to Back ( ): Sends the selected component behind others.

• Refresh Database ( ): Updates the Datasets to accommodate the changes in databases.



5.1.1.1 View Menu

Figure 5.6 – View Menu

This View Menu contains the following commands.

• Template Explorer ( ): Shows the Template Explorer on the right side of the screen.

• Property ( ): Shows the Property Sheet on the left side of the screen.

• Toolbars: Helps to enable/disable various toolbars that are available in OXD.

• Magnifier ( ): Magnifies the area pointed by the mouse on the Magnifier Window. A sample of what appears in the Magnifier Window is given below.

Figure 5.7 – Magnifier

• Tracker ( ): Allows the user to move through the Document Template area in a separate window. The red highlighted area indicates the portion of the Document Template currently being shown on the screen.



Figure 5.8 – Tracker

Moving the rectangle will change the Layout area shown on the main display area.

5.1.1.1 Components Menu

Figure 5.9 – Components Menu

The Components Menu contains the following commands.

• Group Objects ( ): Groups the selected objects together.

• Set Properties As Defaults ( ): Assigns the current properties of the selected component as defaults for the



components of that type added to the template thereafter.

• Standard: Shows the Standard components.

• Additional: Shows the Additional components.

• Form: Shows the Form components.

• Data Access: Shows the Data Access components.

• Wizard: Shows the available wizards.

• Pointer ( ): Sets the mouse pointer to the Pointer mode.

5.1.1.1 Options Menu

Figure 5.10 – Options Menu

The Options Menu contains the following commands.

• Generate Sample HTML: Generates an HTML page, which can be used to request the document associated with the Template currently being worked on. When this option is clicked the following dialog will be displayed to the user, which contains four tabs.



Figure 5.11 – Generate Sample HTML Dialog – General Tab

o General tab: The General tab has the basic requirements for generating the Sample HTML page. Namely, the URL of the CGI/Servlet, the request method, the type of operations to be performed and the required formats.

OXS CGI / Servlet URL should contain the URL of CGI or Servlet to be used.

The request method can be of two types GET or POST.

The request operations can be specified as follows.

Download: Allows downloading the files directly to the location specified by the user.

Direct Print: Gives the option to send the document directly to the printer.

Creation: Allows the user to select cr as a value for OP parameter in the resulting html page. When requested with OP=cr, the user will get an instant response page with URL links to the Current Status and Generated Document.



Mail Service: Allows mailing the document to a recipient using the ODMS (OPRO Document Mail Service).

Print Service: Allows the user to print the document using the OIPS (OPRO Internet Print Service).

Fax Service: Allows the user to fax the document using the OIFS (OPRO Internet Fax Service).

Print via PrintXchange: Allows the user to print the document using Print Exchange of Xerox (a third party service).

ApeosPort: Allows the user to fax the document using “ApeosPort”.

imagio: Allows the user to fax the document using “imagio”.

The preview Format can be OPR, PDF, OXR, OXV, HTML or XDW.

o Dataset Key tab: The Dataset Key tab allows the user to select a Dataset and set conditions in the condition area that is available. The Dataset should be designed to get user inputs using Condition Builder in the VQB for this purpose. The Caption and the Default Value can also be changed in Dataset Key tab, which will be shown in the HTML page.



Figure 5.12 – Generate Sample HTML Dialog – Dataset key Tab

o DBExecute Key tab: The DBExecute Key tab allows the user to update the Databases. The values in the Caption and the Default Value can also be changed in DBExecute Key tab, which will be shown in the Sample HTML page.

Figure 5.13 – Generate Sample HTML Dialog – DBExecute key Tab



o Request Value tab: When the type of data is assigned as Request for a particular component (non URL) in which this type is supported, the user can set the values for it in Request Value tab, which will be shown in the Sample HTML page.

Figure 5.14 – Generate Sample HTML Dialog –Request Value Tab

o Request URL Values tab: When the data type is set to Request in any URL component, the values to be displayed, namely the Caption and the Default Value can be set in Request URL Value tab.

Figure 5.15 – Generate Sample HTML Dialog – Request URL Value



When the user clicks the Show button, a Sample HTML page will be shown in a separate browser window page.

The Generate button will generate and save the HTML page at a specified path.

• Environment Options: The Environment Options dialog allows the user to specify parameters to successfully create and preview OXD Templates. It is also used to customize the OXD workspace according to user’s preference, which gives a greater convenience at the design time. The Environment Options dialog has two tabs namely The General tab and the Layout Default tab.

• The General tab

The General tab contains settings that can be used to change the way a Document can be previewed or generated. It also provides the user to change the number of histories for the reopen option and it also facilitates the user to enable or disable New Template dialog box. The settings provided in the General tab, are discussed bellow.

Figure 5.16 – Environment Options Dialog – General Tab



o The URL dropdown allows the user to select or enter the CGI/Servlet URL path in order to create Documents.

o The OXS Version button allows the user to check the version of the OPRO X Server, which is located in the specified URL path.

o The Settings button of the Internet Connection section is used to bring up the Internet Options dialog, in order to assign the address and the port used by the proxy server. Proxy addresses, which contain SSL support (https), can be also assigned as the Proxy address for OXD.

In order to setup a proxy server for Internet explorer please visit;

http://support.microsoft.com/default.aspx?scid=kb;en-us;135982

Figure 5.17 : Windows Internet Options dialog box

o Show dialog when 'New Template' in 'File' menu is selected option allows the user to enable or disable the New Template





dialog box, when selecting New Template option from the File menu.

o Number of histories for 'Reopen' option allows the user to specify the number entries that should be displayed when opening Templates through the Reopen option available in the File menu and through the Open button ( ).

o Preview Format option allows the user to select the preview format, namely OPR, PDF, HTML or XDW.

o HTML Template for Sample HTML option allows the user to specify an HTML template to use when generating an HTML download page (Sample HTML page).

Figure 5.18 – Environment Options Dialog – Layout Default Tab

• The Layout Default tab

The Layout Default tab contains settings that are used to assign the default appearance for a new Layout that will be added to an existing Template or to a new Template, which will be opened by the OXD application, thereafter. The settings provided in the Layout Default tab, are discussed bellow.



o Background Color option allows changing the default background color, which will be applied, to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Interval option under the Grid section allows the user to change the default distance between two grid points, which will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Snap option allows the user to move any components on the grid points of a new Template or for a new Layout that will be added to an existing Template, thereafter.

o Visible option allows the user to make the grid visible or invisible by default for a new Template or for a new Layout that will be added to an existing Template, thereafter.

o Style option allows the user to make the grid style Absolute or Relative for a new Template or for a new Layout that will be added to an existing Template, thereafter.

o Color option allows the user to specify the color of the grid, which will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Size drop down allows the user to specify the default paper size, which will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Height and Width option allows the user to specify the default height and width of the Custom paper size. In order to enable the Height and Width spinner controls, the user should select Custom paper size from the Size dropdown.

o Unit dropdown allows the user to specify the unit in which the height and the width of the paper Size will be measured. The unit cm is for centimeters and inch is for inches.

o Portrait option under the Orientation section allows the user to change the default paper orientation from Landscape to Portrait. This change will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.



o Landscape option under the Orientation section allows the user to change the default paper orientation from Portrait to Landscape. This change will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Left spinner control under the Margins section allows the user to specify the default distance of the left margin, which will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Right spinner control under the Margins section allows the user to specify the default distance of the right margin, which will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Top spinner control under the Margins section allows the user to specify the default distance of the top margin, which will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Bottom spinner control under the Margins section allows the user to specify the default distance of the bottom margin, which will be applied to a new Template or to a new Layout that will be added to an existing Template, thereafter.

o Same As Display option under the OPR Print Method section, is used to let the OPRO X Browser application print the OPR document made from a new Template in the way characters are placed at the positions same as display. This option will be not applied to a new Layout that will be added to an existing Template.

o 2.3 Compatible option under the OPR Print Method section is used to let the OPRO X Browser application print the OPR document made from a new Template in the way characters are placed at the positions compatible to the templates made by versions before 2.5. This option will be not applied to a new Layout added to an existing Template.

• OPRO File Manager Administration:

OPRO File Manager Administration allows the user to connect to OFMS (OPRO File Manager Service) through an external tool, called OPRO File Manager Admin tool. When the user



selects this option, he will be prompted to login to the OFMS, using the OFMS Login dialog shown below.

Figure 5.19 – OFMS Login Dialog After login into the OFMS, the OFMSA (OPRO File Manager Service Administrator) will be displayed.

Figure 5.20 – OFMA Interface

5.1.1.1 Window Menu

Figure 5.21 – Window Menu

• Windows Menu: The Windows Menu will list Templates, which are currently opened in OXD. When the user selects a Template from the list, it will be brought forward.



5.1.1.1 Help Menu

Figure 5.22 – Help Menu

• Contents & Index: Shows the online help to aid using the OXD application.

• Quick Help: Helps to display a pop up screen or the relative help page, which describes the functionality of the pointed item, through the mouse cursor. When this option has been selected the mouse cursor changes to an arrow with a question mark next to it ( ).

• About: The About dialog box will show the version information, Serial Number and other license information of OXD.

5.1.2 Tool Bars

5.1.1.1 File Tools

Figure 5.23 – File Toolbar

• New Template ( ): Opens a new Template within the OXD application.

• Open Template ( ): Opens an existing Template (*.oxt file).

• Save Template ( ): The current working Template will be saved into the local hard drive.

• Save All Templates ( ): Saves all the Templates, which are currently opened, to the local hard drive.



• Preview ( ): This will allow the user to bring up an on screen preview of the active Document Template.

5.1.1.1 Edit Tools

Figure 5.24 – Edit Toolbar

• Cut ( ): Removes the selected component from the Template and copies it to the clipboard.

• Copy ( ): Keeps the selected component in the Template and copies it to the clipboard.

• Paste ( ): Inserts the contents of the clipboard to a selected area.

• Paste Pointer ( ): Pastes a copied component to wherever position the mouse pointer was clicked.

• Format Painter ( ): Copies the common properties of the component clicked before selecting this option to the component that is clicked later.

• Undo ( ): Removes the final change done on the Template.

• Redo ( ): Applies the last change, which was undone.

5.1.1.1 Help Tools

Figure 5.25 – Help Toolbar

• Help ( ): Displays the online help of the OXD application.

• Quick Help ( ): Displays a pop up screen or the relative help page, which describes the functionality of the pointed item, through the mouse cursor. Once clicked, the



mouse cursor will change to an arrow with a question mark next to it ( ).

5.1.1.1 Align and Size Tools

Figure 5.26 – Align and Size Toolbar

• Align – Left ( ): The selected components will be left aligned.

• Align – Right ( ): The selected components will be right aligned.

• Align – Top ( ): The selected components will be top aligned.

• Align – Bottom ( ): The selected components will be bottom aligned.

• Align – Vertical Center ( ): The selected components will align in a vertically centered manner.

• Align – Horizontal Center ( ): The selected components will align in a horizontally centered manner.

• Size – Same Width ( ): Changes the selected components to the same width.

• Size – Same Height ( ): Changes the selected components to the same height.

• Size – Same Size ( ): Changes the selected components to the same size.

5.1.1.1 Front or Back Tools

Figure 5.27– Front or Back Toolbar



• Bring to Front ( ): Brings the selected component on top of the others.

• Send to Back ( ): Sends the selected component behind others.

5.2 Component Properties

5.2.1 Overall Detailed Description

Properties that are common for most components are explained in depth in this section. Properties, which are specific to each component, will be discussed in section 5.2.2 under each component’s individual explanation. References to this section will be made where necessary.

5.2.1.1 General

The General area of the Properties tab contains properties that are common to all Standard, Additional, Form and Data Access components.

• The Name property contains the name through which the component

is identified within the particular Layout.

• Location & Size consists of four attributes, which assigns the component’s size and its location on the Layout.

• In the Frame area, Size sets the size of the component’s frame with an

upper limit of 100. Color property lets the user choose a color for the frame from a dropdown list, while a graphical square is used to enable or disable each side of the frame.

• Appearance area contains three properties. The Visible property

decides whether the component is visible in a generated preview of the Template. When the Transparent option of a component is checked, any other component that has been placed under it can be seen through, both at design time and when the Template is previewed. When the Drag Lock option has been checked, it prevents a component from being dragged within the Layout.

(For some components, these properties such as Size, Visible and Transparent are set by default and cannot be changed by the user.)



5.2.1.2 Font

Certain components, which support text display, contain properties related to Font.

• Name property provides a dropdown list of system font names, where the required font can be selected.

• The Appearance section contains eight properties. The size of the font can be assigned through Size property. It can be changed either by selecting from the dropdown list or by typing the size manually. Font color can be changed through the Color property. Bold, Italic, Underline and Strikeout are general options. CJK (Chinese, Japanese & Korean Support) can be selected when a font supporting such a language is used. This will enable the font text to be identified in Unicode. EUDC should be checked if the selected font contains user-defined characters.

5.2.1.3 Custom

The Custom section lays down the component specific properties. These will be explained when individual components are discussed.

5.2.1.4 Hyperlink

The check box provided would help to insert a hyperlink, which is specified under the URL box of the selected component.

5.2.1.5 Data / URL Data

The Data/URL Data section specifies the properties concerned with assigning data values for the selected component/ components.

• Type property lets the user select the source of data out of 3 options,

namely Static, Request and Database.

o When Static has been selected as the Type, the component will display the value assigned at the Value property’s edit box. Assigning the Value property could be done in several ways.

Enter a value directly into the Value property’s edit box. This

method is usually used for text-based components. With the use of File button, the user can browse and select a

file from which the data will be loaded.



With the use of URL button, the user can specify a URL to retrieve data from, though the URL Input dialog.

Use the Acquire button to get data from an input device such

as a scanner when the drivers are available. The Acquire option is available on the Image component.

o Request type is used to get user input during document creation time.

The value to be used for the component has to be assigned in the sample generated HTML, before submission.

Request Parameter Name specifies the name through which

the server identifies the particular request. By default this value is assigned to the component name but it can be changed if necessary.

o When the component has to use values retrieved from a database,

the Type should be assigned to Database. There are several other properties related to this.

Dataset provides a list of Dataset components applicable for the Layout. The user can choose a Dataset according to the requirement.

Field property allows the user to select a particular field from

the selected Dataset. Format property allows the user to specify the format in which

the data are to be displayed. The formats available will differ according to the data type of the selected field (Refer 5.2.1.5 for available formats).

The value assigned in Use if null property will be used as the

default value for the component if the Dataset field returns null.

5.2.1.6 Number Formats

The following formats are available for displaying data on a component that supports Database data Type. 0 Digit place holder. If the value being formatted has a digit in the

position where the ‘0’ appears in the format string, then that digit is copied to the output string. Otherwise, a ‘0’ is stored in that position in the output string.



# Digit place holder. If the value being formatted has a digit in the position where ‘#’ appears in the format string, then that digit is copied to the output string. Otherwise, nothing is stored in that position in the output string.

. Decimal point. The first ‘.’ character in the format string determines the

location of the decimal separator in the formatted value. , Number separator. If the format string contains one or more ‘,’

characters, the output will have separators to the left of the decimal point.

Table 1 : Number Formats

5.2.2 Standard Component Properties

5.2.2.1 Label

General: Refer section 5.2.1.1.

Font: Font properties explained in section 5.2.1.2 are applicable to this component.

Custom: Custom properties for the Label component include the Layout property. Using the Layout property the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown. In addition, the background color of the component can be changed using the Color property.



With the Vertical check box, the contents of the Label (e.g. horizontally aligned data) can be rotated vertically making the data inside the Label vertically aligned, or vice versa. This allows the user to switch the orientation of Label contents.

The Style area includes Auto size property that changes the size of the component to show the whole data content. Word wrap and Equalize properties are used to spread or shrink the characters evenly within the component. Fit property is used to stretch the contents accordingly to fit the component’s size.

Text Appearance area includes Line interval property that determines the spaces between the lines of the component’s text. The Character interval property determines the spaces between the characters of the component’s text. Tab size property is used to assign the tab space size between characters. The user can specify the values for Tab size, Character interval and Line interval in pixels, points, centimeters or inches.

Hyperlink: Refer section 5.2.1.4

Conditional Format: This property will allow the associations of conditions with the Label component giving the user enhanced ability to manipulate static data or data retrieved form a database with embedded conditions.

Data: All the properties explained in section 5.2.1.4 are supported except the Acquire option.

5.2.2.2 Image


Custom: Custom properties of the Image component include Layout property. With Layout property, the image inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown.

Appearance area includes Auto size property that is used to resize the control to accommodate the size of the image it displays. Stretch property is used to resize the contents of an



Image, horizontally and/or vertically so that they conform to the boundaries of the component. Stretch with fixed aspect ratio property is useful when the user wants to resize the image within the component, while maintaining the ratio between the width and the height of the image. Show all pages property is useful to display the tiff images with multiple pages. When this property is enabled all the pages, which represents the multi-paged tiff image, will be repeatedly generated in the pages of the output Document. Here each page of the output Document represents a single page of the multi-paged tiff image. The Show all pages property will be disabled when the Image component is placed on a DatasetTable or a HorizontalDatasetTable. If the user selects an image of another format (Examples, gif or jpeg image), then the Show all pages property will be disabled.


Data: Image component supports only Static and Database types. All properties of Static are supported, while Dataset and Field properties of Database type are supported. (Refer 5.2.1.4.)

5.2.2.3 Shape


Custom: The Custom properties of the Shape component allow the user to select the shape type. The shape can be RoundRect (a rectangle with curved edges), Rectangle or Ellipse. The Border properties allow the user to set the thickness of the border through Size, the line Style and border Color. You should also note that the border Style of the Shape component cannot be changed when the border Size of the component is greater than 1.

The background color of the shape can be changed through the Color property in the Background section.

Corner Adjustment properties are available for RoundRect typed shapes. This allows the user to set the curvature of each corner individually or symmetrically.



5.2.2.4 Line

General: Refer section 5.2.1.1. Please note that, it is not recommended to make the Line transparent property off. Line will be always transparent in future versions.

Custom: The Size property assigns the Line thickness, while the Line color can be changed through the Color dropdown box. The Line Style can be chosen from Solid, Dash, Dot, DashDot and DashDotDot.

A single Line or a group of Lines can be drawn in six directions (left, right, top, bottom, upward and downward direction) with the use of the Direction property.

A Line will be drawn in the left direction.

A Line will be drawn in the right direction.

A Line will be drawn in the top direction.

A Line will be drawn in the bottom direction.

A Line will be drawn in the upward direction.



A Line will be drawn in the downward direction.

You can select more than one direction and a Line will be drawn to each direction that you have selected.

5.2.2.5 Date Time



Custom: Custom properties for this component includes the Layout property, where the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown. In addition, the background color of the Date Time component can be changed using the Color property.

The Style area includes Auto size property that changes the size of the component to show the whole data content. Word wrap and the Equalize properties are used to spread or shrink the characters evenly within the component. Fit property will stretch the contents accordingly to fit the component’s size.

Text Appearance area includes Line interval, which determines the spaces between the lines of the component’s text. The Character interval determines the spaces between the characters of the component’s text. Tab size will set the tab space size between characters. The user can specify the values of such properties in pixels, points, centimeters or inches.

Format: Kind property allows the user to select the type of date or time to be displayed (date, time or both date & time). The date format or time format can be specified through the Format properties.



The available formats are as follows:

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) using the strings given by the LongDayNames global variable.

D Display day in year (123).

DDD Displays abbreviated day in Japanese, when the server is installed in a Japanese environment. E.g. { }.

DDDD Displays full name day in Japanese when the server is installed in a Japanese environment. Eg. { }.

M Displays the month as a number without a leading zero (1-12). If the ‘m’ immediately follows an ‘h’ or ‘hh’, the minute rather than the month is displayed.

MM Displays the month as a number with a leading zero (01-12). If the ‘mm’ immediately follows an ‘h’ or ‘hh’ , 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 two-digit number (00-99).

yyyy Displays the year as a four-digit number (0000-9999).

h Displays the hour without a leading zero (0-12). (12 hour clock)

hh Displays the hour with a leading zero (00-12). (12 hour clock)



H Displays the hour without a leading zero (0-23). (24 hour clock)

HH Displays the hour with a leading zero (00-23). (24 hour clock)

m Displays the minute without a leading zero (0-59).

mm Displays the minute with a leading zero (00-59).

s Displays the second without a leading zero (0-59).

ss Displays the second with a leading zero (00-59).

gge Displays the year in Japanese( E.g. { }).

AM/PM Uses the 12-hour clock for the preceding ‘h’ or ‘hh’ , and displays 'AM' for any hour before noon, and 'PM' for any hour after noon. The ‘AM’/’PM’ 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’ , 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.

/ Displays / as the date separator character.

: Displays the time separator character.



Table 2 : Date Time Formats


5.2.2.6 Page Number



Custom: Custom properties for the Page Number component include the Layout property. With the Layout property, the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of the nine areas shown. In addition, the background color of the component can be changed using the Color property.



The Style area includes Auto size property that changes the size of the component to show the whole data content. Word wrap and the Equalize properties spread or shrink the characters evenly within the component. Fit property stretches the contents accordingly to fit the component’s size.

Text Appearance area includes Line interval property, which determines the spaces between the lines of the component’s text. The Character interval will determine the spaces between the characters of the component’s text. The Tab size will assign the tab space size between characters. The user can specify the values for such properties in pixels, points, centimeters or inches.

Settings: The Settings properties allow the user to select the page numbering cycle, indicate whether the page number should be displayed at the first page and the last page of the Layout, Template or the Document, and indicate the offset and the value for the Page Number component.

The Numbering for property is used to specify the behavior of displaying page numbers for Layouts, Templates and Documents. There are several options for this property. They are Layout Cycle, Template Cycle and Document Cycle. The default value is Layout Cycle.

The Layout Cycle option for the Numbering for property, will allow you to number the pages of each Layout in a Template.

Example 1:

Figure 5.28 – Page Numbering for Layout Cycle



In the above figure, the Page Number component in Layout - 1 (Template -1) will number pages from 1 to 3 since Layout - 1 contains 3 pages. You will also notice that the Page Number component in Layout - 1 (Template - 2) will number pages from 1 to 2 since Layout - 1 contains 2 pages.

The Template Cycle option for the Numbering for property, will allow you to number the pages of each Template in the Document.

Example: 2

Figure 5.29 – Page Numbering for Template Cycle

In the above figure, the Page Number component in Template - 1 will number pages from 1 to 3 since Template - 1 contains 3 pages. You will also notice that the Page Number component in Template - 2 will number pages from 1 to 3 since Template - 2 contains 3 pages (pages in Layout - 1 and Layout - 2 of Template - 2).

The Document Cycle option for the Numbering for property, will allow you to number the pages of the entire Document.



Example 3:

Figure 5.30 – Page Numbering for Document Cycle

In the above figure, the Page Number component in the Document will number pages from 1 to 6 since the Document contains 6 pages (pages in Layout - 1 and Layout - 2 of Template - 2, and Layout - 1 of Template - 1).

The Offset property is used to increase or decrease the value of the page number. The default value of the Offset property is 0 (Zero).

Example 4:

The following Template (Template -1) contains 2 Layouts (Layout - 1 and Layout - 2). We have placed two Page Number components for each of the two Layouts (Layout - 1 and Layout - 2). Layout - 1 contains a page numbering of 1 to 3, and Layout - 2 contains page numbering of 1 to 2. Here the value of the Numbering for property is Layout Cycle.



Figure 5.31 – Setting Offset for the Page Number Component

Now we will increase the value of the Offset property in the Page Number component of Layout -1 to 3. Then the page numbers of Layout -1 will change as 4,5,6 for the 3 pages of Layout - 1.

Figure 5.32 – Increased Offset for the Page Number Component

You can also use a negative value as the Offset to decrease the value of the page number.

The Visible in the first page property helps to make the page number visible or invisible in the first page of each Layout Cycle, Template Cycle or Document Cycle. This property will be checked as default.

With reference to example 4 we will uncheck Visible in the first page property in the Page Number component of Layout -1.



Figure 5.33– Setting Visible in the first page for the Page Number Component

The first page of Layout - 1 will not display the page number. The Visible in the last page property helps to make the page number visible or invisible in the last page of each Layout Cycle, Template Cycle or Document Cycle. This property will be checked as default.

With reference to example 4, we will uncheck Visible in the last page property in the Page Number component of Layout -1.

Figure 5.34– Setting Visible in the last page for the Page Number Component

The last page of Layout - 1 will not display the page number.

Value property is used to display a title for the page number when displaying the page number through the Page Number component. The default value is Page #. The # character will be replaced by the numeric value of the page number in the



generated Document or in the Document which will be previewed.

Example 5:

The following Template (Template -1) contains 2 Layouts (Layout - 1 and Layout - 2). We have placed two Page Number components for each of the two Layouts (Layout - 1 and Layout - 2). Layout - 1 contains 3 pages and Layout - 2 contains 2 pages. Therefore the Page Number component of the Layout - 1 will number pages from 1 to 3. The Page Number component of Layout - 2 will number pages from 1 to 2. The Value property of these Page Number components is Page #.

Figure 5.35– Setting a Value for the Page Number Component

Next we will change the Value property of the Page Number component on Layout - 1. Let’s change it to Page Number #. The output displayed by the Page Number component on Layout -1 will change as follows.



Figure 5.36– Changed Value for the Page Number Component


5.2.2.7 Total Page Number



Custom: Custom properties for the Total Page Number component

include the Layout property. With the Layout property, the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of the nine areas shown. In addition, the background color of the component can be changed using the Color property.

Settings: The Settings properties allows the user to select the total page

numbering cycle, indicate whether the total page number should be displayed at the first page and the last page based on the total page numbering cycle, and also to indicate the offset and the value for the Total Page Number component.

With the Numbering for property, the user can specify whether the total page numbering cycle should be carried out as Layout Cycle, Template Cycle or Document Cycle. The Layout Cycle option for the Numbering for property, will allow you to display the last page number of each Layout, when a Layout contains multiple pages. Here the value of the



Total Page Number component will be displayed in each and every page of the Layout. Example 1:

Figure 5.37 – Total Page Numbering for Layout Cycle

In the above figure, the Total Page Number component on all the pages in Layout –1 of Template - 1 will display number 3 as the total page number since the last page number of Layout –1 is 3. The Template Cycle option for the Numbering for property, will allow you to display the last page number of each Template, when a Template contains multiple pages. Here the value of the Total Page Number component will be displayed in each and every page of the Template.



Example 2:

Figure 5.38 – Total Page Numbering for Template Cycle

In the above figure, the Total Page Number component on all the pages of Template - 2 will display number 3 as the total page number since the last page number of Template - 2 is 3.

The Document Cycle option for the Numbering for property, will allow you to display the last page number of the entire Document on all the pages of the Document. Example 3:

Figure 5.39 – Total Page Numbering for Document Cycle

In the above figure, Total Page Number components located on all the pages of the Document (pages in Layout -1 of



Template - 1, Layout - 1 of Template - 2, and Layout - 2 of Template - 2) will display number 6. This is because the last page number of the Document is 6. The Offset property is used to increase or decrease the value of the total page number. The default value of the Offset property is 0 (Zero). Example 4: The following Template (Template -1) contains 2 Layouts (Layout - 1 and Layout - 2), where each Layout contains a Total Page Number component. Layout - 1 contains 3 pages and Layout - 2 contains 2 pages. Therefore the Total Page Number component of the Layout - 1 will display 3 for all the pages in Layout – 1, and the Total Page Number component of the Layout - 2 will display 2 for all the pages in Layout – 2. Here the value of the Numbering for property is Layout Cycle.

Figure 5.40 – Setting the Offset for the Total Page Number Component

In the following example, we have increased the Offset value of the Total Page Number component to number 3. Therefore the value of the total page number in Layout – 1 will increase to 6.



Figure 5.41 – Increasing the Total Page Number through the Offset Property

You can also use a negative value as the Offset to decrease the value of the total page number. Visible in the first page property is used to make the total page number visible or invisible in the first page of each Layout Cycle, Template Cycle or Document Cycle. This property will be checked as default. With reference to example 4, we will uncheck Visible in the first page property in the Total Page Number component of Layout -1. The first page of Layout - 1 will not display the total number of pages.

Figure 5.42 – Setting the Visible in the First Page Property for the Total Page Number Component

Visible in the last page property helps to make the total page number visible or invisible in the last page of each Layout



Cycle, Template Cycle or Document Cycle. This property will be checked as default. With reference to example 4, we will uncheck Visible in the last page property in the Total Page Number component of Layout -1. The last page of Layout - 1 will not display the total number of pages.

Figure 5.43 – Setting the Visible in the Last Page Property for the Total Page Number Component

Value property is used to display a title for the total page number when displaying the total page number through the Total Page Number component. The default value is Total #. The # character will be replaced by the numeric value of the total page number in the generated Document or in the Document which will be previewed. Example 5: In the following figure, Template – 1 contains 2 Layouts (Layout - 1 and Layout - 2). We have placed two Total Page Number components for each of the two Layouts (Layout - 1 and Layout - 2). Layout - 1 contains 3 pages and Layout - 2 contains 2 pages. Therefore the Total Page Number component of the Layout - 1 will display 3 for all the pages and the Total Page Number component of the Layout - 2 will display 2 for all the pages. The Value property of these Total Page Number components is Total #.



Figure 5.44– Setting a Value for the Total Page Number Component

Next we will change the Value property of the Total Page Number component on Layout - 1. Let’s change it to Total Page #. The output displayed by the Total Page Number component on Layout -1 will change as follows.

Figure 5.45–Changed Value for the Total Page Number Component


5.2.2.8 Table


Rule: Sets the borders for the columns and bands of the table.

Grid: The Grid Properties are only applicable to the columns of the Table component. Visibility of each Column can be



enabled/disabled using the Visible property. With the Color property, the user can change the color of each Column.

Custom: The user can change the Background Color of each section of the Table component (Column, Band, Table) through the Background Color dropdown box. The number of Bands and Columns can be increased/decreased respectively through the Band Count and Column Count properties. The Bands and Columns can be distributed evenly in the Table area with the use of Distribute Bands Evenly and Distribute Columns Evenly buttons.

5.2.2.9 URLLabel


Font: Font properties are explained in section 5.2.1.2 and are applicable to this component.

Custom: Custom properties for URLLabel component include the Layout property. With the Layout property, the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown. In addition, the background color of the component can be changed using the Color property.

The Style area includes Auto size property that changes the size of the component to show the whole data content. Word wrap and the Equalize properties spread or shrink the characters evenly within the component. Fit property stretches the contents accordingly to fit the component’s size.





URL Data: The URLLabel component supports all three types of data sources explained in section 5.2.1.4. In the Static type, a URL or the local path of the file, which resides in the OPRO X Server, should be entered for the Value property. The file, which is mentioned, contains data that should be displayed in the URLLabel component. If the user enters a value that has http:// or https://, then the contents will be retrieved via the URL specified. If the user specifies the path of the text file (other than http:// or https://), then the text file will be taken from the local path specified in the OPRO X Server.

The URLLabel allows displaying contents at the design time if the values for the URLLabel component are retrieved from a specified URL. When values are loaded via a text file local to OPRO X Server, such values cannot be displayed during the design time. In Database type, Format and Use if null properties are not supported.

5.2.2.10 URLImage


Custom: Custom properties for URLImage component include the Layout property. With the Layout property, the text inside the

When specifying a text file local to OXS, the path of the text file should be relative compared to the actual path, which stores the text file. For example, lets assume that there is a text file called a.txt in the subfolder test, in the local path of OXS. The default actual path will be – C:/Program Files/OPRO/OPRO X Server/works/texts/test/a.txt. Therefore the OXD user has to mention only test/a.txt as the Value for the URLLabel.

Note



component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown.

Appearance area includes Auto size property where the control resizes to accommodate the Image it displays. The Stretch property is used to resize the contents of an Image, horizontally and/or vertically so that they conform to the boundaries of the component. Stretch with fixed aspect ratio property is useful when the user wants to resize the image within the component, while maintaining the ratio between the width and the height of the image. Show all pages property is useful to display the tiff images with multiple pages. When this property is enabled all the pages, which represents the multi-paged tiff image, will be repeatedly generated in the pages of the output document. Here each page of the output document represents a single page of the multi-paged tiff image. The Show all pages property will be disabled when the Image component is placed on a DatasetTable or a HorizontalDatasetTable. If the user selects an image of another format (Examples, gif or jpeg image), then the Show all pages property will be disabled.


Data: The URLImage component supports all three types of data sources explained in section 5.2.1.5. In Static type, a URL or

When specifying an image file local to OXS, the path of the image file should be relative compared to the actual path, which stores the images. For example, lets assume that there is an image file called a.gif in the subfolder test, in the local path of OXS. The default actual path will be – C:/Program Files/OPRO/OPRO X Server/works/images/test/a.gif Therefore the OXD user has to mention only test/a.gif as the Value for the URLImage.

Note



the local path of the file, which resides in the OPRO X Server, should be entered for the Value property. If the user enters a value that has http:// or https://, then the image will be retrieved via the URL specified. If the user specifies the path of the image file (other than http:// or https://), then the image file will be taken from local path specified in the OPRO X Server.

The image, which consists in a URL, can be displayed at the design time. In both Request and Database types a URL Suffix and a URL Prefix can be assigned, which will be useful when retrieving data from frequently used sources. In Database type, Format and Use if null properties are not supported.

5.2.3 Additional Component Properties

5.2.3.1 URLExecute

General: Properties explained in section 5.2.1.1 are applicable to this component. However by default the Visible property is assigned as true, while the Transparent property is assigned as false. The user cannot change these properties or the size of the component.

URL Data: The URLExecute component supports all three types of data sources and properties, which are explained in section 5.2.1.5.

5.2.3.2 BarCode


Custom: Custom properties for BarCode component include the Layout property. With the Layout property, the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown.

Appearance area includes Auto size property where the control resizes to accommodate the Image it displays. The Stretch property is used to resize the contents of an Image, horizontally and/or vertically so that they conform to the boundaries of the component. Stretch with fixed aspect ratio



property is useful when the user wants to resize the image within the component, while maintaining the ratio between the width and the height of the image.

Settings: Barcode Type property allows the user to choose the encoding method and the Show Text property allows the user to show or hide the text of the BarCode. The option to Insert Check Digit is also provided. Base Width property determines the width of the thinnest line in pixels.

Data: The BarCode component supports all three types of data sources explained in section 5.2.1.5 Show BarCode button under Static type will display the BarCode image according to the Value specified.

5.2.3.3 Graph

General: Properties explained in section 5.2.1.1 are applicable to this component. However by default the Transparent property is assigned as false which the user cannot change.

Custom: Custom properties for Graph component include the Layout property. With the Layout property, the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown.

Appearance area includes Auto size property where the control resizes to accommodate the Image it displays. The Stretch property is used to resize the contents of an Image, horizontally and/or vertically so that they conform to the boundaries of the component. Stretch with fixed aspect ratio property is useful when the user wants to resize the image within the component, while maintaining the ratio between the width and the height of the image.

Settings: There are various properties available under Settings properties. Header property is used to display the Header of the graph, while the Footer property is used to display the footer of the Graph. The Legend property allows the user to select the legend in the graph enabled by Show property. The Legend Alignment allows specifying the alignment of the legend in Graph. Layout property will be used to position the



Legend and the Background Color property is used to change the background color of the graph.


Data: The type could be Static or Database and the Graph could be Single (one graph) or Multi (two graphs) graph.

The Rotation property helps the user to rotate the graph in various degrees. The Font Size property is used to change the font size of the axis. The Legend Title property helps the user to specify the legend title for the graph. The Type property provides the facility of choosing a graph type. The number of Series in the graph can be changed and if the graph is Static, data can be entered in the edit box given under this section. The graph can be viewed at design time through Display Graph button.

5.2.3.4 Chart

General: Properties explained in section 5.2.1.1 are applicable to this component as well. However by default the Transparent property is assigned as false which the user cannot change.

Custom: Custom properties for Chart component are disabled. Preset default Custom properties will be applied to the chart.


Appearance: Allows controlling the look and feel of the Chart. Text Color property defines the text color to be used in the chart. Background Color option sets the background color of the chart. Plot Background Color option defines the color of plot area of the chart. If users enable the Transpose Plot option, Domain (x-axis) and Range (y-axis) will be interchanged in the plot. Generated chart could be rotated using the Rotation buttons. In addition users can control the size of the generated chart by selecting the resolution of the chart in DPI. Users can also define a chart Title and the Position as well. Grid option allows you to display the grid lines in the chart range and domain.



Data: This section allows users to specify the data source and specify some additional chart customizations.

Get Configuration List button will fetch the chart configurations from the OXS. You can use the Single and Double option buttons to specify whether you are defining a single chart or a double chart. Plot Type property allows you to select type of the chart. Configuration option allows you to select the chart configurations specified in the server. Legend option allows users to modify the chart legend. You can change the legend position and background color using Legend Position and Background Color properties. You can set the title of the chart domain by specifying a value for the Title property.In addition you can set upper and lower bounds using Upper Bound and Lower Bound properties. This will control the value ranges displayed on the chart. Similarly you can set the Title, Show Grid Lines, Upper Bound and Lower Bound properties for chart range as well.

Users can set the chart Items to show values by enabling the Show Label option.

Type property will allow the users to select the data source type. If Static option is selected as the type, chart will be created using static data. If Database is selected chart will be created using a Dataset component which specifies the database to be used to create the chart.

If Transpose Data property is enabled, vertical range of data as a horizontal range. Users can increase or decrease the chart series value using Series property.

5.2.3.5 OCCS

OPRO Content Control Service (OCCS) will maintain images required for OPRO X Designer.


Custom: Custom properties for OCCS component include the Layout property. With the Layout property, the text inside the component can be aligned both vertically and horizontally,



on either side or on center, simply by clicking on the desired area out of nine areas shown.

Appearance area includes Auto size property where the control resizes to accommodate the Image it displays. The Stretch property is used to resize the contents of an Image, horizontally and/or vertically so that they conform to the boundaries of the component. Stretch with fixed aspect ratio property is useful when the user wants to resize the image within the component, while maintaining the ratio between the width and the height of the image.

Data: The Get Contents property will allow the user to get images from OPRO Content Control Service, while the Show Contents will allow the user to show images from OCCS, which have been retrieved from Get Contents.

5.2.3.6 SATO Label

General: Properties explained in section 5.2.1.1 are applicable to the SATO Label component. However frames are disabled and the default state of the Transparent property (which is unchecked) cannot be changed.

Device Font: When the Get Device Font List button is clicked, it will display

Device Font List dialog box that has two combo boxes. Server(s) combo box will allow the user to select an appropriate OIPS server supported by the current OXS and the Printer(s) combo box will enable the user to select the required printer accessible through the selected OIPS server. By clicking the OK button, the Device Font List dialog box will be closed and the fonts supported by the selected printer will be loaded to the Device Font List combo box, where the user can select the required font.

Data: All the properties explained in section 5.2.1.5 except the

Acquire property is supported.

5.2.4 Form Components

5.2.4.1 InterfaceGroup




Grid: Properties related to the Grid can be set in this section. Visibility can be enabled or disabled using Visible property. The grid color of the InterfaceGroup component can be assigned by the Color property.

Custom: The Method property of the Action area helps to specify the form request type. The URL property helps to assign the URL address for the method.

5.2.4.2 Text

General: Properties explained in section 5.2.1.1 are also applicable to the Text component. However the height of the box and the default Transparent property (which is unchecked) state cannot be changed.


Custom: The Color property of the Custom properties can be used to change the background of the Text component. Parameter Name property allows specifying the name for the component when passing values using an e-Form. Data Type property permits selecting the data type for the component. Maximum characters that can be typed by the user within this component can be specified in Max Length property. Required option does not allow the Text component to be blank when submitting an e-Form. The Disabled property prohibits the submission of values in the Text component. Read-only property will not allow editing the contents of the component during Preview. Masked property will allow hiding the contents of the component during Preview. The Tab Order property is used to define the order of accessing fields on an eForm of a generated Document, when pressing the Tab key on a keyboard.

Data: All the properties explained in section 5.2.1.5 except the Acquire property is supported.

5.2.4.3 Password

General: Properties explained in section 5.2.1.1 are applicable to the Password component. However the height of the box and the



default state of the Transparent property (which is unchecked) cannot be changed.

Custom: Refer section 5.2.4.2. Additionally the Password component does not include Masked property.

5.2.4.4 Memo

General: Properties explained in section 5.2.1.1 are applicable to the Memo component. However the height of the box and the default state of the Transparent property (which is unchecked) cannot be changed.


Custom: Refer section 5.2.4.2.

Data: All the properties explained in section 5.2.1.5 are supported except the Acquire property.

5.2.4.5 Dropdown

General: Properties explained in section 5.2.1.1 are applicable to the Dropdown component. However the default state of the Transparent property (which is unchecked) cannot be changed.


Custom: Refer section 5.2.4.2. Masked property is not included in the Dropdown component. The Allow user Input property, allows the user to select values during the Document Template preview.




5.2.4.6 List

General: Properties explained in section 5.2.1.1 are applicable to the List component. However the default state of the Transparent property (which is unchecked) cannot be changed.


Custom: Refer section 5.2.4.2. Additionally, the List component does not include the Masked property and the Allow user Input property.


5.2.4.7 Check

General: Properties explained in section 5.2.1.1 are applicable to the Check component. However the default state of the Transparent property (which is unchecked) cannot be changed.

Custom: Check Name property specifies a text string that allows it to be grouped by assigning the same name to multiple Check controls. However when the same name is given, it is not possible to check more than one control of the same group at the preview time in PDF format. The Disabled property prohibits the submission of values in the Check component. The Tab Order property is used to define the order of accessing fields on an eForm of a generated Document, when pressing the Tab key on a keyboard.


5.2.4.8 Radio

General: Properties explained in section 5.2.1.1 are applicable to the Radio component. However the default state of the Transparent property (which is unchecked) cannot be changed.



Custom: Radio Name property specifies a text string that allows it to be grouped by assigning the same name for multiple controls. Enabling the Checked property will set the particular radio button as checked by default. The Disabled property prohibits the submission of values in the Radio component. The Tab Order property is used to define the order of accessing fields on an eForm of a generated Document, when pressing the Tab key on a keyboard.


5.2.4.9 File

General: Properties explained in section 5.2.1.1 are applicable to the File component. However the default state of the Transparent property (which is unchecked) cannot be changed.

Font: Font properties explained in section 5.2.1.2 are applicable to this component. However the default Color of the font cannot be changed.

Custom: The Parameter Name is used to specify the name for the component when passing values using an e-Form. The Disabled property is used to disable the facility of entering values into the Text component when the Template is being previewed. The Tab Order property is used to define the order of accessing fields on an eForm of a generated Document, when pressing the Tab key on a keyboard.

5.2.4.10 Submit

General: Properties explained in section 5.2.1.1 are applicable to the Submit component. However the default state of the Transparent property (which is unchecked) cannot be changed.


Custom: Parameter Name allows specifying the name for the component when passing a value using an eForm. The



Disabled property prohibits the submission of values in the Submit component. The Tab Order property is used to define the order of accessing fields on an eForm of a generated Document, when pressing the Tab key on a keyboard.

Data: All the properties explained in section 5.2.1.5 are supported except the Acquire property. However the Value specified in Data will not be considered in PDF format.

5.2.4.11 Reset

General: Properties explained in section 5.2.1.1 are applicable to the Reset component. However the default state of the Transparent property (which is unchecked) cannot be changed.


Custom: The Tab Order property is used to define the order of accessing fields on an eForm of a generated Document, when pressing the Tab key on a keyboard.


5.2.4.12 OFD I/O

General: Properties explained in section 5.2.1.1 are applicable to the OFD I/O component and in addition this component can be placed out side interface group. If the component is outside, the Save All option will apply to the whole document otherwise it is only applicable to the components inside the interface group. However the Transparent property cannot be changed.


Custom: The Save property is used to save form data into a separate .OFD (OPRO Form Data) file from an eForm in a generated .OPR or .OXR Document. The Load property is used to load



form data from a .OFD (OPRO Form Data) file to a generated .OPR or .OXR Document, which contains an eForm. The Popup property is used as the Behavior, where the user can Save or Load form data by selecting the Save Data or Load Data option from the menu, which appears by the right mouse button click, on the eForm of the generated .OPR or .OXR Document. The Button option is used as the Behavior, where the users can Save or Load form data by clicking the OFD/IO button, which appears on the generated .OPR or .OXR Document. The All property is used to save all the form data that are included in all the eForms of a generated .OPR or .OXR Document. The Current property is used to save form data, which are only in the current eForm. The Tab Order property is used to define the order of accessing fields on an eForm of a generated Document, when pressing the Tab key on a keyboard.

URL Data: All three types of data sources as explained in section 5.2.1.5 are supported.

5.2.4.13 Invisible

General: Properties explained in section 5.2.1.1 are applicable to the Invisible component. However default state of the size, Transparent, Frame and Visible properties cannot be changed.



5.2.4.14 URLText

General: Properties explained in section 5.2.1.1 are applicable to the URLText component. However the height of the component and the default state of the Transparent property cannot be changed.





URL Data: All three types of data sources as explained in section 5.2.1.4 are supported. In Static type, a URL or the local path of the file, which resides in the OPRO X Server, should be entered for the Value property. The file, which is mentioned, contains data that should be displayed in the URLText component. If the user enters a value that has http:// or https://, then the contents will be retrieved via the URL specified. If the user specifies the path of the text file (other than http:// or https://), then the text file will be taken from the local path specified in the OPRO X Server.

The URLText allows displaying contents at the design time if the values for the URLText component are retrieved from a specified URL. When values are loaded via a text file local to OPRO X Server, such values cannot be displayed during the design time. In Database type, Format and Use if null properties are not supported.

5.2.4.15 URLMemo

General: Properties explained in section 5.2.1.1 are applicable to the URLMemo component. However the default state of the Transparent property cannot be changed.


When specifying a text file local to OXS, the path of the text file should be relative compared to the actual path, which stores the text file. For example, lets assume that there is a text file called a.txt in the subfolder test, in the local path of OXS. The default actual path will be – C:/Program Files/OPRO/OPRO X Server/works/texts/test/a.txt. Therefore the OXD user has to mention only test/a.txt as the Value for the URLText.

Note




URL Data: All three types of data sources as explained in section 5.2.1.4 are supported. In Static type, a URL or the local path of the file, which resides in the OPRO X Server, should be entered for the Value property. The file, which is mentioned, contains data that should be displayed in the URLMemo component. If the user enters a value that has http:// or https://, then the contents will be retrieved via the URL specified. If the user specifies the path of the text file (other than http:// or https://), then the text file will be taken from the local path specified in the OPRO X Server.

The URLMemo allows displaying contents at the design time, if the values for the URLMemo component are retrieved from a specified URL. When values are loaded via a text file local to OPRO X Server, such values cannot be displayed during the design time.

5.2.4.16 URLDropDown

General: Properties explained in section 5.2.1.1 are applicable to the URLDropDown component. However the height of the component and the default state of the Transparent property cannot be changed.

When specifying a text file local to OXS, the path of the text file should be relative compared to the actual path, which stores the text file. For example, lets assume that there is a text file called a.txt in the subfolder test, in the local path of OXS. The default actual path will be – C:/Program Files/OPRO/OPRO X Server/works/texts/test/a.txt. Therefore the OXD user has to mention only test/a.txt as the Value for the URLMemo.

Note





URL Data: All three types of data sources as explained in section 5.2.1.4 are supported. In Static type, a URL or the local path of the file, which resides in the OPRO X Server, should be entered for the Value property. The file, which is mentioned, contains data that should be displayed in the URLDropDown component. If the user enters a value that has http:// or https://, then the contents will be retrieved via the URL specified. If the user specifies the path of the text file (other than http:// or https://), then the text file will be taken from the local path specified in the OPRO X Server.

The URLDropDown allows displaying contents at the design time if the values for the URLDropDown component are retrieved from a specified URL. When values are loaded via a text file local to OPRO X Server, such values cannot be displayed during the design time.

When specifying a text file local to OXS, the path of the text file should be relative compared to the actual path, which stores the text file. For example, lets assume that there is a text file called a.txt in the subfolder test, in the local path of OXS. The default actual path will be – C:/Program Files/OPRO/OPRO X Server/works/texts/test/a.txt. Therefore the OXD user has to mention only test/a.txt as the Value for the URLDropDown.

Note



5.2.4.17 URLList

General: Properties explained in section 5.2.1.1 are applicable to the URLList component. However the default state of the Transparent property cannot be changed.



URL Data: All three types of data sources as explained in section 5.2.1.4 are supported. In Static type, a URL or the local path of the file, which resides in the OPRO X Server, should be entered for the Value property. The file, which is mentioned, contains data that should be displayed in the URLList component. If the user enters a value that has http:// or https://, then the contents will be retrieved via the URL specified. If the user specifies the path of the text file (other than http:// or https://), then the text file will be taken from the local path specified in the OPRO X Server.

The URLList allows displaying contents at the design time if the values for the URLList component are retrieved from a specified URL. When values are loaded via a text file local to

When specifying a text file local to OXS, the path of the text file should be relative compared to the actual path, which stores the text file. For example, lets assume that there is a text file called a.txt in the subfolder test, in the local path of OXS. The default actual path will be – C:/Program Files/OPRO/OPRO X Server/works/texts/test/a.txt. Therefore the OXD user has to mention only test/a.txt as the Value for the URLInvisible.

Note



OPRO X Server, such values cannot be displayed during the design time.

5.2.4.18 URLInvisible

General: Properties explained in section 5.2.1.1 are applicable to the URLInvisible component. However the default state of the Transparent property cannot be changed.


URL Data: All three types of data sources as explained in section 5.2.1.4 are supported. In Static type, a URL or the local path of the file, which resides in the OPRO X Server, should be entered for the Value property. The file, which is mentioned, contains data that should be displayed in the URLInvisible component. If the user enters a value that has http:// or https://, then the contents will be retrieved via the URL specified. If the user specifies the path of the text file (other than http:// or https://), then the text file will be taken from the local path specified in the OPRO X Server.

The URLInvisible allows displaying contents at the design time if the values for the URLInvisible component are retrieved from a specified URL. When values are loaded via a text file local to OPRO X Server, such values cannot be displayed during the design time.

When specifying a text file local to OXS, the path of the text file should be relative compared to the actual path, which stores the text file. For example, lets assume that there is a text file called a.txt in the subfolder test, in the local path of OXS. The default actual path will be – C:/Program Files/OPRO/OPRO X Server/works/texts/test/a.txt. Therefore the OXD user has to mention only test/a.txt as the Value for the URLList.

Note



5.2.4.19 DatasetDropDown

General: Properties explained in section 5.2.1.1 are applicable to the DatasetDropDown component. However the default state of the Transparent property cannot be changed.


Custom: Refer section 5.2.4.2. Masked property is not applied to Dataset Dropdown component. Checking Allow user Input property allows selecting or entering values during the Template preview.

Data: Data area contains properties, which are related to the selection of Datasets and the specification of data fields and formats.

5.2.4.20 DatasetList

General: Properties explained in section 5.2.1.1 are applicable to the DatasetList component. However the default state of the Transparent property cannot be changed.


Custom: Refer section 5.2.4.2. However the Masked property is not applied to DatasetList component

Data: Data area contains properties, which are related to the selection of Datasets and the specification of data fields and formats.

5.2.5 Data Access Component Properties

5.2.5.1 Dataset

General: Properties explained in section 5.2.1.1 are applicable to the Dataset component. However the default state of the Transparent and Visible properties cannot be changed.



Fields: The Edit option in the Fields area, will allow the user to call the Query Builder and change the existing conditions and expressions, or filter the data for an existing Dataset. If it is a new Dataset, it will allow the user to make a new query. The Load option will allow the user to add a new .oqm file, created using OPRO Query Maker. The Save option can be used to save the modified dataset as an .oqm file.

Query Builder:

The Query Builder will get executed when the user double click’s a Dataset component. The Query Builder simplifies building queries. A user-friendly interface has been provided with the Query Builder, which increases the speed of developing complex queries.

Sometimes a database connected through OXS may get disconnected. In this instance, if you attempt to execute the Query Builder, the following message will be displayed.

Figure 5.46 – The message that will be displayed when there is a disconnected database

If you need to reconnect to the database, click on the No button and select the Refresh Database option from the menu that can be obtained through the right mouse button click on the Dataset.



Figure 5.47 – Selecting Refresh Database Option

To ignore this message and execute the Query Builder click on the Yes button. Here the database, which is disconnected from OXS, will be shown as disabled in the Database Area.

An executed Query Builder application is shown above. The databases available for the connection are shown on the Database Area (left explorer area). The main Table Area (top--right area) allows dragging and dropping of tables. The fields

Figure 5.48 – Query Builder Interface



involved for the query can be dragged or selected to the Design Grid (workspace), where the queries can be built upon.

The user can drag or select fields of each table to the Design Grid and form the required query.

There are various buttons right on top of the Table Area. The functionality of each of these buttons is described bellow.

SQL: Shows the SQL expression of the created query in a separate window.

Save as Text File button is useful to save the SQL statements to a text file for future reference.

Display Results: Shows the results of the created query in the Result window.

Figure 5.49 – SQL Expression Display



Figure 5.50 – Display Query Results

The font of the result set can be changed through the Font combo box. Save in CSV Format button will save the result in CSV format. The SQL Statement tab will show the SQL statement for that particular query. Stop button is useful to stop the data acquisition from the server when the number of records for the selected query is unexpectedly high.

Expression:

Figure 5.51 – Expression Builder



The Expression button ( ) allows building new expressions for a selected Dataset. The tables and the fields can be selected from the tree view. The statement of the expression being built is shown in the text area at the bottom of the Expression Builder window. If there is a need to edit an existing expression please click on the Edit button in the Field row of the existing expression column, to edit an existing expression.

Figure 5.52 – Expression Builder – Editing an Existing Expression

Click on the Edit button to edit an existing expression through the Expression Builder.



Condition:

The Condition Builder allows building conditions for a selected Dataset. It is also similar to the Expression Builder, but allows creating conditions in addition, for the query.

Group By:

Figure 5.54 – Group By Editor

Figure 5.53 – Condition Builder



Group By Editor allows the user to easily group values that are available to build a query. The fields, which are used by the Group By function, can be selected and arranged accordingly to the requirement, by moving up or down the required grouping, in the text area provided at the lower part of the Group By Editor.

Order By:

Figure 5.55 – Order By Editor

The Order By Editor allows ordering the Dataset according to the fields required. The functional aspects are very similar to the Group By Editor.



Wizard:

The SQL wizard simplifies the query creation process. The user can select from the three types of queries provided to create the query required.

Query Wizards: Simple Query Wizard

Figure 5.57 – Simple Query Wizard – Field Selection Dialog

When the Simple Query has been selected, the Simple Query Wizard dialog will appear, which will request the user to select the tables. The fields available will be displayed in the Available Fields column. After fields are selected, they will be displayed in the Selected Fields column.

Figure 5.56 – Query Wizard – Opening Dialog



After selecting the required fields, click the Next button. The next wizard step will display a dialog requesting the user to specify the required column heading for the columns. Next click the Finish button. Upon completion, the SQL query will be created as required.

Find Duplicate Query wizard:

Figure 5.59 – Find Duplicate Query Wizard – Table Selection Dialog

The above wizard allows finding duplicate information in the selected tables. The required table(s) is selected from the available table list. Upon selection click the Next button. This will take to the next step of the wizard, which shows the following dialog.

Figure 5.58– Simple Query Wizard – Column Heading selection Dialog



Figure 5.60 – Find Duplicate Query Wizard – Field Selection Dialog

The required fields are then selected from the Available Fields list. After selecting the fields to the Duplicate- Values Fields, click the Next button. This will take the user to the next step of the Wizard, which will display the following dialog.

Here, the user can select any additional fields he/she wishes to display along with the result. After selecting the required fields click the Finish button. Upon completion, the query will be displayed in the Query Builder.

Figure 5.61 – Find Duplicate Query Wizard – Additional field Selection



Find Unmatched Query:

Figure 5.62 – Find Unmatched Query Wizard – Table Selection Dialog

This wizard allows the user to find unmatched data in the selected tables. The required table to search for unmatched queries should be selected from the given list. After that the user should click the Next button, where the following dialog will be displayed.

Figure 5.63 – Find Unmatched Query Wizard – Required Table Selection Dialog

Here the user has to select the table from the given list, in which the related records are stored. After selecting, click the Next button. This will take the user to the next step of the wizard, where the following dialog will be displayed, which



will request the user to select the field that may contain duplicate information.

Figure 5.64 – Find Unmatched Query Wizard – Field Selection Dialog

The selected fields, which are matching are shown at the bottom of the dialog. After selecting, click the Next button, which will take the user to the next dialog of the wizard.

Figure 5.65 – Find Unmatched Query Wizard – Additional Field Selection Dialog

The required fields to be displayed in the query can be selected from the Available Fields list. Press the Finish button to complete the query.



5.2.5.2 TextDataset

General: Refer the General area of section 5.2.5.1.

Fields: The Edit option in the Fields property area, will allow the user to execute the Text Query Builder. The Text Query Builder helps to load text or CSV files, which contains fields and field types. This behaves as a table with fields and types in a database. The TextDataset eases the process of loading data in a text or CSV file.

Figure 5.66 – Text Query Builder



Define Fields ( ) button opens the Text Definition dialog, which is shown by the following figure.

Figure 5.67 – Text Definition Dialog

Text Definition dialog helps to define fields and their types. The Encoding option displays the character-encoding format of the text/CSV data file. If the user selects Fixed Length option, the character-encoding format will be 932 Shift_JIS. When Fixed Length option is not selected, the character-encoding format will be UTF-16 little endian. The With Separator is used to separate data in the file, which will be specified in the Value property of the Property Sheet. The With Separator can be specified using the Field Separator or the Quotation Mark. The field names can be specified in the Name column of the Field Definition grid. The field type for the corresponding field can be selected from the Type drop down menu. The field types can be Number, Text and Date. When a field contains Date type, the user has to specify the format of the date from the corresponding dropdown menu provided in the DataFormat column.

Fixed Length option can also be used to specify the width separators for the file. The Position Setting option becomes easier to specify the fixed length. The field width separators can be manually specified, by dragging the separators with the use of the mouse cursor.



The data in the specified file, which is separated with the Field Separator or the Quotation Mark, will be loaded to the grid provided in the Text Settings dialog. The user can specify the With Separator, which separates the text in the selected file, using the Field Separator or Quotation Mark. For example, if the user has selected {SPACE} option from the Field Separator dropdown menu, the data will be separated according spacing among the data items in the selected text/CSV file.

The Load Pattern button is also used to specify the field separators very easily. For this option we have to select the text/CSV file from the Open dialog box. After selecting the necessary text/CSV, the Text Settings dialog will be displayed as shown bellow.

Figure 5.68 - Text Setting Dialog

The data in the specified file, which is separated with the Field Separator, will be loaded to the data grid provided in the Text Settings dialog. The Encoding dropdown menu in the Text Settings dialog menu is used to select the appropriate character-encoding format, in order to view the data loaded to the grid, if the data is in a Unicode form. If the user selects the Fixed Length option, the character encoding will be 932 Shift_JIS. When Fixed Length option is not selected, the user can select any character-encoding form from the Encoding dropdown menu in order to view the data, which is in the data grid.



Fixed Length option can also be used to specify the width separators for the file. The field width separators can be specified manually by dragging the separators in the field width adjustment area, with the aid of the mouse cursor.

Figure 5.69 – Text Definition Dialog – Fixed Length

The data, which is in the first row of the grid, can be taken as the field headings if the user selects Use first row as field names option. The user can also change the font of the data shown in the grid through the dropdown menu, which is at the bottom left hand corner of the Text Settings dialog.

The Expression button ( ) is used to open the Expression Builder which is shown by the following figure.

Field width adjustment area



Figure 5.70 – Expression Builder

The Expression Builder is used to create expressions from the TextDataset fields, functions and operators. The Builder also has a feature where the user can input values for the expression when the Template is in preview. To obtain this feature, the expression should be developed including {USERINPUT} as an operator.

The Condition button ( ) allows to open the Condition Builder which is shown by the following figure.

Figure 5.71 – Condition Builder



The Condition Builder allows specifying conditions for filtering data output using the TextDataset fields, functions and operators. The user can build the condition with {USERINPUT} operators also. User will be prompted to enter the value for the {USERINPUT} specified in Condition Builder, when previewing or requesting from the server via HTML.

Expression Builder & Condition Builder functions explained above in this section are also applicable to the URLTextDataset component described in section 5.2.5.3.

Data: The Data area will help to select the type of content input for the component (Either Static/Request). Create Sample Data ( ) property is used to create sample data for the TextDataset. To make this property enabled, it is required to define the fields for the TextDataset first. There is also an option to load values from either a file or a URL.

5.2.5.3 URLTextDataset

General: Refer the General area of section 5.2.5.1

Fields: The Edit option in the Fields property area, will allow the user to execute the Text Query Builder (Refer figure 5.44). The Text Query Builder helps to load text or CSV files, which contains fields and field types. This behaves as a table with fields and types in a database. The TextDataset eases the process of loading data in a text or CSV file.

Define Fields ( ) option opens the Text Definition dialog, which is shown by the following figure.

Figure 5.72 - Text Definitions Dialog



Text Definition dialog helps to add fields and their types. The user has to specify the character encoding of the data in the text/CSV file, which is in a specified URL location, through the Encoding dropdown menu. If the user selects the Fixed Length option, the character encoding will be 932 Shift_JIS. The With Separator is used to separate data in the file, which will be specified in the Value property of the Property Sheet.

The With Separator can be specified using the Field Separator or the Quotation Mark. The field names can be specified in the Name column of the Field Definition grid. The field type for the corresponding field can be selected from the Type drop down menu. The field types can be Number, Text and Date. When a field contains Date type, the user has to specify the format of the date from the corresponding dropdown menu provided in the DataFormat column.

Fixed Length option can also be used to specify the width separators for the file. The Position Setting option becomes easier to specify the fixed length. The field width separators can be manually specified, by dragging the separators with the use of the mouse cursor.

The Load Pattern button is also used to specify the field separators very easily. For this option we have to select the text/CSV file and then specify the width separators. After specifying the necessary text/CSV, the Text Settings dialog will be displayed (Refer figure 5.46).

The data in the specified file, which is separated with the Field Separator or the Quotation Mark, will be loaded to the grid provided in the Text Settings dialog. The user can specify the With Separator, which separates the text in the selected file, using the Field Separator or Quotation Mark. For example, if the user has selected {SPACE} option from the Field Separator dropdown menu, the data will be separated according spacing among the data items in the selected text/CSV file. The Encoding dropdown menu is used to select the appropriate character-encoding format, in order to view the data loaded to the grid, if the data is in a Unicode form.

Fixed Length option can also be used to specify the width separator for the file. The field width separator can be manually adjusted by dragging the separators in the field width adjustment area (Refer figure 5.47).



The data, which is in the first row of the grid, can be taken as the field headings if the user selects Use first row as field names option. The user can also change the font of the data shown in the grid through the dropdown menu, which is at the bottom left hand corner of the Text Settings dialog.

Refer the Fields area of section 5.2.5.2 for the description on Expression Builder & Condition Builder functions.

Data: The Data area will help to select the type of content input for the component (Either Static/Request).

The URLTextDataset gives the option to load values from a specified URL. Under Request type, the user can specify the URL Suffix and the URL Prefix properties, which will be useful when retrieving data from frequently used sources.

5.2.5.4 DatasetTable


Rule: Assigns the borders for the columns and bands of the DatasetTable.

Custom: The custom area has the Column Count property, which will help the user to change the number of columns in the selected DatasetTable. The Distribute Columns Evenly property is used to distribute columns evenly in the DatasetTable. The background color of the DatasetTable can be changed with the use Background Color property. Align facility is also available. The Dataset property facilitates the selection of a Dataset, which is on the Layout. It also provides a facility to assign the number of linked fields in the DatasetTable.

The Overall tab of the Custom property area provides a facility to enable/disable Page Header, Report Header, Report Footer, Page Footer and a Column Header to the selected DatasetTable.

The Repeat empty header property listed under the Report Header/Footer section provides an empty report header for each page from the second page onwards for a multi page document, which displays data from a DatasetTable. This



option can be selected only when Report Header of the DatasetTable has been selected.

The Align to bottom property listed under the Report Header/Footer section is used to align the Report Footer to the bottom of the DatasetTable, rather than having it displayed immediately after the last Data Band of the DatasetTable. The Report Footer property should be selected to enable Align to bottom property.

The Repeat empty footer property provides an empty report footer for each page from the second page onwards for a multi page document, which displays data from a DatasetTable. This option can be selected only when the above mentioned Report Footer & Align to bottom of the DatasetTable options have been selected.

The Group Header property listed under the Group section of the Groups tab is used to show the Group Header for the selected DatasetTable component. The Show in every page property is used to show the Group Header in every page. The Group Header property should be selected to enable Show in every page property. The Repeat empty header property provides an empty group header for each page from the second page onwards for a multi page document, which displays data from a DatasetTable. This option is enabled only for the first group and can be selected only when Group Header of the DatasetTable has been selected.

The Group Footer property listed under the Group section of the Groups tab is used to show the group footer for the selected DatasetTable component. The Show in every page property is used to show the Group Footer in every page. The Group Footer property should be selected to enable the Show in every page property.

The Align to bottom property is used to align the Group Footer to the bottom of the DatasetTable, rather than having it displayed immediately after the last Data Band of the DatasetTable. This option is enabled only for the first group and the Group Footer property should be selected to enable Align to bottom property. The Repeat empty footer property provides an empty report footer for each page from the second page onwards for a multi page document, which displays data from a DatasetTable. This option can be



selected only when Group Footer & Align to bottom options of the DatasetTable have been selected.

The New page for new group option is used to start every group in a new page.

The Links tab is used when creating SubReports. It is used to link two similar fields from the tables in two DatasetTable components. The user can select any number of similar fields.

The Remove Duplicates tab is used to remove duplicate fields in the DatasetTable components on the Template. In order to remove duplicates, the user has to check the check boxes of the required fields in the Remove Duplicates tab of the selected DatasetTable component.

The Restrict the number of details property which is displayed at the bottom of the custom property sheet, is used to restrict the number of data that will appear in the DatasetTable.

The Number of details property which is also listed at the bottom of the custom property sheet, is used to specify the number of data items that should appear in the selected DatasetTable.

5.2.5.5 HorizontalDatasetTable

General: Refer section 5.2.1.1

Rule: Assigns the borders for the columns and bands of the HorizontalDatasetTable.

Custom: The Custom property area has the Row Count property, which will help the user to change the number of Rows in the selected HorizontalDatasetTable. The background color of the HorizontalDatasetTable can be changed with the use Background Color property. Align facility is also available. The Dataset property facilitates the selection of a Dataset, which is on the Layout. It also provides a facility to assign the number of linked fields in the HorizontalDatasetTable.

The Overall tab of the Custom property area provides a facility to enable/disable Page Header, Report Header,



Report Footer, Page Footer and a Column Header to the selected HorizontalDatasetTable.

The Repeat empty header property listed under the Report Header/Footer section provides an empty report header for each page from the second page onwards for a multi page document, which displays data from a HorizontalDatasetTable. This option can be selected only when Report Header of the HorizontalDatasetTable has been selected.

The Align to right property listed under the Report Header/Footer section is used to align the Report Footer to the right of the HorizontalDatasetTable, rather than having it displayed immediately after the last Data Band of the table. The Report Footer property should be selected to enable Align to right property.

The Repeat empty footer property provides an empty report footer for each page from the second page onwards for a multi page document, which displays data from a HorizontalDatasetTable. This option can be selected only when the above mentioned Report Footer & Align to right of the HorizontalDatasetTable options have been selected.

The Group Header property listed under the Group section of the Groups tab is used to show the Group Header for the selected HorizontalDatasetTable component. The Show in every page property is used to show the Group Header in every page. The Group Header property should be selected to enable Show in every page property. The Repeat empty header property provides an empty group header for each page from the second page onwards for a multi page document, which displays data from a HorizontalDatasetTable. This option is enabled only for the first group and can be selected only when Group Header of the table has been selected.

The Group Footer property listed under the Group section of the Groups tab is used to show the group footer for the selected HorizontalDatasetTable component. The Show in every page property is used to show the Group Footer in every page. The Group Footer property should be selected to enable the Show in every page property.



The Align to right property is used to align the Group Footer to the right of the HorizontalDatasetTable, rather than having it displayed immediately after the last Data Band of the HorizontalDatasetTable. This option is enabled only for the first group and the Group Footer property should be selected to enable Align to bottom property. The Repeat empty footer property provides an empty report footer for each page from the second page onwards for a multi page document, which displays data from a HorizontalDatasetTable. This option can be selected only when Group Footer & Align to right options of the HorizontalDatasetTable have been selected.

The New page for new group option is used to start every group in a new page.

The Links tab is used when creating SubReports. It is used to link two similar fields from the tables in two HorizontalDatasetTable components. The user can select any number of similar fields.

The Remove Duplicates tab is used to remove duplicate fields in the HorizontalDatasetTable components on the Template. In order to remove duplicates, the user has to check the check boxes of the required fields in the Remove Duplicates tab of the selected HorizontalDatasetTable component.

The Restrict the number of details property which is displayed at the bottom of the custom property sheet, is used to restrict the number of data that will appear in the HorizontalDatasetTable.

The Number of details property which is also listed at the bottom of the custom property sheet, is used to specify the number of data items that should appear in the selected HorizontalDatasetTable.

The number of data records that will fit into the available table area (given the current band size) is displayed by clicking on a bottom resize point of DatasetTable and a right resizes point of HorizontalDatasetTable. (When group bands are present, the number of records will be calculated assuming that only one such band will appear on each page. That is, the possibility of more bands appearing due to limited number of data items is ignored.)

Note



5.2.5.6 DatasetTable Container


5.2.5.7 AggregateFunction



Custom: Custom properties for AggregateFunction component include the Layout property. With the Layout property, the text inside the component can be aligned both vertically and horizontally, on either side or on center, simply by clicking on the desired area out of nine areas shown. In addition the background color of the component can be changed through the Color property.

The properties of the Style area include Auto size property, which changes the size of the component to show the whole data content. The Word wrap and Equalize properties spread or shrink the characters evenly within the component. Fit property is used stretch the contents accordingly to fit the components size.


When the Auto adjust property of the Band Height is checked in a DatasetBand of a DatasetTable or a HorizontalDatasetTable, the height of the Band will adjust to accommodate the data in it rather than enabling scroll bars. (Only available for Data bands and Group bands and not for Headers or Footers)

Note



Data: The Database type is the only type supported. Dataset property is used to choose the Dataset in order to calculate the aggregates. Field Drop Down box allows selecting the field that is used to calculate the aggregate. The aggregate function, which is to be used, will be selected through the Function property (MIN, MAX, COUNT, etc).

5.2.5.8 DBExecute


Scripts: The Edit option will allow user to call DBExecute Editor. DBExecute Editor can be used to add or remove database scripts. These scripts can be triggered to execute before or after document creation by choosing the appropriate Timing of execution.

Figure 5.71 – DB Execute Editor

The Left pane can be used to specify the database (by selecting the database) before writing a script. Add button allows the user to initiate a database script and the Apply button will apply the script.



5.2.6 Security

5.2.6.1 Document Security

General: Properties explained in section 5.2.1.1 are applicable to Document Security component. However by default Visible property is assigned as true, while the Transparent property is assigned as false. The user cannot change these or the size of the Document Security component.

Permissions: Encryption Level specifies the encrypting levels of the

document. There are two levels of encrypting, 40-bit RC4 and 128-bit RC4.

The 40-bit RC4 (Acrobat 3.x, 4.x Compatible) encryption

level has a lower level of security, but it is compatible with Acrobat 3 and 4. This level of encryption allows the following security features which can be set in a document.

• No Printing - This prevents the user from printing the file. • No Changing the Document - This prevents the user from

creating form fields, as well as making any other changes. • No Content Copying or Extraction, Disable Accessibility -

This prevents the user from copying text and graphics, and disabling the accessibility interface.

• No Adding or Changing Comments or Form Fields - This prevents user from adding or changing these areas.

The 128-bit RC4 (Acrobat 5 Only) encryption level has a higher level of security, but it is compatible only with Acrobat 5. This level of encryption allows the following features.

• Enable Content Access for the Visually Impaired - This

allows document contents to be copied, which is required to support the Accessibility feature.

• Allow Content Copying and Extraction - This will allow the user to select and copy the contents of the PDF document. This option also lets facilities that need direct access to the contents of a PDF (such as Acrobat Catalog) get to those contents.

• Changes Allowed. This will describe the kind of changes

the users will be allowed to make on the PDF document.



• Printing. This will define the level of printing users are allowed.

(Only No Printing is supported in OPRO X Browser)

Password: The Master Password can be assigned here. The User Password

can be assigned through all the three data types (Static, Request and Database). In Static type the password has to be specified in the text box provided. In Request type the password can be set when the HTML preview is generated. In Database type the password can be retrieved from a database.

5.2.6.2 Digital Signature

General: Properties explained in section 5.2.1.1 are applicable to the Digital Signature component. However the Location, Visible and the Drag Lock properties can be changed. When a user has logged in using an existing profile, the Sign Document dialog will appear.

Font: Font properties explained in 5.2.1.2 will be applied except CJK and EUDC properties.

Custom: The position of the Image and Text can be assigned through the Layout property, while Set as Background property puts the image behind text. The Stretch property is used to stretch the image.

Figure 5.72 – Sign Document



When placing a Digital Signature component the Digital Signature Login dialog will appear.

If a profile for the user already exists, the user can enter the password and proceed. If the user is new to the server, then he will have to create a new profile by clicking the New User Profile button. The New User Profile dialog will then be displayed.

Figure 5.74 – Create New User Dialog

The user will have to enter the data as required and choose a password not less than six characters long. After the above details are typed or when a user has logged in using an existing profile, the Sign Document dialog will appear.

Figure 5.73 – Digital Signature Login Dialog



Figure 5.75 – Sign Document Dialog

After entering the required details as needed, the user can sign the document using the Default Signature Appearance by confirming the password in the textbox given, or else he/she can change the appearance of the signature by creating a new one or selecting a previously created Appearance.

When creating a new Appearance the Digital Signature Appearance Settings dialog will be displayed.

Figure 5.76 – Appearance Settings Dialog



The user can tick the necessary attributes that should be displayed in the image. The user also has the ability to add a new background by checking User Image option and clicking on the Browse button. When the Browse button has been clicked, the following dialog will appear to select a new image for the background.

Figure 5.77 – New Background Open Dialog

The digital signature will be place on the Template after clicking the Sign Document button.

5.2.6.3 MistyGuard SignedPDF

General: Properties explained in section 5.2.1.1 are applicable to the MistyGuard SignedPDF component. However the frames, which are set as default cannot be disabled.

Custom: Custom properties of the component include the Color property, which determines the background color. The Printable property determines whether the signature is printable or not. Author property is used to specify the author of the document. Location property provides details of the Location e.g. City. The Reason property is used to give the reason for signing the document, while the Comment property provides any comments.



5.2.6.4 VeriSign Digital Signature


Font: Refer section 5.2.6.2

Custom: Refer section 5.2.6.2

5.2.6.5 DocuWorks Signature


When placing a DocuWorks Signature component the DocuWorks Signature Profile dialog will appear as shown bellow.

Figure 5.78 – DocuWorks Signature Profile Dialog

This dialog displays information pertaining to the DocuWorks Signature. It contains information such as the Signature Module, Signer of the Document, Certificate Issuer, Remarks, the Certificate Authority and the Certificate validity time frame. The DocuWorks Signature component will be place on the Template after clicking the OK button. In order to cancel the DocuWorks Signature, click on the Cancel button. DocuWorks Signature can be validated only in the Documents generated in the DocuWorks format (.XDW).



5.2.6.6 TimeStamp


Time Stamp Server: Provides the TimeStamp Server name.

When placing a TimeStamp component the Time Stamp Server Dialog will appear as shown bellow.

Figure 5.79 – Time Stamp Server Dialog

This allows the user to select the appropriate TimeStamp server from the Name drop down menu provided. The TimeStamp component will be place on the Template after clicking the OK button.

5.2.7 Wizards

5.2.7.1 DatasetTable Wizard

The DatasetTable Wizard provides a step-by-step guidance to create a complete DatasetTable or a HorizontalDatasetTable with less effort. To use the wizard, it is necessary to have a Dataset component on the Document Template.

The first interface allows the user to select the Dataset in which the document is to be created with. The available fields in the Dataset are shown Available Fields list box. The required fields should be selected to the Selected Fields list box. The Next button should be pressed to continue to the next dialog.



Figure 5.80 – DatasetTable Wizard

The second dialog given bellow shows the user the appearance of the document being created.

Here the user can provide a name to the DatasetTable/HorizontalDatasetTable.

He can also set the position within the page and select the number of DatasetTable/HorizontalDatasetTable groupings in the document. If the grouping is more than one, the Group ID will be automatically assigned to the next available Group ID, considering the other groupings that are already done on the Layout.



The next dialog allows the user to apply bands such as Report Headers, Reports Footers and Column Headers. It is also used to apply Single Column or Multi Columns to the DatasetTable / HorizontalDatasetTable.





When the user clicks the Finish button, the DatasetTable/HorizontalDatasetTable will be automatically generated onto the Template.

5.2.7.2 SubReport Wizard

The SubReport Wizard allows the user to create Sub Reports with less effort. Sub Reports can be constructed in various ways. They are,

DatasetTable within a DatasetTable.

HorizontalDatasetTable within a HorizontalDatasetTable.

The first dialog of the SubReport Wizard allows the user to select the Dataset, which the document should be based upon. The available fields are displayed in the Available Fields list box and the required fields should be moved to the Selected Fields list box. The user can specify in which way the field positions should be set (It is set as vertical in the following figure). The Next button should be clicked to continue to the next interface screen.

Figure 5.83 – Sub Report Wizard



The second dialog, which is similar to the first dialog, allows the user to select the child Dataset and the fields required. When the user clicks the Next button and proceeds to the next wizard step, the gray area highlighted in the preview will show how the child Dataset will appear.





In the third step of this wizard, the user can specify the position of the parent DatasetTable. The user has the ability to link the fields of the parent DatasetTable and the child DatasetTable. When this is done, the user can click the Finish button in order to create the SubReport onto the Document Template.

5.2.7.3 Graph Wizard

Graph Wizard is a tool that helps the user to create graphs with ease.

Figure 5.86 – Graph Wizard

In the first step of this wizard, the user can decide the type of the graph (Simple Graph/Advanced Graph).



Simple Graph:


If the Simple Graph option is selected, the dialog shown above will appear. This dialog helps the user to specify the data source for the graph. It also helps the user to select the Graph Type.

If Database option is selected as the Graph Data Source the following dialog will appear. (For a Database graph, a Dataset must be placed on the Document Template).




The user can then select the Dataset from the Dataset DropDown box and also the Graph Data Fields as required. The number of Series can also be specified, according to which series fields will be added.

When the user selects Static option as the Graph Data Source, the following dialog will be displayed.


The user can enter data manually or load it from a CSV (Comma Separated Values) file in to the data fields. The Series can also be added as previously mentioned in the Database dialog. After entering data manually the user should click the Next button in order to proceed with the wizard.

The dialog, which will be displayed in the next step, will show the properties of the Graph. The user can view the values of the properties and change such values as required.





After the properties have been selected, click the Next button, which in turn shows the final dialog box of the wizard. This dialog box allows the user to modify basic settings of the Graph. After setting these basic properties such as Depth, Elevation and Angle of rotation the user can place the graph onto the Document Template by clicking the Finish button.



Advanced Graph:


If the Advanced Graph option is selected, the user can define multiple graphs in the same area. The remaining dialogs will be same as the simple graphs depending on the type of data (Static or Database).

5.2.7.4 Dataset Change Wizard

Dataset Change Wizard is a tool, which simplifies the change of Datasets used in a Template. This wizard helps to swap the Dataset A with its entire set component properties to Dataset B. This wizard not only makes it possible to change between Datasets and but also makes changes between URLTextDatasets and TextDatasets. The user should select the source Dataset from the Source Dataset drop down menu that lists all the available Datasets used in the Template. Once the source Dataset is specified by the user, the captions of fields of the source Dataset are automatically listed below in the corresponding Field memo. Once the source Dataset is chosen, a destination Dataset must be chosen to make the mapping of Dataset



components possible between the two chosen entities. The Destination Dataset can be specified by selecting a suitable dataset from the Destination Dataset drop down menu which holds all available Datasets used in the Template. Once the user specifies the Destination Dataset the captions of the fields of the Destination Dataset are automatically listed below in the corresponding Fields memo. When choosing the destination Dataset the user should be careful to choose a Dataset with equal or more data fields than the source Dataset in the question. When the source and destination data sources are selected the user would proceed to the next step by clicking the Next button. It should be noted that choosing the same dataset, as the source and destination would prompt an error message from OXD and the user would be compelled to alter his choice of dataset in order to move to the next dialog.

Figure 5.93 – Data change wizard

In this frame, all the data fields of the source Dataset are mapped to the appropriate fields of the destination Dataset. It should be noted not more than one source field can be mapped to a corresponding data field in the destination Dataset, hence making it an one to one mapping process. Trying to do so would prompt an error message from OXD.



Once the mapping process is complete the Finish button becomes enabled and by clicking this button, it signals the successful completion of Dataset swapping in a Template.

Properties of all components, which correspond to the source Dataset, are changed to properties held by the destination Dataset. But if the source Dataset contains user made changes to the format component this change would be retained and would not be over written to the destination Dataset format.

Figure 5.94 – Data change wizard

5.2.8 Layout Properties

The properties of the Layout are explained separately in this section.

General: The Name property is used to specify the name through which the Layout would be identified. The color of the Layout can be selected from the Background Color dropdown list.

Operation: Magnet Mode property provides a special component-

aligning mode. Refer Magnet Mode in 5.3 for details.

Properties related to the Grid can be set in this section. The visibility of the Grid can be enabled/disabled by the Visible property. The Color property is used to change the color of the Grid. The Snap Style and the Interval of the Grid can also be assigned here.



Layout Settings: Unit gives an option to choose between centimeters and inches for several properties in the Layout Settings area.

Left, Right, Top and Bottom properties in the Margins area let

the user set the size of the Layout margins. The Size property allows the user to set the paper size. There is a range of sizes provided such as A4, A3 etc. If Custom is selected as the Size, the user can define the paper size through Height and Width properties. Paper Orientation can also be changed here (Portrait or Landscape). Checking the Hide Layout if box and providing a unique id in {USERINPUT} will enable the Layout to be hidden during a server side preview. When the Non Repeatable property check box (which is unchecked by default) is checked, a Template, which prints results from a database, will only print the first page during preview time regardless of the number of data items available.

5.2.9 Template Properties

The properties, which pertain to the entire template, are described in this section.

Template Settings: When Same As Display option has been selected, the

selected Template will be printed via OXB, in a resolution, which is similar to the resolution of the screen. In order to provide backward compatibility support, 2.3 Compatibility option is selected as default, for all the Templates designed under the previous versions of OXD. The user has the ability to change the option to Same As Display, which will print the generated Templates in OXB, which is similar to the resolution of the screen.



5.3 Editable/Report Area

This is the area used to design Document Templates.

Figure 5.95 – Template Design Area Several features have been provided for the ease of the designer.

• Snap to Grid button ( ) enables/disables the Snap function for the Layout and all its container components. When enabled, a component will snap to a grid line when it is moved. (The Snap property of individual components cannot be controlled by this button)

• Magnet Mode button ( ) enables a feature, which helps the user to align components. In this mode, when a component is moved close to another, the border of the stationary component turns red. Releasing the moving object at this stage will align the two components so that the adjoining borders of them lie in the same position (in contact).



• Group Objects Pointer button ( ) enables easy grouping for components. (The button is enabled only when components that can be grouped are placed on the Layout) Once the button is pressed, the user will be prompted for a Group ID. Clicking the NewID button could set the next available Group ID. Thereafter the components to be grouped can be simply clicked and they will be grouped in the order of clicking. The mouse pointer will change when it is positioned over a component that can be grouped. (Only certain components can be grouped and different types of components can’t be grouped together) Once grouped, each component will display its group id and group order.

The Group ID or the group order of already grouped components can be easily changed using this button. This can be done by choosing a new group id and clicking on the group of components in the required order. (It is also possible to change the group order while retaining the same group id) • Multi-Select function enables the user to change the properties of a group of selected components at once. Once the required components have been selected (by holding the Shift key down while clicking on each component or by drawing a rectangle around the components) the properties of such selected components can be changed through the properties that are available at the Target Component(s) tab of the Property tab. However components placed inside a container cannot be selected together with components placed outside.

Figure 5.96 – Multi Select Option



With the dropdown list available in the Target Component(s) tab, the user can change the properties of a certain type of components that are among the selected multiple components. Once the type of component is selected, the properties can be changed in the Target Component(s) tab.

5.3.1 Explorer Tab

The Explorer tab shows all the components that are placed on the active Layout of the active Template. By clicking on a component on the explorer bar, you can select the particular component in the Template.

Figure 5.97 – Explorer Tab

The order of the components on the Layout (the creation order) can be changed after they have been placed. The component, of which the order has to be changed, should be selected in the Explorer tab and the order can be changed using the Move Up and Move Down buttons ( ) provided on the panel. The position of the component in the explorer tab’s tree will change accordingly.



5.3.2 Property Tab

The Property tab shows the properties of the selected component in the Template. There are two tabs in the Property tab. The Active Component shows all the properties of the active component. The Target Component shows the properties of all the selected components, which are common to any component of that type (except for Data properties).



6. OXD Help

OXD comes with a fully featured online help where almost all the functionalities and other aspects of the OPRO X Designer are fully discussed. From a simple how to do, to a complete explanation of operational aspects is given in the help. The online help dialog comes in standard three tabs, Contents, Index and Search.

Figure 6.1 – OXD Help

Chapter 6



7. OPRO X Designer Tutorial

7.1 Checking whether OXS is Installed Properly

Steps for creating a simple Template are given in order to verify whether OXS is operational.

1. Start OXD and click on the New Template button ( ) to create a new blank Template.

2. Place a Label component on the Template by clicking on Label button ( ) on the Standard component palette and then click on the Template work area.

3. To modify the data displayed in the Label, select the Property tab (on the left side of the work area); go to the Data section and change text inside the Value text box.

4. Save the Template by selecting Save Template ( ) option in the File menu. Give an appropriate file name and select the destination directory in the dialog box, which appears, and click Save. The file will be saved with the extension .oxt.

5. Copy the saved Template to the server directory (*1). This enables you to use this Template with OXS.

6. Select the Generate Sample HTML option from the Options menu and click Show button to generate the sample HTML. Select the appropriate Operation (e.g. dl to download), check the required output format and click the Submit button.

7. If the file is redirected to the format you requested and displayed, OXS is running properly. (*2)

*1 : Save in the directory which you configured in ODCAW.xml under ODCAW/ODTS/PATH/IN_FILE/LOCAL node. (default directory is Templates)

*2 : In order to view Templates in OPR format, it is necessary to have OPRO X Browser installed.

Chapter 7



7.2 Preparing a Simple Template Containing a DatasetTable

In this section, steps are provided for preparing a simple Template, which interacts with a database and generates a simple document with data.

1. Start OXD and click on the New Template button ( ) to create a new blank Template.

2. Select a Dataset component ( ) from the Data Access component palette and place it on the work area of the Template.

3. Double-click on the Dataset component. The OSMS Login dialog will be displayed. Enter a valid user name and a password and click Login. (*1)

4. When the OSMS login is completed successfully, the Query Builder (the query generation tool) will be started. All the databases that are connected to the OXS are displayed on the left side.

5. Double-click on the required table or drag it on to the blank work area on the right side.

*OSMS (OPRO Schema Management Service) is a support service of OXS, which manages the schema information of the database. The username and the password are set in ODCAW.xml.



Figure 7.1 – Dragging a Table to the Table Area

6. Double-click on the required fields to add them to the dataset. All the fields can be added at once by clicking the Add All Fields button ( ).

Figure 7.2 – Adding All Fields of the Table

Add All Fields button.

Selected fields



7. It is possible to view the result set (data content) by clicking the Display Result button ( ). (By clicking the Close button the Result dialog can be closed).

8. When the query is completed, clicking the OK button will close the Query Builder and will return to the Template work area.

9. Select a DatasetTable component ( ) from the Data Access component palette and place it on the work area.

10. Select the DatasetTable (click on it while the Alt key is pressed) and go to the property editor (*2). Select Dataset1 from the Dataset dropdown list in the Custom section. This will attach the Dataset to the DatasetTable.

Figure 7.3 – Selecting a Dataset for the Dataset Table

11. Select the Dataset and view its Property editor. The available fields will be displayed in the Fields area in a tree format.

12. Drag and drop a field on to a DatasetColumn in the DatasetTable or place a Label component on a DatasetColumn and change its Type in the Data section to

Select Dataset

DatasetTable



Database. Select the Dataset and the Field in the provided dropdown lists as required.

*2 Properties of a component that is selected in OXD are shown on the Active Component tab of the property editor, which is on the left side of the work area.

Figure 7.4 – Dragging Fields of the Dataset

Figure 7.5 – Changing the Data Type property to Database

Drag & Drop

Select from Label



13. Row and column borders can be assigned as required by clicking the appropriate button in the Rule section of the property editor of the DatasetTable.

14. Click the Preview button (or select a Preview Format from the drop down menu of the Preview button ) to preview the Template. (*3)

*3 The preview format can be changed in the Preview Format area of the General tab of Environment Options in the Options menu also.

7.3 How to use Conditional Format

This is a new feature, which is specially used in Label component for specifying conditions.

Figure 7.6 – Conditional Format

Adding a Condition

1. Place a Label component on the Template.

2. Select the Label component and press F11 to list the properties.

3. Click the Add button in Conditional Format. Then the content will appear below to specify the condition.



4. By clicking the Add Condition button, the user can add another condition for the same content.

Specifying a Condition

Using Static Data:

1. Add a Condition

2. Select the Equal from the Operator dropdown.

3. Type OPRO in Operand 2.

4. Change properties in Conditional Format to effect when the condition satisfies. (Change the font color to Red, Change background color as Yellow)

5. Type OPRO in the Value edit box under the Data properties of the selected component.

6. Click the Preview button.

7. Now you can see that the condition has been satisfied and the given changes applied have been applied to the Label component.

8. Change the value of the selected Label component (E.g. OPRO1). Thereafter preview the Document Template. The specified changes will not be applied to the Label since the new value of the Label does not satisfy the condition given.

Using Database:

1. Add a Condition

2. Select the Dataset and thereafter the required Field (To select the field double click on the Dataset) from the Operand 1 drop down list (E.g. like SALARY field).

3. Select the required operator from the Operator drop down list (E.g. Greater than).

4. Type a value in the Operand 2 drop down list. (E.g. 5000). You can also specify Dataset fields.



5. If user wants to have another condition, click the Add Condition button and repeat from steps 2 to 4.

6. Now change the properties of the selected Label component which are given bellow the Conditional Format area (E.g. Font Name, Size, Color, Strikeout or Bold).


8. If there is any record that satisfies the condition, then it will apply the changes made for the Label in step 6.

You can also display another Dataset field when the condition of the Conditional Format has satisfied. In order to experience this feature, follow the procedures given bellow.

1. Place a Dataset on the Template and add a database to the Dataset through the Query Builder.

Figure 7.7 – Placing a Dataset Component on the Template

2. Select a table(s) and fields from the Query Builder (Example: Employee database and all the fields of the Employee database).

Place a Dataset component on the Template.



3. Drag fields from the Fields property of the Dataset component to the Template. The dragged field will be placed as a Label component on the Template (Example: Employee ID, Employee Name and Salary fields).

Figure 7.8 – Dragging Fields of a Dataset Component

4. Select one of the Label components and press F11 key to list the properties (Example: Salary label on the Template).

5. Click on the Conditional Format/Add to add a condition.

Drag and drop fields from the Fields property of the Dataset.



Figure 7.9 – Adding a Condition

6. Select the operator from the Conditional Format/Operator (Example: Greater than operator).

Figure 7.10 – Selecting the Operator

Click on the Add button to add a condition.

Select the Operator type (Example: Greater than).



7. Type the required data in Conditional Format/Operand 2 (Example: 5000).

Figure 7.11 – Selecting the Operand 2

8. Change the properties for the Conditional Format to show the effect of satisfying the condition.

Change the background of the Background Color to yellow through Conditional Format/Background Color.

Make the font boldfaced through Conditional Format/Appearance/Bold.

Enter a value for the Operand 2 (Example: 5000).



Figure 7.12 – Selecting the Conditional Property

Check the Change Value property through Conditional Format/Change Value to enable the entering of the Change Value.

Select another field of the Dataset in order to display as the Change Value, from the Change Value dropdown menu.

Figure 7.13 – Selecting Change Value and Selecting a Dataset Field as the Change Value

Select Bold property

Select Yellow color as the Background Color.

Check Change Value property.

Select a field from the Dataset through the Change Value dropdown.



9. Click the Preview button ( ).

10. You will notice that in the preview the content on changed Label (Example: Salary Label) will be replaced by the corresponding value of the field, which has been specified under the Change Value dropdown (Example: corresponding value in the Job Field).

Figure 7.14 – OPR Preview of the Conditional Format

Deleting a Condition

1. Open the Template, which has the Label that includes the Content and the conditions.

2. Select the component and press Function key 11 (F11) to display the properties of the component.

3. Check the condition, which needs to be removed and click the Delete Condition button.

7.4 Displaying data on the document

There are many ways to display the data in a Dataset. They are discussed below:

7.4.1 Directly displaying data on the document

1. Select the Dataset component.

Condition given in the Label has been satisfied (Example: Salary Label will display the Job title of the employee when the salary is greater than 5000).



2. On the bottom of the property bar, there will be the fields that have been loaded into the Dataset.

3. Drag and Drop the required Fields, which needs to be displayed onto the Layout.

4. Click the Preview button. In order to preview the Document Template.

5. Note that the number of pages will be equal to the number of records available in the Dataset (One page per record).

7.4.2 Using a DatasetTable component

Refer section 7.2

7.4.3 Using a DatasetTableContainer with a DatasetTable

The DatasetTableContainer is a component that allows printing two or more DatasetTables one after another with continuity (without having any spaces between the placed dataset tables). This is very useful when data has to be listed down in tables one after the other without a break/space in between.

1. Place a DatasetTableContainer on the Layout.

2. Place a DatasetTable/s into the container

3. Align the DatasetTable by using the Align property, which is under the Custom properties.

4. Place the fields to be displayed into the DatasetTable’s columns

7.5 Using headers and footers in the document

You can insert various headers and footers such as Report Header, Report Footer, Page Header, Page Footer, Column Header, Group Header and Group Footer.

1. Place a Dataset and connect it to the database (refer 7.2).

2. Place a DatasetTable component to the Layout as required

3. Connect the Dataset to the DatasetTable (This will enable the Headers and Footers options in the properties)



4. Tick the required Headers and Footers appropriately using the check boxes provided on the Bands tab of the Custom properties.

5. Place the required component/s or place the data from the Dataset by clicking on the Dataset and dragging and dropping the fields in the property tab to the appropriate Header or Footer.

6. The data fields in the Dataset can be dragged and dropped into the columns as required and clicking the Groups fields will show the grouping bands in the document. To get a set of fields grouped, place the field to be grouped (by dragging and dropping) in the Group Band provided when the Groups field is clicked.

7.6 Using Expression Builder

The Expression builder is a special tool, which is a part of the Query Builder. It simplifies the process of building complex SQL expressions.

1. Place a Dataset component to the Template.

2. Double click on the Dataset component and connect it to a database.

3. Select the tables as required (refer 7.2).

4. After selecting the required tables, click on the Expression Builder icon. This will launch the Expression Builder window.

5. The tables available and their fields will be shown on the top left hand corner of the Expression Builder application.

6. Select the operation/s and the fields needed. (eg. MAX(<Table>.<field>))

7. Make any more expressions as per SQL syntax.

8. Click the OK button to apply the specified expressions.

7.7 Using Condition Builder

The Condition Builder is a tool very similar to the Expression Builder, which allows building complex SQL conditions with least effort.




2. Double click on the Dataset component and connect it to a database

3. Select the tables as required (refer 7.2)

4. After selecting the required tables, click on the Condition Builder icon. This will launch the Condition Builder window.

5. The tables available and their fields will be shown on the top right hand corner of the Condition Builder application.

6. Select the operation/s and the fields needed.

(E.g. <Table1>. <field1>=<Table2>. <feild2>)

7. Make any more conditions as per SQL syntax.

8. Click the OK button to apply the specified conditions.

7.8 Using Group By Editor



3. Select the tables as required (refer 7.2).

4. After selecting the tables required, click on the Group By icon. This will launch the Group By Editor window.

5. The fields available for grouping will be shown in the upper half of the window. Select the field/s needed for grouping in the required order, with the use of the Add button (Order can be changed using the arrow keys).

6. Click the OK button to apply the specified groupings.

7.9 Using Order By Editor





3. Select the tables as required (refer 7.2)

4. After selecting the tables required, click on the Order By icon. This will launch the Order By Editor window.

5. The fields available for ordering will be shown in the upper half of the window. Select the field/s needed for ordering in the required order, with the use of the Add button (Order can be changed using the arrow keys)

6. Click the OK button to apply the specified ordering.

7.10 Using SubReports

This is a special feature, which allows the user to have special grouping of data. This is achieved by placing a DatasetTable component within a Data Band of a parent DatasetTable component.

The two DatasetTables can either be linked to the same Dataset or different Datasets. The Link property of the Property tab allows the user to link the parent field with a child field depending on the fields available.

This can be done as follows:


2. Connect to a database and select the tables and fields required using the Query Builder.

3. Place a second Dataset and do the same (If required)

4. Place a DatasetTable component to the selected Layout.

5. Highlight the Data Band using the mouse and increase its Width & Height if needed.

6. Place another DatasetTable component within the Data Band of the parent DatasetTable.

7. Connect the Datasets with the respective DatasetTables as required



8. Make the link between the parent DatasetTable and the child DatasetTable by using the Link tab, which is located under the Custom properties of the child DatasetTable.

7.11 Using AggregateFunction

1. Place a Dataset component to the Template and connect it to a database.

2. Choose the tables & fields as required

3. Place a DatasetTable on the Document Template.

4. Place an AggregateFunction component in either a Report Header, a Report Footer, a Group Header or a Group Footer as needed where the aggregate is to be displayed

5. Select the type of AggregateFunction and the format needed, which is located under Data properties section.


Appendix B


Expressions and Conditions for Visual Query Builder

A.1 Expressions

A.1.1 {USERINPUT}

Operator {USERINPUT}

o Usage

Use {USERINPUT} to add a user input to the expression. If a {USERINPUT} is added to the expression, when you are going to request the results, you will be prompted to enter the user input.

A.1.2 Add Operator

Operator “+” (Plus sign)

o Usage P + Q where P AND Q can be values or data fields. Add value P to value Q

o Example(s)

20,000 + 10,000 = 30,0000

<DATASET1>.ORACLE-1.ITEM.SALESPRICE + <DATASET1>.ORACLE-1.TAX = 10000.00 <DATASET1>. ORACLE-1.ITEM.SALESPRICE + 100.00 = 115000.00

A.1.3 Subtract Operator

Operator “-“(Minus sign)

Appendix A

Appendix B


o Usage

P - Q where P and Q can be values or data fields. Subtract value P by value Q

o Example(s)

20,000 - 10,000 = 10,000 <DATASET1>.ORACLE-1.ITEM.SALESPRICE - <DATASET1>.ORACLE-1.COSTPRICE = 10000.00 <DATASET1>. ORACLE-1.ITEM.ITEMPRICE - 100.00 = 115000.00

A.1.4 Multiply Operator

Operator “*” (Asterisk sign)

o Usage

P * Q where P AND Q can be values or data fields. Multiply value P by value Q

o Example(s)

2000 * 12 = 24000

<DATASET1>.ORACLE-1.ITEM.ITEMPRICE * <DATASET1>.ORACLE-1.ITEM.QTY = 30000.00 <DATASET1>.ORACLE-1.ITEM.ITEMPRICE * 100.00 = 115000.00

A.1.5 Divide Operator

Operator “/” (Slash sign)

o Usage P/Q where P and Q are numbers or data fields.

Appendix B


Divide value P by value Q

o Example(s)

36 / 6 = 6 3 / 2 = 1.5 <DATASET1>. ORACLE-1.SALES.AMOUNT / 2 = 20000

A.1.6 Concatenation Operator

Operator “||” (Pipe sign)

o Usage

P || Q Where P and Q are two strings, connect string P to string Q. You can only use this operator if all the elements you are connecting are text strings. Concatenate joins multiple text strings to make one contiguous string.

o Example

<DATASET1>.ORACLE-1.CUSTOMER.NAME || <DATASET1>.ORACLE-1.CUSTOMER.ADDRESS = New String

A.1.7 Text Value (Constant)

Operator “‘” (Single Quote sign)

o Usage

‘P’ || field Where P is a string,

o Example

‘Rs’ || <DATASET1>.ORACLE-1.EMP.SAL This will add Rs string to the SAL field.

A.1.8 SUBSTRING ()

o Format

Appendix B


SUBSTRING (string, x, y). Where x is the starting position and y is the length of the string.

o Action Filter a Sub string from a given string.

o Example

SUBSTRING(<DATASET1>.ORACLE-1.CUSTOMER.ADDRESS, 2,10)

A.1.9 LOWER()

o Format

LOWER(x) where x is a text value in a data field or a text string.

o Action

LOWER() prints the text string or text value in the data field in all lower case letters. LOWER() function won't affect numbers contain in a text string. This function can be used to print both uppercase and lowercase letters in lowercase format.

o Example(s)

LOWER(<DATASET1>.ORACLE-1.CUSTOMER.NAME). Display customer name in lowercase. LOWER("INDEX") = "index" Display index in lowercase.

A.1.10 UPPER()

o Format

UPPER (x) where x is a text value in a data field or a text string.

o Action

Appendix B


UPPER () prints the text string or text value in the data field in all upper case letters. UPPER () function won't affect numbers contain in a text string. This function can be used to print both uppercase and lowercase letters in uppercase format.

o Example(s)

UPPER (<DATASET1>.ORACLE-1.CUSTOMER.NAME). Display customer name in uppercase. UPPER ("index") = "INDEX" Display “index” in uppercases.

A.1.11 SUM()

o Format

SUM(field)

o Action

Calculate sum value of data field.

o Example

SUM(<DATASET1>.ORACLE-1.SALES.AMOUNT)

A.1.12 MAX()

o Format

MAX(field)

o Action

Gives the maximum value in data field.

o Example(s)

MAX(<DATASET1>. ORACLE-1.SALES.AMOUNT)

Appendix B


A.1.13 MIN()

o Format

MIN(field)

o Action

Gives the minimum value in data field.

o Example(s)

MIN(<DATASET1>. ORACLE-1.SALES.AMOUNT)

A.1.14 AVG()

o Format

AVG (field)

o Action

Average the values in data field.

o Example(s)

AVG (<DATASET1>. ORACLE-1.SALES.AMOUNT)

A.1.15 COUNT()

o Format

COUNT (field)

o Action

Counts number of entries in the field.

o Example(s) o COUNT (<DATASET1>. ORACLE-1.SALES.SALESPERSON_ID,)

Appendix B


A.1.16 ABS ()

o Format

ABS (y)

where y is the number or data field, which you want to find the absolute value.

o Action

ABS () returns absolute value of y, ignoring any + or - signs.

o Example(s)

ABS (5.50) = 5.50 ABS (10 - 7) = 3 ABS (<DATASET1>. ORACLE-1.SALES.AMOUNT)

A.1.17 DISTINCT ()

o Format

DISTINCT (field)

o Action

Display number of distinct values in the field. Duplicate values are not displayed.

o Example

DISTINCT(<DATASET1>.ORACLE-1.SALES.SALESPERSON_ID).

Appendix B


B.2 Conditions

B.2.1 {USERINPUT}


o Usage

Use {USERINPUT} to add a user input to the condition. If a {USERINPUT} is added to the condition, when you are going to request the results, you will be prompted to enter the user input.

o Example

<DATASET1>.ORACLE-1..EMP.EMPNO= {USERINPUT}

B.2.2 Mathematical Operators

B.2.2.1 Add Operator


o Usage P + Q where P AND Q can be values or data fields of the same type. Add value P by value Q

o Example(s)

<DATASET1>.ORACLE-1.ITEM.ITEMPRICE + <DATASET1>.ORACLE-1.ITEM.TAX

Appendix B


B.2.2.2 Subtract Operator

Operator “-” (minus sign)

o Usage P - Q where P and Q are two values or fields Subtracts Q from P.

o Example

<DATASET1>.ORACLE-1.Employee Sal - <DATASET1>. ORACLE-1.Employee.EPF

B.2.2.3 Multiply Operator


o Usage P * Q where P AND Q can be values or data fields. Multiply value P by value Q

o Example(s) 20,000 * 10,000

<DATASET1>. ORACLE-1.ITEM.SALESPRICE * <DATASET1>. ORACLE-1.TAXPercentage =

B.2.2.4 Divide Operator


o Usage P/Q where P AND Q can be values or data fields. Divides value P by value Q

o Example(s)

Appendix B


20,000/10,000

<DATASET1>.ORACLE-1.ITEM.TotalCost /<DATASET1>.ORACLE-1.COSTPRICE

B.2.3 Text Value (Constant)

Operator “ ‘ ” (Single Quote sign)

o Usage

‘P’ || field Where P is a string,

o Example

‘Rs’ || <DATASET1>.ORACLE-1.EMP.SAL This will add Rs string to the SAL field.

B.2.4 Conditional Operators

B.2.4.1 Equals Operator

Operator “=” (Equals)

o Usage P=Q where P and Q can be values or data fields.

Checks whether value P is equal to value Q for conditional fulfillment checking

o Example(s)

Tabel1.EmployeeNumber = Table2.EmployeeNumber

<DATASET1>.ORACLE-1.Emp.Number = <DATASET1>.ORACLE-1.Sal.Number

Appendix B


B.2.4.2 Greater than Operator

Operator “>” (Greater than)

o Usage

P>Q where P and Q can be values or data fields. Checks whether value P is greater than value Q for conditional fulfillment checking

o Example(s)

Tabel1.EmployeerSal > Table2.StandardSal

<DATASET1>.ORACLE-1.EMP.Sal > < DATASET1>.ORACLE-1.SAL.StandardSal

B.2.4.3 Greater than or Equal Operator

Operator “>=” (Greater than or Equal)

o Usage

P>=Q where P and Q can be values or data fields. Checks whether value P is greater than or equal to value Q for conditional fulfillment checking

o o Example(s)

Tabel1.EmployeerSal >= Table2.StandardSal

<DATASET1>.ORACLE-1.EMP.Sal >= <DATASET1>.ORACLE-1.SAL.StandardSal

Appendix B


B.2.4.4 Less than Operator

Operator “<” (Less than)

o Usage P<Q where P and Q can be values or data fields. Checks whether value P is less than value Q for conditional fulfillment

checking

o Example(s) Tabel1.EmployeerSal < Table2.StandardSal

<DATASET1>.ORACLE-1.EMP.Sal < <DATASET1>.ORACLE-1.SAL.StandardSal

B.2.4.5 Less than or Equal Operator

Operator “<=” (Less than or Equal)

o Usage

P<=Q where P and Q can be values or data fields. Checks whether value P is Less than or Equal to value Q for conditional fulfillment checking

o Example(s)

Tabel1.EmployeerSal <= Table2.StandardSal <DATASET1>.ORACLE-1.EMP.Sal <= < DATASET1>.ORACLE-1.SAL.StandardSal

Appendix B


B.2.4.6 Not Equal Operator

Operator “<>” (Not Equal),

o Usage

P<>Q where P and Q can be values or data fields. Checks whether value P is not equal to value Q for conditional fulfillment checking

o Example(s)

Tabel1.EmployeerSal <> Table2.StandardSal <DATASET1>.ORACLE-1.EMP.Sal <> < DATASET1>.ORACLE-1.SAL.StandardSal

B.2.5 Logical Operators

B.2.5.1 “AND” Operator

o Usage

P AND Q where P and Q can be values or data fields. Does the logical AND operation with P and Q values for conditional fulfillment checking

o Example(s)

Tabel1.EmployeerSal >10000 AND Table2.Bonus>5000 <DATASET1>.ORACLE-1.EMP.Sal >10000 AND < DATASET1>.ORACLE-1.SAL.Bonus>5000

Appendix B


B.2.5.2 “OR” Operator

o Usage

P OR Q where P and Q can be values or data fields. Does the logical OR operation with P and Q values for conditional fulfillment checking

o Example(s)

Tabel1.EmployeerSal >10000 OR Table2.Bonus>5000 <DATASET1>.ORACLE-1.EMP.Sal >10000 OR < DATASET1>.ORACLE-1.SAL.Bonus>5000

B.2.5.3 “NOT” Operator

o Usage

P NOT Q where P and Q can be values or data fields. Does the logical NOT operation with P and Q values for conditional fulfillment checking

o Example(s)

Tabel1.EmployeerSal >10000 AND NOT Table2.Bonus>5000 <DATASET1>.ORACLE-1.EMP.Sal >10000 AND < DATASET1>.ORACLE-1.SAL.Bonus>5000

A.2.5.4 “LIKE” Operator

o Usage

P LIKE Q where P and Q can be values or data fields. Does the logical LIKE operation with P and Q values for conditional fulfillment checking o o Example(s)

Tabel1.Employee.Name LIKE (‘SA%’)

Appendix B


<DATASET1>.ORACLE-1.EMP.Name LIKE (‘SA%’)

A.2.5.6 Open and Close brackets

Operator “(” and “)” Operators

o Usage

(P Condition Q) OPERATOR (R Condition S) where P, Q, R and S can be values or data fields. Does the logical Grouping operation with P Q, R and S values for conditional fulfillment checking o o Example(s)

Tabel1.Employee.Name LIKE (‘SA%’) AND (Table1.Bonus>5000) <DATASET1>.ORACLE-1.EMP.Name LIKE (‘SA%’) OR (<DATASET1>.ORACLE-1.EMP.Sal>40000)

A.2.5.6 Open and Close brackets

Operator “(” and “)” Operators

o Usage

(P Condition Q) OPERATOR (R Condition S) where P, Q, R and S can be values or data fields. Does the logical Grouping operation with P Q, R and S values for conditional fulfillment checking o o Example(s)

Tabel1.Employee.Name LIKE (‘SA%’) AND (Table1.Bonus>5000) <DATASET1>.ORACLE-1.EMP.Name LIKE (‘SA%’) OR (<DATASET1>.ORACLE-1.EMP.Sal>40000)

Appendix B


Expressions and Conditions for Text Query Builder

B.1 Expressions

B.1.1 {USERINPUT}


o Usage

Use {USERINPUT} to add a user input to the expression. If a {USERINPUT} is added to the expression, when you are going to request the results, you will be prompted to enter the user input.

B.1.2 Mathamatical and Character Operators

B.1.2 1 Sum Operator


o Usage P + Q where P AND Q can be values or data fields. Add value P to value Q.

B.1.2 2 Subtract Operator

Operator “-“(Minus sign)

o Usage

P - Q where P and Q can be values or data fields. Subtract value P by value Q.

Appendix B

Appendix B


B.1.2 3 Product Operator


o Usage

P * Q where P AND Q can be values or data fields. Multiply value P by value Q

B.1.2.4 Quotient Operator


o Usage P/Q where P and Q are numbers or data fields. Divide value P by value Q

B.1.2 5 Concatenate Operator

Operator “||” (Pipe sign)

o Usage

P || Q Where P and Q are two strings, connect string P to string Q. You can only use this operator if all the elements you are connecting are text strings. Concatenate joins multiple text strings to make one contiguous string.

B.1.2 6 Quotation of text string (Constant)

Operator “‘” (Single Quote sign)

o Usage

Used to enclose a string in an expression.

B.1.2 7.Quotation of field name (Constant)

Operator “”” (Double Quote sign)

Appendix B


o Usage

Used to enclose a field name in an expression.

B.1.3 String Functions

B.1.3 1 LEN()

o Format

LEN (string)

o Action

This returns the length of the specified string.

B.1.3.2 ISEMPTY()

o Format

ISEMPTY (string)

o Action

Checks whether the specified string is null or has length zero.

B.1.3.3 MID()

o Format

MID(string[, position, length])

o Action

This returns the substring of a string from the specified position which has the specified length.

B.1.3.4 LEFT()

o Format

LEFT(string[, length])

o Action

This returns the substring from the beginning of the string which has the specified length.

Appendix B


B.1.3 5.RIGHT()

o Format

RIGHT(string[, length])

o Action

This returns the substring from the end of the string which has the specified length.

B.1.3 6.LENB()

o Format

LENB(string)

o Action

This returns the length in SJIS bytes of the specified string.

B.1.3.7 SUBSTRINGB()

o Format

SUBSTRINGB(string[, position, length])

o Action


Appendix B


B.1.3 8 MIDB()

o Format

MIDB(string[, position, length])

o Action


B.1.3 9.LEFTB()

o Format

LEFTB(string[, length])

o Action

This returns the substring from the beginning of the string which has the specified length.

B.1.3 10.RIGHTB()

o Format

RIGHTB(string[, length])

o Action

This returns the substring from the end of the string which has the specified length.

B.1.3 11.CONTAINS()

o Format

CONTAINS(string, substr)

o Action

Checks whether the string contains the specified substring.

Appendix B


B.1.3 12 STARTSWITH()

o Format

STARTSWITH(string, substr)

o Action

Checks whether the string starts with the specified substring.

B.1.3 13 ENDSWITH()

o Format

ENDSWITH(string, substr)

o Action

Checks whether the string ends with the specified substring.

B.1.3 14 SEARCH()

o Format

SEARCH(string, substr[, offset]) o Action

Searches the substring in the string and the returned the found position.

B.1.3.15 SUBSTITUTE()

o Format

SUBSTITUTE(string, substr[, target, position])

o Action

Substitute the substring in the string with another string. If position n is given, only the n-th substring found is replaced. If position is 0 or not given, all the substring found is replaced.

Appendix B


B.1.3 16.FIND()

o Format

FIND(string, regex)

o Action

Checks whether the string has a substring that matches the given regular expression.

B.1.3 17.REPLACEALL ()

o Format

REPLACEALL(string, regex[, replacement])

o Action

Replaces all substrings of the string that matches the given regular expression with the given replacement.

B.1.3 18.REPLACEFIRST()

o Format

REPLACEFIRST(string, regex[, replacement])

o Action

Replaces the first substring of the string that matches the given regular expression with the given replacement.

B.1.3 19.CONCATANATE()

o Format

CONCATENATE(string1, string2, ..., stringN)

o Action

This Concatenates all the given strings.

Appendix B


B.1.3 20 REPT ()

o Format

REPT(string, count)

o Action

Repeats the string the specified number of times.

B.1.3 21.TRIM ()

o Format

TRIM(string)

o Action

Removes leading and trailing whitespace from the string.

B.1.3 22.LOWER ()

o Format

LOWER(string[, locale])

o Action

Converts the all characters in the string to lower case.

B.1.3 23.UPPER()

o Format

UPPER(string[, locale])

o Action

Converts the all characters in the string to upper case.

B.1.3 24.CHAR()

o Format

CHAR(number)

Appendix B


o Action

Returns the character of the specified Unicode code point.

B.1.3 25.SUBSTRING ()

o Format

SUBSTRING (string, x, y). Where x is the starting position and y is the length of the string.

o Action Filter a Sub string from a given string. String Functions

B.1.4 Conditional Branching Functions

B.1.4 1 IF()

o Format

IF(condition, value1, value2)

o Action

Branches the values by the specified condition. If the first argument can be parsed as a Boolean true, then the second argument is returned. Otherwise, the third argument is returned.

Appendix B


B.1.5 Numeric Functions

B.1.5 1.ISNUMBER ()

o Format

ISNUMBER(object)

o Action

Checks whether the given object represents a decimal number.

B.1.5 2 CEILING ()

o Format

CEILING(number[, scale])

o Action

Returns the value rounded up, in the direction to positive infinity, to the integer of the decimal number. Rounding is done at the decimal position of the specified scale.

B.1.5 3 FLOOR ()

o Format

FLOOR(number[, scale])

o Action

Returns the value rounded down, in the direction to negative infinity, to the integer of the decimal number. Rounding is done at the decimal position of the specified scale.

B.1.5 4 ROUND ()

o Format

ROUND(number[, scale])

Appendix B


o Action

Returns the value rounded to nearest integer of the decimal number. Rounding is done at the decimal position of the specified scale. If there are two nearest integers, the one having larger absolute value is selected.

B.1.5 5 ROUNDEVEN ()

o Format

ROUNDEVEN(number[, scale])

o Action

Returns the value rounded to nearest integer of the decimal number. Rounding is done at the decimal position of the specified scale. If there are two nearest integers, the even one is selected.

B.1.5 6.ABS ()

o Format

ABS(number)

o Action

Returns the absolute value of the decimal number.

Appendix B


B.1.5 7.SIGN ()

o Format SIGN(number)

o Action

Returns the signum function of the decimal number.

B.1.5 8.MOD ()

o Format

MOD(number, modulo)

o Action

Returns the remainder when the decimal integer divided by antoher decimal integer.

B.1.5 9.POWER ()

o Format

POWER(number, power)

o Action

Returns the decimal number raised to the power of another decimal number.

B.1.5 10.SQRT ()

o Format

SQRT(number)

o Action

Returns the square root of the decimal number.

B.1.5 11.EXP()

o Format

EXP(number)

Appendix B


o Action

Returns Euler's number e raised to the power of the decimal number.

B.1.5 12.LN ()

o Format

LN(number)

o Action

Returns the natural logarithm of the decimal number.

B.1.5 13.LOG ()

o Format

LOG(number)

o Action

Returns the base 10 logarithm of the decimal number.

B.1.5 14.TO_NUMBER ()

o Format

TO_NUMBER(string)

o Action

Parses the string as a decimal number and returns the decimal number value.

B.1.5 15.FORMAT_NUMBER ()

o Format

FORMAT_NUMBER(number[, format, locale])

o Action

Formats a decimal number and returns its string representation.

Appendix B


B.1.6 Date Time Functions

B.1.6 1.ISDATE()

o Format

ISDATE(object) o Action

Checks whether the given object represents a datetime.

B.1.6 2 YEAR ()

o Format

YEAR(datetime)

o Action

Returns the year represented by the given datetime.

B.1.6 3 MONTH()

o Format

MONTH(datetime)

o Action

Returns the number of month represented by the given datetime.

B.1.6 4 DAY()

o Format

DAY(datetime)

o Action

Returns the day of month represented by the given datetime.

Appendix B


B.1.6 5 HOUR ()

o Format

HOUR(datetime)

o Action

Returns the number of hours past the day represented by the given datetime.

B.1.6 6 MINUTE ()

o Format

MINUTE(datetime)

o Action

Returns the number of minutes past the hour represented by the given datetime.

B.1.6 7 SECOND()

o Format

SECOND(datetime)

o Action

Returns the number of seconds past the minute represented by the given datetime.

B.1.6 8 TO_DATE()

o Format

TO_DATE(string[, format, locale, timezone])

o Action

Parses the string as a datetime and returns the datetime value.

Appendix B


B.1.6 9.FORMAT_DATE ()

o Format

FORMAT_DATE(datetime, format[, locale, timezone])

o Action

Formats a datetime and returns its string representation.

B.1.6 10.NOW ()

o Format

NOW()

o Action

Returns the datetime of now, in the default timezone and the default locale.

B.1.6 11.TODAY()

o Format

TODAY()

o Action

Returns the datetime of today at 0:00:00 a.m., in the default timezone and the default locale.

B.1.7. Conditional Operators

B.1.7 1.Equals Operator Operator “=” (Equals)

o Usage P=Q where P and Q can be values or data fields.

Checks whether value P is equal to value Q for conditional fulfillment checking

Appendix B


B.1.7 2.Greater than Operator

Operator “>” (Greater than)

o Usage

P>Q where P and Q can be values or data fields. Checks whether value P is greater than value Q for conditional fulfillment checking

B.1.7 3.Greater than or Equal Operator Operator “>=” (Greater than or Equal)

o Usage

P>=Q where P and Q can be values or data fields. Checks whether value P is greater than or equal to value Q for conditional fulfillment checking

B.1.7 4.Less than Operator Operator “<” (Less than)

o Usage P<Q where P and Q can be values or data fields. Checks whether value P is less than value Q for conditional fulfillment

checking

B.1.7 5.Less than or Equal Operator Operator “<=” (Less than or Equal)

o Usage

P<=Q where P and Q can be values or data fields. Checks whether value P is Less than or Equal to value Q for conditional fulfillment checking

Appendix B


B.1.7 6.Not Equal to Operator Operator “! =” (Not Equal),

o Usage

P! =Q where P and Q can be values or data fields. Checks whether value P is not equal to value Q for conditional fulfillment checking

B.1.8.Logical Operators

B.1.8 1. “AND” Operator

o Usage

P AND Q where P and Q can be values or data fields. Does the logical AND operation with P and Q values for conditional fulfillment checking

B.1.8 2. “OR” Operator

o Usage

P OR Q where P and Q can be values or data fields. Does the logical OR operation with P and Q values for conditional fulfillment checking

B.1.8 3. “NOT” Operator

o Usage

P NOT Q where P and Q can be values or data fields. Does the logical NOT operation with P and Q values for conditional fulfillment checking

Acronyms


Acronyms

CGI Common Gateway Interface

CSV Comma Separated Values

DP Direct To Printer

HTML Hyper Text Markup Language

JRE Java Run-Time Environment

OCCS OPRO Content Control Service

OCCSA OPRO Content Control Service Administrator

ODCS OPRO Data Connection Service

ODDS OPRO Document Data Service

ODMS OPRO Document Mail Service

ODP OPRO Direct to Print

OFD OPRO Form Data

OFMS OPRO File Manager Service

OFMSA OPRO File Manager Service Administrator

OIFS OPRO Internet Fax Service

OIPS OPRO Internet Print Service

OMPS OPRO Mobile Print Services

OPR OPRO Print Report

OPROXML OPRO XML Database

OQM OPRO Query Maker file

OXB OPRO X Browser

OXD OPRO X Designer

OXDC OPRO X Designer Converter

OXR OPRO XML Report

OXTM OPRO X Table Maker

OXS OPRO X Server

OXT OPRO X Designer Template

OXV OPRO X Viewer Template