How it Works
Quark
Loading...
QuarkXPress Server - 2017
User Manual
444 pgs10.65 Mb0
Table of contents
Loading...

Quark QuarkXPress Server - 2017 User Manual

A Guide to QuarkXPress Server 2017
Contents
Conventions .................................................................................1
Getting started with QuarkXPress Server ...................................3
QuarkXPress Server architecture......................................................................3
Understanding QuarkXPress Server .................................................................3
Server templates and static projects.........................................................................4
Projects and layouts..................................................................................................5
Job Jackets and resources........................................................................................5
Caching.....................................................................................................................5
QuarkXPress Server preferences...............................................................................6
Master-renderer environment ...................................................................................6
Changing logging levels in “log4j2.xml“..................................................................7
Understanding QuarkXPress Server XTensions software .................................8
The QuarkXPress Server XTensions API....................................................................8
Configuring QuarkXPress Server for launch .....................................................9
Launching QuarkXPress Server.......................................................................10
Quitting QuarkXPress Server .........................................................................10
The QuarkXPress Server user interface .....................................11
Navigation pane..............................................................................................12
Administration menu.......................................................................................17
General Preferences dialog box .............................................................................18
Using QuarkXPress Server.........................................................30
A GUIDE TO QUARKXPRESS SERVER 2017 | I
Getting started ...............................................................................................33
Getting started: HTTP and HTTPS ..........................................................................33
Getting started: Web services.................................................................................39
QXP Server Manager ..............................................................................................49
Using the Web interface .................................................................................50
nderstanding rendering........................................................................................50
U
Understanding logging...........................................................................................51
Understanding render types ...................................................................................52
Understanding render modifiers.............................................................................87
Using content modifiers..........................................................................................96
Using XML modify.................................................................................................104
Using the Streaming Document Provider .............................................................166
Using the QXPSM SDK .................................................................................188
Sample applications ......................................................................................201
QuarkXPress Server Features ..................................................211
Dynamic Pagination and Flow.......................................................................211
Landscape pagination ...................................................................................216
Automatic callout stacking............................................................................220
Automatic callout stacking example .....................................................................221
Modifier schema (annotated) ...................................................225
ALIGNVERSETTINGS (Modifier schema).......................................................227
ANCHOREDBOXREF (Modifier schema).......................................................228
ii | A Guide to QuarkXPress Server 2017
AUTHOR (Modifier schema)..........................................................................230
BNSTYLE (Modifier schema) .........................................................................231
BOTTOM (Modifier schema) .........................................................................231
BOX (Modifier schema).................................................................................233
OXATTRIBUTE (Modifier schema)...............................................................236
B
CELL (Modifier schema) ................................................................................240
CLIPPING (Modifier schema).........................................................................243
COLSPEC (Modifier schema).........................................................................246
COLUMN (Modifier schema) .........................................................................247
CONDITIONALMASTERPAGEREFERENCE (Modifier schema) .....................255
CONTENTPH (Modifier schema) ...................................................................258
CONTOUR (Modifier schema) .......................................................................260
COPYFIT (Modifier schema) ..........................................................................261
DROPCAP (Modifier schema)........................................................................263
FITTEXT (Modifier schema) ...........................................................................268
A Guide to QuarkXPress Server 2017 | iii
FRAME (Modifier schema) ............................................................................273
GEOMETRY (Modifier schema) .....................................................................275
GRID (Modifier schema) ................................................................................277
GRIDLINE (Modifier schema) ........................................................................278
GROUP (Modifier schema) ............................................................................281
ROUPCHARACTERS (Modifier schema)......................................................282
G
GROWACROSS (Modifier schema)................................................................283
GROWDOWN (Modifier schema)..................................................................283
HEADER (Modifier schema) ..........................................................................283
HEADTROWSTYLE (Modifier schema) ..........................................................283
HEIGHT(Modifier schema).............................................................................284
HIDDEN (Modifier schema)...........................................................................284
HYPERLINK (Modifier schema) .....................................................................286
ID (Modifier schema).....................................................................................287
INDEXTERM (Modifier schema) ....................................................................288
INLINEBOX (Modifier schema) .....................................................................289
INLINETABLE (Modifier schema)...................................................................293
INS (Modifier schema)...................................................................................294
INSET (Modifier schema)...............................................................................294
INTERACTIVITY (Modifier schema) ...............................................................295
ISBN (Modifier schema) ................................................................................295
KEEPLINESTOGETHER (Modifier schema)....................................................295
KEYWORDS (Modifier schema).....................................................................296
LASTTCOLSTYLE (Modifier schema) .............................................................296
LAYER (Modifier schema)..............................................................................297
LAYOUT (Modifier schema)...........................................................................298
LAYOUTREF (Modifier schema).....................................................................300
LEFT (Modifier schema) ................................................................................301
LEFTCONTROLPOINT (Modifier schema) .....................................................301
LEFTGRID (Modifier schema) ........................................................................301
LINESTYLE (Modifier schema).......................................................................303
LINKEDBOX (Modifier schema) ....................................................................304
LIST (Modifier schema)..................................................................................305
LOCKTOGRID (Modifier schema)..................................................................306
MAX (Modifier schema) ................................................................................307
METADATA (Modifier schema)......................................................................307
MOVEDOWN (Modifier schema) ..................................................................308
MOVELEFT (Modifier schema) ......................................................................308
MOVERIGHT (Modifier schema)....................................................................308
iv | A Guide to QuarkXPress Server 2017
AGE (Modifier schema) ...............................................................................311
P
PAGEBREAK (Modifier schema)....................................................................312
PAGEREF (Modifier schema).........................................................................313
PICTURE (Modifier schema) ..........................................................................316
POSITION (Modifier schema) ........................................................................321
PROJECT (Modifier schema) .........................................................................321
PUBLISHER (Modifier schema)......................................................................323
REPEATABLEMASTERPAGEALTERNATIVES (Modifier schema) ....................324
REPEATABLEMASTERPAGEREFERENCE (Modifier Schema) ........................325
ROW (Modifier schema) ................................................................................351
RUBI (Modifier schema) ................................................................................355
RUBITEXT (Modifier schema) ........................................................................356
RULE (Modifier schema)................................................................................358
SECTION (Modifier schema) .........................................................................366
A Guide to QuarkXPress Server 2017 | v
SPREAD (Modifier schema)...........................................................................377
STACKINGORDER (Modifier schema) ...........................................................377
STATICCONTENT (Modifier schema).............................................................377
STORY (Modifier schema) .............................................................................377
SUPPRESSOUTPUT (Modifier schema)..........................................................379
AB (Modifier schema) ..................................................................................379
T
TABLE (Modifier schema) ..............................................................................380
TABLEBREAK (Modifier schema)...................................................................383
TABLESTYLE (Modifier schema) ....................................................................383
TABSPEC (Modifier schema)..........................................................................384
TBODY (Modifier schema).............................................................................384
TCOL (Modifier schema) ...............................................................................384
TCOLSTYLE (Modifier schema) .....................................................................385
TCONTINUED (Modifier schema)..................................................................386
TEXT (Modifier schema)................................................................................386
TEXTATTRIBUTE (Modifier schema) ..............................................................390
TEXTNODEPH (Modifier schema) .................................................................390
TEXTPH (Modifier schema) ...........................................................................391
TFOOT (Modifier schema).............................................................................392
THEAD (Modifier schema).............................................................................392
TITLE (Modifier schema)................................................................................392
TOP (Modifier schema) .................................................................................392
TOPGRID (Modifier schema) .........................................................................393
TROW (Modifier schema) ..............................................................................394
TROWSTYLE (Modifier schema) ....................................................................395
VALUE (Modifier schema) .............................................................................396
VERTEX (Modifier schema) ...........................................................................396
VERTEXPOINT (Modifier schema).................................................................397
VERTICES (Modifier schema) ........................................................................397
WIDTH (Modifier schema).............................................................................398
XREF (Modifier schema)................................................................................398
Using SSL..................................................................................399
Secure Sockets Layer (SSL) support..............................................................399
QuarkXPress Server XTensions software.................................401
CopyDeskArticle XTensions software ...........................................................401
vi | A Guide to QuarkXPress Server 2017
PDF Filter XTensions software......................................................................403
Modifier XTensions software ........................................................................403
Creating XML for Modifier XTensions software.....................................................404
Layer XTensions software .............................................................................405
nteractiveDesigner Server XTensions software ...........................................405
I
App Studio XTensions software ....................................................................406
Telegraph XTensions software..................................................407
Setting Telegraph preferences......................................................................407
Uploading missing or modified pictures...............................................................412
QuarkXPress Server Manager..................................................413
Logging with QXP Server Manager ......................................................................415
Starting QuarkXPress Server Manager..................................................................416
The XTensions Developer Kit (XDK).........................................434
Glossary ...................................................................................435
Legal notices ............................................................................436
A Guide to QuarkXPress Server 2017 | vii

