Xerox FreeFlow VI eCompose User Guide

Version 16.0.3.0 December 2020 702P08482

Xerox

FreeFlow

User Guide

VI eCompose

, FreeFlow Process Manager®, VIPP®, and GlossMark®are trademarks of Xerox

Corporation in the United States and/or other countries. Other company trademarks are acknowledged as follows:

Adobe PostScript

, the Adobe logo, Acrobat®, the Acrobat logo, Acrobat Reader®, Distiller®, Adobe PDF JobReady™, InDesign®,

, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. All instances of the name PostScript in the text are references to the PostScript language as defined by Adobe Systems Incorporated unless otherwise stated. The name PostScript also is used as a product trademark for Adobe Systems’ implementation of the PostScript language interpreter, and other Adobe products. Copyright 1987 - 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Includes

Adobe

Intel

PDF Libraries and Adobe Normalizer technology.

, Pentium®, Centrino®, and Xeon®are registered trademarks of Intel Corporation. Intel Core™Duo is a trademark

of Intel Corporation.

Intelligent Mail

Macintosh

is a registered trademark of the United States Postal Service.

, Mac®, and Mac OS®are registered trademarks of Apple, Inc., registered in the United States and other countries. Elements of Apple's Technical User Documentation used by permission from Apple, Inc.

Novell

and NetWare®are registered trademarks of Novell, Inc. in the United States and other countries. Oracle®is a

registered trademark of Oracle Corporation Redwood City, California.

PANTONE

™

trademark of Denso Wave Incorporated in Japan and/or other countries.

TIFF

is a registered trademark of Aldus Corporation.

The Graphics Interchange Format© is the Copyright property of CompuServe Incorporated. GIFSM is a Service Mark of CompuServe Incorporated.

Windows and Microsoft Edge (Chromium) are trademarks of Microsoft Corporation; Microsoft

, Windows®10, Windows Server®2012, Windows Server®2016, and Windows Server®2019, OneDrive®,

and MS-DOS®are registered

trademarks of Microsoft Corporation.

All other product names and services mentioned in this publication are trademarks or registered trademarks of their respective companies. They are used throughout this publication for the benefit of those companies, and are not intended to convey endorsement or other affiliation with the publication.

Companies, names, and data used in examples herein are fictitious unless otherwise noted.

While every care has been taken in the preparation of this material, no liability will be accepted by Xerox Corporation arising out of any inaccuracies or omissions.

Changes are periodically made to this document. Changes, technical inaccuracies, and typographical errors will be corrected in subsequent editions.

Produced in the United States of America.

Table of Contents

1 FreeFlow VI eCompose Installation ...................................................................................... 7

Getting Started...... . ............................... ............................................................. . .................... 8

Program Download ............... . ............................................................ . . .............................. 8

Documentation Download............................. . ............................................................ . . ..... 8

Barcode Font Download............... . . ............................................................. ....................... 8

Specialty Imaging............... ............................... . ............................................................ . .. 8

Important Upgrade Information............................................. . .............................. . ................. 9

vipo.ini Configuration File Information......................................................... . ......................... 10

Installation Requirements.................. . ............................................................ . . ..................... 12

VIeC Installation.... . ............................................................ . ............................... ................... 14

VIeC Licensing . ............................... . ............................................................ . ......................... 15

Using the Load License Option .............................. ............................... ............................ 16

Using the Activation Key Option .. . ............................................................ . . ..................... 16

VIeC Configuration Options ........ . ............................................................ . . ............................ 18

VIeC Server and Client ............................................ ............................... . ......................... 18

VIeC Client Only ................ . ............................... ............................................................. . 18

VIeC Server Node Servicing a VIeC Cluster............................ ............................... . ........... 18

Additional VIeC Functions............................. . . .............................. . ........................................ 19

lpr Job Submission Installed on a VIeC Server ........................ ................................................ 20

Additional VIeC Printer Creation ....................................................... . ............................... ..... 21

Web-Enabling the VIeC Application ....... . . .............................. ................................................ 22

Defining VIeC Web Security Levels..................................... .............................. . . .............. 22

VIeC Server Node Installation ........................................................... . ............................... ..... 28

VIeC Web Job Submission Service (WJSS) Installation........................ ............................... . .... 31

VIeC Services Installation ...................................................... . . .............................. . ............... 32

Installation Procedures .................................................. ............................... . .................. 32

Uninstalling VI eCompose Services................................................... ............................... . 38

Adobe Acrobat and Reader ......................... ............................... . ........................................... 39

Create an Adobe Acrobat or Reader Privileged Folder ................... ............................... . .... 39

Adjust Security Settings ... .............................. . . ............................................................ . ... 39

2 VI eCompose Overview .........................................................................................................41

VI Suite Customer Forum ....................... . . ............................................................ .................. 42

VIeC .. ............................... . ............................................................ . .............................. . . ....... 43

VIeC Support for FreeFlow Process Manager .............................. . ........................................... 45

Workflow ........................... . ............................... ............................................................. . 45

Limitations.............................................................. ............................... . ......................... 45

SAP Device Type for VI Compose ............................................................. . . ............................ 46

VIeC Dispatch................... . ............................... ............................................................ . . ....... 47

Xerox®FreeFlow®VI eCompose

User Guide

Table of Contents

VIeC Services........................... . ............................................................. ............................... . 48

Setting up and Debugging VI eCompose Services .............................. .............................. 48

VIeC Web ............................. . .............................. . ............................................................ . . ... 49

VIeC Configuration Options ........ . ............................................................ . . ............................ 50

