Configuring Platform Server to be used for publishing with Quark XML Author - Sharepoint Adapter.27
Configuring Platform Server to be used for publishing with Quark XML Author - FileNet Adapter.27
JVM memory allocation on Windows..............................................................27
Using Quark Publishing Platform Server Console or Quark Publishing Platform Server Windows service.28
Using "Serverstartup.bat".......................................................................................28
Configuring Windows authentication..............................................................28
Steps to enable SSO in Platform Clients.................................................................29
ii | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
CONTENTS
Steps to configure Web Client for mixed mode authentication.............................30
Setting preferences for Quark XML Author for Platform...............................78
Setting the Check out location................................................................................78
Setting the file deletion preference on Save and Close..........................................78
Setting the quick search preference........................................................................78
Setting the display revision comments preference on Save and Close..................79
Configuring the Platform Adapters for Microsoft Office components for web sharing.79
Configuring the Quark Publishing Platform Adapter for Microsoft Office - Word...80
Configuring the Quark Publishing Platform Adapter for Microsoft Office - Excel...80
Configuring the Quark Publishing Platform Adapter for Microsoft Office - PowerPoint.80
iv | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
CONTENTS
Update published ClickOnce deployments............................................................80
Manual configuration for QuarkXPress and QuarkCopyDesk XTensions........83
Managing backups and file storage............................................84
Backing up Quark Publishing Platform Server................................................84
Backing up your database.......................................................................................84
Backing up assets....................................................................................................84
Backing up Index files (full text search)...................................................................84
publishing: Contains configuration and resource files for the Quark Publishing
Platform framework.
The Platform Server application consists of following modules:
•
admin.war: The Quark Publishing Platform administration Web application.
•
workspace.war: The Quark Publishing Platform workspace Web application.
•
webservices.war: The Quark Publishing Platform Server Web services module.
•
rest.war: The Quark Publishing Platform server REST interface module.
•
messaging.war: The HTTP-based messaging interface.
•
qxpsm.war: QuarkXPress Server Manager.
•
qxpsmadmin.war: The QuarkXPress Server Manager administration Web application.
To generate the Quark Publishing Platform Server JEE enterprise archive:
Copy the Quark Publishing Platform EAR build to the computer on which the
1
application server is running.
Update the configuration files (including "Database.properties", "managerconfig.xml",
2
"PluginContext.xml", and "QLA.properties.xml") as described in "Quark Publishing
Platform Server — Manual configuration ."
Update the values for the JMX Agent username and password in "serverApp.properties".
3
The values for username and password will be the same used to log on to WebSphere's
admin console.
Run RunEARUpdater.bat. A "For Deployment" folder is created, containing a
4
deployable Quark Publishing Platform EAR file.
Deploying in IBM WebSphere
To deploy in IBM WebSphere (Supported version is 8.5.5.4):
Copy the "qpp" folder from "For Deployment" to the working directory of the
1
application server instance where the EAR file will be deployed. For IBM WebSphere,
this is typically the folder corresponding to the target profile.
To deliver resources (Quark Publishing Platform or otherwise) to IBM FileNet, add the
following to the end of the [working directory]\properties\wsjaas.conf file:
Developed by the Apache Software Foundation, Apache Tomcat™ serves as the standard
reference implementation for Java™ Servlet and JavaServer™ Pages technologies.
Tomcat™ is a servlet container for managing Web applications.
10 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
DEPLOYING QUARK PUBLISHING PLATFORM SERVER TO EXTERNAL SERVER CONTAINERS
When you install the standalone version of Quark Publishing Platform Server, the
installation embeds an instance of Tomcat in the Quark Publishing Platform Server
Java Virtual Machine (JVM™) to manage Quark Publishing Platform Web applications,
such as Quark Publishing Platform Web Client.
However, if you are already running a Tomcat server for other Web applications, and
you want the Quark Publishing Platform Web applications to use your existing Tomcat
server, you can deploy Quark Publishing Platform Server in this instance of Tomcat.
Deploying Quark Publishing Platform Server in your existing (that is, external) Tomcat
server means you don't have to run a separate Quark Publishing Platform Server process
on the server computer. If you want to deploy Quark Publishing Platform Server in
your external Tomcat, you can use a separate build located in "Server (External Web
Container)" in your software package.
Requirements and setup
Quark Publishing Platform Server requires JAVA 7 and Apache Tomcat 7.0.61 or above
to be configured as a Web server. The computer on which Tomcat is running should
be a 64-bit computer. You can add Quark Publishing Platform Server to an existing
Tomcat installation.
Setup Tomcat running on Windows
The existing Apache Tomcat installation folder in the steps below is TOMCAT_HOME
To deploy Quark Publishing Platform in an external Tomcat installation created by
the Tomcat installer or deployed with binaries:
Copy the [QPP_BUILD]/qpp folder to the [TOMCAT_HOME] folder.
1
Copy the contents of the [QPP_BUILD]/webapps folder to the
2
[TOMCAT_HOME]/webapps folder.
If a [TOMCAT_HOME]/endorsed folder does not exist, create this folder.
3
Copy the contents of the [QPP_BUILD]/endorsed folder to the
4
[TOMCAT_HOME]/endorsed folder.
If Tomcat is installed with the installer, in the
5
[TOMCAT_HOME]/qpp/publishing/AS-Busdoc.xslt,
[TOMCAT_HOME]/qpp/publishing/BusDoc2QCD.xslt,
[TOMCAT_HOME]/qpp/publishing/BusDoc2QXPS.xslt and
[TOMCAT_HOME]/qpp/publishing/SmartDoc2QXPS.xsltfiles, update the following
Rename the "serviceArchivesMultiServer" folder, located at
8
{TOMCAT_HOME}/webapps/webServices/WEB-INF, to "services".
Repeat the above steps for all Quark Publishing Platform nodes.
Platform Server deployed in external Tomcat
On each Quark Publishing Platform Server computer:
Deploy a standalone instance of Quark Publishing Platform Server in external Tomcat,
1
using the database on the initial computer.
Open the "ActiveMQ.xml" file located in the qpp/conf folder and add network
2
connectors to integrate the server instance's message queue with one or more server
instances in the cluster, where qpp-node-N is the name of a computer where another
instance of Quark Publishing Platform Server is deployed:
Edit the tomcat_home/conf/context.xml file as follows:
6
<Context sessionCookiePath="/">
Rename the "serviceArchivesMultiServer" folder, located at
7
{TOMCAT_HOME}/webapps/webServices/WEB-INF, to "services".
Repeat the above steps for all Quark Publishing Platform nodes.
8
Configuring IIS as an HTTP load balancer
To configure IIS 7 as an HTTP load balancer:
The first step is to deploy the Tomcat connector. For more details on how to do this,
1
see http://tomcat.apache.org/connectors-doc/webserver_howto/iis.html. Create a new folder
16 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
DEPLOYING QUARK PUBLISHING PLATFORM SERVER TO EXTERNAL SERVER CONTAINERS
named "TomcatConnector," then put the "isapi_redirect.dll" file from the Tomcat
Connector for IIS build.
Create a new file named "isapi_redirect.properties" in the same folder, and insert the
2
following into the file:
extension_uri=/jakarta/isapi_redirect.dll
log_file=C:\TomcatConnector\Log\isapi.log
# Make sure the directory listed for log files in the
# "isapi_redirect.properties" file exists
log_level=info
worker_file=C:\TomcatConnector\worker.properties
worker_mount_file=C:\TomcatConnector\uriworker.properties
Create a new file named "workers.properties" in the same folder, and insert the following
3
into the file, where qpp-node1 and qpp-node2 are the values of the jvmRoute attribute
as specified in the "server.xml" file for each Quark Publishing Platform Server:
# This should be the same as the port in the AJP connector defined
# in the "server.xml" file for the Tomcat server in which Quark
# Publishing Platflrm is deployed
worker.qpp-node1.port=61398
# This should be the same as the port in the AJP connector defined
# in the "server.xml" file for the Tomcat server in which Quark
# Publishing Platflrm is deployed
worker.qpp-node2.port=61398
worker.qpp-node2.lbfactor=3
Create a new file named "uriworker.properties" in the same folder, and insert the
JkWorkersFile conf/workers.properties
JkLogFile logs/mod_jk.log
JkLogStampFormat "[%H:%M:%S] "
JkRequestLogFormat "%T"
JkLogLevel error
JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories
<Directory />
AllowOverride All
<Limit GET HEAD POST PUT DELETE OPTIONS>
Order Allow,Deny
Allow from all
</Limit>
</Directory>
JkMount /workspace TomcatBalancer
JkMount /workspace/* TomcatBalancer
JkMount /webservices TomcatBalancer
JkMount /webservices/* TomcatBalancer
JkMount /admin TomcatBalancer
JkMount /admin/* TomcatBalancer
JkMount /rest TomcatBalancer
JkMount /rest/* TomcatBalancer
JkMount /messaging TomcatBalancer
JkMount /messaging/* TomcatBalancer
JkMount /qxpsm TomcatBalancer
JkMount /qxpsm/* TomcatBalancer
JkMount /qxpsmadmin TomcatBalancer
JkMount /qxpsmadmin/* TomcatBalancer
</IfModule>
18 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
DEPLOYING QUARK PUBLISHING PLATFORM SERVER TO EXTERNAL SERVER CONTAINERS
Create a file named {Apache_2.2_installation}/conf/workers.properties
3
and add the following content to it, where qpp-node1 and qpp-node2 are the values
of the jvmRoute attribute as specified in the "server.xml" file for each Quark Publishing
# This should be commented out, if it is not, you cannot connect to the
Apache Web server which
# acts as the load balancer.
worker.TomcatBalancer.sticky_session_force=True
# This should be the IP address of the first QPP node
worker.qpp-node1.host=Server 1
# 8009 is for external tomcat server
# 61398 is for embedded tomcat with QPP
worker.qpp-node1.port=61398
worker.qpp-node1.lbfactor=3
worker.qpp-node2.type=ajp13
# This should be the IP address of the first QPP node
worker.qpp-node2.host=Server 2
# 8009 is for external tomcat server
# 61398 is for embedded tomcat with QPP
worker.qpp-node2.port=61398
worker.qpp-node2.lbfactor=3
Restart Apache 2.2 httpd.
4
To verify the installations, start Quark Publishing Platform Server on all nodes, then
5
access each server using the computer name or IP address and port of the Apache
server. The Apache server should serve and load-balance the request using the Tomcat
connector. You can view the details in the log files at
{Apache_2.2_Installation}/logs.
Configuring server caches flushing mechanism
Platform Server provides two mechanisms to flush caches across all server instances
in case of an update:
• Notification based - This mechanism clears the cache asynchronously. The Notification
based cache flushing is accomplished by publishing of a message of type CACHE with
property FLUSH_INTERCEPTOR. This is the default configured mechanism.
• REST request based - This mechanism clears the cache synchronously. The REST based
mechanism makes an HTTP request to every peer node to trigger its cache flushing:
In the "ServerApp.properties" file located in the [QPP Server]/conf folder,
5
uncomment the following:
# Uncomment following properties to configure QPP cluster with synchronous
cache update
# Set comma separate URIs of peer server instances which are part of Cluster
This command retrieves a copy of the server certificate named "[server name].pem".
Put this file in the ~/Library/Application Support/Quark/QPP/Certificates
folder (or, if you have customized the plist file at ~/Library/Application
Support/Quark/QPP/[QPP Framework Version], put the file there).
If the "Quark Publishing Platform" and "Certificates" folders do not already exist at the
above locations, create them there manually.
Quark Publishing Platform clients running on Windows do not require a server-based
SSL certificate.
22 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
ENABLING SECURE SOCKETS LAYER (SSL) FOR QUARK PUBLISHING PLATFORM SERVER
Verifying and using SSL
To verify and use SSL:
Start the Quark Publishing Platform Server.
1
Test Quark Publishing Platform Web Client access by entering the following:
2
https://[machine IP/name]:61399/workspace.
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 23
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Quark Publishing Platform Server —
Manual configuration
You can change the default configuration after you install Quark Publishing Platform
Server. In addition to setting parameters with JConsole while Quark Publishing Platform
Server is running, you can adjust settings in different .xml files and .properties files.
You can also adjust memory allocation for your JVM configuration.
Editing "ServerApp.properties"
To edit "ServerApp.properties":
Open the "ServerApp.properties" file in the [QPP Server]/conf folder.
1
Set the rmi.port value to the number of the port on which the RMI registry listens.
2
Java-based RMI clients such as ScriptManager connect through this port.
Set the rmi.servicePort value to the port number used by the RMI server where
3
Quark Publishing Platform service objects are registered.
Set the namingservice.port value to the port number used for listening to object
4
resolution requests by the CORBA naming service.
Set the serverORB.port value to the port number used by the ORB where Quark
5
Publishing Platform service objects are activated.
Set the jms.openWirePort value to the port number opened for JMS communication
6
via the OpenWire protocol. Java clients such as Quark Publishing Platform Script
Manager connect to this port to listen to server notifications.
Set the webServer.port value to the port number on which Tomcat listens for HTTP
7
connections. Quark Publishing Platform Web Client and SOAP clients connect through
this port. The value should be set to that specified for the HTTP connector in the
Tomcat "server.xml" file.
Set the socketStreaming.port value to the port number to be used for file transfer
8
(upload/download).
To bind Quark Publishing Platform Server to a particular IP address, set the
9
server.machinename value to that IP address and set server.bindtoip=true. Or,
if you have multiple network cards and you want to bind Quark Publishing Platform
to all of their IP addresses, set server.machinename=localhost,
24 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
server.bindtoip=false, and
server.addtionalnames=[non-default-ip1],[non-default-ip2].
Set the server.additionalnames value to specify the global IP address where the
10
firewall is exposed.
Enter the webServer.port value you configured for Tomcat (8080, for example).
11
To allow users to log on to Quark Publishing Platform Server even when the directory
12
server is not running, set authentication.external.cacheTicket = true.
To set the password case sensitivity, set the server.password.case.sensitive
13
value to false if case sensitivity is not considered for comparing passwords. This option
is not valid if using LDAP for external authentication.
To configure a session TimeOut, set the session.maxIdle value to specify the session
14
timeout in seconds. and set the session.eviction.thread.delay value to specify
the frequency of the session eviction thread in seconds.
The Repository status updater is the background thread that runs at a specified
15
frequency to test whether the underlying repository is active or not and to update the
status of the same in server database. To configure the repository status updater's sleep
interval, set the repository.status.updator.sleepInterval value to specify
the interval in seconds after which the repository status update thread should run.
If the Realm verif. For Admin. Requests is set in QuarkXPress Server, the
16
username and password for QuarkXPress Server need to be set in this file. Set the
following properties to configure the QuarkXPress Server:
•
Set the qxps.username value to specify the QuarkXPress Server username.
•
Set the qxps.password value to specify the QuarkXPress Server password.
•
Set the qxps.locale value to specify the location of QuarkXPress Server.
Editing "PublishingPool.properties"
To edit "PublishingPool.properties":
Open the "PublishingPool.properties" file in the Server Installation conf folder.
1
Set the publishingThread.pool.maxActive value to specify the maximum number
2
of background publishing threads that can run simultaneously.
Set the publishingThread.pool.maxIdle value to specify the maximum number
3
of idle threads in the pool.
Set the publishingThread.pool.minIdle value to specify the minimum number
4
of idle threads in the pool.
Set the publishingThread.pool.maxWait value to specify the time in milliseconds
5
that the publishing request should wait while borrowing a thread from the pool.
Set the publishingThread.pool.minEvictableIdleTimeMillis value to specify
6
the time in milliseconds for a thread to be in the pool before it can be evicted.
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 25
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Set the publishingThread.pool.timeBetweenEvictionRunsMillis value to
7
specify the time in milliseconds after which the evictor thread should run to remove
idle threads.
Configuring Quark Publishing Platform Renderer for Quark Publishing Platform usage
To configure Quark Publishing Platform Renderer for Quark Publishing Platform usage:
Open the QXPSM Admin Client by navigating to the following URL in a Web browser:
1
http://[QPP server name]:[port]/qxpsmadmin.
In the Manage Servers pane, click Add Servers and add the Quark Publishing Platform
2
instance of Quark Publishing Platform Renderer. For more information, see A Guide
to Quark Publishing Platform Renderer.
Editing "Qla.properties"
To edit "Qla.properties":
Open the "Qla.properties" file in the [QPP Server]/conf folder.
1
Enter the IP address or hostname of the QLA Server in the QlaServer.machinename=
2
field.
Enter the port number of the QLA Server in the QlaServer.port= field.
3
If you have a backup QLA server, enter the IP address (or hostname) and port number
4
in the Backup.QlaServer.machinename= and Backup.QlaServer.port= fields.
Enter the Quark Publishing Platform serial number in the Qla.SerialNumber= field.
5
The QLA Server Console and QLA Client applications display your Quark Publishing
Platform serial number.
Save and close "Qla.properties."
6
Extended configuration files
Configuration files are split into base and ext for ease of deployment.
User specific custom beans, processes and publishingchannels should be defined in
.ext files in the Server Installation ext folder, to separate custom extensions and
maintain them after a software upgrade.
• ChannelConfig-ext.xml
• content-mimetype-mappings-ext.xml
• custom-xml-types-ext.xml
• IndexingChannels-ext.xml
• PluginsContext-ext.xml
26 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
• ProcessConfig-ext.xml
• PublishingConfig-ext.xml
Configuring Platform Server to be used for publishing with Quark XML Author Sharepoint Adapter
To configure Quark Publishing Platform Server to be used for publishing with Quark
XML Author - Sharepoint Adapter:
Open the "sharepoint.properties" file in the [QPP Server]/publishing folder.
1
Set the sharepoint.username value to be the login name of a user with access to
2
Sharepoint sites.
Set the sharepoint.userpassword value to be the login password of the user specified
3
above.
Set the sharepoint.userdomain value to be the domain of the user specified above.
4
Set the sharepoint.sitecollection value to be the URL of a Sharepoint Site
5
Collection which contains documents required during publishing.
Restart the Server.
6
Configuring Platform Server to be used for publishing with Quark XML Author FileNet Adapter
To configure Quark Publishing Platform Server to be used for publishing with Quark
XML Author - FileNet Adapter:
Open the "contentengine.properties" file in the [QPP Server]/publishing folder.
1
Set the filenet.stanza value to be the stanza for filenet content engine connection.
2
You need to edit the parameter only when the filenet server is configured to use a
stanza other than FileNet.
Set the filenet.username value to be the FileNet username.
3
Set the filenet.userpassword value to be the value to be the FileNet password of
4
the user specified above.
Set the filenet.connectionuri value to be the Connection URI of the FileNet
5
Content Engine WebService.
Restart the Server.
6
JVM memory allocation on Windows
On Windows, you can specify JVM memory allocation in different locations, depending
on how you start Quark Publishing Platform Server. On 64-bit operating systems, you
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 27
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
can allocate more memory for the Quark Publishing Platform Java process. In either
case, you should not allocate more than 50 percent of available memory.
Using Quark Publishing Platform Server Console or Quark Publishing Platform
Server Windows service
Stop Quark Publishing Platform Server.
1
If you start Quark Publishing Platform Server with Quark Publishing Platform Server
2
Console or Quark Publishing Platform Server Windows service, open the "wrapper.conf"
file.
Search for the wrapper.java.maxmemory property.
3
Adjust the value. On a 64-bit operating system, you can make the value larger.
4
Save your changes and restart Quark Publishing Platform Server.
5
Using "Serverstartup.bat"
Stop Quark Publishing Platform Server.
1
If you start Quark Publishing Platform Server with the "ServerStartup.bat" file in the
2
Quark Publishing Platform Server installation folder, open "ServerStartup.bat".
Search for java -server -Xmx1536m -XX:MaxPermSize=256m -classpath. 1536m
3
represents 1536MB of RAM allocated to Quark Publishing Platform Server.
On a 64-bit operating system, you can make the value larger.
4
Save your changes and restart Quark Publishing Platform Server.
5
Configuring Windows authentication
Windows users can log on to Quark Publishing Platform transparently with their
Windows user credentials, without ever having to see a login dialog box. Quark
Publishing Platform supports all Windows authentication schemes, including
NTLM-v1/NTLM-v2 and Negotiate/Kerberos. The Platform also supports mixed-mode,
so Windows authentication and Platform authentication can coexist.
You configure Windows authentication with a pluggable HTTP servlet filter. You can
easily enable and disable authentication at deployment time by adding a security filter
to each Web application‘s "web.xml" file.
28 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Each web application of Quark Publishing Platform can be configured to use different
Windows authentication schemes as indicated below.
NTLM and KerberosNegotiate/Kerberos onlyNTLM onlyWeb application
NTLM NegotiateNegotiateNTLMWorkspace
NTLM NegotiateNegotiateNTLMAdmin
NTLM NegotiateKerberosNTLMWeb services
Steps to enable SSO in Platform Clients
For the Admin web app:
Go to C:\Program Files\Quark\Quark Publishing
1
Platform\Server\webapps\admin\WEB-INF
Open the "Web.xml" file and uncomment the following snippet:
Restart the server and access the corresponding web applications with the following
5
URLs:
• For access through native Platform user authentication use the URL :
http://localhost:61400/workspace/local.jsp
• For access through Windows authentication use the URL:
http://localhost:61400/workspace/
The steps above can be repeated for Web Admin or other web apps as well.
30 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Configuring logging levels
You can edit the "log4j.xml" file to adjust logging levels, and you can use JConsole to
change logging levels after starting Quark Publishing Platform Server. You can also set
different logging levels for exceptions.
Changing logging levels in "log4j.xml"
You can change the logging levels for Quark Publishing Platform Web Client and
Quark Publishing Platform Server. Options include ERROR, INFO, WARN, DEBUG,
SQLTRACE, 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.
•
SQL_TRACE = includes messages according to activity related to SQL requests.
•
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 "log4j.xml" file in the {QPP Server}/conf folder.
1
To define the logging level for Quark Publishing Platform Web Client activity, scroll
2
to <logger name=com.quark.qpp.web.webeditor. The structure is as follows:
Do not edit the values of other properties in the "Query.properties" configuration file.
7
Save and close "Query.properties."
8
Restart Quark Publishing Platform Server for these settings to take effect.
9
Database properties
You can manually specify the database connection URL, database user name, database
user password, and database connection pool size.
To change database properties:
34 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
In the "Database.properties" file located in the [QPP Server]/conf folder.
1
Scroll to the Database related configuration section.
2
To specify the driver class name, replace the qpp.jdbc.driverClassName value. For
3
example, for an HSQL database, you would use
qpp.jdbc.driverClassName=org.hsqldb.jdbcDriver.
To specify the database connection URL, replace the path after qpp.jdbc.url.
4
To specify the database user name, replace the qpp.jdbc.userName value.
5
To specify the database user password, replace the qpp.jdbc.password value.
6
To specify the database connection pool size, change the qpp.jdbc.maxActive value.
7
To specify the maximum and minimum numbers of connections that can be idle,
8
change the qpp.jdbc.maxIdle and qpp.jdbc.minIdle values.
To specify the minimum time in milliseconds that a connection must be in the pool
9
before it can be evicted, change the qpp.jdbc.minEvictableIdleTimeMillis
value.
To specify the minimum time in milliseconds after which the evictor thread should
10
run to remove an idle connection, change the
qpp.jdbc.timeBetweenEvictionRunsMillis value.
To adjust the pooling of prepared statements, change the
11
qpp.jdbc.poolPreparedStatements value.
To specify the maximum number of connections to be made in the no-autocommit
12
pool , change the qpp.jdbc.maxActive_noAutoCommit value.
Save and close "Database.properties."
13
If there is a firewall configured between the Platform Server and the Database server
that can terminate TCP sessions when they are idle for a long time, the following
configuration changes should be done in the "Database.properties" file .
•
Set the qpp.jdbc.minIdle value to 0
•
Set the qpp.jdbc.minEvictableIdleTimeMillis value to 60000
•
Set the qpp.jdbc.timeBetweenEvictionRunsMillis value to 60000
Platform Server needs to be restarted for these settings to take effect.
Transformation properties
You can use transformation properties to modify the output of various predefined
transformations. Changes to the "Transformation.properties" file alter the external
commands that are invoked for transforming assets. Commands in this file can contain
predefined macros such as <temp>, <source>, <extension> and <output>.
To change transformation properties:
Open the "Transformation.properties" file located in the [QPP Server]/conf folder.
1
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 35
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
To specify a pattern that does not occur as a value (or part of a value) for any other
2
property, specify a value for transformer.spaceEncodingPattern. This pattern is
used for escaping spaces in commands and other property values.
To specify which file types ImageMagick is allowed to handle, enter a comma-separated,
3
case-insensitive list of file extensions in imTransformer.extensions.
To specify the temporary file location to be used by ImageMagickTransformer, specify
4
a path for imTransformer.tempDir.
To specify the ImageMagick command to be executed for generating output with
5
ImageMagickTransformer, enter a value for imTransformer.jpg.imCommand.
To specify which file types the JawsTransformer is allowed to handle, enter a
6
comma-separated, case-insensitive list of file extensions in
jawsTransformer.extensions.
To specify the temporary file location to be used by JawsTransformer, specify a path
7
for jawsTransformer.tempDir.
To specify the Jaws command to be executed for generating output with
8
JawsTransformer, enter a value for jawsTransformer.jpg.command.
Save and close "Transformation.properties."
9
Session timeout
You can specify how long individual sessions can remain idle before they are timed-out,
as well as the frequency of testing for idle sessions.
To specify timeout parameters:
Open the "ServerApp.properties" file located in the [QPP Server]/conf folder.
1
Scroll to the session.maxIdle= entry.
2
Enter the number of seconds a session can be idle before timing out.
3
To specify the frequency for Quark Publishing Platform Server to perform a background
4
check for idle sessions, enter a number (measured in seconds) in the
session.eviction.thread.delay property.
Save and close "ServerApp.properties."
5
Web Client timeout settings can be changed by adjusting the ajaxTimeout entry in
the "Workspace-Config.xml" file (this entry is in milliseconds). This file is located at
You can specify a background thread that runs frequently to confirm the Quark
Publishing Platform File Server status.
To specify the repository status update interval:
36 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Open the "conf" folder in your Quark Publishing Platform Server folder.
1
Open "ServerApp.properties" in a text-editing application.
2
Scroll to the repository.status.updator.sleepInterval= entry.
3
Enter a value to specify the number of seconds after which the repository status updater
4
thread will run.
Save and close "ServerApp.properties."
5
Moving Quark Publishing Platform Renderer
If you need to move your Quark Publishing Platform Renderer to a different computer,
you don't have to re-install Quark Publishing Platform Server. Instead, you can edit
the "ManagerConfig.xml" file, as follows:
Open the "ManagerConfig.xml" file located in the [QPP Server]/conf folder.
1
Scroll to the <connectioninfo> section at the bottom of "ManagerConfig.xml."
2
Change the name entry value to the IP address or hostname of the new Quark
3
Publishing Platform Renderer.
Change the port entry value to the port number you specified for the new Quark
4
Publishing Platform Renderer.
Save the "ManagerConfig.xml" file and launch Quark Publishing Platform Server.
5
To verify the change, search through the "QppServer.log" file for the line Successfully
6
registered with QXPS.
Alternatively, you can open the Quark Publishing Platform Renderer Manager client
with the URL http://[server]:[port]/qxpsmadmin and make these changes there.
Unless you check Realm verif. For Admin. Requests and enter a user name and
password in the HTTP tab of the QuarkXPress Server Configuration dialog box, you
can leave the <user> and <password> entries blank. This also applies to the username
and password fields in the "ServerApp.properties" file (qxps.username and
qxps.password).
Integrating Quark Publishing Platform with LDAP
For information about integrating Quark Publishing Platform with LDAP, see "Managing
User Lists with LDAP" in A Guide to Quark Publishing Platform.
Using Kerberos authentication
To use Kerberos authentication:
Open "krb5.conf" in a text-editing application. The "krb5.conf" file contains the Kerberos
1
configuration information, which includes the locations of the Key Distribution Center
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 37
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
(KDC) and admin servers for the Kerberos realms. Kerberos is a secure method for
authenticating requests for a service over a computer network.
Specify realm settings in the "krb5.conf" file
Edit "krb5.conf" to specify all realm settings. This includes setting the realm names,
2
default realm, realm-domain mappings, and KDCs for the realms.
Save and close "krb5.conf."
3
The convention is to enter realm names in uppercase letters and domain names in
lowercase letters.
Using Simple authentication
If you are using a directory server other than Active Directory on Windows, then in
most cases you will use the Simple authentication scheme. To use Simple
authentication:
In the LDAP Attribute mapping set the Authentication Name= :uid: User Name=uid.
1
For Simple authentication, the Realm Name is optional.
2
Connecting LDAP user passwords with Quark Publishing Platform Server
If you configure Quark Publishing Platform according to the instructions below and
the connection between Quark Publishing Platform Server and Directory Server breaks,
users can still log on to Quark Publishing Platform Server with their Directory Server
credentials.
When a user logs on to Quark Publishing Platform Server successfully for the first time,
encrypted user credentials are stored in Quark Publishing Platform. These credentials
can then be used for subsequent log-on operations when there is no connection
between Quark Publishing Platform Server and Directory Server.
To specify that the LDAP user password can be retrieved, encrypted, and stored in the
Quark Publishing Platform Server database:
38 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Open the "ServerApp.properties" file located in the [QPP Server]/conf folder.
1
To allow users to log on to Quark Publishing Platform Server when the connection
2
between Quark Publishing Platform Server and Directory Server is broken, change the
value for authentication.external.cacheTicket= to true. The default setting
for authentication.external.cacheTicket= is false (that is, disabled).
To indicate that it is required to evaluate the
3
"CollectionInfo#isAccessibleChildrenAvailable()" flag at runtime for every collection
in context, the value of collections.evaluateAccessibleChildrenFlag= should
be true (default).
Once an element is fetched from the LDAP server, it will be cached in the Platform
4
Server and provided from the cache for a specified number of seconds, and fetched
again after that time. To specify time to live (in seconds) for LDAP cache elements, set
the value for ldap.cache.timetolive=.
To specify the LDAP synchronization time delay (in seconds), set the value for
5
ldap.synchronization.thread.delay= to true. If LDAP synchronization is not
required, set the value to -1.
Save and close "ServerApp.properties."
6
Restricting Workspace Browser palettes
To restrict the number of Workspace Browser windows which can be open at one
time by a user:
Open the "Query.properties" file located in the [QPP Server]/conf folder.
1
Specify a value for the query.maxWatchedQueryCountPerSession parameter.
2
Save and close "Query.properties".
3
Changing query results settings
• To limit the number of results that will be returned for an Assignments based search,
specify a positive non-zero value for the query.maxAssignmentFetchCount
parameter.
• To limit the number of results that will be returned for a User based search, specify a
positive non-zero value for the query.maxRowFetchCount parameter.
Setting up custom content type detection
By default, Quark Publishing Platform is configured to recognize Quark formats,
common picture formats, common content formats (Microsoft Office, plain text, RTF,
PDF, HTML), XML, XHTML, DITA documents, and BusDoc documents. However, you
can configure Quark Publishing to automatically attempt additional, custom content
types. To do so:
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 39
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
To recognize a particular content type by examining a file's MIME type, make sure
1
that MIME type is listed in the "tika-mimetypes.xml" file. If the MIME type is not
included in this file, you can add it to the "custom-mimetypes" file. You can identify
file types by file extension, by magic bytes, or (for XML files) by the root element. For
Save and close "AsposeFilterServiceConfig.properties."
5
Save and close "JawsFilterServiceConfig.properties."
6
APS filter
Adjust the APS filter settings:
Open the "ApsFilterServiceConfig.properties" file located in the [QPP Server]/conf
1
folder.
apsfilter.generatePreview=true.
2
apsfilter.generateThumbnail=true.
3
apsfilter.generateAttributes=true.
4
apsfilter.generateText=true.
5
To specify the time the process should wait before exiting, if indexing is not done,
6
enter a value in the apsfilter.processTimeOut= entry (in milliseconds).
To specify the maximum number of pages for which preview should be generated,
7
enter a value in the apsfilter.previewPages= entry.
Save and close "ApsFilterServiceConfig.properties."
8
POI filter
Adjust the POI filter settings:
Open the "POIFilterServiceConfig.properties" file located in the [QPP Server]/conf
1
folder.
poifilter.approximateCharactersPerPage. Set the number of characters which
2
approximately constitutes a page of text. This value will decide the page break for text
files.
poifilter.previewMaxLineLength. Set the maximum number of characters to
3
place in a row for preview image generation from text files.
44 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
poifilter.fontName. The name of the font to be used for image generation from
4
text.
poifilter.previewFontSize. The size of the font required for text in an image.
5
poifilter.lineSpacing. The spacing between lines in term of multiples of font
6
size defined in the poifilter.previewFontSize property.
Save and close "POIFilterServiceConfig.properties."
7
Configure processing of MS Office documents
Adjust the MS Office filter settings:
Open the "OfficeServiceConfig.properties" file in the [QPP Server]/conf folder.
1
Set the office.defaultImageFormat property to specify the default output format
2
type. Default format is PNG.
Set the office.defaultHorizontalResolution property to specify the default
3
horizontal resolution of previews.
Set the office.defaultVerticalResolution property to specify the default vertical
4
resolution of previews.
Set the office.onePagePerSheet property to true and all content of the sheet will
5
output to only one page.
Set the office.showHiddenWorksheets property to control the visibility of hidden
6
worksheets.
To set the option to remove or hide the hidden columns/rows from the output formats
7
HTML, XHTML, SMARTTABLE and CALS, set the following properties:
•
office.defaultHiddenColumnDisplayType= entry. The allowed values for this
option are hide or remove.
•
office.defaultHiddenRowDisplayType= entry. The allowed values for this option
are hide or remove.
QuarkXPress Server Filter
To adjust QuarkXPress filter settings:
Open the "QxpsFilterServiceConfig.properties" file located in the [QPP Server]/conf
1
folder.
Set the qxpsfilter.useSpreadForArticles= value to true to specify that previews
2
for articles are generated for each spread.
Set the qxpsfilter.useSpreadForProjects= value to true to specify project
3
previews with spreads.
By default, XML deconstruction is enabled. The default setting for the
4
qxpsfilter.generateDeconstructedXML= entry is true. To disable XML
deconstruction, set the entry to false.
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 45
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
By default, Full Text Search (FTS) is enabled. The default setting for the
5
qxpsfilter.generateText= entry is true. To disable FTS, set the entry to false.
A true value for qxpsfilter.generateDeconstructedXML also enables FTS for
QuarkXPress projects and QuarkCopyDesk articles. Text generation is dependent on
XML generation. If you set generateDeconstructedXML to false, Quark recommends
also setting qxpsfilter.generateText to false.
To specify the scale of preview images, adjust the qxpsfilter.previewScale= value.
6
The default value of 1 indicates previews at 100 percent. The values of 2, 3, and 6 are
200 percent, 300 percent, and 600 percent, respectively.
To specify the scale of thumbnail images, adjust the qxpsfilter.thumbnailScale=
7
value. The default value of 1 indicates previews at 100 percent. The values of .5, 2, 3,
and 6 are 50 percent, 200 percent, 300 percent, and 600 percent, respectively.
To specify image quality for JPEG previews, adjust the qxpsfilter.jpegQuality=
8
value. Enter 1 for the highest quality, 2 for high quality, 3 for medium quality, and 4
for lowest quality.
Save and close "QxpsFilterServiceConfig.properties."
9
JAWS filter settings
The JAWS filter is part of the ImageMagick® Filter Service Configurations for EPS, PDF,
and Adobe® Illustrator® files. To specify settings for the JAWS filter:
Open the "JawsFilterServiceConfig.properties" file located in the [QPP Server]/conf
1
folder.
To specify the resolution for thumbnails and previews (measured in dots-per-inch),
2
adjust the jawsfilter.resolution= value.
The jawsfilter.resolution= value is the fallback resolution used to scale the
preview image to the specified size when the proper resolution cannot be calculated.
Save and close "JawsFilterServiceConfig.properties."
3
XML Author filter settings
The XML Author filter is part of the configuration for XML files. XADocFilter is used
to generate Previews and Thumbnails of XML files. To specify settings for the XML
Author filter:
Open the "XADocFilterServiceConfig.properties" file located in the [QPP Server]/conf
1
folder.
To specify the amount of time a process will wait for indexing (with XADocFilter) to
2
complete, adjust the xaDocfilter.processTimeOut= value.
To specify the preview height and width, adjust the xaDocfilter.previewHeight=
3
value and the xaDocfilter.previewWidth= value.
To specify the maximum number of pages for which a preview should be generated,
4
adjust the xaDocfilter.previewPages= value.
46 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Save and close "XADocFilterServiceConfig.properties."
5
ImageMagick, Jaws, and DITA OT directories
By default, ImageMagick, Jaws, and the DITA Open Toolkit are included with Quark
Publishing Platform. However, if you have existing installations of ImageMagick or
Jaws, perform the following tasks:
Open the "ServerApp.properties" file located in the [QPP Server]/conf folder.
1
Scroll to the IMAGE_MAGICK_HOME= entry.
2
Enter the path to your existing ImageMagick bin folder.
3
Scroll to the JAWS_HOME= entry.
4
Enter the path to your existing Jaws bin folder.
5
Scroll to the DITA_HOME= entry.
6
Enter the path to your existing DITA Open Toolkit folder.
7
Save and close "ServerApp.properties."
8
Full text indexing configuration
To configure FTSIndex filter settings:
Open the "LuceneTextIndexingConfig.properties" file located in the [QPP
1
Server]/conf folder.
By default, the storage location for index files is in the Quark Publishing Platform
2
installation folder. However, you can change the location by changing the
lucene.index.dir= parameter to indicate the folder in which you want to store
index files.
Specify the language (class) used most frequently for text indexing and query term
3
analysis by changing the lucene.analyzerClass= parameter. The default setting
—StandardAnalyzer— recognizes English semantics for Full Text Search. But if the
majority of the text in your workflow is not English, you can specify another language
to search more accurately according to that language's semantics. The languages are
listed in the "LuceneTextIndexingConfig.properties" file.
"LuceneTextIndexingConfig.properties" contains information for each parameter, as
well as links to the Apache documentation.
To specify the number of changes after which an index compaction shoud be
4
performed, set a value for lucene.maxModificationWithoutOptimisation.
Save and close "LuceneTextIndexingConfig.properties."
5
Charting Service
To configure the properties for the Charting service modify the below properties:
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 47
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Enter the default output format (PDF/HTML/IMAGE/JSON) in the
1
charting.defaultOutputFormat parameter.
Enter the default values for the image output properties in the following parameters:
The countdown message will be shown with remaining seconds. The user can prevent
the forced log off by clicking Continue Session.
Forced log off countdown
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 57
QUARK PUBLISHING PLATFORM SERVER — MANUAL CONFIGURATION
Configuring messaging
To configure Quark Publishing Platform Server to display Asset Workflow Changed
messages when any listed attribute is changed on the related asset:
Open the "AssetWorkflowChangedMessageAttributes.xml" file located in the
1
[install_path]/Server/conf/ folder.
Set the attribtues IDs or names to trigger the Asset Workflow Changed message
2
when any listed attribute is changed on the related asset.
<!-- List of attribute ids or names to be considered for "ASSET WORKFLOW
CHANGED MESSAGE"
The "ASSET WORKFLOW CHANGED MESSAGE" will be published if there is any
changes in the attributes
of the mentioned asset/>
<util:list id="assetWorkflowAttributes">
<value>name</value>
<value>Status</value>
<value>Workflow</value>
<value>Routed to</value>
</util:list>
</beans>
58 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM WEB CLIENT: MANUAL CONFIGURATION
Quark Publishing Platform Web
Client: Manual configuration
The following sections describe how to configure the advanced settings of Quark
Publishing Platform Web Client.
Configuration overview
The workspace configuration is organized into two categories:
• Application level settings
• Document level settings
These are set in the "Workspace-Config.xml" configuration file in the [QPP Server]/
webapps /workspace/WEB-INF/classes folder.
Application level settings
The attribute elements of ApplicationSettings defines various application level
settings:
•
userNameFormatting: Specifies the format of the user name to be displayed in all
dialogs:
0 to display login name <username>
1
1 to display <First Name> <Last Name>
2
2 to display <Last Name>, <First Name>
3
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 59
QUARK PUBLISHING PLATFORM WEB CLIENT: MANUAL CONFIGURATION
•
layoutPreview: Specifies the look and feel of the preview window for assets belonging
to the QuarkXPress content type:
True to display the preview in a separate browser window
1
False to display the preview ina javascript window instead of a browser.
2
•
viewrevision_expandAll: Specifies whether all revision comments need to be
expanded in the view revisions dialog.
•
supported_picture_extension: Specifies the possible file types allowed when
importing a picture/text in the article/project editors.
•
picture_editing_extension: Specifies the possible file formats allowed when
editing pictures in the article/project editors.
•
defaultPreviewScale: Specifies the default zoom preview setting to be used when
editing articles/projects and viewing assets (live preview). Valid values for this parameter
range from 0.1 to 5.
•
ajaxTimeout: Specifies the time period for all background requests originating from
browser after which the requests will be marked as timed out. The value is specified
in milliseconds.
•
showFormView: Specifies whether to show the form view panel in the Check In dialog.
Set to true to show the form view pane.
•
topBannerJspPath: Specifies the path to the .jsp file to be included to show the top
banner in the assignment page.
•
logoFilePath: Specifies the path to the logo image shown in the top banner in the
assignment page.
•
enabledPublishingChannels: Defines the list of publishing channels that need to
be honored when selecting an asset.
•
enableDeliveryChannels: Defines whether delivery channels needs to be enabled
or not.
60 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM WEB CLIENT: MANUAL CONFIGURATION
•
enabledDeliveryChannels: Defines the list of delivery channels that need to be
honored when selecting an asset. This would get enabled when the
enableDeliveryChannels option is set to true.
•
allowPublishedRenditionDownload: Defines whether to allow the download
output displayed for the various previews using the publishing defined for the selected
62 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM WEB CLIENT: MANUAL CONFIGURATION
Role based Toolbar configuration
This section describes how to define the toolbar items for a desired role. Role based
configuration for toolbar items are configured using the <ToolbarConfig> element.
•
Role name: Specify the name of role whose configuration is to be defined.
•
Item ID: Specify the id of the item whose appearance needs to be configured.
•
showInToolbar: To hide the menu item in the toolbar, set this attribute to false.
•
showInContext: To hide the menu item in the context menu, set this attribute to
false.
•
showInNewMenu:To hide the menu item in the New Asset menu, set this attribute to
false.
•
showInTemplateMenu: If the menu item is not to be shown in the New Asset from
Template, set this attribute to false.
The following is the XML structure of the toolbar configuration:
<Role name ="[ROLE NAME]">
<Item id ="[ITEM ID]"
showInToolbar ="[true/false (defaults to true)]"
showInContextMenu ="[true/false (defaults to true)]"
showInNewMenu ="[true/false (defaults to true)]"
showInTemplateMenu ="[true/false (defaults to true)]"/>
</Role>
<ToolbarConfig>
<Role name ="Guest">
<Item id ="new_qcd_menu_item"/>
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 63
QUARK PUBLISHING PLATFORM WEB CLIENT: MANUAL CONFIGURATION
<Item id ="new-search-btn"/>
<Item id ="duplicate-asset" showInToolbar="false"/>
<Item id ="delete-asset"/>
<Item id ="show-edit-attributes" showInContextMenu="false"/>
<Item id ="show-Asset_preview" showInToolbar="false"/>
........
</Role>
</ToolbarConfig>
The Context menu for the Guest role will look like:
Context menu for Guest role
Toolbar items fo the Guest role will look like:
Toolbar items for Guest role
Here is the list of item IDs:
•
checkin: Check in the Asset
•
show-check-out: Check out the Asset
•
cancel-checkout: Cancel Asset Check out
•
get-asset: Get Asset
•
new-search-btn: New Search (not available as Context Menu Item)
•
show-Asset-Preview: Preview Asset
•
show-edit-attributes: Edit Asset Attributes
•
attachment-info: Show Attachment Information
•
view-revisions: View Asset Revisions
•
duplicate-asset: Duplicate Asset
•
delete-asset: Delete Asset
•
reindex-asset: Reindex Asset (not shown in Toolbar by default)
•
publish-menu-btn: Publish an asset
•
deliver-menu-btn: Deliver an asset
•
restore: Restore assets
64 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
QUARK PUBLISHING PLATFORM WEB CLIENT: MANUAL CONFIGURATION
•
archive-asset: Archive assets
•
open-collection: Open the collection to which the asset belongs
•
refresh-datadoc: Refresh a datadoc
•
unlink-datadoc: Unlink a datadoc
•
open-readonly: Open asset as read-only
•
new_qcd_menu_item: Create new QuarkCopyDesk Article
•
new_qxp_menu_item: Create new QuarkXpressProject from template
The showInToolbar and showInContextMenu attributes are only applicable for menu
items displayed in the toolbar and the context menus. For buttons configured in the
ui-extension.xml file, showInToolbar is not applicable, as the configuration is meant
for adding a toolbar button itself. Additionally the button can be added to context
menu, hence only showInContextMenu is applicable for ui-extension.xml buttons. The
showInNewMenu and showInTemplateMenu attributes are only applicable for menu
items in the New Asset menu dropdown, and are not applicable while setting up role
based configuration for ui-extension.xml menus in this section.
The rest of the configurable elements specified in "Workspace-config.xml" are for
integration with Quark Author Web Edition. For more information, see "Quark Author
Web Edition Configuration Guide".
Restricting access to Web Client/Admin
To restrict the webapp so that the workspace and admin pages can only be accessed
from within your own network, use a Tomcat Valve to restrict access based on an IP
address range.
Open the "server.xml" file located in the {install_path}/conf folder.
1
Edit the context elements corresponding to the admin and workspace applications to
2
engage a RemoteAddrValve. The valve has to be configured to allow only intranet
traffic. The final config would look something like the following:
for Quark Publishing Platform client is AppData\Quark Inc\Quark Publishing
Platform\{version}\Logs
•
for Platform Client related operations in QuarkXPress is AppData\Roaming\Quark
Software Inc\QuarkXPress {version}\{version}\Logs
To change the size of the log file size, define the new size using the QPSLogFileSize
attribute. The size is defined in Bytes. The default value of the Out of the Box config
is 5242880 bytes.
Use the QPSLogFileMode attribute to specify how the log file is written.
Allowed values are:
• 1 (CreateNew). Specifies that the operating system should create a new file. If the file
already exists, a System.IO.IOException is thrown.
• 2 (Create). Specifies that the operating system should create a new file. If the file already
exists, it will be overwritten.
• 3 (Open). Specifies that the operating system should open an existing file. If the file
does not exist, a System.IO.FileNotFoundException is thrown.
• 4 (OpenOrCreate). Specifies that the operating system should open a file if it exists,
otherwise, a new file should be created.
• 5 (Truncate). Specifies that the operating system should open an existing file. Once
opened, the files should be truncated so that the file size is zero bytes.
• 6 (Append). Opens the file if it exists and seeks to the end of the file, or creates a new
file.
FileMode - OpenOrCreate (4) allows one to open a file with the following access :
The setting to create and maintain the log file is mentioned in the
Quark.QPP.Client.config file. This file can be found in the application folder.
Users can enable and disable logging using the QPSLogIsEnabled attribute.
The supported values are:
• 0 (NO)
• 1 (YES)
To change the location of the log file, define the new log location using the
LogFilePath attribute. The log location is AppData\Quark\XML Author\Logs\CMS
Adapter Log.txt
To change the size of the log file size, define the new size using the QPSLogFileSize
attribute. The size is defined in Bytes. The default value is 5242880 bytes.
Use the QPSLogFileMode attribute to specify how the log file is written.
Allowed values are:
• 1 (CreateNew). Specifies that the operating system should create a new file. If the file
already exists, a System.IO.IOException is thrown.
• 2 (Create). Specifies that the operating system should create a new file. If the file already
exists, it will be overwritten.
• 3 (Open). Specifies that the operating system should open an existing file. If the files
does not exist, a System.IO.FileNotFoundException is thrown.
• 4 (OpenOrCreate). Specifies that the operating system should open a file if it exists,
otherwise, a new file should be created.
• 5 (Truncate). Specifies that the operating system should open an existing file. Once
opened, the files should be truncated so that the file size is zero bytes.
• 6 (Append). Opens the file if it exists and seeks to the end of the file, or creates a new
file.
FileMode - OpenOrCreate (4) allows one to open a file with the following access :
• For Quark Publishing Platform Client for Windows, open the "Quark Publishing
Platform Client.exe.config" file (in the Quark Publishing Platform Client application
folder), locate the following text, and set the value attribute to DEFAULT for
[username], FIRSTNAME_LASTNAME for [username] ([first name] [last
name]), or LASTNAME_FIRSTNAME for [username] ([last name], [first name]).
• For QuarkXPress and QuarkCopyDesk for Windows, open the
"Quark.QPP.client.config" file (in the application folder), locate the following text,
and set the value attribute to DEFAULT for [username], FIRSTNAME_LASTNAME for
[username] ([first name] [last name]), or LASTNAME_FIRSTNAME for
[username] ([last name], [first name]).
To change the font and size used for attribute values to a font other than the default
search palette font and size, add the following key to the <appSettings> section of
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 71
Setting maximum number of assets to be fetched (Windows only)
To change the maximum number of assets fetched per collection when the user
performs a Get Asset command or a Get Collection command, add the following
key to the <appSettings> section of the “Quark Publishing Platform Client.exe.config”
file, with the desired number in the “value” attribute:
Specify whether to use Chunked Encoding (Windows only)
To specify whether or not to use Chunked Encoding when transferring files on HTTP,
add the following key to the <appSettings> section of the “Quark Publishing Platform
Client.exe.config” file. Supported values are 0 and 1.
<add key="UseChunkedEncoding" value="0"/>
The default value is 0.
Specify support for lazy loading when searching (Windows only)
To specify support for the lazy loading strategy for searching, add the following key
to the <appSettings> section of the “Quark Publishing Platform Client.exe.config”
file, with the desired strategy in the “value” attribute:
Setting the lazy loading chunk size (Windows only)
To change the chunk size of the lazy loading search results to be fetched, add the
following key to the <appSettings> section of the “Quark Publishing Platform
Client.exe.config” file, with the desired size in the “value” attribute:
<add key="LazyLoadingChunkSize" value="50"/>
The default value is 50.
Setting the service time out values for all remote service references (Windows only)
To change service timeout value for all remote service references, add the following
key to the <appSettings> section of the “Quark Publishing Platform Client.exe.config”
file, with the desired time (in seconds) in the “value” attribute:
<add key="ServiceTimeoutInSeconds" value="0"/>
The default value is 0. Use the default value specified in the Platform Server
configuration.
Setting the service timeout value for publishing service (Windows only)
To change service timeout value for the publishing service, add the following key to
the <appSettings> section of the “Quark Publishing Platform Client.exe.config” file,
with the desired time (in seconds) in the “value” attribute:
Uncomment the line and insert the appropriate proxy details.
2
Save and close the file.
3
Mirroring the collection hierarchy on Check Out/Get
By default, Quark Publishing Platform clients mirror the collection hierarchy on their
local drive when they check out or get an asset. However, you can change this option.
Turning off collection mirroring: Mac OS X
To turn off collection mirroring on Mac OS X:
For Quark Publishing Platform Client, open the file
1
~/Library/Preferences/Quark/QPP/[QPP Framework
Version]/com.quark.qpp.client.Quark Publishing Platform
Client.config.plist, locate the following text, and change <true/> to <false/>:
<key>MirrorCollectionHierarchy</key>
<true/>
For QuarkXPress, open the file ~/Library/Preferences/Quark/QPP/[QPP
Setting preferences for Quark XML Author for Platform
The following settings are also applicable for the Platform Adapter for Microsoft Office.
Setting the Check out location
To set the Check out location preference, use the CheckOutLocation key under the
<appSettings> section of the “Quark.CMS.Adapters.config” file. This sets the initial
preference on first launch of the application.
To change the Check out location Go to File > Preferences > General and browse to
the location you want to set as the Check out location.
This preference can be reset in this way:
•
Reset to Default : User can change the preferences by changing the CheckOutLocation
key under the appSettings section of the “Quark.CMS.Adapters.config” file and
using the Advanced > Reset to Default feature.
Setting the file deletion preference on Save and Close
To set the File Deletion preference, use the FileDeletionOption key under the
<appSettings> section of the “Quark.CMS.Adapters.config” file. This sets the initial
preference on first launch of the application.
To change the file deletion preference Go to File > Preferences > General and select
one of the following values:
Delete without Warning
1
Never Allow Deletion
2
Ask Before Deletion
3
This preference can be reset in the following way:
• Reset to Default : User can change the preferences by changing the
FileDeletionOption key under the appSettings section of the
“Quark.CMS.Adapters.config” file and and using the Advanced > Reset to Default
feature.
Setting the quick search preference
To set the Quick Search preference, use the QuickSearchOption key under the
<appSettings> section of the “Quark.CMS.Adapters.config” file. This sets the initial
preference on first launch of the application.
To change the quick search preference, go to File > Preferences > Search and select
one of the following values:
Name
1
Content
2
Name and Content
3
This preference can be reset in the following way:
78 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
Reset to Default: User can change the preferences by changing the QuickSearchOption
key under the appSettings section of the “Quark.CMS.Adapters.config” file and
using the Advanced > Reset to Default feature.
Setting the display revision comments preference on Save and Close
To set the Display Revision Comments preference, use the
RevisionCommentsDisplayOption key under the <appSettings> section of the
“Quark.CMS.Adapters.config” file. This sets the initial preference on first launch of
the application.
To change the file deletion preference Go to File > Preferences > Search and select
one of the following values:
Always
1
Never
2
New Assignments Only
3
This preference can be reset in the following way:
• Reset to Default: User can change the preferences by changing the
RevisionCommentsDisplayOption key under the appSettings section of the
“Quark.CMS.Adapters.config” file and and using the Advanced > Reset to Default
feature.
Configuring the Platform Adapters for Microsoft Office components for web sharing
The web sharing configuration is only recommended for standalone server installations
and not for external web container deployments or EAR based deployments. If web
sharing configuration is required under those scenarios you will need to work with
Quark Technical Support.
This chapter gives instruction on installing the following Microsoft Office components:
• Quark Publishing Platform Adapter for Microsoft Office - Word
• Quark Publishing Platform Adapter for Microsoft Office - Excel
• Quark Publishing Platform Adapter for Microsoft Office - PowerPoint
The deployment location will be in the "Quark Publishing Platform Server" webapps
folder on the Platform server machine.
The following steps need to be completed before installing any of the components:
Copy and extract the archive "Platform<version and build>_Adapter_for_Office.zip".
1
From the extracted archive, copy/overwrite all files from the folder "webapps\ROOT"
2
to the "Quark Publishing Platform Server\webapps\ROOT" folder.
Copy the contents of the folder "webapps\clientinstallers" to the "Quark Publishing
3
Platform Server\webapps\clientinstallers" folder.
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 79
Copy the "Quark.CMSAdapters.Office.Word.vsto" file from the package folder to
2
\Application Files\App_%HighestVersion%\.
Manual configuration for QuarkXPress and QuarkCopyDesk XTensions
The QuarkXPress and QuarkCopyDesk XTensions have xml based preferences stored
in the QPPXPressXT.xml and QPPXPressXT.xml files in the application preference
folder.
In Windows, the QuarkXPress preference folder is located:
C:\Users\<username>\AppData\Local\Quark\QuarkXPress 10 and the
QuarkCopyDesk preference folder is located: C:\Users\<user
name>\AppData\Local\Quark\QuarkCopyDesk 10
In Mac OS X, the QuarkXPress preference folder is located:
/Volume/users/username/Library/Preferences/Quark/QuarkXPress 10. The
Most of the preferences are set using the user interface, but setting the location of the
Platform menu items is done manually.
To set the location of the Platform menu items:
•
Set the location attribute in the PlatformMenuItemsLocation node, under the
<Basic> section of the “QPPXPressXT.xml” and "QPPXPressXT.xml" files. Set to one
of the following values:
0 File Menu (Default Value)
1
1 Platform Menu
2
2 to show in both file and Platform Menu
3
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 83
MANAGING BACKUPS AND FILE STORAGE
Managing backups and file storage
You choose the backup software and determine the backup intervals for your Quark
Publishing Platform database, your Quark Publishing Platform assets, and essential
files, such as your Quark® Job Jackets® files and script files. Quark recommends
synchronizing backups for your database, assets, and essential files to avoid
inconsistency if you have to restore a backup. Quark also recommends periodic testing
to verify that your backups can be restored successfully, if necessary.
If you move your asset repository, follow the instructions in "Moving Quark Publishing
Platform asset repository."
Backing up Quark Publishing Platform Server
Quark recommends stopping Quark Publishing Platform Server before performing a
backup, but stopping Quark Publishing Platform Server is not required. Back up your
database, your assets, and essential files (such as your FTS index files) on a separate
storage device. Although you can back up your entire "Quark Publishing Platform
Server" folder, the most important folders include the following:
• "conf" folder (contains system configuration files, including files edited manually after
installation)
• "index" folder (contains the Full Text Search index files)
Backing up your database
The database contains all metadata for Quark Publishing Platform assets.
If you use a Microsoft® SQL database or an Oracle database, use the backup tools and
instructions provided with MS-SQL or Oracle.
Backing up assets
You specify the software and intervals for backing up your Quark Publishing Platform
asset repository.
Asset names are encrypted in the Quark Publishing Platform asset repository.
Backing up Index files (full text search)
Quark Publishing Platform Server indexes all files checked into the database so you
can perform a search within the text content of Quark Publishing Platform assets.
84 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE
Quark Publishing Platform Server stores index information for full-text search operations
in the "index" folder. The "index" folder is at the root level of your Quark Publishing
Platform Server folder and is the default location for the files required for full-text
indexes. See "Full text indexing configuration" to learn how to change the full-text index
storage location by editing "LuceneTextIndexingConfig.properties." If you change the
location, back up the new location.
Restoring Quark Publishing Platform Server
If you do not have to restore your Quark Publishing Platform asset repositories, the
storage paths to the asset repositories will still be valid after you restore your Quark
Publishing Platform database. If you must restore your Quark Publishing Platform asset
repositories as well as your database, specify the updated storage location according
to the instructions in "Moving Quark Publishing Platform asset repository."
For example, if the hard drive fails on the computer running Quark Publishing Platform
Server, your latest backup should be stored in a separate location. Re-install Quark
Publishing Platform Server according to the instructions in the Quark Publishing Platform
ReadMe. After you re-install Quark Publishing Platform Server, make sure it is not
running before you restore your database, assets, and other files.
MANAGING BACKUPS AND FILE STORAGE
Restoring Assets
Try to use the same path you used for the old asset repository. For example, if you
replace the hard drive on the computer running Quark Publishing Platform Server,
you can copy the asset repository backup to the same location. Even if you need a new
computer, try to have the same path (for example, C:\QPP_Assets).
If you can search for Quark Publishing Platform assets and you need to see the
encrypted file names, view the "File Path" attribute when your search is complete. The
master file and all asset revisions are stored in the same storage location. The encrypted
asset names follow the same pattern (for example, 34.1.1.1.JPG). The first number
in the encrypted name denotes the asset ID. The second number identifies the
version number, the third number identifies the rendition type for previews, and the
fourth number identifies the first page of the preview.
If you have to restore hardware, launch Quark Publishing Platform Client and
re-establish the link with one or more repositories defined in the Repository tab of
the Administration: Storage screen. Do not delete the storage repository and try to
create another one.
Restoring Quark Publishing Platform Server database
If you use a Microsoft SQL database or an Oracle database, use the restore tools and
instructions provided with MS-SQL or Oracle. When you re-install Quark Publishing
Platform Server, you can enter the correct MS-SQL or Oracle information during the
installation process.
Restoring Full Text Indexes
Restore the "index" folder in the location specified in the
"LuceneTextIndexingConfig.properties" file.
QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE | 85
MANAGING BACKUPS AND FILE STORAGE
Moving Quark Publishing Platform asset repository
If you move your Quark Publishing Platform asset repository, you can update the asset
repository path with Quark Publishing Platform Client. See "Configuring storage
options" in A Guide to Quark Publishing Platform for more information about specifying
asset storage.
To update the asset repository path:
In a Web browser, navigate to http://[server]:[port]/admin and log on with
1
administration privileges.
Display the Administration screen and click Storage. The Administration: Storage
2
screen displays.
Display the Repository tab, which includes one or more entries in the Repository
3
Name column.
Select a repository, and choose Edit > Edit Repository. A warning message displays.
4
This warning displays when you edit an asset repository
Click Yes. The Edit Repository dialog box displays.
5
The Edit Repository dialog box
Enter a new location in the Location field.
6
Repeat steps 4–6 for every repository listed in the Repository tab.
7
86 | QUARK PUBLISHING PLATFORM 2015 SYSTEM ADMINISTRATION GUIDE