Progress DPSPR
Progress DPSPR
Progress DPSPR
OPENEDGE 10
®
OpenEdge Deployment:
®
These materials and all Progress® software products are copyrighted and all rights are reserved by Progress Software Corporation. The
information in these materials is subject to change without notice, and Progress Software Corporation assumes no responsibility for any
errors that may appear therein. The references in these materials to specific platforms supported are subject to change.
Actional, Actional (and design), Allegrix, Allegrix (and design), Apama, Apama (and Design), Artix, Business Empowerment,
DataDirect (and design), DataDirect Connect, DataDirect Connect64, DataDirect Technologies, DataDirect XML Converters,
DataDirect XQuery, DataXtend, Dynamic Routing Architecture, EdgeXtend, Empowerment Center, Fathom, IntelliStream, IONA,
IONA (and design), Mindreef, Neon, Neon New Era of Networks, ObjectStore, OpenEdge, Orbix, PeerDirect, Persistence, POSSENET,
Powered by Progress, PowerTier, Progress, Progress DataXtend, Progress Dynamics, Progress Business Empowerment, Progress
Empowerment Center, Progress Empowerment Program, Progress OpenEdge, Progress Profiles, Progress Results, Progress Software
Developers Network, Progress Sonic, ProVision, PS Select, SequeLink, Shadow, SOAPscope, SOAPStation, Sonic, Sonic ESB,
SonicMQ, Sonic Orchestration Server, Sonic Software (and design), SonicSynergy, SpeedScript, Stylus Studio, Technical
Empowerment, WebSpeed, Xcalia (and design), and Your Software, Our Technology–Experience the Connection are registered
trademarks of Progress Software Corporation or one of its affiliates or subsidiaries in the U.S. and/or other countries. AccelEvent,
Apama Dashboard Studio, Apama Event Manager, Apama Event Modeler, Apama Event Store, Apama Risk Firewall, AppsAlive,
AppServer, ASPen, ASP-in-a-Box, BusinessEdge, Cache-Forward, DataDirect Spy, DataDirect SupportLink, FUSE, FUSE Mediation
Router, FUSE Message Broker, FUSE Services Framework, Future Proof, GVAC, High Performance Integration, ObjectStore Inspector,
ObjectStore Performance Expert, OpenAccess, Orbacus, Pantero, POSSE, ProDataSet, Progress ESP Event Manager, Progress ESP
Event Modeler, Progress Event Engine, Progress RFID, PSE Pro, SectorAlliance, SeeThinkAct, Shadow z/Services, Shadow z/Direct,
Shadow z/Events, Shadow z/Presentation, Shadow Studio, SmartBrowser, SmartComponent, SmartDataBrowser, SmartDataObjects,
SmartDataView, SmartDialog, SmartFolder, SmartFrame, SmartObjects, SmartPanel, SmartQuery, SmartViewer, SmartWindow, Sonic
Business Integration Suite, Sonic Process Manager, Sonic Collaboration Server, Sonic Continuous Availability Architecture, Sonic
Database Service, Sonic Workbench, Sonic XML Server, StormGlass, The Brains Behind BAM, WebClient, Who Makes Progress, and
Your World. Your SOA. are trademarks or service marks of Progress Software Corporation or one of its affiliates or subsidiaries in the
U.S. and other countries. Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S.
and other countries. Any other trademarks contained herein are the property of their respective owners.
Third party acknowledgements — See the “Third party acknowledgements” section on page Preface–8.
December 2009
Last updated with new content: Release 10.2B Product Code: 4496; R10.2B
For the latest documentation updates see OpenEdge Product Documentation on PSDN (http://communities.progress.com/
pcom/docs/DOC-16074).
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preface–1
1. Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1
About startup commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
About startup parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
Using parameter files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Calling parameter files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Creating and editing parameter files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–5
Parameter file format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–6
Contents–2
Contents
Contents–3
Contents
Contents–4
Contents
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index–1
Contents–5
Contents
Procedures
new_york.p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–5
new_york.pf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–6
Contents–6
Contents
Tables
Table 1–1: Control characters in parameter files . . . . . . . . . . . . . . . . . . . . . . . . . . 1–6
Table 2–1: OpenEdge command components . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–2
Table 2–2: UNIX and Windows startup and shutdown commands . . . . . . . . . . . . 2–3
Table 2–3: Windows-only startup commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3
Table 3–1: Client performance parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
Table 3–2: Client product-type parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–4
Table 3–3: Client ABL parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–4
Table 3–4: Client internationalization parameters . . . . . . . . . . . . . . . . . . . . . . . . . 3–8
Table 3–5: Session statistics parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10
Table 3–6: Windows session parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10
Table 3–7: Client database connection parameters . . . . . . . . . . . . . . . . . . . . . . . 3–11
Table 3–8: Server performance parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–15
Table 3–9: Server-type parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–18
Table 3–10: Server internationalization parameters . . . . . . . . . . . . . . . . . . . . . . . . 3–18
Table 3–11: Server statistics collection parameters . . . . . . . . . . . . . . . . . . . . . . . . 3–19
Table 3–12: Server consistency check parameters . . . . . . . . . . . . . . . . . . . . . . . . . 3–19
Table 3–13: Server network parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–20
Table 3–14: DataServer parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–22
Table 3–15: SQL Server parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–24
Table 4–1: Cluster mode qualifier values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–36
Table 4–2: Log entry types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–103
Table 4–3: Logging levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–106
Table 4–4: Parameter interpretation with Service Name (-S) . . . . . . . . . . . . . . . . 4–185
Table 4–5: Values for -shmsegsize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–192
Table 4–6: Schema marshaling parameter values . . . . . . . . . . . . . . . . . . . . . . . . 4–209
Table 4–7: Attributes set by Use OS Locale (–useOsLocale) . . . . . . . . . . . . . . . . 4–215
Table 4–8: Century setting and date format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–228
Contents–7
Contents
Contents–8
Preface
• Purpose
• Audience
• Organization
• Typographical conventions
• OpenEdge messages
Purpose
This book provides a comprehensive reference to the startup and shutdown commands and
startup parameters for OpenEdge®.
Audience
The primary audiences for this book are OpenEdge business application developers and system
administrators. The secondary audiences are OpenEdge developers and technical support
engineers.
Organization
Chapter 1, “Introduction”
Introduces the commands and parameters you can use to start up and shut down OpenEdge
client processes. It also describes how to use a parameter file (.pf) to maintain startup
parameters for a particular database startup, client session startup, or database connection.
Describes the OpenEdge client startup commands that you can enter at the command line.
It describes the syntax of each client startup command, summarizes the tasks you can
perform with the startup commands, and then describes each command and its parameters
in detail.
Provides a detailed reference description for each of the OpenEdge startup parameters,
organized in alphabetical order by syntax.
Preface–2
Preface
For the latest documentation, see the OpenEdge Product Documentation Overview page on
PSDN: http://communities.progress.com/pcom/docs/DOC-16074.
For example, these sentences refer to the ABL compiler’s allowance for parameter passing and
the AVM’s possible response to that parameter passing at run time: “ABL allows you to pass a
dynamic temp-table handle as a static temp-table parameter of a method. However, if at run time
the passed dynamic temp-table schema does not match the schema of the static temp-table
parameter, the AVM raises an error.” The following sentence refers to run-time actions that the
AVM can perform using a particular ABL feature: “The ABL socket object handle allows the
AVM to connect with other ABL and non-ABL sessions using TCP/IP sockets.”
• Like most other keywords, references to specific built-in data types appear in all
UPPERCASE, using a font that is appropriate to the context. No uppercase reference ever
includes or implies any data type other than itself.
• Wherever integer appears, this is a reference to the INTEGER or INT64 data type.
• Wherever character appears, this is a reference to the CHARACTER, LONGCHAR, or CLOB data
type.
• Wherever numeric appears, this is a reference to the INTEGER, INT64, or DECIMAL data type.
References to built-in class data types appear in mixed case with initial caps, for example,
Progress.Lang.Object. References to user-defined class data types appear in mixed case, as
specified for a given application example.
Preface–3
Preface
Typographical conventions
This manual uses the following typographical conventions:
Convention Description
SMALL, BOLD Small, bold capital letters indicate OpenEdge key functions and
CAPITAL LETTERS generic keyboard keys; for example, GET and CTRL.
KEY1 KEY2 A space between key names indicates a sequential key sequence:
you press and release the first key, then press another key. For
example, ESCAPE H.
Syntax:
UPPERCASE Uppercase words are ABL keywords. Although these are always
fixed width shown in uppercase, you can type them in either uppercase or
lowercase in a procedure.
Period (.) All statements except DO, FOR, FUNCTION, PROCEDURE, and REPEAT
or end with a period. DO, FOR, FUNCTION, PROCEDURE, and REPEAT
colon (:) statements can end with either a period or a colon.
{} Large braces indicate the items within them are required. They are
used to simplify complex syntax diagrams.
Preface–4
Preface
Convention Description
... Ellipses indicate repetition: you can choose one or more of the
preceding items.
Syntax
FOR is one of the statements that can end with either a period or a colon, as in this example:
Syntax
In this example, the outer (small) brackets are part of the language, and the inner (large) brackets
denote an optional item:
Syntax
A called external procedure must use braces when referencing compile-time arguments passed
by a calling procedure, as shown in this example:
Syntax
{ &argument-name }
Preface–5
Preface
In this example, EACH, FIRST, and LAST are optional, but you can choose only one of them:
Syntax
In this example, you must include two expressions, and optionally you can include more.
Multiple expressions are separated by commas:
Syntax
In this example, you must specify MESSAGE and at least one expression or SKIP [ (n) ], and
any number of additional expression or SKIP [ ( n ) ] is allowed:
Syntax
In this example, you must specify {include-file, then optionally any number of argument or
&argument-name = "argument-value", and then terminate with }:
Syntax
{ include-file
[ argument | &argument-name = "argument-value" ] ... }
Syntax
Preface–6
Preface
In this example, ASSIGN requires either one or more field entries or one record. Options
available with field or record are grouped with braces and brackets:
Syntax
OpenEdge messages
OpenEdge displays several types of messages to inform you of routine and unusual occurrences:
• Compile messages inform you of errors found while OpenEdge is reading and analyzing
a procedure before running it; for example, if a procedure references a table name that is
not defined in the database.
• Startup messages inform you of unusual conditions detected while OpenEdge is getting
ready to execute; for example, if you entered an invalid startup parameter.
• Continues execution, subject to the error-processing actions that you specify or that are
assumed as part of the procedure. This is the most common action taken after execution
messages.
• Returns to the Procedure Editor, so you can correct an error in a procedure. This is the
usual action taken after compiler messages.
• Halts processing of a procedure and returns immediately to the Procedure Editor. This
does not happen often.
OpenEdge messages end with a message number in parentheses. In this example, the message
number is 200:
If you encounter an error that terminates OpenEdge, note the message number before restarting.
Preface–7
Preface
• Choose Help→ Recent Messages to display detailed descriptions of the most recent
OpenEdge message and all other messages returned in the current session.
• Choose Help→ Messages and then type the message number to display a description of a
specific OpenEdge message.
On UNIX platforms, use the OpenEdge pro command to start a single-user mode character
OpenEdge client session and view a brief description of a message by providing its number.
OpenEdge-install-dir/bin/pro
3. Type the message number and press ENTER. Details about that message number appear.
4. Press F4 to close the message, press F3 to access the Procedure Editor menu, and choose
File→ Exit.
OpenEdge includes ANTLR (Another Tool for Language Recognition) software Copyright ©
2003-2006, Terence Parr All rights reserved. Neither the name of the author nor the names of
its contributors may be used to endorse or promote products derived from this software without
specific prior written permission. Software distributed on an “AS IS” basis, WITHOUT
WARRANTY OF ANY KIND, either express or implied. See the License for the specific
language governing rights and limitations under the License agreement that accompanies the
product.
Preface–8
Preface
prior written permission of the Apache Software Foundation. For written permission, please
contact [email protected]. Software distributed on an “AS IS” basis, WITHOUT
WARRANTY OF ANY KIND, either express or implied. See the License for the specific
language governing rights and limitations under the License agreement that accompanies the
product.
OpenEdge includes Concurrent Java software Copyright 1994-2000 Sun Microsystems, Inc. All
Rights Reserved. -Neither the name of or trademarks of Sun may be used to endorse or promote
products including or derived from the Java Software technology without specific prior written
permission; and Redistributions of source or binary code must contain the above copyright
notice, this notice and the following disclaimers: This software is provided "AS IS," without a
warranty of any kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS
AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. AND
ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE
SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN MICROSYSTEMS, INC.
OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF
LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE,
EVEN IF SUN MICROSYSTEMS, INC. HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
OpenEdge includes DataDirect Connect for ODBC and DataDirect Connect64 for ODBC
software, which include ICU software 1.8 and later - Copyright © 1995-2003 International
Business Machines Corporation and others All rights reserved. Permission is hereby granted,
free of charge, to any person obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so, provided that the above
copyright notice(s) and this permission notice appear in all copies of the Software and that both
the above copyright notice(s) and this permission notice appear in supporting documentation.
OpenEdge includes DataDirect Connect for ODBC and DataDirect Connect64 for ODBC
software, which include software developed by the OpenSSL Project for use in the OpenSSL
Toolkit (http:/www.openssl.org/). Copyright © 1998-2006 The OpenSSL Project. All rights
reserved. And Copyright © 1995-1998 Eric Young ([email protected]). All rights reserved.
OpenEdge includes DataDirect products for the Microsoft SQL Server database which contain
a licensed implementation of the Microsoft TDS Protocol.
OpenEdge includes software authored by David M. Gay. Copyright © 1991, 2000, 2001 by
Lucent Technologies (dtoa.c); Copyright © 1991, 1996 by Lucent Technologies (g_fmt.c); and
Preface–9
Preface
Copyright © 1991 by Lucent Technologies (rnd_prod.s). Permission to use, copy, modify, and
distribute this software for any purpose without fee is hereby granted, provided that this entire
notice is included in all copies of any software which is or includes a copy or modification of
this software and in all copies of the supporting documentation for such software. THIS
SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY
REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
PURPOSE.
OpenEdge includes http package software developed by the World Wide Web Consortium.
Copyright © 1994-2002 World Wide Web Consortium, (Massachusetts Institute of
Technology, European Research Consortium for Informatics and Mathematics, Keio
University). All rights reserved. This work is distributed under the W3C® Software License
[http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231] in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
OpenEdge includes ICU software 1.8 and later - Copyright © 1995-2003 International Business
Machines Corporation and others All rights reserved. Permission is hereby granted, free of
charge, to any person obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, provided that the above copyright notice(s)
and this permission notice appear in all copies of the Software and that both the above copyright
notice(s) and this permission notice appear in supporting documentation.
OpenEdge includes Infragistics NetAdvantage for .NET v2009 Vol 2 Copyright © 1996-2009
Infragistics, Inc. All rights reserved.
Preface–10
Preface
OpenEdge includes JSTL software Copyright 1994-2006 Sun Microsystems, Inc. All Rights
Reserved. Software distributed on an “AS IS” basis, WITHOUT WARRANTY OF ANY
KIND, either express or implied. See the License for the specific language governing rights and
limitations under the License agreement that accompanies the product.
OpenEdge includes OpenSSL software developed by the OpenSSL Project for use in the
OpenSSL Toolkit (http://www.openssl.org/). Copyright © 1998-2007 The OpenSSL
Project. All rights reserved. This product includes cryptographic software written by Eric
Young ([email protected]). This product includes software written by Tim Hudson
([email protected]). Copyright © 1995-1998 Eric Young ([email protected]) All rights
reserved. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse
or promote products derived from this software without prior written permission. For written
permission, please contact [email protected]. Products derived from this software may
not be called "OpenSSL" nor may "OpenSSL" appear in their names without prior written
permission of the OpenSSL Project. Software distributed on an "AS IS" basis, WITHOUT
WARRANTY OF ANY KIND, either express or implied. See the License for the specific
language governing rights and limitations under the License agreement that accompanies the
product.
OpenEdge includes Quartz Enterprise Job Scheduler software Copyright © 2001-2003 James
House. All rights reserved. Software distributed on an “AS IS” basis, WITHOUT
WARRANTY OF ANY KIND, either express or implied. See the License for the specific
language governing rights and limitations under the License agreement that accompanies the
product. This product uses and includes within its distribution, software developed by the
Apache Software Foundation (http://www.apache.org/).
OpenEdge includes code licensed from RSA Security, Inc. Some portions licensed from IBM
are available at http://oss.software.ibm.com/icu4j/.
OpenEdge includes the RSA Data Security, Inc. MD5 Message-Digest Algorithm. Copyright
©1991-2, RSA Data Security, Inc. Created 1991. All rights reserved.
OpenEdge includes Sonic software, which includes software developed by Apache Software
Foundation (http://www.apache.org/). Copyright © 1999-2000 The Apache Software
Foundation. All rights reserved. The names “Ant”, “Axis”, “Xalan,” “FOP,” “The Jakarta
Project”, “Tomcat”, “Xerces” and/or “Apache Software Foundation” must not be used to
endorse or promote products derived from the Product without prior written permission. Any
product derived from the Product may not be called “Apache”, nor may “Apache” appear in
their name, without prior written permission. For written permission, please contact
[email protected].
OpenEdge includes Sonic software, which includes software Copyright © 1999 CERN -
European Organization for Nuclear Research. Permission to use, copy, modify, distribute and
sell this software and its documentation for any purpose is hereby granted without fee, provided
that the above copyright notice appear in all copies and that both that copyright notice and this
permission notice appear in supporting documentation. CERN makes no representations about
the suitability of this software for any purpose. It is provided "as is" without expressed or
implied warranty.
OpenEdge includes Sonic software, which includes software developed by ExoLab Project
(http://www.exolab.org/). Copyright © 2000 Intalio Inc. All rights reserved. The names
“Castor” and/or “ExoLab” must not be used to endorse or promote products derived from the
Products without prior written permission. For written permission, please contact
[email protected]. Exolab, Castor and Intalio are trademarks of Intalio Inc.
Preface–11
Preface
OpenEdge includes Sonic software, which includes software developed by IBM. Copyright ©
1995-2003 International Business Machines Corporation and others. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or
sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
provided that the above copyright notice(s) and this permission notice appear in all copies of the
Software and that both the above copyright notice(s) and this permission notice appear in
supporting documentation. Software distributed on an "AS IS" basis, WITHOUT
WARRANTY OF ANY KIND, either express or implied. See the License for the specific
language governing rights and limitations under the License agreement that accompanies the
product. Except as contained in this notice, the name of a copyright holder shall not be used in
advertising or otherwise to promote the sale, use or other dealings in this Software without prior
written authorization of the copyright holder.
OpenEdge includes Sonic software, which includes the JMX Technology from Sun
Microsystems, Inc. Use and Distribution is subject to the Sun Community Source License
available at http://sun.com/software/communitysource.
OpenEdge includes Sonic software, which includes software developed by the ModelObjects
Group (http://www.modelobjects.com). Copyright © 2000-2001 ModelObjects Group. All
rights reserved. The name “ModelObjects” must not be used to endorse or promote products
derived from this software without prior written permission. Products derived from this
software may not be called “ModelObjects”, nor may “ModelObjects” appear in their name,
without prior written permission. For written permission, please contact
[email protected].
OpenEdge includes Sonic software, which includes code licensed from Mort Bay Consulting
Pty. Ltd. The Jetty Package is Copyright © 1998 Mort Bay Consulting Pty. Ltd. (Australia) and
others.
OpenEdge includes Sonic software, which includes files that are subject to the Netscape Public
License Version 1.1 (the “License”); you may not use this file except in compliance with the
License. You may obtain a copy of the License at http://www.mozilla.org/NPL/. Software
distributed under the License is distributed on an “AS IS” basis, WITHOUT WARRANTY OF
ANY KIND, either express or implied. See the License for the specific language governing
rights and limitations under the License. The Original Code is Mozilla Communicator client
code, released March 31, 1998. The Initial Developer of the Original Code is Netscape
Communications Corporation. Portions created by Netscape are Copyright 1998-1999
Netscape Communications Corporation. All Rights Reserved.
OpenEdge includes Sonic software, which includes software developed by the University
Corporation for Advanced Internet Development http://www.ucaid.edu Internet2 Project.
Copyright © 2002 University Corporation for Advanced Internet Development, Inc. All rights
reserved. Neither the name of OpenSAML nor the names of its contributors, nor Internet2, nor
the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used
to endorse or promote products derived from this software and products derived from this
software may not be called OpenSAML, Internet2, UCAID, or the University Corporation for
Advanced Internet Development, nor may OpenSAML appear in their name without prior
written permission of the University Corporation for Advanced Internet Development. For
written permission, please contact [email protected].
OpenEdge includes the UnixWare platform of Perl Runtime authored by Kiem-Phong Vo and
David Korn. Copyright © 1991, 1996 by AT&T Labs. Permission to use, copy, modify, and
Preface–12
Preface
distribute this software for any purpose without fee is hereby granted, provided that this entire
notice is included in all copies of any software which is or includes a copy or modification of
this software and in all copies of the supporting documentation for such software. THIS
SOFTWARE IS BEING PROVIDED “AS IS”, WITHOUT ANY EXPRESS OR IMPLIED
WARRANTY. IN PARTICULAR, NEITHER THE AUTHORS NOR AT&T LABS MAKE
ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
PURPOSE.
OpenEdge includes XML Tools, which includes versions 8.9 of the Saxon XSLT and XQuery
Processor from Saxonica Limited (http://www.saxonica.com/) which are available from
SourceForge (http://sourceforge.net/projects/saxon/). The Original Code of Saxon
comprises all those components which are not explicitly attributed to other parties. The Initial
Developer of the Original Code is Michael Kay. Until February 2001 Michael Kay was an
employee of International Computers Limited (now part of Fujitsu Limited), and original code
developed during that time was released under this license by permission from International
Computers Limited. From February 2001 until February 2004 Michael Kay was an employee
of Software AG, and code developed during that time was released under this license by
permission from Software AG, acting as a "Contributor". Subsequent code has been developed
by Saxonica Limited, of which Michael Kay is a Director, again acting as a "Contributor". A
small number of modules, or enhancements to modules, have been developed by other
individuals (either written especially for Saxon, or incorporated into Saxon having initially been
released as part of another open source product). Such contributions are acknowledged
individually in comments attached to the relevant code modules. All Rights Reserved. The
contents of the Saxon files are subject to the Mozilla Public License Version 1.0 (the "License");
you may not use these files except in compliance with the License. You may obtain a copy of
the License at http://www.mozilla.org/MPL/ and a copy of the license can also be found in the
installation directory, in the c:/OpenEdge/licenses folder. Software distributed under the
License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
express or implied. See the License for the specific language governing rights and limitations
under the License.
OpenEdge includes XML Tools, which includes Xs3P v1.1.3. The contents of this file are
subject to the DSTC Public License (DPL) Version 1.1 (the "License"); you may not use this
file except in compliance with the License. A copy of the license can be found in the installation
directory, in the c:/OpenEdge/licenses folder. Software distributed under the License is
distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
implied. See the License for the specific language governing rights and limitations under the
License. The Original Code is xs3p. The Initial Developer of the Original Code is DSTC.
Portions created by DSTC are Copyright © 2001, 2002 DSTC Pty Ltd. All rights reserved.
OpenEdge includes YAJL software Copyright 2007, Lloyd Hilaiel. Redistribution and use in
source and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3. Neither the name
of Lloyd Hilaiel nor the names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
Preface–13
Preface
Preface–14
1
Introduction
This chapter introduces the commands and parameters you can use to start up and shut down
OpenEdge® client processes. The following sections describe the commands and parameters,
as well as how to use a parameter (.pf) file to maintain startup parameters for a particular
database startup, client session startup, or database connection:
• Commands to startup and shutdown database processes, such as database servers, database
brokers, and background writer.
• Commands to start up and shutdown client sessions that connect to databases, such as an
ABL (Advanced Business Language) client, AppServer™, and DataServer client.
After setting up your database, you are ready to run OpenEdge. In general, you start clients and
servers as follows:
• Start a database server or broker for a database. Starting a server or broker for a database
is distinct from connecting to a database. For more information on starting these processes,
see OpenEdge Getting Started: Installation and Configuration.
For more information about the startup commands, see Chapter 2, “Client Startup Commands.”
For information about commands to startup and shutdown database processes, see OpenEdge
Data Management: Database Administration.
1–2
About startup parameters
• Client session
• Client connection
• DataServer
• SQL
For more information about the startup parameter usage categories, see Chapter 3, “Startup
Parameter Usage Categories.” For details on the individual startup parameters, see Chapter 4,
“Startup Parameter Descriptions.”
You can access the list of startup parameters defined at startup for the current OpenEdge session
by reading the STARTUP-PARAMETERS attribute on the SESSION system handle from an ABL
procedure. For more information about the STARTUP-PARAMETERS attribute, or the SESSION
system handle, see OpenEdge Development: ABL Reference.
1–3
Introduction
Every OpenEdge executable invokes a parameter file named startup.pf by default. This file
is located in the DLC directory. It must exist for OpenEdge to execute properly. You can modify
startup.pf to add parameter definitions. You can also create one or more additional parameter
files and direct OpenEdge to invoke them after it invokes startup.pf.
Note: In Windows, you can specify the name of the OpenEdge startup file using the
PROSTARTUP environment variable in the progress.ini file and the Registry. See
OpenEdge Deployment: Managing ABL Applications for more information on the
progress.ini file.
From the startup command line, use the Parameter File (-pf) startup parameter to call the
parameter file, as shown in the following table:
The filename can be any valid filename. OpenEdge combines all parameters on a command
line with those in the parameter file. If the same parameter is mentioned more than once, the last
occurrence takes precedence. For more information on startup parameters, see Chapter 4,
“Startup Parameter Descriptions.”
Use the following syntax to specify a parameter file in a CONNECT statement in an ABL
procedure:
Syntax
1–4
Using parameter files
For example, the new_york.p procedure connects using a parameter file called new_york.pf.
new_york.p
You can use the -pf parameter as many times as you like on a command line. This lets you
specify application-specific parameters in one parameter file, database-specific parameters in a
second parameter file, and user-specific parameters in yet another parameter file. It also allows
you to connect to multiple databases from the same command line or CONNECT statement.
When connecting to more than one database, the startup parameters must appear after the
corresponding Physical Database Name (-db) parameter and database name. If connecting to
more than one database, consider putting all the database-related parameters in a parameter file,
then add the -db parameter to the top of the file. To support earlier releases, OpenEdge assigns
any startup parameters that precede all database names to the first database on the command
line.
OpenEdge processes parameters from left to right. Each -pf parameter encountered is
processed first before the next top-level parameter is evaluated. If a parameter file specified by
-pf contains another -pf parameter, the nested parameter file is evaluated before resuming the
top-level processing.
Note: If the same parameter is mentioned more than once, the last occurrence takes
precedence.
3. Specify the filename. OpenEdge alphabetically lists all available startup parameters.
4. Specify which of the parameters you want in the file by choosing the parameter and
entering yes, no, or the appropriate value.
1–5
Introduction
new_york.pf
The format of the parameter file is the same for all operating systems. Follow these rules when
creating a parameter file:
• Use a pound sign (#) to begin a comment. OpenEdge ignores the rest of the line.
• Enclose a value in single (’) or double (“) quotes. Any white space inside the quotes is
treated as part of the token.
• Any parameter not named in a parameter file receives a default value. To remind yourself
of the default values, consider specifying all parameters and their values in the parameter
file and adding the comment “# default” to those values that do not change.
• Use a tilde (~) to suppress the special meaning of the single (’) or double (“) quotes or
tilde (~). A tilde also prefixes the control characters that OpenEdge can recognize in a
parameter file, as listed in Table 1–1.
~b BS character ~010
1–6
2
Client Startup Commands
This chapter describes the OpenEdge client startup commands that you can enter at the
command line. It describes the syntax for each client startup command, summarizes the tasks
you can perform with the startup commands, and then describes each command and its
parameters.
For example, you can use the following command to allow 100 users to access the sports
database and then set values for the database connection, performance, and network parameters:
Component Description
• On UNIX, commands are lowercase. In Windows, commands are not case sensitive.
• On UNIX and Windows, enter parameters exactly as shown in the syntax descriptions.
• On UNIX, values can be case sensitive; for example, UNIX filenames are case sensitive.
In addition, in Windows using the NT File System (NTFS), values can be case sensitive.
In Windows using the File Allocation Table (FAT or FAT32) file system, values are not
case sensitive.
2–2
Tasks you can perform with startup and shutdown commands
Task Command
Table 2–3 summarizes tasks and their related startup commands for Windows only. You can use
these commands in the Command Line field of a Shortcuts Properties dialog box.
Task Command
2–3
Client startup command descriptions
• BPRO command
• MBPRO command
• MPRO command
• PRO command
Note: In general, if the database is not in your current directory, you must specify the full
pathname of the database. There are a few exceptions. See the description of the
command you want to use for more information.
For information about commands to startup and shutdown database processes, see OpenEdge
Data Management: Database Administration.
2–4
BPRO command
BPRO command
Starts a single-user OpenEdge client session in batch or background mode.
Syntax
bpro [ db-name ] -p procedure-name [ parameters ] [ > output-file ]
Parameters db-name
-p procedure-name
parameters
output-file
Notes • For UNIX, the BPRO command runs the following executable:
_progres -1 -b &
The & character causes an OpenEdge batch session to run in the background, and returns
control to the terminal once the session starts. When the & character is not present (for
example, when you simply use the (-b) startup parameter), OpenEdge initiates a batch
session in the foreground without terminal interaction and control does not return to the
terminal until the session completes.
• On UNIX and in Windows, you can redirect batch job input and output with the < and >
redirection symbols. You also can use the pipe symbol (|) to put an OpenEdge batch run
in a command pipeline.
2–5
MBPRO command
MBPRO command
Starts a multi-user OpenEdge client session in batch or background mode.
Syntax
mbpro [ db-name ] -p procedure-name [ parameters ] [ > output-file ]
Parameters db-name
Specifies the database to which you want to connect. If you are connecting to a database
through shared memory and the database is not in your current directory, you must specify
the path of the database. On the other hand, if you are making a client/server connection
to the database, you do not need to specify a path.
-p procedure-name
parameters
output-file
_progres -b &
• On UNIX and in Windows, you can redirect batch job input and output with the < and >
redirection symbols. You also can use the pipe symbol (|) to put an OpenEdge batch run
in a command pipeline.
2–6
MPRO command
MPRO command
Starts a multi-user mode character OpenEdge client session.
Syntax
mpro [ db-name ] [ parameters ]
Parameters db-name
Specifies the database to which you want to connect. If you are connecting to a database
through shared memory and the database is not in your current directory, you must specify
the path of the database. On the other hand, if you are making a client/server connection
to the database, you do not need to specify a path.
parameters
_progres
• The server must be running before you issue this command with the db-name parameter.
If the server is not running, OpenEdge displays the following error message:
2–7
PRO command
PRO command
Starts a single-user mode character OpenEdge client session.
Syntax
pro [ db-name ] [ parameters ]
Parameters db-name
parameters
Specifies the parameters you want to use. You can use any single-user startup parameter
with the PRO command.
_progres -1
2–8
PROWIN32 command (Windows only)
Syntax
prowin32 [ db-name ] [ parameters ]
Parameters db-name
parameters
Note See OpenEdge Deployment: Managing ABL Applications for more information about starting
OpenEdge sessions and connecting to databases.
2–9
Client Startup Commands
2–10
3
Startup Parameter Usage Categories
This chapter provides an overview of the OpenEdge startup parameters organized within the
following usage categories:
This chapter is a a quick reference to locate the appropriate startup parameters to use. Note that
some parameters are listed in multiple categories. For detailed descriptions of the startup
parameters, see Chapter 4, “Startup Parameter Descriptions.”
Note: You can specify one or more startup parameters on the command line or incorporate
them into a .BAT file or a UNIX script file. You can also specify startup parameters
using an OpenEdge startup parameter file. For more information on startup parameter
files, see Chapter 1, “Introduction”.
Client Session parameters (CS)
• ABL parameters
-asyncqueuesize n Async Queue Specifies the total number of bytes allowed for
Size asynchronous request buffers allocated for a
client
-Bt n Number of Specifies the size of the buffer pool for blocks or
Buffers for records from the temporary table
Temporary
Tables
-fc num-entries Schema Field Changes the number (soft limit) of entries in the
Cache Size schema field cache
-l n Local Buffer Specifies the size (soft limit) of the local record
Size buffer
-Mr n Record Buffer Specifies the standard record buffer size in bytes
Size
3–2
Client performance parameters
-pls PROLIB Swap Stores r-code files locally in temporary sort files
-TB blocksize Speed Sort Specifies the block size in kilobytes to allocate
when sorting records for reports or rebuilding
indexes
3–3
Client product-type parameters
-rg Run ABL Client Limits access or functionality of the session to the
ABL client
-rq Run query Client Limits access or functionality of the session to the
Query client
ABL parameters
Use the parameters listed in Table 3–3 to modify ABL behavior.
-baseADE ADE R-code Specifies the ADE r-code directory to the client
Location so the client can add this directory and all
procedure libraries contained in the directory to
the PROPATH
-browcoltype Browse Column Overrides the TYPE attribute for browse columns,
Type and always return “BROWSE-COLUMN” regardless
of the actual column type
3–4
ABL parameters
-clearlog Clear Log File Deletes any file that matches the name of the
specified client log file identified by the
-clientlog parameter
-debugalert Debug Alert Makes ABL stack trace and .NET stack trace
information available during a session, either in
an Alert dialog box or a log file
-errorstack Error Stack Allows error objects to save the ABL call stack
in the CallStack property of an error object at
the time the AVM generates the error object
3–5
ABL parameters
-fldisable Field List Directs ABL to ignore field lists in the r-code
Disable and fetch complete records
-inp n Input Characters Expands the available buffer space for a single
statement
-logginglevel n Logging Level Specifies the level at which log entries are
written to the log file
-logthreshold n Log Threshold Specifies the file size threshold of log files
-nb n Nested Blocks Sets the maximum number (soft limit) of nested
procedure blocks
3–6
ABL parameters
-numlogfiles n Number of Log Specifies the number of rolled over log files to
Files to Keep keep on disk at any one time
-ojmode Outer-join Specifies the mode in which mixed inner and left
Mode outer joins, in queries of three or more joined
tables, are processed
-proxyhost Proxy Host Specifies the name of the host or the IP address
of the host at which the HTTP-based proxy
server is located
-rereadnolock Reread Nolock Directs the AVM to re-read a record from the
database, if the record is already in a buffer
3–7
Client internationalization parameters
-showppuerr Show PPU Error Starting with Release 10.1B, this startup
parameter has no effect; it is supported only for
backward compatibility
In earlier releases, it restores the warning for
message 4132 (“Invalid character unit value <N>.
Changed to 320.”)
-cpcase Case Table Identifies the case table that establishes case
tablename rules for the code page
-cpcoll Collation Table Identifies a collation table to use with the code
tablename page
-cpinternal Internal Code Identifies the code page that the AVM uses in
codepage Page memory
-cplog codepage Log File Code Identifies the code page used for writing
Page messages to the log file
-cpprint Print Code Page Identifies the code page used for printer output
codepage
3–8
Client internationalization parameters
-cprcodein R-code in Code Identifies the code page used for reading r-code
codepage Page text segments
-cprcodeout R-code Out Code Identifies the code page used for writing r-code
codepage Page text segments
-cpstream Stream Code Identifies the code page used for stream I/O
codepage Page
-cpterm codepage Terminal Code Identifies the code page for character terminals
Page
-d dateform Date Format Specifies the format for displaying dates, using
the three-character string of d, m, y in any order
-isnoconv Initial Value Disables a code page conversion that was not
Segment No provided in earlier releases of OpenEdge
Convert
-yr4def Four Digit Year Outputs a four-digit year from EXPORT, MESSAGE
Default and PUT UNFORMATTED statements that may use a
two-digit year
-yy n Century Year Specifies the start of the 100-year period used to
Offset define the two-digit DATE value
3–9
Session statistics parameters
-yd Segment Statistics Writes segment statistics to the client monitor file
(client.mon by default)
-yx Statistics with Collects procedure call statistics and write them to an
Cross-reference output file (proc.mon by default)
1. You can use this parameter only on the command line. It is not supported in a parameter (.pf) file.
3–10
Client Connection parameters (CC)
If you use the Physical Database Name (-db) parameter to specify more than one database when
you start a session, specify the connection parameters for each database after the database name
to which they apply and before the next -db parameter. OpenEdge applies database connection
parameters only to the previously specified database. For example:
Note: OpenEdge implicitly specifies the -db parameter for the first database.
You can specify all other parameters anywhere on the command line. If you specify the same
parameter more than once, OpenEdge uses the value you provide for the last instance of the
parameter.
-cache filename Schema Cache File Reads the database schema from a local
file instead of the database
3–11
Client database connection parameters
-Mm n Message Buffer Size Specifies the message buffer size for
network client/server protocols
3–12
Client database connection parameters
-Mm n Message Buffer Size Specifies the message buffer size for
network client/server protocols
3–13
Client database connection parameters
1. Single-user database connections only; otherwise, use only for server startup.
2. UNIX, Windows only.
3. Different meaning for non-OpenEdge databases.
3–14
OpenEdge Database Server parameters (DBS)
3–15
Database server performance parameters
-bistall Threshold Stall Sends a message to the log file when the
recovery log threshold is reached. Use with
-bithold.
-hash Hash Table Entries Specifies the number of hash table entries for
the buffer pool
-lkhash n Lock Table Hash Specifies the size of the hash table controlling
Size access to the lock table
-Mf n Delayed BI File Delays writing the last before-image (BI) file
Write (UNIX, records
Windows only)
-Mm n Message Buffer Specifies the message buffer size for network
Size client/server protocols
3–16
Database server performance parameters
-omsize n Storage Object Specifies the size of the object cache for all
Cache Size database objects
-pinshm Pin Shared Memory Prevents the database engine from swapping
shared memory contents to disk
-spin n Spin Lock Retries Specifies the number of times a process tries
(UNIX, Windows to acquire a latch before pausing
only)
-SQLStack n SQL Stack Size Specifies the size, in KB, of the SQL Stack
-SQLTempBuff SQL Sorting Defines the size of the temporary table buffer
value Memory in memory
3–17
Database server-type parameters
-SQLTempDisk SQL Sorting on Defines the size of the temporary table for
value Disk backup storage
-SQLTempPgSize SQL Temp Table Defines the size of the temporary table data
value Data Page page
-cpcase tablename Case Table Identifies the case table that establishes
case rules for the code page
-cpinternal code-page Internal Code Page Identifies the code page that the AVM
uses in memory
-cplog code-page Log File Code Page Identifies the code page used for writing
messages to the log file
-cpprint code-page Print Code Page Identifies the code page used for printer
output
3–18
Database server statistics collection parameters
-cprcodein code-page R-code in Code Identifies the code page used for reading
Page r-code text segments
-cpstream code-page Stream Code Page Identifies the code page used for stream
I/O
-cpterm code-page Terminal Code Identifies the code page for character
Page terminals
3–19
Database server network parameters
-classpath pathname SQL Server Identifies the Java classpath to use when
Java™ Classpath starting an SQL server
3–20
OpenEdge Database Server parameters (DBS)
3–21
Startup Parameter Usage Categories
-cpinternal code-page Internal Code Page Identifies the code page that the
AVM uses in memory
-cplog code-page Log File Code Identifies the code page used for
Page writing messages to the log file
-cpprint code-page Print Code Page Identifies the code page used for
printer output
-cprcodein code-page R-code in Code Identifies the code page used for
Page reading r-code text segments
-cpstream code-page Stream Code Page Identifies the code page used for
stream I/O
3–22
DataServer parameters (DS)
3–23
Startup Parameter Usage Categories
-classpath SQL Server Java Identifies the Java classpath to use when
Classpath starting an SQL server
-ServerType Type of Server to Limits the type of server the broker can
Start start
-SQLStack SQL Stack Size Changes the size of the SQL stack
-SQLStmtCache SQL Statement Cache Sets the number of statements that can be
stored in the SQL cache
3–24
4
Startup Parameter Descriptions
This chapter provides a detailed reference description for each of the OpenEdge startup
parameters, organized in alphabetical order by syntax.
Note: Unless otherwise indicated, startup parameter syntax is the same for both UNIX and
Windows.
Single-user Mode (-1)
Operating
system UNIX
and syntax Windows -1
Client – – – –
Connection
The PRO command invokes the OpenEdge executable with -1 by default, but only for the first
database named on the command line. Each additional database must already have a server
running in multi-user mode, unless -1 is added to its parameter list. In the following example,
db1 and db3 are connected in single-user mode; db2 is connected in multi-user mode:
4–2
AdminServer Group (-admingroup)
Operating
system UNIX
and syntax Windows -admingroup user-group[:user-group]
Client – – – –
Connection
user-group
The name of the group of users. There must be a minimum of one valid group or the
AdminServer will not start. If multiple groups are listed, they are separated by a colon. The
user starting the AdminServer must be a valid account in one of the groups.
On UNIX, you can specify a user group as any local group name or NIS group name. Subgroups
are not supported. In Windows, you can specify a user group as any local group name or Domain
group name. Global groups as members of local groups are supported.
If, during the OpenEdge installation process, you accepted the default installation and did not
choose to use authorization, you can use this parameter when starting the AdminServer to select
authorization for one or more user groups. Otherwise, no group authorization is defined and all
users have authorization.
4–3
AdminServer Port (-adminport)
Operating
system UNIX
and syntax Windows -adminport service-name port
Database – – – –
Server
service-name
port
The AdminServer uses this parameter internally. The default is none, and the server does not
attempt to connect to an AdminServer. You do not usually use this parameter directly. The
-adminport setting must match the -admin setting specified when the AdminServer was started.
4–4
After-image File Management Archive Directory List (-aiarcdir)
Operating
system UNIX
and syntax Windows -aiarcdir dirlist
Database – – – –
Server
dirlist
A comma-separated list of directories where archived after-image files are written by the
AI File Management Utility. The directories cannot have any embedded spaces in their
names.
The directories must exist, unless you also specify After-image File Management Archive
Directory Create (-aiarcdircreate) to direct the utility to create the directories.
Note: This parameter is useful only when running the AI File Management utility.
For information on using the AI File Management utility, see OpenEdge Data Management:
Database Administration.
4–5
After-image File Management Archive Directory Create (-aiarcdircreate)
Operating
system UNIX
and syntax Windows -aiarcdircreate
Database – – – –
Server
Note: This parameter is useful only when running the AI File Management utility.
For information on using the AI File Management utility, see OpenEdge Data Management:
Database Administration.
4–6
After-image File Management Archive Interval (-aiarcinterval)
Operating
system UNIX
and syntax Windows -aiarcinterval n
The number of seconds between mandatory extent switches by the AI File Management
utility.
If you specify timed-mode, set the elapsed time between forced AI extent switches with a value
indicating the number of seconds between the switches. The minimum time is 2 minutes, the
maximum is 24 hours. You can modify the interval on a running system by using the RFUTIL
utility.
In both timed and on-demand modes, the AI File Management utility archives full AI extents
every 5 seconds.
Note: This parameter is useful only when running the AI File Management utility.
For information on using the AI File Management utility, see OpenEdge Data Management:
Database Administration.
4–7
After-image Buffers (-aibufs)
Note: Starting in Release 10.1C, the OpenEdge RDBMS expands the range of internal
validations used to ensure database consistency in both index and data blocks during
forward processing. Validations using PROUTIL can be run online as part of routine
health checks. For more information, see OpenEdge Data Management: Database
Administration.
Operating
system UNIX
and syntax Windows -aibufs n
Database – 1 – 20
Server
This parameter is useful only when running the after-image writer (AIW) because the AIW
writes the filled After-image Buffers to disk, making the buffers available to other client and
server processes. Progress Software Corporation recommends you set After-image Buffers
(-aibufs) to the same value specified for the Before-image Buffers (-bibufs) parameter, or a
minimum of 20.
Without the AIW writing the buffers, any gain from increasing the number of buffers is
negligible.
4–8
After-image Stall (-aistall)
Operating
system UNIX
and syntax Windows -aistall
Database – – – –
Server
Wait until the next AI file is backed up and marked empty, then send the following message to
the database log file:
This way you can empty an AI file instead of shutting down the database.
When using after-image (AI) files, you monitor the status of the files to ensure that you do not
attempt to reuse an unavailable file. If all the AI files are filled and OpenEdge cannot switch to
an empty one, by default the database shuts down. See OpenEdge Data Management: Database
Administration for information on using the after imaging feature.
4–9
Area consistency check (-AreaCheck)
Operating
system UNIX
and syntax Windows -AreaCheck areaname
Client – – – –
Connection,
Database
SErver
areaname
When enabled, this option applies consistency checks to all index blocks and record blocks for
record and index write operations. You can only specify one area with -AreaCheck. To check
multiple areas, you must apply consistency checking to the entire database with Database
consistency check (-DbCheck).
Area consistency check validates a block is still physically correct after an operation has been
performed. For example, after an index key is inserted into an index block, the consistency
check validates that the block still laid out correctly.
Area consistency checking can be enabled or disabled while your database is online with
PROMON. See OpenEdge Data Management: Database Administration for more information.
Area consistency check can be enabled for a single user client or for any offline utility. If the
utility is read-only, such as DBANALYS, the -AreaCheck parameter is ignored. Online utilities
determine whether or not to perform area consistency checking during execution based on the
use of -AreaCheck at broker startup or by the enablement/disablement of the database
consistency checking in PROMON.
4–10
Assemblies (-assemblies) startup parameter
Operating
system
and syntax Windows -assemblies assemblies-path
Client Session – – – –
assemblies-path
The absolute or relative path to the directory containing assemblies.xml and any
third-party assemblies. A relative path is relative to the working directory for the
OpenEdge session.
ABL applications using the OpenEdge GUI for .NET must have an assemblies.xml file. If the
-assemblies directory does not contain the file, the AVM raises an error at startup and halts. If
you do not specify -assemblies and the current working directory does not contain the file, the
AVM starts but code that accesses .NET objects generates errors at compile and run time.
If you specify -assemblies and the client machine does not have an appropriate version of the
.NET framework installed, OpenEdge raises an error and shuts down.
4–11
Async Queue Size (-asyncqueuesize)
Operating
system UNIX
and syntax Windows -asyncqueuesize n
The total number of bytes allowed for all asynchronous request buffers allocated for a
client.
As each client connects, request buffers are generated and the size of each buffer determined.
Both send and receive requests can be queued on a client depending how the program is
implemented. When the buffers are filled, additional queued requests are stored in a temporary
table associated with that client session. If you set the value of -asyncqueuesize to 0, all
requests are placed in the temporary table.
Performance may vary based upon whether requests are stored in memory or in the temporary
table. So you may want to choose this value based upon how much data you expect to flow
between the client and the AppServer for asynchronous requests.
Note: You can use -asyncqueuesize only when a client making asynchronous requests is
connecting to an AppServer. The client may be an AppServer.
The following example shows how to start a multi-user mode OpenEdge client session using
-asyncqueuesize:
4–12
Blocks in Database Buffers (-B)
Operating
system UNIX
and syntax Windows -B n
Blocks in Database Buffers (-B) can be changed while the database is online with the PROUTIL
INCREASETO utility.
Notes: On the AIX platform, when starting a database with large shared memory requirements
(for instance, when the -B exceeds the allotted system paging space), the system may
become unstable if the PSALLOC=early environment variable is not set. For more
information, see OpenEdge Getting Started: Installation and Configuration.
Release 10.1C and forward, the OpenEdge RDBMS expands the range of internal
validations used to ensure database consistency in both index and data blocks during
forward processing. Validations using PROUTIL can be run online as part of routine
health checks. For more information, see OpenEdge Data Management: Database
Administration.
4–13
Blocks in Alternate Buffer Pool (-B2)
Operating
system UNIX
and syntax Windows -B2 n
The Alternate Buffer Pool is a collection of buffers in shared memory that are logically separate
from the primary buffer pool. Management of the buffers in the Alternate Buffer Pool is
independent of the primary buffer pool. Assigning specific database areas or objects to occupy
buffers in the Alternate Buffer Pool may improve your buffer hit rate, thereby reducing the need
to read and write buffers to and from disk, possibly improving performance.
You cannot specify Blocks in Alternate Buffer Pool for a Replication target database.
Blocks in Alternate Buffer Pool (-B2) can be changed while the database is online with the
PROUTIL INCREASETO utility.
For more information on the Alternate Buffer Pool and PROUTIL, see OpenEdge Data
Management: Database Administration.
4–14
Batch (-b)
Batch (-b)
Use Batch (-b) to initiate a batch session, with no terminal interaction.
Operating
system UNIX
and syntax Windows -b
Client Session – – – –
When ABL (Advanced Business Language) procedures run in batch mode, the ABL Virtual
Machine (AVM) does not display any messages produced by those procedures on the terminal
screen. However, AVM error messages are displayed to the terminal screen. To suppress these
messages, redirect standard output as shown in this Windows example:
4–15
ADE R-code Location (-baseADE)
Operating
system UNIX
and syntax Windows -baseADE directory
Client Session – – – –
directory
Identifies where the client should look for the ADE r-code.
You can have different versions of ADE r-code on the same machine at the same time. As a
result, you need a way to specify the ADE r-code directory to the client so that the client can
add this directory and all of the procedure libraries contained in the directory to the PROPATH.
The -baseADE startup parameter lets you specify the location of the ADE r-code directory.
At session startup, OpenEdge automatically adds $DLC/gui (or $DLC/tty for character mode
clients) and all procedure libraries in $DLC/gui (or $DLC/tty) to PROPATH.
When you specify -baseADE, the $DLC/gui (or $DLC/tty) directory and the procedure libraries
in $DLC/gui (or $DLC/tty) are not added to PROPATH. Instead, the directory specified using the
-baseADE startup parameter is added to PROPATH followed by all of the procedure libraries in the
directory. For example, if you use -baseADE to specify the following:
-baseADE c:\maint\gui
And c:\maint\gui contains the procedure libraries adecomm.pl, adeuib.pl, and protools.pl,
then PROPATH looks like the following:
...,c:\maint\gui,c:\maint\gui\adecomm.pl,c:\maint\gui\adeuib.pl,c:\maint\gui
\protools.pl,...
If $DLC/gui (or $DLC/tty) or any of the procedure libraries from the directory already are part
of PROPATH (environment variable, .ini file, or registry setting), OpenEdge does not remove
them.
OpenEdge allows you to specify an empty string for <directory>, -baseADE "". In this
situation, OpenEdge does not add $DLC/gui (or $DLC/tty) or the procedure libraries in
$DLC/gui (or $DLC/tty) to PROPATH.
You also can specify the ADE R-code Location with the BASE-ADE attribute of the SESSION
system handle. For more information about this SESSION attribute, see OpenEdge Development:
ABL Reference.
4–16
Base Index (-baseindex)
Operating
system UNIX
and syntax Windows -baseindex n
Database – – – –
Server
The starting index number in the range of indexes for which you want to track access
statistics.
Access to the statistics is handled through the Virtual System Tables (VSTs). Index statistics are
stored in the _IndexStat VST. To obtain index numbers, use the following ABL code:
File-Name
filename
idx-num Index-Name
n1 index name1
n2 index name2
n3 index name3
For more information on virtual system tables, see OpenEdge Data Management: Database
Administration.
4–17
Registry Base Key (-basekey)
Operating
system
and syntax Windows -basekey name
Client Session – – – –
name
The name of the registry basekey. The following are the valid registry basekey values:
• HKEY_CURRENT_USER
• HKEY_CLASSES_ROOT
• HKEY_LOCAL_MACHINE
• HKEY_USERS
• HKEY_CURRENT_CONFIG
• HKEY_DYN_DATA
• INI
You can force OpenEdge to bypass the registry search by specifying INI.
Note: You can use the -basekey startup parameter only at the command line. It is ignored
when used in a parameter (.pf) file.
For more information on using the Registry Base Key (-basekey) startup parameter, see
OpenEdge Deployment: Managing ABL Applications.
4–18
Base Table (-basetable)
Operating
system UNIX
and syntax Windows -basetable n
Database Server – – – –
The starting table number in the range of tables for which you want to track access
statistics.
Access to the statistics is handled through the Virtual System Tables (VSTs). Table statistics are
stored in the _TableStat VST. To obtain table numbers, use the following ABL code:
_File-Number File-Name
n1 table name1
n2 table name2
n3 table name3
For more information on virtual system tables, see OpenEdge Data Management: Database
Administration.
4–19
Before-image Buffers (-bibufs)
Note: Starting in Release 10.1C, the OpenEdge RDBMS expands the range of internal
validations used to ensure database consistency in both index and data blocks during
forward processing. Validations using PROUTIL can be run online as part of routine
health checks. For more information, see OpenEdge Data Management: Database
Administration.
Operating
system UNIX
and syntax Windows -bibufs n
Database – 3 – 20
Server
The BIW continually writes the filled before-image buffers to disk, making the buffers available
to other client and server processes. Without a BIW writing the buffers, any gain from
increasing the number of buffers is negligible.
4–20
Threshold Stall (-bistall)
Operating
system UNIX
and syntax Windows -bistall
Database – – – –
Server
4–21
Recovery Log Threshold (-bithold)
Operating
system UNIX
and syntax Windows -bithold n
The recommended threshold is between 3% and 100% of the largest possible recovery log file
size, rounded to the nearest cluster boundary. If the threshold is set above 1000MB, OpenEdge
issues a warning message to the display and the database log (.lg) file. Once the threshold is
reached, the database performs an emergency shutdown. See OpenEdge Data Management:
Database Administration for more information about recovery logs.
4–22
Private Read-only Buffers (-Bp)
Operating
system UNIX
and syntax Windows -Bp n
Client 64 1 – –
Connection
The request remains active for the entire session unless it is changed or disabled by an
application. Each user of private read-only buffers reduces the number of public buffers, which
is set with Blocks in Database Buffers (-B). The total number of private read-only buffers for
all simultaneous users is limited to 25% of the total blocks in database buffers.
4–23
Maximum Private Buffers per Connection (-Bpmax)
Operating
system UNIX
and syntax Windows -Bpmax n
Database 25% of -B 1 64 64
Server
The number of blocks in the database buffers is controlled by the blocks in database buffers (-B)
parameter. Up to 25% of the blocks created may be allocated for use as private buffers. When
a client connects to an OpenEdge database, the connection requests -Bp n private buffers. Prior
to 9.1C, the maximum value of -Bp was 64. With the -Bpmax parameter, the broker may override
this limit by allowing the value of -Bp to be up to 25% of -B.
Note: Each use of a private read-only buffer reduces the number of public buffers. The total
number of private buffers for all simultaneous users is limited to 25% of the total
blocks in database buffers.
4–24
Bleeding Record Lock (-brl)
Operating
system UNIX
and syntax Windows -brl
Client – – – –
Connection
4–25
Browse Column Type (-browcoltype)
Operating
system
and syntax Windows -browcoltype
Client Session – – – –
For more information on the BROWSE widget or the TYPE attribute, see OpenEdge Development:
ABL Reference.
4–26
Number of Buffers for Temporary Tables (-Bt)
Operating
system UNIX
and syntax Windows -Bt n
An INTEGER that specifies the number of blocks in the buffer for temporary tables.
OpenEdge uses the value you specify for temporary databases used during the session the same
way it uses Blocks in Database Buffers (-B) for permanent databases. The default value is 255.
Use Temporary Table Database Block Size (-tmpbsize) to specify the temporary table database
block size, which dictates the size of each buffer in the temporary table database buffer pool for
the current OpenEdge session.
If you do not have enough free memory (virtual or physical) for the buffer pool, reduce the value
of -Bt. To approximate the amount of memory required (in kilobytes) for the buffer pool, use
the following formula:
See OpenEdge Getting Started: ABL Essentials for more information on temporary tables.
4–27
Index Cursors (-c)
Operating
system UNIX
and syntax Windows -c n
DataServer – – – –
Each active FOR EACH and FIND NEXT loop uses one index cursor for each index the AVM is
using. A cursor takes 64 bytes. If you need more index cursors, the AVM displays the following
error message:
Note: The -c parameter has a different meaning when you connect to an ORACLE database.
For more information, see OpenEdge Data Management: DataServer for Oracle.
4–28
Schema Cache File (-cache)
Operating
system UNIX
and syntax Windows -cache filename
Client – – – –
Connection
filename
To perform database activities, the OpenEdge client keeps a copy of the database schema called
the schema cache in memory. By default, OpenEdge creates the schema cache by reading the
database schema stored in the database file. The time required to read the schema usually is
minimal; however, under the following conditions, the time required to read the schema might
be unacceptable:
• When a large number of clients connect to a database simultaneously, for example, after a
database shutdown or crash
To reduce connection time, OpenEdge lets you store the schema cache as a binary file, called a
schema cache file, on a local disk. The client can then read the schema directly from the schema
cache file.
To write the schema cache file, you build the desired schema cache and save it to a binary file
using the ABL SAVE CACHE statement. The schema cache file is portable across systems, so you
can create the file once and distribute it across a heterogeneous network of systems. For
information on building and saving the schema cache file, see OpenEdge Development:
Programming Interfaces.
If you specify schema cache file (-cache) when you connect to a database and the local schema
is valid, the AVM reads the schema from the local file instead of from the database. The schema
cache is valid if the time stamp of the schema cache file matches the time stamp in the database
master block. If the time stamps do not match, or for some reason the AVM cannot read the file,
the AVM issues a warning message and reads the schema from the database.
Note: If you are generating the local binary schema cache, do not connect to the database
using Trigger Location (-trig) and Schema Cache File (-cache) together.
4–29
Check Double-byte Enabled (-checkdbe)
Operating
system UNIX
and syntax Windows -checkdbe
Client Session – – – –
The -checkdbe parameter specifies that ABL generate compile-time warning messages
whenever it finds a LENGTH function, SUBSTRING function, SUBSTRING statement, or OVERLAY
statement without a CHARACTER, COLUMN, RAW, or FIXED option.
4–30
Check Width (-checkwidth)
Operating
system UNIX
and syntax Windows -checkwidth n
Client Session – – – –
• 0 — Ignore the _width field value and store the data. This is the default mode.
• 1 — Store the data, and generate a warning message if the data exceeds the size
specified in the _width field.
• 2 — Do not store data that exceeds the size specified in the _width field, and generate
an error. Specify this mode if you want ABL to behave like SQL.
ABL allows for variable length data; SQL does not. This startup parameter lets you impose the
SQL requirement that data cannot exceed the size specified in the _width field.
Note: The _width field value for array fields is the size of all array elements after the AVM
converts the array element values to CHARACTER. This means that even with the
-checkwidth startup parameter enabled, array fields can still surpass the _width field
value.
4–31
SQL Server Java Classpath (-classpath)
Operating
system UNIX
and syntax Windows -classpath pathname
SQL – – – –
pathname
SQL database brokers use this parameter when launching the Java Virtual Machine (JVM) to
execute stored procedures. The default is to use the current environment variable CLASSPATH
setting. You do not use this parameter directly.
4–32
Clear Log (-clearlog)
Operating
system UNIX
and syntax Windows -clearlog
Client Session – – – –
Note: This parameter is valid only for interactive or batch clients. WebSpeed agents and
AppServers will silently ignore it.
In the following example, the client will delete the log file debug.log, if it exists, and then open
debug.log as the client log file:
In the following example, the client will delete all the log files matching the name debug.log;
such as debug.000001.log through debug.000003.log. Then the client will open
debug.000001.log as the client log file, as shown:
WebSpeed agents and AppServers will silently ignore the Client Logging (-clientlog)
parameter. The broker handles the clearing of the WebSpeed and AppServer server logs,
through the srvrLogAppend property in the ubroker.properties file.
For more detailed information about enabling logging, see OpenEdge Development: Debugging
and Troubleshooting.
4–33
Client Logging (-clientlog)
Operating
system UNIX
and syntax Windows -clientlog filename
Client Session – – – –
filename
The pathname and filename of the log file OpenEdge uses for messages, ABL stack trace,
and .NET stack trace information.
If the filename you supply is a relative pathname, then a file is accessed relative to the current
working directory. If the filename is an absolute pathname, then the specified file is accessed.
Note: Do not include a numbered sequence in the filename. This might conflict with the
rolled over log files OpenEdge creates based on your Number of Log Files to Keep
(-numlogfiles) and Log Threshold (-logthreshold) startup parameter settings.
Use the Log Entry Types (-logentrytypes) startup parameter to specify one or more types of log
entries you want to write to the log file. Use the Logging Level (-logginglevel) startup parameter
to specify the level at which log entries are written to the log file.
When you use the -clientlog startup parameter, and you also specify the Debug Alert
(-debugalert) startup parameter or set SESSION:DEBUG-ALERT to TRUE, the log file includes an
ABL stack trace for error messages (ABL errors and .NET Exceptions) and Alert-box messages.
The top of the stack (most recent call) is displayed at the top of the trace listing.
.NET Exceptions can be thrown when working with .NET objects in ABL. When you do not
handle these Exceptions—there is no CATCH or NO-ERROR logic present—and Debug Alert is on,
the AVM adds the .NET stack trace to the Debug Alert information after the ABL call stack.
The ABL stack trace and the .NET stack trace are added both in the Debug Alert Help dialog
box and in the client log (when -clientlog is specified).
If an error message is diverted to the ERROR-STATUS system handle, and client logging is
enabled, then no information is written to the log file.
In a non-interactive session, the application is configured so that the output device is associated
with a file (or another device). In this configuration, when an ABL statement encounters an
error, it writes the error to the output device. If client logging is enabled, then this message is
also written to the specified log file. Errors are written to the output device at logging
level 1 (Error) and up.
You can use the MESSAGE statement with the VIEW-AS ALERT-BOX option to write application
specific information to the screen and the log file. In this case, you must specify an entry type
of “4GLMessages” and a logging level of 2 (Basic), at least.
4–34
Client Logging (-clientlog)
Note: When you specify a non-zero value for the Log Threshold (-logthreshold) startup
parameter, only one client process at a time can open the log file. Therefore, consider
specifying a different log file for each client session.
For more information about logging levels, see the Logging Level (-logginglevel) startup
parameter reference entry. For more information about specifying log entry types, see the Log
Entry Types (-logentrytypes) startup parameter reference entry.
You can also use attributes on the LOG-MANAGER system handle to specify log entry types and
logging levels.
For more information about the ABL elements previously referenced above, see OpenEdge
Development: ABL Reference.
For more detailed information about enabling logging, see OpenEdge Development: Debugging
and Troubleshooting.
4–35
Cluster Mode (-cluster)
Operating
system UNIX
and syntax Windows -cluster qualifier
Database – – – –
Server
qualifier
Note: All cluster-enabled databases require the Cluster Mode (-cluster) parameter. If used
with a database that is not cluster-enabled, the parameter is ignored.
Value Description
startup Instructs the broker to redirect the startup request to the OS cluster
manager. The cluster manager will start the database using the
information supplied when the database was enabled for cluster
protection.
For more information on the cluster manager, see OpenEdge Data Management: Database
Administration.
4–36
Combo-box Font (-combofont)
Operating
system UNIX
and syntax Windows -combofont [ FIXED ]
Client Session – – – –
FIXED
Specifies that the default font for decimal combo-boxes with LIST-ITEM-PAIRS is fixed.
Starting with Release 10.0A, a decimal combo-box with LIST-ITEM-PAIRS displays values
using a proportional font, by default. To change the default font back to a fixed font, specify the
-combofont startup parameter with the FIXED option.
A decimal combo-box with LIST-ITEMS displays values using a fixed font, by default. If you
change a decimal combo-box with LIST-ITEMS to LIST-ITEM-PAIRS, after it is realized, the
font automatically changes from fixed to proportional (unless you specified the -combofont
startup parameter with the FIXED option).
Note: If you specify a font in the FONT attribute for a combo-box, specifying this startup
parameter has no effect on the combo-box font.
4–37
Conversion Map (-convmap)
Operating
system UNIX
and syntax Windows -convmap filename
Client Session, – – – –
Database
Server
filename
By default, OpenEdge uses the convmap.cp file in the DLC directory. You can create a CONVMAP
file by using the PROUTIL utility with the CODEPAGE-COMPILER qualifier. See OpenEdge
Development: Internationalizing Applications for more information on CONVMAP files.
4–38
Communications Parameter File (-cp)
Operating
system UNIX
and syntax Windows -cp { com-parms | filename }
Client – – – –
Connection
com-parms, filename
Communications parameters supplied with the -cp parameter override any connection
information stored in the OpenEdge metaschema field _Db-comm in the _Db file record for the
database.
4–39
Case Table (-cpcase)
Operating
system UNIX
and syntax Windows -cpcase tablename
tablename
This table establishes case rules for the code page that the AVM uses in memory. The code page
is specified by the Internal Code Page (-cpinternal) parameter. The case rules are used by the
CAPS and LC functions. Also, in a character field format, you can use an exclamation point (!)
to tell the AVM to convert all characters to uppercase during input.
To retrieve the value of this startup parameter at runtime, use the SESSION system handle.
4–40
Collation Table (-cpcoll)
Operating
system UNIX
and syntax Windows -cpcoll collation-name
collation-name
The name of a collation table within the convmap.cp file, or the name of a collation in the
International Components for Unicode (ICU) library.
The AVM uses the collation rules that you specify to compare characters and sort records if a
BY clause cannot be satisfied by an index. The collation rules specified with the -cpcoll
parameter take precedence over the collation specified for any database the AVM accesses
during the session, except when the AVM uses or modifies pre-existing indexes. When you
update or rebuild a database’s indexes, the AVM uses the collation rules originally defined for
that database.
If you do not use -cpcoll, the AVM uses the language collation rules defined for the first
database on the command line. If you do not specify a database on the command line, the AVM
uses the collation rules with the name “basic.”
To retrieve the value of this startup parameter at runtime, use the SESSION system handle.
4–41
Internal Code Page (-cpinternal)
Operating
system UNIX
and syntax Windows -cpinternal code-page
code-page
For graphical clients, the -cpinternal code page should be the same code page that the
operating system uses. If you do not use -cpinternal, the AVM defaults to the iso8859-1 code
page.
Note: Do not use a 7-bit table with -cpinternal. Only use 7-bit tables for converting data
from a 7-bit terminal to another code page. Do not use them for character conversion
in memory, or for the database.
To retrieve the value of this startup parameter at runtime, use the CPINTERNAL attribute of the
SESSION system handle.
4–42
Log File Code Page (-cplog)
Operating
system UNIX
and syntax Windows -cplog code-page
code-page
Name of the code page for messages written to the log file.
To retrieve value of this startup parameter at runtime, use the CPLOG attribute of the SESSION
system handle.
4–43
Print Code Page (-cpprint)
Operating
system UNIX
and syntax Windows -cpprint code-page
code-page
To retrieve the value of this startup parameter at runtime, use the SESSION system handle.
4–44
R-code in Code Page (-cprcodein)
Operating
system UNIX
and syntax Windows -cprcodein code-page
code-page
Caution: This parameter is for use during very rare situations and in general should not be
used. OpenEdge reads text segments as if they are written in the code page specified
by R-code in Code Page (-cprcodein), even if the text segments were written with a
different code page. For example, if you use the following startup parameters and run
a .r file written with code page IBM850, OpenEdge converts the text segments from
ISO8859-1 to ibm861. This can produce incorrect results, if the .r file was correctly
labeled internally as IBM850: -cprcodein ISO8859-1 -cpinternal ibm861
To retrieve the value of this startup parameter at runtime, use the SESSION system handle. To
determine the code page of an r-code file, use the RCODE-INFO handle.
4–45
R-code Out Code Page (-cprcodeout)
Operating
system UNIX
and syntax Windows -cprcodeout code-page
code-page
Typically, you do not need to specify this parameter since OpenEdge converts the text segment
to the -cpinternal code page when reading r-code. However, if the code page of the intended
user is known, you can use this parameter to provide r-code in the user’s code page.
Performance savings are not significant.
To retrieve the value of this startup parameter at runtime, use the SESSION system handle. To
determine the code page of an r-code file, use the RCODE-INFO handle.
4–46
Stream Code Page (-cpstream)
Operating
system UNIX
and syntax Windows -cpstream code-page
code-page
• Terminals (includes character terminals and DOS Protected mode, but does not include
graphical interfaces or the Windows character interface)
Note: Do not use a 7-bit table with -cpstream. Use 7-bit tables for converting data from a
7-bit terminal to another code page only. Do not use them for character conversion in
memory or for the database.
To retrieve the value of this startup parameter at runtime, use the SESSION system handle. To
determine the code page of an r-code file, use the RCODE-INFO handle.
4–47
Terminal Code Page (-cpterm)
Operating
system UNIX
and syntax Windows -cpterm code-page
code-page
To retrieve the value of this startup parameter at runtime, use the SESSION system handle. To
determine the code page of an r-code file, use the RCODE-INFO handle.
4–48
Cursor Size (-cs)
Operating
system UNIX
and syntax Windows -cs n
Client 256 1 6 6
Connection
OpenEdge indexes have a tree structure. Even large indexes typically are no deeper than three
or four levels. Index cursors, which act as place holders during file access, have size 6 by
default; that is, they support up to five levels of indirect access. Therefore, few users ever
require the cursor size (-cs) parameter. However, in rare cases involving large index keys,
increase -cs in response to the following error message:
4–49
Connection Retry Attempts (-ct)
Operating
system UNIX
and syntax Windows -ct n
Client - 1 50 -
Connection
The number of database connection retry attempts. Specify a value greater than 0.
4–50
Compile Warning List (-cwl)
Operating
system UNIX
and syntax Windows -cwl filename
Client Session – – – –
filename
The name of a file that contains ABL statements that are to trigger a warning if they are
found in the source code at compile time. Each statement must use a single line in the file.
OpenEdge uses the PROPATH variable to locate filename. If it cannot find filename, it
displays an error message and does not start.
When source code containing one or more instances of the specified statements is compiled,
OpenEdge displays a message box containing a warning for each such instance, in the following
format:
The flagged_statement statement from the compile warning list was found in
file file_name at line line_number.
Where:
• flagged_statement is the statement matching an entry in the Compile Warning List file
• line_number is the line in the source file where the flagged statement occurs
The user can click OK in the message box to continue. Compilation occurs normally
You can specify that a warning should occur only if the statement includes specific phrases or
options. To do so, add those phrases or options to the entry in the list. For example, the following
entry results in a warning only for instances of the DEFINE FRAME statement that include the
SHARED option:
In the preceding example, simple DEFINE FRAME statements do not raise a warning message.
However, the statement DEFINE NEW SHARED FRAME does result in a warning; even though the
syntax does not exactly match the list entry, OpenEdge recognizes it as an instance of the
flagged DEFINE SHARED FRAME statement.
4–51
Directory Size (-D)
Operating
system UNIX
and syntax Windows -D n
Each compiled procedure executed during an OpenEdge session requires a directory entry. A
compiled procedure can be a session-compiled version of a procedure or a precompiled r-code
version.
When the AVM creates a session-compiled version of a procedure and there is no available
space in the directory, it discards the oldest inactive compilation of a procedure. The next time
the discarded procedure is run, the AVM must recompile it if it was a session compile, or reopen
and reread it if it was a precompiled r-code version.
The -D limit is a soft limit. If your application needs to exceed the limit, OpenEdge
automatically increases the number of directory entries by 50 percent and dynamically allocates
memory for the expanded array. (Use the Statistics (-y) parameter to check the current directory
size (-D) value.) When the limit is reached, OpenEdge issues a WARNING message, which is
written to the current output (if there is current output) and to the log file (LG).
You can force OpenEdge to adhere to the specified directory size (-D) limit by starting the
session with the Hardlimit (-hardlimit) startup parameter. When you use the -hardlimit startup
parameter, OpenEdge issues a WARNING message when you exceed the directory size limit. It
also issues a message that a resource limit was reached and raises an untrappable STOP
condition. Note that -hardlimit also enforces the limits set by the Local Buffer Size (-l), the
Maximum Memory (-mmax), and the Nested Blocks (-nb) startup parameters, so the STOP
condition is raised when any of the specified limits are reached.
4–52
Date Format (-d)
Operating
system UNIX
and syntax Windows -d dateform
dateform
Notes • The -d sets the display format not the storage format. The storage format is fixed.
• The date constants entered in procedures, or as initial values in the Data Dictionary, are
always specified in month/day/year format.
4–53
DataService (-DataService)
DataService (-DataService)
Use DataService (-DataService) to connect through a NameServer to an ODBC, ORACLE, or
SQL Server DataServer.
Operating
system UNIX
and syntax Windows -DataService data-service
Client – – – –
Connection
data-service
The value for data-service must be a valid name from the DataService list registered to this
NameServer, as defined by your appServiceName List entry in the broker properties file. If a
default DataService has been defined for your broker instance, you can omit this parameter and
connect using the default service.
This parameter must be used in conjunction with the DataServer Logging (-dslog) startup
parameter.
Note: Using the -DirectConnect parameter on the CONNECT statement will override the
-DataService parameter.
For more information on the CONNECT statement, see OpenEdge Development: ABL Reference.
4–54
DataSet100 (-dataset100)
DataSet100 (-dataset100)
Use DataSet100 (-dataset100) when you have r-code containing ProDataSet objects that you
want to compile in OpenEdge 10.1, and run in both OpenEdge 10.1 and 10.0. This startup
parameter directs ABL to compile references to ProDataSet objects in an OpenEdge 10.0
manner, which results in r-code that will run in both 10.1 and 10.0 environments without error
(providing you have not used any new OpenEdge 10.1 features).
Note: This startup parameter has no effect; it is supported only for backward compatibility.
Operating
system UNIX
and syntax Windows -dataset100
Client Session – – – –
4–55
Physical Database Name (-db)
Operating
system UNIX
and syntax Windows -db physical-dbname
Client – – – –
Connection
physical-dbname
The database to connect to when an OpenEdge session is started. Specify the physical (not
the logical) database name. If you are connecting in single-user mode or through shared
memory, and the database is not in your current directory, you must specify the full path
of the database.
Use Single-user Mode (-1) after the name of the database to connect in single-user mode. You
do not have to precede the first database on the command line with -db; however, for all
subsequent databases that you want to connect, precede the database name with -db. For
example, the following command connects two databases, abc and xyz:
4–56
Database consistency check (-DbCheck)
Operating
system UNIX
and syntax Windows -DbCheck
Client – – – –
Connection,
Database
Server
When enabled, this option applies consistency checks to all index blocks and record blocks for
record and index write operations. Database consistency check validates a block is still
physically correct after an operation has been performed. For example, after an index key is
inserted into an index block, the consistency check validates that the block still laid out
correctly.
You can limit the scope of consistency checking by specifying one area with Area consistency
check (-AreaCheck), one table with Table consistency check (-TableCheck), or one index with
Index consistency check (-IndexCheck).
Database consistency checking can be enabled or disabled while your database is online with
PROMON. See OpenEdge Data Management: Database Administration for more information.
Database consistency check can be enabled for a single user client or for any offline utility. If
the utility is read-only, such as DBANALYS, the -DbCheck parameter is ignored. Online
utilities determine whether or not to perform database consistency checking during execution
based on the use of -DbCheck at broker startup or by the enablement/disablement of the database
consistency checking in PROMON.
4–57
Debugger (-debug)
Debugger (-debug)
Use Debugger (-debug) to start an OpenEdge session by running the Application Debugger in
stand-alone mode.
Operating
system UNIX
and syntax Windows -debug
Client Session – – – –
This makes the Debugger (not the Procedure Editor) the point of entry for all application
procedures to run. The Debugger begins by allowing breakpoints before using the Debugger RUN
command to execute the startup procedure. Also, the AVM automatically sets a breakpoint on
the first executable line of the startup procedure before it runs.
For more information on the Debugger, see OpenEdge Development: Debugging and
Troubleshooting.
4–58
Debug Alert (-debugalert)
Operating
system UNIX
and syntax Windows -debugalert
Client Session – – – –
Alternately, you can set the DEBUG-ALERT attribute on the SESSION system handle to TRUE in your
application. The advantage of the DEBUG-ALERT attribute is that its value can be modified during
a client session.
When an unhandled ABL error or .NET Exception occurs—there is no CATCH or NO-ERROR logic
present—in an interactive session for any ABL client, the AVM displays an Error message box.
When Debug Alert is TRUE, the message box also includes a Help button. Clicking on the Help
button produces a Stack Trace dialog box containing ABL stack trace and .NET stack trace
information. The ABL stack trace and the .NET stack trace are written to the client log when
the Client Logging (-clientlog) startup parameter is specified. The top of the stack (most
recent call) is displayed at the top of the trace listing.
To retrieve or reset the value of this parameter at runtime, you use the DEBUG-ALERT attribute of
the SESSION system handle. For more information on the DEBUG-ALERT attribute or the SESSION
system handle, see OpenEdge Development: ABL Reference.
4–59
Enable Attachable Debugging (-debugReady)
Operating
system UNIX
and syntax Windows -debugReady { 0 | port-number }
Client Session – – – –
port-number
The port on which the AVM opens a socket for connecting to the attachable Debugger. If
you want the AVM to find an available port, enter 0 (zero). The default value is 0.
An ABL developer can attach the attachable Debugger to any OpenEdge session running locally
or remotely in a LAN environment. This allows the developer to run the Debugger on one
machine and debug an OpenEdge process running on another machine.
You cannot specify both the Debugger (-debug) and Enable Attachable Debugging
(-debugReady) startup parameters on the command line at the same time. If you do, the AVM
generates an error and shuts down.
For more information about the attachable Debugger, see OpenEdge Development: Debugging
and Troubleshooting.
4–60
Disable Delete Trigger (-disabledeltrig)
Operating
system UNIX
and syntax Windows -disabledeltrig
Client Session – – – –
4–61
Dictionary Expressions (-dictexps)
Operating
system UNIX
and syntax Windows -dictexps
Client Session – – – –
This parameter serves as a temporary step to close possible validation holes in existing
applications. It has the effect of adding a USE-DICT-EXPS option to every frame in the
application, including those that are not used for input. This parameter closes all possible
validation holes, but it is highly inefficient.
You can override this functionality for a particular frame by using the NO-VALIDATE keyword
for that frame. See the Frame Phrase reference entry in OpenEdge Development: ABL Reference
for more details on the NO-VALIDATE option.
If you do not specify -dictexps, ABL uses dictionary and help validation for a field only if that
field is used in an UPDATE, SET, PROMPT-FOR, or ENABLE statement. In addition, ABL does not use
dictionary and help validation when compiling if you specify only the widget:SENSITIVE=YES
construct to make a widget sensitive. ABL stops compiling when it encounters a validation
error.
4–62
Direct I/O (-directio)
Operating
system UNIX
and syntax Windows -directio
This technique has several advantages over buffered reads and writes, such as avoiding the
overhead of maintaining the operating system buffer pool and eliminating competition for
operating system buffers between OpenEdge programs and other programs. The operating
system buffer-pool algorithms are designed for efficient sequential file access; the OpenEdge
buffer-pool algorithms are more efficient for access to an OpenEdge database.
You might improve OpenEdge performance by using the direct I/O feature. To use direct I/O,
use Blocks in Database Buffers (-B) to increase the size of the OpenEdge buffer pool, since
OpenEdge I/O does not pass through the operating system buffer pool. Also, decrease the size
of the operating system buffer pool to compensate for the additional memory allocated to
OpenEdge.
Note: Use asynchronous page writers (APWs). They improve database performance by
performing overhead operations in the background.
4–63
DataServer Logging (-dslog)
Operating
system UNIX
and syntax Windows -dslog filename
DataServer – – – –
Session
filename
The name of log file the DataServer uses for log messages.
The –dslog startup parameter specifies the DataServer log file name.
If you do not specify a log file name at startup, then the default dataserv.lg file will be used
for logging server information.
The dataserv.lg file is the default value for the -dslog parameter. For non-interactive sessions
that encounter errors, warnings or other messages that need to be logged, it writes to this log file
by default.
If the filename you supply is a relative pathname, then a file is accessed relative to the current
working directory. If the filename is an absolute pathname, then the specified file is accessed
unless the $DSLOGDIR environment variable is set to specify a directory path for the -dslog file
name. The $DSLOGDIR setting overrides the current working directory in search for the -dslog
file name.
Note: Do not include a numbered sequence in the filename. This might conflict with the
rolled over log files OpenEdge creates based on your Number of Log Files to Keep
(-numlogfiles) and Log Threshold (-logthreshold) startup parameter settings.
Use the Log Entry Types (-Dsrv LOGENTRYTYPES) DataServer connection parameter to specify
one or more one or more types of log entries you want to write to the server context log file. Use
the Logging Level (-Dsrv LOGGINGLEVEL) DataServer connection parameter to specify the level
at which log entries are written to the log file.
ABL clients, including the client component of the DataServer, write their logging to the file
specified by the –clientlog startup parameter. Refer to the “Client Logging (-clientlog)”
section on page 4–34 for more information.
4–64
DataServer Logging (-dslog)
The OpenEdge client, including the client component of the DataServer, to which the
-clientlog switch applies, can be thought of as the “client log context.” Similarly, the server
component of the DataServer, to which the -dslog switch applies, can be considered the “server
log context.” When the OpenEdge DataServer runs self-service (i.e., not client/server), the
OpenEdge client’s log context and the OpenEdge DataServer’s log context can be merged into
a single log file by selecting the same file name with the -clientlog and -dslog log file
specifications in both log contexts. Note that the -logtheshold, -logappend and -numlog files
parameters specified at client startup apply to both client and server log contexts in this case..
All the server processes affected by these parameters will write to the same -dslog log file and
switch to the next log file when the logthreshold is reached.The code page used for the log file
is -cpinternal and no conversions are performed for these log files.
Fore more information about logging for the client context, see OpenEdge Development: ABL
Reference.
For more about logging for the server context, see the OpenEdge DataServer guides.
4–65
DataServer (-Dsrv)
DataServer (-Dsrv)
Use DataServer (-Dsrv) to tell OpenEdge that the specified keywords are parameters for the
ODBC, ORACLE, or MS SQL Server DataServer.
Operating
-Dsrv keyword ( , value)
system UNIX
and syntax Windows [, keyword2 ( , value2 ) ... ]
DataServer – – – –
These parameters are specific to ODBC data sources or are required to connect to certain data
sources using the OpenEdge DataServers. You can specify up to 50 keywords with the -Dsrv
parameter.
For more information about the parameters, see the OpenEdge DataServer guides.
4–66
Database Type (-dt)
Operating
system UNIX
and syntax Windows -dt db-type
db-type
The value is not case sensitive. When connecting to a non-OpenEdge database, use Database
Type (-dt) to specify the type of database.
4–67
European Numeric Format (-E)
Operating
system UNIX
and syntax Windows -E
AMERICAN is the default value, in which periods are displayed as decimal points and commas as
thousands separators (for example: 1,234,567.89).
When you specify EUROPEAN, continue to use periods as decimal points and commas as
thousands separators in your source files. Note there is no command line parameter to specify
AMERICAN, or reset EUROPEAN.
Numeric format specifications in the Data Dictionary and the decimal constants in procedures
always must use the period to represent the decimal point.
You can also use the NUMERIC-FORMAT attribute on the SESSION system handle to get or set the
numeric format.
4–68
Error Stack (-errorstack)
When -errorstack is specified, the ERROR-STACK-TRACE attribute of the SESSION handle is set
to TRUE. The default value for this attribute is FALSE. While saving the call stack is a useful
debugging feature, it can also consume resources and can potentially affect performance.
Enabling ERROR-STACK-TRACE with this startup parameter is not recommended in a production
environment.
Operating
system
and syntax Windows -errorstack
Client Session – – – –
4–69
Event Level (-evtlevel)
Operating
system
and syntax Windows -evtlevel value
value
• Brief — OpenEdge Error and Warning messages are written to the Event Log.
• Normal — OpenEdge Error and Warning messages are written to the Event Log
along with any OpenEdge message that is normally written to the log file (.lg). This
is the default.
• Full— OpenEdge Error, Warning, and Informational messages are written to the
Event Log along with any messages generated by the Message Statement.
For more information about OpenEdge and the Windows Event Log, see OpenEdge Getting
Started: Installation and Configuration.
4–70
Expand Browse (-expandbrow)
Operating
system
and syntax Windows -expandbrow
Client Session – – – –
The EXPANDABLE attribute has the same behavior as the FIT-LAST-COLUMN attribute. Therefore,
if the -expandbrow parameter is specified at startup, the FIT-LAST-COLUMN attribute is set to
TRUE for each browse in that session.
Note: Progress Software Corporation recommends that you use the FIT-LAST-COLUMN
attribute instead of the EXPANDABLE attribute. This recommendation includes replacing
EXPANDABLE with FIT-LAST-COLUMN in your current code.
For more information on these attributes, see OpenEdge Development: ABL Reference.
4–71
Force Access (-F)
Operating
system UNIX
and syntax Windows -F
Client – – – –
Connection
Note: The PROMON and PROUTIL utilities also use a -F parameter; however, the results
are not the same. In addition, using -F with PROUTIL might compromise the integrity
of the database. For more information, see OpenEdge Data Management: Database
Administration.
4–72
Schema Field Cache Size (-fc)
Operating
system UNIX
and syntax Windows -fc num-entries
num-entries
For example, you might increase the size if you retrieve large numbers of fields from your
database. The schema field cache reduces the time required to compile SQL queries by storing
schema field information in memory. For best results, set this parameter to the total number of
fields retrieved from the database.
OpenEdge uses approximately 150 additional bytes of memory per schema field cache entry
used. Because memory is allocated when required, unused entries produce minimal overhead.
4–73
Filtering Asynchronous COM Events (-filterocxevents)
Operating
system UNIX
and syntax Windows -filterocxevents
Client Session – – – –
An asynchronous COM event is one that is sent by an ActiveX control or Automation object
because of an external event, rather than in response to user input. One example of this is the
Tick event from the PSTimer. Another is an event signalling the receipt of a message from an
external source, such as a control that implements a mail notification system.
By default, asynchronous COM events are handled when any of the following conditions occur:
• While an application is waiting for user input, such as during a WAIT–FOR or UPDATE
statement
Handling COM events during the second and third conditions might cause random problems in
your application, depending on what ABL code is executed in the event trigger. You use the
–filterocxevents startup parameter to prevent asynchronous COM events from being handled
during the second and third conditions.
4–74
Field List Disable (-fldisable)
Operating
system UNIX
and syntax Windows -fldisable
Client Session – – – –
For more information about using field lists, see OpenEdge Getting Started: ABL Essentials.
4–75
Before-image Truncate Interval (-G)
Operating
system UNIX
and syntax Windows -G n
Database – 0 0 0
Server
4–76
Group Delay (-groupdelay)
Operating
system UNIX
and syntax Windows -groupdelay n
When the Group Delay is set greater than zero (0), OpenEdge uses a technique known as Group
Commit. When using Group Commit, a transaction spools its end note to the BI buffer and waits
a short time until the buffer becomes full and is written to disk, or waits for other transactions
to end and store their end notes in the BI buffer so that several transactions are committed by
the same synchronous write. In this manner, Group Commit benefits overall performance,
although each individual transaction might take slightly longer.
4–77
Host Name (-H)
Operating UNIX
system Windows
and syntax (TCP) -H { host-name | localhost1 }
Use Maximum Minimum Single-user Multi-user
with value value default default
Client Connection, – – – –
Database Server,
DataServer
host-name
The name (address) of the database server machine. This name is assigned to the machine
in your TCP/IP hosts file.
localhost
A reserved word that specifies that the database server communicate only with clients on
the database server machine.
4–78
Number of Databases (-h)
Operating
system UNIX
and syntax Windows -h n
The maximum number of databases that can be connected during an OpenEdge session.
OpenEdge automatically allocates enough space to allow the connection of five databases.
4–79
Hardlimit (-hardlimit)
Hardlimit (-hardlimit)
Use Hardlimit (-hardlimit) to force OpenEdge to adhere to the set limits for Directory Size
(-D), Local Buffer Size (-l), Maximum Memory (-mmax), and Nested Blocks (-nb).
Operating
system UNIX
and syntax Windows -hardlimit
Client Session – – – –
Use Hardlimit (-hardlimit), Directory Size (-D), Local Buffer Size (-l), Maximum Memory
(-mmax), and Nested Blocks (-nb) are by default soft limits; that is, OpenEdge tries to manage
system resources within the limits given, but when it cannot, OpenEdge increases the exceeded
limit.
When -hardlimit is specified and one of the limits is exceeded, OpenEdge generates a WARNING
message that is written to the current output (if there is current output) and to the log file (LG).
In addition, OpenEdge issues a message that a resource limit was reached and raises an
untrappable STOP condition.
4–80
Hash Table Entries (-hash)
Operating
system UNIX
and syntax Windows -hash n
The number of hash table entries to use for the buffer pool.
Caution: Do not use this parameter unless directed to do so by Progress Software Corporation
Technical Support.
4–81
No Crash Protection (-i)
Operating
system UNIX
and syntax Windows -i
Client – – – –
Connection,
Database
Server
When running OpenEdge without database integrity, it writes fewer data and before-image
blocks to the disk. In this mode, some ABL procedures (such as those that create and delete large
numbers of records) run significantly faster than if they are running with database integrity.
When running OpenEdge with the -i parameter, transaction undo is supported. Therefore, there
will still be a before-image file, which might grow quite large during very long transactions.
Use this parameter to do bulk data loading or for large batch runs. It reduces the number of disk
input or output operations. Loading a database for the first time is a good example of a use for
this parameter.
Caution: If you run OpenEdge with the -i parameter and OpenEdge fails for any reason, you
cannot recover the database.
Do not use the -i parameter unless you have a complete backup of the database and can rerun
procedures in case of a system failure. If the system fails during an OpenEdge session started
without crash protection, restore the backup copy and rerun the necessary procedures. For
information about restoring a database, see OpenEdge Data Management: Database
Administration.
The following messages might appear when starting an OpenEdge session after a system failure:
4–82
Dynamics Parameter (-icfparam)
Operating
system UNIX
and syntax Windows -icfparam string
Client Session – – – –
string
You can access this string within an ABL procedure by reading the ICFPARAMETER attribute of
the SESSION system handle.
Note: This parameter is reserved for use by Dynamics and procedures that have been
integrated with Dynamics. Using this parameter for any purpose other than operating
within the Dynamics framework will interfere with your ability to integrate your
application with that framework at a later time.
For more information about the ICFPARAMETER attribute or the SESSION system handle, see
OpenEdge Development: ABL Reference.
4–83
Index consistency check (-IndexCheck)
Operating
system UNIX -IndexCheck
and syntax Windows [owner-name.]table-name.indexname
Client – – – –
Connection,
Database
Server
owner-name
Specifies the owner of the table containing the index you want to check. You must specify
an owner name unless the table’s name is unique within the database, or the table is owned
by PUB. By default, ABL tables are owned by PUB.
table-name
indexname
When enabled, this option applies consistency checks to all index blocks and index write
operations.
Index consistency check validates a block is still physically correct after an operation has been
performed. For example, after an index key is inserted into an index block, the consistency
check validates that the block still laid out correctly.
You can only specify one index with -IndexCheck. To check multiple indexes, you can apply
consistency checking to the entire database with Database consistency check (-DbCheck), or if
multiple indexes are in one area, you can apply consistency checking to an entire area with Area
consistency check (-AreaCheck).
Index consistency checking can be enabled or disabled while your database is online with
PROMON. See OpenEdge Data Management: Database Administration for more information.
Index consistency check can be enabled for a single user client or for any offline utility. If the
utility is read-only, such as DBANALYS, the -IndexCheck parameter is ignored. Online
utilities determine whether or not to perform index consistency checking during execution
based on the use of -IndexCheck at broker startup or by the enablement/disablement of the
index consistency checking in PROMON.
4–84
Index Range Size (-indexrangesize)
Operating
system UNIX
and syntax Windows -indexrangesize n
Database – – – –
Server
The number of indexes for which you want to track access statistics.
For more information about tracking index statistics, see OpenEdge Data Management:
Database Administration.
4–85
Initialization File (-ininame)
Operating
system
and syntax Windows -ininame name
Client Session – – – –
name
Name of the initialization registry subkey or the application's initialization (.INI) file.
When the Registry Base Key (-basekey) parameter is not specified at startup, the AVM searches
the HKEY_CURRENT_USER key followed by the HKEY_LOCAL_MACHINE key for the specified name.
If no registry key of the specified name is found, the AVM searches for a .INI file that matches
name.
You can only use this startup parameter at the command line. It is ignored when used in a .pf
file.
Note: The -ininame parameter replaces the -name option for the Windows Attributes (-Wa)
parameter for Version 7.3B and later.
4–86
Input Characters (-inp)
Operating
system UNIX
and syntax Windows -inp n
The number of characters allowed in a single ABL statement. The default is 15000
characters.
If not specified and you exceed 15000 characters in a single statement, the AVM displays a
message indicating that the statement is too long and advises you to increase the number of input
characters per statement using this parameter.
4–87
Internet Protocol (-ipver)
Operating
system UNIX
and syntax Windows -ipver { IPv4 | IPv6 }
IPv4
Specifies Internet Protocol Version 4. Only network connections with IPv4 are allowed.
IPv6
Specifies Internet Protocol Version 6. IPv6 allows network connections with IPv6
addresses and mapped IPv4 addresses. OpenEdge supports V4 mapped addresses where
underlying operating system support exists: UNIX, Linux, and Windows Vista.
Note: The -ipver startup parameter is case sensitive and must be specified in all lower case.
The values IPv4 and IPv6 are not case sensitive, and can be specified in any case.
4–88
AS/400 Ignore Stamp (-is)
Operating
system UNIX
and syntax Windows -is
Client – – – –
Connection,
DataServer
When connecting to the schema holder database and the AS/400 database, OpenEdge compares
the timestamps on the files in the schema holder and the AS/400 physical and logical files. If
the timestamps do not match, the login attempt is rejected.
Note: Whenever any change to the AS/400 database structure is made (whether or not the
change is saved), the AS/400 data dictionary time stamp changes.
OpenEdge checks the timestamp at the initial connection. If an AS/400 user modifies the file
definitions after a successful OpenEdge connect, the user might get unpredictable results.
4–89
Initial Value Segment No Convert (-isnoconv)
Operating
system UNIX
and syntax Windows -isnoconv
Client Session – – – –
• The text literals contain international characters (whether or not the literal is flagged as
untranslatable using the :U attribute).
• The code page of the r-code (-cprcodein) does not match the code page of internal
memory (-cpinternal).
• This is a compile-time option, not a run-time option, and affects the generation of r-code,
not its execution.
When you run earlier versions of OpenEdge under these conditions, and the AVM reads text
literals from r-code into internal memory, it does not convert the code page. To compensate for
this, programmers often pre-convert international characters in text literals to -cpinternal.
When you run Version 9.1A under these conditions, and the AVM reads text literals from r-code
into internal memory, it converts the code page from -cprcodein to -cpinternal. This code
page conversion might cause international characters you have pre-converted to -cpinternal
to be converted again to -cpinternal, which garbles them.
Note: Progress Software Corporation recommends that you avoid preconverting text literals.
4–90
Keyword Forget List (-k)
Operating
system UNIX
and syntax Windows -k filename
Client Session – – – –
filename
The name of a file that contains ABL keywords to disable. Each keyword must use a single
line in the file. If the AVM encounters a word that is not an ABL keyword, it returns a
warning message but continues processing the file. OpenEdge uses the PROPATH variable
to locate filename. If it cannot find filename, it displays an error message and does not
start.
Do not use keywords in procedures as ABL user-defined element names (tables, fields, frames,
variables, streams, and so on). If necessary, disable new keywords (and the features they
implement) until they can be removed from the application.
The directory where OpenEdge is installed contains the following keyword files:
• newkywd — Lists all keywords that are new in the most recent release of OpenEdge
• newkw810— Use instead of newkywd, if you are converting from Progress Version 8 to
OpenEdge Release 10
• newkw710— Use instead of newkywd, if you are converting from Progress Version 7 to
OpenEdge Release 10
• newkw610— Use instead of newkywd, if you are converting from Progress Version 6 to
OpenEdge Release 10
4–91
Key Alias (-keyalias)
Operating
system UNIX
and syntax Windows -keyalias key-alias-name
Database – – – default_server
Server
key-alias-name
Specifies the alias name of the Secure Sockets Layer (SSL) private key/digital certificate
key-store entry to use.
4–92
Key Alias Password (-keyaliaspasswd)
Operating
system UNIX
and syntax Windows -keyaliaspasswd key-alias-password
Database – – – password1
Server
1. The actual value used is the encrypted value of the string “password.”
key-alias-password
Specifies the encrypted Secure Sockets Layer (SSL) Key Alias Password to use to access
the server’s private key/digital certificate key-store entry. The default is password.
The key-alias-password value must be encrypted. You can use the genpassword utility,
located in your installation’s bin directory, to encrypt the password.
4–93
Lock Table Entries (-L)
Note: Starting in Release 10.1C, the OpenEdge RDBMS expands the range of internal
validations used to ensure database consistency in both index and data blocks during
forward processing. Validations using PROUTIL can be run online as part of routine
health checks. For more information, see OpenEdge Data Management: Database
Administration.
Operating
system UNIX
and syntax Windows -L n
The number of entries in the record locking table. If you specify a value that is not a
multiple of 32, OpenEdge rounds the value you specify to the next highest multiple of 32.
Each record that is accessed by any user takes one entry. This is true whether the record is
accessed with SHARE-LOCK or EXCLUSIVE-LOCK.
Increase the size of the lock table if the following message appears:
This message also might indicate that a particular procedure should be restructured into smaller
transactions or should be run in single-user rather than multi-user mode. When lock table limits
are exceeded, check to make sure transactions are not too large before increasing the lock table
size.
If a user process tries to acquire a lock and the lock table overflows, the user's program is
aborted, but the server continues to operate. Any partial transactions are undone.
Note: The two record locks are acquired when records are accessed with the BREAK BY option
(in DO, FOR EACH, or REPEAT statements).
4–94
Local Buffer Size (-l)
Operating
system UNIX
and syntax Windows -l n
The maximum size of the local record buffer is 4GB for most systems. If you get one of the
following error messages, you must increase the size of this buffer:
The Local Buffer Size (-l) limit is a soft limit; so if your application needs to exceed the limit,
OpenEdge automatically increases it and issues a WARNING message. The WARNING is written to
the current output (if there is current output) and to the log file (LG).
You can force OpenEdge to adhere to the specified -l limit by starting the session with the
Hardlimit (-hardlimit) startup parameter. When you use the -hardlimit startup parameter,
OpenEdge issues the WARNING message when you exceed the Local Buffer Size limit. It also
issues a message that a resource limit was reached and raises an untrappable STOP condition.
Note that -hardlimit also enforces the limits set by the Directory Size (-D), the Maximum
Memory (-mmax), and the Nested Blocks (-nb) startup parameters, so the STOP condition is
raised when any of the specified limits is reached.
4–95
Logical Database Name (-ld)
Operating
system UNIX,
and syntax Windows -ld logical-dbname
Client – – – –
Connection
logical-dbname
• It can be any combination of English letters and numbers, underscore (_), and dash (-)
characters.
A logical database name cannot include ABL reserved words, a space, any accented letters, or
any of the following special characters:
For more information on logical database names, see OpenEdge Getting Started: ABL
Essentials and OpenEdge Data Management: Database Administration.
4–96
Literal Question (-literalquestion)
Operating
system UNIX
and syntax Windows -literalquestion
Client Session – – – –
The LITERAL-QUESTION attribute lets you specify how the AVM interprets a quoted character
value during assignment into the BUFFER-VALUE attribute for a character BUFFER-FIELD object.
That is, whether the AVM treats the quoted character value as a literal or non-literal character
value.
When TRUE, the new default value, the AVM treats a quoted character value as a literal character
value. That is, it does not remove enclosing quotes, trailing blanks, or formatting insertion
characters.
When FALSE, the AVM treats a quoted character value as a non-literal character value. That is,
it removes enclosing quotes, trailing blanks, and formatting insertion characters. For example:
• The AVM treats a quoted question mark character ("?") as the Unknown value (?).
For more information about ABL objects and attributes, see OpenEdge Development: ABL
Reference.
4–97
Lock Table Hash Size (-lkhash)
Operating
system UNIX
and syntax Windows -lkhash n
Database – – – –1
Server
1. The default is variable based on the size of your lock table (-l).
Progress Software Corporation recommends changing the value of Lock Table Hash Size
(-lkhash) only after contacting Technical Support.
4–98
Lock release (-lkrela)
Operating
system UNIX
and syntax Windows -lkrela
Client Session - - - -
Using this parameter instructs the database to use the original lock release mechanism installed
in previous versions of OpenEdge (versions 10.1A and higher).
Note: When using this parameter, keep in mind that the database engine may search all lock
chains to be released at transaction end and disconnect time. As a result, you may see
a degradation in performance.
4–99
Lock Timeout (-lkwtmo)
Operating
system UNIX
and syntax Windows -lkwtmo seconds
seconds
An OpenEdge process encountering a locked resource waits for a limited time before continuing
execution. If the resource is still locked, the process times out and the wait is canceled. This
feature is called “lock wait timeout.”
The default wait time is 1800 seconds (30 minutes). The minimum value is 60 seconds. If a user
specifies a value less than 60 seconds, OpenEdge silently sets the value at 60 seconds.
Note: The wait time is accurate to within one minute of the value specified.
Lock timeout applies to interactive and batch clients. The client gets a STOP condition if this
value is exceeded on the AppServer. For more information, see the sections on client/server
conflicts in OpenEdge Application Server: Developing AppServer Applications.
Lock timeout affects WAIT-FOR record locks, schema locks, and transaction commit locks. Lock
timeout does not affect internal locks used inside the database manager, such as buffer locks.
4–100
Language (-lng)
Language (-lng)
Use Language (-lng) to specify the initial return value for the CURRENT-LANGUAGE function. This
setting determines from which r-code segment the AVM reads character-string constants.
Operating
system UNIX
and syntax Windows -lng language-name
Client Session – – ? ?
language-name
The default value for the Language parameter is a character string that contains the question
mark (?) character, which is not to be confused with the Unknown value (?). This tells the AVM
to use the default language for the application.
For more information on the Language startup parameter, see OpenEdge Development:
Internationalizing Applications and OpenEdge Development: ABL Reference.
4–101
Log Entry Types (-logentrytypes)
Operating
system UNIX
and syntax Windows -logentrytypes string
Client Session – – – –
string
By default, the logging level you specify using the Logging Level (-logginglevel) startup
parameter applies to all log entry types specified. However, you can specify a different logging
level for each entry type, as follows:
log-entry-type[:level]
log-entry-type
level
4–102
Log Entry Types (-logentrytypes)
4–103
Log Entry Types (-logentrytypes)
DynObjects.UI
ABL clients and
WebSpeed agents
4–104
Log Entry Types (-logentrytypes)
For more information about log entry types, see OpenEdge Development: Debugging and
Troubleshooting.
The following example shows how to specify one or more individual log entry types:
-logentrytypes DB.Connects,4GLTrace:2,DynObjects.UI:3
The following example shows how to specify all log entry types within a category:
-logentrytypes DynObjects.*
For more information about logging levels and log entry types, see OpenEdge Development:
Debugging and Troubleshooting.
You also can turn on logging at run-time by using the LOG-ENTRY-TYPES attribute on the
LOG-MANAGER system handle. For example, you can include the following line in your ABL
code:
LOG-MANAGER:LOG-ENTRY-TYPES = "DynObjects.UI"
You can turn off logging in your ABL code by setting this attribute to the Unknown value (?).
For example:
LOG-MANAGER:LOG-ENTRY-TYPES = ?
For more information about the LOG-ENTRY-TYPES attribute or the LOG-MANAGER system handle,
see OpenEdge Development: ABL Reference.
4–105
Logging Level (-logginglevel)
Operating
system UNIX
and syntax Windows -logginglevel n
Client Session – – – –
Logging level represents the amount of logging information written to the log file, as shown in
Table 4–3.
1 (Errors) Log OpenEdge error messages. This includes all error messages
and is unrelated to the entry types specified. Errors continue to
be logged at all higher levels.
2 (Basic) Log entry types determine the logged information. Each entry
type will generate at least some output. This is the default.
By default, the logging level you specify applies to all log entry types. However, you can specify
individual log entry types with a different logging level using the Log Entry Types
(-logentrytypes) startup parameter.
You can also use attributes on the LOG-MANAGER system handle to specify log entry types and
logging levels. For more information, see OpenEdge Development: ABL Reference.
For more detailed information about enabling logging, see OpenEdge Development: Debugging
and Troubleshooting.
4–106
Log Threshold (-logthreshold)
Operating
system UNIX
and syntax Windows -logthreshold n
Client Session – – – –
When the current log file becomes equal to or greater than the specified size, OpenEdge
renames and saves the log file and creates a new log file. Valid values are:
• 0 — This means there is no limit other than what the operating system imposes. Specify 0
to ignore the Number of Log Files to Keep (-numlogfiles) startup parameter setting. This
is the default.
• Between 500,000 and 2,147,483,647 — Values are in bytes (one byte typically holds one
character). You can specify a file size up to 2GB, inclusive, but not lower than 500,000.
If you specify a number lower than 500,000, a run-time error occurs and the OpenEdge
process terminates.
OpenEdge names log files based on a sequence number using the following format:
<filename>.999999.<extension>
For example, if you specify a log file named my.log, OpenEdge renames the log file to
my.000001.log before creating a new log file.
Use the Client Logging (-clientlog) startup parameter to specify a log file name for ABL clients.
Note: When a non-zero value is specified for -logthreshold, only one client process at a
time can open the file specified by the Client Logging (-clientlog) startup parameter.
In this case it is recommended that each client session specify a different file name.
Use the DataServer Logging (-dslog) startup parameter to specify a log file name for the server
context of a DataServer client or agent. Use the Number of Log Files to Keep (-numlogfiles)
startup parameter to specify the number of log files to keep.
You can also can use the LOG-THRESHOLD attribute on the LOG-MANAGER system handle to specify
the file size threshold of log files. For more information, see OpenEdge Development: ABL
Reference.
4–107
Auto Server (-m1)
Operating
system UNIX
and syntax Windows -m1
Database – – – –
Server
The OpenEdge broker uses the auto server internally to start a remote user server. This is the
default. You will never have to use this parameter directly.
4–108
Manual Server (-m2)
Operating
system UNIX
and syntax Windows -m2
Database – – – –
Server
• For debugging purposes, to start servers directly and observe their behavior
4–109
Secondary Login Broker (-m3)
Operating
system UNIX
and syntax Windows -m3
Database – – – –
Server
The secondary broker logs in clients and starts remote user servers.
4–110
Maximum Clients Per Server (-Ma)
Operating
system UNIX
and syntax Windows -Ma n
The maximum number of remote users per database server. The default is the Number of
Users (-n) parameter value, divided by the Maximum Servers (-Mn) parameter value.
The Maximum Clients Per Server (-Ma), Minimum Clients per Server (-Mi), and Maximum
Servers (-Mn) startup parameters pertain only to versions of OpenEdge that use shared memory.
In addition, these parameters apply only to databases that are accessed from remote network
nodes.
In most cases, the default behavior is desirable. Note that the default calculation is usually high
because it assumes that all users are remote users, while the number specified with -n includes
local users. If servers become overloaded with clients, reset the -Mn parameter to increase the
number of servers. If experience proves that a given number of remote clients overloads a server
or exhausts the file descriptors on the system, set the Maximum Clients Per Server (-Ma)
parameter to limit clients per server below that level. A file descriptor is an object UNIX uses
to identify a particular file. The file descriptors might be exhausted because OpenEdge uses
them to identify sockets.
4–111
Maximum Area Number (-maxAreas)
Operating
system UNIX
and syntax Windows -maxAreas n
1. The minimum value is the current maximum area number in use for the database.
Maximum Area Number specifies the highest area number available for use during the time the
database is online. Increase the highest area number by shutting down and restarting the
database with a higher value, or remove the -maxAreas parameter to have the maximum number
available.
At database startup, the maximum area number specified with -maxAreas is compared to the
areas defined in the database. If any defined area has a higher area number, the database will not
start.
If the database is expanded with PROSTRCT ADDONLINE, the area numbers specified for any
new areas must be lower than the maximum area number specified with -maxAreas, or the
PROSTRCT ADDONLINE command will fail.
4–112
Maximum Dynamic Server (-maxport)
Operating
system UNIX
and syntax Windows -maxport n
You specify the lowest port number with the Minimum Dynamic Server (-minport) parameter.
The range of port numbers defined by the Maximum Dynamic Server (-maxport) and Minimum
Dynamic Server (-minport) parameters provides client access to an OpenEdge server that is
behind a firewall. Some operating systems choose transient client ports in the 32,768-to-65,535
range. Choosing a port in this range might produce unwanted results.
4–113
Maximum Dynamic DataServer (-dsmaxport)
Operating
system UNIX
and syntax Windows -dsmaxport n
You specify the lowest port number with the Minimum Dynamic DataServer Server
(-dsminport) parameter. The range of port numbers defined by the Maximum Dynamic
DataServer Server (-dsmaxport) and Minimum Dynamic DataServer Server (-
port) parameters provides client access to an OpenEdge server that is behind a firewall. Some
operating systems choose transient client ports in the 32,768-to-65,535 range. Choosing a port
in this range might produce unwanted results.
4–114
Maximum JTA Transactions (-maxxids)
Operating
system UNIX
and syntax Windows -maxxxids n
1. For a JTA-enabled database, the minimum value is (users)/2 where users is the value of the Number of Users
(-n) startup parameter. For a database not enabled for JTA, the minimum is 0.
JTA transactions rely on an external transaction manager to control transaction commit and
rollback. OpenEdge SQL supports the Java Transaction API (JTA) thus enabling the database
to function as a resource manager as defined in the J2EE framework architecture. Because the
transactions are controlled by an external transaction manager, they may take a long time to
complete.
For more information on distributed transactions with JTA, see OpenEdge Data Management:
Database Administration.
4–115
Network Message Compression (-mc)
Operating
system UNIX
and syntax Windows -mc
Client Session – – – –
Use Network Message Compression (-mc) only between OpenEdge clients and compatible
servers. If the client and server are not compatible, a communication error occurs. For more
information on specific compatibilities, contact Progress Software Corporation Technical
Support.
Message compression can improve message throughput by reducing network overhead within
the lower communication layers. This is more common on slower topologies, such as dial-up
and WAN configurations. Progress Software Corporation recommends that you proceed with
caution on faster, more optimized networks where network performance is higher. The high
per-packet processing cost of enabling compression can increase network latency as it improves
throughput. The net result could degrade the overall performance of the application.
4–116
Memory consistency check (-MemCheck)
Operating
system UNIX
and syntax Windows -MemCheck
Client — — – —
Connection,
Database
Server
Memory consistency check detects illegal operations in memory movement, such as a buffer
copy with a negative length of data, or a memory move to an incorrect location. The purpose
Memory consistency check is to prevent memory corruption.
Index and record block operations are checked prior to before-image note writing and the
subsequent database block write. The length of the intended operation is checked to prevent
operations that exceed database the block size.
Index block splits and index insert operations are checked at strategic points to monitor
consistency.
Memory consistency checking can be enabled or disabled while your database is online with
PROMON. See OpenEdge Data Management: Database Administration for more information.
Memory consistency check can be enabled for a single user client or for any offline utility. If
the utility is read-only, such as DBANALYS, the -MemCheck parameter is ignored. Online
utilities determine whether or not to perform memory consistency checking during execution
based on the use of -MemCheck at broker startup or by the enablement/disablement of the
memory consistency checking in PROMON.
4–117
Delayed BI File Write (-Mf)
Operating
system UNIX
and syntax Windows -Mf n
Database 32,768 0 01 3
Server
Any positive value delays OpenEdge from synchronously writing out to disk the last
before-image (BI) file records at the end of each transaction. On UNIX systems using
shared memory, it also specifies the interval that the broker process wakes up to make sure
all BI file changes have been written to disk. The default is 3 for single-user batch jobs and
for multi-user databases using shared memory. Otherwise, the default is 0.
Using the Delayed BI File Write (-Mf) parameter does not reduce database integrity. However,
if there is a system failure, it is possible the last few completed transactions will be lost (never
actually written to the BI file).
When running with full integrity, at the end of each transaction OpenEdge does a synchronous
write to disk of the last BI file block. This write guarantees that the completed transaction is
recorded permanently in the database. If the user is notified that the transaction has completed
and the system or database manager crashes shortly afterwards, the transaction is not lost.
Do not set the Delayed BI File Write (-Mf) parameter on a lightly loaded system with little
database update activity. Under these conditions, the extra BI write is very important and does
not impact performance. On a heavily loaded system, however, the BI write is less important
(the BI block will be written to disk very soon anyway), and has a significant performance
penalty. Setting the Delayed BI File Write (-Mf) parameter to delay this extra BI write saves
one write operation per transaction, which can significantly improve performance. The extra BI
file write is delayed by default for batch jobs.
If the Delayed BI File Write (-Mf) parameter is set to a positive value, the last BI file record is
only guaranteed to be written out to disk when a user logs out, or when the server or broker
process terminates normally. On multi-user systems, the n argument determines the maximum
length of time in seconds during which completed transactions can be lost.
4–118
Minimum Clients per Server (-Mi)
Operating
system UNIX
and syntax Windows -Mi n
Database – 1 – 1
Server
The number of remote users on a server before the broker starts another server. See also
the Maximum Servers (-Mn) startup parameter.
This parameter pertains only to multi-user versions of OpenEdge that use shared memory. In
addition, -Mi and -Mn apply only to databases accessed from remote network nodes.
As remote users enter the database, the broker process starts just one server process for each n
remote users, until the maximum number of servers (specified by the Maximum Servers (-Mn)
parameter) is started. If you specify a value of 1, the broker starts a new server for each of the
first -Mn remote users. Subsequent remote users are distributed evenly among the servers until
the maximum number of users (-n) or maximum clients per server (-Ma) limits are reached.
Typically, you can leave -Mi and -Mn at their default values. If you significantly increase -Mn,
you should also increase -Mi. For example, if you set -Mn to 10 to accommodate up to 40 or more
remote users, increase -Mi to 3 or 4 to prevent a situation where 10 servers were started for just
10 remote users.
4–119
Minimum Dynamic Server (-minport)
Operating
system UNIX
and syntax Windows -minport n
You specify the higher port number with the -maxport parameter. Ports below 1025 are usually
reserved for system TCP and UDP. The range of port numbers defined by the -maxport and
-minport parameters provides client access to an OpenEdge server that is behind a firewall.
This communication is possible only when the access to the server can be limited.
4–120
Minimum Dynamic DataServer (-dsminport)
Operating
system UNIX
and syntax Windows -dsminport n
You specify the highest port number with the Maximum Dynamic DataServer Server
(-dsmaxport) parameter. The range of port numbers defined by the Maximum Dynamic
DataServer Server (-dsmaxport) and Minimum Dynamic DataServer Server (-dsminport)
parameters provides client access to an OpenEdge server that is behind a firewall. Some
operating systems choose transient client ports in the 32,768-to-65,535 range. Choosing a port
in this range might produce unwanted results.
4–121
Message Buffer Size (-Mm)
Operating
system UNIX
and syntax Windows -Mm n
OpenEdge uses message buffers to move records (messages) between servers and remote
clients. Records (plus 40-byte headers) larger than the message buffer size are fragmented into
multiple messages. If your database records are large, increase this parameter to avoid record
fragmentation. However, if the network works more efficiently with small messages, reduce
-Mm and fragment larger records.
Note: On a given database, you must specify the same message buffers size when starting the
server or broker (using PROSERVE) and multi-user clients (using MPRO) and when
shutting down the database (using PROSHUT). That is, if you change the -Mm value on
any database command, you must change all PROSERVE command, MPRO command, and
PROSHUT commands accordingly. For more information, see OpenEdge Data
Management: Database Administration.
4–122
Maximum Memory (-mmax)
Operating
system UNIX
and syntax Windows -mmax n
The AVM dynamically allocates space for r-code segments in the execution buffer as needed.
When memory allocation reaches the value specified by the Maximum Memory (-mmax) value,
the AVM writes nonactive segments to the sort file to make room for new active procedures.
(the AVM writes library-stored r-code to the sort file only if you specified the PROLIB Swap
(-pls) startup parameter.) If you have large procedures or deeply nested procedure calls, you
can use -mmax to increase the initial size of the execution buffer to reduce disk I/O activity
required to swap segments to the sort file.
The -mmax value does not limit the amount of memory available for r-code segments. If the
AVM requires more space in the execution buffer and cannot regain enough space by swapping
inactive segments to the sort file, the AVM allocates more memory.
The -mmax limit is a soft limit; so if your application needs to exceed the limit, the AVM
automatically increases it and issues a WARNING message. The WARNING is written to the current
output (if there is current output) and to the log file (LG).
You can force OpenEdge to adhere to the specified -mmax limit by starting the session with the
Hardlimit (-hardlimit) startup parameter. When you use the -hardlimit startup parameter,
OpenEdge issues the WARNING message when you exceed the Maximum Memory limit. It also
issues a message that a resource limit was reached and raises an untrappable STOP condition.
Note also that -hardlimit also enforces the limits set by the Directory Size (-D) the Local
Buffer Size (-l), and the Nested Blocks (-nb) startup parameters. The STOP condition is raised
when any of the specified limits is reached.
Use Statistics (-y) and Segment Statistics (-yd) to see segment allocation information.
4–123
Maximum Servers (-Mn)
Note: The maximum value for the number of servers that may be started for a database is
limited by available resources of the operating system.
Operating
system UNIX
and syntax Windows -Mn n
Database –1 1 – 4
Server
The maximum number of remote client servers that can be started on the system. The value
specified is always incremented by 1 to provide a server for the primary login broker.
The performance tradeoff to consider is swapping overhead for many servers versus
overloading (slowing down) a server with too many clients. For more information on
controlling memory use, see OpenEdge Data Management: Database Administration.
This parameter pertains only to multi-user versions of OpenEdge that use shared memory. In
addition, this parameter applies only to databases that are accessed from remote network nodes.
Also, use Minimum Clients per Server (-Mi) to adjust the actual number of servers in use. See
the Maximum Clients Per Server (-Ma) and Minimum Clients per Server (-Mi) startup
parameters for more information.
4–124
Servers Per Protocol (-Mp)
Operating
system UNIX
and syntax Windows -Mp n
This parameter limits the number of servers that the broker can start to serve remote users for
any one protocol. The total number of servers for all protocols is still limited by the Maximum
Servers (-Mn) parameter.
4–125
Maximum Servers Per Broker (-Mpb)
Operating
system UNIX
and syntax Windows -Mpb n
Database – – – –
Server
4–126
VLM Page Table Entry Optimization (-Mpte)
Operating
system
and syntax Digital UNIX -Mpte
Database – – – –
Server
This function is a binary switch that is off by default. The -Mpte startup parameter turns the
function on.
4–127
Record Buffer Size (-Mr)
Operating
system UNIX
and syntax Windows -Mr n
The standard record buffer size in bytes. The default value of 1,012 bytes is appropriate in
nearly all cases.
On some systems, you can use Record Buffer Size (-Mr) to improve performance by varying the
standard record buffer size. However, the default value of 1,012 bytes is appropriate in nearly
all cases.
This parameter determines the maximum size of a record buffer the ABL client can hold in its
buffer cache. If you need to fetch a row that is larger than this value, then the AVM allocates a
new record buffer to hold the larger record and frees the buffer after the record buffer goes out
of scope. If you set this parameter too low, the client will spend more time allocating and freeing
memory. Set this parameter to be larger than the average size record the application will read
from the database.
4–128
User MUX Latches (-mux)
Operating
system UNIX
and syntax Windows -mux n
Database 1 0 – 1
Server
Client
Connection
Do not use this parameter unless directed to do so by Progress Software Technical Support.
4–129
Shared-memory Overflow Size (-Mxs)
Note: Starting in Release 10.1C, the OpenEdge RDBMS expands the range of internal
validations used to ensure database consistency in both index and data blocks during
forward processing. Validations using PROUTIL can be run online as part of routine
health checks. For more information, see OpenEdge Data Management: Database
Administration.
Operating
system UNIX
and syntax Windows -Mxs n
1. The maximum is limited only by the size of the signed integer data type on the system. If your system uses a 4 byte
integer, then the formula is: 16KB + (n*300). For all other systems, the formula is: 16KB + (n*400).
The overflow area is appended to the shared-memory area. This parameter is relevant only on
shared-memory systems.
If the overflow area is too small, OpenEdge exits with the following message:
Depending on the operating system, OpenEdge rounds the shared-memory area size to the next
512-byte or 4K boundary.
4–130
Number of Users (-n)
Operating
system UNIX
and syntax Windows -n n
Database 10,000 – – 20
Server
The maximum number of OpenEdge users on the system. After n users have connected to
the OpenEdge database, additional user startup attempts are rejected.
Note: The actual number of allowed users might be smaller than the value of this
parameter. The actual number of allowed users must be equal or less than the result
of the Maximum Servers (-Mn) multiplied by the Maximum Clients Per Server
(-Ma), using whole number values for those parameters.
On systems that do not use shared memory, use Number of Users (-n) to limit the total number
of users below the level that overloads the database server.
On shared-memory systems, -n must be high enough to include local and remote users as well
as background writers (APWs, BIWs, and AIWs), PROWDOG processes, and PROMON
sessions. For more information, see the Minimum Clients per Server (-Mi) and Maximum
Servers (-Mn) startup parameters.
4–131
Nap Time Increment (-napinc)
Operating
system UNIX
and syntax Windows -napinc n
Database – – – 10
Server
Do not use this parameter unless directed to do so by Progress Software Technical Support.
4–132
Nap Time Steps (-napstep)
Operating
system UNIX
and syntax Windows -napstep n
Database – – – 5
Server
Do not use this parameter unless directed to do so by Progress Software Technical Support.
4–133
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -nb n
By default, the maximum number of nested blocks is 50. Nested block entries are allocated in
memory; each requires 16 bytes. Therefore, decrease -nb only if memory is severely limited.
The -nb limit is a soft limit. If your application needs to exceed the limit, the AVM issues a
WARNING message and automatically increases the number of nested procedure blocks allowed.
The WARNING is written to the current output (if there is current output) and to the log file (LG).
You can force the AVM to adhere to the specified -nb limit by starting the session with the
Hardlimit (-hardlimit) startup parameter. When you use the -hardlimit startup parameter, the
AVM issues the WARNING message when you exceed the Nested Blocks (-nb) limit. It also issues
a message that a resource limit was reached and raises an untrappable STOP condition. Note that
-hardlimit also enforces the limits set by the Directory Size (-D), the Local Buffer Size (-l),
and the Maximum Memory (-mmax) startup parameters, so the STOP condition is raised when
any of the specified limits is reached.
4–134
No Lock (-NL)
No Lock (-NL)
Use No Lock (-NL) to have all record retrieval statements default to NO-LOCK record access.
Operating
system UNIX
and syntax Windows -NL
Client Session – – – –
In order to get the NO-LOCK default for any procedure, it must be compiled in an OpenEdge
session started with -NL. Running OpenEdge with -NL has no affect on precompiled procedures.
When a transaction ends, EXCLUSIVE locks are downgraded to SHARE-LOCK, regardless of the -NL
parameter.
4–135
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -noautoreslist
Client Session – – – –
• Defined using the DEFINE QUERY statement without the SCROLLING option
• Opened using the OPEN QUERY statement (but not previously defined using the DEFINE
QUERY statement)
• Not associated with a browse widget (and has not been changed into a scrolling query by
the DEFINE BROWSE statement)
When you specify this startup parameter, you cannot use the GET PREV, GET LAST, REPOSITION,
or BROWSE methods or statements with static non-scrolling queries. If you do, the AVM
generates an error. You can use the GET-FIRST( ) method and GET FIRST statement only on
newly opened queries, and you can use the GET NEXT statement and GET-NEXT( ) method freely.
If you specify this startup parameter and you open a static non-scrolling query with preselect or
sort, the AVM still builds a result-list in order to resolve the query.
Specifying this startup parameter has no affect on dynamic queries, since they are scrolling
queries by default.
Specifying this startup parameter can improve the performance of operations on queries.
4–136
No Check Temp-table Names (-nochkttnames)
Operating
system UNIX
and syntax Windows -nochkttnames
Client Session – – – –
When passing temp-table as a parameter to a procedure, the calling procedure’s temp-table and
the called procedure’s temp-table must match with respect to the number of columns, the data
type of each column, and the number of extents of each column (for columns with extents).
The AVM provides limited checking of temp-table column names when passing temp-tables as
parameters to procedures. That is, for any given column:
• If the name of a column in the calling procedure’s temp-table does not match any column
defined in the called procedure’s temp-table, the AVM processes the column.
• If the name and position of a column in the calling procedure’s temp-table matches a
column defined in the called procedure’s temp-table, the AVM processes the column.
• If the name of a column in the calling procedure’s temp-table matches a column defined
in the called procedure’s temp-table, but the positions do not match, the AVM reports an
error and the called procedure does not run.
Use the No Check Temp-table Names (-nochkttnames) parameter when you want the AVM to
process the temp-table without verifying column names.
4–137
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -noevalprops
Client – – – –
Connection
The reason for using this parameter is to avoid errors that can occur in the Debugger when it
executes the property’s accessor (GET) method. Such errors might occur, for example, if the
Debugger attempts to evaluate the property before the object is fully constructed. Certain side
effects of the property’s GET method can also lead to Debugger errors.
If you use this startup parameter, the Debugger displays “** Property evaluation
disabled **” for any property that has a GET method with an implementation. The parameter
has no effect on ABL properties with empty GET methods, which are always evaluated.
If property evaluation is disabled, you can use the Dataview dialog box to inspect the value of
a property. For more information, see OpenEdge Development: Debugging and
Troubleshooting.
4–138
No Garbage Collection (-nogc)
Operating
system
and syntax Windows -nogc
Client Session – – – –
For more information on garbage collection, see OpenEdge Development: ABL Reference and
OpenEdge Development: Object-oriented Programming.
4–139
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -nohostverify
Client – – – –
Connection
Without this parameter specified, the client compares the host name specified in the connection
with the Common Name specified in the server certificate, and raises an error if they do not
match. With this parameter specified, the client never raises the error.
For more information, see OpenEdge Getting Started: Core Business Services.
4–140
No Inactive Indexes (-noinactiveidx)
Operating
system UNIX
and syntax Windows -noinactiveidx
Client Session – – – –
4–141
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -noincrwarn
Client Session – – – –
The auto-increment messages, messages (5407) through (5410), warn about the automatic
resource usage increases by the Maximum Memory (-mmax), Nested Blocks (-nb), Local
Buffer Size (-l), and Directory Size (-D) startup parameters.
Note: Using the SESSION:SUPPRESS-WARNINGS attribute will suppress all warning messages
during a session, including auto-increment warnings. By using the No Auto-Increment
Warnings (-noincrwarn) startup parameter without the SESSION:SUPPRESS-WARNINGS
attribute, all normal warning messages display except the auto-increment warning
messages.
Caution: The auto-increment warnings may indicate a memory leak in your application,
resulting in excessive resource usage. The No Auto-Increment Warnings
(-noincrwarn) startup parameter does not stop this excess resource usage; it stops the
reporting of this condition.
4–142
Index Hint (-noindexhint)
Operating
system UNIX
and syntax Windows -noindexhint
DataServer – – – –
Generally, index hints improve performance, but ORACLE's responses to hints varies among
releases. This parameter is valid only when using the DataServer for ORACLE.
4–143
Startup Parameter Descriptions
No INT64 (-noint64)
Use No INT64 (-noint64) to execute Release 10.1B code with Release 10.1A executables.
Operating
system UNIX
and syntax Windows -noint64
Client Session – – – –
• ABL source code references to INT64 variables and fields generate errors.
• The XML schema long data type (64-bit signed integer) maps to the ABL DECIMAL data
type rather than the INT64 data type. This mapping applies to:
Notes: Using the -noint64 startup parameter does not guarantee that your r-code will run in
Release 10.1A. You must first make sure that your code does not include any 10.1B
features. However, if you have procedure (.p) files that run in Release 10.1A and you
recompile them without any changes in Release 10.2B with the -noint64 startup
parameter, the procedures still run in Release 10.1A.
The -noint64 startup parameter does not affect performance. The arithmetic
operations in Release 10.1A and earlier code are calculated using the INTEGER data
type while those in Release 10.1B and higher are calculated using the INT64 data type.
4–144
Server Join (-nojoinbysqldb)
Operating
system UNIX
and syntax Windows -nojoinbysqldb
DataServer – – – –
This might slow performance, but provides results that are consistent with OpenEdge behavior.
It also allows you to run DataServer applications on Version 9 clients with Version 8 servers. It
overrides the DataServer default behavior, which is to instruct the non-OpenEdge server to
perform the join.
4–145
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -nosessioncache
Database – – – –
Server
Session caching allows a client to reuse a previously established session if it reconnects prior to
the session cache timeout expiring. Use No Session Cache (-nosessioncache) to disable this
feature. Session caching is enabled by default.
4–146
No Session Reuse (-nosessionreuse)
Operating
system UNIX
and syntax Windows -nosessionreuse
Client – – – –
Connection
For more information, see OpenEdge Getting Started: Core Business Services.
4–147
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -noSQLbyserver
DataServer – – – –
4–148
No UDF in WHERE Clause (-noudfinwhere)
Operating
system UNIX
and syntax Windows -noudfinwhere
Client Session – – – –
4–149
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -numdec numeric-value
numeric-value
The numeric value of the character that represents the decimal point.
The AVM converts numeric-value to its character equivalent using the code page
corresponding to the Internal Code Page (-cpinternal) startup parameter.
In the following example, -numdec is used to change the decimal point in formatted text to a
comma (which, in the ISO8859-1 code page, has a numeric value of 44):
-numdec 44
4–150
Number of Log Files to Keep (-numlogfiles)
Operating
system UNIX
and syntax Windows -numlogfiles n
Client Session – – 3 3
If you specify a value of 1, a run-time error occurs and the OpenEdge process terminates.
Use the Log Threshold (-logthreshold) startup parameter to specify the file size at which
OpenEdge renames and saves log files.
Use the Client Logging (-clientlog) startup parameter to specify a log file name for ABL clients.
Use the DataServer Logging (-dslog) startup parameter to specify a log file name for server
context of a DataServer client or agent.
You also can use the NUM-LOG-FILES attribute on the LOG-MANAGER system handle to specify the
number of log files to keep. For more information, see OpenEdge Development: ABL Reference.
4–151
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -numsep numeric-value
numeric-value
The numeric value of the character that represents the thousands separator.
The AVM converts numeric-value to its character equivalent using the code page
corresponding to the Internal Code Page (-cpinternal) startup parameter.
Note: You can represent the thousands separator with the space character.
In the following example, -numsep is used to change the thousands separator in formatted text
to an apostrophe (which, in the ISO8859-1 code page, has a numeric value of 39):
-numsep 39
4–152
Printer (-o)
Printer (-o)
Specifies the printer to use.
Operating
system UNIX
and syntax Windows -o printername
printername
Identifies the printer to use when processing the OUTPUT TO PRINTER statement in
procedures.
In Windows, use Printer (-o) followed by the name of the printer port. For example:
-o LPT1
If you do not use the -o parameter, the AVM uses the printer specified as the default printer.
On UNIX, use Printer (-o) followed by the name of the spooler and any necessary parameters.
If you do not use the -o parameter, the AVM defaults to lp (System V) or lpr (BSD). If you are
passing arguments with this parameter and are using a script such as PRO or one of your own,
enclose the entire string in quotes so the argument to -o is returned as a single value when
passed to the OpenEdge module. For example:
-o "lp -s"
The AVM uses the spooler or printer port named at execution time rather than using the name
at compile time. That way, precompiled procedures work regardless of which spooler or printer
port is in effect.
To use a print spooler with spooler parameters, use OUTPUT TO PRINTER and specify the spooler
parameters with -o, as in the following commands:
4–153
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -ojmode n
Client Session 2 1 1 1
Mixing inner and left outer joins lets you filter and reduce the amount of data you see on the left
side of your left outer joins. When mixing these two types of join, inner joins take precedence
over left outer joins. That is, the last inner join in a query causes the results of a prior outer join
in the query to be like an inner join. This is because any rows that contain missing data from a
prior left outer join are eliminated by the following inner join, if the data from that inner join is
also missing. If the subsequent inner join has data, rows containing missing data from the prior
left outer join are not eliminated.
If you set the value of -ojmode to 1, mixed inner and left outer joins in queries of three or more
joined tables are processed as described above. Use this join mode when you want to see rows
that contain missing data from a prior left outer join and existent data from a subsequent inner
join. This is the default join mode.
If you set the value of -ojmode to 2, left outer joins take precedence over inner joins. That is,
any rows that contain missing data from a prior left outer join are not eliminated by a subsequent
inner join, whether the data from that inner join is missing or not. Use this join mode when you
want to see rows that contain missing data from both a prior left outer join and a subsequent
inner join.
Note: In any query, keeping your inner joins contiguous on the left with any left outer joins
contiguous on the right will produce the same result in either join mode.
4–154
Storage Object Cache Size (-omsize)
Operating
system UNIX
and syntax Windows -omsize n
4–155
Startup Parameter Descriptions
Password (-P)
Use Password (-P) together with the User ID (-U) to specify the user password.
Operating
system UNIX
and syntax Windows -P password
Client – – – –
Connection
password
OpenEdge checks the _User table for the user ID supplied with the -U parameter. When it finds
that user ID, it compares the password supplied with the -P parameter with the password in the
_User table. If the two passwords match, OpenEdge establishes the database connection.
With certain DataServers, the -P and -U parameters pass DataServer login information to the
non-OpenEdge database. For information, see your DataServer documentation.
4–156
Startup Procedure (-p)
Operating
system UNIX
and syntax Windows -p filename
filename
A common use for the -p parameter is to run an ABL procedure that displays a main application
menu. The user can then choose options from the menu to run other ABL procedures. As a
built-in security measure, when users press CTRL+C while running a procedure specified by -p,
the AVM prevents the users from accessing the Procedure Editor by rerunning the specified
procedure (unless the application explicitly allows Procedure Editor access).
If you use the Batch (-b) startup parameter (MBPRO or BPRO), also use the -p parameter.
4–157
Startup Parameter Descriptions
Parameter (-param)
Use Parameter (-param) to specify a character string that can be accessed from ABL procedures.
Operating
system UNIX
and syntax Windows -param string
Client Session – – – –
string
You can also use this parameter to specify one or more files to load into Procedure Editor
buffers. The Procedure Editor only loads the specified files when you use this parameter with a
startup command that places you directly in the Procedure Editor. The files are not loaded when
you use the parameter with a startup command that places you in the OpenEdge Application
Development Environment (ADE) desktop. Within an ABL procedure, you can access the
string by reading the PARAMETER attribute of the SESSION system handle.
4–158
Prompt for Passphrase (-Passphrase)
Operating
system UNIX
and syntax Windows -Passphrase
Database – – – –
Server
Client
Connection
Database utilities and servers, and non-networked self-service clients indicate that they require
a prompt for key store authentication by adding Prompt for Passphrase (-Passphrase) to the
command line. Prompt for Passphrase (-Passphrase) prompts for the key store passphrase. If
you cannot successfully authenticate the key store, you can not open the database.
For more information on Prompt for Passphrase, and Transparent Data Encryption in general,
see OpenEdge Getting Started: Core Business Services and OpenEdge Data Management:
Database Administration.
4–159
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -PendConnTime n
Database Server – – – 0
When a client attempts to connect to an OpenEdge database, the RDBMS assumes that if the
client can reach the broker, it can also reach the server. Network problems or incorrect
configuration of network devices can prevent the client from reaching the server. In such an
instance, the broker, unaware that the client’s connection failed, continues to increment its count
of connected users. To prevent this problem, OpenEdge brokers use a “reservation” count on
each server and they increment this count whenever they redirect a client to that server.
When -PendConnTime is used, the servers examine the timestamp on the latest reservation and,
if the Pending Connection Time period has elapsed, the broker assumes that the client has failed
to connect. The broker then clears the reservation, making the server available for new clients.
4–160
Parameter File (-pf)
Operating
system UNIX
and syntax Windows -pf filename
Client Connection, – – – –
Client Session,
Database Server,
DataServer
filename
The name of a parameter file that contains startup parameters to run OpenEdge.
This parameter is especially useful if you regularly use the same parameters to start OpenEdge,
or if more parameters are specified than can fit on the command line. This parameter can be
included within the parameter file itself to reference another parameter file.
Use multiple instances of -pf to name multiple parameter files. This allows you to specify
application-specific parameters in one parameter file, database-specific parameters in a second
parameter file, and user-specific parameters in yet another file.
4–161
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -pica n
Database 8192 4 – 16
Server
The database service communications area is used to store after-image block write notifications
intended for OpenEdge Replication.
4–162
Pin Shared Memory (-pinshm)
Operating
system UNIX
and syntax Windows -pinshm
Database – – – –
Server
4–163
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -plm
Client Session – – – –
Otherwise, when using a standard library, the library’s internal directory is loaded into memory.
The directory is used to access the r-code files stored in the library. This parameter slows the
library’s speed of access but increases available memory. If you specify -plm with
memory-mapped libraries, the AVM ignores it. For more information on r-code libraries, see
OpenEdge Deployment: Managing ABL Applications and OpenEdge Getting Started: ABL
Essentials.
4–164
PROLIB Swap (-pls)
Operating
system UNIX
and syntax Windows -pls
Client Session – – – –
Usually, OpenEdge opens the library file and loads the required r-code segments into the r-code
execution buffer. When OpenEdge needs to make space, the segment is removed from the
execution buffer. Later, if that segment is needed again, OpenEdge re-reads the segment from
the open library which remains in the execution buffer until the end of your OpenEdge session
or until you remove the library from the PROPATH.
This process is generally faster than loading the r-code segment from the r-code swap file.
However, if the procedure library is accessed over a network, reading r-code segments once and
storing them locally in the r-code swap file might be more efficient.
Note: Codepage-converted text segments from a standard procedure library are always
swapped to the r-code swap file, whether or not you specify -pls.
If you specify -pls with memory-mapped procedure libraries, the AVM ignores it. For more
information on procedure libraries, see OpenEdge Deployment: Managing ABL Applications
and OpenEdge Getting Started: ABL Essentials.
4–165
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -populate
Client – – – –
Connection
4–166
Preload CLR (-preloadCLR) startup parameter
Operating
system
and syntax Windows -preloadCLR
Client Session – – – –
If you do not specify -preloadCLR, the AVM loads the CLR the first time ABL refers to, or uses,
a .NET type or object either at compile time or runtime. The individual assemblies are loaded
as needed.
If you specify -preloadCLR and the client machine does not have an appropriate version of the
.NET framework installed, OpenEdge raises an error and shuts down.
For more information on accessing .NET objects using the ABL, see OpenEdge Development:
GUI for .NET Programming. For information on the .NET CLR, refer to the Microsoft .NET
Framework documentation.
4–167
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -properties filename
Database – – – –
Server
filename
4–168
Proxy Host (-proxyhost)
Operating
system UNIX
and syntax Windows -proxyhost { host-name | IP-address }
Client – – – –
Connection
host-name
The name of the host at which the HTTP-based proxy server is located.
IP-address
The IP address of the host at which the HTTP-based proxy server is located.
Note: If you specify the Proxy Host (-proxyhost) parameter, you must also specify the
Proxy Port (-proxyport) parameter.
When binding to a WSDL file via the server object’s CONNECT( ) method, all connections
made using the HTTP or HTTPS protocol connect to the proxy server at the specified host and
port.
When you specify this parameter, all connections made by an AppServer client using the HTTP
or HTTPS protocol connect to an AppServer Internet Adapter (AIA) instance using the proxy
server at the specified host and port.
4–169
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -proxyPassword password
Client Session – – – –
password
Password used to authenticate the AppServer client to the HTTP-based Proxy server.
password can be a string of up to 512 printable ASCII characters.
If -proxyhost and -proxyport are not specified on the command line to the OpenEdge client,
any value for -proxyPassword, whether specified with the startup parameter or with the
SESSION attribute, is ignored.
password is validated during the AppServer CONNECT() method. If the password is invalid, the
CONNECT() method fails and the AVM issues an error message.
4–170
Proxy Port (-proxyport)
Operating
system UNIX
and syntax Windows -proxyport { port-number }
Client 65536 1 – –
Connection
port-number
When you specify this parameter, all connections made by an AppServer client using the HTTP
or HTTPS protocol connect to an AppServer Internet Adapter (AIA) instance using the proxy
server at the specified host and port.
When binding to a WSDL file via the server object’s CONNECT( ) method, all connections
made using the HTTP or HTTPS protocol connect to the proxy server at the specified host and
port.
Note: If you specify the Proxy Port (-proxyport) parameter, you must also specify the Proxy
Host (-proxyhost) parameter.
4–171
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -proxyUserid user-id
Client Session – – – –
user-id
user-id used to authenticate an AppServer client to the HTTP-based proxy server. The
user-id can be a string of up to 512 printable ASCII characters, including the space
character.
If -proxyhost and -proxyport are not specified on the command-line to the OpenEdge client,
any value for the -proxyUserid, whether specified with the startup parameter or with the
SESSION attribute, is ignored.
The user-id is validated during the AppServer CONNECT() method. If user-id is invalid, the
CONNECT() method fails and the AVM issues an error message.
4–172
Quick Request (-q)
Operating
system UNIX
and syntax Windows -q
Client Session – – – –
Ordinarily in an ABL procedure, when the RUN statement is used to run a subprocedure, the
AVM searches the directories named by the PROPATH environment variable, looking for a
procedure of the same name with a .r extension. If it finds a file with a .r extension (an r-code
file), it checks to make sure the r-code file has not changed since that r-code file was created.
This search is very useful in a development environment where procedures change regularly and
you want to make sure you are always running the most current version of your application.
However, in a production environment, you might want to bypass this search.
With Quick Request (-q), after the initial search, if the procedure still resides in memory or in
the local session-compiled file, the AVM uses that version of the procedure rather than
searching the directories again. However, the AVM always checks whether Data Dictionary
definitions related to a procedure were modified. If they were modified, the AVM displays an
error when it tries to retrieve the procedure.
4–173
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -r
Caution: If you run OpenEdge with the -r parameter and your system fails because of a system
crash or power failure, you cannot recover the database. You must restore the
database from a backup and restart processing from the beginning. If you are
updating a database using buffered I/O and there is an OpenEdge system failure, but
no hardware failure, OpenEdge can recover the database.
In general, you always want complete database integrity or you want fast performance for large
tasks, such as loading large amounts of data or doing fiscal year-end processing. The -r
parameter does not guarantee complete database integrity, and No Crash Protection (-i) is faster
in terms of performance.
4–174
Alternate Random Number Generator (-rand)
Operating
system UNIX
and syntax Windows -rand n
Client Session 2 1 1 1
The type of random number generator. A value of 1 (the default) indicates that OpenEdge
should use the original generator; specify a value of 2 to use the alternate.
The original number generator always generates the same random sequence; that is, the
numbers that it generates are random, but each time a session starts, it gives you the same set of
numbers from the last session. If you have to generate a different sequence of random numbers,
specify the alternate generator. This generator returns a number from a pseudorandom
sequence of numbers rather than a truly random sequence.
4–175
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -requireusername
Client – – – –
Connection
This parameter ensures that only valid users are able to start an AdminServer.
4–176
Reread Nolock (-rereadnolock)
Operating
system UNIX
and syntax Windows -rereadnolock
Client Session – – – –
The AVM stores records read from the database in internal buffers that are linked to the record
buffers of your ABL application. When two internal buffers for the same record exist, the AVM
decides which to keep and use by rules based on the locking level and age of each copy. This
parameter only affects how the decision is made when both of the following conditions are true:
• The AVM finds an older NO-LOCK copy of that same record already in memory.
For more information on record locking, see the chapter on data handling and record locking in
OpenEdge Getting Started: ABL Essentials.
Note: This parameter causes no extra database activity; it simply determines whether to keep
the older or newer of the copies already in memory.
You use this parameter to resolve client-server currency conflicts. You also use it to resolve
server-to-server currency conflicts by using it as an AppServer startup parameter through the
Progress Explorer or by setting the srvrStartupParam property in the ubroker.properties
file for the appropriate AppServer. When applications use record buffers with a large scope,
such as default buffers scoped to the main block of long life persistent procedures as you might
have on an AppServer, using -rereadnolock is strongly advised.
• It has no affect on records that are retrieved through RECID or ROWID. In that case, the
AVM will not re-read the record. Instead, it uses the copy of the record already stored in
the buffer. If you need the most current version of the record, use the RELEASE statement
on all buffers that contain a copy of the record before reading the record, or use the FIND
CURRENT or GET CURRENT statement to re-read the record.
• It has no affect on the behavior of the query cache used for a query with NO-LOCK that
is specified through the CACHE phrase of the DEFINE QUERY statement. To force the
AVM to always re-read the record, set the cache size to zero (0). However, this may
significantly degrade performance if the database is accessed across a network. Set the
cache size to zero only when it is critical to retrieve the most current version of a record.
4–177
Startup Parameter Descriptions
• It has no affect on the behavior of the prefetch cache that is used by default when retrieving
records NO-LOCK across the network. By default, when executing a CAN-FIND function
or a FIND, FOR, or OPEN QUERY statement on a database that is accessed across a
network, the AVM fetches several records at a time and stores them in a prefetch cache.
The AVM will only send a request to the database server to fetch more records if the
requested record is not in the current prefetch cache. If the record is in the current cache,
the AVM will not read a new copy of that record even if -rereadnolock is set. To eliminate
this cache so that the most current version of the record is always read, use the
NO-PREFETCH keyword in the appropriate statements. However, using the
NO-PREFETCH keyword may significantly degrade performance. Set NO-PREFETCH
only if it is critical to retrieve the most current version of a record.
4–178
Re-usable Objects Cache (-reusableObjects)
Operating
system UNIX
and syntax Windows -reusableObjects cache-size
cache-size
This parameter can improve the performance of applications that use ABL classes. When a class
object is deleted, either by the DELETE OBJECT statement or through garbage collection, the
AVM caches the object. When the AVM instantiates the same class later, the stored object is
re-initialized and removed from the cache. This re-use saves much of the overhead of
instantiating a class.
Note: The cache only stores class-based objects. However, it does not store .NET classes,
.NET-derived ABL classes, classes with STATIC elements, or session-compiled
classes.
The cached class objects continue to hold some resources. You might want to modify the
settings of Directory Size (-D) and Maximum Memory (-mmax) to account for the number of
cached objects. For more information on the re-use of objects, see the DELETE OBJECT
statement in OpenEdge Development: ABL Reference and the section on object life-cycle in
OpenEdge Development: Object-oriented Programming.
4–179
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -rg
Client Session – – – –
Use this parameter if you have more than one type of OpenEdge client and want to limit
access/functionally of the session to the ABL client.
4–180
Read-only Media (-RO)
Operating
system UNIX
and syntax Windows -RO
Client – – – –
Connection
Note: Do not run servers for a read-only database. OpenEdge does not support servers for
read-only users.
If you use the -RO parameter when other users are updating the database, you might see invalid
data, such as stale data or index entries pointing to records that have been deleted.
A read-only session is essentially a single-user session. Read-only users do not share database
resources (database buffers, lock table, index cursors). However, unlike a normal single-user
database, a read-only database can be simultaneously accessed by multiple -RO users.
When a read-only session starts, it does not check for the existence of a lock file for the database.
Furthermore, a read-only user opens the database file, but not the log or before-image files.
Therefore, read-only user activity does not appear in the log file.
If a database is opened with -RO, the string returned by the DBRESTRICTIONS function includes
the keyword READ-ONLY.
4–181
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -rq
Client Session – – – –
Use this parameter if you have more than one type of OpenEdge client and want to limit access
or functionality of the session to the Query client.
4–182
Run Run-time Client (-rr)
Operating
system UNIX
and syntax Windows -rr
Client Session – – – –
Use this parameter if you have more than one type of OpenEdge client and want to limit access
or functionality of the session to the Run-time Client.
4–183
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -rx
Client Session – – – –
If OpenEdge is started with -rx, you can only compile encrypted source code. Use -rx when
you are shipping an application in the form of encrypted source code to end-user sites having
query or run-time versions of OpenEdge. You must prepare a tool that end users can run to
compile your code, and this tool must include a command that invokes OpenEdge with -rx.
4–184
Service Name (-S)
Operating
system UNIX
and syntax Windows -S { service-name | port-number }
Client Connection, – – – –
Database Server
service-name
port-number
The port number of the host; if using Progress Explorer, the port number of the
NameServer.
The system administrator must make an entry in the services file that specifies the server or
broker name and port number.
When the broker spawns a server, the server inherits all of the network parameters (except the
Service Name parameter) from the broker. Because there is no restriction on the number of
brokers you can start, you can have multiple brokers running with different network parameters.
See also the Server Group (-servergroup) startup parameter description.
Table 4–4 shows how the broker, server, and remote client interpret each of their parameters
when you use the -S parameter.
Module Interpretation
Broker Parameters apply to the connections on which the broker is listening for
connection requests from remote clients
Server Parameters apply to the connection between the server and the remote
client
Remote Client Parameters identify the connection parameters to the broker or the server
To run multi-user OpenEdge from a remote network node, use both the Host Name (-H) and
Service Name (-S) parameters.
4–185
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -s n
Client 5,242,8781 9 40 40
Session
Note: It is recommended that the -s session startup parameter be set to 128. Setting this
startup parameter to a smaller value may result in runtime errors in some
environments.
Stack overflow errors are most likely when data definitions are loaded for very large tables or
use recursive procedures.
Note: If your application passes array parameters to procedures or functions, your stack size
requirements can increase significantly.
4–186
Screen-value Mode (-scrvalmode)
Operating
system
and syntax Windows -scrvalmode n
Client – – 0 0
Session
Prior to OpenEdge R10.0, the SCREEN-VALUE attribute for a combo-box returns the empty
string ("") if the selected item in the list is empty. Starting with Release 10.0, the
SCREEN-VALUE attribute for a combo-box returns the Unknown value (?) if the selected item
in the list is empty. In either case, if no item in the combo-box list is selected, the
SCREEN-VALUE attribute returns the Unknown value (?).
4–187
Startup Parameter Descriptions
Operating
system
and syntax UNIX -semsets n
Database Maximum 1 – 3
Server Number of
Users +1
An INTEGER specifying the number of semaphore sets available to the OpenEdge broker.
When more than 1,000 users connect to a single database, there might be high contention for the
semaphore set. If there is a lot of semaphore contention on a system, using multiple semaphore
sets helps alleviate this contention and improve performance on high user counts.
For more information on using semaphore sets, see OpenEdge Data Management: Database
Administration.
4–188
Server Group (-servergroup)
Operating
system UNIX
and syntax Windows -servergroup name
Database – – – –
Server
name
The name you specify must match the name of a servergroup in the conmgr.properties file.
Use the Progress Explorer tool to create servergroups and save them in the conmgr.properties
file. Do not edit the conmgr.properties file directly. To start a database configuration use
Progress Explorer or the DBMAN utility.
Note: You can use the mergeprop utility installed with OpenEdge to edit the
conmgr.properties file. For information on using mergeprop, see OpenEdge Getting
Started: Installation and Configuration.
4–189
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -ServerType [4GL|SQL|Both]
4GL
SQL
Both
To change the value of -ServerType, use the config.properites file or the command line.
4–190
Session Timeout (-sessiontimeout)
Operating
system UNIX
and syntax Windows -sessiontimeout n
Database – – – 180
Server
Specifies in seconds the length of time a SSL session will be held in the SSL session cache.
The default is 180 seconds.
SSL session caching allows a client to reuse a previously established SSL session if it
reconnects prior to the SSL session cache timeout expiring.
4–191
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -shmsegsize n
256 –
512 –
1024 1g
2048 2g
4096 4g
4–192
Shared memory segment size (-shmsegsize)
2048 2g
4096 4g
8192 8g
16384 16g
32768 32g
1. You must include the “g” if you specify the value in gigabytes.
The shared memory segment size can impact performance. Increasing the segment size
decreases the number of segments allocated and reduces the resources needed to manage the
segments. See OpenEdge Data Management: Database Administration for more information.
4–193
Startup Parameter Descriptions
Note: Starting with Release 10.1B, this startup parameter has no effect; it is supported only
for backward compatibility.
Operating
system UNIX
and syntax Windows -showppuerr
Client Session – – – –
Prior to Release 10.1B, the AVM and the compiler raise warning message 4132 when an ABL
program tries to set a column or width attribute to a value greater than 320. The AVM or the
compiler resets the column or width attribute value to 320 and suppresses the associated
warning message.
• At compile time, the compiler raises warning message 4132 when an ABL program tries
to set a column or width attribute to a value greater than 320. The AVM resets the column
or width attribute value to 320 and the compiler generates the associated warning message
(for example: Invalid character unit value 200,000. Changed to 320.).
• At run time, the AVM raises warning message 13734 (“Invalid character unit value
%|<value>. Changed to %|<max>.”) when an ABL program tries to set a column or width
attribute to a value greater than 131,072. The AVM resets the column or width attribute
value to 131,072 and the AVM generates the associated warning message (for example:
Invalid character unit value 200,000. Changed to 131,072.).
Note: The AVM stores column and width values in the internal storage format called
Progress Portability Units (PPU).
4–194
AS/400 Server Program Name (-Sn)
UNIX
Operating Windows
system
and syntax (SNA Only) -Sn
Client – – – –
Connection
4–195
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -spin n
Database – 0 0 10,000, or
Server 6000 * # CPUs1
1. For single CPU systems, the default is 10,000. For multi-CPU systems, the default is 6000 * # of CPUs
If the value of n is greater than 0, then a spin lock algorithm is used for shared-memory data
structures. When a process has to lock a shared-memory structure, the process tries up to n times
to acquire the latch for that structure. If it has not acquired the latch in n tries, the process pauses,
or naps. The length of the pause increases gradually if the process repeatedly fails to acquire a
latch. After the allotted nap time, the process wakes up and tries to acquire the lock again. If it
fails to acquire the lock, it will retry up to the number of tries specified by n.
If the value of n is 0, a system of semaphores and queues is used instead of spin locks. The spin
lock algorithm is much more efficient than using semaphores when you have multiple
processors.
On multi-processor machines, the default value is 6000 * # of CPUs. If this causes too much
CPU usage, reduce the value. If you have fast processors, a value as high as 10,000 * # of CPUs
might be effective.
You can evaluate the -spin values through the OpenEdge Monitor (PROMON utility) R&D
options. See OpenEdge Data Management: Database Administration for more information on
the PROMON utility. The -spin parameter controls the performance indicator called resource
waits. By setting the -spin value higher, you can reduce the resource waits. Note that when
setting the -spin value higher ceases to reduce the resource waits, continuing to set it higher
can adversely effect CPU utilization. To view the resource waits value:
• Choose option 3. Other Displays, then choose option 1. Performance Indicators to view
the resource waits. Resource waits is the last item reported in the listing.
4–196
SQL Open Cursors (-SQLCursors)
Operating
system UNIX
and syntax Windows -SQLCursors value
SQL 512 10 – 50
value
4–197
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -SQLStack n
SQL System 1 1 1
Dependent
4–198
SQL Statement Cache Size (-SQLStmtCache)
Operating
system UNIX
and syntax Windows -SQLStmtCache n
SQL – – – 100
4–199
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -SQLTempBuff value
value
4–200
SSL-based Connection (-ssl)
Operating
system UNIX
and syntax Windows -ssl
Client – – – –
Connection,
Database
Server
Note: Be sure you need SSL before using this parameter. SSL incurs more or less heavy
performance penalties, depending on resources and load.
For more information, see OpenEdge Getting Started: Core Business Services.
4–201
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -stsh n
Client Session 31 1 2 2
The default size is sufficient for most index fields, but large character fields with a word index
might require more space.
You can calculate an appropriate stash size by taking the size in bytes of the largest field with a
word index, doubling that value, and adding 1KB. For example, if the largest word indexed field
is 2,000 characters long, set -stsh to 5 to create a stash area of 5KB. If you do not allocate
enough space, OpenEdge terminates with a fatal error. If this occurs, restart OpenEdge with a
larger stash area.
4–202
Temporary Directory (-T)
Operating
system UNIX
and syntax Windows -T dirname
dirname
If you do not use this parameter, OpenEdge creates these temporary files in the current working
directory. On UNIX and Windows, these filenames begin with a prefix of lbi, dbi, pge, srt, or
trp, followed by a number. On UNIX, the number is the process ID of the user’s OpenEdge
session. Windows uses a random number.
Note: Access the -T parameter using the SESSION:TEMP-DIR attribute. This attribute is
read-only.
On UNIX, OpenEdge names these files uniquely for each user to avoid filename conflicts.
Furthermore, OpenEdge stores these files as “unlinked” with no visible name in the UNIX file
system (unless you use Save Temp Files (-t).
In Windows, if two or more users share the same working directory and there is a conflict of
temporary files, the following message appears:
4–203
Startup Parameter Descriptions
Operating
system
and syntax UNIX -t
Client Session – – – –
With or without the -t parameter, OpenEdge always deletes the temporary files when it
terminates normally.
If you are running a Windows ABL client against a database with transparent data encryption
enabled, be aware that encrypted table data is stored in decrypted form inside the OpenEdge
temporary files. Protect the OpenEdge temporary files, as well as any application-generated
temporary files, using operating system security such as built-in file encryption or a third party
products.
You cannot use Save Temp Files (-t) with an encryption-enabled database. If you try to start
an encryption-enabled database with -t, the following error occurs:
4–204
Table consistency check (-TableCheck)
Operating
system UNIX
and syntax Windows -TableCheck [owner-name.]tablename
Client — — – —
Connection,
Database
Server
owner-name
Specifies the owner of the table you want to check. You must specify an owner name
unless the table’s name is unique within the database, or the table is owned by PUB. By
default, ABL tables are owned by PUB.
tablename
Table consistency check validates a block is still physically correct after an operation has been
performed.
You can only specify one table with -TableCheck. To check multiple tables, you must apply
consistency checking to the entire database with Database consistency check (-DbCheck) or if
multiple tables are in one area, you can apply consistency checking to an entire area with Area
consistency check (-AreaCheck).
Table consistency checking can be enabled or disabled while your database is online with
PROMON. See OpenEdge Data Management: Database Administration for more information.
Table consistency check can be enabled for a single user client or for any offline utility. If the
utility is read-only, such as DBANALYS, the -TableCheck parameter is ignored. Online
utilities determine whether or not to perform table consistency checking during execution based
on the use of -TableCheck at broker startup or by the enablement/disablement of the table
consistency checking in PROMON.
4–205
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -tablerangesize n
Database – – – –
Server
The number of tables for which you want to track access statistics.
For more information on tracking table statistics, see OpenEdge Data Management: Database
Administration.
4–206
Speed Sort (-TB)
Operating
system UNIX
and syntax Windows -TB blocksize
Client 31 1 8 8
Session
blocksize
The block size in kilobytes, to allocate when sorting records for reports and when
rebuilding indexes. The default block size is 8K but can be reset anywhere from 1KB to
31KB.
If you increase the block size beyond 8KB, OpenEdge sorts records faster but uses more
memory and disk space in the process. If system memory is severely limited, you might actually
choose to lower the block size.
Sort space is allocated in the SRT file, a temporary session file having a system-generated unique
name with the prefix srt. OpenEdge uses the SRT file to store session-compile modules, to swap
r-code segments into and out of the in-memory execution buffer, and as temporary work space
during sorting (including rebuilding indexes). Use -TB to set the SRT file block size (that is, the
increments by which the SRT file grows).
See also the Merge Number (-TM), Maximum Memory (-mmax), and PROLIB Swap (-pls)
startup parameters.
4–207
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -tstamp
Client – – – –
Connection
Note: Progress Software Corporation recommends that you use CRC instead of time stamp.
When precompiling a procedure, the AVM inserts in the r-code file a list of referenced tables
and their cyclic redundancy code values (CRCs) by default. At run time, OpenEdge compares
the CRCs in the r-code to those in the database being run against. If the CRCs do not match,
OpenEdge returns an error message.
Notes: To use time stamp values rather than CRC values, specify Time Stamp (-tstamp) for
the process that compiles the procedures.
For more information on time stamp and CRC values, see OpenEdge Deployment: Managing
ABL Applications.
4–208
Temp-table Schema Marshal (-ttmarshal)
Operating
system UNIX
and syntax Windows -ttmarshal n
Client Session – – – –
A value between 0 and 4 representing the amount of schema information to marshal for
temp-table parameters. The default value is 0 (which includes all schema information for
all temp-table parameters).
Value Description
You can override this startup parameter setting for an individual temp-table parameter by setting
one of the following attributes on the Temp-Table object handle:
• SCHEMA-MARSHAL attribute
• MIN-SCHEMA-MARSHAL attribute
• NO-SCHEMA-MARSHAL attribute
Note: If you specify more than one of these attributes for an individual temp-table, the AVM
uses the attribute you most recently specified. The MIN-SCHEMA-MARSHAL and
NO-SCHEMA-MARSHAL attributes are supported only for backward compatibility. Use the
SCHEMA-MARSHAL attribute instead.
For more information about these attributes, see OpenEdge Development: ABL Reference.
4–209
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -TM n
Client Session 32 1 5 5
The number of blocks or streams to be simultaneously merged during the sort process.
See also the description of the Speed Sort (-TB) startup parameter.
4–210
Temporary Table Database Block Size (-tmpbsize)
Operating
system UNIX
and syntax Windows -tmpbsize n
Client Session – – 4 4
An INTEGER that specifies the temp-table database block size. Valid values are:
• 4 — Sets the block size to 4096 bytes. This is the default value.
The temp-table database block size dictates the size of each buffer in the temp-table database
buffer pool for the current OpenEdge session.
Use Number of Buffers for Temporary Tables (-Bt) to specify the number of buffers in the
temp-table database buffer pool.
Note: With the changes made in Release 10.1B to provide support for expanded keys and
temp-tables, the default block size for temp-tables has increased from a 1KB block size
to a 4KB block size on all platforms. If you are creating very small temp-tables, you
might notice a performance degradation with this change.
See OpenEdge Getting Started: ABL Essentials for more information on temp-tables.
4–211
Startup Parameter Descriptions
Token (-tok)
Use Token (-tok) to specify the maximum number of tokens allowed in a single ABL
statement.
Operating
system UNIX
and syntax Windows -tok n
The number of tokens allowed in an ABL statement. The default is 3000 tokens.
If you exceed 3000 tokens in a single statement, the AVM displays a message advising you to
increase the number of tokens per statement using this parameter.
4–212
Trigger Location (-trig)
Operating
system UNIX
and syntax Windows -trig { dir-name | lib-name }
Client – – – –
Connection
dir-name, lib-name
Library names must have a .pl extension. the AVM interprets all other extensions as directory
names. If you do not use Trigger Location (-trig) when connecting to the database, the AVM
searches the PROPATH for the triggers.
Note: If you are generating the local binary schema cache, do not connect to the database
using Trigger Location (-trig) and the Schema Cache File (-cache) together.
4–213
Startup Parameter Descriptions
User ID (-U)
Use User ID (-U) with Password (-P) to specify the user ID.
Operating
system UNIX
and syntax Windows -U userid
Client – – – –
Connection
userid
OpenEdge checks the _User table for the user ID supplied with the -U parameter. When it finds
that user ID, it compares the password (after it has encoded the password) supplied with the -P
parameter with the password in the _User table. If the two passwords match, OpenEdge assigns
the user ID to the OpenEdge session. Otherwise, the user is not allowed to connect to the
database.
With certain DataServers, the -U and -P parameters pass DataServer login information to a
non-OpenEdge database. For more information, see your DataServer documentation.
4–214
Use OS Locale (-useOsLocale)
Operating
system
and syntax Windows -useOsLocale
Client – – – –
Session
This parameter causes the AVM to set certain SESSION system handle attributes based on the
current Windows locale settings.
Table 4–7 lists these SESSION system handle attributes and shows the startup parameters that
individually affect the value of each attribute.
If any of the startup parameters shown in this table appear on the same command line
with the -useOsLocale parameter, any that follow -useOsLocale override the setting
from -useOsLocale and any that -useOsLocale follows are overridden by the setting from
-useOsLocale.
For more information on these SESSION system handle attributes, see OpenEdge Development:
ABL Reference.
In a session accessing .NET objects, Progress Software Corporation recommends that you use
this startup parameter to resolve potential discrepancies between localization settings in your
ABL session and the embedded .NET Common Language Runtime (CLR). Using this
parameter makes your ABL session conform to Windows (and therefore .NET) settings. If you
want to override these settings in your ABL session, you can also propagate these overrides to
the CLR by instantiating a .NET System.Globalization.Cultureinfo class and making the
appropriate settings using the properties and methods of this instance.
4–215
Startup Parameter Descriptions
Operating
system
and syntax Windows -usewidgetid
Client Session – – – –
Specifying application-defined widget IDs for ABL widgets defined in your OpenEdge GUI
application allows you to identify those widgets at runtime while testing your application with
a third-party automated test tool. When specified, the AVM uses any application-defined widget
IDs when creating the widgets at runtime, instead of using the widget IDs it normally generates
by default. The widget ID value of any given widget remains the same across OpenEdge
sessions, unless you purposely change the value using the WIDGET-ID attribute for that widget.
This allows a third-party automated test tool to identify the same widget consistently each time
you run the tool with your application.
For more information about specifying application-defined widget IDs using the WIDGET-ID
attribute with ABL widgets, see OpenEdge Development: ABL Reference. For more
information about using application-defined widget IDs when testing OpenEdge GUI
applications with third-party automated test tools, see OpenEdge Development: Programming
Interfaces.
4–216
Version 6 Colon (-v6colon)
Operating
system UNIX
and syntax Windows -v6colon
Client Session – – – –
If you do not specify this parameter, the AVM moves the field two characters to the right.
4–217
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -v6q
Client Session – – – –
If you do not use this parameter, the server might use more than one index. Using more than one
index is more efficient, but might change the order in which records are returned.
The -v6q parameter also causes cursor repositioning with FOR EACH statements, as in Version 6.
4–218
Windows Passthrough Printing (-Wa -wpp)
Operating
system
and syntax Windows -Wa -wpp
Client Session – – – –
You can only use this startup parameter at the command line. It is ignored when used in a .pf
file. It must be the last parameter in the command.
4–219
Startup Parameter Descriptions
Operating
system
and syntax Windows -wss
Client Session – – – –
This parameter applies only to a Windows GUI client. If an existing OpenEdge session is
running on the machine when -wss is specified, the new session terminates and the windows of
the existing session are brought forward to alert the user. To avoid unnecessary processing of
other parameters, use the -wss parameter first on the command line.
If more than one OpenEdge application is installed on a user’s machine, do not use the -wss
parameter else it will prevent a user from running two or more applications at the same time. In
addition, the -wss parameter does not recognize versions of OpenEdge prior to Version 9.0.
4–220
Windows Exit - No Dialog (-wy)
Operating
system
and syntax Windows -wy
Client Session – – – –
4–221
Startup Parameter Descriptions
Statistics (-y)
Use Statistics (-y) to collect procedure access and usage statistics throughout the OpenEdge
session.
Operating
system UNIX
and syntax Windows -y
Client Session – – – –
At session end, the AVM writes these statistics to the default output file client.mon. For
detailed information on the output written to the client.mon file, see OpenEdge Deployment:
Managing ABL Applications.
At startup, the -y parameter sends a report of all the startup parameters to the output file. This
report includes all default values, overridden values, and values you set at startup. Unlike the
other statistics that the -y parameter collects, this report is not written at session end and is not
affected by the SHOW-STATS statement.
Note: The specific statistics displayed might change periodically as new OpenEdge features
are implemented.
The edit buffer map statistics are written each time a user exits from OpenEdge or uses the
SHOW-STATS statement. These lines list the procedures currently in the edit (or execution) buffer
and their r-code sizes.
Note: If you cannot execute SHOW-STATS from the Procedure Editor or cannot add the
statement to your ABL code (for example, if while using Run-time OpenEdge), you
can specify Statistics with CTRL+C (-yc) instead of the -y parameter. Both parameters
behave the same way, except -yc lets you use CTRL+C as a substitute for the
SHOW-STATS statement.
The program-access statistics are written to the output file when the session ends or when you
use the SHOW-STATS statement. In the output, temp file reads and writes are reads and writes to
the SRT file, which stores each user’s session compiles and active r-code files. The Bytes column
is a cumulative total. The Stat file checks are recorded because they represent a relatively
time-consuming system call. Unless you invoke Quick Request (-q), the AVM makes a stat call
each time a precompiled subprocedure is called with the RUN statement.
The AVM places the default output file (client.mon) in the current working directory;
however, you can specify a different output file by using the CLIENTMON environment variable.
Simply set CLIENTMON to point to the file you want to use. For example, in a UNIX environment,
if you wanted to use a file named stats in the /usr/tmp directory, enter the following command
at the system prompt:
4–222
Statistics with CTRL+C (-yc)
Operating
system UNIX
and syntax Windows -yc
Client Session – – – –
Use this parameter if you cannot execute SHOW-STATS from the Procedure Editor or if you cannot
add the statement to your ABL code (for example, if while using run-time OpenEdge).
When you specify this parameter, it disables CTRL+C as an interrupt signal. In addition, pressing
CTRL+C only emulates SHOW-STATS without the CLEAR option.
4–223
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -yd
Client Session – – – –
• A breakdown of an r-code file by segment type, including the number of segments and
their total size
• Read and write access to the sort file by segment type and access type, including the
number of times the sort file was accessed and the number of bytes read from/written to
the sort file
4–224
Four Digit Year Default (-yr4def)
Operating
system UNIX
and syntax Windows -yr4def
Client Session – – – –
This option causes all dates to use a four-digit year, regardless of what is specified by the
Century year Offset (-yy) startup parameter.
If you do not use this parameter, the EXPORT, MESSAGE and PUT UNFORMATTED statements produce
a two-digit year for the date if it is within the 100 year period defined by the Century Year Offset
(-yy) startup parameter. If the date is outside of that 100 year period, these statements produce
a four-digit year for the date.
Using -yr4def does not affect statements such as DISPLAY, UPDATE and PUT (without
UNFORMATTED), nor any default schema or program variable date formats, which continue to use
the default format 99/99/99. These statements have the FORMAT phrase where an overriding date
format can be given, if the 4-digit year is desired, or the fields and variables can be defined with
the explicit 99/99/9999.
4–225
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -yx
Client Session – – – –
• How often was a procedure swapped to and from the temporary file (SRT file)?
The AVM places the default output file for the -yx parameter, proc.mon, in your current
working directory. However, you can specify a different output file by using the PROCMON
environment variable. Simply set PROCMON to point to the file you want to use.
For example, in a UNIX environment, if you want to use a file named stats in the /usr/tmp
directory, enter the following on the command line:
Use the SHOW-STATS statement to write the procedure call statistics to the output file. The CLEAR
option sets all counters and timers (such as Calls and Time) to 0. When you exit OpenEdge, the
-yx parameter writes the procedure call statistics to the output file whether or not you use
SHOW-STATS.
The following example shows sample procedure call statistics as they appear in the output file:
4–226
Statistics With Cross-reference (-yx)
The fields that appear in the output file proc.mon are as follows:
• Caller — The names of any calling procedures. The word <top> indicates there was no
calling procedure, and you ran the called procedure directly from the Procedure Editor.
• Load Size — The size, in bytes, of each called procedure as the AVM loads it into
memory. If you see a load size of 0, the called procedure is an uncompiled source
procedure (.p file), or an r-code file (.r file) that was previously loaded into memory.
• Calls — The number of times the Caller procedure calls the Callee procedure.
• Rd Bytes — Generally, the called procedure’s load size. However, if the procedure is
swapped out of memory and later restored, Rd bytes equals the procedure’s Load Size
added to the number of bytes read from the SRT file. Rd Bytes grows larger each time the
procedure is swapped out of memory and restored from the SRT file.
• Reread — The number of bytes the AVM reads from the SRT file to restore a Caller
procedure that was overwritten. The AVM restores only what is necessary to continue
executing the Caller procedure. In some cases, this is less than the amount swapped to the
SRT file.
4–227
Startup Parameter Descriptions
Operating
system UNIX
and syntax Windows -yy n
Some OpenEdge applications reserve only two-digits for the year in the date format. When, for
example, -yy is set at 1950, the AVM determines if the two-digit year value is greater or less
than 50. If the year is greater than 50, the AVM assumes that the date is in the twentieth century.
If the year is less than 50, the AVM assumes that the date is in the twenty-first century.
00-49 1900-1949
00-49 2000-2049
00-79 2000-2079
Notice that all two-digit year values expand into the 100-year period beginning with -yy.
To test the effect of -yy, start OpenEdge with a different -yy value and run the following
procedure:
4–228
Century Year Offset (-yy)
If you use a hard-coded date containing a two-digit year in a .p file, the AVM honors the -yy
parameter and expands the two-digit year to a four-digit year during compilation. However, this
may not match the runtime -yy. For this reason, Progress Software Corporation recommends
that you use four digit years for hard-coded dates in programs. For example:
Note: When you dump or load any database, the -yy setting you load with must match the
-yy setting that was used for dumping, unless you use the Four Digit Year Default
(-yr4def) startup parameter for dumping.
This startup parameter provides the same functionality as the SESSION:YEAR-OFFSET attribute.
4–229
Startup Parameter Descriptions
4–230
Index
Numbers After-image Stall (-aistall) startup
parameter 4–9
-1 startup parameter 4–2
aiarcdir startup parameter 4–5
Auto Server (-m1) startup parameter 4–108 -Bp startup parameter 4–23
Index–2
Index
Index–3
Index
-db startup parameter 3–11, 4–56 Error Stack (-errorstack) startup parameter
4–69
-DbCheck startup parameter 4–57
-errorstack startup parameter 4–69
Debug Alert (-debugalert) startup parameter
4–59 European Numeric Format (-E) startup
parameter 4–68
-debug startup parameter 4–58
Event-Level (-evtlevel) startup parameter
-debugalert startup parameter 4–59 4–70
Debugger (-debug) startup parameter 4–58 -evtlevel startup parameter 4–70
-debugReady startup parameter 4–60 Expand Browse (-expandbrow) startup
Decimals parameter 4–71
ABL interpretation 4–68 -expandbrow startup parameter 4–71
Delayed BI File Write (-Mf) startup
parameter 4–118 F
-dictexps startup parameter 4–62
-F startup parameter 4–72
Dictionary Expressions (-dictexps) startup
Fast Schema Change (-populate) startup
parameter 4–62
parameter 4–166
Direct I/O (-directio) startup parameter 4–63
-fc startup parameter 4–73
-directio startup parameter 4–63
File descriptors 4–111
Directories
Files
for temporary files 4–203
client.mon 4–222
Directory entries keyword 4–91
compiled procedures 4–52 parameters 1–4
saving temporary 4–204
Directory Size (-D) startup parameter 4–52 searching 4–173
startup.pf 1–4
Double-byte characters
check 4–30 Filtering Asynchronous COM Events
(-filterocxevents) startup parameter 4–74
-Dsrv startup parameter 4–66
Index–4
Index
Index–5
Index
L M
-L startup parameter 4–94 -m1 startup parameter 4–108
Index–6
Index
Index–7
Index
Number of Log Files to Keep (-numlogfiles) Physical Database Name (-db) startup
startup parameter 4–151 parameter 4–56
location 3–11
Number of Users (-n) startup parameter
4–131 -pica startup parameter 4–162
Index–8
Index
-proxyPassword startup parameter 4–170 Run Run-time client (-rr) startup parameter
4–183
-proxyport startup parameter 4–171
-rx startup parameter 4–184
-proxyUserid startup parameter 4–172
S
Q
-S startup parameter 4–185
-q startup parameter 4–173
-s startup parameter 4–186
Quick Request (-q) startup parameter 4–173
Save Temp Files (-t) startup parameter
4–204
R
Schema Cache File (-cache) startup
-r startup parameter 4–174 parameter 4–29
-rand startup parameter 4–175 Schema Field Cache Size (-fc) startup
parameter 4–73
R-code In Code Page (-cprcodein) startup
parameter 4–45 Screen-value Mode (-scrvalmode) startup
parameter 4–187
R-code Out Code Page (-cprcodeout) startup
parameter 4–46 -scrvalmode startup parameter 4–187
Read-only (-RO) startup parameter 4–181 Search for files
speeding up 4–173
Record Buffer Size (-Mr) startup parameter
4–128 Search path
limiting 4–173
Record fragmentation 4–122
Secondary Login Broker (-m3) startup
Recovery Log Threshold (-bithold) startup parameter 4–110
parameter 4–22
Secondary Login Broker server type 4–110
Require Username (-requireusername)
startup parameter 4–176 Segment Statistics (-yd) startup parameter
4–224
-requireusername startup parameter 4–176
SELECT Pass Through Disable
Reread Nolock (-rereadnolock) startup (-noSQLbyserver) startup parameter
parameter 4–177 4–148
-rereadnolock startup parameter 4–177, Semaphore Sets (-semsets) startup
4–179 parameter 4–188, 4–189
Re-usable Objects Cache (-reusableObjects) -semsets startup parameter 4–188, 4–189
startup parameter 4–179
Server Join (-nojoinbysqldb) startup
-rg startup parameter 4–180 parameter 4–145
-RO startup parameter 4–181 Server startup parameters
buffers 3–15
-rq startup parameter 4–182
networks 3–20
-rr startup parameter 4–183 performance 3–15
server type specification 3–18
Run ABL Client (-rg) startup parameter statistic collection specification 3–19
4–180
Servers
Run Query Client (-rq) startup parameter controlling number spawned for one
4–182 protocol 4–125
defined 1–2
types 4–108, 4–109
Index–9
Index
-shmsegsize startup parameter 4–192 Stack Size (-s) startup parameter 4–186
Index–10
Index
Stash Area (-stsh) startup parameter 4–202 Thousands Separator (-numsep) startup
parameter 4–152
Statistic Collection startup parameters 3–19
Threshold Stall (-bistall) startup parameter
Statistics 4–21
tracking access 4–17, 4–22
Time Stamp (-tstamp) startup parameter
Statistics (-y) startup parameter 4–221,
4–208
4–222
-TM startup parameter 4–210
Statistics with Cross-reference (-yx) startup
parameter 4–226 -tmpbsize startup parameter 4–211
Statistics with CTRL-C (-yc) startup -tok startup parameter 4–212
parameter 4–223
Token (-tok) startup parameter 4–212
Storage Object Cache Size (-omsize) startup
parameter 4–155 -trig startup parameter 4–213
Stream Code Page (-cpstream) startup Trigger Location (-trig) startup parameter
parameter 4–47 4–213
Index–11
Index
Index–12