Conventions

Formatting conventions highlight information to help you quickly find what you
eed.
n
Bold type style: The names of all dialog boxes, fields, and other controls are set•
in bold type. For example: “Click OK.”
References: In descriptions of features, parenthetical references guide you in•
accessing those features. For example: “The Find/Change dialog box (Edit
menu) lets you find and replace text.”
CONVENTIONS
Arrows: You will often see arrows (>), which map out the menu path to a feature.•
For example: “Choose Edit > Style Sheets to display the Style Sheets dialog
box.”
Icons: Although many tools and buttons are referenced by name, which you can•
see by displaying ToolTips, in some cases icons are shown for easy identification.
For example, “Click the button on the Measurements palette to center text.”
Cross-platform issues: This application is quite consistent across operating•
systems. However, some labels, buttons, key combinations, and other aspects of
the application must differ between Mac OS® and Windows® because of user
interface conventions or other factors. In such cases, both the Mac OS and
Windows versions are presented, separated by a slash, with the Mac OS version
presented first. For example, if the Mac OS version of a button is labeled Select,
and the Windows version is labeled Browse, you are directed to “Click
Select/Browse.” More complex cross-platform differences are mentioned in
notes or parenthetical statements.
A GUIDE TO QUARKXPRESS SERVER 2017 | 1
CONVENTIONS
2 | A Guide to QuarkXPress Server 2017

GETTING STARTED WITH QUARKXPRESS SERVER

Getting started with QuarkXPress Server
QuarkXPress Server lets you render QuarkXPress projects in a variety of formats.

QuarkXPress Server architecture

The QuarkXPress Server architecture is shown in the following diagram.
QuarkXPress Server architecture diagram

Understanding QuarkXPress Server

