Macromedia InDesign - CS6 Server Development User Guide
ADOBE® INDESIGN® CS6
INTRODUCTION TO ADOBE
INDESIGN CS6
SERVER DEVELOPMENT
2012 Adobe Systems Incorporated. All rights reserved.
Introduction to Adobe® InDesign® CS6 Server Development
If this guide is distributed with software that includes an end user agreement, this guide, as well as the software
described in it, is furnished under license and may be used or copied only in accordance with the terms of such license.
Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or
transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written
permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law
even if it is not distributed with software that includes an end user license agreement.
The content of this guide is furnished for informational use only, is subject to change without notice, and should not be
construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or
liability for any errors or inaccuracies that may appear in the informational content contained in this guide.
Please remember that existing artwork or images that you may want to include in your project may be protected under
copyright law. The unauthorized incorporation of such material into your new work could be a violation of the rights of
the copyright owner. Please be sure to obtain any permission required from the copyright owner.
Any references to company names in sample templates are for demonstration purposes only and are not intended to
refer to any actual organization.
Adobe, the Adobe logo, InCopy, and InDesign are either registered trademarks or trademarks of Adobe Systems
Incorporated in the United States and/or other countries. Windows s either a registered trademark or a trademark of
Microsoft Corporation in the United States and/or other countries. Mac OS is a trademark of Apple Computer,
Incorporated, registered in the United States and other countries. All other trademarks are the property of their
respective owners.
Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Notice to U.S. Government End Users.
The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R. §2.101, consisting of
“Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48
C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through
227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are
being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted
to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright
laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S.
Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the
provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act
of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR
Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding
sentence shall be incorporated by reference.
Contents
1 Introduction to Adobe InDesign Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About Adobe InDesign Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Where to start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
C++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
COM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
launchd Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Performance and scalability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2 Installing and Running InDesign Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installing InDesign Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Running the installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
CJK feature set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Firewalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Installing the InDesign Server Windows Service (Windows only) . . . . . . . . . . . . . . . . . . . . . . 10
Installing the InDesign Server SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Running InDesign Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
InDesign Server command-line arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Starting InDesign Server from the command line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Starting InDesign Server for use with SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Starting InDesign Server for use with CORBA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Starting from another program or script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Running multiple InDesign Server instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Quitting InDesign Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Configuring InDesign Server Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Configuring an InDesign Server launchd daemon for Mac OS . . . . . . . . . . . . . . . . . . . . . . . . . 17
3 Interfacing with InDesign Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Interfacing with InDesign Server through SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Using sampleclient to run an InDesign Server script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Interfacing with InDesign Server through a plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Interfacing with InDesign Server through COM (Windowsonly) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Visual Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Interfacing with InDesign Server through LBQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Handling error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Accessing errors and messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3
4
Redirecting errors and messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Frequently asked questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Can I specify both a SOAP port and an IOR file when launching the server? . . . . . . . . . . . . 27
Is there an index of all classes and methods in the InDesign Server scripting DOM? . . . . 27
Can I interact with InDesign Server if I launch it without SOAP? . . . . . . . . . . . . . . . . . . . . . . . 27
How do I return a value from my script to my SOAP client? . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4 Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
InDesign Server scripting and plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
JavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1
Introduction to Adobe InDesign Server
This document includes an overview of Adobe® InDesign® Server. It describes how to install and run
InDesign Server in a simple environment and describes how to communicate with InDesign Server from
external components.
About Adobe InDesign Server
InDesign Server is used by systems integrators and solution developers to build server-based publishing
solutions. You can think of InDesign Server as a version of InDesign with no user interface. It is built on the
same code base as the desktop version of InDesign, but it is adapted for server use. The adaptations
include support for multiple instances, error capturing and logging, and communication through SOAP.
Like its desktop counterpart, InDesign Server offers a rich development environment. It supports open
standards such as XML, and it is highly scriptable and extensible. InDesign Server can be extended by
using the APIs supplied in the InDesign plug-in SDK and the InDesign Server scripting SDK. These APIs can
be used to create C++ plug-ins, JavaScript scripts, AppleScript scripts, and VBScript scripts.
Where to start
Refer to Getting Started with the Adobe InDesign Server SDK for information on where to start, what is
contained in the InDesign Server SDK installation directory, and how to use the samples provided with the
SDK.
Term in ol og y
This section defines terms used throughout this document:
Ant — Another Neat Tool, a Java-based build tool.
Client—A requester of services from a server in a distributed computing system.
COM—Component Object Model, a technology facilitating interoperability between applications and
components.
IDS—InDesign Server.
<IDS>—The directory where you installed InDesign Server.
<IDS SDK> — The directory where you installed the InDesign Server SDK.
InDesign Server SDK —Includes various technologies for working with InDesign Server, such as SOAP.
All InDesign Server documentation is included in this SDK.
InDesign scripting DOM—Scripting document object model. This refers to the objects within InDesign
and their hierarchy, as accessed through scripting.
InDesign scripting SDK—The API for accessing the scripting DOM.
5
CHAPTER 1: Introduction to Adobe InDesign Server Roadmap 6
IOR file—Interoperable Object Reference file. This is used by CORBA and its clients to identify an object
in the CORBA object model.
IPv6—Internet Protocol Version 6, the successor to IPv4. IPv6 is supported by InDesign CS4 Server and
later.
Job queueing—A mechanism that queues submitted jobs, executes them asynchronously, and
provides a means to later check a job’s status.
Load balancing—Distributing jobs across multiple instances and servers based on availability.
<locale>—In a path, the language version of InDesign Server; for example, english.
LBQ—An add-on component, Load Balancing and Queuing, that performs job queueing and load
balancing for multiple IDS instances.
Server—The provider of services in a distributed computing system.
Shell window—A command-line window. On Windows®, use Command Prompt (located in the
Accessories folder from the Start menu). On Mac OS®, use the Terminal utility (located in
/Applications/Utilities).
<Scripting SDK>—The directory where you installed the InDesign scripting SDK.
<SDK>—The directory where you installed the InDesign plug-in SDK.
SOAP—Simple Object Access Protocol, an XML-based protocol for exchanging messages between
<version>—In a path, the version number of InDesign Server; for example, for CS6, this is 8.0.
WSDL—Web Service Description Language, an XML-based format for describing how to access a Web
Roadmap
This section provides an overview of various ways to work with and extend InDesign Server and specifies
how to find out more about the topics. The rest of this document provides additional information.
Documentation
The InDesign plug-in SDK and the InDesign Scripting SDK contain documentation and sample code to
teach you how to extend InDesign Server. Both SDKs are available for download from Adobe.com. The
document titles mentioned within this document are located in the SDKs.
Scripting
programs and platforms. InDesign Server supports several versions of SOAP: SOAP industry standard
Versions 1.1 and 1.2 (RPC and doc/lit) and WSDL 1.1.
service and what operations it will perform.
Like InDesign, InDesign Server provides scripting support for JavaScript, AppleScript, and VBScript.
Write a script
To learn how to write InDesign Server scripts, read the following documents:
CHAPTER 1: Introduction to Adobe InDesign Server Roadmap 7
Adobe InDesign Scripting Tutorial
Adobe InDesign Scripting Guide
Adobe InDesign Server Scripting Guide
Also, you can access the InDesign Object Model Viewer from within the Help menu of Adobe
ExtendScript Toolkit.
Run a script
InDesign Server provides one SOAP method, RunScript, that is used to send a script to InDesign Server.
Your installation of InDesign Server provides a simple SOAP client, SampleClient, that you can use to run a
script. See “Using sampleclient to run an InDesign Server script” on page 20
SampleClient was written using C++, and its source code is provided in the InDesign products SDK. The
InDesign Server SDK contains other sample client projects written in several languages, including C#, PHP,
VB.NET, and Flex.
.
C++
Write a C++ Plug-in
InDesign Server is written in C++ and provides support for C++ plug-ins developed with the InDesign C++
API. For details, refer to “Interfacing with InDesign Server through a plug-in” on page 23
Plug-In Programming Guide, and “InDesign Server Plug-in Techniques” in Getting Started with Adobe
InDesign Plug-In Development.
Access your Plug-in using scripting
To access your plug-in from a script, you must make your plug-in scriptable. For details, refer to the
“Scriptable Plug-in Fundamentals” chapter in the Adobe InDesign Plug-In Programming Guide.
COM
InDesign Server publishes a COM type library that you can use to write COM components that interoperate
with InDesign Server. COM components can be written in several languages. This document briefly
discusses using Visual Basic and C# in “Interfacing with InDesign Server through COM (Windowsonly)” on
page 24.
Windows Service
You can use a Windows Service to manage InDesign Server. To employ the service, first install
InDesignServerService as described in “Installing the InDesign Server Windows Service (Windows only)”
on page 10. Then you can use the InDesign Server Microsoft Management Console snap-in to configure
InDesignServerService.
, Adobe InDesign
CHAPTER 1: Introduction to Adobe InDesign Server Roadmap 8
launchd Daemon
You can use a launchd daemon to manage InDesign Server on Mac OS. To learn how to configure a
daemon, see “Configuring an InDesign Server launchd daemon for Mac OS” on page 17
.
Performance and scalability
Documentation and tools related to the performance and scalability of InDesign Server are available in the
InDesign Server SDK. Refer to Getting Started with the Adobe InDesign Server SDK.
2
Installing and Running InDesign Server
This chapter explains how to install, run, and configure Adobe InDesign Server.
Installing InDesign Server
Before installing InDesign Server, check your system to make sure it matches the relevant system
requirements. Then run the installer provided by the ESD (Electronic Software Download). After you install,
you can run InDesign Server from the command line, as described in “Running InDesign Server” on
page 11. Please note that serialization for InDesign Server occurs at the command line on first launch by
using the
System requirements
Refer to the detailed system requirements for running InDesign Server, located in the application’s ReadMe
file.
If you want to run the InDesign Server Windows Service, Microsoft .NET Framework Version 2.0 or higher is
required.
-serialnumber argument.
Running the installer
Once you download and expand the InDesign Server ESD (Electronic Software Download), you can run the
installer by double-clicking the installer icon. Follow the instructions displayed on your screen. During
installation, you can specify where to install InDesign Server or use the default location.
On Windows , InDesign Server CS6 is 64 bit only.
On Mac, InDesign Server CS6 is 32 bit only.
CJK feature set
InDesign Server performs composition based on the enabled feature set: Roman (English) or Japanese
(CJK). On Windows, registry settings are used to specify the enabled feature set. On Mac OS, there are two
applications, one with the Roman feature set enabled and one with the CJK feature set enabled.
When installing InDesign Server on an English version of Windows, the feature set defaults to Roman.
When installing on a Chinese version of Windows (for example), the feature set defaults to CJK. During
installation on an English Windows, if you set the installation language to Chinese, the feature set defaults
to CJK.
You can change the default feature set by running regedit and modifying the following keys (change
version number as appropriate):
64-bit application on 64-bit Windows:
HKEY_LOCAL_MACHINE\SOFTWARE\Adobe\InDesign Server\<version>
9
Loading...