plugin - APEXlang Reference

`plugin`

Parent: app

Children: actionPositiontype = templateComponent, actionTemplatetype = templateComponent, attributeGrouptype in (item); type in (region); type in (process); type in (dynamicAction); type in (templateComponent); type in (genAITool), customAttribute, eventtype in (item); type in (region); type in (dynamicAction), file, slottype = templateComponent, standardAttributeConfigtype in (item); type in (region); type in (process); type in (dynamicAction); type in (restDataSource)

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 The name of your plug-in.
`apexlangName`	`string`	Yes		data type=`string`; maxLen=40 Enter the camelCase name for this plug-in as it appears in an APEXlang file. Caution: Changing it may prevent existing APEXlang files from being imported.
`staticId`	`string`	Yes		data type=`string`; maxLen=45; textCase=`UPPER`
`type`	`enum`	Yes	`templateComponent`	data type=`string`; lov=`STATIC` Valid values: `templateComponent` `item` `region` `dynamicAction` `genAITool` `process` `authenticationScheme` `authorizationScheme` `restDataSource` `interactiveReportColumn`
`theme`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`theme` Applies when`type = templateComponent`

Property Groups:

templateComponent

Property	Type	Required	Default Value	Details
`availableAs`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `partial` `report` `regionOnly` Applies when`type = templateComponent`
`partial`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type = templateComponent`
`reportBody`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type = templateComponent and availableAs = report`
`reportGroup`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type = templateComponent and availableAs = report`
`reportRow`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type = templateComponent and availableAs = report`
`reportContainer`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type = templateComponent and availableAs = report`
`translateTemplates`	`boolean`	Yes	`false`	data type=`boolean` Applies when`type = templateComponent`
`defaultEscapeMode`	`enum`	Yes	`html`	data type=`string`; lov=`STATIC` Valid values: `html` `htmlAttribute` `stripHtml` `raw` Applies when`type = templateComponent`
`numberOfLazyLoadingSkeletons`	`integer`	No		data type=`integer`; maxLen=32767 Applies when`type = templateComponent and availableAs = report`

templateComponent {
  availableAs: [
    partial
    report
  ]
  partial: ```html
    value
  ```
  reportBody: ```html
    value
  ```
  reportGroup: ```html
    value
  ```
  reportRow: ```html
    value
  ```
  reportContainer: ```html
    value
  ```
  translateTemplates: false
  defaultEscapeMode: html
  numberOfLazyLoadingSkeletons: 42
}

defaultSlots

Property	Type	Required	Details
`regions`	`string`	No	data type=`string`; lov=`SLOTS` Applies when`type = templateComponent`
`items`	`string`	No	data type=`string`; lov=`SLOTS` Applies when`type = templateComponent`
`buttons`	`string`	No	data type=`string`; lov=`SLOTS` Applies when`type = templateComponent`

defaultSlots {
  regions: value
  items: value
  buttons: value
}

aiTool

Property	Type	Required	Default Value	Details
`executionLocation`	`enum`	Yes	`serverSide`	data type=`string`; lov=`STATIC` Valid values: `clientSide` `serverSide` Applies when`type = genAITool`
`supportedExecutionPoints`	`array of enums`	Yes	`onDemand`	data type=`string`; lov=`STATIC` Valid values: `augmentSystemPrompt` `onDemand` Applies when`type = genAITool`

aiTool {
  executionLocation: clientSide
  supportedExecutionPoints: [
    augmentSystemPrompt
    onDemand
  ]
}

onDemand

Property	Type	Required	Default Value	Details
`description`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type = genAITool and supportedExecutionPoints = onDemand`
`parameters`	`enum`	Yes	`noParameters`	data type=`string`; lov=`STATIC` Valid values: `noParameters` `definedByAiTool` `definedByPlugIn` Applies when`type = genAITool and supportedExecutionPoints = onDemand`
`parametersJsonSchema`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`type = genAITool and supportedExecutionPoints = onDemand and parameters = definedByPlugIn`

onDemand {
  description: ```
    value
  ```
  parameters: noParameters
  parametersJsonSchema: ```json
    value
  ```
}

component

