Database property names for step templates

Messages about step templates might refer to properties by their database names, which begin with StepTemplate.

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 after the step template has been created.
  • No means that an authorized user cannot change the value.

Step template properties

Database name Notebook tab: field name Brief description Internal values Editable
Step.Color Step color Specifies the color of the step as it appears in the workflow builder.
  • Red
  • Orange
  • Gray
  • Blue
  • Purple
  • Not set
 Yes
Step.Description Step description Describes the purpose of the step. For example, it might describe how the step processes a job.   Yes
Step.DisplayName General: Step name The name given to a step when it is added to a workflow.   Yes
Step.ID General: Step identifier Specifies the internal name for this step. This value is derived from the name of the step.   No
Step.Template.CreatedBy General: Template created by Specifies the name of the feature or extension that created the step template.   No
StepTemplate.Color Step color Specifies the color of the step as it appears in the workflow builder.
  • Red
  • Orange
  • Gray
  • Blue
  • Purple
  • Not set
 Yes
StepTemplate.Description General: Template description Contains text that describes the function of the step template.   Yes
StepTemplate.Enabled General: Enabled status Specifies whether the step template is enabled.
  • No
  • Yes
 No
StepTemplate.HighResourceUsage Tuning Properties page: Concurrent step limit Specifies where the limits are set for the number of steps created from the step template that can run at the same time.
  • Use limits set here
  • Use limits set on server
 Use limits set here
StepTemplate.ID Displayed in the properties notebook title: Step template name Contains the name of the step template.   No
StepTemplate.LastModified Last modified The date and time that the step was last changed.   No
StepTemplate.MaximumActiveCount Tuning Properties page: Limit the number of concurrent steps active in the system to radio button Specifies how many occurrences of the step template, and any steps that are created from it, can run concurrently on a specific type of RICOH ProcessDirector object.   Yes
StepTemplate.MaximumActiveUnit Tuning Properties page: for each drop-down list Specifies the type of RICOH ProcessDirector object to which the value of the Maximum active count property for the step template applies.
  • PerInputDevice
  • PerPrinter
  • PerServer
  • PerSystem
 Yes
StepTemplate.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this step.   No
StepTemplate.ModuleType General: Module type Identifies the type of function the step template provides.
  • Cleanup
  • InitJobType
  • Java
  • Manual
  • Print
  • Submit
  • SubmitChild
 No
StepTemplate.Servers Tuning Properties page: Run only on the selected server or servers radio button Lists all the restricted-usage servers and general-usage servers on which any steps that are created from the step template can run.   Yes
StepTemplate.SourceID General: Step template source ID Specifies the name of the step template that was used to create this step template.   No
StepTemplate.UseGeneralServerPool Tuning Properties page: Servers to use Specifies which computers can run the steps created by the step template.
  • Run on specific servers
  • Run on servers in general server pool
 Run on servers in general server pool
Parent topic: Database property names