PersonalEffect 13.2 Installation Guide
PersonalEffect 13.2 Installation Guide
Installation Guide
Version 13.2
Notices
U.S. Patents 6948115, 7406194, 7548338, 7757169, 10180815, 10491947 B1, JP Patent 4406364B and pending patents.
PersonalEffect System Version 13.2 Installation Guide, Document Revision: 3.3, June 2024
XMPie provides this publication "as is" without warranty of any kind, either express or implied. This publication may contain technical
inaccuracies or typographical errors. While every precaution has been taken in the preparation of this document, the publisher and author
assume no responsibility for errors or omissions. Nor is any liability assumed for damages resulting from the use of the information contained
herein. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. XMPie
may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time.
XMPie, the XMPIE logo, PersonalEffect, uChart, uCreate, uDirect, uEdit, uImage, uPlan, uProduce, uStore, StoreFlow, TransMedia, Circle,
ADOR, XLIM, eMedia Cloud, RURL, XMPL, OpenXM and the slogan "one to one in one" are trademarks or registered trademarks of XMPie, A
Xerox Company, and may not be used without permission. No part of these materials may be used or reproduced in any form, or by any means,
without the express written consent of XMPie. To request permission to use these materials, please contact marketing@[Link].
XEROX® and XEROX FreeFlow®, FreeFlow Output Manager® and FreeFlow Process Manager® are trademarks of Xerox Corporation in the
United States and/or other countries.
Adobe Acrobat, Adobe Illustrator, Adobe InDesign, Adobe Photoshop and Adobe After Effects are trademarks of Adobe Systems
Incorporated.
SQL Server, Windows Server, Windows, Microsoft Office, Microsoft Excel and Microsoft Access are trademarks or registered trademarks of
Microsoft Corporation.
Other trademarks and service marks are the property of their respective owners.
Contents
Chapter 1: PersonalEffect Configurations.................................................................................. 1
uProduce Server ............................................................................................................................................................................. 1
System Configuration .......................................................................................................................................................... 1
XMPie Turn-Key Systems........................................................................................................................................... 1
XMPie Enterprise Platforms ..................................................................................................................................... 2
i
Upgrading uProduce .................................................................................................................................................................. 27
Repairing a uProduce Installation ......................................................................................................................................... 27
Uninstalling uProduce ............................................................................................................................................................... 28
Chapter 5: Using Helicon ISAPI_Rewrite for Friendly URLs and Setting up a Proxy
Server.................................................................................................................................................. 36
Introduction to ISAPI_Rewrite ............................................................................................................................................... 36
Setting Up Secure Access through a ProxyServer ........................................................................................................... 36
Firewall Setup ............................................................................................................................................................................... 37
Helicon ISAPI_Rewrite Installation ...................................................................................................................................... 38
ISAPI_Rewrite License Keys ............................................................................................................................................ 38
Installing ISAPI_Rewrite on a Proxy Server ............................................................................................................... 38
Setting up a Proxy Server on a uProduce server ...................................................................................................... 38
ISAPI_Rewrite Installation and Update ...................................................................................................................... 39
Installing the ISAPI_Rewrite on a Proxy Server ............................................................................................... 39
Registering ISAPI_Rewrite 3.x ............................................................................................................................... 40
Updating the Proxy Server with Friendly URL Settings ................................................................................ 40
ii
Chapter 7: Installing FTP Server on IIS WebServer to Support PersonalEffect ............ 50
Installing an FTP Server on an Existing IIS WebServer .................................................................................................. 50
Creating a New Local User Account on a Windows Server using the Windows Interface .............................. 51
Removing the Newly Created Users from the UsersGroup ................................................................................ 51
Adding an FTP Site ...................................................................................................................................................................... 51
Configuring FTP User Isolation .............................................................................................................................................. 52
Adding the XMPL Application (Virtual Folder) to theRoot FTP Site .............................................................. 52
Adding an Allow Authorization Rule for an <rurl-username> User ........................................................................ 53
Adding an Allow Authorization Rule for an <xmpl-username> User ..................................................................... 53
Fine Tuning for FTP Authorization Rules ............................................................................................................................ 53
Enabling FTP Passive Mode on IIS for ServersRunning on Top of Amazon EC2 .................................................. 54
iii
Chapter 1: PersonalEffect Configurations
uProduce Server
uProduce is the main component of PersonalEffect configurations. uProduce is a production server and
campaign dashboard application, driven by a browser- based interface.
The tasks users can perform using the uProduce Server(s) include:
• Defining the real database(s) and Assets that will be used to generate personalized Documents
• Managing the personalized Document’s production to various media formats
• Actual generation of target media file formats for rendering personalized Documents
uProduce is also responsible for Campaign management and enables users to manage Accounts, Campaigns
included in the Accounts, and users who are authorized to access those Campaigns and Accounts.
System Configuration
PersonalEffect is available in two types of configurations:
• XMPie Turn-Key Systems
• XMPie Enterprise Platforms
1
Chapter 1: PersonalEffect Configurations
2
Chapter 1: PersonalEffect Configurations
3
Chapter 2: Preparing the uProduce
Environment
This chapter explains how to install Microsoft Windows system and software components and how to install
the required Adobe software. In addition, additional server settings and prerequisites that are essential for
the functioning of the uProduce server will be explained.
Before installing the uProduce software, verify that:
• All computers on which you intend to install the uProduce software are NOT a Domain Controller.
• Avoid using the NTFS file compression on the uProduce Server (especially if the SQL Server is
installed on the same computer).
• All computers have an up-to-date Windows Server operating system.
• The uProduce Server includes Internet Information Services (IIS) and Message Queuing (MSMQ)
and .Net Framework, if the SQL Server is installed on the same computer as uProduce.
• The uProduce Extension Server and uImage Processing Unit include the MSMQ component.
• Ensure you have the following:
• Link to the download site provided by your XMPie Supportrepresentative
Installation Overview
Installing the XMPie Server environment includes several stages:
1. Checking server settings, installing service packs and hot fixes, disabling error reporting, disabling
Windows Defender and enabling remote desktop connection.
Start with Checking Server Settings.
4
Chapter 2: Preparing the uProduce Environment
3. Installing the required software on the uProduce Server or uProduce Directorand Extension
Servers, as well as any additional Extension Servers or add-ons.
For details, see Installing uProduce.
Performance Considerations
To improve the performance of the uProduce Server as well as the Extension Server or uImage Processing
Unit, install each component on a dedicated computer. No other software application should be installed on
these servers.
Installing and running antivirus software on these computers might affect theirperformance and may
require specific settings, in order to reduce performancedegradation to a minimum.
For more information, see Excluding folders from antivirus scanning on PersonalEffect servers.
Similarly, install XMPie desktop applications such as uPlan and uCreate on dedicated computers and not on
the same computer as the uProduce Server.
Note: Do not install uProduce on a computer whose name containsany characters other than dot ("."),
dash ("-"), or English letters and numbers.
5
Chapter 2: Preparing the uProduce Environment
8. Click OK.
6
Chapter 2: Preparing the uProduce Environment
4. In the Remote Desktop section, select the Allow connections only from computers running Remote
Desktop with Network Level Authentication(recommended) option.
5. Save your settings and close the System Properties dialog box.
Note: Internet Information Services (IIS) is required only on theuProduce Server, and not on the Extension
or UPU machines.
On Windows Server, you install the Internet Information Services (IIS), Microsoft Message Queuing
(MSMQ) and Storage Services in a single procedure.
7
Chapter 2: Preparing the uProduce Environment
6. In the Select server roles screen, in the Roles list, select File And StorageServices > Storage Services.
Note that this component may already be installed on the server.
8
Chapter 2: Preparing the uProduce Environment
8. If a dialog box asking to add the Web Server (IIS) Management Tools feature is displayed, click Add
Features.
Note: The Windows Server Update Services should not be installed. Make sure that this checkbox
is unchecked before clicking Next.
9. Click Next.
9
Chapter 2: Preparing the uProduce Environment
10. In the Select features screen, in the Features list, select the following options:
Once you select the HTTP Activation, you are required to confirm the installation of Windows
Process Activation Service:
10
Chapter 2: Preparing the uProduce Environment
• Directory Browsing
• HTTP Errors
• Static Content
Under Health and Diagnostics, select:
• HTTP Logging
• Custom Logging
• Logging Tools
Under Performance, select:
• Static Content Compression
Under Security, select:
• Request Filtering
• Basic Authentication
• Windows Authentication
Under Application Development, select:
• .Net Extensibility 3.5
If a dialog box asking to add features that are required for .NETExtensibility 3.5 is displayed,
click Add Features.
• .Net Extensibility 4.5/4.6
• ASP
If a dialog box asking to add features that are required for ASP is displayed, click Add Features.
• [Link] 3.5
If a dialog box asking to add features that are required for ASP .NET 3.5 is displayed, click Add
Features.
• [Link] 4.5/4.6
Under Management Tools, select all available options including the sub-options under IIS 6
Management Compatibility.
14. Click Next.
11
Chapter 2: Preparing the uProduce Environment
This section describes how to create a login in SQL Server by using SQL Server Management Studio. A login
is the identity of the person or process that is connecting to an instance of SQL Server.
Overview
Due to security principles, SQL Server authentication might not be permitted by certain organizations. In
such scenarios, Windows Authentication is mandatory.
In order to connect to SQL Server, prior to the installation of XMPie server products (uProduce, uStore), you
must create a login based on a Windows principle (such as a domain user account or a Windows local user
account).
12
Chapter 2: Preparing the uProduce Environment
Prerequisites
Before creating SQL Server logins, make sure you have prepared two Windows account users (either a
domain user account or a Windows local user account). Work with your network administrator to ensure
that these accounts are ready to use.
• XMPie-Installer-User - this account will be used by XMPie server applications for connecting to the
SQL Server database and for the installation process only.
• XMPie-Application-User (Service User) – this account will be used by XMPie server applications,
and all internal activities will be performed through this account.
Despite security concerns, you can alternatively use a single user both for the installation process and
XMPie application internal activities.
1. On the taskbar, click Start, point to All Programs, point to Microsoft SQL Server, and then click SQL
Server Management Studio.
The Connect to Server window is displayed.
2. Log in to the SQL Server Management Studio with the corresponding credentials.
3. In Object Explorer, expand the folder of the server instance in which you want to create the new
login.
4. Right-click the Security folder, point to New, and select Login….
5. In the Login – New dialog box, on the General page, enter the name of the Install-User in the Login
name box. Alternately, click Search… to open the Select User or Group dialog box.
If you click Search.
• Under Select this object type, click Object Types… to open the Object Types dialog box and
select any or all the following: Built-in security principals, Groups and Users. Built-in security
principals and Users are selected by default. When finished, click OK.
• Under From this location, click Locations… to open the Locations dialog box and select one of the
available server locations. When finished, click OK.
• Under Enter the object name to select (examples), enter the XMPIE- Installer-User that you
want to find.
• Click OK.
6. To create a login based on a Windows principal, select Windows authentication. This is the default
selection.
7. From the Default database list, select a default database for the login. Master is the default for this
option.
8. From the Default language list, select a default language for the login.
13
Chapter 2: Preparing the uProduce Environment
9. Go to the Server Roles page, select the dbcreator check box. The public server role is already
selected by default. If not, make sure to select it as well.
10. Click OK to close the Login – New dialog box.
11. Repeat steps 3-8 in order to create the XMPie-Application-User. Note that for this user, only the
public role is sufficient.
You may now proceed with XMPie Server application installation.
From this point on, the instructions in this guide assume that you have completedthe SQL Server installation.
Note: Repeat the installation on every Extension Server where Adobe InDesign server is installed.
Note: If uImage is used with Adobe CC-2022/2023 apps, it must be installed separately on a PC
workstation.
14
Chapter 2: Preparing the uProduce Environment
2. From the Help menu select Updates. The Creative Cloud application opens.
3. At the top right corner, click the More Options icon, and select Preferences.
4. Under the Auto Update section, ensure that the Enable auto-update checkbox is not selected.
Note: Remember to repeat the above procedure on every computer that serves as a uImage
Processing Unit.
Make sure that you set up Adobe update preferences for all uProduce active users.
15
Chapter 3: Installing uProduce
Installing uProduce
This chapter covers the following procedures:
• Installing the uProduce Server and Additional Servers
• Adding XMPie Licenses in the uProduce License Manager
• Installing uProduce Extensions and uImage Processing Unit
• Configuring uProduce Server for SSL in uCreate Print Connectivity
• Setting up the IIS Log Folder
• Upgrading uProduce
• Repairing a uProduce Installation
• Uninstalling uProduce
Note: XMPie PersonalEffect does not support installation on computer systems that utilize Federal
Information Processing Standards (FIPS). For more information on Federal Information Processing
standards and guidelines, refer to the National Institute of Standards and Technology (NIST).
1. To start the installation process, locate the uProduce Installation folder and double-click the XMPie
uProduce Server [Link] file.
Depending on your computer’s security settings, you might get the following message right after
clicking the installation file.
16
Chapter 3: Installing uProduce
4. Read the license agreement carefully. Select I accept the terms of the license agreement to accept
its terms and then click Next to continue. If you select I do not accept the terms of the license
agreement, you will not be able to continue the installation process.
The Customer Information screen is displayed:
5. Enter your information under: User Name, Company Name and the License Key for the uProduce
installation or the uImage Processing Unit installation, as provided by XMPie.
6. Click Next.
7. If Adobe Photoshop is installed on your server, the uProduce installer will automatically install the
uImage component on the same server. If you do not intend to install uImage on this server, make
sure to uninstall Adobe Photoshop prior to the uProduce installation.
If Adobe Photoshop is not installed on your server, the uImage screen is displayed asking you if you
want to run uImage installation.
17
Chapter 3: Installing uProduce
• If you want to install uImage on that server, make sure that you first install the English version of
the Adobe Photoshop software, then continue the installation of uProduce and select Yes in the
uImage screen. If Adobe Photoshop is not installed and you select Yes, the installation process
will be blocked.
• If you do not want to install uImage on that server, click No and proceed with the installation
process.
By default, the installation destination is set to the root of the largest disk (orpartition) available on
your system.
9. In the Choose Destination Location screen, do one of the following:
• To install uProduce File System on a remote location such as an external storage or file server:
− First, select the Install uProduce File System to separate location checkbox, and then click the
new Change button that appears.
− Browse to the remote location or type its path using the UNC syntax. For example, \\<server
name>\<remote_shared_folder>.
Make sure that the shared folder is created prior to the uProduce installation and that its sharing
permissions are set to allow full access for a uProduce user. The same user has to be defined during
the installation process in the Logon Information screen of the uProduce Installation Wizard.
Note: It is highly recommended that you install uProduce on a different partition from the
operating system partition.
18
Chapter 3: Installing uProduce
The Database Server Login screen enables you to connect to local or remote database servers.
Connect to a database by defining the database server connection as follow:
<computer_name>\<instance_name>.
Alternatively, click Browse to select a database server from your local network. The installer
searches your network for computers that have an SQL Server database installed.
The resulting list is displayed in the Browse - Database Server dialog.
Note: You must select the database from the list in the Browse - Database Server dialog rather than
typing it in the Database Server field.
If SQL Browse Service is disabled, in order to install uProduce you must add in the Database Server
field: 1433. Example: <computer_name>\<instance_name>, 1433
10. Select the database, to which you want to connect, and click OK. The name of the database server is
displayed in the Database Server.
11. Select whether to connect using the SQL Server Authentication (SQL Server Authentication using
Login ID and Password) or using Windows Authentication.
19
Chapter 3: Installing uProduce
Note: If you select Window Authentication when connecting to a remote database, you must be
familiar with the login information. You mustalso make sure you completed the procedure of
creating a login in SQLServer for Windows Authentication, described in Installing Microsoft SQL
Server.
12. If you selected SQL Server Authentication using Login ID and Password, enter the Login ID and the
Password to connect to the uProduce database. Click Next to continue.
The installer checks the connection to the database server and verifies the Login ID and Password
you provided to connect to the uProduce database.
13. If you selected Windows Authentication, the logged in Windows account will be used during the
installation process.
uProduce Server uses the Windows user account to run its internal services.
This user account is set up differently, depending on whether uProduce is installed as part of a
Workgroup or as part of a Domain.
• When the uProduce Server is part of a Workgroup, the installer will ask for the User name and
Password. In the Domain field, the name of the local computer will be automatically selected.
• When the uProduce Server is part of a Domain, the installer will ask for the User name,
Password and Domain name. In the Domain field, make sure you choose the domain name and
not the local computer.
Note: When the uProduce Server is part of a Domain, it is mandatory to add the Domain user, that
will be authorized to run uProduce services, to the local Administrators group prior to specifying
the user account for uProduce in the Logon Information screen.
20
Chapter 3: Installing uProduce
Select the user you want to use from the list and then click OK.
-OR-
Click New User to create a new local user. The Create Local User dialog box opens.
• Enter the user information in the User Name, Password and Confirm password fields:
The installer creates a new Windows user with the name and password youprovided, and adds it
to the local Administrators group.
16. Click Next when you finish setting up the uProduce user account. The Ready to Install the Program
screen is displayed.
17. Click Install to begin the uProduce installation. The uProduce Server Setup begins copying files onto
the host computer.
When the process is completed, the InstallShield Wizard Complete screen is displayed.
18. Select Yes, I want to restart my computer now and then click Finish to restart your server.
19. In order for the tasks to run without limits of any conditions, from your Control Panel, open the Task
Scheduler.
• Right-click each of the XMPie tasks (beginning with “XMP”), select Properties > Conditions tab.
• Ensure the condition Start the task only if the computer is on AC power is removed.
21
Chapter 3: Installing uProduce
• You can repair errors in the installation procedure, such as missing or corrupt files, using the
uProduce System Repair mechanism. See Repairing a uProduce Installation.
22
Chapter 3: Installing uProduce
4. Type in (or copy) the appropriate XMPie license key into the License Key field.
If your server does not have an active internet connection, open the internet browser on another
computer, that has an internet connection, and go to [Link] Type, or
paste in, the Machine ID in the top field and the License Key in the License Key field.
6. Click Get Activation Key. The new Activation Key is displayed in your browser.
7. Copy the Activation Key and paste it into the Activation Key field of the License Manager screen in
uProduce.
You should now have all the information required by the License Manager.
23
Chapter 3: Installing uProduce
To install the uProduce Extension Server and/or the uImage Processing Unit:
1. Log on to the server on which you want to install the uProduce Extension Server. When you log on,
make sure to use the same administrative username and password you defined during the
installation of the uProduce Director. See Installing the uProduce Server and Additional Servers.
2. To start the installation, locate the uProduce Installation folder and double- click the XMPie
uProduce Server [Link] file.
3. Follow the installation procedure as described in See Installing the uProduce Server and Additional
Servers.
When the Customer Information screen is displayed, enter the User Name, Company Name and
uProduce Extension Server or the uImage Processing Unit License Key, as provided by XMPie, in
the License Key field.
Note: The license for uImage Processing Unit is dedicated exclusively for uImage production jobs.
The installation process will continue similar to the uProduce installation process.
Note: The Adobe software (Photoshop and Illustrator) installed on the uImage Processing Unit is
very resource intensive. Although the uImage Processing Unit can run on desktop operating
systems, it requires a dedicated computer. Do not install any additional software on the uImage
Processing Unit computer.
24
Chapter 3: Installing uProduce
7. Select Turn on Windows Firewall for both private and public networks.
8. Click OK.
11. In the Actions panel, select New Rule. The New Inbound Rule Wizard opens.
• In the Protocol and Ports page, select TCP, Specific local ports: 80
• In the Name page, provide a name for the rule, and click Finish.
A new rule is created and appears in the Inbound Rules list.
25
Chapter 3: Installing uProduce
1. In the XMPie installation folder, create a new folder and name it IISLogs.
2. Open the Internet Information Services (IIS) Manager by going to the Control Panel, pointing to
Administrative Tools, and then clicking Internet Information Services (IIS) Manager.
3. Click Continue.
4. In the Internet Information Services (IIS) Manager Window, expand the Sites folder.
26
Chapter 3: Installing uProduce
6. In the Directory field, set the new Log File Directory path to the IIS Logs folder you have created in
step 1 above (for example, D:\XMPie\IISLogs).
7. Click Apply in the Actions pane on the left, and then close the Internet Information Services (IIS)
Manager window.
Upgrading uProduce
Before upgrading uProduce to a new version, make sure you do the following:
1. Back up the entire XMPie folder using Windows backup tool (or any other backup utility).
• Completely remove the currently installed Adobe products from the uProduce Server, uProduce
Extension Server and any additional uImage Processing Units (if exist).
• Install the latest Adobe products on the uProduce Server, uProduce Extension Server (see
Installing Adobe InDesign Server (AIS) and any additional uImage Processing Units (if exist).
27
Chapter 3: Installing uProduce
3. Select Repair and click Next. Follow the installation procedure as described in Installing the
uProduce Server and Additional Servers.
Note: If you need to modify the installation settings, such as user name or database server login, choose
Modify.
You cannot change the installation folder on which uProduce is installed.
Uninstalling uProduce
To uninstall uProduce software:
1. Begin by logging into the uProduce Extension Server, if one exists. Otherwise, begin with the
uProduce Director.
2. Go to Control Panel>Programs and Features and select XMPie uProduce Server Program.
3. Click Uninstall.
6. Repeat this procedure on all additional uProduce Extension Servers, and finally on the uProduce
Server.
7. Restart the server to ensure your changes are enacted.
28
Chapter 4: Installing Circle Agent
Note: The computer from which you are operating Circle must beconnected to the same LAN as the
uProduce system.
Installation Process
The Circle agent is a component of the uProduce system. It must be installed on each uProduce Director.
2. Click Next.
The Ready to Install the Program window is displayed.
3. Click Install.
When the installation has completed, the InstallShield Wizard Completed window is displayed.
29
Chapter 4: Installing Circle Agent
Note: You can also access the XMPie Circle Agent Settings window by clicking the Circle icon in the
system tray and selecting XMPie Circle Agent Settings from the Options menu.
30
Chapter 4: Installing Circle Agent
2. Optionally, select Use manual proxy and define the following proxy settings:
• Proxy Address: The address of the Proxy Server behind which uProduce is located. Each proxy
URL must be preceded by https://
• User Name: The user name used to connect to the proxy server. The username must be filled in
only if the proxy server requires authentication.
• Password: The password used to connect to the proxy server. The password must be filled in
only if the proxy server requires authentication.
31
Chapter 4: Installing Circle Agent
2. Type a Circle username and Circle password in the relevant fields. This user must have Builder
permissions to all accounts.
3. Click Next.
The Add Circle Accounts selection window is displayed, listing all Circle accounts of the specified
user.
4. Select the Circle accounts to be granted access to the uProduce server and click Finish.
The selected accounts are added to the Access Permission area in the XMPie Circle Agent Settings
window.
32
Chapter 4: Installing Circle Agent
The Test Settings window details the steps and progress of the test. If all the tests that are
successful, “Completed successfully” is displayed.
The Circle Connection between the uProduce system and Circle now exists.
2. Click Save Settings.
The Cloud Tracking window is displayed.
Cloud Tracking is used to collect events tracked by uProduce and to store them in the cloud. This
tracking information can later be used, e.g., when defining an event filter for Circle scheduling.
Note: The events stored in the cloud do not contain any Personally Identifiable Information (PPI)
that can be used to distinguish or trace an individual’s identity.
3. Type your uProduce administrator name and password in the relevant fields and then click Connect.
You are now connected to the uProduce system.
4. Click Save.
Cloud tracking is now activated.
33
Chapter 4: Installing Circle Agent
3. Specify your Circle username and password. The Circle user must haveBuilder permissions.
4. Click Next. The Agent Settings fields are populated with the existingconnection details.
5. If required, change the settings. Note that the changes affect all agentsusing the Circle connection.
34
Chapter 4: Installing Circle Agent
3. Type the uProduce administrator name and password and select the Cloud Tracking checkbox.
4. Click Save.
35
Chapter 5: Using Helicon ISAPI_Rewrite for
Friendly URLs and Setting up a ProxyServer
Introduction to ISAPI_Rewrite
ISAPI_Rewrite is a URL rewriter for Microsoft IIS. A URL rewriter translates a complex URL into a more
comfortable and shorter URL. Another usage of the rewriter is to implement a proxy server.
Personalized web sites usually use friendly URLs. The usage of friendly URLs hides the complex parameters
and logical structure of a URL that personalized web sites require.
uProduce provides personalized web sites through the ICP technology (for more information on ICP, please
refer to the uProduce User Guide), and uses ISAPI_Rewrite for friendly URLs.
uProduce also uses ISAPI_Rewrite in the context of proxy server implementation. A proxy server is used in
front of web servers to add a layer of security. All connections coming from the web to a personalized web
site that was created using uProduce, are routed through the proxy server. This feature provides added
security by preventing direct communication between the uProduce Server and remote computers that
reside beyond the firewall.
The following sections explain how to set up ISAPI_Rewrite for proxy server and friendly URLs solution.
36
Chapter 5: Using Helicon ISAPI_Rewrite for Friendly URLs and Setting up a Proxy Server
Firewall Setup
To allow communication into the proxy server from the web, several rules should be defined in the Firewall.
Work with your network administrator to ensure that TCP Ports 80 and 443 are accessible for
HTTP/HTTPS traffic coming:
• From the web to the proxy server
• From the proxy server to the uProduce server
In some organizations, the above settings are implemented using two Firewall devices: one between the
Web and the DMZ network - Front-End firewall, and another one between the DMZ network and the
internal LAN – Back-End firewall. In this case, the Firewall rules must be set on both Firewalls. On the Front-
End firewall, the Web client must be allowed to access into the proxy server using ports 80 and 443, and on
the Back-End Firewall, the proxy server is allowed to access the uProduce Server only via ports 80 and 443.
37
Chapter 5: Using Helicon ISAPI_Rewrite for Friendly URLs and Setting up a Proxy Server
uProduce server
• Install uProduce (Installing uProduce )
Proxy server
• Install ISAPI_Rewrite 3.0 full version via uProduce Admin Settings section (see ISAPI_Rewrite
Installation and Update).
• Create uProduce Rules by running the ISAPI_Rewrite VB script from uProduce Admin Settings
section (see Updating the Proxy Server with Friendly URL Settings).
• Update the Proxy Server (see Updating the Proxy Server with Friendly URL Settings).
38
Chapter 5: Using Helicon ISAPI_Rewrite for Friendly URLs and Setting up a Proxy Server
Note: The following procedure must be performed on the Proxy Server. You must be logged on to the Proxy
server as “administrator” to perform the following steps. In an XMPie Enterprise platform, the
ISAPI_Rewrite is installed and updated on each Proxy server.
4. Under RURL Proxy Utils click Download RURL Proxy Utility Installer for Windows Server 32 bit or
64 bit link in step 1 according to your Web Server Windows operating system.
A File Download-Security Warning window is displayed, warning you that an isapi_rwf.msi file is
about to run.
5. Click Open or Run (depends on your browser) to run the proxy installer package.
An Internet Explorer - Security Warning dialog box is displayed.
6. Click Run.
The Welcome to the ISAPI_Rewrite Full Installation Wizard screen is displayed.
8. Follow the on-screen instructions; click Finish to exit the ISAPI Rewrite Full Setup installer.
Note: Make sure to install the ISAPI_Rewrite utility in the default path defined in the installer
(usually, C:\Program Files\Helicon\ISAPI_Rewrite3\).
Note that the partition (C:\) can be changed, while the rest of the path should be the default of the
Helicon Installer.
39
Chapter 5: Using Helicon ISAPI_Rewrite for Friendly URLs and Setting up a Proxy Server
After you finish your ISAPI_Rewrite installation, you must register ISAPI_Rewrite 3.x.
2. Click Register.
The Enable ISAPI_Rewrite dialog box is displayed.
3. In the Registration Name field enter “XMPie” and in the Registration Key field enter the registration
key provided with the XMPie licenses.
Note: The registration name must be XMPie. Otherwise, the Register button will not become
active.
• Click Accept.
Note: The following procedure must be performed on the Proxy Server. You must be logged to your Proxy
Server computer as “administrator” to perform the following steps.
3. Click the Settings button. The uProduce Server Settings page is displayed:
40
Chapter 5: Using Helicon ISAPI_Rewrite for Friendly URLs and Setting up a Proxy Server
4. Under RURL Proxy Utils, click the RURL Proxy Utility Data Installer download link in step 5. A File
Download-Security Warning dialog box is displayed, warning you that an [Link] file is
about to run.
5. Click Open or Run (depends on the browser you are using) to run the script file.
41
Chatper 6: Testing and Troubleshooting
This chapter explains how to test uProduce, to ensure it is correctly installed on your system. This chapter
provides instructions for running the Server, logging in, creating a user, creating an Account, uploading a
sample Campaign package that is included as part of your installation software, and proofing the Documents
used for the Campaign.
uProduce Interface
The uProduce interface is a Web-based environment with a hierarchical structure. The Accounts are at the
highest level, followed by the Campaigns. Each Campaign in turn, contains its Design, Logic, and production
resources.
When you log in to uProduce, a list of Accounts appears on the first page. Regular users can click the
following buttons or links to access various tasks:
Accounts Displays all Accounts to which you have access, for the current customer.
Settings Enables you to define commercial printer settings, FTP site, and network
path for production.
For non-administrator users, the buttons listed above appear on every uProduce page. In addition, each
page displays buttons that enable you to carry out actions related to that page.
Administrators can use the following additional buttons to manage users and production units:
Users Displays all uProduce users and enables you to create new users or
modify existing users.
Balance Displays the current balance of production units.
Note: The Accounts and Campaign buttons are not available on the dashboard when logging in as
administrator.
42
Chatper 6: Testing and Troubleshooting
Logging in as Administrator
The uProduce installation procedure creates a default uProduce administrator user. You will need to log
into the uProduce software as administrator to begin creating other users and Accounts.
Note: If you are accessing the uProduce Dashboard locally from the uProduce Server and if
Internet Explorer Enhanced Security Configuration is enabled on your server, for the proper
functioning of the uProduce Dashboard you must add the following web pages to the Trusted Sites
zone in Internet Explorer: localhost, <machinename>, <Server IP Address>, about:blank.
43
Chatper 6: Testing and Troubleshooting
Item Description
Login Information
User Information
First Name First name of the new user.
Last Name Last name of the new user.
44
Chatper 6: Testing and Troubleshooting
1. Log in as the new user, using the user name and password you defined in the previous section.
The empty list of Accounts is displayed.
2. In the Accounts page, click New. The New Account page is displayed:
Item Description
Share with List of users who can be selected to share this Account.
Email Settings Email Settings such as the default Email Delivery Provider and Opt-out
placeholders (such as Physical Address and Unsubscribe URL).
4. Click Save.
The new Account is displayed in the list of Accounts.
45
Chatper 6: Testing and Troubleshooting
Uploading a Campaign
A Campaign package file offers you an easy method to upload or download all the components of a single
Campaign, using a single action. The Campaign package file has the extension: .cpkg, includes the
Campaign’s Plan file, and may include Data Sources, asset sources, fonts, and Documents associated with
the Campaign. Your uProduce installation CD contains a file called [Link] under the Verification
Campaign folder, which you can upload to uProduce and continue testing the system.
To upload a Campaign package file and create a new Campaign with prepared components:
1. From the Accounts List, click the new Account you created in the previous section.
The empty list of Campaigns is displayed.
Item Description
6. At the end of the process, make sure the various components in the package are placed in their
correct locations on the Campaign tree. The Campaign List page displays the newly created
Campaign.
46
Chatper 6: Testing and Troubleshooting
Proofing Documents
The uProduce proof feature enables users to check the final product and preview the outcome of
production Documents. You will use the proof feature to make sure uProduce is installed correctly and is
capable of preparing Documents for production.
The proof process opens a new browser window with a list of links to the Documents. For print Documents,
the link is to *.PDF or *.JPG files. For Web- based Documents, the links are to a series of *.HTML files.
1. In the Campaign page, go to the Documents pane, and double-click the InDesign Document.
The selected Document’s details are displayed.
2. Click Proof.
The Proof Document page is displayed, enabling you to create proof job:
Item Description
47
Chatper 6: Testing and Troubleshooting
Recipients
Copy from Port Connect to an Interactive Content Port (ICP)and use it as a
Data Source. For details on creating Ports in uProduce, see
Chapter 8: Working with Ports in uProduce User’s Guide.
Recipients Data Source Select the Data Source that includes the recipients’
information, from which you wantto generate a proof.
Table (No. Of recipient) Select the table that includes the recipients’information.
Plan Filter Select All Recipients filter or choose one ofthe filters you
created in uPlan.
Additional DataSources Select the Data Source you want to use foreach Data Source
schema defined in your Plan (if any).
Range Select the records range.
All Produce a proof using all the records.
From Enter a range of records for which you will create a proof. A
maximum of 50 records willbe processed.
Production and Deployment
Job Priority Proof jobs are submitted to the “Rush job” queue and take
precedence over Process jobs which do no have the Immediate
priority.
When submitting a Proof job, you can determine its priority in
the “Rush job” queue. Priority controls the order of the jobin
the waiting queue.
Choose between four priority options:
• Low — submit the job with a low [Link] job will be
submitted to the lowest level of the waiting queue.
• Normal — submit the job with a normal priority (the default
option for Process jobs). The job will be placed among other
normal jobs in the waiting queue.
• High — submit the job with a high [Link] job will be
placed at the top area of thewaiting queue.
• Immediate — The job will be processed immediately. If all
production instances are busy, one of the currently running
jobswill be paused in favor of processing the "Immediate"
job. If all instances are currently handling "Immediate" jobs,
the job will be placed at the top of the waiting queue until
one of the instances becomes available.
4. Click Submit.
A new page displays the status of the job:
48
Chatper 6: Testing and Troubleshooting
A sign next to the Recent Job field indicates that messages have been produced relating to the
job. Click this sign to view the messages.
5. If the process of preparing the proof files is successful, the sign is displayed next to the Recent
Job field. Click the sign to display the Job Results page with a link to the proof file.
6. Under Job Results, click the link to the file to view the final proof result:
7. You can repeat steps 2 through 6 for the HTML Document in the test Campaign components.
49
Chapter 7: Installing FTP Server on IIS Web
Server to Support PersonalEffect
This appendix describes how to install and configure an FTP Server on top of Microsoft Internet Information
Server (IIS), to support XMPie PersonalEffect.
The instructions in this appendix assume that you have completed the XMPie XMPL Server installations.
Installation and configuration of an FTP Server on top of Microsoft Internet Information Server (IIS)
involves the following procedures:
• Installing an FTP Server on an Existing IIS Web Server
• Creating a New Local User Account on a Windows Server using the Windows Interface
• Adding an FTP Site
• Configuring FTP User Isolation
• Adding an Allow Authorization Rule for an <rurl-username> User
• Adding an Allow Authorization Rule for an <xmpl-username> User
• Fine Tuning for FTP Authorization Rules
• Enabling FTP Passive Mode on IIS for Servers Running on Top of AmazonEC2
3. If the Before you begin page of Add Roles and Features Wizard is displayed, click Next.
4. On the Select installation type page, select Role-based or feature-based installation, and click Next.
5. On the Select destination server page, select Select a server from the server pool, select your server
from the Server Pool list, and then click Next.
6. On the Select server roles page, expand the Web Server (IIS) node, and then expand the FTP Server
node.
7. Select the FTP Server and FTP Service checkboxes, and then click Next.
50
Chapter 7: Installing FTP Server on IIS Web Server to Support PersonalEffect
2. In the console tree, expand Local Users and Groups, and click Users.
• Username: <rurl-username>
• Password: <anypassword>
5. Select or clear the checkboxes as follows:
6. Click Create.
8. Click Close.
2. On the Connections pane, expand the server node and click the Sites node.
3. On the Actions pane, click Add FTP Site to open the Add FTP Site wizard.
4. On the Site Information page, in the FTP site name box, type a unique friendly name for the FTP site:
XMPL-FTP
51
Chapter 7: Installing FTP Server on IIS Web Server to Support PersonalEffect
7. Under Binding, in the IP Address list, select or type an IP address if you do not want the IP address
to remain All Unassigned.
8. In the Port box, leave the default value.
10. Select – No SSL and click Next to open the Authentication and Authorization Information page.
11. Under Authentication, select the Basic authentication method only.
2. In the Connections pane, expand the server node, expand Sites and then click the XMPL-FTP site.
2. In the Connections pane, expand the server node, expand Sites and then click the XMPL-FTP site
you want to add an application.
3. In the Actions pane, click View Applications, and then click Add Application.
4. In the Add Application dialog box, enter the following information:
• Alias: <xmpl-username>
Important: You must define the Application alias name to be identical to the <xmpl-username>
you previously created.
• Physical Path: X:\XMPie\XMPieWebServer\XMPieWebSiteManagement\XMPieWebSite
s\{Subscription-ID}
Note that the X drive represents the drive where the XMPie XMPL server application was
installed.
5. Click Connect as, choose Specific user and click Set. Type in the username <xmpl-username> and
the corresponding password (twice) and click OK.
You can test the Connect as feature by clicking the Test Settings… button.
52
Chapter 7: Installing FTP Server on IIS Web Server to Support PersonalEffect
3. On the FTP Authorization Rules page, click Add allow rule in the Actions pane.
4. In the Add Allow Authorization Rule dialog box, select the following type of access:
• Under Permissions, select Read and Write to enable read and write access.
5. Click OK to close the Add Allow Authorization Rule dialog box.
3. On the FTP Authorization Rules page, click Add allow rule in the Actions pane.
4. In the Add Allow Authorization Rule dialog box, select the following type of access:
All sub-folders related to PE 1G under the root XMPL-FTP site must not allow access to the <xmpl-
username> user
4. Click the allow rule for <xmpl-username> and select Remove in the Actions pane.
Click Yes to confirm.
5. Repeat steps 3-4 for the remaining folders (TestingServer, UploadedFiles) under the XMPL-FTP
site.
53
Chapter 7: Installing FTP Server on IIS Web Server to Support PersonalEffect
4. Click the allow rule for <rurl-username> and select Remove in the Actions
5. pane.
Click Yes to confirm.
6. Click the allow rule for <xmpl-username> and select Edit… in the Actions pane.
7. Under Permissions, select Write to enable write access.
To configure the FTP service to only use a limited number of ports for passive mode FTP:
4. Enter the range of port numbers that you want the FTP service to use. For example, 41000-41099
allows the server to support 100 passive mode data connections simultaneously.
5. Enter the external IPv4 address (Public IP address) through which the data connections arrive.
7. From an administrative command prompt, restart the Microsoft FTP Service to make sure all the
changes took effect:
net stop ftpsvc
net start ftpsvc
Note that you must also create a firewall rule on AWS environment (Security Group) to allow inbound
connections on the TCP ports you configured in the previous procedure. Please work with your
system/network administrator in order to allow it.
54
Chapter 8: Installing eCompose Add-On on
uProduce
Overview
eCompose acts as a composition engine similar to XLIM. The main task of eCompose is to convert VIPP
packages (.vpc files) to PDF format.
eCompose can be added to any uProduce production server, i.e. uProduce Solo or uProduce Extension.
eCompose supports multi-instance mode. The number of instances depends on the uProduce license.
System Preparation
• eCompose integration works only if uProduce has a proper license key that permits this use. Prior
to the installation, ensure you have the XMPie key named eCompose Integration.
For a Solo system, you need one key; for a Cluster system (Director(s) plus Extensions), you need
keys as the number of Print Extensions.
In addition, you need the Xerox FreeFlow eCompose license(s), according to the number of Print
Extensions.
• Log in to the uProduce Dashboard as admin and activate the “eCompose Integration” key.
• Download the FreeFlow® VI eCompose 15.x zip file from the XMPie Download center.
Installation
1. Extract the VI eCompose zip file to the XMPie machine on which you wish to install it.
• If you do not have it, the system will work in trial mode for 60 days.
• Default Job Folder name - type XMPie
55
Chapter 8: Installing eCompose Add-On on uProduce
• Drives on which the program and customer files are to be located - select the drive where XMPie
folder exists.
• Available VIeC Server(s) on the network - select the default choices.
• Default media size (A4 or USLetter) - select the relevant choices for your country.
• When the installation has completed successfully, verify that there is a new folder named xvtp in
the chosen drive.
• In the bin subfolder, you will find a java script file named [Link]
Open the Command prompt as administrator and run the following command line:
[Link] “$:\xvtp\bin\[Link]”
Click Enter for the default options.
After running the above script you will find five new services named Freeflow VI ecompose.
Select the one named FreeFlow VI eCompose Service and change its Startup type to Automatic.
All other should have Startup Type Manual.
56
Chapter 8: Installing eCompose Add-On on uProduce
Post Installation
After activating the service and setting it to Automatic mode, you need to adjust the allowed number of
instances.
1. Open the [Link] file in $:\ProgramData\Xerox\VIPP\VIPO where $ is the drive where eCompose
was installed.
2. Change the value of the key vtpserver_number_instances to the number of XMPie MI-Enabler x2
(for example, set MI4 to 8).
57
Proxy servers impact the deployment of uProduce systems by facilitating secure, mediated web interactions, crucial for protection in network configurations involving DMZs . They simplify maintenance by enabling centralized management of incoming and outgoing traffic without exposing internal servers . This role reduces the risk of attacks, minimizes downtime from security breaches, and optimizes resource allocation by offloading processing that would otherwise burden core servers . Additionally, they support friendly URL transformations via ISAPI_Rewrite, aiding in the seamless presentation of personalized content, crucial for user experience and efficiency .
Proxy servers coupled with ISAPI_Rewrite provide security enhancements by anonymizing and securing web requests . They hide the back-end server's details and route web traffic through the DMZ, limiting direct exposure to external threats . Firewall configurations restrict traffic to specific ports, ensuring that only HTTP/HTTPS requests reach the proxy, which then securely communicates with the uProduce server, thus maintaining security integrity while delivering personalized web content .
Installing ISAPI_Rewrite directly on a uProduce server, while possible, is not recommended because it increases security risks by exposing the server to potential web-based attacks . Typically, a proxy server is employed to handle requests and provide a layer of security by keeping web server details hidden . When installed on a separate proxy server, ISAPI_Rewrite mediates web interactions securely, maintaining server anonymity and integrity .
ISAPI_Rewrite is used to create friendly URLs by translating complex URLs for ease and security . It also acts as a proxy layer to prevent direct communication with uProduce servers, adding security by anonymizing web server details . For its configuration, ISAPI_Rewrite is installed on a proxy server typically located in the DMZ, with specific firewall rules allowing TCP ports 80 and 443 for HTTP/HTTPS traffic . However, installing ISAPI_Rewrite directly on a uProduce server is not recommended due to potential exposure to web-based malicious attacks .
A proxy server with ISAPI_Rewrite is significant for URL management by providing friendly URLs, which simplifies complex URL structures and improves user accessibility . This setup masks internal URL parameters, thus offering a cleaner presentation to users while maintaining robust backend security . The proxy server redirects traffic securely within the network, reducing exposure to vulnerabilities and enhancing overall system protection through rigorous firewall rule enforcement .
If Adobe Photoshop is installed on the server before uProduce, the installer will automatically include the uImage component unless otherwise specified . If you do not plan to install uImage but have Adobe Photoshop, you must uninstall Photoshop beforehand . Otherwise, the uImage screen during installation will prompt for its setup which requires the English version of Adobe Photoshop . Attempting to continue without these prerequisites will halt the installation process .
The XMPie-Installer-User is primarily used during the SQL Server installation and is granted roles such as dbcreator alongside the public role to support setup activities . In contrast, the XMPie-Application-User, utilized for ongoing application tasks, requires only the public role for its operations, reflecting its focus on internal application activities rather than installation .
In a DMZ configuration, the Front-End firewall permits web client access to the proxy server via TCP ports 80 and 443 for HTTP/HTTPS traffic, facilitating external communication . The Back-End firewall, on the other hand, restricts the proxy server's communication with the uProduce server to the same ports, ensuring that only secure connections pass through to the internal network, thus protecting internal systems from direct exposure .
The Circle connection setup is crucial for linking the agent with uProduce through Circle for project management . The initial configuration occurs in the XMPie Circle Agent Settings window post-installation, involving several steps: configuring proxy settings, entering system details such as the uProduce System Name and Dashboard URL, and assigning access permissions to Circle accounts with the necessary builder permissions . Testing and saving these settings ensure that the connection is correctly established and functional .
The process involves several steps: first, ensure you have two Windows account users ready, often involving coordination with a network administrator . One account, XMPie-Installer-User, is for the installation process, and the other, XMPie-Application-User, handles the internal activities . In SQL Server Management Studio, log in and expand the server instance in Object Explorer, then right-click the Security folder and select New, then Login . In the Login dialog, specify the Install-User name and choose Windows authentication . Select a default database and language, and configure the Server Roles by selecting the dbcreator checkbox along with the public role . Repeat this process for the XMPie-Application-User but only assign the public role .