scan_fax sdk.pdf

Xerox WC / DC Scan / Fax SDK Developer’s Guide

Scan/Fax SDK Developer GuideScan_Fax SDK version 4.2

This document is intended for third-party software developers, system integrators, and technical support analysts interested in integrating the WC/WCP/DCS scan to network or server fax services in their products or workflows. Textual descriptions contained in this document will focus on the currently marketed WorkCentre/ WorkCentre Pro line of products.

XEROX CONFIDENTIAL Version 4.2 of 115

1

1

2

3

4

56

789

1011

2


Prepared by:

Xerox OG/SEBU SolutionsXerox Corporation, 1 Publisher’s Parkway, Bldg. #855, Webster, NY 14580

©2003 by Xerox Corporation. All rights reserved.

Copyright protection claimed includes all forms and matters of copyrightable material and information now allowed by statutory or judicial law or hereinafter granted, including without limitation, material generated from the software programs which are displayed on the screen such as styles, templates, icons, screen displays, looks, etc.

Printed in the United States of America.

XEROX® and all Xerox product names mentioned in this publication are registered trademarks of the Xerox Corporation. Other company trademarks are also acknowledged.

Adobe®, and PostScript® are trademarks of Adobe Systems, Inc.

Microsoft® is a registered trademark, and Windows NT is a trademark of Microsoft Corporation.

HP, and HPCL are registered trademarks of Hewlett Packard, Inc.

TIFF® is a trademark of Aldus Corporation.

NetWare, NetWare Name Services, and Novell are registered trademarks, and LAN Workplace is a trademark of Novell, Inc.

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


3

12

1314

15

161718

19

2021

22

23

24

25

2627

2829

4


TABLE OF CONTENTS

1 INTRODUCTION.......................................................................................................................................................................6

1.1 DEVICE SUPPORT REQUIREMENTS................................................................................................................................61.2 READING ROADMAP...................................................................................................................................................61.3 UPDATES..................................................................................................................................................................6

1.3.1 Updates from version 4.0 to 4.2....................................................................................................................61.3.2 Updates from version 3.7 to 4.0....................................................................................................................7

1.4 DEFINITIONS AND ACRONYMS.....................................................................................................................................71.5 RELATED SDKS ......................................................................................................................................................9

2 SCAN AND FAX SERVICES FUNCTIONAL OVERVIEW................................................................................................10

2.1 INSTALLATION AND ENABLING....................................................................................................................................102.2 SERVICE SETUP AND CONFIGURATION..........................................................................................................................112.3 NETWORK SCAN JOB PRE-CONFIGURATION....................................................................................................................112.4 SCAN OUTPUT- FILE TRANSFER, IMAGE AND CONTROL FILES........................................................................................112.5 PARTNER APPLICATION INTEGRATION OPPORTUNITIES.....................................................................................................12

2.5.1 MFD configuration options.........................................................................................................................152.5.2 Required integration....................................................................................................................................172.5.3 Recommended integration...........................................................................................................................18

3 DEVICE LEVEL CONFIGURATIONS ................................................................................................................................19

3.1 NETWORK SCANNING SETUP.....................................................................................................................................193.1.1 Image Setting...............................................................................................................................................193.1.2 Template Pool Setup....................................................................................................................................203.1.3 Repository Setup..........................................................................................................................................233.1.4 Include authenticated username in scan job log.........................................................................................233.1.5 Confirmation Sheet......................................................................................................................................243.1.6 Default Template.........................................................................................................................................24

3.2 SERVER FAX SETUP.................................................................................................................................................243.2.1 Fax Repository configuration......................................................................................................................243.2.2 Include authenticated username in scan job log.........................................................................................253.2.3 Confirmation Sheet......................................................................................................................................25

3.3 SECURE WORKFLOWS................................................................................................................................................253.3.1 Proxy Server................................................................................................................................................253.3.2 SSL 253.3.3 IP Sec...........................................................................................................................................................253.3.4 Trusted Certificate Authorities....................................................................................................................26

3.4 OTHER DEVICE LEVEL CONFIGURATIONS......................................................................................................................263.4.1 Network Authentication...............................................................................................................................263.4.2 Off-Box Validation Option...........................................................................................................................273.4.3 Include job based accounting data in scan job log.....................................................................................27

4 SCAN TEMPLATES AND JOB LOGS..................................................................................................................................28

4.1 CUSTOMIZING THE UI FOR YOUR WORKFLOW...............................................................................................................284.2 XST FILE STRUCTURE...............................................................................................................................................29

4.2.1 File Name....................................................................................................................................................294.2.2 Service names and entries...........................................................................................................................294.2.3 Service invocation names ...........................................................................................................................304.2.4 Attribute names and values..........................................................................................................................30


5

30

6


4.2.5 Compulsory Attributes.................................................................................................................................304.2.6 Sample scan template and log.....................................................................................................................30

4.3 BASE TEMPLATE – COMMON.XST................................................................................................................................334.3.1 Xrx_svc_general..........................................................................................................................................344.3.2 Xrx_svc_scan...............................................................................................................................................354.3.3 Xrx_document..............................................................................................................................................384.3.4 Xrx_svc_file.................................................................................................................................................424.3.5 Other attribute values .................................................................................................................................464.3.6 Fax service...................................................................................................................................................46

4.4 ATTRIBUTE EDITING AT THE DEVICE LUI....................................................................................................................464.5 USING METADATA TO CUSTOMIZE THE WORKFLOW......................................................................................................47

4.5.1 Examples......................................................................................................................................................494.5.2 Special character representation in MetaDataValue..................................................................................51

4.6 BUILD JOB.............................................................................................................................................................514.6.1 Processing multi-segment jobs....................................................................................................................54

4.7 SYSTEM GENERATED JOB CONTEXT ATTRIBUTES IN JOB LOG............................................................................................544.7.1 Scanner IP address: OutputURI / OutputURL............................................................................................554.7.2 Authenticated user name: NetworkUsername.............................................................................................554.7.3 JBA data: AcctName and AcctValue...........................................................................................................554.7.4 NumberScannedSegments............................................................................................................................554.7.5 NumberImagesScanned...............................................................................................................................56

4.8 IMPLEMENTATION DIFFERENCES ACROSS THE PRODUCT LINE.........................................................................................56

5 SCAN OUTPUT AND PROCESSING....................................................................................................................................58

5.1 IMAGE...................................................................................................................................................................585.1.1 File Format..................................................................................................................................................585.1.2 Files Stored for Multi-page TIFF and PDF................................................................................................585.1.3 Files Stored for Single-page TIFF and JPEG.............................................................................................58

5.2 JOB LOG................................................................................................................................................................595.3 FILE TRANSFER.......................................................................................................................................................59

5.3.1 Directory Locking - the .LCK Directory.....................................................................................................595.3.2 File Transfer Protocols...............................................................................................................................59

5.4 FILING POLICIES......................................................................................................................................................605.4.1 Rename New File (New Auto Generate)......................................................................................................605.4.2 Overwrite Existing File (Overwrite)............................................................................................................615.4.3 Append.........................................................................................................................................................615.4.4 New Exact....................................................................................................................................................615.4.5 Add Date To Name / GEN_DATE_TIME_ID..............................................................................................61

5.5 PROCESSING SCAN OUTPUT........................................................................................................................................625.5.1 Adding functionality – Using Network Scanning as a Workflow Onramp..................................................625.5.2 Monitoring and Retrieving Files From the Scan to File Repository ..........................................................625.5.3 Pseudo code sample for Repository Management.......................................................................................635.5.4 Avoiding the Need to Deal with the .LCK Directory ..................................................................................65

6 INTEGRATING WITH SERVER FAX / NETWORK FAX.................................................................................................66

6.1 SERVER FAX DEVICE LEVEL CONFIGURATION.................................................................................................................666.2 SERVER FAX UI OPTIONS.........................................................................................................................................66

6.2.1 Fax UI..........................................................................................................................................................666.2.2 Scan template pre-programmed fax service................................................................................................686.2.3 Other options...............................................................................................................................................68

6.3 IMPLEMENTING THE FAX SERVER CONNECTOR.............................................................................................................686.3.1 Processing the Fax Send Data.....................................................................................................................69


7

8


6.4 FAX CONFIRMATIONS...............................................................................................................................................726.4.1 Printed Fax Confirmations..........................................................................................................................726.4.2 Fax Confirmations via Email......................................................................................................................73

6.5 PROCESSING RECEIVED FAXES...................................................................................................................................736.5.1 Printing Jobs on the WC/WCP/DCS...........................................................................................................73

7 APPENDICES...........................................................................................................................................................................84

7.1 DOCUMENT HISTORY.............................................................................................................................................113


9

31

32

10


1 IntroductionThe Xerox WorkCentre Scan Fax SDK allows developers to integrate the Xerox WorkCentre (WC/WCP)/DocumentCentre System (DCS) scan-based functions into their applications. Xerox scanning is based on the Xerox Network Scan Architecture and not TWAIN. This document is intended for developers and system integrators interested in integrating the WC/WCP/DCS scan to network or server fax services in their products or workflows.

Textual descriptions contained in these documents will focus on the currently marketed WorkCenter / WorkCentre Pro line of products. It is assumed that the reader is familiar with the WC/WCP/DCS product lines and capabilities. Functional differences between newer and older product lines are disclosed in the appendix.

1.1 Device Support Requirements

Partner products must support the currently marketed WorkCentre / WorkCentre Pro line of products. Support for older products is strongly encouraged due to the size of the existing install base and the likelihood that a customer will have a mixture of newer and older products.

1.2 Reading Roadmap

Vendors interested in programmatic configuration capabilities and device management should use the XDCLibrary SDK.

Vendors interested in using scan to network as a workflow on-ramp to applications such as archival systems, forms processing applications and the like, read Vendors interested in integrating with the control files should use the Parser SDK. Vendors interested in managing Xerox Scan Templates directly on the MFD should use the Scan Template Management API/SDK.

Vendors interested in integrating a server fax application should read sections 1 Introduction and 2 Scan and FaxServices Functional Overview, followed by 6 Integrating with Server Fax. It is recommended that vendors use the Parser SDK to parse the control files, and XCDTools SDK to manage the device. Vendors interested in integrating with Fax via SMTP should refer to the SMTP Fax SDK.

Vendors interested in implementing off-box metadata validation should use the Metadata Validation API/SDK.

1.3 Updates

1.3.1 Updates from version 4.0 to 4.2Updated device list and updated functionality tables through the document to match.

Updated Table 2: Key scanning capabilities across models.

Added section 3.1.1 Image Setting.

Updated Table 3: Template Pool and Repository settings, 3.4.1 Network Authentication with LoginSource , 4.3.2.6 Color Mode , 4.3.3.2 Resolution , 4.3.3.3 DocumentFormat.

Added section 4.3.4.3 LoginSource.


11

33

3435363738

394041

42

434445

46

4748

49505152

53545556

57

58

5960

61

62

6364

65

12


Updated 4.3.4.4 RepositoryAlias , Table 9: Metadata and Metadata Validation Attributes , Table 10: File transferimplementation , Table 11: Data in job log implementation , Table 13: Network Scan and Server Fax servicesavailability per device model.

Updated section 4.2.2 Service names and entries.

1.3.2 Updates from version 3.7 to 4.0Additional protocols HTTP and HTTPS: see Table 3: Template Pool and Repository settings, and section 4.3.4 Xrx_svc_file.

Security: see section 3.3 Secure workflows.

Off Box Validation: see section 3.4.2 Off-Box Validation Option and section 4.5 Using MetaData to customize theworkflow. Refer to the Off Box Validation SDK.

JBA data: see section 3.4.3 Include job based accounting data in scan job log and section 4.7.3 JBA data: AcctNameand AcctValue.

Compulsory attributes: see section 4.2.5 Compulsory Attributes.

Build job: see section 4.6 Build Job and section 5.5 Processing scan output.

Updated base template: see section 4.3 Base template – common.xst.

New and updated attributes: see sections 4.3.2.5 CompressionQuality, 4.3.2.7 Output Usage / Scan presets, 4.3.3.2 Resolution, 4.3.3.4 CompressionsSupported, 4.3.3.5 MixedType, 4.3.3.6 MixedTypesSupported, 4.3.3.7 MixedCompressionsSupported, 4.3.4.1 DocumentFilingPolicy, 4.3.4.2 FilingProtocol, 4.3.4.9 XrxHTTPScriptLocation, 4.3.4.10 ServerValidationReq, 4.7.3 JBA data: AcctName and AcctValue, 4.7.4 NumberScannedSegments, 4.7.5 NumberImagesScanned, and 5.4.5 Add Date To Name / GEN_DATE_TIME_ID.

1.4 Definitions and Acronyms

ASCII For this document, ASCII refers to US ASCII single-byte codes from 0 through 127. This is the same character set defined by Latin-1 for character codes from 0 through 127.

Attribute Value Pair(s) Usage of this phrase is usually in the context of the description of a job attribute and its associated value. Example: JobTemplateName = “Test.xst”. Refer to Attribute Manual for details on Scan Template Attributes.

DC / DCS Document Centre / Document Centre System (also used as a generic term for all Xerox MFD in this category)

Device UI / LUI Device User Interface or Local User Interface – buttons and soft panel

Document Management Fields /

Metadata Fields

Job Template Metadata Fields are predefined attributes in the Job Template Language. Use of these fields allows users to input data at the device UI at the time of scan. This data is written to the Job Log xst file.

Embedded Fax / On board Fax Some devices support Fax board is installed within the Device.

Flate A lossless compression made up of a mix of LZ77 and adaptive Huffman encoding (RFC 1951).

FlowPort Xerox Product (document management application)

HTTP(S) Hyper Text Transfer Protocol (Secure)


13

666768

69

707172

73

7475

7677

78

79

80

8182838485

86

14


Internet Services /

Web UI /

CentreWare Internet Services /

Embedded web server

Web server embedded in the Xerox device.

JBA Job Based Accounting / Job Based Network Accounting / Network Accounting [Xerox device supported capability.]

JFIF JPEG File Interchange Format

JPEG Joint Photographic Experts Group

Job Log A formatted file generated by a service containing detailed information about execution of the scan to file / scan to network fax job. File has extension .XST. The device transfers this file / the scan to file output. It contains values pertinent to work flow processing, including user input from the Device UI.

Local Template Pool The template store that resides on a Xerox device.

MIB Management Information Base. (Xerox products use Xerox proprietary MIBs)

MH /G3MH CCITT Group 3 Modified Huffman

MMR /G4MMR CCITT Group 4 Modified Modified Read

MRC Mixed Raster Content

NC Network Controller

Network Authentication Xerox device can be configured to

Network Fax / Fax Server Scanned images and related files are stored in a ‘fax repository’ (folder on the network). The fax repository is monitored by a fax server application that processes and sends the fax.

NSA Network Scanning Architecture [Xerox specification]

OCR Optical Character Recognition

ODO On Demand Overwrite (of device hard disk work space, a security feature)

PDF Portable Document Format

Remote Template Pool / Template Pool

A template pool that resides on a workstation or a server.

Repository A directory on the network where scan output files are stored.

SA/KO System Administrator / Key Operator

For the purpose of this document, assumed to be the person responsible for device configuration and setting.

Service A collection of functionality, i.e. an operation that may be performed on a document: e.g. print, scan, fax, file, email, etc.

Simple Template COM Interface

SSL Secure Sockets Layer

Template / Job Template A persistent format that contains the attributes of a job.


15

16


Template Pool A (network) folder that contains Job Template files. In common usage refers to the Remote Template Pool.

Third Party

Third Party Solutions

Third Party Applications or Agents

For the purposes of this document Non Xerox creator of software or hardware application solutions that make use of the Scan based capabilities of the Xerox device.

TIFF Tagged Image File Format.

Version / Release For the purposes of this document, “release” and “version” are both used to indicate Product Version, unless otherwise specified. For a tabular list of versions refer to the tables here below.

WCP Xerox WorkCentre Pro

XDCLibrary Refer to documentation with XDCLibrary SDK

XDCLibrary Refer to documentation with XDCLibrary SDK

XSM (Xerox Scan Manager) format File format used for filing scan images.

1.5 Related SDKs

References:

Title Parser SDK

Description JTL Parser for xst files.

Title SMTP Fax SDK

Description Provides a description of SMTP Fax implementation.

Title XDCLibrary SDK

Description Provides a dll and documentation for MFD management over SNMP.

Title Scan to Email SDK

Description Provides a description of the scan to email implementation.

Title Off Box Validation SDK

Description Provides an SDK to implement a web service that will provide off box validation at the time of network scan.

Title Template Management SDK

Description Provides an SDK to manage scan templates on MFDs.


17

87

88

89

90

18


2 Scan and Fax Services Functional OverviewScan services are optional features that must be purchased by the customer. These services have been specially developed to facilitate the integration of third party products, and the customization of the user interface for specific workflow requirements.

• Network Scanning transfers image files and control files to the network. Workflow programming is achieved through Xerox Scan Templates. When using Network Scanning as a workflow on-ramp, third party integrators may provide customized scan templates. Customized templates may require the user to enter metadata at the time of scan if required by the workflow. This user entered metadata may be validated prior to allowing the scan job to complete. Network Scanning supports a range of industry standard imaging and file formats.

• Fax (aka network fax or server fax) transfers image files and control files to the network. The scan and file parameters are restricted to industry standard fax requirements supported by server fax applications.

The graphics here below illustrate the basic processes.

2.1 Installation and enabling

The customer must purchase the appropriate hardware+software kit to obtain Network Scanning and Fax capabilities.

Once installed, these features are available for configuration and use. Optional features may have one of the following four states:

Unavailable = the machine hardware must be upgraded to support the feature.

Available = the machine hardware supports the feature, but the feature is not installed.

Enabled = the feature is installed.

Disabled = the feature is installed but the customer has disabled the feature through the Local UI.

If a device has both Server Fax and Embedded Fax installed, only one of them may be enabled at any given time. This selection may be made directly at the device LUI by an administrator.


19

91

929394

9596979899

100

101102

103

104

105

106107

108109

110

111

112

113

114115

116

117

21


2.2 Service setup and configuration

Scanning functionality as supported on this class of Xerox products is based on Xerox proprietary NSA [Network Scanning Architecture] and provides various integration points at different levels. Service setup and configuration is at the device level.

Scan job parameters can be pre-programmed and stored for re-use in the form of a scan template [xst file]. The remote Template Pool defines the off box location where scan templates are stored. The MFD is configured to point at this location and copy templates into the local hard drive (to the local template pool). This process is called Template Refresh or Update. An MFD supports a single Remote Template Pool, which may be shared by multiple applications. A specific Remote Template Pool may be shared by multiple MFDs. A walk up user may select an available scan template for use. The device will display up to 250 scan templates.

The network location to transfer the scan output to can be provided via a customized scan template, or the MFD must be configured. These network scanning destinations where the scan job output is transferred by the Xerox MFD are referred to as repositories. The application would monitor and process the network scanning output from this location. At the time of scan, the walk up user can select and add a preconfigured destination.

The typical Server Fax job is a particular Network Scanning job. (There are no templates or template pool to be configured.) The Fax Repository defines the folder where server fax jobs would be transferred by the MFD. The server fax application would monitor this location.

2.3 Network scan job pre-configuration

The next level of pre-configuration is at the individual scan template level. This corresponds to the job level. The scan template can be customized to meet application workflow requirement. The scan template defines the imaging and file transfer parameters, and additional settings including metadata and metadata validation..

At the MFD, the user selects from a list of named templates. Selecting a template at the local UI results in populating the LUI fields with the values defined within the template. The user will have the option to change some of the pre-configured values at the device LUI. The user can also enter metadata from the device LUI at the time of scan, if programmed in the scan template.

Details on scan templates are in the section on Scan Templates and Job Logs.

No scan templates are available for Server Fax.

The Scan Template Management API/SDK can be used to provide a service that will store and manage scan templates directly on the device.

2.4 Scan Output- File Transfer, Image and Control files

The protocol services supported by the Xerox MFD for depositing scan images on a remote server are:

• FTP• SMB• HTTP (requires script)• HTTPS (requires script)• NCP (NetWare Only) for both IP and IPX

The devices respect a co-operative mechanism called ‘Directory Locking’ to ensure non-contention during file transfer in a shared environment. Applications integrating with Scan to Network File and Server Fax must support Directory Locking.


22

118

119120121

122123124125126127

128129130131

132133134

135

136137138

139140141142

143

144

145146

147

148

149150151152153154155156157

23


Xerox MFDs include monochrome and color scanners and produce TIFF, JFIF-JPEG or PDF formats. Within the Xerox NSA framework, the scan output may consist of image files and control files. An optional control file for network scan is the job log. The job log is always provided for Server Fax. The job log is a modified form of the scan job template. The Job Log is different from the original job template in that the results of the scan service step will be reflected in the file. The job log can also contain other context sensitive data such as the authenticated user login, and any metadata entered by the user. Third-party applications can then use the job log to perform subsequent workflow processing.

The Parser SDK is used to read job log xst files. Server fax applications must retrieve the fax job parameters from the job log. In the case of Network Scan, the template may specify that the walk up user can enter information at the device LUI, at the time of scan. This information is written to the job log as metadata.

2.5 Partner application integration opportunities

The table and graphics here list the sequence of the network scan and server fax jobs with in integration requirements and applicable SDKs.

Table 1: Scan/Fax process tasks

[user, admin, application, network servers]

Required and Optional scan/fax tasks

Network Scanning Server Fax

1. Required set MFDs1 Application administrator must identify the MFDs to configure.

Application administrator must identify the MFDs to configure.

2. Required configure MFD

Network scan configuration options include template pool, repository and scan template configuration. Not all configurations are required. Service configuration can be achieved by using the XDCLibrary SDK. Job configuration is a custom scan template.

Application must set the Fax Repository. Service configuration can be achieved by using the XDCLibrary SDK.

3. Optional- access controls – JBA & Network Authentication

Walk-up user may be required to authenticate to access the service.

Walk-up user may be required to authenticate to access the service.

4. Required user input Select Template Enter / select phone number

5. Optional user input and external services

User may make changes to pre-configured settings and enter metadata. Validate user entered metadata.

The user may change settings and specify a time to fax.

6. Required file transfer

Device transfers the scan output to the location specified. If an xst file was requested then it will be included. The xst file contains the job setting, and any metadata the user may have entered entered. Application must support MFD file transfer process.

Device transfers single page TIFF and XST file in an XSM folder to the server fax repository location. The xst file contains the fax parameters. Application must support MFD file transfer process.

7. Required Scan output picked up and processed by partner

Partner application tasks range from moving only the image file to manipulations on both the image and xst files with numerous

Fax server reads the fax job settings from the xst file and faxes the image. Fax server

1 At this time there is no automated device discovery tool.


24

158159160161162163164

165166167

168

169170

171

172

20

25


Required and Optional scan/fax tasks

Network Scanning Server Fax

application. combinations in between. Use the Parser SDK to support scan job log files (.xst files).Use the Metadata Validation API/SDK to increase reliability of user input at the time of scan.

writes fax confirmation, transmission report etc.

With respect to the application, configuration is a startup task, a one-time task. The polling phase is run time and a continuous loop. The numbers used in the following diagrams correspond to the task numbers in the above table.


26

173

174175

176

177178

27



28

179

29


2.5.1 MFD configuration options

Figure 1: Network Scan Case 1

If the scan application server is co-located with the scan template pool and the scan destination for one or multiple MFDs, the integrations options are:

• An administrator would specify the MFDs, and confirm the folders for template pool and repository (scan destination).

• Using the XDCLibrary SDK the application may programmatically configure the MFDs template pool. An alternative would be to provide instructions for an administrator to manually configure the Xerox MFDs via the Web browser.

• Using the Scan Fax SDK and the Parser SDK the application may generate the required custom template(s), and transfer it to the template pool. Using the XDCLibrary SDK the application may refresh templates at the MFDs. When the scan destination is specified in the custom scan template, then no repository configuration is required on the device. One alternative would be to use the Template Management API/SDK to manage a custom template directly on each device, and not use template pool at all. Another alternate would be to provide a static template with directions for an administrator to manually configure the MFDs via the Web browser, and transfer the template. Users can be directed to refresh the templates before scanning at the LUI.

• Using the Metadata Validation API/SDK the application may validate user entered metadata.

• The scan application will monitor the scan destination / repository for the scan output to process.


30

180

181182183

184185

186187188

189190191192193194195196

197198199

31


Figure 2: Other network scan configurations

A scan application can monitor multiple MFDs, multiple template pools and multiple scan repositories [scan destinations] as can be seen from the above configurations.


32

200

201202

33


Figure 3: Server Fax configuration

A Server Fax application should:

• Accept a list of MFDs to configure.

• Use the XDCLibrary SDK to configure the Fax Repository on each MFD.

• Monitor the Fax Repository for outgoing faxes.

• Read the .xst scan job log file using the Parser SDK to parse the fax number, fax time, device IP address, authenticated user login and any other data.

• Be able to print a fax confirmation sheet to the MFD IP address.

• Support printing to the MFDs with Job Based Accounting enabled.

2.5.2 Required integrationAn application must provide a supported method of Xerox MFD service configuration. Minimally this could be steps documented for an administrator to apply manually to each MFD via the device Web UI.

Repository management is a requirement for all applications integrating with network scan / server fax. Some devices require the default repository to be set before the network scan service may be available to the walk up user.

An application integrating with network scanning may provide means to edit a custom scan template, configure the template pool, and refresh templates. Or steps to manually edit a custom scan template from the device web UI.

If an application integrating with network scanning provides a custom scan template without all file transfer details, the application must configure the default repository on the device with the file transfer details, or provide instructions for manual configuration by the device admin.

Server Fax applications must process the scan job log for various parameter values.

Server Fax applications must support printing fax confirmations back to the device where the fax job was scanned from. Server Fax applications must support printing incoming faxes to the Xerox MFDs. Server Fax applications must support printing to the Xerox MFDs in a Job Based Accounting environment.

An application integrating with network scanning must also provide a list of supported Xerox MFD and scan job settings, if they do not support the full range available.


34

203204

205206207208209

210211

212213214

215216

217218

219220221

222

223224225

226227

35


2.5.3 Recommended integrationIt is recommended that applications integrating with Network Scanning and Server Fax use the Parser SDK.

These applications can add ease-of-use value by using XDCLibrary SDK to support the MFD management aspect of a workflow.

Additional reliability can be gained by implementing Metadata Validation API/SDK.


36

228229

230231

232

39


3 Device Level Configurations The current set of device level configurations is described here. These device web UI and device LUI configurations require an administrator login and password, and must be manually set for each individual device. Refer to XDCLibrary SDK for the SNMP based programmatic interface.

Workflow and template level settings are detailed in section 4 Scan Templates and Job Logs. It will be pointed out that some settings are available at both levels. With device cloning available in the WCP line, configurations may be saved in a file and applied to another WCP at the same software level, via the web browser session.

It is recommended that applications managing device configurations programmatically should notify the administrator or log device configuration changes.

The following table summarizes some key capabilities of Network Scanning.

Table 2: Key scanning capabilities across models

STM

& O

BV

Met

adat

a Remote Template Refresh

Template Pool and/ or Repository

SMB

FTP

HTT

P/S

Authenticated User data in

xst

Col

or S

can

JBA

dat

a in

xst

Logi

nSou

rce

Serv

er F

ax

DC220/230/332/340/420/426ST

DC240/255/265

DC432/440ST

DC425/430/432/440ST 3.x and higherDC460/470/480/490ST 19.2.x and higher

DC535/545/555

DC535/545/555 0.20.53.0 and higher

WCP [except those here under]

WCP 32 /40 / 2128 / 2636/ 3545 Color

WCP 123 / 128 / 133Xerox 4110 / 4590

WCP 232 / 238 / 245 / 255 / 265 / 275

WC 7132 / 7228 / 7235 / 7245

WC 7655 / 7665

WC 4150

3.1 Network Scanning Setup

