Template: Software

This section specifies the template Software.

The specification comprises a SysML Block that represents the template and an associated Parametric Diagram that defines the templates and PLCS PSMTemplate objects instantiated by the Software template.

The specification comprises the following sections:

Section Description provides a description of the template;
Section Template Block specifies the SysML Block that represents the template;
Section Template Properties specifies the properties, i.e. the SysML Part, Reference and Value properties of the templates SysML Block;
Section Template Output Ports specifies the SysML Output Ports of the templates SysML Block. These bind to the templates and PLCS PSM objects instantiated by the Software template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the Software template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the Software template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the Software template and bound to private parts of the template;
Section Default instances species the instances that have been instantiated in the template. These are used to set the default value of blocks.
Section Constraint blocks identifies the constraint blocks that have been specified in this template;
Section Example data provides example XML data sets that have been instantiated in accordance with this template.

NOTE An explanation of a template and its specification is provided in the Template overview

Description

The Software template describes how to represent an approved software (or software version) that may be installed in an item of supply individual (partly based on the ISO-IEC 19770-2 Software Identification Tags standard).

Related Templates

No templates have been explicitly defined as being related to the Software template.

NOTE The Software template may make reference to other templates as part of the Parametric Diagram. These are not listed here.

Template Block

Figure 1 shows the SysML Block that represents the template. The Block is an abstraction representing a pattern of templates and PLCS PSMTemplate objects.

The properties, i.e. the SysML Block Part, Reference and Value properties, of the template's SysML Block are described in the Template Properties section.

The output ports shown on the template's SysML Block are described in the template output ports section.

The SysML Parametric diagrams for the template Block are shown in template parametric diagram section.

Figure 1 - Template block definition diagram for Software

Template Properties

The following SysML Part, Reference, and Value properties are defined for this template:

References:

licensingOrg [1] (Template: SwedishDefence:ExternalActor)

Relationship to the external actorthat represents the organization that is licensing the use of the software.

requiredSoftware [0..*] ()

Software that is required to work properly.

itemOfSupply [0..1] (Template: SwedishDefence:ItemOfSupplyDefinition)

Corresponding ItemOfSupply.

Parts:

softwareId [1] (Template: OASIS:Identification)

A unique identifier of the software.

The reference data used in Template: OASIS:Identification is restricted as follows:

RDL constraint 1:

softwareId constraint

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareId

softwareName [1] (Template: OASIS:Descriptor)

The base name of the product (e.g. Office).

The reference data used in Template: OASIS:Descriptor is restricted as follows:

RDL constraint 1:

softwareName constraint

The reference data for:

OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareName

softwareVersionId [1] (Template: OASIS:Identification)

Underlying development version for the software.

The reference data used in Template: OASIS:Identification is restricted as follows:

RDL constraint 1:

softwareVersionId constraint

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareVersionId

softwareDescription [0..1] (Template: OASIS:Descriptor)

A longer, detailed description of the software.

The reference data used in Template: OASIS:Descriptor is restricted as follows:

RDL constraint 1:

softwareDescription constraint

The reference data for:

OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareDescription

softwareColloquialVersion [0..1] (Template: OASIS:Descriptor)

The informal or colloquial version of the product (i.e. 2013). Note that this version may be the same through multiple releases of a software product where the version specified in software version id is much more specific and will change for each software release.

The reference data used in Template: OASIS:Descriptor is restricted as follows:

RDL constraint 1:

softwareColloquialVersion constraint

The reference data for:

OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareColloquialVersion

softwareEdition [0..1] (Template: OASIS:Descriptor)

The variation of the product (Extended, Enterprise, Professional, Standard etc).

The reference data used in Template: OASIS:Descriptor is restricted as follows:

RDL constraint 1:

softwareEdition constraint

The reference data for:

OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareEdition

softwareProductFamily [0..1] (Template: OASIS:Descriptor)

The overall product family this software belongs to. Product family is not used to identify that a product is part of a suite, but is instead used when a set of products that are all related may be installed on multiple different devices. For example, an Enterprise backup system may consist of a backup server, multiple different backup systems that support mail servers, databases and ERP systems as well as individual software items that backup client devices. In this case all software titles that are part of the backup system would have the same productFamily name so they can be grouped together in reporting systems.

The reference data used in Template: OASIS:Descriptor is restricted as follows:

RDL constraint 1:

softwareProductFamily constraint

The reference data for:

OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareProductFamily

softwareRevision [0..1] (Template: OASIS:Identification)

The informal or colloquial representation of the sub-version of the given product (i.e., SP1, R2, RC1, Beta 2, etc). Note that the SoftwareIdentity.version will provide very exact version details.

The reference data used in Template: OASIS:Identification is restricted as follows:

RDL constraint 1:

softwareRevision constraint

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#softwareRevision

Template Output Ports

The following output ports are defined for this template:

pvd (Block: Ap239Ap233Psm:PartViewDefinition)

Enables the Block: Ap239Ap233Psm:PartViewDefinition instantiated by this template to be referenced when the template is used.

Template constraints

There are no constraints defined for this template.

Template Parametric diagram

This section describes the template's Parametric Diagram. The diagram details the pattern of templates and PLCS PSMTemplate objects that are required to represent the template Software.

The public properties, i.e. those visible in the template's SysML block (See Figure 1) are shown on the left of a Parametric Diagram.

NOTE Restrictions on the reference data to be set on the public properties is defined in the Template Properties section.

The output ports are shown on the right of a Parametric Diagram.

PLCS PSM objects are shaded khaki and Templates are shaded light green in a Parametric Diagram.

Figure 2 - Software

Instantiated Blocks

The following blocks are instantiated by this template and bound to private parts of the template as shown in the Parametric Diagram section:

Private Part Property:software [1] (Template: OASIS:Part)

Private Part Property:classifierSoftware [1] (Template: OASIS:Classifier)

Private Reference Property:classSoftware [1] (Block: Ap239Ap233Psm:ExternalOwlClass)

The following constraint, normally a uniqueness constraint, is applicable when instantiating the ExternalOwlClass:

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: ur1

Specification: (OCL2.0)

ExternalOwlClass::allInstances()->isUnique(class)

Private Part Property:partDefVdc [1] (Template: OASIS:ViewDefinitionContext)

Private Part Property:combDesc1 [1] (Constraint Block: OASIS:Descriptor:CombineDescriptors)

Private Part Property:combDesc [1] (Constraint Block: OASIS:Descriptor:CombineDescriptors)

Private Part Property:requiredSoftwareRel [0..*] (Block: Ap239Ap233Psm:NextAssemblyViewUsage)

Private Part Property:itemOfSupplyAsg [0..1] (Block: Ap239Ap233Psm:ResourceItemRealization)

Default instances

There are no instances that have been instantiated in this template.

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

No example data sets have been provided for this Template.