standardAttributeConfig - APEXlang Reference

`standardAttributeConfig`

Parent: plugin

Applies whentype in (item)type in (region)type in (process)type in (dynamicAction)type in (restDataSource)

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `defaultEndpoint` `hasLov` `hasInitJavaScriptCodeAttribute` `regionSourceIsHtml` `regionSourceIsPlainText` `regionSourceIsPlsqlFunctionBody` `regionSourceIsPlsqlCode` `regionSourceIsSqlQuery` `regionSourceSupportsDifferentDataSources` Applies when`type in (dynamicAction)type in (item)type in (region)type in (restDataSource)`

Property Groups:

validation

Property	Type	Required	Default Value	Details
`required`	`boolean`	Yes	`false`	data type=`boolean`

validation {
  required: false
}

sqlQuery

Property	Type	Required	Default Value	Details
`minColumns`	`integer`	No		data type=`integer`; maxLen=3 Applies when`type in (dynamicAction) and name in (hasLov)type in (dynamicAction) and name in (regionSourceIsPlsqlFunctionBody)type in (dynamicAction) and name in (regionSourceIsSqlQuery)type in (dynamicAction) and name in (regionSourceIsPlsqlCode)type in (item) and name in (hasLov)type in (item) and name in (regionSourceIsPlsqlFunctionBody)type in (item) and name in (regionSourceIsSqlQuery)type in (item) and name in (regionSourceIsPlsqlCode)type in (region) and name in (hasLov)type in (region) and name in (regionSourceIsPlsqlFunctionBody)type in (region) and name in (regionSourceIsSqlQuery)type in (region) and name in (regionSourceIsPlsqlCode)type in (restDataSource) and name in (hasLov)type in (restDataSource) and name in (regionSourceIsPlsqlFunctionBody)type in (restDataSource) and name in (regionSourceIsSqlQuery)type in (restDataSource) and name in (regionSourceIsPlsqlCode)`
`maxColumns`	`integer`	No		data type=`integer`; maxLen=3 Applies when`type in (dynamicAction) and name in (hasLov)type in (dynamicAction) and name in (regionSourceIsPlsqlFunctionBody)type in (dynamicAction) and name in (regionSourceIsSqlQuery)type in (dynamicAction) and name in (regionSourceIsPlsqlCode)type in (item) and name in (hasLov)type in (item) and name in (regionSourceIsPlsqlFunctionBody)type in (item) and name in (regionSourceIsSqlQuery)type in (item) and name in (regionSourceIsPlsqlCode)type in (region) and name in (hasLov)type in (region) and name in (regionSourceIsPlsqlFunctionBody)type in (region) and name in (regionSourceIsSqlQuery)type in (region) and name in (regionSourceIsPlsqlCode)type in (restDataSource) and name in (hasLov)type in (restDataSource) and name in (regionSourceIsPlsqlFunctionBody)type in (restDataSource) and name in (regionSourceIsSqlQuery)type in (restDataSource) and name in (regionSourceIsPlsqlCode)`

sqlQuery {
  minColumns: 42
  maxColumns: 42
}

default

Property	Type	Required	Default Value	Details
`value`	`multiline string`	No		data type=`multiline string`; maxLen=4000

default {
  value: ```
    value
  ```
}

help

Property	Type	Required	Default Value	Details
`helpText`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Specify help text for this plug-in attribute. The help text is displayed as context sensitive help for the attribute in the Builder.

help {
  helpText: ```
    value
  ```
}

examples

Property	Type	Required	Default Value	Details
`examples`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Specify examples for this plug-in attribute. The examples are displayed as part of the context sensitive help for the attribute in the Builder.

examples {
  examples: ```
    value
  ```
}

dependingOn

Property	Type	Required	Default Value	Details
`attribute`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`customAttribute`
`conditionType`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `=` `!=` `inList` `notInList` `isNull` `isNotNull` Applies when`attribute is set`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`attribute is set and conditionType in (=)attribute is set and conditionType in (!=)`
`list`	`array of strings`	Yes		data type=`string`; maxLen=4000 Applies when`attribute is set and conditionType in (inList)attribute is set and conditionType in (notInList)`
`alwaysEvaluate`	`boolean`	Yes	`true`	data type=`boolean` Applies when`attribute is set`

dependingOn {
  attribute: @component
  conditionType: "="
  value: value
  list: [
    value
    value
  ]
  alwaysEvaluate: false
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

standardAttributeConfig sample (
    name: defaultEndpoint
    validation {
        required: false
    }
    sqlQuery {
        minColumns: 42
        maxColumns: 42
    }
    default {
        value: ```
          value
        ```
    }
    help {
        helpText: ```
          value
        ```
    }
    examples {
        examples: ```
          value
        ```
    }
    dependingOn {
        attribute: @component
        conditionType: "="
        value: value
        list: [
          value
          value
        ]
        alwaysEvaluate: false
    }
    comments {
        comments: ```
          value
        ```
    }
)