DEPL 1.0 MAILINGLIST Avatar
  1. OMG Issue

DEPL — Inconsistent use of label attribute in DeploymentPlan

  • Key: DEPL-5
  • Legacy Issue Number: 5957
  • Status: open  
  • Source: Zuehlke Engineering ( Frank Pilhofer)
  • Summary:

    Elements of the DeploymentPlan use the "label" attribute and
    describe it as a unique identifier, which is inconsistent with
    the description of the label attribute in the modeling
    conventions.

    Proposed resolution:

    Elements of the DeploymentPlan do not need a "human readable
    label". They should have "name" and "source" attributes. The
    Planner can generate unique names for all elements, and use
    the "source" attribute to provide traceability, by filling it
    with location data for the source element in the Component
    Data Model. In an error condition, the exception can indicate
    the name of the faulty item in the Deployment Plan, a user can
    then locate this element by name, read the source attribute,
    and thus trace the error to the original element.

    In section 3.8, "Execution Data Model", in the Attributes
    section for the ArtifactDeploymentDescription class, delete
    the "label" attribute, and add "name" and "source" attributes:

    • name: String A unique identifier for this element of
      the DeploymentPlan
    • source: String [*] Identifies the ImplementationArtifact-
      Description elements that caused this
      artifact to be part of the deployment.

    Replace the third paragraph of the Semantics section ("A Planner
    can generate a human readable label ...") with

    A Planner may compose a human readable value for the source
    attribute by combining the label attributes of packages,
    implementations, assembly subcomponents and Implementation-
    ArtifactDescription elements, describing a "path" of the
    artifact's origins in the Component Data Model. The source
    attribute may have more than one element, since Artifact-
    DeploymentDescription elements may be shared among instance
    deployments, if the same implementation artifact is part of
    multiple component implementations. In case of an error, a
    user can use this information to track the problem and
    identify its source.

    A Planner must generate a name that is unique among the top-
    level elements in a DeploymentPlan.

    In the Attributes section for the MonolithicDeploymentDescrip-
    tion class, delete the "label" attribute, and add "name" and
    "source" attributes:

    • name: String A unique identifier for this element of
      the DeploymentPlan
    • source: String [*] Identifies the MonolithicImplementation-
      Description elements that caused this
      component to be part of the deployment.

    Replace the second paragraph of the Semantics section ("A
    Planner can generate a human readable label ...") with

    A Planner may compose a human readable value for the source
    attribute by combining the label attributes of packages,
    implementations, assembly subcomponents and MonolithicImple-
    mentationDescription elements, describing a "path" of the
    component implementation's origins in the Component Data
    Model. The source attribute may have more than one element,
    since MonolithicDeploymentDescription elements may be shared
    among instance deployments, if the same component implementation
    artifact is deployed more than once. In case of an error, a
    user can use this information to track the problem and
    identify its source.

    A Planner must generate a name that is unique among the top-
    level elements in a DeploymentPlan.

    In the Attributes section for the InstanceDeploymentDescrip-
    tion class, delete the "label" attribute, and add "name" and
    "source" attributes:

    • name: String A unique identifier for this element of
      the DeploymentPlan
    • source: String Identifies the MonolithicImplementation-
      Description elements that caused this
      component to be part of the deployment.

    Replace the first paragraph of the Semantics section ("A Planner
    can generate a human readable label ...") with

    A Planner may compose a human readable value for the source
    attribute by combining the label attributes of packages,
    implementations, assembly subcomponents and MonolithicImple-
    mentationDescription elements, describing a "path" of the
    component implementation's origins in the Component Data
    Model. In case of an error, a user can use this information
    to track the problem and identify its source.

    A Planner must generate a name that is unique among the top-
    level elements in a DeploymentPlan.

    In the Attributes section for the PlanConnectionDescription
    class, delete the "label" attribute, and add "name" and "source"
    attributes:

    • name: String A unique identifier for this element of
      the DeploymentPlan
    • source: String [*] The labels of all AssemblyConnection De-
      scription elements that were combined into
      this PlanConnectionDescription.

    Add to the Semantics section:

    A Planner may compose a human readable value for the source
    attribute by combining the label attributes of package imple-
    mentations, assembly subcomponents and AssemblyConnectionDe-
    scription elements, describing a "path" of the connection's
    origins in the Component Data Model. The source attribute may
    have more than one element, since a connection in the "flatte-
    ned" plan might be a combination of multiple connection segments
    on different levels of the assembly hierarchy. In case of an
    error, a user can use this information to track the problem
    and identify its source.

    A Planner must generate a name that is unique among the top-
    level elements in a DeploymentPlan.

    In the Attributes section for the PlanPropertyMapping class,
    delete the "label" attribute, and add "name" and "source"
    attributes:

    • name: String A unique identifier for this element of
      the DeploymentPlan
    • source: String [*] The labels of all AssemblyConnection De-
      scription elements that were combined into
      this PlanConnectionDescription.

    Add to the Semantics section:

    A Planner may compose a human readable value for the source
    attribute by combining the label attributes of package imple-
    mentations, assembly subcomponents and AssemblyPropertyMapping
    elements, describing a "path" of the mapping's origins in the
    Component Data Model. The source attribute may have more than
    one element, since a mapping in the "flattened" plan might be
    a combination of multiple mapping "segments" on different
    levels of the assembly hierarchy. In case of an error, a user
    can use this information to track the problem and identify its
    source.

    A Planner must generate a name that is unique among the top-
    level elements in a DeploymentPlan.

    In section 3.11, "Exceptions", rename the "label" attribute to
    "name" in the ResourceNotAvailable, PlanError, StartError and
    StopError exceptions.

    For consistency, also make a similar change in the PackageError
    exception: delete the "label" attribute, and add a "source"
    attribute:

    • source: String Identifies a location in the package
      where the error occured.

    Change the Semantics section to read:

    The implementation of the RepositoryManager interface should
    compose a human readable value for the source attribute from
    the label attributes of elements in the hierarchy defined by
    the PackageConfiguration, ComponentPackageDescription, Compo-
    nentImplementationDescription, SubcomponentInstantiationDe-
    scription, AssemblyConnectionDescription, AssemblyProperty-
    Mapping and ImplementationArtifactDescription elements so
    that a user can locate the problem as precisely as possible.

  • Reported: DEPL 1.0b1 — Thu, 19 Jun 2003 04:00 GMT
  • Updated: Fri, 6 Mar 2015 20:58 GMT