VIeC Multiple Instance .......... . .............................. . . ......................................................... 50

VIeC Server and Client ............................................ ............................... . ......................... 52

VIeC Client Only ................ . ............................... ............................................................. . 53

VIeC Server Node Servicing a VIeC Cluster............................ ............................... . ........... 54

vipo.ini Configuration Settings .................................................... ............................... . ........... 56

Optional .ini Entries................... . ............................... . ...................................................... 58

3 Using VIeC ...............................................................................................................................59

VIeC Server and Client ................ . . .............................. ............................... ............................ 60

Using VIeC Local Server ..................... . ............................................................ . . ..................... 61

File Menu Options..................... . ............................................................. ......................... 61

Job Selection Menu Options ................. ............................................................ . . .............. 63

Help Menu Options.......................... . . .............................. . ............................................... 63

Using the VIeC Job Submission Client ...... .............................. . . .............................................. 64

Window Elements ......................................................... . .................................................. 64

Job Creation Area Field Descriptions ......................... . . ..................................................... 66

Specifying PDF Output File Names..................... . ............................................................ . 72

Specifying an Index File.............................. . ............................................................. ....... 75

Template Field Descriptions ............. . ............................................................ . .................. 79

Using VIeC Watched Folders Client ............................. . . ......................................................... 80

Window Elements ......................................................... . .................................................. 80

Adding Watched Folders ........... ............................................................. . ......................... 82

File Ready Check.............................. ............................................................. . .................. 82

Command Line Options for VIeC Watched Folders Client.. . . .............................. ................ 83

Bulk Processing ...................................... . . ............................................................ .................. 84

Housekeeping ...................... ............................................................. . .................................... 85

4 Using BOOKMARK, PDF Features, and Project Containers..............................................87

Using the VIPP®BOOKMARK Command ......................................................... . . ..................... 88

Extended Bookmarks .. . ............................... . ........................................................... . . ....... 88

Using VIPP

PDF/X Support .... . .............................. . . ........................................................... . . ..................... 91

Using VI Project Containers ........ ............................................................. . . ............................ 92

PDF Interactive Features......................... ............................... ............................ 90

5 Using lpr to Submit VIeC Jobs .............................................................................................93

Lpr Client ...................................................... . . .............................. . ........................................ 94

Lpr Command Syntax for the Windows OS ................... . ............................... .......................... 95

Parameter Definitions ................................ . ............................... . ........................................... 96

Parameter Defaults...................................................... . ............................... .......................... 97

Example Lpr Job Submissions ..................... . ............................................................. .............. 98

Xerox®FreeFlow®VI eCompose User Guide

Table of Contents

6 VIPP®Job to PDF File Conversion .......................................................................................99

PDF Security Options ........................... ............................... . ................................................ 100

VIeC Security Options Dialog ............... . ............................................................ . ............ 100

VIeC Configuration..... . ............................... . ........................................................... . . ..... 101

Personalized Open Passwords for Split PDFs.. ............................... . .................................. 102

Font Locations .......................... ............................... . ........................................................... 105

Assigning a Job Options File............. ............................... . .................................................... 106

PDF Resources and Compatibility with APPE.......... . .............................. . ............................... 107

7 Using VIeC Services............................................................................................................. 109

Definitions.................................................... . . .............................. ....................................... 110

VI eCompose Server........... . ............................................................ . .............................. 110

VI eCompose Service .......................................... ............................... . ........................... 110

Constraints ............................................ . . ............................................................ ................ 111

8 Using VIeC Dispatch........................................................................................................... 113

VIeCD Data Flow .................. . .............................. . ............................................................ . . . 115

VIeCD IncomingFolders Filters ...... .............................. . . ....................................................... 116

Eligibility: CommandTemplates, RuleVars, and the DispatchRule Fieldname.......................... 117

Index File......... . ............................................................. ............................... . ................ 117

RuleVars .................. . .............................. . . ........................................................... . ......... 118

Reserved Index File Field Name........ . . .............................. .............................................. 118

AutoRun Filters ....................................... . .............................. . ............................................. 119

Processing.............. . ............................... ............................................................. . ................ 120

VIeCD Job Life Cycle.............................. . . ............................................................ ................ 121

Ineligible ........................... . ............................... ............................................................ 122

Rule Conflict ......................................... ............................... . ......................................... 122

Eligible........................................................ . ............................... ................................... 122

Pending ..................................... ............................... . .................................................... 122

Current ........ . . .............................. ............................... .............................. . . ................... 122

Held...................... ............................... . ............................................................ . ............ 123

Complete.......... ............................... . ............................................................ . ................ 123

Dispatch Filters .................. ............................... . ............................................................ . ..... 124

Dispatch Rule Files ..................................... . ............................... .......................................... 125

System Built-in Macros............................................ ............................... . ....................... 131

Rule File Variable References................................................... . . .............................. ....... 132

Special Character Sequences in CSV and XML Index Files .................................................. . . . 133

VIeC Dispatch Window . . . .............................. ............................................................. . ......... 134

Pending Jobs. . .............................. . . ........................................................... . . ................... 135

Eligible Jobs.......................... . . .............................. ............................... .......................... 135

Conflict Jobs .......................... . .............................. . ........................................................ 136

Completed Jobs ............................................................ . ............................... ................. 136

File Menu............ ............................... .............................. . . ............................................ 137

Edit Menu...................... ............................................................. . .................................. 137

Trace Menu........................ . ............................................................. .............................. 140

Xerox®FreeFlow®VI eCompose

