Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The metadata for each property consists of the following attributes:

Attribute

Description

Active

Whether this property is in use for the integration.  Allows hiding the property without removing it.

Code

A unique, required name which is used by the API and other scripts, and therefore must following keyword limitations of Java and Groovy (e.g. no spaces or special characters other than underscore).

Display Name

A name for the property which will be displayed for data entry rather than the technical Key Name.

Description

A meaningful description of what the property is used for. 

Required

Whether or not a value for the property is required for CMS instances using this provider.  Implementations should use default values in the Java/Groovy class or script for any optional properties.

Data Type

The data type for the property.  Supported types - String, Boolean, Integer, or Double

Sub-Type

An optional qualifier describing the type of data the property will contain.  This is used to validate the data entry.  Supported types - URL, JDBCURL, or Directory.  Simply leave blank if none of these qualifiers are applicable.

Encrypted

Indicates whether the property is secure and should be encrypted when stored, and care should be taken not to print their values in the logs.

Values for these properties will be provided when instances of this CMS are created.

...