QuarkXPress Server helps automate the generation of QuarkXPress layouts to a
variety of output formats—including JPEG, Portable Document Format (PDF), and
PostScript®—all from a centralized Web application. To send a request to
QuarkXPress Server, all you need to do is enter a URL into your Web browser’s
A GUIDE TO QUARKXPRESS SERVER 2017 | 3
GETTING STARTED WITH QUARKXPRESS SERVER
address field. For example, the following URL instructs the QuarkXPress Server
application named “QXPServer” to return the file “MyProject.qxp” as a PDF file:
ttp://QXPServer:8080/pdf/MyProject.qxp
h
The QuarkXPress Server application receives these requests, renders (creates) the
requested projects in the requested formats, and then returns the rendered file to
the client application—the Web browser in this case.
The format of QuarkXPress Server URL requests is described in detail in “
URL requests“ and in “Web integration.”
You can also create custom applications that communicate with a QuarkXPress
Server application using HTTP, Simple Object Access Protocol (SOAP), or another
protocol. For more information, see “Web integration.”
You can think of QuarkXPress Server as a special version of QuarkXPress that runs
on a server with the following main differences:
Instead of accepting input from a keyboard and mouse, QuarkXPress Server•
accepts input in the form of URLs and other types of requests.
Instead of sending a project to a printer, QuarkXPress Server renders (creates)•
output in a particular format and sends the rendered file to a client.

Server templates and static projects

QuarkXPress Server can open, render, and serve two types of projects:
Static projects are QuarkXPress projects that can be rendered and served as-is in a•
variety of formats by the QuarkXPress Server application. For example, you
might make a product manual available as a static project and allow customers
to download that manual in a variety of formats.
Creating
Server templates are QuarkXPress projects that can be manipulated by the•
QuarkXPress Server application before being rendered and served. For example,
you might make a sales piece available as a server template so that each person
who downloads it receives a personalized copy.
QuarkXPress Server can open QuarkXPress documents, projects, and templates
created in any language edition of QuarkXPress 7.0 or later. QuarkXPress Server can
save and export projects in QuarkXPress 8.x, 9.x and 10.x format.

The document pool and the Streaming Document Provider

QuarkXPress Server has two main ways to find or receive content for rendering.
The document pool•
The Streaming Document Provider•
QuarkXPress Server can read templates and static projects from a directory called
the document pool. The document pool can be any directory that is available to
QuarkXPress Server through a file system or an FTP server. You can use any of the
following methods to place files in the document pool:
Drag the files to the document pool directory.•
4 | A Guide to QuarkXPress Server 2017
GETTING STARTED WITH QUARKXPRESS SERVER
Use the Add Files command in the Document Pool screen of the QuarkXPress•
Server Web interface.
Upload the files using FTP to the document pool directory.•
Use Telegraph XTensions® software to upload the files to the document pool•
from within QuarkXPress. (For more information about Telegraph XTensions
software, see “
Telegraph XTensions software.”)
For more information about the document pool, see “
Interface
The document pool directory cannot be an encrypted directory.
QuarkXPress Server can also receive templates, projects, and other files as part of a
multipart HTTP request. For more information, see “Using the Streaming Document
Provider.”
In addition, QuarkXPress Server can serve documents from a database, a content
management system, or other sources. Collectively, the document pool and any
other source of files to be served are referred to as document providers.
.”
The QuarkXPress Server User

Projects and layouts

QuarkXPress projects can contain one or more layouts, and only one layout can be
rendered at any given time. If you do not specify a layout when you send a
rendering request, QuarkXPress Server renders the first layout in the project.

Job Jackets and resources

In QuarkXPress, resources are things such as style sheets, colors, H&Js, output styles,
and item styles. Resources are stored in a Job Jackets structure, which can be either
embedded in a project or stored in a separate Job Jackets file.
QuarkXPress Server uses a default Job Jackets file to make a default set of resources
available to all projects handled by QuarkXPress Server, regardless of whether they
are included in the projects and articles you render. You can update this file in two
ways:
Using the QuarkXPress Server Web interface. For more information, see “
Jackets dialog box.”
Using request handlers. For more information, see “
“updateprefsfromjj.”
Once you’ve downloaded the default Job Jackets file, you can update its resources
using QuarkXPress. For more information, see “Job Jackets” in A Guide to
QuarkXPress.
The location of the default Job Jackets file is stored in the QuarkXPress Server
preferences folder. For more information, see “
QuarkXPress Server preferences.”
jobjacket“ and•

Caching

To maximize efficiency, QuarkXPress Server uses cached versions of all rendered
projects whenever possible. You can configure projects so that they are never
Job•
A Guide to QuarkXPress Server 2017 | 5
GETTING STARTED WITH QUARKXPRESS SERVER
cached, so that they are cached for a particular amount of time, or so that they are
rendered every time they are served.

QuarkXPress Server preferences

When you launch QuarkXPress Server, the application creates preferences files that
are functionally and structurally equivalent to the preferences files created by
QuarkXPress. These preferences files reside in the QuarkXPress Server “Preferences”
folder. QuarkXPress Server also creates a “QuarkXPress Server.prf” file in the
“Preferences” folder. This file contains preference settings that are specific to
QuarkXPress Server.
QuarkXPress Server uses these preferences the same way QuarkXPress uses them. If
an XTensions module creates a project in QuarkXPress Server, that project draws its
settings from the QuarkXPress Server preferences just as a new QuarkXPress project
draws its settings from the QuarkXPress preferences.
Preferences files are stored in the following locations:
Mac OS:
Renderer/
•
•
•
Windows :•
C:\Windows\System32|config\systemprofile\AppData\Roaming\Quark
\QuarkXPressServer Renderer [version]
For more information about preferences, see the “Administration menu.”
[User]/Library/Preferences/Quark/QuarkXPress Server•

Quark License Administrator