User Guide

Table of Contents

9 Using VIeC Web................................................................................................................... 141

Accessing VIeC Using the Web Browser.................... ............................................................ 142

Job Status and Submission... . . ............................................................ ............................... . .. 143

Job Status Panel ..................................... . . .............................. ....................................... 143

Submit Job: Job Submission Panel.................. . . .............................. . ............................... 144

Administration........................................... . ............................... .......................................... 146

User and Group Administration...................... ............................................................. . . . 146

Server Administration....................... . . ........................................................... . ................ 147

Cluster Administration ............................................... . .............................. . .................... 149

Basic Authentication Quick Setup........ . ............................... . ................................................ 152

Performing Basic Authentication ............................................................ . ....................... 152

Disable Basic Authentication.............................. . ............................... ............................ 152

Web Browser Notes............................................ ............................... . .................................. 153

Starting and Stopping the Web Application ............................... . ............................... .......... 154

Changing the Port for HTTP and HTTPS ................................... .............................. . . ............ 155

10 VIeC Web Job Submission Service................................................................................. 157

11 How VIPP

Set Up the VIPP®Application .................................. . ........................................................... 160

Setting up VIeC and the VIeC Index Template....................... . ............................................. 162

Passing Data from the Index Template ......... . . ............................................................ ......... 164

BOOKMARK Interacts with Dispatch........................................................ 159

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

This chapter contains:

• Getting Started.................. . .............................. . ............................................................ . ............. 8

• Important Upgrade Information......................................................... .............................. . . ......... 9

• vipo.ini Configuration File Information....... . . ........................................................... . .................. 10

• Installation Requirements.............................. . ............................................................ . .............. 12

• VIeC Installation............... . . ............................................................ ............................... . ........... 14

• VIeC Licensing ............................. ............................................................ . . ................................ 15

• VIeC Configuration Options ................... . . ............................................................ . ..................... 18

• Additional VIeC Functions.......................................... .............................. . . ................................ 19

• lpr Job Submission Installed on a VIeC Server ............................................................. . .............. 20

• Additional VIeC Printer Creation ................................ .............................. . . ................................ 21

• Web-Enabling the VIeC Application............. . .............................. . . .............................................. 22

• VIeC Server Node Installation ......... . . ............................................................ . ............................ 28

• VIeC Web Job Submission Service (WJSS) Installation..... ............................... ............................ 31

• VIeC Services Installation........................................................ . .................................................. 32

• Adobe Acrobat and Reader ............................... . . .............................. ......................................... 39

Note: Refer to the following information:

• Install locally

Install locally VIeC and all components. You are required to log in locally, with system administrator credentials. Installations from a remote location, or using Windows Terminal Services, are not supported and do not work as expected.

• Virtual machine

You can install VI eCompose on a virtual machine with a unique MAC address or UUID. However, no support is provided for the VM environment.

• Updates are released as Full Installers.

• You can install any FreeFlow VI Suite 16.0.3.0 update over any prior release of the FreeFlow VI Suite. Installation of VI Suite components require system administrator privileges.

• Before any update installation, stop all active VI eCompose modules.

• Before any update installation, stop all active VI eCompose modules, such as FreeFlow VI eCompose or VI eCompose services.

Xerox®FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

Getting Started

Before you begin, first download the software from the Xerox website. Download instructions are provided here. After you have downloaded the appropriate files, you can proceed to the installation instructions that follow.

PPrrooggrraamm DDoowwnnllooaadd

To download VI eCompose, go to www.xerox.com/support, select Software & Platforms, select FreeFlow, select FreeFlow Variable Information Suite, select Driver & Downloads. If necessary, to

display the correct installer file, select the Operating System type appropriate for your target platform. To download the installer, click the VI eCompose installer file.

Note: Programs are delivered in .zip format. You can download the programs directly to the

target device. If the device does not have Internet access, copy the .zip file on the target

device. Extract the zip file, which contains .exe file for the FreeFlow VI eCompose installation.

DDooccuummeennttaattiioonn DDoowwnnllooaadd

English language versions of the FreeFlow Variable Information Suite documentation is available for download. Go to www.xerox.com/support, select Software & Platforms, select FreeFlow, select FreeFlow Variable Information Suite, and select Documentation.

BBaarrccooddee FFoonntt DDoowwnnllooaadd

To download barcode fonts, go to www.xerox.com/support, search for VIPP, then select Software.

Note: When downloading fonts, you are directed to review an End User License Agreement. To

download the fonts, review and accept the End User License Agreement. If you do not accept

the End User License Agreement, you exit from the font download page.

SSppeecciiaallttyy IImmaaggiinngg

Xerox Specialty Imaging is not supported when generating PDF as the output format. VIeC does not support any Specialty Imaging effects.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

Important Upgrade Information

When you have a previous VI eCompose software version earlier than 16.0.3.0 installed on your system and you are upgrading to a new version of VIeC, before you uninstall the earlier version, it is recommended that you install version 16.0.3.0 or later.

To enhance security, the internal password hash algorithm for the eCompose Web Application (HTTP) and Secure Web Application (HTTPS) have been upgraded from MD5 to 256-bit SHA-2. As a result, user passwords generated on versions of eCompose prior to version 15.0 no longer function, and before users can log in again, a one-time password reset is required.

A new password utility (sha2passwd.exe) has been provided to help in this transition. The utility can be invoked from the command line or from a batch file and works by resetting the indicated user password in the Web Application password file (vtpw.pwd). It is recommended that the administrator uses this utility to reset each user password to a unique temporary password. When the password is reset and provided to the user, the user logs in using the temporary password and immediately changes the password to a password of their choice.

