Class: ParameterSetting

A parameter setting to be propagated to points of insertion in a resolved profile.

URI: oscal:ParameterSetting

 classDiagram
    class ParameterSetting
    click ParameterSetting href "../ParameterSetting/"
      HasPropsAndLinks <|-- ParameterSetting
        click HasPropsAndLinks href "../HasPropsAndLinks/"
      
      ParameterSetting : class_
        
      ParameterSetting : constraints
        
          
    
        
        
        ParameterSetting --> "*" ParameterConstraint : constraints
        click ParameterConstraint href "../ParameterConstraint/"
    

        
      ParameterSetting : depends_on
        
      ParameterSetting : guidelines
        
          
    
        
        
        ParameterSetting --> "*" ParameterGuideline : guidelines
        click ParameterGuideline href "../ParameterGuideline/"
    

        
      ParameterSetting : label
        
      ParameterSetting : links
        
          
    
        
        
        ParameterSetting --> "*" Link : links
        click Link href "../Link/"
    

        
      ParameterSetting : param_id
        
      ParameterSetting : props
        
          
    
        
        
        ParameterSetting --> "*" Property : props
        click Property href "../Property/"
    

        
      ParameterSetting : select
        
          
    
        
        
        ParameterSetting --> "0..1" ParameterSelection : select
        click ParameterSelection href "../ParameterSelection/"
    

        
      ParameterSetting : usage
        
      ParameterSetting : values
        
      

Inheritance

• ParameterSetting [ HasPropsAndLinks]

Slots

Name	Cardinality and Range	Description	Inheritance
param_id	1 TokenType	The identifier for the parameter being set or referenced	direct
class_	0..1 TokenType	A textual label that provides a sub-type or characterization	direct
depends_on	0..1 TokenType	(deprecated) Another parameter invoking this one	direct
label	0..1 MarkupLineType	A short, placeholder name for the parameter, which can be used as a substitut…	direct
usage	0..1 MarkupMultilineType	Describes the purpose and use of a parameter	direct
constraints	* ParameterConstraint	A formal or informal expression of a constraint or test	direct
guidelines	* ParameterGuideline	A prose statement that provides a recommendation for the use of a parameter	direct
values	* String	A parameter value or set of values	direct
select	0..1 ParameterSelection	Presenting a choice among alternatives	direct
props	* Property	A list of properties	HasPropsAndLinks
links	* Link	A list of links	HasPropsAndLinks

Usages

used by	used in	type	used
ProfileModify	set_parameters	range	ParameterSetting

In Subsets

• profile

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/lmodel/oscal

Mappings

Mapping Type	Mapped Value
self	oscal:ParameterSetting
native	oscal:ParameterSetting

LinkML Source

Direct

name: ParameterSetting
description: A parameter setting to be propagated to points of insertion in a resolved
  profile.
in_subset:
- profile
from_schema: https://w3id.org/lmodel/oscal
mixins:
- HasPropsAndLinks
slots:
- param-id
- class_
- depends-on
- label
- usage
- constraints
- guidelines
- values
- select
slot_usage:
  param-id:
    name: param-id
    required: true

Induced

name: ParameterSetting
description: A parameter setting to be propagated to points of insertion in a resolved
  profile.
in_subset:
- profile
from_schema: https://w3id.org/lmodel/oscal
mixins:
- HasPropsAndLinks
slot_usage:
  param-id:
    name: param-id
    required: true
attributes:
  param-id:
    name: param-id
    description: The identifier for the parameter being set or referenced.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    alias: param_id
    owner: ParameterSetting
    domain_of:
    - ParameterSetting
    - SetParameter
    range: TokenType
    required: true
  class_:
    name: class_
    description: A textual label that provides a sub-type or characterization.
    comments:
    - OSCAL's key is `class`. A slot or alias named `class` makes the generated dataclasses
      invalid Python, and gen-doc names a page after the slot, so `_class` hid its
      page from the site. `class_` is the spelling the generated Pydantic model gives
      a slot named `class`.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - Group
    - Control
    - Property
    - Part
    - Parameter
    - ProfileGroup
    - ParameterSetting
    - AssessmentPart
    - ControlPart
    range: TokenType
  depends-on:
    name: depends-on
    description: (deprecated) Another parameter invoking this one. This construct
      has been deprecated and should not be used.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    alias: depends_on
    owner: ParameterSetting
    domain_of:
    - Parameter
    - ParameterSetting
    range: TokenType
  label:
    name: label
    description: A short, placeholder name for the parameter, which can be used as
      a substitute for a value if no value is assigned.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - Parameter
    - ParameterSetting
    range: MarkupLineType
  usage:
    name: usage
    description: Describes the purpose and use of a parameter.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - Parameter
    - ParameterSetting
    range: MarkupMultilineType
  constraints:
    name: constraints
    description: A formal or informal expression of a constraint or test.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - Parameter
    - ParameterSetting
    range: ParameterConstraint
    multivalued: true
    inlined: true
    inlined_as_list: true
  guidelines:
    name: guidelines
    description: A prose statement that provides a recommendation for the use of a
      parameter.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - Parameter
    - ParameterSetting
    range: ParameterGuideline
    multivalued: true
    inlined: true
    inlined_as_list: true
  values:
    name: values
    description: A parameter value or set of values.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - Parameter
    - ParameterSetting
    - SetParameter
    range: string
    multivalued: true
  select:
    name: select
    description: Presenting a choice among alternatives.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - Parameter
    - ParameterSetting
    range: ParameterSelection
    inlined: true
  props:
    name: props
    description: A list of properties.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - HasPropsAndLinks
    - Resource
    - Addition
    - SystemCharacteristics
    - SystemInformation
    - InformationType
    - ImpactLevel
    - AuthorizationBoundary
    - Diagram
    - NetworkArchitecture
    - DataFlow
    - SystemImplementation
    - LeveragedAuthorization
    - SspImplementedRequirement
    - SspStatement
    - ByComponent
    - Export
    - ProvidedControlImplementation
    - ControlResponsibility
    - InheritedControlImplementation
    - SatisfiedControlImplementation
    range: Property
    multivalued: true
    inlined: true
    inlined_as_list: true
  links:
    name: links
    description: A list of links.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: ParameterSetting
    domain_of:
    - HasPropsAndLinks
    - Addition
    - SystemCharacteristics
    - SystemInformation
    - InformationType
    - ImpactLevel
    - AuthorizationBoundary
    - Diagram
    - NetworkArchitecture
    - DataFlow
    - SystemImplementation
    - LeveragedAuthorization
    - SspImplementedRequirement
    - SspStatement
    - ByComponent
    - Export
    - ProvidedControlImplementation
    - ControlResponsibility
    - InheritedControlImplementation
    - SatisfiedControlImplementation
    range: Link
    multivalued: true
    inlined: true
    inlined_as_list: true