3.1.1 Image SettingSome, devices set certain properties for PDF and color TIFF formats at the device level.


40

233

234235236

237238239

240241

242

243

244

245

246247

41


PDF properties include: enable Fast Web Viewing, optimize for mixed images, optimize for uniform text.

Color TIFF properties include: TIFF TTN2.

See.Appendix B.

3.1.2 Template Pool SetupTemplate pool can be configured via XDCLibrary SDK and the Device Web UI.

If the application will integrate via custom scan templates placed in the remote template pool then use these settings. The relationship between device, template pool and application necessitates team work among applications.

• A device may be configured for a single remote template pool only.

• Multiple devices can refer to the same remote template pool. There is no known limit.

• Multiple applications can refer to the same remote template pool. There is no known limit.

This group of settings specifies the protocol to be used for copying templates and network location of the remote template pool. The MFD LUI displays up to 250 templates [from the local and remote template pools] at the local UI, in alphabetic order. The system caches the content of the template pool on the local hard drive.

If a device template pool has not been set, an application may select to set it.

If a device template pool is already set, an application should use the existing template pool.

It is recommended that an application using a shared remote template pool be sensitive to templates it owns as well as other templates.

Table 3: Template Pool and Repository settings

SETTABLE VALUE

DEFAULT VALUE

ASSOCIATED FILING PROTOCOL

RANGE/SYNTAX

COMMENTS

Friendly Name[For repositories only. Not for Template Pool]

Null FTP, NCP, SMB, HTTP, HTTPS

0-64 characters • Optional field for all configurations.• Supported characters: printable ISO

8859-15.

Server Name Null NCP 1-255 characters • Required field for NCP (Bindery and NDS) configurations.

• Supported characters: ASCII 32 - 42, 44-62, 64-95, 97-126

Server Name (IP Address)

0.0.0.0 FTP, SMB, HTTP2, HTTPS

0 bits – 30 bits, (0.0.0.0) – (255.255.255.254)

• Required field for FTP configurations if a DNS Host Name has not been specified.

• Required field for SMB configurations if a NetBIOS Host Name has not been specified.

• Required field for HTTP/S configuration if a Host Name has not been specified.

Server Name (Host Name)

Null FTP, HTTP, HTTPS

1-255 characters • Required field for FTP configurations if an IP Address has not been specified.

• Supported characters: ASCII 45, 48-57, 65-90, 97-122

2 All references to HTTP and HTTPS implementation introduced with WCP 2xx refer to XRXHTTP and XRXHTTPS as described in the Attribute Manual.


42

248

249

250

251252

253254

255256257258259260

261

262

263264

265

3738

43


SETTABLE VALUE

DEFAULT VALUE


RANGE/SYNTAX

COMMENTS

Server Name (NetBIOS Host Name)

Null SMB 1-255 characters • Required field for SMB configurations if an IP Address has not been specified.

• Supported characters: ASCII 33,35, 37 - 63, 65 - 123, 125

Port Number 2113980443

FTPSMB HTTPHTTPS

5 digits, 1-65535 • Required field for FTP, SMB and HTTP/S configurations.

Volume (Share Name)

Null SMB 1-127 characters • Required field for SMB configurations.• Supported characters: 33, 35-63, 65-123,

125. Volume Null NCP 0-255 characters • Required field for NCP (Bindery)

configurations (if NDS Context and NDS Tree are not specified).

• Supported characters: ASCII 32-42, 44-62, 64-95, 97-126.

Path Null FTP, NCP, SMB, HTTP, HTTPS

0-255 characters • Required field for all configurations but the field may be blank.

• Supported characters: ASCII: 32 (NCP only), 33, 35, 37-42, 44-62, 65-123, 125.

Filing Protocol FTP FTP, NCP, SMB, HTTP, HTTPS

NA • NA

Login Source[For repositories only. Not for Template Pool]

SYSTEM FTP, NCP, SMB, HTTP, HTTPS

USERLOGINPROMPTNONESYSTEM

• Allows the SA to choose if the login access to the repository uses the system login name and password, the authenticated user’s name and password, or if the system should prompt the user to enter the login name and password. None (no credentials) is given as an option for HTTP and HTTPS repositories.

• Requires Network Authentication configuration.

Login Source[For template distribution repositories without LoginSource specified]

NONE FTP, NCP, SMB, HTTP, HTTPS

USERLOGINPROMPTPROMPT_IF_NECESSARYNONE

• The template may or may not contain its own Login Source, allowing an independent choice of user credentials, Prompt, None, and Prompt if Necessary.

• Requires Network Authentication configuration.

Login Name Null FTP, NCP, SMB, HTTP, HTTPS

1-255 characters • Required field for all configurations, only if the Login Source is System Credentials. May be blank for HTTP and HTTPS configurations.

• Supported characters: ASCII: 32, 33, 35-126.


44

45


SETTABLE VALUE

DEFAULT VALUE


RANGE/SYNTAX

COMMENTS

Login Password Null FTP, NCP, SMB, HTTP, HTTPS

0-64 characters • Required field for all configurations only if the Login Source is System Credentials, but the field may be blank.

• Supported characters: ASCII: 32, 33, 35-91, 93-126.

• Device can mask this value.• Passwords are stored encrypted and will

not be returned by the MFD in clear text.NDS Context Null NCP 0-255 characters • Required field for NCP (NDS)

configurations (if Volume is not specified).

• Required field if NDS Tree is specified.• Supported characters: ASCII 32-42,

44-62, 64-95, 97-126.NDS Tree Null NCP 0-255 characters • Required field for NCP (NDS)

configurations (if Volume is not specified).

• Required field if NDS Context is specified.

• Supported characters: ASCII 32-42, 44-62, 64-95, 97-126.

Script Name/Location

Null HTTP, HTTPS 1-128 characters • Required field for HTTP and HTTPS configurations.

• A script is required to support XRXHTTP/XRXHTTPS implementation in a manner similar to the other file transfer protocols supported by Xerox MFDs.

• A sample script is available in the Attribute Manual.

Validate SSL Certificate

FALSE HTTPS TRUE, FALSE • HTTPS server must be identified by FQDN if this value is TRUE and must have a valid certificate that may be verified.

3.1.2.1 Template Refresh Time

Template Refresh Time can be configured manually via the Device Web UI.

This setting allows the application to specify a time when the system will refresh its local copy from the remote template pool, once a day. The walk-up user can always refresh at the device LUI.

SETTABLE VALUE DEFAULT VALUE RANGE

Template Pool Refresh Time 00:00 w/ 24hr clock; 12:00am w/ 12hr clock.

00:00-23:59 or 12:00am-12:00pm

3.1.2.2 Remote Template Refresh function

This event can be triggered programmatically using the XDCLibrary SDK and manually at the Device Web UI.


46

266

267

268

269270

271

272

273

47


WCP support Web UI refresh and programmatic refresh. The user can explicitly initiate a refresh of the local copy at the local UI or via the Web UI.

If an application is unable to ensure the programmatic refresh, the walk up user must be instructed to refresh templates at the device LUI prior to selecting a template.

3.1.3 Repository SetupRepositories can be configured via XDCLibrary SDK and manually at the Device Web UI.

Once the network scanning option has been installed and enabled on a device, a default repository must be configured in order for the network scanning service to be available at the device LUI. The default repository is used when a repository has not been specified in the selected template.

The system allows the configuration of the default repository and up to 4 alternate repositories for network scanning. Each repository can be on a separate server with unique Operating Systems and Filing Protocols. These repositories are available as selectable destinations for scan templates defined via the device Web UI. These destinations may also be available to the user at the local UI for selection at the time of scan.

Each repository setting consists of a group of configurations that determine the network location, filing protocol and user login for a specific file transfer. Refer to Table 3: Template Pool and Repository settings.

File transfer setting may be supplied in a scan to file template as well. The repository defined in a template does not have to be set up as the default or as an alternate repository in the device configuration.

If the application integration is to a single folder, then one option is to set the default repository only. The workflow may use the MFD’s default template, which will use the default repository setting. Another option is to supply a custom template, without file transfer parameters, which would then use the configured default repository.

If an integration is more dependant on settings such as image format and scan processing, then it is recommended to supply custom templates. The file transfer parameters may be supplied within the custom template itself. See details in section 4.3.4 Xrx_svc_file.

3.1.4 Include authenticated username in scan job logThis optional function can be enabled programmatically via XDCLibrary SDK and manually at the Device Web UI.

This setting defines whether or not Network Authenticated [see section 3.4.1 Network Authentication] user login and/or domain values should be written to the job log xst file. If the application will use such job and context data, then enable this setting. If this setting is enabled, and the Network Authentication service itself is not enabled at the time of scanning, then the attribute will be present in the xst file, but will have null value.

The table here under lays out the behavior expectations based on the state of these settings.

Table 4: Authenticated username in scan job log

NETWORK AUTHENTICATIONENABLED

GUEST AUTHENTICATIONENABLED

NO AUTHENTICATION

Job log to contain User Name Only

NetworkUsername is included in the job log (.xst) and populated with the user name (e.g. “jdoe”).

NetworkUsername is included in the job log (.xst) and populated with “Local User”.

NetworkUsername is included in the job log (.xst) and populated with a null string.

Job log to contain Authentication Provider Only

NetworkUsername is included in the job log (.xst) and populated with the authentication provider (e.g. “usamc”).




48

274275

276277

278279

280281282

283284285286

287288

289290

291292293

294295296

297298

299300301302

303

304

49


Job log to contain User Name and Authentication Provider

NetworkUsername is included in the job log (.xst) and populated with the user name and authentication provider (e.g. “usamc/jdoe”).



Job log to not contain user info.

NetworkUsername is not provided in the template.



3.1.5 Confirmation SheetConfirmation sheet printing can be configured manually via Device Web UI. It can also be configured at the device LUI with administrator password.

A network scanning confirmation sheet is a sheet printed at the MFD, after completion of a network scanning job which details the status – success or failed – of the particular job, along with some other job details such as image settings and destination.

This setting defines when scan confirmation sheets should be produced by the device - only when an error occurs, always or never. The device produced scan confirmation sheet is not directly used in any workflow integration. It may be used for troubleshooting purposes.

3.1.6 Default TemplateAt a device level, the default template can be configured manually at the Device Web UI.

The default template specifies the default values for the scan pathway when no template has been selected. It is also used to populate fields not explicitly defined in a selected template. The original instance of the default template on the local hard drive cannot be manipulated in older devices, but can be edited using the Scan Template Management API (see the Scan Template Management SDK for information on how to do so).

Depending on the MFD certain values of the default template may be configurable. These configurations are used as a basis for new scan templates created at the device web UI or through the STM service. The default template is always available for selection at the device UI.

An integration path is to set some scan setting in the default template, and use this for a workflow along with the default repository configuration.

For the factory default settings refer to Appendix C.

3.2 Server Fax Setup

3.2.1 Fax Repository configurationThe fax repository can be configured via XDCLibrary SDK and manually at the Device Web UI.

The basic settings are similar to network scanning repositories. Refer to Table 3: Template Pool and Repositorysettings.

In addition to the file transfer protocols supported by other repositories and the template pool, the fax repository can also be configured to use SMTP. Use the SMTP_Fax SDK for this integration.


50

305306307

308309310

311312313

314315

316317318319

320321322

323324

325

326

327328

329330

331332

51


3.2.2 Include authenticated username in scan job logThis setting defines whether or not Network Authenticated [see section 3.4.1 Network Authentication] user login and/or domain values should be written to the job log xst file.

For setting details refer to section 3.1.4 Include authenticated username in scan job log.

3.2.3 Confirmation SheetConfirmation sheet printing can be configured manually via Device Web UI. It can also be configured at the device LUI with administrator password.

A confirmation sheet is a sheet printed at the MFD, after completion of a server fax job which details the status – success or failed – of the file transfer to the server fax destination. This is not a fax confirmation sheet. The fax confirmation sheet is the responsibility of the fax server application.

This setting defines when server fax confirmation sheets should be produced by the device - only when an error occurs, always or never. This device produced confirmation sheet is not directly used in any workflow integration. It may be used for troubleshooting purposes.

3.3 Secure workflows

The WCP 2xx series can be configured to meet secure workflow requirements. Listed here are some required and optional settings for increased security and encryption.

3.3.1 Proxy ServerProxy server can be configured via the Device Web UI.

Proxy server configurations will apply to transactions for Remote Template Pool and File Repositories using HTTP(S), where required. Either the proxy server IP address or Host Name must be supplied. The default port number is 8080.

3.3.2 SSLSSL can be enabled via the device web UI. All the SSL configurations must be completed manually via the device web UI. Remote detection of the enabled / disabled state of SSL can be done via the XDCLibrary SDK.

When SSL is enabled, the web UI will use HTTP over SSL. When doing so, the URLs for accessing the device must be changed to use HTTPS as the protocol rather than HTTP (e.g. https://device.url/). (If using “http” as the protocol, the client will receive a redirect to the proper location. This redirect will work for browsers, but not necessarily for other applications.)

Using SSL for the web UI does not affect template pools or repositories. Template pools and repositories can use HTTP or HTTPS according to their configuration, independently of the setting for the web UI.

SSL can use a certificate signed by the device, or a certificate signed by an external authority. To generate a certificate signed by the device, select to generate a self signed certificate; for a certificate singed by an external authority, generate a certificate signing request. When the request is signed, the signed certificate can be uploaded to the device.

3.3.3 IP SecIPSec can be enabled and a shared secret can be configured via the device web UI. The shared secret must be copied to clients and servers on the network to enable secure communication.


52

333334335

336

337338339

340341342

343344345

346

347348

349350

351352353

354355356

357358359360

361362

363364365366

367368369

53

https://device.url/


Once an IPSec channel is established between two points, it stays open until the network connection is lost, for example if one end (MFD) reboots or goes into power saver. Only network clients and servers will have the ability to establish an IPSec tunnel with the MFD, the device will neither establish nor re-establish a secure connection if it is lost.

3.3.4 Trusted Certificate AuthoritiesSigned certificates can be uploaded to the MFD. The device generic certificate can be downloaded.

To restrict HTTPS access to specific template pools or repositories, upload the server certificate for each trusted server. (To use the trusted server list, the template pool and/or repository access protocol must be HTTPS.) To restrict access on the server, down load the device certificate and use it.

Instead of individual certificate management in an enterprise environment, it is recommended to use an external signing authority for all trusted servers, and upload the signing authority certificate to the devices and to the repository and pool servers.

3.4 Other device level configurations

The configurations described here directly affect and influence Network Scanning and Server Fax. However they are not tasks customarily relegated to document management or server fax applications. This information is presented for application documentation purposes. If there are configurations which are critical to the full functionality of the integrating workflow, then the application administrator guide and user guide must highlight the specific configuration requirements in a note.

3.4.1 Network AuthenticationThe MFD can be configured to require a user login prior to entering any of the scan services pathways. (i.e., network scanning, server fax) When enabled, the user login name for scan to file and network fax jobs can be entered into the scan job log. Network authentication can be configured programmatically via XDCLibrary SDK and manually at the Device Web UI. This service can be enabled / disabled at the device LUI with administrator access.

For platforms supporting LoginSource, the authenticated user credentials may be used for network scan to file transfers.

When the network authentication information is recorded in the job lob, the job log will contain the user login and the domain. The application may query the domain for further details on the user, such as email address, etc. Listed here below are the supported systems.

Table 5: Network authentication supported systems

Operating System Selected Available Authentication Type

Windows 2000 Kerberos / SMB

NT 4.0 SMB

Novell 4.x/5.x NDS

SUN Solaris Kerberos

The enablement of this service affects these other settings: 3.1.4 Include authenticated username in scan job log, 3.2.2 Include authenticated username in scan job log and 3.4.2 Off-Box Validation Option.


54

370371372373

374375

376377378

379380381

382

383384385386387

388389390391392393

394395

396397398

399

400401

55


3.4.2 Off-Box Validation OptionThis applies only to metadata in Network Scan. This option can be configured via Device Web UI. This option cannot be configured via the XDCLibrary SDK. The status of Off Box Validation, enabled or disabled, can be gathered via the XDCLibrary SDK.

Configurations via the Device Web UI are used for job level settings while creating Web UI templates.

Offbox validation will provide metadata parameters to an external server for validation that the information entered by a walk-up user is correct. If the server replies that the information is not correct, or if the server is not available, the user will not be allowed to proceed. The purpose of this feature is to reduce long-term costs associated with incorrect data entry of metadata.

When offbox validation is enabled, the device can be configured to export the Authenticated user login with validation request. This will apply to off-box metadata validation transactions. If network authentication is not enabled, then the name will not be available.

See the Offbox Validation SDK for more information about offbox validation and directions for providing an off box validation service.

3.4.3 Include job based accounting data in scan job logThis applies equally to network scan job logs and server fax job logs. No separate setting is required. The JBA service must be enabled and configured.

The status of JBA service, enabled or disabled, can be gathered via the XDCLibrary SDK. A JBA application must have configured the JBA service. There are administrator settings at the device LUI to enable and disable JBA.

If JBA is enabled and configured, and the walk-up user has authenticated to access the network scan or server fax then the JBA data will be included in the scan job log.


56

402403404405

406

407408409410

411412413

414415

416417418

419420

421422

58


4 Scan Templates and Job LogsScan templates provide a convenient way to preprogram common scan to file tasks. Templates are formatted text files that define workflow requirements and network scanning attributes for a job. Scan templates can be created

• via the device’s web UI [CentreWare Internet Services],

• or using the Parser SDK,

• or through a third party tool.

Templates created through the device’s web UI are stored on the device’s hard drive and are limited to defining only the services directly supported by the device web UI.

Templates created by the Parser SDK and other tools can define a more customized work sequence. These templates can be stored in a remote template pool and shared by any WCP/DCS on the network.

After a template is created, it can be stored in an external template pool, or can be stored directly on a specific MFD using the Scan Template Management SDK. (See the Scan Template Management SDK for more information about using it to store templates on a device.)

Selecting a template at the local UI results in populating all fields with the values defined within the template. The user has the opportunity to edit certain template settings at the device LUI.

The default template and repository values are used when a template does not supply all the required parameters to complete a scan job. Refer to the Appendix for a listing of default values supported across devices.

4.1 Customizing the UI for your workflow

The mechanism available to customize the local UI to meet a workflow’s specific requirements is the scan template. Templates can have the appropriate repository and scan parameters to perform specific tasks such as archiving shipping invoices, scanning forms for download into a forms processing application, or distributing documents to regional offices. Templates can be named to identify the task to be performed in order to make selection of the template more intuitive. (e.g., “Archive_invoices, “Forms_download”, “Office_Distribution”). Third party applications can provide tools to create and upload customized templates that have user, job or application specific information in them using the Parser SDK and XDCLibrary SDK.

The Parser SDK provides a C-language based programmatic interface to decode and encode .xst files (i.e., job log and template files). The Parser SDK is available for download on the Xerox Business Partner web site. Vendors are encouraged to use the Parser SDK to create and parse .xst files as properly parsing the file can be quite involved. The Parser SDK will properly handle the various permutations of entries within the .xst files and will ensure that a properly formatted .xst file is produced.

For ease of maintenance, templates shared across multiple devices should be stored in a template pool that all of the devices point to. Another option is to store scan templates directly on the device; see the Scan Template Management API/SDK for more information.

You can create a template from scratch or modify an existing template to produce the template that you need. If starting from an existing template, it is recommended that you start with the common.xst template described later in this section. This template has been verified to work on all devices and is therefore a good place from which to start.

See section 4.3 Base template – common.xst.


59

423

424425

426427428429430

431432

433434435

436437

438439

440

441442443444445446447

448449450451452

453454455

456457458459

460

60


4.2 Xst file Structure

Job templates are text files written using the job template language (JTL). They are typically 1K to 10K bytes in size.

Template file format is required to be in any of the ISO-8859 single-byte encoding, such as ISO-8859 -1 or ISO-8859 -15. This includes all of the Latin- character encodings as well. Multi-byte character encodings, such as UTF-16, Unicode, and UTF-32 are not allowed.

UTF-8, UTF-16, and Unicode files are not allowed. These files record additional information at the beginning of the file that indicates the format for the rest of the file; these characters are not ignored by the template parser and will cause the template to be rejected by the device.

Characters to be displayed on the LUI, must be within the ASCII character range. Current behavior is that displayed characters are assumed to be in Latin-1, but this behavior may change in future devices.

4.2.1 File NameThe file names of templates are required to be in the ASCII character set, or Latin-1 character codes up to 127. Other template file names will not be displayed properly by the local UI on the device.

The filename following DOS convention and <8 characters>.<xst> name is supported across all devices3. Current devices support a 24 character string, including 4 character extension. The Local UI displays file names using a proportional font; depending on the characters used, about 20 characters of the filename will be visible.

For selection of a template, the file name is presented to the walk up user in a drop down pick list. The file names are listed in alphabetic order.

4.2.2 Service names and entriesAll Xerox-defined service names and entries are in ASCII, or in the base set for any of the ISO 8859 encoding. Xerox-defined services do not support user-defined or partner’s custom attributes.

Unsupported service types containing user-defined attributes may exist in a job template file. Such services are ignored by the device. For partner’s custom services, the service name can be any string using the encoding of the template file.

NOTE: Confirm with Xerox SDK Engineers there is no potential conflict BEFORE implementing ANY NEW CUSTOM SERVICE OR ATTRIBUTE.

A template consists of a series of service invocations and object instances. Service invocations define the services (e.g., scan, file, fax) that should be performed for this job. A template file contains the following main sections:

• Xrx_svc_general – Provides general information about the job template and job.• Xrx_svc_scan – Defines parameters on how the physical document should be scanned.• Xrx_document – Defines the output.• Xrx_svc_file – Defines parameters for where to file the document.• Xrx_svc_fax – This optional section defines parameters for where to fax the document.• Xrx_dscrpt_metadata – This optional section defines any metadata fields for the job. If this job does not

require metadata entry, this section will not appear• Xrx_svc_validation – This optional section provides validation server details.

The following sections are contained in job log files only:• xrx_dscrpt_accounting – Lists the JBA data.

3 Some earlier releases are case sensitive.


61

461

462463

464465466

467468469

470471

472473474

475476477

478479

480481482

483484485

486487

488489

490491492493494495496

497498499

500

57

63


4.2.3 Service invocation names Service invocation names are rarely used, and when used are usually numbered (except for the job log from the results of a build-job). When used, these names must be in ASCII, or in the first 127 characters of the ISO-8859 encoding used to create the template.

4.2.4 Attribute names and valuesAll Xerox-defined attribute names and attribute values are in ASCII, or in the base set for any of the ISO 8859 encodings. Except as noted below, string values are expected to be in ASCII or the first 127 characters of the ISO-8859 encoding used for the file. Dates are expected to be in the format MM/DD/YYYY unless otherwise noted in the Scan_Fax SDK. Numbers are expected to contain no separators other than a decimal point for floating-point values.

For partner’s custom services, the attribute names and values can be any string using the encoding of the template file. Attributes are defined within an invocation of a service or instance of an object. Each attribute has a type, a name that is unique within the invocation or instance, and a set of values. An attribute is analogous to a named constant. For a listing of the currently defined template attributes, refer to the Scan Attributes Manual.

4.2.5 Compulsory AttributesA compulsory attribute is an attribute within the template that can not be modified by the device or the walk-up usre. For example, in a scan resolution is request of 1200x1200 dpi and the device cannot perform a 1200x1200 dpi scan, then the device will modify the resolution to its default resolution; however, if the attribute is compulsory, then the job will fail.

A template creator may designate a template attribute as non-compulsory by preceding the attribute name in the template with an asterisk ‘*’. If an attribute is designated as non-compulsory or if the JobTemplateLanguageVersion is less than 4, or if the device is older than WCP 2xx, the walk-up user is allowed to modify the attribute. On earlier devices, the preceding asterisks are ignored.

The impact of compulsory attributes is that platforms supporting compulsory attributes will not substitute a supported value for non-supported values in a template. Templates with unsupported values will either not be selectable at the device LUI or will fail. On devices where compulsory attributes are not supported, the system would substitute a supported value and the template would be available for selection at the device LUI.

Attributes supporting compulsory:

• DocumentObjectName, • DocumentFilingPolicy, • DocumentFormat, • CompressionQuality and • Resolution

Compulsory attribute may be used in cases a particular attribute value is critical to a workflow.

4.2.6 Sample scan template and logThe following is a sample job template called “sample.xst” that will create a multi-page TIFF file called “MyDoc.tif” that will file to the FTP server at 10.10.10.10 in the directory /MyScanDir. It has a single metadata field called “Account #” which will default to the value “1234”.[service xrx_svc_general] { enum_DCS DCSDefinitionUsed = DCS_GENERIC; string JobTemplateLanguageVersion = "2.03.08"; enum_encoding JobTemplateCharacterEncoding = ASCII; enum_confmethod ConfirmationMethod = PRINT; enum_confstage ConfirmationStage = AFTER_JOB_COMPLETE; string JobTemplateDescription = "Sample Template"; string JobTemplateName = "sample.xst";


64

501502503504

505506507508509510

511512513514

515516517518519

520521522523

524525526527

528

529530531532533534

535536537538539540541542543544545546547

65


string JobTemplateCreator = "Xerox"; }end

[service xrx_svc_scan] { enum_sided SidesToScan = ONE_SIDED; enum_mediasize InputMediaSize = AUTO; enum_imagemode DocumentImageMode = TEXT; integer CompressionQuality = 0; enum_colormode ColorMode = BLACK_AND_WHITE; enum_autoexposure AutoExposure = LEAD_EDGE; struct_magnification Magnification = NONE; struct_borders InputEdgeErase = 0/0/0/0/IN; integer Darkness = 0; integer Sharpness = 0; integer Contrast = 0;}end

[doc_object xrx_document] doc_1{ enum_resolution Resolution = RES_300X300; enum_outputsize OutputImageSize = SAME_AS_ORIGINAL; enum_docformat DocumentFormat = XSM_TIFF_V6; string DocumentObjectName = "MyDoc"; enum_halftonemethod HalftoneMethod = ERRORDIFFUSE; enum_halftonescreen HalftoneScreen = AUTO; }end

[service XRX_SVC_FILE] file_1{ boolean ServiceEnabled = TRUE; enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE; string RepositoryAlias = "Partner"; string DocumentPath = "/MyScanDir"; string RepositoryName = "10.10.10.10"; string UserNetworkFilingLoginName = "FTPUsername"; string UserNetworkFilingLoginID = "FTPpassword"; enum_filingprotocol FilingProtocol = FTP;}end

[description xrx_dscrpt_metadata] entry_1{ string MetaDataFieldName = "Field1"; string MetaDataPrompt = "Account #"; string MetaDataType = "string"; string MetaDataDefaultValue = "1234"; string MetaDataValue = ""; }endThe job log is a modified form of the job template that is stored with the scan images in the document repository for scan to file and scan to fax jobs. The Job Log is different from the original job template in that the results of the scan service will be reflected in the file. Flowport or other third-party applications can then use the job log to perform subsequent workflow processing. The job log is different from the job template in the following ways4:

• It contains the status of each service step. (e.g., completed)• It contains the attribute values that a service has used to process the request. (e.g., the actual scan

programming attributes used, the actual DocumentObjectName used)

• It contains user input values entered at the UI. (e.g., any metadata values or the fax phone number)

• If network authentication is enabled on the device, it contains the logged in user name.

4 Specific job log details may vary depending on model and device software release.


66

548549550

551552553554555556557558559560561562563564565566

567568569570571572573574575576577

578579580581582583584585586587588589590

591592593594595596597598599600

601602603604

605606607

608609

62

67


The job log will have the name <DocumentObjectName>.xst. The DocumentObjectName is the value from the job template and matches the “Document Name” value specified when the template was created.