How to use the sha2passwd.exe utility:

Bring up a command prompt and change directory to the eCompose bin directory, X:\Program Files(x86)\Xerox\VIPP\xvtp\bin, where X is the partition where the VI eCompose software is installed.

Note: For the utility to function properly, the current working directory needs to be the

eCompose bin directory.

Invoke the utility, specifying the name of the password file, the user name of the user, and the new (temporary) password.

Then the password for that user is reset. If the specified user is not present in the password file, the user and their new password are added to the password file. Example:

sha2passwd vtpw.pwd john changeMeSoon

Result: the password file vtpw.pwd is updated for the user name john with a 256-bit SHA-2 hash for the password changeMeSoon. John can use that password to log in, then use the Web interface to change the password immediately.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

vipo.ini Configuration File Information

The configuration of the VIeC installation is specified in the vipo.ini file at C:\ProgramData \Xerox\VIPP\VIPO\vipo.ini for Windows 10, Windows Server 2012 including R2, Windows

Server 2016, and Windows Server 2019.

The vipo.ini file is similar to this example:

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

A key entry is user_root=

• A VIeC Server processes any job submitted with user_root.

• A VIeC Job Submission Client submits local jobs to the appropriate location with user_root.

• The VIeC installation program adjusts the user_root entry according to the configuration that you select:

– VIeC Server and Client

– Client only

– VIeC Server Node servicing a VIeC Cluster

Note: The use of remote_user_root and the associated remote_server_root entries

were intended for use with a developer license configuration that is no longer available. Both entries are deprecated, so ignore the entries mentioned in older or other external documentation.

Note: Manual edits of the .ini and .conf files are discussed in the related sections of this

guide.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

Installation Requirements

VIeC can be installed on workstations that run in these environments:

• Windows 10, Windows Server 2012 including R2 32-bit and 64-bit platforms, Windows Server 2016, and Windows Server 2019 64-bit platform only

• Intel Pentium 4, Intel Centrino, Intel Celeron, Intel Xeon, or Intel Core Duo or better processor

• 2 Gbytes or more RAM for each instance.

• 5 Gbytes or more available hard drive space

• 1024 x 768 monitor screen resolution. The higher resolution is preferred.

• DVD-ROM or CD-ROM drive

• Microsoft .NET Framework 4.8 (installed)

Requirements to Run Multiple Instances of VIeC

For best results, a minimum of one CPU core and 2 Gbytes of RAM is required for each instance of VIeC. If Dispatch is involved, enough CPU or memory for all simultaneous post-processing operations is required. The requirements vary, based on the load and complexity of the jobs that need processing.

A minimum configuration for four instances, without considering VIeC Dispatch, is a quad core system with at least 8 Gbytes of RAM, running on a 64-bit operating system. Note that 32-bit operating systems are not able to address enough RAM to support the 8 Gbyte minimum RAM. If there is Dispatch post-processing or other system loads, more CPU and RAM capacity is required.

Requirements to Run the VIeC Web Job Submission Service

The general rule is that each Normalizer instance determined by the vinip.ini setting nip_ number_of_instances requires one CPU core and 2 Gbytes of RAM, just as with the initial VIeC multiinstance configuration. After the CPU and RAM allocations are made, further adjustments can be required. A dual-core system with 4 Gbytes of RAM would initially have nip_number_of_instances set to 2.

The expected use of WJSS is the submission of many small jobs with a few pages. WJSS can support the submission or any job, small or large. This can mean that the memory footprint requirement for a given Normalizer instance is less than 2 Gbytes. A high volume of small jobs can put a different load on network and disk I/O, which can push the overall system to being more I/O bound than CPU bound. When the system is up and running, users can see benefits from running more instances than there are cores, or they may need less working RAM than a system with different workflow requirements. On-site experimentation is encouraged.

PDF/VT-1

The Additional Profile Options dialog available from the Job Submission Client includes an option to create PDF/VT-1 compliant PDF files in addition to including Media and Finishing options. When using PDF/VT-1 and Media Finishing, always consider this information:

• Media and Finishing options and PDF/VT-1 compliance are applied only to the Master PDF file and not to any child PDF files that are split from the master PDF. While the master PDF file can

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

include Media and Finishing options and be PDF/VT-1 compliant, any child PDFs split from the master PDF do not have such features included.

• Not all printer devices honor PDF files that contain Media and Finishing requests or that are compliant with the PDF/VT-1 standard. Only the digital front end (DFE) systems that are supported honor the feeding and finishing requests.

Supported Print Servers

Xerox FreeFlow Print Server (FFPS) version 9.3 SP1 or above.

Trial Period

The initial installation of VIeC provides a 60-day trial period. After the trial-period, a production license is required for system functionality. You can activate the production license anytime during or after the trial period.

Note: The trial detects prior installations of VIeC and cannot activate the trial if the software

was installed more than 60 days before. Do not change the system clock to circumvent the

license mechanism because VIeC detects changes and cannot operate on that system.

The System Host ID of the Windows workstation and the product release version are required to get a license. When a license is not available immediately, the software can be installed, and the license can be activated later.

System administrator login credentials and privileges are required to install the VIeC software. Modify/Read and Execute/Write privileges are required on the drive and directories where VIeC is installed.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

VIeC Installation

1. Download the VI eCompose .zip file, then extract the files to get the .exe file for the installation.

For more information on downloading VI eCompose, refer to Program download.

