1. Copyrights About this guide About SwitchProxy... 5

(1)

(2)

1. Copyrights

Certified PDF is a registered trademark of Enfocus BVBA.

Enfocus PitStop Pro, Enfocus PitStop Workgroup Manager, Enfocus PitStop Server, Enfocus Connect YOU, Enfocus Connect ALL, Enfocus Connect SEND, Enfocus StatusCheck, Enfocus CertifiedPDF.net, Enfocus PDF Workflow Suite, Enfocus Switch, Enfocus SwitchClient, Enfocus SwitchScripter and Enfocus Browser are product names of Enfocus BVBA.

Adobe, Acrobat, Distiller, InDesign, Illustrator, Photoshop, FrameMaker, PDFWriter, PageMaker, Adobe PDF Library™_{, the Adobe logo, the Acrobat logo and PostScript are}

trademarks of Adobe Systems Incorporated.

Datalogics, the Datalogics logo, PDF2IMG™_{and DLE}™_{are trademarks of Datalogics, Inc.}

Apple, Mac, Mac OS, Macintosh, iPad and ColorSync are trademarks of Apple Computer, Inc. registered in the U.S. and other countries.

Windows, Windows 2000, Windows 7, Windows 8, Windows 8.1, Windows 10, Windows 2008 Server, Windows 2008 Server R2, Windows Server 2012 and Windows Server 2012 R2 are registered trademarks of Microsoft Corporation.

PANTONE®_{Colors displayed here may not match PANTONE-identified standards. Consult}

current PANTONE Color Publications for accurate color. PANTONE® and other Pantone, Inc.

trademarks are the property of Pantone, Inc. ©_{Pantone, Inc., 2006.}

OPI is a trademark of Aldus Corporation.

Monotype is a trademark of Monotype Imaging Inc. registered in the U.S. Patent and Trademark Office and may be registered in certain jurisdictions. Monotype Baseline is a trademark of Monotype Imaging Inc.

Quark, QuarkXPress, QuarkXTensions, XTensions and the XTensions logo among others, are trademarks of Quark, Inc. and all applicable affiliated companies, Reg. U.S. Pat. & Tm. Off. and in many other countries.

This product and use of this product is under license from Markzware under U.S.Patent No. 5,963,641.

Other brand and product names may be trademarks or registered trademarks of their respective holders. All specifications, terms and descriptions of products and services are subject to change without notice or recourse.

(4)

2. About this guide

This guide is intended to help system administrators and users of SwitchProxy with the installation of SwitchProxy.

(5)

3. About SwitchProxy

SwitchProxy works in combination with Switch.

Goal

The goal of the product is to:

• Act as an intermediate between SwitchClient, Switch Web Services and Enfocus Connectors on the client side and Switch Server on the server side. Further in this document, we will use the term "client" to refer to SwitchClient, Enfocus Connect or any other application using the Switch Web Services.

• Improve the overall communication between Switch Server and its clients and lower the resource usage of communication on Switch by letting SwitchProxy cache data and handle requests autonomously where possible.

• Ensure that the clients can keep uploading their jobs to SwitchProxy in case Switch Server is too busy or temporarily down.

How it works

When using SwitchProxy, connections coming from the clients to Switch Server will be routed through SwitchProxy.

SwitchProxy caches part of the data that is sent between Switch and its clients to improve the Switch communication.

When a new request comes in, SwitchProxy decides to

• Either handle the request by itself with the help of the cache, or

• Send the request to the Server and then send the answer back to the client.

When SwitchProxy accepts a job from a client, it stores the job locally and later sends it to the Switch Server. This means that when a client submits a job, the time taken by it to submit the job will not be affected, even if the Switch Server is down or too busy to accept new jobs. Client users will still be able to submit jobs when the Server cannot be reached, but they will not be able to perform other tasks like checking the status or approving jobs.