To prevent unauthorized use, launching QuarkXPress Server requires the presence of
a Quark® License Administrator (QLA) server. QuarkXPress Server follows the
configuration and control rules that are enforced by QLA. For more information
about QLA, see the QLA documentation included with QuarkXPress Server.

Master-renderer environment

Requests for project renders are stored in a connection queue. The requests in the
rendering queue can be processed by a single QuarkXPress Server application, or by
a master QuarkXPress Server application and several renderers (additional instances
of QuarkXPress Server). The master QuarkXPress Server application launches the
available number of renderers and then passes the requests in the connection queue
to those renderers as they become available. The number of renderers available for
launch is determined by the number of licenses available from the QLA server.
The master QuarkXPress Server process and all of the renderers it launches share the
following elements:
6 | A Guide to QuarkXPress Server 2017
GETTING STARTED WITH QUARKXPRESS SERVER
The same application preferences (each renderer has its own preferences files,•
but QuarkXPress Server keeps them synchronized)
The same document cache in memory•
The same memory cache•
The same server XTensions modules (a separate instance of each XTensions•
module runs with each renderer)
The same server document pool (if defined in the QuarkXPress Server•
preferences or if a document provider is used in place of the document pool)
If a renderer unexpectedly quits, the master QuarkXPress Server restarts the renderer
without requiring any action from you.

Changing logging levels in “log4j2.xml“

You can change the logging levels for QuarkXPress Server. Options include ERROR,
INFO, WARN, DEBUG, and TRACE.
ERROR = includes messages that indicate disrupted and failed requests.•
INFO
= includes messages that indicate the state of services.•
WARN
= includes non-critical service error messages•
DEBUG
= includes messages that indicate server resource usage.•
TRACE
= includes messages according to activity related to requests.•
Refer to Java documentation for more information about logging levels.
To change logging levels:
Open the “conf” folder in your QuarkXPress Server folder.
1.
Open “log4j2.xml” in a text-editing application.2.
To define the logging level for QuarkXPerss Server errors, scroll to <logger3.
name=com.quark.qxps. The structure is as follows:
<logger name=”com.quark.qxps”>
<level value=”ERROR” />
</logger>
To define the logging level for QuarkXPress Server transactions, scroll to4.
<logger name=QXPSTransactionLogger. The structure is as follows:
<logger name=”com.quark.qxps” additivity=”false”>
<level value=”INFO” /> <appender-ref ref=”QxpsTransactionFileAppender” />
</logger>
To define the logging level for other activity, scroll to the <root>. The structure5.
is as follows:
<root>
<priority value=”ERROR” /> <appender-ref ref=”QxpsServerAsyncAppender” />
</root>
Save and close “log4j2.xml.”6.
A Guide to QuarkXPress Server 2017 | 7
GETTING STARTED WITH QUARKXPRESS SERVER
nderstanding QuarkXPress Server XTensions software
U
uarkXPress Server ships with a collection of XTensions software that adds
Q
capabilities to QuarkXPress Server. For example, PDF Export XTensions software lets
QuarkXPress Server serve content in PDF format; Modifier XTensions software lets
you retrieve, manipulate, and reconstruct XML representations of projects; and
QuarkCopyDesk® Renderer XTensions software lets you create QuarkCopyDesk
articles. Telegraph XTensions software works with QuarkXPress to allow designers to
name boxes in template files so that those boxes can be addressed by URLs.
For more information about XTensions software included with QuarkXPress Server,
XTensions software“ and “Telegraph XTensions software.”
see “

The QuarkXPress Server XTensions API

