addColumn

The addColumn element allows a new column to be added to the schema.

Example:

<addColumn name="x_my_new_column" dataType="Integer" table="case">
	<description>This is a description for my new column.</description>
</addColumn>

Required Attributes:

Attribute Name

Description

name

Specifies the name of the column.

dataType

The data type of the column. Valid values are:

  • String
  • Integer
  • SmallInteger
  • TinyInteger
  • Real
  • Double
  • Character
  • String
  • LongString
  • DateTime
  • Decimal

table

Specifies the name of the table on which this column should be added.


Optional Child Elements:

Element Name

Default

Description

length

0

For string columns, the length (in characters) of the column. This is required for string columns. The length can be increased, but cannot be decreased, as this could cause data loss.

description

 

Description of the column and its purpose.

isSearchable

false

For Oracle database systems, indicates if this column should be searchable in a case-insensitive manner or not.

defaultValue

 

The default value to be placed in this column when a new row is inserted.

isUserDefined

true

Indicates if this column has been defined by the customer.

decimalWidth

0

For decimal data types, specifies the maximum number of integers before and after the decimal point.

mantissaWidth

0

For decimal data types, specifies the maximum number of integers following the decimal point.

clarifyGenericFieldID

-1

This data is used by Amdocs/Clarify applications to identify fields in different objects that are handled in a similar way. For example, a WIPbin contains different types of objects, such as cases and bugs. Certain fields in these objects (such as the ID number and title) are treated in the same way by the application and are assigned the same clarifyGenericFieldID.

isNullable

false

Specifies if the column should be nullable or not.

isCurrencyData

false

Indicates if this column holds monetary (currency) data.

isAChangeField

false

Indicates that this is a column that I want to know about changes to. When this column's data is changed, the column indicated by the isChangeDateField is updated to the current date/time. There can be multiple isAChangeField columns and one isChangeDateField column for each table.

isChangeDateField

false

Indicates that when a isAChangeField column's data changes, this column is set to the current date/time. There can be multiple isAChangeField columns and one isChangeDateField column for each table. .

isNotClientDistributable

false

In a mobile (Traveler) implementation, indicates if the column data should be synced to the client or not.

isNotServerDistributable

false

In a mobile (Traveler) implementation, indicates if the column data should be synced to the server or not.

isPredefined

false

This attribute is not typically used.

isComputed

false

This attribute is not typically used.

isMandatory

false

This attribute is not typically used.

isDirect

false

This attribute is not typically used.

isBinaryData

false

This attribute is not typically used.

isUserModified

false

This attribute is not typically used.

See Also

schemaScript

addExclusiveRelationSet

addIndex

addJoin

addRelation

addSqlView

addSqlViewColumn

addTable

addView

addViewColumn

updateColumn

updateIndex

updateJoin

updateRelation

updateTable

updateSchema

updateSqlView

updateSqlViewColumn

updateView

updateViewColumn

Next

addExclusiveRelationSet

addColumn