A sample job log which matches the sample job template is shown below. The modified items are highlighted.[service xrx_svc_general] { enum_DCS DCSDefinitionUsed = DCS_GENERIC; string JobTemplateLanguageVersion = "2.03.08"; enum_encoding JobTemplateCharacterEncoding = ASCII; enum_confmethod ConfirmationMethod = PRINT; enum_confstage ConfirmationStage = AFTER_JOB_COMPLETE; string JobTemplateDescription = "Sample Template"; string JobTemplateName = "sample.xst"; string JobTemplateCreator = "Xerox"; string NetworkUsername = "adv.sol.xerox.com/tpatil"; string ServiceDefinitionUsedVersion = "less_2.S01.00.60.3.tgz:IntelInside:lynx:0.S01.00.60.3:03/25/2003"; }end

[service xrx_svc_scan] file_1 { boolean ServiceEnabled = TRUE; enum_sided SidesToScan = TWO_SIDED; enum_mediasize InputMediaSize = AUTO; enum_imagemode DocumentImageMode = TEXT; integer CompressionQuality = 0;

enum_colormode ColorMode = BLACK_AND_WHITE; enum_autoexposure AutoExposure = LEAD_EDGE; struct_magnification Magnification = NONE; struct_borders InputEdgeErase = 0/0/0/0/IN; integer Darkness = 0; integer Sharpness = 0; integer Contrast = 0;}end

[doc_object xrx_document] doc_1{ enum_resolution Resolution = RES_300X300; enum_outputsize OutputImageSize = SAME_AS_ORIGINAL; enum_docformat DocumentFormat = XSM_TIFF_V6; string DocumentObjectName = "MyDoc"; enum_halftonemethod HalftoneMethod = ERRORDIFFUSE; enum_halftonescreen HalftoneScreen = AUTO; }end

[service XRX_SVC_FILE] { enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE; string RepositoryAlias = "Partner"; string DocumentPath = "/MyScanDir"; string RepositoryName = "10.10.10.10";

string UserNetworkFilingLoginName = "FTPUsername"; enum_filingprotocol FilingProtocol = FTP;} (XRX_STATUS_COMPLETED)end

[description xrx_dscrpt_metadata] entry_1{ string MetaDataFieldName = "Field1"; string MetaDataPrompt = "Account #"; string MetaDataType = "string"; string MetaDataDefaultValue = "1234"; string MetaDataValue = "4356";} (XRX_STATUS_COMPLETED)end


68

610611

612613614615616617618619620621622623624625626627

628629630631632633634635636637638639640641642643644

645646647648649650651652653654655

656657658659660661662663664665666

667668669670671672673674675676

677

69


The following items from the above job log should be noted:

• The NetworkUsername attribute is the name of the authenticated user that was logged in at the time the scan job was initiated. It is of the form “<domain>/<user name>”.

• The ServiceDefinitionUsedVersion attribute identifies the ESS software version that was used to process the job.

• In this particular example, the user manually changed the plex to duplex to scan 2-sided originals.• The filing service completed successfully as indicated by the XRX_STATUS_COMPLETED value

appended to the XRX_SVC_FILE definition.• The value for the metadata field “Account #” was specified by the user.

4.3 Base template – common.xst

This template can be used as a starting point for building a customized template. This template will work on all devices except DC2xx / DC3xx. If the integration must include a template to be used on either of these MFDs, use the next template provided. The values in bold must be changed to correct values for the network.

[service xrx_svc_general] { * enum_DCS DCSDefinitionUsed = DCS_GENERIC; * string JobTemplateLanguageVersion = "4.00.07"; * enum_encoding JobTemplateCharacterEncoding = ASCII; * enum_confmethod ConfirmationMethod = PRINT; * enum_confstage ConfirmationStage = AFTER_JOB_COMPLETE; * string JobTemplateDescription = "DCS Common Template"; * string JobTemplateName = "Common.xst"; * string JobTemplateCreator = "Xerox"; }end

[service xrx_svc_scan] { * enum_sided SidesToScan = ONE_SIDED; * enum_mediasize InputMediaSize = AUTO; * enum_imagemode DocumentImageMode = TEXT; * integer CompressionQuality = 128; * enum_colormode ColorMode = BLACK_AND_WHITE; * enum_autoexposure AutoExposure = LEAD_EDGE; * struct_magnification Magnification = NONE; * struct_borders InputEdgeErase = 0/0/0/0/IN; * integer Darkness = 0; * integer Sharpness = 0; * integer Contrast = 0;}end

[doc_object xrx_document] doc_1{ * enum_resolution Resolution = RES_300X300; * enum_outputsize OutputImageSize = SAME_AS_ORIGINAL; * enum_docformat DocumentFormat = XSM_TIFF_V6; * string DocumentObjectName = "DOC"; * enum_compression CompressionsSupported = ANY; * enum_mixedtype MixedTypesSupported = MULTI_MASK_MRC; * enum_mixedcompressions MixedCompressionsSupported = ANY_BINARY, ANY_CONTONE;}end

[service XRX_SVC_FILE] file_1{ * enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE; * string RepositoryAlias = "Partner"; * string DocumentPath = "/InetPub/repository"; * string RepositoryName = "10.10.10.10"; * string UserNetworkFilingLoginName = “FTPUsername”;


70

678

679680

681682

683684685

686

687

688689690691692693694695696697698699700701702

703704705706707708709710711712713714715716717718

719720721722723724725726727728729730

731732733734735736737738

71


* string UserNetworkFilingLoginID = “FTPpassword”; * enum_filingprotocol FilingProtocol = FTP;}end

If the template must be deployed as a shared template on DC2xx/DC3xx, then use the version here under. This template can be used on all device and can be used as a starting point for building a customized template.:

[service xrx_svc_general] { * enum_DCS DCSDefinitionUsed = DCS_GENERIC; * string JobTemplateLanguageVersion = "4.0.07"; * enum_encoding JobTemplateCharacterEncoding = ASCII; * enum_confmethod ConfirmationMethod = PRINT; * enum_confstage ConfirmationStage = AFTER_JOB_COMPLETE; * string JobTemplateDescription = "DCS Common Template"; * string JobTemplateName = "Common_B.xst"; * string JobTemplateCreator = "Xerox"; }end

[service xrx_svc_scan] { * enum_sided SidesToScan = ONE_SIDED; * enum_mediasize InputMediaSize = AUTO; * enum_imagemode DocumentImageMode = TEXT; * integer CompressionQuality = 128; * enum_colormode ColorMode = BLACK_AND_WHITE; * enum_autoexposure AutoExposure = LEAD_EDGE; * struct_magnification Magnification = NONE; * struct_borders InputEdgeErase = 0/0/0/0/IN; * integer Darkness = 0; * integer Sharpness = 0; * integer Contrast = 0;}end

[doc_object xrx_document] doc_1{ * enum_resolution Resolution = RES_300X300; * enum_outputsize OutputImageSize = SAME_AS_ORIGINAL; * enum_docformat DocumentFormat = XSM_TIFF_V6; * string DocumentObjectName = "DOC";}end

[service XRX_SVC_FILE] file_1{ * enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE; * string RepositoryAlias = "Partner"; * string DocumentPath = "/InetPub/repository"; * string RepositoryName = "10.10.10.10"; * string UserNetworkFilingLoginName = “FTPUsername”; * string UserNetworkFilingLoginID = “FTPpassword”; * enum_filingprotocol FilingProtocol = FTP;}end

The following sections briefly describe the attributes most frequently modified in a template and by walk-up users. All attributes are not implemented equally across all devices. In general devices will attempt to complete the job by using defaults. If you are implementing any form of GUI to get input for configuring a base template, please use the attribute LUI labels provided in the Attribute Manual.

4.3.1 Xrx_svc_generalThis section contains general information about the job template and the job. None of these may be specified as compulsory, none of these are available at the LUI. The following attributes may need to be changed:


72

739740741742

743

744745746747748749750751752753754755756757

758759760761762763764765766767768769770771772773

774775776777778779780781782

783784785786787788789790791792793794

795796797798

799800801

73


4.3.1.1 JobTemplateLanguageVersion

The value of this attribute is determined by the version of JTL Parser that writes the xst file.

This is the version of the JTL Parser used to write the template. If the JobTemplateLanguageVersion is prior to 4.00.00 all attributes are considered non-compulsory.

4.3.1.2 JobTemplateName

Valid value is an ISO8859-1 / LATIN-1 text string. Maximum 20 characters allowed in the Web UI.This value should contain a descriptive name for the template. It should match the file name chosen for the template. This value is not used for storage by the system. The template name displayed at the device UI is the actual file name of the xst file. Some devices will replace the value of this attribute with the local template name and path in the job log.

4.3.1.3 JobTemplateDescription

A valid value is an ISO8859-1 / LATIN-1 text string of upto 100 characters. Note: maximum character limit may differ across the product line

This value should contain a description of the purpose of the template.

4.3.1.4 JobTemplateCreator

This value identifies the template creator.

4.3.1.5 ConfirmationMethod

Valid values are PRINT, [NONE] =no IP address in Job LogThis attribute may control the IP address of the device being added to the Job Log. The value of this attribute must be specified as PRINT if the workflow will require the IP address of the scan source device in the job log.

4.3.1.6 SuppressJobLog

Valid values are TRUE=image only scan output, no job log, FALSE=default value, job log is output, Syntax: boolean SuppressJobLog = TRUEThis attribute specifies whether or not a job log file should be stored with the scan output image for this job. Some workflows may not require the processing of a job log. Specifying [ see section 4.5 Using MetaData to customizethe workflow] takes precedence over setting this attribute to FALSE.

4.3.2 Xrx_svc_scanThis section defines parameters on how the physical document should be scanned. CompressionQuality may be specified as compulsory. Most of these are available for editing at the LUI. The following attributes may need to be changed:

4.3.2.1 SidesToScan

Valid values are ONE_SIDED, TWO_SIDED, and SECOND_SIDE_ROTATION.This defines the number of sides to scan of the input document. One option is the second side may be rotated 1800.

4.3.2.2 AutoExposure

Valid values are LEAD_EDGE and OFF.This attribute specifies an image processing technique(s) to compensate for the low-density quality of the input image in order to produce an output image whose background is mostly white.


74

802

803

804805

806

807808809810811

812

813814

815

816

817

818

819820821

822

823824825826827

828829830831

832

833834

835

836837838

75


4.3.2.3 InputEdgeErase

Valid values are NONE TOP: 0-50mm or 0-2in LEFT: 0-50mm or 0-2inBOTTOM: 0-50mm or 0-2in RIGHT: 0-50mm or 0-2in

This attribute specifies that the scan service will 'erase' the spots, punch holes, noise, fold, crest and staple marks along any or all of the four edges of the input scanning region.

4.3.2.4 DocumentImageMode

Valid values are MIXED, TEXT, and PHOTO.This attribute specifies an image processing operation. The value results in the system optimizing the scan operation for the indicated image type. It is one of the attributes used to determine the compression applied.

4.3.2.5 CompressionQuality

Valid values are 0, 128, and 255.Assigned to provide priority to quality or file size. This setting affects the range of values used to represent each pixel in the image. (i.e., pixel depth)

The supported Compression Quality values are:

255: highest quality / least compression / largest file size largest MRC Background and Foreground resolutions / least lossy JBIG2

128: The median range value where quality and file size carry equal weight in the computation of optimized image settings.

0: lowest quality / most compression / smallest file size smallest MRC Background and Foreground resolutions / most lossy JBIG2

The value of this attribute should be changed depending on workflow requirements. It can be specified as compulsory.

The following table demonstrates the result of using the Compression Quality option on a single color original output as a single page TIFF file.

Scan Settings TIFF File Size (kb)Smallest

0Smaller

128Largest

255Grayscale TEXT 194 454 758

PHOTO 198 453 758PHOTO & TEXT 196 451 752

ColorTEXT 231 653 1322PHOTO 228 640 1335PHOTO & TEXT 229 649 1325

The following table demonstrates the result of using the Compression Quality option on a single black and white original output as a multi-page TIFF file on WCP 2xx.


76

839

840841842843844845

846847

848

849850851

852

853854855

856

857858859860

861862863864865

866867

868869870

77


Scan Settings TIFF File Size (kb)Smallest

0Smaller

128Largest

255Black and White TEXT 34 34 34

PHOTO 60 59 60PHOTO & TEXT 48 48 45

4.3.2.6 Color Mode

Valid values are BLACK_AND_WHITE, GRAYSCALE, and FULL_COLOR.This attribute specifies the color mode for scanning.

Output Color Option Description

Color File Formats that encode images as a single image plane - scanned image data is encoded as 24-bit color, 8 bits per component.

File Formats that encode images as multiple image planes (MRC) - the background image plane is 24 -bit color, 8 bits per component. The selector plane is binary.

Grayscale (and Black and White +Mixed & Black and White+Photo on certain platforms)

File Formats that encode images as a single image plane - scanned image data is encoded as 8-bits per pixel grayscale.

File Formats that encode images as multiple image planes (MRC) - the background image plane is encoded as 8 bits per pixel grayscale. The selector plane is binary.

Black and White

(Only Black and White+Text in cases)

Binary Output

4.3.2.7 Output Usage / Scan presets

Valid values are TRUE and FALSE.TRUE allows the user to select from single select pre-set options supported by the system.FALSE renders the system supported single select pre-set options unavailable to the walk-up user for this particular scan job template.

Starting with WCP2xx the system will support single button scanning image quality options. The system makes available to the following scan pre-sets:

• Sharing and Printing• High Quality Printing• Archival Record• OCR• Simple Scan

The user has the option to select one of these options and then complete the scan job, which will be completed using system specific attribute settings.

To make available the supported Scan Presets at the LUI: [service xrx_svc_scan] { boolean OutputUsage = TRUE; }

To disallow Scan Presets at the LUI:


78

871

872

873874

875

876877878879

880881

882883884885886887888

889890891892893894

895

79


[service xrx_svc_scan] { boolean OutputUsage = FALSE; }

4.3.2.8 Input Orientation

The input orientation has not been set in the basic template. The system allows the user to define the image orientation at the device LUI. If the user defines it correctly (and all images are the same orientation) the image will appear in the correct orientation in the viewer. For example proper settings will cause images in a PDF or TIFF document to appear up-side-up in applications on the desktop.

If a system is unable to physically rotate the image (can also be due to hardware limitation) the TIFF Tag Orientation will be set. All TIFF Viewers may not support the orientation tag.

4.3.3 Xrx_documentThis section defines parameters on how the output document should be produced. Resolution, DocumentFormat and DocumentObjectName may be specified as compulsory. These are available for editing at the LUI. The following attributes may need to be changed:

4.3.3.1 DocumentObjectName

Valid value is an ISO8859-1 /LATIN-1 text string without space, maximum 40 characters. It can be specified as compulsory.

This defines the name of the document to be produced. This string is used as the base file name of the produced document.

The dependencies between DocumentObjectName, FileFormat and Filing Policy are listed in Appendix D.

4.3.3.2 Resolution

Valid values are RES_72X72, RES_100X100, RES_200X200, RES_300X300, RES_400X400, and RES_600X600.

Resolution may be specified as compulsory. It is available for editing at the LUI.

Product Resolution available

72x72

100x100

100x200 200x200 300x300 400x400 600x600

DC220/230/340/332ST Yes Yes Yes Yes

DC420/425/426/430/432/440ST Yes Yes Yes Yes Yes

DC240/255/265/460/470/480/490ST Yes Yes Yes

DC535/545/555ST Yes Yes Yes

WCP 35/45/55/65/75/90/123/128/133/165/175WCP 40/32/2128/2636/3545 ColorXerox 4110/4590WC 7132 / 7228/ 7235/ 7245

Yes Yes Yes Yes

WCP 2xx WC 7655 / 7665 / 4150 Yes Yes Yes Yes Yes


80

896897898899

900

901902903904

905906

907

908909910911

912

913914

915916

917

918

919

920

921

81


4.3.3.3 DocumentFormat

Valid values are XSM_TIFF_V6, TIFF_V6, PDF, and JFIF_JPEG. It can be specified as compulsory.

This defines the output image format for the document. It is available for editing at the LUI.

Product/Version Single-page TIFF

XSM_TIFF_V6

Multi-page TIFF

TIFF_V6

PDFPDF

JPEG JFIF_JPEG

(Color)DC220/230ST Launch, Wave2 Yes No No No

DC220/230ST Wave3, SMP1.08DC240/255/265/460/470STDC420/426ST

Yes Yes No No

DC220/230ST SMP1.05 DC332/340ST Launch, SMP1DC425/430/432/440ST DC460/470ST (19.1.x or higher)DC480/490ST DC535/545/555ST

Yes Yes Yes No

WorkCentre Pro 35/45/55/65/75/90 / 123/128/ 133 /165/175 / 2xxXerox 4110/4590

Yes Yes Yes No

WorkCentre Pro 32/35/40/45/2128/2636/3545 ColorWC 7132 / 7228/ 7235/ 7245/7655 / 7665 / 4150

Yes Yes Yes Yes

4.3.3.4 CompressionsSupported

This attribute is multi-value. Valid values are ANY, G3MH, G4, JPEG, JBIG, ARITHMETIC_ENCODED_JBIG2, HUFFMAN_ENCODED_JBIG2, MIXED, FLATE, and FLATE_COMPRESSED_JPEG. These programming options are available through templates only.This allows a workflow to ensure that compressions that are not supported by the workflow are not exported to it. In order to allow the device to select the best compression possible, use the attribute value “ANY”. This attribute specifies what compressions the workflow supports. MIXED is listed in the sequence as an indicator that MRC is supported. If the CompressionsSupported attribute is absent or if a template specifies NONE, then one of the set of required compressions [G3MH, G4, and JPEG] will be used.

4.3.3.5 MixedType

Valid values are ANY, MULTI-MASK_MRC, 2_LAYER_MRC, and 3_LAYER_MRC. These programming options are available through templates only. This is a single value attribute. This attribute specifies what Type of MRC image a workflow using the selected Job Template is to use.Mixed compressions are a combinatorial compression scheme where an image is split into separate layers and/or areas and each layer is optimally compressed based on the content of that layer. The MixedType attribute records what mixed compression type was used in the document.

4.3.3.6 MixedTypesSupported

These programming options are available through templates only. This is a multi value attribute.

Valid values are ANY, MULTI-MASK_MRC, 2_LAYER_MRC, and 3_LAYER_MRC.Mixed compressions are a combinatorial compression scheme where an image is split into separate layers and/or areas and each layer is optimally compressed based on the content of that layer. The MixedTypesSupported attribute lists what mixed compression types are allowed in the document.


82

922

923

924

925

926927928929930931932933

934

935936937938939940

941

942

943944945946

83


This enables a workflow to ensure that Mixed types that are not supported by the workflow are not exported to that workflow. If the CompressionsSupported attribute includes MIXED, then the MixedTypesSupported attribute is examined to see what type of mixed compression types are allowed for the job.

The MixedTypesSupported value of ANY indicates that the device will determine the Mixed Type to be used based on other job parameters. ANY allows workflows to continue to get new Mixed Types without editing the template. To disallow any mixed compression types, omit MIXED from the CompressionsSupported list.

4.3.3.7 MixedCompressionsSupported

These programming options are available through templates only. This is a multi value attribute.

Valid values are ANY, G4, JPEG, ARITHMETIC_ENCODED_JBIG2, HUFFMAN_ENCODED_JBIG2, and FLATE_COMPRESSED_JPEG.This allows a workflow to ensure that MRC compressions that are not supported are not exported to it. ANY allows workflows to continue to get new Compressions without editing the template.

4.3.3.8 Compression

This value cannot be supplied via a template xst file. The compression used is a function of the Color Mode, Resolution, Document Format, and Original Type. The following tables show the mapping between the original type, output color, document format and compression method used.

Original Type / Document Image

Mode

CompressionMonochrome device Color device

TIFF PDF TIFF PDF JFIFB&W Color B&W Color B&W Color

PHOTO G3 Flate/G3 G3 JPEG JPEG JPEG JPEG JPEGMIXED G4 MRC/G4 G4 JPEG MRC MRC JPEG JPEGTEXT G4 MRC/G4 G4 JPEG MRC MRC JPEG JPEG(deprecated values)AUTO G4MAGAZINE G3HALFTONE G3 G3

The WCP devices support MRC (Mixed Raster Content) for certain scan settings only. MRC is a combinatorial compression scheme where an image is split into separate layers and/or areas and each layer is optimally compressed based on the content of that layer. By default MRC is enabled. The following table highlights how compression will be used.

Color ModeOriginal Type

Res

olut

ion

>10

0x10

0

COMPRESSIONSSUPPORTED SELECTIONS

Mix

ed

Ari

thm

etic

JB

IG2

Huf

fman

JB

IG2

G4

Flat

e

COMPRESSION USED

Any Photo&Text T T NA NA NA MIXEDB&W Photo&Text NA F T NA NA NA ARITHMETIC_ENCODED_JBIG2


84

947948949

950951952

953

954

955956957958

959

960961962

963

964

965966967968

85


Color ModeOriginal Type

Res

olut

ion

>10

0x10

0

COMPRESSIONSSUPPORTED SELECTIONS

Mix

ed

Ari

thm

etic

JB

IG2

Huf

fman

JB

IG2

G4

Flat

e

COMPRESSION USED

Any Photo&Text T T NA NA NA MIXEDB&W Photo&Text NA F F T NA NA HUFFMAN_ENCODED_JBIG2B&W Photo&Text NA F F F T NA G4B&W Photo&Text NA F F F F NA G3B&W Photo&Text F T T NA NA NA ARITHMETIC_ENCODED_JBIG2B&W Photo&Text F T F T NA NA HUFFMAN_ENCODED_JBIG2B&W Photo&Text F T F F T NA G4B&W Photo&Text F T F F F NA G3B&W Text NA NA T NA NA NA ARITHMETIC_ENCODED_JBIG2B&W Text NA NA F T NA NA HUFFMAN_ENCODED_JBIG2B&W Text NA NA F F T NA G4B&W Text NA NA F F F NA G3B&W Photo NA NA NA NA NA T FlateB&W Photo NA NA NA NA NA F G3

Grayscale or Color Text T T NA NA NA NA MIXEDGrayscale or Color Photo&Text NA F NA NA NA T FLATE_COMPRESSED_JPEGGrayscale or Color Photo&Text NA F NA NA NA F JPEGGrayscale or Color Text or Photo NA NA NA NA NA T FLATE_COMPRESSED_JPEGGrayscale or Color Text or Photo NA NA NA NA NA F JPEG

MRC support varies across devices, with the general trend being that a newer device will support more compression options than an older one. The following table lists the current mapping of supported mixed compression selections with which compressions will be used in multi layer documents.

Table 6: MRC Applied [varies per model, this is an example]

Compression selection combinationsArithmetic

Encoded JBIG2Huffman Encoded

JBIG2G4 Flate JPEG

MRC Compressions Used

T NA NA T NA Binary: Arithmetic JBIG2Contone: Flate Compressed JPEG

T NA NA F NA Binary: Arithmetic JBIG2Contone: JPEG

F T NA T NA Binary: Huffman JBIG2Contone: Flate Compressed JPEG

F T NA F NA Binary: Huffman JBIG2Contone: JPEG

F F NA T NA Binary: G4Contone: Flate Compressed JPEG

F F NA F NA Binary: G4Contone: JPEG


86

969

970971972

973

974

87


Table 7: Compression Reported in Job Log

Compression Compression Value Reported in Job Log xst

G3 G3MH

G4 G4

ARITHMETIC_ENCODED_JBIG2 ARITHMETIC_ENCODED_JBIG2

HUFFMAN_ENCODED_JBIG2 HUFFMAN_ENCODED_JBIG2

JPEG JPEG

MRC MIXED

Flate FLATE

Flate compressed JPEG FLATE_COMPRESSED_JPEG

MRC with Flate Compressed JPEG MIXED

4.3.4 Xrx_svc_fileThis section defines parameters on where and how to file the document. The set of attributes required to set a destination vary per protocol. See Table 3: Template Pool and Repository settings for details. The following attributes may need to be changed in the base template for the network scan environment:

4.3.4.1 DocumentFilingPolicy

This attribute defines the filing policy to use when transferring the file. Detailed filing policy descriptions are in section 5.4 Filing Policies. This attribute has data type enum with valid values being:

OVERWRITEAPPENDNEW_EXACTNEW_AUTO_GENERATEGEN_DATE_TIME_ID

4.3.4.2 FilingProtocol

This attribute defines the filing protocol to use. This attribute has data type enum with valid values being:

FTPNCPSMBXRXHTTPXRXHTTPS

SMTP is a valid value for this attribute, but it is not applicable to a template.

4.3.4.3 LoginSource

This attribute enables the template creator to define, for each destination in the template, how the device should login to the repository. This attribute has data type enum with valid values being:

USERLOGINPROMPTPROMPT_IF_NECESSARYNONESYSTEM


88

975

976

977978979980

981

982983

984985986987988

989

990

991992993994995996

997

998999

10001001100210031004

89


TEMPLATE

UserLogin: Use the credentials of the user logged in at the system.

Prompt: Prompt the user at the device to enter credentials at the LUI.

Prompt if Necessary: Prompt the user only if the login name in the template, does not match the login name of the user logged in at the system.

None: Use no credentials.

System: Use the credentials defined at the device for that repository.

Template: Use the credentials that are contained in the template.

4.3.4.4 RepositoryAlias

This attribute is a label for a filing destination.. It is displayed at the device LUI when a template is selected. This capability facilitates association of a template with a workflow or business process, for example.

This attribute has data type sting, where ISO8859-1 / LATIN-1 text string of 0-64 characters is valid. The first 22 or so will be displayed.

If template defined login credentials fail for file transfer, the device may compare a template value of RepositoryAlias with system defined values ; and in case of a match attempt file transfer with system defined login credentials..

4.3.4.5 RepositoryName

This attribute defines the name of the destination repository. This attribute has data type string. A valid value is a US ASCII text string of 1-255 characters. The actual value depends on the protocol selected.

For FTP this field contains either the IP address or the server/host name. The port number can optionally be appended. (e.g., 10.10.19.10:21 or myServerName:21). Default port is 21.

For NCP this field contains the server name.

For SMB this field contains the NETBIOS host name. Default port is 139.

For HTTP this field contains the server hostname. Default port is 80.

For HTTPS with server certificate validation required this field must contain the FQDN of the server. Default port is 443.

4.3.4.6 RepositoryVolume

This attribute defines the volume or share name of the repository. This attribute has data type string. A valid value is a US ASCII text string. The actual value depends on the protocol selected.

For FTP this field is not used and should be a NULL string or removed from the template.

For NCP this field contains the volume name. 0-255 characters is valid.

For SMB this field contains the server share name. 1-127 characters is valid.

4.3.4.7 NDSNameContext

This attribute defines the NDS context for the server. It has data type string and a valid value is US ASCII.

For FTP and SMB this field is not used and should be a NULL string or removed from the template.

For NCP this field contains the context name.


90

100510061007

1008

10091010

1011

1012

1013

1014

10151016

10171018

101910201021

1022

1023

10241025

10261027

1028

1029

1030

1031

1032

10331034

1035

1036

1037

1038

1039

1040

1041

91


4.3.4.8 NDSTree

This attribute defines the NDS tree for the server. It has data type string and a valid value is US ASCII.

For FTP and SMB this field is not used and should be a NULL string or removed from the template.

For NCP this field contains the tree name.

4.3.4.9 XrxHTTPScriptLocation

This attribute defines the complete location and file name of the script file required for HTTP/S filing. It is only required for HTTP / S file transfers. It has data type string and a valid value is 1-128 character US ASCII text string. The implementation of XRXHTTP and XRXHTTPS require a script resident on the repository server. See the three sample scripts provided in this SDK package: xerox_asp.zip, xerox_php.zip and xerox_cgi.zip.

4.3.4.10 ServerValidationReq

This attribute indicates if the device must validate the server certificate. It applies only to HTTPS, and is a per repository setting. This attribute has data type Boolean with valid values:

TRUEFALSE

4.3.4.11 DocumentPath

This attribute defines the directory path of the repository. The attribute has data type string. A valid value is a US ASCII text string. Depending on the configuration, the path may be a relative path or an absolute path.

4.3.4.12 UserNetworkFilingLoginName

This attribute is the file transfer User login. It has data type string. A valid value is a US ASCII text string.

4.3.4.13 UserNetworkFilingLoginID

This attribute is the file transfer User password. It has data type string. A valid value is a US ASCII text string

4.3.4.14 Syntax for different protocols

SMB example with username and password:[service XRX_SVC_FILE] file_1{

enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE; string RepositoryAlias = "Partner"; string DocumentPath = "DirectoryPathOfRepository"; string RepositoryName = "ApplicationServerNETBIOShostName"; string UserNetworkFilingLoginName = "SMBusername"; string UserNetworkFilingLoginID = “SMBpassword”; enum_filingprotocol FilingProtocol = SMB; string RepositoryVolume = "ServerSharename"; }end

FTP example with username and password:[service XRX_SVC_FILE] file_1{ enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE; string RepositoryAlias = "Partner"; string DocumentPath = "DirectoryPathOfRepository";


92

1042

1043

1044

1045

1046

1047104810491050

1051

10521053

10541055

1056

10571058

1059

1060

1061

1062

1063

106410651066

10671068106910701071107210731074107510761077

10781079

10801081108210831084

93


string RepositoryName = "IPaddressOfFTPserver:Port"; string UserNetworkFilingLoginName = “FTPUsername”; string UserNetworkFilingLoginID = “FTPpassword”; enum_filingprotocol FilingProtocol = FTP;}end

XRXHTTP example with username and password:[service xrx_svc_file] file_1{ string RepositoryAlias = "Partner"; enum_filingprotocol FilingProtocol = XRXHTTP; string RepositoryName = "IPaddressOfHTTPserver:Port"; string DocumentPath = "CompleteDirectoryPathOfRepositry"; string XrxHTTPScriptLocation = "CompleteDirectoryPathAndNameOfScriptFile"; boolean ServerValidationReq = FALSE; enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;}end

There are various approaches to managing the file transfer. One method is to include all details in the scan template. A few devices do not support the UserNetworkFilingLoginID [user password] when supplied in a template. All these devices allow the password to be input at the device LUI.

The other method is to configure the single default repository on the MFD. If a template is supplied with an empty filing service, then the default setting is applied.

4.3.4.15 Filing to Multiple Destinations

It is possible to specify that a job should be filed to multiple destinations. The device will attempt to file to each of the specified destinations. If a file transfer fails on one destination the system attempts to file to the next specified destination. A few older devices may stop after the first failed destination.

The following excerpt is an example of three invocations in a Filing Service from a job log file:

[service xrx_svc_file]{string RepositoryAlias = "Scan Test";string UserNetworkFilingLoginName = "scan";enum_filingprotocol FilingProtocol = FTP;string RepositoryName = "10.10.10.10:21";string DocumentPath = "\\JBA2";string RepositoryVolume = "";string NDSTree = "";string NDSNameContext = "";enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;}(XRX_STATUS_COMPLETED){enum_filingpolicy DocumentFilingPolicy = OVERWRITE;string RepositoryAlias = "Scan22";string UserNetworkFilingLoginName = "scan";enum_filingprotocol FilingProtocol = FTP;string RepositoryName = "10.10.10.10:21";string DocumentPath = "/Eliz";string RepositoryVolume = "";string NDSTree = "";string NDSNameContext = "";}{enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;string RepositoryAlias = "AcctJba";string UserNetworkFilingLoginName = "scan";enum_filingprotocol FilingProtocol = FTP;string RepositoryName = "10.10.10.10:21";string DocumentPath = "/jba2";


94

108510861087108810891090

10911092

10931094109510961097109810991100110111021103

1104110511061107

11081109

1110

111111121113

1114

1115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145

95


string RepositoryVolume = "";string NDSTree = "";string NDSNameContext = "";}(XRX_STATUS_COMPLETED)

4.3.5 Other attribute values This following table provides additional attribute values that are supported on all devices. The ‘Result’ column provides an indication to the affect of replacing the attribute value with the value in the “Optional Values” column.

Table 8: Optional Attribute Value for common.xst

Attribute Value in common.xst Optional Values supported by all

devices

Result

AutoExposure LEAD_EDGE NONE Turns off background suppression.

DocumentFilingPolicy NEW_AUTO_GENERATE OVERWRITE, NEW_EXACT

Changes the filing policy to the indicated policy

DocumentImageMode TEXT PHOTO Results in the image mode being set to photo.

DocumentObjectName DOC String – up to 8 characters

Sets the DocumentObjectName to the indicated value.

Resolution RES_300X300 RES_200X200 Changes the scan resolution to 200x200

4.3.6 Fax serviceSee section 6.2.2 Scan template pre-programmed fax service.

4.4 Attribute editing at the device LUI

At the device LUI, when a walk up user selects a scan template, some attributes are available for editing, before completing the scan job.

Attributex Can editXC Can edit + Compulsory

DC

220/

230/

332

/340

/420

/425

/426

/43

0/43

2/44

0ST

DC

240/

255/

265/

460/

470/

480/

490S

T DC

460/

470/

480/

490S

T ES

S19.

5 or

hig

her

DC

5xxS

T/W

CP3

5/45

/556

5/70

/90/

165/

175

WC

P C

olor

WC

P2xx

WC

P123

/128

/133

WC

713

2

WC

76x

x

WC

72x

x

WC

415

0

[ScanPresets] x x x x


96

11461147114811491150

115111521153

1154

11551156

1157

11581159

97


AutoExposure x x x x x x x xColorMode x x x[Grayscale] xCompressionQuality x XC x XC x XCContrast x x x x x x xDarkness x x x x x x x x x xSharpness x x x x x x x x xResolution x x x x x XC x XC x XCDocumentImageMode x x x x x x x x x xInputEdgeErase x x x x x x x x x xInputMediaSize x x x x x x x x x xMSO mixed size originals

x [WCP only]

x x x x x

[Image orientation] x x x x x x x x xOutputImageSize xMagnification x x xSidesToScan x x x x x x x x x xDocumentFormat x x x XC XC XCDocumentObjectName x x x XC XC XCDocumentFilingPolicy x x x XC XC XCRepositoryName xDocumentPath x[file transfer login] x x x[file transfer password]

x x x

[Add filing destination]

x x x x x

[Copy Job] x[Book mode] x x[Build job] x x

4.5 Using MetaData to customize the workflow

Document Management Fields or Metadata fields provide the ability for the walk-up user to input data to the job at the device UI. Metadata fields are used to provide a customized UI for data input. The user input is stored in the scan job log. The device LUI displays up to six metadata entries though the architecture supports an infinite number. In order to require entry of a metadata field, mark the field as required.

The metadata attributes are described by a description object: XRX_DSCRPT_METADATA. The first declaration of “ref_invocation UserData” in the [doc_object xrx_document] service will provide the labels of each individual MetaData Field. MetaData Fields are named invocations. There is no restriction on the naming or the individual labels.

Table 9: Metadata and Metadata Validation Attributes

Attribute Name Value Description

MetaDataFieldName 1 to 128 characters. This attribute cannot be blank or null. During metadata validation, this is further

The name of the attribute, This value is not displayed at the LUI.


98

1160

1161

1162116311641165

1166116711681169

1170

99


restricted to the maximum field name length for validation; this limit is at least 15 characters, but may be increased in future devices or service packs.

MetaDataPrompt Up to 50 characters can be entered of which the first 20 to 25 characters will be displayed.

The prompt is displayed at the LUI to indicate what data the user should enter. If the MetaDataPrompt is null then no prompt is displayed at the LUI.

MetaDataType STRING Currently only string data is used. No data validation is done at the MFD.

MetaDataValue This field will accept up to 128 characters. During metadata validation, the value used for validation will be truncated to the value length for validation; this limit is at least 63 characters but may be increased in future devices or service packs.

The value is the user input at the LUI at the time of scan. If the user does not enter a value the MetaDataDefaultValue is assigned as the value.

MetaDataDefaultValue Up to 128 characters can be entered but only 60 will be displayed. During metadata validation, the value used for validation will be truncated to the value length for validation; this limit is at least 63 characters but may be increased in future releases.

The default value is assigned to the MetaDataValue if the user does not enter a value at the Document Center.

MetaDataMaskingRequired Enum NONE, MASK_ONLY, MASK_AND_OMITDefault NONE

Specifies if the data is to be clear text, or masked at the LUI, or masked at LUI and not entered in scan job log.

MetaDataRequiredEntry Boolean TRUE/FALSEDefault FALSE

Specifies if on-box validation is required. The device will display a warning and job will not proceed unless data is entered at the LUI. If MetaDataRequiredEntry is TRUE and theMetaDataDefaultValue is populated, the device allows the job to be submitted with the value defined in the template or with a value entered by the user at the LUI.. If the MetaDataPrompt is null the MetaDataRequiredEntry attribute is set to FALSE.

MetaDataValidationRequired Boolean TRUE/FALSEDefault FALSE

Specifies if off-box metadata validation by a specified server is required or not. Refer to the Metadata Validation SDK to implement a validation server. All metadata entries will be validated together, in a single validation transaction.

MetaDataValidationServerName String Max 127 characters With the MetaDataValidationServerPath


100

101


Default Null defines the URI of the validation server. Entry must comply with any internet addressing rules. This service is enabled over HTTPS only. The default port is 443.

MetaDataValidationServerPath String Max 127 charactersDefault Null

With the MetaDataValidationServerName defines the URI of the validation server.

MetaDataValidationTimeout 5-100 secondsDefault 8 seconds

Specifies a maximum allowed time for off-box metadata validation.

MetaDataValidationTimeoutPolicy Enum CANCEL_WITHOUT_VALIDATION

ValidationProtocol Enum single value

enum_protocol {

HTTPS

}

This attribute allows a user to define the protocol used for validation. This attribute is available per validation server.

4.5.1 ExamplesThe following is an excerpt from a template containing 6 meta data fields:

[doc_object xrx_document] doc_1{ integer BitsPerPixel = 1; enum_resolution Resolution = RES_300X300; enum_docformat DocumentFormat = XSM_TIFF_V6; string DocumentObjectName = "Fields"; enum_outputsize OutputImageSize = SAME_AS_ORIGINAL; ref_invocation UserData = xrx_dscrpt_metadata:entry_1, xrx_dscrpt_metadata:entry_2, xrx_dscrpt_metadata:entry_3, xrx_dscrpt_metadata:entry_4, xrx_dscrpt_metadata:entry_5, xrx_dscrpt_metadata:entry_6;}end...[description xrx_dscrpt_metadata] entry_1{ string MetaDataFieldName = "Field1"; string MetaDataPrompt = "Enter a value for Field1"; string MetaDataType = "string"; string MetaDataDefaultValue = "Default Value of Field1"; string MetaDataValue = ""; } entry_2{... } entry_6{ string MetaDataFieldName = "Field678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678"; string MetaDataPrompt = "Enter a value for Field6"; string MetaDataType = "string"; string MetaDataDefaultValue = "Default Value of Field6"; string MetaDataValue = ""; }end

This is the corresponding job log:


102

1171

11721173

117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212

12131214

103


[doc_object xrx_document] doc_1{ integer BitsPerPixel = 1; enum_resolution Resolution = RES_300X300; enum_docformat DocumentFormat = XSM_TIFF_V6; string DocumentObjectName = "Fields"; enum_outputsize OutputImageSize = SAME_AS_ORIGINAL; ref_invocation UserData = xrx_dscrpt_metadata:entry_1, xrx_dscrpt_metadata:entry_2, xrx_dscrpt_metadata:entry_3, xrx_dscrpt_metadata:entry_4, xrx_dscrpt_metadata:entry_5, xrx_dscrpt_metadata:entry_6; integer NumberImagesScanned = 2; }end

[description xrx_dscrpt_metadata] entry_1{ string MetaDataFieldName = "Field1"; string MetaDataPrompt = "Enter a value for Field1"; string MetaDataDefaultValue = "Default Value of Field1"; string MetaDataValue = "keyboard entered data is here for field1"; }(XRX_STATUS_COMPLETED) entry_2{... }(XRX_STATUS_COMPLETED) entry_6{ string MetaDataFieldName = "Field678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678"; string MetaDataPrompt = "Enter a value for Field6"; string MetaDataDefaultValue = "Default Value of Field6"; string MetaDataValue = "Default Value of Field6"; }(XRX_STATUS_COMPLETED)end

Example1 of relevant section of a template using Metadata Validation:[service xrx_svc_validation] { string MetaDataValidationServerName = "10.10.10.10"; string MetaDataValidationServerPath = "ReferenceValidationServer/XrxValidationServiceImpl.asmx"; enum_protocol ValidationProtocol = HTTPS; integer MetaDataValidationTimeout = 15; }end

[description xrx_dscrpt_metadata] 1{ * string MetaDataDefaultValue = "f11"; * string MetaDataPrompt = "Field one"; * string MetaDataFieldName = "fname1"; * string MetaDataType = "string"; boolean MetaDataValidationRequired = TRUE; } 2{ * string MetaDataPrompt = "Field two"; * string MetaDataFieldName = "fname2"; * boolean MetaDataRequiredEntry = TRUE; boolean MetaDataValidationRequired = TRUE; * string MetaDataType = "string"; } 3{ * string MetaDataDefaultValue = "f31"; * string MetaDataFieldName = "fname3"; * string MetaDataType = "string"; boolean MetaDataValidationRequired = TRUE; }


104

12151216121712181219122012211222122312241225122612271228

1229123012311232123312341235123612371238123912401241124212431244124512461247124812491250

12511252

125312541255125612571258125912601261

1262126312641265126612671268126912701271127212731274127512761277127812791280128112821283

105


4{ boolean MetaDataValidationRequired = TRUE; * string MetaDataPrompt = "Field four"; * string MetaDataFieldName = "fname4"; * enum_metadatamaskingrequired MetaDataMaskingRequired = MASK_ONLY; * string MetaDataType = "string"; } 5{ boolean MetaDataValidationRequired = TRUE; * string MetaDataPrompt = "Field five"; * string MetaDataFieldName = "fname5"; * enum_metadatamaskingrequired MetaDataMaskingRequired = MASK_AND_OMIT; * string MetaDataType = "string"; }end

Example2 of a metadata validation service:[service xrx_svc_validation] { enum_protocol ValidationProtocol = HTTPS; string MetaDataValidationServerName = "10.10.10.10:4433"; string MetaDataValidationServerPath = "ReferenceValidationServer/XrxValidationServiceImpl.asmx"; }end

4.5.2 Special character representation in MetaDataValueCertain special characters have a programmatic meaning. When these are keyed in as part of a metadatavalue string, they are distinguished in the Job Log by use of “\” before the character. For instance “\” (back-slash) and “ (double quote) are recorded as \\ and \" respectively.

Example from a job log:[description xrx_dscrpt_metadata] entry_1{ string MetaDataFieldName = "FaxNumber"; string MetaDataPrompt = "Fax Number"; string MetaDataType = "string"; string MetaDataValue = "09876534231';}{][_?><|+=*&^%¢£$#@!`~-\"';/.,mn\\:)(jhgABCÅÙÒÛÔÊÂÚÓÆÇ"; string MetaDataDefaultValue = "12345"; }(XRX_STATUS_COMPLETED)

4.6 Build Job

Some devices support Build Job at the device LUI within the Network Scanning service.

A customer may use this feature to accomplish any or all of the following tasks:

• Combine documents from the platen and the DADF into a single job.

• Scan a large number of sheets/pages into a single job.

• Apply different image processing choices to different pages or segments of a job.

Build Job must be enabled by the user at the device’s local user interface prior to the first scan. Images may be scanned from the platen or the DADF for creation of a Build Job. The documents must be scanned in the order that they are to appear in the output job/file. Some job processing values will only be allowed to be set once per Build Job. Other job processing values may be set per segment. When all images have been scanned the user selects End


106

128412851286128712881289129012911292129312941295129612971298

12991300

13011302130313041305130613071308

13091310

1311131213131314

1315131613171318131913201321132213231324

1325

1326

1327

1328

1329

1330

1331

1332133313341335

107


Build Job to complete the scan job process. The device now assembles the entire document in the form indicated in the template (PDF, TIFF, etc.), and exports the document and the job log as usual. The document consists of multiple segments, and the job log contains information about how the job was assembled.

The job log reflects each segment of the build job as a separate invocation of the corresponding service. Using Job Template Language (JTL) templates, the history of the document is distributed among several services in the job log. An example job log after scanning is:[service XRX_SVC_GENERAL]{ string JobTemplateLanguageVersion = "2.1"; enum_DCS DCSDefinitionUsed = DCS_GENERIC; string JobTemplateName = "scan.xst"; ref_invocation xrx_svc_scan_segments = xrx_svc_scan:scan_1, xrx_svc_scan:scan_2, xrx_svc_scan:scan_3; integer NumberScannedSegments = 3;}end

[service XRX_SVC_SCAN]scan_1{ enum_imagemode DocumentImageMode = MIXED; enum_sided SidesToScan = ONE_SIDED; enum_colormode = BLACK_AND_WHITE;}scan_2{ enum_imagemode DocumentImageMode = PHOTO; enum_sided SidesToScan = TWO_SIDED; enum_colormode = FULL_COLOR;}scan_3{ enum_imagemode DocumentImageMode = MIXED; enum_sided SidesToScan = ONE_SIDED; enum_colormode = AUTO;}end

[doc_object XRX_DOCUMENT]doc_1{ enum_resolution Resolution = RES_200x200; enum_docformat DocumentFormat = PDF; ref_invocation UserData = xrx_dscrpt_metadata:field_1, xrx_dscrpt_metadata:field_2; integer NumberImagesScanned = 3;}doc_2{ enum_resolution Resolution = RES_600x600; enum_docformat DocumentFormat = PDF; ref_invocation UserData = XRX_DSCRPT_METADATA:Field_1, XRX_DSCRPT_METADATA:Field_2; integer NumberImagesScanned = 4;}doc_3{ enum_resolution Resolution = RES_300x300; enum_docformat DocumentFormat = PDF; ref_invocation UserData = XRX_DSCRPT_METADATA:Field_1, XRX_DSCRPT_METADATA:Field_2; integer NumberImagesScanned = 2;}end

[service XRX_SVC_FILE]file_1{ ref_invocation OutputDocument = xrx_document:doc_1, xrx_document:doc_2, xrx_document:doc_3; enum_filingprotocol FilingProtocol = SMB; string RepositoryVolume = "Scan"; string RepositoryName = "Server"; string DocumentPath = "";}(XRX_STATUS_COMPLETED)end


108

133613371338

133913401341

1342134313441345134613471348134913501351

135213531354135513561357135813591360136113621363136413651366136713681369

137013711372137313741375137613771378137913801381138213831384138513861387138813891390

13911392139313941395139613971398139914001401

1402

111


[description xrx_dscrpt_metadata]field_1{ string MetaDataPrompt = "Enter Phone Number"; string MetaDataFieldName = "phone"; string MetaDataDefaultValue = ""; string MetaDataValue = "51234";}field_2{ string MetaDataPrompt = "Enter Office Location"; string MetaDataFieldName = "location"; string MetaDataDefaultValue = ""; string MetaDataValue = "Austin";}

Changes to the job log for build job (compared to a typical job log) are noted in blue above. The changes are:

• New attributes are placed in the service xrx_svc_general:• xrx_svc_scan_segments lists the scan segments created by the scan service;• NumberScannedSegments reflects the number of segments. The number of segments listed in

xrx_svc_scan_segments will be the same as the number listed in NumberScannedSegments.• Multiple invocations appear in xrx_svc_scan, xrx_document, and xrx_svc_file. The invocations correspond to

one another in the order they appear -- in other words, the first doc invocation is the document created by the first scan invocation, the second doc invocation is created by the second scan invocation, and so on.

• The filing service indicates what segments are assembled in the document, in the order in which they appear in the output file. When using multipage formats that allow varying image settings (such as Multipage-TIFF or PDF), the different segments will be embedded in the output file. In single-page formats, each image will correspond to the format listed in the job log.• Use the attribute NumberImagesScanned to determine which images correspond to the given format.

Reconstructing the user's actions based on the above job log, this job was created in the following manner:

1. The user selected build-job.2. The user set image-mode to mixed, resolution to 200dpi, media to single-sided, color-mode to black-and-

white, and scanned three sheets. This information is from:2.1. Based on the information in xrx_svc_scan/scan_1:

2.1.1. The pages had mixed images (photos) and text on each page.2.1.2. The media had images only on one side of the paper.2.1.3. The media was scanned in grayscale 1-bit (i.e., black and white).

2.2. Based on the information in xrx_document/doc_1:2.2.1. The image was scanned at 200dpi.2.2.2. Three pages were scanned.

3. The user set image-mode to photo, resolution to 600dpi, media to double-sided, color-mode to full-color, and scanned two sheets.3.1. Based on the information in xrx_svc_scan/scan_2:

3.1.1. The pages in this segment contained color photos.3.1.2. The media contained images on both sides of the media.

3.2. Based on the information in xrx_document/doc_2:3.2.1. Four images were scanned; since the media contained images on both sides, there were two

pages, scanned as images 4 - 7.3.2.2. The images were scanned at 600dpi.

4. The user set image-mode to mixed, resolution to 300dpi, media to single-sided, color-mode to auto, and scanned two sheets.4.1. Based on the information in xrx_svc_scan/scan_3:

4.1.1. The remaining pages contained a mixture of images (photos) and text.4.1.2. The remaining pages contained images on only one side of the media.


112

1403140414051406140714081409141014111412141314141415

14161417

14181419

1420142114221423

142414251426

1427142814291430

143114321433

143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457

113


4.1.3. Some remaining pages may contain color or may contain black-and-white; the device detected whether the pages contained color; if not, they were scanned as grayscale or black-and-white.

4.2. Based on the information in xrx_document/doc_3:4.2.1. The images were acquired at 300dpi.4.2.2. Two images were acquired in this segment.

In the output PDF file, pages 1 - 3 are 200dpi black-and-white, pages 4 - 7 are 600dpi color, and pages 8 - 9 are 300dpi. (The image will need to be opened to find the color settings for the last two pages.)

It's not possible to tell based on the job log whether the single-sided images were acquired on the platen or from the feeder; however, the second segment was acquired in the document feeder (the two-sided setting indicates that the document handler turned the pages over during image acquisition). In each segment, this user adjusted the resolution, sides-per-page, and image mode settings at each step.

The job log contains duplicate information in the document and scan segments. All information should be repeated in each section; however, if any information is omitted from a subsequent segment, then the information from the prior segment applies. If information is omitted from the first segment, then device defaults apply for that segment.5

Metadata references are repeated in each segment of the document object, as is the document format. However, neither of these can change during the job, and these values will be replicated but not different.

4.6.1 Processing multi-segment jobsFor most purposes, multi-segment jobs will not impact consuming applications. The information contained in the first segment will be used by the JTL parser, which will be sufficient for most parsing. However, if the information about the document structure is needed, then use the following algorithm to detect a multi-segment job:

1. Read the attribute NumberScannedSegments to determine the number of segments in the job.2. If the attribute is missing or its value is equal to one, then there's only one segment in the job. Note: older

devices and devices that do not support build-job will omit this attribute from the job log. 3. Read global information such as metadata and document format from the first invocation of the appropriate

service.4. If the NumberScannedSegments attribute exists and is greater than one, then

4.1. Initialize an iterator serviceIterator to the first invocation of the scan service.4.2. Initialize an iterator documentIterator to the first invocation of the document service.4.3. Initialize the current page number to 0.4.4. While there are more invocations of the document and scan service, do the following:

4.4.1. Set the first page number in the range to the current page number + 1.4.4.2. Set the last page number in the range to the current page number + NumberImagesScanned

from the current documentIterator.4.4.3. « do the work for the pages from first-page-number to last-page-number »4.4.4. Set the current page number to the last page number in the range.4.4.5. Increment both invocation iterators serviceIterator and documentIterator.

Refer to the Parser SDK for an example on how to parse a multi-segment job.

4.7 System generated job context attributes in job log

Scan attributes we have described earlier have been used for pre-programming the scan job. Some scan attributes which transmit job context data are may be written by the system the job log.5 Contact the Solutions & SDKs group if you encounter a case where this happens. This behavior is not expected and has not occured in our testing.


114

14581459146014611462146314641465

1466146714681469

147014711472

14731474

1475147614771478

1479148014811482148314841485148614871488148914901491149214931494149514961497

1498

14991500

109110

115


4.7.1 Scanner IP address: OutputURI / OutputURLThis attribute is contained in the xrx_svc_general service of the job log. The MFD may use either OutputURI or OutputURL. This attribute has data type string, and the syntax contains [among other details] the originating device IP address. The IP address is used to print back any job confirmation from an application to the originating scanner.

Example from a job log created by an MFD at IP address 10.10.10.10: string OutputURL = "service:printer:lpr://10.10.10.10";

See section 4.3.1.5 ConfirmationMethod.

4.7.2 Authenticated user name: NetworkUsernameSee sections 3.4.1 Network Authentication, 3.1.4 Include authenticated username in scan job log and 3.2.2 Includeauthenticated username in scan job log for the configurations required to enable this function.

The type of this attribute is string. It is included in the xrx_svc_general service of the job log. It is included in both network scan and server fax job logs.

Example from a job done by a user with user name ‘tpatil’, from domain ‘adv.sol.xerox.com’:string NetworkUsername = "adv.sol.xerox.com/tpatil";

This can be used to query the domain, for example to find the email address property of this user.

4.7.3 JBA data: AcctName and AcctValueSee section 3.4.3 Include job based accounting data in scan job log for details on how to enable this function. This section is included in both network scan and server fax job logs. It is included in a description section of a job log. These are attributes with data type string. See the example here below. XRX_USERID and XRX_ACCTID are Job Based Accounting attributes.

Example from a job where the user specified ‘U1’ for the User ID and ‘A1’ for the Account ID:[description xrx_dscrpt_accounting] 1{ string AcctName = "XRX_USERID"; string AcctValue = "U1"; } 2{ string AcctName = "XRX_ACCTID"; string AcctValue = "A1"; }end

This data (the XRX_USERID and XRX_ACCTID values) can be used to print back any job confirmations or fax reports to the MFD. The reports can be charged by an accounting system to the user who initiated the scan or fax job. For detailed explanation and examples of use, refer to Appendix H, “Adobe PostScript and PCL Embedding Of Billing Codes In Network Print Jobs” in the Job Based Accounting API Specification (latest version) available on the Xerox partner web site.

4.7.4 NumberScannedSegmentsThis attribute results from a build job. It is contained in the xrx_svc_general service of the job log. This attribute has data type integer. It specifies the total number of individual segments in a build job.

See section 4.6 Build Job for details and an example.


116

1501150215031504

15051506

1507

150815091510

15111512

15131514

1515

15161517151815191520

152115221523152415251526152715281529153015311532

15331534153515361537

153815391540

1541

117


4.7.5 NumberImagesScannedThis attribute specifies the number of distinct output images produced per scanning job. It is contained in the xrx_document service of a job log. For a build job, each specific iteration of the document service will specify NumberImagesScanned. See section 4.6 Build Job for details and an example.

4.8 Implementation Differences Across the Product Line

Not all attribute values nor all attributes are implemented across the product line. When creating a template intended to be used across different products it is safest to only specify the attributes that you really need in order for your job to correctly execute. Wherever possible, try to utilize only those attributes that were defined in the common.xst. In general, attributes not supported by a device are ignored and attribute values not supported by a device are replaced by the device default. However, these behaviors may vary across the product line.

When defining a template intended to be used on multiple products, you must test it on each of these products to ensure that the specified template will work properly. This will be done during the integration and validation test phases for your product.

Table 10: File transfer implementation

