Skip to end of metadata
Go to start of metadata

iteraplan provides seven different types of Custom Attributes

  • Enumeration
    These attributes have a specific number of possible values defined for them.
  • Text
    Unlike enumeration-type attributes, Text Attributes permit users to enter text strings of their choice as attribute values. 
  • Numeric
    Numeric Attributes require users to enter numbers as attribute values. Up to two places following the decimal point are permitted.
  • Date
    A Date Attribute requires users to enter a date as the attribute value (format depends on the currently active user interface language).
  • Date Interval
    A Date Interval is edited with two date editors for start and end date. Values that depend on date attributes can only be changed by editing the corresponding date value.
  • Accountability
    These attributes require the entry of a user (see Users) as attribute value.
  • Boolean
    Boolean Attributes can either have Yes or No as attribute values.

Properties for all types of attributes

  • Name: The usage of special characters is possible in attribute names, but not recommended. Especially the characters in the following list will cause problems when using iteraQl in the query console or in the filter for the partial data export.

    < > ( ) { } [ ] @ & ! # = / | " ' ; . :

    Furthermore attributes must not have the same name as a Building Block Type in any locale, as that leads to issues with, for example, the Import/Export functionality. The attribute name must not be included in the following blacklist of reserved keywords (case doesn't matter):

    'architecturalDomains', 'availableForInterfaces', 'baseComponents', 'businessDomains', 'businessFunctions', 'businessMappings', 'businessObject', 'businessObjectAssociations', 'businessObjects', 'businessProcess', 'businessProcesses', 'businessUnit', 'businessUnits', 'children', 'description', 'direction', 'generalisation', 'id', 'informationFlows', 'informationFlows1', 'informationFlows2', 'informationSystemDomains', 'informationSystemInterface', 'informationSystemInterfaces', 'informationSystemRelease', 'informationSystemRelease1', 'informationSystemRelease2', 'informationSystemReleaseAssociations', 'informationSystemReleases', 'informationSystems', 'infrastructureElement', 'infrastructureElementAssociations', 'infrastructureElements', 'interfaceDirection', 'iteraplan_InformationSystemInterfaceID', 'itService', 'itServices', 'lastModificationTime', 'lastModificationUser', 'name', 'parent', 'parentComponents', 'position', 'predecessors', 'product', 'products', 'projects', 'specialisations', 'successors', 'technicalComponentRelease', 'technicalComponentReleaseAssociations', 'technicalComponentReleases'

    In addition: Using a custom attribute named 'version' can lead to unexpected results when filtering for the version of Information Systems or Technical Components. We recommend to use a different name.

  • Description
  • Attribute Group: One of the groups already defined. The affiliation of an attribute to a particular group can be entered either on the form for editing attributes or the form for editing attribute groups
  • Mandatory Attribute: If the user omits an entry for a mandatory field, it is still possible to save the Building Block. However, the missing value will be highlighted as warning.

Additional properties for some attribute types

  • Enumeration: a predefined set of values have to be defined for attributes of this type, since users must assign one of these values when setting attributes for a particular instance of a Building Block. You can also enable an attribute for multiple-value selection. Users can then select multiple attribute values from the list. If this option is not set, only one value can be selected from the set of predefined options. All attribute values must be case insensitively unique. For Enumeration Attributes it is also possible to set a standard colour to be loaded on default for representation in diagrams. Enumeration Attributes with just two values (and for which no multiple choice is permitted) can be used to represent either-or choices.

    Control characters, including newline and carriage return, should not be used in enumeration attribute values, as they can lead to unexpected errors. See also the restrictions for attribute names above.

  • Text: You have the option of selecting 'Multiline Attribute Values'. A multi-line field instead of the single-line field is then presented for users to enter their text, whith the possibility to enter up to 4000 characters.

  • Numeric: It is possible to specify a lower and upper limit for attribute values, and a unit. Attribute values are still accepted even if they are outside the permitted range, but are shown in red font in the view mode of the Building Block.

  • Date Interval: You can define a colour which is used in the master plan diagram. Optionally it is possible to set a start date attribute and an end date attribute. In this case the start respectively end date are loaded from the date attribute and cannot be edited within the date interval.

  • Accountability: You have to define a set of values (users) for attributes of this type. You can also enable an attribute for multiple-value selection. For Accountability Attributes it is also possible to set a standard colour for representation in diagrams.

  • No labels