shortcut - APEXlang Reference

`shortcut`

Parent: app

Direct Properties:

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		data type=`string`; maxLen=255 The shortcut name identifies the shortcut and is the name that the shortcut is referenced using. To reference a shortcut use the "SHORTCUT_STATIC_ID" syntax wherever a shortcut is permitted The name will automatically be converted into all uppercase. All references to shortcuts must be in upper case.

Property Groups:

source

Property	Type	Required	Default Value	Details
`type`	`enum`	Yes	`htmlText`	data type=`string`; lov=`STATIC` Valid values: `functionBody` `htmlText` `htmlEscapeSpecialChars` `image` `jsEscapeSingleQuotes` `message` `jsMessageEscapeSingleQuotes`
`htmlCode`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`type in (htmlText)type in (htmlEscapeSpecialChars)`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`type = functionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = javaScript-mle`
`text`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`type = jsEscapeSingleQuotes`
`messageName`	`string`	Yes		data type=`string`; maxLen=255; textCase=`UPPER` Applies when`type in (message)type in (jsMessageEscapeSingleQuotes)`
`imageUrl`	`string`	Yes		data type=`string`; maxLen=255 Applies when`type = image`

source {
  type: functionBody
  htmlCode: ```html
    value
  ```
  language: plsql
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  text: ```
    value
  ```
  messageName: value
  imageUrl: value
}

error

Property	Type	Required	Default Value	Details
`errorMessage`	`multiline string`	No		data type=`multiline string`; maxLen=4000 If an error should occur during the processing of a shortcut then the following text is displayed.

error {
  errorMessage: ```
    value
  ```
}

config

Property	Type	Required	Default Value	Details
`buildOption`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`buildOption`

config {
  buildOption: @component
}

subscription

Property	Type	Required	Default Value	Details
`master`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`shortcut`

subscription {
  master: @component
}

comments

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

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

APEXlang Example

shortcut sample (
    staticId: value
    source {
        type: functionBody
        htmlCode: ```html
          value
        ```
        language: plsql
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        text: ```
          value
        ```
        messageName: value
        imageUrl: value
    }
    error {
        errorMessage: ```
          value
        ```
    }
    config {
        buildOption: @component
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)