In addition to the XTensions modules included with QuarkXPress Server, developers
can create custom XTensions software that add features. The complete server
XTensions Application Programming Interface (API) documentation is available in
the QuarkXPress Server XTensions Developer’s Kit (XDK).
As of version 8.0, the QuarkXPress Server XDK is Unicode-compliant.
The QuarkXPress Server XDK lets you create XTensions modules that provide the
following abilities:
The ability to register request handlers•
The ability to register project providers•
The ability to register new render formats•
The ability to add items to the list of response properties, cookies, and HTTP•
header items
The ability to log messages in log files•
The ability to initiate a new transaction to be processed by the server•
The ability to completely control how projects are processed by the server•
In addition, QuarkXPress Server XTensions software can register for the following
basic callbacks:
Pre-processing•
Content loading•
Layout modification•
Post-processing•
Removing slugs while running the QuarkXPress project renderer•
Analyzing the server after a transaction is complete•
Pre- and post-transaction callback•
8 | A Guide to QuarkXPress Server 2017
onfiguring QuarkXPress Server for launch
C
o configure QuarkXPress Server prior to launch, open the file [QuarkXPress
T
Server application folder]/conf/ServerApp.properties
modify it as follows:
GETTING STARTED WITH QUARKXPRESS SERVER
folder) and
To make the server run without loading any network interface, use the
nonetwork option with the qxpservercore.serverRendererParameters. In
his mode, the only transactions a server can run are those passed to it by
t
another process.
To control whether renderers are monitored, set•
qxpservercore.monitorrenderers.value to true or false.
To specify the query interval for monitoring renderers, set•
qxpservercore.monitorrenderers.queryinterval.value to a value in
seconds.
To specify the number of retries for monitoring renderers, set•
qxpservercore.monitorrenderers.noofretries.value to an integer. If a
renderer process has been attempting to fulfill a request for the specified number
of retries (with the specified query interval in seconds between retries), the
renderer monitor recyles that process.
To control how many renderers the master process launches, specify a number•
for
qxpserver.subrenders. Note that the number of renderers you can launch
depends on your license.
To force the renderers to restart on a periodic basis, specify a value in hours for•
qxps.render.recycle.interval. The default value is 24, or 24 hours.
Decimal values are permitted. Renderers restart serially, so one renderer doesn’t
restart until the other is finished restarting. If a renderer is busy, the master
process waits for 15 minutes, and then if the renderer is still busy, postpones the
restart until the next interval elapses. Set this value to zero to turn the automatic
restart feature off.
-•
The request timeout at Renderer lets you specify the timeout value for rendering.•
It is set to 10 minutes by default.
qxpserver.renderer.request.timeout.name = requestTimeout
qxpserver.renderer.request.timeout.value = 10
To control whether the server should collect performance metrics, set•
qxpserver.CollectPerformanceMetrics=true to collect and false to not
collect metrics.
To set the number to transactions after which performance metrics data will be•
flushed to file:
qxpserver.CollectPerformanceMetrics.flush.transactioncount =
100
To send JMX notifications when performance metrics change set:•
qxpserver.CollectPerformanceMetrics.sendjmxnotifications =
true
Enable this flag to automatically refresh admin ui through JMX notifications•
qxpserver.CollectPerformanceMetrics.adminui.autorefresh = true
A Guide to QuarkXPress Server 2017 | 9
GETTING STARTED WITH QUARKXPRESS SERVER
To reset metrics on every launch of qxps. If set to true, the QuarkXPress Server•
will clear old metrics and start capturing fresh metrics on every launch.
qxpserver.CollectPerformanceMetrics.resetmetricsonserverlaunch
= false
To accelerate the time to troubleshoot a failed rendering request, QuarkXPress•
Server creates the rescue folder and collects the data for failed and timed out
transactions by default into a folder name QXPSRescuedata<ver> relative to doc
pool.
Setting this value to false means the rescue folder will not be created and no
data will be collected.
qxpserver.rescuefolder.manage=true
Specify the rescue folder path for failed transactions. If no value is given here,•
the document pool path would be considered by default:
qxpserver.rescuefolder.path = <Specify custom folder path>

Launching QuarkXPress Server

On Windows, you can install QuarkXPress Server as an application or as a service
(Quark recommends that you always run it as a service). On Mac OS, QuarkXPress
Server always runs as an application.
If you install QuarkXPress Server on Windows as an application, you can launch it
using the Start menu or by double-clicking the “ServerStartup.bat” in the
QuarkXPress Server application folder.
For information on launching QuarkXPress Server in a separate Tomcat installation,
see “Deploying QuarkXPress Server externally” in the QuarkXPress Server ReadMe.
QuarkXPress Server offers a browser-based user interface instead of a conventional
user interface.

Quitting QuarkXPress Server

To quit QuarkXPress Server, press Control+C.
10 | A Guide to QuarkXPress Server 2017

THE QUARKXPRESS SERVER USER INTERFACE

The QuarkXPress Server user interface
QuarkXPress Server offers a browser-based user interface. This chapter describes how
you can use it to configure and customize your QuarkXPress Server application and
manage your server XTensions modules.
To view the QuarkXPress Server welcome page, launch a Web browser and enter the
http://[server]:[port] (where [server] is the IP address or domain
URL
name of the server and [port] is the TCP/IP port on which the server is running).
The welcome screen displays.
The QuarkXPress Server welcome page
To display the administrative client, click Open Admin Client. If the server has
realm verification enabled, you will be asked to enter your user name and password.
The administrative client displays.
A GUIDE TO QUARKXPRESS SERVER 2017 | 11
THE QUARKXPRESS SERVER USER INTERFACE
avigation pane
N
Status Monitor screen
The navigation pane on the left side has two areas shown in the lower left. The
Server Information area lets you view server information and the transaction log,
and the Document Pool area lets you view the contents of the document pool. You
can collapse and expand this pane with the button at the right end of the

Navigation Pane header.

