Database property names for Automated Verification

Some messages refer to Automated Verification properties.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that Ricoh ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

Automated Verification properties

Database name Field name Brief description Internal values Editable
BarcodeReader.BarcodeFormat Barcode Format Specifies the barcode format used to determine where the values for the Job number and Document sequence number properties can be found in the set of data returned by the camera or barcode scanner.   Yes
BarcodeReader.Description Description Describes a barcode reader object. For example, the description might include details of where the camera or barcode scanner is placed, such as on an inserter exit or a printer output bin.   Yes
BarcodeReader.ID Name The name of the barcode reader.   Yes
BarcodeReader.IpAddress IP Address Specifies the IP address or hostname that Ricoh ProcessDirector uses to connect to the camera or barcode scanner that you want to use with this barcode reader object.   Yes
BarcodeReader.LastModified Last modified The date and time when the barcode reader was last changed.   No
BarcodeReader.Location Barcode reader location Specifies the location associated with the barcode reader.   Yes
BarcodeReader.Port Port Specifies the port that Ricoh ProcessDirector uses to connect to the camera or barcode scanner that you want to use with this barcode reader object.   Yes
BarcodeReader.State Barcode reader state Specifies whether the barcode reader detected invalid data.
  • OK
  • Attention
No
BarcodeReader.Status Connection status Specifies the status of the barcode reader.
  • Connected
  • Disconnected
No
Doc.AV.ScanCount Scan count Shows the total number of times the barcode on a document is scanned.   No
Doc.ChildJobID Not displayed in property notebook The job ID of the job that added the document   No
Doc.CurrentFirstPage Not displayed in property notebook The page number of the first page of the document in the current print file.   No
Doc.CurrentPages Not displayed in property notebook The number of pages for the document in the current job.   No
Doc.CurrentSheets Current sheets The number of sheets for the document in the current job.   No
Doc.DataLen Not displayed in property notebook The length of the document in bytes in the original file.   No
Doc.DataOffset Not displayed in property notebook The offset of the document in bytes from the start of the original file.   No
Doc.ID Document number A unique identifier for a document in the document database; defined automatically when WriteDocumentsToDatabase runs.   No
Doc.Insert.Sequence Insert sequence Shows the position of the document in the job.   No
Doc.OriginalFirstPage Original first page The page number of the first page of the document in the original job.   No
Doc.OriginalJobID Original job number The number of the job that received the document into the system.   No
Doc.OriginalPages Original pages The number of pages in the document in the original job.   No
Doc.OriginalSequence Sequence in original job The relative position of this document in the original job. For example, the first document in the job displays a value of 1, the second document in the job displays a value of 2.   No
Doc.OriginalSheets Sheets The number of sheets for the document in the original job.   No
Doc.SequenceInChild Not displayed in property notebook The sequence of the document in the child job.   No
Doc.State State The state of the document.   No
Doc.TT.BarcodeScanTime1 Document scanned 1 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime2 Document scanned 2 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime3 Document scanned 3 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime4 Document scanned 4 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime5 Document scanned 5 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeStatus1 Document status 1 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus2 Document status 2 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus3 Document status 3 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus4 Document status 4 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus5 Document status 5 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.Verification.Recipient Verification recipient Specifies information, such as account name, that helps you to identify a document.   No
Job.Conditions.ChangeJobType New workflow Specifies the new workflow to which this job is transferred.   Yes
Job.Doc.ChildJobType Child workflow Specifies the workflow for the child jobs that are created.   Yes
Job.Doc.CreatedDocumentCount Created document count Specifies the number of documents created by the first WriteDocumentsToDatabase step that processes a job. This value represents the number of documents that were contained in the original job; it does not change as the job moves through its workflow, even if documents are reprinted.   No
Job.Doc.DocumentCount Document count Specifies the total number of documents in a job. The value of this property displays only after a step based on WriteDocumentsToDatabase or UpdateDocumentsInDatabase runs.   No
Job.Doc.DocumentPropertyTemplate Document property template Specifies the path and name of a template file that contains the document properties.   Yes
Job.Doc.EnhanceAFPControlFile Enhance AFP control file Specifies a control file that defines more processing for documents in the job.   Yes
Job.Doc.PropertyCSV Property conditions file Specifies the CSV file containing job document property conditions and property values to set when those conditions are true.   Yes
Job.TrackAndTrace.AutoComplete Complete step when all barcodes are read Specifies whether Ricoh ProcessDirector moves the job to the next step after all the documents for the job are detected.
  • Yes
  • No
Yes
Job.TrackAndTrace.BarCodeReader Barcode reader Specifies one or more barcode readers that are used to record barcodes read for this step.   Yes
Job.TrackAndTrace.Status Document status property Specifies which document status property should be updated with a status of OK when the barcode on a document is read by the camera or barcode scanner associated with the ReadBarcodeData step in a workflow.
  • DocTTStatus1
  • DocTTStatus2
  • DocTTStatus3
  • DocTTStatus4
  • DocTTStatus5
  • DocTTStatusInsertJobs
Yes
Job.TT.WaitTime Results file inactivity timer Specifies the amount of time that Ricoh ProcessDirector waits after a barcode is recorded in the results file for the job before it moves the job to the next step.   Yes
Job.TT.DocScanned Document scan time property Specifies which Document scanned property to update with the date and time when a camera or barcode scanner reads the barcode on a document. The ReadBarcodeData step in a workflow sets values for both the camera or barcode scanner and the Document scanned property.
  • DocTTTime1
  • DocTTTime2
  • DocTTTime3
  • DocTTTime4
  • DocTTTime5
Yes
 
Copyright © 2013, 2018