2. Run the .exe file. To install the software, follow the onscreen instructions.

a. Accept the Software License Agreement.

b. Choose the following options from the install set:

• Client and Server: This option requires a software license.

• Client Only: This option requires access to a remote server.

• Server Node: This option services a cluster.

• LPR Setup: This option appends the LPR feature to an existing VI eCompose installation.

• LPR Job Submission: If you want to submit jobs through LPR, for LPR print driver installation, select Yes.

3. When prompted, provide the following VIeC configuration information for your system:

• Choose the Default Job Folder name.

• Choose the drive location for the program and customer files.

• Choose the drive that contains VIPP

customer files, such as the xgfc directory.

• Choose the available VIeC Servers on the network.

• Choose the default media size: A4 or US Letter.

• Choose the shortcut folder to create a product icon.

For more information about the available configuration options, refer to VIeC configuration

options.

4. After the installation completes, restart your system.

To convert the trial license to a product unit, order the VI eCompose License kit. After the order is processed, the license kit is delivered. Included in the license kit is the software activation key. To activate your software, follow the instructions in Using the Activation Key Option. Not all locations across the world support the use of license enablement using the automated license activation process. If the license kit does not contain the software activation key, obtain a license file, then follow the instructions in Using the Load License Option.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

VIeC Licensing

If the software has not been installed previously on your device, VI eCompose software installs with a 60-day trial period. To use the product after the 60-day trial period, to convert the trial to a fully licensed version of the product, purchase a production license. Without a valid license, the software is not usable.

The process to license VI eCompose depends on where and how VI eCompose was purchased. VI eCompose software has unique licensing requirements based on the geographical region. When you purchase VI eCompose software, the licensing requirements for your region are included in the kit.

• System clock

Do not attempt to change the system clock to circumvent the license. VIeC software detects changes. If tampering is attempted, the software fails to operate.

• Manual Load License process

When using the manual process of the Load License option, you are provided a license file. License files have the file extension *.dat for all VI products that are generated using an automated process. The process saves the file as HardwareAddress.dat, where HardwareAddress is the address of the computer on which the product is licensed. It is possible to receive more than one product license file with identical file names. It is your responsibility to ensure that you do not overwrite existing licenses when saving a new product license. When license files that are used on a single computer are set to expire at the same time, you can request one file that activates all VI products on that computer.

• VIeC Clients do not require a license.

• A workstation in a client-only configuration accesses a remote, licensed VIeC Server to process

To manually load or activate your VIeC license, from the menu bar on one of the main Dispatch, Local, or Web Server panels, select Help→Install/Update Software License. You can use this option to view how many days remain in the trial version or view the status of the license.

When you select the Install/Update Software License option, a VI eCompose License panel appears. The panel provides access to information about the installed license and two unique licensing options. Use the panel to choose the option suited to your location. The panel includes license information:

• License Type

• Days Remained: The number of days until the existing license expires.

• License Host ID: VleC software finds and displays the information from your computer. If a valid

• Product Version: The installed version of the VIeC software.

If you have obtained a license file: Use this option when you have received a license file with the file extension *.dat. When the file is delivered, ensure that you store the file in a safe and accessible place on your computer.

VIPP

license file has been loaded, the Host ID used by the license is shown.

jobs.

Note: When you install an upgrade to an existing version of VIeC software with a valid license,

the software finds and activates the previously installed license. No further action is required

until the license expires.

For instructions, refer to Using the Load License option.

If you have an activation key: The information in the panel is designed for users who have received a

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

software activation key as part of the software license kit for the VIeC software.

If you do not have the license kit, and are in a location that requires this option, to purchase the software license kit for the VIeC software, contact your Xerox sales representative. After the order has been processed, a license kit is shipped to you. The license kit contains the software activation key and serial number, if provided.

For further instruction, refer to Using the Activation Key option.

UUssiinngg tthhee LLooaadd LLiicceennssee OOppttiioonn

To activate the VI eCompose license using a license file:

1. Select the Load License option.

2. Browse to the location of the license file, select it, then click OK.

3. The license will be installed. The new license information will be displayed at the top of the license panel.

4. Select OK to activate the license.

UUssiinngg tthhee AAccttiivvaattiioonn KKeeyy OOppttiioonn

Note:

• Retain the software activation key and serial number in a safe location for future upgrades or support.

• If you have the software activation key, you can use the automated license process.

1. For System Host IDs, choose one of the available options for the license Host ID. The default is recommended.

Note: If the automated license process fails, when you contact Xerox Technical Support for

assistance, have available the hardware System Host ID string and the software activation

key.

2. For Serial Number, enter the serial number of the device where the software is installed.

3. For Software Activation Key, enter the information, then click Activate.

4. The Xerox License Server can request additional information. Enter the requested information, then select OK.

This information and the Software Activation Key are submitted to the Xerox License Server.

5. If additional information is required to validate the license request, a new screen appears. Enter the required information, then select OK.

The Xerox License Server validates the information and enables the license or returns an error code if the information supplied does not match the Xerox records.

6. If an error code is generated, for assistance, contact your local Xerox representative and report the error code.

7. If the information entered is valid, a license file is generated and loaded to your system. Details of the license appear in the License Information area of the License screen. To apply the license, click OK. When the OK button is selected, the license is applied.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

Sometimes, the automated license activation fails. If the license activation fails, for assistance, contact Xerox Technical Support. Ensure that you have available the System Host ID of the workstation and the software activation key supplied in the Software Activation Kit. If the license is emailed to you, you can activate the license manually.

