User manual MACROMEDIA COLFUSION MX 7 COLDFUSION MX DEVELOPER S GUIDE

[. . . ] COLDFUSION MX 7 ® ColdFusion MX Developer's Guide Trademarks 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and WebHelp are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. [. . . ] If any field in the submitted form is blank, display a message and set the other form fields to display data that the user submitted. <cfif OR OR OR Trim(Form. fullName) is "" Trim(Form. surname) is "" Trim(Form. email) is "" Trim(Form. phone) is ""> <h2>You must enter a value in every field. </h2> <cfset fullNameValue= Form. fullName> <cfset surnameValue= Form. surname> <cfset emailValue=Form. email> <cfset phoneValue=Form. phone> <cfset uidValue=Form. uid> <cfelse> <cfset attributelist= "objectclass=top, person, organizationalperson, inetOrgPerson; cn=#Trim(Form. fullName)#; sn=#Trim(Form. surname)#; mail=#Trim(Form. email)#; telephonenumber= #Trim(Form. phone)#; ou=Human Resources; uid=#Trim(Form. uid)#"> If the user entered data in all fields, sets the attributelist variable to specify the entry's attributes, including the object class and the organizational unit (in this case, Human Resources). The Trim function removes leading or trailing spaces from the user data. Updating an LDAP directory 531 Code <cfldap action="add" attributes="#attributeList#" dn="uid=#Trim(Form. uid)#, ou=People, o=Airius. com" server=#myServer# username=#myUserName# password=#myPassword#> <cfoutput><h3>Entry for User ID #Form. uid# has been added</h3> </cfoutput> </cfif> </cfif> </cfif> <cfform action="update_ldap. cfm" method="post"> <table> <tr><td>Full Name:</td> <td><cfinput type="Text" name="fullName" value=#fullNameValue# size="20" maxlength="30" tabindex="1"></td> </tr> . <tr><td colspan="2"> <input type="Submit" name="action" value="Add" tabindex="6"></td> </tr> </table> <br> *All fields are required for Add<br> </cfform> Description Adds the new entry to the directory. Outputs the data entry form, formatted as a table. Each cfinput field always has a value, set by the value attribute when the page is called. The value attribute lets ColdFusion update the form contents when the form is redisplayed after the user clicks Add. The code that handles cases in which the user fails to enter all the required data uses this feature. 532 Chapter 23: Managing LDAP Directories Code <cfldap name="GetList" server=#myServer# action="query" attributes="cn, sn, mail, telephonenumber, uid" start="o=Airius. com" scope="subtree" filter="ou=Human Resources" sort="sn, cn" sortControl="asc, nocase"> <table border="1"> <tr> <th>Full Name</th> <th>Surname</th> <th>Mail</th> <th>Phone</th> <th>UID</th> </tr> <cfoutput query="GetList"> <tr> <td>#GetList. cn#</td> <td>#GetList. sn#</td> <td>#GetList. mail#</td> <td>#GetList. telephonenumber#</td> <td>#GetList. uid#</td> </tr> </cfoutput> </table> </body> </html> Description Queries the directory and gets the common name, surname, e-mail address, telephone number, and user ID from the matching entries. Searches the subtree from the entry with the DN of o=Airius. com, and selects all entries in which the organizational unit is Human Resources. Sorts the results by surname and then common name (to sort by last name, then first). Display the query results in a table. Deleting a directory entry To delete a directory entry, you must specify the entry DN. The Retrieve button lets you view a user's information in the form before you delete it. To delete an entry: 1. Open update_ldap. cfm, which you created in "Adding a directory entry" on page 528. Between the first and second </cfif> tags, add the following code: <cfelseif Form. action is "Retrieve"> <cfldap name="GetEntry" server=#myServer# action="query" attributes="cn, sn, mail, telephonenumber, uid" scope="subtree" filter="uid=#Trim(Form. UID)#" start="o=Airius. com"> <cfset fullNameValue = GetEntry. cn[1]> <cfset surnameValue = GetEntry. sn[1]> <cfset emailValue = GetEntry. mail[1]> <cfset phoneValue = GetEntry. telephonenumber[1]> Updating an LDAP directory 533 <cfset uidValue = GetEntry. uid[1]> <cfelseif Form. action is "Delete"> <cfldap action="delete" dn="uid=#Trim(Form. UID)#, ou=People, o=Airius. com" server=#myServer# username=#myUserName# password=#myPassword#> <cfoutput><h3>Entry for User ID #Form. UID# has been deleted </h3></cfoutput> 3. At the end of the code for the Add button (the input tag with Value=Add at the bottom of the form), delete the </td> end tag. 4. After the end of the Add button input tag, add the following code: &nbsp <input type="Submit" name="action" value="Retrieve" tabindex="7"> &nbsp <input type="Submit" name="action" value="Delete" tabindex="8"></td> 5. Save the file and run it in your browser. 534 Chapter 23: Managing LDAP Directories Reviewing the code The following table describes the code: Code <cfelseif Form. action is "Retrieve"> <cfldap name="GetEntry" server=#myServer# action="query" attributes="cn, sn, mail, telephonenumber, uid" scope="subtree" filter="uid=#Trim(Form. UID)#" start="o=Airius. com"> <cfset fullNameValue= GetEntry. cn[1]> <cfset surnameValue=GetEntry. sn[1]> <cfset emailValue=GetEntry. mail[1]> <cfset phoneValue= GetEntry. telephonenumber[1]> <cfset uidValue=GetEntry. uid[1]> <cfelseif Form. action is "Delete"> <cfldap action="delete" dn="uid=#Trim(Form. UID)#, ou=People, o=Airius. com" server=#myServer# username=#myUserName# password="password"> <cfoutput><h3>Entry for User ID #Form. UID# has been deleted</h3></cfoutput> &nbsp <input type="Submit" name="action" value="Retrieve" tabindex="7"> &nbsp <input type="Submit" name="action" value="Delete" tabindex="8"></td> Description If the user clicks Retrieve, queries the directory and gets the information for the specified User ID. Sets the form field's Value attribute to the corresponding query column. This example uses the array index [1] to identify the first row of the GetEntry query object. Because the query always returns only one row, the index can be omitted. The user clicks delete, deletes the entry with the specified User ID and informs the user that the entry was deleted. Displays submit buttons for the Retrieve and Delete actions. Updating a directory entry The cfldap tag lets you change the values of entry attributes. To do so, you specify the entry DN in the dn attribute, and list the attributes to change and their new values in the attributes attribute. The following example builds on the code that adds and deletes an entry. Because the UID is part of the DN, you cannot change it. Updating an LDAP directory 535 To update an entry: 1. Open update_ldap. cfm, which you created in "Adding a directory entry" on page 528. [. . . ] See parameters Arguments scope as array 182 as structure 183 in components 229 user-defined functions and 181 variables 34, 66 arithmetic operators 76 ArrayAppend CFML function 102 ArrayDeleteAt CFML function 103 ArrayInsertAt CFML function 102 ArrayNew CFML function 100 ArrayPrepend CFML function 102 arrays 2-dimensional 98 3-dimensional 99 adding data to 100 adding elements to 100, 102 as variables 52 copying 104 creating 100 description 97 elements 98 elements, adding 102 elements, deleting 103 functions 108 in dynamic expressions 86 index 98 multidimensional 100 passing to functions 179 populating 105 referencing elements in 100 resizing 103 user-defined functions and 179 validating 666 variables 52 ArraySet CFML function 105 ArraySort CFML function 114 ASCII 406 assignment, CFScript statements 128 associative array notation 109 asynchronous mode defined 1070 sending SMS messages using 1079 attachments, e-mail 988 attributecollection reserved attribute 248 attributes for custom tags 246 passed from forms to XML 729 passing values 245, 246 Attributes scope 33, 65 1104 Index authenticating, users 289 authentication application-based example 394 application-based scenario 387 cookies and 380 defined 376 digest 379 HTTP, basic 379 LDAP example 399 logout 385 Microsoft NTLM 379 persistence of 380 persistence of information 386 Session scope and 380 storing login information 380 types 379 user 378 using a database 390 web server 379 web server scenario 386 web server-based example 391 web servers and 378 authorization defined 376 described 376 web servers and 378 AVG SQL function 739 B backreferences about 150 case conversions with 152 in regular expressions 674 in replacement strings 151 omitting from 152 banded reports defined 770 sample 771 base tags 254 Base64 variables 51 basic authentication HTTP 379 web services and 906 basic exception types 311 best practices, Flash forms 707 BETWEEN SQL operator 454 binary data validating 666 binary data type 45 binary files, saving 994 binary variables 51 binding data, in Flash forms 699 SMS gateway 1069 BOM 411 Boolean operators 76 values, validating 665 variables 49 break, CFScript statement 135 browser, ColdFusion component 238 browsers cfform considerations 634 displaying e-mail in 984 requesting component pages with 237 transferring data to a server 881 buddies adding instant messaging 1053 IM GatewayHelper management methods 1059 management example 1056 methods for managing 1052 build components 205 drop-down list boxes 642 queries 467 reports 778 search interfaces 619 slider bar controls 643 tree controls 634 built-in variables client 350 custom tags 250 server 359 session 355 Byte Order Mark (BOM) 411 C C++ CFX tags implementing 269 LD_LIBRARY_PATH 269 registering 270 SHLIB_PATH 269 C++ development environment 269 cacerts file 544 caching applications 299 attributes 300 Flash data 707 flushing pages 300 locations of 299 Index 1105 page areas 300 pages 299 possible issues 300 to variables 300 caching connections 1001 calculated field calculation options 783 defining 782 Report Builder 782 Caller scope 33, 65 calling CFX tags 262 COM objects 947 CORBA objects 961 Java objects 928 nested objects 930, 948 object methods 929, 947 user-defined functions 175 cascading style sheets. See CSS case sensitivity assigning XML document object data 854 referencing XML document object data 852 specifying XML document object 857 case sensitivity, of CFML 39 cellular phone, simulator for SMS 1081 cfabort tag about 38 OnRequestEnd. cfm 280 cfapplet tag description 632 using 655, 656 cfapplication tag 344 defining an application with 275 relation to application definition pages 280 cfargument tag and validation 662 handling invalid data 670 validation considerations 664 cfassociate tag 255 cfbreak tag 37 cfcache tag about 299 possible issues 300 cfcache tag, location of tag 300 cfcalendar tag, masking input of 671 cfcase tag 36 cfcatch tag 323 example 327 using 323 variables 325 cfchart tag about 734 charting queries 736 introduced 733 cfchartdata tag 734, 736 cfchartseries tag 734 cfcollection tag 555 cfcompile utility 250 cfcomponent tag attributes for document-literal web services 905 basic usage 205 web services, publishing 898 cfcontent tag about 412 Excel spreadsheet 1017 using 999, 1014 CFCs See also components calling asynchronuously 1038 cfdefaultcase tag 36 cfdirectory tag about 1012 for file operations 999 queries and 489 cfdocument tag about 764 cfdocument scope 767 unsupported tags 764 with cfhttp 768 cfdocumentitem tag 766 cfdocumentsection tag 766 cfdump tag for COM objects 949 for debugging 435 for multidimensional array 101 with query of queries 495 cfelse tag 36 cfelseif tag 36 cferror page 317 cferror tag 317 CFEvent class 1088 about 1088 constructor 1088 responding to incoming messages 1096 responding to outgoing messages 1098 CFEvent object for SMS gateway messages 1073 CFEvent structure 1031 1106 Index cfexit tag about 38 behavior of 253 OnRequestEnd. cfm and 280 cffile tag 1003 cfflush tag HTML headers and 623 SetLocale and 409 using 306, 623 cffont. properties file 804 cfform controls, described 632 cfform tag and XML skinnable forms 710 usage notes 633 XML generated by, example 726 cfformgroup accordion and tabnavigator attributes 696 in Flash forms 693 repeater attribute 695 cfformgroup tag example 694 extending in XML forms 730 in XML skinnable forms 713 XML structure for 726 cfformitem tag extending in XML forms 730 in Flash forms 690 in XML skinnable forms 713 XML structure for 726 cfftp tag attributes 1002 connection actions 1002 using 999 cffunction tag attributes 175 creating user-defined functions 174 security and 382 web services, publishing 899 cfgrid tag controlling cell contents 648 editing data in 649 handling failed validation 682 returning user edits 648 using 644 validating with JavaScript 680 XML structure for 723 cfhttp tag creating queries 994 Get method 836, 992 Post method 838, 996 queries and 489 use in Report Builder advanced query mode 797 using 992 with cfdocument tag 768 cfhttpparam tag 996 CFID cookie 344 server-side variable 346 cfif tag 36 cfimport tag about 243 calling custom tags 243 cfinclude tag about 162 recommendations for 164 using 163 cfindex tag queries and 489 cfinput tag bind attribute 699 handling failed validation 682 validating with JavaScript 680 XML structure for 722 cfinsert tag creating action pages 478 form considerations 477 inserting data 475 cfinvoke tag example 892 invoking component methods 218 passing parameters with 225 web services, consuming 891, 892 within a component definition 220 cfinvokeargument tag basic usage 226 omit attribute 893 web services invocation 892 cfldap tag about 520 indexing queries 572, 573 output 539 queries and 489, 539 Verity and 539 cflocation tag 351 cflock tag controlling time-outs 365 examples 368 for file access 371 name attribute 365 nesting 366 Index 1107 scope attribute 364 throwOnTimeout attribute 365 time-out attribute 365 using 360, 363 cflog tag 321 cflogin tag structure 383 using 381, 382 cfloginuser tag 381 cflogout tag about 382 and user sessions 386 cfloop tag about 37 emulating in custom tags 253 nested 106 cfmail tag attributes 975 sample uses 977 sending mail as HTML 976 cfmailparam tag 981 cfmailpart tag, multipart e-mail 977 CFML case sensitivity 39 CFScript 40 Code Compatibility Analyzer 442 code validation 442 comments 28 components 32 constants 32 converting data to JavaScript 880 data types 35 debugging 434 description 22 development tools 23 elements 28 expressions 34, 76 extending 259 extensions 23 flow control 35 functions 23, 31 in Report Builder 797 reserved words 39 special characters 39 syntax errors 443 tags 22, 29 variables 33 CFML event gateway 1038 CFML functions ArrayAppend 102 ArrayDeleteAt 103 ArrayInsertAt 102 ArrayNew 100 ArrayPrepend 102 ArraySet 105 ArraySort 114 CreateObject 891 CreateTimeSpan 306, 354, 492 DateFormat 679 DeleteClientVariablesList 351 DollarFormat 679 dynamic evaluation 87 evaluating 88 Expression Builder 799 for arrays 108 for globalization 413 for queries 489 for security 381 for structures 121 formatting data 617 GetAuthUser 382 GetClientVariablesList 350 GetLocale 409 GetLocaleDisplayName 409 HTMLEditFormat 883, 986 IIF 90 IsCustomFunction 198 IsDefined 70, 113, 616, 678 IsStruct 113 IsUserInRole 382 IsWDDX 851 IsXML 851 IsXmlAttribute 851 IsXmlDoc 851 IsXmlElem 851 IsXmlNode 851 IsXmlRoot 851 JavaCast 936 ListQualify 629, 630 ListSort 114 MonthAsString 105 Rand 625 RandRange 625 REFind 153 REFindNoCase 153 Report Builder 799 Report Builder report functions 798 1108 Index SetEncoding 418 SetLocale 409 SetVariable 90 StructClear 116 StructCount 113 StructDelete 116 StructIsEmpty 113 StructKeyArray 114 StructKeyExists 113 StructKeyList 114 StructNew 112 syntax 80 ToString 851 URLEncodedFormat 444 XmlChildPos 851 XmlElemNew 850 XmlFormat 851 XmlGetNodeType 851 XmlNew 850, 856 XMLParse 850 XmlParse 857 XmlSearch 850 XmlTransform 850 XmlValidate 851 See also individual function names CFML syntax, Code Compatibility Analyzer 442 CFML tags, for globalization 413 cfmodule tag, calling custom tags 243 cfNTauthenticate tag 382 cfobject tag instantiating components 218 invoking component methods 221 cfoutput tag data-type conversions 60 populating list boxes 625 using with component objects 928, 947 cfparam tag about 71, 349 and validation 662 handling invalid data 670 testing and setting variables 71 using for validation 683 validation considerations 664 cfpop tag deleting e-mail 989 queries and 489 query results 579 query variables 984 retrieving attachments 988 retrieving headers 985 retrieving messages 987 using 984 using cfindex with 572, 573 cfprocessingdirective tag 411 cfquery tag cachedWithin attribute 306 creating action pages 479, 485 debugging with 434 populating list boxes 625 syntax 466 using 466 using cfindex with 572, 573 using cfquery attributes in the Query Builder 797 CFR file displaying in a browser 791 displaying using cfreport 791 cfreport tag displaying reports 775 saving to a file 791 cfreportparam tag about 778 input parameters 779 using 792 cfrethrow tag nesting 333 syntax 333 using 325, 333 cfsavecontent tag 300 CFScript comments 126 conditional processing 129 creating user-defined functions 172 description 23 differences from JavaScript 127 example 124, 137 exception handling 136 expressions 125 function statement 173 introduction 40 language 125 looping 131 reserved words 127 return statement 174 statements 125 syntax, for user-defined functions 173 user-defined function syntax 173 using 123 var statement 174 variables 125 web services, consuming 893 Index 1109 cfsearch tag about 548 properties 561 cfselect tag handling failed validation 682 populating list boxes 642 XML structure for 722 cfset tag component objects and 928, 947 description 23 tag syntax 29 cfsetting tag, debugging with 435 cfslider tag description 633 handling failed validation 682 validating with JavaScript 680 cfstat utility enabling 425 Windows NT and 425 cfstoredproc tag 303 cfswitch tag 36 cftextarea tag, bind attribute 699 cftextinput tag handling failed validation 682 validating with JavaScript 680 cfthrow tag nesting 333 using 332 cftimer tag 440 CFToken cookie 344 server-side variable 346 cftrace tag attributes 439 using 436 cftree tag description 633 form variables 638 handling failed validation 682 image names 640 in cfform tag 633 URLs in 641 validating with JavaScript 680 XML structure for 725 cftry tag 323 example 327 nesting 333 cfupdate tag creating action pages 483 using 483 cfwddx tag 876 CFX tags calling 168, 262 cfx. jar 262 compiling 269 creating in Java 261 debugging in C++ 270 debugging in Java 266 description 259 developing in C++ 269 Java 260 LD_LIBRARY_PATH 269 locking access to 360, 365, 371 recommendations for 168 registering 270 sample C++ 269 sample Java 260 scopes and 69 SHLIB_PATH 269 testing Java 262 using 167 cfx. jar 262 cfxml tag 850 CGI cfhttp Post method and 836, 992 returning results to 998 scope 33, 65 character classes 149 character encodings about 406 conversion issues 408 defined 405 determining page 411 files 419 forms and 417, 418 processing data from various sources 419, 420 searching and indexing 421 Unicode 407 character sets defined 405 See also character encodings Chart Wizard, Report Builder 800 charting about 736 individual data points 736 Report Builder 800 charts 3D 746 administering 756 area 753 1110 Index background color 744 border 745 caching 756 curve chart considerations 755 data markers 748 dimensions 744 drill-down 758 embedding URLs 758 example 751 file type 744 foreground 744 labels 745, 746 linking from 758 markers 746 multiple series 747 paint 747 referencing JavaScript 758 threads 756 tips 747 check boxes errors 615 lists of values 627 multiple 627 child tags 254 class loading, mechanism 919 classes, debugging 267 classpath configuring 261 Java objects and 919 client cookies 344 Client scope 277 about 34, 66, 340 in event gateway listener CFCs 1033 client state management clustering 346 described 342 client variable storage, specifying 348 client variables built-in 350 caching 351 cflocation tag and 351 characteristics of 277, 340 configuring 346 creating 349 deleting 351 description 343 exporting from Registry 351 listing 350 periods, using 58 setting options for 346 storage method 347 using 349, 356 clustering and persistent variables 342 client state management 346 code locking 360 reusing 161 structuring components 230 Code Compatibility Analyzer, using 442 ColdFusion applications 275 CFScript 123 component browser 238 development tools 23 EJBs and 938 J2EE and 24 JSP and 918 logout 385 searching 547 servlets and 918 support for globalization 405 using for instant messages 1047 using for SMS 1065 variables 44 XML and 843 See also ColdFusion MX ColdFusion components. See components ColdFusion MX about 22 action pages, extension for 613 CFML 22 CORBA type support 964 dynamic evaluation 87 error handling 312 error types 309 functions 23 integrating e-mail with 973 Java objects and 919 scripting environment 22 security 374 standard event gateways 1024 support for LDAP 519 tags 22 Verity Search Server 24 See also ColdFusion ColdFusion MX Administrator creating collections 553 debugging settings 424 event gateway pages 1026 Index 1111 options 24 web services, consuming 896 collections creating 553 creating with cfcollection tag 555 defined 547 indexing 554, 559, 560 populating 554 searching 548 color format, Flash styles 702 column aliases, SQL 457 columns 447 COM arguments 954 calling objects 947 character encodings 420 component ProgID and methods 949 connecting to objects 952 creating objects 951 description 946 displaying object with cfdump 949 error messages 955 getting started 948 requirements 949 setting properties 952 threading 954 using properties and methods 952 viewing objects 950 WDDX and 875 COM objects Application scope, using 958 calling 947 connecting to 952 creating 951 displaying with cfdump 949 improving performance of 955, 958 Java proxies for 955 releasing 953 viewing 950 commas, in search expressions 591 comments CFScript 126 in CFML 28 commits 451 Common Object Request Broker Architecture. See CORBA compiler exceptions about 310 errors 313 compiling, C++ CFX tags 269 complex data types about 45 returning 911 web services and 909 complex variables 52 Component Object Model. [. . . ]