R ACCELL/SQL: Configuration Variable and Utility Reference E 1989, 1992, 1993, 2001, 2005 by Unify Corporation Sacramento, California, USA All rights reserved. Printed in the United States of America. No part of this document may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise without the prior written consent of Unify Corporation. Unify Corporation makes no representations or warranties with respect to the contents of this document and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose. Further, Unify Corporation reserves the right to revise this document and to make changes from time to time in its content without being obligated to notify any person of such revisions or changes. The Software described in this document is furnished under a Software License Agreement. The Software may be used or copied only in accordance with the terms of the license agreement. It is against the law to copy the Software on tape, disk, or any other medium for any purpose other than that described in the license agreement. Unify Corporation values and appreciates any comments you may have concerning our products or this document. Please address comments to: Product Manager Unify Corporation 2101 Arena Boulevard Ste. 100 Sacramento, CA 95834-1922 (800) 248-6439 (916) 928-6400 FAX (916) 928-6406 UNIFY, ACCELL, VISION, and the Unify Logo are registered trademarks of Unify Corporation. Unify DataServer is a trademark of Unify Corporation. UNIX is a registered trademark of the Open Group in the United States and other countries. The X Window System is a product of the Massachusetts Institute of Technology. Motif, OSF, and OSF/Motif are trademarks of Open Software Foundation, Inc. SYBASE is a registered trademark, and SQL Server, DBĆLibrary, and Open Server are trademarks of Sybase, Inc. INFORMIX is a registered trademark of Informix Software, Inc., a subsidiary of IBM. INGRES is a trademark of Computer Associates International, Inc. ORACLE is a registered trademark of Oracle Corporation. Sun is a registered trademark, and SunView, SunĆ3, SunĆ4, X11/NeWS, SunOS, PCĆNFS, and Open Windows are trademarks of Sun Microsystems. All SPARC trademarks are trademarks or registered trademarks of SPARC International, Inc. SPARCstation is licensed exclusively to Sun Microsystems, Inc. Novell is a registered trademark of Novell, Inc. Macintosh is a trademark of Apple Computer, Inc. Microsoft, MS, MSĆDOS, and Windows are registered trademarks of Microsoft Corporation. All other products or services mentioned herein may be registered trademarks, trademarks, or service marks of their respective manufacturers, companies, or organizations. Part Number: 7247Ć04 2 Contents About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to Use this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Item Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Keyboard Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 3 3 3 5 Configuration Variable Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Configuration Variable Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . 9 ACLCONFIG(INFORMIX, INGRES, ORACLE, SYBASE SQL Server, only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 ACLDBDBG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 ACLDBGON(A CCELL/SQL Interactive Debugger only) . . . . . . 10 ACL_DBUTIL_SCH(INFORMIX, INGRES, ORACLE, and SYBASE SQL Server only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 ACLDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 ACLENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 ACLMXOPNVARF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 ACLPATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 ACLPRESMODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 ACLSCROLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 ACLTXMODE(RDBMSĆspecific effects) . . . . . . . . . . . . . . . . . . . . 15 ACLTXTNONDSPCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 ACLVARDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 ACLVARMEMLIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 ACPLPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 AGEN_ERFL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 AGEN_HPSZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 AGEN_PSCOL(INFORMIX, INGRES, ORACLE, and Unify DataServer only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 AGEN_SEL_SET_DR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 AMGR_ERFL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 AMGR_FORM_CA_SZ .................................. 22 AMGR_FUNC_CA_ SZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 AMGR_HPSZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 AMGR_INI_M_SZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 AMGR_LCK_SCH(Unify DataServer only) . . . . . . . . . . . . . . . . . . 24 AMGR_NUM_WD WS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 AMGR_SEL_M_SZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 AMGR_SEL_SET_DR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 AMGR_SKIP_OC2F_NAIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 AMGR_STK_B_SZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 AMSHMKEY(Unify DataServer RDBMS only) . . . . . . . . . . . . . . 28 AMTFMT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 AMTNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 AMTPREC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 AMTROUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 APPMAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 APPRESDIR(X Window variable used with Motif UI option only) 33 ATERMCAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 BOLNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 BOOLFMT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 CH_BURST_CHK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 CH_OLD_BURST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 CH_TIMER_CHK(Character mode only) . . . . . . . . . . . . . . . . . . . 37 CLEAR_FLD_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 CMDSCOPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 CONFIG_READONL Y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 CTRLCABT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 CURRSYM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 DATEFMT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 DATNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 DBCHARSET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 DBHOST(SYBA SE SQL Server and Unify DataServer) . . . . . . . . 45 DBNAME(INFORMIX, INGRES, SYBASE SQL Server, and Unify DataSĆ erver only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 DBPATH(Unify DataServer and INFORMIX SE only) . . . . . . . . 48 DBTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 DBUSER(INGRES, ORACLE, SYBASE SQL Server, and Unify DataServer only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 DELIMFLD(Character mode only) . . . . . . . . . . . . . . . . . . . . . . . . . 51 DFLTVCFILE(SYBA SE SQL Server only) . . . . . . . . . . . . . . . . . . 51 DFLTVCMEM(SYBA SE SQL Server only) . . . . . . . . . . . . . . . . . . 52 DSQUERY(SYBA SE SQL Server RDBMS variable) . . . . . . . . . . 53 EDIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 ERRCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 EXPL_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 FKEYGAPS(Character mode only) . . . . . . . . . . . . . . . . . . . . . . . . . 55 FLTFMT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 FLTNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 FLTROUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 II_CHECKPOINT(INGRES RDBMS variable) . . . . . . . . . . . . . . 57 II_DATABASE(INGRES RDBMS variable) . . . . . . . . . . . . . . . . . 58 II_DUMP(INGRES RDBMS variable) . . . . . . . . . . . . . . . . . . . . . . 58 II_GCNxx_RMT_VNODE(INGRES RDBMS variable) . . . . . . . . 59 II_JOURNAL(INGRES RDBMS variable) . . . . . . . . . . . . . . . . . . 59 II_SYSTEM(INGRES RDBMS variable) . . . . . . . . . . . . . . . . . . . . 60 INFORMIXDIR(INFORMIX RDBMS variable) . . . . . . . . . . . . . 60 LANG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 LANGDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 LENONULL(INFORMIX RDBMS only) . . . . . . . . . . . . . . . . . . . 62 M_LIBS(Motif UI option only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 MON1, MON2, MON3, MON4, MON5, MON6, MON7, MON8, MON9, MON10, MON11, MON12 . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 NULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 NUMFMT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 NUMNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 OL_LIBS(OPEN LOOK UI option only) . . . . . . . . . . . . . . . . . . . . 66 OPENWINHOME(X Window variable used with OPEN LOOK UI option only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 OPNARCHS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 ORACLE_HOME(OR ACLE RDBMS variable) . . . . . . . . . . . . . . 68 ORACLE_SID(OR ACLE RDBMS variable) . . . . . . . . . . . . . . . . . 68 OSEC2WAIT(INFORMIX, INGRES, ORACLE, and SYBASE SQL Server only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 PAGELN(RPT and irs only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 PATH(UNIX only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 RADIXSEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 RNGMETACH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 SEPARATOR(RPT and irs only) . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 SHELL(UNIX only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 SPOOLER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 SQLFLDCNT(Unify DataServer only) . . . . . . . . . . . . . . . . . . . . . . 74 STCNRTLK(Unify DataServer only) . . . . . . . . . . . . . . . . . . . . . . . . 74 STRNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 SYBASE(SYBA SE SQL Server RDBMS variable) . . . . . . . . . . . . 75 SYBASE_MSGS(SYBA SE SQL Server only) . . . . . . . . . . . . . . . . . 76 SYBASE_RB_ ERRNUMS(SYBASE SQL Server only) . . . . . . . . 77 SYBASE_RB_RESTART(SYBA SE SQL Server only) . . . . . . . . . 77 SYBTRGMSG(SYBA SE SQL Server only) . . . . . . . . . . . . . . . . . . 78 SYBTXTSIZE(SYBA SE SQL Server only) . . . . . . . . . . . . . . . . . . . 78 TBCONFIG(INFORMIX RDBMS variable used only with INFORMIX OnĆ Line) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 TERM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 TIMEFMT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 TIMNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 TRIADSEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 TWO_TASK(ORACLE RDBMS variable) . . . . . . . . . . . . . . . . . . . 82 TXTNULLCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 UAMOUNT64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 ULDFLA GS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 ULDLIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 ULDNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 UNICAP(Character mode only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 UNIFY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 UNIFYTMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 UNUMERIC64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 UPPNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 USTRBCHARS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 UTXTBCHARS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 UXPUSHSHELL(Motif and OPEN LOOK UI options only) . . . 90 UXSYSTEM(Motif and OPEN LOOK UI options only) . . . . . . . 91 WIDTH(RPT and irs only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 WP_IGNORE_ UNDEFINED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 XAPPLRESDIR(X Window variable used with Motif and OPEN LOOK UI options only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 XAPPRESLANGP ATH(X Window variable used with Motif UI option only) 92 XENVIRONMENT(X Window variable used with Motif and OPEN LOOK UI options only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 ACCELL/SQL Utilities Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Utilities Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 96 96 accell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 ACMB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 ACPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 adev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 adevmnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 AGEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 ALNK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 AMGR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 amgr.ld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 ASC2H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 ASC2Q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 asqlmsg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 bldcmf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 ckguires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 ckunicap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 clrtbls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 dmpcfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 FRMDOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 frmlst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 gtlogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H2ASC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 169 irs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 make_maf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 makeamake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 MKAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 orcfltr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 PAINTHLP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 PICT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 prlcinf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 q2a2q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 Q2ASC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 ridutil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 RPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 rpt.ld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 syncauth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 About This Manual ACCELL/SQL: Configuration Variable and Utility Reference describes tools and techniques that application administrators and developers can use to manage an ACCELL/SQL application. (This information applies regardless of the RDBMS or the user interface option with which ACCELL/SQL is being run.) How to Use this Manual This manual uses various graphic conventions to help you distinguish between commands that you type, keys that you press, information that displays on your screen, and the different elements of ACCELL/SQL and the user interface. Item Names References to program names, database table and column names, file names, and form field names appear in bold typeface, for example: Use the same procedure to define the address_1 and address_2 fields that you used to define the co_name field. The Target Table field lets you specify which database table this form will directly query and update. Keyboard Keys A word or letter framed to look like a key indicates the corresponding key on your keyboard, for example: RETURN Represents the return key. This key could be labeled as “Enter”, “RTN,” or . ACCELL/SQL Commands Words that appear in bold, italic, sans serif typeface indicate ACCELL/SQL commands that you can execute by pressing a defined key sequence or selecting a menu button, for example: Press ADD/UPDATE, then PREVIOUS FORM . To move to the last record, press the LAST RECORD button on the Next Operations menu. 1 Helpful Information The manual also uses the following conventions to present helpful information such as application tips, warnings, and locations of additional information: Tip Tip contains helpful information. Warning Warning cautions against actions that could cause data loss or damage to the database. Additional Help Additional Help tells you where to find more information about described topics. Dependencies Dependencies points out features or characteristics that differ from RDBMS to RDBMS, from operating system to operating system, from user interface to user interface, or from hardware platform to hardware platform. 2 About This Manual Syntax Conventions This manual uses various graphic conventions to help you distinguish between commands that you type, keys that you press, information that displays on your screen, and the different elements of ACCELL/SQL and the user interface. The manual uses the following syntax conventions to describe the format of ACCELL/4GL statements and functions, Report Writer (RPT) statements, and operating system command-level commands: boldface Boldface words are command keywords or literal strings that you must type exactly as shown. ACCELL/4GL statement and section keywords are shown in all UPPERCASE, but can be typed in either uppercase or lowercase letters. (Function names such as yesno$() are case sensitive.) italic words Italic words are names, numbers, or expressions that you must provide. Examples are table names, column names, and constants. Italics are also used for manual names and terms defined in the glossary. All-uppercase italics are used for configuration variable names. About This Manual $ All ACCELL/4GL system function names are suffixed by a dollar sign ($), as in status$( ), to distinguish them from user-defined functions. This dollar sign is a syntax element that must be included in the function name. Do not include a dollar sign when you name or call your own functions. [] Nonbold square brackets indicate that the enclosed word or item is optional and may be left out. Boldface brackets, [ ], are syntax elements that must be included, as in count[character]. || Vertical bars that enclose a stacked list of options mean that you can choose one of the listed options, but only one of them. ... Ellipsis points indicate that you may repeat the immediately preceding item any number of times, as needed. 3 4 About This Manual Configuration Variable Reference 5 Chapter Focus The configuration variable descriptions in this chapter are listed in alphabetical order. Most of the variables listed in this chapter can be used regardless of the underlying RDBMS (relational database management system) or operating system. However, in some cases, syntax and usage can depend on the RDBMS or the operating system being used. For RDBMS-specific information about configuration variables, see the ACCELL/SQL: RDBMS Integration manual. For comparisons of configuration variables used by various relational database management systems, see the ACCELL/SQL: Portability Guidelines manual. For explanations of how to use field display formats, see the ACCELL/SQL: Localizing an Application, ACCELL/SQL: Creating Screen Forms, ACCELL/SQL: Writing Form Scripts, and ACCELL/SQL: Creating Reports With RPT Report Writer manuals. Dependencies The examples shown in this chapter use a format that is based on the UNIX operating system. If you are using a different operating system, use the format required on your system. The UNIX $VARIABLE_NAME format is allowed only at the operating system command level; variable expansion is not performed on variables set in a configuration file. 6 Configuration Variable Reference Configuration Variable Descriptions ACLCONFIG (INFORMIX , INGRES, ORACLE, SYBASE SQL Server, only) Path and file name for the application configuration file to be used with ACCELL/SQL with INFORMIX, INGRES, ORACLE , or SYBASE SQL Server. This file is usually named application.cf, where application is the name of the application. The .cf file name suffix is required. For example, if the application link file is named accts.al, the application configuration file is named accts.cf, and the application files are in the directory /usr/ASQL/apps/accts, then ACLCONFIG is set to /usr/ASQL/apps/accts/accts.cf. Summary ACLDBDBG ACLCONFIG Configuration Variable Dependencies: Used with INFORMIX, INGRES, ORACLE, or SYBASE SQL Server RDBMS. Requires the correct path format for the operating system. Valid values: Any valid path and file name Default value: UNIX: ”$UNIFY/unify.cf” Example: UNIX: ”/usr/ASQL/apps/accts.cf” Additional help: ACCELL/SQL: RDBMS Integration Name of the error file used for SQL debugging. If ACLDBDBG is set to the name of an error file, every message that was sent to the RDBMS is sent to the specified error file. If this variable is undefined, messages are sent to the null device. Summary ACLDBDBG Configuration Variable Dependencies: Requires the correct directory path format and file name format for the operating system Valid values: Any valid file name or any valid directory path and file name Default value: None table continued on next page Configuration Variable Reference 7 ACLDBDBG Configuration Variable Example: ”sqlerrs” ”/usr/aclapps/tmp/sqlerrs” Additional help: ACCELL/SQL Interactive Debugger: Developer’s Reference ACLDBGON (ACCELL/SQL Interactive Debugger only) ACCELL/SQL Interactive Debugger control flag, which is used by ACCELL/M anager. ACCELL/SQL Interactive Debugger is an optional feature of ACCELL/SQL and must be purchased and licensed separately. Regardless of the value of ACLDBGON, you can enable the debugger for the manager by including the -debug option on the command line that is used to start AMGR. Summary ACLDBGON Configuration Variable Valid values: Default value: Additional help: TRUE The debugger is automatically enabled FALSE The debugger is off, unless specifically enabled through the -debug command line option to AMGR FALSE ACCELL/SQL Interactive Debugger: Developer’s Reference ACL_DBUTIL_SCH (INFORMIX , INGRES, ORACLE, and SYBASE SQL Server only) 8 Name of the logical database object that contains the ACCELL/SQL Development Environment, Menu Handler, and Tutorial tables, if not the default DBUTIL (dbutil, if the RDBMS requires lowercase). If you want to use a different logical database object, create the tables in the database, owner, schema, or user where you want them to be located. Then set ACL_DBUTIL_SCH to the name of the logical database object that contains the tables. This variable is used by the accell and adev utilities. Configuration Variable Reference Summary ACLDIR ACL_DBUTIL_SCH Configuration Variable Dependencies: The specified logical database object is a database (SYBASE SQL Server), a schema (Unify DataServer), or a user (ORACLE). Valid values: Any valid database, schema, or user name, depending on the RDBMS Default value: ”DBUTIL” or ”dbutil” Example: ”SYSTBLS” Additional help: “Using the Tutorials and Menu Handler” and “Using ACCELL/SQL Report Writer” in ACCELL/SQL: RDBMS Integration Path for the ACCELL/SQL release directory. This directory is the parent directory of the lib directory that is specified by the UNIFY configuration variable. The ACLDIR variable can be set only at the operating system command level and cannot be specified in a configuration file. If you do not set ACLDIR, the accell script and other ACCELL/SQL scripts set the configuration variable to a value that is written to the script at installation Summary Configuration Variable Reference ACLDIR Configuration Variable Dependencies: Requires the correct path format for the operating system Valid values: Any valid path Default value: Directory in which ACCELL/SQL is installed Example: UNIX: ”/usr/ASQL” Additional help: ACCELL/SQL: Setting Up a User Environment 9 ACLENV Path for the application development directory. This directory contains subdirectories for each application that is registered with ACCELL/E nvironment. Dependencies ORACLE users only: If you are running ACCELL/SQL on ORACLE, ACLENV must be set to a directory that is in the same file system as the one in which ACCELL/SQL is running. The developer’s and completed tutorials cannot be rebuilt if the ACLENV environment variable is set to a directory that is in a different file system. Summary ACLMXOPNVARF Summary 10 ACLENV Configuration Variable Dependencies: Requires the correct path format for the operating system. Valid values: Any valid path Default value: None Example: UNIX: Additional help: ACCELL/SQL: Developing an Application ”/usr/ASQL/devapps” Number of file descriptors that ACCELL/SQL can have assigned at one time for variable-length data files. Variable-length data files store TEXT or BINARY field data. ACLMXOPNVARF Configuration Variable Dependencies: The maximum number of file descriptors depends on the operating system Valid values: Positive integers greater than or equal to 2 Default value: 5 Example: 8 Additional help: ACCELL/SQL: Writing Form Scripts Configuration Variable Reference ACLPATH Directory path list for the ACCELL/SQL application link file (.al), form archive file (.fa), and help (.hlp) archive file. You can include the current directory in the path list. The ACLPATH configuration variable enables you to distribute the .al, .fa, and .hlp files over one or more directories. ACCELL/SQL searches through the directories in the order specified in ACLPATH. Set the ACLPATH variable only if your application’s .al, .fa, and .hlp files are not all located in the current directory when you execute the application. Summary ACLPATH Configuration Variable Dependencies: Requires the correct path format for the operating system Valid values: Any valid path list Default value: UNIX: ”.” Example: UNIX (colon-separated paths): ”.:/usr/ASQL/devapps/accts:/usr/ASQL/AcctsApp” Additional help: ACLPRESMODE Summary “Building Application Systems” in ACCELL/SQL: Managing an Application Presentation mode to be used when an ACCELL/SQL application is being executed. If set, ACLPRESMODE must specify a presentation mode (user interface option) that you have licensed for your release of ACCELL/SQL . Do not set ACLPRESMODE to a presentation mode that is not licensed. ACLPRESMODE Configuration Variable Valid values: ”CHARACTER”, ”CHAR”, empty string (””), or unset for a character user interface ”MOTIF” (for the Motif UI option) ”OPENLOOK” (for the OPEN LOOK UI option) The values for this variable can be set in uppercase or lowercase characters. table continued on next page Configuration Variable Reference 11 ACLPRESMODE Configuration Variable (continued) Default value: ”CHARACTER” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface (for information about developing an application for the Motif or OPEN LOOK UI option ACCELL/SQL: Using an Application (for information about using an application with the Motif or OPEN LOOK UI option) ACLSCROLL Default scroll mode (page by page or line by line) for scrolling through selected sets. A page is equal to the number of records in the multi-occurrence area. The scrolling mode determines which records are displayed when you scroll to records outside the multi-occurrence area. The scrolling mode also determines which record is current after one of the following commands is executed: PREVIOUS RECORD , NEXT RECORD , PREVIOUS SET, or NEXT SET. Summary ACLSCROLL Configuration Variable Valid values: ”PAGE” Scroll through the selected set page by page ”LINE” Scroll through the selected set line by line 12 Default value: ”PAGE” Additional help: ACCELL/SQL: Writing Form Scripts and ACCELL/SQL: Using an Application (for information about scrolling through a selected set) Configuration Variable Reference ACLTXMODE (RDBMS-specific effects) Summary ACCELL/SQL transaction mode flag that determines whether the current transaction is committed or continued as the user moves from form to form. ACLTXMODE Configuration Variable Dependencies: INFORMIX OnLine or SE (not MODE ANSI) ACLTXMODE works as described. INFORMIX MODE ANSI ACLTXMODE has no effect because automatic transaction handling is always enabled. INGRES ACLTXMODE has no effect because automatic transaction handling is always enabled. ORACLE ACLTXMODE has no effect because automatic transaction handling is always enabled. SYBASE SQL Server ACLTXMODE works as described. Unify DataServer ACLTXMODE has no effect because automatic transaction handling is always enabled. Valid values: TRUE ACCELL/SQL starts a transaction before any SQL statements are executed. As the user moves from form to form, transactions are continued or committed, depending on the options in the CHOOSE FIRST FORM and CHOOSE NEXT FORM sections. FALSE ACCELL/SQL ignores the transaction specification in the CHOOSE FIRST FORM and CHOOSE NEXT FORM sections. You must use the COMMIT WORK statement to explicitly commit a transaction. The current transaction is committed if the application ends normally; otherwise, the transaction is rolled back. Default value: TRUE table continued on next page Configuration Variable Reference 13 ACLTXMODE Configuration Variable (continued) Additional help: ACCELL/SQL: Writing Form Scripts (for information about transaction management) ACCELL/SQL: RDBMS Integration (for RDBMS-specific information about transaction management) CHOOSE FIRST FORM statement, CHOOSE NEXT FORM statement, and tx_mode$( ) system function descriptions in ACCELL/SQL: Script and Function Reference ACLTXTNONDSPCH Placeholder character for control characters to be displayed in TEXT fields (for example, the circumflex: ^). Use ACLTXTNONDSPCH to define the placeholder character to be displayed for unrecognized control characters. When inserting data into a TEXT field, you can insert control characters. ACCELL/SQL can display common control characters such as newline and tab. However, if ACCELL/SQL does not recognize a control character, a placeholder character is displayed instead of the actual control character. Summary ACLTXTNONDSPCH Configuration Variable Valid values: Any valid printable character, enclosed in double quotation marks (”character”). Default value: ”^” Additional help: ACCELL/SQL: Writing Form Scripts (for information about using TEXT fields) ACCELL/SQL: Managing an Application (for information about storing TEXT values) 14 Configuration Variable Reference ACLVARDIR Path of the directory to be used to temporarily store variable-length TEXT or BINARY data in files. This directory is used only when the size of the variable-length data grows larger than the size specified in the ACLVARMEMLIM configuration variable. When variable-length data is stored in a temporary file on disk, the data is retrieved from the disk as needed. If the variable-length data later shrinks to less than the size specified in ACLVARMEMLIM , the data is copied into memory and the disk file is removed. If the variable-length data is stored in a temporary file on disk, you can determine the path of the file by using ACCELL/4GL to view the value of the FILE_PATH general attribute. FILE_PATH contains the path name of the temporary file created by ACCELL/SQL . Summary ACLVARDIR Configuration Variable Dependencies: Requires the correct path format for the operating system Valid values: Any valid path Default value: UNIX: ”/usr/tmp” Example: UNIX: ”/usr/ASQL/AcctsApp/tmp” Additional help: “Storing Text and Binary Values” in ACCELL/SQL: Managing an Application FILE_PATH general attribute description in ACCELL/SQL: Script and Function Reference ACLVARMEMLIM Memory limit in bytes for storing variable-length data for TEXT or BINARY variables. If more space is needed to store the TEXT or BINARY variable, the variable is stored on disk and retrieved from the disk as needed. In memory, space for variable-length data variables is allocated on the heap. Therefore, if you plan on using variable-length text and binary variables, increase AMGR_HPSZ to add more heap memory for these variables. You can determine whether a variable is in memory or on disk by using ACCELL/4GL to view the value of the IN_MEMORY general attribute. If IN_MEMORY is TRUE, the variable is stored in memory; if IN_MEMORY is FALSE, the variable is stored on disk. Configuration Variable Reference 15 Summary ACLVARMEMLIM Configuration Variable Valid values: Positive integers Default value: 1024 Example: 2k Additional help: AMGR_HPSZ configuration variable description on page 21 “Storing Text and Binary Values” in ACCELL/SQL: Managing an Application IN_MEMORY general attribute description in ACCELL/SQL: Script and Function Reference ACPLPP Preprocessor for the ACCELL/SQL compiler, ACPL. The preprocessor must be specified as a complete path name, with both directory and file names specified. The specified executable can be an operating system command script. Either the ACPLPP configuration variable or the UPPNAME configuration variable can be used to specify the preprocessor: If both ACPLPP and UPPNAME are set, the preprocessor specified by the ACPLPP configuration variable is used. If ACPLPP is not set, but UPPNAME is set, the preprocessor specified by the UPPNAME configuration variable is used. If neither ACPLPP nor UPPNAME is set, the ACPLPP default value is used. Summary ACPLPP Configuration Variable Dependencies: Requires the correct path and file name formats for the operating system Valid values: Any valid path and file name Default value: UNIX: ”/lib/ucpp” (if UPPNAME is not set) table continued on next page 16 Configuration Variable Reference ACPLPP Configuration Variable Example: UNIX: ”/usr/Apps/lib/ucpp” Additional help: UPPNAME configuration variable description on page 85 ACPL utility syntax and description on page 103 ACCELL/SQL: Writing Form Scripts (for information about writing and compiling form scripts) AGEN_ERFL Directory path and file name of the file to which ACCELL/G enerator sends error messages. This variable can be set simply to a file name if the file is in the current working directory. Summary AGEN_ERFL Configuration Variable Dependencies: Requires the correct path format (if specified) and file name format for the operating system Valid values: Any valid path (absolute or relative path) and file name. (A file name alone is sufficient if the file is in the current directory.) Default value: UNIX: ”/dev/null” Examples: UNIX: ”/tmp/agen.err” ”agen.err” ”../agen.err” Additional help: ACCELL/SQL: Creating Screen Forms (for information about creating screen forms) AGEN_HPSZ Size in bytes of the heap memory to be used by ACCELL/G enerator. The heap space is used for application string variables. The value of this variable varies for each application and must be determined by trial and error. If the heap size is too small, the application cannot execute, and you will receive an error message that not enough memory is available to run the generator. Configuration Variable Reference 17 If the heap size is too large, the application is too large, and you will receive an error message that memory cannot be allocated. Do not set AGEN_HPSZ to a value that is less than the default. You can determine the default for your release either by examining the unify.cf file or by running the config utility. Summary AGEN_HPSZ Configuration Variable Dependencies: The maximum number of bytes depends on hardware capacities Valid values: A positive integer in the range of 32k to 1M bytes Default value: Hardware dependent Example: 32k (or 32768) Additional help: config utility syntax and description on page 155 ACCELL/SQL: Creating Screen Forms (for information about creating screen forms) AGEN_PSCOL (INFORMIX , INGRES, ORACLE, and Unify DataServer only) Indicator that determines whether pseudo-columns are displayed when the developer zooms to the list of target table columns when using ACCELL/G enerator. For example, when using ACCELL/SQL and Unify DataServer when AGEN_PSCOL is set to TRUE, a row ID column is also displayed. Even when AGEN_PSCOL is FALSE and the column names do not appear on the zoom form, you can still type the name of a pseudo-column on the Field Definition form. Summary AGEN_PSCOL Configuration Variable Dependencies: Used only with INFORMIX, ORACLE, and Unify DataServer Valid values: TRUE PseudoĆcolumns are displayed on the list of target table columns FALSE PseudoĆcolumns are not displayed on the list of target table columns table continued on next page 18 Configuration Variable Reference AGEN_PSCOL Configuration Variable Default value: Additional help: FALSE ACCELL/SQL: RDBMS Integration (for information about using pseudo-columns) ACCELL/SQL: Creating Screen Forms (for information about creating screen forms) AGEN_SEL_SET_DR Summary Path for the directory where ACCELL/G enerator stores temporary files for selected sets. AGEN_SEL_SET_DR Configuration Variable Dependencies: Requires the correct path format for the operating system Valid values: Any valid path Default value: UNIX: ”/usr/tmp” Example: UNIX: ”/usr/Apps/Accts/tmp” Additional help: ACCELL/SQL: Creating Screen Forms (for information about creating screen forms) AMGR_ERFL Summary Directory path and file name of the file to which ACCELL/M anager sends error messages, runtime messages, and cache statistics. If this variable is not set, cache statistics are not kept. This variable can be set simply to a file name if the file is in the current working directory. AMGR_ERFL Configuration Variable Dependencies: Requires the correct path format (if specified) and file name format for the operating system Valid values: Any valid path (absolute or relative path) and file name. (A file name alone is sufficient if the file is in the current directory.) table continued on next page Configuration Variable Reference 19 AMGR_ERFL Configuration Variable Default value: UNIX: ”/dev/null” Examples: UNIX: ”/usr/Apps/Accts/tmp/errfile” ”amgr.err” ”../amgr.err” Additional help: AMGR_FORM_CA_SZ Summary “Tuning Cache Size” in ACCELL/SQL: Managing an Application Size in bytes of the buffer used by ACCELL/M anager to cache forms. This variable also determines whether forms are cached. If AMGR_FORM_CA_SZ is set to 0, forms are not cached; if set to any other value, forms are cached. AMGR_FORM_CA_SZ Configuration Variable Dependencies: Maximum form cache size depends on the hardware and operating system Valid values: –1 Size is unlimited; all forms are cached. 0 Do not cache forms. A positive integer (1 through the maximum size of a long) 20 Default value: 0 (Forms are not cached.) Example: 50k Additional help: “Caching Application Forms and Functions” in ACCELL/SQL: Managing an Application Configuration Variable Reference AMGR_FUNC_CA_ SZ Summary Size in bytes of the buffer used by ACCELL/M anager to cache global functions. This variable also determines whether functions are cached. If AMGR_FUNC_CA_SZ is set to 0, functions are not cached; if set to any other value, functions are cached. AMGR_FUNC_CA_SZ Configuration Variable Dependencies: Maximum function cache size depends on the hardware and operating system Valid values: –1 Size is unlimited; all global functions are cached. 0 Do not cache global functions A positive integer (1 through the maximum size of a long) AMGR_HPSZ Default value: –1 (All global functions are cached.) Example: 30k Additional help: “Caching Application Forms and Functions” in ACCELL/SQL: Managing an Application Size in bytes of the heap memory to be used by ACCELL/M anager for string operations. The value of this variable varies for each application and must be determined by trial and error. If the heap size is too small, the application cannot execute, and you will receive an error message that not enough memory is available to run the application. If the heap size is too large, the application is too large, and you will receive an error message that memory cannot be allocated. Do not set AMGR_HPSZ to a value that is less than the default. You can determine the default for your release either by examining the unify.cf file or by running the config utility. Configuration Variable Reference 21 Summary AMGR_INI_M_SZ AMGR_HPSZ Configuration Variable Dependencies: The maximum number of bytes depends on hardware capacities Valid values: A positive integer, usually in the range of 32k to 64k bytes Default value: Hardware dependent Example: 32k (or 32768) Additional help: config utility syntax and description on page 155 Size in bytes of the initial process to be used by ACCELL/M anager for the application. The default value for this variable is hardware dependent. You can determine the default for your release either by examining the unify.cf file or by running the config utility. Summary AMGR_LCK_SCH (Unify DataServer only) AMGR_INI_M_SZ Configuration Variable Dependencies: The maximum number of bytes depends on hardware capacities Valid values: A positive integer Default value: Hardware dependent Example: 64k Additional help: config utility syntax and description on page 155 Flag that indicates whether the application database design is locked when you execute ACCELL/M anager. No one can perform DDL (data definition language) operations while the database design is locked. The database design that can be locked defines the database that is specified by the DBNAME and DBPATH configuration variables. 22 Configuration Variable Reference Summary AMGR_NUM_ WDWS Summary AMGR_SEL_M_SZ Summary AMGR_LCK_SCH Configuration Variable Dependencies: Used only on the Unify DataServer RDBMS Valid values: TRUE The database design is locked so that no one can change the definitions of any of the tables in the database while ACCELL/Manager is being executed. FALSE The database design is not locked. Individual table definitions are locked as each table is accessed. Default value: FALSE Additional help: None Maximum number of ACCELL/SQL windows that can be active at one time when running ACCELL/M anager, regardless of the user interface option (character or GUI). Separate windows are used to display screen forms, help forms, and the results of executing statements such as DISPLAY TRIM and DISPLAY HELP. AMGR_NUM_WDWS Configuration Variable Valid values: A positive integer Default value: 128 Example: 80 Additional help: None Size in bytes of the memory used by ACCELL/M anager to store selected set information. When the selected set memory size is exceeded, ACCELL/SQL stores the selected set information on disk. AMGR_SEL_M_SZ Configuration Variable Valid values: A positive integer Default value: 4048 table continued on next page Configuration Variable Reference 23 AMGR_SEL_M_SZ Configuration Variable (continued) Example: 8k 32k Additional help: AMGR_SEL_SET_ DR Summary 24 ACCELL/SQL: Writing Form Scripts (for information about selected sets) Path for the directory in which ACCELL/M anager stores temporary files for selected sets. For best application performance, set AMGR_SEL_SET_DR to different paths for different users. AMGR_SEL_SET_DR Configuration Variable Dependencies: Requires the correct path format for the operating system Valid values: Any valid path Default value: UNIX: ”/usr/tmp” Example: UNIX: ”/usr/Apps/Accts/tmp” Additional help: ACCELL/SQL: Writing Form Scripts (for information about selected sets) Configuration Variable Reference AMGR_SKIP_OC2F_ NAIF Summary Improves the compatibility between ACCELL/SQL and ACCELL/IDS by allowing the ON CLEAR TO FIND section to fire only when a ON CLEAR TO FIND command is executed while in ADD/UPDATE mode. Setting AMGR_SKIP_OC2F_NAIF to TRUE sets ACCELL/SQL to behave in the same fashion as ACCELL/IDS . AMGR_STK_B_SZ Configuration Variable Valid values: TRUE ON CLEAR TO FIND section will not be fired only when a CLEAR TO FIND command is executed. FALSE ON CLEAR TO FIND section will be fired only when a CLEAR TO FIND command is executed. This is the default ACCELL/IDS behavior. AMGR_STK_B_SZ Summary Configuration Variable Reference Default value: FALSE Additional help: Unify ACCELL/IDS: Reference Size in bytes of a block in the stack used by ACCELL/M anager for storing form information that is needed for application startup. All information about the fields and trim on a form must fit in one stack block. AMGR_STK_B_SZ Configuration Variable Dependencies: The maximum number of bytes depends on hardware capacities Valid values: A positive integer Default value: Hardware-dependent Example: 16384 4k Additional help: None 25 AMSHMKEY (Unify DataServer RDBMS only) Key that identifies the segment of shared memory that is used by ACCELL/M anager. This configuration variable can be set only from a configuration file. Warning Always shut down the database and clean up shared memory before trying to change a shared memory key value. Changing a shared memory key while the database is running can corrupt the database. If you want to change a shared memory key configuration variable, take these steps: 1. Run shutdb to shut down the database. 2. Run shmclean to clean up shared memory. 3. Reset the shared memory key configuration variable. Summary AMSHMKEY Configuration Variable Dependencies: Used only on Unify DataServer RDBMS Valid values: A positive integer Default value: 6904 Additional help: Unify DataServer: Managing a Database Unify DataServer: Configuration Variable and Utility Reference AMTFMT Default format template to be used to display AMOUNT data. A dollar sign ($) in the AMTFMT variable indicates the position of the currency symbol that is specified by CURRSYM . A comma (,) in the AMTFMT variable indicates the position of the triad separator that is specified by TRIADSEP. A period (.) in the AMTFMT variable indicates the position of the radix separator that is specified by RADIXSEP. When you use AMTFMT to position the currency symbol on the right, use only one dollar sign, regardless of the number of characters in the currency symbol. For example, if AMTFMT is set to ”###,##&.&&$” (with a single $ on the right), and CURRSYM is set to ”XXX”, the amount 123456.78 is displayed as 123,456.78XXX . 26 Configuration Variable Reference Summary AMTFMT Configuration Variable Dependencies: Used with AMTPREC, CURRSYM, RADIXSEP, and TRIADSEP configuration variables Valid values: Any valid AMOUNT format template that is recognized by ACCELL/SQL or RPT, or the C language printf( ) function format. The value must be enclosed in quotation marks (”print_format”). Default value: ”%1.2lf” Example: ”%.2f” ”###,##&.&&” Additional help: AMTPREC configuration variable description on page 28 CURRSYM configuration variable description on page 39 RADIXSEP configuration variable description on page 69 TRIADSEP configuration variable description on page 79 DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application Configuration Variable Reference 27 AMTNULLCH Summary Null display character for AMOUNT data. The character specified in AMTNULLCH overrides NULLCH for AMOUNT data. AMTNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”character”) Default value: ”*” Example: ”#” Additional help: NULLCH configuration variable description on page 62 “Format Templates” in ACCELL/SQL: Localizing an Application AMTPREC Display precision (number of digits following the radix separator) for AMOUNT data. If AMTPREC is set to zero (”0”), neither the radix separator nor the digits following the radix separator are displayed. Summary AMTPREC Configuration Variable Dependencies: Used with AMTFMT, CURRSYM, RADIXSEP, and TRIADSEP configuration variables. Valid values: Any integer greater than or equal to 0 (This value must be enclosed in quotation marks: ”integer”) Default value: ”2” Example: ”0” Additional help: AMTFMT configuration variable description on page 26 CURRSYM configuration variable description on page 39 RADIXSEP configuration variable description on page 69 table continued on next page 28 Configuration Variable Reference AMTPREC Configuration Variable (continued) TRIADSEP configuration variable description on page 79 DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application AMTROUND Value at which AMOUNT data is rounded up before being displayed. For example, when AMTROUND is set to ”5”, digits 0 through 4 are rounded down, and 5 through 9 are rounded up. If AMTROUND is set to ”3”, the amount 123.393 rounds to 123.40. Summary AMTROUND Configuration Variable Valid values: Any integer from 0 through 9. (This value must be enclosed in quotation marks: ”integer”) Default value: ”5” Example: ”5” Additional help: AMTFMT configuration variable description on page 26 DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application APPMAP Configuration Variable Reference Directory path and file name for the application database map file to be used to access databases in an ACCELL/SQL application system. Set this variable only if you have an application system in which you have multiple applications that access different databases. 29 Each entry of the application database map file contains two columns: The first column contains the directory path and file name of the application link file (.al). The second column contains the values of the configuration variables that are used to locate the application database. Summary APPMAP Configuration Variable Dependencies: The first column of the referenced application database map file requires the correct path and file name formats for the operating system. The format and content of the second column depends on the underlying RDBMS: 30 S For INFORMIX SE, use the values of the DBPATH and INFORMIXDIR configuration variables, separated by a space. S For INFORMIX OnLine, use the values of the INFORMIXDIR and TBCONFIG configuration variables, separated by a space. S For INGRES, use the value of the DBNAME configuration variable. S For ORACLE, use the value of the ORACLE_SID configuration variable. S For SYBASE SQL Server, use the values of the SYBASE and DSQUERY configuration variables, separated by a space. S For Unify DataServer use the value of the DBPATH configuration variable. Valid values: Any valid path and file name Default value: None Example: UNIX: ”/usr/ASQL/Apps/AppMap” Additional help: “Building Application Systems” in ACCELL/SQL: Managing an Application Configuration Variable Reference APPRESDIR (X Window variable used with Motif UI option only) Used with the Motif UI option, specifies the path for the directory that contains the application resource file if the file is not in $XAPPRESLANGPATH. The application resource file is named AccellM. This path name must end with a slash (/); for example, /usr/acct/aclapp/. APPRESDIR is an X Window environment variable that you can set for your application. This variable can be set only at the operating system command level and cannot be specified in a configuration file. Summary APPRESDIR Configuration Variable Dependencies: Used only with Motif UI option. Requires the correct path format for the operating system. Valid values: Any valid path, ending with a slash character (/) Default value: N/A Example: UNIX: ”/usr/acct/aclapp/” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface ATERMCAP Directory path and file name for the termcap file provided with your ACCELL/SQL release. The ACCELL/SQL termcap may contain different settings from those found in your operating system’s termcap file. ACCELL/SQL needs the terminal capabilities settings specified in the ACCELL/SQL termcap to run correctly. Having two termcap files enables you to use your standard termcap for non-ACCELL/SQL activities (such as vi or RDBMS utilities) and use the ACCELL/SQL termcap for running ACCELL/SQL . If ATERMCAP is not defined, ACCELL/SQL uses TERMCAP to access the termcap file. Summary ATERMCAP Configuration Variable Dependencies: Requires the correct path and file name formats for the operating system Valid values: Any valid path and file name table continued on next page Configuration Variable Reference 31 ATERMCAP Configuration Variable (continued) BOLNULLCH Summary Default value: ”” Example: UNIX: ”/ASQL/lib/termcap” Additional help: ACCELL/SQL: Setting Up a User Environment Null display character for BOOL data. The character specified in BOLNULLCH overrides NULLCH for BOOL data. BOLNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”character”) Default value: ”*” Example: ”#” Additional help: NULLCH configuration variable description on page 62 “Format Templates” in ACCELL/SQL: Localizing an Application BOOLFMT Default format template to be used to display Boolean (BOOL) data. In American English format, a Boolean value is generally displayed as YES or NO or as TRUE or FALSE. Do not set BOOLFMT at runtime to a larger size than the Boolean field was defined as in ACCELL/G enerator. For example, if the field was created with the default Boolean three-character-wide format, and you set BOOLFMT to ”TRUE/FALSE”, the value will be truncated to TRU or FAL. Error message –8895 will be displayed: The screen field is not wide enough for the formatted value. Summary BOOLFMT Configuration Variable Valid values: Two Boolean values, up to five characters each, separated by a slash character ( / ) and enclosed in quotation marks (”positive_value /negative_value ”) table continued on next page 32 Configuration Variable Reference BOOLFMT Configuration Variable (continued) Default value: ”YES/NO” Example: ”JA/NEIN” Additional help: DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application CH_BURST_CHK Maximum time, measured in tenths of a second, between receipt of each character of a character burst that represents a special terminal key, such as a function key. If the number of tenths of a second between each character read is greater than the value specified by CH_BURST_CHK , the character is assumed to be a standalone character. A value of 1 is adequate for most cases, but if the terminal input is especially slow, as when transmitting through a modem or over a network, CH_BURST_CHK may need to be set to a higher value. The effects of CH_BURST_CHK depend partially on whether the CH_OLD_BURST configuration variable is also set: CH_BURST_CHK is used when the CH_OLD_BURST configuration variable is set to FALSE and ACCELL/M anager is not running off a pipe. If ACCELL/M anager is running off a pipe (for example, when an ACCELL/SQL application is started from Menu Handler), the CH_BURST_CHK configuration variable is not used, regardless of the CH_OLD_BURST value. When running off a pipe, ACCELL/M anager uses the ndelaypad value specified in the unicap file. If CH_OLD_BURST is set to TRUE, it overrides CH_BURST_CHK so that the ndelaypad entry in the unicap file is used instead. Configuration Variable Reference 33 The CH_BURST_CHK configuration variable affects special character reads when you use ACCELL/M anager or ACCELL/G enerator. The advantage of using CH_BURST_CHK is that it results in blocked (delayed) reads that allow the CPU to perform other tasks while it waits for the character burst. With ndelaypad, your application consumes more CPU time because of the number of reads that must be performed. Summary CH_BURST_CHK Configuration Variable Valid values: 1 through 127 Default value: 1 Additional help: CH_OLD_BURST configuration variable description on page 34 ndelaypad description in ACCELL/SQL: Setting Up a User Environment CH_OLD_BURST Flag that indicates whether ACCELL/SQL is to use ndelaypad to determine how to read character bursts for special characters instead of using the value specified by CH_BURST_CHK . ndelaypad is set in the system section of the unicap file and specifies the number of no delay reads to be performed to get each character from the terminal. Setting CH_OLD_BURST to TRUE overrides the CH_BURST_CHK configuration variable, so that ndelaypad is used. ndelaypad is also used automatically when you run AMGR off a pipe, even if CH_OLD_BURST is set to FALSE. The CH_OLD_BURST configuration variable affects special character reads when you use ACCELL/M anager or ACCELL/G enerator. The advantage of using ndelaypad is that you can achieve finer granularity if the number of reads specified can be performed in less than one-tenth of a second. However, use of ndelaypad can use up CPU time because ndelaypad causes ACCELL/SQL to keep performing reads until the maximum ndelaypad value is reached. 34 Configuration Variable Reference Summary CH_OLD_BURST Configuration Variable Valid values: TRUE ACCELL/SQL continues to use ndelaypad FALSE ACCELL/SQL uses the value specified in the CH_BURST_CHK configuration variable Default value: TRUE Additional help: CH_BURST_CHK configuration variable description on page 33 ndelaypad description in ACCELL/SQL: Setting Up a User Environment CH_TIMER_CHK (Character mode only) Maximum time, measured in tenths of a second, between tests for a timer. When ACCELL/M anager is running off a pipe, the CH_TIMER_CHK value is rounded to the nearest full second. (Because reads off a pipe cannot be interrupted ACCELL/SQL must depend on the UNIX time command, which has a precision of seconds.) This variable is valid only when ACCELL/M anager is running with a character user interface, that is, when the ACLPRESMODE configuration variable is set to ”CHARACTER”. Set the CH_TIMER_CHK configuration variable to a value that is smaller than the time specified for the timer that has the shortest firing time in the application. Otherwise, if you set CH_TIMER_CHK to a longer value, you will delay the servicing of that timer. For example, the following statement installs a timer that is called after 10 seconds: CREATE TIMER EVENT $Atimer IN 10 SECONDS . . . If the CH_TIMER_CHK configuration variable is set to 5, every five-tenths of a second ACCELL/M anager tests for whether 10 seconds has passed, when the user is stopped on a field for input. Configuration Variable Reference 35 Summary CH_TIMER_CHK Configuration Variable Dependencies: Used only with the character UI option. (If set, this variable has no effect on an application that is run with graphical UI options because they handle timers as X events.) Valid values: 1 through 127 Default value: 1 Additional help: ACCELL/SQL: Setting Up a User Environment ACCELL/SQL: Writing Form Scripts CLEAR_FLD_MODE Summary Mode in which the CLEAR FIELD command is executed. Attempting to update a row in the database from a target table variable that is UNDEFINED is considered an error when CLEAR_FLD_MODE is set to STRING or NONE. CLEAR_FLD_MODE Configuration Variable Valid values: ALL All column types are set to spaces. The user can leave the field from a STRING column. Attempting to leave the field from other data types results in an error window. NONE All data types are set to UNDEFINED. The user can leave the field from all data types. STRING A string column is set to spaces. All other data types are set to UNDEFINED. The user can leave the field from all data types. Default value: Additional help: 36 STRING CLEAR FIELD command description in ACCELL/SQL: Using an Application Configuration Variable Reference CMDSCOPE Indicator that specifies the scope of attributes for all ACCELL/SQL predefined commands. CMDSCOPE has no effect on commands that are defined by the developer with the ACCELL/4GL DEFINE COMMAND statement. Summary CMDSCOPE Configuration Variable Valid values: ”LOCAL” ACCELL/SQL command attributes are in effect only when executing the form that is associated with the form script in which the attributes are set. ”GLOBAL” ACCELL/SQL command attributes are in effect throughout the application, regardless of the current form or the form script in which the attributes are set. The values can be specified in uppercase or lowercase letters. Default value: ”LOCAL” Additional help: ACCELL/SQL: Writing Form Scripts The SET COMMAND statement description in ACCELL/SQL: Script and Function Reference CONFIG_READONLY Local configuration variable override status. CONFIG_READONLY specifies whether the variables in the configuration file in which CONFIG_READONLY is set can be overridden by setting them in a higher level configuration file or at the operating system command level. CONFIG_READONLY can be set only in a configuration file. You can use CONFIG_READONLY to protect the application configuration file against user changes at the operating system command level. Configuration Variable Reference 37 Summary CONFIG_READONLY Configuration Variable Valid values: TRUE All configuration variables in the configuration file except database location variables are readĆonly. These are the database location configuration variables for each RDBMS : INFORMIX OnLine: INFORMIXDIR and TBLCONFIG. INFORMIX SE: DBPATH and INFORMIXDIR. INGRES: DBNAME. ORACLE: ORACLE_HOME and ORACLE_SID. SYBASE SQL Server: DSQUERY and SYBASE. Unify DataServer: DBPATH and DBNAME. FALSE Configuration variables in the configuration file can be overridden by setting them in a higher level configuration file or at the operating system command level Default value: FALSE Additional help: “Configuring an Application Environment” in ACCELL/SQL: Managing an Application ACCELL/SQL: Setting Up a User Environment CTRLCABT Control-C-Abort flag that determines whether the current transaction is rolled back when the user presses CONTROL C to exit the application. Summary CTRLCABT Configuration Variable Valid values: TRUE ACCELL/SQL rolls back the current transaction FALSE 38 ACCELL/SQL commits the current transaction Default value: FALSE Additional help: ACCELL/SQL: Using an Application, ACCELL/SQL: Writing Form Scripts Configuration Variable Reference CURRSYM Currency symbol that is used when displaying AMOUNT data. This configuration variable is used only when a format template is used. A format template can be specified in several ways: in a USING clause in an ACCELL/4GL form script in a using clause in an irs or RPT script in a DISPLAY_FORMAT field attribute in the AMTFMT configuration variable, set either at the operating system command level or in a configuration file Summary DATEFMT CURRSYM Configuration Variable Dependencies: Used with a format template or AMTFMT, and TRIADSEP and RADIXSEP Valid values: 1 to 3 print characters enclosed in quotation marks (”characters”) Default value: ”$” Example: ”DM” ”xxx” Additional help: “Currency Amount Display Format Search Priority” in ACCELL/SQL: Managing an Application Default format in which to accept and display dates. When specifying a date format, follow these guidelines: The date format separator character can be a slash (/), a dash (–), a dot (.), or a space ( ), as shown in these examples: ”DD/MM/YY” ”DD–MM–YY” ”DD.MM.YY” ”DD MM YY” The month, day, and year can be specified in any order, as shown in these examples: ”DD/MM/YY” ”MM/DD/YY” ”YY/MM/DD” Configuration Variable Reference 39 The year can be specified as a two-character or four-character year, as shown in these examples: ”DD/MM/YYYY” ”YY/MM/DD” To specify the month as a number, use MM in the month portion of the date format specification. To specify a three-letter abbreviation for the month, as in May or Dec, use AAA. (The A characters must be specified in uppercase, although the month names will be displayed with initial capital letters only.) To specify that days and months less than 10 display as 1 through 9 rather than 01 through 09, use a single D and M. For example, to display June first, 1999, as 6/1/1999 , set DATEFMT to this value: ”M/D/YYYY” To display the entire month name, instead of just the first three letters, specify as many A characters as needed for the largest month name. Otherwise, the name will be truncated to the number of A characters specified. If the value is truncated, error message –8895 will be displayed: The screen field is not wide enough for the formatted value. For example, to display the date “12 September 1992,” set DATEFMT to this value: ”DD AAAAAAAAA YYYY” If you want to enter and display months in the local language, use the MON1 through MON12 configuration variables. You can enter DATE values without using separators under the following conditions: You must enter two digits for both the day and month values. You must enter each part (day, month, year) of the DATE value in the same order as defined in DATEFMT. If you enter 2–digit year values, you must have set CENTRUY_CUTOFF to an appropriate value. The default value is 00, which means that all 2–digit years fall in the range 1900 through 1999. Even if DATEFMT includes alphabetic characters for the month, you must enter months using two digits. You may enter a 4–digit year when DATEFMT specifies a 2–digit year (YY/MM/DD), or enter a 2– digit year when DATEFMT specifies a 4–digit year (DD.MM.YYYY). 40 Configuration Variable Reference The separator character you define in DATEFMT must differ from the search range metacharacter. The following are valid entries when DATEFMT is set as shown: YYYY MM DD 991210 YY/DD/MM 19991012 DD.MM.YYYY 101299 Dates with two digit years can cause some confusion if they fall outside a range defined by CENTURY_CUTOFF. To avoid this confusion, ACCELL/Manager now forces all dates that fall outside of this range to be displayed with 4 digits in the date. For example, if CENTURY_CUTOFF is set to 25, it defines the hundred year period 1925–2024. Thus, any date that falls in this range may be displayed on the screen with 2 digit years (1/1/25 = 1/1/1925; 3/1/24 = 3/1/2024). However, a year that falls outside of this hundred year window would always be displayed with 4 digits in the year, regardless of how DATEFMT is set ( 1/1/ 1924 = 01/01/1924 with DATEFMT=MM/DD/YY). Summary DATEFMT Configuration Variable Dependencies: Manipulation of DATE data depends in part on the underlying RDBMS Valid values: A combination of the letters D (day), M (numeric month) or A (alphabetic month), and Y (year) format characters, plus a separator character. The format template must be enclosed in quotation marks (”format_template”). Default value: ”MM/DD/YY” table continued on next page Configuration Variable Reference 41 DATEFMT Configuration Variable (continued) Example: See preceding bulleted list Additional help: “Date (or Time) Display Format Search Priority” in ACCELL/SQL: Managing an Application DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application DATNULLCH Null display character for DATE data. If DATNULLCH is set to ”*”, a null date displays as ********. The character specified in DATNULLCH overrides NULLCH for DATE data. Summary DATNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”character”) Default value: ”*” Example: ”#” Additional help: NULLCH configuration variable description on page 62 “Format Templates” in ACCELL/SQL: Localizing an Application 42 Configuration Variable Reference DBCHARSET Summary The locale name. This read-only configuration variable specifies the character set of the database. DBCHARSET Configuration Variable Valid values: 0 1 2 3 4 5 6 7 DBHOST (SYBASE SQL Server and Unify DataServer) ANSI, ISO–8859–X (all single byte character sets) Japanese SJIS Japanese EUC Korean EUC Simplified Chinese (EUC-CN, GBK) Traditional Chinese (BIG-5) UTF–8 Traditional Chinese (EUC-TW) Default value: ”0” Additional help: LANG configuration variable description On UNIX with SYBASE SQL Server: Name of the database server that contains the database to be used with ACCELL/SQL . If DBHOST is not set, the default server is the server that is specified by the SYBASE SQL Server DSQUERY configuration variable. On UNIX with Unify DataServer: Name of the host database machine to be used with UNIFY/Net. On Windows with SYBASE SQL Server: Indicator for a database server entry that is specified in the win.ini file. Database server entries are specified in the [SQLSERVER] section in win.ini. Each database server entry identifies the database server to be used for a specific application. For example, for an ACCELL/SQL application that is run in Windows with a SYBASE SQL Server database, a server entry in win.ini serves the same purpose as the DSQUERY configuration variable on UNIX. Set the DBHOST configuration variable in the application configuration file. Then, if you run two applications in ACCELL/SQL for Windows, each application can use its own server. Configuration Variable Reference 43 For example, the win.ini server entry for application app_a is dsquery=value, and the win.ini server entry for application app_b is bserver=value. For app_a, the DBHOST configuration variable is set to ”dsquery” in app_a.cf. For app_b, DBHOST is set to ”bserver” in app_b.cf. Summary DBHOST Configuration Variable Dependencies: UNIX: Used only with SYBASE SQL Server and Unify DataServer. Windows: Used only with SYBASE SQL Server. Valid values: Any valid server name (SYBASE SQL Server) or host machine name (Unify DataServer) Default value: UNIX with SYBASE SQL Server: None (The server specified by DSQUERY is used.) UNIX with Unify DataServer: None (Local access facilities are used.) Windows with SYBASE SQL Server: None (The first entry in the [SQLSERVER] section in win.ini is used.) Example: UNIX: ”dbmach” Windows: ”dsquery” Additional help: Unify DataServer: UNIFY/Net Guide (for information about using DBHOST with Unify DataServer and UNIFY/Net) ACCELL/SQL: Developing an Application for Windows (for information about using DBHOST with an ACCELL/SQL for Windows application) DBNAME (INFORMIX , INGRES, SYBASE SQL Server, and Unify DataServer only) INFORMIX: The name of the database. For INFORMIX OnLine, the file name is the database name (which has no suffix); for INFORMIX SE, the file name is the database name without the .dbs file name suffix. For example, if /usr/accell/db/tutorial.dbs is the path and file name for the database, the name specified by DBNAME is tutorial. DBNAME must be set for ACCELL/SQL to run on INFORMIX. INGRES: The name of the database. The specified name can include the virtual node name and the server type. 44 Configuration Variable Reference SYBASE SQL Server: The name of the database to be used in the server that is specified in DSQUERY. If DBNAME is not set, then ACCELL/SQL uses the default database for the user. Unify DataServer: The name of the database root file, excluding the directory path. The base of the specified name is used to build the application configuration file name when using ACCELL/SQL with the Unify DataServer RDBMS. For example, if DBNAME is set to accts.db, the application configuration file is named accts.cf. Summary DBNAME Configuration Variable Dependencies: Usage depends on the underlying RDBMS Valid values: INFORMIX: The simple file name of the database, excluding the .dbs suffix, if the name has one. INGRES: The database name, which can include the virtual node name and the server type, if specified in this format: [virtual_node_name::]dbname[/server_type] SYBASE SQL Server and Unify DataServer: A simple file name; the specified name cannot contain slashes (/) or backslashes (\). Default value: SYBASE SQL Server: the user’s default database Unify DataServer: ”file.db” Example: Unify DataServer: ”accts.db” SYBASE SQL Server: ”pubs” INFORMIX: ”tutorial” Additional help: Configuration Variable Reference ACCELL/SQL: RDBMS Integration 45 DBPATH (Unify DataServer and INFORMIX SE only) INFORMIX SE: The paths of one or more database directories, separated by colons (:). Each of these directories may contain databases. The DBPATH variable enables ACCELL/SQL to search for the database in places other than the current directory. For example, if the full path names of your database directories are /usr/accell/db/tutorial.dbs and /usr/infsql/db/accts.dbs , then DBPATH is set to /usr/accell/db:/usr/infsql/db . Unify DataServer: The directory path, excluding the file name, for the database root file (file.db) and associated files such as .idx and .dbv files. This variable is used with DBNAME to find database files such as the compiled application configuration file, for example, file.cfg. The application runs faster if DBPATH is an absolute path name, such as “/usr/DB,” instead of a relative path name, such as “.” or “DB.” Summary DBTYPE DBPATH Configuration Variable Dependencies: Used only with Unify DataServer or INFORMIX SE Valid values: Any valid path Default value: UNIX: ”.” Example: UNIX: ”/usr/DB” Additional help: ACCELL/SQL: RDBMS Integration Type of database with which ACCELL/SQL is being used. This information is used to determine RDBMS functionality such as whether null values are supported and which system functions, configuration variables, and metacharacters are supported. INFORMIX : The DBTYPE configuration variable and the db_type$( ) system function cannot be used to differentiate among the versions and modes of INFORMIX (OnLine, SE, MODE ANSI). 46 Configuration Variable Reference Summary DBTYPE Configuration Variable Dependencies: Database type is specific to the underlying RDBMS Valid values: ”INFORMIX” for INFORMIX RDBMS ”INGRES” for INGRES RDBMS ”ORACLE” for ORACLE RDBMS ”SYBASE” for SYBASE SQL Server RDBMS ”U2000” for Unify DataServer RDBMS Default value: The type of RDBMS used by the release software Example: ”SYBASE” Additional help: ACCELL/SQL: Portability Guidelines ACCELL/SQL: RDBMS Integration db_type$( ) system function description in ACCELL/SQL: Script and Function Reference DBUSER (INGRES, ORACLE, SYBASE SQL Server, and Unify DataServer only) INGRES: The user name to be used to run the application. This lets an INGRES user who has been given super user permission through the INGRES accessdb utility run as another user. For INGRES, the DBUSER configuration variable has no password portion. ORACLE and SYBASE SQL Server: The user name and password to be used to log in to the database. These values must be specified in the form user_name/password. ACCELL/SQL supports use of the ORACLE 7 authentication of the user name by the operating system. The operating system login user name is then used to log in to the database. To specify this option, specify a user name of ”/” and no password; for example, set the DBUSER configuration variable to the value ”/”. See your ORACLE 7 Server Administrator’s Guide for information about authenticating users. Unify DataServer: The operating system user name and encrypted password to be used to access a remote database through the UNIFY/Net option. Configuration Variable Reference 47 Summary DBUSER Configuration Variable Dependencies: Usage depends on the underlying RDBMS Valid values: INGRES: A valid user name. ORACLE or SYBASE SQL Server: See the following table: Specifying DBUSER on SYBASE SQL Server or ORACLE" Unify DataServer: See the following table: Specifying DBUSER on Unify DataServer" Default value: ORACLE or SYBASE SQL Server: No default: if the user name and password are not specified, ACCELL/SQL prompts the user for them Unify DataServer: The current operating system user name with no password Additional help: “Logging in to the Database” in ACCELL/SQL: RDBMS Integration (SYBASE SQL Server or ORACLE only) Unify DataServer UNIFY/Net Guide (for information about using DBUSER with Unify DataServer and UNIFY/Net) Specifying DBUSER on SYBASE SQL Server or ORACLE If: Then: You specify both user_name and password The user_name and password must be separated by the slash (/) character, e.g., jones/mypswd You want to indicate a null password You must include the slash (/) character, e.g., jones/ You want ACCELL/SQL to prompt for Specify only the user name; omit the the password only slash character and password, e.g., jones You want ACCELL/SQL to prompt for Do not set DBUSER both the user name and the password 48 Configuration Variable Reference Specifying DBUSER on Unify DataServer DELIMFLD (Character mode only) Summary DFLTVCFILE (SYBASE SQL Server only) If: Then: You specify both user_name and password The user_name and password must be separated by the slash (/) character, and the password must be in encrypted form, e.g., bob/xxx No password is required The slash (/) character is optional, e.g., bob Flag that is used in character mode to indicate the default appearance of the current field on a form. Graphical user interfaces use the native GUI method to indicate the current field (for example, input focus). DELIMFLD Configuration Variable Dependencies: Used in character mode only; ignored by GUI Valid values: TRUE The current field is displayed in reverse video FALSE The current field is displayed in normal video Default value: TRUE Additional help: ACCELL/SQL: Creating Screen Forms Number of files that can be held open at one time to be used for maintaining selected set information for nested queries. This does not limit the number of nested queries allowed. Keeping files open for nested query selected sets reduces database access overhead. In general, the higher the number of files specified by DFLTVCFILE , the better the performance, except that you risk running out of file descriptors. Configuration Variable Reference 49 Summary DFLTVCMEM (SYBASE SQL Server only) DFLTVCFILE Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: Any integer up to the number of open files allowed by the operating system Default value: 5 Example: 7 Additional help: ACCELL/SQL: RDBMS Integration Size in bytes of the memory used by the nested query manager to store information needed to retrieve database rows selected by a nested query. If the selected set contains more bytes than specified by DFLTVCMEM , the nested query manager stores the rest of the selected set rows in a disk file. Memory is allocated based on the value of DFLTVCMEM , so be careful that you do not set the variable too high. A value of 10k is recommended. You can override the limit specified in DFLTVCMEM by using the set_cursor_mem_limit$( ) system function. Summary DFLTVCMEM Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: Any positive integer Default value: Value of the ACLVARMEMLIM configuration variable Example: 10000 Additional help: ACLVARMEMLIM configuration variable description on page 15 DFLTVCFILE configuration variable description on page 49 ACCELL/SQL: RDBMS Integration 50 Configuration Variable Reference DSQUERY (SYBASE SQL Server RDBMS variable) Summary EDIT Default name of the database server that contains the database to be used with ACCELL/SQL . If the DBHOST configuration variable is not set, the default server is the server that is specified by the SYBASE SQL Server DSQUERY configuration variable. DSQUERY Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: Any valid server name Default value: The first database server name listed in the SYBASE SQL Server interfaces file Example: dbrus Additional help: ACCELL/SQL: Setting Up a User Environment ACCELL/SQL: RDBMS Integration File name and optional directory path for a text editor or word processor. The specified text editor or word processor is used in these cases: You choose the “Editor” option from ACCELL/SQL Menu Handler Main menu. You choose “Edit ACCELL/4GL Script” from the Operation menu in ACCELL/SQL Development Environment. You press EDIT FILE while the cursor is on a variable-length TEXT field. You execute the edit command from ACCELL/SQL Interactive Debugger—a separately licensed ACCELL/SQL option. This variable can be set only at the operating system command level and cannot be specified in a configuration file. Summary EDIT Configuration Variable Dependencies: Requires the correct path and file name formats for the operating system Valid values: Any valid text editor or word processor file name, optionally preceded by a directory path table continued on next page Configuration Variable Reference 51 EDIT Configuration Variable ERRCH Default value: UNIX: ”vi” Example: UNIX: ”/usr/bin/vi” Additional help: ACCELL/SQL: Writing Form Scripts, ACCELL/SQL: Creating Reports with RPT Report Writer Error display character that is displayed when a field has a data overflow, data underflow, or other data error. Summary EXPL_MODE ERRCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”character”) Default value: ”?” Example: ”*” Additional help: ACCELL/SQL: Creating Reports with RPT Report Writer Flag that indicates whether ACCELL/M anager uses explicit mode to search for strings. This variable sets the default search mode for all forms. To change the search mode for a specific form at runtime, use the explicit_mode$( ) system function. Tip When you document your application for end-users, tell them how to enter search criteria. If you do not want them to have to determine whether to add the match many metacharacter to the end of their search criteria, in the AFTER FIELD section add the metacharacter if it is needed. 52 Configuration Variable Reference Summary EXPL_MODE Configuration Variable Dependencies: The metacharacter that is used to match many characters depends on the RDBMS. For example, the default match many metacharacter used by Unify DataServer is the asterisk (*), and the default used by SYBASE SQL Server is the percent sign (%). Valid values: TRUE String field values must match explicitly specified search criteria. The search criteria can include string search metacharacters. FALSE If the field being searched is not a primary key, ACCELL/Manager performs pattern matching. ACCELL/Manager appends the match many metacharacter to the end of the search string before starting the search. If the field that is being searched is a primary key, setting EXPL_MODE to FALSE has no effect. Pattern matching is not performed. Default value: FALSE Additional help: SEARCH_RANGES attribute and the explicit_mode$( ) system function descriptions in ACCELL/SQL: Script and Function Reference. For the metacharacters to be used with each RDBMS, see ACCELL/SQL: RDBMS Integration. FKEYGAPS (Character mode only) Summary Flag that indicates whether function key prompts are displayed with gaps where function keys are not currently active. If set to TRUE, function key prompts are displayed with gaps. FKEYGAPS Configuration Variable Dependencies: Affects character user interfaces only. Valid values: TRUE Function key prompts are displayed with a gap where a function key is not currently active. FALSE Function key prompts are displayed with no gaps. table continued on next page Configuration Variable Reference 53 FKEYGAPS Configuration Variable (continued) FLTFMT Default value: TRUE Additional help: ACCELL/SQL: Creating Screen Forms for information about defining function key prompts on a screen form Default format template to be used to display FLOAT data. Summary FLTFMT Configuration Variable Valid values: Any valid FLOAT print format that is recognized by ACCELL/SQL, irs, RPT, or the C language printf( ) function format. The value must be enclosed in double quotation marks (”print_format”). Default value: ”%g” Example: ”###,##&.&&” Additional help: DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application FLTNULLCH Null display character for FLOAT data. The character specified in FLTNULLCH overrides NULLCH for FLOAT data. Summary FLTNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”character”). Default value: ”*” table continued on next page 54 Configuration Variable Reference FLTNULLCH Configuration Variable (continued) Example: ”#” Additional help: NULLCH configuration variable description on page 62 “Format Templates” in ACCELL/SQL: Localizing an Application FLTROUND Value at which FLOAT data is rounded up before being displayed. For example, if FLTROUND is set to ”5”, digits 0 through 4 are rounded down, and digits 5 through 9 are rounded up. Summary FLTROUND Configuration Variable Valid values: Any integer from 0 through 9. (This value must be enclosed in quotation marks: ”integer”) Default value: ”5” Additional help: DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application II_CHECKPOINT (INGRES RDBMS variable) Configuration Variable Reference Full directory path for the default checkpoint location. The II_CHECKPOINT variable is set at the installation level by the INGRES SA and affects all users who are using the same installed release of INGRES. This variable can be overridden only when the database is created. 55 Summary II_CHECKPOINT Configuration Variable Dependencies: Used only with INGRES RDBMS. Valid values: See INGRES database administration manuals Additional help: ACCELL/SQL: RDBMS Integration and INGRES Database Administrator’s Guide II_DATABASE (INGRES RDBMS variable) Summary Full directory path for the default database location. The II_DATABASE variable is set at the installation level by the INGRES SA and affects all users who are using the same installed release of INGRES. This variable can be overridden only when the database is created. II_DATABASE Configuration Variable Dependencies: Used only with INGRES RDBMS. Valid values: See INGRES database administration manuals Additional help: ACCELL/SQL: RDBMS Integration and INGRES Database Administrator’s Guide II_DUMP (INGRES RDBMS variable) Default directory path for the dump log files to be used in online backups. The II_DUMP variable is set at the installation level by the INGRES SA and affects all users who are using the same installed release of INGRES. This variable can be overridden only when the database is created. Summary II_DUMP Configuration Variable Dependencies: Used only with INGRES RDBMS. table continued on next page 56 Configuration Variable Reference II_DUMP Configuration Variable (continued) Valid values: See INGRES database administration manuals Additional help: ACCELL/SQL: RDBMS Integration and INGRES Database Administrator’s Guide II_GCNxx_RMT_ VNODE (INGRES RDBMS Name of the default node to be used for INGRES/Net when no node is specified. variable) Summary II_GCNxx_RMT_VNODE Configuration Variable Dependencies: Used only with INGRES RDBMS. Valid values: See INGRES database administration manuals Additional help: ACCELL/SQL: RDBMS Integration and INGRES Database Administrator’s Guide II_JOURNAL (INGRES RDBMS variable) Full directory path for the default journal location. The II_JOURNAL variable is set at the installation level by the INGRES SA and affects all users who are using the same installed release of INGRES. This variable can be overridden only when the database is created. Summary II_JOURNAL Configuration Variable Dependencies: Used only with INGRES RDBMS. Valid values: See INGRES database administration manuals Additional help: ACCELL/SQL: RDBMS Integration and INGRES Database Administrator’s Guide Configuration Variable Reference 57 II_SYSTEM (INGRES RDBMS variable) Summary Path for the parent directory of the INGRES RDBMS release software. II_SYSTEM Configuration Variable Dependencies: Used only with INGRES RDBMS. Valid values: See INGRES database administration manuals Additional help: ACCELL/SQL: RDBMS Integration and INGRES Database Administrator’s Guide INFORMIXDIR (INFORMIX RDBMS variable) Summary LANG Path of the directory where the INFORMIX RDBMS release is installed. INFORMIXDIR Configuration Variable Dependencies: Used only with INFORMIX RDBMS. Requires the correct path format for the operating system. Valid values: Any valid path Default value: None Example: UNIX: ”/usr/INFRMXDB” Additional help: ACCELL/SQL: RDBMS Integration The collating sequence locale name. The collating sequence locale name also determines the character set used to build the database. The locale name that you specify is dependent on your operating system. Some common multilingual Solaris 8 locale names are: en_US.UTF–8 C de_DE.ISO8859–1 en_US en_US.ISO8859–1 fr_FR.ISO8859–1 ja_JP.eucJP zh_CN.EUC zh.GBK zh_CN.GBK zh.UTF–8 58 Configuration Variable Reference On UNIX, you can display the available locale names for your host by using the locale –a command. If you set LANG to a UNICODE value, you can use non-alphanumeric characters in database object names, such as table names. The ASCII symbols, * % ! @ | , and so on, are still restricted from database object names. This configuration variable can be set in the database configuration file (dbname.cf) or in the environment. If it is set in both, the setting in dbname.cf is used. Summary LANG Configuration Variable Valid values: Any valid locale name on your host Default value: ”C” (for the local ASCII collating sequence) Example: ”de_DE.ISO8859-1” Each database is created based on the current locale as specified by the LANG configuration variable. To access the database, you must have the LANG configuration variable set to the value in effect when the database was created. LANGDIR The current language library directory name in $UNIFY. This directory contains any localized message files. English and Japaense message files are available by default. You can create a directory under $UNIFY that contains your application’s localized files. Summary Configuration Variable Reference LANGDIR Configuration Variable Valid values: Any valid directory name under $UNIFY Default value: ”” 59 LENONULL (INFORMIX RDBMS only) Summary M_LIBS (Motif UI option only) Flag that indicates whether zero-length strings are to be treated as null values or non-null values. LENONULL Configuration Variable Dependencies: Used only with INFORMIX RDBMS Valid values: TRUE ZeroĆlength strings are treated as null values. FALSE ZeroĆlength strings are treated as nonĆnull values. Default value: FALSE Example: TRUE Additional help: ACCELL/SQL: RDBMS Integration Link directive that indicates the directory path and file names for the Motif user interface libraries. These libraries are used by the amgr.ld script for loading a custom AMGR. To use the amgr.ld utility, first set these variables at the operating system command level, then add the path names where the archives can be found on your system. Warning Sun systems only: If you do not specify a path name link directive for M_LIBS, the linker by default uses the Sun OS LD_LIBRARY_PATH configuration variable to find the libraries to be linked to. You cannot use the same LD_LIBRARY_PATH specification to link both a custom manager for Motif and a custom manager for OPEN LOOK. To try to do so can result in severe errors and undesirable side effects during runtime. Therefore, do not rely on defaulting to LD_LIBRARY_PATH. Instead, use path name directives in the M_LIBS and OL_LIBS specifications. 60 Configuration Variable Reference Summary M_LIBS Configuration Variable Dependencies: Used only with Motif UI option. Requires the correct path and file name formats for the operating system. Valid values: Any valid path Default value: ”–lXm –lXt –lXll” Example: ”–L/usr/localnet/sun4/motif.1.1.3/lib –lXm –lXt –lXll” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface MON1, MON2, MON3, MON4, MON5, MON6, MON7, MON8, MON9, MON10, MON11, MON12 Summary Names of the months in the local language, for example, in English, French, or German. When you set the MON1 through MON12 configuration variables, use the month name format (AAA) to specify the month in the DATEFMT configuration variable. To display the entire month name, instead of just the first three letters, use as many A characters as needed for the largest month name. For example, to display the date “12 September 1992,” you set DATEFMT to ”DD AAAAAAAAA YYYY”. MON1 . . . MON12 Configuration Variables Valid values: For each variable, name of the associated month in the local language, enclosed in quotation marks (”month_name”). Default values: English language month names in all-uppercase Examples: English MON1: ”January” German MON2: ”Februar” English MON5: ”May” French MON7: ”Juillet” Additional help: DATEFMT configuration variable description on page 39 DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference table continued on next page Configuration Variable Reference 61 MON1 . . . MON12 Configuration Variables (continued) print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application NULLCH Default null display character for all data types. You can override this variable by specifying a default null display character for each displayable data type: AMOUNT, BOOL, DATE, FLOAT, NUMERIC, STRING, TIME, and TEXT. Summary NULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”Character”) Default value: ”*” Example: ”#” Additional help: AMTNULLCH configuration variable description on page 28 BOLNULLCH configuration variable description on page 32 DATNULLCH configuration variable description on page 42 FLTNULLCH configuration variable description on page 54 NUMNULLCH configuration variable description on page 63 STRNULLCH configuration variable description on page 73 TIMNULLCH configuration variable description on page 79 table continued on next page 62 Configuration Variable Reference NULLCH Configuration Variable (continued) TXTNULLCH configuration variable description on page 80 “Format Templates” in ACCELL/SQL: Localizing an Application NUMFMT Default format template to be used to display NUMERIC data. Summary NUMFMT Configuration Variable Valid values: Any valid NUMERIC print format that is recognized by ACCELL/SQL, irs, or RPT, or the C language printf( ) function format. The value must be enclosed in quotation marks (”print_format”). Default value: ”%d” Example: ”###,##&” Additional help: DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application NUMNULLCH Summary Null display character for NUMERIC data. The character specified in NUMNULLCH overrides NULLCH for NUMERIC data. NUMNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”Character”) Default value: ”*” table continued on next page Configuration Variable Reference 63 NUMNULLCH Configuration Variable Example: ”#” Additional help: NULLCH configuration variable description on page “Format Templates” in ACCELL/SQL: Localizing an Application OL_LIBS (OPEN LOOK UI option only) Link directive that indicates the directory path and file names for the OPEN LOOK user interface libraries. These libraries are used by the amgr.ld script for loading a custom AMGR. If you do not add a link directive for the directory path, the linker by default uses the LD_LIBRARY_PATH configuration variable to find the libraries. Warning Sun Systems only: If you do not specify a path name link directive for OL_LIBS, the linker by default uses the Sun OS LD_LIBRARY_PATH configuration variable to find the libraries to be linked to. You cannot use the same LD_LIBRARY_PATH specification to link both a custom manager for Motif and a custom manager for OPEN LOOK. To try to do so can result in severe errors and undesirable side effects during runtime. Therefore, do not rely on defaulting to LD_LIBRARY_PATH. Instead, use path name directives in the M_LIBS and OL_LIBS specifications. Summary OL_LIBS Configuration Variable Dependencies: Used only with OPEN LOOK UI option. Requires the correct path and file name formats for the operating system. Valid values: Any valid path table continued on next page 64 Configuration Variable Reference OL_LIBS Configuration Variable (continued) Default value: ”–lXol –lXt –lXll” Example: ”–L/usr/localnet/sun4/motif.1.1.3/lib –lXol –lXt –lXll” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface OPENWINHOME (X Window variable used with OPEN LOOK UI option only) Summary Directory path used by the OPEN LOOK Intrinsics Toolkit provided by Sun Microsystems, Inc. This variable is an X Window environment variable that must be set at the operating system command level and cannot be specified within a configuration file. OPENWINHOME Configuration Variable Dependencies: Used only with OPEN LOOK UI option. Requires the correct path format for the operating system. Valid values: Any valid directory search path specification Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface OPNARCHS Number of ACCELL/M anager form archives (.fa files) that can be open at one time. Summary OPNARCHS Configuration Variable Dependencies: Used only on versions of the UNIX operating system in which the allowed number of file descriptors is limited to 25 or less Valid values: Positive integers table continued on next page Configuration Variable Reference 65 OPNARCHS Configuration Variable (continued) ORACLE_HOME (ORACLE RDBMS variable) Summary Default value: 5 Example: 8 Path for the directory where the ORACLE RDBMS release is installed. The ORACLE release directory is where ACCELL/SQL searches for ORACLE error messages; it is also the directory that contains ORACLE utilities, such as sqlload. ORACLE_HOME Configuration Variable Dependencies: Used only on ORACLE RDBMS. Requires the correct path format for the operating system. Valid values: Any valid path Example: UNIX: ”/usr/Oracle_Rel” Additional help: ACCELL/SQL: Setting Up a User Environment ACCELL/SQL: RDBMS Integration ORACLE_SID (ORACLE RDBMS variable) ORACLE system identifier for a unique SGA (system global area). An SGA is a memory region that contains the following information for an ORACLE instance. information, such as locking information, that is shared between processes database buffers data dictionary information Summary ORACLE_SID Configuration Variable Dependencies: Used only on ORACLE RDBMS Valid values: Up to 32 alphanumeric characters table continued on next page 66 Configuration Variable Reference ORACLE_SID Configuration Variable (continued) Default value: None Example: test Additional help: ACCELL/SQL: Setting Up a User Environment ACCELL/SQL: RDBMS Integration OSEC2WAIT (INFORMIX , INGRES, ORACLE, and SYBASE SQL Server only) Number of seconds to wait for locks. If a lock is not obtained by the end of the specified time, ACCELL/M anager assumes that the object is already locked and gives up the lock attempt. If OSEC2WAIT is not set or is set to 0, ACCELL/M anager waits indefinitely. To escape a waiting condition, the user can press INTERRUPT. In this case, the manager assumes that a lock conflict has occurred and gives up waiting for the lock. The number of seconds to wait for locks is initialized by the OSEC2WAIT configuration variable, but can be changed during runtime by using the l_wait_time$( ) ACCELL/4GL function. To specify whether users can interrupt database operations, use the l_allow_interrupt$( ) system function. Summary OSEC2WAIT Configuration Variable Dependencies: Used only on INFORMIX, ORACLE, and SYBASE SQL Server RDBMS Valid values: Any integer Default value: 0 Example: 10 Additional help: l_wait_time$( ) system function and l_allow_interrupt$( ) system function descriptions in ACCELL/SQL: Script and Function Reference ACCELL/SQL: RDBMS Integration Configuration Variable Reference 67 PAGELN (RPT and irs only) Summary PATH (UNIX only) Length of a report page in number of lines. PAGELN Configuration Variable Dependencies: Used only by Report Writer through RPT or irs Valid values: Any integer Default value: 66 Additional help: ACCELL/SQL: Creating Reports with RPT Report Writer Executable path name list. The path list must include the ACCELL/SQL release bin directory for the operating system to find the ACCELL/SQL executables. The path must also include the correct RDBMS directory, so that RDBMS executables, such as isql or shutdb, can be found. This variable can be set only at the operating system command level and cannot be specified in a configuration file. Summary PATH Configuration Variable Dependencies: Used only on the UNIX operating system Valid values: Any valid directory path list Default value: UNIX: ”.:bin:/usr/bin” Example: UNIX (colon-separated paths): ”.:/usr/ASQL/devapps/accts:/usr/ASQL/AcctsApp” Additional help: 68 ACCELL/SQL: Setting Up a User Environment Configuration Variable Reference RADIXSEP Radix separator character to be used when displaying AMOUNT or FLOAT data. This configuration variable is used only when a format template is used. A format template can be specified in these ways: in a USING clause in an ACCELL/4GL form script or in an irs or RPT script in a DISPLAY_FORMAT field attribute in the AMTFMT configuration variable, set either at the operating system command level or in a configuration file When the AMOUNT or FLOAT data is displayed, the radix separator specified by RADIXSEP displays in the position indicated by the period (.) in the format template. Summary RADIXSEP Configuration Variable Dependencies: Used only with the AMTFMT format template) Valid values: Any printable character that is recognized as a radix separator. The value must be enclosed in quotation marks (”radix_separator”). Default value: ”.” Example: ”,” Additional help: AMTFMT configuration variable description on page 26 AMTPREC configuration variable description on page 28 CURRSYM configuration variable description on page 39 TRIADSEP configuration variable description on page 79 DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application Configuration Variable Reference 69 RNGMETACH Range metacharacter to be used when specifying search range criteria outside the [ ] metacharacters, for example, a dash (–). Dependencies Every RDBMS : When you set RNGMETACH, avoid setting it to a standard metacharacter that is used by ACCELL/SQL for your RDBMS. For example, if you are using SYBASE SQL Server and you set RNGMETACH to the percent sign (%), you will no longer be able to use the percent sign character as the metacharacter to match zero or more characters. Summary RNGMETACH Configuration Variable Dependencies: The specified value should not be a standard metacharacter that is recognized by ACCELL/SQL on your RDBMS. Valid values: Any ASCII character except one of the following: ? * [ ] ! @ , < > Default value: ”–” Example: ”#” Additional help: ACCELL/SQL: RDBMS Integration (for information about string search metacharacters used for each RDBMS) ACCELL/SQL: Writing Form Scripts (for information about performing string searches) SEPARATOR (RPT and irs only) Summary Separator character, such as the vertical bar (|), that is used to separate columns in input files for Report Writer (RPT and irs). SEPARATOR Configuration Variable Dependencies: Used only by RPT and irs Valid values: Any printable character except these reserved characters: ^!#@*.() If you must use a reserved character, make appropriate application adjustments. For example, if you set the separator to an asterisk (*), you must change the default null character to something else. table continued on next page 70 Configuration Variable Reference SEPARATOR Configuration Variable (continued) SHELL (UNIX only) Default value: | (vertical bar) Additional help: ACCELL/SQL: Creating Reports with RPT Report Writer Command processor to be used to execute operating system commands from ACCELL/SQL applications. This variable is used when executing the ACCELL/SQL background$( ), push_shell$( ), and system$( ) system functions and the debugger shell command, and when executing the “Operating System” option from the Menu Handler Main menu. This variable can be set only at the operating system command level and cannot be specified in a configuration file. Summary SPOOLER SHELL Configuration Variable Dependencies: Used only on the UNIX operating system Valid values: Any valid path list Default value: UNIX: ”/bin/sh” Example: UNIX: ”/bin/sh” Additional help: ACCELL/SQL: Setting Up a User Environment Name of the print spooler. Summary SPOOLER Configuration Variable Dependencies: This value may be operating system or hardware dependent Valid values: Any valid print spooler name table continued on next page Configuration Variable Reference 71 SPOOLER Configuration Variable (continued) SQLFLDCNT (Unify DataServer only) Summary STCNRTLK (Unify DataServer only) Summary Default value: UNIX: ”lpr” Example: UNIX: ”pslaser1” Additional help: ACCELL/SQL: Setting Up a User Environment Maximum number of columns allowed in an SQL/A query. ACCELL/SQL uses this variable to determine the maximum number of updated columns in an UPDATE statement. SQLFLDCNT Configuration Variable Dependencies: Used only on the Unify DataServer RDBMS Valid values: Any integer Default value: 150 Example: 20 Additional help: The UPDATE statement description in ACCELL/SQL: Script and Function Reference Set consistency lock retention flag. This variable determines whether locks are retained or released when the form is cleared or a new form is made current when running at set consistency. For example, if STCNRTLK is TRUE and the form is running at set consistency, locks are retained when the user executes a CLEAR TO FIND or a PREVIOUS FORM . STCNRTLK Configuration Variable Dependencies: Used only with Unify DataServer Valid values: TRUE If the current form is running at set consistency, locks on selected set rows are retained until a COMMIT WORK or a ROLLBACK WORK. table continued on next page 72 Configuration Variable Reference STCNRTLK Configuration Variable (continued) FALSE STRNULLCH Summary If the current form is running at set consistency, locks on selected set rows are released when the form is cleared or a new form is made current. Default value: TRUE Additional help: ACCELL/SQL: RDBMS Integration Null display character for STRING data. The character specified in STRNULLCH overrides NULLCH for STRING data. STRNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”Character”) Default value: ”*” Example: ”#” Additional help: NULLCH configuration variable description on page 62 “Format Templates” in ACCELL/SQL: Localizing an Application SYBASE (SYBASE SQL Server RDBMS variable) Path of the directory that contains the SYBASE interfaces file. This directory is usually the directory where your SYBASE SQL Server release is installed. This variable can be set only at the operating system command level and cannot be specified in a configuration file. If SYBASE is not set before you install your ACCELL/SQL release software, the installation procedure will prompt you for the value. Configuration Variable Reference 73 Summary SYBASE_MSGS (SYBASE SQL Server only) Summary SYBASE Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS. Requires the correct path and file name formats for the operating system. Valid values: Any valid path Default value: None Example: /home/Sybase Additional help: ACCELL/SQL: Setting Up a User Environment, ACCELL/SQL: RDBMS Integration Comma-separated list of strings that indicate which messages (of those generated by triggers) should be sent to ACCELL/SQL . SYBASE_MSGS Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: One of the following string values, specified in uppercase or lowercase letters: None Send SYBASE SQL Server errors only ”Errors” Send raiserror messages ”Messages” Send print messages ”Errors,Messages” Send raiserror and print messages ”Messages,Errors” Send raiserror and print messages 74 Default value: None Example: ”Errors,Messages” Additional help: ACCELL/SQL: RDBMS Integration Configuration Variable Reference SYBASE_RB_ ERRNUMS (SYBASE SQL Server only) Summary List of error numbers that are used to notify ACCELL/SQL that a rollback was performed on the operation that fired a trigger. Otherwise, if this configuration variable were not set, ACCELL/SQL would have no indication that the rollback occurred. SYBASE_RB_ERRNUMS Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: A comma-separated list of error numbers in the raiserror range of greater than 20000. Single numbers can appear in the list, and a dash (–) in the first or last character indicates that the range is open-ended. Default value: ”20001–” Examples: ”20001” ”20001–21000” ”22000,23000–23010,30000–” ”–27500” Additional help: SYBASE_RB_ RESTART (SYBASE SQL Server only) ACCELL/SQL: RDBMS Integration Range of error numbers for which no ACCELL/SQL error is displayed when a rollback occurs in a trigger. In this case, ACCELL/SQL ignores the error and starts a new transaction. Set this variable only if you do not want ACCELL/SQL to display error messages for a specific range of errors. This variable is similar to SYB_RB_ERRNUMS , except that it does not display the error. Summary SYBASE_RB_RESTART Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: A comma-separated list of error numbers in the raiserror range of greater than 20000. Single numbers can appear in the list, and a dash (–) in the first or last character indicates that the range is open-ended. Default value: None table continued on next page Configuration Variable Reference 75 SYBASE_RB_RESTART Configuration Variable (continued) Examples: ”20001” ”20001–21000” ”22000,23000–23010,30000–” ”–27500” Additional help: ACCELL/SQL: RDBMS Integration (for information about handling trigger errors) SYBTRGMSG (SYBASE SQL Server only) Summary SYBTXTSIZE (SYBASE SQL Server only) Error number to be associated with the ACCELL/SQL row identification triggers. ACCELL/SQL writes the specified error number into the trigger text. Therefore, if you change the value of the SYBTRGMSG configuration variable, you must regenerate the trigger so that the number in the trigger matches the number specified by SYBTRGMSG. SYBTRGMSG Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: A recognized error number Default value: None Examples: ”21000” Additional help: ACCELL/SQL: RDBMS Integration Number of bytes that can be transferred from a SYBASE SQL Server text or image field to ACCELL/SQL . The default SYBASE SQL Server text and image data transfer size is 32k bytes. Set SYBTXTSIZE if you have text or image fields that exceed 32k bytes. If SYBTXTSIZE is not set and text or image fields exceed 32k bytes, the field values are truncated. 76 Configuration Variable Reference Summary TBCONFIG (INFORMIX RDBMS variable used only with INFORMIX OnLine) SYBTXTSIZE Configuration Variable Dependencies: Used only on the SYBASE SQL Server RDBMS Valid values: A positive integer Default value: 32k Examples: 64k Additional help: ACCELL/SQL: RDBMS Integration Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. Each INFORMIX OnLine system has such a configuration file in the $INFORMIXDIR/etc directory. This variable is an RDBMS variable. Set the variable if more than one INFORMIX OnLine system is initialized in the directory specified by INFORMIXDIR . For example, if you have two INFORMIX systems, the first INFORMIX configuration file could be named tbconfig, while the second INFORMIX configuration file is named tbconfig2. Summary TBLCONFIG Configuration Variable Dependencies: Used only with INFORMIX OnLine. Valid values: Any valid file name Default value: tbconfig Example: tbconfig3 Additional help: INFORMIX Guide to SQL Reference INFORMIX OnLine Administrator’s Guide TERM User’s terminal type, as defined in the termcap file. This variable must be set for your terminal to work correctly with ACCELL/M anager and ACCELL/G enerator. This variable can be set only at the operating system command level and cannot be specified in a configuration file. Configuration Variable Reference 77 Summary TERM Configuration Variable Dependencies: This value is hardware dependent Valid values: Any valid terminal name that can appear in the termcap file Default value: ”vt100” Example: ”sun4” Additional help: ACCELL/SQL: Setting Up a User Environment The users’ manual that came with your terminal TIMEFMT Format in which to accept and display TIME values. Summary TIMEFMT Configuration Variable Dependencies: Manipulation of TIME data depends in part on the underlying RDBMS Valid values: A combination of the letters H (hour) and M (minutes), plus a separator character, enclosed in quotation marks (”format_template”). The letters can be uppercase or lowercase, and the separator character can be any printable character. Default value: ”HH:MM” Example: ”HH.MM” ”HH:MMam/pm” Additional help: “Date (or Time) Display Format Search Priority” in ACCELL/SQL: Managing an Application DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application 78 Configuration Variable Reference TIMNULLCH Null display character for TIME data. The character specified in TIMNULLCH overrides NULLCH for TIME data. Summary TIMNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”Character”) Default value: ”*” Example: ”#” Additional help: NULLCH configuration variable description on page 62 “Format Templates” in ACCELL/SQL: Localizing an Application TRIADSEP Triad separator character (for thousands) that is used when displaying AMOUNT or FLOAT data. The TRIADSEP configuration variable is used only when a format template is used. A format template can be specified in several ways: in a USING clause in an ACCELL/4GL form script or a using clause in an irs or RPT script in a DISPLAY_FORMAT field attribute in the AMTFMT configuration variable (for AMOUNT data), set either at the operating system command level or in a configuration file in the FLTFMT configuration variable (for FLOAT data), set either at the operating system command level or in a configuration file Summary TRIADSEP Configuration Variable Dependencies: Used with a picture format or AMTFMT, and CURRSYM and RADIXSEP Valid values: Any printable character enclosed in quotation marks (”triad_separator”) Default value: ”,” table continued on next page Configuration Variable Reference 79 TRIADSEP Configuration Variable (continued) Example: ”.” Additional help: AMTFMT configuration variable description on page 26 AMTPREC configuration variable description on page 28 CURRSYM configuration variable description on page 39 RADIXSEP configuration variable description on page 69 DISPLAY_FORMAT field attribute description and DISPLAY statement syntax and description in ACCELL/SQL: Script and Function Reference print statement description in ACCELL/SQL: Creating Reports with RPT Report Writer “Format Templates” in ACCELL/SQL: Localizing an Application TWO_TASK (ORACLE RDBMS variable) Summary TXTNULLCH Default alias or default driver and parameters to be used with SQL*Net TCP/IP to connect to a database on a remote machine. TWO_TASK Configuration Variable Valid values: Any valid database alias or driver name and parameters Example: acctdmach Additional help: ORACLE RDBMS manual: SQL*Net TCP/IP User’s Guide Null display character for TEXT data. The character specified in TXTNULLCH overrides NULLCH for TEXT data. Summary TXTNULLCH Configuration Variable Valid values: Any printable character enclosed in quotation marks (”Character”) Default value: ”*” table continued on next page 80 Configuration Variable Reference TXTNULLCH Configuration Variable (continued) Example: ”#” Additional help: NULLCH configuration variable description on page 62 “Format Templates” in ACCELL/SQL: Localizing an Application UAMOUNT64 Summary Flag that specifies whether AMOUNT data is stored as 32-bit or 64-bit for stored procedures, triggers, ACCELL/SQL and RPT variables only. This configuration variable has no impact on Interactive SQL/A, embedded SQL/A, or RHLI variables. By setting the UAMOUNT64 configuration variable to FALSE, you can maintain compatability with previous versions of Unify DataServer. UAMOUNT64 Configuration Variable Valid values: TRUE Amount variables and expressions are stored as currency (64Ćbit) structures. FALSE Amount variables and expressions are HUGE AMOUNT (double precision), as in previous versions of Unify DataServer. Default value: FALSE See Also: Variables in Unify DataServer: Creating Reports with RPT Report Writer Warning A runtime error due to overflow can occur if 64-bit constants are allowed at compile time and not at runtime. That is, if a stored procedure or trigger is compiled with the UAMOUNT64 configuration variable set to FALSE, and the UAMOUNT64 configuration variable is set at runtime, overflow may occur. Configuration Variable Reference 81 ULDFLAGS Link directive that indicates the list of special loader options needed by this platform. These options are used by amgr.ld to load a custom manager. Summary ULDLIBS Dependencies: Requires the correct loader option(s) specification. Valid values: Any valid loader option(s). Default value: The appropriate default has been set in your release software. Examples: ”–Bstatic” Additional help: ACCELL/SQL: Setting Up a User Environment Link directive that indicates the directory path and file names for special libraries needed by this platform. These libraries are used by amgr.ld to load a custom manager. Summary 82 ULDFLAGS Configuration Variable ULDLIBS Configuration Variable Dependencies: Requires the correct path format and library name abbreviation format. (The path is optional.) Valid values: Any valid library name abbreviation(s) proceeded by an optional directory path specification. Default value: The appropriate default has been set in your release software. Examples: ”–L/usr/localnet/sun4/lib –ll –lm” Additional help: ACCELL/SQL: Setting Up a User Environment Configuration Variable Reference ULDNAME Name of the linker called by amgr.ld when linking custom managers. The linker name can be preceded by an optional directory path. Summary ULDNAME Configuration Variable Dependencies: The value of the ULDNAME variable depends on the hardware on which you are running ACCELL/SQL. Requires the correct path format and file name format for the operating system. (The path is optional.) Valid values: Any valid path and file name Default value: The appropriate default has been set in your release software. Examples: UNIX: ”cc” ”/usr/bin/cc” Additional help: UNICAP (Character mode only) ACCELL/SQL: Setting Up a User Environment Directory path and file name of the ACCELL/SQL keyboard capabilities file. This variable can be set only at the operating system command level and cannot be specified in a configuration file. Summary UNICAP Configuration Variable Dependencies: Used with character mode only. Requires the correct path and file name formats for the operating system Configuration Variable Reference Valid values: Any valid path and file name Default value: UNIX: ”$UNIFY/unicap” Example: UNIX: ”/etc/unicap” Additional help: ACCELL/SQL: Setting Up a User Environment 83 UNIFY Directory path for the ACCELL/SQL release lib directory. This directory usually contains the ACCELL/SQL unicap and termcap files, the ACCELL/SQL message files, and the libraries for building a custom manager. This variable can be set only at the operating system command level and cannot be specified in a configuration file. Summary UNIFY Configuration Variable Dependencies: Requires the correct path format for the operating system Valid values: Any valid path Examples: UNIX: ”/ASQL/lib” ”$ACLDIR/lib” Additional help: UNIFYTMP ACCELL/SQL: Setting Up a User Environment Path for the directory in which ACCELL/SQL temporary files are to be stored. Summary UNIFYTMP Configuration Variable Dependencies: Requires the correct path format for the operating system and may also be hardware dependent Valid values: Any valid path Default value: UNIX: ”/tmp” Example: UNIX: ”/usr/ASQL/tmp” Additional help: AGEN_SEL_SET_DR configuration variable description on page 19 AMGR_SEL_SET_DR configuration variable description on page 24 84 Configuration Variable Reference UNUMERIC64 Summary Flag that specifies whether NUMERIC data is stored as 32-bit or 64-bit for stored procedures, triggers, ACCELL/SQL , and RPT variables only. This configuration variable has no impact on Interactive SQL/A, embedded SQL/A, or RHLI variables. By setting the UNUMERIC64 configuration variable to FALSE, you can maintain compatability with previous versions of Unify DataServer. NUMERIC64 Configuration Variable Valid values: TRUE Numeric variables and expressions are stored as 64Ćbit. FALSE Numeric variables and expressions use 32 bits precision, as in previous versions of Unify DataServer. Default value: FALSE Warning A runtime error due to overflow can occur if 64-bit constants are allowed at compile time and not at runtime. That is, if a stored procedure or trigger is compiled with the UNUMERIC64 configuration variable set to TRUE, and the UNUMERIC64 configuration variable is not set at runtime, overflow may occur. UPPNAME Alternative C preprocessor, which can be used for the ACCELL/SQL compiler, ACPL, if ACPLPP is not set. The preprocessor must be specified as a complete path name, with both directory and file names specified. The specified executable can be an operating system command script. Either the ACPLPP configuration variable or the UPPNAME configuration variable can be used to specify the preprocessor: If both ACPLPP and UPPNAME are set, the preprocessor specified by the ACPLPP configuration variable is used. If ACPLPP is not set, but UPPNAME is set, the preprocessor specified by the UPPNAME configuration variable is used. If neither ACPLPP nor UPPNAME is set, the ACPLPP default value is used. Configuration Variable Reference 85 Summary UPPNAME Configuration Variable Dependencies: Requires the correct path and file name formats for the operating system Valid values: Any valid path and file name Default value: UNIX: ”/lib/ucpp” Example: UNIX: ”/usr/Apps/lib/ucpp” Additional help: ACPLPP configuration variable description on page 16 ACCELL/SQL: Writing Form Scripts (for information about compiling applications) USTRBCHARS The USTRBCHARS configuration variable lists the characters to be blocked from data entry (that is, add/update mode) into a text field of data type STRING. When a user attempts to enter an unwanted character, a beep will sound and the character will not be accepted. Note that in GUI mode, the entered characters are not checked until you execute a data accept command such as NEXT FIELD. When a string of characters is pasted into a field, one or more unwanted characters may be present in the string. In GUI mode, the entire set of pasted characters is blocked and an error message identifies the first unwanted character found. In character mode, only the unwanted characters are blocked; the valid characters are allowed in the field. 86 Configuration Variable Reference Summary USTRBCHARS Configuration Variable Valid values: A string of character representations separated by tabs or spaces. The printable ASCII characters (other than the exceptions listed below) can be represented as themselves or as their octal or hex value. All non–printable characters except NULL (0) must be represented using their octal or hex values. (NULL is not valid.) Octal values must be in the range 01–0377, and must begin with a leading zero. Hex values must be in the range of 0x01 – 0xff and must include the 0x prefix. For hex constants, the alphabetic digits (a–f) can be represented in either case (A or a). The following four printable characters must be represented using their octal or hex values: S apostrophe ( ') 047 (octal) 0x27 (hex) S double quote ( ") 042 (octal) 0x22 (hex) S backslash ( / ) S circumflex ( 0134 (octal) 0x5C (hex) ^) 0136 (octal) 0x5E (hex) If any invalid character representations are found in the string, the entire setting is ignored. Default value: None (no characters are disallowed for text fields of type STRING in the application). Example: To block the characters @, *, the backslash, and the apostrophe, the following setting could be used: USTRBCHARS = ”@ * 0134 0x27” Additional help: Configuration Variable Reference To block characters of type TEXT, use the UTXTBCHARS configuration variable. 87 UTXTBCHARS The UTXTBCHARS configuration variable lists the characters to be blocked from data entry (add/update mode) into a text field of data type TEXT. When a user attempts to enter an unwanted character, a beep will sound and the character will not be accepted. Note that in GUI mode, the entered characters are not checked until you execute a data accept command such as NEXT FIELD. When a string of characters is pasted into a field, one or more unwanted characters may be present in the string. In GUI mode, the entire set of pasted characters is blocked and an error message identifies the first unwanted character found. In character mode, only the unwanted characters are blocked; the valid characters are allowed in the field. Summary UTXTBCHARS Configuration Variable Dependencies: None. Valid values: A string of character representations separated by tabs or spaces. See the USTRBCHARS configuration variable for details. Default value: None (no characters are disallowed for text fields of type TEXT in the application). Example: To block the characters @, *, the backslash, and the apostrophe, the following setting could be used: UTXTBCHARS = ”@ * 0134 0x27” Additional help: UXPUSHSHELL (Motif and OPEN LOOK UI options only) Summary To block characters of type STRING, use the USTRBCHARS configuration variable. Name of the file to use for the terminal emulator in which push_shell$( ) will execute operating system command level (shell) commands. For example, to use an xterm window, set UXPUSHSHELL to xterm. Otherwise, set the variable to an alternative terminal emulator. UXPUSHSHELL Configuration Variable Dependencies: Used with the Motif and OPEN LOOK UI options only Valid values: Any valid terminal emulator file name table continued on next page 88 Configuration Variable Reference UXPUSHSHELL Configuration Variable (continued) Default value: UNIX: ”xterm” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface UXSYSTEM (Motif and OPEN LOOK UI options only) Summary Terminal emulator command string to be used to pass commands to the operating system when calling the system$( ) system function. For example, to use an xterm window, set UXSYSTEM to xterm –e. Otherwise, set the variable to an alternative terminal emulator command string. UXSYSTEM Configuration Variable Dependencies: Used with the Motif and OPEN LOOK UI options only Valid values: Any valid terminal emulator command Default value: Actual default may be different, depending on the hardware platform Example: UNIX: ”xterm –e sh –c” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface WIDTH (RPT and irs only) Summary Configuration Variable Reference Width of a report page in number of characters. WIDTH Configuration Variable Dependencies: Used only by Report Writer through RPT or irs Valid values: Any integer Default value: 80 Example: 132 Additional help: ACCELL/SQL: Creating Reports with RPT Report Writer 89 WP_IGNORE_ UNDEFINED Summary Indicates whether an undefined value written to a pipeline will produce a warning at runtime. Developers are encouraged to leave this variable at the default setting of FALSE. In more mature applications, the warnings may be more of a hindrance than debugging aids, in which case you might want to set WP_IGNORE_UNDEFINED to TRUE. WP_IGNORE_UNDEFINED Configuration Variable Valid values: Default value: XAPPLRESDIR (X Window variable used with Motif and OPEN LOOK UI options only) Undefined values written to a pipeline will produce a warning at runtime. TRUE Undefined values written to a pipeline will not produce a warning at runtime. False Path of the directory that contains the application resource file. This application resource file is the version of AccellOL or AccellM that was modified by the developer. This variable is an X Window environment variable that can be set only at the operating system command level and cannot be specified in a configuration file. Summary XAPPRESLANG PATH (X Window variable used with Motif UI option only) 90 FALSE XAPPLRESDIR Configuration Variable Dependencies: Used with the Motif and OPEN LOOK UI options only. Requires the correct path format for the operating system. Valid values: Any valid path, terminated by a slash character (/) Example: UNIX: ”/usr/acct/aclapp/” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface (for information about the resource evaluation hierarchy) Path of the directory that contains the application resource file. The application resource file for the Motif UI option is named AccellM. This variable is an X Window environment variable that can be set only at the operating system command level and cannot be specified in a configuration file. Configuration Variable Reference Summary XAPPRESLANGPATH Configuration Variable Dependencies: Used with the Motif UI option only. Requires the correct path format for the operating system. Valid values: Any valid path, terminated by a slash character (/) Example: UNIX: ”/usr/acct/aclapp/” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface (for information about the resource evaluation hierarchy) XENVIRONMENT (X Window variable used with Motif and OPEN LOOK UI options only) Summary Directory path and file name of the file that contains the resource settings for the user’s environment. This variable is an X Window environment variable that can be set only at the operating system command level and cannot be specified in a configuration file. XENVIRONMENT Configuration Variable Dependencies: Used with the Motif and OPEN LOOK UI options only. Requires the correct path and file name formats for the operating system. Valid values: Any valid path and file name Example: UNIX: ”/usr/acct/aclapp/alcRes” Additional help: ACCELL/SQL: Developing an Application for a Graphical User Interface (for information about the resource evaluation hierarchy) Configuration Variable Reference 91 ACCELL/SQL Utilities Reference 92 Chapter Focus This chapter contains an alphabetic list of syntax and usage descriptions for ACCELL/SQL utilities. ACCELL/SQL utilities are scripts and programs that you can run from the operating system command line to perform tasks such as these: developing application forms and form scripts (adev, AGEN, make_maf, makeamake, and MKAP ) compiling and integrating applications (ACMB, ACPL, and ALNK) running applications (accell and AMGR) customizing applications (amgr.ld, bldcmf, and PAINTHLP) documenting and getting information about applications (FRMDOC , frmlst, and PICT) converting application files to and from ASCII format (ASC2H, ASC2Q, H2ASC, q2a2q, and Q2ASC) retrieving information about configuration variables (config) printing reports (irs, RPT, and rpt.ld) running applications through the ACCELL/SQL menu handler (accell and syncauth) Dependencies The syntax and examples shown for these utilities are based on the UNIX operating system. If you use a different operating system, you must follow the syntax conventions required on your system. ACCELL/SQL Utilities Reference 93 Utilities Descriptions The utilities described in this section are listed in alphabetic order. Format Each ACCELL/SQL utility description is divided into several parts: Utility name Utility name Syntax Conventions 94 Indicates the start of the utility description. Indicates continuation of the utility description. Syntax Syntax for the utility. Arguments Required and optional command line arguments that are used when you call the utility. Description Utility usage and any special conditions and notes. Security Special permissions required to run the utility. See Also Other utilities, ACCELL/4GL statements or functions, or manual sections that relate to the utility. The utility syntax descriptions follow these conventions: BOLD Boldface words and characters are keywords. A keyword is usually required word. italic Italicized words are substitution strings. Substitute the item described in the Description section for the italicized word. || A set of vertical bars surrounds a stack of alternative arguments from which you can choose one. The bars are not part of the command. [] Square brackets enclose an optional element. The brackets are not part of the command. () Boldface parentheses are part of the command, and like keywords, must be typed in exactly as shown. ACCELL/SQL Utilities Reference accell System setup, application execution Syntax [directory_path/]accell Arguments directory_path/ Specifies the path of the directory where the accell script is stored. On UNIX systems, accell is stored in the release bin directory. If you have set the PATH configuration variable to include the release bin directory, simply type the script name at the command line to start accell. Description The accell script starts ACCELL/SQL through ACCELL/SQL Menu Handler. Menu Handler displays the ACCELL/SQL Main menu. From ACCELL/SQL Main menu, you can select any of these options: ACCELL/SQL Development Environment Starts ACCELL/E nvironment so that you can create forms, write form scripts, compile, combine, load, and run applications in a menu driven environment. SQL Starts your RDBMS version of SQL so that you can query the database. ACCELL/SQL Tutorials Displays the Tutorials submenu so that you can run either the ACCELL/SQL developer’s tutorial or the completed tutorial. Operating System Opens a window to the operating system so that you can run operating system commands. ACCELL/SQL Utilities Reference 95 accell Editor Starts the system editor so that you can edit ASCII files, such as SQL or RPT files. Menu Handler Maintenance Utilities Displays a submenu from which you can add, modify, or delete menus and programs; modify menu and program security; and create or modify help documentation. Make Default Application Starts the MKAP utility in an interactive mode so that you can create a default application. Read the MKAP utility description, starting on page 181, before you select this option. The following diagram shows an example of the Main menu. The options and function key prompts shown on the menu may differ slightly on your system. ACCELL/SQL [adev] Menu Item 1 of 7 Main Menu 1. ACCELL/SQL Development Environment 2. Interactive SQL 3. ACCELL/SQL Tutorials 4. Operating System 5. Editor 6. Menu Handler Maintenance Utilities 7. Make Default Application SELECTION: F1–select 96 F2–up F3–down F4–home F5–previous F6–clear F7–exit F8–help F10–more ACCELL/SQL Utilities Reference accell Required Configuration Variables Before you can run accell, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. DBTYPE Set to the type of database with which ACCELL/SQL is being used (INFORMIX, INGRES, ORACLE, SYBASE, or U2000). If the ACCELL/E nvironment, Menu Handler, and Tutorial tables are in a logical database object that is not named DBUTIL (or dbutil on an RDBMS that requires lowercase object names), you must set the ACL_DBUTIL_SCH configuration variable to the name of the logical database object that contains the tables. The accell script sets some configuration variables to their default values, if the variables were not previously set: ATERMCAP (UNIX only) PATH (UNIX only) UNICAP See Also MKAP utility description on page 181, ATERMCAP configuration variable description on page 31, DBTYPE configuration variable description on page 46, PATH configuration variable description on page 68, UNICAP configuration variable description on page 83, UNIFY configuration variable description on page 84, ACCELL/SQL: Developing an Application for information about developing an application, “Customizing User Menus” in ACCELL/SQL: Localizing an Application ACCELL/SQL Utilities Reference 97 ACMB Application development Syntax For a master application form: ACMB [-i] archive_name -a[i] MAF_name [object_file] For a standard form or global function: ACMB [-i] archive_name [-i] standard_form_name [object_file] Arguments –i Before archive_name, indicates that the archive file name does not have the default .fa suffix. Before standard_form_name, –i indicates that the specified standard form name does not include the default form file name suffix, .fq. archive_name Specifies the name of the form archive to be created; archive_name is usually the name of the application. If archive_name is not preceded by the –i option, the combiner appends the default archive file name suffix, .fa. 98 –a Before MAF_name, indicates that the specified form is a master application form. The –a option is required if the form is a master application form. –ai Before MAF_name, –ai indicates that the specified form is a master application form and the specified form name does not include the default form file name suffix, .aq. When you use both the –a and –i options, they must be combined as –ai. MAF _name Specifies the name of an ACCELL/SQL master application form. If preceded by –ai, the name does not include the default form file name suffix, .aq. ACCELL/SQL Utilities Reference ACMB standard_form_name Specifies the name of an ACCELL/SQL standard form. If preceded by –i, the name does not include the default form file name suffix, .fq. object_file Description Specifies the name of a compiled ACCELL/4GL script, if not form_name.fo or form_name.ao. The ACMB utility combines an ACCELL/SQL form and its form script object file, or a global function object file, into a form archive. Combining the form and form script object file or global function object file into an archive is the third step when you build an ACCELL/SQL application: 1. Create forms with AGEN . 2. Compile scripts with ACPL. 3. Combine form and 4GL script object file with ACMB . 4. Link application archives with ALNK . Tip When you modify a screen form, global function script, or a form script, you must use ACMB to recombine the form and script object file or function object file into the form archive. Required Configuration Variables Before you can run ACMB, these configuration variables must be set: UNIFY ACCELL/SQL Utilities Reference Set to the path of the ACCELL/SQL release lib directory. 99 ACMB You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are shown in the following table. Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 100 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference ACMB Running ACMB From the Command Line To run ACMB from the command line, first make sure that the current directory is the directory that contains the files to be combined. Then type the ACMB utility name followed by the name of the form or global function that you want to combine. The combiner creates a form archive in the specified archive file. ACMB assumes that the archive file name suffix is .fa, unless the –i option is used to specify another archive file name. Unless the –i option is used to specify another form file name suffix, the combiner assumes that standard forms have the default standard form suffix, .fq, and master application forms have the suffix .aq. The combiner assumes that 4GL form script object files have the default suffix: .ao for a master application form and .fo for a standard form. To override the default object file name, specify the object_file name. Running ACMB From ACCELL/E nvironment To run ACMB from ACCELL/E nvironment, select either the “Compile/Integrate Forms and 4GL” option or the “Compile/Integrate/Run Application” option on the ACCELL/E nvironment Operation menu. ACMB is automatically called after the script file is compiled. For information about using ACCELL/E nvironment, see ACCELL/SQL: Developing an Application. Example These examples show how to use ACMB. The first example combines the standard form fcompany and its script into the form archive tutorial: ACMB tutorial fcompany The second example uses ACMB with the –a option to combine the master application form tutorial and its script into the application tutorial: ACMB tutorial –a tutorial ACCELL/SQL Utilities Reference 101 ACMB See Also 102 ACPL utility description on page 103, AGEN utility description on page 117, ALNK utility description on page 122, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Developing an Application for information about developing an application, ACCELL/SQL: RDBMS Integration for RDBMS-specific information about developing an application, ACCELL/SQL: Writing Form Scripts ACCELL/SQL Utilities Reference ACPL Application development Syntax For a master application form script and standard form scripts: ACPL [-S db_object] [-U user_name] [-P password] [-Iinclude_path] -a[i] [-p] [-y] [-c] MAF_script standard_form_script_list For a standard form script: ACPL [-S db_object] [-U user_name] [-P password] [-Iinclude_path] [-i] [-p] [-y] [-c] standard_form_script_list Arguments –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the files to be compiled: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. ACCELL/SQL Utilities Reference 103 ACPL –P password (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. –Iinclude_path Specifies the path of the include file directory that contains the header files (.h file name suffix) to be included in the form script. Make sure that no space separates the –I prefix from the include_path, for example, –I/usr/accell/include). To specify multiple paths, repeat the –Iinclude_path option for each path. –a Before MAF_script and standard_form_script_list, indicates that the first file named in the list is a master application form script. The –a option is required if the form script is for a master application form. –ai Before MAF_script and standard_form_script_list, indicates that the first file named in the list is a master application form script, and the file names do not include the default file name suffixes. The default suffixes are .as for the master application form script file and .fs for a standard form script file. When you use both the –a and –i options, they must be combined as –ai. –i Before standard_form_script_list, indicates that the specified standard form script files do not have the default file name suffix, .fs. –p Indicates that the preprocessor (ucpp) output is to be saved in a file named script_name.io, where script_name is the name of the form script file that is being compiled. Normally, the script_name.io file is removed after a successful compile. The script_name.io file remains in your directory only if the compile produces errors or you include the –p option when you run ACPL. 104 ACCELL/SQL Utilities Reference ACPL –y Indicates that the compiler is to produce a file that contains the symbol table output of the compile. The file is named script_name.sy, where script_name is the name of the form script file that is being compiled. –c Indicates that the compiler is to produce a machine assembly code file named script_name.cd, where script_name is the name of the form script file that is being compiled. MAF_script Specifies the name of a master application form script file. The master application form script file name must be preceded by the –a option, and the master application form script file name must precede the first name in the standard_form_script_list. standard_form_script_list Specifies the names of one or more standard form script files to be compiled. If one of the files is a master application form script file, file_list must be preceded by the –a option and the master application form script file name, MAF _script. Description The ACPL utility compiles one or more ACCELL /4GL form script files listed in file_list. Compiling scripts is the second step when you build an ACCELL/SQL application: 1. Create forms with AGEN . 2. Compile scripts with ACPL. 3. Combine form and 4GL script object file with ACMB . 4. Link application archives with ALNK . Required Configuration Variables Before you can run ACPL, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are shown in the following table. ACCELL/SQL Utilities Reference 105 ACPL Configuration Variables Used to Identify the Database RDBMS INFORMIX Variable OnLine INFORMIXDIR INFORMIX SE INGRES ORACLE Description Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACPL also uses the ACPLPP configuration variable, which is set to the default ACCELL/SQL preprocessor, usually ucpp. 106 ACCELL/SQL Utilities Reference ACPL Running ACPL From the Command Line To run ACPL from the command line, type the ACPL utility name followed by the names of the form script files that you want to compile. If you do not use the –i (or –ai) option to specify a different file name suffix, ACPL assumes that the form script files have the default file name suffixes: .as for a master application form script, and .fs for a standard application form script. ACPL performs these tasks: 1. Calls the preprocessor, usually ucpp. The ucpp preprocessor is similar to the operating system preprocessor, cpp. However ucpp is more compatible with ACCELL/SQL . To use a different preprocessor, you can set the ACPLPP configuration variable to your preprocessor name. The preprocessor produces an intermediate output file named script_name.io, where script_name is the name of the form script file that is being compiled. For each #include statement in the script, the preprocessor reads in the associated header file. If the compiler is called with no –I options, ACPL searches the /usr/include directory for the header files. 2. After the preprocessor is finished, ACPL compiles the ACCELL /4GL form scripts and validates the syntax of the statements. If a compile error occurs, ACPL stops execution and leaves the script_name.io file in the current directory. You can view the script_name.io file to see the results of the compile up to the time of the compile termination. The line numbers that display for a compile error are internal to script_name.io. The numbers may not match your form script file. 3. The compiler creates the form script object file with the name script_name.ao for a master application form script file or script_name.fo for a standard form script, where script_name is the name of the form script file that is being compiled. Running ACPL From ACCELL/E nvironment To run ACPL from ACCELL /Environment, select the “Compile/Integrate Forms and 4GL” option or the “Compile/Integrate/Run Application” option on the ACCELL/E nvironment Operation menu. ACPL starts to compile the current form’s script file. ACCELL/SQL Utilities Reference 107 ACPL For information about using ACCELL/E nvironment, see ACCELL/SQL: Developing an Application. Troubleshooting String Constant Compile Errors When you compile the application, you may receive a message that you have exceeded the maximum allowed number of string constants in the form script. ACPL registers a string constant for each instance of a C-hook function call and for each parameter in a system or user function. This can result in a large number of string constants that do not actually appear in the form script file. If you receive a compiler error message that you have exceeded the maximum allowed number of string constants in the form script, try these options: Reduce the number of actual string constants in the form script. Reduce the number of C-hook function calls in the form script. Reduce the number of system and user function calls in the form script. Example These examples show how to compile form script files for an application. The first example compiles a standard form script named fcompany.fs: ACPL fcompany The second command compiles a master application form script named tutorial.as: ACPL –a tutorial See Also 108 ACMB utility description on page 98, AGEN utility description on page 117, ALNK utility description on page 122, ACPLPP configuration variable description on page 16, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Writing Form Scripts ACCELL/SQL Utilities Reference adev Application development Syntax adev Arguments None Description The adev utility starts ACCELL/E nvironment. (For more information than given here about how to use ACCELL/E nvironment to develop and maintain an application, see ACCELL/SQL: Developing an Application.) From ACCELL/E nvironment you can perform these tasks: edit application information edit screen forms edit form scripts compile and integrate applications run applications open a window to the operating system Required Configuration Variables Before you can run adev, these configuration variables must be set: ATERMCAP (UNIX only) Set to the directory path and file name of the ACCELL/SQL termcap file. UNICAP Set to the directory path and file name of the ACCELL/SQL unicap file. UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files, shown in the following table. ACCELL/SQL Utilities Reference 109 adev Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db If the ACCELL/E nvironment, Menu Handler, and Tutorial tables are in a logical database object that is not named DBUTIL (or dbutil on an RDBMS that requires lowercase object names), you must also set the ACL_DBUTIL_SCH configuration variable to the name of the logical database object that contains the tables. 110 ACCELL/SQL Utilities Reference adev Running adev From the Command Line To run adev from the command line, type the adev utility name with no arguments. ACCELL/E nvironment assumes that the default ACCELL/SQL directory structure is to be used: an aclenv directory, with subdirectories for each ACCELL/SQL application. To specify the aclenv directory as the directory path, set the ACLENV configuration variable. Running adev From ACCELL/SQL Menu Handler To run adev from ACCELL/SQL Menu Handler, select the “ACCELL/SQL Development Environment” option from the ACCELL/SQL Menu Handler Main menu. Developing an Application An application must be developed entirely from ACCELL/E nvironment (through ACCELL/SQL Menu Handler) or entirely from operating system command level utilities. When you develop an application through ACCELL/E nvironment, application files are automatically managed for you as an integrated application. The application can be run from ACCELL/E nvironment. If you try to add files to the application by running the operating system command level utilities (AGEN, ACPL, ACMB, and ALNK), the new files are not integrated with the application. When you develop an application entirely by running the operating system command level utilities, AGEN, ACPL, ACMB, and ALNK, the application is not registered with ACCELL/E nvironment. However, if you develop an application entirely by running the operating system command level utilities, you can register the compiled, combined, and linked application with ACCELL/E nvironment. Simply start ACCELL/E nvironment and add the application name to the List of Applications form. You can zoom to the List of Applications form from the Current Application form, which is displayed when you start ACCELL/E nvironment. ACCELL/SQL Utilities Reference 111 adev See Also 112 adevmnt utility description on page 113, ACL_DBUTIL_SCH configuration variable description on page 8, ACLENV configuration variable description on page 10, ATERMCAP configuration variable description on page 31, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNICAP configuration variable description on page 83, UNIFY configuration variable description on page 84, ACCELL/SQL: Developing an Application (for a description of developing an application in ACCELL/E nvironment). ACCELL/SQL Utilities Reference adevmnt ACCELL/E nvironment Maintenance Syntax adevmnt Arguments None Description The adevmnt utility starts the ACCELL/E nvironment maintenance application. From this application you can perform these tasks: display information on locks currently held by ACCELL/E nvironment delete lock records held by ACCELL/E nvironment The adevmnt utility updates the ADEVLOCKS table, which contains lock record information. ACCELL/E nvironment Maintenance Application Menu The ACCELL/E nvironment maintenance application menu contains these options: 1. Display Lock Records 2. Display, Delete (one at at time) Lock Records 3. Enter Search Criteria to Remove a Group of Lock Records 4. Exit the application Option 1, “Display Lock Records,” displays a multi-occurrence form. The form is read-only; no updates, inserts, or deletes are allowed on this form. The form simply displays a list of the current locks that are held by ACCELL/E nvironment. For each lock, the host name, user identifier, process identifier, object name (application or form name), and object type (A for application, F for form) is displayed. ACCELL/SQL Utilities Reference 113 adevmnt Option 2, “Display, Delete (one at a time) Lock Records,” opens the same form as option 1, but allows deletes. To delete one of the listed records, select the record and use the DELETE RECORD command. For options 1 and 2, you can use the CLEAR TO FIND command to limit the search to a particular set of records. Option 3, “Enter Search Criteria to Remove a Group of Lock Records,” opens a single-occurrence form on which you can type search criteria that consists of one or more of these entries: host name, user name, and process identifier. The specified values are used to perform a non-interactive delete of a group of lock records. Before the delete is performed, you are told how many records will be deleted and asked to confirm that the delete should be performed. If you specify no criteria, all lock records are deleted (after confirmation). Zoom forms to list host names, user identifiers, and process identifiers are provided for Option 3. Note that because of the complexity of networked environments, user identifiers are listed instead of user names. Running adevmnt To run adevmnt from the command line, simply type the utility name with no arguments. Required Configuration Variables Before you can run adevmnt, these configuration variables must be set: ATERMCAP (UNIX only) Set to the directory path and file name of the ACCELL/SQL termcap file. UNICAP Set to the directory path and file name of the ACCELL/SQL unicap file. UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. These configuration variables are listed in the following table. 114 ACCELL/SQL Utilities Reference adevmnt Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db If the ACCELL/E nvironment, Menu Handler, and Tutorial tables are in a logical database object that is not named DBUTIL (or dbutil on an RDBMS that requires lowercase object names), you must set the ACL_DBUTIL_SCH configuration variable to the name of the logical database object that contains the tables. ACCELL/SQL Utilities Reference 115 adevmnt See Also 116 adev utility description on page 109, ATERMCAP configuration variable description on page 31, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNICAP configuration variable description on page 83, UNIFY configuration variable description on page 84, “Controlling Concurrency in ACCELL/E nvironment,” in ACCELL/SQL: Managing an Application, DELETE RECORD and CLEAR TO FIND command descriptions in ACCELL/SQL: Writing Form Scripts and ACCELL/SQL: Using an Application, ACCELL/SQL: Developing an Application ACCELL/SQL Utilities Reference AGEN Application development Syntax For a master application form: AGEN [-S db_object] [-U user_name] [-P password] [-C table_name] -a[i] MAF_name standard_form_list For a standard form: AGEN [-S db_object] [-U user_name] [-P password] [-C table_name] [-i] standard_form_list Arguments –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the forms to be created or edited: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. ACCELL/SQL Utilities Reference 117 AGEN –P password (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. –C table_name Specifies the name of a target table for which AGEN is to create a form and default fields for every column in the table, except binary columns. The form that is created has the same name as the specified table; the fields on the form have the same names as the columns in the table. –a Before MAF_ name and standard_form_list, indicates that the first form specified is a master application form. The –a option is required if you run AGEN on a master application form. –ai Before MAF_ name and standard_form_list, indicates that the first form specified is a master application form, and the specified form names do not have the default form file name suffixes. The default suffixes are .aq for the master application form and .fq for a standard form. When the –a and –i options are both used, they must be combined as –ai. –i Before standard_form_list, indicates that the specified standard form names do not have the default form file name suffix, .fq. MAF _name Specifies the name of a master application form to be created or edited. The MAF_name must be preceded by the –a option, and the master application form name must precede the first name in the standard_form_list. standard_form_list Specifies the names of one or more ACCELL/SQL standard forms to be created or edited. If one of the forms is a master application form, standard_form_list must be preceded by the –a option and the master application form name, MAF_name. 118 ACCELL/SQL Utilities Reference AGEN Description The AGEN utility starts ACCELL /Generator on one or more screen forms listed in form_list. Generating screen forms is the first step when you build an ACCELL/SQL application, as shown in the following diagram: 1. Create forms with AGEN . 2. Compile scripts with ACPL. 3. Combine form and 4GL script object file with ACMB . 4. Link application archives with ALNK . Required Configuration Variables Before you can run AGEN, these configuration variables must be set: ATERMCAP Set to the directory path and file name of the ACCELL/SQL termcap file. UNICAP Set to the directory path and file name of the ACCELL/SQL unicap file UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are shown in the following table: ACCELL/SQL Utilities Reference 119 AGEN Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 120 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference AGEN Running AGEN From the Command Line To run AGEN from the command line, type the AGEN utility name followed by the list of form files that you want to create or edit. AGEN assumes that form file names have the default file name suffix (.fq for standard forms and .aq for the master application form), unless you use the –i or –ai option when you specify the form names. To move to the next form that was specified in file list, use the PREVIOUS FORM command. AGEN exits the current form and starts the next form. Running AGEN From ACCELL/E nvironment To run AGEN from ACCELL /Environment, select the “Edit ACCELL /Generator Form” option on the ACCELL/E nvironment Operation menu. ACCELL /Generator is started for the current form. For information about using ACCELL/E nvironment, see ACCELL/SQL: Developing an Application. See Also ACMB utility description on page 98, ACPL utility description on page 103, ALNK utility description on page 122, ATERMCAP configuration variable description on page 31, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNICAP configuration variable description on page 83, UNIFY configuration variable description on page 84, PREVIOUS FORM command description in ACCELL/SQL: Using an Application, ACCELL/SQL: Creating Screen Forms ACCELL/SQL Utilities Reference 121 ALNK Application development Syntax ALNK [-i] archive_name [application_name [-i] [application_link_file ]] Arguments –i Before archive_name, indicates that the specified form archive name does not include the default file name suffix, .fa. Before application_link_file, –i indicates that the specified application link file name does not include the default file name suffix, .al. archive_name Specifies the name of the form archive file. If the application uses more than one form archive, archive_name must be the form archive that contains the master application form. If archive_name is not preceded by the –i option, the linker assumes that the form archive has the default archive file name suffix, .fa. If the archive is not in the current directory, ALNK searches for the archive in the directories specified by the ACLPATH configuration variable. ACLPATH specifies the path list for the ACCELL/SQL application link file (.al), form archive file (.fa), and help archive file (.hlp). application_name Specifies the name of the application, if the archive_name is different from the name of the master application form. If application_name is not specified, ALNK searches for a master application form that has the same base name as archive_name. For the application to link, the application name must have the same base name (the name without the file name suffix) as the master application form file. application_link_file Specifies the name of the application link file to be created. If application_link_file is not preceded by the –i option, the linker creates an application link file named archive_name.al. 122 ACCELL/SQL Utilities Reference ALNK Description The ALNK utility links the application’s archive file into an application link file. ACCELL /Manager uses the application link file to start the application. This file contains information about the application’s forms and the form archives that contain the forms. ALNK creates the application link file from information found in the REQUIRED FORMS and REQUIRED FUNCTIONS clauses of the master application form’s APPLICATION section. Linking is the fourth step when you build an ACCELL/SQL application: 1. Create forms with AGEN . 2. Compile scripts with ACPL. 3. Combine form and 4GL script object file with ACMB . 4. Link application archives with ALNK . Required Configuration Variables Before you can run ALNK, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. these variables are shown in the folowing table: ACCELL/SQL Utilities Reference 123 ALNK Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 124 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference ALNK Running ALNK From the Command Line To run ALNK from the command line, type the ALNK utility name followed by the name of the form archive to be linked. Usually, the form archive, application link file, and application all have the same name. In this case, to link the application files you can simply type the utility name and the archive name: ALNK archive_name Running ALNK From ACCELL/E nvironment To run ALNK from ACCELL/E nvironment, select either the “Compile/Integrate Forms and 4GL” option or the “Compile/Integrate/Run Application” option on the ACCELL/E nvironment Operation menu. ALNK is called after all form and script files are compiled and combined. For information about using ACCELL/E nvironment, see ACCELL/SQL: Developing an Application. See Also ACMB utility description on page 98, ACPL utility description on page 103, AGEN utility description on page 117, ACLPATH configuration variable description on page 11, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Writing Form Scripts ACCELL/SQL Utilities Reference 125 AMGR Application execution Syntax RDBMS , OS, and GUI dependencies AMGR [-S db_object] [-U user_name] [-P password] [- d debug ] [GUI_resource_specifications] [application_path/]application_link_file_name [access_code] Arguments –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the application to be run: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. 126 ACCELL/SQL Utilities Reference AMGR –P password (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. –d –debug Indicates that AMGR is to start with ACCELL/SQL Interactive Debugger enabled. (ACCELL/SQL Interactive Debugger is a separately licensed ACCELL/SQL option.) If the debugger is not licensed, you cannot use this option. GUI_resource_specifications (Motif and OPEN LOOK UI options only) One or more standard X Toolkit resource specifications or ACCELL/SQL resource specifications, separated by spaces. Valid resource specifications are shown in the next two tables. The first table shows standard standard X Toolkit resources. For the valid values that can be specified for these resources, see the X Toolkit Intrinsics Reference Manual. If the result is “No effect in ACCELL/SQL ,” the resource specification is not used for ACCELL/SQL applications, although the specification will not produce a usage error. X Toolkit GUI Resource Specifications Option Result -bg -background Sets the background color for the entire application. -fg -foreground Sets the foreground color of the entire application. For the OPEN LOOK UI option, note that this is different from the font color. -bd -bordercolor Sets border color. No effect in ACCELL/SQL. -bw -borderwidth Sets border width. No effect in ACCELL/SQL. -display Specifies the name of the server on which ACCELL/Manager is to run. -fl -fontlist (Motif UI option) Specifies the font list to be used for all windows. table continued on next page ACCELL/SQL Utilities Reference 127 AMGR X Toolkit GUI Resource Specifications (continued) Option Result -fn -font (OPEN LOOK UI option) Specifies the font to be used for all windows. -geometry Causes ACCELL/Manager to size itself incorrectly (on startup only) before it resizes itself to internal parameters. Unpleasant but no permanent effect. -iconic Sets initial state. No effect in ACCELL/SQL. -name Allows a user to set the application name, which determines the resources that are loaded. -reverse -rv +rv Sets reverse video. Sets initial state. No effect in ACCELL/SQL. -synchronous +synchronous Allows server synchronization to be turned on or off. No noticeable effect, except that performance slows if set to synchronous. -title Allows the user to change the application title in the title bar. The second table ACCELL/SQL resources and their valid values: ACCELL/SQL GUI Resource Specifications Option Result -busyMouse file_name Selects the bitmap to use for the busy mouse. If file_name is not an absolute path (beginning with /), then the path specified by the UNIFY configuration variable is used. (table continued on next page) 128 ACCELL/SQL Utilities Reference AMGR ACCELL/SQL GUI Resource Specifications (continued) Option Result -cof button -clickOnField button Controls clickĆonĆfield capability and specifies the mouse button to be used when you click on a field. The button argument is Btn1, Btn2, Btn3, or None, as described in the GUI manual. -hf font -highlightFontList font (Motif UI option) Allows the user to specify which highlight font list will be used to represent blink, dim, or reverse. -hf font -highlightFont font (OPEN LOOK UI option) Allows the user to specify which highlight font will be used to represent blink, dim, or reverse. -if file_name -iconFile file_name Specifies a valid bitmap format icon file. If file_name is not an absolute path (beginning with /), then the path specified in the UNIFY configuration variable is used. -up -usePixmaps Causes the application to use pixmaps to maintain the form. +up +usePixmaps Causes the application to stop using pixmaps to maintain the form. Additional Help For information about using the X toolkit intrinsics, see the O’Reilly and Associates manuals, X Toolkit Intrinsics Reference Manual and X Toolkit Intrinsics Programming Manual, for version X11 and your release (R4 or R5). application_path Specifies the path of the directory that contains the application link file. The specified path can be either absolute or relative. ACCELL/SQL Utilities Reference 129 AMGR application_link_file_name Specifies the name of the application link file (the .al file). If the specified application link file name is not preceded by an application path, the manager searches the current directory for the application_link_file_name file. For the application to be run, the application link file must have the same base name (the name without the file name suffix) as the master application form file. access_code A number from 0 to 15, indicates which interactive database operations (of find, add, update, and delete) are allowed during application execution. The default is 15, which allows the end user to perform all four interactive operations. For a list of the operations allowed by each code, see the table “Interactive Operations Allowed by AMGR Access Codes” on page 133. Description The AMGR script starts the appropriate version of ACCELL /Manager to run an ACCELL/SQL application. The version of ACCELL/M anager that is started depends on the value of the ACLPRESMODE configuration variable and whether the associated user interface option has been licensed: ACLPRESMODE and ACCELL/M anager ACLPRESMODE Value Manager Started User Interface Option OPENLOOK XOLAMGR OPEN LOOK UI option MOTIF XMAMGR Motif UI option CHARACTER, CHAR, CAMGR Character UI option empty string, or unset 130 ACCELL/SQL Utilities Reference AMGR Required Configuration Variables Before you can run AMGR, you must set these configuration variables: ATERMCAP Set to the directory path and file name of the ACCELL/SQL termcap file. UNICAP Set to the directory path and file name of the ACCELL/SQL unicap file. UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files, as shown in this table. Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS table continued on next page ACCELL/SQL Utilities Reference 131 AMGR Configuration Variables Used to Identify the Database (continued) RDBMS SYBASE SQL Server Unify DataServer Variable Description SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db You must also set the ACLPATH configuration variable if any of these files are not in the current directory (the directory from which you run AMGR): the specified application link file (application_path is not the current directory.) the form archives (.fa files) defined for the application help archives (.hlp files) defined for the application Running AMGR From the Command Line To run AMGR from the command line, type the AMGR utility name followed by the name of the application link file to be used. ACCELL/M anager uses the application link file (the .al file) to find the form archives that contain the application forms and their associated ACCELL/4GL form script files. If you do not specify an access_code, the default access code is 15, which allows the user to perform find, add, update, and delete operations. The operations allowed by each access code are shown in the next table. 132 ACCELL/SQL Utilities Reference AMGR Interactive Operations Allowed by AMGR Access Codes To allow these operations: Use this access code: None 0 Delete only 1 Update only 2 Update and delete 3 Add only 4 Add and delete 5 Add and update 6 Add, update, and delete 7 Find only 8 Find and delete 9 Find and update 10 Find, update, and delete 11 Find and add 12 Find, add, and delete 13 Find, add, and update 14 Find, add, update, and delete 15 The AMGR’s exit status can be used to programatically determine if the session aborted due to a fatal error. If the exit status of AMGR is non–zero, a fatal error occurred. The particular error is not identified by the exit status. It must be identified by seeing the error message that is displayed or printed by AMGR. Fatal errors are described in the AMGR Error Messages section. ACCELL/SQL custom managers are built with ORACLE Version 7 libraries. If you load a custom manager with ORACLE Version 7 libraries, you will be able to access both ORACLE 7 and ORACLE 6 databases. ACCELL/SQL Utilities Reference 133 AMGR Running AMGR From ACCELL/E nvironment To run AMGR from ACCELL/E nvironment, select either the “Compile/Integrate/Run Application” option or the “Run Application” option on the ACCELL/Environment Operation menu. AMGR is called for the current application. For information about using ACCELL/E nvironment, see ACCELL/SQL: Developing an Application. Example The first example runs the tutorial application. Because no application path is specified, AMGR expects to find the application in the current directory or in the directory that is specified in the ACLPATH configuration variable. AMGR tutorial The second example runs the tutorial application from the aclenv directory, when the tutorial application is located in the aclenv/tutorial directory: AMGR tutorial/tutorial Dependencies Motif and OPEN LOOK UI options only: This example specifies GUI resources for the screen foreground and background colors, and also specifies an icon file named tut_icon to be used for the tutorial application: AMGR –background White –foreground Black –iconFile tut_icon tutorial 134 ACCELL/SQL Utilities Reference AMGR See Also ACMB utility description on page 98, ACPL utility description on page 103, AGEN utility description on page 117, ALNK utility description on page 122, amgr.ld utility description on page 136, ACLPATH configuration variable description on page 11, ATERMCAP configuration variable description on page 31, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNICAP configuration variable description on page 83, UNIFY configuration variable description on page 84 ACCELL/SQL Utilities Reference 135 amgr.ld Application development Syntax amgr.ld custom_amgr_name [-presentation_mode] [-Onet_access_mode] [-Olinker_name] chooktb.o object_file_list Arguments custom_amgr_name Specifies the name of the executable file to be created. –presentation_mode Specifies the user interface presentation mode type, which can be any of these values: character (Default) Manager for character UI only. openlook Manager for OPEN LOOK graphical and character UI. motif Manager for Motif graphical and character UI. –Onet_access_mode (Unify DataServer RDBMS only) Specifies the UNIFY/Net database access mode, which can be any of these values: local_only (Default) Access local databases only. remote_only Access remote databases only. local_remote Access both local and remote databases. –Olinker_name Specifies the name of a language-specific linker, which can be any of these values: adaa.ld Linker for ADA language functions. cbla.ld Linker for COBOL language functions. sqla.ld (Default) Linker for C language functions. object_file_list Specifies the names of the C-hook object files to be loaded in addition to chooktb.o. Object file names must be separated by spaces. The object files can be the C Language object files themselves or the archives that contain the object files. 136 ACCELL/SQL Utilities Reference amgr.ld Description The amgr.ld utility relinks ACCELL/M anager to create a new custom manager. A custom manager is a version of ACCELL/M anager that recognizes developer-defined C language functions. Required Configuration Variables Before you can run amgr.ld, these configuration variables must be set: UNIFY Set to the directory path of the ACCELL/SQL release lib directory. DBTYPE Set to the name of the RDBMS on which the ACCELL/SQL application runs, for example, INFORMIX, INGRES, ORACLE, SYBASE, U2000. If you are using the Motif or OPEN LOOK UI option, you must set the following configuration variables. These variables ensure that amgr.ld can find the appropriate libraries for the UI option: M_LIBS (Motif UI option only) Path of the directory that contains the Motif libraries: the –lXm –lXt –lX11 archive files. OL_LIBS (OPEN LOOK UI option only) Path of the directory that contains the OPEN LOOK libraries: the –lXol –lXt –lX11 archive files. These variables must be set at the operating system command level. Regardless of the user interface, you must also set the configuration variables that are used by your RDBMS to find your database files. These variables are listed in the following table. ACCELL/SQL Utilities Reference 137 amgr.ld Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 138 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference amgr.ld Writing C-Hook Functions for ACCELL/SQL Applications When you write your own C-hook functions, you must modify the chooktb.c file, then relink the chooktb.o object file and the object files for your C-hooks. The chooktb.o file is the compiled version of the C-hook function table where C-hook functions are declared. (For more information about creating and using C-hook functions, see ACCELL/SQL: Writing Form Scripts.) After you have relinked the manager to include your C-hooks, you can run your new custom manager with this command: custom_amgr_name application_name [access_code] The command has these components: cust_amgr_name is the name of the custom manager. application_name is the directory path and file name of the application link file. access_code is a number from 0 to 15 that determines which interactive database operations (of find, add, update, and delete) are allowed during application execution. For a table of the access codes that are recognized by AMGR, see page 133. See Also AMGR utility description on page 126, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DBTYPE configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, M_LIBS configuration variable description on page 60, OL_LIBS configuration variable description on page 64, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Writing Form Scripts ACCELL/SQL: Developing an Application for a Graphical User Interface Unify DataServer: UNIFY/Net Guide ACCELL/SQL Utilities Reference 139 ASC2H Form and file conversion Syntax ASC2H archive_name [< ascii_file_name] Arguments archive_name Specifies the name of the help archive file to which the ascii_file is to be converted. Usually archive_name has the same base name as the master application form and has the file suffix .hlp. < ascii_file_name Specifies the name of the input file that contains the ASCII version of the help archive to be converted. If this argument is omitted, ASC2H expects its input from the terminal screen. Description The ASC2H utility converts an ASCII version of a help form archive to a help form archive file. You use ASC2H when you move a help form archive from one machine to another and when you upgrade to a newer release of ACCELL/SQL . Converting From Release to Release If you convert an application from one release of ACCELL/SQL to another release, make sure that you use the source release versions of Q2ASC and H2ASC to convert the forms and help archives to ASCII. Use the destination release versions of ASC2Q and H2ASC to convert the ASCII format files back to forms and help archives. For example, to convert an application from ORACLE to SYBASE SQL Server, use the Q2ASC and H2ASC that came with your ACCELL/SQL for ORACLE release to convert the forms and help archives to ASCII format. After you move the files to the new application directory, use the ASC2Q and ASC2H that came with your release of ACCELL/SQL for SYBASE SQL Server to convert the ASCII files back to forms and help archives. Required Configuration Variables Before you can run ASC2H, set these configuration variables: UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are shown in the following table. 140 ACCELL/SQL Utilities Reference ASC2H Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer ACCELL/SQL Utilities Reference SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db 141 ASC2H See Also 142 ASC2Q utility description on page 143, H2ASC utility description on page 167, Q2ASC utility description on page 202 DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Converting Release 1 Applications to Release 2 ACCELL/SQL Utilities Reference ASC2Q Form and file conversion Syntax For a master application form: ASC2Q [-S db_object] [-U user_name] [-P password] -a[i] MAF_name [< ascii_file_name] For a standard form: ASC2Q [-S db_object] [-U user_name] [-P password] [-i] standard_form_name [< ascii_file_name] Arguments –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the ASCII files to be converted: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. ACCELL/SQL Utilities Reference 143 ASC2Q –P password (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. –a Before MAF_name, indicates that the ASCII form file to be converted is for a master application form. The –a option is required if you run ASC2Q on an ASCII form file for a master application form. –ai Before MAF_name, indicates that the specified form is a master application form that does not have the default form file name suffix, .aq. When the –a and –i options are both used, they must be combined as –ai. –i Before standard_form_name, indicates that the ASCII form file is to be converted to an ACCELL/G enerator form file that does not have the default file name suffix. The default file name suffix is .fq for a standard form or .aq for the master application form. MAF _name Specifies the name of the master application form file to which the ASCII form file is to be converted. If MAF _name is not preceded by the –i option, the ASC2Q utility creates a form file with the name MAF _name.aq. standard_form_name Specifies the name of the standard form file to which the ASCII form file is to be converted. If standard_form_name is not preceded by the –i option, the ASC2Q utility creates a form file with the name standard_form_name.fq. < ascii_file_name Specifies the name of the input file that contains the ASCII form file to be converted. If this argument is omitted, ASC2Q expects its input from the terminal screen. 144 ACCELL/SQL Utilities Reference ASC2Q Description The ASC2Q utility converts an ASCII form file to a form file that can be used by ACCELL/G enerator or the combiner. You use ASC2Q when you move a screen form archive from one machine to another and when you upgrade to a newer release of ACCELL/SQL . Converting From Release to Release If you convert an application from one release of ACCELL/SQL to another release, make sure that you use the source release versions of Q2ASC and H2ASC to convert the forms and help archives to ASCII. Use the destination release versions of ASC2Q and H2ASC to convert the ASCII format files back to forms and help archives. For example, to convert an application from ORACLE to SYBASE SQL Server, use the Q2ASC and H2ASC that came with your ACCELL/SQL for ORACLE release to convert the forms and help archives to ASCII format. After you move the files to the new application directory, use the ASC2Q and ASC2H that came with your release of ACCELL/SQL for SYBASE SQL Server to convert the ASCII files back to forms and help archives. Running ASC2Q To run ASC2Q from the command line, type the ASC2Q utility name followed by the name of the ACCELL/SQL form file that you want to create. ASC2Q assumes that the specified form file name has the default file name suffix (.fq for a standard form or .aq for the master application form), unless you use the –i or –ai option when you specify the form names. To ensure that form changes and database changes match, follow these steps when you modify the database: 1. Run the Q2ASC utility before you modify the database. 2. Modify the database. 3. Run the ASC2Q utility. Tip Sometimes you can restore a corrupted form file if you convert it to an ASCII file, then convert the ASCII file back to a form file. ACCELL/SQL Utilities Reference 145 ASC2Q Required Configuration Variables Before you can run ASC2Q, these configuration variables must be set: Set to the path of the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are listed in the following table. Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 146 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference ASC2Q See Also ASC2H utility description on page 140, H2ASC utility description on page 167, Q2ASC utility description on page 202, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Converting Release 1 Applications to Release 2 ACCELL/SQL Utilities Reference 147 asqlmsg Diagnostic utility Warning This utility, which is located in the release diag directory, is for diagnostic use by Unify Customer Support only. Use this diagnostic utility only when instructed to do so by Unify Customer Support and only under their direction. 148 ACCELL/SQL Utilities Reference bldcmf Application development Syntax bldcmf [-Oidxint=index_interval] unify.msg Arguments –Oidxint=index_interval Specifies the number of messages per hash bucket. The index_interval is used to compute the number of hash table buckets required to index the message file. If index_interval is not specified, then the default number of messages is used: 10. unify.msg Description Indicates that bldcmf is to compile the unify.msg message file. The bldcmf utility can be run only on the unify.msg file. Although the uerror.msg file can be edited, it is never compiled be bldcmf. The bldcmf utility rebuilds the compiled message file (unify.cmf) from the message source file (unify.msg). Both the source file and the compiled message file are stored in the release lib directory (the directory that is specified by the UNIFY configuration variable). Gaps in the message file (nonexistent messages) still require hash table bucket entries. For example, if the messages range from message number 30 to message number 100, but the message file actually contains only 50 messages (and the default index value of 10 is used), 7 hash table buckets are allocated: (100 – 30) / 10 = 7 Warning Before you edit the unify.msg file, save backup copies of unify.msg (the message source file)and unify.cmf (the compiled message file). For example, copy unify.msg to a file named unify.msg1, and copy unify.cmf to a file named unify.cmf1. Make sure that you edit the original file, not the backup. ACCELL/SQL Utilities Reference 149 bldcmf Required Configuration Variables Before you can run bldcmf, these configuration variables must be set: Set to the path of the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are listed in the following table. Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 150 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference bldcmf Example This example rebuilds the unify.cmf file with an index interval of 15: bldcmf –Oidxint=15 unify.msg See Also PAINTHLP utility description on page 191, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, “Rebuilding the Compiled Message File” in ACCELL/SQL: Localizing an Application ACCELL/SQL Utilities Reference 151 ckguires System setup GUI only Syntax ckguires [-verbose] Arguments –verbose Description The ckguires utility verifies the compatibility of ACCELL/SQL GUI resource files installed on your system against the default resource files supplied in a new ACCELL/SQL release’s lib directory. Indicates that ckguires is to display the version number of any mismatched resource files. If ckguires reports any version mismatches, take these steps: 1. Make a list of the old files that must be updated with new resource information. 2. Save any changes that you have made to the old files on your list. 3. Remove the old files that are on your list from your system. 4. Rerun the utility opts.install to install new versions of the resource files. 5. Merge saved changes into the new resource files. The ckguires utility is located in the release diag directory, rather than the release bin directory. This is a diagnostic utility that is usually run only under direction of Unify Customer Support. Required Configuration Variables Before you can run ckguires, this configuration variable must be set: UNIFY See Also 152 Set to the path of the ACCELL/SQL release lib directory. UNIFY configuration variable description on page 84; Your ACCELL/SQL Installation Guide (for information about opts.install ), ACCELL/SQL: Developing an Application for a Graphical User Interface (for information about specifying resources for ACCELL/SQL applications) ACCELL/SQL Utilities Reference ckunicap System setup Character mode only Syntax ckunicap [-Oprint] [unicap_path_name] Arguments –Oprint Indicates that ckunicap is to print the unicap file after the messages. unicap_path_name Specifies the directory path and file name of the unicap file to be used. If no path and file name are specified, ckunicap accepts data from standard input. Description The ckunicap utility verifies the syntax of the unicap file and reports errors in the format and representation of characters. ckunicap does not verify semantics. Semantic errors are verified by applications that use unicap entries. The unicap file is used only for ACCELL/SQL running in character mode. Required Configuration Variables Before you can run ckunicap, this configuration variable must be set: UNIFY See Also Set to the path of the ACCELL/SQL release lib directory. UNIFY configuration variable description on page 84, unicap file description in ACCELL/SQL: Setting Up a User Environment ACCELL/SQL Utilities Reference 153 clrtbls Diagnostic utility Warning This utility, which is located in the release diag directory, is for diagnostic use by Unify Customer Support only. Use this diagnostic utility only when instructed to do so by Unify Customer Support and only under their direction. 154 ACCELL/SQL Utilities Reference config System setup Syntax cconfig_file_name config [ddbname Arguments ] -a -e -q variable variable . . . –cconfig_file_name Indicates that config is to display the values of variables in the specified configuration file. If the –cconfig_file_name option is not specified, config uses the default file. –ddbname Indicates that config is to display values from the configuration file associated with the specified database. If the –ddbname option is not specified, config uses the application database file for the current database. –a Indicates that config is to display the values of all the configuration variables that are currently set anywhere in the configuration file hierarchy. config also displays the directory paths and file names of the configuration files in which the variables are set. Variables set at the operating system command level do not display. –e Indicates that config is to display the current values of all configuration variables. If the variable is set in a configuration file, config displays the configuration file’s directory path and file name. If the variable is set at the operating system command level, config displays the word environment. Variables that are set at the operating system command level override variables that are set in configuration files. –q variable Indicates that config is to display the value of the specified configuration variable. If the specified configuration variable is undefined, config displays two double quotation marks (””) to indicate a null value. The –q option can be used only with a single configuration variable and cannot be used with the –a or –e option. ACCELL/SQL Utilities Reference 155 config variable . . . Description Indicates that config is to display the value of one or more specified configuration variables. If a variable is overridden by a variable that is set at the operating system command level, that variable’s value is displayed as well. If either configuration variable value is numeric, config displays the value in decimal, hexadecimal, and octal. The config utility enables you to display configuration variable values. If the variable is set in a configuration file, config displays the directory path and file name of the file. The config utility also recompiles the application configuration file if application.cf has a later time stamp than application.cfg. When you compile the application configuration file, you enhance application performance because configuration variable values can be located quickly in a compiled configuration file. Dependencies For the Unify DataServer RDBMS, the compiled application configuration file is also the compiled database configuration file and is named dbname.cfg. Required Configuration Variables Before you can run config, this configuration variable must be set: UNIFY Example Set to the path of the ACCELL/SQL release lib directory. The following examples show how to use the config utility. The first example calls config to display the values of two configuration variables. config AGEN_ERFL AGEN_HPSZ config responds: AGEN_ERFL: ’/dev/null’ AGEN_HPSZ: ’32k’ (environment) ’8k’ (configuration) 32768 0x8000 0100000 decimal value 156 hexadecimal value Value of variable set at operating system command level Value of variable set in configuration file octal value ACCELL/SQL Utilities Reference config The second example calls config to display the values of all the configuration variables that are currently set and indicate whether they are set at the operating system command level (in the environment) or in a configuration file. config –e config responds: Variable Name ––––––––––––––––– Configuration Value ––––––––––––––––––– AGEN_ERFL AGEN_HPSZ AGEN_SEL_SET_DR AMGR_ERFL /dev/null 32k /usr/tmp /dev/null ... ... CNO Configuration File ––– –––––––––––––––––– * /usr/db/file.cf environment /usr/db/file.cf /usr/db/file.cf The headers on the config report contain this information: Variable Name Name of the configuration variable for which a value is displayed. Configuration Value Current value of the configuration variable. CNO An asterisk (*) in this column means that you cannot override the value of this configuration variable by setting the variable at the operating system command level. Configuration File Name of the file that contains the configuration variable. If the variable is set at the operating system command level, this column contains “environment.” See Also UNIFY configuration variable description on page 84, “Configuring an Application Environment,” in ACCELL/SQL: Managing an Application ACCELL/SQL Utilities Reference 157 dmpcfg Diagnostic utility Warning This utility, which is located in the release diag directory, is for diagnostic use by Unify Customer Support only. Use this diagnostic utility only when instructed to do so by Unify Customer Support and only under their direction. 158 ACCELL/SQL Utilities Reference FRMDOC Application documentation Syntax For a master application form: FRMDOC -a[i] MAF_name [> ascii_file_name] For a standard form: FRMDOC [-i] standard_form_name [> ascii_file_name] Arguments –a Before MAF _name, indicates that the specified form is a master application form. This option is required if you run FRMDOC on a master application form. –ai Before MAF _name, indicates that the specified form is a master application form, and the form name does not include the default .aq file name suffix. When the –a and –i options are both used, they must be combined as –ai. –i Before standard_form_name, indicates that the specified standard form name does not have the default file name suffix: .fq for a standard form or .aq for the master application form. MAF _name Specifies the name of a ACCELL/SQL master application form file to be documented. If MAF_name is not preceded by the –i option, the FRMDOC utility produces documentation for the master application form file named MAF_name.aq. standard_form_name Specifies the name of the ACCELL/SQL standard form file to be documented. If standard_form_name is not preceded by the –i option, FRMDOC utility produces documentation for the form file named standard_form_name.fq. ascii_file_name Specifies the name of the file to which the FRMDOC output is sent. If this argument is omitted, FRMDOC sends its output to standard output, which is usually the terminal screen. ACCELL/SQL Utilities Reference 159 FRMDOC Description The FRMDOC utility is a documentation prototyping tool that produces a report of form characteristics for an ACCELL/SQL form file. You can use the FRMDOC report as an ASCII format template that you can edit in a text editor to produce documentation for application end-users. You can also use the FRMDOC report to make sure that your finished application matches your original application design. Required Configuration Variables Before you can run FRMDOC , these configuration variables must be set: Set to the path of the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files: Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software table continued on next page 160 ACCELL/SQL Utilities Reference FRMDOC Configuration Variables Used to Identify the Database (continued) RDBMS ORACLE Variable ORACLE_SID ORACLE_HOME Description the unique SGA (system global area) to be used ORACLE system identifier for Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db Running FRMDOC From the Command Line To run FRMDOC from the command line, type the FRMDOC utility name followed by the name of the ACCELL/SQL form file for which you want documentation. FRMDOC assumes that the specified form file name has the default file name suffix (.fq for a standard form or .aq for the master application form), unless you use the –i or –ai option when you specify the form name. FRMDOC produces a multiple-page report about the specified screen form. Page 1 is titled “FORM REPORT” and contains this information: the name of the ACCELL/SQL form that the report describes the name of the target table for the form a list of the database operations that can be performed on this form. The possible database operations are “find allowed,” “Update allowed,” “delete allowed,” and “add allowed.” ACCELL/SQL Utilities Reference 161 FRMDOC whether the form is to be created in a base window if used on a graphical user interface whether click-on-field capability is enabled for the form if used on a graphical user interface whether users can use a scrollbar to move through the current set of records if used on a graphical user interface whether the form is single-occurrence or multi-occurrence. all the sort fields and their sort order for the form the form display coordinates, width in number of rows, and height in number of columns the menu description string the name of the help form archive Page 2 is titled “FORM IMAGE” and contains this information: numbers that indicated columns and rows prompts and trim field windows that are indicated by a string of characters that represent the data type: A = AMOUNT N = NUMERIC B = BOOLEAN S = STRING D = DATE T = TIME F = FLOAT X = TEXT a list of fields that includes the field coordinates and video attributes Page 3 is titled “FIELD DEFINITIONS” and contains this information: the number of fields on the form which field is first on the form the order in which fields are accessed—by row or by column 162 ACCELL/SQL Utilities Reference FRMDOC For each field listed on the field definitions page, the report lists this information: the field name the field data type the field input length the field window width and height whether the field has Stop for Input enabled whether the field is a tab-stop field Page 4 is titled “ADVANCED FIELD DEFINITIONS” and contains this information: the field name whether the field can be updated whether the field is a repeating field whether the field is left or right justified See Also Q2ASC utility description on page 202, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84 ACCELL/SQL Utilities Reference 163 frmlst Diagnostic utility Warning This utility, which is located in the release diag directory, is for diagnostic use by Unify Customer Support only. Use this diagnostic utility only when instructed to do so by Unify Customer Support and only under their direction. 164 ACCELL/SQL Utilities Reference gtlogin System setup SYBASE SQL Server and ORACLE only Syntax gtlogin [user_name[/password]] Arguments user_name Specifies the user name to be used to log into the database. password Specifies the password to be used to log into the database. Description The gtlogin utility obtains the user name and password of the current user. The password is not echoed to the screen as the user types it. The gtlogin utility directs the result in the form user_name/password to standard output. Redirect the output to a file if you do not want it to print on the screen. You can start the gtlogin utility in several ways: If you enter no command line arguments, gtlogin prompts for the user name and password. If you enter only a user name on the command line, then gtlogin prompts you for the password. If you enter both a user name and a password on the command line, then gtlogin does not prompt for anything. Instead, gtlogin echoes the user name and password in a form suitable for DBUSER or the –U and –P command line options. If you press CONTROL and gtlogin exits. D at the login or password prompt, nothing is echoed Usually you would run gtlogin from a script or a program. The gtlogin utility is used by scripts and make files to obtain the user name and password one time only. The –U and –P command line arguments can then be used to provide the user name and password to ACCELL/SQL utilities. ACCELL/SQL Utilities Reference 165 gtlogin Required Configuration Variables Before you can run gtlogin, these configuration variables must be set: Example UNIFY Set to the path of the ACCELL/SQL release lib directory. DBTYPE Set to the type of database with which ACCELL/SQL is being used (INFORMIX, INGRES, ORACLE, SYBASE, or U2000). This example shows how to use the gtlogin utility to set the DBUSER configuration variable from the UNIX operating system Bourne shell: DBUSER=`gtlogin`; export DBUSER The quotation marks (‘ . . . ‘) that surround gtlogin are backquotes. In this case gtlogin prompts for the user name and password. This script example ensures that DBUSER is set. When the script is run, it asks for the user name and password once, then sets DBUSER (if necessary). The report writer, RPT, obtains the user name and password from DBUSER and does not need to prompt the user for them. Determines whether DBUSER is set RPT runs without prompting See Also 166 . . . if test –z ”$DBUSER” then DBUSER=`gtlogin` fi export DBUSER . . . RPT . . . RPT . . . RPT . . . DBTYPE configuration variable description on page 46, DBUSER configuration variable description on page 47, UNIFY configuration variable description on page 84, ACCELL/SQL: RDBMS Integration ACCELL/SQL Utilities Reference H2ASC Form and file conversion Syntax H2ASC archive_name [> ascii_file_name] Arguments archive_name Specifies the name of the help archive file to be converted. Usually archive_name is the name of the master application form and has the file suffix .hlp. The file name suffix must be included, even if the suffix is .hlp. > ascii_file_name Specifies the name of the file to which the ASCII version of the help archive is to be written. If this argument is not specified, the H2ASC utility sends its output to the terminal screen. Description The H2ASC utility converts an ACCELL/SQL help archive file to an ASCII help archive. You use H2ASC when you move a help form archive from one machine to another and when you upgrade to a newer release of ACCELL/SQL . Required Configuration Variables Before you can run H2ASC, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are listed in the following table. ACCELL/SQL Utilities Reference 167 H2ASC Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 168 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference H2ASC Converting From Release to Release If you convert an application from one release of ACCELL/SQL to another release, make sure that you use the source release versions of Q2ASC and H2ASC to convert the forms and help archives to ASCII format. Use the destination release versions of ASC2Q and H2ASC to convert the ASCII format files back to forms and help archives. For example, if you convert an application from ORACLE to SYBASE SQL Server, use the Q2ASC and H2ASC that came with your ACCELL/SQL for ORACLE release to convert the forms and help archives to ASCII format. After you move the files to the new application directory, use the ASC2Q and ASC2H that came with your release of ACCELL/SQL for SYBASE SQL Server to convert the ASCII files back to forms and help archives. Example This example converts a help archive name named accts.hlp to an ASCII file named accts.hz. H2ASC accts.hlp > accts.hz See Also ASC2H utility description on page 140, ASC2Q utility description on page 143, Q2ASC utility description on page 202, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Converting Release 1 Applications to Release 2 ACCELL/SQL Utilities Reference 169 irs Report generation and execution Syntax irs [-d dbname] [-S db_object] [-U user_name] [-P password] [-O PROMPTER =prompter_name SELECTOR =selector_name SCREEN FILE =file_name PRINTER PIPE = command BACKGROUND ERROR_FILE =file_name DEBUG_MODE ] irs_script n=parameter_value REPORT=rpt_section_name Arguments –d dbname Indicates that irs is to use the specified database. If dbname is not specified, the default is the current database. –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the application files to be used: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. 170 ACCELL/SQL Utilities Reference irs –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. –P password (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. –OPROMPTER =prompter_name Indicates that irs is to use the specified custom prompter executable. The prompter prompts the user for parameter input. –OSELECTOR=selector_name Indicates that irs is to use the specified custom selector executable. The selector prompts the user for report format selection. –OSCREEN Indicates that irs is to send the report to standard output. The paging utility to be used when SCREEN is specified is determined by the PAGER configuration variable. –OFILE=file_name Indicates that irs is to send the report to the specified file. –OPRINTER Indicates that irs is to send its output to the specified printer. The print spooler to be used when PRINTER is specified is determined by the SPOOLER configuration variable. –OPIPE =command Indicates that irs is to direct report output as specified by the command string. ACCELL/SQL Utilities Reference 171 irs –OBACKGROUND Indicates that irs is to run in the background. (The default is foreground.) –OERROR_FILE =file_name Indicates that irs is to send error messages to the specified file. –ODEBUG_MODE Indicates that irs is to run in debug mode and send text that has replaced parameters to the standard error file. –On=parameter_value Indicates that irs is to substitute the specified parameter value for all occurrences of the parameter placeholder $n in the report script. n is a number from 1 through 128. –OREPORT=rpt_section_name Specifies the name of the RPT_SECTION section that contains the script to be used to format the report. If the RPT_SECTION name contains spaces or other special characters, enclose the name in double quotation marks (”rpt_section_name”); use a backslash (\) to escape special characters. irs_script 172 Specifies the name of the irs report script file to be used. The irs script file contains four sections: INPUT_SECTION, ENVIRONMENT_SECTION , SQL_SECTION, and RPT_SECTION . ACCELL/SQL Utilities Reference irs Description The irs utility is used to run ACCELL/SQL Report Writer (RPT) report scripts. If you use irs with command line arguments, you can call irs from other areas of an ACCELL/SQL application. You can use irs command line arguments to: override specifications in the report script environment section provide values for the report script input section automatically select the report format Almost all command line arguments use the –O flag, immediately followed by an optional argument (no embedded spaces). The irs utility calls the RPT utility to compile the report format section of the report script. Tip As an alternative, you can run the RPT utility to generate reports. Required Configuration Variables Before you can run irs, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. DBTYPE Set to the type of database with which ACCELL/SQL is being used (INFORMIX, INGRES, ORACLE, SYBASE, or U2000). ACCELL/SQL Utilities Reference 173 irs Example The following two examples each call irs with three command line arguments. The first example directs irs to send error messages to the /tmp/err.out file, send all other output to the screen, and replace the $1 and $2 parameters by the dates (99/01/01 and 99/12/31). Every occurrence of $1 and $2 is replaced by the text string that follows the =; also, corresponding prompts and messages are skipped Error messages are sent to an arbitrary file irs –OERROR_FILE=/tmp/err.out –OSCREEN –O1=91/01/01 –O2=91/12/31 Calls RPT in integrated mode Program output is sent to standard output (the screen) The second example directs irs to pipe output to the /tmp/out file and the lpr printer, replace the $1 parameter with an SQL query, and use the format.irs integrated mode script. Every occurrence of $1 is replaced by the string that follows = (in this case, an SQL database query) irs –OPIPE=’utee /tmp/out | lpr’ –O1=’select * from history ;’ format.irs Output from SQL/RPT is piped to a file and the printer through the utee command See Also 174 Name of the integrated mode script to be used RPT utility description on page 211, DBTYPE configuration variable description on page 46, UNIFY configuration variable description on page 84 ACCELL/SQL: Creating Reports With RPT Report Writer ACCELL/SQL Utilities Reference make_maf Application development Syntax make_maf release_lib_dir form_name Arguments release_lib_dir Specifies the path of the ACCELL/SQL release lib directory, which is usually the directory where you installed ACCELL/SQL . (If the UNIFY configuration variable is set and you are on a UNIX-based operating system, you can specify the release lib directory as $UNIFY.) form_name Description Specifies the name of the master application form to be created. The make_maf utility is a prototyping tool that creates a master application form named form_name.aq. make_maf is the utility that is called by ACCELL/G enerator when you use the generator to create a master application form. Required Configuration Variables Before you can run make_maf, this configuration variable must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are listed in the following table. ACCELL/SQL Utilities Reference 175 make_maf Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 176 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference make_maf Example This example creates a master application form named acctg_app.aq. make_maf $UNIFY acctg_app See Also makeamake utility description on page 178, MKAP utility description on page 181, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84 ACCELL/SQL Utilities Reference 177 makeamake Application development Syntax makeamake [-S db_object] Arguments –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the application files to be used: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. The makeamake utility passes the –S option to ACPL. Description The makeamake utility creates a make file that contains the ACCELL/SQL commands to compile (ACPL), combine (ACMB), and link (ALNK) the current application. The makefile, which is named makefile, is used to recreate a runtime application after form and script files have been modified. Run makeamake to ensure that the make file is up to date after these events: after you create your application forms and form scripts after you add or delete forms or form scripts 178 ACCELL/SQL Utilities Reference makeamake To create a make file, take these steps: 1. Change directories to your application directory. 2. Remove any makefile that exists. 3. To generate the new make file for your application, run makeamake. 4. After you have a make file, run the make utility to relink the application. The make utility compares the dates of all the files that are listed in the make file to determine whether any of the files have been modified since the last relink. Depending on the files that you have modified, make automatically compiles, combines, and links the modified files. To use makeamake, the forms must all be in a single form archive and all form and form script files must all be in the current directory. You cannot use the makeamake utility if you have multiple form archives or have distributed form and form script files over several directories. Required Configuration Variables Before you can run makeamake, this configuration variable must be set: Set to the path of the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are listed in the following table. Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. table continued on next page ACCELL/SQL Utilities Reference 179 makeamake Configuration Variables Used to Identify the Database (continued) RDBMS INFORMIX SE INGRES ORACLE Variable Description DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer See Also 180 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db make_maf utility description on page 175, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Developing an Application, ACCELL/SQL: Writing Form Scripts ACCELL/SQL Utilities Reference MKAP Application development -A application_name [-S db_object] [-U user_name] [-P password] target_table_name [[, target_table_name] , . . . ] Syntax MKAP Arguments –A application_name Specifies the name of the application to be created. If the application_name argument is specified, the master application form is created as application_name.aq. The application_name argument is required if the command line contains more than one target_table_name argument. –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the application files to be used: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. ACCELL/SQL Utilities Reference 181 MKAP –P password (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. target_table_name Specifies the name of a target database table for which a form is to be created. If application_name is not specified, the master application form name is created as target_table_name.aq, and the standard form is created as target_table_name.fq. If more than one target_table_name is specified, the master application form is created as application_name.aq, and the standard forms are created as target_table_name.fq (one standard form for each target table specified). Description The MKAP utility is an application prototyping tool that can be run from the operating system command line or from a menu through ACCELL/SQL Menu Handler. When run through Menu Handler, MKAP runs interactively; when run from the command line, MKAP does not run interactively. MKAP creates a default application that includes a master application form (.aq file) and at least one standard form (.fq file). For each target table that is specified on the command line, MKAP creates a default form with these features: One field for each target table column, except for BINARY type columns. Forms cannot contain BINARY fields. The field prompts are the database column names of the target table columns. The name is truncated if its length exceeds 10 characters. Field windows are to the right of the corresponding field prompts. Fields and prompts are arranged in alphabetical order by the prompt strings. Fields and prompts are listed in one, two, or three columns, depending on the number and size of the fields. Warning The MKAP utility overwrites existing application forms and scripts. Use MKAP only to create a new application; do not use MKAP on an existing application. 182 ACCELL/SQL Utilities Reference MKAP Tip Modifying forms created by MKAP: Forms that were created by MKAP can be modified in ACCELL/G enerator like any other ACCELL/SQL application form. Creating a master application form: To create only a default master application form, use the make_maf utility. Column names: Column names are used as the prompts for the fields on the default forms created by MKAP. However, the number of characters allowed for a prompt is 10. If the column name is longer than 10 characters, the name is truncated to 10 characters for the prompt. If you have a target table that has column names that are not unique in the first 10 characters, do not include the target table in the target table list specified to MKAP. Instead, use ACCELL/G enerator to create the form for the table. Target tables that have many columns: MKAP calls ACCELL/G enerator to create the default forms. ACCELL/G enerator calculates how many fields can fit on the form, based on the sizes of and number of the target table columns. If the target table has more columns than the form has field space for, ACCELL/G enerator creates only as many fields as fit on the form. The excess columns are omitted from the form. If you receive an error message that not all fields can be accommodated for the target table, use ACCELL/G enerator to create the form for the table. Alternatively, you can use MKAP to create the form, then use ACCELL/G enerator to modify the form. Target table names that are longer than 10 characters: If a target table name is longer than 10 characters, the name is truncated. This can lead to a link error because some target table names listed in the application files do not have matching database target table names. If a target table name is longer than 10 characters, do not include it in the target table list that is specified to MKAP. Instead, use ACCELL/G enerator to create the form for the table. ACCELL/SQL Utilities Reference 183 MKAP Required Configuration Variables Before you can run MKAP, this configuration variable must be set: Set to the path of the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are listed in the following table. Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 184 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference MKAP Running MKAP From the Command Line To run MKAP from the command line, type the utility name, followed by the application name and any additional options. On the command line to MKAP you cannot specify a different default form size, field size, or trim size from the system defaults used by ACCELL/G enerator. For example, the default size for each form field is the size of the corresponding column in the target table. Running MKAP from ACCELL/SQL Menu Handler To run MKAP from ACCELL/SQL Menu Handler, run the accell utility to start Menu Handler. Select the Make Default Application option from the Main menu. When started from Menu Handler, MKAP runs interactively. This is the first MKAP form that is displayed: Make Default Application MKAP Application Information form Database name: DBUTIL Password: Application name: Register with Menu Handler: Target Tables Target Tables form Tip When you start MKAP from the command line, MKAP is not form driven and does not have an option that lets you register the application with Menu Handler. You cannot mix application development methods. You must either develop the entire application through ACCELL/E nvironment or develop the entire application through command-level utilities, such as AGEN, ACPL, ACMB, and ALNK. If you want to be able to complete the application through ACCELL/E nvironment, run MKAP through Menu Handler. ACCELL/SQL Utilities Reference 185 MKAP When the MKAP form is displayed, create a default application by following these steps: 1. In the Database name field, type the name of the database to be used for this application, or press RETURN to accept the default DBUTIL. 2. If the cursor stops on the Password field, type the password that will log you in to the database. 3. In the Application name field, type the application name, for example, acctsapp. If the application already exists, MKAP will ask whether you want to overwrite the application. 4. At the Register with Menu Handler prompt, type yes to register the application with Menu Handler, otherwise type no. 5. Type in the name of a target table on the Target Tables form. You can zoom to a list of target table names to obtain the table name. Press ADD/UPDATE after you add the table name. 6. The Target Tables form is a multi-occurrence form, with one record for each table name. 7. For additional table names that you want to add to the list, press CLEAR TO ADD before you add each table name. Type the target table names one at a time on the Target Tables form and press ADD/UPDATE after you add each table name 8. After you specify all the table names for which you want to create forms, ask MKAP to make the application. If you are using the character user interface, press F2 to make the application. If you are using the Motif or OPEN LOOK UI option, select make app from the User pull-down menu, or press F2 to execute the menu option. Depending on the RDBMS and on your current environment, after you tell MKAP to create the application, the database login form may be displayed so that you can type in your database user name and password. MKAP makes a directory for the application and creates the application link file (.al), the form files (.aq and .fq), and other necessary application files. 186 ACCELL/SQL Utilities Reference MKAP Example This example shows how to use MKAP from the command line to create an application named sales with a master application form named sales.aq. The sales application also includes three standard forms: company.fq, orders.fq, and items.fq. MKAP –A sales company orders items See Also AGEN utility description on page 117, UNIFY configuration variable description on page 84, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Developing an Application ACCELL/SQL Utilities Reference 187 orcfltr Report generation and execution ORACLE only Syntax orcfltr Arguments None Description The orcfltr utility filters an ORACLE SQL*Plus-generated input file so that it can be used by RPT. When ORACLE SQL*Plus produces an input file for RPT, the file does not contain separator characters. RPT expects the input file to be in a format that includes separator characters. The orcfltr utility takes the ORACLE SQL*Plus output and converts it to a format that RPT can use. The orcfltr utility is similar to other UNIX filters that take input from stdin and send output to stdout. But before you use orcfltr, you must make the SQL*Plus settings that are described in the table on the next page. ORACLE SQL*Plus must be called with the –susername/password option so that prompts and other extraneous information are not output to orcfltr. SQL*P lus Settings Needed for orcfltr SQL*P lus Statement Default? Result of Statement Execution set pages > 0 Yes Prints the headings so that orcfltr can determine where to place column separator characters. set und– set und on Yes Prints the underline character for the heading so that orcfltr can determine where to place separator characters. set feedback 0 No Suppresses the printing of the row count at the end of the selected set so that orcfltr does not treat the line as a data line. Table continued on next page 188 ACCELL/SQL Utilities Reference orcfltr SQL*P lus Settings Needed for orcfltr (continued) SQL*P lus Statement Default? Result of Statement Execution set trim off No Keeps the line intact, without truncating it, so that orcfltr can distinguish between a line that contains data with spaces and a newline before the heading. set recsep off No Suppresses the line of separator characters after the row, so that orcfltr can distinguish between a data line that contains spaces and a newline before the heading. set newp 1 Yes Used with trim off and recsep off, so that orcfltr can determine the difference between a newline before a heading and a data line that contains spaces. This is necessary because headings and data are interspersed in the SQL*Plus output. Also set the linesize variable to a number greater than or equal to the length of the largest single column value. Or alternatively, to truncate the data, use the column command. If the ORACLE SQL*Plus output is unrecognizable, the orcfltr utility displays this error message: Input not in correct format Required Configuration Variables Before you can run orcfltr, this configuration variable must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. orcfltr and irs If you use irs, irs automatically calls orcfltr. When irs processes the SQL_SECTION irs calls ORACLE SQL*Plus. irs and first passes the SQL*Plus results through orcfltr then passes them on to RPT. ACCELL/SQL Utilities Reference 189 orcfltr orcfltr and Pipelines You do not need to use orcfltr when you use RPT through the PIPELINE statement in ACCELL/4GL . Example These syntax examples show alternative ways to use orcfltr. The first example calls sqlplus for the specified user and runs the sqlscript1.sql script. The output is passed to orcfltr, which filters the output to produce input in a format that RPT can understand. The filtered input is then passed to RPT. sqlplus –suser_name/password < sqlscript1.sql | orcfltr | RPT rptscript1 – The second example calls sqlplus for the specified user and runs the sqlscript1.sql script. The output is passed to orcfltr, which filters the output and creates an input file that has a format that RPT can understand. sqlplus –suser_name/password < sqlscript1.sql | orcfltr > file1 The third example calls orcfltr to filter the file1 file and create the file2 file, which can then be passed to RPT as an input file in a format that RPT can understand. orcfltr < file1 > file2 The fourth example calls orcfltr to filter the file2 file and pass the output to RPT in a format that RPT can understand. orcfltr < file2 | RPT rptscript1 – See Also 190 irs utility description on page 170, RPT utility description on page 211, UNIFY configuration variable description on page 84, ACCELL/SQL: RDBMS Integration ACCELL/SQL Utilities Reference PAINTHLP Application development Syntax PAINTHLP [-i] archive_name Arguments –i Before archive_name, indicates that the specified help archive file name does not have the default .hlp suffix. archive_name Specifies the name of the help archive file to be edited: application_name.hlp Contains the application help forms. Usually, application_name is the same as the master application form (the .aq file). Description DBGHLP The ACCELL/SQL debugger help forms. PAINTMSG The field help forms for the ACCELL/G enerator forms such as the Form Definition form and the Field Definition form. SERRORS Contains the ACCELL/SQL error forms that pop up when a runtime error occurs. SGLHLP The ACCELL/SQL release runtime help forms for commands SGLPNTHLP The general help forms for ACCELL/G enerator. The PAINTHLP utility allows you to add, modify, or delete help forms in a help archive file. Required Configuration Variables Before you can run PAINTHLP, these configuration variables must be set: ATERMCAP Set to the directory path and file name of the ACCELL/SQL termcap file. UNICAP Set to the directory path and file name of the ACCELL/SQL unicap file. UNIFY Set to the path of the ACCELL/SQL release lib directory. ACCELL/SQL Utilities Reference 191 PAINTHLP You must also set the configuration variables that are used by your RDBMS to find your database files: Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 192 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference PAINTHLP Running PAINTHLP From the Command Line To run PAINTHLP from the command line, type the PAINTHLP utility name, followed by the name of the help archive to be edited. PAINTHLP displays the initial PAINTHLP screen, which prompts you to indicate whether you want to add, modify, or delete a help form, or exit the PAINTHLP utility. If you choose to add, modify, or delete a form, PAINTHLP then prompts you for the form name. Warning You can modify existing forms only. Do not add or delete forms from the DBGHLP, PAINTMSG, SERRORS, SGLHLP, or SGLPNTHLP files. Tip If you do not know the names of the help forms in your application, you can use the H2ASC utility (page 167) to convert your help archive to ASCII format. Then look through the ASCII help archive file for the help form names. After you have found the names, use the ASC2H utility (page 140) to convert the ASCII file back to help archive format. Running PAINTHLP From ACCELL/SQL Menu Handler To add, modify, or delete help forms from ACCELL/M enu Handler, select the “Add or Modify Help for Menu Items” option from the “Menu Handler Maintenance Utilities” submenu. For information about this Menu Handler option, see “Customizing User Menus,” in ACCELL/SQL: Localizing an Application. Adding and Modifying Help Forms Through ACCELL/Generator You can also add and modify help forms from ACCELL /Generator. However, to delete a help form from a help archive, you must select the PAINTHLP Delete option. ACCELL/SQL Utilities Reference 193 PAINTHLP See Also 194 ASC2H utility description on page 140, H2ASC utility description on page 167, ATERMCAP configuration variable description on page 31, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNICAP configuration variable description on page 83, UNIFY configuration variable description on page 84, “Customizing Help Archives” in ACCELL/SQL: Localizing an Application. ACCELL/SQL: Creating Screen Forms, ACCELL/SQL: Error Messages ACCELL/SQL Utilities Reference PICT Application execution Syntax PICT file_name Arguments file_name Description The PICT script reads an ASCII file that contains an ACCELL/SQL form and displays the screen form on the terminal screen. The ASCII file can contain escape sequences to paint reverse video, underline, low intensity, or a combination of video characteristics. If the terminal also supports a graphics character set, then simple line figures can also be displayed. Specifies the name of the ASCII file that contains the screen form to be displayed. The PICT utility is also used to display the ACCELL/SQL logo. Running PICT From the Command Line To run PICT from the command line, type the PICT utility name, followed by the name of the file that contains the form. Required Configuration Variables Before you can run PICT, these configuration variables must be set: ATERMCAP Set to the directory path and file name of the ACCELL/SQL termcap file. UNICAP Set to the directory path and file name of the ACCELL/SQL unicap file. UNIFY Set to the path of the ACCELL/SQL release lib directory. You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are shown in the following table. ACCELL/SQL Utilities Reference 195 PICT Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 196 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference PICT See Also PAINTHLP utility description on page 191, ATERMCAP configuration variable description on page 31, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNICAP configuration variable description on page 83, UNIFY configuration variable description on page 84 ACCELL/SQL Utilities Reference 197 prlcinf Diagnostic utility Warning This utility, which is located in the release diag directory, is for diagnostic use by Unify Customer Support only. Use this diagnostic utility only when instructed to do so by Unify Customer Support and only under their direction. 198 ACCELL/SQL Utilities Reference q2a2q Form and file conversion Syntax q2a2q [-S db_object] [-U user_name] [-P password] Arguments –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the forms to be converted: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. –P password ACCELL/SQL Utilities Reference (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. 199 q2a2q Description The q2a2q utility first calls Q2ASC to convert all ACCELL/SQL form files to ASCII form file format. Then q2a2q calls ASC2Q to convert the ASCII form files back to ACCELL/SQL form file format. Required Configuration Variables Before you can run q2a2q, these configuration variables must be set: Set to the path of the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are shown in the following table: Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS table continued on next page 200 ACCELL/SQL Utilities Reference q2a2q Configuration Variables Used to Identify the Database (continued) RDBMS SYBASE SQL Server Unify DataServer Variable Description SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db Running q2a2q From the Command Line To run this utility from the command line, make sure that the current directory is the directory where the application’s ACCELL/SQL form files (.aq and .fq files) are stored. Then type the utility name followed by any command line options that you want to use. You can use the q2a2q utility when the table or column definitions have changed in the database design or when the runtime IDs have changed and you do not use ID mapping. For example, if a column is assigned a new data type or a new field size, you must use q2a2q to convert the application forms. See Also ASC2Q utility description on page 143, Q2ASC utility description on page 202, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84 ACCELL/SQL Utilities Reference 201 Q2ASC Form and file conversion Syntax For a master application form: Q2ASC -a[i] MAF_name [> ascii_file_name] For a standard form: Q2ASC [-i] standard_form_name [> ascii_file_name] Arguments –a Before MAF_name, indicates that the form to be converted is the master application form. The –a option must be used when you convert the master application form. –ai Before MAF_name, indicates that the form to be converted is the master application form, and the form name does not include the default file suffix, .aq. (When the –a and –i options are both used, they must be combined as –ai.) –i Before standard_form_name, indicates that the specified form name does not include the default file suffix: .fq for a standard form or .aq for the master application form. MAF _name Specifies the name of a ACCELL/SQL master application form file to be converted to ASCII format. If MAF _name is not preceded by the –i option, Q2ASC assumes that the master application form file is named MAF_name.aq. standard_form_name Specifies the name of a ACCELL/SQL standard form file to be converted to ASCII format. If standard_form_name is not preceded by the –i option, Q2ASC assumes that the form file is named standard_form_name.fq. ascii_file_name Specifies the name of the file that will contain the ASCII version of the form file. If this argument is omitted, Q2ASC sends its output to the terminal screen. If the form file is for a master application form, the ASCII file name has a .az file name suffix; if the form file is for a standard form, the ASCII file name has a .fz file name suffix. 202 ACCELL/SQL Utilities Reference Q2ASC Description The Q2ASC utility converts an ACCELL/SQL form file to an ASCII form file. You use Q2ASC when you move a screen form archive from one machine to another and when you upgrade to a newer release of ACCELL/SQL . You can also use Q2ASC to convert form files to an ASCII format that is suitable for source code control. Required Configuration Variables Before you can run Q2ASC, these configuration variables must be set: Set to the path of the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files: Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS table continued on next page ACCELL/SQL Utilities Reference 203 Q2ASC Configuration Variables Used to Identify the Database (continued) RDBMS INGRES SYBASE SQL Server Unify DataServer Variable Description DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db Running Q2ASC To convert a form, type the Q2ASC utility name followed by the name of the form that you want to convert. Q2ASC assumes that the specified form file name has the default file name suffix (.fq for a standard form or .aq for the master application form), unless you use the –i or –ai option when you specify the form name. To ensure that form changes and database changes match, follow these steps when you modify the database: 1. Run the Q2ASC utility before you modify the database. 2. Modify the database. 3. Run the ASC2Q utility. 204 ACCELL/SQL Utilities Reference Q2ASC Converting From Release to Release If you convert an application from one release of ACCELL/SQL to another release, make sure that you use the source release versions of Q2ASC and H2ASC to convert the forms and help archives to ASCII format. Use the destination release versions of ASC2Q and H2ASC to convert the ASCII format files back to forms and help archives. For example, if you convert an application from ORACLE to SYBASE SQL Server, use the Q2ASC and H2ASC that came with your ACCELL/SQL for ORACLE release to convert the forms and help archives to ASCII format. After you move the files to the new application directory, use the ASC2Q and ASC2H that came with your release of ACCELL/SQL for SYBASE SQL Server to convert the ASCII files back to forms and help archives. Example This example converts a master application form named accts.aq to an ASCII file named accts.az. Q2ASC –a accts.aq > accts.az See Also ASC2H utility description on page 140, ASC2Q utility description on page 143, H2ASC utility description on page 167, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Converting Release 1 Applications to Release 2 ACCELL/SQL Utilities Reference 205 ridutil System setup INGRES and SYBASE SQL Server only Syntax ridutil [-S current_db] [-U user_name] [-P password] - c i t [[database_name.]owner_name.]target_ table_name Arguments –S db_object Sets the current database to the specified name. For INGRES, the database name can include an optional virtual node name and server type. If the –S option is omitted, the database name specified by the DBNAME configuration variable is used. If DBNAME is not set, then the user’s default database is the current database. The –S option can be used only once on the command line for INGRES and SYBASE SQL Server. –U user_name (INGRES and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. If –U is omitted, the user name specified by the DBUSER configuration variable is used. If DBUSER is not set, the user’s login name is used. 206 –P password Specifies the password of the user who wants to run the utility. If –P is omitted, the password specified by the DBUSER configuration variable is used. This option has no default, and the user is not prompted for the password. –c Indicates that ridutil is to create entries in the _aclrowids_ table. If the _aclrowids_ table does not exist, ridutil creates the table in the current database and prompts the user for the column entries. ACCELL/SQL Utilities Reference ridutil The row ID columns can be of these data types: money int tinyint smallint char varchar datetime The row ID columns cannot be of these data types: float text binary varbinary image bit To use the –c option to create the table or to create entries for tables that you do not own, you must be the database owner or system administrator. Either set the DBUSER configuration variable to dbo or sa, or use the –U user_name and –P password options to indicate that you are the database owner. You can create entries for tables that you own; you do not need to be the database owner or system administrator. –i Indicates that ridutil is to write to stdout the names of the columns that will be used to identify the rows in the specified table. You can redirect the output to a file so that you can refer to the row ID information later. Use the file redirection symbol: > ASCII_ file_name. –t (SYBASE SQL Server only) Indicates that ridutil is to write to stdout the text for an insert/update trigger for the specified table. Triggers are required only when the columns that ACCELL/SQL uses to identify the rows are modified by the database during an update or delete. Redirect the output to a file so that you can edit the trigger. Use the file redirection symbol: > ASCII_ file_name. ACCELL/SQL Utilities Reference 207 ridutil database_name Specifies the name of the database that contains the table for which row identification criteria is to be specified. If the database name is specified, the owner name must also be specified. owner_name Specifies the name of the owner of the table for which row identification criteria is to be specified. target_table_name Specifies the name of the table for which row identification criteria is to be specified. Description The ridutil utility performs several row ID management tasks: When run with the –i option, ridutil displays the names of the columns used to identify rows selected from the specified target table. When run with the –c option, ridutil adds entries for the specified target table to the _aclrowids_ table. ridutil creates the _aclrowids_ table if it does not exist. The _aclrowids_ entries specify the columns to be used to identify rows selected from the specified target table. The ridutil utility prompts you for the names of the columns to be used to identify rows in the specified table. If entries already exist, ridutil prompts for whether you want to remove the entries. If you answer yes, ridutil removes the entries. When run with the –t option, ridutil displays the text for an insert/update trigger for the specified target table. Required Configuration Variables Before you can run ridutil, these configuration variables must be set: 208 UNIFY Set to the path of the ACCELL/SQL release lib directory. DBTYPE Set to the type of database with which ACCELL/SQL is being used (INGRES or SYBASE). SYBASE (SYBASE SQL Server only) Set to the name of the directory that contains the SYBASE SQL Server interfaces file. DSQUERY (SYBASE SQL Server only) Set to the name of the database server that contains the database to be used. ACCELL/SQL Utilities Reference ridutil Security If you use the –c option to create the _aclrowids_ table or to add entries for tables that you do not own, you must be the database owner or system administrator. Example These examples show the results when you run ridutil with the –i option. In the first example, ridutil is asked to display the names of the columns that will be used to identify the rows in table T1, which is owned by owner in the mydb database. ridutil –i mydb.owner.T1 Table T1 has a unique clustered index on columns C1 and C2, and the _aclrowids_ table does not contain an entry for T1. Therefore, ridutil displays these results: T1 C1 C2 In the second example, the ridutil utility is run with the –c option to create a new entry for T1: ridutil –c mydb.owner.T1 When prompted for the _aclrowids_ entry, the values entered indicate that ACCELL/SQL is to use columns C1 and C4 to identify the rows in table T1. If ridutil is subsequently run with the –i option, the utility displays these results: T1 C1 C4 In the third example, ridutil is run with the –t option, and output is redirected to a file named table2_trg: ridutil –t mydb.owner.table2 > table2_trg ACCELL/SQL Utilities Reference 209 ridutil ridutil writes the following trigger text to table2_trg: Variables for row ID column values and raiserror message Returns row ID column values CREATE TRIGGER table2_trigger ON owner.table2 FOR INSERT, UPDATE AS DECLARE @var0 char(20) DECLARE @var1 datetime DECLARE @var2 int DECLARE @msg char(255) /* ** The trigger will only print the WHERE values ** if the application which invoked it is ACCELL/SQL ** and values exist in the inserted table. */ IF @@rowcount=0 RETURN IF EXISTS (SELECT * FROM master.dbo.sysprocesses p WHERE p.spid = @@spid AND p.program_name = ’ACCELL/SQL’) BEGIN /* ** Select the columns which form the RowID from the inserted table. */ SELECT @var0 = a_char, @var1 = a_date, @var2 = a_integer FROM inserted SELECT @msg = CONVERT(char(255),@var0) RAISERROR 21000 @msg ridutil writes message number specified by SELECT @msg = CONVERT(char(255),@var1) RAISERROR 21000 @msg SYBTRGMS G into SELECT @msg = CONVERT(char(255),@var2) RAISERROR 21000 @msg END trigger go See Also 210 ACCELL/SQL: RDBMS Integration, DBTYPE configuration variable description on page 46, DSQUERY configuration variable description on page 51, SYBASE configuration variable description on page 73, UNIFY configuration variable description on page 84 ACCELL/SQL Utilities Reference RPT Report generation and execution Syntax RPT [-S db_object] [-U user_name] [-P password] [-Oreport] [-r] report_script [ Arguments –S db_object input_file - ] (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the application files to be used: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a valid virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. ACCELL/SQL Utilities Reference 211 RPT –P password (ORACLE and SYBASE SQL Server only) Specifies the password of the user who wants to run the utility. If –P is omitted, the password is obtained from the system views. –Oreport Indicates that RPT is to also print the Table Usage Information report. (The Table Usage Information report can also be printed alone, without an RPT report; see page 213.) –r Indicates that RPT is to remove the report script file after the report is produced. report_script Specifies the name of the script file that contains the RPT statements used to format the report. input file Specifies the name of the ASCII file that contains the data to be formatted. – Indicates that the input data is passed to RPT through a pipe. The input data can be produced by any program that meets these criteria: The input data is in ASCII format. The input data does not have column headings. Each line of input data matches the format specified in the RPT script input section. If neither input_file nor – is specified, RPT scans the script file and prints the Table Usage Information report. This report lists the number of RPT internal tables used by the script, the maximum number of elements in each table, and any syntax or semantic errors detected. 212 ACCELL/SQL Utilities Reference RPT Description The RPT utility uses the specified report_script file to produce a report. The report_script file contains the RPT statements that define the format of the report. If report_script is the only argument that is specified, RPT compiles the script and produces the Table Usage Information report for the script. Required Configuration Variables Before you can run RPT, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. DBTYPE Set to the type of database with which ACCELL/SQL is being used (INFORMIX, INGRES, ORACLE, SYBASE, or U2000). The Table Usage Information Report The Table Usage Information report displays information about all compilation errors that occurred and about the internal tables used by the RPT script. Internal tables set limits on report elements such as the number of expressions, variables, or input items allowed in the RPT script. To compile a script and print the RPT Table Usage Information report, type the utility name followed by the name of the report script: RPT script_name Tip As an alternative, you can use the irs utility to generate reports. Example The first example uses the statements from an RPT script file named rscript to format the data from an input file named rinput. RPT rscript rinput ACCELL/SQL Utilities Reference 213 RPT The second example pipes the output produced by the SQL script named sscript to RPT. RPT uses the statements in the RPT script file rscript to format the piped results. SQL sscript | RPT rscript – This example produces a Table Usage Information report for a script named rscript. RPT rscript RPT then produces the following Table Usage Information report: RPT – Report Processor Copyright Unify Corporation 1991. No syntax errors were found in the report script. RPT TABLE USAGE INFORMATION Table Name Expression Nodes Variables Constant Commands Print Statements Print Items Sort Items Input Items Command Groups Set Statements If Statements Aggregates Function Calls Arguments See Also 214 Used Maximum n n n n n n n n n n n n n n 400 150 250 256 125 256 15 100 25 100 50 50 50 100 irs utility description on page 170, rpt.ld utility description on page 215, DBTYPE configuration variable description on page 46, UNIFY configuration variable description on page 84, ACCELL/SQL: Creating Reports With RPT Report Writer, Unify DataServer: UNIFY/Net Guide ACCELL/SQL Utilities Reference rpt.ld Application development, Report generation and execution Syntax rpt.ld rpt_executable_name [object_files] archive_name Arguments rpt_executable_name Specifies the name of the RPT executable to be produced. This argument enables you to assign a name other that rpt to the new executable file, so that it does not overwrite the current rpt executable. object_files Specifies the names of the C object files to be loaded with the RPT executable. archive_name Specifies the directory path and file name of the archive file to be used. Description The rpt.ld utility creates a new RPT executable. You must use the rpt.ld utility when you want to add C-hook functions to RPT for your application. After you write C-hook functions to be used with RPT, you must perform these tasks: 1. Edit the func table in ufunc.c to reference to your C-hook functions. (Copy the prototype file that comes with the software release, and edit the copy.) 2. Compile all your source files. 3. Create an archive. The object file ufunc.o must be the first object file in the archive. 4. Change directory to your application bin directory. 5. Run rpt.ld to load your custom version of RPT. ACCELL/SQL Utilities Reference 215 rpt.ld Required Configuration Variables Before you can run rpt.ld, these configuration variables must be set: Set to the ACCELL/SQL release lib directory. UNIFY You must also set the configuration variables that are used by your RDBMS to find your database files: Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 216 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference rpt.ld Example This example loads a C-hook object file named morecalc.o and an archive named rptarchv, to create a new RPT executable named rpt_c. rpt.ld rpt_c morecalc.o rptarchv See Also irs utility description on page 170, RPT utility description on page 211, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Creating Reports With RPT Report Writer, Unify DataServer: UNIFY/Net Guide ACCELL/SQL Utilities Reference 217 SQL Report generation and execution Syntax Arguments RDBMS- specific options for ORACLE and SYBASE SQL Server RDBMS SQL [-S db_object] [-U user_name] [-P password] [SQL_script_name] –S db_object (INFORMIX, INGRES, SYBASE SQL Server, and Unify DataServer only) Specifies the name of the database object that owns or contains the database tables to be used: RDBMS db_object Description INFORMIX database Name of a valid database. INGRES database Name of a valid database and, optionally, a virtual node name and server type. SYBASE SQL Server database Name of a valid database. Unify DataServer schema Name of a valid schema. This option can be repeated for each file that has a different schema in the file list. The –S option can be used only once on the command line for INFORMIX, INGRES, and SYBASE SQL Server. The –S option can be used only if you use the SQL_script_name option to specify a script file and run SQL in script mode. The –S option cannot be used in interactive mode. –U user_name (INGRES, ORACLE, and SYBASE SQL Server only) Specifies the name of the user who wants to run the utility. For INGRES , this option can be used only by a user who has been given super user permission through the INGRES accessdb utility. For ORACLE and SYBA SE SQL Server, if -U is omitted, the user name is obtained from the system views. 218 ACCELL/SQL Utilities Reference SQL If the –U option is omitted, SQL uses the user name that is specified in DBUSER . If DBUSER is not set, SQL prompts you for the user name. –P password (ORACLE and SYBASE SQL Server only) Indicates that SQL is to use the specified password to log into the database. If this option is omitted, SQL uses the password that is specified in DBUSER . If DBUSER is not set, SQL prompts you for the password. SQL_script_name Indicates that SQL is to start in script mode and use the specified SQL script file. The specified script file can contain only one SQL query. When you include a script file name, SQL sends the output to standard out. You can pipe the output to an input file or directly RPT to process. If you omit the user name, password, and script name options, SQL calls the RDBMS SQL to run interactively and passes the appropriate options. For example, for SYBASE SQL Server, ACCELL/SQL would call isql to run in interactive mode. Description The SQL utility produces a correctly formatted input file for RPT. The input file is formatted with no header or footer, and input file columns are delimited by a separator character, usually a vertical bar (|). To change the separator character, set the SEPARATOR configuration variable as described in the “Configuration Variable Reference.” Required Configuration Variables Before you can run SQL, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. DBTYPE Set to the type of database with which ACCELL/SQL is being used (INFORMIX, INGRES, ORACLE, SYBASE, or U2000). ACCELL/SQL Utilities Reference 219 SQL You must also set the configuration variables that are used by your RDBMS to find your database files. These variables are shown in the following table. Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES ORACLE Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software ORACLE_SID ORACLE system identifier for the unique SGA (system global area) to be used ORACLE_HOME Path of the root directory of the ORACLE RDBMS SYBASE SQL Server Unify DataServer 220 SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db ACCELL/SQL Utilities Reference SQL Example The command shown in the first example pipes the output from an SQL script named empsql to RPT, which uses an RPT format script file named emprpt to generate a report. SQL empsql | RPT emprpt – The second example redirects the SQL output from the empsql script to a file named empinput: SQL empsql > empinput You can then specify empinput as the input file for RPT. RPT emprpt empinput The SQL script must use statements that are recognized by the RDBMS version of SQL. For example, for ORACLE SQL*P lus, the script may contain statements such as this one: select * from table_name where num_field > 30; As another example, for SYBASE SQL Server isql, the script may contain statements such as these: select * from table_name where num_field > 30 go (Make sure that SYBASE SQL Server isql statements are terminated by the go keyword.) See Also RPT utility description on page 211, DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DBTYPE configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Creating Reports With RPT Report Writer ACCELL/SQL: RDBMS Integration ACCELL/SQL Utilities Reference 221 syncauth Menu Handler operation Syntax RDBMS- specific options for INGRES, ORACLE and SYBASE SQL Server RDBMS syncauth [user_name[/password]] Options for INGRES, ORACLE, and SYBASE SQL Server RDBMSs only Arguments user_name (INGRES, ORACLE, and SYBASE SQL Server only) Indicates that syncauth is to use the specified user name to log into the database. If this option is omitted, syncauth uses the user name that is specified in DBUSER . If DBUSER is not set, syncauth prompts you for the user name. password (ORACLE and SYBASE SQL Server only) Indicates that syncauth is to use the specified password to log into the database. If this option is omitted, syncauth uses the password that is specified in DBUSER . If DBUSER is not set, syncauth prompts you for the password. (Note that to specify the user name and password to syncauth you use the same format as the DBUSER configuration variable, instead of the –U user_name and –P password options used by most ACCELL/SQL utilities.) Description The syncauth utility synchronizes ACCELL/SQL Menu Handler with the database. When database or user names are added to the database or removed from the database, Menu Handler must be synchronized with these database changes, so that the Menu Handler information matches the database. To synchronize Menu Handler and the database, take these steps: 1. Make sure that no one else is using the database. 2. Make sure that you have database administration privileges. 222 ACCELL/SQL Utilities Reference syncauth 3. Run syncauth from the operating system command line. Type the name of the utility: syncauth The syncauth utility updates database or user information when users are added, to bring Menu Handler up to date with the database. The syncauth utility also removes user names that have been deleted from the database and removes registration for all the programs and menus that were owned by the deleted users. Required Configuration Variables Before you can run syncauth, these configuration variables must be set: UNIFY Set to the path of the ACCELL/SQL release lib directory. DBTYPE Set to the type of database with which ACCELL/SQL is being used (INFORMIX, INGRES, ORACLE, SYBASE, or U2000). Configuration Variables Used to Identify the Database RDBMS INFORMIX OnLine INFORMIX SE INGRES Variable Description INFORMIXDIR Path of the directory where the INFORMIX release is installed TBCONFIG Name of the file that contains the configuration variables for an INFORMIX OnLine system, if the file is not named tbconfig. DBPATH Path of the directory that contains the application database file and associated files INFORMIXDIR Path of the directory where the INFORMIX release is installed DBNAME Name of the database II_SYSTEM Path of the parent directory for the INGRES release software table continued on next page ACCELL/SQL Utilities Reference 223 syncauth Configuration Variables Used to Identify the Database (continued) RDBMS SYBASE SQL Server Unify DataServer See Also 224 Variable Description SYBASE Name of the directory that contains the SYBASE SQL Server interfaces file DSQUERY Name of the database server that contains the database to be used DBPATH Path of the directory that contains the application database file and associated files DBNAME Simple file name of the database file, for example, file.db DBNAME configuration variable description on page 44, DBPATH configuration variable description on page 46, DBTYPE configuration variable description on page 46, DSQUERY configuration variable description on page 51, INFORMIXDIR configuration variable description on page 58, ORACLE_HOME configuration variable description on page 66, ORACLE_SID configuration variable description on page 66, TBCONFIG configuration variable description on page 77, UNIFY configuration variable description on page 84, ACCELL/SQL: Developing an Application ACCELL/SQL Utilities Reference ACCELL/SQL Utilities Reference 225