Database property names for Postal Enablement
Messages might refer to various 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 an authorized user can change the value.
- No means that an authorized user cannot change the value.
Postal Enablement
| Database name | Field name | Brief description | Internal values | Editable |
|---|---|---|---|---|
| Doc.Address.1 | Address block line 1 | Specifies the first line of the address block in the document. | No | |
| Doc.Address.Company | Postal company name | Specifies the company name in the document. | No | |
| Doc.Address.PostalCode | Postal code | Specifies the zip code in the document. | No | |
| Doc.Address.ZipCode | Zip code | Specifies the zip code in the document. | No | |
| Doc.ChildJobID | Not displayed in property notebook | The job ID of the job that contains 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. (AFP jobs only). | No | |
| Doc.DataOffset | Not displayed in property notebook | The offset of the document in bytes from the start of the original file.(AFP jobs only). | No | |
| Doc.DocSize.PieceThickness | Variable mail piece thickness | Specifies the thickness of a mail piece when the mail pieces in a job have different thicknesses. | No | |
| Doc.DocSize.PieceWeight | Variable mail piece weight | Specifies the weight of a mail piece when the mail pieces in a job have different weights. | No | |
| Doc.ID | Document number | A unique identifier for a document in the document database; defined automatically when WriteDocumentsToDatabase runs. | 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, and so on. | No | |
| Doc.OriginalSheets | Sheets | The number of sheets for the document in the original job. | No | |
| Doc.Postal.AddressProcessingRC | Address processing return code | A value returned from postal software to indicate the result of its address correction processing. | No | |
| Doc.Postal.Category | Processing category | Specifies the grouping of postal processing determined by the postal software for the document. | No | |
| Doc.Postal.ChangeAddressRC | Change of address return code | A value returned from postal software to indicate if an address change is available for the document. | No | |
| Doc.Postal.ContainerBreakMark | Pallet break mark | Specifies the pallet break mark for the document. | No | |
| Doc.Postal.ContainerNumber | Pallet number | Specifies the pallet number for the document. | No | |
| Doc.Postal.HandlingUnitBreakMark | Container break mark | Specifies the container break mark for the document. | No | |
| Doc.Postal.HandlingUnitNumber | Container number | Specifies the container number for the document. | No | |
| Doc.Postal.PackageBreakMark | Package break mark | Specifies the package break mark for the document. | No | |
| Doc.Postal.PackageNumber | Package number | Specifies the package number for the document. | No | |
| Doc.Postal.PostageRate | Postage rate | Specifies the postage rate for the document. | No | |
| Doc.Postal.PostageRateCode | Postage rate code | Specifies the postage rate code for the document. | No | |
| Doc.Postal.SequenceNumber | Presort sequence number | Specifies the presort sequence number for the document. | No | |
| Doc.Postal.SequencingProcessingRC | Presort processing return code | A value returned from postal sorting software to indicate the result of its processing. | 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 | |
| Job.Conditions.ChangeJobType | New workflow | Specifies the new workflow to which this job will be transferred. | Yes | |
| Job.Doc.ChildJobType | Child workflow | Specifies the workflow for the child jobs that are created. | Yes | |
| Job.Doc.ColumnsToKeep | Columns to keep | Specifies a comma-separated list of the names of column headings in the external results file. | Yes | |
| Job.Doc.ContainsHeader | External results contain column headings | Specifies whether the external results file returned from the external program contains headings for the document property columns. |
|
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 additional processing for documents in the job.(AFP jobs only). | Yes | |
| Job.Doc.PropertyCSV | Property conditions file | Specifies a comma-separated file which is used to update document properties based on existing property settings. | Yes | |
| Job.Doc.DocPropForHeading | Document properties | Specifies document properties in the order that they should be added as column headings in the modified results file that is produced by a step based on the MapExternalResultsFiletoDocPropsstep template. | Yes | |
| Job.Doc.DocPropToOutput | Document properties | Specifies document properties that will be written to the external document properties file that is produced by a step based on the BuildExternalDocPropsFile step template.. | Yes | |
| Job.Doc.ExternalHeadings | Column headings | Specifies the column headings to use in the external document properties file that is produced by a step based on the BuildExternalDocPropsFile step template. | Yes | |
| Job.Doc.InputFileName | External results file | Specifies the name of the comma-separated or tab-delimited file containing the document properties and other information returned from the external program. This file is input to a step based on the MapExternalResultsFiletoDocProps step template. | Yes | |
| Job.Doc.InputFileType | File type | Specifies the type of the external results file, which is input to a step based on the MapExternalResultsFiletoDocProps step template. | Yes | |
| Job.Doc.OutputFileDPFName | Modified results file | Specifies the name of the tab-delimited file containing the document properties that you selected from the document properties in the external results file. A step based on the MapExternalResultsFiletoDocProps step template creates this file as output. | Yes | |
| Job.Doc.OutputFileName | External document properties file | Specifies the fully qualified output filename for the external document properties file that is produced by a step based on the BuildExternalDocPropsFile step template. | Yes | |
| Job.Doc.OutputFileType | File type | Specifies the output file type for the External document properties file. | Yes | |
| Job.DocSize.DefaultPieceHeight | Mail piece height | Specifies the height of the mail piece. | Yes | |
| Job.DocSize.DefaultPieceLength | Mail piece length | Specifies the length of the mail piece. | Yes | |
| Job.DocSize.DefaultPieceThickness | Identical mail piece thickness | Specifies the thickness of a mail piece when all mail pieces in a job have the same thickness. | Yes | |
| Job.DocSize.DefaultPieceWeight | Identical mail piece weight | Specifies the weight of a mail piece when all mail pieces in a job have the same weight. | Yes | |
| Job.DocSize.VaryingWeightAndThickness | Use variable measurements | Specifies whether the mail pieces in the job have the same weight and thickness or different weights and thicknesses. |
|
Yes |
| Job.DPF.MergeFile | Modified Results File | The name of the tab-delimited file containing the properties selected from the external results file. This file is produced by a step based on the MapExternalResultsFiletoDocProps step template. | Yes | |
| Job.Postal.Category | Processing category | Specifies a grouping of postal processing that can be determined by the postal software. | Yes | |
| Job.Postal.Class | Mail class | Specifies the class of mail for the job. For example, the class of mail for the United States Postal Service might be first class, standard, or parcel. | Yes | |
| Job.Postal.ContainerMaxWeight | Maximum weight of pallet | Indicates the maximum possible weight of a pallet for mailing. When the weight of individual documents is known, this property can be used to group documents into jobs so that the maximum weight is not exceeded. | Yes | |
| Job.Postal.ContainerMinWeight | Minimum weight of pallet | Indicates the minimum possible weight of a pallet for mailing. | Yes | |
| Job.Postal.ContainerSize | Pallet size | Shows the size of an individual pallet. | Yes | |
| Job.Postal.HandlingUnit | Container size | Specifies the size of the container. | Yes | |
| Job.Postal.HandlingUnitMaxWeight | Maximum weight of container | Specifies the maximum weight that your postal service accepts for a container. | Yes | |
| Job.Postal.HandlingUnitMinWeight | Minimum weight of container | Specifies the minimum weight that your postal service accepts for a container. | Yes | |
| Job.Postal.MailerID | Mailer ID | Specifies the identification number of the company sending the mail. | Yes | |
| Job.Postal.MailStream | Presort process | Specifies the type of sorting that the job qualifies for based on the requirements set by your postal service. | Yes | |
| Job.Postal.PieceType | Mail type | Specifies the shape of the mail pieces in the job. | Yes | |
| Job.Postal.PostageStatementDate | Postage statement date | Specifies the date the job is sent to the postal service and the date that the postal service receives payment for the job. | Yes | |
| Job.Postal.Type | Mail rate type | Specifies the type of mail rate for the job. | Yes |