Note:

• If connecting to the license server fails, you can go to any Internet-connected device and log in to the portal using this URL: https://www.xeroxlicensing.xerox.com/activation

• Enter the activation key, then follow the onscreen prompts. Ensure that you have available the System Host ID of the VIeC system. Xerox emails a license file to you. Move the license to a safe location on the VIeC system, then use the Load License option to install the license.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

VIeC Configuration Options

During installation, you are required to select the VIeC software configuration for your site. To determine which of the available VIeC configuration options is appropriate, click the links and review the information.

• VIeC Server and Client

• VIeC Client only

• VIeC Server Node servicing a VIeC Cluster

VVIIeeCC SSeerrvveerr aanndd CClliieenntt

This is the default configuration that results from a typical single-workstation VIeC installation.

Choose this option to install the following components on a single workstation:

• Local VIeC Server

• Job Submission Client

• Watched Folders Client

• VIeC Web Application

• VIeC Secure Web Application

• VIeC Dispatch Server

This option is discussed in detail in VIeC configuration options, a section of the FreeFlow VI eCompose User Guide.

VVIIeeCC CClliieenntt OOnnllyy

Choose this option to install the following components in a client-only configuration:

• Job Submission Client

• Watched Folders Client

No license is required. An existing VIeC Server is required on the network where the client can submit jobs.

Note: The installation script requires that you select the Remote Server Drive. Before the path

can be entered on the client installation, an available VIeC Server on the network is required.

The client requires access to the server.

For more information about this option, refer to VIeC configuration options, in the FreeFlow VI eCompose User Guide.

VVIIeeCC SSeerrvveerr NNooddee SSeerrvviicciinngg aa VVIIeeCC CClluusstteerr

Choose this option to install a VIeC Server Node servicing a VIeC Cluster. This is an advanced option to be used by system administrators only. Refer to VIeC configuration options, a section of the FreeFlow VI eCompose User Guide, for more complete information.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

Additional VIeC Functions

Additional functionality can be added either during or after the initial installation of VIeC. To add the additional functionality, you must log into an account with administrator access on the PC. Insert the CD you created previously into the PC's CD/DVD drive. The installation should start automatically. If the installation does not start automatically, browse the CD to the Windows folder and double-click on the setviec.exe file to start the installation. Follow the on-screen instructions to add additional functionality.

Installation of these additional functions are described in these sections:

• lpr job submission installed on a VIeC Server

• Additional VIeC printer creation

• Web-enabling the VIeC Server

• VIeC Server Node installation

• VIeC Services installation

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

lpr Job Submission Installed on a VIeC Server

To install the lpr job submission option for VIeC, select lpr printing during VIeC installation, or select Install VI eCompose LPR Option from the VIeC program folder after VIeC installation.

This option must be installed on each VIeC Client machine that will be running lpd and receiving lpr jobs for submission to VIeC for processing.

Note: To successfully install lpr job submission:

• Log on locally to the system where the VIeC LPR Printing installer will execute using a login account that has Administrator rights. Installations from a remote location, or using Windows Terminal Services, will not work as expected.

• Ensure that VIeC Client is installed on the Windows system that is receiving the lpr jobs.

• Ensure that you have Control Panel access.

Access to the Control Panel varies between Windows or Windows Server Operating Systems in use. Adjust these instructions according to your operating system.

1. From the Start button, go to Settings→Control Panel.

2. At the Control Panel, find and double-click Administrative Tools.

3. In the Administrative Tools window, find and double-click Services.

4. In the Services window, find TCP/IP Print Server. When the option is present skip to Step 8, when not continue to the next step.

5. Install TCP/IP Print Server. Go to Settings→Control Panel→Add Remove Programs.

6. Click on the Add/Remove Windows Components icon on the left.

7. Check Other Network File and Print Services, then click Next and Finish.

8. Return to Control Panel→Administrative Tools→Services and double-click TCP/IP Print Server.

9. Select Automatic for the Startup Type.

10. Click Start, then click OK.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

Additional VIeC Printer Creation

You can create additional VIeC printers.

Note:

• Characters in printer name

The VIeC printer name cannot exceed 64 characters and must consist of only alphanumeric, dash (-), and underscore (_) characters. All other characters result in errors or unexpected outcomes.

• At the end of each step in the wizard, click the Next button as required.

• Access varies.

Access to programs and settings varies according to the Windows or Windows Server operating system in use. Adjust these instructions according to your operating system.

1. From the Start menu, go to Settings→Printers.

2. To launch the Add Printer wizard, double-click Add Printer.

3. Select Local Printer.

Note: Ensure that this setting is not selected: Automatically detect and install my Plug and

Play printer.

4. Select xvtp port.

5. For the manufacturer, select Generic. For the printer type, select Generic/Text Only.

6. When prompted, select Keep existing driver.

7. For printer name, enter the virtual printer name for the lpr-to-VIeC command.

Note: Ensure that the virtual printer is not selected as the default printer.

8. When prompted, select Do Not Share This Printer.

9. To bypass printing a test page, select No, then click Finish.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

Web-Enabling the VIeC Application

Note: Access to programs and settings varies according to the operating system in use:

Windows 10, Windows Server 2012 including R2, Windows Server 2016, and Windows Server

2019. Adjust these instructions according to the operating system.

To enable the VIeC Server to accept VIPP

1. To start the VIeC Server, use one of these options:

• Select Start→All Programs→Xerox FreeFlow VI eCompose xx→VI eCompose Web Server.

