Using Fields

A field is a container of information within a business object. Fields can reflect information that is typed or selected by the user. Sometimes field information is generated by the system.

After creating a field, add it to a form for viewing. On a form, a field is represented using a field control such as a check box, text box, or drop-down list. The Field type determines which controls can be used. When a form is opened for a read-only object, all controls except those listed in the exception list become read-only.

Field Types

Field type	Description	Control used
Date/Time	Stores a date using the format for date/time entries.	Date, time, or date/time box
Link	A system field in a parent object that points to the related record (such as customer for the incident object).	Label menu or link selector
Logical	A yes-no (or true-false) field.	Check box or radio button
Number	Stores whole numbers.	Number box
Text	Stores letters, numbers, and punctuation.	Text box or combo box; sometimes a radio button

Common Object Field Properties

Field	Description
Field Name	Enter a unique name without spaces or special characters.
Display Name	Enter a name that appears to users.
Description	Optional. Enter a description of the object.
Pick List Validated	Select this option to use a validation list, then select a list from the drop-down menu. The field must be marked as Unicode to be used as the pick list for a validated text field. Also, the data type between the stored field in the named validation list, and a validated field, must match. For example, if the named validation list is defined against a text field, but the user is attempting to use it for a number field, the validation will not work. You can also translate values from a validated pick list. If a field is validated and the field from where it is fetching data is marked Is Localizable, then click the Values link in the Validated section, and add the translated values for the supported languages.
Is State Transition	This option appears when the previous Validated option is selected. This constrains the field value based on the current status. Mostly used for problem or change fields and is activated by the status field. For example, without this option selected, a user could create a change record and immediately set it to a Closed status. Selecting this option blocks this behavior and strictly enforces the state transitions.
Field AnnotationA tag on a business object, business object group, business object relationship, or field identifying the item as a valid target. It is a property that identifies the purpose of the item so that other applications (for example, the FrontRange application, the FrontRange Administrator, integrated applications, FrontRange extensions, etc.) can identify or use that item.s	Select to identify the field as a valid target. This property identifies the field's purpose so that other applications (for example, the mobile application) can identify or use the field.
Unique	Check to assign a unique ID to a record. This ID is unique across all instances (records) in the business object table. This is the same as the UNIQUE index used in a SQL database.
Nullable	Check to allow a NULLNo value. A field that is blank. value to be entered in a field. Values are not enforced in this field, but when they are defined, they must be unique (even though Unique is not checked).
Localized	When selected, the localized version of the field is prepared in the database table for translation. If not selected, the localized version of the field is removed from the table and any existing translations are removed. Only administrators can update the field's localized value.
Hidden in UI	Check to not show this field in the HEAT interface. This field cannot be used in creating a form. Typically activated by default, it is of particular use in group and member objects.
Searched	Check to make this field searchable. For example, number fields often produce unexpected results when performing a text search. You can check this field to make your field search correctly. An example is the IncidentNumber field in the incident object.
Stored	Select to store field values in the database. When unchecked, it permits the field to be evaluated at runtime but not store its values.
System	Set automatically for fields created, maintained and used by the system. Such fields can not be modified or deleted in the Application Designer.
Audited	When selected, any changes to this field will be audited in the audit stream.
Full-text indexed	Only one full-text indexed field is allowed per object. A full-text index can contain up to 1024 fields (columns). This field is used to store information about significant words, to speed up searches.
Commonly Used	Replaced by new layout editor interface.

Field Options

Number

Includes integers and real numbers.

Field	Description
Total Number of Digits	Number of digits allowed to be stored in a field entry.
Precision	Level of decimal precision to be stored in a field entry.

Text

Stores text strings. This includes single and multiple rows strings up to 2000 characters length as well as huge amount of text, whose size could be up to several megabytes.

