How it Works
Quark
Loading...
QuarkXPress Server - 2018
User Manual
31 pgs210.07 Kb0

Quark QuarkXPress Server - 2018 User Manual

Download
Getting Started with QuarkXPress Server 2018
GETTING STARTED WITH QUARKXPRESS SERVER 2018 | I
Contents
Introduction..................................................................................1
Related Documents ......................................................................2
System Requirements...................................................................3
System requirements: Mac OS X ......................................................................3
System requirements: Windows .......................................................................4
Installing QuarkXPress Server......................................................6
Installing QuarkXPress Server: Mac OS X ........................................................6
Installing QuarkXPress Server: Windows..........................................................6
Upgrading QuarkXPress Server...................................................8
Deploying QuarkXPress Server Manager ....................................9
Installing QuarkXPress Server Manager ...........................................................9
Installing QuarkXPress Server Manager: Mac OS X................................................10
Installing QuarkXPress Server Manager: Windows .................................................10
Deploying QXPSM in a shared Spring context ...............................................10
Deploying in an external Web container....................................13
Deploying QXP Server in external Tomcat .....................................................13
Deploying QXPSM in external Tomcat............................................................14
Deploying QXP Server in WebSphere ............................................................15
Prerequisites............................................................................................................15
Installing the IBM-WebSphere developer version ..................................................16
Configure the Java 7 SDK in the IBM WebSphere .................................................16
Start IBM WebSphere .............................................................................................17
QXPS WebApp deployment into IBM WebSphere UI............................................17
QXPS WebApp silent deployment into IBM WebSphere.......................................19
Deploying QXP Server in WebLogic ...............................................................19
QXPS WebApp deployment into WebLogic UI......................................................21
Introduction to QLA Server........................................................22
Uninstalling.................................................................................23
Uninstalling: Mac OS X ...................................................................................23
INTRODUCTION
GETTING STARTED WITH QUARKXPRESS SERVER 2018 | 1
Introduction
QuarkXPress® Server is a high-fidelity content-composition and rendering server
application. It is built on multiple technologies derived from QuarkXPress. Through
a network connection and a browser, QuarkXPress Server can return rendered
versions of QuarkXPress layouts and QuarkCopyDesk articles in a variety of formats.
This document provides information about QuarkXPress Server software.
SYSTEM REQUIREMENTS
GETTING STARTED WITH QUARKXPRESS SERVER 2018 | 3
System Requirements
This section lists baseline minimum requirements for evaluation and
demonstration. Like any enterprise system, performance is highly contextual based
on data complexity, number of requests, and IT infrastructure. Your specific
requirements for production shall require development as part of the overall
solution planning process.
For more information, please contact http://www.quark.com/support or your Quark
sales contact.
The following is a list of factors to consider when scaling up for production:
Number of requests per minute
Content richness •
Rendered page count •
Number of raster images rendered •
Number of vector images rendered •
Number of images with transparency •
Number of tables •
Number of tables which span across multiple pages •
Number of landscape pages •
Number of footnotes in table cells •
Number of cross references •
Number of image callouts or text callouts •
Output richness •
PDF/print output styles •
Digital output, e.g. number and size of interactive artifacts •
System requirements: Mac OS X
Software
Mac OS X 10.11 (El Capitan™), macOS 10.12 (Sierra™) or macOS 10.13.x (High •
Sierra™)
SYSTEM REQUIREMENTS
Getting Started with QuarkXPress Server 2018 | 5
*Like any enterprise system, performance is highly contextual based on data
!
complexity, number of requests, and IT infrastructure. Contact your account
manager for sizing your organization’s publishing needs.
INSTALLING QUARKXPRESS SERVER
Getting Started with QuarkXPress Server 2018 | 7
Disable any virus protection software. If you are concerned about a virus 1.
infecting your computer, run a virus check on the installer file and then disable
your virus detection software.
Double-click the Installer icon and follow the instructions on the screen. 2.
In the Software Verification screen, enter the validation code. 3.
Do not discard the validation code. You will need it if you have to reinstall.
!
When the License Server Details screen displays, enter the IP address and port 4.
number of the main Quark License Administrator (QLA) server in the Host
Name or IP Address and License Server Port fields. Optionally, enter the IP
address and port number of a backup QLA server in the Backup Host Name or
IP Address and Backup License Server Port fields.
When the Configuration Settings screen displays: 5.
Enter a port number for QuarkXPress Server. •
To install QuarkXPress Server as an automatic service that launches when •
the computer starts up, check Install QuarkXPress Server as a service. You
can choose Local or Domain from the Choose System drop-down menu. If
you choose Domain, enter values in the Domain, User, and Password
fields.
When the Destination screen displays: 6.
The screen displays the drive and folder where QuarkXPress Server will be •
installed. To install QuarkXPress Server elsewhere, click Browse and navigate
to the desired folder.
In the Number of renderers to launch field, enter the number of renderers •
you want to run. The number of available renderers is determined by the
QLA license file.
Complete the installation. 7.
When the installation completes, click Finish. 8.
After its initial launch, QuarkXPress Server creates a “Preferences” folder for each
!
renderer. For example, if you have two renderers, QuarkXPress Server creates two
folders named “Preferences sub1” and “Preferences sub2”. The getserverinfo
request returns the path of the QuarkXPress Server preferences under the element
PREFERENCESPATH.
The URL for getting the QuarkXPress Server Preferences Path:
!
http://localhost:8080/getserverinfo
DEPLOYING QUARKXPRESS SERVER MANAGER
GETTING STARTED WITH QUARKXPRESS SERVER 2018 | 9
Deploying QuarkXPress Server Manager
There are three ways to deploy QuarkXPress Server Manager:
As a standalone server. To deploy QuarkXPress Server Manager in this manner, •
install the software as described in “Installing QuarkXPress Server Manager,” then
double-click the server/QXPSMServerStart.command (Mac OS X) or
server/QXPSMServerStart.bat (Windows) file in the QuarkXPress Server
Manager application folder.
As an independent Web application in an existing Tomcat Web container. For •
more information, see “Deploying QXPSM in external Tomcat.”
As a Web application that shares the same Spring context. For more information, •
see “Deploying QXPSM in a shared Spring context.”
Installing QuarkXPress Server Manager
QuarkXPress® Server Manager coordinates rendering requests in a multiple
QuarkXPress Server instance environment, using load-balancing, fail-safe, and
caching capabilities to determine which server in the pool can best process each
document request. If the first QuarkXPress Server instance in an array is unable to
process a render request, QuarkXPress Server Manager sends the request to another
instance. QuarkXPress Server Manager also provides an object-oriented
programming environment for working with QuarkXPress Server, and it exposes a
set of Web services and Web objects that can be used in any SOAP-compatible
environments such as .NET, JavaScript™, Java™, and Objective-C.
The QuarkXPress Server Manager installation includes three primary components:
QuarkXPress Server Manager Server (the server application that provides services •
for load-balancing, fault-tolerance, and the SOAP server that allows third-party
communication with QuarkXPress Server instances through Web services).
The QuarkXPress Server Manager Web-based administrative client. •
The QuarkXPress Server SDK, which includes Web services API documentation; •
Web service stubs and samples for .NET, Java, and Objective-C; and an
Extensibility Tool for generating custom stubs. This component is helpful for
developing client-side solutions using the QuarkXPress Server Manager Web
services and servlet interface.
DEPLOYING QUARKXPRESS SERVER MANAGER
Getting Started with QuarkXPress Server 2018 | 11
This type of deployment model is possible only when the application in which
!
QuarkXPress Server Manager is to be embedded is a Spring application and is
deployed with an embedded or external Tomcat Web container.
To install QuarkXPress Server Manager in a shared Spring context:
Copy the qxpsm and qxpsmadmin Web application to the webapps folder for 1.
your existing application, so that QuarkXPress Server Manager can be
recognized as a Web application in the existing Web container.
Set cacheFolderContextFile to the path of the “cache.xml” file relative •
to the current working directory.
Set serverXmlFilePath to the path of the “Server.xml” file relative to the •
current working directory.
Copy all QXPSM-dependent jar files from 2.
[QXPSM_Home]/Server/dependencies and [QXPSM_Home]/Server/lib to
a common location, then add all of these jar files to the application classpath so
that they are available to other Web applications that want to use the
QuarkXPress Server Manager API locally.
Import the QuarkXPress Server Manager Spring context file, 3.
“ManagerContainerConfig.xml,” into the existing application Spring context.
Create a Java class named CustomContextLoaderListener that extends 4.
org.springframework.web.context.ContextLoaderListener. Override
the method loadParentContext() as shown here:
public class CustomContextLoaderListener extends org.springframework.web.context.ContextLoaderListener { private static final Logger logger = Logger.getLogger(GlobalContextLoaderListener.class); public void contextInitialized(ServletContextEvent servletContextEvent) { super.contextInitialized(servletContextEvent); String contextName = servletContextEvent.getServletContext().getServletContextName( ); } protected ContextLoader createContextLoader() { return new CustomContextLoader(); } class CustomContextLoader extends ContextLoader { protected ApplicationContext loadParentContext(ServletContext servletContext) {
//============================================================ = //Here, returns the spring context to be used as parent context
//============================================================ = return com.xyz.myapplication.MyApplicationContext.getContext(); } protected WebApplicationContext
DEPLOYING IN AN EXTERNAL WEB CONTAINER
GETTING STARTED WITH QUARKXPRESS SERVER 2018 | 13
Deploying in an external Web container
For development, and simple test deployments, QuarkXPress Server and
QuarkXPress Server Manager are provided pre-installed in an instance of Apache
Tomcat. However, for production deployment alongside other Web applications,
QuarkXPress Server and QuarkXPress Server Manager can be deployed in an existing
Tomcat or WebSphere.
Deploying QXP Server in external Tomcat
To install QuarkXPress Server as an independent Web application in an existing
Tomcat Web container:
Verify that Tomcat 7.0.77 is installed. 1.
Set up the following environment variables: 2.
JAVA_HOME = Java installation folder. For example: E:\Program •
Files\Java\jdk1.8.0_121
CATALINA_HOME = Tomcat installation folder. For example: E:\apache-•
tomcat-7.0.77
Copy contents of the [QXPS_BUILD]/webapps folder to the 3.
[TOMCAT_HOME]/webapps folder.
Copy the [QXPS_BUILD]/conf folder to [TOMCAT_HOME]/bin. 4.
(Mac OS X only) Open the file [Tomcat_Home]/ 5.
bin/conf/ServerApp.properties and make the following changes:
Uncomment the Mac OS X settings section: •
#qxpserver.serverRendererPath=./webapps/ROOT/QuarkXPressSe rver Renderer/QuarkXPress Server.app/Contents/MacOS #qxpserver.serverRendererExecutableName=QuarkXPress Server #qxpserver.DocumentRootFolder=/QuarkXPress Server Documents
Comment out the Windows settings section: •
qxpserver.serverRendererExecutableName=QuarkXPress Server Renderer.exe qxpserver.DocumentRootFolder=C\:\\QuarkXPress Server Documents
In the [TOMCAT_HOME]/bin/conf/Qla.properties file, set the host name, 6.
port number, and serial number of your instance of QLA Server.
DEPLOYING IN AN EXTERNAL WEB CONTAINER
Getting Started with QuarkXPress Server 2018 | 15
Verify that Tomcat 7.0.77 is installed. 1.
Locate the Tomcat installation folder (referred to here as [Tomcat_Home]). 2.
Locate the QuarkXPress Server Manager external Tomcat installation folder 3.
(referred to here as [QXPSM_Tomcat]).
Drag the contents of [QXPSM_Tomcat]/conf to [Tomcat_Home]/conf. 4.
Drag the contents of [QXPSM_Tomcat]/webapps to 5.
[Tomcat_Home]/webapps.
Drag [QXPSM_Tomcat]/qxpsm to [Tomcat_Home]. 6.
Open the file [Tomcat_Home]/conf/ManagerContainerConfig.xml and 7.
make the following changes in the ContainerAdapter bean:
Set cacheFolderContextFile to the path of the “cache.xml” file relative •
to the current working directory.
Set serverXmlFilePath to the path of the “Server.xml” file relative to the •
current working directory.
Open the file [Tomcat_Home]/conf/Catalina.properties and specify the 8.
path of the shared class loader. For example:
shared.loader=${catalina.home}/qxpsm/lib/*.jar,${catalina.home
}/conf
Open the file [Tomcat_Home]/conf/Catalina/localhost/cache.xml and 9.
set the docbase attribute to the path of the appropriate cache folder.
Double-click the “startup.sh” shell file (Mac OS) or the “startup.bat” file 10.
(Windows). These files can be found in the TOMCAT_HOME/bin folder.
Deploying QXP Server in WebSphere
To install QuarkXPress Server as an independent Web application in an IBM
WebSphere Web container:
Prerequisites
Download the IBM Installation Manager 1.6.2 software and extract its contents 1.
to your local folder (for example, IBM_MANAGER_DIR).
Download the IBM WebSphere 8.5.5.0 developer version software. This is in 3 2.
parts in an archived (.zip) format.
Extract all 3 parts of IBM WebSphere 8.5.5.0 to your local folder (for example, 3.
IBM_WEBSPHERE_DIR).
Download the SDK for Java 1.7 for IBM WebSphere 8.5.5.0, This is in 3 parts in 4.
an archived (.zip) format.
Extract all 3 parts of SDK for Java 1.7 to your local folder (for example, SDK-5.
FOR-Java-1.7_DIR).
DEPLOYING IN AN EXTERNAL WEB CONTAINER
Getting Started with QuarkXPress Server 2018 | 17
IBM WebSphere 8.5.5.0 will be installed in your Program Files location.
C:\Program Files (x86)\IBM\WebSphere.
During the installation, you will be asked to enter the configuration file for Part 8.
2 and Part 3 of IBM WebSphere. Select the files from their respective folders:
$(SDK-FOR-Java-1.7_DIR)/was.repo.8550.java7_part2 •
$(SDK-FOR-Java-1.7_DIR)/was.repo.8550.java7_part3 •
The Java7 SDK for IBM WebSphere will be installed successfully. Check it at the 9.
$(WS_INSTALLED_DIR)/AppServer/java_1.7_64 folder
Open the cmd window. Navigate to the 10.
$(WS_INSTALLED_DIR)/AppServer/bin folder.
Type the command managesdk.bat -listAvailable. 11.
Type the command managesdk.bat -enableProfile -profileName 12.
AppSrv01-sdkname 1.7_64. This binds IBM WebSphere into Java7 runtime.
Start IBM WebSphere
Enter First Step.bat from the start menu or from 1.
$(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01/firststeps/fir
ststeps.bat.
The WebSphere Application server dialog displays.
Start the Server. 2.
QXPS WebApp deployment into IBM WebSphere UI
Copy the [QXPS_BUILD]/conf folder to WebSphere’s current directory (for 1.
example, $(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01. Open
“ServerApp.properties” and update the following:
qxpswebserver.embeddedwebcontainer= false •
qxps.webapp.context.name= /qxps •
Open the “QXPSLoadComponents.properties” file located at 2.
$(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01/conf and remove
the following entries:
<import resource="classpath:com/quark/azure/auth/AzureAuthContext.xml" /> <import resource="classpath:com/quark/qxps/azure/config/AzureConfigura tion.xml"/> <import resource="classpath:com/quark/qxps/azure/config/AzureConfigura tion.xml"/>
Open the “PropertiesFilePlaceholders.properties” files located at 3.
$(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01/conf and remove
the following entries:
<value>file:./conf/AzureAuthenticate.properties</value> •
DEPLOYING IN AN EXTERNAL WEB CONTAINER
Getting Started with QuarkXPress Server 2018 | 19
QXPS WebApp silent deployment into IBM WebSphere
Copy the [QXPS_BUILD]/conf folder to WebSphere’s current directory (for 1.
example, $(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01. Open
ServerApp properties and update the following:
qxpswebserver.embeddedwebcontainer= false •
qxps.webapp.context.name= /qxps •
In the [TOMCAT_HOME]/bin/conf/Qla.properties file, set the host name, 2.
port number, and serial number of your instance of QLA Server.
Set QlaServer.machinename to the IP address or hostname of the QLA •
server.
Set QlaServer.port to the port number of the QLA server. •
If you have a backup QLA server, set Backup.QlaServer.machinename •
and Backup.QlaServer.port to its IP address or hostname and port
number.
Save the following script as “install.jython”: 3.
earLoc='C:\QXPSTestAutomation\WebSphere\$(EAR_NAME) appName='$(EAR_NAME)' print AdminApp.install(earLoc, ['-MapWebModToVH', [['.*', '.*', 'default_host']]]) AdminConfig.save()
Save the following script as “uninstall.jython”: 4.
appName=’ $(EAR_NAME)’ print AdminApp.uninstall(appName) AdminConfig.save()
Open the cmd window with admin privilege, go to the 5.
$(WS_INSTALLED_DIR)/AppServer/profiles/AppSrv01/bin folder and
run the following commands:
wsadmin.bat -f '$(PATH_TO_INSTALL_JYTHON_SCRIPT)' -lang jython
Restart IBM WebSphere to launch the QuarkXPress Server. 6.
Deploying QXP Server in WebLogic
To install QuarkXPress Server as an independent Web application in an Oracle
WebLogic Web container:
Download the WebLogic Server 12c from http://www.oracle.com. 1.
Extract the downloaded archive and go through the steps given in the 2.
“README.txt” file in the [$wls]/wlsxxxx folder.
Your domain username and password are those that you entered while setting
up WebLogic.
Start the WebLogic Server using the startWebLogic.cmd cmd in the 3.
$wls]/wlsxxxx/user_projects/domains/base_domain/ folder.
Copy the [QXPS_BUILD]/conf folder to WebLogic’s current directory (for 4.
example, [$wls]/wlsxxxx/user_projects/domains/base_domain).
DEPLOYING IN AN EXTERNAL WEB CONTAINER
Getting Started with QuarkXPress Server 2018 | 21
QXPS WebApp deployment into WebLogic UI
Navigate to the administrative console page for your server 1.
(http://localhost:7001/console) and log in using the domain credentials that you
entered during the WebLogic setup in “Deploying QXP Server in WebLogic”.
Go to domain structure > Deployments > Install, then select the QuarkXPress 2.
Server EAR file ([QXPS_BUILD]\QXPS-EAR\qxps-2017.ear) and select Next.
Select the Install this deployment as an application option button and click 3.
Next.
Click Next, leaving all default settings. 4.
Select the Yes, take me to the deployment’s configuration screen button and 5.
click Finish.
Click Save to finish the installation and save the configuration settings. 6.
Go to the Deployments option listed on the left panel under Domain 7.
Structure.
Observe the status of the qxps-2018 webapp. It will be shown in an active state
after a successful installation.
INTRODUCTION TO QLA SERVER
GETTING STARTED WITH QUARKXPRESS SERVER 2018 | 23
Uninstalling
If the uninstaller detects a running instance of the application, an alert displays.
Close the application before you begin to uninstall.
Uninstalling: Mac OS X
To uninstall QuarkXPress Server, open the Applications folder on your hard drive
(or the folder in which QuarkXPress Server was installed) and drag the
QuarkXPress Server folder to the trash.
To uninstall QuarkXPress Server Manager, open the Applications folder on your
hard drive (or the folder in which QuarkXPress Server Manager was installed) and
drag the QuarkXPress Server Manager folder to the trash.
Uninstalling: Windows
To uninstall QuarkXPress Server or QuarkXPress Server Manager:
Choose Start > All Programs > QuarkXPress Server 2017 > Uninstall or Start 1.
> All Programs > QuarkXPress Server Manager > Uninstall.
Click Yes. 2.
The uninstaller gathers the information necessary for uninstalling and then an
alert displays to notify you that the contents of the application folder will be
deleted.
Click Yes to continue or No to cancel.3.
CHANGES IN THIS VERSION
Getting Started with QuarkXPress Server 2018 | 25
Added PICTURE@ALTTEXT. This lets you set alternate text for each image to •
enhance accessibility.
CONTACTING QUARK
GETTING STARTED WITH QUARKXPRESS SERVER 2018 | 27
Contacting Quark
The support portal allows you to log support tickets, track tickets, receive status
notifications, chat with a technical support representative, search the Knowledge
Base, and access product documentation.
With direct access to documentation across all Quark software - from QuarkXPress
and App Studio to Quark Enterprise Solutions - you can find answers to your
questions at your convenience. Our support team is also available to help, either
through our support portal or via phone for our maintenance contract customers.
If you are a Quark customer and have a current maintenance or support contract
your account has already been created for you using your registered email address. If
you do not have a support contract you can purchase a single support incident to
get your problem resolved. If you have purchased or registered a supported product,
you are eligible for free support for the first 90 days.
In the Americas
For more details, please check out our support website http://www.quark.com/support.
Outside the Americas
For countries outside the Americas, please visit the following sites to access your
support account:
Support Website
France - http://www.quark.com/fr/support •
Germany - http://www.quark.com/de/support •
Loading...
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use