Property	Type	Required	Default Value	Details
`supports`	`array of enums`	Yes	`APEX_APPLICATION_PAGE_ITEMS:APEX_APPL_PAGE_IG_COLUMNS`	data type=`string`; lov=`STATIC` Valid values: `pageItems` `interactiveGridColumns` `facets` `facetGroupItems` `filters` `filterGroupItems` Applies when`type = item`
`supports`	`array of enums`	Yes	`APEX_APPLICATION_PAGE_PROC:APEX_APPL_AUTOMATION_ACTIONS:APEX_APPL_TASKDEF_ACTIONS:APEX_APPL_WORKFLOW_ACTIVITIES`	data type=`string`; lov=`STATIC` Valid values: `pageProcesses` `automationActions` `taskDefinitionActions` `workflowActivities` Applies when`type = process`
`supportsSessionStateDataTypes`	`array of enums`	Yes	`varchar2`	data type=`string`; lov=`STATIC` Valid values: `varchar2` `clob` `boolean` Applies when`type = item`
`standardAttributes`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `visibleWidget` `standardFormElement` `sessionStateChangeable` `readOnlyAttr` `escapeSpecialCharsAttr` `quickPickAttrs` `sourceAttrs` `formatMaskDateOnly` `formatMaskNumberOnly` `elementAttrs` `widthAttrs` `heightAttr` `elementOptionAttr` `placeholderAttr` `iconAttr` `encryptSessionStateAttr` `listOfValues` `lovDisplayNullAttrs` `cascadingLovAttrs` `joinLovforColumnDisplay` `filter` `link` `initJavascriptCodeAttr` `facetGatherOccurrences` `facetShowSelectedFirst` `facetMaxDisplayedEntries` `facetClientSideFiltering` `facetLovDisplayNullValue` `aiEnabled` `configurableAiEnabled` `configurableAiSystemPrompt` `requiresAiChatWidget` `alwaysMultipleValues` `optionalMultipleValues` Applies when`type = item`
`standardAttributes`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `rowSelection` `regionTemplateAttr` Applies when`type = templateComponent`
`standardAttributes`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `regionSourceSupportsDifferentDataSources` `regionSourceIsSqlQuery` `regionSourceIsPlsqlCode` `regionSourceIsPlsqlFunctionBody` `regionSourceIsHtml` `regionSourceIsPlainText` `pageItemsToSubmitAttr` `orderByAttr` `noOfFetchedRowsAttr` `noDataFoundMessageAttr` `escapeSpecialCharsRegionAttr` `initJavascriptCodeAttr` `regionColumns` `headingColumnAttr` `headingAlignmentColumnAttr` `alignmentColumnAttr` `cssClassColumnAttr` `customAttrsColumnAttr` `escapeSpecialCharsColumnAttr` `supportsFacetedSearchSmartFilters` `lazyLoading` `lazyLoadingAlways` `isEditable` `aiEnabled` `configurableAiEnabled` `configurableAiSystemPrompt` `requiresAiChatWidget` Applies when`type = region`
`standardAttributes`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `forItem` `forButton` `forRegion` `forJquerySelector` `forJavaScriptExpression` `forTriggeringElement` `forEventSource` `affectedElementRequired` `defaultFireOnInitialization` `stopExecutionOnErrorAttr` `waitForResultAttr` `initJavascriptCodeAttr` `aiEnabled` `configurableAiEnabled` `configurableAiSystemPrompt` `requiresAiChatWidget` Applies when`type = dynamicAction`
`standardAttributes`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `sessionNotValidAttr` `hasLoginPage` Applies when`type = authenticationScheme`
`standardAttributes`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `defaultEndpoint` `doNotTestEndpoint` Applies when`type = restDataSource`
`standardAttributes`	`array of enums`	No		data type=`string`; lov=`STATIC` Valid values: `region` `regionRequired` `waitForCompletion` `form` `aiEnabled` `configurableAiEnabled` `configurableAiSystemPrompt` Applies when`type = process`

component {
  supports: [
    pageItems
    interactiveGridColumns
  ]
  supportsSessionStateDataTypes: [
    varchar2
    clob
  ]
  standardAttributes: [
    visibleWidget
    standardFormElement
  ]
}

source

