Xerox FreeFlow Output Manager 8.0 Command Line Guide

F

reeFlow®
Output Manager

Version 8.0
701P49954
September 2009

®

FreeFlow

Output Manager
Command Line

User Guide

Prepared by:
Xerox Corporation

Global Knowledge & Language Services
800 Phillips Road
Building 0218-01A
Webster, New York 14580
USA

Copyright © 1996-2009 Xerox Corporation. All rights reserved. Xerox® and the sphere of connectivity design, FreeFlow®,
FreeFlow Makeready®, FreeFlow Output Manager®, and FreeFlow Process Manager® are trademarks of Xerox Corporation in
the US and/or other countries.

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.
Printed in the United States of America.
Other company trademarks are acknowledged as follows:

Adaptec®, the Adaptec logo, SCSlSelect®, and EZ-SCSI® are trademarks of Adaptec, Inc.
Adobe PDFL - Adobe PDF Library Copyright © 1987-2009 Adobe Systems Incorporated.
Adobe®, the Adobe logo, Acrobat®, the Acrobat logo, Acrobat Reader®, Distiller®, Adobe PDF JobReady™, and PostScript®,
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 - 2009 Adobe Systems Incorporated and its licensors. All rights reserved.
Autologic® is a registered trademark of Autologic Information International, Inc.
Compaq® and QVision® are registered United States Patent and Trademark Office, for Compaq Computer Corporation.
DEC, DEC RAID, and Redundant Array of Independent Disks are registered trademarks of Digital Equipment Corporation.
Dundas - This software contains material that is (c) 1997-2000 DUNDAS SOFTWARE LTD., all rights reserved.
Imaging Technology provided under license by Accusoft Corporation.
ImageGear © 1996-2005 by AccuSoft Corporation. All Rights Reserved.
Intel® and Pentium® are registered trademarks of Intel Corporation.
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
ScanFix® Image Optimizer and ImagXpress are either registered marks or trademarks of Pegasus Imaging Corp. Copyright ©
1997-2008 Pegasus Imaging Corp. All rights reserved.
SonyTM and Storage by SonyTM are trademarks of Sony.
PANTONE ™ and other Pantone, Inc. trademarks are the property of Pantone Inc.
Preps™ is a registered trademark of Creo Inc. All rights reserved.
Quark® and QuarkXpress® are registered trademarks of Quark, Inc.
StorageViewTM is a trademark of CMD Technology, Inc.
TIFF® is a registered trademark of Aldus Corporation.
Windows®, Windows XP®, Windows Server® 2003, Windows Server® 2008, and Internet Explorer are trademarks of
Microsoft Corporation; Microsoft® and MS-DOS® are registered trademarks of Microsoft Corporation.
Portions Copyright ©?2001 artofcode LLC.
This software is based in part on the work of the Independent JPEG Group.
Portions Copyright?© 2001 URW++. All Rights Reserved.
This product includes software developed by the Apache Software Foundation.
Copyright © 1999-2003 The Apache Software Foundation. All rights reserved.
This software is based in part on the work of Graeme W. Gill.
© Press-sense Ltd. 2002-2007. All rights reserved.
Includes Adobe® PDF Libraries and Adobe Normalizer technology
The Graphics Interchange Format © is the Copyright property of CompuServe Incorporated. GIFSM is a Service Mark
property of CompuServe Incorporated.
Portions contain an implementation of the LZW algorithm licensed under U.S. Patent 4,558,302.
Parts of this software Copyright © 2004-2006 Enterprise Distributed Technologies Ltd. All Rights Reserved.
Parts of this software Copyright © 1995-2003, The Cryptix Foundation Limited. All Rights Reserved.
Parts of this software are a SSLv3/TLS implementation written by Eric Rescorla and licensed by Claymore Systems, Inc. All
Rights Reserved.
Parts of this software Copyright © 2002, Lee David Painter and Contributors. Contributions made by Brett Smith, Richard
Pernavas, Erwin Bolwidt.
Parts of this software Copyright © 1995-2005, Jean-loup Gailly and Mark Adler.
All other product names and services mentioned in this publication are 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.
Changes are periodically made to this document. Changes, technical inaccuracies, and typographical errors will be corrected
in subsequent editions

Table of Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

2 FreeFlow Output Manager overview. . . . . . . . . . . . . . . . . . . . . 2-1

What is FreeFlow Output Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Objects and attribute model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

3 CLI operation and commands . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

CLI overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

CLI operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Security considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Return value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Command syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Extended attribute string syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Attribute Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Object identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Attribute value string syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

CLI help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6

Software Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6

add-document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6

backup-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7

browse-repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8

cancel-document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8

cancel-job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9

check-job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10

clear-counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10

copy-to-document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11

copy-from-document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12

copy-job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13

create-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-16

create-queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16

create-report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17

create-snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17

delete-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-18

delete-document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-18

delete-job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19

delete-queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20

disable-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20

disable-queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21

discover-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22

end-processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22

enable-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-23

enable-queue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23

get-device-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-24

get-document-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24

get-job-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25

Command Line User Guide i

Table of Contents FreeFlow Output Manager

get-queue-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26

get-server-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26

hold-job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27

hold-new-jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-28

list-devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29

list-jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29

list-queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30

move-job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31

pause-queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32

print-job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33

purge-queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36

remove-device-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36

remove-document-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37

remove-job-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37