SwitchProxy must be installed on a computer on the same local area network where Switch Server is running, that is, behind the firewall. To have the best result, install SwitchProxy on a different physical machine from the one running Switch Server.

(6)

4. Getting started

SwitchProxy is designed to improve the stability and speed of the communication between Switch Server on the server side and SwitchClient, Switch Web Services or Enfocus Connectors on the client side. To get the best results, SwitchProxy must be installed on a different physical machine from the one running Switch Server.

4.1 System requirements

The system requirements are listed on the Switch product page on the Enfocus web site. To check the system requirements

Go to http://www.enfocus.com/en/products/switch#requirements.

4.2 SwitchProxy installation scenarios

There are three options.

You can install SwitchProxy:

1. On a separate computer. (Recommended)

(7)

3. Along with Switch Server.

The installation procedure is the same for all three scenarios.

4.3 Setting up SwitchProxy

The setup of SwitchProxy remains the same irrespective of the installation scenario.

Note: In the following, it is assumed that the Switch Server is already running, and is able to accept client connections.

Setting up SwitchProxy consists of the following steps:

1. Install SwitchProxy, i.e. run the installer on the computer where SwitchProxy will be installed.

2. Activate SwitchProxy using a command prompt or Terminal. 3. Start SwitchProxy.

4. Configure the application(s) you want to connect to with SwitchProxy, for example SwitchClient, Enfocus Connect or Switch Web Services.

(8)

5. Verify the setup, i.e. the connection between SwitchProxy, the application(s) you want to use (SwitchClient, an Enfocus Connector Project, or Switch Web Services) and Switch Server.

4.3.1 Installing SwitchProxy

The installation of SwitchProxy remains the same irrespective of the installation scenario. The SwitchProxy Installer should run on the machine where SwitchProxy will be installed.

To install SwitchProxy from the DVD:

1. Insert the Enfocus DVD into your DVD drive. 2. On Windows OS:

a. The DVD wizard appears and shows you the contents of the DVD.

b. Double-click Enfocus_SPR_<version number>.exe to start the installation. c. Click the Next button and follow the installation instructions on your screen.

Once the installation is complete, the InstallShield Wizard Complete screen appears. d. Click Finish to complete the installation.

3. On Mac OS X:

a. Open the DVD and double-click the Enfocus_SPR_<version number>.dmg. b. Click the Continue button and follow the installation instructions on your screen.

Once the installation is complete, the Installation Succeeded screen appears. c. Click Close to close this screen.

4.3.2 Activating SwitchProxy

Prerequisite: You need:

• An Enfocus ID. If you don't have one yet, you can create one through the My Account section of the Enfocus web site https://my.enfocus.com/en/user/register.

• A valid license key for SwitchProxy.

You must activate SwitchProxy using a command prompt on Windows, or the Terminal on Mac OS X. The activation command is the same for Windows and Mac OS X.

To activate SwitchProxy

1. Go to the ActivationTool directory using a command prompt (Windows) or the Terminal (Mac OS X):

• On Windows:

1. Click Start > Run . 2. Type cmd.

3. Go to the ActivationTool directory using the command prompt, for example type C:\> cd C:\Program Files\Enfocus\Enfocus SwitchProxy 13\ActivationTool

• On Mac OS X:

(9)

2. Go to the ApplicationTool directory using Terminal, for example type _{cd /}

Applications/Enfocus/Enfocus\ SwitchProxy 13/ActivationTool

2. Type the following activation command:

• On Windows: type _{enfocus_activationtool.exe -act -pk <SwitchProxy}

license key> -a <Enfocus ID> <Enfocus ID password>

• On Mac OS X: type _{./enfocus_activationtool -act -pk <SwitchProxy}

license key> -a <Enfocus ID> <Enfocus ID password>

A message appears, saying the activation succeeded.

4.3.3 Starting SwitchProxy

You must start SwitchProxy using a command prompt on Windows, or the Terminal on Mac OS X. The command is the same for Windows and Mac OS X.

