Internal Object


The entityAttribute object defines a unique member of the entity. Entity attributes correspond to the columns of database tables and columns of a spreadsheets. Both the entity attribute and its properties are described by this object.

    def newEntityAttribute
        intObj = {
            attributeName: nil,
            attributeCode: nil,
            attributeAlias: [],
            attributeDefinition: nil,
            dataType: nil,
            allowNull: true,
            unitOfMeasure: nil,
            domainId: nil,
            minValue: nil,
            maxValue: nil

attributeName: string (required) - the common name used to identify this attribute

attributeCode: string (required) - the code used to identify this attribute. Most often this will be the table or spreadsheet column name

attributeAlias: array - an array of quoted strings providing alternate names by which the attribute is known

attributeDefinition: string (required) - a succinct but comprehensive definition for the attribute

dataType: string - the datatype for the attribute. Names for datatypes vary widely by database management system. Use the datatype name associated with the database system that implemented the entity (e.g., 'integer', 'boolean', 'decimal(8,5)', 'varchar(200)').

allowNull: boolean - indicates whether null values are allowed for the attribute

unitOfMeasure: string - a unit-of-measure for the attribute (e.g., 'meters', 'atmospheres', 'liters').

domainId: string - provides the domain ID for the dictionaryDomain containing the list of permissable values for this attribute

minValue: string - the minimum range value permissible for this attribute

maxValue: string - the maximum range value permissible for this attribute