remove-queue-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38

remove-server-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38

release-held-new-jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-39

release-job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-40

reorder-documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41

reprocess-job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42

restore-server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-45

resume-queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-46

set-device-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-46

set-job-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-47

set-document-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48

set-queue-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48

set-server-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49

shutdown-system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-50

update-devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-50

list-custom-view-groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-51

enable-custom-view-groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-51

disable-custom-view-groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-52

set-custom-view-group-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-52

remove-custom-view-group-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-53

get-custom-view-group-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-54

create-multifunction-device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-54

set-multifunction-device-attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55

enable-multifunction-devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-56

disable-multifunction-devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-56

list-multifunction-devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57

delete-multifunction-devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57

get-multifunction-device-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58

enable-send-to-production. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58

disable-send-to-production . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59

set-send-to-production-attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59

publish-queue-to-mfd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-60

list-multifunction-device-registrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-60

delete-multifunction-device-registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61

4 Attribute summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-1

Attributes of queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Informational . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

ii Command Line User Guide

FreeFlow Output Manager Table of Contents

Queue Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Queue Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

Read-only job attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

date-time-at-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

date-time-at-creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

date-time-at-processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

date-time-at-processing-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

date-time-at-marking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

date-time-at-marking-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

duration-marking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

total-printing-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

job-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

job-id-on-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

job-id-on-printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

job-pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

job-impressions-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

job-impressions-completed-black-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

job-impressions-completed-color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

job-k-octets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

job-originating-user-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

job-originating-host-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

job-reprocessed-job-ids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

job-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

job-state-reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10

number-of-documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12

output-device-actual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12

output-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12

proof-print-copies-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12

queue-assigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12

Read-write job attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13

interleaved-sheets-col . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13

ipp-attribute-fidelity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-account-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-accounting-data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-accounting-user-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-hold-until . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-hold-until-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-message-to-operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-message-from-operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

job-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-14

job-offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

job-pass-through . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

job-priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

job-retention-period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

job-recipient-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

job-sheet-message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

job-splitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-16

output-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16

pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16

preprocessing-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

postprocessing-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

Command Line User Guide iii

Table of Contents FreeFlow Output Manager

proof-print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

Read-only document attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

document-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

document-number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

document-uri-on-printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

date-time-at-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

date-time-at-creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

date-time-at-processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

date-time-at-processing-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

date-time-at-marking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

date-time-at-marking-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

duration-marking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

total-printing-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

impressions-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18

impressions-completed-color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

impressions-completed-black-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

document-job-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

k-octets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

job-id-on-printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

document-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

document-state-reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20

output-device-assigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21

Read-write document attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21

adjust-bw-darkness-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21

adjust-bw-darkness-value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22

adjust-contrast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22

adjust-cyan-red . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22

adjust-lightness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22

adjust-magenta-green . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22

adjust-saturation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23

adjust-yellow-blue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23

anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23

black-overprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23

color-destination-profile-back . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23

color-destination-profile-front . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24

color-effects-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24

color-emulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24

copies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24

cover-back . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24

cover-front . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25

document-color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25

document-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25

document-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25

document-set-range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25

document-sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

finishings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

finishings-col . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

booklet-making . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

booklet-fold-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

booklet-square-fold-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

iv Command Line User Guide

FreeFlow Output Manager Table of Contents

booklet-staple-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

booklet-trim-width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

font-name-requested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

font-size-requested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27

force-front-side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27

halftone-graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27

halftone-images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28

halftone-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28

highlight-colorant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28

highlight-colorant-mismatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29

highlight-map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30

highlight-map-color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31

insert-sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-31

interleaved-sheets-col . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31

media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32

media-col . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-32

number-up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33

opi-image-insertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34

opi-image-pre-scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34

orientation-requested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34

page-delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34

page-ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34

pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

output-bin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-35

page-overrides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

page-ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

page-rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

pages-per-subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

printer-resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36

rendering-intent-graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36

rendering-intent-images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36

rendering-intent-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36

resample-method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37

resource-cleanup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37

resource-pre-scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38

sample-set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-38

sample-sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-38

separator-sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38

sheet-collate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38

sides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38

toner-saver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-39

trapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39

trap-width-fast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39

trap-width-slow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39

trc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39

undefined-source-cmyk-graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40

undefined-source-cmyk-images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40

undefined-source-cmyk-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40

undefined-source-gray-graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40

undefined-source-gray-images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40

undefined-source-gray-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

Command Line User Guide v

Table of Contents FreeFlow Output Manager

undefined-source-rgb-graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

undefined-source-rgb-images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

undefined-source-rgb-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

vi-container-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

x-image-shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42

x-side1-image-shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42

x-side2-image-shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42

y-image-shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42

y-side1-image-shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42

y-side2-image-shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42

Read-only device attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

device-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

device-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

printer-controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

printer-controller-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

printer-high-watermark-reached . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

printer-is-accepting-jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

printer-make-and-model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

printer-network-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

printer-ready-for-deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

printer-queue-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

printer-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

printer-state-reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

printer-up-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

printer-uri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

queued-job-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

queued-job-page-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

printer-secure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44

Read-write device attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

interposer-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

printer-high-watermark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

printer-high-watermark-enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

printer-location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

printer-low-watermark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

printer-make-and-model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

printer-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45

Device capability attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

booklet-making-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