1. Go to the SwitchProxy installation directory using a command prompt (Windows) or the Terminal (Mac OS X):

• On Windows:

1. Click Start > Run . 2. Type _cmd.

3. Go to the SwitchProxy installation directory, for example type C:\> cd C: \Program Files\Enfocus\Enfocus SwitchProxy 13

• On Mac OS X:

1. Go to HD > Applications > Utilities > Terminal .

2. Go to the SwitchProxy installation directory, for example type _{cd /Applications/}

Enfocus/Enfocus SwitchProxy 13\SwitchProxy

2. Type the following command:

• On Windows: type _{SwitchProxy.exe -i <IP of the computer where Switch}

Server is running> -p <Switch Server port> -P <SwitchProxy server port>

• On Mac OS X: type ./SwitchProxy -i <IP of the computer where Switch Server is running> -p <Switch Server port> -P <SwitchProxy Server port>

Note: This topic describes the basic parameters for running the application. However, you can specify a number of additional parameters, for example to run SwitchProxy as a Service or daemon, to configure error e-mails, to check the Switch

(10)

Proxy log file, to connect to older versions of SwitchClient and Connect, ... For more information, refer to SwitchProxy parameters - Overview on page 13.

4.3.4 Configuring the application to use with SwitchProxy

To be able to use SwitchProxy with a particular application (SwitchClient, Switch Web Services, Enfocus Connect), you must configure this application to connect to the IP address and port used by SwitchProxy.

Below, the procedure for use with SwitchClient and Enfocus Connect is explained. The

procedure for use with Switch Web Services depends on the way you have designed your custom client interface.

4.3.4.1 Configuring SwitchClient

In order to use SwitchProxy with SwitchClient, it is necessary to configure SwitchClient to connect to the IP and port used by SwitchProxy. The following configuration should be done on the SwitchClient machine.

Note: Switch Server must be running! Otherwise SwitchClient will not be able to connect to SwitchProxy.

To configure SwitchClient 1. Launch SwitchClient.

2. On the menu bar, click Edit > Connections . The Connections window appears.

3. To create a new connection, click the + button (below the list of Switch Servers). 4. Enter the required details:

• Server Address: IP of the computer where SwitchProxy is running. • Port: The port where SwitchProxy is running.

• User name: An existing Switch user. By default, an Administrator user is set up, without a password. You can however set up your own users in Switch. For more information, refer to the Switch Reference Guide on the Enfocus web site.

