Uploaded image for project: 'Z Archived: Kuali Rice Documentation'
  1. Z Archived: Kuali Rice Documentation
  2. KRDOC-20

Create a list of Configuration Parameters available in Rice so that we can document them

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Blocker
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.0
    • Component/s: Release Notes
    • Labels:
      None
    • Responsible Team:
      Rice Team

      Description

      We need to generate a list of all of the configuration parameters in Rice so that we can include them in the documentation.

      The easiest way to find all of these will be to trace these back to calls to org.kuali.rice.core.Config.

      In particular, the following methods on that class:

      getProperty(...)
      getProperties()
      getBooleanProperty(...)
      getPropertiesWithPrefix(...)

      Ideally, most of the parameter names will be represented in some constants class (i.e. RiceConstants, KewConstants, KimConstants, etc.)

      We need to put these in some form (spreadsheet or confluence page) and then send that to Innovativ. Each one should include:

      parameter name
      description
      default value
      required - indicates if the parameter is required or not (like some of the database-related configuration parameters)
      module - keep in mind that some of these may be global and not specific to a module
      whether the parameter is client, server or both - some configuration parameters are only used in the context of the standalone server

        Attachments

        1. mylyn-context.zip
          11 kB
        2. mylyn-context.zip
          45 kB
        3. parser.tgz
          1.15 MB
        4. riceParameters.xls
          440 kB
        5. riceParameters.xls
          264 kB

          Issue Links

            Activity

            Hide
            caseyhb Casey Boettcher (Inactive) added a comment -

            Need to include common-config-defaults.xml in context, but Mylyn seems broken

            Show
            caseyhb Casey Boettcher (Inactive) added a comment - Need to include common-config-defaults.xml in context, but Mylyn seems broken
            Hide
            caseyhb Casey Boettcher (Inactive) added a comment -

            Updated spreadsheet to include common-config-defaults.xml and rice-config.xml sample in ./web/src/main/config/example-config

            Show
            caseyhb Casey Boettcher (Inactive) added a comment - Updated spreadsheet to include common-config-defaults.xml and rice-config.xml sample in ./web/src/main/config/example-config
            Hide
            caseyhb Casey Boettcher (Inactive) added a comment -

            Updated the attached spreadsheet to include the 1500+ parameters that were gathered programatically. These are on the third sheet (labeled "recoder"). The first sheet contains global variables and user-defined parameters gotten from various xml configuration files (common-config-defaults.xml and rice-config.xml). The second sheet (labeled "KEW") was a feeble attempt to complete the task of consolidating and annotating the parameters manually.

            These files were parsed:

            api/src/main/java/org/kuali/rice/core/util/JSTLConstants.java
            api/src/main/java/org/kuali/rice/core/util/RiceConstants.java
            api/src/main/java/org/kuali/rice/ken/service/KENServiceConstants.java
            api/src/main/java/org/kuali/rice/kew/util/KEWConstants.java
            api/src/main/java/org/kuali/rice/kim/util/KimConstants.java
            api/src/main/java/org/kuali/rice/kns/service/ParameterConstants.java
            api/src/main/java/org/kuali/rice/kns/util/KNSConstants.java
            impl/src/main/java/org/kuali/rice/kcb/util/KCBConstants.java
            impl/src/main/java/org/kuali/rice/ken/util/NotificationConstants.java
            impl/src/main/java/org/kuali/rice/kew/batch/XmlConstants.java
            impl/src/main/java/org/kuali/rice/kew/util/KEWPropertyConstants.java
            impl/src/main/java/org/kuali/rice/kew/xml/XmlConstants.java
            impl/src/main/java/org/kuali/rice/kim/util/KIMPropertyConstants.java
            impl/src/main/java/org/kuali/rice/kns/authorization/AuthorizationConstants.java
            impl/src/main/java/org/kuali/rice/kns/util/KNSPropertyConstants.java
            impl/src/main/java/org/kuali/rice/kns/util/RiceKeyConstants.java
            impl/src/main/java/org/kuali/rice/kns/web/listener/JstlConstantsInitListener.java
            impl/src/main/java/org/kuali/rice/ksb/util/KSBConstants.java
            kcb/src/test/java/org/kuali/rice/kcb/test/TestConstants.java
            ken/src/test/java/org/kuali/rice/ken/test/TestConstants.java
            kew/src/test/java/org/kuali/rice/kew/routemodule/TestRouteModuleConstants.java
            kew/src/test/java/org/kuali/rice/kew/test/TestConstants.java
            kns/src/test/java/org/kuali/test/KNSTestConstants.java
            web/src/test/java/edu/sampleu/travel/infrastructure/Constants.java

            The code used to parse the files above is in the attached tarball.

            Show
            caseyhb Casey Boettcher (Inactive) added a comment - Updated the attached spreadsheet to include the 1500+ parameters that were gathered programatically. These are on the third sheet (labeled "recoder"). The first sheet contains global variables and user-defined parameters gotten from various xml configuration files (common-config-defaults.xml and rice-config.xml). The second sheet (labeled "KEW") was a feeble attempt to complete the task of consolidating and annotating the parameters manually. These files were parsed: api/src/main/java/org/kuali/rice/core/util/JSTLConstants.java api/src/main/java/org/kuali/rice/core/util/RiceConstants.java api/src/main/java/org/kuali/rice/ken/service/KENServiceConstants.java api/src/main/java/org/kuali/rice/kew/util/KEWConstants.java api/src/main/java/org/kuali/rice/kim/util/KimConstants.java api/src/main/java/org/kuali/rice/kns/service/ParameterConstants.java api/src/main/java/org/kuali/rice/kns/util/KNSConstants.java impl/src/main/java/org/kuali/rice/kcb/util/KCBConstants.java impl/src/main/java/org/kuali/rice/ken/util/NotificationConstants.java impl/src/main/java/org/kuali/rice/kew/batch/XmlConstants.java impl/src/main/java/org/kuali/rice/kew/util/KEWPropertyConstants.java impl/src/main/java/org/kuali/rice/kew/xml/XmlConstants.java impl/src/main/java/org/kuali/rice/kim/util/KIMPropertyConstants.java impl/src/main/java/org/kuali/rice/kns/authorization/AuthorizationConstants.java impl/src/main/java/org/kuali/rice/kns/util/KNSPropertyConstants.java impl/src/main/java/org/kuali/rice/kns/util/RiceKeyConstants.java impl/src/main/java/org/kuali/rice/kns/web/listener/JstlConstantsInitListener.java impl/src/main/java/org/kuali/rice/ksb/util/KSBConstants.java kcb/src/test/java/org/kuali/rice/kcb/test/TestConstants.java ken/src/test/java/org/kuali/rice/ken/test/TestConstants.java kew/src/test/java/org/kuali/rice/kew/routemodule/TestRouteModuleConstants.java kew/src/test/java/org/kuali/rice/kew/test/TestConstants.java kns/src/test/java/org/kuali/test/KNSTestConstants.java web/src/test/java/edu/sampleu/travel/infrastructure/Constants.java The code used to parse the files above is in the attached tarball.
            Hide
            caseyhb Casey Boettcher (Inactive) added a comment -

            The Spring files should be parsed and added to this spreadsheet as well.

            Show
            caseyhb Casey Boettcher (Inactive) added a comment - The Spring files should be parsed and added to this spreadsheet as well.
            Hide
            caseyhb Casey Boettcher (Inactive) added a comment -

            Collected all properties listed in the following files:

            ./impl/src/main/resources/org/kuali/rice/core/CommonSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/core/RiceDataSourceSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/core/RiceJTASpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kcb/config/KCBSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/ken/config/KENSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kew/config/KEWJPASpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kew/config/KEWOJBSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kew/config/KEWSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kew/config/ServerKEWSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kim/config/KIMInterfaceSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBModuleConfigurationSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBJPASpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBOJBSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBThinClientSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kns/config/KNSSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/standalone/config/StandaloneSpringBeans.xml
            ./impl/src/main/resources/TestHarnessSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBSpringBeans.xml
            ./impl/src/main/resources/org/kuali/rice/kim/config/KIMImplementationSpringBeans.xml

            see sheet labeled Spring

            Show
            caseyhb Casey Boettcher (Inactive) added a comment - Collected all properties listed in the following files: ./impl/src/main/resources/org/kuali/rice/core/CommonSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/core/RiceDataSourceSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/core/RiceJTASpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kcb/config/KCBSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/ken/config/KENSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kew/config/KEWJPASpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kew/config/KEWOJBSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kew/config/KEWSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kew/config/ServerKEWSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kim/config/KIMInterfaceSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBModuleConfigurationSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBJPASpringBeans.xml ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBOJBSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBThinClientSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kns/config/KNSSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/standalone/config/StandaloneSpringBeans.xml ./impl/src/main/resources/TestHarnessSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/ksb/config/KSBSpringBeans.xml ./impl/src/main/resources/org/kuali/rice/kim/config/KIMImplementationSpringBeans.xml see sheet labeled Spring

              People

              • Assignee:
                caseyhb Casey Boettcher (Inactive)
                Reporter:
                ewestfal Eric Westfall
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Due:
                  Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 2 days
                  2d
                  Remaining:
                  Remaining Estimate - 2 days
                  2d
                  Logged:
                  Time Spent - Not Specified
                  Not Specified