cover-back-supported, cover-front-supported . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

finishings-col-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

insert-sheet-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

media-col-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

page-overrides-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47

proof-print-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47

trc-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47

5 Server Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-1

Read-only server attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

server-jobs-processed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

server-jobs-accepted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

server-pages-processed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

server-k-octets-processed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

vi Command Line User Guide

FreeFlow Output Manager Table of Contents

server-snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Read-write server attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

server-maximum-snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

server-snapshot-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

server-snapshot-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

server-report-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

server-report-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

reset-counter-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

reset-counter-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

6 Using the CLI in Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Programming considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Preprocessing Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Postprocessing Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

Hot Folder/Port Controller Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

Sample Hot Folder/Port Controller Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

PDL Analysis Preprocessor Script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

A Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

CLI Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-19

Finishing Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-21

Media Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-26

XOMPDLANA Script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-28

xompdlana script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-28

Command Line User Guide vii

Table of Contents FreeFlow Output Manager

viii Command Line User Guide

Introduction

1

Purpose

Many users will interact with the FreeFlow Output Manager (FFOM) only through its browser
based GUIs. However all FreeFlow Output Manager capabilities are also accessible through its
command line interface (CLI). This document helps you understand how to use the Xerox
FreeFlow Output Manager command line interface.

FFOM CLI commands can be used from a command window to interact with FFOM but they can
also be used in scripts that will be automatically executed by FFOM. This is a powerful way to
customize FFOM to a specific workflow. This document tells you how to use this feature of
FFOM.

Command Line User Guide 1-1

Introduction FreeFlow Output Manager

1-2 Command Line User Guide

FreeFlow Output

2

Manager overview

What is FreeFlow Output Manager

FFOM is an output management system. Its primary purpose is to sit in front of a fleet of
production printers and manage the flow of print jobs submitted to them.

Print jobs are created by client applications, frequently residing on other hosts in a network.
FFOM accepts jobs requests from:

• LPR network printing protocol

• IPP network printing protocol

• JMF protocol (receives JDF jobs)

• Multi-function device (job is scanned at a MFD and sent to FreeFlow Output Manager for
printing at a Production Printer)

• a local command line interface

• either local or network mounted “hot-folders”

• clients sending data to a predefined TCP/IP port

Note that the last two mechanisms rely on the command line interface to perform job
submission.

There are seven user-visible objects in FFOM:

• Job: The job object is a model of a print job. The job object is the managed unit of work
within FFOM. It contains information on the characteristics and state of the job and its
documents. A job can include one or more documents.

• Document: The document object represents the data to be printed and information about
how the data is to be printed.

• Queue: A queue is the central object in FFOM. It maintains a pool of jobs and is responsible
for management of the distribution of these jobs to devices. Each queue has a name and
zero or more associated devices.

• Device: A device represents a printer and a port on an actual printer (for example, a specific
IPP port/virtual printer on a DocuSP). It is possible to have more than one FFOM device that
represents the same printer.

• Server: The server object contains server statistic information. The data includes snapshots
of the internal counters. The internal counters record the number of jobs, number of pages,

Command Line User Guide 2-1

FreeFlow Output Manager overview FreeFlow Output Manager

and number of bytes received by the queue, sent to devices, and received by the clients
such as CLI, IPP, LPR, GUI, and JMF. Refer to section 5 for details.

• Custom View Group: The Custom View Group defines the objects that are accessible to the
logged in operator. Objects such as printers and queues can be added to the custom view
group. If printers and queues are accessible to the logged in operator, their jobs and
documents are accessible as well.

The feature can be enabled or disabled. When enabled, FFOM administrators still have
access to all objects in the system. FFOM operators can only access the objects that are
associated with the Custom View Groups that the FFOM operator belongs.

• Multi-Function Device (MFD): A device used to scan a job and forward it to FFOM for
further processing. The MFD is used as a client job submitter to FFOM.

All these objects can be dynamically created and deleted. Queues and devices have names
given by the administrator; jobs have names (id’s) that are created by the system; documents
are identified by their position in the job.

FFOM supports a rich set of job processing attributes. Job attributes may be supplied via a
default job ticket associated with a queue, a job ticket prepended to the print data stream or
from instructions delivered via the submission protocol. FFOM supports jobs that contain both
the ASCII Job Ticket and the XPIF Job Ticket. While the job is held or pending in an FFOM
queue, a job ticket editor can be used to inspect and set job ticket instructions.

An FFOM queue is the client submission point. They map to devices in the following ways:

• A queue can accept submissions from any inbound gateway or MFD.

• A queue can send jobs to any number of devices (including zero);

• A device can accept jobs from any number of queues.

In other words, a queue provides a 1-to-n mapping from an inbound service to devices.

Although FFOM does not export a formal, programming interface, it does have a command line
interface and supports three mechanisms through which a sophisticated user can customize job
processing and/or manipulate the document data to be printed. These are the hot-folder
submission method and the queue preprocessing and postprocessing program. The first two
mechanisms allow a user to cause an arbitrary script to be executed when a job enters the
FFOM system. This script, a DOS bat file using FFOM’s CLI, has access to the job object, its
attributes, and for hot-folder submission, the document data. The script can do whatever its
writer wants.

FFOM supplies one program executable intended for use in preprocessing programs. This
program will read a document and guess its PDL, the number of pages in the document, and
whether or not the document is color or monochrome.