If you click Server Information, the Status Monitor screen displays.
This screen shows the following usage reporting metrics :
1. Server Name: Name or IP of the machine running QuarkXPress Server.
2. Server Startup time: Shows the date and time at which the QuarkXPress Server
Service was launched.
3. Active Renderers: Represents the number of renderers busy processing a
rendering job. This updates dynamically.
4. Idle Renderers: Represents the number of renderers in an idle state. This updates
dynamically.
5. Observation Time: The time period during which the server’s activity is
monitored to collect performance metrics.
6. Busy Time: Sum of all time periods when the server is busy processing at least
one rendering transaction.
For Example: Busy Time = Busy Period 1 + Busy Period 2 + Busy Period 3 + … + Busy
Period n, where Tr1, Tr2, …Trn represent incoming rendering transactions.
12 | A Guide to QuarkXPress Server 2017
THE QUARKXPRESS SERVER USER INTERFACE
Busy Time : Transactions Vs. Observation Period
7. Server Utilization: The percentage of server capacity used during the
Observation Time.
Utilization (%) = (Busy Time /Observation Time) * 100.
For Example: For an Observation Time of 50 minutes if the server is busy for 40
minutes, the Server Utilization(%) = (40 / 50) * 100 = 80%.
8. Rendering Throughput: The average number of rendering transactions
completed during Busy Time.
Rendering Throughput = total rendering transactions completed / Busy Time.
For example, if 150 rendering transactions are completed in a busy time of 50
minutes, then the throughput would be 150/50 = 3 transactions / min.
9. Arrival Rate: The number of arrivals per unit of time.
Arrival Rate = Total transactions arrived / Observation Time
For example for a total of 1500 rendering requests arrived, during 50 minutes
Observation Time, the Arrival Rate = 1500/50 = 30 transactions / minute.
10. Response Time for a rendering transaction: It is the total time taken to
complete a transaction from its submission to completion.
Response Time= Queue Time + Processing Time
For example if a server running with 2 the rendering transaction Tr1 goes to
renderer1, Tr2 goes to renderer2, Tr3 waits in queue until one of the renderer
becomes free. The response time for each rendering transaction is as shown below.
A Guide to QuarkXPress Server 2017 | 13
THE QUARKXPRESS SERVER USER INTERFACE
Response Time: Transactions Vs. Time
11. Average Response Time: Average amount of time taken to complete a
transaction from its submission to completion.
For Example:
Time taken to complete transaction 1 = Tr1
Time taken to complete transaction 2 = Tr2
…
…
Time taken to complete transaction n = Trn
Average Response Time = (Tr1 + Tr2 + … + Trn) / n
12. Peak Response Time: The highest response times recorded during a given
observation time.
For example, if during a given Observation Time, if response times for various
rendering transactions are as below,
Tr1 = 7 sec
Tr2 = 15 sec
Tr3 = 2 sec
Tr4 = 2 sec
Tr5 = 20 sec
…
…
Trn = 4 sec
Peak Response Time = MAX(7,15,2,2,20 …4) = 20 sec.
14 | A Guide to QuarkXPress Server 2017
THE QUARKXPRESS SERVER USER INTERFACE
13. Average Queue Time: The average time a rendering job stays in the queue
before it gets processed. The average queue time = total queue time / total rendering
transactions completed.
For example, if the total queue time is 3 minutes (i.e. 180 seconds) and 150
transactions are completed, then the Average Queue Time = (3 * 60) /150 = 1.2
seconds
14. Peak Queue Time: The highest waiting time a rendering job stays in the queue.
For example, if during a given Observation Time, the waiting times iare:
Tr1 = 0 sec
Tr2 = 5 sec
Tr3 = 2 sec
…
…
Trn = 4 sec
Peak Queue Time = MAX(0,5,2, …4) = 5 sec.
15. Current Queue Length: The number of rendering jobs waiting in the queue to
be processed.
16. Peak Queue Length: The highest queue lengths recorded during a given
observation time.
17. Rendering Requests: The total number of transactions delegated to renderers
during a given observation time (e.g. PDF, JPG, /getprojinfo, /jobjacket,
/getrendererprefs, /setrendererprefs, etc).
18. Pages Rendered: Sum total of all pages rendered for each rendering transaction
during a busy time.
19. Images Processed: Sum total of all image files either imported or rendered as a
part of the rendering transaction during the observation time.
20. Average Rendering Time Per Page: The average time taken to render a page.
Average rendering time per page = busy time / total pages rendered.
For example, if a total of 15000 pages are rendered when the server was busy for 50
minutes (i.e. 3000 sec), the Average Rendering Time Per Page = (50*60)/15000 = 0.2
seconds
21. Total Renditions: The number of renditions of various formats rendered by the
server during the observation time. By default, this includes PDF, JPEG, HTML5,
EPUB, KINDLE, APPSTUDIO, EPS, XML, PNG, CopyDesk Articles, QuarkXPress
Projects.
22. Failed Transactions Count: The number of failed transactions.
23. Error Rate: The percentage of failed transactions during the Observation Time.
For example if out of 500 rendering transactions, if 10 transactions failed, then the
Error Rate (%) = (10 / 500) * 100 = 2%.
A Guide to QuarkXPress Server 2017 | 15
THE QUARKXPRESS SERVER USER INTERFACE
24. RESET button: Clicking on the reset button results in the following sequence of
actions:
The server usage information recorded during the Observation Time is backed up•
to a backup file (
Clears all the server usage information displayed in the Status Monitor page of•
Admin UI by resetting the values to zero.
Starts a fresh Observation Time under which all the usage information will be•
freshly recorded again.
The icons in the area below represent the renderers that are currently running and
show which requests are being processed by each renderer in real time. This screen
also shows the number of active and idle renderers.
The information for the Observation Time can be downloaded as a backup (step-5).
A file named “Telemetry.json” is downloaded in association with the .zip archive
downloaded using the Download Logs button under Manage Logs.
Telemetry.json) within the QuarkXPress Server logs folder.
REST interface for usage data:
http://<servernameorip>:8080/telemetry
http://<servernameorip>:8080/cleartelemetry
If you click Manage Logs, the Logs screen displays the current transaction log.
Logs screen
To download the active log including recent crash reports, click Download Logs•
at the top of the Logs header.
To make the log scroll automatically as events occur, check Auto Scroll.•
To clear all logs, click Clear All Logs.•
To clear the current log, click Clear Log.•
16 | A Guide to QuarkXPress Server 2017
THE QUARKXPRESS SERVER USER INTERFACE
To display the Log Settings dialog box, click Log Settings. In this dialog box,•
you can change the maximum log file size, the maximum rolling count, and the
logging level for the general QuarkXPress Server log, the QuarkXPress Server
transaction log, and the QuarkXPress Server fatal log.
Each transaction entry in the QuarkXPress Server transaction log has some•
useful information related to request URI, time taken for rendering, rendered
output size, pages generated, images processed, average time per page,
time/duration a transaction has waited in the queue before it got
processed(queue time), queue length, and the number of other transactions still
waiting in the queue at the time it was processed.
To view a particular log file, choose an option from the Select Log File drop-•
down menu.
If you click Show XTensions Information, the XTensions Information screen
displays, allowing you to view the status of all installed XTensions modules.
If you click Manage Fonts, a list of fonts installed on the Server machine is
displayed.
Fonts screen
To search fonts, use the list search box in the top right corner.
To add fonts to the Server machine, click the Add Fonts button. This will copy the
fonts to the “privatefonts” folder in the QuarkXPress Renderer folder.