Field	Description
Field Type	Choose a type from the drop-down list. Text. To create a plain text field. Unicode Text. To allow the field to contain non-English characters. For a Unicode text field which is marked as validated, only named validation lists with stored fields which are Unicode text fields, will be shown. Similarly, regular text fields can only by validated by named validation lists, with stored fields which are regular text fields. As an example, assume there is a named validation list defined against the LoginID field in Profile.Employee, which has been marked as Unicode (for example, DisplayName of Employee with LoginID value by Team). In order for it to be used as the pick list for a validated text field, the field must also be marked as Unicode, in order for the named validation list to show up. Also, the data type between the stored field in the named validation list, and a validated field, must match. For example, if the named validation list is defined against a text field, but the user is attempting to use it for a number field, the validation will not work. HTML. To enable HTML controls and allow users to enter HTML text. HTML fields are limited to 200KB. See also note below.
Variable	Select this option to create a field of variable length, then enter the maximum number of characters permitted. The default length is 32. The highest number allowed is 2000.
Fixed	Fixes the length of a field entry to a specified size. The field value includes padding to the right. The default length is 32. The highest number allowed is 2000.
Unlimited	Click to allow an unlimited number of characters or bytes to be displayed for this property. The highest number allowed is 2GB. HTML fields should not exceed 200MB.
Full Text Search Enabled	Enables the field to be included in full-text searches.

Placing HTML (including JavaScript) into a text field and then binding it to an HTML control creates a security hole. Obviously, this is not good practice and we do not recommend this.

Password

Stores passwords. Passwords themselves are not stored; the hash function's result is stored instead. When you type a password, the hash function's returned value is compared to the stored value. If they match, the password is correct.

Field	Description
Maximum Length	Character limit for a field entry.

Passwords appear as dots on the screen. See Password Policy.

Password Options

SymmetricallyEncriptedString

Stores text securely. In contrast with the password field type, it can be restored.

SymmetricallyEncryptedString fields are stored in the database in encrypted view. For encryption, symmetric algorithm is used. Symmetric here means that for encryption and decryption the same key is used. Therefore, encrypted value can be easily decrypted when needed. Since symmetric keys are stored in database and can be retrieved by experienced users, this type should be used only in scenarios when "weak" data protection could be implemented.

Field

Description

Maximum Length

Character limit for a field entry.

Crypt Key

Encryption key for a asymmetrically encrypted string.

Encryption Algorithm

Encryption algorithm used:

Symmetrical encryption can use 0 (DES), 1 (RC2), 2 (Rijndael) and 3 (TripleDes) algorithms.

Asymmetrical encryption uses only the RSA algorithm.

AsymmetricallyEncriptedString

Store text as securely as possible. Use this field to maximize security for stored text. In contrast with symmetrically encrypted text, this text cannot be restored without an externally stored private key. Due to decryption and performance issues, use this type only when necessary.

AsymmetricallyEncryptedString fields are stored in the database in encrypted view. For encryption, asymmetric algorithm is used. Asymmetric here means that there are two parts of key�Public and Private. The public key can be widely known and used for encryption, but for decryption private part of key must also be known.HEAT stores only the public key, so the data can only be decrypted by an user who knows the private key as well as the public key.

Field	Description
Public Crypt Key	Public half of an asymmetrical (public-private combination) encryption key. The private half of the key is not stored in HEAT.

Date/Time

Stores date and time entries together. In special circumstances, you also may store date or time as separate entries.

Field	Description
Hold Date	By default, date/time fields display calendar date and time. Select this option to NOT show the date in a date/time field.
Hold Time	Select to NOT show the time in a date/time field.
TimeZone	Select to automatically show the time zone list.

Binary

Stores large binary files such as images.

Field	Description
Unlimited	Select to allow an unlimited number of characters or bytes to be displayed for this property.
Limit To	Number of characters allowed to be stored in a field entry (maximum 2000 characters allowed).
Full Text Search Enabled	Select to enable full text search on this field. Select the Type Column from the drop-down list.

Link

Allows you to link one object to another.

Field	Description
Relationship	Specify the relationship to be used..
Restrict To	When the relationship specifies a standalone business object or a member object, this field displays the name of the target object. When the relationship specifies a group object as the target, you can restrict the relationship to a specific group.
Validate By	Specify a field to validate by.
Targeted Selection	Select the group if the relationship specifies a group object as the target.
Identifier Property	Appends a default, unique _RecID to a business property. You can manually edit this identifier.
Category Property	Appends a default _Category to the business property. You can manually edit this category.