• Password: The password of the Switch user (if you don't use the default Administrator user).

5. Click Ok.

(11)

6. Once the connection is obtained, click OK.

4.3.4.2 Configuring Enfocus Connect

In order to use SwitchProxy with an Enfocus Connector, you must enter the IP address and the port used by SwitchProxy in the Connector project definition. The following configuration should be done for each Connect Project with delivery to Enfocus Switch.

Note: Before you start, create a flow with a Submit point (in Switch) to which you want to deliver the jobs handled by the Connector Project concerned. Make sure Switch Server is running, otherwise Enfocus Connect will not be able to connect to SwitchProxy.

To configure Enfocus Connect

1. Open Enfocus Connect YOU, SEND or ALL as required.

2. Select the Connector project you want to use with SwitchProxy. 3. In the right part of the application, click the Delivery tab.

4. If the Delivery method list is deactivated (i.e. grayed out), select the Enable remote delivery checkbox.

In Enfocus Connect SEND, the Delivery method list is always active. 5. Enter the following details:

• Server: IP address of the computer where SwitchProxy is running • Port: Port used by SwitchProxy

• Login type: Select one of the following options:

• Ask user and password: The Connector will ask for a user name and a password to log in. You do not need to enter the User and Password fields.

• Ask password only: The Connector will use the user name defined in the User field, and ask the user for the password. You need to enter the User name field.

• Use specified credentials above: The Connector will use the credentials defined in the User and Password field. You need to enter the User and Password field. • Submit point: Select the appropriate Submit point from the list. If the desired Submit

point is not listed, click Refresh to refresh the list.

Files handled by the Connector will now be delivered to Switch using SwitchProxy. We

recommend verifying the setup as explained in Verifying the SwitchProxy setup (Enfocus Connect) on page 12.

(12)

If SwitchProxy is set up correctly, you should be able to submit jobs in SwitchClient and pass them to Switch Server via SwitchProxy.

To verify the SwitchProxy setup, i.e. the connection to SwitchClient and Switch Server 1. Launch Switch.

2. Create a flow with a Submit point. 3. Click Activate Flow.

4. Go to the SwitchClient machine and submit a job.

5. The job submitted in SwitchClient appears in the Switch flow. 6. To close SwitchProxy, press Ctrl+C.

4.3.6 Verifying the SwitchProxy setup (Enfocus Connect)

Use this procedure, if you have configured an Enfocus Connector Project which should deliver the output files to Switch via SwitchProxy.

To verify the SwitchProxy setup, i.e. the connection to the Connector Project and Switch Server 1. Launch Switch.

2. Select the flow with the Submit point selected in the Delivery tab of the Connector project you want to use.

See Configuring Enfocus Connect on page 11. 3. Click Activate Flow.

4. Go to the Connector and submit a job.

5. The job submitted to the Connector appears in the Switch flow. 6. To close SwitchProxy, press Ctrl+C.

(13)

5. Running SwitchProxy

SwitchProxy is a command-line application and therefore it offers no user interface. For an overview of the main parameters, refer to SwitchProxy parameters.

You can run SwitchProxy either in command-line mode or as a Service (on Windows) or daemon (on Mac). The difference between the two run modes and the procedures is explained further.

5.1 SwitchProxy parameters - Overview

When starting the application without parameters, or with the _--help parameter, a help message is printed, showing the possible parameters. To run correctly, a minimum of three parameters must be given.

Parameter Comments

--switch-ip or -i <IP or hostname> IP address or host name of the computer running Switch Server

--switch-port or -p <port> Port used by Switch Server for client

connections (as set in Switch Preferences > Internal communication > Port for SwitchClient )

--proxy-port or -P <port> Port on the local computer where SwitchProxy should listen for client connections. This port should be used in the client. If SwitchProxy is running on a different computer than the Switch Server, this could be the same port as the one Switch Server uses.

--AllowOlderClients Allows to use the old SSL certificates for compatibility with clients released before Switch 12 update 1.

As of Switch 12 update 1, Switch Server uses new, secure SSL certificates for the HTTPS communication with Switch Clients, Enfocus Connectors and Switch Designer. This was necessary to protect Switch against the Heartbleed Bug (a leak in OpenSSL).

We recommend upgrading to SwitchClient 12 update 1 or Enfocus Connect 12 or later. You must recreate the old Connectors to make sure

(14)

Parameter Comments

Note: Keep in mind that, when using this parameter, all connections (to old and new clients) use the old certificates.

--smtp-server <server>

--smtp-port <port>

--mailto <address>

--mailfrom <address>

IP or hostname of the SMTP server Switch Server port

E-mail of the administrator who should receive an error mail in case of problems

From address in the error mail

Note: Use these 4 parameters if you want to configure error mails that are sent automatically to an administrator, each time the Switch Server is down. You must configure all 4 parameters, otherwise no mails will be sent. For more information, refer to Configuring error e-mails on page 17.

Options Comments

-install Installs, starts and exits SwitchProxy as a Windows Service or daemon (on Mac OS X). Refer to:

• SwitchProxy run modes on page 15

• Running SwitchProxy as a Windows Service on page 16

• Running SwitchProxy as a daemon (on Mac OS X) on page 16

-uninstall Stops and removes SwitchProxy as a Windows Service or a daemon (on Mac OS X). Refer to: • Removing SwitchProxy on Windows on page

19

• Removing SwitchProxy on Mac OS X on page 19

--help Allows you to print all parameters and options available for SwitchProxy.

--readme _{Opens the SwitchProxy Read Me file (PDF)}

in your default PDF viewer. The Read Me file provides contact information and other useful information, for example about the product key

(15)

Options Comments

and activation, the system requirements and the version history.

If you use this option, all other parameters are ignored.

--license Opens the Enfocus End User License Agreement (EULA) (PDF) in your default PDF viewer.

If you use this option, all other arguments are ignored.

--webhelp Opens the Enfocus Switch Proxy installation guide (HTML) in your default browser application. Note that the HTML version also includes a PDF version (Click the button in the top right corner).

--version Displays the current version number, for example SwitchProxy 13 update 1 Build 1234355.

--verbose Displays additional information in case of errors and warnings. Refer to Checking the SwitchProxy log file on page 18.

If SwitchProxy has expired or for any reason cannot start (for example, the SSL files cannot be found), an error is printed and SwitchProxy ends with a non-zero return code.

5.2 SwitchProxy run modes

SwitchProxy can run in two modes: command-line mode or Service/daemon mode.

Command-line mode

In command-line mode, SwitchProxy runs inside a Command (Windows) or Terminal (Mac OS X) window.

If the Command/Terminal window is closed, SwitchProxy is terminated.

In command-line mode, SwitchProxy runs under the user account that was used to start the command (usually the user who logged in).

(16)

In this mode, SwitchProxy continues to run until either the system is shut down or the user manually chooses to shut down the Service/daemon. At system boot, SwitchProxy is automatically started. This is also the case if SwitchProxy crashes; the system will restart it automatically.

When running as a Service/daemon, SwitchProxy uses the Local System account on Windows and the root account on Mac.

5.2.1 Running SwitchProxy as a Windows Service

If you run SwitchProxy as a Windows Service, it runs as a background process monitored by Windows.

To run SwitchProxy as a Windows Service 1. Open a command prompt:

• On Windows Server Edition (Windows 7, Windows, Windows 8.1, Windows 2008 Server (R2), Windows Server 2012 (R2), Windows Vista):

1. Click Start > All Programs > Accessories .

2. Right-click Command Prompt and select Run as administrator. • On older Windows systems:

2. Go to the SwitchProxy installation directory, for example type C:\> cd C:\Program Files\Enfocus\Enfocus SwitchProxy 13.

3. Type SwitchProxy.exe -i <IP of the Computer where Switch Server is running> p <Switch Server port> P <SwitchProxy Server port> -install

This command should exit (might take a few seconds) without any output. The first time you run it, you might get the following error: The service did not respond to the start or control request in a timely fashion. Repeat the same command again to get the correct result.

4. Verify that the Service has been installed correctly: a. Go to Start > Run .

b. Type _services.msc

c. Search for Enfocus SwitchProxy.

d. Check the Status and the Startup Type of Enfocus SwitchProxy.

The status should be Started and the startup type should be Automatic.

5.2.2 Running SwitchProxy as a daemon (on Mac OS X)

If you run SwitchProxy as a daemon, it runs as a background process monitored by Mac OS X. Note: You need administrator access to be able to start SwitchProxy as a daemon. To run SwitchProxy as a daemon

(17)

1. Go to HD > Applications > Utilities > Terminal .

2. Go to the SwitchProxy installation directory, for example type: cd /Applications/ Enfocus/Enfocus SwitchProxy 13\SwitchProxy

3. Type su and press Enter.

4. Type the administrator password and press Enter.

5. Type the following command: ./SwitchProxy -i <IP of the computer where Switch Server is running> -p <Switch Server port> -P <SwitchProxy server port> -install

SwitchProxy will start as a daemon. Use the Mac Activity Monitor to check if the daemon is running.

5.3 Handling errors

SwitchProxy provides feedback about problems in different ways.

Startup errors

Errors such as too few or incorrect parameters or a faulty installation prevent SwitchProxy from starting correctly. In these cases, an error message is printed to the command window and SwitchProxy returns an error code.

Error e-mails

When an error occurs during normal operation (for example, the Switch Server is down), you can configure SwitchProxy to send an e-mail to the administrator.

Log file

When SwitchProxy is running in command-line mode, some feedback may be displayed in the Command/Terminal window.

When running as a Service/daemon, this feedback is instead sent to a log file.

5.3.1 Configuring error e-mails

In the majority of the installations, SwitchProxy is running on a server in the DMZ, without a human operator present all the time. Therefore, it is important that administrators are notified of any errors.

To configure error e-mails

1. Go to the SwitchProxy installation directory using a command prompt (Windows) or the Terminal (Mac OS X).

(18)

• On Mac OS X: type _{./SwitchProxy --smtp-server <IP or hostname of the}

SMTP server> --smtp-port <Switch Server port> --mailto <e-mail of the administrator who should receive the mail> --mailfrom <From address in the error e-mail>

When an error occurs, for example, the Switch Server is down, an e-mail will be sent to the specified e-mail address. Note that only one mail per minute is sent (to prevent spamming). This e-mail contains all the errors that may have occurred in that one minute interval.

5.3.2 Checking the SwitchProxy log file

When running SwitchProxy as a Service or daemon, errors are stored in a log file (SwitchProxy.log).

Note: The log file is limited to 10 MB. When its size exceeds this limit, older content is deleted to log new information.

1. Type the following command:

• On Windows, type SwitchProxy.exe --print-log

• On Mac OS X, type _{./SwitchProxy --print-log} If you add other arguments, they will be ignored. The log file contains warnings and errors.

2. To get additional information (in addition to errors and warnings), use the --verbose

(19)

6. Removing SwitchProxy

To remove or uninstall SwitchProxy, the following steps need to be performed.

6.1 Removing SwitchProxy on Windows

To remove SwitchProxy installed on a Windows machine

1. Go to the machine on which you have installed SwitchProxy. 2. Open a command prompt:

• On Windows Server Edition (Windows 7, Windows 8, Windows 8.1, Windows 2008 Server (R2), Windows Server 2012 (R2), Windows Vista):

1. Click Start > All Programs > Accessories .

2. Right-click Command Prompt and select Run as administrator. • On older Windows systems:

3. Go to the SwitchProxy installation directory using the command prompt, for example type _C:

\> cd C:\Program Files\Enfocus\Enfocus SwitchProxy 13

4. Type _{Switchproxy.exe -uninstall}

Any existing SwitchProxy Service is stopped and uninstalled. If no SwitchProxy Service was installed, this will have no effect.

5. Click Start > Control Panel > Add and Remove Programs . 6. Select Enfocus SwitchProxy.

7. Select Remove option and click Next. The Confirm Uninstall window appears. 8. Click OK.

The uninstallation progress bar appears.

9. The Uninstall Complete window appears, once the uninstall is complete. 10.Click Finish.

(20)

1. Go to the machine on which you have installed SwitchProxy. 2. Go to HD > Applications > Utilities > Terminal .

3. Go to the SwitchProxy installation directory using Terminal, for example: _{cd /}

Applications/Enfocus/Enfocus SwitchProxy 13\SwitchProxy

4. In Terminal, type su and press Enter.

5. Type the administrator password and press Enter.

6. Type _{./SwitchProxy -uninstall} in Terminal on Mac OS X.

The files related to SwitchProxy must be removed manually, if any (see the next step). 7. Remove the SwitchProxy files from the following folders:

• User preferences folder • Hard Disk preferences folder

• Application folder (HD/Application/Enfocus/SwitchProxy) • Receipts folder (HD/Library/Receipts)