Database property names for servers

Messages about servers might refer to properties by their database names, which begin with Instance.

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

Server properties

Database name Notebook field name Brief description Internal values Editable
Instance.Description Server description Contains user-defined text that describes the Ricoh ProcessDirector server.   Yes
Instance.Enabled Enabled status Specifies whether the server can do tasks.
  • No
  • Yes
No
Instance.ID Displayed in the properties notebook title: Server name Contains the name of the server.   No
Instance.IPAddress Server IP address or host name Specifies either the network IP address or the fully qualified host name of the computer that the server is running on.   Yes
Instance.InGeneralServerPool In general server pool Specifies whether the server is a general-usage server or a restricted-usage server.
  • No
  • Yes
Yes
Instance.LastModified Last modified The date and time that the server was last changed.   No
Instance.MaxHighUsageSteps Maximum resource-intensive step count Controls how many resource-intensive steps the server lets run concurrently.   Yes
Instance.MaxLowUsageSteps Maximum step count for other steps Controls how many non-resource-intensive steps the server lets run concurrently.   Yes
Instance.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this server.   No
Instance.Status Connection status Shows the current status of the server.
  • Connected
  • Disconnected
No