Using Annotations for Defining Properties

You use annotations to define the source configuration type properties that appear in Deployment Automation during component configuration.

The following annotations must be defined in the AllUITypeFileCreator class:

Annotation	Usage
SourceConfigTypeConfig	This is the configuration for a custom source configuration type. It has the name, version, and description of the custom source configuration type.
VersionParams	This allows creation of versioned artifacts. `VersionParams` can have more than one `VersionParam` defining all the individual properties that may be required for creating a single version. Defining `VersionParam` will result in showing the Import Version dialog box in the Deployment Automation component Versions page. A fully qualified `VersionParam` has the following: name: Name of the parameter displayName: Display name of the parameter description: Description of the parameter datatype: Defines what type of data this parameter can support. Valid values are: TEXT: Defines all text fields TESTAREA: Defines fields for holding multiline text CHECKBOX: Defines choices SELECT: Defines list of choices using drop down control MULTI_SELECT: Defines list of multi selectable choices using drop down control SECURE: Defines secure text fields allowedValues: Defines the set of allowed values that may be used with SELECT/ MULTI_SELECT fields. This has the following: label: Defines what would be the label for the UI field value: Defines what would be the value for the UI field required: Makes the parameter required defaultValue: Defines the default value for the parameter
SourceConfigTypeParam	This defines individual parameters for a custom source configuration type. A fully-qualified `SourceConfigTypeParam` has the following: displayName: User-defined display name of the parameter description: Short description of the parameter datatype: Defines what type of data this parameter can support. Valid values are: TEXT: Defines all text fields TESTAREA: Defines fields for holding multiline text CHECKBOX: Defines choices SELECT: Defines list of choices using drop-down control MULTI_SELECT: Defines a list of multi-selectable choices using drop-down control SECURE: Defines secure text fields allowedValues: Defines the following set of allowed values that may be used with SELECT/ MULTI_SELECT fields: label: Defines the label for the UI field value: Defines the value for the UI field hidden: This hides the parameter when displayed in the UI. This field does not appear in the UI. If you want to set a value and have it be available in the next execution of common integrator, you must set this field to `readOnly=false`; otherwise, set values are not available to the next execution. readOnly: A value of `true` indicates this field as read only and `false` as not. If this field is set to `readOnly=true`, any new value assignment is not persisted in the database. If it is set to `false`, the new value assignment is saved in the database and is available for subsequent integrator runs. required: Makes the parameter required defaultValue: Defines the default value for the parameter

Annotation

Usage

SourceConfigTypeConfig

This is the configuration for a custom source configuration type. It has the name, version, and description of the custom source configuration type.

VersionParams

This allows creation of versioned artifacts. VersionParams can have more than one VersionParam defining all the individual properties that may be required for creating a single version.

Defining VersionParam will result in showing the Import Version dialog box in the Deployment Automation component Versions page. A fully qualified VersionParam has the following:

name: Name of the parameter
displayName: Display name of the parameter
description: Description of the parameter
datatype: Defines what type of data this parameter can support. Valid values are:
- TEXT: Defines all text fields
- TESTAREA: Defines fields for holding multiline text
- CHECKBOX: Defines choices
- SELECT: Defines list of choices using drop down control
- MULTI_SELECT: Defines list of multi selectable choices using drop down control
- SECURE: Defines secure text fields
allowedValues: Defines the set of allowed values that may be used with SELECT/ MULTI_SELECT fields. This has the following:
- label: Defines what would be the label for the UI field
- value: Defines what would be the value for the UI field
required: Makes the parameter required
defaultValue: Defines the default value for the parameter

SourceConfigTypeParam

This defines individual parameters for a custom source configuration type. A fully-qualified SourceConfigTypeParam has the following:

displayName: User-defined display name of the parameter
description: Short description of the parameter
datatype: Defines what type of data this parameter can support. Valid values are:
- TEXT: Defines all text fields
- TESTAREA: Defines fields for holding multiline text
- CHECKBOX: Defines choices
- SELECT: Defines list of choices using drop-down control
- MULTI_SELECT: Defines a list of multi-selectable choices using drop-down control
- SECURE: Defines secure text fields
allowedValues: Defines the following set of allowed values that may be used with SELECT/ MULTI_SELECT fields:
- label: Defines the label for the UI field
- value: Defines the value for the UI field
hidden: This hides the parameter when displayed in the UI. This field does not appear in the UI. If you want to set a value and have it be available in the next execution of common integrator, you must set this field to readOnly=false; otherwise, set values are not available to the next execution.
readOnly: A value of true indicates this field as read only and false as not. If this field is set to readOnly=true, any new value assignment is not persisted in the database. If it is set to false, the new value assignment is saved in the database and is available for subsequent integrator runs.
required: Makes the parameter required
defaultValue: Defines the default value for the parameter