Remote Template Refresh

Multiple file services in network scan template

SMB HTTPHTTPS

FTP NCP Login Source

SMTP for Fax Repository

File transfer password is read from a scan template

DC220/230/332/340/420/426ST

DC240/255/265/460/470/480/490ST

DC425/430/432/440ST DC535/545/555 All WCP except those below WCP 123 / 128 / 133 Xerox 4110 / 4590

WC 7132 / 7228 / 7235 / 7245

WC 4150 WCP 2xx WC 7655 / 7665

Table 11: Data in job log implementation

Scan origin MFD IP Address in job log

Build job details in network scan job log

MetadataUser input in network scan job log

JBA data in job log

Authenti-cated User and domain in job log

DC220/230/332/340/420/426STDC240/255/265/460/470/480ST (18.x, 19.0.x, 19.1.x ESS)

DC432/440ST (2.x ESS) DC425/430/432/440ST

Server Fax job only


118

1542154315441545

1546

15471548154915501551

1552

155315541555

1556

1557

1558

1559

119


DC460/470/480/490ST (19.2.x ESS or higher)DC535/545/555

DC 535/545/555 0.20.53.0WCP 32/35/40/45/2128/2636/3545 ColorWCP 35/45/55/65/75/90 /165/175

WCP 123 / 128 / 133Xerox 4110 / 4590WC 7132 / 7228 / 7235 / 7245

WC 4150 WCP 2xxWC 7655 / 7665


120

121


5 Scan output and processing

5.1 Image

5.1.1 File FormatThe TIFF files produced by the system for monochrome images are consistent with TIFF-FX profile S (RFC2301) and the subset of TIFF-FX Profile F (RFC2301) that supports MMR (G4) [T.6] and MH (G3) [T.4] bi-level compression. These files are TIFF 6.0 compatible. The TIFF files produced by the system for color and grayscale images for scan to file and scan to email are TIFF 6.0 with or without TTN2 extensions. The TIFF files produced by the system for color or grayscale images for IFAX are consistent with TIFF-FX profile C.

On some devices , the System Administrator can select whether the JPEG compression conforms to the TIFF 6.0 standard (Old JPEG) or to the TIFF 6.0 standard with TTN2 extensions (New JPEG) for Full Color and Grayscale TIFF files.

The PDF files produced by the system are PDF image files. They are essentially TIFF files with a PDF wrapper. Searchable PDF files must be created using a third-party application.

5.1.2 Files Stored for Multi-page TIFF and PDFFor multi-page TIFF and PDF, the system stores the image file and the job log. For multi-page TIFF and PDF files, the name of the image file created will be of the form <DocumentObjectName>.<tif/pdf>. (e.g., MyDoc.pdf) The name of the job log file will be <DocumentObjectName>.xst. (e.g., MyDoc.xst) The DocumentObjectName is the value from the job template and matches the “Document Name” value specified when the template was created. If the file format was PDF, the DocumentObjectName was “MyDoc”, and the DocumentPath was “MyScanDir”, the directory listing would look as follows:

/MyScanDir/MyDoc.pdf/MyScanDir/MyDoc.xst

5.1.3 Files Stored for Single-page TIFF and JPEG• XSMDESC.dat – This is an ISO8859-1 / LATIN-1 text file that contains the value of

<DocumentObjectName>.

• NEXTNAME.dat – This is an ISO8859-1 / LATIN-1 text file that contains the next available image file name. (e.g., 00000003.tif)

• <DocumentObjectName>.DAT – This is an ISO8859-1 / LATIN-1 text file that contains a list of the image files that have been stored to this directory. Each file name is terminated with a CR/LF. The file is updated as each image file is transferred.

If the file format was TIFF, the DocumentObjectName was “MyDoc”, the DocumentPath was “MyScanDir” and 3 pages were scanned, the directory listing would look as follows:

/MyScanDir/MyDoc.XSM/00000001.tif/MyScanDir/MyDoc.XSM/00000002.tif/MyScanDir/MyDoc.XSM/00000003.tif/MyScanDir/MyDoc.XSM/MyDoc.xst/MyScanDir/MyDoc.XSM/MyDoc.DAT/MyScanDir/MyDoc.XSM/XSMDESC.DAT/MyScanDir/MyDoc.XSM/NEXTNAME.DAT


122

1560

1561

156215631564156515661567

156815691570

15711572

1573157415751576157715781579

15801581

1582

15831584

15851586

158715881589

1590

15911592

1593159415951596159715981599

123


5.2 Job Log

Job logs have the same structures as scan job templates. See details in section 4 Scan Templates and Job Logs.

5.3 File Transfer

5.3.1 Directory Locking - the .LCK DirectoryIn order to ensure that only one device/client is processing files in a particular repository at any one time, the system creates a temporary directory by the name of <DocumentObjectName>.LCK (the lock directory) within the DirectoryPath specified in the job template. The existence of this directory indicates that the document repository is being modified and should not be modified by another device/client.

After the device opens a connection to the specified file server, it checks to see if the lock directory exists in the specified repository directory. If it doesn’t exist, it creates the lock directory. If it does exist, it checks to see if the lock was placed there by the device itself. If it was, this indicates that the previous filing attempt terminated abnormally and the partially transferred files are deleted. If the lock wasn’t placed there by the device then the job is aborted and no files are stored. Once all files have been stored the lock directory is removed and the connection is closed. The device must complete this sequence of creating the .LCK folder [with or without contents] , transferring all scan job related files [image and other], and finally deleting the .LCK folder [and optional contents] for a scan job to complete successfully. Any interruption of these processes can produce a ‘Failed’ job or a job hung in the scan queue. The case of an incomplete job in the scan queue, could require manual deletion from the device UI, followed by a power-off-power-on sequence to flush the queue.

If the file format was TIFF, the DocumentObjectName was “MyDoc” and the DocumentPath was “MyScanDir” the directory listing would look as follows while files were being transferred:

/MyScanDir/MyDoc.LCK/MyScanDir/MyDoc.XSM

5.3.1.1 No .LCK Directory

Some systems support a minimal subset of Xerox NSA. These systems do not write a .LCK directory during file transfer.

• WorkCentre M24• WorkCentre Pro 423/428• DocuColor 1632/2240

5.3.2 File Transfer ProtocolsThe following file transfer protocols are supported over Ethernet (10 MB and 100 MB)

• FTP Filing over IP• NCP Filing over IPX for NetWare 3.12• NCP Filing over IPX for NetWare 4.1 Bindery• NCP Filing over IPX for NetWare 4.1 and 5.1 NDS• NCP Filing over IP • SMB Filing via NetBIOS over TCP/IP• SMB Filing over TCP/IP• HTTP & HTTPS

For details on HTTP & HTTPS requirements for Xerox Scan to Network, refer to the attached document.


124

1600

1601

1602

16031604160516061607

1608160916101611161216131614161516161617

16181619

16201621

1622

16231624

162516261627

16281629

1630163116321633163416351636163716381639

125


Older versions of the system support these protocols over Token Ring as well. However this medium is no longer supported in the newer products.

5.4 Filing Policies

The filing policy specifies the method used to store a scanned document in the document repository. There are five options available: Overwrite Existing File / OVERWRITE, Append to Existing File / APPEND, Do Not Save if it Already Exists / NEW_EXACT, Rename New File / NEW_AUTO_GENERATE, and Add Date To Name / GEN_DATE_TIME_ID.

Table 12: File Format and Filing Policy combinations

Filing PolicyFile Format

Overwrite Existing File

(Overwrite)

Rename New File(New Auto Generate)

Append to Existing File

(Append)

Do Not Save if it Already Exists(New Exact)

Add Date To Name

(Gen Date Time Id)

Single Page TIFF Yes Yes Yes Yes YesJPEG-JFIF Yes Yes Yes Yes YesMulti Page TIFF Yes Yes NA (not

applicable)Yes Yes

PDF Yes Yes NA (not applicable)

Yes Yes

5.4.1 Rename New File (New Auto Generate)This policy results in a unique file name or .XSM directory to be created within the specified repository for the given image file(s). This policy is typically used when multiple scans to the same repository may be performed prior to emptying the repository. The DocumentFilingPolicy of NEW_AUTO_GENERATE supersedes the compulsory modifier for the DocumentObjectName attribute. The DocumentObjectName will be generated as if the compulsory modifier was not set.

For multi-page TIFF or PDF, the first file stored to the directory will be of the form:

< DocumentObjectName>.<PDF/TIF>

Subsequent files stored to the directory will be of the form:

<First 5 characters of the DocumentObjectName><3 digit number>.<PDF/TIF>

The DocumentObjectName is the value from the job template and matches the “Document Name” value specified when the template was created. The <3 digit number> will start at 000 and increment by 1 until reaching 999. If the user has removed documents from the document repository, then the first unused number found will be used. If all numbers have been used then an error is reported and the files are not stored. If the DocumentObjectName has not been specified in the template, the value “DOC” will be used.

If the DocumentObjectName is MyDoc, the result of 3 consecutive PDF scans would produce the following 3 files:

MyDoc.pdfMyDoc000.pdfMyDoc001.pdf


126

16401641

1642

1643

1644164516461647

1648

1649

165016511652165316541655

1656

1657

1658

1659

1660

1661

16621663166416651666

1667

1668

166916701671

127


For single page TIFF and JPEG formats, the first set of files stored will have a directory name of the form:

< DocumentObjectName>.XSM

Subsequent sets of files stored will have a directory name of the form:

<First 5 characters of the DocumentObjectName><3 digit number>.XSM

If the DocumentObjectName is MyDoc, the result of 3 consecutive TIF scans would produce the following 3 directories:

MyDoc.xsmMyDoc000.xsmMyDoc001.xsm

5.4.2 Overwrite Existing File (Overwrite)This policy results in the previously stored document to be deleted prior to storing the newly scanned document. This is true even if the image file format has changed. (e.g., if the newly scanned document is in PDF format and the previously scanned document was in JPEG format, the <DocumentObject>.XSM directory is deleted prior to storing the <DocumentObject>.pdf and <DocumentObject>.xst files.)

5.4.3 AppendThis policy can only be used with single-page TIFF and JPEG image formats. If the directory <DocumentObjectName>.XSM does not exist, the directory is created and the files are stored starting with the number “00000001”. If the directory already exists, the next available file number is used based upon the value stored in the NEXTNAME.DAT file. If a previously stored PDF or multi-page TIFF file with the same DocumentObjectName exists in the directory, the job is cancelled and the images are not filed.

5.4.4 New ExactThis policy results in the files being stored only if no previous document with the same name exists in the specified directory. This is true even if the image file format has changed. (e.g., if the newly scanned document is in PDF format and the <DocumentObject>.XSM directory exists or <DocumentObject>.<tif/pdf> exists, the job is cancelled and the images are not filed.)

5.4.5 Add Date To Name / GEN_DATE_TIME_IDThe filing service appends a date/time stamp to the DocumentObjectName attribute. The date/time stamp will be extracted at the time of job submission (per the date/time configured on the device) to assist the user in identifying the correct file. The format of the file name of this filing policy is: documentobjectname_YYYYMMDDhhmmss. If more than one job is scanned with the same document name, at the same time, to the same repository, then a 3-digit, ordinal integer will be appended to the end of the second job’s file name (e.g. JOB1 = documentobjectname_YYYYMMDDhhmmss.pdf and JOB2 = documentobjectname_YYYYMMDDhhmmss_000.pdf). The DocumentFilingPolicy of GEN_DATE_TIME_ID supersedes the compulsory modifier for the DocumentObjectName attribute. The DocumentObjectName is generated as if the compulsory modifier was not set.


128

1672

1673

1674

1675

1676

1677

16781679

168016811682

16831684168516861687

168816891690169116921693

16941695169616971698

1699170017011702170317041705170617071708

129


5.5 Processing scan output

5.5.1 Adding functionality – Using Network Scanning as a Workflow OnrampA common way to enter a scan-based workflow is to use a custom template to scan to a particular directory on a file server and establish an agent that monitors (polls) the directory for new jobs. Using a multi-page document format such as TIFF or PDF along with a New Auto Generate or Gen Date Time ID filing policy is the recommended implementation approach. Single page TIFF or JPEG files could also be used but multi-page and single page formats should not be used within the same directory. Doing so will likely yield unexpected results, especially in an environment where a mix set of WCPs and DCSs are used. New Auto Generate should be used in order to avoid timing problems between devices trying to file to the repository and the agent monitoring the directory. Filing policies are described in section 5.4 Filing Policies, and file formats are described in section 5.1.1 File Format.

File transfer via FTP is supported across all devices. Details on variance in support of other filing protocols can be found in the appendix. It is recommended to monitor the files from a standard FTP directory. See section 5.5.2 Monitoring and Retrieving Files From the Scan to File Repository below for guidelines and recommendations for monitoring and retrieving files.

Some devices support SMB, which may be preferred for higher security and encryption; an option for new devices is using Xerox HTTP/S filing, providing encryption of the image files during transfer. In both cases, the scan repository will need corresponding configuration to ensure security of the repository.

The file monitoring and retrieving requirements are identical for all protocols. It is recommended that the file monitoring and retrieving be dealt with as a ‘file hand off’ system. It is not recommended to directly use an FTP service in the application to consume the files. The FTP server within the application would have to adhere to the monitoring and retrieving requirements. FTP file transfer as described within the scope of this SDK is tested with standard FTP servers, for example as supplied with Microsoft Internet Services.

5.5.2 Monitoring and Retrieving Files From the Scan to File Repository One of the most important aspects of monitoring and retrieving files from the scan to file repository is properly managing the .lck directory. Failure to do this properly can result in periodic unexpected results due to timing problems that might occur between the agent and other WCP/DCS manipulating files in that repository. The .lck file and scan image output are associated by sharing the same file name.

Example:

doc.lck & doc.xsm

doc.lck & doc.tif

doc.lck & doc.pdf

myscan.lck & myscan.tif

These .lck directory guidelines should be followed during implementation:

• Do not attempt to retrieve and/or process files while the .lck directory exists in the repository. This indicates that another client is manipulating files in the repository.

• If your application requires and processes the job logs (.xst files), pick them up before picking up image files.

• When a .lck directory exists have the agent also check the timestamp on the directory and compare it against the current time of day. If the lock is relatively old (e.g., more than 15 minutes old) have the agent post a warning message to the operator so that the directory can be inspected.

• If selecting to support a locking mechanism similar to the MFD, the agent/application may create its lock mechanism to identify the document that you are processing, prior to retrieving files from a repository. If


130

1709

171017111712171317141715171617171718

1719172017211722

172317241725

17261727172817291730

17311732173317341735

1736

1737

1738

1739

1740

1741

17421743

17441745

174617471748

17491750

131


your agent deletes the files from the repository once they have been retrieved/processed, delete the files BEFORE removing the lock mechanism.

• If using a locking mechanism, use it for identification of jobs being processed as well as crash recovery. Crash recovery mechanisms should be able to automatically remove locks that remain in the repository due to the abnormal termination of your program.

The following repository processing guidelines should be followed during implementation:

• Do not allow your agent/application to maintain a lock on a directory for too long a period of time. If data processing can take an extended period of time, consider copying/moving the files to another directory prior to processing the data. Scan jobs waiting to file on a WCP/DCS device may get aborted if it takes too long to clear the lock.

• For single page image formats (i.e., single page TIFF and JPEG), process the image files by enumerating the directory rather than depending on the <DocumentObjectName>.DAT file for the directory listing. If you do use the <DocumentObjectName>.DAT file, the code must verify that the image file extension is present and add it if it is missing.

• For single page image formats, use the .XSM directory name to derive the file base name used within the directory. (e.g., if the directory name is MyDoc001.XSM, the base name for files within the directory is MyDoc001.) This is particularly important when using the New Auto Generate filing policy.

• Although early devices limited the <DocumentObjectName> to 8 characters, use at least a 32 character storage string to hold this value. Future versions of the system may loosen this limitation.