Property	Type	Required	Default Value	Details
`plsqlCode`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type in (region)type in (dynamicAction)type in (process)type in (authorizationScheme)type in (authenticationScheme)type in (item)type in (restDataSource)type in (genAITool)`
`sampleData`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `employees` `tasks` `products` `projects` Applies when`type in (region)type in (templateComponent)`

source {
  plsqlCode: ```plsql
    value
  ```
  sampleData: employees
}

callbacks

Property	Type	Required	Default Value	Details
`apiInterface`	`enum`	Yes	`procedure`	data type=`string`; lov=`STATIC` Valid values: `procedure` `procedureWithLegacyAttributes` `function`
`renderProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type in (dynamicAction)type in (item)type in (region)type = genAITool and executionLocation = clientSide`
`metaDataProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = item`
`sessionSentryProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = authenticationScheme`
`invalidSessionProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = authenticationScheme`
`authenticationProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = authenticationScheme`
`postLogoutProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = authenticationScheme`
`ajaxProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type in (authenticationScheme)type in (dynamicAction)type in (region)type in (item)`
`validationProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = item`
`executionFunctionProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type in (authorizationScheme)type in (process)type = genAITool and executionLocation = serverSide`
`completionFunctionProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = process and standardAttributes = waitForCompletion`
`terminationFunctionProcedureName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = process and standardAttributes = waitForCompletion`
`restSourceCapabilitiesProcedure`	`string`	No		data type=`string`; maxLen=255 Applies when`type = restDataSource`
`restSourceFetchProcedure`	`string`	No		data type=`string`; maxLen=255 Applies when`type = restDataSource`
`restSourceDmlProcedure`	`string`	No		data type=`string`; maxLen=255 Applies when`type = restDataSource`
`restSourceExecuteProcedure`	`string`	No		data type=`string`; maxLen=255 Applies when`type = restDataSource`
`aiRequestHandlerProcedure`	`string`	No		data type=`string`; maxLen=255 Applies when`type = region and standardAttributes in (configurableAiEnabled)type = region and standardAttributes in (aiEnabled)type = item and standardAttributes in (configurableAiEnabled)type = item and standardAttributes in (aiEnabled)type = dynamicAction and standardAttributes in (configurableAiEnabled)type = dynamicAction and standardAttributes in (aiEnabled)`
`aiResponseHandlerProcedure`	`string`	No		data type=`string`; maxLen=255 Applies when`type = region and standardAttributes in (configurableAiEnabled)type = region and standardAttributes in (aiEnabled)type = item and standardAttributes in (configurableAiEnabled)type = item and standardAttributes in (aiEnabled)type = dynamicAction and standardAttributes in (configurableAiEnabled)type = dynamicAction and standardAttributes in (aiEnabled)`
`restSourceDiscoverProcedure`	`string`	No		data type=`string`; maxLen=255 Applies when`type = restDataSource`

callbacks {
  apiInterface: procedure
  renderProcedureName: value
  metaDataProcedureName: value
  sessionSentryProcedureName: value
  invalidSessionProcedureName: value
  authenticationProcedureName: value
  postLogoutProcedureName: value
  ajaxProcedureName: value
  validationProcedureName: value
  executionFunctionProcedureName: value
  completionFunctionProcedureName: value
  terminationFunctionProcedureName: value
  restSourceCapabilitiesProcedure: value
  restSourceFetchProcedure: value
  restSourceDmlProcedure: value
  restSourceExecuteProcedure: value
  aiRequestHandlerProcedure: value
  aiResponseHandlerProcedure: value
  restSourceDiscoverProcedure: value
}

advanced

Property	Type	Required	Default Value	Details
`filePrefix`	`string`	No		data type=`string`; maxLen=255 Determines the virtual path the Web server uses to point to the files of the plug-in. Do not specify anything to reference files which are stored with your plug-in definition in the database. For performance reasons you can also store your plug-in files on your Web Server. Use `#APEX_FILES#` or any valid URL to reference them.
`category`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `component` `effect` `execute` `initialize` `miscellaneous` `navigation` `notification` `style` `builtInComponents` `appComponents` `themeComponents` `ai` Applies when`type = dynamicAction`
`quickPick`	`boolean`	Yes	`false`	data type=`boolean` Applies when`type = templateComponent`
`substituteAttributeValues`	`boolean`	Yes	`false`	data type=`boolean` Applies when`apiInterface in (function)apiInterface in (procedureWithLegacyAttributes)`
`deprecated`	`boolean`	Yes	`false`	data type=`boolean`
`legacy`	`boolean`	Yes	`false`	data type=`boolean`

advanced {
  filePrefix: value
  category: component
  quickPick: false
  substituteAttributeValues: false
  deprecated: false
  legacy: false
}

css

