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 Task
    • Status: Resolved Resolved
    • Priority: Blocker 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

      1. parser.tgz
        1.15 MB
        Casey Boettcher
      2. riceParameters.xls
        440 kB
        Casey Boettcher
      3. riceParameters.xls
        264 kB
        Casey Boettcher

        Issue Links

          Activity

          Hide
          Eric Westfall added a comment -

          Added frank and joe as watchers.

          Casey, Frank is working on the install guide right now and trying to complete it by the end of the week so I'd like to get this together for them as soon as possible. I was thinking it hopefully shouldn't take you more than a couple of days to compile this list. Do you think this will be possible?

          Show
          Eric Westfall added a comment - Added frank and joe as watchers. Casey, Frank is working on the install guide right now and trying to complete it by the end of the week so I'd like to get this together for them as soon as possible. I was thinking it hopefully shouldn't take you more than a couple of days to compile this list. Do you think this will be possible?
          Hide
          Eric Westfall added a comment -

          Casey's going to start here by just getting a list of the parameter names together. We can fill in descriptions from what is currently existing in the documentation and figure out from there what is missing and what is unnecessary.

          Show
          Eric Westfall added a comment - Casey's going to start here by just getting a list of the parameter names together. We can fill in descriptions from what is currently existing in the documentation and figure out from there what is missing and what is unnecessary.
          Hide
          Aaron Hamid (Inactive) added a comment -

          For what it's worth, at one point we started this here: https://test.kuali.org/confluence/display/KULRICE/Configuration+Parameter+Documentation I'm not sure if it's of any use now.

          Show
          Aaron Hamid (Inactive) added a comment - For what it's worth, at one point we started this here: https://test.kuali.org/confluence/display/KULRICE/Configuration+Parameter+Documentation I'm not sure if it's of any use now.
          Hide
          Casey Boettcher (Inactive) added a comment -

          Many thanks. It's a great starting point.

          Show
          Casey Boettcher (Inactive) added a comment - Many thanks. It's a great starting point.
          Hide
          David Elyea added a comment -

          Is part of this work going to be to remove unused parameters from all our config files (template, example, or otherwise)? I know for a fact that almost all of the example files and template files hold values that no longer need to be set.

          Also, are we going to distinguish in the list which parameters are 'required', such as the database url.

          Show
          David Elyea added a comment - Is part of this work going to be to remove unused parameters from all our config files (template, example, or otherwise)? I know for a fact that almost all of the example files and template files hold values that no longer need to be set. Also, are we going to distinguish in the list which parameters are 'required', such as the database url.
          Eric Westfall made changes -
          Field Original Value New Value
          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
          module (keep in mind that some of these may be global and not specific to a module)
          whether or not the parameter is used by the client, server or both (some configuration parameters are only used in the context of the standalone server)

          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

          Hide
          Eric Westfall added a comment -

          Good point on the required, I added that.

          However, this task is not to go through and clean up unnecessary configuration parameters from some of our existing files. The work represented here is purely an exercise for documentation purposes to identify all of the configuration parameters the we have available.

          Show
          Eric Westfall added a comment - Good point on the required, I added that. However, this task is not to go through and clean up unnecessary configuration parameters from some of our existing files. The work represented here is purely an exercise for documentation purposes to identify all of the configuration parameters the we have available.
          Casey Boettcher (Inactive) made changes -
          Link This issue is related to KULRICE-2932 [ KULRICE-2932 ]
          Hide
          Casey Boettcher (Inactive) added a comment -

          Recall that we discussed the possibility of properties both declared and init'd programmatically, without reference to an xml or properties file. This does indeed occur in BaseConfig's loadDefaults() method.

          Show
          Casey Boettcher (Inactive) added a comment - Recall that we discussed the possibility of properties both declared and init'd programmatically, without reference to an xml or properties file. This does indeed occur in BaseConfig's loadDefaults() method.
          Hide
          Casey Boettcher (Inactive) added a comment -

          Attached preliminary list of parameters

          Show
          Casey Boettcher (Inactive) added a comment - Attached preliminary list of parameters
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 33872 ]
          Hide
          Casey Boettcher (Inactive) added a comment -

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

          Show
          Casey Boettcher (Inactive) added a comment - Need to include common-config-defaults.xml in context, but Mylyn seems broken
          Casey Boettcher (Inactive) made changes -
          Attachment mylyn-context.zip [ 33962 ]
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 33872 ]
          Hide
          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
          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
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 34045 ]
          Casey Boettcher (Inactive) made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          Casey Boettcher (Inactive) made changes -
          Attachment mylyn-context.zip [ 34291 ]
          Eric Westfall made changes -
          Project KRICE Development [ 10220 ] Kuali Rice Documentation [ 10440 ]
          Key KULRICE-2947 KRDOC-20
          Component/s Release Notes [ 12693 ]
          Component/s Documentation [ 11241 ]
          Eric Westfall made changes -
          Fix Version/s 1.0 [ 15290 ]
          Fix Version/s 1.0 Documentation [ 15107 ]
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 34045 ]
          Hide
          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
          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.
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 34461 ]
          Casey Boettcher (Inactive) made changes -
          Attachment parser.tgz [ 34462 ]
          Casey Boettcher (Inactive) made changes -
          Status In Progress [ 3 ] Open [ 1 ]
          Hide
          Casey Boettcher (Inactive) added a comment -

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

          Show
          Casey Boettcher (Inactive) added a comment - The Spring files should be parsed and added to this spreadsheet as well.
          Hide
          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
          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
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 35981 ]
          Casey Boettcher (Inactive) made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]

            People

            • Assignee:
              Casey Boettcher (Inactive)
              Reporter:
              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

                  Structure Helper Panel