Smart Connection Enterprise - WoodWing Community
Transcription
Smart Connection Enterprise - WoodWing Community
Smart Connection Enterprise Admin Guide Smart Publishing Smart Connection Enterprise Admin Guide version 5.0.1 Smart Connection Enterprise intentionally left blank iii Legal Disclaimer Legal disclaimer © 1998-2007 WoodWing Software bv. All Rights Reserved. WoodWing Smart Connection Enterprise Admin Guide Production Note This manual was created electronically using Adobe InDesign, Adobe InCopy, WoodWing Smart Styles, WoodWing Smart Layout, WoodWing Smart Speller and WoodWing Smart Connection Enterprise. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of WoodWing Software. The information in this book is furnished for informational use only and is subject to change without notice. The software described herein is furnished under a license agreement, and it may be used or copied only in accordance with the terms of the agreement. Smart Layout, Smart Styles, Smart Catalog, Smart Hyphen, Smart Speller and Smart Connection Enterprise are trademarks of WoodWing Software. Adobe, InDesign and InCopy are trademarks of Adobe Systems Incorporated. Apple, Mac, and Macintosh are trademarks of Apple Computer, Inc. registered in the U.S. and other countries. Microsoft, Windows, Windows XP and Windows Vista are trademarks of Microsoft Corporation registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. iv WoodWing WoodWingPublishing family of products Solutions WoodWing Publishing Solutions Smart Connection Pro & Enterprise Since 1997, WoodWing Software engineers have worked with the Adobe InDesign engineering team to create editorial solutions for Adobe InDesign and InCopy. With a combination of publishing experience and a deep knowledge of the Adobe InDesign/InCopy architecture, WoodWing Software offers solutions, productivity tools and plug-ins that make publishing with these programs faster, easier and much more effective. Smart Connection is a powerful workflow solution aimed at publishing environments where Adobe InDesign CS3 and InCopy CS3 drive production. Smart Connection allows designers to work on a layout while editors write content - simultaneously. One can even assign different stories from one page to separate editors. Editors have the ability to see how their copy will rest on the designed page. Smart Connection’s easy-to-use interface is one of its very much appreciated features. The open XML-based architecture allows quick and flexible integration with a variety of platforms and systems. WoodWing products include the acclaimed Smart Connection Pro & Enterprise editorial solutions, Smart Layout, Smart Catalog, Smart Styles, Smart Speller, Smart Hyphen and others. WoodWing is based in Zaandam, The Netherlands, and has offices in Kuala Lumpur and the United States. Customers are served through select partners. Smart Layout Smart Layout optimizes and speeds up the layout process by adding the Article concept to InDesign. An Article consists of several elements, such as the head, intro, body and also images. Smart Layout defines a relationship between these elements. Smart Layout’s intelligent behavior and automatic processes strongly improve the efficiency of InDesign users working with multiple columns of text. This is of particular interest for newspapers and magazines with tight deadlines. WoodWing WoodWingPublishing family of products Solutions Smart Catalog Smart Speller Smart Catalog is a scalable and powerful solution to publish variable data right from inside Adobe InDesign CS3. Smart Catalog links data from a plain text- or XML file, or a database to an InDesign document. Once the corresponding links have been set up, Smart Catalog lets you manage the data in your InDesign document. Smart Speller adds the enhanced spelling functionality of the language institute *TALŌ to Adobe InDesign and Adobe InCopy CS3. Smart Speller offers tremendous improvements to the spelling provided by InDesign and InCopy. In addition to enhanced spelling functionality for languages that are standard available in InDesign and InCopy, Smart Speller also introduces spelling functionality for other languages that are not available in standard InDesign and InCopy. Smart Catalog can be used to efficiently create any publication that links to external data. Examples include price lists, image catalogs, product overviews, travel brochures, exhibition books, etc. Smart Hyphen Updating the publication with the latest information then becomes as easy as one push on a button. Smart Hyphen introduces the intelligent syllable technology of the *TALŌ language modules to Adobe InDesign and Adobe InCopy CS3, adding an almost human understanding of language. Smart Hyphen offers tremendous improvements to the standard hyphenation provided by InDesign and InCopy, and also adds a number of languages to these applications. Languages are continually maintained and updated. Text flow and white space will be improved dramatically. Smart Styles The award-winning Smart Styles automated styling tool delivers powerful formatting capabilities to Adobe InDesign CS3 users. This unique software combines object-, table- and smart text styles into powerful Smart Styles. Smart Styles are conveniently stored in libraries and can be applied with a simple drag and drop to set all of the styling attributes of the object or group of objects. Smart Styles removes repetitive and timeconsuming tasks and ensures consistent formatting. For more information on WoodWing products, visit www.woodwing.com. vi Contents Contents Intro Chapter 01 | Introduction___________________ 2 Server Chapter 06 | Server installation____________ 30 1. Manuals___________________________________ 2 1.1 Section divisions in this manual_ ____________ 2 2. Revisions__________________________________ 3 3. How to obtain support_______________________ 3 1. Upgrading your server______________________ 30 2. Server installation__________________________ 30 Section A. Dbase installation & configuration_ ___ 31 Section A1. MySQL installation________________ 31 Section A2. Oracle 10g configuration___________ 33 Section A3. MSSQL 2005 configuration_ _______ 37 Section B. ionCube installation________________ 38 Section B1. How to install ionCube_ ___________ 38 Section B2. Shipped ionCube versions_________ 39 Section B3. How to upgrade ionCube__________ 40 Section B4. Troubleshooting ionCube__________ 40 Section C. PHP installation & configuration______ 41 Section D. Ensuring the WebServer is started____ 47 Section E. Installing phpMyAdmin______________ 49 Section F. Installing Enterprise server___________ 50 Section G. Upgrading to Enterprise 5.0_________ 56 Section G1. Upgrading custom properties_ _____ 58 Section H. Testing the Enterprise Server________ 59 Section H1. Advanced testing_________________ 60 Section H2. Additional testing options__________ 60 Chapter 02 | Introducing Smart Connection Enterprise________________________________ 6 1. Enterprise new features______________________ 7 2. Available languages_ _______________________ 10 Basics Chapter 03 | The concept_________________ 12 1. The Enterprise concept_____________________ 12 1.1 Flexibility_ ______________________________ 13 1.2 The Enterprise structure_ _________________ 13 1.2.1 In detail_____________________________ 15 Chapter 04 | System architecture_ _________ 20 1. Architecture overview_______________________ 20 2. Scalability_________________________________ 21 3. Integration________________________________ 22 4. Architecture in-depth_______________________ 22 4.1 The clients______________________________ 22 4.2 The application server____________________ 23 4.3 The database layer_______________________ 24 Chapter 07 | Licensing____________________ 64 1. Introduction to licensing_____________________ 65 1.1 Server connection licenses________________ 65 1.2 Web Editor licenses______________________ 65 1.3 InDesign and InCopy licenses______________ 65 2. The License Status page____________________ 66 3. Activating licenses_________________________ 67 Chapter 05 | Deployment strategy__________ 26 1. Where to store the files______________________ 26 2. Machine setup_____________________________ 27 3. Network configuration_ _____________________ 27 vii Contents 3.1 Activating the Enterprise Server license______ 67 3.1.1 Activating a license online______________ 68 3.1.2 Activating a license offline______________ 69 3.2 Activating additional Enterprise licenses_____ 70 3.3 Activating client licenses__________________ 71 3.3.1 Activating a license online______________ 72 3.3.2 Activating a license offline______________ 73 4. Deactivating licenses_ ______________________ 74 5. Removing licenses_________________________ 75 Step 11. Controlling user authorizations_ ______109 Step 12. Final settings______________________111 Section B. Additional maintenance_____________112 B1. Publications_ __________________________112 B1.1 Creating a publication_________________112 B1.2 Copying a publication_________________113 B1.3 Reordering publications_______________114 B1.4 Editing a publication__________________115 B1.5 Deleting a publication_________________115 B2. Issues_ _______________________________116 B2.1 Adding an issue______________________116 B2.2 Reordering issues____________________116 B2.3 Deleting issues_______________________117 B2.4 Editing an issue______________________119 B2.5 Copying an issue_____________________119 B3. Editions_______________________________120 B3.1 Adding an edition_ ___________________120 B3.2 Reordering editions___________________120 B3.3 Deleting editions_ ____________________121 B3.4 Editing an edition_____________________121 B4. Sections_ _____________________________122 B4.1 Adding a section_____________________122 B4.2 Reordering sections_ _________________122 B4.3 Deleting sections_____________________123 B4.4 Editing a section_____________________123 B5. Workflow______________________________124 B5.1 Adding a workflow_ __________________124 B5.2 Editing a workflow status______________125 B5.3 Deleting workflow statuses_ ___________125 B6. Routing rules_ _________________________126 B6.1 Adding routing rules__________________126 Chapter 08 | Publication and workflow setup_ __________________________________ 78 1. Logging in_ _______________________________ 78 2. Chapter setup_____________________________ 79 Section A. Workflow setup_____________________ 80 Step 1. Creating users and groups_____________ 80 1.1 Creating users_ ________________________ 80 1.2 Creating groups________________________ 82 1.2.1 Adding a user to a group_______________ 83 1.2.2 Adding users and groups with LDAP_____ 84 Step 2. Setting up access profiles_ ____________ 86 Step 3. Setting up a publication_______________ 91 3.1 Creating your publications_ ______________ 91 Step 4. Assigning administrators_ _____________ 93 Step 5. Creating an issue_____________________ 94 Step 6. Creating sections_____________________ 97 Step 7. Creating editions_____________________ 98 Step 8. Setting up a workflow_________________ 99 Step 9. Further setting up deadlines___________102 9.1 Defining relative deadlines_______________102 9.2 Reviewing issue deadlines_ _____________105 Step 10. Automatic routing__________________107 viii Contents B6.2 Editing routing rules_ _________________127 B6.3 Deleting routing rules_ ________________127 B7. User authorizations_____________________128 B7.1 Adding user authorizations_____________128 B7.2 Creating a user authorization report_____128 B7.3 Deleting user authorizations____________129 B7.4 Editing user authorization rules_________130 B7.5 Deleting user authorization rules________130 B8. Admin authorizations____________________131 B8.1 Adding admin authorizations___________131 B8.2 Deleting admin authorizations__________132 B9. Access profiles_________________________132 B9.1 Creating access profiles_______________132 B9.2 Reordering access profiles_____________133 B9.3 Deleting access profiles_______________133 B10. Groups_ _____________________________134 B10.1 Creating groups_____________________134 B10.2 Copying groups_____________________134 B10.3 Adding a user to a group_____________135 B10.4 Editing a group_ ____________________135 B10.5 Deleting a group____________________136 B11. Users________________________________136 B11.1 Creating users______________________136 B11.2 Copying users______________________137 B11.3 Editing a user_______________________138 B11.4 Deleting a user______________________138 B11.5 Adding a user to a group_____________138 B12. Meta data____________________________139 B12.1 Filtering the page____________________139 B12.2 Displayed meta data items____________140 B12.3 Creating a custom property___________141 B12.4 Editing a meta data item_ ____________143 B12.5 Deleting a meta data item_ ___________143 B13. Dialog setup__________________________144 B13.1 Creating a dialog or query setup_______144 B13.2 Restricted meta data_ _______________147 B13.3 Editing a dialog setup________________148 B13.4 Deleting a dialog setup_______________148 B14. Named queries________________________149 B14.1 Creating a named query______________149 B14.2 Editing a named query_______________151 B14.3 Deleting a named query______________151 B15. User queries__________________________152 B16. Clean up_____________________________153 B16.1 Remove by date____________________153 B16.2 Remove issue______________________154 B16.3 Trash Can Query/Browse_____________155 B16.4 Empty Trash Can____________________156 B17. Log_ ________________________________156 B17.1 Deleting service logs_________________158 B18. Online users__________________________160 B19. MadeToPrint__________________________160 B19.1 Creating a MadeToPrint rule_ _________161 B19.2 Editing a MadeToPrint rule____________161 B19.3 Deleting a MadeToPrint rule___________162 B20. Licensing_____________________________162 Chapter 09 | Server configuration_________ 164 1. Basic configuration settings_________________165 1.1 Application server settings_ ______________165 1.2 Database settings______________________165 1.3 File server settings______________________166 1.4 Date time settings_ _____________________166 ix Contents 2. Configuring your database usage____________167 2.1 Advanced database settings_____________167 3. Where to store the files_____________________167 3.1 The ATTACHMODULO setting____________168 4. Setting up multiple application servers________168 5. Monitoring system activity and logging_ ______169 5.1 High-level monitoring____________________169 5.2 Low-level debug monitoring______________169 6. Automatic JPG/PDF/EPS creation___________170 7. Storing layouts and articles locally_ __________172 8. Security_ ________________________________173 8.1 Security checkpoints____________________173 8.2 Security related facts____________________173 8.3 Logon expiration________________________174 9. Versioning_ ______________________________174 10. Customizing the web user interface_________176 10.1 Changing the look and feel______________176 10.2 Selecting the language_ ________________177 10.3 Changing the terminology_______________177 10.3.1 Method 1 (one language)_____________177 10.3.2 Method 2 (two or more languages)_ ___179 11. Geometry update and remote module_______179 12. Messages and events_ ___________________180 12.1 User messages________________________181 12.2 Live update___________________________181 12.3 Hot inbox_____________________________182 12.4 Example configuration__________________182 13. Email notifications________________________183 13.1 Basic email configuration_ ______________183 13.2 Enable email notification per publication___184 13.3 Enable email notification per user_________184 14. Reporting_______________________________185 15. Password management___________________186 16. Server-side preview generation_____________186 16.1 File locations and access rights__________190 16.2 Enterprise configuration_________________190 17. Troubleshooting preview generation_________190 18. Modifying business logic__________________191 18.1 Custom event handling_________________192 18.2 Overruling business logic_ ______________192 19. Advanced settings_______________________193 19.1 Configserver.php settings_______________193 19.2 MadeToPrint settings___________________195 19.3 New configuration settings______________196 Chapter 10 | Server internals_ ____________ 200 1. Application server_________________________200 2. Customizing your business logic_____________202 2.1 Open source code______________________202 3. Database________________________________203 4. Numbered storage________________________206 4.1 Structured storage______________________207 5. Backup or removal________________________208 Client Chapter 11 | Client installation____________ 210 1. Requirements_ ___________________________210 2. Installation_______________________________210 2.1 Macintosh installation____________________210 2.2 Windows installation_ ___________________212 3. Authorization and registration_______________213 3.1 Activating the Enterprise plug-ins__________214 3.1.1 Activation via the Internet______________215 Contents 3.1.2 Activation via fax or email_ ____________216 3.2 Transferring an activation_________________219 4. Registering Enterprise_ ____________________219 5. Uninstalling Enterprise_ ____________________220 5.1 Uninstalling from Macintosh_ _____________220 5.2 Uninstalling from Windows_______________221 6. Basic client configuration___________________222 1.2.1 Starting InDesign Server CS3__________237 1.2.2 InDesign Server configuration settings___238 1.2.3 Testing InDesign Server_______________239 2. Activation________________________________240 Chapter 14 | Web Editor configuration_____ 242 1. Configserver.php settings_ _________________242 1.1 Server settings_________________________243 1.2 Server features_________________________244 1.2.1 Features no longer supported__________245 2. The workspace folder______________________246 3. Implemented GUI technology_______________246 4. Article templates__________________________247 5. Save version dialog________________________247 6. Workflow dialogs__________________________247 7. Browsers________________________________248 7.1 Browser compatibility____________________248 7.2 Clearing the browser cache_ _____________248 7.3 Browser tabs___________________________249 Chapter 12 | Client configuration__________ 226 1. Configuration settings______________________226 1.1 Fixed list of application servers____________227 1.2 Dynamic list of application servers_________227 1.3 Enable automatic view updates___________227 1.4 Automatic check-out on place____________227 1.5 Automatic update Enterprise panel________228 1.6 Ask before updating links_ _______________228 1.7 Use proxy settings______________________228 1.8 Silent save_____________________________228 1.9 Automatic XML mapping_________________228 1.10 Using https connections _ ______________229 1.11 Automatic logon_______________________229 1.12 Logging______________________________229 1.13 Obsolete options______________________230 1.14 Offline documents_ ____________________231 1.15 Smart Connection palette character size_ _231 1.16 UseRecoveryBaseFolder________________231 Extra Chapter 15 | Troubleshooting_____________ 252 1. Initial testing______________________________252 2. Common errors___________________________253 3. Verifying client version information_ __________254 4. Verifying server version information___________254 5. How to obtain support_____________________255 Web Editor Chapter 13 | Web Editor installation_______ 234 Appendix A | Meta data properties_______ A258 Appendix B | Action property list_________ B262 Appendix C | Named query examples_ ___ C268 1. Installation steps__________________________234 1.1 Installing the Web Editor on the server_ ____234 1.2 Installing Web Editor for InDesign Server____235 1. Wildcard search_ _______________________ C269 2. User inbox_____________________________ C270 xi Contents Appendix D | Geometry update examples__ D272 Appendix E | Web Editor server features__ E276 Appendix F | Revisions_ ________________ F280 1. Changes in version 5.0.1__________________F280 2. Changes in version 5.0.0__________________F281 Index_ _________________________________ 283 xii 01 Introduction Intro 01 Introduction 1. Manuals 1.1 Section divisions in this manual Smart Connection Enterprise comes with two manuals: this Installation & Administration Guide which explains how to install, set up and administer Smart Connection Enterprise, and the User Guide which explains how to use Smart Connection in daily usage using InDesign, InCopy and the Web Applications. This manual has been divided into various sections so that information can be easily accessed. Each section is identified with a tab. Intro—Contains information on how to use the manual and provides general information on Smart Connection Enterprise and its concept. (Chapters 1-2) Smart Connection Enterprise is highly customizable and allows integration with any third-party database, content management system, server or other system. Basics—Provides information on system architecture and deployment strategy. (Chapters 3-5) This admin guide describes the standard Smart Connection Enterprise setup using the standard WoodWing server. Server—Explains how to install and configure Smart Connection Enterprise on a server. (Chapters 6-10) Chapter 01 Introduction Client—Explains how to configure Smart Connection Enterprise for use on a client (InDesign or InCopy). (Chapters 11-9) Extra—Provides additional (Chapter 15-Appendix E)) Intro Web Editor—Explains how to install and configure the Smart Connection Enterprise Web Editor. (Chapters 13-14) information. 2. Revisions For an overview of the revisions made in the latest version of this guide, see Appendix F: Revisions. 3. How to obtain support For details on obtaining support for Smart Connection Enterprise, see Chapter 15: Troubleshooting. Intro Chapter 01 Introduction intentionally left blank 02 Introducing Smart Connection Enterprise Intro 02 Introducing Smart Connection Enterprise Welcome to Smart Connection Enterprise, a prominent member of WoodWing’s Smart Publishing Team. For copy-driven stories, Smart Styles can be used to quickly format the complete story in one single action. Smart Connection is a powerful workflow solution aimed at publishing environments where Adobe InDesign CS3 and InCopy CS3 drive production. Smart Connection allows designers to work on a layout while editors write content - simultaneously. One can even assign different stories from one page to separate editors. Editors have the ability to see how their copy will rest on the designed page. Smart Connection’s easy-to-use interface is one of its very much appreciated features. The open XML-based architecture allows quick and flexible integration with a variety of platforms and systems. Smart Layout can be used to easily create layouts for new articles consisting of multiple unlinked stories. These Smart Layout items can be sent to InCopy as one unit without the need to select all elements one by one. Smart Layout further enables InCopy editors to create articles with multiple components and to adjust an article so it fits the Smart Layout item exactly. Smart Speller adds the enhanced spelling functionality of the language institute*TALŌ to Adobe InDesign and Adobe InCopy CS3. Smart Hyphen introduces the intelligent syllable technology of the *TALŌ language modules to Adobe InDesign and Adobe InCopy CS3. Smart Connection Enterprise in combination with WoodWing’s Smart Styles, Smart Layout, Smart Speller and Smart Hyphen plug-ins form a Smart Publishing Team. For more information, visit www.woodwing.com. Chapter 02 Introducing Enterprise 1. Enterprise new features individual item is still following its own workflow, but the Dossier itself has a workflow of its own. Apart from the ease in the content creation process, the Dossier is also very important when sending content to other systems (Web/Archive). The following features are new to Smart Connection Enterprise version 5.0: For version 5.0 we limit Dossiers to some simple user interface features within InDesign and InCopy. This will be further expanded in future releases. Pagination per edition This feature introduces the possibility for planning tools to vary the page numbering on a per edition basis. Changing the viewed edition in InDesign will update the page numbering accordingly. Equally the generated output PDF or EPS page numbers will vary per edition will vary. Full scripting support Introduction of scripting to InDesign, InCopy and InDesign Server for easy access to the Smart Connection Enterprise functionality. This includes among other things: log in/out, all types of queries, creating, opening and saving articles in InCopy and layouts in InDesign creating, checking in/out and placing of articles and images on a layout Prevent download of placed objects In InDesign, the linked objects are no longer downloaded to the client if they are not needed. This drastically improves the performance when images are stored in the Enterprise system. Relative date/time queries The user query functionality has been extended to include relative queries. The options Within Last and Within Next have been added to date/time criteria with the ability to specify a number of minutes, hours, days, weeks or months. Also fixed options to query Today, Yesterday, Tomorrow, Last Week and Next Dossiers Dossiers are introduced to facilitate the cross-media content production process and allows the grouping of (news) items. For example: articles, images, video clips and audio clips that are related to the same topic can be packed together in a single dossier. Each Intro Access rights on meta data Through the Dialog Setup screen of the WebApps, it is now possible to mark fields in the dialogs as restricted. Restricted fields require that the user has been given the right to change that property. Like other access rights, the right to change restricted properties is controlled through Access Profiles. Chapter 02 Introducing Enterprise Intro Week have been added. articles at the same time. Larger work area—Dynamic panes enable to adjust the work area to your needs. Automatic save—Safety backup in background View versions—Open old versions in readonly mode. Flexible dialogs—Customizable workflow dialogs. Word counts—Characters, word and paragraphs are shown. More basic formatting—Subscript, superscript, bullets and numbering CS3 Text Variables and Smart Catalog fields—Shown iconized to preserve position and data. Preserve advanced formatting—Various advanced InCopy formats are preserved, even when not shown in the editor, such as drop caps and line indentions. Sticky Notes and improved page navigation at preview pane. Locate frames between text and preview—Find current text frame at preview or vice versa. Improved interface—Resizable text area and side pane with preview, versions, word count and messages. Paste HTML from web sites—All text and most formatting is converted into InCopy format, such as fonts, colors, sizes. Admin SOAP interface For integration purposes, Enterprise version 5.0 introduces a SOAP interface that gives integrators the opportunity to act on the administration part of the Enterprise Server. The unlocked functionality includes: Listing, creation, retrieval and modification of publications issues sections editions Listing, retrieval and creation of users groups A full description can be SmartConnectionAdmin.wsdl. found in the Web Editor useability enhancements The Web Editor that is part of Smart Connection Enterprise version 5.0 has been entirely redesigned from the ground up and offers a robust architecture with the far future in mind. It contains the following new features: Multiple tabs—Each article displays in its own tab, thereby facilitating working on multiple Chapter 02 Introducing Enterprise more information and examples, see the Enterprise User Guide. Server-side licensing & concurrent licensing In Enterprise 5.0 the server installation needs to be activated before it can be used. After activation the number of concurrent connections to the Enterprise system is maximized by the number of purchased seats. The new licensing system also adds support for subscription licensing. Part of the same system is the ability to install client licenses of InDesign/InCopy and the Web Editor as concurrent licenses. The Enterprise system will limit the number of clients that can work at the same time on a system, but the software itself can be installed on more workstations then the limit allows, thus using seats more efficiently. Planning SOAP interface A number of new features have been added to the planning interface: A displacement of the content with respect to the outside frame can be specified for adverts. This allows adverts with a large bleed to be positioned correctly on the page A layer name can be specified for an advert. The InDesign client will move the advert to the specified layer and create the layer if needed. Planners can now make changes to layouts that are open in InDesign for editing. For new and existing pages a master page can be specified which should be used as its basis Current Issue concept With this feature the users no longer have to think in which issue they need to store their objects and create queries that have to be updated each time after starting work on a new issue. The current issue can be set on a per publication basis in the publication setup. Users simply store their work in the issue labeled Current. As a result, the issue drop-down in the workflow dialogs will contain an additional Current and a derived Next issue entry. Both entries will show the value of the named issue in parentheses. The issue list box in user query setup dialog will have three new entries: Previous, Current and Next which are all bound to or derived from the set current issue. For InCopy cross-media enhancement It’s now possible to create hyperlinks in the text in InCopy (and InDesign) such that the URL can be used in a web CMS to create a real hyperlink. Intro Many more features: Articles in draft, work off-line, User Messages, Spelling checker, etc. Chapter 02 Introducing Enterprise Intro 2. Available languages Smart Connection Enterprise is available in the following languages: English German French Italian Spanish Dutch Portuguese Polish Russian Chinese (Simplified and Traditional) Taiwanese Japanese Korean 10 03 The concept 03 Basics The concept 1. The Enterprise concept This chapter explains the concept behind the Smart Connection Enterprise system itself, as well as its components and terminologies used. Smart Connection Enterprise (Enterprise) conceptually separates design from content to allow designers and editors to work in tandem. This parallel workflow enables them to work simultaneously on the same publication, section, or on a single page. Enterprise uses a workflow approach common among publishers. It is publication based, meaning that it takes a publication such as a newspaper, magazine, book or newsletter as its foundation. The System Administrator sets up the workflow for the particular project, then allows designers and editors access as needed. For a typical publication the workflow will most likely follow this setup: Publication / Issue / Section. (See figure 1 on the next page.) 12 Chapter 03 The concept SCE WORKFLOW Database Publication Book Client Issue Section Brand Section Chapter Project InDesign User InCopy User Basics Administrator configures and maintains the Database Figure 1. Enterprise provides a flexible workflow for every production environment 1.1 Flexibility 1.2 The Enterprise structure Smart Connection Enterprise is also effective for publishing processes unrelated to magazines, newspapers or other periodicals. As an Administrator, you can change the terminology to suit the workflow needs. The workflow terms could be “Client” instead of “Publication,” and “Brand” instead of “Issue,” and “Project” instead of “Section,” if your workflow is client and project oriented. This adaptability to numerous environments makes Smart Connection Enterprise extremely flexible. A typical Enterprise workflow based on a publication setup consists of a hierarchical structure as shown in figure 1.2 on the next page. As you can see, the first layer within the structure consists of three areas: Users, Groups and Publications. Each created user needs to be assigned to a group in order to have access to a publication. Since the users and groups reside on the same global layer as the publications, they need to be created only once and can be assigned to any created publication. 13 Chapter 03 The concept Smart Connection Enterprise Groups Users Basics Issue Edition Edition Section Section Publications Workflow Workflow Routing Routing User auth. Admin auth. User auth. Figure 1.2 The Smart Connection Enterprise structure A Publication could for instance be a magazine or a newspaper and can consist of the following: Issue Such as today’s issue or tomorrow’s issue. Note that an issue can have its own setup of editions, workflow, routing rules and user authorization rules, thereby overruling the publication setup. Edition Such as a morning edition or evening edition. Section Such as a news or sports section Workflow The workflow that a layout or its components need to follow (such as the first draft and final version of an article). Routing rules An automated workflow where a layout or its components can be routed to a particular group of users once a certain status has been reached. User authorizations Rules that provide users with access to web applications and/or specific functions within the client application. Admin authorizations Rules that provide users with administration access to the publication. 14 Chapter 03 The concept 1.2.1 In detail issue feature in InDesign and InCopy, see the Smart Connection Enterprise User Guide.) The following section describes each area in more detail. Issue For each publication, one or more issues are created, such as today’s newspaper, this year’s catalog or next month’s magazine. Enterprise determines the previous and next issue based on the order of the issues as set on the Publication Maintenance page. With Smart Connection Enterprise 5.0, a new feature is introduced: Current Issue. For each publication, a current issue can be set to be the issue that is going to be published next. In a daily newspaper environment, this would typically be tomorrow’s paper. (This option is set on the Publication Maintenance page, see section 3.1 Creating your Publications in Chapter 8: Publication and Workflow Setup.) When an issue needs a different setup for editions, sections, workflows, routing rules and user authorizations than those set for the main publication, these settings can be overruled and individual settings that apply just for a specific issue can be set. Editions Editions have been introduced since Enterprise 4.2 and allow the creation of different renditions of the same publication, such as localized publications of the same regional newspaper where articles or adverts can be varied whilst keeping the remainder of the newspaper identical. When a current issue is set for a publication (which is optional), users will be able to save to and query on a ‘current issue’ rather than referring to a specific issue by name. This is especially handy when creating a query since the query only needs to be created once and can be used every time, giving different results depending on which issue is current at that time. (For more information on the functionality of the current It is possible to assign either a complete page to one or more renditions, or only certain components of a page. The output will then generate different renditions when needed or combine renditions when possible. 15 Basics Publication At the highest level within the Enterprise structure, a publication can be created that represents the actual newspaper, magazine, catalog etc. Together with the current issue option a ‘previous issue’ and ‘next issue’ is also introduced, allowing users to save to or query on issues that preceded or will follow the current issue, again without having to refer to it by name. Chapter 03 The concept Editioning dramatically reduces production time, assure uniform looking content and lessen the number of source files. section to be routed to a particular group of users once a certain status has been reached. For instance, a rule could be set up for a news article to be routed to the Chief Editor as soon as it reaches the status Final Version. Basics (For more information on the functionality of editions in InDesign and InCopy, see the Smart Connection Enterprise User Guide.) User authorizations Authorizations to the files of your publication as well as access to the web applications are set with a number of authorization rules. Each rule defines the authorizations for a user group which can be set specific per section and/or workflow status. Section A section can be set up for a publication to specify a news or sports section of a newspaper, a chapter of a book or product range in a catalog. Workflow A workflow consists of a file type/status combination. File types are determined by Enterprise and the following file types are currently available: Article Article template Layout Layout template Image Advert By adding a group of users to the User Authorization section of a publication, these users will be granted access to the web applications as well as certain features within the client applications InDesign and InCopy, depending on the settings set in the access profile. Advert template Plan Audio Video Library Dossier Admin authorizations By adding a group of users to the Admin Authorization section of a publication, all users will have access to the Maintenance section of that publication. The administrator manually sets up a group of statuses for each file type, one for each stage of the workflow that it needs to pass. For example: an article workflow could be set up containing a First Draft, Second Draft and Final Version status. Deadlines Deadlines ensure that users know when files (articles, layouts, etc.) need to be finished by. Deadlines are determined by first deciding on a publication date: the final date when the issue is going to be published. Using this date, a Deadline is determined: the date when the issue needs to be Routing rules This optional setting allows for automatically routing files that belong to a certain 16 Chapter 03 The concept ready for output. Other deadlines can then be assigned to editions, sections and statuses and can be entered as either a fixed calendar date or a date relative to other deadlines or the main deadline. Relative dates are preferable since they allow automatic and instant updating of all other related deadlines set throughout the publication. Basics A color coding and reporting system is used throughout various parts of the interface (both on the server side and client side) allowing users to visually track the current deadline status for that part of the publication. Non-working days and holidays can be set up in Enterprise so that they are excluded from the deadline calculation. (For more information, see Chapter 9: Server Configuration.) 17 Basics Chapter 03 The concept intentionally left blank 18 04 System architecture 04 Basics System architecture 1. Architecture overview also act as a client. All of these clients connect to the customizable Application Server via a publishing oriented XML/SOAP interface. The Application Server has all the business logic to determine which actions are allowed, which actions trigger other actions etc. The application server connects via a Database independent module to the underlying SQL database and a file server to store the binary files. See section 4: Architecture in-depth for a more detailed description of each layer. Enterprise uses a three-tier architecture consisting of the Client, Application Server and Database: Client SOAP Application Server During the nineties the three-tier model was used more and more to allow scalable solutions, with a big boost during the internet hype. Often ignored is the de-coupling of the layers and as a result, a lot of threetier systems have a lot of business logic encapsulated into the clients, making customization impossible and limiting flexibility. SQL Database Figure 1. The Enterprise three-tier architecture Users interact with applications at the Client layer which can be either an application like InDesign or a web application via a browser. Other systems can Enterprise has a very clean three-tier model with a lot of independence between the layers. The client layer 20 Chapter 04 System architecture works against the WoodWing Application Server, but if integrated with a CMS it will talk to a completely different server without the WoodWing server involved at all. The same independence is also available between the Application Server and the Database. Client Application Server 2. Scalability The flexible three-tier model allows maximum scalability, making various configurations possible. Database Basics Figure 2b. Application Server and Database separated One possible set-up is to run all layers on one machine, a typical demo setup which we don’t rule out here. For small installations, the Application Server and the Database can run on one machine: You can introduce as many additional application servers as you want or need. Depending on your database choice, you can also distribute your database: Client Client Application Server Database Application Server Figure 2a. Client(s), Application Server and Database running on one machine Database Another typical setup is to have the Application Server and Database separated over two machines. Figure 2c. Multiple Application Servers and Databases 21 Chapter 04 System architecture Basics 3. Integration 4.1 The clients Besides the free choice of which database to use, you are also free to choose the complete back-end system. Because the client applications communicate with the server via an open SOAP interface, any backend can be integrated as long as it provides a thin SOAP layer. System Integrators never had such an easy way of fully integrating InDesign and InCopy whilst publishers can easily integrate InDesign and InCopy with any content management system such as EMC’s Documentum. The clients communicate with the Application server using SOAP (XML messages via HTTP). The SOAP interface is documented in a so-called WSDL which allows you to integrate any client or integrate the Enterprise clients with any server. Several WoodWing partners have created additional applications using this SOAP layer, including planning tools, wire tools etc. Adobe Tools Enterprise client Web browser Smart Connection Pro/Enterprise plug-ins HTML/HTTP WebApps Client layer SOAP services Any back-end system/CMS SOAP PHP SOAP services Figure 3. Integrating Enterprise Business logic For more information about integrating Enterprise, contact WoodWing for the Smart Connection Enterprise SOAP toolkit. Application server To DB interface Figure 4.1 Interaction between clients and application server 4. Architecture in-depth Besides the traditional clients, Enterprise also comes with a number of Web applications (WebApps). The out-of-the-box WebApps can be used to manage the stored database files by browsing and querying for your files and subsequently changing document meta The following sections describe each architecture layer in more detail. 22 Chapter 04 System architecture 4.2 The application server data properties such as status, uploading images or showing management information via convenient pie-charts, column charts and much more. (For more information on the WebApps, see the Smart Connection Enterprise User Guide.) The Application Server consists of the following modules: SOAP These WebApps are PHP pages implementing specific features. The PHP page itself executes on the server where the user can use any web browser as the frontend user interface. As usual with Enterprise, it’s all open, so the user interface of these WebApps can be customized via HTML templates, the functionality can be adapted via PHP or you can have your own WebApps developed. The WebApps also connect via the Application server which means all business logic is in full effect and the WebApps themselves remain very simple. PHP HTML Apache or IIS Web server SOAP HTML Basics C o n f i g PHP SOAP services Business logic Admin Database interface Application server File system We have put a lot of effort into this layer to ensure that it is flexible enough to integrate with any backend system. Also, it has been designed with remote usage in mind. With traditional three-tier systems, the communication is typically very chatty, meaning a lot of messages are send back and forth resulting in poor remote performance. The Enterprise SOAP protocol has been designed from the ground up to be as least chatty as possible, thereby ensuring maximum performance and scalability. File store SQL SQL DB Database layer Figure 4.2 The application server The SOAP services are used for clients to connect via HTTP. The PHP interface goes directly into the business logic layer with the same calls as those used by the SOAP layer. The business layer connects to the Database via the Database Interface offering DB independence. 23 Chapter 04 System architecture The Application Server contains PHP sources and runs with Apache or MS-IIS as web server, using PHP via CGI or ISAPI/NSAPI. file system, the latter being the default setup. When storing the files in the file system, it is important to realize that the client layer does not access the file server directly; this is all done via the application server which guards over the files. So from the client side there is no need to mount a file server: the network communication is all plain internet protocol. Basics The configuration module contains all typical settings used to configure the application server. If needed, the business logic layer can be further customized via PHP. The default data model contains tables for the editorial entities such as publication, issues, section and objects but also holds relations between objects for tracking which article is placed in which page, which article is planned, which pages are part of which InDesign layouts, which versions are available etc. Furthermore it also contains tables for Enterprise’s publishing oriented security model. Lastly some tables are available for globally defined queries and user specific settings to allow roaming users. Depending on the setup, the business logic will store all files as blobs inside the SQL database or it will store all meta data and relations in the database and the files themselves into a file system. In the latter case, which is the default setup, the file system is conceptually part of the database layer. 4.3 The database layer As indicated earlier, the database can be any common SQL database. Supported databases vary per reseller and integrator. The data model can be easily customized to allow custom meta data fields on top of the very rich meta data offered out of the box. If needed, the data model can also be integrated with existing databases. Enterprise even allows the use of non-SQL databases which would just require a PHP script to connect to the non-SQL database. As was mentioned in the previous section, the actual files can be either stored inside the database or in the 24 05 Deployment strategy 05 Basics Deployment strategy 1. Where to store the files Before actually starting your installation, you need to consider the deployment strategy. As explained in the previous chapter, Smart Connection Enterprise can be installed in various configurations. This chapter will provide some basic guidance. Consult your local reseller or integrator for advice based on your particular situation. Enterprise supports three models to store the actual files: As plain files in the file system As compressed files in the file system As a blob inside the database In all cases, the database contains all meta data and the client layer will never access the files directly, this is always done via the application server. When using MySQL, we strongly advice to store the files outside the database. For other databases we advice to store them outside the database as well, except if there are compelling arguments not to. 26 Chapter 05 Deployment strategy 2. Machine setup For larger systems (150 users and up) we advise using a dedicated server for the File Store, a dedicated database server and one or more application servers. As explained in the previous chapter, there are various options for allocating the Enterprise components to machines. The components to allocate are: The Application Server The Database The File Store (also needed when storing the files as blobs in the database) 3. Network configuration It is impossible to provide generic advice on how to allocate these modules to machines as it highly depends on the hardware used, type of publication (file sizes), interaction frequency, number of users etc. Therefore, please keep in mind that the following are just some generic rules of thumb: Although typical clients are connected to a 100 Mbit network, we strongly advise a 1 Gbit (or higher) network between the application server and the server holding the files (data base or file store). A separate network segment is recommended as well. For very small systems up to 50 users, put all components on one machine. This means the least administration overhead. For small to medium sized systems from 50 to 150 users, separate the application server to a separate machine and run the database and File Store on one machine. Depending on the hardware used it could also make sense to separate the file system and run the database and application server on one machine. Depending on the actual system load you could introduce an additional application server. Client 100 Mbit or more Application Server Database Figure 3. Preferred network configuration 27 1 Gbit or more Basics Whichever configuration you choose, it is important to realize that any file transfer happens from database to application server and from application server to client. Whenever the files (either inside a data base or file store) are not stored on the same machines as the application server, each file will be transferred across the network twice. Chapter 05 Deployment strategy Basics When the system will be used by many client applications, we advise to set up separate network segments for both the client and application servers. In other words: use a network segment for a number of users and a dedicated application server for these users. Each application server is then connected to two network segments: the client segment, as well as the high-speed segment to connect to the data base/file store. 28 06 Server installation 06 Server Server installation This chapter will walk you through the necessary steps for completely installing the Enterprise server components. As a starting point it is assumed that the basic server installation (operating system, network and Web Server) has been performed successfully. Section A Database installation & configuration Section A1 MySQL Section A2 Oracle 10g Section A3 MSSQL 2005 Section B PHP installation & configuration Section C ionCube installation Section D Ensuring that WebServer is started Section E Optional: Installing phpMyAdmin to administer MySQL Section F Installing Enterprise server 5.0 Section G Upgrading to Enterprise 5.0 Section H Testing the installation 1. Upgrading your server If you have already installed Enterprise server and want to upgrade to version 5.0, you need to replace the server software and update the database model. (See Section G: Upgrading to Enterprise 5.0 for more details.) The following sections will start with the generic actions for a standard installation using the standard paths on Mac OS, Windows or RedHat Linux. Following that, additional information is given for customized installations. If a single server setup is performed, the basic installation steps should be sufficient to set up the system without modifying any Enterprise configuration file. 2. Server installation At high-level, the installation consists of the following steps: 30 Chapter 06 Server installation Section A. Dbase installation & configuration Section A1. MySQL installation Smart Connection Enterprise 5.0 has been extensively tested and is certified by WoodWing to work with either MySQL v4.1.x and 5.0.x, Oracle 9/10 or MSSQL 2005. Enterprise has been extensively tested and is certified by WoodWing to work with MySQL. Contact your local reseller/integrator or visit www.mysql.com for the latest information on certified versions of MySQL. In general, we advice to always use the latest/newest versions of all supported applications. Installation of each of these database servers is different so each will be documented under its own heading. Note that we will mostly skip the installation of the database server itself and refer to its installation manual to correctly install the database server. Special consideration though will be given on how to configure the different database servers to work with Enterprise. Before installing MySQL v5.0.x, make sure that any other currently installed version of MySQL is not running. (For more information, refer to the MySQL Read Me file.) Using XAMPP or WAMMP. XAMPP or WAMMP (Windows) is a distribution which combines Apache, PHP and MySQL in a single package, thereby making it ideal for quickly setting up a new Enterprise server. XAMPP is available for most operating systems and is readily available at http:// sourceforge.net/projects/xampp. First install XAMPP and then complete the configuration of Smart Connection Enterprise by following the relevant sections in this manual. 31 Server Mac OS Server 10.2 and 10.3 come with MySQL v3.23.x installed which is NOT supported for usage with Enterprise. Chapter 06 Server installation Windows Windows Server Configuration Windows of MySQL 5.0.27 on Strict Mode. Make sure to unselect it. After running the installer, you are given the option to start the configuration wizard (you can also run the configuration wizard at a later time). The following settings are important in relation to Enterprise: Step 5. Default Character Set / Collation The Enterprise database needs the UTF8 character set/collation. Either make this the default for all databases here or be sure to select UTF8 as the character set/collation when creating the Enterprise database. Step 1. Install As Windows Service Select this option to make sure MySQL is started automatically. Normally this option is already selected by default. Step 6. If you install MySQL in a folder other than C:\MYSQL, or if you intend to start MySQL on NT/Win2000 as a service, you must create a file named C:\MY.CNF or \Windows\my.ini with the following information: [mysqld] basedir=E:/installation-path/ datadir=E:/data-path/ Step 2. Include Bin Directory in Windows PATH Your web server must be able to find the mysql executables/libraries. Select this option to make sure the web server can find them. This option is normally not set by default, so it needs to be selected. Step 7. When using MySQL with DB as file the storage, add the following option to the my.cnf file (under the heading [mysqld]): max_allowed_packet=100M Step 3. Modify Security Settings Enter a root password if you have not entered one yet. After your have installed MySQL, the installation directory will contain four files named as follows: my-small.cnf my-medium.cnf Step 4. Disable Strict Mode At this time, Enterprise does not support 32 Chapter 06 Server installation Windows Mac OS / Linux my-large.cnf my-huge.cnf You can use this as a starting point for your own C:\my.cnf file. Also make sure MySQL is automatically started at start-up, either by the RPM used for installation or by moving it to your startup items (MacOS only). Database References For downloading MySQL www.mysql.com. Mac OS / Linux installers, visit Configuration of MySQL 5.0.27 on MacOS/ Linux Section A2. Oracle 10g configuration Preparing the database After installing Oracle 10g you need to set up the Enterprise database. Although creating the tables themselves can be done from the Enterprise web pages, you first need to prepare the database. To do this, start the Oracle Database Configuration Assistant and follow the instructions. Each number given here refers to the step number in the main window. Step 1. Under the heading [mysqld], add: default-character-set=utf8 Step 2. If necessary remove or comment out the following entries (# character): #sql-mode = strict_trans_tables #sql-mode = strict_all_tables Step 1. Select Create a Database. Step 3. When using MySQL with DB as file the storage, add the following option to the my.cnf file (under the heading [mysqld]): max_allowed_packet=100M Step 2. Select General Purpose. Step 3. Give the database a name, for example SCENT5. (Careful: the database name can be no longer than eight characters.) The SID is 33 Server After installing MySQL the my.cnf file needs to be edited: Chapter 06 Server installation Step 11. Database Storage: no changes necessary. automatically calculated. Step 4. Management Options: no changes necessary. Step 12. Finish and wait for the database to be created, this may take a while. Step 5. Enter passwords for the database administrators. The first part of creating the database is now finished. Next, you will need to set up a table space and database users. Server Step 6. Choose the Storage mechanism., such as the default (File System). A. Creating the Table Space Now that the database is prepared, you need to create a table space in which the tables will be created: Step 7. Select the Database File Locations. For example: select Use Common Locations for all Database Files and select a directory where to store the data. Step 1. Log in to the Oracle Enterprise Manager with user name SYS as SYSDBA by selecting Oracle - Database Control in the Programs menu. Step 8. Specify the Flash Recovery Area: no changes necessary. Step 9. Sample Schemes / Custom Scripts: no changes necessary. Step 2. Select the Administration tab and create a new table space, preferably using the same name as the database, in this example ‘SCENT5’. Step 10. Initialization parameters: Memory tab: no changes necessary Sizing tab: no changes necessary Character Sets tab: select Use Unicode (AL32UTF8) and select ‘UTF8 - ...’ as the National Character Set. Connection Mode tab: no changes necessary. Step 3. Enter a filename for the table space. Step 4. Add the table space. 34 Chapter 06 Server installation B. Creating Database Users You can choose between two options when creating database users: create two separate users or one combined user. table space. Option 1: Creating Separate Users Creating two separate users involves creating a Root user (who has limited database access and can not alter tables) and creating a WoodWing user having most rights and for example the ability to alter tables. Normal users of the system would typically use the Root account to log in to the Oracle database. Step 7. Add the role CONNECT (if not already added.) Creating two separate users involves creating a Root User and a WoodWing User. Creating the WoodWing User Step 1. Log in to the appropriate Oracle Enterprise Manager with user name SYS as SYSDBA (if not logged in yet). Step 6. Choose TEMP as temporary table space. Step 8. Add the system privilege (System tab) CREATE SYNONYM. Step 9. Add the user. Step 2. Select the Administration tab and create a new user. Step 3. Enter WoodWing as name. Step 2. Select the Administration tab and create a new user. Step 4. Enter a password (twice). Step 3. Enter Root as name. Step 5. Choose the name of the created table space (in our example SCENT5) as the default table space. Step 4. Enter a password (twice). Step 5. Choose the name of the created table space (in our example SCENT5) as default Step 6. Choose TEMP as temporary table space. 35 Server Creating the Root User Step 1. Log in to the Oracle Enterprise Manager with user name SYS as SYSDBA (if not logged in yet). Server Chapter 06 Server installation Step 7. In the Role tab, add the roles CONNECT, SELECT_CATALOG_ROLE, DBA, CTXAPP. Step 6. Choose TEMP as the temporary table space. Step 8. In the System tab, add the following system privileges: CREATE PROCEDURE CREATE TRIGGER CREATE TYPE EXECUTE ANY PROCEDURE EXECUTE ANY TYPE SELECT ANY DICTIONARY SELECT ANY TABLE UNLIMITED TABLESPACE Step 7. In the Role tab, add the roles CONNECT, SELECT_CATALOG_ROLE, DBA, CTXAPP. Step 8. In the System tab, add the following system privileges: CREATE PROCEDURE CREATE TRIGGER CREATE TYPE EXECUTE ANY PROCEDURE EXECUTE ANY TYPE SELECT ANY DICTIONARY SELECT ANY TABLE UNLIMITED TABLESPACE Step 9. Add the user. Creating a Combined User Step 1. Log in to the Oracle Enterprise Manager with user name SYS as SYSDBA (if not logged in yet) Step 9. Add the user. Step 2. Create a new user. Step 3. Enter root as name. Step 4. Enter a password (twice). Step 5. Choose the name of the created table space (in our example ‘SCENT5’) as default table space. 36 Chapter 06 Server installation Section A3. MSSQL 2005 configuration Step 3c. Select the Options entry. Step 1. Start Microsoft SQL Server Management Studio. Step 3d. For collation, Latin1_General_CI_AI option. Step 2. In the Object Explorer (see the panel at left side of the screen), do the following: IMPORTANT: You must choose the Latin1_General_CI_AI option, regardless of your language, country or region. Other options are NOT supported by Enterprise. Step 2a. Unfold the machine name entry (root node of the tree). Make sure that the machine name matches the DBSERVER option in configserver.php. choose the Step 3e. Press the OK button. In the Management Studio, the Tables entry beneath SCEnterprise shows all tables created by the dbadmin tool. Step 2c. Select New DataBase from the context menu. If you want to have multiple databases and you already have a SCEnterprise database installed, do NOT rename the SCEnterprise database in order to create another one with the name SCEnterprise. Creating another SCEnterprise database results in errors in the Management Studio. Instead, create a new database with a different name, for example SCEnterpriseDemo, and rename the DBSELECT option in the configserver.php file as well. This enables you to easily switch between installed databases. Step 3. The New Database dialog appears. Ensure of the following: Step 3a. Make sure that the General entry is selected. Step 3b. Enter SCEnterprise as the database name (this can be any name, as long as it matches the DBSELECT option in configserver.php.) 37 Server Step 2b. Unfold the Databases entry and right mouse click in order to show the context menu. Chapter 06 Server installation Section B. ionCube installation Server For security reasons, Smart Connection Enterprise Server uses ionCube to encrypt some of its PHP modules. ionCube is a third-party product that is shipped within the server software package. The ionCube product consists of modules that are precompiled and so they are dependant on the operating system, the platform and the PHP version used. Those modules can be found in the /SCEnterprise/server/ioncube folder. The module that matches the platform, processor and PHP version needs to be loaded by the web service on startup. Section B1. How to install ionCube The following table lists the supported platforms by ionCube. Some platforms are supported out-of-thebox, some need manual installation steps and some are not supported (see the overview below the table for an explanation on the indicators displayed in the SCE column): OS / Platform file sub folder Windows (x86) win - Linux (x86) lin - Linux (x86-64) lin lin_x86-64 SCE [1] [2] 38 OS / Platform file sub folder Linux (ppc) lin lin_ppc DragonFly (x86) dra - FreeBSD 4 (x86) fre - FreeBSD 6 (x86) fre fre_6_x86 [2] FreeBSD 6 (AMD64) fre fre_ AMD64 [2] BSDi (x86) bsd - NetBSD (x86) net - NetBSD (x86-64) net net_x8664 OpenBSD 3.7 (x86-64) ope ope_3.7_ x86-64 OpenBSD 3.9 (x86-64) ope ope_3.9_ x86-64 [2] OpenBSD 3.8 (x86) ope - [3] OS X (ppc) dar dar_ppc [2] OS X (i386) dar - Solaris (sparc) sun - Solaris (x86) sun sun_x86 [2] Other - - [4] SCE [3] Chapter 06 Server installation Explanation The following table explains the indicators used in the Smart Connection Enterprise column of the previous table: [3] Explanation ionCube works out-of-the box. The module is located in the /server/ioncube folder and is loaded automatically by the web service. If your platform/processor is not listed, it might be available at: For Windows installations, the ionCube module needs to be configured in the php.ini file: [1] http://www.ioncube.com/loaders.php [4] zend_extension_ts = C:\Inetpub\wwwroot\ SCEnterprise\server\ioncube\ ioncube_loader_win_5.2.dll If so, see Section B3: How to upgrade ionCube. A version of IonCube is only available for PHP v5.1. This version is not officially supported by Smart Connection Enterprise which requires PHP v5.2. However, you can use it for demo purposes. The ionCube module in the /server/ioncube folder is present, but is for the wrong processor type. You need to move the module away to a new sub folder and then copy the correct modules from “sub folder” (see column at table above) to the ionCube folder. Then restart web service. Section B2. Shipped ionCube versions For example, assume you have PPC processor for Mac OSX, you need to do the following: 1. Create a directory named /server/ioncube/dar_x86 2. Move ioncube_loader_dar_* to /server/ioncube/dar_x86 3. Copy /server/ioncube/dar_ppc/* to /server/ioncube 4. Restart Apache: sudo apachectl restart The following ionCube modules are shipped with Smart Connection Enterprise Server v5.0.1: OS/Platform Windows (x86) 39 Version 3.1.32 Release Date Jul 4, 2007 Server If not, see the ionCube web site for contact information in case there is no module available for your platform/processor. Restart web service to reflect changes made to the PHP configuration. [2] Shipped since v5.0.1. For v5.0 installations you need to download the ionCube package from: http://www.ioncube.com/ loaders.php. Copy the downloaded modules into the /server/ioncube folder. Restart the web service. Chapter 06 Server installation Server OS/Platform Version Release Date OS/Platform Solaris (x86) Linux (x86) 3.1.32 Jul 4, 2007 Linux (x86-64) 3.1.32 Jul 4, 2007 Linux (ppc) 3.1.32 Sep 23, 2007 DragonFly (x86) 3.1.24 Nov 9, 2006 FreeBSD 4 (x86) 3.1.32 Jul 4, 2007 FreeBSD 6 (x86) 3.1.32 Jul 4, 2007 FreeBSD 6 (AMD64) 3.1.24 Dec 15, 2006 BSDi (x86) 3.1.21 Jun 10, 2006 NetBSD (x86) 3.1.29 Mar 24, 2007 NetBSD (x86-64) 3.1.16 May 3, 2006 OpenBSD 3.7 (x86-64) 3.1.23 Aug 26, 2006 OpenBSD 3.9 (x86-64) 3.1.27 Jan 11, 2007 OpenBSD 3.8 (x86) 3.1.32 Jul 4, 2007 OS X (ppc) 3.1.32 Jul 5, 2007 OS X (i386) 3.1.32 Jul 5, 2007 Solaris (sparc) 3.1.29 Apr 9, 2007 Version 3.1.29 Release Date Mar 6, 2007 Section B3. How to upgrade ionCube The ionCube version shipped with Smart Connection Enterprise Server could be older than the latest version available or even not shipped at all. In those situations, do the following: Download latest version http://www.ioncube.com/loaders.php from: Copy the downloaded modules into the /server/ioncube folder. Restart the web service. Section B4. Troubleshooting ionCube The wwtest page tells you if ionCube is working properly. If not, make sure you have properly followed the steps in this document. If that doesn’t help, visit the ionCube web site: http://www.ioncube.com/loader_installation.php. 40 Chapter 06 Server installation Linux Section C. PHP installation & configuration Enterprise has been extensively tested and is certified by WoodWing to work with PHP v5.2.0 to 5.2.4. Contact your local reseller/integrator for the latest information on certified versions of PHP. For Linux, also install the MySQL extension for PHP. Windows For Mac OS and Linux it is important to use a PHP distribution that includes the GD2, SOCKETS, MBSTRING and EXIF libraries. The Mac OS PHP distribution by Entropy and the XAMPP distribution contains these libraries. Red Hat Enterprise Linux v3.x PHP distribution is also known to include these libraries. The PHP installer for Windows will prompt you to select your IIS version. The following table shows which version is built into which version of Windows: IIS version When MSSQL is used in combination with MS IIS, it is required to use the ISAPI version of PHP. The ISAPI version of PHP can only be installed manually. (See www.visualwin.com/PHP-ISAPI for more information.) 5.0 Windows 2000 5.1 Windows XP 6.0 Windows Server 2003 Make sure the extension_dir is pointing to the folder in which the extensions mentioned above reside. Step 1. Execute the PHP v5.2.0 installer and choose the standard installation. Step 2. Install required PHP extensions 41 Server MSSQL / Oracle Version of Windows Chapter 06 Server installation Windows Step 3. Edit the php.ini file Mac OS Server When one of the following DLLs is missing, copy them from PHP setup’s extensions folder (available on the Enterprise CD in the Manual Installation/Extensions folder) to C:/php/ext: php_gd2.dll php_exif.dll php_sockets.dll php_mbstring.dll When using MS SQL Server, also copy php_mssql.dll. Location (depending on installation): user:local: php5:lib. The php.ini file can be edited by using a text editor such as TextWrangler or BBEdit. Use the menu File > Open Hidden to browse to /usr/local/php5/lib or use Finder to directly open the folder by selecting Go > Go to Folder. Enter /usr/local/php5/lib/. Alternatively, start the Terminal (Applications:Utilities:Terminal) and enter: cd /usr/local/php5/lib sudo pico -w php.ini Type the Root Password and you are ready to edit. Make sure when using MSSQL 2005 that the Client Tools are installed on each of the Enterprise Application Server machine(s), otherwise the connection to the database will fail. This is because PHP5 ships a bad version of the ntwdblib.dll module (2000.2.8.0) which also resides at a bad location (c:\php). This module needs to be removed manually after PHP5 installation. A newer version (2000.80.194.0) is installed at a better location (c:\windows\system32) by the Client Tools installation. After this update, it is required to reboot the machine or restart Internet Services. Note that installing Client Tools will not install the MSSQL server, which is good to know when your Application Servers are running on different machines than your database. a. Ensure that variables_order is set to “EGPCS”: variables_order = "EGPCS" b. Change the following settings to at least the following values: upload_max_filesize = 100M post_max_size = 100M memory_limit = 250M c. Add the correct time zone, for example: 42 Chapter 06 Server installation Windows Mac OS Ensure that the entry extension=php_exif.dll is listed last date.timezone = Europe/Amsterdam For a full list of time zones, see http://nl3.php.net/manual/en/timezones.php. b. Add or install the following modules: PHP folder: ssleay32.dll libeay32.dll Extensions folder: php_openssl.dll d. Reboot. Instead of rebooting, you can also just restart Apache. Windows Edit the php.ini file with Notepad. The file is normally found in the Windows directory (but when using WAMP for example, the php.ini-file can be found in a subdirectory of wamp) d. If Oracle Server is used then also uncomment (remove the ; character) extension=php_oci8.dll a. In the list of Windows Extensions, do the following: Uncomment (remove the ; character) extension=php_exif.dll extension=php_gd2.dll extension=php_mbstring.dll extension=php_openssl.dll extension=php_sockets.dll Add extension=php_soap.dll e. If Mysql is used then also uncomment (remove the ; character) extension=php_mysql.dll f. Change the following settings to at least the values shown below: upload_max_filesize = 100M 43 Server c. If MSSQL Server is used then also uncomment (remove the ; character) extension=php_mssql.dll Set the following settings: mssql.textlimit = 2147483647 mssql.textsize = 2147483647 Chapter 06 Server installation Windows Linux a. Ensure that variables_order is set to “EGPCS”: variables_order = "EGPCS" Server post_max_size = 100M memory_limit = 250M g. Add the following entries: save_path = C:\PHP\sessiondata upload_tmp_dir = C:\PHP\uploadtemp (Ensure that both folders have full Read and Write access enabled for the Internet Guest User.) Add the correct time zone, for example: date.timezone = Europe/Amsterdam For a full list of time zones, see: http://nl3.php.net/manual/en/timezones.php. b. Change the following settings to at least the following values: upload_max_filesize = 100M post_max_size = 100M memory_limit = 250M c. Add the correct time zone, for example: date.timezone = Europe/Amsterdam For a full list of time zones, see http://nl3.php.net/manual/en/timezones.php. h. Ensure that variables_order is set to “EGPCS”: variables_order = "EGPCS" d. Set the following MSSQL settings: mssql.textlimit = 2147483647 mssql.textsize = 2147483647 i. Configure the ionCube module: zend_extension_ts= C:\Inetpub\wwwroot\ SCEnterprise\server\ioncube\ ioncube_loader_win_5.2.dll e. Edit /httpd/conf.d/conf.php Increase LimitRequestBody to 100000000. Remove index.php from the DirectoryIndex. Step 3a. Reboot Instead of rebooting you can also just restart MS IIS or Apache. f. Reboot. Instead of rebooting you can also just restart Apache. 44 Chapter 06 Server installation Apache Additional PHP Information Mac OS accented characters are not displayed correctly by the Enterprise WebApps. This can be fixed by changing/adding AddDefaultCharSet in the Apache config file /httpd/httpd.conf to: AddDefaultCharSet UTF-8 or AddDefaultCharSet off Mac OS 10.4 comes with PHP 4.3.10 which is not supported. The correct PHP installer can be executed without the need to uninstall PHP. To check the version of a PHP installation, open the Terminal and type: PHP version 4: /usr/bin/php -v PHP version 5: /usr/local/php5/bin/php -v Also set the DefaultType to: DefaultType text/html Checking the version is not a complete test since the included PHP libraries are also important. These are tested in the last installation step. Apache Windows The PHP installer modifies the Apache configuration files for PHP. To do this manually, edit /httpd/httpd.conf to enable php support in both the Load Module and Add Module list. To use Apache for Windows instead of MS IIS requires some additional configuration. For more details refer to the PHP/Apache documentation. Some Apache installations overrule the character set of HTML pages. As a result, The PHP installer installs the CGI version of 45 Server The default web page for Enterprise should be index.htm. However, for Apache it can be index.php as well in which case the Enterprise logon page remains empty. To avoid this problem, make sure the index.htm file is listed above the index.php file in the httpd configuration file. Chapter 06 Server installation Windows Windows Server PHP, the ISAPI version can only be installed manually: a. Copy PHP tree to c:/php b. Copy php5ts.dll to windows\system32 c. Add a new webservice extension: Executable: c:\php\sapi\php5isapi.dll All Verbs Script Engine: yes Verify: yes Instead of using the ISAPI version of PHP, it is required to restart the WebServer when a change is made in php.ini. For Windows 2003 Server: Open Internet Information Manager, go to WebService Extensions and add new webservice extension: Extension name: php Set extension to allowed: yes Required file: c:\php\sapi\php5isapi.dll When using Oracle in combination with IIS, your IIS user has to have Write Access for the Oracle home folder. If this is not the case you will not be able to connect to the database. For Windows XP: Open Internet Information Manager (via Control Panel > Administration Tools). Open the Local Computer list, followed by Web Sites > Default Web Site. Right-click on SCEnterprise and select Properties. Click the Create button followed by the Configuration button. Extension name: php Set extension to allowed: yes Required file: c:\php\sapi\php5isapi.dll PHP 5.2 has been linked against a newer version of the OCI.DLL than the one delivered with the Oracle 9 installation. It is necessary to download and install the Oracle InstantClient. This can be done from www.oracle.com/ technology/software/tech/oci/instantclient/ index.html. To install the InstantClient on Windows: a. Unzip the zip to a folder, for instance C:\instantclient b. Copy tnsnames.ora from the admin folder to C:\instantclient c. Set/add the TNS_ADMIN environment d. Go to Websites Properties - Home Directory - Configuration and add: 46 Chapter 06 Server installation Windows Section D. Ensuring the WebServer is started Mac OS variable to C:\instantclient d. Set/add the NLS_LANG environment variable to the appropriate value. This can be looked up in the registry. Step 1. Starting WebServer if needed. MAC OS client: a) Go to System Preferences > Sharing b) Start Personal Web Sharing if needed PHP References www.php.net PHP reference site with installers for Windows. MAC OS Server: a) Start Server Admin b) Under Computers/Services, select Web c) In the toolbar, click Start Service Step 2. Testing the WebServer. Open Safari or another web browser and type http://localhost. If this fails, try http://127.0.0.1. This should bring up the Apache welcome page. (See figure D on the next page.) If not, consult the Apple documentation to make the WebServer work. Windows Step 1. Start WebServer if needed: Control Panel > Admininstration Tools > Services Start World Wide Web Publishing if needed 47 Server www.entropy.ch/software/macosx/php For downloading the certified Entropy PHP build for Mac OS. Chapter 06 Server installation Linux Windows Step 2. Test WebServer Open Internet Explorer or another web browser and type localhost. This should bring up the MS IIS welcome page. If not, consult the Microsoft documentation to make the WebServer work. line at the bottom: /etc/init.d/httpd start Step 2. Test WebServer Open a web browser and type http://localhost. If this fails, try http://127.0.0.1. This should bring up the Apache welcome page. (See figure D.) If not, consult the Linux documentation to make the WebServer work. Server Possible failures: Oracle uses a documentation tool on port 80. The Oracle tool can be stopped or removed. Linux Step 1. Start WebServer if needed To test if Apache is working, type at the command prompt: /etc/init.d/httpd status To start Apache, type at the command prompt: Figure D. The Apache welcome page displays after entering http://localhost in a browser /etc/init.d/httpd start Making sure Apache starts at start-up can be done in several ways, an easy way is to edit the file /etc/rc.local and add the following 48 Chapter 06 Server installation Section E. Installing phpMyAdmin Step 2. Testing the phpAdmin page This is an optional installation step when using MySQL. When using MySQL it is strongly recommended to install phpMyAdmin. It is also recommended that you use a version that is 2.7 or higher. To display the phpAdmin page, open a browser and type: http://localhost/phpMyAdmin/index.php. Step 1. Copy the phpMyAdmin folder to the web root The location of the web root is as follows: Mac OS Figure E. The phpAdmin page c:\inetpub\wwwroot If you get an error such as “Forbidden - You don’t have permission to access /phpMyAdmin/index.php on this server”, you need to check access rights of the file system on the phpMyAdmin folder and make sure that the webserver user (Mac OS: www, Windows: IUSR_<servername>, Linux: nobody) has at least Read access. An easy fix is to recursively apply read access to Other (Mac OS and Linux) or Everyone (Windows). Windows Linux /var/www/html If the browser page shows sources of the PHP script, this means that the WebServer has no association for the .php extension. This can be fixed in the Apache configuration file or MS Internet Information Manager. 49 Server /Library/WebServer/Documents Chapter 06 Server installation Section F. Installing Enterprise server Additional phpMyAdmin Information Open the file config.inc.php in your favorite editor and change the values for Host, User, Password and Authentication Mode to fit your environment. Here, Host means the MySQL server. Also insert the correct value for $cfg[‘PmaAbsoluteUri’]. Have a look at the Configuration section for an explanation of all values. So far, the installation steps were all for generic software components. The following steps will install the Enterprise specific software. Step 1. Installing the Application Server phpMyAdmin References http://www.phpmyadmin.net Server Unzip the zip file and copy the complete SCEnterprise folder (containing index.php, index.html, index.htm etc) to the webroot folder. The location is dependent on the system and http server (Apache/IIS), but normally one of the following locations: Mac OS /Library/WebServer/Documents Windows c:\inetpub\wwwroot Linux /var/www/html 50 Chapter 06 Server installation Step 2. Create a FileStore folder and apply access rights Step 3. Edit the Enterprise configuration file If a standard installation is performed using all standard paths with Application server, Database and File Store all on a single machine, there may be no need to change the basic configuration file. (For more information on setting configuration options, see Chapter 9: Server Configuration.) This step always needs to be performed, even when you have chosen to store files inside the database. Default locations for the FileStore folder are: Mac OS / Linux The config.php configuration file can be found at the following location: /FileStore Mac OS Windows Server /Library/WebServer/Documents/ SCEnterprise/Config c:\FileStore Windows These default locations are not locations we advise to use for production systems; they have just been chosen to allow easy initial installation on all machines. The location can always be changed at a later stage. c:\inetpub\wwwroot\SCEnterprise\ Config Linux Make sure the WebServer user (Mac OS: www, Windows: IUSR_<ServerName>, Linux: nobody) has Read and Write access (and for Windows also Delete access) to the file store. /var/www/html/SCEnterprise/Config 51 Chapter 06 Server installation The following settings need to be checked and/or changed: BASEDIR OS file server path of the SCEnterprise folder. Ensure to edit the correct BASEDIR setting of your OS. Server BASEDIR OS file server path of the SCEnterprise folder. Ensure to edit the correct BASEDIR setting of your OS. INETROOT Web server path of SCEnterprise folder. INETROOT Web server path of SCEnterprise folder. DBSELECT Name of database, default SCEnterprise. DBSELECT Name of database, default SCEnterprise. DBUSER Database user to be used by the Application Server. For a default installation this should be set to “root” for MySQL and to “sa” for MSSQL. DBUSER Database user to be used by the Application Server. For a default installation this should be set to “root” for MySQL and to “sa” for MSSQL. DBPASS Password for the database user. DBPASS Password for the database user. ATTACHMENTDIRECTORY Path to the File Store, which can be a mount point on a different machine. ATTACHMENTDIRECTORY Path to the root of the File Store, which can be a mount point on a different machine. EXPORTDIRECTORY Folder in which exports are downloaded. EXPORTDIRECTORY Folder in which exports are downloaded. WOODWINGSYSTEMDIRECTORY Folder in which Enterprise stores certain system files. This directory MUST be a child directory of the ATTACHMENTDIRECTORY. 52 Chapter 06 Server installation MySQL TEMPDIRECTORY Folder in which Enterprise stores temporary files. A typical setup would be to create a root filestore and create the other directories in it. Since you are editing PHP code, always use forward slashes (/) as path separators and make sure to keep the correct PHP syntax. When the database will be on a different server than the Application Server or when you do not use MySQL or files must be stored in the database, or you want to use a different file structure in the File Store, you also need to edit configserver.php. (See Chapter 9: Server Configuration for more details.) a) Open your web browser and go to http://localhost/phpMyAdmin/index.php. (See figure E in Section E.) b) Create a new SCEnterprise. c) Select utf8_general_ci as collation. database named Oracle Step 4. Creating the SCEnterprise database Step 5. Configuring configserver.php How to create the database depends on the database server used. Please note that the database does not have to be named SCEnterprise, you can name it any way you want. Make sure though that the DBSELECT option in config.php is named likewise. When not using MySQL or when the database server is separated from the application server, the configserver.php file needs to be edited. You can find configserver.php in the same location as config.php. Open it in a editor and adjust the following values if needed: MSSQL Server Inside MSSQL Server Enterprise Manager, create a database named SCEnterprise. DBTYPE Either oracle, mssql or mysql (default) (Make sure the values are in lower case.) 53 Server See section A2. Chapter 06 Server installation DBSERVER Usually localhost, but dependent on where the database server is located. Server Step 6. Run wwtest. After creating the database, it is wise to run preliminary tests on the wwtest page (http://localhost/SCEnterprise/server/wwtest) to find out how the installation is progressing. Fix any errors until wwtest reports no more errors. If that is the case, proceed to Step 7. (See also Section H: Testing the Enterprise Server.) Figure F. The DBAdmin page Step 7. After creating the database, open your web browser and go to http://localhost/SCEnterprise/server/admin/ dbadmin.php (see figure F). If all is well, the web page will tell you that no tables have been created yet. Click on Update to create the Enterprise tables and populate them with initial values. Oracle To be able to run dbadmin.php succesfully, you need to set the DBUSER in config.php to Woodwing. This is a temporary measure because the normal Root user does not have the privileges to create or alter tables. Be sure to reset DBUSER to Root after having run dbadmin.php. When a Combined User has been created (see the section Creating Database Users), this step is not needed. 54 Chapter 06 Server installation Additional Enterprise Server Information The standard setup uses a database user root without password. This is obviously not secure (it is just used to ease initial installation) and we strongly recommend to create and use a new database user WITH a password. If any problems arise, you may want to create the database yourself by executing the relevant sql scripts available in the /scenterprise/server/ dbscripts folder in your database tool. The following assumes you are upgrading from Smart Connection Enterprise version 4.10. Replace 410 by 420 when upgrading from version 4.2.x. Replace by 340 when upgrading from 3.4.x: MySQL scent410_500.mysql.sql Server MSSQL Execute in the following order: 1) scent410_500.ident.mssql.sql 2) scent410_500.mssql.sql Oracle Execute in the following order: 1) scent410_500.case.ora.sys.sql 2) scent410_500.ora.sys.sql 55 Chapter 06 Server installation Section G. Upgrading to Enterprise 5.0 in detail how to configure these for Enterprise 5.0. Also be sure to create a _SYSTEM_ folder in the FileStore folder with Read and Write access for the www user. Server Smart Connection Enterprise version 3.4 or higher can be upgraded to version 5.0. This is a fairly simple process, but before you upgrade you may want to backup your data first as a safety precaution: Step 1. Create a dump or backup of your existing SCEnterprise database. The configuration options are documented in the configuration files themselves but you may also want to read Section F: Installing Enterprise Server and/or Chapter 9: Server Configuration. Step 2. Back-up the File Store. (See Section F: Step 2 for locations.) Next, log in to Enterprise as administrator by opening http://localhost/scenterprise/ in your web browser. Step 3. Back-up SCEnterprise config files. (See Section F: Step 3 for locations.) Step 4. Back-up the SCEnterprise directory if you have made modifications to the code. (See Section F: Step 4 for locations.) After having made the backup, remove the old SCEnterprise folder and copy the new SCEnterprise folder to that location. Then, if needed, reconfigure SCEnterprise by editing config.php and/or configserver. php. Note that it is not allowed to just copy the old config.php/configserver.php over the new ones, as important modifications to the configuration files have been made and are necessary to run Enterprise 5.0. Figure Ga. The Enterprise log in page Then, open http://localhost/scenterprise/server/ admin/dbadmin.php. If all is well, the option to upgrade from your current version to version 5.0 In particular, changes have been made to the definitions of the FileStore paths. Please review 56 Chapter 06 Server installation Should any problems occur, you may want to alter the database yourself by executing the relevant sql scripts available in the /scenterprise/ server/dbscripts folder in your database tool. will be selected. Click Update to start altering the database structure. (See figure Gb.) The following assumes you are upgrading from Smart Connection Enterprise version 4.10. Replace 410 by 420 when upgrading from version 4.2.x. Replace by 340 when upgrading from 3.4.x: MySQL scent410_500.mysql.sql Execute in the following order: MSSQL 1) scent410_500.case.ora.trx.sql 2) scent410_500.ora.trx.sql When upgrading from Enterprise version 4.1, you need to manually set the identity flag on the first column (named 'id') of the following two tables: smart_objects and smart_deletedobjects. This can be done in the MSSQL Enterprise Manager. MSSQL Execute in the following order: 1) scent410_500.ident.mssql.sql 2) scent410_500.mssql.sql 57 Server Oracle Figure Gb. The option to upgrade to version 5 selected on the DBAdmin page Chapter 06 Server installation Section G1. Upgrading custom properties MSSQL Server 3) When upgrading from Enterprise version 4.1 to version 5.0.0, you need to manually set the identity flag on the first column (named 'id') of the following tables: smart_authorizations smart_config smart_ticket This can be done in the MSSQL Enterprise Manager. The rules for creating custom properties have been tightened so that more databases can be supported. The smart_objects table (prefixed with c_) now uses the name of a custom property (not the display name) as the field name. Therefore, as from Enterprise v4.2, it is not allowed anymore for the name of the custom property to contain spaces and/or nonASCII characters. This means that if you have defined custom properties which do not follow this new rule, you need to rename the custom properties. These changes are not required when upgrading to Enterprise version 5.0.1 or higher, since these settings are part of the respective update scripts. It may be needed to ‘ALTER TABLE’ the smart_objects table, especially when using an Oracle database since on Oracle these changes are not automatically implemented. When completed, a page displays showing that the converted profiles have been added. If you have defined named queries it may also be needed to modify those as they may contain references to custom properties by name. Figure Gc. A message displays confirming that the profiles have been converted Although it is not required by the system, when upgrading to version 5 it is advised to change the field types of the custom properties of type 'list'. These fields are present in the smart_objects and smart_deletedobjects table and are set to either BLOB or CLOB by default. You may change these to varchar(200) manually, in BOTH tables. This may increase performance as well as prevent SQL errors. 58 Chapter 06 Server installation Section H. Testing the Enterprise Server user (Mac OS: www, Windows: IUSR_ <servername>, Linux: www) has at least Read Access. An easy fix is to recursively apply Read Access to Other (Mac OS and Linux) or Everyone (Windows). Now that all software has been installed, the last step is to run some tests to see if the system is performing properly. To do this, open your web browser and go to http://localhost/SCEnterprise/server/wwtest. The page does not come up. Try http://localhost/SCEnterprise/server/wwtest/ index.htm. If this does not work, this means that your web server does not have its default page set correctly. (See you web server documentation for details on how to fix this.) Test page fails on Application Server test. When you run into the problem “Logon FAILED: HTTP Response 404 Not Found”, you should check the INETROOT setting in config.php. Figure H. The Enterprise server test page If the test page does not show up, the web server is not working properly. Some of the issues that you may run up against are: Test Page fails on FileStore test. The new subdirectory _SYSTEM_ must be added to the File Store directory. This subdirectory must have the same access rights as the FileStore directory. Error: “Forbidden - You don’t have permission to access /SCEnterprise/ Server/wwtest on this server”. Check the file system’s access rights on the SCEnterprise folder and make sure that the webserver 59 Server No test screen appears, just some PHP code. This means that the web server has no association for the .php extension. This can be fixed in the Apache configuration file or MS Internet Information Manager, depending on what web server you are using. Chapter 06 Server installation Section H2. Additional testing options Some basic tests are run automatically when opening the wwtest page. If everything is OK, all test results are shown in green. You can now start using Enterprise. Should any of these tests have failed, the result is shown in red. Follow the instructions given on the screen to resolve the issue. At the top of the test page, the following options are available that will provide more detailed information on the Enterprise environment: Configuration overview Provides settings as set in the config.php, configserver.php and serverinfo.php files, as well as details on the installed PHP version. Server Section H1. Advanced testing If you encounter problems while using Enterprise or when you need to test a specific feature, you may want to run an advanced test. Click the Advanced button at the bottom of the page, select the test you want to run and press the Test button. Positive test results show in green, failures show in red. Figure H2a. The configuration overview Phpinfo Shows details on the PHP configuration and/or which libraries are installed. The php configuration can be modified by editing the php.ini file. See figure H2b on the next page. (For more details on editing the php.ini file, see Section C: Step 2.) Figure G1. The Enterprise server advanced test page 60 Chapter 06 Server installation The plan interface test page This tool can be used to test the plannings SOAP interface. You only need to do this if you want to connect to a planning tool like such as JournalDesigner. To test the plannings interface, open http://localhost/SCEnterprise/ser ver/wwtest/ clientplan.php. Figure H2b. The PHP version page The preview test page Enterprise can work together with ImageMagick to automatically create previews and thumbnails. The preview test page can be used to verify the version of ImageMagick installed and to test if the system is set up correctly. Click the link in the top of the page for more information on using clientplan.php. Server Figure H2d. The plan interface test page Figure H2c. The preview test page Troubleshooting In case some of the tests failed or if there are other problems, refer to Chapter 15: Troubleshooting. 61 Server Chapter 06 Server installation intentionally left blank 62 07 Licensing 07 Server Licensing After installing Smart Connection Enterprise Server, a license for it needs to be activated in order to be able to use it. Similarly, licenses need to be activated for the Web Editor as well as for InDesign and InCopy. This chapter explains all steps related to activating, deactivating and removing licenses. 64 Chapter 07 Licensing 1. Introduction to licensing 1.2 Web Editor licenses The following sections describe the various licenses available. The Web Editor application requires separate client licenses to be activated. Web Editor licenses are per concurrent user, which is taken once the user enters the Web Editor. After closing the Web Editor (without logging off) the user is still occupying a Web Editor license which will be freed after log-off from the Web Applications. 1.1 Server connection licenses Before the server can be used, you will need to activate Server Connection Licenses per concurrent user. An external system or automatic process (such as Smart Mover or a Planning System) also makes a connection to the server, so will also need a connection license to be available. When you have reached the number of concurrent users, additional users won’t be able to logon. 1.3 InDesign and InCopy licenses An administrator can at any time logon to the WebApp to remove logons for making connections available again. When using multiple system instances (each with their own database) you will need to divide your server connection licenses among the systems. The concurrency is only offered per system instance. When concurrent licenses are used and activated server-side, you still need to activate the InDesign and InCopy client plug-ins for concurrent licensing. With a concurrent license serial you can activate an unlimited amount of InDesign/InCopy plug-ins for concurrent licensing. When logging in, the server will determine if a concurrent license is available. If not, the log-on will fail. 65 Server Smart Connection Enterprise for InDesign and InCopy can either be licensed seat-based or per concurrent user. Seat-based licenses are activated client side via the activation wizard or an activation file to activate without user interference. Concurrent licenses are administrated server-side via the same screens as the server connections. Chapter 07 Licensing 2. The License Status page Licenses are managed via the License Status page. The page can be accessed via the Maintenance menu. A A C B C D Add additional client licenses button B License info Activate More button D Deactivate button Option description Renew In case the license is a so called timelimited license, the license should be renewed before the specified date. If not, the license will expire. Expires Date when the license will expire Current Number of licenses in use. Usage Graphical display of licenses used vs available seats Limit Maximum number of licenses within license Server Figure 2. The License status page The following options are listed: Action Option description Application The application for which the license is installed Status The status of the license: OK Expires [within x days] Expired “The current license has renewed” Usage limit reached Message to Activate More button for activating additional server or client licenses. Deactivate button for deactivating licenses. In case the license has expired, a Remove button can be used to remove the license. For information on activating additional server licenses, see Section 3.2: Activating Additional Enterprise Licenses. For information on activating concurrent client licenses, see Section 3.3: Activating Client Licenses. be For information on deactivating licenses, see Section 4: Deactivating Licenses. A more detailed description of the status, e.g. containing error codes. 66 Chapter 07 Licensing 3. Activating licenses Since no licenses are activated yet, no Web Applications or Maintenance options are available. The License Status page is displayed: The following sections describe the process of activating the various licenses. 3.1 Activating the Enterprise Server license To activate a license for Smart Connection Enterprise Server, do the following: Step 1. Log in to Enterprise by opening http://<yourserver>/scenterprise/ in your web browser. Step 2. Click the Get License link. The Activate page appears. (See figure 3.1c on the next page.) From this point on, activation can be done either online via the internet or offline via fax or email. For activating online, see Section 3.1.1 Activating a License Online. For activating offline, see Section 3.1.2 Activating a License Offline. Figure 3.1a The Enterprise log in page 67 Server Figure 3.1b The License Status page Chapter 07 Licensing For Steps 1 and 2, see Section 3.1 Activating the Enterprise Server License. Step 3. Press Next. The Serial Number page appears. Server Figure 3.1c The Activate page 3.1.1 Activating a license online To continue with the automated process, a web browser with internet access is required. A browser connection status is displayed at the bottom of the page, indicating whether or not your current browser can be used for this process. If your browser cannot be used, check your internet connection: e.g. your proxy settings, (software) firewalls, router configuration, etc. Your browser needs to support Javascript, but you will see an error message in case Javascript support would have been switched off. Alternatively, activate Enterprise by email, but be aware that this typically takes two working days. (For more information, see Section 3.1.2 Activating a License Offline) Figure 3.1.1 The Serial Number page Step 4. Enter the serial number and number of concurrent licenses (this allows you to divide your licenses among several system instances). If you are unsure of the number of concurrent licenses available for this serial number, press the Check button. Step 5. Select the check box to register Smart Connection Enterprise Server. Only registered copies of Enterprise are entitled to upgrades. 68 Chapter 07 Licensing 3.1.2 Activating a license offline Step 6. Select the check box The Actual Server Time is... to confirm the time on the application server. To activate a license offline via mail, do the following: Step 7. Press Next. The Contact Information page appears. Enter all required fields. When activating a license offline, it takes two working days to process your request. Step 8. Press Next. The License Status page appears. If all has gone well, a message displays that the licensed has installed successfully. For Steps 1 and 2, see Section 3.1 Activating the Enterprise Server License. Step 3. On the Activate page, select the check box I don’t have access to the Internet or I prefer activating by e-mail. Step 4. Click Next. The Offline Activation page appears. Figure 3.1.2 The Offline Activation page 69 Server Step 9. (Optional) To verify the current license status or to install additional concurrent licenses for the client applications, access the License Status page by doing one of the following: Click the link Logon to the Web Application as an Administrator to Add More Concurrent Applications Select Logout in the menu The log-on screen will appear. After logging in, all applications and maintenance options have become available in the Applications and Maintenance menus. Navigate to Licensing in the Maintenance menu. The License Status page will appear. (See Section 2. The License Status Page.) Chapter 07 Licensing 3.2 Activating additional Enterprise licenses Step 5. Send the following details by email to [email protected]: To activate additional Smart Connection Enterprise Server licenses, do the following: Product name and version Per product: The serial number Per product: The number of concurrent users/ connections for this installation. The installation code: (as provided on screen) Step 1. Press the Activate More button on the License Status page. (For more information, see Section 2: The License Status page.) Step 2. Follow the steps as outlined in Section 3.1: Activating the Enterprise Server License. Server Step 6. Press Cancel to terminate the process for now and wait for WoodWing support to send you an activation code. Once you have received the activation code, repeat Steps 1 to 4. Then, do the following: Step 7. Enter the serial number and activation code. Step 8. Press Next. The License Status page appears. If all has gone well, a message displays that the licensed has installed successfully. Step 9. Press the License Status link or select Logout in the menu. The log-on screen will appear. After logging in, all applications have become available. Navigate to Licensing in the Maintenance menu. The License Status page will appear. (See Section 2. The License Status Page.) 70 Chapter 07 Licensing 3.3 Activating client licenses To activate a concurrent client license, do the following: For the client applications (InDesign, InCopy and the Web Editor), the process of registering a license is dependent on the type of license used. Step 1. Access the License Status page. (See Section 2: The License Status page.) Licences for the Web Editor are always concurrent licenses. Step 2. Press the link Add Additional Client Licenses. The Activate page appears. Seat-based licenses are activated client side via the activation wizard or an activation file to activate without user interference. No additional steps on the server are required. (For more information, see Chapter 11: Client Installation.) Server Concurrent client licenses require an additional activation step on the server, using the same screens as the server connections (as explained in the following sections). With a concurrent license serial you can activate an unlimited amount of Web Editor users or InDesign/ InCopy plug-ins for concurrent licensing. When logging in, the server will determine if a concurrent license is available. If not, the log-on will fail. Figure 3.3 The Activate page From this point on, activation can be done either online via the internet or offline via email. For activating online, see Section 3.1.1 Activating a License Online. For activating offline, see Section 3.1.2 Activating a License Offline. When using a concurrent license for InDesign and InCopy, the InDesign and InCopy clients also need to be activated as a concurrent license. (For more information, see Chapter 11: Client Installation.) 71 Chapter 07 Licensing Server 3.3.1 Activating a license online To continue with the automated process, a web browser with internet access is required. A browser connection status is displayed at the bottom of the page, indicating whether or not your current browser can be used for this process. If your browser cannot be used, check your internet connection: e.g. your proxy settings, (software) firewalls, router configuration, etc. Your browser needs to support Javascript, but you will see an error message in case Javascript support would have been switched off. Alternatively, activate Enterprise by email, but be aware that this typically takes two working days. (For more information, see Section 3.1.2 Registering a License Offline) Figure 3.3.1 The Serial Number page For Steps 1 and 2, see Section 3.3 Activating Client Licenses. Step 3. Press Next. The Serial Number page appears. (See figure 3.3.1.) Step 4. Select the product from the list, serial number and number of concurrent licenses. If you are unsure of the number of concurrent licenses available for this serial number, press the Check button. Step 5. Press Next. The License Status page appears. If all has gone well, a message displays that the licensed has installed successfully. 72 Chapter 07 Licensing 3.3.2 Activating a license offline Step 5. Send the following details by email to [email protected]: To activate a client license offline via email, do the following: Product name and version Per product: The serial number Per product: The number of concurrent users/ connections for this installation. The installation code: (as provided on screen) When activating a license offline, it takes two working days to process your request. For Steps 1 and 2, see Section 3.1 Activating the Enterprise Server License. Step 6. Press Cancel to terminate the process for now and wait for WoodWing support to send you an activation code. Step 3. On the Activate page, select the check box I don’t have access to the Internet or I prefer activating by e-mail. Step 7. Enter the serial number and activation code. Step 8. Press Next. The License Status page appears. If all has gone well, a message displays that the licensed has installed successfully. Step 9. Repeat this process for each client for which the license needs to be registered. Step 10. Return to the License Status page to verify the license of each client. Figure 3.3.2 The Offline Activation page 73 Server Once you have received the activation code, repeat Steps 1 to 4. Then, do the following: Step 4. Click Next. The Offline Activation page appears. Chapter 07 Licensing 4. Deactivating licenses Step 3a. Enter a number less than the maximum connections to reduce the connections. In case server connection licenses or client licenses needs to be deactivated, do the following: Internet access process. is required for or Step 3b. Enter the maximum number of connections to remove the license completely. this Step 1. Access the License Status page. (See Section 2: The License Status page.) Step 4. Press Next. After the changes have been processed, a screen appears informing that the process has been completed successfully. Step 2. Press the Deactivate button for the license that needs to be deactivated. The Deactivate page appears. Server After deactivating license, these are available to be activated again on a different system instance. Figure 4. The Deactivate page Use one of the following methods: 74 Chapter 07 Licensing 5. Removing licenses To remove a license, do the following: Step 1. Access the License Status page. (See Section 2: The License Status page.) When a license expires, Enterprise will prompt you via a message on the Layout Status page to remove the license completely. Step 2. Press the Remove License link. The Remove License page appears. By pressing the Remove button, you will remove all licenses on this system. Note that it is better to deactivate licenses first, if possible. If the license is not deactivated first, the WoodWing activation server will not be notified and activating the license later may result in a limited number of concurrent connections or users. Server Figure 5b. The Remove Licenes page Step 3. Press the Remove button. The license will be removed and on successful removal a confirmation message will display. Figure 5a. When a license becomes corrupted, a message will display on the License Status page 75 Server Chapter 07 Licensing intentionally left blank 76 08 Publication and workflow setup 08 Server Publication and workflow setup Managing the publications and workflow is done via the Enterprise web pages. This chapter goes through the process of setting up a standard publication step by step as well as describing all additional maintenance options. 1. Logging in To access the web pages, open a browser and type http://<yourserver>/scenterprise/. The Log In screen will appear (see figure 1a). Figure 1a. The Enterprise log in page When going through the standard installation, you can logon as user woodwing with password ww. This is an administrator account and we strongly advise to change the password. After logon you will see the Enterprise home page with on the left side the main menu containing links to the Web Applications as well as various maintenance options. (See figure 1b.) 78 Chapter 08 Publication and workflow setup Step 8. Setting up a workflow Step 9. Further setting up deadlines Step 10. Automatic routing Step 11. Controlling user authorizations Step 12. Final settings A B Section B—Additional Maintenance describes the various tasks that can be performed once a publication is fully set up and in use. C D E A C Web applications menu B Web applications icons Maintenance menu D Logout E Server version 2. Chapter setup This chapter is divided into two sections. Section A—Workflow Setup will talk you through a 12-step process using the Maintenance menus for setting up a complete publication environment. Step 1. Creating users and groups Step 2. Setting up access profiles Step 3. Setting up a publication Step 4. Assigning administrators Step 5. Creating an issue Step 6. Creating sections Step 7. Creating editions B11. User B2. Issues B12. Meta data B3. Editions B13. Dialog setup B4. Sections B14. Named query B5. Workflow B15. User query B6. Routing rules B16. Clean up B7. User authorizations B17. Log B8. Admin authorizations B18. Online users B9. Access Profiles B19. MadeToPrint B10. Group B20. Licensing Information on using the Web Applications can be found in the Smart Connection Enterprise User Guide. The standard installation of Enterprise creates a sample publication WW News which can be used for testing. This sample publication can be deleted once you are done testing. 79 Server Figure 1b. The Enterprise home page B1. Publications Chapter 08 Publication and workflow setup Section A. Workflow setup This section describes in detail how to set up a fully working Publication for everyday use in a standard workflow environment. It is advised that the steps are followed in sequence. A B A B Create new user C Copy user Figure 1.1a The overview of users page Step 1. Creating users and groups Server Created user C Step 2. Select New User. Maintenance page appears. Any created user or group is seen globally by the system. They are therefore available to all created publications and don’t have to be defined for each publication separately. In addition, a user can belong to more than one group, and can therefore be part of multiple publications at the same time. The User Once a user is created, it needs to be assigned to a group. Then, Access rights (user profiles) are applied to that group, determining which actions are available to its users. Figure 1.1b The user maintenance page 1.1 Creating users To create a user, do the following: The table on the next page shows the properties that can be set: Step 1. Select User from the Maintenance menu. The Overview of Users page appears. (See figure 1.1a.) A default user, WoodWing, already exists. 80 Chapter 08 Publication and workflow setup Property description User Short name of the user that can be used to log on. Note: user names cannot exceed 27 characters (even less when special characters are used). Full name Full name of the user. Deactivated Option to deactivate a user without removing it. This is very useful for temporary employees that are expected to return. New password User’s password (mandatory). Until which date the user account is active. If left blank no end date is applicable. Email Email address of the user for email notifications. Language the user prefers to use in the browser interface. Color Color to identify this user from other users. Mainly used as color for tracking changes and creating Sticky Notes. To change the default color, click the Pick button and select a color from the palette. Determines whether the Send email user should receive email notification when notifications when a file is routed file routed to me to him/her. Figure 1.1c The new user added to the list of users Determines whether the Send email user should receive email notification when notifications when a file is routed file routed to one to a group he/she is a member of my groups of. Before the user is able to use any of the web applications or see any stored files on the client side, the user needs to be added to a group (see step 1.2 Creating groups). 81 Server Valid till Language At the bottom of the page, a section appears for adding the user to a group. Since we have not set up any (new) groups yet, the created user will be added to a group in the next step. Press the silver arrow beneath the Groups section to return to the Users Overview and note that the new user has been added. Password How many days from now the expiration in days current password will be valid. From which date the user account is active. If left blank no start date is applicable. description Step 3. To add the user to the system, press the Update button. User can Determines whether the user can not change change his/her password via the password client interface. Valid from Property Chapter 08 Publication and workflow setup 1.2 Creating groups The following table shows the properties that can be set: A user needs to belong to a group before he/she is able to use any of the web applications or see any stored files on the client side. To create a group, do the following: Step 1. Select Group from the Maintenance menu. The Overview of Groups page appears. (See figure 1.2a.) A default group, Admin, already exists. Property description Name Name of the group. Must be unique with respect to other groups and user names. Admin If this is set, users in this group can access the admin applications to control users, groups and publications. It also allows to unlock files locked by another user via the Query/Browse page. Routing Enterprise uses groups for both access rights and workflow routing. Only those groups that have the Routing option set are available for routing in order to prevent unnecessarily long lists of groups in the routing lists. Server A B C D Created group B Create new group Admin and/or routing rights applied users in group A D C E E Copy group Number of Step 3. To add the group to the system, press the Update button. Figure 1.2a The groups overview page Step 2. Select New Group. The Group Maintenance page appears At the bottom of the page, a section appears for adding a user to the group. Figure 1.2b The group maintenance page 82 Chapter 08 Publication and workflow setup 1.2.1 Adding a user to a group Step 4. Click on Add User. The Add Users to a Group page appears: Figure 1.2.1b A user has been added to the group Figure 1.2.1a The add users to group page Press the silver arrow beneath the Users section to return to the Overview of Groups page and note that the new group has been added. Server Step 5. From the User drop-down menu, select the user to be added to the group. Step 6. Click the Add button to add the selected user to the group. The Group Maintenance page appears again, showing the added user at the bottom of the page in the Users section. (See Figure 1.2.1b.) Figure 1.2.1c The new group added to the list of group A user can be assigned to multiple groups at the same time. Step 7. Repeat this process for each user that needs to be added. Group names can not exceed 27 characters (less if special characters are used). 83 Chapter 08 Publication and workflow setup 1.2.2 Adding users and groups with LDAP Group Data—Name, Description Memberships—User groups that are defined both in Enterprise and LDAP are assigned to the user logging in Server By integrating LDAP with the Smart Connection Enterprise server, the administrator is able to better control user authorization as well as better maintain user accounts. LDAP Configuration The first step is to enable LDAP for PHP. In the following installation steps, it is assumed that you have installed PHP in the C:\PHP folder. With LDAP enabled (which is optional), user authorization is controlled via the LDAP server and not anymore through the Enterprise server. When LDAP finds the log-in valid, Enterprise synchronizes the user account by also making it available in its own database (when missing). It will then check if there are any user groups that are defined both in Enterprise and LDAP. Only taking those groups into account, if a user is assigned to a certain group in LDAP, that user will be assigned to the corresponding Enterprise user group as well. Step 1. Check if the C:\PHP\ext folder exists. If not, your PHP installation is not complete. Most safe is to remove the entire PHP installation and install a complete PHP version. This can be done by renaming the C:\PHP folder and creating a new C:\PHP folder to which you install (or copy) a full new installation. Step 2. Check in the C:\PHP\ext folder if the php_ldap.dll module is present. If not, reinstall PHP as described in step 1. Synchronizing Users and User Groups User groups that have already been set up in LDAP can be synchronized by importing them to the Enterprise server as opposed to creating groups manually. Users are synchronized after successfully logging in, after which a user account is created and his/her (LDAP) group memberships are synchronized with Enterprise. Step 3. Check if the extension_dir option is set correctly by opening the php.ini file and searching for the extension_dir setting. Make sure the setting looks as follows: extension_dir="C:\PHP\ext" The following data is synchronized: User Data—ID, Full Name, Password, E-mail, Deactivation If there is a leading “;” semicolon (such as ;extension_dir=...), make sure you remove the “;” to enable the setting. 84 Chapter 08 Publication and workflow setup Step 4. Check if the LDAP module is enabled by opening the php.ini file and searching for php_ldap.dll. Make sure the setting looks as follows: extension=php_ldap.dll. information about the meaning of LDAP configuration parameters. Step 8. Run the http://localhost/SCEnterprise/ server/wwtest page and check if there are NO errors or warnings. If the LDAP module could not be found or loaded, download the Dependency Walker tool from internet. Drag and drop the C:\PHP\ext\php_ldap.dll module onto the tool and see if there are any errors shown (ignore the error about a missing php5ts.dll module) If there are any modules missing, download them from internet and install them at the appropriate location. If there is a leading “;” semicolon (such as ;extension=php_ldap.dll), make sure you remove the “;” to enable the setting. Importing user groups Once LDAP support is enabled, you can import user groups from LDAP into Enterprise: Step 6. Restart IIS/Apache. (On Windows 2000 Server running IIS, it is not enough to just restart IIS after enabling the php_ldap extension. You have to restart the server itself.) Step 1. Select Group from the Maintenance menu. The Groups Overview page appears. Step 2. Press the Import button. Step 7. Enable LDAP for Enterprise by uncommenting the NETWORK_DOMAINS and LDAP_SERVERS options in the configserver.php file. Enter your LDAP server configuration in NetworkDomain and LDAPServer objects as shown in the shipped examples. Note: Comments are left in the file referring to php files that provide more Step 3. Select the network domain you want to import from. Step 4. Optionally: apply a query like ‘*Admin*’ to narrow down the results. Step 5. Tag the groups you want to import. 85 Server Step 5. Check if the SSL libraries are installed. Browse to the c:\windows\system32 folder and check if the ssleay32.dll and libeay32.dll modules are present. If not, copy them from the PHP\Win32 binary package to the c:\windows\ system32 folder. After having copied the DLLs to the systems32 folder, remember to add Read and Execute permission to “everyone”. Chapter 08 Publication and workflow setup Step 2. Setting up access profiles Step 6. Press the Import button. The tagged groups should now be present in the Enterprise database (including the group description field). Access profiles are groups of access rights which can be applied to different user groups for different publications. Access profiles are defined globally, meaning that they can be reused when defining multiple publications. Through access profiles, certain features can be disabled, preventing the user from using them. Access Profiles are assigned by section/status combination (when defining user authorizations for a publication/ issue) for one or more groups of users. Server The purpose of this is to be able to ensure that for example changes to a file can only be made by users from a specific group and only when a certain status has been reached, thereby preempting unwanted changes. To create an access profile, do the following: Step 1. Select Access Profiles from the Maintenance menu. The Profile Overview page appears. A default profile, Full Control, already exists. (See figure 2a on the next page.) 86 Chapter 08 Publication and workflow setup The following overview shows a complete description of all rights and features, grouped under their relevant headings: A Access Features B C D Access features describe what access users have to files within a publication, issue or section. They replace the access rights from earlier versions of Enterprise. E A Created profile B Create new profile C Reorder profiles D Order entry field E Description Figure 2a. The profile overview page Step 2. Select New. The Profile Maintenance page appears. description View User can view/find files in the query results. Read User can open files for reading. Open for Edit User can open files for editing as well as lock files. Write User can create or save files. Delete User can delete files. User can change the status of a file Change status forwards (to the next status in the forward workflow). Figure 2b. The profile maintenance page Change status Step 3. Name the profile and add a description that explains the purpose of the profile. User can change the status of the file both forwards and backwards (to its next or previous status in the workflow). Restore version User can restore old versions. Step 4. Decide for this profile which access rights and/or features should be enabled and which ones should be disabled. Keep locked 87 User can take files offline. Server Feature Chapter 08 Publication and workflow setup Server The View and Read access rights can be confusing at first. Normally people have View and Read access rights if they are allowed to open a file for reading. View only allows users to see files and their status without providing the ability to open those files for reading. When a placed InCopy file is opened, the user not only needs Access rights to the InCopy file, but also Read access rights to the InDesign file in order to enable Write to Fit. Here the separation between View and Read comes in handy: for InCopy users you can set not to have View access rights, but do grant Read access rights to the InDesign file. This way, they don’t see the InDesign files in their list but they can open InCopy files and see them on the page they are placed on. Feature description Query/browse User can browse and query. Publication overview User can browse files and see previews/thumbnails of the files. Upload User can upload file(s) to the system. Reporting User can view several type of reports. Export User can export files. Webeditor User can edit articles with the Web Editor. My Profile User can change his/her own profile: change language and/ or set password. Styles Because of this, it is good practice to grant everybody working within a publication Read access rights to every file in order to make sure that the system can access files if needed. The View access can subsequently be used to determine which files are shown to the user. Without the View access, the user doesn’t see a file and thus cannot open the file. Style features limit the options the user has in InDesign/ InCopy to apply or edit styles. Web Features Web features limit the options that a user has when logged in to the web application. Basically each menu item under the Applications heading can be enabled/ disabled by setting the relevant feature. 88 Feature description Apply paragraph styles User can apply paragraph styles. Edit paragraph styles User can create, duplicate, delete and edit paragraph styles in InDesign/InCopy. Also allows the user to Load Paragraph Styles, Load All Styles and Break Link to Style. Chapter 08 Publication and workflow setup Feature description Feature description Apply character styles User can apply character styles. Use the Fit text into frame (CopyFit) Only applicable to Smart Layout. User uses CopyFit. Composition User can set Preferences that influence composition: advanced type, character settings, grids, text wrap. User can create, duplicate, delete and edit character styles. Also allows the user to Edit character styles Load Character Styles, Load All Styles and Break Link to Style. Track Changes Feature description Feature description Apply paragraph formatting User can apply paragraph formatting (can use the paragraph palette). Force track changes All changes by this user are tracked (shown in his/her color) by default. Select font family User can change the font family. Edit track changes User can disable/enable the tracking of his/her changes. Set font style User can set the font style (bold, italic). Linguistic Set basic formats User can set underline, strike through, all caps, small caps, superscript, subscript. Linguistic features limit the options the user has to use the dictionary in InDesign/InCopy. Feature description Set advanced formats User can set type size, kerning, leading etc. Can also use all Story and all Character palette options not covered in the other typographic features. Change language/ dictionary User can set the language/ dictionary. Typography 89 Server Typography features limit the options the user has in InDesign/InCopy to apply fonts to a section of text. Track changes features define if and how track changes is implemented for the user. Each user has a unique color in which text and/or layout changes made by that user are highlighted. Chapter 08 Publication and workflow setup Feature description Feature description Edit dictionary User can edit the dictionary: make changes to spelling/ hyphenation/add words/etc. Create dossiers User can create dossiers. Create from layer User can create new articles from layer. Layout Create from document Layout features limit the options the user has to resize text frames in InCopy. User can create new articles from document. Abort checkout User can abort checkout. Feature Change restricted properties User can change restricted properties. Change publication/ issue/section User can change the publication, issue or section to which a file belongs. description Resize text frames per User can resize text frames line per line. Server Resize text frames per User can resize text frames coordinates per coordinates. Config Color Config features limit the options the user has to configure InDesign/InCopy. Color features limit the options the user has to use swatches in InDesign/InCopy. Feature description Feature description Edit tags and element labels User can edit tags and element labels. Apply swatches User can apply swatches from the swatches palette. Modify keyboard shortcuts User can create and modify keyboard shortcuts. Edit swatches User can create, duplicate, delete and edit swatches. Edit text macros User can create and edit text macros. Workflow Workflow features limit the options the user has to perform certain workflow actions. 90 Chapter 08 Publication and workflow setup Step 3. Setting up a publication Section into your own terms, for example into Program, Region, Book and Chapter. (For more information see Section 10 Customizing the Web User Interface in Chapter 9: Server Configuration.) There are two types of publications that can be set up: Periodic Publications (such as magazines and newspapers) and Project-Oriented Publications (typically used by books and ad-agencies). 3.1 Creating your publications Periodic Publications For periodic publications the sections, editions, workflow and authorizations are all defined on publication level. When a new issue is created, the issue automatically receives the sections, editions, workflow and authorizations for that publication. To create a new publication, do the following: Step 1. Select Publication from the Maintenance menu. The Publication Overview page appears. A default publication, WW News, already exists. Server Project-oriented Publications For project-oriented publications, Enterprise Issues are used per project. For this purpose, Enterprise allows you to define sections, editions, workflow and authorizations per issue. A You can mix the periodic and project driven publications within one Enterprise system. You can even combine them within one publication. Note that if you choose for an issue to overrule the publication definitions, you will need to redefine these completely for that issue. B A C E C D E F Created publication B Create new publication Copy publication D Reorder publications Number of issues F Publication order Figure 3.1a The publication overview page Step 2. Select New. The Profile Maintenance screen appears. (See figure 3.1b on the next page.) Enterprise allows you to translate the default terminologies Publication, Edition, Issue and 91 Chapter 08 Publication and workflow setup Property description Time settings Opens the relative deadlines page1. (See section 9.1: Defining Relative Deadlines later in this chapter.) At this stage of setting up a publication, no issues have been created yet so the Current Issue dropdown list is empty. We will come back to this option later in the workflow. 1 Figure 3.1b The publication maintenance page Step 3. Press the Update button to create the publication. As soon as the publication is created in the system, all other sections for managing the publication appear on the Publication Maintenance page (Issue, Edition, Section, Workflow, Routing, User Authorizations and Admin Authorizations). Server The following table shows the properties that can be set: Property description Name Name of the publication. Determines whether email notifications should be enabled for this publication. Email (See Section 13: Email notifications notifications in Chapter 9:Server Configuration for more details.) Description Description of the publication Reading order reversed Determines whether the pages in the publication overview are displayed in ascending or descending order. Current issue For setting the current issue. Leave blank to not set a current issue1. (See Chapter 3: The Concept for more information.) Figure 3.1c After clicking the Update button, all other sections for managing the publication appear 92 Chapter 08 Publication and workflow setup Step 4. Assigning administrators At the most basic level, only a publication name needs to be entered for creating a publication. All other options can also be set at a later stage. There are two levels of administration. The first level gives maintenance access to all publications and is defined by enabling the Admin option of user groups. (See Step 1: Creating Users and Groups earlier in this chapter). The second level gives access to a single publication. This can be done by adding groups under Admin Authorization of the publication’s maintenance page. User, groups and profiles don’t have to be defined per publication. Enterprise works with a global list of users, groups and access profiles which can be assigned per publication. (For more information, see Step 1: Creating Users and Groups.) When logging in as a user that belongs to the admin group, all maintenance options for all publications are available as well as all application options. Figure 4. Two created groups with different administration levels In order to give members of the editors group maintenance access to a specific publication, that group needs to be added to the Admin Authorizations section of that publication. 93 Server For example, assume there are two groups as shown in the figure 4a. The admin group has the Admin option enabled. The editors group has the Admin option disabled. Chapter 08 Publication and workflow setup Step 5. Creating an issue To also give members of the editors group access to the Applications section, the group needs to be added to the User Authorizations section of that publication. (For more information, see Section 11: Controlling User Authorizations.) To create a new issue, do the following: Server Step 1. Open the Publication Maintenance page for the publication to which you want to add an issue and locate the Issue menu. (See figure 5a.) Since we are working with a newly created publication, no issues exist yet. A A Add issue B B Reorder issues Figure 5a. The issue menu Step 2. Select Add. The Issue Maintenance page appears. 94 Chapter 08 Publication and workflow setup Figure 5b. The issue maintenance page Property description Name Name of the issue. Publication date Date when the issue needs to be published by. Deadline Date when the issue needs to be finished by. Expected pages Number of expected pages. Subject Currently doesn't have a special meaning. Description Description of the issue description Active Use to deactivate the issue. This will hide it from the users without actually removing it from the system. Overrule publication Use to determine if the new issue should have its own section, workflow and user authorization definitions. (See previous section Periodic vs Project Oriented Publications for more information.) After selecting this option, press the Update button to show the options for setting the Sections, Workflow and Authorizations for this issue. Time settings Only available when Overrule Publication is active. Displays the Relative Deadline page. Reading order reversed Only available when Overrule Publication is active. Determines whether the pages in the issue overview are displayed in ascending or descending order. Deadlines Displays the Issue Deadlines page. Step 3. Enter a Name for the issue. Step 4. Enter a Publication Date for the issue by doing the following: a) In the date field, either manually enter a date or use the date picker to select a date from the calender. To open the date picker, click on the Date Picker icon. (See figure 5c on next page.) 95 Server The following table shows the properties that can be set: Property Chapter 08 Publication and workflow setup A B C A B C D D A A C C Date field Time field Date picker icon D Date picker B Info icon B Date picker icon Recalculate icon D Info icon Figure 5d. Entering a deadline for an issue Server Figure 5c. Selecting a date from the date picker The Recalculate icon is only meaningful if a deadline is entered. If a publication date is set, one can enter days/hours/minutes and after clicking the calculator icon the deadline is calculated. b) If required, also enter a time in the Time field. Step 5. Enter a Deadline for the issue by doing the following: a) To read additional information on setting deadlines, click the Info icon. b) In the date field, either manually enter a date or use the date picker to select a date from the calender. To open the date picker, click on the Date Picker icon. c) If required, also enter a time in the Time field. d) Click the Recalculate icon to calculate the time between the set Publication date for the issue and the entered deadline. Step 6. Press the Update button to create the issue. At the most basic level, only a name needs to be entered for creating an issue. All other options can also be set at a later stage. 96 Chapter 08 Publication and workflow setup Step 6. Creating sections As mentioned in Step 3: Setting up a publication, there are two types of publications: Periodic-oriented Publications and Project-oriented Publications. A For periodic-oriented publications you will create sections via the Publication maintenance page. For project-oriented publications, you will add sections via the Issue maintenance page. A Add section B B Reorder section Figure 6a. The section menu Since we are working with a newly created publication/issue, no sections exist yet. Step 2. Select Add. The Section Maintenance screen appears. A publication/issue needs to have at least one section. If no section is available, reporting will give unexpected results. Also the deadline functionality will not working properly. To create a new section, do the following: Step 1. For Periodic-oriented Publications: Open the Publication Maintenance page for the publication to which you want to add an issue and locate the Section menu. (See figure 6a on the next page) For Project-oriented Publications: Open the Issue Maintenance page for the issue to which you want to add a section and locate the Section menu. Figure 6b. The section maintenance page 97 Server To be able to create sections per issue, you need to enable the Overrule Publication option for that issue. (For more information, See Step 5: Creating an Issue.) Chapter 08 Publication and workflow setup Step 7. Creating editions Slight differences exist between a Section Maintenance page opened from the Publication Maintenance page compared to one opened from the Issue Maintenance page. The editions option allows the creation of different renditions of the same publication and works by combining content that is similar with content that in certain places differs. For instance, it is possible to assign either a complete page to one or more renditions, or only certain components of a page. Server The following table shows the properties that can be set: Property description Name Name of the section. Publication date Only available when accessed via Issue Maintenance page. Date when the issue needs to be published by. Description Description of the section. Pages Currently doesn't have a special meaning. Only available in case section is maintained via the Issue maintenance page. When outputting the publication, different renditions will be generated by combining only those parts of the publication that belong to the same edition. (See also Chapter 3: The concept.) To create a new edition, do the following: Step 1. Open the Publication Maintenance page for the publication to which you want to add an edition and locate the Edition menu. (See figure 7a.) Since we are working with a newly created publication, no editions exist yet. Step 3. Fill the relevant fields. Step 4. Press the Update button to create the section. At the most basic level, only a name needs to be entered for creating a section. All other options can also be set at a later stage. A A B Add edition B Reorder editions Figure 7a. The edition menu 98 Chapter 08 Publication and workflow setup Step 8. Setting up a workflow Editions can also be added via the Issue Maintenance page in case the 'Overrule Publication' option is used. Enterprise is a workflow-driven system and each file type within the workflow (such as a layout, article or image) needs to be given a workflow status. Step 2. Select New. The Edition Maintenance page appears. Each file type can have its own workflow (a set of statuses grouped together in a status list) that can be different per publication or even issue (for project oriented workflows). A typical status list for a file could for instance be First Draft, Second Draft, and Final Version. Figure 7b The edition maintenance page Step 3. Enter a name and description. Step 4. Press Update to create the edition. The Publication Maintenance page will appear with the newly created edition added to the edition menu. To be able to create statuses per issue, you need to enable the Overrule Publication option for that issue. (See Step 5: Creating an Issue for more information.) To create a new status list, do the following: Step 1. For Periodic-oriented Publications: Open the Publication Maintenance page for the 99 Server For periodic-oriented publications you will create a new status via the Publication maintenance page. For project-oriented publications, you will create a new status via the Issue maintenance page. Chapter 08 Publication and workflow setup Step 3. From the File Type drop-down list, select the file type for which a status list needs to be created. Select from the following types: publication to which you want to add an issue and locate the Workflow area. (See figure 8a.) For Project-oriented Publications: Open the Issue Maintenance page for the issue to which you want to add a section and locate the Workflow area. A Server A Since we are working with a newly created publication/issue, no workflows exist yet. Step 2. Select Add. The Workflow Maintenance page appears. A C description Article InCopy or other type of text article. Article Template InCopy document template. Layout InDesign documents. Layout Template InDesign document template. Image Images and graphs. Advert Reserved for future usage. Advert Template Reserved for future usage. Plan Plan object systems Audio Audio files. Video Video files. Library InDesign library files (.indl format) Dossier Enterprise dossiers. Add workflow Figure 8a. The workflow menu A File type B C from planning Update status B Add status File type drop-down list Step 4. Click the Add Status button. A new row of editable status fields appear. Figure 8b. The workflow maintenance page 100 Chapter 08 Publication and workflow setup Step 5. Set each property as required. The following table shows the properties that can be set: Property description Order Order in which the status needs to appear in the status list. Name Name for the status. Workflow status of an issue cannot be the same as the status of the same file type on publication level. In order to be able to select the Next Status, start with the very last status of the workflow (e.g. Final Version) and work your way backwards. This way, the next status is always available to choose from and prevents you from having to set this later. To set a status color, click on the Pick button to make the color palette appear and select any from the available colors. For layout statuses: a PDF (default), EPS or high-res JPG will be created (depending on the server configuration). Server Output For article statuses: an XML file of the composed text will be created (depending on the server configuration). For any other object types but Layout, the output option currently doesn’t have a special meaning. This can be used for integration purposes. Next Status Defines the next status after this status. Used for Send File To and Send File to Next options in the client interface. Color Color associated with this status as used by the client applications. Deadline Deadline specific for this status, relative to the deadline of the publication or issue the workflow is attached to. A A C B C Color palette B Selected color Color hexidecimal code Figure 8c. Selecting a color from the color palette Step 6. Add the status to the list by: a) Clicking the Add Status button. This will save the currently added status and automatically display a new row of status fields. b) Clicking the Update button. This will save the currently added status without displaying a 101 Chapter 08 Publication and workflow setup Step 9. Further setting up deadlines new row of status fields. Server Step 7. When finished, click the silver arrow to return to the publication or issue maintenance page where the new status lists are added to the workflow menu. Now that a publication has been fully set up and the necessary structure is in place, deadlines can be assigned in more detail. This is done by setting relative deadlines for editions, sections, statuses and section/status combinations. The aim of this is to finely control deadlines for each part of the publication structure. (For more information on the concept of deadlines, see Section 1.2.1: In Detail in Chapter 3: The Concept.) IMPORTANT: For the deadline functionality to function properly, it is imperative that the next sections are followed in order. Figure 8d. The newly created status lists added to the workflow menu 9.1 Defining relative deadlines To set up a relative deadline, do the following: Step 1. Open the Publication Maintenance page for the publication to which you want to set relative deadlines for. Step 2. Click on the Alarm Clock icon next to Time Settings. (See figure 9.1a on the next page.) 102 Chapter 08 Publication and workflow setup Step 3. For each of the sections on the page, set the required deadline: Relative deadlines of Editions A A Figure 9.1c Relative deadlines for editions Alarm clock icon Controls time before the issue deadline that each edition must be ready at. Figure 9.1a. The alarm clock icon The Relative Deadline page appears. Relative deadlines of Sections Figure 9.1d Relative deadlines for sections Controls the time before the issue deadline that each section must be ready at. Figure 9.1b The relative deadline page for a publication 103 Server In the example shown in figure 9.1c, three editions exist: Main, North and South. The North and South editions must be finished earlier because newspapers must be transported to the North and the South regions. So for Main, 1 hour is entered and for North and South 4 hours. Click the Update Editions button to store these values to the database. Chapter 08 Publication and workflow setup Relative deadlines of Section States In the scenario shown in figure 9.1d, all sections must be finished at a certain time and the front page is finished last. So 1 hour is entered for the front page and 4 hours for all other sections. This means that all sections except the front page must be finished 4 hours before the issue deadline. Click the Update Sections button to store these values to the database. Figure 9.1f Relative deadlines for sections/statuses Relative deadlines of Statuses Server Normally, the above information is enough to manage your deadlines but it may be that for certain sections certain states normally take longer. This section allows you to reserve more time for these states. Click the Update Sections/States button to recalculate these values from the Relative Deadlines of States table and to store the values to the database. This means that all section/state combinations are reset to their default value as defined in the states section. Figure 9.1e Relative deadlines for statuses Controls the time that each state is supposed to last. All states are categorized by workflow type and are ordered by their order in the list. The highest numbered order is supposed to be last, so the time needed for this state represents the time until section deadline. Finishing the definition You must have updated all these tables to have a complete definition. Ensure therefore to fill in the form from top to bottom. Click on ALL update buttons at least once to complete the definition. If you decide to add a section or state to the publication definition, keep in mind that you have to update the relative deadlines as well in order to have correctly working deadlines. When finished entering values, click the Update States button to store these values to the database. It is also possible to edit the relative deadlines of states in the states maintenance screen. 104 Chapter 08 Publication and workflow setup 9.2 Reviewing issue deadlines To review how all the various deadline settings affect a particular issue in a publication, the Issue Deadlines page can be viewed. Step 1. From the Publication Maintenance page, click on the name of an Issue to open the Issue Maintenance page. (See figure 9.2a.) Note that in this example, the issue deadline is set to August 24th at midnight (5 days before the publication date). Server Step 2. Click on the Alarm Clock icon. The Issues Deadlines page appears. (See figure 9.2b on the next page.) Note that it displays all the (relative) deadlines that have been set previously. A A Alarm clock icon Figure 9.2a The alarm clock icon 105 Server Chapter 08 Publication and workflow setup Figure 9.2b The issue deadlines page displays all the (relative) deadlines set 106 Chapter 08 Publication and workflow setup Step 10. Automatic routing routing when using one of the WebApps. But the group is not shown the moment you check in a layout or article on the client side. Enterprise allows you to route files to a particular user or group. When a user watches his/her Inbox, all files will be shown that are either routed to him/her or any of the groups he/she is a member of. To create new routing rules, do the following: Step 1. For Periodic-oriented Publications: Open the Publication Maintenance page for the publication to which you want to add routing rules and locate the Routing menu. (See figure 10a.) For Project-oriented Publications: Open the Issue Maintenance page for the issue to which you want to add routing rules and locate the Routing area. The automatic routing features allow you to setup routing to be applied automatically whenever a file reaches a particular status. This can be defined per section and/or status. Server For periodic-oriented publications you will create new routing rules via the Publication maintenance page. For project-oriented publications, you will create new routing rules via the Issue maintenance page. To be able to create routing rules per issue, you need to enable the Overrule Publication option for that issue. (For more information, see Step 5: Creating an Issue.) A A Add routing rules Figure 10a. The routing menu Not all groups can be used for routing. Only groups with the Routing option enabled can be used for routing. (For more information, See Section 1: Creating Users and Groups.) Note that this restriction works on the client side but not on the server side. So if you have not enabled the option for a group you still can select the group for automatic Since we are working with a newly created publication/issue, no routing rules exist yet. Step 2. Select Add. The Routing Maintenance page appears. (See figure 10b. on the next page.) 107 Chapter 08 Publication and workflow setup a) Clicking the Add Routing button. This will save the currently added rule and automatically display a new row of rule fields. b) Clicking the Update button. This will save the currently added rule without displaying a new row of rule fields. A B C D E F Step 5. When finished, click the silver arrow to return to the publication or issue maintenance page where the rules are added to the routing menu. (See figure 10c where all articles with status Final Version are automatically routed to the Chief Editors group.) Display Section drop-down list B Update routing rules C Section drop-down list D Add routing rules E Status drop-down list F Route To drop-down list A Server Figure 10b. The routing maintenance page The following table shows the properties that can be set: Property description Section (top Filters the page to only show routing d ro p - d o w n rules for selected section. Set to All to list) show all sections. Section Select the section to which the rules needs to apply. Status Select an combination. Route To Select the group to which object needs to be routed to when status is reached object Figure 10c. The newly created routing rules added to the routing menu type/status Step 3. Set each property as required. Step 4. Add the routing rules by: 108 Chapter 08 Publication and workflow setup Step 11. Controlling user authorizations menu. (See figure 11a.) For Project-oriented Publications: Open the Issue Maintenance page for the issue to which you want to add routing rules and locate the User Authorizations. menu. Authorizations to the files of your publication as well as access to the web applications are set with a number of authorization rules. Each rule defines the authorizations for a user group which can be set specific per section and/or workflow status. For periodic-oriented publications you will create authorization rules via the Publication maintenance page. For project-oriented publications, you will create authorization rules via the Issue maintenance page. A A B Add user authorizations B Create report Since we are working with a newly created publication/issue, no authorization rules exist yet. Step 2. Select Add. The Authorization Maintenance page appears. (See figure 11b on the next page.) As the first step in setting up your authorizations, we strongly advise to analyze your workflow, user groups and the required access control on paper. To create new authorization rules, do the following: Step 1. For Periodic-oriented Publications: Open the Publication Maintenance page for the publication to which you want to add routing rules and locate the User Authorizations 109 Server Figure 11a. The user authorizations menu To be able to create authorization rules per issue, you need to enable the Overrule Publication option for that issue. (For more information, see Step 5: Creating an Issue.) Chapter 08 Publication and workflow setup This will save the currently added rule and automatically display a new row of rule fields. b) Clicking the Update button. This will save the currently added rule without displaying a new row of rule fields. A B A C Step 5. When finished, click the silver arrow to return to the publication or issue maintenance page where the rules are added to the routing menu. (See figure 11c.) C Group drop-down list B Update button Add authorization button Server Figure 11b. The authorization maintenance page Step 3. From the Group drop-down list, select the group for which authorization rules need to be created. Editable fields appear for setting up the rule. Figure 11c. The newly created authorization rules added to the user authorizations menu Select from the following properties: Property description Section Select from All sections or a specific section. Status Select from All object type/status combinations or a specific object type/status combination. Profile Select an Access Profile Users can be assigned to multiple user groups. Using this efficiently, it minimizes the number of authorization rules you need and thereby easing up the setup and maintenance. Introducing a user group like All or All for <my pub> allows you to set some generic access control like View and/or Read rights for everybody involved with the publication. This again minimizes the number of authorization rules. Step 4. Add the authorization rule by: a) Clicking the Add Authorization button. 110 Chapter 08 Publication and workflow setup Step 12. Final settings Because of this, it is good practice to grant everybody working within a publication Read access rights to every file in order to make sure that the system can access files if needed. The View access can subsequently be used to determine which files are shown to the user. Without the View access, the user won’t see a file and thus cannot open it. To finish setting up the publication, return to the Publication Maintenance page and in the Current Issue drop-down menu, select the issue that needs to be set as such (i.e. the issue that will be published next). Note also that the Previous Issue and Next Issue options are controlled by Enterprise itself and is based on the order of the issues as set on the Publication Maintenance page. (For more information on the Profiles that are assigned, see Step 2: Setting Up Access Profiles.) 111 Server When multiple Issues are set up and the Current Issue option is being used, it is imperative that an order sequence is truly specified. If this is not done (or not done correctly), Enterprise may not be able to properly determine the Previous and Next issues. (For more information on ordering issues, See Section B2.2 Reordering issues.) Chapter 08 Publication and workflow setup B1. Publications Section B. Additional maintenance Server This section describes all tasks that can be performed for each item listed in the Maintenance menu. In case a task has already been discussed in Section A, it will refer to that section. B1. Publications B11. User B2. Issues B12. Meta data B3. Editions B13. Dialog setup B4. Sections B14. Named query B5. Workflow B15. User query B6. Routing rules B16. Clean up B7. User authorizations B17. Log B8. Admin authorizations B18. Online users B9. Access Profiles B19. MadeToPrint B10. Group B20. Licensing This section describes all available tasks for managing publications and their components. Via the Publication Overview page, publications can be created, copied and reordered. A B A C E C D E F Created publications B Create new publication Copy publication D Reorder publications Number of issues in publication F Publication order Figure B1. The publication menu B1.1 Creating a publication See Section A: Step 3.1 Creating your Publication. 112 Chapter 08 Publication and workflow setup B1.2 Copying a publication The new publication will have the same sections, workflow, issues (if Duplicate Issues was selected), authorization rules, meta data and dialog setup as defined for the source publication. Copying a publication can be useful when the new publication is identical (or in most parts similar) to an already existing publication. This saves time in setting up a new publication. To copy a publication, do the following: Step 1. On the Publication Overview page, select Copy. The Duplicate publication page appears. Server Figure B1.2 The duplicate publication page Step 2. From the Source Publication dropdown menu, select the publication to copy. Step 3. In case the Issues of the copied publication also need to be copied over, check the Duplicate Issues check box. Step 4. In the New Publication field, enter a name for the new publication. Step 5. Click the Copy button to copy the publication. The Publication Overview page appears again with the newly created publication listed. 113 Chapter 08 Publication and workflow setup B1.3 Reordering publications The Publication Maintenance page contains options to update/edit and delete publications. The list of publications as shown on the Publication Overview page can be sorted in any order by numbering each publication. The way the list is sorted is also the way lists of publications appear in the client interface. To reorder a list of publications, do the following: Server Step 1. On the Publication Overview page, enter a number in the order field for each publication. The higher the number, the lower the publication will end up on the list. A A Step 2. Press the Reorder button. The list is sorted in descending order. B Update publication A Delete publication Figure B1.3 The publication maintenance page 114 Chapter 08 Publication and workflow setup B1.4 Editing a publication B1.5 Deleting a publication To edit a publication, do the following: To delete a publication, do the following: Step 1. Change any of the properties that need to be changed: name, email notifications, description, reading order reversed, current issue and time settings. Step 1. On the Publication Overview page, click on the publication that needs to be deleted. The Publication Maintenance page appears. Step 2. Press the Delete button. A dialog appears to confirm deletion of the publication. Step 2. Press the Update button to save the changes. Step 3. Do one of the following: a) Press the OK button to delete the publication. The publication is deleted and the Publication Overview page appears again. or b) Press Cancel to return to the Publication Maintenance page without deleting the publication. 115 Server Figure B1.5 The confirm deleting a publication dialog Chapter 08 Publication and workflow setup B2.2 Reordering issues B2. Issues This section describes all available tasks for managing issues. The list of issues as shown on the Publication Maintenance page can be sorted in any order by numbering each publication. The way the list is sorted is also the way lists of issues appear in the client interface and is used by Enterprise to determine the Previous Issue and Next Issue when a Current Issue is selected from the Current Issue drop-down list. Via the Issue Menu on the Publication Maintenance page, issues can be created, reordered and deleted. Server To reorder a list of issues, do the following: A A D B C Add issue B Reorder issues Delete issue Step 1. Enter a number in the order field for each issue. The higher the number, the lower the issue will end up on the list. D C Step 2. Press the Reorder button. The list is sorted in descending order. Order field Figure B2. The issue menu When multiple Issues are set up and the Current Issue option is being used, it is imperative that an order sequence is truly specified. If this is not done (or not done correctly), Enterprise may not be able to properly determine the Previous and Next issues. B2.1 Adding an issue See Section A: Step 5 Creating an Issue. 116 Chapter 08 Publication and workflow setup B2.3 Deleting issues To delete an issue, do the following: Step 1. Press the Delete Issue icon. A dialog appears to confirm deletion of the issue. A B C D E F A Show file details B Delete file C Publication dropdown list D Delete file info E Issue drop-down list F File type list Figure B2.3b The remove issue page Figure B2.3a The confirm deleting an issue dialog The issue cannot be deleted before the stored files are first removed or transferred to another issue. or To do this, proceed as follows: b) Press the OK button to delete the issue. 2a. Review the Delete File Info section to verify the number and type of files that are flagged to be deleted. Two scenarios exist: 1) The Issue does not contain any stored files: the issue is deleted and the publication maintenance page is displayed again. 2b. To review more detailed info about these files, press the Show icon. The following section will appear: (See next page.) 2) The issue contains stored files: the Remove Issue page appears. 117 Server Step 2. Do one of the following: a) Press Cancel to return to the Publication Maintenance page without deleting the issue. Chapter 08 Publication and workflow setup Figure B2.3d The confirm deleting issue files dialog Figure B2.3c More detailed info appears after clicking the Show icon The files aren’t actually deleted, but moved to the Trash Can. See Section B16: Clean Up. 2c. If a file needs to be moved to a different issue instead of being deleted, click the Move button. In the drop-down list that becomes available next to it, select the issue to which the file needs to be moved to. 2f) Press Cancel to return to the Remove Issue page without deleting/moving the files. Server or Press OK to delete and/or move the selected files. A dialog appears to inform you that the issue has been successfully deleted. Figure B2.3d Selecting the Move button enables the dropdown list to select an issue 2d) When finished, press the Delete icon. Figure B2.3e The issue has been successfully deleted 2e) A dialog appears asking you to confirm deletion of the files. (See figure B2.3d.) The files aren’t actually deleted, but moved to the Trash Can. See Section B16: Clean Up. 118 Chapter 08 Publication and workflow setup B2.5 Copying an issue The Issue Maintenance page contains options to update/edit and to copy an issue. To copy an existing issue, do the following: Step 1. Open the Issue Maintenance page for the issue that needs to be copied. Step 2. Press the Copy button. The Duplicate Issue page appears. A Update issue B B Copy issue Figure 2.5 The duplicate issue page Figure B2.3f. The issue maintenance page Step 3. Enter a name for the new issue. B2.4 Editing an issue Step 4. Press the Duplicate button. The Issue Maintenance page appears for the new issue showing the settings that have been inherited from the source issue. To edit an issue, do the following: Step 1. Change any of the properties that need to be changed: name, publication date, deadline, expected pages subject, description, active, overrule publication and time settings. Step 5. Make any changes and press the Update button to save these changes. Step 6. Press the silver arrow to return to the Publication Maintenance page. Step 2. Press the Update button to save the changes. 119 Server A Chapter 08 Publication and workflow setup B3.2 Reordering editions B3. Editions This section describes all available tasks for managing editions. The list of editions as shown on the Publication Maintenance page can be sorted in any order by numbering each edition. The way the list is sorted is also the way lists of editions appear in the client interface. Via the Edition Menu on the Publication Maintenance page, editions can be created, reordered and deleted. To reorder a list of editions, do the following: Step 1. Enter a number in the order field for each edition. The higher the number, the lower the edition will end up on the list. Server Step 2. Press the Reorder button. The list is sorted in descending order A A D B C Add edition B Reorder editions Delete editon D C Order field Figure B3. The editon menu B3.1 Adding an edition See Section A: Step 7 Creating Editions. 120 Chapter 08 Publication and workflow setup B3.3 Deleting editions The Edition Maintenance page contains options to update/edit an edition. To delete an edition, do the following: Step 1. Press the Delete Edition icon. A dialog appears to confirm deletion of the edition. A A Update edition Figure B3.3a The confirm deleting an edition dialog Figure B3a. The edition maintenance page B3.4 Editing an edition or To edit an edition, do the following: b) Press the OK button to delete the edition. Step 1. Change any of the properties that need to be changed: name and description. Step 2. Press the Update button to save the changes. 121 Server Step 2. Do one of the following: a) Press Cancel to return to the Publication Maintenance page without deleting the edition. Chapter 08 Publication and workflow setup B4.2 Reordering sections B4. Sections This section describes all available tasks for managing sections. The list of sections as shown on the Publication Maintenance page can be sorted in any order by numbering each section. The way the list is sorted is also the way lists of sections appear in the client interface. Via the Section Menu on the Publication Maintenance page, sections can be created, reordered and deleted. To reorder a list of sections, do the following: Step 1. Enter a number in the order field for each section. The higher the number, the lower the section will end up on the list. Server Step 2. Press the Reorder button. The list is sorted in descending order A A D B C Add section B Reorder sections Delete section D C Order field Figure B4. The section menu B4.1 Adding a section See Section A: Step 6 Creating Sections. 122 Chapter 08 Publication and workflow setup B4.3 Deleting sections To delete a section, do the following: Step 1. Press the Delete Section icon. A dialog appears to confirm deletion of the section. A A Update section Figure B4a. The section maintenance page Figure B4.3a The confirm deleting a section dialog B4.4 Editing a section To edit a section, do the following: Step 1. Change any of the properties that need to be changed: name and description. or Step 2. Press the Update button to save the changes. b) Press the OK button to delete the section. The Section Maintenance page contains options to update/edit a section. 123 Server Step 2. Do one of the following: a) Press Cancel to return to the Publication Maintenance page without deleting the section. Chapter 08 Publication and workflow setup B5.1 Adding a workflow B5. Workflow This section describes all available tasks for managing workflows. See Section A: Step 8 Setting up a Workflow. Server Via the Workflow Menu on the Publication Maintenance page, workflows can be created. A A Add workflow Figure B5. The workflow menu 124 Chapter 08 Publication and workflow setup B5.3 Deleting workflow statuses The Workflow Maintenance page contains options to update/edit and delete workflow statuses. To delete a workflow status, do the following: Step 1. Press the Delete Workflow Status icon. A dialog appears to confirm deletion of the workflow status. A A C B C Update workflow B Add status Delete workflow status Figure B5.1 The workflow maintenance page Figure 5.3 The confirm deleting a workflow status dialog Step 2. Do one of the following: a) Press Cancel to return to the Workflow Maintenance page without deleting the workflow status. To edit a workflow status, do the following: Step 1. Change any of the properties that need to be changed: order, status, output, color and deadline. or b) Press the OK button to delete the workflow. Step 2. Press the Update button to save the changes. 125 Server B5.2 Editing a workflow status Chapter 08 Publication and workflow setup B6.1 Adding routing rules B6. Routing rules This section describes all available tasks for managing routing rules. See Section A: Step 10 Automatic routing. The Routing Maintenance page contains options to update/edit and delete routing rules. Via the Routing Menu on the Publication Maintenance page, routing rules can be added. Server A A A Add routing rules A Figure B6. The routing menu C B Update routing rules Delete routing rules C B Add routing rules Figure B6.1 The routing maintenance page 126 Chapter 08 Publication and workflow setup B6.2 Editing routing rules B6.3 Deleting routing rules To edit a routing rule, do the following: To delete a routing rule, do the following: Step 1. Change any of the properties that need to be changed: file type/status combination, route to group. Step 1. Press the Delete Routing Rule icon. A dialog appears to confirm deletion of the routing rule. Step 2. Press the Update button to save the changes. Figure B6.3 The confirm deleting a routing rule dialog or b) Press the OK button to delete the routing rule. 127 Server Step 2. Do one of the following: a) Press Cancel to return to the Workflow Maintenance page without deleting the routing rule. Chapter 08 Publication and workflow setup B7.2 Creating a user authorization report B7. User authorizations This section describes all available tasks for managing user authorizations. To create a user authorization report, do the following: Step 1. Press the Create Report icon. The User Authorizations Report page appears, showing all user authorizations per user group. Via the User Authorizations Menu on the Publication Maintenance page, user authorizations can be added or a report can be created. Server A A A A C B C B7.1 Adding user authorizations Step 11 Controlling B Group overview Step 2. To print the page, press the Print this Page button. Figure B7. The user authorizations menu A: Print This Page button Figure B7.2 The user authorizations report Add user authorizations B Create report Delete user authorizations See Section Authorizations. B User 128 Chapter 08 Publication and workflow setup B7.3 Deleting user authorizations The Authorization Maintenance page contains options to add, update/edit and delete user authorization rules. To delete a user authorizations, do the following: Step 1. Press the Delete user authorizations icon. A dialog appears to confirm deletion of the user authorizations. A A C Figure B7.3 The confirm deleting a user authorization dialog B Update routing rules Delete routing rules C B Add routing rules or b) Press the OK button to delete the user authorization. 129 Server Figure B7a. The authorization maintenance page Step 2. Do one of the following: a) Press Cancel to return to the Workflow Maintenance page without deleting the user authorization. Chapter 08 Publication and workflow setup B7.4 Editing user authorization rules B7.5 Deleting user authorization rules To edit a user authorization rule, do the following: To delete a user authorization rule, do the following: Step 1. Change any of the properties that need to be changed: section, status and profile. Step 1. Press the Delete Authorization Rule icon. A dialog appears to confirm deletion of the authorization rule. Step 2. Press the Update button to save the changes. Server Figure 7.5 The confirm deleting a user authorization rule dialog Step 2. Do one of the following: a) Press Cancel to return to the Authorization Maintenance page without deleting the routing rule. or b) Press the OK button to delete the user authorization rule. 130 Chapter 08 Publication and workflow setup B8.1 Adding admin authorizations B8. Admin authorizations This section describes all available tasks for managing admin authorizations. To add a user group to the admin list, do the following: Via the Admin Authorizations Menu on the Publication Maintenance page, admin authorizations can be added and deleted. Step 1. Press the Add icon. The Grant Admin Rights page appears. A A B A Add admin authorizations authorizations B Add authorization button B Group drop-down list Figure B8.1 The authorization maintenance page Delete admin Figure B8. The user authorizations menu Step 2. From the Group drop-down list, select the user group that needs to be added. Step 3. Click the Add button. The group is added to the list and you are returned to the Publication Maintenance page. 131 Server A B Chapter 08 Publication and workflow setup B8.2 Deleting admin authorizations B9. Access profiles To delete an admin authorization, do the following: This section describes all available tasks for managing access profiles. Step 1. Press the Delete Admin Authorization icon. A dialog appears to confirm deletion of the admin authorization. Via the Profile Overview page, access profiles can be created and reordered. A Server Figure B8.2 The confirm deleting an admin authorization dialog B Step 2. Do one of the following: a) Press Cancel to return to the Authorization Maintenance page without deleting the admin authorization. C D E A Created profile B Create new profile C Reorder profiles D Order entry field E Description Figure B9. The profile overview page or B9.1 Creating access profiles b) Press the OK button to delete the admin authorization. See Section A: Step 2 Setting up Access Profiles. 132 Chapter 08 Publication and workflow setup B9.2 Reordering access profiles B9.3 Deleting access profiles Access profiles can be deleted via the Profile Maintenance page, by doing the following: The list of access profiles as shown on the Profile Overview page can be sorted in any order by numbering each profile. To reorder the list of profiles, do the following: Step 1. On the Profile Overview page, click on the Access Profile that needs to be deleted. The Profile Maintenance page appears. Step 1. Enter a number in the order field for each profile. The higher the number, the lower the profile will end up on the list. Step 2. At the bottom of the page, press the Delete button. A dialog appears to confirm deletion of the profile. Step 2. Press the Reorder button. The list is sorted in descending order. Server Figure B9.3 The confirm deleting an access profile dialog Step 3. Do one of the following: a) Press Cancel to return to the Profile Maintenance page without deleting the Profile. or b) Press the OK button to delete the access profile. 133 Chapter 08 Publication and workflow setup B10.2 Copying groups B10. Groups This section describes all available tasks for managing groups. To copy a group, do the following: Step 1. Press Copy Group. The Duplicate Group page appears. Via the Overview of Groups page, groups can be created and copied. A B C D A B C D A Source group drop-down list B New group dropdown list C Description D Copy Group button E Figure B10.2a The authorization maintenance page Created group B Create new group D Admin and/or routing rights applied users in group Server A C E Copy group Number of Step 2. From the Source Group drop-down list, select the group which needs to be copied. Figure B10. The groups overview page Step 3. In the New Group Name field, enter a name for the new group. B10.1 Creating groups Step 4. In the Description field, enter a description. See Section A: Step 1.2 Creating Groups. Step 5. Press the Copy Group button to copy the group. A dialog appears confirming that the group has been copied and the Overview of Groups page appears again. (See figure B10.2b on the next page.) 134 Chapter 08 Publication and workflow setup B10.3 Adding a user to a group See Section A: Step 1.2.1 Adding a user to a group. B10.4 Editing a group Figure B10.2b The group copied dialog To edit a group, do the following: The Group Maintenance page contains options to update/edit and delete groups as well as the option to add users to the group. Step 1. Change any of the properties that need to be changed: name, description, admin option and routing option. A B C A C Add user to group Delete group B Update group Figure B10b. The group maintenance page 135 Server Step 2. Press the Update button to save the changes. Chapter 08 Publication and workflow setup B10.5 Deleting a group B11. Users To delete a group, do the following: This section describes all available tasks for managing users. Step 1. Press the Delete Group button. A dialog appears to confirm deletion of the group. Via the Overview of Users page, users can be created and copied. A B Server Figure B10.5 The confirm deleting a group dialog C D E F G H Created user B Create new user C Copy user Full name E email address user F Language setting G User color H User deactivated A Step 2. Do one of the following: a) Press Cancel to return to the Group Maintenance page without deleting the group. D Figure B11. The users overview page or B11.1 Creating users b) Press the OK button to delete the group. See Section A: Step 1.1 Creating Users. 136 Chapter 08 Publication and workflow setup B11.2 Copying users To copy a user, do the following: Step 1. Press Copy User. The Duplicate User page appears. Figure B11.2b The user copied dialog A The User Maintenance page contains options to update/edit and delete users as well as the option to add users to a group. B Source user drop-down list B Server A Copy User button Figure B11.2a The authorization maintenance page Step 2. From the Source User drop-down list, select the user that needs to be copied. A B Step 3. In the User Property field, enter a user name, full name, password and email address for the new user. C Step 4. Press the Copy User button to copy the user. A dialog appears confirming that the group has been copied and the Overview of Groups page appears again. (See figure B11.2b) A C Update user B Delete user Add user to a group Figure B11b. The user maintenance page 137 Chapter 08 Publication and workflow setup B11.3 Editing a user B11.4 Deleting a user To edit a user, do the following: To delete a user, do the following: Step 1. Change any of the properties that need to be changed: user name, full name, deactivated option, passwords, user cannot change password option, password expiration in days option, valid from option, valid till option, email, send email notification options, language and color. Step 1. Press the Delete User button. A dialog appears to confirm deletion of the user. Figure B11.4 The confirm deleting a user dialog Step 2. Press the Update button to save the changes. Server Step 2. Do one of the following: a) Press Cancel to return to the User Maintenance page without deleting the user. or b) Press the OK button to delete the user. B11.5 Adding a user to a group See Section A: Step 1.2.1 Adding a User to a Group. 138 Chapter 08 Publication and workflow setup B12.1 Filtering the page B12. Meta data This section describes all available tasks for managing meta data. The top of the page contains four options for filtering the available meta data items: Via the Meta Data page, meta data items can be created or edited. Publication A Filter option description <All> All publications Publication name Filter by selected publication B C Page filtering options B Meta data items Add custom property button Figure B12. The meta data page Property The meta data page is divided into three sections: the top of the page allows you to filter the page to show only those items that you are after, the middle section of the page shows the meta data items found based on the selected filter and the bottom of the page contains the option to create new meta data items. 139 Property description All properties Display all properties. Static Core system properties that are required for most operations. Dynamic Known system properties maintained by the system. Server A C Type Filter on file type: article, article template, layout, layout template, image, advert, advert template, plan, audio, video, library, dossier. Server Chapter 08 Publication and workflow setup Property description XMP Properties that are synchronized by the system with Adobe XMP meta data as stored inside Adobe files. (For a full overview of how the XMP properties are mapped to the database fields, see Appendix A: Meta Data Properties.) Custom Custom made properties. Sort on group Displays only those items that have a Group set and sorts them alphabetically by group. B12.2 Displayed meta data items The middle section of the page displays the available meta data items based on the applied filter. It displays the following data: Custom Custom properties that have been created will show up here by publication and file type. When clicking on an item, the page will be filtered to show all items for that publication and file type, including any created custom properties. Data description Name Name of the property Display name Display name (name as shown in the interface) Group Specified group Type Property type By clicking on the property name, the property details page is opened. Through this page, the property can be updated or (in case of custom properties) deleted. (See sections B12.3 Creating a Custom Property and section B12.4 Editing a Meta Data Item.) The way the page is filtered also determines to which publication and type any newly created custom property will belong to. For example: when clicking the Add Custom Property button whilst the page is filtered to publication ‘WW News’ and file type ‘article’, the newly created custom property will only be active for articles that are part of the WW News publication. 140 Chapter 08 Publication and workflow setup B12.3 Creating a custom property To create a custom property, do the following: Step 1. Filter the page to a publication/file type combination to make the custom meta data item publication/file type dependent or filter the page to display all publications and all file types. (The latter is the recommended method. If custom meta data items need to be made publication/file type dependent, this can be better done through the Dialog Setup page.) Figure 12.3a The custom property page description Name Property name. Should not contain any spaces and may not start with a number. Valid characters: a-z, A-Z, 0-9 or _. Display name Name used for displaying the property in the client interface Group When filled, the property will be shown in workflow dialogs on a separate tab control. If left blank they will be placed on the General tab Type String—any sequence of characters Multistring— to be used for keywords Multiline—input can be displayed on multiple lines Boolean—True of False Integer—whole numbers Double— decimal numbers e.g. 1.56. Date—date Datetime—date and time List—drop-down list Multilist—list box Default value Default property value Value list List of values that a list or drop-down list should hold Min value The minimum value. Used for numeric values. Max value The maximum value. Used for numeric values. Max length The maximum length that the value can have. Used for strings. Step 3. Press Update to add the custom The following table shows the properties that can be set. 141 Server Step 2. At the bottom of the Meta Data page, click on Add Custom Property. The Custom Property page will appear. Property Chapter 08 Publication and workflow setup property to the system. The Meta Data page displays again. Figures 12.3b and 12.3c show examples of how the different types eventually display in the client (in these examples in the Check In dialog). Figure 12.3a shows the items when displayed on the General tab (this is done by leaving the Category field blank) and figure 12.3b shows the items when Grouped Tab is entered in the Group field. Server Figure 12.3c Custom meta data added to a separate tab of the check in dialog To actually make meta data items appear in the client interface, they need to be used in a dialog setup. (For more information, see Section B13 Dialog Setup.) See also Section G1: Upgrading Custom Properties in Chapter 6: Server Installation. Figure 12.3b Custom meta data added to the General tab of the check in dialog 142 Chapter 08 Publication and workflow setup B12.4 Editing a meta data item Editing display names allows you to use other terms for the static properties Publication, Issue and Section, such as Program, Book and Chapter. To edit a meta data item, do the following: Step 1. On the Meta Data page, click on the name of the meta data item. The Property page for that item will appear. Depending on the type of item, the following properties can be edited: B12.5 Deleting a meta data item Only custom meta data items can be fully removed from the system. The other meta data types static, dynamic and XMP can only be cleared of any additionally entered data to bring them back to the default state. Item type editable properties Display name Dynamic Display name, category, default value, value list XMP Display name, category, default value, value list Custom Display name, category, type, default value, value list, min value, max value, max length To delete or clear a meta data item, do the following: Step 1. On the Meta Data page, click on the name of the meta data item. The Property page for that item will appear. Step 2. Do one of the following: To clear a static, dynamic or XMP meta data item, press the Clear button. To delete a custom meta data item, press the Delete button. Figure B12.4 The static property edit page Step 2. After making the required changes, press the Update button. The Meta Data page will display again. 143 Server Static Chapter 08 Publication and workflow setup B13.1 Creating a dialog or query setup B13. Dialog setup This section describes all available tasks for managing workflow dialogs and query setups. By creating a workflow dialog setup or a query setup, meta data property fields can be displayed at various places in the client interface (either web, InDesign, InCopy or Smart Browser). Via the Dialog Setup page, dialog setups and query setups can be created or edited. The following table shows for each action that can be selected, in which workflow dialog the meta data will appear and the action required for bringing up that dialog in the client: A B Server C D E Page filtering options B Created query groups Update button D Legend E Add action property button A C Figure B13. The dialog setup page Action workflow dialog menu action Send To Send File To Send File to Copy To Copy File To Copy File to Create Save As, Create Article Save As, Save Version, Create Article, Create Article from Layer, Create Article from Document Check In Check In Check In Set Properties Properties Properties For an overview of how the meta data fields in these workflow dialogs look like, see Section B12.3 Creating a Custom Property. 144 Chapter 08 Publication and workflow setup Apart from the workflow dialog, the user query dialog is also populated by meta data fields, as well as the query/browse option in the web client. The following table shows how query meta data can be controlled in the various clients: displays appears in Query Parameters Possible parameters for creating user queries (InDesign, InCopy) InDesign and InCopy Query dialog Query result columns Returned columns for user queries InDesign and InCopy Smart Connection palette Query result columns web Returned columns for user queries in web client Query/Browse page web client Query result columns InDesign Returned columns for user queries in InDesign InDesign Smart Connection palette Query result columns InCopy Returned columns for user queries in web client InCopy Smart Connection palette Query result columns Smart Browser Returned columns for user queries in Smart Browser Smart Browser Smart Connection palette Step 1. Filter the Dialog Setup page to a publication/file type combination to make the setup publication/file type dependent or filter the page to display all publications and all file types so that the setup applies to all workflow and query dialogs. Step 2. Click the Add Action Property button. A new section appears above the buttons for setting the meta data property settings. Server Action To create a dialog setup, do the following: Figure B13.1a The meta data property settings appear after clicking the Add Action Property button The following meta data properties can be set: 145 Property description Group Group (if any). Not editable. Order Order in which meta data should appear in client interface Chapter 08 Publication and workflow setup Property description Property Select meta data property. Unused custom made properties are listed first, preceded by an asterisk (*)1 Editable Select if meta data should be editable by user2 Mandatory Select if meta data should be mandatory2 Restricted Select if user is not allowed to modify meta data2 cannot be edited (this is because the character count value is provided by the system and should not be entered manually). See Appendix B: The Action Property list See Section B13.2 Restricted Meta Data 1 Figure B13.1b A lock icon is displayed when the system automatically sets the editable setting 2 In the Custom section of the page, a publication/ file type/action group is displayed to indicate that at least one action property has been added to that combination. Server Step 3. Set the required meta data settings. Step 4. Do one of the following: To add the action property without adding another one, press the Update button. A To add the action property and display a new set of property settings for adding another action property, press the Add Action Property button. B C The created action property is displayed in the section above the Add Action Property button. Take note of the settings that are shown for that action since they may hold additional information. For instance, when adding the Character Count property, the editable setting is automatically selected and a lock icon is displayed to indicate that this option The selected publication/file type/action combination A displayed custom group indicates that at least one action property exists for this group C The created action property A B Figure B13.1c A custom group is displayed after adding an action property 146 Chapter 08 Publication and workflow setup Restricted When checked, only users that have the option ‘Change Restricted Properties’ selected in their Access Profile are allowed to edit the field. For all other users the field will behave as an uneditable field and will appear grayed-out. When not checked, the setting of the ‘Change Restricted Properties’ option in the user’s Access Profile is not taken into account. B13.2 Restricted meta data When adding an action property, the way that meta data field interacts with the user can be controlled via three check boxes: Editable, Mandatory and Restricted. The working of each interaction is as follows: Editable When checked, the user will be able to edit the content of the field, for instance by editing the default value or by entering a new value. When not checked, the field will appear grayed out and will not be editable by the user. This can be used for instance when a default value is given for a meta data field that should not be changed. Note that not all combinations of setting these three options can be used. For instance: making a field mandatory but not editable is illogical if no default value is given. Mandatory When checked, the user is required to enter a value in the field. If no value is entered and the user attempts to go to the next step of the process (e.g. by clicking an OK button in the dialog), the user is prompted that a value is required for that field. When not checked, the field can be left blank by the user. 147 Server For an overview of the combinations that can be used, see the table B13.2 on the next page. Chapter 08 Publication and workflow setup 1 Editable Mandatory selected selected Restricted not selected comments Correct. It is good practice to make a field editable when also making it mandatory. Alternatively, see combination 3. 2 selected not selected selected Not logical. By setting Restricted, all users who do not have the option ‘Change Restricted Properties’ selected won’t be able to edit the field, even when Editable is selected. It would suffice to just use Restricted. 3 not selected selected selected Correct, but only if a default value is given. 4 selected selected selected Not logical. See combination 2. In this scenario, it would be better to use combination 3. Server Table B13.2 An overview of the restricted meta data combinations B13.3 Editing a dialog setup B13.4 Deleting a dialog setup To edit a dialog setup, do the following: To delete a dialog setup or a property that is part of the setup, do the following: Step 1. In the Custom section on the Dialog Setup page, select the publication/file type group that needs to be edited. The properties that are part of the group appear on screen. Step 2. Make the required changes. Step 1. In the Custom section on the Dialog Setup page, select the publication/file type group that needs to be deleted either completely or partly. The properties that make up the group appear on screen. Step 3. Press the Update button. Step 2. Delete a property by pressing Delete. Step 3. To delete the whole group, delete all listed properties. 148 Chapter 08 Publication and workflow setup B14.1 Creating a named query B14. Named queries This section describes all available tasks for managing named queries. To create a named query, do the following: Step 1. On the Overview of Queries page, click the New Query button. The Named Queries page appears. Named queries show up in the user’s query palette and will execute an SQL statement that is defined as part of the named query definition. It is also possible to define parameters for a named query which translate to input fields that the user can fill in. Via the Overview of Queries page, queries can be created or edited. A A B SQL statement fields B update button Figure B14.1. The named queries page A Created queries B Create new query button The following properties can be set: Query—Name as shown to the user. Figure B14. The overview of queries page Comment—Optional administrator comment about the query. Interface—List of parameters for the query. Each parameter must start on a new line respecting the following syntax: <name>,<type> [,<default>] [,<list entries>] 149 Server B A Chapter 08 Publication and workflow setup Server The following table shows how each parameter is used: parameter description name Mandatory. Name of parameter. Displayed as pop-up help for the input field in InDesign/InCopy palette. type Mandatory. Data type of parameter. Must be one of the following: string | bool | int | list default Optional. Initial value of parameter. Automatically filled in the first time user selects this named query. list entries The first three columns returned should always be object id, object type, object name and object format. This is required to make the client applications work properly. To support status colors and automatic updating of column fields, your query also needs to return PublicationId, IssueId, SectionId and StateId. Normally these are returned as the last columns. Step 2. Press the Update button to add the query to the system. The Overview of Queries page appears again. Optional. Entries listed in combo box to allow user select one. Each entry must be separated using slashes ( / ). While working on your named queries we recommend to first make sure that the SQL is correct by executing the SQL, for example with phpMyAdmin. Only used when type=list. When no default is set, the first entry is preselected. SQL—The SQL statement for this named query. The parameters can be used inside the SQL with $<parametername>. For string values this needs to be surrounded with ". The name of the user executing the query can be used in the SQL statement as "$user". Newly created named queries will only be available to a user when he/she logs out and logs back in to the system. However, changes in the SQL section do NOT require a re-logon, since all the clients know about is the list of named queries and their parameters. For examples of named queries, see Appendix C: Named Query Examples. 150 Chapter 08 Publication and workflow setup B14.2 Editing a named query B14.3 Deleting a named query To edit a named query, do the following: To delete a named query, do the following: Step 1. On the Overview of Queries page, click on the name of the query that needs to be edited. The Named Queries page appears. Step 1. On the Overview of Queries page, click on the name of the query that needs to be deleted. The Named Queries page appears. Step 2. Make any changes as required. Step 2. Press the Delete button. A dialog appears to confirm deletion of the named query. Step 3. When finished, press the Update button. The Overview of Queries page appears again. Server Changes in the SQL section do NOT require a re-logon by the users of the client applications, since all the clients know about is the list of named queries and their parameters. Figure B14.3 The confirm deleting a named query dialog Step 3. Do one of the following: a) Press Cancel to return to the Named Query page without deleting the query. or b) Press the OK button to delete the named query and return to the Overview of Queries page. 151 Chapter 08 Publication and workflow setup B15. User queries To share a query with other users or groups, do the following: This section describes all available tasks for managing user queries. Step 1. From the User drop-down list, select the user from whom you want to share queries from. Whenever a user creates a custom query in the client application, this query is saved to the database during log-off. It is then possible to share this query with other users or groups. Step 2. In the Queries section, the custom queries that have been created by the selected user will appear. Select one or more queries that need to be shared. Server Via the User Queries page, user queries can be shared. Step 3. In the Destination section, select a combination of users and/or groups to which the query needs to be shared. A Step 4. Press the Submit button to share the query. A dialog will appear confirming that the query has been successfully copied. B C D E A D User drop-down list B User queries Groups E Submit button Figure B15b. The successfully copied query dialog C Users The query will be available to the users and/or groups the next time they log in. Figure B15a. The user queries page 152 Chapter 08 Publication and workflow setup B16.1 Remove by date B16. Clean up This section describes all available tasks for cleaning up files. The Remove by Date page is used to remove unused (not placed) articles and/or images within an issue that have been created before the entered date. Other file types cannot be removed via this page. Via the Clean Up page, files can be removed by date or issue, moved to another issue or they can be restored. It is also possible to empty the Trash Can. A To remove an article or image from an issue by date, do the following: B Step 1. Click on the Remove by Date icon on the Clean Up page. The Remove by Date page appears. Server A C A C D B C D Remove files by date B (Re)move files by issue Empty trash can by query D Empty trash can E F G H A Publication drop-down list B Find files C Info button D Additional info E Issue drop-downlist F Calender icon G Date field H Article check box I Image check box Figure B16a. The clean up page Figure B16.1a The remove by date page Step 2. Make a selection from the Publication and Issue drop-down lists from which the files need to be removed. 153 I Chapter 08 Publication and workflow setup Step 3. Enter a date in the date field, or click the Calender icon to select a date from the calender. Step 4. Select the article and/or image check box. The lower half of the page will automatically display the number of files found in the system by that type that are older than the specified date. (If the selections are made in a different order, press the Find button to run the query.) Figure B16.1d The confirm deleting a file dialog Do one of the following: 1) Press Cancel to return to the Remove by Date page without deleting the file(s). Server Figure B16.1b The page shows the number of files found based on the query or 2) Press the OK button to delete the file(s). Step 5. Press Show to review more detailed info about the found files. The following section will appear: The files aren’t actually deleted, but moved to the Trash See Section: B16.4 Empty Trash Can. B16.2 Remove issue The Remove Issue page allows you to remove an issue and its objects altogether or to move objects from one issue to another. Figure B16.1c More detailed info appears after clicking the Show icon Step 6. Deselect any files that should not be deleted. For a description on how to use the Remove Issue page, see Step B2.3 Deleting Issues. Step 7. Press Delete to delete the files. A dialog appears to confirm deletion of the file(s). 154 Chapter 08 Publication and workflow setup B16.3 Trash Can Query/Browse that need to be restored or deleted. After each selection is made, the page will automatically update itself and display the found files in the Browse Result section. Files end up in the trash can when they are deleted via the Delete function in a client application or via the Remove by Date or Remove Issue options in the web application. The Trash Can Query/Browse page allows you to either restore or permanently destroy all files from the trash can. The files can be chosen by running a query on the database by making selections and/or entering data in various fields. Step 2. To further narrow down the search, use any of the file property fields. To include these in the query, press the Search icon. The found files will be displayed in the Browse Result section. A To reset the page at any time, press the Reset icon. B D E F G H I J K Step 4. Select any file that need to be restored or deleted by manually selecting a check box or by pressing Select All. Publication drop-down lists B File property fields Query result filter D Delete check box E Restore files F Permanently delete files G File details H Select all files I Unselect all files J Search icon K Reset page icon A C Step 5. Do one of the following: a) To restore the selected file(s): press Restore Selected. b) To permanently delete the selected file(s): press Delete Selected Permanently. Figure B16.3 The trash can query/browse page To search for files using the Trash Can Query/Browse page and delete or restore them, do the following: Step 1. From the publication drop-down lists, make the required selections to locate the files 155 Server Step 3. Use they Query Result filter to increase or decrease the total number of displayed files on the page. C Chapter 08 Publication and workflow setup B16.4 Empty Trash Can B17. Log Files end up in the trash can when they are deleted via the Delete function in a client application or via the Remove by Date or Remove Issue options in the web application. The Empty Trash Can option will permanently destroy all files from the trash can. This section describes all available options regarding the Log page. Via the Log page, user actions can be viewed that have been tracked by the system such as log on, log off as well as requests by the client applications. What is logged can be set by the LOGLEVEL option in the configserver settings. (For more information, see Section 5.1: High-level Monitoring in Chapter 9: Server Configuration.). To delete all files from the trash can, do the following: Server Step 1. Click the Empty Trash Can icon A dialog appears to confirm emptying the trash can. Figure B16.4 The confirm emptying the trash can dialog Do one of the following: 1) Press Cancel to return to the Clean Up page without emptying the trash can. or 2) Press the OK button to empty the trash can. 156 Chapter 08 Publication and workflow setup C D C E DeleteObjectRelation When the relation between two objects is broken. E.g. when an image is removed from a layout. DeleteObjects Object is deleted, not permanently, but to the Trash Can. E GetObjectRelations When displayed objects are are related to each other. GetObjects When the properties of an object requested. GetServers Gets list with application servers. Used during logon and during testing in the wwtest. GetStates Not Logged. F User info drop-down lists B Search icon Reset page icon D Select service log check box Service log details F Delete service log Figure B17a. The log page The following services are logged: Service description Service called when an object is taken offline or set back to online. GetVersion ChangeOnlineStatus Cannot locate when logged. Seems to be used to get version information of the server. ChangePassword User changes password ListVersions CopyObject Not logged. When the 'Show Versions ...' option is chosen in a client application. LogOff User logs off CreateObjectRelation When a relation is created between two objects. E.g. when an image is placed into a dossier. LogOn User logs on NamedQuery A named query is executed e.g. 'Inbox' search in the Query/Browse application. QueryObjects A query is done to select e.g. all objects of an issue or to refresh a window. CreateObjects New object is created. E.g. when an article is saved for the first time. 157 Server description B A A Service Server Chapter 08 Publication and workflow setup Service description RestoreVersion When a previous version is restored. SaveObjects Object is saved. E.g. when an article is saved after it is changed. SendMessages When in Publication Overview the message icon is used. SendTo Not Logged. SetObjectProperties One of the properties of an object is changed. E.g. when the status is changed from 'draft' to 'ready'. Service Purge Objects Object is permanently deleted (Empty Trash Can) UnlockObjects Unlock an article/layout. E.g. when an article is checked in. UpdateObjectRelation Relation between two objects is changed. E.g. when the 'Send Geometry' option is selected or an image within a dossier is placed on a layout within the same dossier. Step 2. Press the Search icon to display the results. Step 3. To view more detailed information on a service, click anywhere on the service detail row. The Service Details page appears. Figure 17b. The service log details page B17.1 Deleting service logs Service logs can be deleted either individually or in groups. To delete service logs individually, do the following: Step 1. Press the Delete Service Log icon. A dialog appears to confirm deleting the log. To view the services used by a certain user, do the following: Step 1. Make a selection from the User, Service and IP drop-down lists, and enter a date in the date field (optional). Figure B17.1a The confirm deleting the log dialog 158 Chapter 08 Publication and workflow setup Do one of the following: 1) Press Cancel to return to the Log page without deleting the log. or Figure B17.1b The confirm deleting the log dialog 2) Press the OK button to delete the log. Do one of the following: 1) Press Cancel to return to the Log page without deleting the log(s). To delete service logs in groups, do the following: Server Step 1. Manually select the service log(s) that you want to remove by selecting its check box or press Select All to select all displayed service logs. or 2) Press the OK button to delete the log(s). Step 2. Press Delete Selected to delete the selected logs. A dialog appears to confirm deleting the log(s). 159 Chapter 08 Publication and workflow setup B18. Online users MadeToPrint operations are called based on rules set in Enterprise on the MadeToPrint page. Each rule is set to a trigger status of a layout. As soon as this status is reached, the document will be sent to MadeToPrint. This section describes all available options regarding the Online Users page. Via the Online Users page, an overview can be seen of all users that are currently logged in to the server. When a user is logged in twice, two entries are listed: one for each session. Figure B18 shows the same user logged in with InDesign and the web applications: Rules can be defined on two levels (Publication and Issue) and only one rule per layout status can exist. For each printing rule, triggers and routing rules can be set. Triggers Server States can be defined for objects on the layout that they must have reached before printing is done. Figure B18. The online users page Routing B19. MadeToPrint On successful print, the next state the layout and related objects are set to can be defined. This section describes all available options regarding the MadeToPrint page. Per rule you can set the following triggers and routing: Axaio’s MadeToPrint integration offers automatic printand PDF output features. Via the MadeToPrint page (see figure B19), Smart Connection Enterprise can be integrated with this product and set to execute Made to Print output operations when files reach a certain status. Triggers The MadeToPrint solution is an optional feature that needs to be purchased separately and requires extra installation steps. 160 Layout The status that the Layout must have. Article The status that the Article must have. Chapter 08 Publication and workflow setup Step 2. Press the Add button. The status fields appear. Triggers Image The status that the Image must have. Step 3. In the Before section, select a status that a layout, article or image must have reached in order for the rule to be actioned. Routing Layout The status the Layout will be set to on successful print. Article The status the Article will be set to on successful print. Image The status the Image will be set to on successful print. Step 4. In the After section, select the status that a layout, article or image will be set to on successful print. Step 5. In the Axaio section, specify a print job: enter the exact name for the print job that has been created in MadeToPrint. Server Print job Print job Step 6. Press the Save button to add the rule to the system. The print job defined in Made to Print. B19.1 Creating a MadeToPrint rule B19.2 Editing a MadeToPrint rule To create a MadeToPrint rule, do the following: To edit a MadeToPrint rule, do the following: Step 1. From the Publication and Issue lists, select the publication and issue to which the rule should apply. 161 Chapter 08 Publication and workflow setup Step 1. Press the Edit icon for the rule that needs to be edited. The status fields change into editable fields. Step 2. Make the changes as required. Step 3. Press the Save button to store the changes. B19.3 Deleting a MadeToPrint rule Server To delete a MadeToPrint rule, do the following: Step 1. Press the Delete icon for the rule that needs to be deleted. The rule is deleted immediately. B20. Licensing This section describes all available options regarding the Licensing page. The licensing page gives a current overview of the installed licenses and provides options to Register, Register More, Unregister and Adding (client) licenses. (For more information, see Chapter 7: Licensing.) 162 09 Server configuration 09 Server configuration Linux This chapter explains the configuration options of the Enterprise server. Server /var/www/html/SCEnterprise/Config All configuration files (in .php format) are held inside the SCEnterprise config folder: Note: Since PHP code is being edited, always use forward slashes ‘/’ as path separators to make sure to keep the correct PHP syntax. Mac OS /Library/WebServer/Documents/ SCEnterprise/Config Windows c:\inetpub\wwwroot\SCEnterprise\ Config 164 Chapter 09 Server configuration 1. Basic configuration settings 1.2 Database settings The basic configuration settings are kept in the config.php file. Check the following entries. DBUSER Database user to be used by the Application Server. Note: this is the single database user that is used by the application server to access the database. This database user account needs SELECT, INSERT, UPDATE and DELETE privileges. 1.1 Application server settings BASEDIR OS file path of the SCEnterprise folder. Make sure you edit the correct BASEDIR setting of your OS. For creation and deletion of custom properties, the database user also requires ALTER TABLE privilege. The application server itself authorizes all requests for the user logged on via the Enterprise user tables which are completely separate from the database users. Default is 'root'; for MSSQL Server you could use 'sa' as default. INETROOT Web server path of the SCEnterprise folder. Default value: '/SCEnterprise' DBPASS Password for the database user. Default is an empty string. DBSELECT Name of your Enterprise database. Default value: 'SCEnterprise' 165 Server Default values: Windows: 'c:/Inetpub/wwwroot/SCEnterprise' Mac OS/Linux: '/Library/WebServer/Documents/ SCEnterprise' Chapter 09 Server configuration 1.3 File server settings 1.4 Date time settings ATTACHMENTDIRECTORY Path to the File Store, which can be a mount point on a different machine. LANGPATDATE Format for date display. LANGPATAMPM Set to true for am/pm time display. Default values: Windows: 'c:/FileStore' Mac OS/Linux: '/FileStore' LANGPATTIMEDIFF Letters for Day/Hour/Minute in entering relative times (Tag/Stunde/Minute for German, Dag/ Uur/Minuut for Dutch etc). Server TEMPDIRECTORY Folder in which Enterprise stores temporary files. EXPORTDIRECTORY Folder in which exports are downloaded. WOODWINGSYSTEMDIRECTORY Folder in which Enterprise stores certain system files. This directory MUST be a child directory of the ATTACHMENTDIRECTORY. FILENAME_ENCODING When using certain languages on a Windows system, filenames may not be generated correctly because characters get 'garbled'. In that case, define FILENAME_ENCODING to for example 'CP1251' on a Russian system. 166 Chapter 09 Server configuration 2. Configuring your database usage 3. Where to store the files The file configserver.php holds a number of settings to configure your database usage. Verify the following entries. As explained in Chapter 5: Deployment Strategy, files can either be stored inside the database or inside a file system. This is determined by the following setting in configserver.php: 2.1 Advanced database settings DBTYPE Type of database to used: "mysql" MySQL (default option) "mssql" MSSQL Server "oracle" Oracle DBSERVER IP address of your database server. By default this is the same machine as the application server. Default value for Macintosh is '127.0.0.1'. For Windows or Linux, default is 'localhost'. For MSSQL and ORACLE the machine name must be entered, not the ip address. When storing files inside the database, the maximum file size per file is limited to 4 Gb. DBMAXQUERY Maximum number of records returned in query results. Default is 100 records. When set to zero (0), there is no limit and all records are returned. The filestore (ATTACHMENTDIRECTORY) always needs to be created, even when using DB as file storage. Make sure to do so and set the correct permissions as well. 167 Server ATTACHSTORAGE Methods for storing files: FILE When storing files inside the file system using numeric structure (default option). DB When storing files inside the database. (Only supported for Oracle systems.) REALFILE The same as FILE but then not using a numeric structure but using the Publication/Issue/ Section structure instead. Names of articles, layouts etc. are used as the filenames in the Filestore. Chapter 09 Server configuration 4. Setting up multiple application servers Server 3.1 The ATTACHMODULO setting When choosing to store the files inside the file system with the FILE storage option, you can use the ATTACHMODULO setting to determine how many objects share one folder. (For more information, see Chapter 10: Server Internals.) If you need or choose to use multiple application servers, you can set them up using the standard installation steps (PHP, WebServer, Enterprise Server, Test Enterprise server), pointing them all to the same single database. The required sub folders inside the File Store folder are created automatically, except the root folder. The newly created sub folders carry the same access attributes as their parent root folder. Make sure that the root folder exists and that the access rights are correctly configured. The WebServer user needs the following access rights set: Per client machine you can determine which application server is used by editing its WWSettings.xml file (see Chapter 12: Client Configuration) and setting the URL of the application server. Webserver user platform access rights www Mac OS Read and Write IUSR Windows Read, Write and Delete nobody Linux Read and Write The database can also reside on one of the machines used as Application Server. When using MSSQL or Oracle as the database you need to install the database client libraries on the application server. 168 Chapter 09 Server configuration 5. Monitoring system activity and logging The low-level logging is turned on with the following setting in configserver.php: Enterprise offers two facilities: high-level monitoring and low-level debug logging. The high-level monitoring records all processed SOAP requests. The low-level debug logging dumps all SQL queries and SOAP details for debugging purposes. DEBUGLEVEL Possible settings are: NONE, FATAL, ERROR, WARN, INFO, DEBUG The amount of information gets richer from left to right. 5.1 High-level monitoring NONE disables the low level logging. The high-level monitoring is configured in the configserver.php file: Disable logging Logon and Logoff only (default value) All SOAP calls (note that this creates a very large log file.) An empty string disables low-level logging which is the default. The result of the SOAP logging is written to the smart_log table and can be viewed via the Log web application. (See Section B17. Log in Chapter 8: Publication and Workflow Setup.) With low-level logging turned on, the log files keep growing, thereby consuming disk space and reducing performance. When low-level logging is turned on, a warning Running in Debug mode is shown in the web logon screen. 5.2 Low-level debug monitoring The low-level debug logging writes files with all SQL statements (mysql.log), details for all SOAP calls (soap/<date>/<time>_<call>_Req.xml) and time spent inside the Application Server (soap-debug.log). 169 Server LOGLEVEL 0 1 2 OUTPUTDIRECTORY Path to write log files to. The path needs to end with /, for example: "c:/scentlog/output/" Chapter 09 Server configuration 6. Automatic JPG/PDF/EPS creation thumbnails are also always saved per page no matter which feature is set. The server decides whether to store the page files in File Store or in the database. (See Section 3: Where to Store the Files.) While saving a document in InDesign, the Enterprise plug-in for InDesign can automatically generate JPG, PDF or EPS files per page and sent them to the server. This behavior depends on some feature settings made at server side. Using both PDF and EPS is not supported. There are six features that can be enabled: The features can be configured in the configserver.php file. The following example will store previews for each save and store EPS’s when saving the document into any ‘produce’ status: 2 Server JPG format1 Feature2 Client Event 3 CreatePagePreview on save CreatePagePreviewOnProduce on produce define ( 'SERVERFEATURES', serialize ( array('CreatePagePreview', 'CreatePageEPSOnProduce'))); EPS format1 Feature2 Client Event 3 CreatePageEPS on save CreatePageEPSOnProduce on produce Features are retrieved from the server during client login. After making changes, you have to log out and log in again to activate them (only for running clients). PDF format1 Feature Client Event 2 CreatePagePDF "on save" means that the page files are sent to the server when the user saves the InDesign file (to the server). Note that native InDesign files can be stored locally only, in which case the page files are NOT sent. (For more information, see Section 7: Storing Layouts and Articles Locally.) 3 4 CreatePagePDFOnProduce 5 3 on save on produce The page file format depends on the chosen feature and is sent by the InDesign plug-in together with the native InDesign file (which is always sent). Note that 1 "on produce" does the same but only when the layout has reached a so called ‘produce’ status, which is 170 Chapter 09 Server configuration a property of the status. (See Chapter 8: Publication and Workflow Setup.) In this example, assume that you have a "print" status defined for layout objects for which the 'produced' status is enabled. Then, each InDesign client must have a "print" PDF style defined. The CreatePagePDF option has special treatment by the client software and is used when a saved document does NOT reach any 'produced' status (yet). In that case, the given PDF style name is used as defined in InDesign. This can be done as follows: 4 define ('SERVERFEATURES', (array('CreatePagePDF' => style))); If you like to use the default style instead, give the [Press Quality] value as follows: define ('SERVERFEATURES', serialize( array('CreatePagePDFOnProduce’ => '[Press Quality]'))); serialize ’my own This is the default configuration. Since InDesign CS2, many PDF presets are renamed. For example, for the English version, [Press] has been renamed to [Press Quality]. English: [High Quality Print] [Press Quality] Note: This is not a complete list. The CreatePagePDFOnProduce option does basically the same as CreatePagePDF, but then only when the saved object reaches the produced status. However, if NO style is given, the status name is considered to be the PDF style to be used at client. This allows you to use different output definitions depending on the reached statuses. 5 define ('SERVERFEATURES', serialize (array('CreatePagePDFOnProduce'))); 171 Server You can also use one of Adobe’s predefined (localized) styles: Chapter 09 Server configuration 7. Storing layouts and articles locally The Enterprise InDesign and InCopy plug-ins can store native files (InDesign/InCopy documents) to the local hard disk without sending them to the server. This is done to reduce network traffic and speed up intermediate save operations. Server If the user selects the menu File > Save, the file is saved locally. When the menu Smart Connection > Save Version is selected, the file is saved locally and sent to the server as a new version. Only for the server save operation, the save dialog is raised to let the user change status or add comments. Client Event Local Server ID place article 1 Yes Opt 2 ID create article Yes Opt 2 ID check-in article Yes Opt 2 ID check-out article Yes No IC/ID File > Save Yes Opt 2 IC/ID Smart Connection Yes > Save 1 Yes You can also set the behavior to always save to the server. This is done with the server feature AlwaysSaveDocIntoDatabase in configserver.php. For example: If the AlwaysSaveDocIntoDatabase option is enabled, a layout document reaches a special state at InDesign wherein it is not saved to the server yet although an article is placed on it. When opening that article in InCopy a warning dialog will raise: “The story has been placed on a layout which is not saved since then. Therefore, no layout information is available...”. In that case the InDesign document will not be opened, and InCopy will treat it as an unplaced article. define ('SERVERFEATURES', serialize (array('AlwaysSaveDocIntoDatabase'))); When the InDesign document is closing it will be saved to the server to ensure data integrity. Using this feature, native files are always sent to the server regardless of which save menu entry is selected. Then, in both cases the save dialog is raised. Note that the warning dialog won’t raise when the UseXMLGeometry option is enabled. (See Section 11: Geometry Update and Remote Module.) This is because layout information is always synchronized. 1 The following table shows when native files are sent to the server or only saved locally. Optional. Default is "No". The native layout file is only sent to the server when the server feature AlwaysSaveDocIntoDatabase is set. 2 172 Chapter 09 Server configuration 8. Security 8.2 Security related facts The standard installation steps of Enterprise have been written with ease of installation in mind. After a successful installation please check the following notes to make sure you end up with a secure installation. Enterprise uses its own user definitions and password which are used to authenticate the clients with the application server. The application server applies the business logic and authorization rules what a specific user can do. The application server itself always uses the configured database user that has 'full' access to the database. 8.1 Security checkpoints Enterprise user passwords are stored encrypted inside the database. For each client session, a ticket is created and returned to the client application. Instead of sending passwords, the ticket is sent along each SOAP call (between client and Application Server). If you use the file system, the default location is the FileStore directory in the root of your disk. Change this into a better place and set the location in config.php. Next, make sure the access rights are set as narrow as possible. (For more information, see Section 3: Where to Store the Files.) If you raise the security level of your web browser, cookie support might get disabled implicitly. However, cookies are used by the Smart Connection Enterprise system, so make sure you enable it again after raising the security level. 173 Server The standard MySQL user root does not have a password. Set a password for root (or even better delete the root user and create a new MySQL user account with password) and enter this user/password into config.php as well. Chapter 09 Server configuration 9. Versioning 8.3 Logon expiration Enterprise expires logon sessions automatically after a configured time of inactivity. The term can be set to be different for web clients because these are typically not logged off. Enterprise offers versioning capabilities. Via either the Query/Browse option, Smart Browser or via InDesign or InCopy, you can view a list of versions for a file and rollback to an older version. This will create a new version based on this older version. EXPIREDEFAULT Generic logon expiration time in seconds. Default value: 24*3600. EXPIREWEB Logon expiration time in seconds for web based clients. Default value: 3600. Enterprise stores up to a configurable number of versions per file. Besides the total number of versions to save, you can also define how many of the oldest versions should be saved. Server When the total number of versions is exceeded, the version will be deleted that comes after the configured number of oldest files to keep. These numbers can be set per type of object in configserver.php: MAX_ARTICLE_VERSION Total number of versions to store per article. Default value: 10 MAX_IMAGE_VERSION Total number of versions to store per image. Default value: 5 174 Chapter 09 Server configuration MAX_VIDEO_VERSION Total number of versions to store per video file. Default value: 5 SAVEFIRST_LAYOUT_VERSION Number of oldest versions to store per layout. Default value: 0 MAX_AUDIO_VERSION Total number of versions to store per audio file. Default value: 5 SAVEFIRST_LIBRARY_VERSION Number of oldest versions to store per library file. Default value: 0 MAX_LAYOUT_VERSION Total number of versions to store per layout. Default value: 5 Server MAX_LIBRARY_VERSION Total number of versions to store per library file. Default value: 5 SAVEFIRST_ARTICLE_VERSION Number of oldest versions to store per article. Default value: 1 SAVEFIRST_IMAGE_VERSION Number of oldest versions to store per image. Default value: 0 SAVEFIRST_VIDEO_VERSION Number of oldest versions to store per video file. Default value: 0 SAVEFIRST_AUDIO_VERSION Number of oldest versions to store per audio file. Default value: 0 175 Chapter 09 Server configuration 10. Customizing the web user interface 10.1 Changing the look and feel Server You can change the look and feel, language and the used terms of the web pages shown by the user- and admin web applications. Enterprise offers a framework that separates your customizations from the core system. This simplifies updating new versions of the system by keeping your customizations. The look and feel is determined by the HTML templates, style sheets and images. These files reside in the .../config/templates/ and .../config/images folders. You are free to edit those files, but care needs to be taken. Use a UTF-8 text editor for the HTML templates. Make sure that the content and location of keywords (e.g. "<!- - CONFIG:ISSUE - ->") remain untouched. Before you start making changes, you need to understand how web pages are shown by the web applications. For each user request, a PHP script reads in a HTML template from the /config/templates folder and a dictionary file (enUS.xml for example) from the /config/resources folder. All keywords shown in the template file are replaced by values defined in the dictionary. For example, if the template carries the keyword"<!- - CONFIG:ISSUE - ->", the current language is English and you are using the standard shipped templates, it will be replaced with the value "Issue" before the requested page is actually shown to the user. Note that the replacements are only done in memory, so the template files remain untouched. 176 Chapter 09 Server configuration 10.2 Selecting the language Web users can overrule the company language setting by setting their own language. This is done in the My Profile option in the Web Applications menu. The available languages are listed in a drop down box. Out-of-the-box, Smart Connection Enterprise offers thirteen languages that you can choose from: English (default), French, German, Italian, Spanish, Brazilian Portuguese, Dutch, Japanese, Korean, Chinese, Russian and Polish. The language of the server is defined in the .../config/configserver.php file in the SERVERFEATURES definition: 'CompanyLanguage' 'enUS' . 10.3 Changing the terminology You can select one of the following values for this setting: Language setting German deDE English enUS Spanish esES French frFR Japanese jaJP Italian itIT Dutch nlNL Brazilian Portuguese ptBR Russian ruRU Simplified Chinese zhCN Traditional Chinese zhTW Korean koKR Polish plPL 10.3.1 Method 1 (one language) Modify the configlang.php file (make a backup first): (See next page.) 177 Server You might want to use different terms than those standard shipped. For example: as a newspaper you might be quite happy with Publication/Issue/Section/ Status terms, but as a book publisher you might want to use Project/Book/Chapter/Status terms instead. There are two different methods for changing the terms to suite your workflow: one for a workflow that contains one language and one that contains two or more languages. Chapter 09 Server configuration Server Default static properties: function getUiTerms() { static $terms; if (!isset($terms)) { // not cached yet $terms = array(); $terms[] = new Term( 'Publication', BizResources::localize('PUBLICATION',false) ); $terms[] = new Term( 'Publications',BizResources::localize('PUBLICATIONS',false ) ); $terms[] = new Term( 'Issue', BizResources::localize('ISSUE',false) ); $terms[] = new Term( 'Issues', BizResources::localize('ISSUES',false) ); $terms[] = new Term( 'Section', BizResources::localize('SECTION',false) ); $terms[] = new Term( 'Sections', BizResources::localize('SECTIONS',false) ); $terms[] = new Term( 'Edition', BizResources::localize('EDITION',false) ); $terms[] = new Term( 'Editions', BizResources::localize('EDITIONS',false) ); $terms[] = new Term( 'State', BizResources::localize('STATE',false) ); $terms[] = new Term( 'States', BizResources::localize('STATES',false) ); Rename the static properties as follows: function getUiTerms() { static $terms; if (!isset($terms)) { // not cached yet $terms = array(); $terms[] = new Term( 'Publication', $terms[] = new Term( 'Publications', $terms[] = new Term( 'Issue', $terms[] = new Term( 'Issues', $terms[] = new Term( 'Section', $terms[] = new Term( 'Sections', $terms[] = new Term( 'Edition', $terms[] = new Term( 'Editions', $terms[] = new Term( 'State', $terms[] = new Term( 'States', } return $terms; } 178 'Project' ); 'Projects' ); 'Book' ); 'Books' ); 'Chapter' ); 'Chapters' ); 'Region' ); 'Regions' ); 'Status' ); 'States' ); Chapter 09 Server configuration 10.3.2 Method 2 (two or more languages) 11. Geometry update and remote module Step 1. First make a backup of the language files in the config/resources directory that you wish to edit. Step 2. Open the dictionary file ../config/resources/enUS.xml (for English) in a text editor that supports UTF-16 encoding. Step 3. Each line of the XML file shows the following format: <Term key="ISSUE">Issue</Term>. Make sure you respect the XML format, else the system might fail reading the dictionary file. However, a disadvantage of the XML Geometry Update feature is that there won’t be layers available (all layers will be packed into a single layer). This means that layers cannot be used in the Layout View of InCopy and a preview of the last saved InDesign file is shown depending on active layers at saving time. Another disadvantage is that the resolution of non-editable articles is limited to the resolution of generated geometry preview files. Zooming to higher percentages can therefore result in a more blurred view. Currently the XML Geometry Update feature is not working with Editions and not fully working with Sticky Notes. 179 Server By default, when a placed article is opened in InCopy, the layout file is opened as well. The same happens when sending layout updates from InDesign and receiving them in InCopy. Big layout files will cause long wait times and more network load. If you wish to significantly reduce these aspects, you might want to enable the so called XML Geometry Update functionality exposed by the Remote Module since Enterprise v3.3. When enabled, a tiny geometry file and a geometry preview file is saved by InDesign and loaded by InCopy, instead of a large layout file. Optionally, the preview files can be suppressed to make it even more faster. Chapter 09 Server configuration 12. Messages and events To enable the XML Geometry Update feature exposed by the Remote Module, add the UseXMLGeometry entry to the SERVERFEATURES configuration in the configserver.php file or remove the entry to disable it. Note that this setting can only be done system wide. Enterprise has an event mechanism built into both its InDesign and InCopy clients and its server, offering the following functionality: User Messages Live Update Hot Inbox Custom Event Handling Server By default, the geometry files will carry layout preview information. For performance reasons you might want to suppress the preview. In that case you won’t see the layout in InCopy. Nevertheless, you can still ‘write-to-fit’. To suppress the geometry preview, add SuppressGeometryPreview entry to the SERVERFEATURES section. Events are broadcasted by the server and received by all InDesign and InCopy clients. Broadcasted packages are limited to 1024K, which stands for 45 item properties on average use. The server never exceeds this limit. Fields exceeding the limit are not sent. By default, geometry preview files are 72 DPI. This way the files are small, but articles placed on large pages might become unreadable. In that case you can change the resolution of the preview files by adding a GeometryPreviewResolution entry followed by a value indicating DPI. For segmented networks (with multiple sub nets), multicasting needs to be used instead of broadcasting. A separate tech note about multicasting is available from your reseller or integrator. For example configurations, see Appendix D: Geometry Update Examples. MULTICAST_TTL Time-To-Live options for multicasts. Make sure this value is set correctly for your network. More info about TTL values can be found at http://www.geniusweb.com/LDP/ HOWTO/Multicast-HOWTO-2.html. 180 Chapter 09 Server configuration 12.1 User messages MULTICAST_IF The network interface used to send out multicasts. If your server machine has more than one network card, make sure this setting points to the right interface. Users can send messages to object items raising dialogs at InCopy and InDesign clients. Enabling User Messages, enables the "Send Message" entry in the Enterprise menu when the user is logged in. In the SERVERFEATURES of the configserver.php the following options must be set: Messaging EventPort MC_MEDIATOR_PORT, MC_MEDIATOR_ADDRESS The MC_MEDIATOR_PORT setting is an UDP port used for the IP address indicated with the MC_MEDIATOR_ADDRESS setting. This can be the local address if the mediator is running on the same machine as the Smart Connection Enterprise Server. (See section 12.4: Example Configuration on how to set these changes.) Server Events are not considered to arrive client-side 100% guaranteed. Therefore, events are not required for clients to work correctly. There are some scenarios in which events might not be received: User is not logged in System file dialog (such as file save-as) lays on top while OS’s message queue is full Client machine is disconnected from network 12.2 Live update Items shown in database view are updated automatically as soon as their properties are changed in the database. In the SERVERFEATURES section of the configserver.php file, the following options must be set: Broadcasting EventPort (See section 12.4: Example Configuration on how to set these changes.) 181 Chapter 09 Server configuration 12.3 Hot inbox 12.4 Example configuration Newly created / incoming items are shown directly in user’s inboxes. Enabling this feature implicitly also enables Live Update. In the SERVERFEATURES section of the configserver.php file, the following options must be set: HotInbox Broadcasting EventPort In the configserver.php file, the following changes must be made to use all flavors of messaging: define('SERVERFEATURES', serialize( array( new Feature( 'Messaging' ), new Feature( 'Broadcasting' ), new Feature( 'EventPort' , 8093 ), new Feature( 'HotInbox' , 'Inbox'), )) ); Server (See section 12.4: Example Configuration on how to set these changes.) You are free to change the event port number. If you are using more than one system on a single network, the port must differ or else clients will try updating views using sent data of foreign databases which obviously makes no sense. In the SERVERFEATURES section of the configserver.php file, the following options must be set: Broadcasting EventPort The HotInbox’s value must match a Named Query showing the user’s inbox. An example of an inbox is given in Appendix C: Named Query examples. The client will add all new items to the inbox view that have a RouteTo property matching the current user logged in. Note that there is no further checking done (for access rights, item locations, statuses, etc), so it’s added to the view regardless of the inbox query definition. If an item disrespects the query it disappears when the user manually refreshes the entire view (running the inbox query). When a new item is created, only the most important fields get updated in the palette. (See section 12.4: Example Configuration on how to set these changes.) 182 Chapter 09 Server configuration 13. Email notifications 13.1 Basic email configuration Enterprise can send automatic email notifications when files are routed to a person or a group. When a user received such a notification he/she can look in his/her Inbox to see which files are waiting. To enable this feature, you need to perform the following steps: In the configserver.php file, the following settings should be configured for email notifications: EMAIL_NOTIFICATION Subject for the e-mail notifications. Default value: "WoodWing SCEnterprise notification for %routeto%" Step 1. Set the basic email configuration options Step 3. Enable per user if notifications should be sent. EMAIL_SMTP SMTP server to send email. For example smtp.mydomain.com Default value: "" EMAIL_SMTP_SENDER E-mail address to use as the sender of the notification e-mail. For example [email protected] Default value: "" EMAIL_SMTP_USER Logon name if required for your SMTP server. Default value: "" 183 Server EMAIL_NOTIFICATION_FILE File to use for the body of the e-mail notification. Default value: BASEDIR."/config/ templates/email.txt" Step 2. Enable the email notification option per publication Chapter 09 Server configuration 13.2 Enable email notification per publication EMAIL_SMTP_PASS Password if required for your SMTP server. Default value: "" Per publication you can configure if you want to enable email notification. This is done through the Publication Maintenance page by selecting the Email notifications option. (See Section 3.1 Creation your Publications in Chapter 8: Publication and workflow setup.) The value of the setting EMAIL_NOTIFICATION or the contents of the file set with the EMAIL_NOTIFICATION_FILE can contain the following placeholders that will be replaced by the appropriate values: 13.3 Enable email notification per user Name of the file the notification is about. %routeto% Name of the user or group this file is routed to. %state% Workflow status of the file. Server %name% Per user you can set two email options via the User Maintenance page: Send email notification when file routed to me Send email notification when file routed to one of my groups 184 Chapter 09 Server configuration 14. Reporting The class scent_reportutils (as implemented in /server/apps/report.php) offers a useful function to get a list of all statuses and their colors for a particular publication/issue: function getColorList( $inPub, $inIssue, $objType, &$graph, &$colors ) Enterprise allows you to define any kind of report via small PHP scripts. These files have to be put into the /config/reports folder. Inside your script you will need to implement a function called SCEntReport that accepts two parameters for the selected publication and issue. The HTML result of the report should be returned by this function. Enterprise includes a limited license of the KavaChart components from Visual Engineering Inc. that we use for charts. To use KavaChart components in your own scripts, you can buy a KavaChart license that comes with developer documentation. See www.ve.com for more information. The following is an example report: // Result into a table: first column pie chart: $txt = "<table><tr><td>"; $txt .= graphpie($graph,350, $colors); // second column list of status and the count of objects $txt .= "</td><td><table>"; foreach ($graph as $key => $value) $txt .= "<tr><td>$key</td><td align=\"right\">$value</td></tr>"; $txt .= "</table></td>"; return $txt; } ?> 185 Server <?php function SCEntReport( $inPub, $inIssue ) { // First get associative array with status/counts and list of colors // for these statuses $reportutils = new scent_reportutils; $reportutils->getColorList( $inPub, $inIssue, "Article",$graph, $colors ); Chapter 09 Server configuration 15. Password management 16. Server-side preview generation The life-span of a User Account and/or its password can be controlled, resulting in less interaction by the administrator. Use of character type and password length can also be controlled. Some Enterprise components generate previews from images, for example the Upload page or Smart Upload. Typically file formats like PSD and PDF/EPS are not always (fully) supported. In order to have more sophisticated preview generation capabilities you can also install and configure server-side preview generation. Doing so will also enhance the meta data extraction capabilities. PASSWORD_EXPIRE Days after which a password expires. Server PASSWORD_MIN_CHAR Minimal characters in a password. The following additional components are required for server-side preview generation: PASSWORD_MIN_LOWER Minimal lower case characters in a password. Imagemagick PASSWORD_MIN_UPPER Minimal uppercase characters in a password. Imagemagick is free software (under the General Public License) and runs on all major operating systems. See the website www.imagemagick.org. Ghostscript PASSWORD_MIN_SPECIAL Minimal special characters in a password. Ghostscript is copyrighted and is available under several licenses: AFPL: Owned by Artifex Software, Inc. and artofcode LLC, formerly Aladdin Ghostscript. This version is the most up to date: it supports the newest PDF features and image formats. This version may be used freely but may not be distributed commercially. 186 Chapter 09 Server configuration Windows GPL: distributed with the General Public License, which allows free use and free distribution under certain circumstances. GPL versions are usually released about a year after the AFPL release. Therefore, this version doesn’t contain the latest features but is stable. Ghostscript Download a version under the GPL license from http://prdownloads.sourceforge.net/ ghostscript. Choose a version subdirectory gs### and run gs###w32.exe (where ### is the version number, e.g. gs815/gs815w32. exe). Of course, you can also download other versions (under another license) from http://prdownloads.sourceforge.net/ ghostscript/. GNU: distributed with the GNU license. These are older Ghostscript versions that were part of the GNU project. For more information about Ghostscript, see the following web sites: www.cs.wisc.edu/~ghost http://ghostscript.com/awki Run the installer. The following sections contain installation details: Windows or Imagemagick See the website www.imagemagick.org. Download a Windows installer from e.g. ftp://ftp.nluug.nl/pub/ImageMagick/binaries. Run the installer and have the installation process modify the PATH setting. You will have to reboot to use the modified PATH setting. Assign “read and execute” access rights for the webserver user IUSR_ <machinename> to the file cmd.exe in the <windows>\system32 directory. 187 Server Allow a PHP page to start a command shellThis can be established in two ways: Copy the executable cmd.exe from the <windows>\system32 directory to the PHP directory (the directory where php. exe resides, e.g. c:\php); Chapter 09 Server configuration Windows Macintosh If a PHP page can’t start a command shell, you will see the error message 'Unable to Fork'. (E.g. imagemagick-6.1.7.pkg.tar.gz) Install the package. The PATH setting of the command shell should include the path to Imagemagick and Ghostscript. Ghostscript Run the installer from: www.versiontracker.com/dyn/moreinfo/ macosx/18096&vid=159121&mode=info or www.linuxprinting.org/macosx/hpijs/ Server Allowing PHP pages to execute a command shell can cause a security risk for your web server because any PHP page can now execute any DOS command. Therefore, be sure that: Unfortunately, these versions are not very recent. You can have a look at www.cups.org/espgs/index.php, and see whether a recent version (with an installer) is available or you can compile Ghostscript yourself. Also install the fonts in the font archive files. ������������������������������������� No malicious script pages (like PHP, ASP, cgi, etc.) can be installed on the web server ���������������������������� The user IUSR_<machinename> doesn’t have access to files that may not be accessed by a web user (via a Install Ghostscript in /usr/local (the binaries installed in /usr/local/bin). In case you want to test Imagemagick from the command line: Add /usr/local/ bin to the PATH setting in ~/.profile (for the current user), or in /etc/profile (for all users): Macintosh Imagemagick Download a package from: www.entropy.ch/software/macosx/ #imagemagick export PATH=”$PATH:/usr/ local/bin” 188 Chapter 09 Server configuration Linux Linux ImageMagick There are three ImageMagick: options for http://prdownloads.sourceforge.net/ ghostscript/ installing Download the .tar.gz archives, and compile and install the source code. Follow the instructions in the “How to install Ghostscript” document (doc/ install.htm).Also install the fonts in the font archive files. 1. Download a binary package from ftp:// ftp.nluug.nl/pub/ImageMagick/binaries (e.g. ImageMagick-i686-pc-linux-gnu. tar.gz) For installation notes, see http:// imagemagick.sourceforge.net/http/ www/QuickStart.html. 2. If you are familiar with it, install a .rpm package or install via e.g. yum. In case you want to test the Imagemagick from the command line: add /usr/local/bin to the PATH setting to ~/.profile (for the current user) or /etc/profile (for all users): 3. If you are familiar with it, install a .rpm package or install e.g. via yum. Ghostscript export PATH=”$PATH:/usr/local/bin” There are three options to install Ghostscript: export MAGICK_HOME=”/usr/local” export LD_LIBRARY_PATH=”/ 1. Download a version under the GPL license from: http://prdownloads.sourceforge. net/ghostscript/. Choose a version subdirectory first, e.g. 8.15. Of course, you can also download other versions (under another license) from usr/local/lib” 189 Server 2. Download the source from www.imagemagick.org and follow the make instructions. Chapter 09 Server configuration 17. Troubleshooting preview generation 16.1 File locations and access rights Server Access rights need to be set for the WebServer user: Webserver user platform www Mac OS IUSR Windows nobody Linux When experiencing issues with server-side preview generation, check the following: First try to test Imagemagick via the test page (http://yourserver/SCEnterprise/server/wwtest) and follow the test preview link. Press the Show versions button to see whether the Imagemagick commands convert and identify can be found and executed successfully. On Linux and Mac, the Ghostscript version will also be shown. If the version numbers can not be shown: The preview application uses the Temp subdirectory of the ATTACHMENTDIRECTORY for temporary files. Ensure that the WebServer user has got Read and Write access rights set. Check the settings checkbox before pressing the Show versions button, and see whether the Imagemagick (and Ghostscript) paths are part of the PATH setting. Be sure that the webserver user has execute access for the Imagemagick and Ghostscript executables (convert, gs). Macintosh and Linux 16.2 Enterprise configuration Add the ServerCreateImagePreview entry to the SERVERFEATURES setting in configserver.php to specify that Imagemagick should be used to generate the thumbnails, previews and meta data of created or updated images. Imagemagick �������������������������������� and Ghostscript are expected in /usr/local/bin. The ���� MAGICK_HOME, LD_LIBRARY_ PATH and DYLD_LIBRARY_PATH settings should be present and valid. 190 Chapter 09 Server configuration 18. Modifying business logic Try calling the Imagemagick commands convert and identify in a shell (command prompt) to see whether the installation was successful. Type convert –version, or /usr/local/bin/ convert –version. Enterprise offers two facilities to enhance or modify the server’s business logic: Event Handler to execute PHP code when a business event occurs. Windows Overrule business logic calls via smartserver.php. To change behavior when setting meta data, implement the validateMetaData($user, MetaData &$meta) function in smartvalidator.php. Throw a BizException to cancel setting the metadata when for example user’s input is invalid. You can for example apply naming conventions or filter meta data to prevent a user from setting a specific field. Next, try uploading an image and view the preview by pressing the Preview button. If this fails, check the Verbose checkbox and check the command line and possible error messages. Check the access rights of the input and output directory (the Temp subdirectory of the ATTACHMENTDIRECTORY). Next to this test page, you can also specify a value for OUTPUTDIRECTORY in configserver.php. Error information will be written to a file named imagemagick.txt in the output directory specified. 191 Server The convert command can also be a system command. Be sure that the Imagemagick path is the first path in the PATH setting, or specify the Imagemagick path explicitly in preview.php. If the wrong convert command is used, the error message 'Access Denied' may appear. Chapter 09 Server configuration Server 18.1 Custom event handling 18.2 Overruling business logic You also have the possibility to develop your own server operations that are triggered by workflow events. These operations can be implemented in the eventhandler.php located in the SCEnterprise\ config\code sub folder of the web root folder on the SCEnterprise server. This event handling mechanism can be used for example to integrate Smart Connection Enterprise with your CMS. The following workflow events will be triggered: logon / logoff createobject / deleteobject saveobject setobjectproperties sendto lockobject / unlockobject createobjectrelation / deleteobjectrelation updateobjectrelation deadlinechange sendmessage deletemessage Enterprise uses the SmartServer php class to implement its business logic. All standard logic is implemented in the SmartServerBase class that resides in the folder /SCEnterprise/server. Inside the file /config/code/smartserver.php you can find the empty SmartServer class that can be used to override any of the business calls. Typically you will use this to overrule one of the business calls (for example LogOn). In your implementation you can execute some code, call the base class implementation and after this execute some code. 192 Chapter 09 Server configuration 19. Advanced settings PASSWORD_CRYPT Reserved for future usage. Default value: 'Server' Below is a description of advanced settings that were not described previously. We don’t expect you will need to change these settings. SERVERADDONS Mechanism to enable/disable add-ons. Supported values: 'JournalDesigner' => 'PlanSystem' Default value: serialize(array()); 19.1 Configserver.php settings DBPREFIX Prefix used for all database table names. This must not be changed. Default value: "smart_" CACHEDIR The directory temporary objects are cached in. Default is the FileStore/cache folder. UPDATE_GEOM_SAVE If ON, client gives warning dialog when geometry update is available. Note that when using this setting, UseXMLGeometry should be disabled and vice versa. EXTENSIONMAP Mapping of file types (extensions, for example image.jpg) to their mime type and object type in the Enterprise database. A jpg would become an Image when uploading in the WebApp. PERSONAL_STATE When PERSONAL_STATE is defined as ON, users of the system can create an article or layout without immediately bringing it into the workflow. The user chooses the 'Personal' state and as long as the article or layout is in that state no implicit actions (dependent on state) are performed and the article/layout is left alone. As soon as the article or layout is ready it can be brought in to a workflow state (again) and normal procedure can prevail. SERVERURL URL used by wwtest web pages to logon as SOAP client. Default value: 'http://’.$_SERVER[“HTTP_HOST”]. INETROOT.’/index.php' 193 Server MIMEMAP Mapping of MIME types to file extensions. Chapter 09 Server configuration When in Personal state only the user (or users, when routed to a group) who is the RouteTo of the article/layout has access to the file. HOLIDAYS Specify a date as a non-working day. Possible setting: y-m-d or m-d SERVERFEATURES Generic mechanism to enable/disable system features, contains serialized array of strings. Supported string values: AlwaysSaveDocIntoDatabase Versioning StoreSettings CreatePagePreview CreatePagePreviewOnProduce CreatePageEPS CreatePageEPSOnProduce CreatePagePDF CreatePagePDFOnProduce UseXMLGeometry SuppressGeometryPreview Messaging Broadcasting EventPort HotInbox ServerCreateImagePreview KeepCheckedOut CompanyLanguage (See next page for the default values.) PERSONAL_STATE_COLOR Defines the color of the state Personal. Server RETURN_SHORT_USERNAMES Return either long user names (default) or short user names in modifier/creator fields NONWORKDAYS Defines the days of the week NOT being worked. Sunday=0, Monday=1, ..., Saturday=6 XMLTYPE MULTICAST_TTL, MULTICAST_IF, MC_MEDIATOR_PORT, MC_MEDIATOR_ADDRESS Multicast related settings as explained in separate tech note available from your reseller or integrator. DEADLINE_WARNTIME Enterprise can warn a user that a deadline is near: the so-called soft deadline. Enter the soft deadline in seconds before the real deadline. CREATEVERSION_ONSTATECHANGE Creates a version on every status change. 194 Chapter 09 Server configuration 19.2 MadeToPrint settings Default value: define ('SERVERFEATURES', serialize(array( new Feature( 'CreatePagePreview' ), new Feature( 'CreatePagePDFOnProduce' , '[Press Quality]' ), new Feature( 'Messaging' ), new Feature( 'Broadcasting' ), new Feature( 'EventPort' , 8093 ), new Feature( 'HotInbox' , 'Inbox'), new Feature( 'CompanyLanguage' , 'enUS'), new Feature( 'KeepCheckedOut' ) )) ); MTP_SERVER_DEF_ID Server name used to login in SCEnterprise (wwsettings.xml). MTP_USER The user name of the SCEnterprise user. MTP_PASSWORD The password of the SCEnterprise user. MTP_CALLAS_FOLDER_IN Input folder of Made to Print from Made to Print perspective. MTP_CALLAS_FOLDER_OUT Output folder of Made to Print from Made to Print perspective. MTP_JOB_NAME Default job of Made to Print. MTP_POSTPROCESS_LOC Location of the postprocessing script. 195 Server MTP_SERVER_FOLDER_IN Input folder of Made to Print from server perspective. Chapter 09 Server configuration 19.3 New configuration settings Configuration settings introduced in Enterprise version 5.0 APPLICATION_SERVERS List of application servers (returned through GetServersReponse SOAP call) Server Example: define( 'APPLICATION_SERVERS', serialize( array( // ServerInfo( Name, URL [, Developer] [, Implementation] [, Technology] [, Version] [, array of Feature] [, Cryptkey (file path)] ) new ServerInfo( SERVERNAME, SERVERURL, SERVERDEVELOPER, SERVERIMPLEMENTATION, SERVERTECHNOLOGY, SERVERVERSION, unserialize(SERVERFEATURES), defined('ENCRYPTION_PUBLICKEY_PATH') ? ENCRYPTION_PUBLICKEY_PATH : null ), // this server new ServerInfo( 'WoodWing.net', 'http://demo.woodwing.net/SCEnterprise/index.php', SERVERDEVELOPER, SERVERIMPLEMENTATION, SERVERTECHNOLOGY, '', // version unknown - may not be null array() )// feature set unknown - may not be null ENCRYPTION_PRIVATEKEY_PATH Path to private RSA encryption key and base64 encoded private key. Example: define ('ENCRYPTION_PRIVATEKEY_PATH', BASEDIR.'/config/encryptkeys/privkey_1024.pem' ); 196 Chapter 09 Server configuration ENCRYPTION_PUBLICKEY_PATH Path to private RSA encryption key and base64 encoded public key. Example: define ('ENCRYPTION_PUBLICKEY_PATH', BASEDIR.'/config/encryptkeys/pubkey_1024.pem' ); LDAPServer List of LDAP servers, needed for usage of ActiveDirectory or LDAP. Example: define( 'LDAP_SERVERS', serialize( array( new LDAPServer( 'myldap_server', null, 'myldap.mycompany. local', 'ACTIVEDIRECTORY' ))); Server NetworkDomain List of network domains, needed for usage of ActiveDirectory or LDAP. Example: define( 'NETWORK_DOMAINS', serialize( array(new NetworkDomain( 'myldap.mycompany.local', array( 'myldap' ) )))); 197 Server Chapter 09 Server configuration intentionally left blank 198 10 Server internals 10 Server internals 1. Application server config/encryptkeys Contains certificates to support https (secure http) connections. Server The Enterprise application server consists of a folder tree with the following sub folders: config/images Image files used by the web applications. Changing these allows you to modify the look and feel of the web user interface. config System configuration files for the Application Server and its connection to the database and Operating System. config/reports Contains PHP report scripts. (For more information see Section 14: Reporting in Chapter 9: Server Configuration.) config/articletemplates Directory where article templates for usage in the Web Editor are stored. These templates are globally available. config/resources Contains language files for all supported languages. config/code Contains PHP files for additional custom implementations. Here you can enrich the system with custom functionality on system events and overrule the business logics. config/templates HTML templates and style sheets used by the web applications. 200 Chapter 10 Server internals config/webeditor themes Themes for the Web Editor that allow you to change the look and feel of widgets, such as the toolbar, slide bar, dialogs and tabs. server/bizservices Contains PHP classes implementing workflow services based on the definition of the services as specified in the workflow WSDL. server Core Application Server files. server/dataclasses Contains PHP files with data structures used thoughout the server. server/admin Contains PHP files implementing the various web admin applications to manage users, groups, publications etc. the admin server/dbdrivers Contains PHP files with the implementation of the drivers of the various supported databases. soap server/apps Contains PHP files implementing the various web applications such as query/browse and image upload. server/dbscripts SQL scripts for manual creation/update of the database. Also includes the abstract database model and a viewer. server/apps Contains web applications for non-admin users. server/appservices Contains web services for non-admin users. server/dhtmlsuite DHTML library used to draw advanced widgets in web applications, such as tab strips, pane splitters, toolbars, etc. server/bizclasses Contains PHP classes with the business logic. server/interfaces WSDL interface definitions. 201 Server server/adminservices Contains services for interface. server/dbclasses Contains PHP classes that contain the translation from business objects to database objects including the SQL representation. Chapter 10 Server internals 2. Customizing your business logic server/ioncube Contains libraries for all operating systems to support decryption of servercode files which were encrypted with Ioncube. server/javachart Java components used charts. (For more visit http://www.ve.com) to Enterprise offers various facilities to modify business logic or trigger additional actions as discussed in Section 18: Modifying Business Logic in Chapter 9: Server Configuration. This is the preferred way to make any changes but if your needs go further, you can customize the core server. produce information, 2.1 Open source code Server server/PEAR PHP library used by the Enterprise PHP code. The Application Server is written in PHP and SQL. Since this is open source, you are technically free to make changes. However, this is NOT recommended because of the following reasons: We can not offer support Internal interfaces, objects and the database model are subject to change and so you might need to rewrite your customizations for the next coming version. server/soap PHP classes that wrap around the PEAR SOAP subsystem. server/tinymce Contains the external tinymce library which is used in the Web Editor. server/utils Contains PHP files with utility classes and functions. The source files of the Application Server can be found at: (see next page.) server/wwtest Contains pages to test the functioning of the Enterprise server. 202 Chapter 10 Server internals Mac OS 3. Database Enterprise uses the following database tables: /Library/WebServer/Documents/ SCEnterprise/server smart_actionproperties Custom meta data properties assigned to workflow dialogs. Windows smart_authorizations Holds the authorization rules. c:\inetpub\wwwroot\ SCEnterprise\server Linux /var/www/html/SCEnterprise/server smart_config Version of installed database model. Used by database setup scripts to update the model to newer versions. smart_deletedobjects If an object is deleted, it is moved to this table. smart_elements Contains the components that an article consists of. smart_groups Definitions of user groups. 203 Server smart_appsessions Articles that are currently in draft by users working with the Web Editor application. This includes new, locked and viewed articles. Chapter 10 Server internals smart_issueeditions Holds information about the actual deadline defined for an edition in a particular issue. MadeToPrint integration. smart_messagelog Holds all messages that are sent or that are linked to an object. smart_issuesection Holds information about the actual deadline defined for a section in a particular issue. smart_namedqueries Named Query definitions. Server smart_issuesectionstate Holds information about the actual deadline and relative deadline defined for a status/section combination in a particular issue. smart_objecteditions Edition specific information for an object. smart_objectlocks Instead of using DB specific SQL features, Enterprise uses this table to lock objects. This way the system can be used cross-database. smart_log Logs user actions, can be viewed via the Logs WebApp. smart_messagelog Holds user and system messages sent to objects as well as Sticky Notes added to layouts. Also used by plan system integrations for storing messages to inform the designer working on the layout about changes made to plan. smart_mtp Holds your MadeToPrint configuration settings. smart_objectrelations Holds relations between objects, such as which articles are placed on a layout. smart_objects Meta data for all objects. Note that all objects have a unique ID. System adds custom properties to this table using “c_” prefixes. smart_objectversions Holds information about older version of object versions. integration smart_mtpsentobjects Holds the objects that are sent to the 204 Chapter 10 Server internals smart_pages For each layout (InDesign) object, this table holds the meta data of its pages. smart_publsections The sections with links to their publication. smart_routing The automatic routing definitions. smart_placements Holds detailed information about the placements of a story/image on a layout. smart_sectionstate Holds information about the relative deadline for a status in a section. smart_profiles List of Access Profiles that can be used in the entire system. smart_settings User settings, for example the user defined queries. smart_profilefeatures Definition of Access Profiles. smart_storage Holds the files when stored inside DB. smart_publeditions Publication Edition definitions. smart_tickets Tickets for users logged on. When a user logs on, a ticket is generated which is used for the subsequent calls. smart_publadmin Administrators assigned to publications. smart_publications Publication definitions of the entire system. smart_users User definitions and encrypted password. smart_publissues The issues with links to their publication. smart_usrgrp Links users with groups. 205 Server smart_states Workflow status definitions. smart_properties Custom meta data property definitions. Chapter 10 Server internals 4. Numbered storage For example: assume you have enabled the features CreatePagePreview and CreatePagePDFOnProduce (see Chapter 9: Server Configuration, Section Automatic JPG/PDF/ EPS Creation) and configured File Store storage. Then, saving an InDesign document (object id = 57) consisting of two pages to a status that has the produce flag enabled, page files are saved in the File Store as shown in table 4.1: By default, each object file stored in the File Store has the following naming conventions: For the files directly belonging to an object: [object ID] – [“thumb” | “preview” | “native”] . [version #] Server For the files belonging to pages of a layout object: [object ID] – page<number>-[“1” | “2”| “3”] File Name Version File Format Page RenditionType1 57-native current INDD 1 native 57-preview current JPG 1 preview 57-thumb v1 JPG 1 thumb 57-native.v1 v1 INDD 1 native 57-preview.v1 v1 JPG 1 preview 57-thumb.v1 v1 JPG 1 thumb 57-page1-1 current JPG 1 thumb 57-page1-2 current JPG 1 preview 57-page1-3 current PDF 1 output 57-page2-1 current JPG 2 thumb 57-page2-2 current JPG 2 preview 57-page2-3 current PDF 2 output Table 4. Example of files stored in File Store 1 The RenditionType is referring to the WDSL definition. Note that both EPS and PDF formats are stored as ‘output’ rendition type. Having both output formats enabled is NOT supported. 206 Chapter 10 Server internals 4.1 Structured storage Per object you can have more than one file. For objects likes pages and images several so-called renditions are stored which include the native file, thumbnail files, preview files etc. Also, per version additional files are stored and for layout objects also files per pages are stored. Alternatively to the numbered storage, files can be stored respecting the Publication / Issue / Section structure as objects are stored in the database. To enable this feature, set the ATTACHSTORAGE setting of configserver.php to REALFILE value. Server To ensure optimum performance when many files are stored, the system automatically creates sub folders. For instance, if you are about to store more than 1000 objects in one folder, the system creates a sub-folder named “1”. Files between 100 and 200 are stored inside that folder. The folder creation is done recursively, so if you store the 1000th file in the File Store, sub-folder named “10” is created inside the “10” folder. You can configure the number of objects to be stored inside one folder via the ATTACHMODULO setting inside the configserver.php file (the default is 100). 207 Chapter 10 Server internals 5. Backup or removal script created with step 1 above and press Go. It is possible to backup the complete content of the Enterprise database. This can also be used to recreate the database into a new installation. Step 2. Copy recursively the files from step 2 into your File Store. After this make sure access rights are set correctly. Server With the default configuration, Enterprise stores meta data inside the database and the actual files inside the File Store on disk. To back-up your installation, do the following: The description provided above cannot be used to copy the content of one Enterprise setup into another Enterprise that already has content inside. Step 1. Export/backup your SQL database. For MySQL you can do this for example with phpMyAdmin: select your database, choose export and export to file. For more info on backup of MySQL see: http://dev.mysql.com/doc/mysql/en/Backup. html http://jeremy.zawodny.com/mysql/mysqlbackup-and-recovery.html Step 2. Copy all files (recursively) from your File Store folder. To re-create the database in an empty Enterprise installation, do the following: Step 1. After creating your database with phpMyAdmin, choose SQL tab, select the SQL 208 11 Client installation 11 Serverinstallation Client internals 1. Requirements 2. Installation Adobe Applications The following section describes how to install Smart Connection Enterprise for the client applications. Adobe InDesign CS3 Adobe InCopy CS3 For installing Adobe InDesign and Adobe InCopy, follow the instructions as provided by Client Operating System Mac OS X 10.4.8 or higher Windows XP with Service Pack 2 or Windows Vista Home Premium, Business, Ultimate, or Enterprise Adobe. 2.1 Macintosh installation Hardware Step 1. Start the installation program for Smart Connection Enterprise by double-clicking the installer SCEnterprise_v5.0.x.app. Enter your system password in the Authenticate dialog and click OK. The introduction screen will appear. Same requirements and recommendations as standard InDesign/InCopy. See www.adobe.com for details. We strongly recommend to make sure enough memory is used, at least 512 Mb for InCopy and at least 768 Mb for InDesign. Step 2. Click Continue. 210 Chapter 11 Client installation Step 3. Read the license agreement and continue after agreeing with it. Allows writers working with InCopy to edit overset text in Layout mode. The column width will be the same as the source column. Step 7. Click Install. Step 4. Select the destination where to install Smart Connection Enterprise. Since the plugins need to be installed within the InDesign/ InCopy folder, this will be the same drive where these client applications are installed. Step 8. If you have multiple installations of InDesign or InCopy installed, select the installation into which you want to install Smart Connection Enterprise. Step 5. Click Continue. Step 6. Select which items to install: Client Figure 2.1b When multiple versions of InDesign or InCopy are installed, select the destination folder Setup will now install the files. When finished, click Quit to close the installer. Figure 2.1a The Enterprise custom installation screen SCEnterprise 5.0 for Adobe InDesign CS3 The client software for Adobe InDesign. SCEnterprise 5.0 for Adobe InCopy CS3 The client software for Adobe InCopy. InCopy overset plug-in. 211 Chapter 11 Client installation 2.2 Windows installation Step 1. Start the installation program for Smart Connection Enterprise by double clicking the installer SCEnterprise_v5.0.x.exe. Step 2. The Choose Setup Language screen appears. Select either English or Japanese and click Next. The introduction screen will appear. Step 3. Click Next. Figure 2.2a Select the Enterprise product to install Client Step 4. Read the license agreement and continue after agreeing with it. Step 8. Click Next to continue. Step 9. Select which components to install: Smart Connection Enterprise plug-ins The client software for Adobe InDesign/ InCopy. Documentation. The Smart Connection Enterprise User Guide in PDF format. (See figure 2.3 on the next page.) Step 5. Select which product to install: Smart Connection Enterprise 5.0 for InDesign CS3—The client software for Adobe InDesign. Smart Connection Enterprise 5.0 for InCopy CS3—The client software for Adobe InCopy. (See figure 2.2.) Step 6. Click Next to continue. Step 7. Select the destination where to install Smart Connection Enterprise. Since the plug-ins need to be installed within the InDesign/InCopy folder, this will be the same application folder where these client applications are installed. 212 Chapter 11 Client installation 3. Authorization and registration After installation, the Enterprise plug-ins for the client need to be activated. Without activation, Enterprise will not function. Enterprise can either be activated as a trial version or as a licensed version. Trial version To try out Enterprise without purchasing a license, the application can be activated for a period of 30 days after which it will stop working. Figure 2.2b The Enterprise custom installation screen Licensed version Setup will now install the files. When finished, click OK to close the installer. When concurrent licenses are used and activated server-side, you still need to activate the InDesign and InCopy client plug-ins for concurrent licensing. With a concurrent license serial you can activate an unlimited amount of InDesign/InCopy plug-ins for concurrent licensing. When logging in, the server will determine if a concurrent license is available. If not, the log-on will fail. 213 Client Smart Connection Enterprise for InDesign and InCopy can either be licensed seat-based or per concurrent user. Seat-based licenses are activated client side via the activation wizard or an activation file to activate without user interference. Concurrent licenses are administrated server-side. (See Chapter 7: Licensing.) Chapter 11 Client installation 3.1 Activating the Enterprise plug-ins For activating your copy of Enterprise as a licensed version, you need to purchase a valid license upon which you will receive a serial number. For CD delivery the serial number is typically found inside the box. The activation processes can be started from the About WoodWing Plug-Ins dialog menu. When launching InDesign or InCopy for the first time after having installed Enterprise, the About WoodWing Plug-ins dialog is displayed automatically. The dialog can also be displayed at any time by doing one of the following: Before you activate, determine which workflow to use for this process. For flexibility, activation can be done immediately through the use of the internet. Alternatively, you can send an e-mail or fax with pertinent information after which an activation code will be send back to you within two working days. Mac OS: From the InDesign or InCopy menu, select About WoodWing Plug-ins Windows: From the Help menu, select About WoodWing Plug-ins Client The About WoodWing dialog displays, showing all installed WoodWing products with their respective activation status (demo, activated or expired). Figure 3.1 The About WoodWing Plug-Ins dialog 214 Chapter 11 Client installation 3.1.1 Activation via the Internet To activate Enterprise, do the following: Windows Vista users: In order to make sure that the activation does not fail, run InDesign/ InCopy with administrator privileges. Do this by rightclicking the InDesign/InCopy application icon and selecting Run as Administrator. To activate Enterprise via the Internet, do the following: (for the first two steps in this process, see section 3.1 Activation Enterprise) Step 3. Click Next. On the screen that appears, enter the serial number that you received. Step 1. From the list, select Enterprise. Step 2. Choose the Activate button. A screen appears informing that the serial number needs to be validated. Figure 3.1.1a Enter the provided serial number When you don’t have a serial number and would like to first try out the product without purchasing it, leave the serial number field blank and select the option “I don’t have a WoodWing serial number and I would like to activate a demo license”. The option to register the product is selected by default. If you do not want 215 Client Activation can be done via the Internet or by fax/ email. For activation via the Internet, follow the steps as explained in Section 3.1.1 Activation via the Internet. For activation via fax/email, follow the steps as explained in Section 3.1.2 Activation via fax/email. Chapter 11 Client installation 3.1.2 Activation via fax or email to register, de-select it. (For more information on the benefits of registering your product, see section 4 Registering Enterprise.) To activate Enterprise via fax or email, do the following: (for the first two steps in this process, see section 3.1 Activation Enterprise) Step 4. Click the Next button. If you have opted to register the product, a screen appears where you can fill out your personal details. Else, a dialog appears informing you that the activation wizard is now ready to contact the WoodWing server via the Internet. In case you are using a proxy server, you must specify its settings before connecting. Select the option “Use a HTTP Proxy Server” and type your proxy information in the specified fields. Step 3. Select the option “I don’t have access to the Internet or I rather activate through email or fax. Please note that this takes two business days.” Step 4. Click Next. You are requested to send in your WoodWing serial number, the Adobe serial number and registration info, including name, company name, email and address. Client When the authorization process is completed, the results are displayed on screen: Figure 3.1.2a When activating by fax or email, you are prompted to send in serial numbers and personal details Figure 3.1.1b Enterprise successfully activated Click the Copy button to copy the InDesign / InCopy serial number to the Step 5. Click Finish and restart the application. 216 Chapter 11 Client installation Step 9. To verify that the activation has been successful, open the About WoodWing plugins dialog: clipboard so that it can be easily pasted into an email. Step 5. E-mail or fax the details to: Email: [email protected] Fax: See the number listed in the dialog. Mac OS: From the InDesign or InCopy menu, select About WoodWing Plug-ins Step 6. Click Cancel to leave the activation process. Windows: From the Help menu, select About WoodWing Plug-ins Within two business days, your authorization code will be e-mailed or faxed to you. Both methods require a different way of activating the software. After the authorization code is delivered by email: Step 7. You will receive a file named WWActivate.xml. Place this in the following location: Client Mac OS: Library:Preferences:WoodWing Figure 3.1.2b Enterprise successfully activated Windows XP: C:\Document and Settings\All Application Data\WoodWing After the authorization code is delivered by fax: Step 7. Return to the About WoodWing Dialog box. Users\ Windows Vista: C:\ProgramData\WoodWing Step 8. Select Enterprise Activate. Step 8. Restart Indesign / InCopy. 217 Chapter 11 Client installation Step 9. Select the option “I don’t have access to the Internet or I rather activate through email or fax. Please note that this takes two business days.”. Choose Next and Next again. Step 10. In the screen that appears, enter your WoodWing serial number and the received authorization code. Figure 3.1.2d Enterprise successfully activated Client Step 12. Click Finish and restart InDesign or InCopy. Figure 3.1.2c Enter the received authorization code Step 11. Choose Next to start the authorization process. When the authorization process is completed, the results are displayed on screen: (See figure 3.1.2d.) 218 Chapter 11 Client installation 4. Registering Enterprise 3.2 Transferring an activation Once the Enterprise software has been activated, it is possible to transfer your serial number to another computer. You still have only one license, but this will allow you to switch to another computer if needed. Registration is an optional process and is not required. When registering your product, you are eligible to receive product upgrades and technical support. Registering a WoodWing product can only be done during the activation process. Step 1. Display the About ������������������������ WoodWing Plug-ins menu : Mac OS: From the InDesign or InCopy menu, select About WoodWing Plug-ins Windows: From the Help menu, select About WoodWing Plug-ins To register Enterprise, do the following: Step 1. Follow steps 1 and 2 as described in Section 3.1 Activating Enterprise. Step 2. Select the Enterprise plug-in. Step 2. The option to register the product is selected by default. Make sure that it is still selected. Step 3. Choose the Transfer Activation button. Client The dialog indicates that the serial number must be validated through access to the internet. Step 4. Choose Next. A Step 5. If needed, fill out the proxy settings. Step 6. Choose Next to continue. A Step 7. Upon activation results, choose Finish. Register product option Figure 4a. The option for registering your product is selected by defaut 219 Chapter 11 Client installation 5. Uninstalling Enterprise Step 3. With the correct activation information entered, click the Next button. A window for entering your personal details appears. The installer for Enterprise can also be used to remove the application from your system. 5.1 Uninstalling from Macintosh To un-install Enterprise from a Macintosh, do the following: Before beginning, close all open applications. Step 1. Double-click the Enterprise Installer (������������������������������������������ SCEnterprise_5.0.x.app�������������������� ). The Introduction screen appears. Client Figure 4b. Enter your details on the registration screen Step 4. Click Next and continue with the activation steps as outlined in section 3.1.1 Activating via the Internet and Setion 3.1.2 Activating via e-mail or fax. Step 2. On the Introduction Screen, click Continue. The License screen appears. Step 3. Click Continue followed by Agree to continue the installation. Step 4. Select the Destination drive and click Continue. Step 5. Open the Custom Install drop-down menu and choose Uninstall. Figure 5.1 Selecting uninstall from the drop-down menu 220 Chapter 11 Client installation 5.2 Uninstalling from Windows Step 6. Click Uninstall. A message appears stating that when clicking the Continue button, all open applications will be automatically closed. Ensure that any unsaved documents are saved first before proceeding. To un-install Enterprise from a Windows system, do the following: Before beginning, close all open applications. Step 7. Click Continue to continue with the uninstalling process (or click Cancel to close the dialog without starting the uninstalling process). Step 1. Navigate �������������������������������������� to the Control Panel via the Windows Start Menu and choose Add or Remove Programs. Step 8. If you have more than one version of InDesign/InCopy installed, the uninstaller will prompt you to select from which version you want to uninstall Enterprise. Select the desired version and click OK. Step 2. Choose Smart Connection Enterprise v5.0 from the list of installed programs. Enterprise will be uninstalled. Step 4. Confirm that you want to remove the selected application and all of its features. Enterprise will be uninstalled. Step 3. Choose the Remove button. 221 Client Once the uninstall process is completed, a message displays informing you that several plug-ins are left on the system. These plug-ins are required for other WoodWing applications that may be installed. In case no other WoodWing software is present on your system, these can be manually removed by deleting the WoodWing folder from the InDesign or InCopy Plug-Ins folder respectively. Chapter 11 Client installation 6. Basic client configuration Windows XP The installation installs a configuration file named WWSettings.xml through which various Enterprise settings can be controlled. This default configuration file includes two Enterprise servers: localhost and WoodWing. The first assumes to have the Enterprise Application server on the same machine as the client machine. This obviously is not the normal production situation. The WoodWing server can be used for testing and we advice to remove this from the configuration file for production, just to prevent any mistakes. C:\Documents and Settings\ All Users\Application Data\WoodWing This folder is hidden by default. To display this folder, change the folder options. (For more information on displaying hidden folders, see the Windows XP Help file.) Windows Vista The location of the WWSettings.xml file has been changed since the introduction of Smart Connection Enterprise 4.0: C:\Program Data\WoodWing This folder is hidden by default. To display this folder, change the folder options. (For more information on displaying hidden folders, see the Windows Vista Help file.) Client Mac OS Library:Preferences:WoodWing The WWSettings.xml file can be changed with a plain text editor. Examples of the default contents are shown on the next page. 222 Chapter 11 Client installation Examples of the WWSettings.xml content: Default content <?xml version="1.0" encoding="utf-8"?> <Settings xmlns:SCEnt="urn:Smart Connection Enterprise"> <SCEnt:Servers> <SCEnt:ServerInfo name="localhost" url="http://127.0.0.1/SCEnterprise/ index.php"/> <SCEnt:ServerInfo name="WoodWing" url="http://demo.woodwing.net/ SCEnterprise/index.php"/> </SCEnt:Servers> </Settings> Your content (assuming a single Application Server) can look like: <?xml version="1.0" encoding="utf-8"?> <Settings xmlns:SCEnt="urn:Smart Connection Enterprise"> <SCEnt:Servers> <SCEnt:ServerInfo name="Server" url="http://SCEntServer/SCEnterprise/ index.php"/> </SCEnt:Servers> </Settings> Client 223 Client Chapter 11 Client installation intentionally left blank 224 12 Client configuration 12 Client configuration This chapter explains the configuration options of the Enterprise client as well as its exposed functions for scripting purposes. This folder is hidden by default. To display this folder, change the folder options. (For more information on displaying hidden folders, see the Windows XP Help file.) Client 1. Configuration settings Windows Vista Settings are applied through the WWSettings.xml file, the location of which has changed since the introduction of Enterprise 4.0: C:\Program Data\WoodWing This folder is hidden by default. To display this folder, change the folder options. (For more information on displaying hidden folders, see the Windows Vista Help file.) Mac OS Library:Preferences:WoodWing The WWSettings.xml file can be changed with a plain text editor. Windows XP C:\Documents and Settings\ All Users\Application Data\WoodWing 226 Chapter 12 Client configuration 1.1 Fixed list of application servers 1.3 Enable automatic view updates For information how to set the list of application servers, see Section 6: Basic Client Configuration in Chapter 11: Client Installation. The Enterprise plug-ins for InDesign and InCopy automatically update the Smart Connection palette on most user database actions such as Save, Close etc. These automatic view updates can be enabled with the setting below: 1.2 Dynamic list of application servers When using a different or customized server, it might be required to get a list of servers from the Application Server. For this usage you must use only one ServerInfo element below Settings. That server is then used to retrieve the list of servers dynamically. For instance: <SCEnt:ViewUpdate/> The disadvantage of this option is that for each update a query is sent resulting in server and network load. A good alternative is enabling the broadcasting mechanism as written in Chapter 6: Server Configuration, Messages and Events. This causes significantly less server/network load. 1.4 Automatic check-out on place The following setting can be used for InDesign to force articles to automatically check-out after placing. 227 <SCEnt:CheckOutOnPlace/> Client <Settings> <SCEnt:ServerInfo name="Server" url="http://SCEntServer/ SCEnterprise/index.php"/> </Settings> Chapter 12 Client configuration 1.5 Automatic update Enterprise panel user is the user name of an authorized proxy user. The password is the password associated with the proxy user. The following setting can be used to let the Smart Connection Panel update automatically. If you do not set this, then the browse content of the panel is not updated automatically but needs to be refreshed manually. 1.8 Silent save To suppress the Save dialog when using the Save Version command, add the following setting: <SCEnt:AutoRefreshPanel/> <SCEnt:SilentSaveVersion/> 1.6 Ask before updating links 1.9 Automatic XML mapping Client The following setting can be used to prevent automatic updating of links in your document. When this setting is set you will be asked if you want to update the links in your document. The following setting can be used for both InDesign and InCopy to automatically call the Map Styles to Tags and Map Element Labels to Tags commands before an InCopy file is saved to the database. <SCEnt:SkipUpdateLinks/> This makes sure the InCopy XML articles contain additional XML tags that allow easy conversion with XLSLT. An obvious downside is the fact that saving of InCopy files (also check-in articles from InDesign) will become somewhat slower. 1.7 Use proxy settings The following setting can be used to enable clients behind a proxy server. <SCEnt:Proxy address="proxy_ address" user="proxy_user" password="proxy_password"/> The address is the address of the proxy server. The 228 <SCEnt:MapStyleTagsToXML/> Chapter 12 Client configuration Windows 1.10 Using https connections How to use https Connections to the Enterprise Server is explained in a separate document . Contact your local reseller/integrator for more details. <SCEnt:LogFile RequestBuffer= "C:\SCEnt_client_log\" ResponseBuffer= "C:\SCEnt_client_log\" SOAPResponse= "C:\SCEnt_client_log\" SOAPRequest= "C:\SCEnt_client_log\" Advanced = "true" /> 1.11 Automatic logon The following setting can be used to automatically login to the server at start-up. Obviously using this setting can introduce a security breach. The value of the location should be the name as specified in the server list. (See section 1.2: Dynamic list of Application Servers.) Mac OS <SCEnt:AutoLogin name="user" pw="pw" location="server"/> 1.12 Logging The Enterprise plug-ins for InDesign and InCopy offer extensive logging capabilities. The following setting dumps files of all network requests and responses. Most interesting are typically the SOAP request and response. With the Advanced attribute set, a sub folder is created per session, storing all calls sequentially. This attribute is meant to be set temporary for detailed analysis because the required storage space will grow significantly. If the Advanced attribute is not set (or set to "false"), per type of call only the last one will be saved (overwriting any previous one). Required storage space will stay about the same, but now only the last call of each type can be traced and there is no way to determine the call sequence. 229 Client <SCEnt:LogFile RequestBuffer="Macintosh HD:log" ResponseBuffer="Macintosh HD:log" SOAPResponse="Macintosh HD:log" SOAPRequest="Macintosh HD:log" Advanced = "true"/> Chapter 12 Client configuration Apart from the log file there is also a logging mechanism that writes all kind of information to a log file. Note that this file keeps growing and can become very large. You can also filter logging in specific areas, for example: <Logging level="0" allareas="0"> <area name="SCEnt-Workspace"/> <area name="SCEnt-Logon"/> </Logging> The location of the WWLog.xml is inside the InDesign and InCopy folders. Up until version v3.4, a log file existed named WWLog.txt which was located in both the InDesign and InCopy application folders. Since version v4.0 these files have been renamed to WWLog_InDesign.txt and WWLog_InCopy.xml. The Logging attributes have the following options: level all = 0, info = 2, warning = 5, error = 8 all areas only listed areas enabled = 0, all areas enabled = 1 area name SCPro-MCV, SCEnt-Workspace, SCEntLogon,SCEnt-DIME, SCEnt-MIME, SCEntSOAP, SCEnt-HTTP, SCEnt-HTTPTimer The location of these log files is: Mac OS Client 1.13 Obsolete options Users:<user name>:Library: Preferences:WoodWing Since Smart Connection Enterprise v3.3, the following options have become obsolete: PDFExportPreDefinition changed into a server feature NoViewUpdate changed into ViewUpdate Windows c:\Documents and Settings\<user name>\Application Data\WoodWing To enable logging, add the following code to WWSettings.xml: <Logging level="0" allareas="1"> </Logging> 230 Chapter 12 Client configuration 1.14 Offline documents 1.15 Smart Connection palette character size Offline documents are stored locally in the following folders: The size of the characters in the Smart Connection palette can be set to Small (default), Medium, Large or ExtraLarge. This option only enlarges the size of the characters in the query results. All other fields (such as the drop-down lists, menu items, etc) remain the default size. Also, the height of the rows in the palette remains the same. Mac OS Users:<user name>:Documents: Smart Connection:InCopy <SCEnt:PanelFontSize Size="Small"/> <SCEnt:PanelFontSize Size="Medium"/> <SCEnt:PanelFontSize Size="Large"/> <SCEnt:PanelFontSize Size="ExtraLarge"/> Users:<user name>:Documents: Smart Connection:InDesign Windows 1.16 UseRecoveryBaseFolder By default the client creates a sub folder in the user's documents folder to (temporarily) store the files received from the server. For sites that are using roaming profiles where the user's folder is located on a server, this results in degraded performance as the file is transferred at least three times across the network. The UseRecoveryBaseFolder setting allows the client to store documents in the same folder as where InDesign stores its recovery files. This recovery location can be configured through the File Handling preference of InDesign and InCopy. C:\Documents and Settings\ <user name>\MyDocuments\ Smart Connection\InDesign 231 Client C:\Documents and Settings\ <user name>\MyDocuments\ Smart Connection\InCopy Client Chapter 12 Client configuration intentionally left blank 232 13 Web Editor installation 13 Web Editor installation 1. Installation steps This chapter provides a list of steps that need to be performed for installing and activating the Smart Connection Enterprise Web Editor 5.0. The Web Editor installation consists of two parts: the installation of the actual Web Editor on the server side and the installation of the Web Editor plug-ins for InDesign Server (required for the Compose, Preview and Create PDF functionality). 1.1 Installing the Web Editor on the server Web Editor The Web Editor is part of the Enterprise Web Applications and is installed during the normal installation of Smart Connection Enterprise. (For more information on the server installation, see Chapter 6: Server Installation.) 234 Chapter 13 Web Editor installation Mac OS 1.2 Installing Web Editor for InDesign Server To install the Web Editor for InDesign Server, do the following: Step 1. Run the InDesign Server CS3 setup to install InDesign Server CS3, as per Adobe’s instructions. WoodWing.pln.InDesignPlugin b) Remove the following plug-ins from the Plug-ins\InCopyWorkflow folder, located in the InDesign Server CS3 application folder: InCopy Bridge.InDesignPlugin InCopyExport.InDesignPlugin InCopyImport.InDesignPluginWoodWing InDesignPlugins.pln.InDesignPlugin Step 2. Add the Enterprise Web Editor files to the InDesign Server CS3 installation: The plug-ins are available on the Partner website http://partners.woodwing.net. Mac OS Windows a) Copy the following plug-ins into the Plug-ins\WoodWing folder of your InDesign Server CS3 installation: Element Label.pln SCCore Content.pln SCCore DataLink.pln SCCore Geometry.pln SCCore InDesign.pln SCCore StickyNotes.pln SCCore Template.pln SCEntEditioning.pln SCFile.pln SCPro Frames InDesign.pln WoodWing.pln 235 Web Editor a) Copy following plug-ins from the Windows archive into the Plug-ins\WoodWing folder of your InDesign Server CS3 installation: Element Label.pln.InDesignPlugin SCCore Content.pln.InDesignPlugin SCCoreDataLink.pln.InDesignPlugin SCCore Geometry.pln.InDesignPlugin SCCore InDesign.pln.InDesignPlugin SCCore StickyNotes.pln.InDesignPlugin SCCore Template.pln.InDesignPlugin SCEntEditioning.pln.InDesignPlugin SCFile.pln.InDesignPlugin SCPro Frames InDesign.pln.InDesignPlugin WoodWing Frameworks.pln.InDesignPlugin Chapter 13 Web Editor installation Windows product. Replace INSERT YOUR SERIAL HERE with the serial number you received. The wwact:auth_code element is optional and contains the authorization code needed to activate the product. In case you cannot activate the product over the internet, this code can be obtained by contacting the support team. Replace manualActivation with the code received from the support team. b) Copy the following DLL’s to the InDesign Server CS3 application folder: libcurl-7_16_0.dll xerces-c_2_6.dll c) Remove the following plug-ins from the Plug-ins\InCopyWorkflow folder, located in the InDesign Server CS3 application folder: InCopy Bridge.apln InCopyExport.apln InCopyImport.apln Step 4. Place the WWActivate.xml file in the following location: Mac OS /Library/Preferences/WoodWing/ Step 3. Activate the Web Editor plug-ins by creating a WWActivate.xml file with the content as shown in figure 1.2. Windows XP Web Editor The wwact:serial element must contain the serial number you received with the C:\Documents and Settings\All Users\ Application Data\Woodwing\ <?xml version=”1.0” encoding=”UTF-8” standalone=”yes” ?> <wwact:activate xmlns:wwact=”http://www.woodwing.com/activation.xml”> <wwact:product> <wwact:key>SCPRID500</wwact:key> <wwact:serial>INSERT YOUR SERIAL HERE</wwact:serial> <wwact:autho_code>manualActivation</wwact:autho_code> </wwact:product> </wwact:activate> Figure 1.2 The WWActivate.xml file for activating the Web Editor plug-ins for InDesign Server 236 Chapter 13 Web Editor installation 1.2.1 Starting InDesign Server CS3 This folder is hidden by default. To display this folder, change the folder options. (For more information on displaying hidden folders, see the Windows XP Help file.) To start InDesign Server CS3 with the soap interface enabled, you need to specify the port to the application. After following the steps below, the soap interface of the server will be available on port 18383. Windows Vista Startup can also be automated using Scheduled Tasks (Windows), or Macaroni C:\ProgramData\Woodwing\ (Mac). This folder is hidden by default. To display this folder, change the folder options. (For more information on displaying hidden folders, see the Windows Vista Help file.) Windows Open a command prompt Change to the directory C:\Program Files\ Adobe\Adobe InDesign Server CS3\ Type indesignserver –port 18383 Mac OS Change to the directory /Applications/Adobe InDesign Server CS3/ Type ./InDesignServer –port 18383 237 Web Editor Open a new Terminal window Chapter 13 Web Editor installation 1.2.2 InDesign Server configuration settings INDESIGNSERV_HOST Defines the address and port on which the soap interface of InDesign Server CS3 is available. Important to note is that it is an http address. The port you started the InDesign Server CS3 with is defined after a colon. You can use the dns name instead of the host’s ip address. To be able to use InDesign Server CS3 with the Web Editor, the following variables need to be set in the configserver.php file of the Smart Connection Enterprise server. The configserver.php file is stored in the following locations: Example: define ('INDESIGNSERV_HOST', 'http://170.0.0.101:18383'); Mac OS When InDesign Server is running on a different machine than Enterprise server, make sure that the port is not blocked by firewalls or routers. /Library/WebServer/Documents/ SCEnterprise/config TEMPLATEDIR Location where the company article templates can be stored. These templates can then be used to create new articles in the web editor. (For more information, see Section 1: Configserver.php Settings in Chapter 14: Web Editor Configuration.) Windows Web Editor c:\inetpub\wwwroot\SCEnterprise\ config Linux WEBEDITDIR Defines the location where the Enterprise Server will put files for use by InDesign Server CS3. (For more information, see Section 1: Configserver.php Settings in Chapter 14: Web Editor Configuration.) /var/www/html/SCEnterprise/config 238 Chapter 13 Web Editor installation 1.2.3 Testing InDesign Server WEBEDITDIRIDSERV Defines the location where InDesign Server CS3 will look up files that have been made available by the Enterprise Server. Typically this is a mounted folder (network folder). Physically the folder is same folder as defined in the WEBEDITDIR setting. The InDesign Server CS3 process must be able to read existing files and write new files in this folder. To see if the system is performing properly, do the following: Step 1. Open your web browser and go to http://<yourserver>/SCEnterprise/server/ wwtest. Examples: define (‘WEBEDITDIRIDSERV’, ’/Volumes/webedit/’); define (‘WEBEDITDIRIDSERV’, ’//170.0.0.101/webedit/’); A A Advanced button Figure 1.2.3a The wwtest page Step 2. Click the Advanced button. Step 3. Select the InDesign Server/Web Editor 239 Web Editor In this example, 'webedit' is a share created at the Enterprise server's machine, which is mounted at the InDesign Server's machine. The share gives read/write access to the InDesign Server process and is mapped onto the WEBEDITDIR location at the Enterprise server's machine. Chapter 13 Web Editor installation 2. Activation test and press the Test button. After installing the Web Editor, licenses need to be activated for each user. For more information on licensing, see Chapter 7: Licensing. Figure 1.2.3b Selecting the InDesign Server / Web Editor test Web Editor The test, if successful, shows the version of the InDesign Server CS3 instance and the version and state of all WoodWing products installed. 240 14 Web Editor configuration 14 Web Editor configuration Windows This chapter provides a list of settings settings for managing and configuring the Web Editor. c:\inetpub\wwwroot\SCEnterprise\ config 1. Configserver.php settings Linux To ensure that the article can be edited, the following settings in the configserver.php must be set correctly. /var/www/html/SCEnterprise/config Web Editor The configserver.php file is stored in the following locations: Mac OS /Library/WebServer/Documents/ SCEnterprise/config 242 Chapter 14 Web Editor configuration 1.1 Server settings user', Linux: 'nobody', Windows: 'IUSR_ <machine>'. INDESIGNSERV_HOST Defines the address and port on which the soap interface of InDesign Server CS3 is available. (For more information, see Section 1.2.2 InDesign Server Configuration Settings in Chapter 13: Web Editor Installation.) Example (for all platforms): define( 'WEBEDITDIR', WOODWINGSYSTEMDIRECTORY.'/ WebEdit/' ); When modifying the default location of the WebEdit folder, we advice not to use the FileStore folder itself, but to always create a sub directory. This to avoid conflicts with documents that are stored in the FileStore folder when using the REALFILE option. (For more information on the REALFILE option, see Section 3: Where to Store the Files in Chapter 8: Server Configuration.) TEMPLATEDIR Defines the location where the company article templates can be stored. These templates can then be used to create new articles in the web editor. Example: define( 'BASEDIR.'/config/ articletemplates/' ); 243 Web Editor WEBEDITDIRIDSERV The logical access path, from InDesign Server perspective, to the physical location specified by WEBEDITDIR. (For more information, see Section 1.2.2 InDesign Server Configuration Settings in Chapter 13: Web Editor Installation.) Example (for all platforms): define ('WEBEDITDIRIDSERV', WOODWINGSYSTEMDIRECTORY.'/ WebEdit/'); WEBEDITDIR Defines the location where the Enterprise Server will put files for use by InDesign Server CS3. By default this is a folder as defined by WOODWINGSYSTEMDIRECTORY.The default values are /FileStore/_SYSTEM_ (Mac OS) or c:/FileStore/_SYSTEM_ (Windows). Therefore, the default location of WEBEDITDIR is: Mac OS: /FileStore/_SYSTEM_/WebEdit Windows: c:/FileStore/_SYSTEM_/WebEdit It’s important that Enterprise Server has Read and Write access to this folder: Mac OS: 'www Chapter 14 Web Editor configuration 1.2 Server features WEB_MIN_FONT_SIZE Minimal font height in points, to be used in text widgets (default=8). (For readability during editing only. This has no effect on content or storage.) Additional features can be enabled by adding one of the following options to the SERVERFEATURES section of the configserver.php file: For examples on how to define the following settings in configserver.php, see Appendix E: Web Editor Server Features. WEB_MAX_FONT_SIZE Maximum font height in points, to be used in text widgets (default=36). (For readability during editing only. This has no effect on content or storage.) DisabledWebEditorButtons This setting defines which buttons will not be available in the Web Editor toolbar. The list is comma separated. Add one of the following values to remove the button: bold, italic, underline, strikethrough, charmap, sub, sup, bullist, numlist, styleselect, styleselectchar, removeformat, undo, redo, zoom, search, replace, print, visualchars, undo, redo, zoom, search, replace, print, visualchars, spellchecker. Web Editor Example: new Feature( 'WebEditorDictionaries', 'enUS,frFR,nlNL' ), WebEditorDictionaries Listed dictionaries for the spellchecker in the Web Editor. Currently supported languages are: English (enUS), Dutch (nlNL), French (frFR), Italian (itIT), Spanish (esES), Polish (plPL), 244 Chapter 14 Web Editor configuration 1.2.1 Features no longer supported Danish (daDK), German (deDE) and Swedish (svSV). Use commas to list more than one: 'enUS,nlNL'. The following features are no longer supported: AutoSaveInterval Defines the save interval for automatically saving articles to the workspace folder. Enter '0' to disable the feature or add a value for a specific number of minutes. LABELHEIGHTS WEBDISABLEMARKUP As an alternative, use the option DisabledWebEditorButtons. This can be listed in the SERVERFEATURES option. Example: new Feature( 'AutoSaveInterval', '15' ), SilentSaveVersion Surpresses the Save Version dialog when user presses the Save Version button. This feature is disabled by default. Example: new Feature( 'SilentSaveVersion' ), Web Editor For InDesign Server specific settings, see Chapter 13: Web Editor Installation. 245 Chapter 14 Web Editor configuration 2. The workspace folder 3. Implemented GUI technology A workspace folder is used as a temporary storage for draft versions of articles. The location is defined in the WEBEDITDIR option of the configserver.php file. Each article component can be edited in the Web Editor via a so-called text widget. These widgets rely on a third-party component named TinyMCE. The Web Editor embraces this product to outsource all text editing and formatting complexities. Currently, TinyMCE version 2.1 is implemented and can be found in the /server/tinymce folder. By default, articles are automatically saved to the workspace folder every five minutes. (For more information, see Section 1.2 Server Features.) Read-only articles are not auto-saved. Many GUI widgets, such as the workflow toolbar and its buttons, the slide bar between the two panes, the tabs in the side pane and the dialog borders with their grayed-out background overlay are all implemented by DHTML Suite modules. The Web Editor embraces this product to outsource GUI complexities and browser compatibilities. The suite can be found in the /server/ utils/dhtmlsuite folder. If needed, the look & feel of all widgets mentioned can be adjusted via the files found in the /config/webeditor-themes/ww folder. The folder is also used for storing (temporary) files when the Compose, Preview and PDF Creation options are used. Ensure therefore that InDesign Server has got full access to this folder by means of the WEBEDITDIRIDSERV setting. Web Editor When the Check In or the Abort Checkout option is used, the temporary sub folders are removed again. 246 Chapter 14 Web Editor configuration 4. Article templates 5. Save version dialog Article templates that users have access to via the Start Article page, need to be made available by the Administrator (Company templates by the sys admin, Publication templates by the pub admin.). It is not possible for Web Editor users to either create or store templates themselves. Users can save an intermediate version by pressing the Save Version button in the toolbar. This will bring up a Save Version dialog where settings can be set for saving the article. The Save Version dialog can be suppressed by adding the following option to the FEATURESET section of the configserver.php file: new Feature( 'SilentSaveVersion' ), Templates should be stored in InCopy format with a .wwcx file extension. The Web Editor works with two types of article templates: Company templates and Publication templates. 6. Workflow dialogs Workflow dialogs raised in the Web Editor are dynamically drawn and respect customizations made through the MetaData and Dialog Setup admin pages. (For more information, see Section B12. Meta Data in Chapter 8: Publication and Workflow Setup.) The following features are currently not implemented: Tab support (grouping) Date/time and Boolean fields Min/Max value validation Read-only and mandatory fields Protected fields Publication templates are specific to a Publication/Issue/Section and stored as any other object in a publication/issue/section location. 247 Web Editor Company templates are used throughout the company and are stored in the /config/articletemplates folder. Templates stored in this folder become available for all users, regardless of their defined access rights. One such template is provided by Enterprise, named “default”. (Contrary to Enterprise 4.2, this template is not any more required for converting plain text articles to InCopy articles. Enterprise 5 will keep plain text as it is.) Chapter 14 Web Editor configuration 7. Browsers 7.2 Clearing the browser cache The Web Editor users will run the Web Editor within a web browser. The following sections describe how to configure and set up these browsers. It is recommended to clear the browser cache before working with the Web Editor for the first time. To clear the browser cache, do the following: 7.1 Browser compatibility FireFox 2.0 Macintosh/Windows: From the Tools menu, select Clear Private Data. Make sure that the option Cache is selected and press the Clear Private Data Now button. The following browsers are compatible with the Web Editor version 5.0: Macintosh Windows Internet Explorer not supported version 7.0 FireFox version 2.0 Internet Explorer 7.0 Windows: Step 1. From the Tools menu, select Internet Options. Step 2. Choose the General tab. Step 3. Under Browsing History, click Delete. Step 4. Go to Temporary Internet Files and click Delete files. Step 5. Click Close, followed by OK to close the dialog. Web Editor version 2.0 248 Chapter 14 Web Editor configuration 7.3 Browser tabs Articles can be opened in separate tabs, thereby facilitating working on multiple articles at the same time. For Internet Explorer 7, this functionality needs to be enabled by doing the following: Step 1. Open Internet Explorer 7. Step 2. Select Tools, followed by Internet Options. Step 3. Click Settings. Step 4. Select the option Always Open Popups in New Tab. Step 5. Click OK to close the dialog. Web Editor 249 Web Editor Chapter 14 Web Editor configuration intentionally left blank 250 15 Troubleshooting 15 Troubleshooting 1. Initial testing This chapter describes the steps to follow when encountering problems with Smart Connection Enterprise. The first step is to execute all tests on the wwtest page. (For more information, see section G: Testing the Enterprise Server of Chapter 6: Server Installation.) Extra In case something unexpected happens on the client, it could be useful to turn on client logging. (For more information, see Chapter 12: Client Configuration.) 252 Chapter 15 Troubleshooting 2. Common errors When saving a file from a client application, I get an error For example: HTTP error 413 Unsupported encoding, use one of ISO8859-1, US-ASCII, UTF-8 Empty page when going to http://Server/ SCEnterprise Try adding /index.htm at the end of the URL. If this works, then the problem is either that your web server has not set index.htm nor index.html as the default page or it has set index.php as the default page with a higher priority. (The latter happens typically on Linux installations; check the PHP installation steps in Chapter 6: Server Installation for solutions.) When such a low-level error happens it typically means some maximum value has been exceeded such as the maximum upload size. (See the PHP installation steps in Chapter 6: Server Installation for which values need to be increased in config.php and conf.php (Linux). Logon/logoff Test fails in a Smart Connection Enterprise/IIS web server configuration Performing the logon/logoff test on the wwtest page results in an error similar to: “LogOn Logon FAILED: HTTP Response 401 Authentication Failed Time elapsed: 0.02s” Extra This error message refers to the fact that the access rights are not correctly set for the web user. You should open IIS and check the Anonymous Access and Authentication Control settings on the Directory Security tab. Click the Edit button and make sure that at least the Anonymous Access check box is set. It is not necessary to also have the Integrated Windows Authentication checked (you may do this but it is not required). 253 Chapter 15 Troubleshooting 3. Verifying client version information 4. Verifying server version information To check which version of Enterprise is installed for the InDesign and InCopy clients, do the following: To check on the server side which version of Enterprise is installed , do the following: Mac OS: From the InDesign or InCopy menu, select About WoodWing Plug-ins Step 1. Open your browser and enter http://<yourserver>/SCEnterprise/server/ wwtest. Windows: From the Help menu, select About WoodWing Plug-ins Step 2. Click on the Configuration Overview link at the top of the page. The Configuration Overview page appears with the exact version of Enterprise listed in the header. The About WoodWing Plug-ins Window opens and displays the WoodWing web address plus a list of WoodWing software and the version(s) installed on your system. Figure 4a. The configuration overview page Also, the version is listed in the web application at the bottom of the navigation menu. Extra Figure 3. The About WoodWing Plug-Ins dialog Figure 4b. The version of Enterprise is listed at the bottom of the navigation menu 254 Chapter 15 Troubleshooting 5. How to obtain support REALFILE) Have any customizations been done? Send any sample files along that may help speed up the process For any technical queries, please visit our Knowledge Base first. It provides answers to Frequently Asked Questions as well as tips, hints and background information. The Knowledge Base is available at WoodWing’s web site www.woodwing.com. Should you require additional support, contact your local dealer (for a list of local dealers visit the WoodWing website www.woodwing.com). Extra In case you have not bought your software through a local dealer, contact WoodWing’s Support Department by filling out the Support Form on www.woodwing.com. Supply them with the following information: Version of both client and server applications Steps performed (please be as detailed as possible since the smallest step could be important) Expected results Actual results Provide an HTML output of the “Configuration overview” test from the wwtest page Server OS and version Database used Web Server used PHP version used (CGI/ISAPI) Files stored in database or FileStore (FILE/ 255 Extra Chapter 15 Troubleshooting intentionally left blank 256 A Meta data properties A Meta data properties In the Enterprise environment, each different meta data field type stored in the system is called a property. There are a few different types of properties with each having its own level of customization. It is synchronized by the system with Adobe XML meta data as stored inside Adobe files as well as in the database. The table on the following pages shows how the XML properties are mapped onto the database fields. Extra For more information on meta data, see Section B12: Meta Data in Chapter 8: Publication and Workflow Setup. A258 Appendix A Meta data properties WSDL (SOAP) Adobe XMP Adobe FileInfo dialog (UI) IPTC / EXIF smart_objects table (DB) - documentid Copyright Status - copyrightmarked BasicMetaData DocumentID DocumentID - RightsMetaData CopyrightMarked CopyrightMarked Copyright CopyrightNotice Copyright Notice Copyright String Copyright CopyrightURL CopyrightURL Copyright Info URL - copyrighturl Credit Credit Origin | Credit Credit credit Source Source Origin | Source Src source Author Author Author Credit Src author Subject ImageDescription UserComment Comments Description Caption Image Description description Byline Caption Writer descriptionauthor Keywords Keyword keywords slugline SourceMetaData ContentMetaData Description DescriptionAuthor Keywords Keywords Slugline Title Document Title Headline Byline Title Image Name ColorSpace - - Colorspace JPEGColorspace colorspace - - Geometry (WxH) depth Width - - Geometry (WxH) width FileSize - - Filesize filesize A259 Extra Height Appendix A Meta data properties WSDL (SOAP) Adobe XMP Format format Dpi XResolution Adobe FileInfo dialog (UI) IPTC / EXIF smart_objects table (DB) - Format format - Resolution Units dpi WorkflowMetaData Instructions Origin | Instructions Special Instructions comment Urgency Urgency Origin | Urgency - urgency Modified ModifyDate - - modified Created CreateDate Origin | Date Created - created Extra Comment A260 B Action property list B Action property list Extra When creating a dialog setup (as described in Section B13.1 Creating a Dialog or Query Setup in Chapter 8: Publication and Workflow Setup), various meta data action properties can be selected from a list named Property. The table on the following pages describes in detail what each property is used for. B262 Appendix B Action property list Fieldname in smart_objects table description Author Author Author of an object as shown in the FileInfo dialog in InDesign. Character Count LengthChars Number of characters in an Article object. Color Space ColorSpace BW, RGB, CMYK, LAB, etc. (Only for Image, Video, Audio, Advert and Layout objects.) Columns Columns Number of columns used for an article. Comment Comment Comment on any object. Stored per version of the object. Content PlainContent The whole textual content of an Article object. We advise against using this property in query results as this may decrease performance. Copyright Copyright Copyright as read from an Image, Audio or Video object and as shown in the FileInfo dialog in InDesign. Copyright Marked CopyrightMarked CopyrightMarked as read from an Image, Audio or Vide object and as shown in the FileInfo dialog in InDesign. Copyright URL CopyrightURL CopyrightURL as read from an Image, Audio or Vide object and as shown in the FileInfo dialog in InDesign. Created By Creator First creator of the object. This may be the user who imported (uploaded) an existing file. Created On Created Date and time when the object was first inserted (created) into the database. Credit Credit Credit of an object as shown in the FileInfo dialog in InDesign. Deadline Deadline Deadline of any object, depending on the workflow state of the object. Must have configured deadlines in the webapp. Description Description Description of an object as shown in the FileInfo dialog in InDesign. B263 Extra Property Extra Appendix B Action property list Property Fieldname in smart_objects table description Description Author DescriptionAuthor Author of the Description of an object as shown in the FileInfo dialog in InDesign. Doc ID DocumentID XMP document ID of an object. Dpi Dpi Dots per Inch for Image objects. Flag Flag Property to denote a Flagged status in the sense that there is something special with this object: the object needs attention. Read-only property. FlagMsg FlagMsg Property to denote a Flagged status (see Flag) in the sense that there is something special with this object: the object needs attention. This is the textual message that accompanies the Flag. Read-only property. Format Format Mime type of an object. Height Height Height in points. ID ID Unique id of an object as stored in the database. In Use By LockedBy Name of the user by whom an object is locked. Empty if the object is not locked. Keywords Keywords Keywords of an object as shown in the FileInfo dialog in InDesign. Line Count LengthLines Number of lines in an Article. Modified By Modifier Name of the user who has last edited the object. Important: setting the properties of an object will not result in a change of the Modifier field. Modified On Modified When the object was last edited. Important: setting the properties of an object will not result in a change of the Modified field. B264 Appendix B Action property list Property Fieldname in smart_objects table description Page Range PageRange Page range of a Layout. Paragraph Count LengthParas Number of paragraphs in an Article. Placed On Placed On Typically the Layout on which an Article or Image has been placed. Route To RouteTo User or group of users to whom the object is routed. Will appear in the inbox of that user or all users in the user group. Size FileSize File size of the ‘native’ rendition (main file) of an object, in bytes. Slugline Slugline Snippet of the content of an article. Source Source Source of an object as shown in the FileInfo dialog in InDesign. Type Type Object type of the object as stored in the database, for example Article or Image. Urgency Urgency Urgency or Priority of an object. Can be set by an user. Version Version Current version of the object, starting at 0. Width Width Width in points Word Count LengthWords Number of words in an Article. Extra B265 Extra Appendix B Action property list intentionally left blank B266 C Named query examples C Named query examples Named queries can be created by the administrator users via the Named Query option of the Maintenance menu (see section B14. Named Queries of Chapter 8: Publication and Workflow Setup). Named queries show up in the user’s query palette and will execute an SQL statement that is defined as part of the named query definition. Extra This appendix shows two examples of a named query: Wildcard Search and User Inbox. C268 Appendix C Named query examples 1. Wildcard search query comment interface NameSearch Wildcard search for object name. ObjectName,string ObjectType,list,Layout,Article/ArticleTemplate/Layout/LayoutTemplate sql select o.id as “ID”, o.type as “Type”, o.name as “Name”, st.state as “State”, ul.fullname as “LockedBy”, p.publication as “Publication”, i.issue as “Issue”, s.section as “Section”, o.comment as “Comment”, o.routeto as “RouteTo”, o.creator as “Creator”, o.format as “Format”, um.fullname as “Modifier”, p.id as “PublicationId”, i.id as “IssueId”, s.id as “SectionId”, st.id as “StateId” from smart_objects as o left join smart_publications as p on (o.`publication` = p.`id`) left join smart_publissues as i on (o.`issue` = i.`id`) left join smart_publsections as s on (o.`section` = s.`id`) left join smart_states as st on (o.`state` = st.`id`) left join smart_objectlocks as l on (o.`id` = l.`object`) left join smart_users as ul on (l.`usr` = ul.`user`) left join smart_users as um on (o.`modifier` = um.`user`) where o.`name` like “%$ObjectName%” and o.`type` = “$ObjectType” and (o.`state`!=-1 OR (o.`state`=-1 AND o.`routeto`=’$user’)) Extra C269 Appendix C Named query examples 2. User inbox Extra query comment Inbox User inbox. Shows objects that are routed to current user (or group of which current user is member of). interface sql select o.id as “ID”, o.type as “Type”, o.name as “Name”, st.state as “State”, ul.fullname as “LockedBy”, ol.name as “PlacedOn”, o.filesize as “FileSize”, um.fullname as “Modifier”, o.modified as “Modified”, p.publication as “Publication”, i.issue as “Issue”, s.section as “Section”, o.comment as “Comment”, o.routeto as “RouteTo”, o.creator as “Creator”, o.format “Format”, um.fullname as “Modifier”, p.id as “PublicationId”, i.id as “IssueId”, s.id as “SectionId”, st.id as “StateId” from smart_objects as o left join smart_users as um on (o.`modifier` = um.`user`) left join smart_users as uc on (o.`creator` = uc.`user`) left join smart_objectlocks as l on (o.`id` = l.`object`) left join smart_users as ul on (l.`usr` = ul.`user`) left join smart_objectrelations as r on (o.`id` = r.`child`) left join smart_objects as ol on (r.`parent` = ol.`id`) left join smart_publications as p on (o.`publication` = p.`id`) left join smart_publissues as i on (o.`issue` = i.`id`) left join smart_publsections as s on (o.`section` = s.`id`) left join smart_states as st on (o.`state` = st.`id`) left join smart_groups as gr on (o.`routeto` = gr.`name`) left join smart_usrgrp as ug on (gr.`id` = ug.`grpid`) left join smart_users as ur on (ug.`usrid` = ur.`id`) where o.`routeto` = “$user” or ur.`user`= “$user” C270 D Geometry update examples D Geometry update examples Extra The next pages contain examples of using the Geometry Update and Remote Module features as described in Section 11: Geometry Update and Remote Module of Chapter 9: Server Configuration. D272 Appendix D Geometry update examples Geometry disabled define('SERVERFEATURES', serialize( array( )) ); Geometry enabled using 72 DPI preview files define('SERVERFEATURES', serialize( array( new Feature( 'UseXMLGeometry ), )) ); Geometry enabled using 300 DPI previews define('SERVERFEATURES', serialize( array( new Feature( 'UseXMLGeometry ), new Feature( 'GeometryPreviewResolution', 300 ), )) ); To benefit from this setting, ensure that the Display Performance setting in InCopy is set to High Quality (Preferences > Display Performance). Geometry enabled without preview files define('SERVERFEATURES', serialize( array( new Feature( 'UseXMLGeometry ), new Feature( 'SuppressGeometryPreview' ), )) ); Extra D273 Appendix D Geometry update examples Extra GeometryPreviewQuality Possible values: 1 (low), 2 (good), 3 (excellent), 4 (great) define('SERVERFEATURES', serialize( array( new Feature( 'UseXMLGeometry ), new Feature( 'GeometryPreviewQuality', 3 ), )) ); D274 E Web Editor server features E Web Editor server features Extra The following page provide examples on the options that can be set for the Web Editor in the configserver.php file. (For more information, see Chapter 14: Web Editor Configuration.) E276 Appendix E Web Editor server features define (‘SERVERFEATURES’, serialize(array( new Feature( 'DisabledWebEditorButtons', 'underline, strikethrough'), // hide “Underline” and “Strike-Through” buttons new Feature( 'WebEditorDictionaries', 'enUS,frFR,nlNL' ), // show English, French and Dutch dictionaries new Feature( 'AutoSaveInterval', '0' ), // zero means disabled new Feature( 'SilentSaveVersion' ), // suppress save dialog )) ); define ('INDESIGNSERV_HOST', 'http://127.0.0.1:18383'); // ID Server address define ('TEMPLATEDIR', BASEDIR.'/config/articletemplates/'); define ('WEBEDITDIR', '/WebEditor/workspace/'); define ('WEBEDITDIRIDSERV', 'Volumes/webedit/'); // public share, mounted to folder '/WebEditor/workspace/' define( 'WEB_MIN_FONT_SIZE', 6 ); // editor font size never shown smaller than 6 points define( 'WEB_MAX_FONT_SIZE', 40 ); // editor font size never shown larger than 40 points Extra E277 Appendix E Web Editor server features Default: define ('SERVERFEATURES', serialize(array( ... //new Feature( 'DisabledWebEditorButtons', '' ), //new Feature( 'WebEditorDictionaries', '' ), //new Feature( 'AutoSaveInterval', '0' ), //new Feature( 'SilentSaveVersion' ), ... )) ); Extra define (‘INDESIGNSERV_HOST’, ‘’); // ID Server address, for example http://myidserver:18383 define (‘TEMPLATEDIR’, BASEDIR.’/config/articletemplates/’); // including trailing / template directory define (‘WEBEDITDIR’, WOODWINGSYSTEMDIRECTORY.’/WebEdit/’); // including trailing / define (‘WEBEDITDIRIDSERV’, WOODWINGSYSTEMDIRECTORY.’/WebEdit/’); // path to (mounted) WEBEDITDIR location from InDesign Server perspective (including trailing /) //define( ‘WEB_MIN_FONT_SIZE’, 8 ); // set minimum editor font size (to avoid unreadable text) //define( ‘WEB_MAX_FONT_SIZE’, 32 ); // set maximum editor font size (to avoid unreadable text) E278 F Revisions F Revisions Admin Guide version 5.0.1 - November 9, 2007 Issue comments 6843 Issue comments DB option for ATTACHSTORAGE only supported for Oracle systems. (See Chapter 9 Server Configuration, Section 3: Where to Store Files.) 6640 Additional info on Custom metadata set as 'Type = List' (See Chapter 6 Server Installation, Section G1. Upgrading custom properties.) 6861 Info added on ionCube installation. (See Chapter 6 Server Installation, Section B: ionCube Installation; Section C. PHP installation & configuration, Step 3, Windows.) 6743 Additional option added to my.cnf file when using mysql and DB as filestorage. (See Chapter 6 Server Installation, Section A1. MySQL installation, Windows, Step 7.) 6868 6805 Changed fax number reference. (See Chapter 11 Client Installation, Section 3.1.2 Activation via fax or email.) Order field issue must be filled in when Current Issue feature is used. (See Chapter 8 Publication and Workflow Setup, Step ���������������������� 12. Final Settings, Section B2.2: Reordering issues.) 6909 Upgrade instructions refined. (See Chapter 6 Server Installation, Section G. Upgrading to Enterprise 5.0, SQL.) n/a Added info on client activation on Windows Vista. (See Chapter 11 Client Installation, Section 3.1 Activating the Enterprise plug-ins.) Extra 1. Changes in version 5.0.1 6808 Added available languages for Enterprise. (See Chapter 2 Introducing Smart Connection Enterprise, Section 2: Available Languages.) F280 Appendix F Revisions Admin Guide version 5.0.0 - October 15, 2007 2. Changes in version 5.0.0 New Enterprise version 5 features Web Editor Extra F281 Extra Appendix F Revisions F282 Index Index A Automatic routing_ _________________________ 107 AutoRefreshPanel__________________________ 228 AutoSaveInterval_____________________ 245, E277 Access profiles_____________________________ 132 Deleting access profiles__________________ 133 Reordering access profiles________________ 133 Setting up access profiles_ ________________ 86 Action property list_ ______________________ B262 Activating licenses___________________________ 67 Activating a license offline (Client)___________ 73 Activating a license offline (Server)___________ 69 Activating a license online (Client)___________ 72 Activating a license online (Server)_ _________ 68 Activating client licenses___________________ 71 Activating the Enterprise Server license______ 67 Activating additional Enterprise licenses____ 70 Admin authorizations_ _______________ 14, 16, 131 Adding admin authorizations______________ 131 Deleting admin authorizations_____________ 132 AlwaysSaveDocIntoDatabase___________ 172, 194 APPLICATION_SERVERS_ __________________ 196 Application server_______________________ 20, 23 Architecture________________________________ 20 Application server________________________ 20 Client___________________________________ 20 Database_ ______________________________ 20 Article templates___________________________ 247 ATTACHMENTDIRECTORY__________ 52, 166, 167 ATTACHMODULO__________________________ 168 ATTACHSTORAGE_________________________ 167 AutoLogin_________________________________ 229 B BASEDIR_ _______________________ 52, 165, E277 Broadcasting______________________________ 194 Browsers_ ________________________________ 248 C CACHEDIR________________________________ 193 CheckOutOnPlace_________________________ 227 Clean up__________________________________ 153 Client______________________________________ 20 Client configuration____________________ 222, 226 Client installation___________________________ 210 Macintosh installation____________________ 210 Windows installation_____________________ 212 CompanyLanguage_________________________ 194 config.php_ ___________________________ 51, 165 ATTACHMENTDIRECTORY_______ 52, 166, 167 BASEDIR_ _________________________ 52, 165 DBPASS___________________________ 52, 165 DBSELECT_________________________ 52, 165 DBUSER___________________________ 52, 165 EXPORTDIRECTORY________________ 52, 166 FILENAME_ENCODING__________________ 166 INETROOT_________________________ 52, 165 LANGPATAMPM________________________ 166 283 Index LANGPATDATE_________________________ 166 TEMPDIRECTORY_ _________________ 53, 166 WOODWINGSYSTEMDIRECTORY_____ 52, 166 configserver.php_ _________ 53, 167, 193, 238, 242 AlwaysSaveDocIntoDatabase_____________ 172 APPLICATION_SERVERS________________ 196 ATTACHMODULO_______________________ 168 ATTACHSTORAGE______________________ 167 BASEDIR_ ___________________________ E277 CACHEDIR_____________________________ 193 CreatePageEPSOnProduce_______________ 170 CreatePagePDF_________________________ 171 CreatePagePDFOnProduce_______________ 171 CreatePagePreview______________________ 170 CREATEVERSION_ONSTATECHANGE_____ 194 DBMAXQUERY_________________________ 167 DBPREFIX_ ____________________________ 193 DBSERVER_ _______________________ 54, 167 DBTYPE___________________________ 53, 167 DEADLINE_WARNTIME__________________ 194 ENCRYPTION_PRIVATEKEY_PATH_ _______ 196 ENCRYPTION_PUBLICKEY_PATH_________ 197 EXPIREDEFAULT________________________ 174 EXPIREWEB____________________________ 174 EXTENSIONMAP________________________ 193 GeometryPreviewResolution_ _____________ 180 HOLIDAYS_____________________________ 194 INDESIGNSERV_HOST_ ______ 238, 243, E277 LDAPServer____________________________ 197 MAX_ARTICLE_VERSION_ _______________ 174 MAX_AUDIO_VERSION__________________ 175 MAX_IMAGE_VERSION__________________ 174 MAX_LAYOUT_VERSION_________________ 175 MAX_LIBRARY_VERSION________________ 175 MAX_VIDEO_VERSION_ _________________ 175 MC_MEDIATOR_ADDRESS__________ 181, 194 MC_MEDIATOR_PORT______________ 181, 194 MIMEMAP_ ____________________________ 193 MULTICAST_IF_ ___________________ 181, 194 MULTICAST_TTL___________________ 180, 194 NetworkDomain_________________________ 197 NONWORKDAYS_ ______________________ 194 OUTPUTDIRECTORY____________________ 191 PASSWORD_CRYPT_ ___________________ 193 PASSWORD_EXPIRE____________________ 186 PASSWORD_MIN_CHAR_________________ 186 PASSWORD_MIN_LOWER_______________ 186 PASSWORD_MIN_SPECIAL______________ 186 PASSWORD_MIN_UPPER________________ 186 PERSONAL_STATE______________________ 193 PERSONAL_STATE_COLOR______________ 194 RETURN_SHORT_USERNAMES__________ 194 SAVEFIRST_ARTICLE_VERSION_ _________ 175 SAVEFIRST_AUDIO_VERSION_ ___________ 175 SAVEFIRST_IMAGE_VERSION____________ 175 SAVEFIRST_LAYOUT_VERSION___________ 175 SAVEFIRST_LIBRARY_VERSION__________ 175 SAVEFIRST_VIDEO_VERSION_____________ 175 SERVERADDONS_______________________ 193 ServerCreateImagePreview_ ______________ 190 SERVERFEATURES_ _________ 194, 244, D273 AlwaysSaveDocIntoDatabase___________ 194 284 Index AutoSaveInterval________________ 245, E277 Broadcasting_________________________ 194 CompanyLanguage____________________ 194 CreatePageEPS_______________________ 194 CreatePageEPSOnProduce_____________ 194 CreatePagePDF_______________________ 194 CreatePagePDFOnProduce_____________ 194 CreatePagePreview____________________ 194 CreatePagePreviewOnProduce__________ 194 DisabledWebEditorButtons_ ______ 244, E277 EventPort____________________________ 194 GeometryPreviewQuality_ ____________ D274 GeometryPreviewResolution__________ D273 HotInbox_____________________________ 194 KeepCheckedOut_____________________ 194 LABELHEIGHTS______________________ 245 Messaging___________________________ 194 ServerCreateImagePreview_____________ 194 SilentSaveVersion_______________ 245, E277 StoreSettings_________________________ 194 SuppressGeometryPreview_______ 194, D273 UseXMLGeometry_______________ 194, D273 Versioning____________________________ 194 WEB_MAX_FONT_SIZE________________ 244 WEB_MIN_FONT_SIZE________________ 244 WEBDISABLEMARKUP________________ 245 WebEditorDictionaries___________ 244, E277 SERVERURL___________________________ 193 SuppressGeometryPreview_______________ 180 TEMPLATEDIR_______________ 238, 243, E277 UPDATE_GEOM_SAVE__________________ 193 UseXMLGeometry__________________ 172, 180 WEB_MAX_FONT_SIZE________________ E277 WEB_MIN_FONT_SIZE_________________ E277 WEBEDITDIR________________ 238, 243, E277 WEBEDITDIRIDSERV_________ 239, 243, E277 XMLTYPE______________________________ 194 Configuration overview_______________________ 60 CreatePageEPS____________________________ 194 CreatePageEPSOnProduce_____________ 170, 194 CreatePagePDF_______________________ 171, 194 CreatePagePDFOnProduce_____________ 171, 194 CreatePagePreview____________________ 170, 194 CreatePagePreviewOnProduce_______________ 194 CREATEVERSION_ONSTATECHANGE________ 194 Current Issue_________________________ 111, 116 Current issue_______________________________ 15 Custom event handling______________________ 192 Customizing Customizing your business logic___________ 202 Interface_______________________________ 176 Changing the terminology_ _____________ 177 Custom property___________________________ 141 D Database_ _________________________________ 20 Backup or removal_ _____________________ 208 DB Admin page_____________________________ 54 DBMAXQUERY____________________________ 167 DBPASS______________________________ 52, 165 DBPREFIX_ _______________________________ 193 DBSELECT____________________________ 52, 165 285 Index DBSERVER_ __________________________ 54, 167 DBTYPE______________________________ 53, 167 DBUSER______________________________ 52, 165 Deactivating licenses_________________________ 74 DEADLINE_WARNTIME_____________________ 194 Deadlines__________________________________ 16 Relative deadlines_______________________ 102 Relative deadlines of Editions_ __________ 103 Relative deadlines of Sections___________ 103 Relative deadlines of Section States______ 104 Relative deadlines of Statuses___________ 104 Setting up deadlines______________________ 96 Further setting up deadlines_____________ 102 Dialog setup_______________________________ 144 Action property list_ ___________________ B262 Creating a dialog or query setup___________ 144 Deleting a dialog setup___________________ 148 Editing a dialog setup____________________ 148 Restricted meta data_____________________ 147 DisabledWebEditorButtons_ _________________ 244 Documents Offline documents_______________________ 231 ENCRYPTION_PUBLICKEY_PATH____________ 197 EventPort_________________________________ 194 Events. See Messages Custom event handling___________________ 192 EXPIREDEFAULT___________________________ 174 EXPIREWEB_______________________________ 174 EXPORTDIRECTORY___________________ 52, 166 EXTENSIONMAP___________________________ 193 F Features New features_____________________________ 7 Access rights on meta data_______________ 7 Admin SOAP interface___________________ 8 Current Issue concept_ ________________ 7, 9 Dossiers_______________________________ 7 Full scripting support____________________ 7 Pagination per edition____________________ 7 Planning SOAP interface_ ________________ 9 Prevent download of placed objects________ 7 Server-side licensing & concurrent licensing 9 Web Editor usability enhancements________ 8 FILENAME_ENCODING_____________________ 166 File Store______________________________ 27, 51 E Editions____________________________ 14, 15, 120 Creating editions_________________________ 98 Deleting editions_ _______________________ 121 Editing an edition________________________ 121 Reordering editions______________________ 120 Email notifications__________________________ 183 ENCRYPTION_PRIVATEKEY_PATH_ __________ 196 G GeometryPreviewQuality_ _________________ D274 GeometryPreviewResolution_ __________ 180, D273 Geometry update_ _________________________ 179 Examples____________________________ D272 Ghostscript________________________________ 186 286 Index Groups___________________________________ 134 Adding a user to a group_____________ 83, 135 LDAP________________________________ 84 Copying groups_________________________ 134 Creating groups__________________________ 80 Deleting a group_ _______________________ 136 Editing a group_ ________________________ 135 Current Issue______________________ 111, 116 Current issue____________________________ 15 Deleting issues__________________________ 117 Editing an issue_________________________ 119 Next issue_______________________________ 15 Previous issue___________________________ 15 Remove Issue page_ ____________________ 154 Reordering issues_______________________ 116 H K HOLIDAYS________________________________ 194 HotInbox__________________________________ 194 Hot inbox_________________________________ 182 httpd.conf__________________________________ 45 KeepCheckedOut__________________________ 194 L LABELHEIGHTS_ __________________________ 245 LANGPATAMPM___________________________ 166 LANGPATDATE____________________________ 166 LANGPATTIMEDIFF_________________________ 166 Language Selecting the language___________________ 177 Languages Available languages_______________________ 10 LDAP Adding users and groups__________________ 84 LDAPServer_______________________________ 197 libcurl-7_16_0.dll___________________________ 236 libeay32.dll_________________________________ 43 License status page_________________________ 66 Licensing_ _________________________________ 64 Activating licenses________________________ 67 Activating a license offline (Client)_________ 73 Activating a license offline (Server)_ _______ 69 I Imagemagick______________________________ 186 INDESIGNSERV_HOST_ _________ 238, 243, E277 INETROOT____________________________ 52, 165 Installation - Client. See Client installation Interface Customizing____________________________ 176 ionCube_ __________________________________ 38 Installation______________________________ 38 Supported platforms______________________ 38 Troubleshooting__________________________ 40 Upgrading_______________________________ 40 Versions_ _______________________________ 39 Windows php.ini settings__________________ 44 Issues________________________ 14, 15, 111, 116 Copying an issue________________________ 119 Creating an issue_________________________ 94 287 Index Activating a license online (Client)_________ Activating a license online (Server)_ _______ Activating client licenses_________________ Activating the Enterprise Server license____ 72 68 71 67 MAX_IMAGE_VERSION_____________________ 174 MAX_LAYOUT_VERSION____________________ 175 MAX_LIBRARY_VERSION___________________ 175 MAX_VIDEO_VERSION_ ____________________ 175 MC_MEDIATOR_ADDRESS_____________ 181, 194 MC_MEDIATOR_PORT_________________ 181, 194 Messages_________________________________ 180 Email notifications_______________________ 183 Hot inbox______________________________ 182 Live update_____________________________ 181 User messages_________________________ 181 Messaging________________________________ 194 Meta data_________________________________ 139 Creating a custom property_______________ 141 Deleting a meta data item_ _______________ 143 Editing a meta data item__________________ 143 Meta data properties___________________ A258 Restricted meta data_____________________ 147 MIMEMAP_ _______________________________ 193 Monitoring. See Logging MSSQL____________________________________ 31 MSSQL 2005 configuration________________ 37 MULTICAST_IF_ ______________________ 181, 194 MULTICAST_TTL______________________ 180, 194 my.cnf_____________________________________ 32 MySQL____________________________________ 31 Installation______________________________ 31 Activating additional Enterprise licenses 70 Deactivating licenses______________________ 74 InDesign and InCopy licenses______________ 65 Removing licenses_ ______________________ 75 Server connection licenses_________________ 65 Web Editor licenses_______________________ 65 Live update_______________________________ 181 Logging___________________________________ 169 Client logging___________________________ 229 High-level monitoring_ ___________________ 169 LOGLEVEL_____________________________ 169 Log page_ _____________________________ 156 Low-level debug monitoring_______________ 169 OUTPUTDIRECTORY____________________ 169 LOGLEVEL________________________________ 169 Log page_ ________________________________ 156 M MadeToPrint_______________________________ 160 Creating a MadeToPrint rule_______________ 161 Deleting a MadeToPrint rule_______________ 162 Editing a MadeToPrint rule________________ 161 MadeToPrint settings_ ___________________ 195 MapStyleTagsToXML________________________ 228 max_allowed_packet_ ___________________ 32, 33 MAX_ARTICLE_VERSION_ __________________ 174 MAX_AUDIO_VERSION_____________________ 175 N Named queries_ ___________________________ 149 Creating a named query__________________ 149 288 Index Deleting a named query__________________ 151 Editing a named query___________________ 151 Examples____________________________ C268 Network configuration________________________ 27 NetworkDomain____________________________ 197 New features. See Features Next issue__________________________________ 15 NONWORKDAYS_ _________________________ 194 php_gd2.dll_ _______________________________ 42 php_mbstring.dll____________________________ 42 php_mssql.dll_______________________________ 42 php_openssl.dll_____________________________ 43 php_sockets.dll_____________________________ 42 Phpinfo page_______________________________ 60 PHP interface_______________________________ 23 phpMyAdmin Installing________________________________ 49 Plan interface test page______________________ 61 Preview Preview generation______________________ 186 Ghostscript__________________________ 186 Imagemagick_________________________ 186 Preview test page___________________________ 61 Previous issue______________________________ 15 Publication_____________________________ 14, 15 Publications_______________________________ 112 Copying a publication____________________ 113 Creating a publication____________________ 112 Deleting a publication____________________ 115 Editing a publication_____________________ 115 Periodic publications______________________ 91 Project-oriented publications_______________ 91 Reordering publications__________________ 114 Setting up a publication___________________ 91 O Offline documents__________________________ 231 Online Users page__________________________ 160 Oracle_____________________________________ 31 Oracle 10g configuration_ _________________ 33 OUTPUTDIRECTORY__________________ 169, 191 P PanelFontSize_ ____________________________ 231 PASSWORD_CRYPT_ ______________________ 193 PASSWORD_EXPIRE_______________________ 186 PASSWORD_MIN_CHAR____________________ 186 PASSWORD_MIN_LOWER__________________ 186 PASSWORD_MIN_SPECIAL_________________ 186 PASSWORD_MIN_UPPER___________________ 186 Password management_____________________ 186 PERSONAL_STATE_________________________ 193 PERSONAL_STATE_COLOR_________________ 194 PHP PHP installation & configuration_____________ 41 php.ini_____________________________________ 42 php_exif.dll_________________________________ 42 Q Queries Named queries. See Named queries Examples__________________________ C268 289 Index User queries____________________________ 152 Deleting sections________________________ 123 Editing a section_ _______________________ 123 Reordering sections_ ____________________ 122 Security___________________________________ 173 SERVERADDONS__________________________ 193 Server connection licenses___________________ 65 ServerCreateImagePreview_ ____________ 190, 194 SERVERFEATURES_ _______________________ 194 SERVERURL______________________________ 193 SilentSaveVersion_ ______________ 228, 245, E277 SkipUpdateLinks___________________________ 228 SmartConnectionAdmin.wsdl_ _________________ 8 Smart Connection palette Character size__________________________ 231 Smart Hyphen_______________________________ 6 Smart Layout________________________________ 6 Smart Styles_________________________________ 6 SOAP interface_ ________________________ 20, 22 ssleay32.dll_________________________________ 43 Storage Numbered storage_ _____________________ 206 Structured storage_ _____________________ 207 StoreSettings______________________________ 194 Storing files_________________________________ 26 Support_____________________________________ 3 SuppressGeometryPreview_______ 180, 194, D273 R Relative deadlines__________________________ 102 Relative deadlines of Editions______________ 103 Relative deadlines of Sections_____________ 103 Relative deadlines of Section states________ 104 Relative deadlines of Statuses_____________ 104 Remote module____________________________ 179 Removing licenses_ _________________________ 75 Reporting_________________________________ 185 Reports Creating a user authorization report________ 128 RETURN_SHORT_USERNAMES_____________ 194 Revisions_ __________________________________ 3 Routing Automatic routing_ ______________________ 107 Routing rules_______________________ 14, 16, 126 Adding routing rules_ ____________________ 126 Deleting routing rules_ ___________________ 127 Editing routing rules______________________ 127 S SAVEFIRST_ARTICLE_VERSION_ ____________ 175 SAVEFIRST_AUDIO_VERSION_ ______________ 175 SAVEFIRST_IMAGE_VERSION_______________ 175 SAVEFIRST_LAYOUT_VERSION______________ 175 SAVEFIRST_VIDEO_VERSION________________ 175 Section________________________________ 14, 16 Sections__________________________________ 122 Creating sections_________________________ 97 T TEMPDIRECTORY_ ____________________ 53, 166 TEMPLATEDIR__________________ 238, 243, E277 290 Index W Terminology Changing the terminology_ _______________ 177 Trash Can_________________________________ 155 Empty Trash Can________________________ 156 WAMMP___________________________________ 31 WEB_MAX_FONT_SIZE_______________ 244, E277 WEB_MIN_FONT_SIZE________________ 244, E277 WEBDISABLEMARKUP_____________________ 245 WEBEDITDIR___________________ 238, 243, E277 WEBEDITDIRIDSERV____________ 239, 243, E277 Web Editor Arcticle templates_______________________ 247 Browsers_ _____________________________ 248 Web Editor configuration_ ________________ 242 Web Editor installation_ __________________ 234 Workspace folder_ ______________________ 246 WebEditorDictionaries_________________ 244, E277 Web Editor licenses__________________________ 65 WebServer_________________________________ 47 WOODWINGSYSTEMDIRECTORY________ 52, 166 Workflow__________________________ 14, 16, 124 Adding a workflow_______________________ 124 Deleting workflow statuses________________ 125 Editing a workflow status_________________ 125 Setting up a workflow_____________________ 99 Workflow setup_____________________________ 80 Workspace folder_ _________________________ 246 WWActivate.xml____________________________ 236 WWLog_InCopy.xml________________________ 230 WWLog_InDesign.txt_ ______________________ 230 WWSettings.xml_ _____________________ 222, 226 AutoLogin______________________________ 229 AutoRefreshPanel_______________________ 228 CheckOutOnPlace_______________________ 227 U Uninstalling Enterprise (client)________________ 220 Uninstalling from Macintosh_______________ 220 Uninstalling from Windows________________ 221 UPDATE_GEOM_SAVE_ ____________________ 193 User authorizations__________________ 14, 16, 128 Controlling user authorizations_____________ 109 Creating a user authorization report________ 128 Deleting user authorization rules___________ 130 Deleting user authorizations_______________ 129 Editing user authorization rules____________ 130 User messages____________________________ 181 User queries_______________________________ 152 Users_____________________________________ 136 Adding a user to a group_____________ 83, 138 LDAP________________________________ 84 Copying users__________________________ 137 Creating_ _______________________________ 80 Deleting a user__________________________ 138 Editing a user___________________________ 138 Online Users page_______________________ 160 UseXMLGeometry___________ 172, 180, 194, D273 V Versioning____________________________ 174, 194 ViewUpdate_______________________________ 227 291 Index MapStyleTagsToXML_____________________ 228 PanelFontSize_ _________________________ 231 SilentSaveVersion_ ______________________ 228 SkipUpdateLinks________________________ 228 ViewUpdate____________________________ 227 wwtest_ _____________________________ 239, 254 wwtest page_ __________________________ 54, 59 X XAMPP____________________________________ 31 xerces-c_2_6.dl____________________________ 236 XML Geometry Update______________________ 179 XMLTYPE_________________________________ 194 292 Hyphen nection Catalog hen Styles Speller alog WoodWing Software Zaandam, The Netherlands Tel +31 75 61 43 400 [email protected] WoodWing USA Detroit, Michigan USA Tel +1 313 962 0542 [email protected] WoodWing Asia Pacific Kuala Lumpur, Malaysia Tel +60 3 2163 4935 [email protected] Layout es ller www.woodwing.com Products, features and specifications are subject to change without prior notice. The Adobe logo, InDesign and InCopy are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/ or other countries. All other trademarks are the property of their respective owners. ©2007 WoodWing Software