Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-33237

Document scripting engine built-in variables in User Guide

    Details

    • Type: Feature Request
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 6.1.1 CE GA2
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      {markdown}
      The User Guide has a [nice chapter on scripting](http://www.liferay.com/documentation/liferay-portal/6.1/user-guide/-/ai/running-scripts-from-the-control-panel), but it does not document the built-in variables available to script authors.

      The variables are bound to all of the script languages (groovy, beanshell, etc) and can be accessed using the scripting language's syntax.

      The variables are defined in the [scripting engine source code](https://github.com/liferay/liferay-portal/blob/master/portal-impl/src/com/liferay/portal/scripting/ScriptingImpl.java#L120).

      In particular, these variables are available but undocumented:

      * portletConfig
      * portletContext
      * preferences
      * actionRequest
      * renderRequest
      * resourceRequest
      * portletRequest
      * actionResponse
      * renderResponse
      * resourceResponse
      * portletResponse
      * userInfo{markdown}

        Attachments

          Activity

            People

            Assignee:
            support-lep@liferay.com SE Support
            Reporter:
            james.falkner James Falkner
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated:

                Packages

                Version Package