User manual MACROMEDIA BREEZE - USING THE BREEZE XML WEB SERVICES

Using the Breeze XML Web Services Trademarks ActiveEdit, ActiveTest, Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware, Authorware Star, Backstage, Blue Sky Software, Blue Sky, Breeze, Bright Tiger, Clustercats, ColdFusion, Contents Tab Composer, Contribute, Design In Motion, Director, Dream Templates, Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, Help To Source, HomeSite, Hotspot Studio, HTML Help Studio, JFusion, JRun, Kawa, Know Your Site, Knowledge Objects, Knowledge Stream, Knowledge Track, LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Action!, Macromedia Central, Macromedia Flash, Macromedia M Logo and Design, Macromedia Spectra, Macromedia xRes Logo and Design, MacroModel, Made with Macromedia, Made with Macromedia Logo and Design, MAGIC Logo and Design, Mediamaker, Movie Critic, Open Sesame!, RoboDemo, RoboEngine JFusion, RoboHelp, RoboHelp Office, RoboInfo, RoboInsight, RoboPDF, 1-Step RoboPDF, RoboFlash, RoboLinker, RoboScreenCapture, ReSize, Roundtrip, Roundtrip HTML, Shockwave, Sitespring, Smart Publishing Wizard, Software Video Camera, SoundEdit, Titlemaker, UltraDev, Web Design 101, what the web can be, WinHelp, WinHelp 2000, WinHelp BugHunter, WinHelp Find+, WinHelp Graphics Locator, WinHelp Hyperviewer, WinHelp Inspector, and Xtra 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. Third-Party Information This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third-party sites. Copyright © 1997-2004 Macromedia, Inc. All rights reserved. This manual may not be copied, photocopied, reproduced, translated, or converted to any electronic or machine-readable form in whole or in part without prior written approval of Macromedia, Inc. Acknowledgments Project Management: Stephanie Gowin Writing: Jody Bleyle Managing Editor: Rosana Francescato Editing: Mary Kraemer Production Management: Patrice O'Neill Media Design and Production: Adam Barnett, John Francis Second Edition: September 2004 Macromedia, Inc. 600 Townsend St. San Francisco, CA 94103 CONTENTS INTRODUCTION: Before You Begin ................................... 9 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Guide to instructional media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Typographical conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 CHAPTER 1: Architecture Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Data flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Calling an action on the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 About parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 About principals, SCOs, and IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 About security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 CHAPTER 2: Working with Filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 21 23 23 24 24 25 About filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About sort filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Special filter scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filter reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Testing code in the browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Where to go from here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHAPTER 3: Common Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 27 28 32 35 Calling your first action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Integrating Breeze with a directory service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Integrating Breeze with a portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generating reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHAPTER 4: Action Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 37 41 41 42 43 46 Alphabetical action listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Action reference entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . accesskey-exec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . accesskey-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . acl-preference-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . action-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 common-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-field-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 custom-fields-delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 group-membership-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 permissions-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 permissions-reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 permissions-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 principal-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 principal-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 principals-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 report-account-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 report-active-meeting-presenters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 report-active-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 report-bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 report-bulk-content-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 report-bulk-content-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 report-bulk-content-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 report-bulk-course-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 report-bulk-course-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 report-bulk-meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 report-bulk-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 report-course-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 report-course-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 report-disk-usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 report-meeting-attendance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 report-meeting-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 report-my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 report-my-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 report-quiz-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 report-quiz-definition-answers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 report-quiz-definition-questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 report-quiz-interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 report-quiz-question-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 report-quiz-question-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 report-quiz-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 report-quiz-question-totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 report-quiz-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 report-quiz-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 report-sco-slides. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 report-sco-views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 4 Contents report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 report-training-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 sco-build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 sco-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 sco-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 sco-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 sco-move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 sco-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 sco-search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 sco-shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 sco-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 sco-upload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 trees-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 user-accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 user-update-pwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 CHAPTER 5: XML Results Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 About returned XML code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Alphabetical list of XML tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 access-key (container) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 access-key (key) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 access-key-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 access-keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 answer-correct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 answer-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 comment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 cookie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 course . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 date-begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 date-closed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 date-created . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 date-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 date-expired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 date-last-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 date-modified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 date-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 date-time-attempted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 domain-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Contents 5 expired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 first-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 hit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 last-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 last-viewed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 last-viewed-date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 my-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 participant-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 physical-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 presentation-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 principal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 principal-custom-field-values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 principal-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 question . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 question-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 quiz-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 quiz-definition-answers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 quiz-definition-questions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 quiz-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 quota. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 report-account-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 report-active-meeting-presenters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 report-active-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 report-bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 report-bulk-content-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 report-bulk-content-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 report-bulk-course-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 report-bulk-course-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 report-bulk-meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 report-bulk-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 report-bulk-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 report-course-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 report-disk-usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 report-meeting-attendance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 report-meeting-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 6 Contents report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 report-quiz-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 report-quiz-interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 report-quiz-question-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 report-quiz-question-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 report-quiz-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 report-quiz-question-totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 report-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 report-quiz-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 report-quiz-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 report-sco-slides. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 report-sco-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 report-training-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 sco. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 sco-author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 sco-data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 sco-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 sco-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 sco-search-info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 scos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 source-sco . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 time-slot-begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 time-slot-end. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 time-taken. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 trees. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 url-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 user (common-info) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 user (user-accounts). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 user-first-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 user-last-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 user-login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 user-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 view-date-time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Contents 7 8 Contents INTRODUCTION Before You Begin The Macromedia Breeze XML web services enable your external system (such as a web application) to interact with a Breeze server. This guide provides information on how to call XML web services (actions) on the Breeze server from your external system and how to interpret the XML results that Breeze returns. This guide also provides reference material explaining what each action does and what the parameters for each action are. Note: To use the Breeze XML web services, you must have a valid access key. For more information, see "About security" on page 17. The web services discussed in this document are subject to change. Please see the updates page (www.macromedia.com/go/breeze_xmlapi_updates) for the latest updates and changes. Audience This book is intended for developers who want to integrate the Breeze XML web services into their external systems, such as web applications. Before you use this book, you should understand the basics of XML and of using HTTP requests to communicate between an application and a server. You must also understand how to write code in a server language such as Macromedia ColdFusion Markup Language (CFML). Guide to instructional media Macromedia Breeze contains a variety of media to help you quickly learn how to use the product. In addition to this book, the following electronic manuals and online help systems are available: · Breeze Installation Guide describes how to install the Breeze modules. This guide is available as a DVD insert for enterprise users, and as a PDF on the DVD. · Using the Macromedia Breeze Manager describes how to use the administration, presentation, and training components of Breeze Live. You can access Using the Breeze Manager from the Breeze Manager Home page, and from the Help link in the Breeze Manager web application. 9 · Breeze Live User Guide for Meeting Presenters includes information about using the Breeze Live web application to host online real-time meetings. The documentation includes procedures that demonstrate the simplicity of adding slides, Flash SWF files, images, live audio, and video to your presentation. You can access Breeze Live User Guide for Meeting Presenters from the Breeze Manager Home page and from the Help menu within a Breeze Live meeting room (when you enter as a presenter) by selecting Meeting > Help. · Breeze Live User Guide for Meeting Participants includes information relevant to users participating in an online real-time meeting. Breeze Live offers meeting participants several options to make their experience truly participatory, including the ability to send messages and questions to presenters and to each other, and the ability to participate through live video and audio. You can access Breeze Live User Guide for Meeting Participants from the Breeze Manager Home page and from the Help menu within a Breeze Live meeting room (when you enter as a participant) by selecting Meeting > Help. · Using the Macromedia Breeze Plug-In for Microsoft PowerPoint describes use of the plug-in that allows users to create Breeze presentations from PowerPoint. You can access Using the Breeze Plug-In for PowerPoint from the Breeze Manager Home page and from the Breeze menu in PowerPoint by selecting Breeze > Help. · Using the Breeze Publish Wizard includes procedures for publishing Breeze presentations created in PowerPoint to your Breeze server. You can access Using the Breeze Publish Wizard from the Breeze Manager Home page and from the Help button on the Publish Wizard. Note: The relevance of these guides to users depends on the modules installed on the Breeze Presentation platform, the type of user (such as meeting content manager, information technology engineer, or course presenter), and the user's Breeze account permissions. Additional resources The following list contains some useful resources that are available on the web: Note: For a list of Breeze resources, see "Guide to instructional media" on page 9. The Web Service Primer at xml.com (http://webservices.xml.com/pub/a/ws/2001/04/04/ webservices/) is a good introduction to web services. "Working with XML and ColdFusion" in the ColdFusion Developer's Handbook (www.macromedia.com/devnet/mx/coldfusion/articles/cf_handbk_ch6.html) provides information about XML basics and creating XML code using CFML. "Leveraging XML with ColdFusion" (www.macromedia.com/devnet/mx/coldfusion/articles/ cf_handbk_ch7.html) discusses web services, Simple Object Access Protocol (SOAP), and how to call web services using CFML. The XSL Transformations (XSLT) specification Numeric representation of dates and time (www.w3.org/TR/xslt) introduces XSLT, which you can use to convert formatted data to other formats. (www.iso.ch/iso/en/prods-services/popstds/ datesandtime.html) provides information about the ISO 8601 standard date and time format. More specifically, the W3C note about dates and times (www.w3.org/TR/NOTE-datetime) provides information about the specific profile of ISO 8601 that Breeze uses. 10 Introduction: Before You Begin Typographical conventions The following typographical conventions are used in this book: · Italic font indicates a value that should be replaced (for example, in a folder path). · Code font indicates code. It also indicates names of actions, names of parameters, names of tags, and names of attributes. · Bold font indicates a verbatim entry. Typographical conventions 11 12 Introduction: Before You Begin CHAPTER 1 Architecture Overview The Macromedia Breeze XML API model exposes interfaces as a set of XML web services. These services let your external system (such as a portal application) communicate with the Breeze server, using HTTP or HTTPS to call actions on the server and to receive results formatted as XML code. You can use the web services to add Breeze management and reporting capabilities to your external system. Note: Breeze doesn't currently support Simple Object Access Protocol (SOAP). This chapter describes the flow of data between the Breeze server and web applications and how you set parameters and security permissions. 13 Data flow The following diagram shows an example of the flow of data in a web application that interacts with the Breeze server: Step 1: Web browser requests page. Step 7: Web server sends finished page to requesting browser. Step 2: Web server finds page and passes it to application server. Step 3: Application server executes code. Step 6: Application server inserts data in page and then passes the page to the web server. Step 4: Application server calls action on Breeze server. Step 5: Breeze server returns XML data to application server. The following example describes what might happen when a user connects to a training portal intranet site that was created with Macromedia ColdFusion MX and that uses Breeze XML web services: 1. A logged-in user uses a web browser to request a page that shows a list of the courses that the user is signed up for. 2. The web server finds the relevant page and passes it to the application server. 3. The application server parses and executes the ColdFusion code contained in the page. 4. As part of executing the code, the application server calls an action on the company's Breeze server, requesting the list of courses. The action call takes the form of an HTTP POST request with appropriate security credentials included in the request. 5. The Breeze server executes the action, returning the resulting XML data to the application server. 6. The application code parses the returned XML and inserts data into the web page as appropriate, and then passes the finished page to the web server. 7. The web server passes the finished page to the browser to be displayed. 14 Chapter 1: Architecture Overview Calling an action on the server To call an action on the Breeze server, pass the relevant parameters to the web services servlet at http://server_name/api/xml. In Breeze 4.0, there are two parameters that are required for all actions: the parameter named action specifies the name of the action, and the parameter named accesskey specifies the account's access key. In Breeze 4.1, you do not need to pass the accesskey parameter. Passing the accesskey parameter in Breeze 4.1 is not harmful, it is ignored. Most actions also have other parameters. For more information about access keys, see "About security" on page 17. For more information about additional parameters for a given action, see the action's documentation in Chapter 4, "Action Reference," on page 37. You can send the parameters to the server in either of the following ways: · Create a query string--a URL that includes query parameters--and send it to the server as an HTTP GET or POST request, with the HTTP content type set to "application/ x-www-form-urlencoded". (In most cases, you don't need to explicitly set the content type when you use this approach.) The URL to use for the query string has the form http://breeze.example.com/api/ xml?action=action_name&accesskey=access_key, with the action's other parameters appended as additional query parameters separated by ampersands (&). · Create an XML object containing the parameter data as param tags contained in a params tag, and then send an HTTP POST request to the server, with the HTTP content type set to "text/xml". For example code demonstrating how to call an action, see Chapter 3, "Common Tasks," on page 27. Note: The example code in this book uses the query parameters approach, both for readability and because of limitations in using CFML to send XML objects containing parameter data. Macromedia recommends using the POST method when possible; because of the way HTTP implements GET and POST, using POST may provide higher security levels than passing parameters in the query string. For more information, see "About security" on page 17. About parameters For most actions, you can specify one or more additional parameters. (The accesskey and action parameters are required. For more information, see "Calling an action on the server" on page 15.) You usually specify parameters as name-value pairs, but the exact process depends on the details of the language you use to call the action on the Breeze server. For sample code in ColdFusion Markup Language (CFML), see Chapter 3, "Common Tasks," on page 27. In the documentation for each action, all listed parameters are required except for those specifically marked as optional. About parameters 15 For some actions, you can provide multiple parameters with the same name. For example, the principals-delete action takes a parameter named principal-id; you can specify multiple principal-id name-value pairs (each with the name principal-id) when you call the action on the Breeze server. The following CFML code example shows how to delete two specified users in a single action call, by specifying two principal-id parameters. (This example relies on variables called baseurl, accesskey, and loginCookie that you set during the login process. For more information, see "Integrating Breeze with a directory service" on page 28.) In some other actions, you can provide multiple sets of parameters. For example, the groupmembership-update action takes parameters named group-id, principal-id, and is-member; to make multiple updates in a single call, specify each of those parameters for principal and group, and then specify them (using the same parameter names again) for another, and so on. About principals, SCOs, and IDs There are two basic kinds of entities in Breeze: principals and Shareable Content Objects (SCOs). A principal is any entity that can have permissions that control how it can interact with SCOs. The following are the most common types of principals: user group A specific user. A group of users. There are other types of principals, known as primary groups: admins, authors, live-admins, and course-admins. For information about primary groups, see Using the Breeze Manager. You can create and modify users and groups, but not primary groups. A SCO is a Breeze document, such as a meeting or a presentation. Folders are also SCOs. Breeze includes the following types of SCOs: tree The root of a folder hierarchy. A tree's root is treated as an independent hierarchy; you can't determine the parent folder of a tree from inside the tree. A folder on the server's hard disk, containing Breeze content. A presentation. A course. A meeting. folder presentation course meeting flv swf image A Flash video file. A Flash SWF file. An image file. 16 Chapter 1: Architecture Overview session A session of a meeting. A session begins when someone enters an empty meeting and ends when all attendees leave the meeting. archive An archived meeting. A file shared using the file-sharing pod within a meeting. attachment pod logos A plug-in for a meeting. An image (such as a corporate logo) that can be attached to content such as presentations. Each principal and SCO has a unique ID number. When you call an action that uses an entity's ID as a parameter, the parameter name indicates what kind of entity the ID belongs to, but the ID remains the same, regardless of the parameter name. Parameter names for IDs include acl-id, folder-id, group-id, parent-acl-id, principal-id, sco-id, and user-id. For example, to update a user's password, call the user-update-pwd action, and give the user's ID as the user-id parameter. To determine a user's name, call the principal-info action, and give the user's ID as the principal-id parameter. There are a few other kinds of IDs, such as account-id, answer-id, permission-id, and question-id. But in most cases, a parameter name that ends in -id indicates that the parameter's value is either a principal's ID or a SCO's ID. About security The security model in Breeze ensures that any code calling a given action is authorized to do so. Almost every action call must include a cookie that represents a specific logged-in user. In Breeze 4.0, almost every action call must also include an access key. In Breeze 4.1, you do not need to pass the accesskey parameter. However, passing the accesskey parameter in Breeze 4.1 is not harmful, it is ignored. In Breeze 4.0, the access key (also called a connection key) is a code that prevents unauthorized use of the server. Every action (including login) requires an access key, which you specify as a parameter named accesskey. Access keys are case-sensitive. To locate your access key, see "Access keys for Macromedia Breeze hosted (ASP) customers" on page 18 and "Access keys for Macromedia Breeze Enterprise (licensed) customers" on page 18. To call most actions, you must be acting as a particular logged-in user, so you must call the login action before you can perform most other actions. (The exceptions, which are the actions you can call without logging in, are Action Reference, action-list, common-info, login, and useraccounts.) When you log in, the Breeze server returns XML results, which indicate a successful login. The HTTP headers of those results include a cookie called BREEZESESSION. When you receive the results of a login call, you must save the value of that cookie for later use. You must include that cookie's value in every subsequent request that you make as that logged-in user. For examples of how to do this, see Chapter 3, "Common Tasks," on page 27. About security 17 To successfully call an action, you must supply both an access key and the cookie for a logged-in user who has the permissions to call that action. If you don't supply both credentials (for example, if you supply the cookie for a user who doesn't have the right permissions), the action fails. Your application can log in multiple users and can call actions for any of those users. For example, when an ordinary user is using your application, you may want to authenticate as that user and call actions using that user's credentials, while also keeping an administrative user logged in to perform tasks that require higher levels of permissions. For information about the possible status codes that the server can return, see the status tag. Access keys for Macromedia Breeze hosted (ASP) customers Note: In Breeze 4.1, you no longer need an access key to call actions. However, passing the accesskey parameter in Breeze 4.1 is not harmful, it is ignored. By default, your account is not enabled for XML web services. You must contact Macromedia technical support to obtain a valid XML access key to use with each action. To contact technical support, go to the Breeze support page (www.macromedia.com/support/ breeze/) and request that an XML access key be generated for your account. Access keys for Macromedia Breeze Enterprise (licensed) customers Note: In Breeze 4.1, you no longer need an access key to call actions. However, passing the accesskey parameter in Breeze 4.1 is not harmful, it is ignored. Your server installation initially has no XML access key. You must add an access key before you can use the XML web services. To add an access key: 1. Locate the custom.ini file, in the breeze subdirectory of the installation directory. 2. Add a parameter at the end of the file by typing the following text on a new line: XML_API_KEY= 3. Immediately after the equal sign (=), on the same line, type an access key of your choice. The key should be 16 characters and should be a combination of numbers and letters. Access keys are case-sensitive. 4. Stop the Breeze server, and then restart it. About permissions Permissions define the ways in which a particular principal can interact with a given SCO. A permission mapping, indicating what permissions a particular principal has for a particular SCO, is called an ACL. An ACL consists of three pieces of information: the ID of a SCO (usually referred to in this context as an ACL ID), the ID of a principal, and a keyword that indicates what the permissions are (usually referred to as a permission ID). There are two kinds of permissions in Breeze: permissions associated with specific SCOs, and permissions that belong to all users who are members of special groups that are called primary groups. Permissions for primary groups take precedence over the permissions set on a SCO. 18 Chapter 1: Architecture Overview To find out what permissions a logged-in user has for a particular item, call the permissions-info action. To change a principal's permissions, call the principal-update action. If a particular principal has no explicitly specified permissions on a particular SCO, that principal's permissions on the SCO's parent apply. You can specify the following permissions on a SCO: view The principal can view the SCO but not modify it. For a course, the view permission lets the principal enroll in the course. For a meeting, view lets the principal attend the meeting. For a folder, view lets the principal view the contents of the folder. publish The principal can publish the SCO to the server and can update the SCO. This permission includes the view permission. It also lets the principal view reports related to the SCO. For a folder, publish doesn't let the principal create new folders within the folder or to set permissions for the folder. You cannot specify this permission on meetings or courses. manage The principal can view, delete, move, and edit the SCO. This permission also lets the principal set permissions for the SCO. For a folder, the manage permission lets the principal view reports for files in the folder and create new folders. You cannot specify this permission on meetings or courses. The principal cannot view, access, or manage the SCO. You cannot specify this permission on meetings or courses. denied presenter (For meetings only) The principal can create or present a meeting. This permission lets the principal create or present the meeting, even if the principal doesn't have view permission on the meeting's parent folder. Because a group is a principal, you can set these permissions on a SCO for a nonprimary group as well as for an individual user; if a group has a particular permission, all members of the group have that permission. Use the group-membership-update action to add a member to a group. Use the permissions-update action to set a group's permissions for a particular SCO. The only way to obtain certain other kinds of permissions is to be a member of a primary group, as follows: The account authors primary group lets its members create or edit a presentation anywhere in the system, regardless of the ACL permissions. The account administrators primary group can manage users and groups. can create and present meetings anywhere The account meeting administrators primary group in the system, regardless of the ACL permissions. The course managers primary group can create and edit courses anywhere in the system, regardless of the ACL permissions. To have full access to the entire system, you must be a member of all four primary groups. About security 19 About public access permissions There is a special principal ID which, instead of being a number, has the value "publicaccess". This ID sets the default access setting for everyone, whether they are logged in or not. You can assign any of the following permissions on a SCO for the public-access principal: denied view Nobody can view, access, or manage the SCO. Anyone can view the SCO, even if not logged in. view-only (For presentations only) Anyone can view the presentation, even if not logged in. However, the permissions set on the presentation's parent folder do not apply to the presentation. For example, even if a user has manage permission on the parent folder, the user can't delete a presentation that has view-only permission. (Normal permissions still apply to the presentation; if the user has manage permission on the presentation, the user can delete it.) view-hidden (For meetings only) Anyone can attend the meeting, even if not logged in. However, the permissions set on the meeting's parent folder do not apply to the meeting. Never assign manage, presenter, or publish permissions to the public-access principal. Never assign view-only or view-hidden permissions to normal principals. About security and launching content When you launch a SCO, you must provide authentication. You can do so using any of the following approaches: · When you open the URL of the content, add a query parameter named session with a value equal to the value of the login cookie, as shown in the following example: http://breeze.example.com/p12345678/?session=breez3238uf298 This approach is a potential security problem because anyone who obtains the specified URL can act as the logged-in user. If you take this approach, use the cookie for an ordinary user rather than the cookie for an administrative user. Also, if a user gives the URL to someone else (for example, by copying it and pasting it into an e-mail message), they are giving access to their account, which presents a security risk. · You can set a BREEZESESSION cookie on the user's browser, using the value of the login cookie. However, this approach works only if your application is running on a server with the same domain name as the Breeze server. Also, if your application server is a J2EE servlet environment (such as ColdFusion or Java), the application server might also use a cookie named BREEZESESSION, which results in potential conflicts between Breeze and the application server. · You can simply open the URL, and require the user to log in again. This approach is more secure than the others but can result in some inconvenience for users. 20 Chapter 1: Architecture Overview