In addition to preprocessing, an FFOM queue can be configured so that another script is
executed when the job enters a terminal state. This postprocessing program is intended to
perform things like sending e-mail notification but, again, it can do anything its writer wants.

FFOM supports two job scheduling paradigms:

• First-in, First-out—this is the underlying scheduling mechanism, all other things being equal
(or irrelevant), the first job to enter a queue will be the first job to be sent to a printer

• Priority—incoming jobs can have or be given a priority and the higher the priority, the more
quickly the job will be sent to a printer

2-2 Command Line User Guide

FreeFlow Output Manager FreeFlow Output Manager overview

FFOM supports five device selecting paradigms:

• Round-robin—this is the default, underlying device selecting algorithm; all other things
being equal, a queue will cycle through its associated printers and assign a job to the next
available device.

• High-watermark—since most FFOM printers are “spooling” printers; they accept numerous
jobs and have internal queues. FFOM devices can be configured to stop accepting jobs
when they a specified number of jobs already queued-up for printing.

• Capability matching—FFOM devices have attributes that specify their capabilities (‘xxx­supported’ attributes). If so configured, FFOM will match these printer capabilities against
the job’s requirements and not schedule a job to a printer that cannot support all of the
job’s needs.

• Least-busy by job count—Send a job to a printer with the least number of uncompleted
jobs.

• Least-busy by page count—Send a job to a printer with the least pages pending to print.
This applies only to jobs forwarded from FreeFlow Output Manager to the printer.

FFOM supports the following five job splitting models:

• Copies—If a job specifies multiple copies, FFOM will distribute the number of copies of the
job evenly amongst the printers that can print the job.

• B/W and Color Pages—If a job contains color and black and white (B/W) pages, FFOM will
send pages containing color to a Color printer and the B/W pages to a monochrome printer.

• Page range—For a job, FFOM will distribute to each of the printers that can print the job
specifying specific pages to print.

• Documents—If a job contains multiple documents, FFOM will distribute the documents
amongst the printers that can print the job.

• Sets— If the job contains a document that is a VI Container and the VI Container is a VIPP
file with a database, FFOM will distribute to each of the printers that can print the job
specifying the document sets to print.

The FFOM will transform a document whose data is a PDF file to PostScript if the device that will
print the job only supports PostScript.

Users will benefit from the following features of FFOM:

• Centralized control over a printer farm—Through a single FFOM operator interface, an
operator can control how jobs are routed to a set of printers, see their status and redirect
them if necessary.

• Intelligent routing—A client can submit jobs to a single FFOM queue and expect that it will
be routed to a printer that is capable of printing the job and is available.

• Better utilization of printer resources—The print shop will realize more efficient utilization
of its printers since FFOM will ensure that jobs aren’t sent to devices that cannot print
them.

• Quicker turnaround—By taking advantage of FFOM’ job splitting features, multiple copy
jobs can be spread across several printers resulting in less time to print the entire job.

Command Line User Guide 2-3

FreeFlow Output Manager overview FreeFlow Output Manager

Objects and attribute model

The user-visible objects, (queues, jobs, documents and devices), all have attributes that define
the object’s properties and behaviors. This section describes the model of an object and its
attributes that FFOM presents.

There are three operations that affect an attribute: get, set and remove. The get operation
returns the current value of an attribute, the set operation creates the attribute (if necessary)
and gives it a value; the remove operation removes the attribute from the object. The CLI
explicitly implements the get, set and remove operations for each object.

From the perspective of the end-user, attributes are either read-only or read-write. A read-only
attribute cannot be set or removed. These attributes are typically created when the object is
created and the FFOM software manages their values.

A read-write attribute is instantiated when it is given a value; either explicitly by a user of the
GUI/CLI or, in the case of jobs, through instructions processed by the inbound gateways. A
read-write attribute has its value removed by “removing” the attribute.

In general, read-write attributes do not have default values that are set by the FFOM software.
(But, if there is one, it will have its value explicitly set to that default value.)

The get operation on an attribute that has not been instantiated fails.

For example:

xomsetque –x “queue-connect-to-all-devices=true” queue1

will succeed (assuming queue1 exists). If this is followed by:

xomgetque –x queue-connect-to-all-devices queue1

the command will succeed and the write the string

queue1:queue-connect-to-all-devices=true

to standard-out (stdout). If this is followed by:

xomremque –x queue-connect-to-all-devices queue1

and then

xomgetque –x queue-connect-to-all-devices

the final get-queue-attributes will return an error and display the message “queue-connect-to­all-devices” does not exist.

This means that a script can use the return of a CLI get operation to determine if an attribute
has been instantiated (i.e., has a value). It also means that for the “-all” argument for the CLI
get operation, the command will return only the attributes that have been instantiated (i.e.,
that have values).

2-4 Command Line User Guide

CLI operation and

3

commands

This section describes the FFOM CLI commands, their options and operands.

CLI overview

Although it is expected that most FFOM users will use the GUIs for most day-to-day operations,
FFOM includes a CLI that provides access to all FFOM functionality. This CLI will be used by
customers or analysts in hot folder, port controller, pre or post-processing scripts.

CLI operation

Security considerations

Since the CLI allows access to all FFOM operations including potentially destructive ones, its
use is restricted to running on the same host as the server software and particular
operations are restricted to members of the FFOM authorization groups.

Return value