Administration menu

The administration menu lets you manage QuarkXPress Server.
A Guide to QuarkXPress Server 2017 | 17
THE QUARKXPRESS SERVER USER INTERFACE
You do not have to restart the server in GUI mode to set preferences.

General Preferences dialog box

The General Preferences dialog box (Administration > Preferences > General) lets
you set preferences that are not related to rendering. It includes the tabs described
in the following topics.
You can also set general preferences using the
nformation, see “setprefs.”
i
setprefs request handler. For more
General Preferences — Server
The Server tab (Administration > Preferences > General > Server) includes the
following controls.
Use the Document Root Folder field to specify the location of the document pool.
Putting the document pool on a network connected drive is not recommended,
because this negatively impacts the performance of QuarkXPress Server.
Use the Allow Memory Caching check box to control whether memory is cached.
Use the Max Memory Cache Size field to specify the maximum memory size
allocated to the cache memory. Valid values are from 10MB to 1024MB.
Use the Force Served Documents Closed check box to control whether
QuarkXPress Server closes projects from the document pool after it renders them,
regardless of the Telegraph XTensions software setting. Uncheck this box to keep
such projects open on the server.
Use the Default Renderer Type drop-down menu to specify the default rendering
format for the server.
Appstudio: Returns a .zip file containing an HTML5 App Studio article.•
Appstudio Upload: Exports an HTML5 App Studio article and uploads it to the•
App Studio Publishing Portal.
ePUB: Returns an ePUB file.•
EPS Document: Returns an Encapsulated PostScript (EPS) file.•
JPEG: Returns a JPEG file.•
PDF: Returns a PDF file.•
PNG: Returns a Portable Network Graphics (PNG) file.•
PostScript: Returns a PostScript file.•
QCDDOC: Returns a QuarkCopyDesk article.•
QuarkXPress Document: Returns a QuarkXPress project.•
Raw Custom: Returns a file in internal QuarkXPress format for use by server•
XTensions software developers.
RLE Raw Custom: Returns a file in internal QuarkXPress format (compressed•
using Run Length Encoding) for use by server XTensions software developers.
18 | A Guide to QuarkXPress Server 2017
THE QUARKXPRESS SERVER USER INTERFACE
Use the Scale field to specify the default scale percentage at which QuarkXPress
Server should render projects.
Use the Disable QXD Return check box to specify whether QuarkXPress Server can
return QuarkXPress projects to clients.
General Preferences — Log
The Log tab (Administration > Preferences > General > Log) includes the
ollowing controls.
f
se the Log Document Problems check box to specify whether to include problem
U
descriptions in transaction log files. The “Log” folder inside the QuarkXPress Server
application folder contains three log files:
QuarkXPress Server Fatal Log.log: This log lists all fatal errors.•
QuarkXPress Server Log.log: The log for the Java process. This log contains•
source code-level logging information that can be useful in troubleshooting.
QuarkXPress Server Transaction Log.log: This log lists all transactions and all•
errors.
Detailed application logging is enabled for these log files only if it is enabled in the
“log4j.xml” file.
To log detailed transaction timing data, check Log Timing Data.
Logged problems include the following:
Missing Fonts: If fonts are missing from a project that has been requested for•
rendering, a one-line description of each missing font is added to the error log. If
QuarkXPress Server receives a request to render a project and does not have
access to the fonts required by the project, it uses the fonts specified in the Fonts
tab of the Preferences dialog box (Administration > Preferences > General). If
these fonts are also unavailable, QuarkXPress Server substitutes Helvetica (Mac
OS) or Arial (Windows). This behavior is the same as it is in QuarkXPress.
Missing Pictures•
Missing SXTs: If a required server XTensions module is missing when a•
rendering request is received, a one-line description of each missing module is
added to the error log. If the name of the missing module is not returnable, the
XTensions module ID number is returned.
Text Encoding/Character Set Problems: If text is sent to a text box in the•
template and the system does not have access to the correct font glyph, the issue
is logged. The log data indicates the character set that the system attempted to
convert. For example, the log entry might show that a request for Japanese
characters was sent to an English project.
Information about missing fonts and missing pictures is also recorded in the
“QuarkXPressServerRenderer.log” file. This file also contains detailed timing
information, including the transaction UID for each transaction. This log file can be
found here:
Mac OS:
[drive]/Users/[user name]/Library/Logs/Quark•
A Guide to QuarkXPress Server 2017 | 19
THE QUARKXPRESS SERVER USER INTERFACE
Windows: [drive]:\Program Files\Quark\QuarkXPress Server•
017\log
2
To download all logs to a non-server computer, click Show Transaction Log in the
QuarkXPress Server Web interface, then click Download Logs on the home page.
General Preferences — Email
QuarkXPress Server can automatically notify someone by e-mail when the checked-
ut QLA license is about to expire. The Email tab (Administration > Preferences >
o
General > Email) lets you specify where such e-mail messages should be sent.
Use the Server field to specify the domain name or IP address of the e-mail server
that QuarkXPress Server should use to send messages (for example,
mail.quark.com).
Use the Port field to specify the port number of the e-mail server that QuarkXPress
Server should use to send messages. Valid values are from 0 to 255.
Use the From to specify the source e-mail address the QuarkXPress Server
application should use to send messages (for example,
QXPSserver1@quark.com).
Use the To to specify the e-mail address to which the QuarkXPress Server
application should send messages (for example,
QXPServerAdmin@quark.com).
General Preferences — Authentication
The Authentication tab (Administration > Preferences > General >
Authentication) includes the following controls.
Check Authenticate For Admin Requests to enable the Username and Password
fields. These fields let you control access to administrative parameters and features.
You can enter up to 32 characters.

