Start Documaker DAL Reference version 11.3 Skywire Software, L.L.C. Phone: (U. S.) 972.377.1110 3000 Internet Boulevard (EMEA) +44 (0) 1372 366 200 Suite 200 FAX: (U. S.) 972.377.1109 Notice Frisco, Texas 75034 (EMEA) +44 (0) 1372 366 201 www.skywiresoftware.com Support: (U. S.) 866.4SKYWIRE (EMEA) +44 (0) 1372 366 222 [email protected] PUBLICATION COPYRIGHT NOTICE Copyright © 2008 Skywire Software, L.L.C. All rights reserved. Printed in the United States of America. This publication contains proprietary information which is the property of Skywire Software or its subsidiaries. This publication may also be protected under the copyright and trade secret laws of other countries. TRADEMARKS Skywire® is a registered trademark of Skywire Software, L.L.C. Docucorp®, its products (Docucreate™, Documaker™, Docupresentment™, Docusave®, Documanage™, Poweroffice®, Docutoolbox™, and Transall™) , and its logo are trademarks or registered trademarks of Skywire Software or its subsidiaries. The Docucorp product modules (Commcommander™, Docuflex®, Documerge®, Docugraph™, Docusolve®, Docuword™, Dynacomp®, DWSD™, DBL™, Freeform®, Grafxcommander™, Imagecreate™, I.R.I.S. ™, MARS/NT™, Powermapping™, Printcommander®, Rulecommander™, Shuttle™, VLAM®, Virtual Library Access Method™, Template Technology™, and X/HP™ are trademarks of Skywire Software or its subsidiaries. Skywire Software (or its subsidiaries) and Mynd Corporation are joint owners of the DAP™ and Document Automation Platform™ product trademarks. Docuflex is based in part on the work of Jean-loup Gailly and Mark Adler. Docuflex is based in part on the work of Sam Leffler and Silicon Graphic, Inc. Copyright © 1988-1997 Sam Leffler. Copyright © 1991-1997 Silicon Graphics, Inc. Docuflex is based in part on the work of the Independent JPEG Group. The Graphic Interchange Format© is the Copyright property of CompuServe Incorporated. GIFSM is a Service Mark property of CompuServe Incorporated. Docuflex is based in part on the work of Graphics Server Technologies, L.P. Copyright © 1988-2002 Graphics Server Technologies, L.P. All other trademarks, registered trademarks, and service marks mentioned within this publication or its associated software are property of their respective owners. SOFTWARE COPYRIGHT NOTICE AND COPY LIMITATIONS Your license agreement with Skywire Software or its subsidiaries, authorizes the number of copies that can be made, if any, and the computer systems on which the software may be used. Any duplication or use of any Skywire Software (or its subsidiaries) software in whole or in part, other than as authorized in the license agreement, must be authorized in writing by an officer of Skywire Software or its subsidiaries. PUBLICATION COPY LIMITATIONS Licensed users of the Skywire Software (or its subsidiaries) software described in this publication are authorized to make additional hard copies of this publication, for internal use only, as long as the total number of copies does not exceed the total number of seats or licenses of the software purchased, and the licensee or customer complies with the terms and conditions of the License Agreement in effect for the software. Otherwise, no part of this publication may be copied, distributed, transmitted, transcribed, stored in a retrieval system, or translated into any human or computer language, in any form or by any means, electronic, mechanical, manual, or otherwise, without permission in writing by an officer of Skywire Software or its subsidiaries. DISCLAIMER The contents of this publication and the computer software it represents are subject to change without notice. Publication of this manual is not a commitment by Skywire Software or its subsidiaries to provide the features described. Neither Skywire Software nor it subsidiaries assume responsibility or liability for errors that may appear herein. Skywire Software and its subsidiaries reserve the right to revise this publication and to make changes in it from time to time without obligation of Skywire Software or its subsidiaries to notify any person or organization of such revision or changes. The screens and other illustrations in this publication are meant to be representative, not exact duplicates, of those that appear on your monitor or printer. Contents Chapter 1, Using DAL 2 Introduction to DAL 3 Using the Field’s Properties Window 4 Entering Calculations in External Files 4 Formatting the Script 5 Creating a DAL Script Library 7 Executing a DAL Script from a Menu 8 Using INI Options 10 Using Built-In Functions 11 Checking KeyID Entries 14 Grammar and Syntax 14 Assignment Statements 22 Flow Control Statements 26 Using While...Wend Statements 28 BeginSub and EndSub 28 BeginSub 29 EndSub 30 Data Storage Statements 31 Testing DAL Scripts 32 Using the DAL Debugger in Documaker Workstation 33 Runtime Error Messages 35 DAL Script Examples Chapter 2, Function Reference 40 Overview 41 Bit/Binary Functions 42 Database Functions iii 43 ODBC Handler 44 DB2/2 Handler 45 Creating a Database Handler for an Excel Database 47 Associating Tables with Handlers 48 Accessing Database Fields 49 Setting Up Memory Tables 50 Date Functions 51 Date Formats 57 Documaker Server Functions 58 Documaker Workstation Functions 59 Docupresentment Functions 60 Field Functions 61 Field Formats 62 Numeric Formats 63 Locating Fields 66 File and Path Functions 67 Have Functions 68 INI Functions 69 Graphics Functions 70 Mathematical Functions 71 Miscellaneous Functions 72 Name Functions 73 Page Functions 74 Printer and Recipient Functions 75 Section Functions 76 String Functions 78 Time Functions 78 Time Formats 79 Using the Time Zone Functions 80 ICU Time Zones 86 WIP Functions 87 XML Functions 88 Using DAL XML Functions iv 88 XML Path Locator 92 Locating Objects 95 Where DAL Functions are Used 107 @ 109 ? 111 ABS 112 AddAttachVAR 113 AddBlankPages 115 AddComment 116 AddDocusaveComment 117 AddForm 118 AddForm_Propagate 120 AddImage 123 AddImage_Propagate 125 AddOvFlwSym 126 AFELog 127 Always 128 Append 129 AppendText 131 AppendTxm 133 AppendTxmUnique 136 AppIdxRec 137 ApplyInserts 138 Ask 139 AssignWIP 140 Avg 142 BankRound 143 Beep 144 BitAnd 145 BitClear 146 BitNot 147 BitOr 148 BitRotate 150 BitSet 151 BitShift 153 BitTest 154 BitXor v 155 BreakBatch 157 Call 158 Chain 159 CFind 160 ChangeLogo 162 Char 163 CharV 164 CodeInList 165 Complete 166 CompressFlds 168 ConnectFlds 171 CopyForm 172 Count 175 CountRec 176 Cut 177 DashCode 180 Date 181 Date2Date 182 DateAdd 184 DateCnv 186 Day 187 DayName 189 DaysInMonth 190 DaysInYear 191 DBAdd 192 DBClose 193 DBDelete 194 DBFind 196 DBFirstRec 197 DBNextRec 198 DBOpen 199 Creating Variable Length Records from Flat Files 200 DBPrepVars 201 DBUnloadDFD 202 DBUpdate 204 DDTSourceName 205 Dec2Hex vi 206 DeFormat 207 DelBlankPages 208 DelField 210 DelForm 211 DelImage 213 DelLogo 214 DelWIP 215 DestroyList 216 DeviceName 218 DiffDate 219 DiffDays 220 DiffHours 221 DiffMinutes 222 DiffMonths 223 DiffSeconds 224 DiffTime 225 DiffYears 228 DupForm 229 EmbedLogo 230 Exists 231 FieldFormat 232 FieldName 234 FieldPrompt 235 FieldRule 237 FieldType 238 FieldX 239 FieldY 240 FileDrive 241 FileExt 242 FileName 243 FilePath 244 Find 245 Format 246 FormDesc 247 FormName 248 FrenchNumText 249 FullFileName vii 250 GetAttachVAR 251 GetData 253 GetFormAttrib 255 GetINIBool 257 GetINIString 259 GetListElem 260 GetOvFlwSym 261 GetValue 262 GroupName 263 GVM 264 HaveField 266 HaveForm 267 HaveGroup 268 HaveGVM 269 HaveImage 270 HaveLogo 272 HaveRecip 273 Hex2Dec 274 Hour 275 ImageName 276 ImageRect 278 IncOvFlwSym 279 INI 280 InlineLogo 281 Input 282 Insert 283 INT 284 IsPrintObject 285 IsXMLError 286 JCenter 287 JLeft 288 JRight 289 JustField 291 KickToWIP 293 LeapYear 294 Left 295 LEN viii 296 ListInList 298 LoadINIFile 299 LoadLib 300 LoadXMLList 301 Logo 303 Lower 304 MailWIP 305 MajorVersion 306 MAX 308 MIN 310 MinorVersion 311 Minute 312 MLEInput 315 MLETranslate 318 MOD 319 Month 320 MonthName 321 MSG 322 NL 323 NUM 324 Numeric 325 NumText 327 PAD 328 PageImage 329 PageInfo 331 PaginateForm 332 ParseListCount 334 ParseListItem 336 PathCreate 337 PathExist 338 POW 339 Print 340 Print_It 341 PrinterClass 342 PrinterGroup 343 PrinterID 344 PrinterOutputSize ix 345 PutFormAttrib 347 PutINIBool 349 PutINIString 351 RecipBatch 352 RecipCopyCount 353 RecipientName 354 RecipName 355 Refresh 356 RemoveAttachVAR 357 RenameLogo 358 ResetFld 359 ResetOvFlwSym 360 Retain 361 Right 362 RootName 363 Round 364 RouteWIP 365 RPErrorMsg 366 RPLogMsg 367 RPWarningMsg 368 SaveINIFile 369 SaveWIP 370 Second 371 SetDeviceName 373 SetEdit 375 SetFld 377 SetFont 378 SetFormDesc 379 SetGVM 380 SetImagePos 382 SetLink 383 SetLogo 384 SetProtect 385 SetRecip 386 SetRequiredFld 387 SetWIPFld 388 Size x 389 SlipAppend 390 SlipInsert 391 SpanField 393 SrchData 395 STR 396 STRCompare 398 SUB 399 SUM 402 SuppressBanner 403 Table 405 Time 406 Time2Time 407 TimeAdd 408 TimeZone 409 TimeZone2TimeZone 411 TotalPages 412 TotalSheets 413 TriggerFormName 414 TriggerImageName 415 TriggerRecsPerOvFlw 416 Trim 417 Upper 418 UniqueString 419 UserID 420 UserLvl 421 WeekDay 423 WhatForm 424 WhatGroup 425 WhatImage 426 WIPExit 427 WIPFld 428 WIPKey1 429 WIPKey2 430 WIPKeyID 431 XMLAttrName 432 XMLAttrValue 433 XMLFind xi 434 XMLFirst 435 XMLFirstAttrib 436 XMLFirstText 437 XMLGetCurName 438 XMLGetCurText 439 XMLNext 440 XMLNextAttrib 441 XMLNextText 442 XMLNthAttrName 443 XMLNthAttrValue 444 XMLNthText 445 Year 446 YearDay Chapter 3, Keyword Reference 448 Keyword Table 449 And 450 BeginSub 451 Break