The CLI commands will return 0 if successful and a positive integer if an error occurred.
Error messages will be written to standard error. All other data from the CLI is written to
standard out (stdout). A complete list of error codes is given in Appendix B. Commonly
expected error codes are also shown with each command, although these should not be
considered exhaustive.

Command syntax

The FFOM CLI is patterned after a traditional UNIX command. The basic syntax of a FFOM
CLI command is:

command [-options [option argument]] operand

The options are all single letters, option arguments are not optional, and the options must
precede the operand. To ensure uniqueness (and that they are unpronounceable), all FFOM
CLI commands are prefixed with “xom” (signifying “Xerox Output Management”).

Command Line User Guide 3-1

CLI operation and commands FreeFlow Output Manager

Extended attribute string syntax

The set, get and remove CLI commands use the –x option to specify attribute/value pairs
and attribute names.

In the initial implementation, specifying multiple attributes in a single set command
requires that the attribute/value pairs be separated by commas and that there be no white
space in the –x string (unless it’s the value of an attribute and has been enclosed by
quotes). For example, in a set command the CLI wants to receive:

-x attr=value,attr=value,attr = value

rather than

-x attr=value attr=value.

When setting an attribute, the entire attribute/value pairs must be enclosed in double
quotes. Example:

xomsetque Ross –x “queue-connected-to-all-devices=true”

Attribute Files

In addition to attributes specified using the -x option, one or more attributes can be
specified in a file. The attributes specified are written in XPIF format.

Object identifiers

FFOM objects (jobs, documents, queues and devices) are often the operands of CLI
commands. Queues and devices are identified by their unique names. Although jobs have a
unique numeric id, the FFOM CLI requires that user also specify the queue the job resides in
along with the job id. The syntax for this is “queue:id”. A document’s id consists of the job
identifier followed by a “:” followed by the number of the document within the job. For
example ‘queue1:123’ identifies job 123, which is currently contained in queue1 and
queue1:123:2 identifies the second document in the same job.

Note that if a job has only one document, it is not necessary to specify the document
number. For example, if job 123 has only one document associated with it

xomsetdoc –x sides=two-sided-long-edge queue1:123:1

and

xomsetdoc –x sides=two-sided-long-edge queue1:123

are identical.

Attribute value string syntax

The following section shows the CLI string representation for the attribute syntaxes.

boolean

The boolean attribute syntax has only two values: ‘true’ and ‘false’. For example:

xomsetque –x “queue-connect-to-all-devices=true”

queue1

followed by

xomgetque –x queue-connect-to-all-devices queue1

would return

queue1:queue-connect-to-all-devices = true

3-2 Command Line User Guide

FreeFlow Output Manager CLI operation and commands

Note that the CLI prints the string ‘queue1:queue-connect-to-all-devices = true’ to
standard-out. The command returns a 0 even if the value of the attribute is false.

collection

The collection attribute syntax is a container holding a set of attributes, called member
attributes. The names of each member attribute are unique for a collection attribute, but
may be the same as the name of a member attribute in another collection attribute or the
same as the name of an attribute that is not a member of a collection.

FreeFlow Output Manager validates and processes each member attribute of a collection
attribute in the same way that it validates and processes normal attributes. The collection
merely serves as a ‘container’ for the member attributes. Each member attribute can
have any attribute syntax type, including 'collection', and can be either single-valued or
multi-valued (1setOf). The length of a collection value is not limited. However, the length of
each member attribute must not exceed the limit of its attribute syntax.

The CLI represents collection syntax as the member attributes and their values enclosed in
curly braces (‘{‘and ‘}’). Each member attribute is delimited by a comma with no spaces
within the collection.

For example:

xomsetjob –x cover-front={media=na-letter­transparent,cover-type=print-none}

followed by:

xomgetjob –x cover-front queue1:123

would return:

queue1:123:cover-front={media=na-letter-transparent
cover-type=print-none}

dateTime

The dateTime syntax is the full (non-truncated) representation of the date/time value as
defined in ISO 8601:

YYYY-MM-DDThh:mm:ss

For example:

xomsetque –x “job-hold-until-time=2003-04-01T18:00:00”

queue1

followed by

xomgetjob –x date-time-at-processing queue1:123

would return

queue1:123:date-time-at-processing=2003-04-01T09:45:52

enum

The enum attribute syntax is an enumerated integer value in the range 1 to MAX and each
value has an associated ‘keyword’ name. The CPSS spec uses 'type1', 'type2' and 'type3'
prefixes to indicate different levels of review and/or standards bodies that are involved in
the definition of the values. This specification has removed those indicators.

Since each integer in the enum has an associated keyword, either the enum or associated
keyword can be used when specifying the enum value.

Command Line User Guide 3-3

CLI operation and commands FreeFlow Output Manager

integer

The integer syntax include an inclusive range constraint of the form (min:max). Valid values
for attributes must be within these ranges. The MIN value for integers is –2**31 and the
MAX value for integers is 2**31-1.

For example

xomsetjob –x “job-priority=202” queue1:123

would return an error since the maximum value for job-priority is 100.

keyword

The keyword syntax is a sequence of characters of length 1 to 255 containing only the US­ASCII encoded values for lowercase letters, uppercase letters, hyphen, dot and underscore.
The first character must be lowercase and the keywords must be U.S. English.

This syntax type is used for enumerating semantic identifiers. Keyword values for attributes
are listed in the description of the attribute.

mimeMediaType

