Add/Edit Item Dialog Box

This dialog box allows you to add/edit item of the list or the enumeration.

Option Description
Item type This text box displays the type of the item.
Inline type information This check box controls how the information about the property is stored in the component configuration. If this check box is not selected, then type, cardinality, representation and value will be stored in separate entries. If this check box is selected, then type, cardinality and representation will be stored directly in the single VALUE entry. This can be useful when the values of the complex objects are replaced. For a formal definition of an inline representation, see Inline Representation.

In particular, this check box is taken into consideration for representation of property value.

For example, for Integer type the default representation of value 111 is: VALUE = 111. Inline representation is: VALUE = Integer32:111.

Representation Select a representation in which the property value will be saved in the configuration. Each type has its own specific set of representations. Select the type of representation which is appropriate for you. Only a limited set of types has specific representations. The following table describes the list of additional representations with the corresponding types:
Additional representations:
Type Representation display name Internal name
Date/Time Local date/time local
Binary Binary from file fileref
Binary from UNICODE string unicode
Binary from ANSI string string
Object Object reference objectref
Item value This text box cannot be empty for any type except for String type. Enter the value of the property manually or click the button to open a dialog box which helps to enter value for the item. Actual dialog box depends of the specified Item type and Representation. One of the following dialog boxes are displayed:

The format of the value definition depends on the value of Representation and Inline type information options.

When specifying an item value the following format should be used:

  • For Boolean type strings "true", "yes", "on" and "1" represent a values of true, and strings "false", "no", "off" and "0" represent a value of false.
  • For Date/Time type there are two representations: default and Local date/time. For the default representation the following format should be used: yyyy-MM-dd HH:mm:ss (4 digit year and 24 hour time are required). For the local representation, the time should be represented in the user’s locale settings. Inline representation requires inclusion of the value in quotation marks.
  • For Floating point type a number can be represented with simple or exponential record using '.' (point) character as decimal point symbol. Special values are represented with strings: "+INF", "-INF" and "NAN". 64 bit float point range is supported.
  • For Identifier type a value should be represented as "{8-4-4-4-12}", like {1A589494-AC8A-4FF7-814D-7EEFE306A033}.
  • For Integer type a value should be represented in decimal form in 32 bit signed range.
  • For String type a value should be represented as is. Since string is not encoded, the special characters (like line separation or Unicode characters which do not belong to the current user language) cannot be stored in the configuration file. However if an RRT of another component is used as the string value, then that component can pass an arbitrary string as an RRT. Empty strings are also supported. Inline representation requires inclusion of the value in quotation marks and encoding content like the C strings do (using backslashes '\’).
  • For Binary type the default representation is the sequence of hexadecimal digits and blank separators. All separators are ignored. If required, the value is post-padded with "0" digit to fit into 8-bit bound. For example, the following strings represent the same value: "0d0a5570" , "0d0a 5570", "0 d0a 557".
    • Binary from file. Instead of hexadecimal value specify the file path here in same form as for string value. When the component stores this field it reads the file and place its content into the field value.
    • Binary from UNICODE string. Instead of hexadecimal value specify the string here in same form as for string value. The string content will be passed into the binary value. Each character will be represented with 16 bits of UTF16 encoding. No null-terminator will be appended.
    • Binary from ANSI string. Instead of hexadecimal value specify the string here in same form as for string value. The string content will be passed into the binary value. Each character will be represented with 8 bits of ANSI encoding using the Windows user code page. No null-terminator will be appended.

The above rules describe the format of the simple type. To store values of such fields the component creates VALUE entry which contains the above format.

  • Object type in default representation (when Inline type information is OFF) contains additional entry CLASS which contains string value of the object’s class name. It does not have VALUE entry. Instead it has set of subtopics each named FIELD. Each subtopic contains information about one field of the object. Therefore, it’s impossible to replace value of the Object using RRT in default representation. To do that use inline representation (when Inline type information is OFF).

Any type in enumeration and list cardinality in default representation (when inline is OFF) does not have VALUE entry. Instead it has a set of subtopics each named ITEM. Each subtopic contains information about one item of the list (its representation and value). Therefore it’s impossible to replace value of the enumeration or list using RRT in default representation. To do that use inline representation.

Example:

This example demonstrates representation of list of objects. The list contains one item. The item is object with two fields: "f1" and "f2". Other information is omitted for simplicity.

TYPE = Object
CLASS = MyClass
CARDINALITY = LIST
INLINE = NO
ITEM { 
      INLINE = NO
      FIELD {
            NAME = f1
            VALUE = abcd
      }
      FIELD {
            NAME = f2
            VALUE = 123
      }
}

Inline representation of the same example is:

INLINE = YES
VALUE = List Object "MyClass": {{"f1"="abcd", "f2"= 123}}
Verification specify if the component should verify value of this item when submitting documents into the FileNet P8 Content Engine object store. Following settings are possible:
  • Check — Always check value of this item.
  • Do not check — Never check value of this item.
  • Default — Use parent (list or enumeration) settings.
Note: When parent value of a complex type ( List or Enumeration) is inline, then all its items will be verified or not verified accordingly to the parent’s settings. This is similar to the Default value of Verification.