Help:- Template checklistindexpreviousnextupside index

This section details a series of quality checks that should be undertaken once the template has been constructed.

Check that the following files have been committed:

  1. <<Template>>/imagemap.xml
  2. If any Constraints in the template:
    <<Template>>/Constraints.png
  3. If any Instances in the template:
    <<Template>>/Instances.png
  4. <<Template>>/imagemap.xml
  5. <<Template>>/<<Template>>.png
  6. <<Template>>/<<Template>>.xmi
  7. <<Template>>/template.xml
  8. <<Template>>/template.png
  9. <<Template>>/dvlp/UUID.xml
  10. The SysML file. For Magicdraw:
    <<Template>>/dvlp/<<Context>><<Template>>.mdxml

Check the following on the template cover page.

  1. Editor: Has the editor been specified?
    <contacts><editor ref="??"/></contacts>

Check the following in the Template.

Check that the naming of properties conforms to Model & naming conventions

There should be no template that is just an assignment Block - unless the template specifies explicit characterization of the assignment.

Multiple assignment Blocks should not in general be included in the template as there may be many assignments required each of which may need individual characterization.

An example is shown in Figure 1. The BreakdownElementRealization has a multiplicity of [0.*]. If more than one is instantiated, it not possible to characterize e.g. classify, them individually.

images/mult_asg_block.png
Figure 1 -  Multiple assignment Blocks

Public properties should not be directly made into flow ports.

An example is shown in Figure 2. The public property "context" is bound to the identificationContext which is also bound to the Flow Port context.

images/pub_flow_port.png
Figure 2 -  Public properties to Flow Ports

Optional characterizations e.g date, person, approval assignments, should only be included if the business meaning is clear. E.g. the date is a start date. The person is the "operator".

Check the following on the Template SysML Block Definition Diagram.

  1. Is the diagram as small as possible with no excessive whitespace?
  2. Has the block representing the template been coloured Green? E.g fill color = RGB [204, 255, 204]
  3. Are only the public parts visible?
  4. Are all flow ports shown on the template Block, name and have a multiplicity stated?

Check the following on the Template SysML Parametric Diagram.

  1. If the template is an OASIS template, check that is more than one block, either a template block or a PLCS PSM block, in the diagram;
  2. Is the diagram as small as possible with no excessive whitespace?
  3. Can the diagram be viewed in its entirety in a web browser?
  4. Are all blocks and parts that represent templates coloured Green, fill color = RGB [204, 255, 204]
  5. Are all constraints coloured Blue, fill color = RGB [204, 204, 255]
  6. Are all parts named?
  7. Has the multiplicity of all parts been explicitly defined?
  8. Is there at least one private part identified as multiplicity=1 that will be instantiated when the template is instantiated.
  9. Has the multiplicity of all flow ports been explicitly defined and is it the same as the multiplicity of the parts that binds to it?
  10. Are all flow ports shown on the template Block bound on the parametric diagram?
  11. Have all the mandatory parameters (public parts) of the private parts been exposed, and are they bound?

Check the following on the Instances SysML Block Definition Diagram.

  1. Is the diagram and all instances contained within a package called "Instances"?
  2. Is the diagram as small as possible with no excessive whitespace?

Check the following on the Constraints SysML Block Definition Diagram.

It is necessary to clearly identify the ports that are the "output" or results of a constraint block function. Hence all output ports of a constraint block, ports that are assigned to by OCL constraints in functional constraint blocks, should be marked as ReadOnly to signify they carry the results of the OCL and should not be assigned to.

An example is shown in Figure 3. The OCL constraint variable combined is the result of the combination of Classifications hence it should be a "ReadOnly" port.

images/constraint_ouput.png
Figure 3 -  Constraint Block Ports
  1. Is the diagram and all constraint blocks contained within a package called "Constraints"?
  2. Is the diagram as small as possible with no excessive whitespace?
  3. Are all parameters shown?
  4. Is the OCL 2 constraint shown in the SysML Constraint compartment?
  5. Are all constraint blocks coloured Blue, fill color = RGB [204, 204, 255]

Check the following on the template Description.

  1. Has a description been provided?
  2. Are all references to other PLCSlib components hyperlinked?
    • Term: linked using term.ref. E.g. <term.ref term="PLCS PSM"/>
    • DEX: linked using dex.ref. E.g. <dex.ref context="Exemplar" dex="ConsumptionOfLife"/>
    • Template: linked using template.ref. E.g. <template.ref context="OASIS" template="ClassCode"/>
    • PLCS PSM blocks:linked using class.ref E.g. <class.ref package="Ap239Ap233Psm" class="Part"/>
    • OWL classes:linked using rdl.ref E.g. <rdl.ref uri="http://docs.oasis-open.org/ns/plcs/oasis-rdl#Maintenance_task"/>
    • Figures:linked using figure.ref E.g. <figure.ref id="OWLClassAndIndividual"/>

Are all Notes and examples formatted correctly:

  1. Notes: specified using <note>
  2. Examples: specified using <example>

Diagrams

  1. Are all diagrams showing the PSM hyperlinked? In other words, has the XML figure.map element been used to display the diagram?
Issue reporting