The mimeMediaType attribute syntax is the Internet Media Type (called MIME type) as
defined by RFC 2046 for identifying a document format. The value may include a charset,
or other, parameter, depending on the specification of the Media Type in the IANA registry.
Although most other syntax types allow for only lower-case values, this syntax type allows
for both mixed-case values which are case insensitive.

The FFOM CLI recognizes only the following mimeMediaType values for input:

•‘text/plain’: An plain text document in US-ASCII

•‘application/postscript’: A PostScript document

•‘application/vnd.hp-PCL’: A PCL document

•‘application/pdf’: A PDF document

•‘application/octet-stream’: An unspecified representation

•‘image/tiff’: A Tagged Image File Format document.

• 'application/vnd.xerox-VI-project-container': A VI container file.

For example:

xomsetjob –x document-format=”application/postscript”
queue1:123

would set the job’s document format attribute to PostScript.

name

This syntax type is used for user-friendly strings. Names are never translated from one
natural language to another. The maximum length of a name syntax type is 255 octets. If
the attribute will always contain less than 255 octets, the syntax can be qualified by the
maximum allowable length (for example, device-name is limited to 127 octets).

The delimiters for inputting the name syntax are right and left quotation marks. To avoid
parsing problems, the FFOM CLI restricts the name syntax type to exclude:

• left and right quotation marks

•the colon (“:”)

• left and right curly braces (“{“and “}”)

For example:

xomcreque “Useless Queue”

does exactly what you’d think it does.

3-4 Command Line User Guide

FreeFlow Output Manager CLI operation and commands

rangeOfInteger

This syntax is an ordered pair of integers that defines an inclusive range of integer values.
The first integer specifies the lower bound and the second specifies the upper bound. If a
range constrain is specified (e.g., 1:100), then the constraint applies to both integers.

For example:

xomsetque –x “job-priority-supported=100:100” queue1

sets queue1 so that it will only accept really important jobs (i.e., jobs with a priority of 100).

The following example:

xomsetque –x “job-priority-supported=1:1000” queue1

will fail with an INVALID PARAMETER error since the maximum value allowed for the
attribute job-priorities accepted is 100.

text

A text attribute is an attribute whose value is a sequence of zero or more characters
encoded in a maximum of 1023 (‘MAX’) octets. MAX is the maximum length for each value
of any text attribute. However, if an attribute will always contain values whose maximum
length is much less than MAX, the definition of that attribute will include a qualifier that
defines the maximum length for values of that attribute.

For example:

xomsetdev –x “device-make-and-model=’Xerox DocuTech
75’” device1

The delimiters for inputting the text syntax are right and left quotation marks. To avoid
parsing problems, the FFOM CLI restricts the text syntax type to exclude:

• left and right quotation marks

•the colon (“:”)

• left and right curly braces (“{“and “}”)

uri

The uri attribute syntax is any valid Uniform Resource Identifier (see RFC 2396). The
particular uri scheme supported for a given attribute is described in that attribute’s
description.

1setOf

The 1setOf attribute is one or more values of the above attribute syntax types (except
1setOf itself). The attribute is called 1setOf rather than just setOf as a reminder that the
set of values must not be empty. The sets are normally unordered but a given attribute can
specify that the values must be in a particular order.

Command Line User Guide 3-5

CLI operation and commands FreeFlow Output Manager

The CLI represents 1setOf syntax as the values enclosed in curly braces (‘{‘and ‘}’) with the
values separated by commas. For example:

xomgetdev –x orientation-requested-supported device1

might return

device1: orientation-requested-supported
={portrait,landscape}.

CLI help

Every FFOM CLI command accepts the options “-h” or “-?”. These options cause the
command to write a brief help message to standard out.

Software Version

Every FFOM CLI command accepts the option "-v". This option will display the version of
FFOM.

Example:

xomlisjob -v

might return

8.0.0.0_808[10305.20090225]

add-document

This command adds a document to an existing job. For this operation to be successful, the job­state must be held. The job attribute number-of-documents is incremented by 1. If the
document is located in a document repository, a username and password is required to retrieve
the document from the repository.

This operation has the following optional argument:

• "open". If specified, the job is kept open which delays preprocessing until the job is
"closed". The job is considered closed when any of the commands xomrepjob, xomsetjob,
xomsetdoc, xomadddoc does not specify the -e option is invoked.

Command name:

xomadddoc

Operand:

uri uri designating the file to be added to the job.

Options:

-j queue:jobId

-e open (delays preprocessing of job)

-u username required to login to the document repository

-s password required to login to the document repository

3-6 Command Line User Guide

FreeFlow Output Manager CLI operation and commands

Returns:

0 if successful
JOB_NOT_IN_QUEUE (12) if the job does not exist
INVALID_PARAMETER (22) if the uri is invalid (i.e., file

does not exist)

Examples:

xomadddoc –j myQ:14 samplefile.ps
xomadddoc –j myQ:14 “C:\SampleFile.ps”
xomadddoc –j myQ:15 /export/cs/samplefile.pdf
xomadddoc -j myQ:15 repository://39083202434903 -u ross

-s mypassword

backup-server

This command will create a backup of FFOM. The created backup file is a zip file which is used
to restore FFOM through the restore-server command. The user invoking the command must
have Windows Administrator privileges as FFOM processes are stopped and restarted during
this operation.

The backup file contains the following:

• Configuration settings

