Control number fields

A Control Number field contains a string that uniquely identifies a record. The use for a control number is described more fully in "Naming records". The system generates a record's control number when the record transitions from the null state to any other state. A Control Number field uses all the usual field properties, which are described in "Field properties".

The Do not Auto Populate and Read Only check boxes are grayed out and always checked. You cannot uncheck either check box.

If the Generate on Create check box is checked, the Control Number field is set to a generated value the first time that the record transitions to a state other than null. This is usually desirable.

The generated value is based on a counter associated with the business object. There are other settings that control the format of generated control numbers described in Control numbers. If we use the default values for these settings, the control numbers generated for records created from the same business object are 1, 2, 3, etc.

If the Generate on Create is not checked, no value is automatically put in the Control Number field. This is useful only if you have a workflow to set a value in the field.

It is not usually a good idea to check a Control Number field's Required check box. The value of a Control Number field is usually not set until the first time the record that contains the Control Number field is saved. If the Required check box is checked, a form will not allow the record to be saved until the Control Number field has a value. Since control number fields are always read-only, you will be unable to put a value in the field or save the record.

IBM® Maximo® Real Estate and Facilities Data Integrator does not properly handle updates to records for business objects containing publish names that include a Control Number field with the Generate on Create check box selected. In this scenario, Data Integrator is unable to determine that a record included in an upload file already exists in the system, causing new records to be created each time the file is uploaded. For more information, see Application Building for the IBM Maximo Real Estate and Facilities: Data Management.

Tip: Control Number field names should end with CN for easy identification later, e.g., cstControlNumberCN.