• On the lower right side of the computer screen, right-click the VIeC Server icon, then select

Launch Web Application.

A small icon appears in the lower right corner of the window. The VIeC Server is web-enabled.

2. Obtain the system Network Identification or the IP address.

• To obtain the Network Identification, select Start→Settings→Control Panel→System, then

click the Computer Name tab. The system identification is the full computer name, for example: lab computer.

• To obtain the IP address, from a command prompt, enter ipconfig. The IP address is the

multiple-part number, for example: 11.1.1.111.

3. Start a Web browser on the VIeC Server or anywhere that has TCP/IP access to the system. In the browser address field, type the web-enabled VIeC Server address. Click the Job Submission link.

You can submit VIPP

jobs to the web-enabled VIeC Server.

jobs using the Web:

Caution: It is recommended that you do not leave the VIeC Web installation at the default

level of security. For more information, refer to Defining VIeC Web security levels.

DDeeffiinniinngg VVIIeeCC WWeebb SSeeccuurriittyy LLeevveellss

There are four types of security supported by VIeC Web:

No security, HTTP only Anyone with TCP/IP access to the VIeC Web Application can submit,

view, retrieve all jobs, and perform VIeC Web and VIeC Server administration. The HTTP setting can be an acceptable level of security for a VIeC installation on a LAN that is not connected to a larger network, such as in a training environment. The No Security HTTP only setting is not recommended for a production environment.

HTTP Basic Authentication Allows user account-level security with user passwords and group

security on an area-by-area basis. The HTTP Basic Authentication option is preferred to the No security, HTTP only option.

Note: Passwords transferred between the client and Wb

browser are transmitted as plain text and are not encrypted.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

HTTPS (HTTP Secure) over SSL (Secure Sockets Layer)

The HTTPS option encrypts the traffic between client Web browsers and the VIeC Web Application.

Note: Using SSL alone does not provide any user name,

password, or group configuration capability.

HTTPS via SSL with HTTP Basic Authentication

This is the preferred level of security for a VIeC Web installation. HTTPS and SSL combine the user name, password, and group configuration capabilities of HTTP Basic Authentication with the transaction encryption provided with SSL. This security level is obtained by applying at the same time the Basic Authentication and SSL configurations.

NNoo SSeeccuurriittyy,, HHTTTTPP OOnnllyy

This is the default security level at installation. Xerox recommends that you change this security level when the VIeC Servers are accessible from the internet and to protect sensitive information found in production environments.

HHTTTTPP BBaassiicc AAuutthheennttiiccaattiioonn

The VIeC Web implementation of HTTP Basic Authentication allows the VIeC administrator to set up a system of user-by-user access to controlled areas or realms. The VIeC administrator can associate user names with access to a specific realm or with named groups that are designated as having access to a specific realm.

Security for non-web-enabled VIeC installations can be restricted by setting read and write access on a user or group basis. To set the read and write access, on the operating system where the VIeC server is hosted, use the permissions mechanism of the file system.

After a VIeC Server is web-enabled, the read and write access at the operating system file system level is performed by the VIeC Web Application. The VIeC administrator can provide equivalent security. The VIeC Web support for Basic Authentication is an important part of providing that level of security.

HTTP Basic Authentication can be used with HTTP using the vtpweb.exe application or HTTPS.

To enable Basic Authentication for VIeC Web:

1. Click Basic Authentication Quick Setup.

2. In the required fields, type the needed information, then click Perform Quick Setup. To review the current settings and note areas that needs correction, use the Results screen.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

3. For additional security options, use the following options.

While not strictly a component of HTTP Basic Authentication, when HTTP Basic Authentication is enabled and active, additional security-related options can be configured:

• Strict Passwords

The administrator can require and configure the use of strict passwords. If strict passwords are enabled, the following criteria apply:

– A password must contain at least eight characters.

– A password must contain both letters and numbers.

– A password must contain both lowercase and uppercase letters.

– A password must contain at least one special character such as .#!$

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

– A password must not contain the contextual information such as the user name or

website name.

To enable requiring strict passwords, manually change vipo.ini, then restart the web Application. To enable strict passwords, use a text editor to add or change the line as follows:

vtpw_require_strict_passwords=1

A value of 0 indicates that strict passwords are not required.

• Password Reuse

Administrators can configure disallowing the reuse of passwords. If disallowing password reuse is enabled, users cannot use the same password more than once.

To disallow password reuse, manually change vipo.ini, then restart the web Application. To disallow password reuse, use a text editor to add or change the line as follows:

vtpw_disallow_password_reuse=1

A value of 0 indicates that password reuse is allowed.

• Login Session Expiration

Administrators can configure a login session expiration time out. If a user session is not active for longer than the specified time out, the session logs out and requires the user to log in again to resume the activity.

To enable login session expiration, manually change vipo.ini, then restart the web Application. To enable login session expiration, use a text editor to add or change the line as follows:

vtpw_session_maxduration_minutes=30

The number specified is the session expiration login time out value in minutes. A value of 0 indicates that the session never times out.

• Unsuccessful Login Attempt Lockout

Administrators can configure the number of times a user can unsuccessfully attempt to login before the account is locked.

To enable an unsuccessful login attempt lockout, manually change vipo.ini, then restart the web Application. To enable unsuccessful login attempt lockout, use a text editor to add or change the line as follows:

vtpw_unsuccess_login_max_attempt=5

The number specified is the maximum number of times a user can make unsuccessful attempts to log in before the account is locked. A value of 0 indicates that there is no limit on the number of unsuccessful login attempts.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