Property	Type	Required	Default Value	Details
`fileUrls`	`array of strings`	No		data type=`string`; maxLen=4000 Applies when`type in (region)type in (dynamicAction)type in (item)type in (templateComponent)type = genAITool and executionLocation = clientSide` Enter Cascading Style Sheet file URLs to be loaded with this plug-in. Each URL has to be written on a new line. If you provide a minified version of your file you can use the substitution string `#MIN#` to include `.min`, or `#MIN_DIRECTORY#` to include `minified/` in your file URL for a regular page view, and an empty string if the page is viewed in debug mode. You also have access to the substitution string `#PLUGIN_FILES#` to substitute with the value of the plug-in's file prefix. File URLs you enter here will be emitted within the `#APEX_CSS#` substitution string in the page template. Note: You do not need to include opening or closing `link` tags, just the file URL.

css {
  fileUrls: [
    value
    value
  ]
}

javaScript

Property	Type	Required	Default Value	Details
`fileUrls`	`array of strings`	No		data type=`string`; maxLen=4000 Applies when`type in (region)type in (dynamicAction)type in (item)type in (templateComponent)type = genAITool and executionLocation = clientSide` Enter JavaScript file URLs for code to be loaded with this plug-in. Each URL has to be written on a new line. If you provide a minified version of your file you can use the substitution string `#MIN#` to include `.min`, or `#MIN_DIRECTORY#` to include `minified/` in your file URL for a regular page view, and an empty string if the page is viewed in debug mode. You also have access to the substitution string `#PLUGIN_FILES#` to substitute the value of the plug-in's file prefix. JavaScript file URLs you enter here will be emitted within the `#GENERATED_JAVASCRIPT#` substitution string in the page template. Note: You do not need to include opening or closing `script` tags, just the file URL.

javaScript {
  fileUrls: [
    value
    value
  ]
}

information

Property	Type	Required	Details
`version`	`string`	No	data type=`string`; maxLen=30
`aboutUrl`	`string`	No	data type=`string`; maxLen=255
`helpText`	`multiline string`	No	data type=`multiline string`; maxLen=4000

information {
  version: value
  aboutUrl: value
  helpText: ```
    value
  ```
}

subscription

Property	Type	Required	Default Value	Details
`master`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`plugin`
`subscribeComponentSettings`	`boolean`	Yes	`true`	data type=`boolean` Applies when`master is set`

subscription {
  master: @component
  subscribeComponentSettings: false
}

comments

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

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

APEXlang Example

plugin sample (
    name: value
    apexlangName: value
    staticId: value
    type: templateComponent
    theme: @component
    templateComponent {
        availableAs: [
          partial
          report
        ]
        partial: ```html
          value
        ```
        reportBody: ```html
          value
        ```
        reportGroup: ```html
          value
        ```
        reportRow: ```html
          value
        ```
        reportContainer: ```html
          value
        ```
        translateTemplates: false
        defaultEscapeMode: html
        numberOfLazyLoadingSkeletons: 42
    }
    defaultSlots {
        regions: value
        items: value
        buttons: value
    }
    aiTool {
        executionLocation: clientSide
        supportedExecutionPoints: [
          augmentSystemPrompt
          onDemand
        ]
    }
    onDemand {
        description: ```
          value
        ```
        parameters: noParameters
        parametersJsonSchema: ```json
          value
        ```
    }
    component {
        supports: [
          pageItems
          interactiveGridColumns
        ]
        supportsSessionStateDataTypes: [
          varchar2
          clob
        ]
        standardAttributes: [
          visibleWidget
          standardFormElement
        ]
    }
    source {
        plsqlCode: ```plsql
          value
        ```
        sampleData: employees
    }
    callbacks {
        apiInterface: procedure
        renderProcedureName: value
        metaDataProcedureName: value
        sessionSentryProcedureName: value
        invalidSessionProcedureName: value
        authenticationProcedureName: value
        postLogoutProcedureName: value
        ajaxProcedureName: value
        validationProcedureName: value
        executionFunctionProcedureName: value
        completionFunctionProcedureName: value
        terminationFunctionProcedureName: value
        restSourceCapabilitiesProcedure: value
        restSourceFetchProcedure: value
        restSourceDmlProcedure: value
        restSourceExecuteProcedure: value
        aiRequestHandlerProcedure: value
        aiResponseHandlerProcedure: value
        restSourceDiscoverProcedure: value
    }
    advanced {
        filePrefix: value
        category: component
        quickPick: false
        substituteAttributeValues: false
        deprecated: false
        legacy: false
    }
    css {
        fileUrls: [
          value
          value
        ]
    }
    javaScript {
        fileUrls: [
          value
          value
        ]
    }
    information {
        version: value
        aboutUrl: value
        helpText: ```
          value
        ```
    }
    subscription {
        master: @component
        subscribeComponentSettings: false
    }
    comments {
        comments: ```
          value
        ```
    }
)