updateColumn

The updateColumn element allows an existing column to be modified.

Example:

<updateColumn name="x_my_new_column"  table="case" >
   <description>This is the description of the updated column.</description>
</updateColumn>

Required Attributes:

Attribute Name

Description

name

Specifies the name of the column.

table

Specifies the name of the table on which this column exists.


Optional Child Elements:

Element Name

Description

length

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

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

Indicates if this column has been defined by the customer.

decimalWidth

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

mantissaWidth

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

clarifyGenericFieldID

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

Specifies if the column should be nullable or not.

isCurrencyData

Indicates if this column holds monetary (currency) data.

isAChangeField

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

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

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

isNotServerDistributable

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

isPredefined

This attribute is not typically used.

isComputed

This attribute is not typically used.

isMandatory

This attribute is not typically used.

isDirect

This attribute is not typically used.

isBinaryData

This attribute is not typically used.

isUserModified

This attribute is not typically used.

Notes:

[1] The only changes to a decimal type column precision and mantissa are these which don't cause data loss. For example, if mantissaWidth increases, the decimalWidth must also increase accordingly.

See Also

schemaScript

addColumn

addExclusiveRelationSet

addIndex

addJoin

addRelation

addSqlView

addSqlViewColumn

addTable

addView

addViewColumn

updateIndex

updateJoin

updateRelation

updateTable

updateSchema

updateSqlView

updateSqlViewColumn

updateView

updateViewColumn

Next

updateIndex

updateColumn