• Jobs, Queues, Printers

– Jobs in the pending, held state will be backed up and restored successfully. Jobs in

processing, and completed states will be backed up but upon restore will be deleted.

• Printers registered in Printer Registration Utility

• Standalone Repository Management configuration settings

• Hot Folder and Port Configuration configuration settings

• Accounting Module database and reports

The command must be invoked from the "bin" sub-directory of the FFOM installation directory
(e.g. C:\Program Files\xerox\FreeFlow Output Manager).

Command name:

ffom_backup

Operand:

Fully qualified path to the backup file to be created. If the operand is not specified, the
generated file is written to the FFOM installation sub-directory called "Backups". The
name of the file is ffbackup_OutputManager_YYYYMMDD_n.zip where:

• YYYY is the year

• MM is the numerical month (e.g. 01 is January)

• DD is the day of the month

• n is the incremental version to avoid conflicts of existing files with the same name in

the directory

Command Line User Guide 3-7

CLI operation and commands FreeFlow Output Manager

Returns:

0 if successful

Example:

ffom_backup
ffom_backup "C:\Backups\ffombackup_20090528_1.zip"

browse-repository

This command will return the list of items and their associated repository IDs contained in the
specified directory. The IDs for the files are used as input for the xomprijob, xomadddoc,
xomcpfdoc, xomcptdoc commands when specifying an item in a document repository.

Command name:

xombrorps

Operand:

Directory ID in the form "repository://<id>"

Options:

-u username required to login to the document repository

-s password required to login to the document repository

Returns:

0 if successful
INVALID_PARAMETER (22) if the attribute is not

recognized

Example:

xombrorps -u ross -s mypassword
xombrorps -u ross -s mypassword repository://

0234348324024055389043

cancel-document

This command cancels a document associated with an existing job. The cancel-document
operation prevents the document from being printed. The operation is successful if the job-state
is pending, held, or processing. If the document-state is processing, best effort is made to cancel
printing at the device. If the job contains only a single document, the document cannot be
cancelled; the job must be cancelled.

The document-state is set to “aborted” and document-state-reasons is set to “cancelled-by­operator”. The associated document data is not deleted.

Command name:

xomcandoc

3-8 Command Line User Guide

FreeFlow Output Manager CLI operation and commands

Operand:

queue:jobId:docId

Options:

None

Returns:

0 if successful
DOCUMENT_NOT_FOUND (25) if document does not exist
JOB_ERROR (13) if attempting to cancel last document in

the job

Examples:

xomcandoc myQueue:14:3

cancel-job

This command cancels a job (i.e., sets its job-state to canceled). As much as is practical, no
further processing or printing will occur on a cancelled job; if it is printing when the cancel is
issued, FFOM will attempt to stop printing. The job-state is set to "aborted" and job-state­reasons is set to "job-canceled-by-operator".

FFOM will accept or reject the cancel operation depending on the job’s state. The following
table shows the effect the cancel operation has on job-state.

Current job-status New job-status Status

pending aborted Ok, cancel occurs immediately

held aborted Ok, cancel occurs immediately

processing aborted Ok, may return before completed

aborted aborted Operation returns an error

completed completed Operation returns an error

A canceled job is not necessarily removed from the system. If, for example, the job’s job-
retention-period attribute has a value, the job will stay in FFOM until the retention period
expires.

Command name:

xomcanjob

Operand:

queue:id

Command Line User Guide 3-9

CLI operation and commands FreeFlow Output Manager

Options:

none

Returns:

0 if successful
JOB_NOT_IN_QUEUE (12) if the job does not exist
JOB_IN_INVALID_STATE (11) if the job cannot be canceled

Examples:

xomcanjob queue1:123

check-job

This command returns a list of job attributes that fail capability scheduling against a specified
device. The job attributes are listed via stdout.

Command name:

xomchkjob

Operand:

job-id

Options:

-d name of device

Returns:

0 if successful
JOB_NOT_IN_QUEUE (12) if the job does not exist
DEVICE_NOT_FOUND (7) if the device does not exist

Examples:

xomchkjob myQ:34 –d MyPrinter
media-col
sides

clear-counters

This command resets the "counters since last reset" to 0. Refer to chapter 5, Server Attributes on
page 1 for more information on counters.

Command name:

xomclrcnt

Options:

None

3-10 Command Line User Guide

FreeFlow Output Manager CLI operation and commands

Returns:

0 if successful

Examples:

xomclrcnt

copy-to-document

This command replaces the document data for the document with the specified file. This
operation is used by preprocessing or postprocessing scripts that may wish to modify the
original document data and store an updated version associated with the document.

If the document data is stored in a document repository, a username and password is required
to retrieve the document from the repository.

To obtain a copy of the original document data, the script uses the copy-from-document
operation.

Command name:

xomcptdoc

Operand:

Filename

-d queue-name:jobId:document-number

Options:

-b max number of bytes to store. If not specified, the

entire document data is stored.

-u username required to login to the document repository

-s password required to login to the document repository

Returns:

0 if successful
DOCUMENT_NOT_FOUND (25) if document does not exist
INVALID_PARAMETER (22) if can’t read data from file

Examples:

xomcptdoc –d myQueue:14:1 newdocdata

Replaces the current document data for the document referenced by myQueue:14:1 with
the contents of the file newdocdata

xomcptdoc –d myQueue:14:1 –b 100 newdocdata