• When implementing for a New Auto Generate filing policy, have the code check for both a truncated <DocumentObjectName> string and a non-truncated string. (e.g., if <DocumentObjectName> is ThisName, have it check for ThisN<3 digit number> and ThisName<3 digit number>. I.e., ThisN001 and ThisName001. The convention of truncating the name to 8 characters is not consistently enforced by all products.

• When checking for and retrieving files from the repository, it is advisable to check for all file formats even if your work procedure calls for storing only one type of format using a particular filing policy. (Recall that the output file format can be overwritten by the user at the UI.) Section 5.1.1 File Format describes what files are stored for each format and section 5.4 Filing Policies describes file name changes applied based on the filing policy used. The application should delete any formats or files that it is not able to process.

• When using the New Auto Generate filing policy, do not depend on the file number index to indicate what order the documents were scanned. As discussed previously, the system looks for the first available file/directory name available for the given <DocumentObjectName> within the repository. If an agent deletes files as they are processed, it is possible to have documents that were scanned later to have an “earlier” name index. If the order in which documents were scanned is important, you may need to check the timestamp on the file or use a single page file format in conjunction with the Append filing policy.

For details on processing multi-segment [Build Job] output see section 4.6.1 Processing multi-segment jobs.

5.5.3 Pseudo code sample for Repository ManagementThis is an example of pseudocode to illustrate monitoring a directory for scan output from Xerox MFDs. This example is specific to processing only multipage TIFF and PDF files with a job log. The application will move appropriate files to a ‘working directory’. This code also assumes a locking mechanism similar to Xerox MFD file locking is being used.CheckForDocsToProcess (){

Log into servercd to repository directoryfor all files with filenames starting with the correct "DocumentObjectName" or with the correct file extension,


132

17511752

175317541755

17561757

1758175917601761

1762176317641765

176617671768

17691770

17711772177317741775

17761777177817791780

178117821783178417851786

1787

17881789179017911792179317941795179617971798

133


{ if DocumentIsLocked(<file base name>) { //this document is busy...try again later skip this document (continue from the beginning of the for() loop) } if the file is a tif file

{create the file base name by deleting the .tif extension from the file nameif <file base name>.xst does NOT exist{

// the xst file is missing!?log an errordelete <file base name>.TIF

}else

MoveDocToWorkingDir(<file base name>, ".tif");}if the file is a pdf file{

create the file base name by deleting the .pdf extension from the file nameif <file base name>.xst does NOT exist{

// the xst file is missing!?log an errordelete <file base name>.pdf

}else

MoveDocToWorkingDir(<file base name>, ".pdf");}if the file is a .xsm directory{

// application doesn't support this format. Delete directory and contentscreate the file base name by deleting the .xsm extension from the file namelog an errorrmdir <file base name>.xsm

}

// We don't do anything with .xst files...they are processed above} // end for each file

} //end CheckForDocsToProcess

// This function checks to see if the document is locked and returns TRUE if it is and FALSE otherwise.// It also deletes the lock if it turns out the document was locked by us.

bool DocumentIsLocked (fileBaseName){

if fileBaseName.lck exists{

retrieve fileBaseName.lck/lockinfo.datif the lockinfo.dat is NOT ours

// file is locked, try again laterreturn TRUE;

else // something must have happened before, this is our lock{ // remove the lock...it will be restored later

rm fileBaseName.lck/lockinfo.datrmdir fileBaseName.lck

}}return FALSE;

}


134

179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861

135


MoveDocToWorkingDir (fileBaseName, extension){

// lock the document so no one messes with it while we copy themIf (mkdir fileBaseName.lck) is NOT successful,

return //someone snuck in since the time we checked...we'll try again later

store fileBaseName.lck/lockinfo.dat // so we know its ours

// copy the files to a working directorycp fileBaseName.extension to our working directorycp fileBaseName.xst to our working directory

// delete the files from the repository, we are donerm fileBaseName.xst rm fileBaseName.extension

// remove the lockrm fileBaseName.lck/lockinfo.dat rmdir fileBaseName.lck

}

5.5.4 Avoiding the Need to Deal with the .LCK Directory If your application/workflow process does not need the job log file and you only wish to process multi-page output formats (i.e., multi-page TIFF or PDF), it is possible to use only the native operating system file locking mechanisms to avoid contention problems in the repository.

As mentioned in section 4.3.1.6 SuppressJobLog, the system can be configured to not store the job log with the job. When used in conjunction with a multi-page output format the result is only one file per job to be stored. Under this circumstance, the operating system’s file permissions mechanism should prevent two clients from operating on the same file at the same time. Locking the directory would then be redundant with the file protections offered by the operating system.

Although it is possible to integrate the system in this manner, implementation of a locking mechanism and the file processing guidelines are highly recommended.


136

18621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884

1885188618871888

18891890189118921893

18941895

1896

137


6 Integrating with Server Fax / Network FaxServer fax as implemented on the Xerox MFD is a particular case of network scanning. The document produced by the MFD is restricted to industry fax standards. The UI follows industry conventions. In general, the WorkCentre Pro supports the T.30 ITU FAX Standard and integrates with Fax solution providers that comply with the ITU Facsimile Specifications.

6.1 Server fax device level configuration

Server fax requires the configuration of the Fax Repository. Read section 3.2 Server Fax Setup for details.

Refer to SMTP Fax SDK for integrating with a Fax Repository configured via SMTP.

For other device level configurations that apply to server fax read sections 3.3 Secure workflows and 3.4 Otherdevice level configurations.

6.2 Server Fax UI options

There are two ways for users to initiate a [server] fax job at the MFD:

• The user may initiate a Fax job. This is the primary use case also called ‘walk-up fax’. The fax UI is the recommended method for integrating network fax services with the device.

• The user may initiate a Network Scan job, using a template with a pre-programmed fax service. In this case they are using the Network Scan UI and not the Fax UI. The scan UI does not support the fax attributes, so the user cannot change the fax number or fax time. A fax server application may support both these options.

The following table shows the devices that support these user interface options.

Table 13: Network Scan and Server Fax services availability per device model

No Server Fax

Walk-up Server Fax

Server Fax via Network Scan

DC 220/230/332/340/420/426ST WCP 123/128/133Xerox 4110 / 4590WC 7132 / 7228 / 7235 / 7245

DC425/426/430/432/440ST

DC240/255/265/460/470/480/490/535/545/555STWCP 32/35/40/45/2128/2636/3545 ColorWCP 35/45/55/65/75/90 /165/175 WCP 2xxWC 4150 / 7655 / 7665

6.2.1 Fax UIThe fax UI is specifically designed for third party fax server integration. It provides fax specific job programming features such as keypad dial string entry, special dial string soft panel entry and dial directory capabilities. It also


138

1897

1898189919001901

1902

1903

1904

19051906

1907

1908

19091910

1911191219131914

1915

1916

1917

191819191920

139


constrains job programming options to those needed for fax transmission. (e.g., scan resolution constrained to 200x100 and 200x200).

The following table compares the fax UI and the network scan UI.

Table 14: Fax attributes

Job Programming Parameter Fax UI

(Walkup Fax)

Network Scan UI

(Fax Using a Template)

Destination phone number Up to 50 characters per phone number. Characters constrained to only those applicable to fax dialing

Must be pre-programmed, at the time of template creation. No character limit or constraints. Not available at the device UI at the time of faxing.

Number of destinations Up to 50 phone numbers Must be pre-programmed, at the time of template creation. Not available at the device UI at the time of faxing.

Dial Directory Up to 30 programmable entries No support

Scan/transmission resolution Fine (200x200) / Standard (200x100)

Any scan resolution supported by the device. This is typically 200x200, 300x300, 400x400, and 600x600. (The fax server must convert to an appropriate transmission resolution if the selected scan resolution is not supported.)

Color Monochrome (black and white) only

Monochrome, gray-scale or color., as available on the MFD.

Send Time Immediate or specified time Must be pre-programmed, at the time of template creation. Immediate or specified time. Not available at the device UI at the time of faxing.

Image file format Single page TIFF Any supported format (Normally, single page TIFF, multi-page TIFF, PDF or JPEG)

Filing policy New Auto Generate New Auto Generate

Table 15: Compression Used for Server Fax - Walk-Up UI

Original Type Selected at LUI Compression

Text G4

Photo&Text G4

Photo G3

Halftone Photo (monochrome machines only)

G3

The following table shows dial string characters supported and their meaning:

Table 16: Dialing Characters (Walk Up Fax)


140

19211922

1923

1924

1925

1926

19271928

1929

141


Character Symbol

0, 1, 2, 3, 4, 5, 6, 7, 8, 9 0, 1, 2, 3, 4, 5, 6, 7, 8, 9Dial Pause ,Long Pause |Group Dial \Mask Data /

Password Check Switch SPulse to Tone Switch :

Wait for Network tone detection WLocal ID [+] character check +

Local ID [space] character check space

6.2.2 Scan template pre-programmed fax serviceThe fax service supports two attributes, PhoneNumber and FaxAfterTime.

PhoneNumber is an attribute of data type string. It can be multi-valued. The valid syntax is to enclose individual fax numbers in double quotes. If more than one fax number is specified then separate these by a comma.

FaxAfterTime has data type struct_timeofday. The syntax of this attribute is

struct_timeofday FaxAfterTime

struct {

int hours, minutes;

}

where hours is an integer between 00 to 23 and minutes is an integer between 00 to 59. If FaxAfterTime is not specified then the default is to fax immediately.

Example of a fax service specifying two numbers [1234567 and 9876543] to be faxed after 9:30 pm:[service xrx_svc_fax] { struct_timeofday FaxAfterTime = 21:30; string PhoneNumber = "1234567","9876543"; }end

6.2.3 Other optionsFor devices that do not support the fax UI vendors can use network scan with metadata fields, to integrate with a fax application. For example, you can define metadata entries to input the fax phone number and other fax related entries. By specifying the filing repository to be the directory being monitored by the fax server, you can send “fax” jobs to the fax server.

You can also use scan to email to input fax jobs to your system. Destination phone numbers can be passed as part of the email address string by defining format conventions for email addresses. A typical format used is: <phone number>@<fax server name> (e.g., [email protected]).

6.3 Implementing the Fax Server Connector

The two primary components of the Fax Server connector are the fax send processing component and the fax receive processing component.


142

19301931

19321933

1934

1935

1936

1937

1938

19391940

1941194219431944194519461947

19481949195019511952

195319541955

1956

19571958

143

mailto:[email protected]


The fax send processing component is responsible for monitoring the fax repository for output from the Xerox MFD, retrieving and converting them to fax transmittable format, transmitting the fax to the destination phone number(s) and printing/sending the confirmation report.

The fax receive component is responsible for receiving the fax transmissions and routing them to their destination location. This destination may be either a printer, or an email location or other electronic location.

6.3.1 Processing the Fax Send DataA fax application must at a minimum support the features and image transfer mechanisms defined by the fax UI:

• Single page TIFF that are stored in the fax repository under the New Auto Generate filing policy,

• 200x100 and 200x200 resolution images,

• multiple fax recipients with the dial string characters defined in Table 16 above, and

• time specified for faxing.

Vendors are encouraged to also support scans initiated through scan templates. This support would imply supporting additional image resolutions (200x200, 400x400, 600x600), image file formats (multi-page TIFF, PDF, JPEG), color modes (color, gray-scale), and filing policies (New exact, append, overwrite, gen date time). If a vendor chooses not to support all of these features, it must at least handle the input file(s) gracefully.

6.3.1.1 Job Processing Partitioning

The following table shows how the various job processing steps associated with fax job processing are partitioned between the Xerox device and the fax server. This table takes into account fax jobs initiated from both the fax UI and the network scan UI.

Feature Xerox Device Responsibilities Fax Server Responsibilities

File transfer to the fax server

Transfer image and job log to fax repository per protocol settings.

Monitor fax repository, retrieve image and job log to temp store, delete image and job log from fax repository.

Record and process fax destination phone numbers

Set PhoneNumber attribute in XRX_SVC_FAX section with phone numbers, including any special dialing characters. Each phone number string is enclosed in double quotes. Multiple numbers are separated by comma.

Read the PhoneNumber attribute in the job log and interpret any special dialing characters.

Resolution Output the image of selected resolution. Set XRX_DOCUMENT Attribute Resolution to FAX FINE, FAX STANDARD, 200x200, 300x300, 400x400 or 600x600.

Scale and resolution convert images as needed to accomplish fax. The fax vendor is required to pad/scale outgoing fax documents to a width of 1728 pixels. The fax vendor is also required to retain the integrity of the images sent.

Send Time If FAX is to be delayed set FaxAfterTime attribute of XRX_SVC_FAX to the requested time. The format is Hours:Minutes in 24-hour time with range of 00:00 to 23:59. The default Delayed Start value is 00:00.

Read FaxAfterTime attribute from XRX_SVC_FAX in job log.


144

195919601961

19621963

19641965

19661967196819691970197119721973

1974

197519761977

145


Fax transmission header The fax vendor must supply the Transmission Header. The sender of a fax, not the sending device must, by US law, identify the date, time, and telephone number of the sending fax device. The user has the ability to automatically generate the date, time, and telephone number of the sending device on the header of each page of the fax.

Fax cover sheet The fax vendor may automatically generate a cover sheet that is sent as the first page of the document. The cover sheet may contain the following information:

• Title• To:• From:• Destination Telephone

Number• Telephone Number of

Sending Fax Device• Fax Transmission Date• Fax Transmission Time

Fax Send Confirmation Set XRX_SVC_GENERAL attribute OutputURL to service:printer:lpr://x.x.x.x where x.x.x.x is the IP address of the originating MFD.

Print Fax Send Confirmation to originating Xerox device (using IP address & LPR). Or send confirmation according to other user specified configurations.

Transmission Report Set XRX_SVC_GENERAL attribute OutputURL to service:printer:lpr://x.x.x.x where x.x.x.x is the IP address of the originating MFD.

Send Transmission Report back to originating Xerox device using IP address & LPR. Or emit transmission report according to other user specified configurations.

Image selection (for template fax only - Document Format).

Write out black and white / grayscale / color single-page / multi-page TIFF / PDF / JPEG files. Set DocumentFormat and ColorMode per user settings.

Monitor repository directory and process contents.

It is the responsibility of the Fax Application to convert the image to fax formats.

Fax Sender Set XRX_SVC_GENERAL attribute NetworkUsername to <domain>/<userid>.

It is the responsibility of the Fax Application to read the userid and domain. The Fax Application may attempt an LDAP query to gather more user context information, for example the email address of the user, to send a Fax Confirmation to the user’s email inbox.


146

147


JBA data Set AcctName and AcctValue attributes in the job log.

Read the attributes from the job log and use them as appropriate. They can be inserted in the print stream of the fax confirmation directed at the scan originating MFD.

6.3.1.2 Monitoring the Fax Repository

For details on how the MFD transfers the files to the fax repository read section 5.3 File Transfer. For details on the image read section 5.1 Image. The fax repository monitoring component should be implemented consistent with the guidelines define in the sections 5.5.2 Monitoring and Retrieving Files From the Scan to File Repository, and 5.5.3 Pseudo code sample for Repository Management.

6.3.1.3 Parsing the Job Log

The job log is a specially formatted ASCII text file storing the job programming and execution parameters for the Fax job. It contains the following important pieces of information that will be needed to process the job:

• The IP address of the device that submitted the fax job.

• The network authenticated user name of the person that submitted the job (if network authentication was enabled).

• The destination phone numbers for the fax job.

• The transmission scheduling requirements for the job.

• The JBA data, user ID and account ID.

Vendors are encouraged to use the Parser SDK to read the job log whenever possible.

6.3.1.3.1 Reading the Destination Phone Number and Fax After TimeThe presence of a xrx_svc_fax section within the job log indicates that the job requires fax job processing. If this section is missing from the job log, then no fax processing is required. Entries within this section of the job log .xst file are described in the following table.

Attribute Name Description

PhoneNumber A list of destination fax numbers. Each phone number is surrounded by double quotes and is separated by a comma from the next entry. The phone number is recorded exactly as entered by the user and must be interpreted consistent with the definitions in Table 16.

Note that “\” (backslash) is the parser escape character, and therefore if backslash is within the dial string, they are represented as \\ and \” respectively.

FaxAfterTime If present, the time that the job should be transmitted. The time is represented in military time. If this entry is missing or is blank, the job should be transmitted immediately.

Examples of the fax service invocation in a job log follow:


148

1978

1979

1980198119821983

1984

19851986

198719881989

1990199119921993

1994199519961997

1998

19992000

2001

149


Example of Fax Service in Job Log:

[service xrx_svc_fax] { struct_timeofday FaxAfterTime = 18:30; string PhoneNumber = "79662"; }endExpected interpretation of this Fax Service by the Fax Application:

PhoneNumber = "79662" Fax to number : 79662FaxAfterTime = 18:30 This is a Delayed Fax, store and fax after 6:30 pm, not earlier.

Example2 of Fax Service in Job Log (.xst file):

[service xrx_svc_fax] { ref_invocation InputDocument = xrx_document:FiledDocument; string PhoneNumber = "9874652", "123,456,6789"; }endExpected interpretation of this Fax Service by the Fax Application:

PhoneNumber = "9874652", Fax to number : 9874652"123,456,6789"; Fax to number : 123,456,6789

6.3.1.3.2 Reading the Device IP Address and Authenticated User NameFor other data of interest in the job log see sections 4.7.1 Scanner IP address: OutputURI / OutputURL, 4.7.2 Authenticated user name: NetworkUsername and 4.7.3 JBA data: AcctName and AcctValue.

The device IP address is required for printing the fax confirmation to the originating scanner. JBA values may inserted in the print stream to correctly account for the job.

6.4 Fax Confirmations

The fax server should be able to print and/or send via email, a transmission report indicating whether or not the fax transmission was successful. Printed transmission reports should be printed at the scanning device. Emailed transmission reports should be sent to the logged in user who initiated the fax.

The emailed or printed confirmation reports should contain the fax transmission job programming parameters as well as an image of the first page of the original outbound fax.

6.4.1 Printed Fax ConfirmationsPrinted transmission reports can be sent to the scanning device by using the IP address available in the OutputURL attribute in the job log. If the OutputURL is not available the server should print the confirmation at an alternative printer that the user had previously defined. Follow the guidelines specified in section 6.5.1Printing Jobs on theWC/WCP/DCS to create and send the print job to the device.


150

2002

2003200420052006200720082009

201020112012

2013

2014201520162017201820192020

20212022

202320242025

20262027

2028

202920302031

20322033

20342035203620372038

151


6.4.2 Fax Confirmations via EmailEmailed transmission reports can be sent to the user. The NetworkUsername attribute can be used along with an LDAP query to ascertain the email address of that user. If the NetworkUsername is not available in the job log, the confirmation report should be printed in accordance with section 6.4.1 Printed Fax Confirmations.

6.5 Processing Received Faxes

The fax server should be able to print and/or send via email received faxes. The user should be provided the means to specify which printer should be used for printing received faxes.

6.5.1 Printing Jobs on the WC/WCP/DCSThere are two main ways to send print jobs to the device:

• You can print using the device print driver.

• You can generate a print stream and send the job directly to the device.

If you currently generate an application file such as PDF, RTF or TIF, you may find it simpler to use the Xerox driver that was provided for that device to do your printing.

The following sections provide additional information on both approaches.

6.5.1.1 Printing Jobs via the Driver

You can print jobs by automatically loading them in an application and printing them via the device’s print driver. Device drivers allow you to set appropriate defaults, including the network accounting parameters to use, the default media type and color, the output tray location and suppressing the banner sheet.

Although this method is probably the easiest to implement, the following shortcomings should be noted:

• The correct print driver for that particular model should be used. This means that all devices that you are likely to print to must be installed as part of the setup process.

• Since all print jobs that are going to a particular printer are using the same driver settings, custom settings on a per job basis are not available. Thus, for example, in a network accounting environment, you could not charge a confirmation report or received fax to a particular user.

6.5.1.2 Printing Jobs by Sending Directly to the Printer

PCL printing via LPR is the recommended method for submitting jobs to a device. Most WC/WCP/DCS devices support PCL 5, Postscript 3, PDF and TIFF printing.

In order to ensure that the data stream can successfully be printed on the WC/WCP/DCS device, the application should generate a self-contained PCL 5 compatible data stream and only use the set of permanent fonts available on the device. Fonts outside of the permanent set of fonts should be downloaded as part of the data stream. Each job should be self-contained and not assume that sequentially submitted jobs will process in the order submitted or that other intervening jobs will not be introduced. Multiple jobs should not be concatenated together as this type of data stream is not supported on Xerox devices.

Media size, plex, and page orientation should be defined using the standard PCL commands. Input and output tray selections should be made through the appropriate PCL command but the specific tray index may vary across the devices. Note that it is generally recommended that you NOT specify a specific input tray for media selection but rather specify the media size, type and color instead. The device will select the appropriate tray based on the media specifications provided.


152

2039204020412042

2043

20442045

20462047

2048204920502051

2052

2053

205420552056

2057

20582059

206020612062

2063

20642065

206620672068206920702071

20722073207420752076

153


Access to Xerox device specific features is typically made through a PJL comment inserted at the beginning of the data stream. Attributes such as media type and color, finishing requirements, job name, job owner, job type and banner sheet enable/disable are defined through these comments.

The following table shows the device specific PCL commands and PJL comments that would be of most interest to an application developer.

Table 17: PJL commands

[refer to the PDL Guides posted at www.xerox.com for full details]

[default values depend on device hardware options installed]

Print Feature

DC240/255/265DC460/470/480/490

DC555/545/535 WorkCentre Pro

DC340/332/230/220DC440/432/430/426/425/420

Simplex <esc> & l int S where int is 0 = simplex or @ PJL COMMENT OID_ATT_SIDES n; where 1 = simplexDuplex <esc> & l int S where int is 1=duplex long edge binding 2=duplex short edge binding

or @ PJL COMMENT OID_ATT_SIDES n; where 2 = duplexDo not duplex any job with media smaller than A6

Number of Copies

<esc> & l int Xor @PJL SET COPIES = intwhere int is 1 to 9999 (1 to 999 for DC2xx devices)

<esc> & l int Xor @PJL SET COPIES = int

where int is 1 to 9999

<esc> & l int Xor @PJL SET COPIES = int

where int is 1 to 999Media Sizeuse with Media Type

<esc> & l int A where int is 2=NA_LETTER3=NA_LEGAL26=ISO_A4

Media Type NOTE: Use this command in conjunction with the Media Size and Media Color commands.

@PJL COMMENT OID_ATT_DEFAULT_MEDIUM_TYPE_”value” Where value is one of the following: standard, transparency, labels, drilled, recycled, preprinted, heavyweight, other.

@PJL COMMENTOID_ATT_DEFAULT_MEDIUM_TYPE“value”Where value is one of the following:bond, letterhead, standard, transparency, labels, drilled, recycled, preprinted, cardstock, other, system-default, envelopes, tabs, Custom1 – Custom7

@PJL COMMENT OID_ATT_DEFAULT_MEDIUM_TYPE_”value”Where value is one of the following: Standard, Transparency, labels, drilled,recycled, preprinted, tabs, heavyweight, other

Media ColorNOTE: Use in conjunction with Media Size and Media Type

@PJL COMMENTOID_ATT_DEFAULT_MEDIUM_ COLOR “value”Where value is one of the following: yellow, green, buff, white, red, ivory, gray, clear, pink, goldenrod, orange, blue, other.

@PJL COMMENTOID_ATT_DEFAULT_MEDIUM_ COLOR “value”Where value is one of the following:buff, blue, clear, gray, green, ivory, orange, other, pink, red, white, yellow, goldenrod, unspecified, Custom1 - Custom 7.

@PJL COMMENTOID_ATT_DEFAULT_MEDIUM_ COLOUR valueWhere value is one of the following:Yellow, green, buff, white, red, ivory, gray, clear, pink, goldenrod, orange, blue, other

Media Source

<esc> & l int HWhere int is one of the following:0 = Auto Select1 = Tray 12 = Bypass Tray4 = Tray 25 = High Capacity Feeder23 = Tray 324 = Tray 4

<esc> & l int HWhere int is one of the following:0 = Auto Select1 = Tray 14 = Tray 223 = Tray 3 (High Capacity)24 = Tray 4 (High Capacity)2 = Bypass Tray

<esc> & l int HWhere int is one of the following:0 = Auto Select1 = Tray 12 = Tray 23 = Tray 34 = Tray 45 = High Capacity Feeder6 = Bypass Tray


154

207720782079

20802081

2082

2083

2084

155


Output Location

DC 460/470 ST only@PJL COMMENTOID_ATT_OUTPUT_BINS valueWhere value can be one of the following:OID_VAL_OUTPUT_BIN_TOPOID_VAL_OUTPUT_BIN_MAIN

@PJL COMMENTOID_ATT_OUTPUT_BINS valueWhere value can be one of the following:With a catch tray:OID_VAL_OUTPUT_BIN_SIDEWith a 2000 Sheet Stapler/Stacker (Office Finisher)OID_VAL_OUTPUT_BIN_TOPOID_VAL_OUTPUT_BIN_STACKER

<esc> & l int GWhere int is one of the following:TopTray, Stacker, SideTray,2 = bin 1, 3 = bin 2, 4 = bin 3, 5 = bin 4, 6 = bin 5, 7 = bin 6, 8 = bin 7, 9 = bin 8, 10 = bin 9, 11 = bin 10

Secure Print @PJL COMMENT OID_ATT_JOB_TYPE OID_VAL_JOB_TYPE_SECURE_PRINT;@PJL COMMENT OID_ATT_JOB_PASSWORD “string”

Stapling @PJL COMMENT OID_ATT_FINISHINGOID_VAL_FINISHING_STAPLE;@PJL COMMENT XRXSTAPLE = valueWhere value is one of the following:PORTRAIT(the Document Centre uses the StapleHead at the front – Staple Head 1)DUAL

@PJL COMMENT OID_ATT_FINISHINGOID_VAL_FINISHING_STAPLE;@PJL COMMENT XRXSTAPLE = valueWhere value is one of the following:PORTRAITLANDSCAPEDUAL

@PJL COMMENT OID_ATT_FINISHING value;Where value is one of the following:OID_VAL_FINISHING_STAPLEOID_VAL_GENERIC_NONE

Collation @PJL COMMENT OID_ATT_OUTPUT valueWhere value is one of the following: OID_VAL_OUTPUT_PAGE_COLLATEOID_VAL_OUTPUT_NO_PAGE_COLLATE

Job Name @PJL COMMENT OID_ATT_JOB_NAME “string”Where string is a maximum of 40 characters

Job Owner @PJL COMMENT OID_ATT_JOB_OWNER “string”Where string is a maximum of 40 characters

JBA enabled environment

@PJL COMMENT OID_ATT_JOB_COMMENT "FaxPrintJob"

JBA @PJL COMMENTOID_ATT_ACCOUNTING_INFORMATION"UserID|042AccountID";Where UserID is a value the Printer Administrator has assigned to a user. Where AccountID is a value the Printer Administrator has assigned to the account.NOTE: You must delimit the User ID and the Account ID with a |042.

(DC 440/432/ 425 only)@PJL COMMENTOID_ATT_ACCOUNTING_INFORMATION“UserID|042AccountID”;Where UserID is the value the printer administrator has assigned to a user. Where AccountID is the printer administrator has assigned to the account.

Orientation <esc> & l int O where int =0=Portrait1=Landscape

<esc> & l int O Where int is one of the following:0 = Portrait1 = Landscape2 = Rotated Portrait3 = Rotated Landscape

<esc> & l int O where int =0=Portrait1=Landscape

Banner Sheet

@PJL COMMENT OID_ATT_START_SHEET valueWhere value is OID_VAL_JOB_SHEET_FULL (on) OID_VAL_JOB_SHEET_NONE (off)

@PJL COMMENTOID_ATT_START_SHEET value;Where value is one of the following:OID_VAL_JOB_SHEET_FULL (On)OID_VAL_JOB_SHEET_NONE (Off)


156

157


PJL required <ESC>%-12345X@PJL JOB<PJL SET COMMANDS>@PJL COMMENT XRXbegin<XRX PJL COMMENTS>@PJL COMMENT XRXend<print stream><esc>%-12345X

Print Feature WC 76xxSimplex/ Duplex

<esc> & l int S where int is 0 = simplex 1=duplex long edge binding 2=duplex short edge bindingor @ PJL COMMENT OID_ATT_SIDES n; where 1 = simplex 2 = duplex

Number of Copies <esc> & l int X or @PJL SET COPIES = int where int is 1 to 9999

Media Sizeuse with Media Type

<esc> & l int A where int is 2=NA_LETTER3=NA_LEGAL26=ISO_A4

Media Type NOTE: Use this command in conjunction with the Media Size and Media Color commands.

@PJL COMMENT OID_ATT_DEFAULT_MEDIUM_TYPE_”value”Where value is one of the following: Standard,

Media ColorNOTE: Use in conjunction with Media Size and Media Type

@PJL COMMENTOID_ATT_DEFAULT_MEDIUM_ COLOUR “value”Where value is one of the following:buff, blue, clear, gray, green, ivory, orange, other, pink, red, white, yellow, goldenrod, unspecified, Custom1 - Custom 7.

Media Source <esc> & l int HWhere int is one of the following:0 = Auto Select1 = Tray 14 = Tray 223 = Tray 3 (High Capacity)24 = Tray 4 (High Capacity)2 = Bypass Tray5 = High Capacity Feeder Tray 6

Output Location @PJL COMMENT OID_ATT_OUTPUT_BINS value where value can be one of the following:OID_VAL_OUTPUT_BIN_MIDDLE (non stacker)OID_VAL_OUTPUT_BIN_TOPOID_VAL_OUTPUT_BIN_STACKER (stacker)

Print color mode @PJL COMMENT OID_ATT_COLOR_MODE valueWhere value is one of the following:OID_VAL_COLOR_MODE_BLACK_WHITE; [B&W]OID_VAL_COLOR_MODE_AUTOMATIC; [Automatic]

Secure Print @PJL COMMENT OID_ATT_JOB_TYPE OID_VAL_JOB_TYPE_SECURE_PRINT;@PJL COMMENT OID_ATT_JOB_PASSWORD “string”

Stapling @PJL COMMENT XRXSTAPLE = valueWhere value is one of the following:PORTRAIT [1 staple]DUAL [2 staples] @PJL COMMENT OID_ATT_FINISHING OID_VAL_FINISHING_STAPLE_MULTIPLE; [4 staples];

Collation @PJL COMMENT OID_ATT_OUTPUT valueWhere value is one of the following:


158

2085

159


OID_VAL_OUTPUT_PAGE_COLLATE; [collate]OID_VAL_OUTPUT_NO_PAGE_COLLATE; [do not collate]

Job Name @PJL COMMENT OID_ATT_JOB_NAME “string”Where string is a maximum of 40 characters

Job Owner @PJL COMMENT OID_ATT_JOB_OWNER “string”Where string is a maximum of 40 characters


@PJL COMMENT OID_ATT_JOB_COMMENT "FaxPrintJob"

JBA @PJL COMMENT OID_ATT_ACCOUNTING_INFORMATION_AVP “XRX_USERID,UserID”;@PJL COMMENT OID_ATT_ACCOUNTING_INFORMATION_AVP “XRX_ACCTID,AccountID”;Where UserID is the value the printer administrator has assigned to a user. Where AccountID is the printer administrator has assigned to the account.

Orientation <esc> & l int O where int =0=Portrait1=Landscape

Banner Sheet @PJL COMMENT OID_ATT_START_SHEET valueWhere value is OID_VAL_JOB_SHEET_FULL (on) OID_VAL_JOB_SHEET_NONE (off)

PJL required <ESC>%-12345X@PJL JOB<PJL SET COMMANDS>@PJL COMMENT XRXbegin<XRX PJL COMMENTS>@PJL COMMENT XRXend<print stream><esc>%-12345X

Print Feature

WC 7132 WC 7228 / 7235 / 7245

WCP 123 / 128 / 133 WC 4150

Simplex @PJL SET DUPLEX = value1Where value1 is one of the following:OFF: simplexOR<ESC>&l int S where int is one of the following:0: simplex

@PJL COMMENT OID_ATT_PLEX OID_VAL_PLEX_SIMPLEX = simplex

OR

@PJL COMMENT OID_ATT_SIDES 1 = simplex

Duplex @PJL SET DUPLEX = value1@PJL SET BINDING = value2Where value1 is ON: duplexWhere value2 is one of the following:LONGEDGESHORTEDGE(value2 is used combined with value1=ON)OR<ESC>&l int SWhere int is one of the following:1: Duplex Long Edge Binding2: Duplex Short Edge Binding

<ESC>&l2S (short edge bind) <ESC>&l1S (long edge bind)@PJL COMMENT OID_ATT_SIDES 2 = duplexor @PJL COMMENT OID_ATT_PLEX OID_VAL_PLEX_DUPLEX = duplex

Number of Copies

@PJL SET COPIES = in where int is: 1～999(This parameter used for uncollated mode.)OR<ESC>&l int X where int is: 1～999

@PJL SET COPIES = [1 < =n <= 9999]


160

2086

161


Media Sizeuse with Media Type

@PJL SET PAPER = valueWhere value is one of the following:A4LEDGER : 11x1711x15LEGAL : 8.5x14JISEXEC : 8.5x13LETTER : 8.5x118x10EXECUTIVE : 7.25x10.5CUSTOM : Custom paperOR<ESC>&l int AWhere int is one of the following:2 : Letter (8.5x11)3 : Legal (8.5x14)6 : Ledger (11x17)26 : A440 : 8.5x13101 : Custom135 : 8x10

@PJL SET PAPER = valueWhere value is one of the following:B4B5LETTER = 8.5x11LEGAL = 8.5x14A4JISEXECLEDGER = 11x17CUSTOM = Custom paperOR<ESC>&l int AWhere int is one of the following:2 = Letter (8.5 x 11)3 = Legal (8.5 x 14)6 = Ledger (11x17)26 = A4

<ESC>&l int AWhere int is one of the following:2 = Letter (8.5 x 11)3 = Legal (8.5 x 14)25 = A542 = A526 = A445 = B5 (JIS)46 = B4 (JIS)

Media Source

@PJL SET MEDIASOURCE= valueWhere value is one of the following:TRAY1 : Feed from paper tray1TRAY2 : Tray2TRAY3 : Tray3TRAY5 : SMHOR<ESC>&l int HWhere int is one of the following:0: Feed paper from default tray4 : Tray11 : Tray25 : Tray320 = Auto2 or 3 = SMH

@PJL SET MEDIASOURCE= valueWhere value is one of the following:TRAY1 : Feed from paper tray1TRAY2 : Tray2TRAY3 : Tray3TRAY4 : Tray4TRAY5 : SMHOR<ESC>&l int HWhere int is one of the following:0: Feed paper from default tray4 : Tray11 : Tray25 : Tray38 : Tray420 = Auto2 or 3 = SMH

@PJL SET MEDIASOURCE= valueWhere value is one of the following:TRAY1 = Feed from paper tray1TRAY2 = Tray2TRAY3 = Tray3TRAY4 = Tray4TRAY5 = SMHOR

<ESC>&l int HWhere int is one of the following:0 = Feed paper from default tray4 = Tray11 = Tray25 = Tray38 = Tray420 = Auto2 or 3 = SMH

<ESC>&l int HWhere int is one of the following:0=Autoselect tray 1=tray12= Bypass Tray, 4=tray2, 6=envelope feeder, 23=Tray 3 24=Tray 4

OutputLocation

@PJL SET OUTBIN = valueWhere value is one of the following:UPPER : Main trayMAINTRAY: Main trayCENTERTRAY : Main tray

@PJL SET OUTBIN = valueWhere value is one of the following:UPPER : Main trayMAINTRAY: Main trayCENTERTRAY : Main tray

@PJL SET OUTBIN = valueWhere value is one of the following:UPPER = Main trayMAINTRAY = Main trayCENTERTRAY = Main tray


162

163


LOWER : Side traySIDETRAY : Side trayOUTBIN101 : Finisher tray

LOWER : Side traySIDETRAY : Side trayMAINTRAY3 : Top tray (w/ C-Finisher)OUTBIN101 : Finisher tray (w/ B-Finisher orC-Finisher)BOOKLETTRAY : Booklet tray (w/C-Finisher and booklet module)

OUTBIN101 = Finisher stacker

Secure Print @PJL SET HOLD = value1Where value1 is one of the following:PROOF: proof printSTORE: confidential print (secureprint)BOXSTORE: box accumulation

@PJL SET HOLDTYPE =value2Where value2 is one of the following:PRIVATE: need passwordPUBLIC: don’t need password

@PJL SET HOLDKEY ="four-digit string"The HOLDKEY variable acts as a passwordwithout encryption to protect a held job.Four-digit string can be any four-digit valuefrom 0000 to 9999. The default value is “”.Example Password: 1234<ESC>%-12345X@PJL JOB MODE=PRINTER<CR><LF>@PJL SET HOLD=STORE <CR><LF>@PJL SET HOLDTYPE=PRIVATE <CR><LF>@PJL SET HOLDKEY="1234"<CR><LF>@PJL SET USERNAME="Nagaoka" <CR><LF>@PJL SET JOBNAME="Job1" <CR><LF>

@PJL SET HOLD = value@PJL SET HOLDKEY="four-digit string"The HOLDKEY variable acts as apassword to protect a held job.The variable value can be anyfour-digit value from 0000 to 9999. Thedefault value is “”.

@PJL COMMENT OID_ATT_JOB_PASSWORD "number"; where number = encrypted string of 4 to 10 bytes longLength of String used to

Secure encrypt Secure

Print ID Print ID

4 Pkde

5 Pkdep

6 Pkdepk

7 Pkdepkd

8 Pkdepkde

9 Pkdepkdep

10 Pkdepkdepk

Stapling @PJL SET STAPLE = valueWhere value is one of the following:TOPDUALTOPLEFT

@PJL SET STAPLE = valueWhere value is one of the following:

OID_ATT_FINISHING value

Where “value” is one ofOID_VAL_FINISHING_STAPLE


164

165


TOPRIGHTBOTTOMDUALBOTTOMLEFTBOTTOMRIGHTLEFTDUALRIGHTDUALSADDLENONE

TOPDUALTOPLEFTTOPRIGHTBOTTOMDUALBOTTOMLEFTBOTTOMRIGHTLEFTDUALRIGHTDUALNONE

OID_VAL_GENERIC_NONE

@ PJL COMMENT XRXSTAPLE = PORTRAIT@ PJL COMMENT XRXSTAPLE = LANDSCAPE

Collation @PJL SET QTY = int where int is: 1～999(If you use this parameter, it also indicate use collate mode automatically.)

@ PJL COMMENT OID_ATT_OUTPUT value:Where value is:OID_VAL_OUTPUT_PAGE_ COLLATE for Collate ONOID_VAL_OUTPUT_NO_PAGE_ COLLATE for Collate OFF

Job Name ＠PJL SET JOBNAME = “jobname-string”Where jobname-string is a maximum of 32 charactersExclude 「”」(22H) character

@PJL COMMENT OID_ATT_JOB_NAME "<string>";

Job Owner Example:@PJL SET USERNAME="Nagaoka"

@PJL COMMENT OID_ATT_JOB_OWNER "<string>";


@PJL COMMENT OID_ATT_JOB_COMMENT "FaxPrintJob"Requires enablement at the device LUI.

Orientation @PJL SET ORIENTATION= valueWhere value is one of the following:PORTRAITLANDSCAPEOR<ESC>&l int OWhere int is one of the following:0: Portrait1: Landscape2: Reverse Portrait3: Reverse Landscape

<ESC>&l int OWhere int is one of the following:0: Portrait1: Landscape2: Reverse Portrait3: Reverse Landscape

Banner Sheet

@PJL SET JOBATTR=“@BANR=value”Where value is one of the following:START: start sheetDEVICE: depend on device settingOFF: no banner sheet

@PJL COMMENT OID_ATT_START_SHEET value; value = OID_VAL_JOB_SHEET_NONE

OID_VAL_JOB_SHEET_FULL

Job BasedAccounting

@PJL SET JOBATTR = “@JOAU = string1”@PJL SET JOBATTR = “@JOAP = string2”@PJL SET JOBATTR = “@DAID = string3”Where string1 is a maximum of 32 character (legal value: 20H-7EH) as job owner (Capital character & small character is distinguished)

@PJL SET JOBATTR =“@JOAU = string”Where string is a maximum of 32character(Capital character & small character isdistinguished)

@PJL COMMENT OID_ATT_ACCOUNTING_INFORMATION_AVP "XRX_USERID,<user>";

@PJL COMMENT OID_ATT_ACCOUNTING_INFORMATION_AVP "XRX_ACCTID,<account>";


166

167


Where string2 is a maximum of 12 character (legal value: 20H-7EH) as password without encryption. It can be null (zero length string)Where string3 is a maximum of 32 character (legal value 20H-7EH) as account ID. It can be null (zero length string)

Where <user> and <account> are assigned values.

PJL required <ESC>%-12345X@PJL JOB MODE=PRINTER<PJL SET>@PJL ENTER LANGUAGE=PCL<print stream><ESC>%-12345X@PJL EOJ

6.5.1.2.1 Using PJL CommentsXerox specific PJL comments must be inserted in the data stream in a specific format in order to be recognized by the system. The comments must be enclosed in a XRXbegin – XRXend block at the beginning of the data stream.

<ESC>%-12345X@PJL JOB<PJL SET COMMANDS>@PJL COMMENT XRXbegin<XRX PJL COMMENTS>@PJL COMMENT XRXend<print stream><esc>%-12345XThese lines have the following function:

• <esc>%-12345X@PJL is the standard UEL command as defined in the PCL lanaguage manual.

• XRXbegin denotes the beginning of Xerox specific PJL comments.

• XRXend denotes the end of Xerox specific PJL comments.

A data stream can only have one XRXbegin -XRXend block. If more than one block exists the resulting behavior is not defined.

It is good practice to end the data stream with the Exit UEL command:

<esc>%-12345XSee the following example:

<esc>%-12345X@PJL@PJL COMMENT XRXbegin@PJL COMMENT OID_ATT_JOB_OWNER "Joe Xerox";@PJL COMMENT OID_ATT_JOB_NAME "Received Fax Job";@PJL COMMENT OID_ATT_JOB_TYPE OID_VAL_JOB_TYPE_PRINT;@PJL COMMENT OID_ATT_START_SHEET OID_VAL_JOB_SHEET_NONE;@PJL COMMENT OID_ATT_DEFAULT_MEDIUM_TYPE "Recycled";@PJL COMMENT OID_ATT_DEFAULT_MEDIUM_COLOUR "Orange";@PJL COMMENT OID_ATT_FINISHING OID_VAL_FINISHING_STAPLE;@PJL COMMENT OID_ATT_OUTPUT OID_VAL_OUTPUT_PAGE_COLLATE;@PJL COMMENT XRXend


168

2087

20882089

2090

2091209220932094209520962097

2098

20992100210121022103

2104

2105

2106

21072108210921102111211221132114211521162117

169


6.5.1.2.2 Working in Network Accounting Enabled EnvironmentsIn order to ensure that your fax server application works in a network accounting enabled environment, you must add the OID_ATT_JOB_COMMENT to your data stream:

<esc>%-12345X@PJL@PJL COMMENT XRXbegin@PJL COMMENT OID_ATT_JOB_COMMENT "FaxPrintJob"@PJL COMMENT XRXend

OID_ATT_JOB_COMMENT "FaxPrintJob" specifies that this is a fax print job and should bypass network accounting validation.

6.5.1.2.3 Printing With or Without a Banner SheetA banner sheet is a sheet that is printed at the beginning of each job that makes it easier for users to locate their jobs in a workgroup environment. The banner sheet contains user name and job name information.

The OID_ATT_START_SHEET comment specifies if the job should emit a banner sheet when printed. The comment value OID_VAL_JOB_SHEET_FULL specifies that the banner should be printed with this job. The comment value OID_VAL_JOB_SHEET_NONE specifies that the banner should not be printed with this job. If the comment does not appear, the banner sheet is printed based on the system administrator (SA) setting at the device. It is recommended that either you don’t include the OID_ATT_START_SHEET comment (i.e., let the banner print based on the SA setting) or you specify that a banner should not be printed.

The following sample comment sections specifies that banner should not be printed:

<esc>%-12345X@PJL@PJL COMMENT XRXbegin@PJL COMMENT OID_ATT_JOB_COMMENT "FaxPrintJob"@PJL COMMENT OID_ATT_START_SHEET OID_VAL_JOB_SHEET_NONE;@PJL COMMENT XRXend

If you choose to let the banner be printed based on the SA setting at the device, be sure to specify the job owner and job name as explained in the next section. This will make the banner more useful and produce banners that have meaningful job names and user names.

6.5.1.2.4 Specifying the Job Owner and Job Name

A meaningful job name and user name should be specified in the comment section in order for useful entries to be displayed on the WCP/DCS job queue and for banner sheets to contain meaningful information.

For fax confirmation sheets, a job owner name based on the logged in user name and a job name based on the destination fax number (e.g., “Fax confirmation for 555-1234”) is recommended. For received faxes, a job owner name based on the fax server name (e.g., “Fax Server ABC”) and a job name based on the sending device (e.g., “Fax from 555-4321”) is recommended.

<esc>%-12345X@PJL@PJL COMMENT XRXbegin@PJL COMMENT OID_ATT_JOB_OWNER "Fax Server ABC";@PJL COMMENT OID_ATT_JOB_NAME "Fax from 555-4321";@PJL COMMENT OID_ATT_JOB_COMMENT "FaxPrintJob"@PJL COMMENT XRXend


170

21182119

21202121

212221232124

21252126

212721282129

2130213121322133

21342135

2136

21372138213921402141214221432144

2145

21462147

21482149215021512152

215321542155215621572158

171


6.5.1.2.5 Submitting Secure Print Jobs

A secure print job is a job that is held at the WCP/DCS device until a user comes to the device and enters a 4-digit PIN to release the job for printing. You can specify a job to be a secure print job by including the following 2 comments in the XRX header block:

@PJL COMMENT OID_ATT_JOB_TYPE OID_VAL_JOB_TYPE_SECURE_PRINT;@PJL COMMENT OID_ATT_JOB_PASSWORD “string”

The PIN number is encoded based on the mapping shown in Table 18. The following example shows how the pin 1234 would appear in the header:

<esc>%-12345X@PJL@PJL COMMENT XRXbegin@PJL COMMENT OID_ATT_JOB_OWNER "Fax Server ABC";@PJL COMMENT OID_ATT_JOB_NAME "Fax from 555-4321";@PJL COMMENT OID_ATT_JOB_COMMENT "FaxPrintJob"@PJL COMMENT OID_ATT_JOB_TYPE OID_VAL_JOB_TYPE_SECURE_PRINT;@PJL COMMENT OID_ATT_JOB_PASSWORD “AYWQ”@PJL COMMENT XRXend

Table 18: Secure Print Password encoding for 4-digit password

Number Thousands Hundreds Tens Units0 @ [ T U1 A Z U T2 B Y V W3 C X W V4 D _ P Q5 E ^ Q P6 F ] R S7 G \ S R8 H S \ ]


172

2159

216021612162

21632164216521662167

2168216921702171217221732174

2175

2176

21772178

173


7 Appendices

Appendix A: Devices Covered by this SDK

The software versions listed in the tables below are the documented major releases for the products covered in this SDK. A software release can apply to multiple models. Incremental releases not listed here will, in general, behave like the previous major release, identified by the consecutive numbering. Releases not listed in the tables below are not assumed to be 100% compatible with the descriptions in this document. APIs within the XDC library can be used to verify the specific versions of software installed on the device.

Software Versions – DC 220/230/332/340/420/425/426/430/432/440

Release Date ESS UI MFSYS IIT DCSYSDC220/230STDC220/230ST Launch 1.0.2 19.3 XC0048 XC1427 XC3051DC220/230ST Wave 2 1.8.2 19.4 XC0048 XC1427 XC3051DC220/230ST General Release (Wave 3) 10- 1998 1.12.8 20.4 XC0052 XC1427 XC3054DC220/230ST SMP1.05 11- 1998 1.12.18 20.5 XC0052 XC1427 XC3054DC220/230ST SMP1.08 9- 1999 1.12.35.1 209f XC0052 XC1427 XC3061DC332/340STDC332/340ST Launch 7- 1999 1.12.27.2s S1.11 XC0109 XC1305 XCE239DC332/340ST SMP1 9- 1999 1.12.35.1s S113a XC0111 XC1306 XCE241DC420/426STDC420ST Launch XE 2.1 42.9 XC0052 XC1427 XC2061DC420ST Launch US 7- 2000 2.1.2 43.4 XC0052 XC1427 XC2061DC420ST SMP 1 9- 2000 2.1.7 44.0 XC0052 XC1427 XC2061DC420ST SMP 2 11- 2000 2.2.6 44.6 XC0052 XC1427 XC2061DC420ST SMP 2.1 1- 2001 2.2.6 44.6 XC0052 XC1427 XC2061DC426/420ST 2.3.19 2-2004 2.3.19 47.2 XC0052 XC1427 XC2061/

XC3061DC432/440STDC432/440ST Launch XE 2_1s S2.30 XC0114 XC1306 XCE241DC432/440ST Launch US 7- 2000 2_1_2s S236a XC0114 XC1305 XCE241DC432/440ST SMP 1 9- 2000 2_1_7 S2.43aDC432/440ST SMP 2 11- 2000 2_2_6s S2.60 XC0114 XC1306 XCE241DC432/440ST SMP 2.1 1- 2001 2_2_6s S2.62 XC0114 XC1306 or

XC1307XCE241

DC432/440ST General Release 2_4 6- 2002 2_3_11_1s S2.75DC425/432/440STDC425/432/440ST Launch 425 9- 2001 3_0_5_4s S3.46b XC0114 XC1306 XCE245DC425/432/440ST SV3-65 11- 2001 3_0_7_1 S3.46b XC0114 XC1306 XCE245DC425/432/440ST General Release 3_2.1 5- 2002 3_2_1_3s S3.69 XC0114 XC1306 XCE245DC430STDC430ST General Release DC430_01 1- 2004 3.3.24s S3.83 XCE114 XC1306 XCE245/

XCE241

Software Versions – DC 240/255/265/460/470/480/490

Release Date ESSElectronic Sub

System

UI IOT

DC240/255/265STDC240/255/265ST 6.04 (L18.1) 1- 2000 0.18.1.24 0.18.1.25 0.18.1.25


174

2179

2180

21812182218321842185

2186

2187

2188

2189

175


Release Date ESSElectronic Sub

System

UI IOT

DC240/255/265ST 6.08 (L18.6) 7- 2000 0.18.6.05.3 0.18.6.4 0.18.6.7DC460/470STDC460/470ST 7.01 (Launch) 7- 2000 0.19.0.28.2 0.19.0.27 0.19.0.28DC460/470/480STDC460/470/480ST 7.19.01.020 10- 2000 0.19.01.018 0.19.01.017 0.19.01.020DC460/470/480ST 7.19.01.504 5- 2001 0.19.01.502.4 0.19.01.504 0.19.01.504DC460/470/480/490STDC460/470/480/490ST 7.0.19.02.051 (Launch 490) 8- 2001 0.19.02.050.1 0.19.02.049 0.19.02.051DC460/470/480/490ST 7.0.19.02.503 10- 2001 0.19.02.503.6 0.19.02.503 0.19.02.503DC460/470/480/490ST 7.0.19.04.038 3- 2002 0.19.04.034.3 0.19.04.037 0.19.04.038DC460/470/480/490ST 7.0.19.05.026 9- 2002 0.19.05.021.1 0.19.05.024 0.19.05.026DC460/470/480/490ST 7.0.19.05.509 4- 2003 0.19.05.909 0.19.05.502 0.19.05.509

Software Versions – DC 535/545/555System Software Version Date NC

Network Controller

UIUser

Interface

IOTInput Output

Terminal

SIPScan Image Processor

DC535/545/555STDC535/545/555ST 0.14.52.0 7- 2002 0.19.10.047.1 0.10.14.51 17.64.0 8.16.51DC535/545/555ST 0.20.53.0 11- 2002 0.19.11.010.1 0.10.20.7 18.3.0 8.22.16DC535/545/555ST 0.26.32.0 2- 2003 0.19.12.003.1 0.10.20.7 27.1.0 8.26.2DC535/545/555ST 0.27.18.0 11- 2003 0.19.12.011.1 0.10.27.31 28.52 8.27.04

Software Versions – WorkCentre & WorkCentre Pro

System Software Version Date NCNetwork

Controller

UIUser

Interface

CCM/SIP

IOTInput

Output Terminal

WCP 65/75/90 1.001.00.060 5-2003 1.00.60.3 001.00.060 19.51.00WCP 65/75/90 1.001.02.027 11-2003 1.02.027.01 001.02.026 01.02.07WCP 65/75/90 1.001.02.063 4- 2004 1.02.063.03 001.02.063 01.02.63WCP 65/75/90 1.001.02.716 2-2006 1.08.016.01 1.02.714 1.02.716

WCP 40/32 Color 0.001.00.060 5-2003 1.00.60.3 001.00.060 01.00.60 09.00.00WCP 40/32 Color 0.001.01.010 7-2003 1.01.010.01 001.00.060 01.01.10 09.00.00WCP 40/32 Color 0.001.02.028 11-2003 1.02.028.02 001.02.028 01.02.28 13.00.00WCP 40/32 Color 0.001.02.059 4- 2004 1.02.058.04 001.02.059 01.02.59 13.00.00

WCP 35/45/55 3 /4.028.11.000 7-2003 1.01.308.01 002.27.019 10.27.24 20.81.00WCP 35/45/55 3 /4.084.16.000 11-2003 1.02.329.01 002.84.014 10.84.2 23.16.00WCP 35/45/55 3 /4.097.20.000 6- 2004 1.02.366.01 002.92.012 10.95.01 23.35.00

WCP 165/175 7.047.30.000 10- 2004 1.03.664.02 006.46.010 06.47.00 47.55.00

WCP 2128/2636/3545 Color 0.001.04.044

9-2004 03.04.044.01 0.01.04.043 01.04.044 08.00.00

WCP 2128/2636/3545 Color 0.001.04.052

7-2005 3.04.049.02 001.04.051 01.04.052 09.00.03

WCP 2128/2636/3545 Color 1-2006 3.04.510.01 001.04.509 01.04.511 09.00.03


176

2190

2191

2192

2193

177


0.001.04.511WCP 232/238/245/255/265/275 13.027.24.000

7-2005 40.010.50930 12.27.22 12.27.6 61.20.0

WCP 232/238/245/255/265/27513.050.003.0

5-2006 40.010.51172 12.39.026 12.39.004 61.40.000

WCP 232/238/245/255/265/27513.039.024.001

6-2006 40.010.51123 12.50.003 12.50.001 50.00.000

WC 7655 / 7665 40.32.50855 6-2006 40.032.50855 40.32.50855 7.08.00WC 7655 / 7665 40.32.50869 9-2006 40.032.50869 40.32.05869 7.08.00

WCP 123/128 1.202.0 7- 2004 1.202.0 / 1.232.1WCP123/128 1.203.4 2-2005 1.203.4 / 1.233.4WCP 123/128/133 1.204.7 9-2005 1.204.7 / 1.234.7WCP 123/128/133 1.205.3 4-2006 1.205.3 / 1.235.3

WorkCentre 7132 1.200.6 4-2006 1.200.6

WorkCentre 7228/7235/7245 4-2006 1.220.1

WorkCentre 4150 10.099.02.000 9-2006 1.00.99.02 / 2.01.13 0.030.29.015 1.00.16

Software Versions – OtherSystem Software Version Date Network ControllerXerox 4110/4590 1.202.6 2/2006 1.202.6Xerox 4110/4590 1.202.7 3/2006 1.202.7

Appendix B: Image Setting

For the devices that support this feature, it is a device level configuration, currently available via the Device Web UI.

TIFF JPEG Compression Version (TIFF 6.0 / TIFF Specification Supplement 2) would specify the desired format for all color TIFF images.

PDF Compression can specify either Optimized for Mixed Text and Images per Page ,and Optimized for Uniform Text or Images per Page. The table here below indicates the applied MRC specifications.

Scan Settings

Output Color

Original Type Output File Format

Resolution MRC Enable / Disable System Administrator setting available on the Web UI

Scan Output

Color PhotoPhoto & TextTextPhoto & TextText

PDF Any N/A Full color single image plane PDF600 x 600400 x 400

N/A Full color single image plane PDF

300 x 300200 x 200

N/A Full color single image plane PDFEnable Full color multi image plane PDFDisable Full color single image plane PDF

Gray-scale

PhotoPhoto & TextTextPhoto & TextText

PDF Any N/A Grayscale single image plane PDF600 x 600400 x 400

N/A Grayscale single image plane PDF

300 x 300200 x 200

N/A Grayscale single image plane PDFEnable Grayscale multi image plane PDFDisable Grayscale single image plane PDF


178

2194

2195

21962197

21982199

22002201

2202

179


Appendix C: Differences between devices and specific caveats

Scan Template Name DC 220/230/332/340/420/425/426/430/432/440ST do not support scan template names using upper case characters.

File transfer password in scan template UserNetworkFilingLoginID

DC 220/230/332/340/420/425/426/430/432/440 ST, WCP 123/128/133, and Xerox 4110 / 4590 will not read the file transfer password from a scan template in the remote template pool. These devices will prompt the walk up user for the password.

Remote Template Refresh via SNMP

All DC devices do not support Remote Template Refresh. They can be programmed via the Web UI to refresh once every 24 hours.

All WC devices support Remote Template Refresh via SNMP as well as via the Web UI.

WCP 123/128/133, Xerox 4110 / 4590, and WC 7132 / 7228 / 7235 / 7245 will reject the SNMP SET if the device LUI is in the Network Scan pathway. They can be programmed via the Web UI to refresh at fixed intervals.

Scan configuration via Web UI WCP 123/128/133, Xerox 4110 / 4590, and WC 7132 / 7228 / 7235 / 7245 will reject scan configurations if the device LUI is in the Network Scan pathway.

Scan template FTP filing and template refresh

DC 460/470/480/490 must be upgraded to release 7.0.19.5.527 or higher to support n.n.n.n:21 syntax.

Authenticated username in scan/server fax job log

NetworkUsername

DC 2xx / 3xx / 4xx ST and DC 5xx before 0.20.53.0 do not support writing the NetworkUsername attribute value to the scan / server fax job log.

Authenticated username in server fax job log

NetworkUsername

WC 7655 / 7665 will write the authenticated user name (domain and user name) to the server fax job log only if the Fax Repository LoginSource is set to Authenticated User.

Specify credentials for file transfer

LoginSource

Only WC 7655 / 7665 supports this programming, for file transfers over SMB only.

Device scan / server fax confirmation/error sheet

WCP 123/128/133, Xerox 4110 / 4590, and WC 7132 do not support a device scan / server fax activity confirmation / error sheet.

JBA bypass print PJL WCP 123/128/133, Xerox 4110 / 4590, and WC 7132 / 7228 / 7235 / 7245 must be configured by the administrator at the device LUI to support these codes.

Default template WCP 123/128/133, Xerox 4110 / 4590, and WC 7132 / 7228 / 7235 / 7245 do not supply a default template.

Filing to multiple destinations Filing to multiple destinations via a single scan template is not supported on DC220/230/332/340/420/425/426/430/432/440ST, WCP 123/128 /133, Xerox 4110 / 4590, and WC 7132 / 7228 / 7235 / 7245.

MetaDataValue WCP 165/175 7.047.30.000 will write an unknown string to MetaDataValue if the field is left blank by the user at the device LUI. Upgrade to the latest software to fix this issue.

MetaDataRequiredEntry In a network scan template WC 7132 / 7228 / 7235 / 7245 will ignore the


180

2203

2204

2205

181


MetaDataDefaultValue if MetaDataRequiredEntry=TRUE.

MetaDataValidationServerName If metadata validation is specified only via a scan template, WC 4150 requires the port be specified along with the MetaDataValidationServerName. Example 10.10.10.10:443

Compulsory syntax Compulsory syntax for specific attributes is supported by WCP 2xx, WC 76xx and WC 4150.

WCP 123/128/133, Xerox 4110 / 4590, and WC 7132 / 7228 / 7235 / 7245 do not expose changes to color, output format, document name, etc at the device LUI.

InputOrientation / Rotation WCP 123/128/133, and WC 7132 / 7228 / 7235 / 7245 support 180-degree rotation. Certain selections of Input Orientation will not be applied equally across all scan output formats.


182

183


[BLANK]


184

2206

185


Appendix D:Scan to File device defaults

Device WC 7655/7665 WC7132 WC 7228/ 7235/7245 WC 4150 Device Information

OutputURL Device IP address Device IP address Device IP address Device IP address

ServiceDefinitionUsedVersion Release version Release version

JobTemplateLanguageVersion 4.0.06 2.0 2.0 4.0.06Image

Darkness 0 0 0 0Sharpness 0 0 0Contrast 0 0 0 0AutoContrast TRUEInputEdgeErase 3/3/3/3/MM 3/3/3/3/MM 3/3/3/3/MM 6/6/6/6/MMSidesToScan ONE_SIDED ONE_SIDED ONE_SIDED ONE_SIDEDInputMediaSize AUTO AUTO AUTO AUTODocumentImageMode MIXED TEXT TEXT TEXTAutoExposure AUTO OFF OFF LEAD_EDGE

InputOrientation PORTRAIT Compression MIXED G4 G4 G4

Resolution RES_300X300 RES_200X200 RES_200X200 RES_300X300BitsPerPixel 24 1 1 1HalftoneMethod ERRORDIFFUSE HalftoneScreen AUTO ColorMode AUTO BLACK_AND_WHITE BLACK_AND_WHITE BLACK_AND_WHITEMagnification MANISO/100 NONE

OutputImageSize AUTO AUTOCompressionQuality 128 128


186

2207

187


CompressionsSupported

G4, ARITHMETIC_ENCODED_JBIG2, HUFFMAN_ENCODED_JBIG2, FLATE, FLATE_COMPRESSED_JPEG, MIXED, NEW_JPEG_TIFF_TTN2, OLD_JPEG_TIFF_V6;

MixedTypesSupported MULTI_MASK_MRC

MixedCompressionsSupported

G4, ARITHMETIC_ENCODED_JBIG2,HUFFMAN_ENCODED_JBIG2, JPEG, FLATE_COMPRESSED_JPEG

FTP

RepositoryName n.n.n.n:21(For FTP) n.n.n.n:21(For FTP) n.n.n.n:21(For FTP) n.n.n.n:21(For FTP)RepositoryAlias (supported) (supported) (supported) (supported)ConfirmationMethod PRINT PRINT PRINT PRINT

ConfirmationStage AFTER_JOB_COMPLETE AFTER_JOB_COMPLETE SuppressJobLog FALSE FALSE FALSE FALSE

File

DocumentObjectName DOC (template name) (template name) DOCDocumentFormat PDF XSM_TIFF_V6 XSM_TIFF_V6 PDF

DocumentFilingPolicy NEW_AUTO_GENERATE NEW_AUTO_GENERATE NEW_AUTO_GENERATE NEW_AUTO_GENERATEJob (enabled elements)

JBA AcctName / AcctValue (2 pairs) (2 pairs)NetworkUsername domain/user domain/user domain/user domain/userNumberScannedSegments <integer> <integer>

Device WCP 2xx WCP M123/128/133 WCP165/175 /35/45/55 WCP C2128/C2636/C3545 Device Information

OutputURL Device IP address Device IP address Device IP address Device IP address


188

2208

189


ServiceDefinitionUsedVersion Release version Release version Release version

JobTemplateLanguageVersion 4.00.03 2.0 2.03.08 2.03.08Image

Darkness 0 0 0 0Sharpness 0 0 0 Contrast 0 0 0 InputEdgeErase 3/3/3/3/MM 3/3/3/3/MM 3/3/3/3/MMSidesToScan ONE_SIDED ONE_SIDED ONE_SIDED ONE_SIDEDInputMediaSize AUTO AUTO AUTO AUTODocumentImageMode MIXED TEXT MIXED MIXEDAutoExposure LEAD_EDGE OFF LEAD_EDGE OFF

InputOrientation PORTRAIT PORTRAIT PORTRAITCompression MIXED G4 G4 G4

Resolution RES_300X300 RES_200X200 RES_200X200 RES_200X200BitsPerPixel 1 1 1 1HalftoneMethod ERRORDIFFUSE ERRORDIFFUSE HalftoneScreen AUTO AUTO ColorMode BLACK_AND_WHITE BLACK_AND_WHITE BLACK_AND_WHITE BLACK_AND_WHITEMagnification MANISO/100

OutputImageSize AUTO CompressionQuality 128

CompressionsSupported

G4, ARITHMETIC_ENCODED_JBIG2, HUFFMAN_ENCODED_JBIG2, FLATE, FLATE_COMPRESSED_JPEG, MIXED;

MixedTypesSupported MULTI_MASK_MRC

MixedCompressionsSupported

G4, ARITHMETIC_ENCODED_JBIG2,HUFFMAN_ENCODED_JBIG2, JPEG, FLATE_COMPRESSED_JPEG


190

191


MixedType MULTI_MASK_MRC

MixedCompressions

ARITHMETIC_ENCODED_JBIG2, FLATE_COMPRESSED_JPEG

FTP

RepositoryName n.n.n.n:21(For FTP) n.n.n.n:21(For FTP) n.n.n.n:21(For FTP) n.n.n.n:21(For FTP)RepositoryAlias (supported) (supported) (supported)ConfirmationMethod PRINT PRINT NONE

ConfirmationStage AFTER_JOB_COMPLETE AFTER_JOB_COMPLETE SuppressJobLog FALSE FALSE

File

DocumentObjectName DOC (template name) DOC DOCDocumentFormat PDF XSM_TIFF_V6 PDF PDF

DocumentFilingPolicy NEW_AUTO_GENERATE NEW_AUTO_GENERATE NEW_AUTO_GENERATE NEW_AUTO_GENERATEAccounting (JBA)

AcctName XRX_USERID AcctValue (user name) AcctName XRX_ACCTID AcctValue (account name)

Device WCP 40/32 C WCP 65/75/90

DC535/545/555ST DC460/470/480/490ST 7.0.19.04.xxx

DC460/470/480/490ST 7.0.19.02.xxx

DC460/470/480ST 7.19.01.xxx

Device Information OutputURL Device IP address Device IP address Device IP address Device IP address Device IP address

ServiceDefinitionUsedVersion Release version Release version Release version Release version Release version

ServiceDefinitionUserVersion JobTemplateLanguageVersion 2.03.08 2.03.08 1.3 1.3 1.3

Image Darkness 0 0 0 0 0Sharpness 0 0 0 0Contrast 0 0 0 0InputEdgeErase 3/3/3/3/MM 3/3/3/3/MM 3/3/3/3/MM 3/3/3/3/MM 3/3/3/3/MM


192

2209

193


SidesToScan ONE_SIDED ONE_SIDED ONE_SIDED ONE_SIDED ONE_SIDEDInputMediaSize AUTO AUTO AUTO AUTO AUTODocumentImageMode MIXED MIXED MIXED MIXED MIXEDAutoExposure OFF LEAD_EDGE LEAD_EDGE LEAD_EDGE LEAD_EDGEInputOrientation PORTRAIT PORTRAIT PORTRAIT PORTRAIT PORTRAITCompression G4 G4 G3MH G3MH G3MHResolution RES_200X200 RES_200X200 RES_300X300 RES_300X300 RES_300X300BitsPerPixel 1 1 1 1 1HalftoneMethod ERRORDIFFUSE ERRORDIFFUSE ERRORDIFFUSE HalftoneScreen AUTO AUTO AUTO ColorMode BLACK_AND_WHITE BLACK_AND_WHITE Magnification Rotation OutputImageSize

FTP RepositoryName n.n.n.n:21(For FTP) n.n.n.n:21(For FTP) n.n.n.n 21(For FTP) n.n.n.n 21(For FTP) IP address only for FTPRepositoryAlias (supported) (supported) ConfirmationMethod PRINT PRINT

ConfirmationStageAFTER_JOB_COMPLETE

AFTER_JOB_COMPLETE

SuppressJobLog File

DocumentObjectName DOC DOC DOC DOC DOCDocumentFormat PDF PDF TIFF_V6 XSM_TIFF_V6 XSM_TIFF_V6

DocumentFilingPolicyNEW_AUTO_GENERATE

NEW_AUTO_GENERATE

NEW_AUTO_GENERATE

NEW_AUTO_GENERATE

NEW_AUTO_GENERATE

Device DC460/470ST 7.01 (Launch) DC 240/255/265 DC 420/425/432/440 DC 220/230/332/340Device Information

OutputURL Device IP address Device IP address Only for server fax

ServiceDefinitionUsedVersion Release version Release version


194

2210

2211

195


ServiceDefinitionUserVersion Release version JobTemplateLanguageVersion 1.3 1.3 1.3

Image Darkness 0 0 0 if supported "0"Sharpness 0 0 0 if supported "0"Contrast 0 0 InputEdgeErase 0/0/0/0/IN 0/0/0/0/INSidesToScan ONE_SIDED ONE_SIDED ONE_SIDED ONE_SIDEDInputMediaSize AUTO AUTO AUTO AUTODocumentImageMode MIXED MIXED TEXT TEXTAutoExposure LEAD_EDGE LEAD_EDGE NONE AUTO or NONEInputOrientation PORTRAIT PORTRAIT PORTRAIT if supported "PORTRAIT"Compression G3MH G3MH Resolution RES_300X300 RES_300X300 RES_300X300 RES_300X300BitsPerPixel 1 1 HalftoneMethod HalftoneScreen ColorMode Magnification NONE NONERotation ROT_0 if supported "ROT_0"OutputImageSize SAME_AS_ORIGINAL SAME_AS_ORIGINAL

FTP RepositoryName IP address only for FTP IP address only for FTP IP address only for FTP IP address only for FTPRepositoryAlias ConfirmationMethod PRINT PRINTConfirmationStage SuppressJobLog FALSE

File

DocumentObjectName DOCNumber algorithm (0001, 0001000,) (TIME STAMP) (TIME STAMP)

DocumentFormat XSM_TIFF_V6 XSM_TIFF_V6 XSM_TIFF_V6 XSM_TIFF_V6DocumentFilingPolicy NEW_AUTO_GENERATE NEW_AUTO_GENERATE NEW_AUTO_GENERATE OVERWRITE


196

2212

197


Appendix E: Device Filing Policy

Overwrite Exception

Note: Exceptions refer to a filing behavior different from the general behavior described above. Each exception is specific to a particular version of ESS software.

Do not use Overwrite mode with DC220/230ST, prior to release SMP1.05.DC480ST (19.0.x ESS only) DC535/545/555ST (Launch & SMP1)

Behavior of Overwrite Filing Policy when a Previous Scan Job With the Same Name is in the Repository

DC220/230ST

(Launch, Wave2)

DC220/230/

420ST(Wave3,

SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/

460/ 470ST

DC480/490ST DC460/470/480/490ST (19.4.38)

DC535/545/555ST

WCP / WC

A single-page document exists. A new document is scanned in single-page format.

A new document replaces the existing document.









A single-page document exists. A new document is scanned in multi-page format.

N/A A new document is filed.

A new document is filed.


A multi-page document replaces the existing document.

A multi-page document replaces the existing document.




A single-page document exists. A new document is scanned in pdf format.

N/A N/A A new document is filed.


N/AESS 19.1.5xx: A PDF document replaces the existing document.

A PDF document replaces the existing document.




A single-page document exists. A new document is scanned in jpeg format.


A multi-page A new A new A new A new An XSM An XSM A new An XSM A new


198

2213

2214

22152216

2217221822192220

22212222

199


DC220/230ST

(Launch, Wave2)

DC220/230/

420ST(Wave3,

SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/

460/ 470ST

DC480/490ST DC460/470/480/490ST (19.4.38)

DC535/545/555ST

WCP / WC

document exists. A new document is scanned in single-page format.

document is filed.

document is filed.

document is filed.

document is filed.

directory replaces the .tif file. The .xst file is left intact.


490ST: A new document is filed.

document replaces the existing document.


document replaces the existing document.

A multi-page document exists. A new document is scanned in multi-page format.

N/A A new document replaces the existing document.








A multi-page document exists. A new document is scanned in pdf format.

N/A N/A A PDF document replaces the existing document.

A PDF document is filed. The .tif file is left intact. The .xst is replaced.

N/AESS 19.1.5xx: A PDF is filed. The .tif file is left intact. The .xst is replaced.

A PDF document replaces the existing document.




A multi-page document exists. A new document is scanned in jpeg format.


A pdf format document exists. A new document is scanned in single-page format.






The job is rejected.

490ST: A new document is filed.


An XSM directory replaces the .pdf file. The .xst file is left intact.


A pdf format document exists. A new document is scanned in multi-page format.

N/A A multi page TIF is filed. The .PDF file is left intact. The .xst is replaced.

A multi page TIF is filed. The .PDF file is left intact. The .xst is replaced.


A multi page TIF is filed. The .PDF file is left intact. The .xst is replaced.ESS 19.1.5xx: writes and


490ST: The .PDF file is left intact. The .xst is replaced by the multi page TIF





200

201


DC220/230ST

(Launch, Wave2)

DC220/230/

420ST(Wave3,

SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/

460/ 470ST

DC480/490ST DC460/470/480/490ST (19.4.38)

DC535/545/555ST

WCP / WC

deletes files- final result is no action.

document

A pdf format document exists. A new document is scanned in pdf format.

N/A N/A The new document replaces the existing document.

The new document replaces the existing document.

N/AESS 19.1.5xx: The PDF is deleted.

The .PDF is deleted and the job is rejected.

490ST: The new document replaces the existing document.




A pdf format document exists. A new document is scanned in jpeg format.


A jpeg format document exists. A new document is scanned in single page tif format.


A jpeg format document exists. A new document is scanned in multiple page tif format.


A jpeg format document exists. A new document is scanned in pdf format.


A jpeg format document exists. A new document is scanned in jpeg format.



202

203


Append

Note: If APPEND filing policy is used to write to the same document repository with the same document name, previous job logs are lost. This is true for jobs either originated from the same or different job templates. The job log only contains the information about the last append operation.

Exceptions


For DC220/230ST SMP1.05 release, if multi-page mode is used along with Append and user input is required at the Document Centre local UI (i.e. password), then the resulting scanned document will be in PDF filing format. Five files are transferred: .pdf, .xst, Nextname.dat, .dat, and Xsmdesc.dat. These files are stored in the directory specified by DocumentPath attribute.

DC220/230ST SMP1.05 release, PDF + Append will file a new document if one does not exist with the same name. If there is an existing pdf document by the same name, a new pdf file will be created using the name stored in the existing Nextname.dat file. The Nextname.dat file, the DocumentObjectName.dat file, the Xsmdesc.dat file, and the DocumentObjectName.xst file will all be overwritten.

DC220/230ST Wave3 release, multi-page mode, the resulting scanned document is in single-page format and files are stored in the directory specified by the DocumentPath attribute.

DC220/230/332/340/420/432/440ST all other releases, multi-page TIF + Append scan job are rejected.

DC332/340/432/440ST, pdf format + Append scan jobs are rejected.

DC240/255/265/460/470ST in multi-page mode, Append will transfer a new file.

DC460/470/480 release 7.19.01.504: this software is sensitive to case. Also in the case of a single multi page TIF document or a single PDF document in the repository, a single page TIF + Append job using the same document name fails.


204

2223

22242225

222622272228

2229

22302231

2232

223322342235

223622372238

22392240

2241

2242

2243

22442245

205

Xerox Document Centre Scanning Services SDK Developer’s Guide

Behavior of Append Filing Policy when a Previous Scan Job With the Same Name is in the Repository

DC220/230ST(Launch, Wave2)

DC220/230/230/420ST

(Wave3, SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/460/470ST

DC480/490ST DC460/470/480/490ST(19.4.38)

DC535/545/555ST

WCP / WC


The newly scanned document appends to the existing document.









N/A The job is rejected.


The job is rejected. The job is rejected.





N/A N/A A new document is filed.

The job is rejected. N/AESS 19.1.5xx: job rejected.





JPEG append to XSM or new PDF is filed.

A multi-page document exists. A new document is scanned in single-page format.





The job is rejected.ESS 19.1.5xx: job fails.460/470 ESS 19.2.xx: A new document is filed.

The job is rejected.ESS 19.2.xx: A new document is filed.


Fail








A multi-page document exists. A new document is

N/A N/A A PDF document replaces the

The job is rejected. N/A The job is rejected.




206

2246

2247

207



DC220/230/230/420ST

(Wave3, SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/460/470ST

DC480/490ST DC460/470/480/490ST(19.4.38)

DC535/545/555ST

WCP / WC

scanned in pdf format.

existing document.








A new document is filed. ESS 19.1.5xx: job fails.

The job is rejected.ESS 19.2.xx: A new document is filed.


Fail.




The job is rejected. The .PDF file is left intact. The .xst is replaced by the multi page TIF documents.





N/A N/A The newly scanned document appends to the existing document.

The job is rejected. N/AESS 19.1.5xx: job is rejected.











208

209



DC220/230/230/420ST

(Wave3, SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/460/470ST

DC480/490ST DC460/470/480/490ST(19.4.38)

DC535/545/555ST

WCP / WC




JPEG append to XSM or new PDF is filed.

New Exact Exceptions


For DC425ST Launch release, if the repository contains a single PDF job, and another job is filed to the same repository, using the same DocumentObjectName, PDF format and NewExact filing policy, the existing job is replaced.

Behavior of New Exact Filing Policy when a Previous Scan Job With the Same Name is in the Repository


210

22482249

22502251

2252

22532254

2255

211



DC220/230/420ST

(Wave3, SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/460/470ST

DC480/490/535/545/555ST,

DC460/470(19.4.38)

WCP / WC


The job is rejected. The job is rejected. The job is rejected. The job is rejected. The job is rejected. The job is rejected. The job is rejected.


N/A A new document is filed.



The job is rejected. The job is rejected. The job is rejected.


N/A N/A The job is rejected. A new document is filed.

N/AESS 19.1.5xx: job rejected.









The job is rejected. The job is rejected. The job is rejected.


N/A The job is rejected. The job is rejected. The job is rejected. The job is rejected. The job is rejected. The job is rejected.


N/A N/A The job is rejected. The .tif file is left intact. The .xst is replaced by the PDF documents.

N/AESS 19.1.5xx: job rejected.


A multi-page document exists. A new document is scanned in jpeg



212

213



DC220/230/420ST

(Wave3, SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/460/470ST

DC480/490/535/545/555ST,

DC460/470(19.4.38)

WCP / WC

format.A pdf format document exists. A new document is scanned in single-page format.








N/A A multi page TIF is filed. The .PDF file

is left intact. The .xst is replaced.



A multi page TIF is filed. The .PDF file is left intact. The .xst is replaced.ESS 19.1.5xx: job rejected.



N/A N/A The job is rejected. The job is rejected.425ST: The existing document is replaced by a new document.

N/A ESS 19.1.5xx: job rejected.










A jpeg format The job is rejected.


214

215



DC220/230/420ST

(Wave3, SMP1.08)

DC220/230ST(SMP1.05)

DC332/340/425/432/440ST

DC240/255/265/460/470ST

DC480/490/535/545/555ST,

DC460/470(19.4.38)

WCP / WC

document exists. A new document is scanned in jpeg format.

New Auto Generate

DC240/255/265/460/470/480/490/535/545/555ST General Behaviors

A new document is created. The first five characters of the DocumentObjectName will be used as a seed to create the document name. If the DocumentObjectName is five characters or less, all will be used as the seed. The remaining three characters will be a counter that is incremented by one in base 10 for each use. If the user has removed documents from the document repository, then the first unused number found will be used. If all increments are used, then the job will be rejected. If the DocumentObjectName is not present in the template, then "DOC" is used as the default seed. All document formats supported, single-page TIF, multi-page TIF and PDF, are treated equally in naming.

DC240/255/265/460/470/480/490/535/545/555ST & WCP General Behaviors

A new document is created. The first five characters of the DocumentObjectName will be used as a seed to create the document name. If the DocumentObjectName is five characters or less, all will be used as the seed. The remaining three characters will be a counter that is incremented by one in base 10 for each use. If the user has removed documents from the document repository, then the first unused number found will be used. If all increments are used, then the job will be rejected. If the DocumentObjectName is not present in the template, then "DOC" is used as the default seed. All document formats supported, single-page TIF, multi-page TIF and PDF, are treated equally in naming.

Note: Single-page jobs and multi-page jobs are treated equally in naming.

Naming convention examples

Scan job order and File format specified in template File transferredDocumentObjectName = “scanningtest”1. Single page TIF Scanning.xsm (directory containing files)2. Multi page TIF Scann000.tif, scann000.xst3. Single page TIF Scann001.xsm (directory containing files)4. PDF Scann002.pdf, scann002.xstNo DocumentObjectName in template1. Single page TIF DOC.xsm (directory containing files)2. Multi page TIF DOC000.tif, DOC000.xst3. Single page TIF DOC001.xsm (directory containing files)4. PDF DOC002.pdf, DOC002.xst


216

22562257

2258

22592260226122622263

2264

22652266226722682269

2270

2271

217


The following figures describe the contents of *.XSM directory, particularly the naming conventions resulting from different Document Names. The examples assume Single page TIF file format is specified in the template.

Note: the file names are the same when DocumentObjectName = “scanningtest” or “scanning”

DC220/230/332/340ST General Behaviors

A new document is created. The file/directory naming format is DDHHMMSS, where DD is date, HH is hour, MM is minute, and SS is second. For example, if a document is scanned on 4/11/2000 at 3 seconds after 8:01 a.m., the resulting document name will be 11080103 for the .xsm directory, .xst file, and the .dat file:

11080103.xsm 00000001.tif11080103.xst11080103.datNextname.datXsmdesc.dat

Exceptions



< Repository >Doc.xsm

Doc001.xsm

Doc000.xsm

First job

Second job

Third job

00000001.tif, 00000002.tif,…nextname.dat, doc.datdoc.xst, xsmdesc.dat

00000001.tif, 00000002.tif, …nextname.dat, doc000.datdoc000.xst, xsmdesc.dat

00000001.tif , 00000002.tif, …nextname.dat, doc001.datdoc001.xst, xsmdesc.dat

DocumentObjectName = “”

218

227222732274

2275

2276

22772278

22792280

228122822283228422852286

22872288

2289

219


DC220/230ST SMP 105 release, if pdf format is used, the first scan job may create the following files: 00000001.pdf, 11080103.xst, 11080103.dat, Nextname.dat, Xsmdesc.dat The second scan job to the same repository will cause the 00000001.pdf file, the Nextname.dat file, and the Xsmdesc.dat file to be replaced. As a result, the repository will contain the following files: 00000001.pdf, 11080103.xst, 11080103.dat, 11100203.xst, 11100203.dat, Nextname.dat, Xsmdesc.dat

DC420/432/440ST General Behaviors

A new document is created.

If the DocumentObjectName is eight characters or less, the first five characters will be used as a seed to create the document name. If the DocumentObjectName is five characters or less, the entire name will be used as the seed. The remaining three characters will be used as a counter that is incremented by one in base 10 for each use. If the user has removed documents from the document repository, then the first unused number found will be used. If all increments are used, then the job will be rejected. If the DocumentObjectName is not present in the template, the file/directory naming format is DDHHMMSS, where DD is date, HH is hour, MM is minute, and SS is second. If DocumentObjectName = “” (Blank), then "DOC" is used as the default seed (see Naming convention examples). Single-page documents do not interfere with multi-page or pdf documents. The naming scheme of multi-page documents does not interfere with pdf documents but the .xst file generated by a newly scanned document overwrites an existing .xst file.

Exceptions


DC440 SMP2.2 If the DocumentObjectName is more than eight characters, the entire string is used to create file / directory name, overwriting existing files with the same name.

Example :

DocumentObjectName = "scanningtest";

The names for the scanned documents will be:

A Directory named scanningtest.xsm

Which contains

00000001.tif00000002.tifscanningtest.datscanningtest.xstxsmdesc.datnextname.dat


220

2290229122922293

2294

22952296

2297

2298229923002301230223032304

2305

23062307

230823092310

2311

2312

2313

2314

2315

231623172318231923202321

221


Second Scan Job overwrites these files

Third Scan Job overwrites these files.

DC425 SMP 3_2_1, SMP 3_2_2

Naming convention examples

Scan job order and File format specified in template File transferredDocumentObjectName = “scanningtest”5. Single page TIF Scanningtest.xsm (directory containing files)6. Multi page TIF Scanningtest.tif, Scanningtest.xst7. Single page TIF Scann000.xsm (directory containing files)8. PDF Scanningtest.pdf, replaced scanningtest.xstNo DocumentObjectName in template1. Single page TIF DOC.xsm (directory containing files)2. Multi page TIF DOC.tif, DOC.xst3. Single page TIF DOC000.xsm (directory containing files)4. PDF DOC.pdf, replace DOC.xst

The following figure describes the contents of *.XSM directory when no Document Object Name is specified for a Single page TIF scan job.


222

23222323

2324

23252326

2327

232823292330

223


Behavior of New Auto Generate (a.k.a. Rename New File) Filing Policy when a Previous Scan Job is in the Repository

DC425/432/440STDocumentObjectName =

“12345678”

DC460/470/480/490/535/545/555STWorkCentre Pro

DocumentObjectName= “12345678”


A file is transferred.Exists: 12345678.xsmScan 1: 12345000.xsmScan 2: 12345001.xsmScan 3: 12345002.xsm



A file is transferred.Exists: 12345678.xsmScan 1: 12345678.tif and 12345678.xstScan 2 :12345000.tif and 12345000.xstScan 3 : 12345001.tif and 12345001.xst

A file is transferred.Exists: 12345678.xsmScan 1 :12345000.tif and 12345000.xstScan 2 : 12345001.tif and 12345001.xstScan 3 : 12345002.tif and 12345002.xst


A file is transferred.Exists : 12345678.xsmScan 1 : 12345678.pdf and 12345678.xstScan 2 : 12345000.pdf and 12345000.xstScan 3 : 12345001.pdf and 12345001.xst

A file is transferred.Exists: 12345678.xsmScan 1 : 12345000.pdf and 12345000.xstScan 2 : 12345001.pdf and 12345001.xstScan 3 : 12345002.pdf and 12345002.xst


< Repository >Doc.xsm

Doc001.xsm

Doc000.xsm

First job

Second job

Third job

00000001.tif, 00000002.tif,…nextname.dat, doc.datdoc.xst, xsmdesc.dat

00000001.tif, 00000002.tif, …nextname.dat, doc000.datdoc000.xst, xsmdesc.dat

00000001.tif , 00000002.tif, …nextname.dat, doc001.datdoc001.xst, xsmdesc.dat

DocumentObjectName = “”

224

2332

225



“12345678”



A single-page document exists. A new document is scanned in jpeg6

format.



A file is transferred.Exists: 12345678.tif and 12345678.xstScan 1 : 12345678.xsmScan 2 : 12345000.xsmScan 3 : 12345001.xsm



A file is transferred.Exists: 12345678.tif and 12345678.xstScan 1: 12345000.tif and 12345000.xstScan 2: 12345001.tif and 12345001.xstScan 3: 12345002.tif and 12345002.xst

A file is transferred.Exists: 12345678.tif and 12345678.xstScan 1: 12345000.tif and 12345000.xstScan 2: 12345001.tif and 12345001.xstScan 3: 12345002.tif and 12345002.xst


A file is transferred and a job log replaced.Exists: 12345678.tif and 12345678.xst The pdf job creates 12345678.pdf and replaces 12345678.xstScan 1 :12345000.pdf and 12345000.xstScan 2 : 12345001.pdf and 12345001.xstScan 3: 12345002.pdf and 12345002.xst

A file is transferred.Exists: 12345678.tif and 12345678.xstScan 1 : 12345000.pdf and 12345000.xstScan 2 :12345001.pdf and 12345001.xstScan 3 :12345002.pdf and 12345002.xst




A file is transferred. Exists: 12345678.pdf and 12345678.xstScan 1: 12345678.xsmScan 2 : 12345000.xsmScan 3 : 12345001.xsm

A file is transferred.Exists : 12345678.pdf and 12345678.xstScan 1 : 12345000.xsmScan 2 : 12345001.xsmScan 3 : 12345002.xsm


A file is transferred and the existing job log is replaced.Exists : 12345678.pdf and 12345678.xstScan 1 : 12345678.tif and 12345678.xstScan 2 : 12345000.tif and 12345000.xst

A file is transferred.Exists: 12345678.pdf and 12345678.xstScan 1 : 12345000.tif and 12345000.xstScan 2 :12345001.tif and 12345001.xstScan 3 :12345002.tif and 12345002.xst

6 JFIF-JPEG is only supported on WCP 32/40 C


226

227

228



“12345678”



Scan 3 :12345001.tif and 12345001.xstA pdf format document exists. A new document is scanned in pdf format.

A file is transferred.Exists: 12345678.pdf and 12345678.xstScan 1 : 12345000.pdf and 12345000.xstScan 2 :12345001.pdf and 12345001.xstScan 3: 12345002.pdf and 12345002.xst

A file is transferred.Exists: 12345678.pdf and 12345678.xstScan 1 : 12345000.pdf and 12345000.xstScan 2 :12345001.pdf and 12345001.xstScan 3 :12345002.pdf and 12345002.xst


A file is transferred.Exists : 12345678.pdf and 12345678.xstScan 1 : 12345000.xsmScan 2 : 12345001.xsmScan 3 : 12345002.xsm






A file is transferred.Exists: 12345678.xsmScan 1 :12345000.tif and 12345000.xstScan 2 : 12345001.tif and 12345001.xstScan 3 : 12345002.tif and 12345002.xst



Miscellaneous DC220/230/332/340STFor DC220/230/332/340ST, if the DocumentObjectName is left blank in Overwrite, Append, and New Exact mode, the system generates a name using DDHHMMSS

timestamp and files as if the filing policy was NEW AUTO GENERATE.

Prior to DC220/230ST SMP1.08 release, a user cannot select NEW AUTO GENERATE or NEW EXACT at the Document Centre UI. If NEW AUTO GENERATE or NEW EXACT is specified in a template and any scan information other than filing policy is entered at the Document Centre UI, the filing policy changes to the system default, which


229

23332334

23352336

23372338

230


can be set to OVERWRITE or APPEND. If the filing policy is changed at the Document Centre UI, it is properly applied to the scan job. If OVERWRITE or APPEND is specified in the template, entering scan information (e.g. entering a password) at the Document Centre UI does not cause the filing policy to change.

For DC220/230ST Wave3 release, multi-page TIFF format is supported by the Document Centre but not supported by the local UI. Consequently, a user cannot select multi-page format at the Document Centre UI. Furthermore, a user cannot use a template that specifies multi-page format and requires user input at the Document Centre UI. (e.g. entering a password.) For example, if a template specifies multi-page TIFF format and NEW AUTO GENERATE filing policy, a user inputs information at the Document Centre UI, XSM format and the system default filing policy, which can be set to OVERWRITE or APPEND, will be used. Files will be stored in the DocumentPath directory instead of the DocumentObjectName.xsm directory.

DC240/255/265STDC240/255/265ST version L18, DocumentObjectName should not be left blank in a template. If in a template, DocumentObjectName = “” and DocumentFormat = XSM_TIFF_V6, regardless of the filing policy specified, the first attempt to use the template will result in a .xsm directory. The following attempts to use the same template without removing the .xsm directory from the repository will result in a file transfer failure. If in a template, DocumentObjectName = “” and DocumentFormat = TIFF_V6, regardless of the filing policy specified, the first attempt to use the template will result in a .xst and .tif file. The following attempts to use the same template will result in the existing document being overwritten.

DC460/470/480 release 7.19.01.504: this software is sensitive to case, resulting in variant behavior.

Behavior of Add Date To Name Filing Policy when a Previous Scan Job is in the Repository

Devices not supporting this Filing Policy including:DC332/340/425/432/440ST

DC460/470/480/490ST (19.4.38) DC535/545/555STWCP 32/40c, 35/45/55, 65/75/90, 2128/2636/354c, 165/175, 123/128

Devices supporting this Filing Policy Including : WCP 2xx / WC

A document exists in the repository. A new document is scanned in using Add Date To Name Filing Policy.

All system that do not support the Add Date To Name filing policy change filing policy from Add Date to Name to Rename.

The new document it filed with the date and time in the name.


231

23392340

23412342234323442345

2346

23472348234923502351

2352

2353

2354

2355

232


7.1 Document History

Version 4.2Date August 25, 2006

Document RevisionVersion Date Description

1.0 5/31/2000 Original release.

2.0 6/16/2000 Added DC420/432/440ST products.

2.1 10/5/2000 Added DC470, DC440, and Document Management Fields

2.11 10/25/2000 Misc. clarifications and FAX section update, TOC update.

2.12 10/25/2000 Final change for 460/470 release

2.13 11/20/2000 Added DC480 release

2.14 1/25/2001 Added DC440 SMP2.2 release

2.15 5/4/2001 Added simple scanning and samples, updates to metadata section, examples for metadata for fax, network fax integration DC440ST, DC420 SMP 2.2, DC440 SMP2.2.1

3 10/4/2001 Add DC425, DC490, Scan to Email, network authentication, change layout, revise CentreWare chapter, revise appendices, revise attribute manual, and add output samples, TOC update.

3.1 12/18/2001 Add DC425/460/470/480/490 Refresh, repository processing guidelines, update file transfer and file locking, update appendices

3.2 5/17/2002 Add DC460/470/480/490 refresh, DC 425/432/440 SMP3.2.1, updates to Fax integration section (PJL Header), update Appendices.


233

23562357

2358

2359

2360

2361

234


Version Date Description

3.3 10/2002 Add DC535/545/555ST, DC425/432/440ST SMP3.2.2, IFax, FTP parameters, SMB, overview diagrams, Image Quality

3.4 1/2003 Network Authentication information in Job Log

DC535/545/555ST 0.20.53.0(SMP1)

Updated common.xst (Simple Scan)

Updated Receive Fax PJL Header section

3.5 2/2003 WorkCentre Pro pre-launch information

Receive Fax Requirements

Color support (grayscale and color), File Format

File transfer password in MetaData / LUI Option.

Compression Quality options (file size)

Email file attachment, job splitting options


3.6 7/2003 WCP 65/75/90 &WCP 32/40 C

3.7 3/2004 WCP 35/45/55

Fax requirements – printing to Xerox device update

Image Settings update

File transfer and xst updates

4.0 9/2005 WCP 123/128, WCP 2xx

Fax requirements – printing to Xerox device update

Image Settings update

File transfer and xst updates

Compulsory attribute syntax

New attributes

Secure workflows


235

236


Version Date Description


4.2 September 06


237

2362

23632364

23652366

238

scan_fax sdk.pdf

Documents

xerox confidential version

fax sdk version

xerox product names

trademark of aldus corporation

trademark of novell

company trademarks

server fax services

trademarks of adobe