Renderer Preferences dialog box

Use the renderer Preferences dialog box (Administration > Preferences >
Renderer) to set up default preferences for use when projects are created in
QuarkXPress Server. It includes the tabs described in the following topics.
Many of these preferences come into play only when you create a project in
QuarkXPress Server, either using a construct request or through a request handled
by a custom QuarkXPress Server XTensions module.
You can also set renderer preferences using the
handler. For more information, see”setrendererprefs.”
setrendererprefs request
Preferences — Display
The Display pane (Administration > Preferences > Renderer > Display) includes
the following controls.
Use the Color TIFFs drop-down list to specify the color depth of screen previews
created for color TIFFs when they are imported.
20 | A Guide to QuarkXPress Server 2017
THE QUARKXPRESS SERVER USER INTERFACE
Use the Gray TIFFs drop-down list to specify the resolution of screen previews
created for grayscale TIFFs when they are imported.
Choose a profile that corresponds to your monitor from the Monitor Profile drop-
down menu, or choose Automatic. Profiles can be placed in the “Profiles” folder in
the QuarkXPress Server application folder.
Preferences — Input Settings
he Input Settings tab (Administration > Preferences > Renderer > Input
T
Settings) includes the following controls.
Check Smart Quotes to force QuarkXPress to replace feet (‘)and inches (“) marks
automatically with the specified quotation marks.
Use the Format drop-down menu to specify the default characters to be used with
the Smart Quotes feature and Convert Quotes option in the Get Text dialog box
(File > Get Text).
To change the separators used for indicating sequential ranges for output, enter a
value in the Sequential Page Range Separator. This value override the preferences
set for a project.
To change the separators used for indicating nonsequential ranges for output, enter
a value in the Non Sequential Page Range Separator. This value override the
preferences set for a project.
Preferences — Font Fallback
The Font Fallback pane (Administration > Preferences > Renderer > Font
Fallback) includes the following controls.
Check Font Fallback to activate the Font Fallback feature. When this feature is
active, if the application encounters a character it cannot display in the current
font, it attempts to find a font that can display the character.
If the application encounters a missing font when opening a project, it uses the
preferences in this pane to determine which substitute fonts to use.
If you add characters to an exising project and the font cannot support those
characters, the application will search the system for a font that can display the
characters.
Check Search to have the application search for a suitable font that is used in the
active project. To restrict the search to a particular range, choose an option from the
Search Type drop-down menu. To search the entire story where a missing font
occurs, choose Active Story. To search a particular number of paragraphs in both
directions, choose Paragraph and enter a number in the Search Limit field.
To indicate which fallback fonts should be used when no other font can be found
(taking the Search settings into account), choose options from each of the drop-
down menus in the Font List area.
To indicate which font should be used for the slug line when a layout is printed
with registration marks turned on, choose an option from the Slug Line Font drop-
down menu.
A Guide to QuarkXPress Server 2017 | 21
THE QUARKXPRESS SERVER USER INTERFACE
references — Open and Save
P
he Open and Save pane (Administration > Preferences > Renderer > Open and
T
Save) includes the following controls.
Choose an option from the Encoding drop-down menu to indicate how the
applications should display characters in non-Unicode text.
Preferences — Fonts
The Fonts pane (Administration > Preferences > Renderer > Fonts) includes the
ollowing controls.
f
o specify default replacement fonts, check Specify Default Replacement Font and
T
choose options from the Roman and East Asian drop-down menu.
To highlight characters that are in a Traditional Chinese encoding’s UDA/VDA (User
Defined Area/Vendor Defined Area) range so that these characters can be visually
verified, check Highlight character ranges defined by Traditional Chinese font
vendors.
Preferences — EPS
The EPS pane (Administration > Preferences > Renderer > EPS) includes the
following controls.
To control whether the application should generate a preview of an EPS file or use
the preview (if any) embedded in the file, choose an option from the Preview drop-
down list. The option specified in this pane is used only when the EPS preview is
being created. If you change the preference, you need to reimport the EPS file.
Preferences — PDF
Use the PDF pane of the Preferences dialog box (Administration > Preferences >
Renderer > PDF) to set preferences for rendering in PDF format.
The PDF pane displays only if PDF Filter XTensions software is loaded. For more
information, see “PDF Filter XTensions software.“
Use this pane to specify a PDF workflow:
Click DirectPDF to generate PDF output in the browser. This is the default•
option.
Click PDFtoFolder to generate and save PDF files to a folder. Click•
Select/Browse to specify a location for the folder in the Watched Folder field.
Click PS4D (PostScript File for Later Distilling) to generate a PostScript file. Click•
Select/Browse to specify a location for the folder in the Watched Folder field.
Use this pane to set the desired PDF output style. Choose from the following output
styles:
Default PDF Output Style•
Print - Medium Quality/Medium Resolution•
PDF/X-1a:2001•
22 | A Guide to QuarkXPress Server 2017
Loading...
+ 414 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use