Database property names for Reports
Messages about data collectors and print jobs might refer to properties added by the
Reports feature by their database names.
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.
In the Job ticket column:
- Yes means that the property can be set from one or more values in the job ticket that is used to submit the job.
- No means that the property cannot be set from values in the job ticket.
| Database name | Field name or column heading | Brief description | Internal values | Editable | Job ticket |
|---|---|---|---|---|---|
| BarcodeReaderActionsCollector.UserProps | User properties to capture | Specifies the properties that this data collector captures about the user who does an action on a barcode reader. | Yes | ||
| BarcodeReaderActionsCollector.BarcodeReaderProps | Barcode reader properties to capture | Specifies properties that this data collector captures about a barcode reader when a user does an action on it. | Yes | ||
| Collector.Cleanup | Remove expired entries | Specifies whether the data collector removes database entries after a specified retention time. |
|
Yes | |
| Collector.Description | Description | Describes the type of data collected by the data collector. | No | ||
| Collector.Enabled | Enabled Status | Specifies whether the data collector is writing data to its PostgreSQL database table. |
|
Yes | |
| Collector.FailureDirectory | Error log directory | Specifies the full path and name of the directory that RICOH ProcessDirector writes a file to when it cannot put the property values in the database table. | Yes | ||
| Collector.ID | Name | Specifies the name of the data collector. | No | ||
| Collector.LastModified | Last modified | Specifies the date and time that the data collector was last changed. | No | ||
| Collector.ModifiedBy | Modified by | Specifies the name of the person who last changed the data collector. | No | ||
| Collector.Retention | Retention period | Specifies how long to keep entries in the database table used by a data collector. | Yes | ||
| Collector.Table | Database table name | Specifies the name of the database table where the data collector writes its information. | Yes | ||
| InputDeviceActionsCollector.UserProps | User properties to capture | Specifies the properties that this data collector captures about the user who does an action on an input device. | Yes | ||
| InputDeviceActionsCollector.InputDeviceProps | Input device properties to capture | Specifies the properties that this data collector captures about an input device when a user does an action on it. | Yes | ||
| InserterActionsCollector.UserProps | User properties to capture | Specifies the properties that this data collector captures about the user who does an action on an inserter controller. | Yes | ||
| InserterActionsCollector.InserterProps | Inserter properties to capture | Specifies the properties that this data collector captures about an inserter controller when a user does an action on it. | Yes | ||
| JobActionsCollector.UserProps | User properties to capture | Specifies the properties that this data collector captures about the user who does an action on a job. | Yes | ||
| JobActionsCollector.JobProps | Job properties to capture | Specifies the properties that this data collector captures about a job when a user does an action on it. | Yes | ||
| JobPrintCollector.JobProps | Job properties to capture | Specifies the job properties that the Job Print Progress data collector captures when a job starts printing and when a job stops printing. | Yes | ||
| JobPrintCollector.PrinterProps | Printer properties to capture | Specifies the printer properties that the Job Print Progress data collector captures when a job starts printing and when a job stops printing. | Yes | ||
| Job.Reports.DocFileToStore | Document properties file | Specifies the name of a tab-delimited file containing property values to write to the database. | Yes | No | |
| Job.Reports.DocPropToStore | Document properties to write | Specifies the document properties to write to the database. | Yes | No | |
| Job.Reports.DocumentTableName | Document properties table | Specifies the name of the table where the selected document properties are stored in the database. | Yes | No | |
| Job.Reports.EventType | Event type | Adds a custom label for the information that the step stores in the database. | Yes | No | |
| Job.Reports.JobPropToStore | Job properties to write | Specifies the job properties to write to the database. | Yes | No | |
| Job.Reports.JobTableName | Job properties table | Specifies the name of the table where the selected job properties are stored in the database. | Yes | No | |
| JobStepCollector.ContinueOnFailure | Continue on error | Specifies whether jobs continue to process in their workflows if the Job Step Progress data collector fails to capture information. |
|
Yes | |
| JobStepCollector.JobProps | Job properties to capture | Specifies the job properties that the Job Step Progress data collector captures at the beginning and end of each workflow step. | Yes | ||
| PrinterActionsCollector.UserProps | User properties to capture | Specifies the properties that this data collector captures about the user who does an action on a printer. | Yes | ||
| PrinterActionsCollector.PrinterProps | Printer properties to capture | Specifies the properties that this data collector captures about a printer when a user does an action on it. | Yes | ||
| PrinterStatusCollector.PrinterProps | Printer properties to capture | Specifies the printer properties that the Printer Status data collector captures when the printer’s Enabled status or Printer status property changes. | Yes | ||
| StepCollector.DatabaseTables | Database tables affected | Specifies the names of the database tables that steps based on the WritePropsToReportsDatabase step template write data into. | A list with all tables defined for a WritePropsToReportsDatabase step that exist in the Reports database whether these tables contain data or not. | No | |
| StepDurationCollector.JobProps | Job properties to capture | Specifies the job properties that the Job Step Duration data collector captures during each workflow step. | Yes | ||
| UserActionsCollector.UserProps | User properties to capture | Specifies the properties that this data collector captures about the user who does an action on a target user. | Yes | ||
| UserActionsCollector.TargetUserProps | Target user properties to capture | Specifies the properties that this data collector captures about a target user when a user does an action on it. | Yes | ||
| WorkflowSystem.Capture.Database | Database | Specifies the name of the PostgreSQL database to use for storing the information collected for reporting. | Yes | ||
| WorkflowSystem.Capture.Hostname | PostgreSQL server IP address or host name | Specifies either the network IP address or the host name of the computer where the PostgreSQL database that stores job and printer data is stored | Yes | ||
| WorkflowSystem.Capture.Password | Password | Specifies the password that you want RICOH ProcessDirector to use for logging in to the PostgreSQL reports database. | Yes | ||
| WorkflowSystem.Capture.Port | PostgreSQL server port | Specifies the port number to use for communicating with the PostgreSQL reports database. | Yes | ||
| WorkflowSystem.Capture.Username | User name | Specifies the user name that you want RICOH ProcessDirector to use for logging in to the PostgreSQL reports database. | Yes |