CSM 10.4 Documentation

Home

Define General Properties for a Field

Use the General page in the Field Properties window to define general properties for a field.

To define general properties for a field:

  1. Open the Field Properties window. For more information, see Open the Field Properties Window.
  2. Select the General page.
  3. Define general information for the field:
    Option Description
    Name

    Provide a display name for the field.

    Internal Name

    When you provide a display name, the internal name is automatically populated with the field display name (you can change this, if necessary).

    The internal name is the name given to the field in the Business Object's database table. An internal name can only have letters, digits, and underscore characters.

    (Optional) Description Provide a description.
    Field Type

    Select a field type (Text, Number, Date/Time, or Logical).

    Warning:

    When you change the field type for a field, a warning is displayed. By confirming the change of field type, you accept that existing content might be overwritten.

    Example: A description field with a Field Type of Text is displayed on multiple Incident Forms. You update the Field Type for that description field to Number. Consequently, the description on each affected Incident is updated to a default number of 0. Any existing descriptions are overwritten.

    If you change the Field Type for a field, you must ensure the correct Control is used for any Forms on which the field is displayed. Failing to do so may cause Form errors.

    Some Field Type changes may not result in content being overwritten. For example, if you create a Blueprint in an environment with no data and subsequently apply it to your production site. Regardless, we recommend you investigate the impact of changing Field Type before acting.

    Track Changes to Field

    Select to track changes made to the field in the Business Object's history.

    Note:

    For field changes to be tracked, the Business Object must have a history Relationship and Track Field Changes defined on the History page of the Business Object Properties window. For more information, see Define History Properties for a Business Object.

    You must select the Track Field Changes check box if the field will be encrypted (enabled in Advanced properties. For more information, see Define Advanced Properties for a Field); decrypting fields is tracked in Journal-History records.

  4. Based on the field type, define general field properties. For more information, see the relevant details:
    Note: Logical Fields do not have any additional user-defined general properties. They can hold only one of two values: True or False, and Yes or No.
  5. Select OK.

  6. To publish the Blueprint and commit the changes, select File > Publish Blueprint (for more information, see Publish a Blueprint).

    Alternatively, to save the Blueprint and continue making other changes, select File > Save Blueprint (for more information, see Save a Blueprint).


Was this article useful?