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

          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

          Casey Boettcher (Inactive) made changes -
          Link This issue is related to KULRICE-2932 [ KULRICE-2932 ]
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 33872 ]
          Casey Boettcher (Inactive) made changes -
          Attachment mylyn-context.zip [ 33962 ]
          Casey Boettcher (Inactive) made changes -
          Attachment riceParameters.xls [ 33872 ]
          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 ]
          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 ]
          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