• Account Lockout Duration

Administrators can configure how long a user waits after a lockout occurs before the user can attempt another log in.

To change the user wait time after a lockout, manually change vipo.ini, then restart the web Application. To change the duration, use a text editor to add or change the line. For example:

vtpw_account_lockout_duration_minutes=2

The number specified is the number of minutes a user is required to wait before attempting to log in again. A value of 0 indicates that there is no wait before the user is allowed to attempt a login.

HHTTTTPPSS ((HHTTTTPP SSeeccuurree)) oovveerr SSSSLL ((SSeeccuurree SSoocckkeettss LLaayyeerr))

Beyond Basic Authentication, it can be useful to secure the communication channel between the client browser and the VIeC Web Application directly.

VIeC implementation of HTTPS (secure web Application)

1. The SSL Certificate needs to be installed from IIS.

2. To open the IIS Manager, in the Run command, type inetmgr or search for Internet Information Service in the Start menu.

3. In the Connections pane on the left side of the window, to change the port, navigate to Server→Sites→Default Web Site.

4. Click FreeFlow VIeCompose. On the right side of the window, you can find the Browse Folder.

5. To launch Web Application, click Browse *.80(http), or to launch Secure Web Application, click Browse *.443(https).

6. By default, there is a self-signed SSL certificate and that certificate needs to be changed to the correct SSL certification.

7. From the client browser, replace http in the VIeC Web browser URL with https:

https://url_name

https://nn.n.n.nnn, where nn.n.n.nnn is the IP address.

SSSSLL CCeerrttiiffiiccaattee IInnssttaallllaattiioonn

The following instructions guide you through the SSL installation process on Microsoft IIS 7. If you have more than one server or device, you need to install the certificate on each server or device that you need to secure. To install the SSL certificate, refer to the following instructions:

1. Launch IIS Manager. Click Start→Control Panel→Administrative Tools→Internet Information Services (IIS) Manager.

2. Select your server name. In the left Connections menu, select the server name as host where you want to install the certificate.

3. Navigate to the Security section. In the center menu, click the Server Certificates under the Security section near the bottom.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

4. Click Complete Certificate Request. In the right Actions menu, click Complete Certificate Request.

5. Browse to your Server Certificate. In the Complete Certificate Request wizard field, to browse and select your Server Certificate file that you saved on the desktop of your server, click ….

6. Name your certificate. Enter a Friendly Name, which is an internal reference name that is used to distinguish the file later. It is recommended that you include the Certification Authorities name and expiration date.

7. Click OK.

The installed certificate appears in the refreshed Server Certificate List.

Binding your Certificate to your Website

Proceed with the following steps, which help you assign or bind the SSL certificate to the appropriate website.

1. Access your Sites folder. From the left Connections menu, expand the name of your server, expand the Sites folder, then expand the Default Web Site folder.

2. In the right Actions menu, click Bindings.

3. In Site Bindings window, click Add.

Note: If you already have the appropriate site binding created, click Edit then change the

SSL Certificate accordingly.

4. In Add Site Bindings window, enter the following information:

• For Type, select HTTPS

• For IP Address, select All Unassigned. If you have multiple IP addresses, select the IP address

that applies.

• For Port, enter 443 unless SSL traffic appears on another port.

• For SSL Certificates, select the friendly name of the SSL certificate that you installed. To

confirm the validity details of the certificate, click View.

• To finish binding the SSL certificate to your live website, click OK.

Note: For changes to take effect, you need to restart your server.

OOppeennSSSSLL LLiicceennssee SSttaatteemmeenntt

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit,

http://www.openssl.org/.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

VIeC Server Node Installation

This is an advanced option for use by the VIeC system administrator. Before you install a VIeC Server, you must:

• Obtain a license for each VIeC Server

• Map a network drive (for example, X) to the shared drive on the file server

On each workstation on which a VIeC Server has to be installed, select VIeC Server Node servicing a VIeC Cluster.

When prompted, choose the network drive of the file server that has been set up for use by the VIeC Cluster.

During installation, for each workstation on drive C, the user_root is set automatically to:

user_root=X:\Program Files(x86)\Xerox\VIPP\xvtp\users

This indicates that each VIeC Server treats jobs placed on the file server as if they were local; that is, it processes jobs on the file server and places the output on the file server.

After bringing up the first VIeC Server, you will have a configuration similar to this:

To test the installation, submit a small local job from the Job Submission Client on the VIeC Server. The job results are generated on the file server, not on the VIeC Server workstation.

Xerox®FreeFlow®VI eCompose User Guide

FreeFlow VI eCompose Installation

More VIeC Servers can be added to the Cluster by repeating this installation process.

During the installation process, a skeleton directory structure is installed on the file server, which makes it appear to VIeC Clients as a VIeC Server. This allows VIeC Clients to submit jobs to the file server as if they were a VIeC Server. Now, Client-only installations can be pointed at the file server to set up a VIeC Cluster.

VIeC Server Nodes in a Cluster cooperate transparently when selecting jobs, that is they do not get in each other's way. You can add Server Nodes to the Cluster to improve the job turnaround time or remove them for maintenance while the Cluster itself is active, as long as at least one VIeC Server Node is servicing the Cluster. Before you remove a node, ensure that you shut down the node gracefully. The only impact on clients is in the improvement or degradation of their job turnaround time.

Xerox

FreeFlow®VI eCompose

User Guide

FreeFlow VI eCompose Installation

Xerox®FreeFlow®VI eCompose User Guide

+ 138 hidden pages