Previous Topic: Understanding the Component XML StructureNext Topic: ItemSyncDefinition


Basic Properties

The basic properties of your custom component help to distinguish it from other custom components that you create.

FacetType/name

Specifies the component name. Each component must have a unique name that identifies it internally within the system. Carefully choose a name with a minimal possibility of naming conflicts with future similar components. For example, define a naming scheme that helps ensure that these component names are unique.

Note: This name is never exposed externally. To display a component name in the user interface, use the ItemSyncDefinition, itemTypeLabel, and itemTypeLabelPlural elements.

Can be updated: No

Possible values: Alphanumeric and underscore. Dot and dash are not permitted.

Documentation

Specifies internal comments for the component. To help make these comments useful, we recommend that you describe why and when you added or changed the component.

Can be updated: Yes

Possible values: Plain text

Effect of updating: None

When does the update take effect: Immediately

Required Actions for updates to take effect: None

Component

Asserts that this item is a component.

Can be updated: No

Possible values: true

FacetOf

Asserts that this component is an item.

Can be updated: No

Possible values: namespace="http://im.ca.com/core" name="Item"