WritePropsToReportsDatabase

A step based on this step template lets you choose which job and document properties to store in the Reports database when the step runs. You can insert multiple copies of this step template in a workflow to store different properties at different times during job processing.
These job properties are always stored:
  • Current phase (Job.Phase)
  • Current state (Job.State)
  • Current step (Job.Step)
  • Current time (Job.CurrentTime)
  • Current workflow (Job.Process)
  • Event type (Job.Reports.EventType)
  • Job number (Job.ID)
These document properties are always stored:
  • Associated job number (Doc.CurrentJobID)
  • Original job number (Doc.OriginalJobID)

Job property defaults

  • Document properties file: ${getFileName(document,dpf,read)}
  • Document properties table: doc_workflow_props
  • Document properties to write:
  • Event type:
  • Job properties table: job_workflow_props
  • Job properties to write:

Usage notes

  • This step must run on the primary server.
  • If the table specified in Document properties table or Job properties table does not exist in the Reports database when the step runs, the table is created.
  • Every time a job or document property is added to the database table, a new column is created. The name of the column takes the database name of the job or document property, replacing every period (.) with an underscore (_). For example, the table column for Document.TotalPages is Document_TotalPages.
  • Make sure that the table names are not the same as the names of database tables specified on any of the data collectors.
  • You must select at least one job property or one document property to store, in addition to the properties that are stored by default.
  • If you run the step and later remove items from the list of properties to write, those properties are not recorded the next time the step runs. However, their columns are not deleted from the tables.
  • You must enable data collection from the Database settings page or the job fails during this step.
  • You can select to delete the data stored by the WritePropsToReportsDatabase step during a workflow. Use Workflow Step Collector from the Data Collectors section to configure the retention time. The Workflow Step Collector is enabled by default.