Replaces the current document data for the document referenced by myQueue:14:1 with
the first 100 bytes from the contents of the file newdocdata.

xomcptdoc -d myQueue:14:1 repository://

32349028342390423 -b 100 -u ross -s mypassword

Replaces the current document data for the document referenced by myQueue:14:1 with
the first 100 bytes from the contents of the file contained in the repository.

Command Line User Guide 3-11

CLI operation and commands FreeFlow Output Manager

copy-from-document

This command copies the document data associated with the document to a file or provides an
absolute filepath to the document data. The –f option will instruct copy-from-document to
copy the document data content to the specified filename. Otherwise, the command will return
the absolute file path to the file in FFOM’s spool directory.

This is used by preprocessing or postprocessing scripts that may wish to perform some action on
the document data such as analyzing the data for the PDL format, estimating the number of
impressions the document represents.

If the document data will be stored to a repository, a username and password is required to
store the document into the repository.

Command name:

xomcpfdoc

Operand:

queue:jobId:docId

Options:

-b max number of bytes to retrieve.

If not specified, entire document data is retrieved.

-f <filename> absolute filepath where the document data

is copied

-a prepend document attributes using an XPIF job ticket

-u username required to login to the document repository

-s password required to login to the document repository

Returns:

0 if successful
DOCUMENT_NOT_FOUND (25) if document does not exist
INVALID_PARAMETER (22) if can’t write data to file
JOB_IN_INVALID_STATE (11) if document is in wrong state

Examples:

xomcpfdoc myQueue:14:1

Returns the filepath to the document data referenced by document 1 of job-id 14 in queue
“myQueue”.

xomcpfdoc myQueue:14:1 –f C:\mylocalcopy

Copies the document data referenced by document 1 of job-id 14 in queue “myQueue” to
the file “C:\mylocalcopy”.

xomcpfdoc myQueue:14:1 –f C:\mylocalcopy –a

Copies the document data referenced by document 1 of job-id 14 in queue “myQueue” to
the file “C:\mylocalcopy” prepending the document attributes in XPIF job ticket format

xomcpfdoc myQueue:14:1 -f repository://

2340928342390423908 -u ross -s mypassword

3-12 Command Line User Guide

FreeFlow Output Manager CLI operation and commands

Copies the document data referenced by document 1 of job-id 14 in queue "myQueue" to a
file in the repository.

copy-job

The copy-job operation creates a duplicate copy of the original job and its associated
documents and submits the job to the specified queue. The operation applies to the job in any
state with the exception of "pre-processing".

The new copy is processed the same way as a newly submitted job into the system.

This operation has the following optional arguments:

• "open". If specified, the job is kept open which delays preprocessing until the job is
"closed". The job is considered closed when any of the commands xomcpyjob, xomrepjob,
xomsetjob, xomsetdoc, xomadddoc does not specify the -e option is invoked.

• "hold-job". If the option is specified, the new job will be put in the held state. This allows
modification of the new job's attributes prior to the job being released for scheduling.

The job template attributes of the created job are identical to those in the original job.

The document template attributes of the create documents within the job are identical to
those in the original.

The following table indicates how the read-only job attributes of the new job are affected.

Attribute Value in new job

date-time-at-completed Attribute deleted (i.e., no value)

date-time-at-creation Absolute time of the copy operation

date-time-of-processing Attribute deleted (i.e., no value)

date-time-at-processing-completed Attribute deleted (i.e., no value)

date-time-at-marking Attribute deleted (i.e., no value)

date-time-at-marking-completed Attribute deleted (i.e., no value)

job-impressions-completed Attribute deleted (i.e., no value)

job-impressions-completed-color Attribute deleted (i.e., no value)

job-impressions-completed-black­only

Attribute deleted (i.e., no value)

duration-marking Attribute deleted (i.e., no value)

document-name Same as original job

job-id Assigned by system

job-id-on-client Same as original job

job-id-on-printer Attribute deleted (i.e., no value)

Command Line User Guide 3-13

CLI operation and commands FreeFlow Output Manager

Attribute Value in new job

pages Same as original job

job-k-octets Same as original job

job-originating-user-name Same as original job

job-originating-host-name Same as original job

job-name Same as original job

job-parent-job-id Job ID of original job

job-reprocessing-job-ids Attribute deleted (i.e., no value)

job-state pending or held

job-state-reasons Attribute deleted (i.e., no value)

number-of-documents Same as original job

output-device-actual Attribute deleted (i.e., no value)

output-device Same as original job if submitted to saame queue.

Otherwise attribute deleted

The following table indicates how the read-only document attributes of the new job are
affected.

Attribute Value in newdocument

date-time-at-completed Attribute deleted (i.e., no value)

date-time-at-creation Absolute time of the copy operation

date-time-of-processing Attribute deleted (i.e., no value)

date-time-at-processing-completed Attribute deleted (i.e., no value)

date-time-at-marking Attribute deleted (i.e., no value)

date-time-at-marking-completed Attribute deleted (i.e., no value)

impressions-completed Attribute deleted (i.e., no value)

impressions-completed-color Attribute deleted (i.e., no value)

impressions-completed-black-only Attribute deleted (i.e., no value)

duration-marking Attribute deleted (i.e., no value)

document-name Same as original document

impressions Same as original job

job-id-on-printer Attribute deleted (i.e., no value)

k-octets Same as original document

document-state pending

3-14 Command Line User Guide