information-system-model-documentation-generator/gcube-model-isrelatedto.rst

IsRelatedTo

Activates

Activates has a Service <Service> instance both as source and target as well as CallsFor <CallsFor> but with a complete different semantic. Activates is used to indicates that the source Service <Service> of the relation enable the operation of the target Service. Examples are between a VirtualMachine <VirtualMachine> and an HostingNode <HostingNode> to capture the VirtualMachine <VirtualMachine> is operating the HostingNode <HostingNode>. Another example is between a VirtualMachine <VirtualMachine> and an EService <EService>, e.g., between a VirtualMachine <VirtualMachine> and a database instance. This relation can be created also between an HostingNode <HostingNode> and one EService <EService>, e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. Activates is also used between an EService <EService> and a RunningPlugin <RunningPlugin> which enrich the functionality offered by the source service.

Activates extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Service <Service>	Activates <Activates>	0..n	Service <Service>	Activates has a Service <Service> instance both as source and target as well as CallsFor <CallsFor> but with a complete different semantic. Activates is used to indicates that the source Service <Service> of the relation enable the operation of the target Service. Examples are between a VirtualMachine <VirtualMachine> and an HostingNode <HostingNode> to capture the VirtualMachine <VirtualMachine> is operating the HostingNode <HostingNode>. Another example is between a VirtualMachine <VirtualMachine> and an EService <EService>, e.g., between a VirtualMachine <VirtualMachine> and a database instance. This relation can be created also between an HostingNode <HostingNode> and one EService <EService>, e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. Activates is also used between an EService <EService> and a RunningPlugin <RunningPlugin> which enrich the functionality offered by the source service.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Service <Service>	Activates <Activates>	0..n	Service <Service>	The source Service enables the target Service to be running. Examples are an Hosting Node which enables an EService; A VirtualMachine enabling an EService or an HostingNode; An EService enabling a RunningPlugin; A VirtualMachine enabling an HostingNode etc

The Activates current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

BelongsTo

BelongsTo indicates that a Person <Person> belong to the target LegalBody <LegalBody>.

BelongsTo extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Person <Person>	BelongsTo <BelongsTo>	0..n	LegalBody <LegalBody>	BelongsTo indicates that a Person <Person> belong to the target LegalBody <LegalBody>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Person <Person>	BelongsTo <BelongsTo>	0..n	LegalBody <LegalBody>

The BelongsTo current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

CallsFor

A Service <Service> instance can require another Service <Service> instance to properly operate and this is indicated with CallsFor. Motivations similar to the ones for Requires <Requires> relation conducted to the definition for this relation.

CallsFor extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Service <Service>	CallsFor <CallsFor>	0..n	Service <Service>	A Service <Service> instance can require another Service <Service> instance to properly operate and this is indicated with CallsFor. Motivations similar to the ones for Requires <Requires> relation conducted to the definition for this relation.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Service <Service>	CallsFor <CallsFor>	0..n	Service <Service>	A reference to the Services needed by the target instance to work.

The CallsFor current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Discovers

Any EService <EService> or its specialisations can be related with another EService <EService> with Discovers relation. Discovers relation inform that the source EService <EService> discovers the target through the information system.Discovers relation specialise the semantic of CallsFor <CallsFor>.

Discovers extends CallsFor

Definition
Source	Relation	Multiplicity	Target	Description
EService <EService>	Discovers <Discovers>	0..n	EService <EService>	Any EService <EService> or its specialisations can be related with another EService <EService> with Discovers relation. Discovers relation inform that the source EService <EService> discovers the target through the information system.Discovers relation specialise the semantic of CallsFor <CallsFor>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
EService <EService>	Discovers <Discovers>	0..n	EService <EService>	A reference to any other EService, the EService instance is discovering through query on IS.

The Discovers current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Uses

Uses relation inform regarding the network invocation of the targetEService <EService> by the source. Uses relation specialises the semantic of CallsFor <CallsFor>.

Uses extends CallsFor

Definition
Source	Relation	Multiplicity	Target	Description
EService <EService>	Uses <Uses>	0..n	EService <EService>	Uses relation inform regarding the network invocation of the targetEService <EService> by the source. Uses relation specialises the semantic of CallsFor <CallsFor>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
EService <EService>	Uses <Uses>	0..n	EService <EService>	A reference to any other EService, the EService instance is invoking.

The Uses current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Demands

Demands is used to properly support to share a VirtualService <VirtualService> with another context.

Demands extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
VirtualService <VirtualService>	Demands <Demands>	0..n	Software <Software>	Demands is used to properly support to share a VirtualService <VirtualService> with another context.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
VirtualService <VirtualService>	Demands <Demands>	0..n	Software <Software>

The Demands current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

DependsOn

DependsOn indicates that a Software <Software> requires another one to work. This relation must not be confused with Requires <Requires>.

DependsOn extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Software <Software>	DependsOn <DependsOn>	0..n	Software <Software>	DependsOn indicates that a Software <Software> requires another one to work. This relation must not be confused with Requires <Requires>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Software <Software>	DependsOn <DependsOn>	0..n	Software <Software>	To capture any dependency between two software artifacts.

The DependsOn current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsPluginOf

A Plugin <Plugin> is a piece of Software extending the capabilities of another Software <Software> (main) and requiring the main Software <Software> to be executed. The relation between the main Software <Software> and the Plugin <Plugin> is expressed by IsPluginOf relation. IsPluginOf is an extension of DependsOn <DependsOn>.

IsPluginOf extends DependsOn

Definition
Source	Relation	Multiplicity	Target	Description
Plugin <Plugin>	IsPluginOf <IsPluginOf>	0..n	Software <Software>	A Plugin <Plugin> is a piece of Software extending the capabilities of another Software <Software> (main) and requiring the main Software <Software> to be executed. The relation between the main Software <Software> and the Plugin <Plugin> is expressed by IsPluginOf relation. IsPluginOf is an extension of DependsOn <DependsOn>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Plugin <Plugin>	IsPluginOf <IsPluginOf>	0..n	Software <Software>	A reference to the Software this Plugin is conceived to extend the capabilities.
Plugin <Plugin>	IsPluginOf <IsPluginOf>	0..n	Software <Software>	To capture the relation between a Software and its Plugins.

The IsPluginOf current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Enables

Any Service <Service> representing running code of a specific software has the relation Enables targeted to the corresponding Software <Software>. Enables is used for example by EService <EService> to indicates the running software; from HostingNode <HostingNode> to indicate the running software container; within RunningPlugin <RunningPlugin> and the software represented as Plugin <Plugin>.

Enables extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Service <Service>	Enables <Enables>	0..n	Software <Software>	Any Service <Service> representing running code of a specific software has the relation Enables targeted to the corresponding Software <Software>. Enables is used for example by EService <EService> to indicates the running software; from HostingNode <HostingNode> to indicate the running software container; within RunningPlugin <RunningPlugin> and the software represented as Plugin <Plugin>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Service <Service>	Enables <Enables>	0..n	Software <Software>	A reference to any Software the Service is enabling (i.e. the Software is running throught the EService).

The Enables current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Hosts

Hosts relation is used from a Site <Site> a Service <Service> instance. The target of the Hosts relation depends on the service offered by the Site. When the resources provided by a site are virtual machines, Hosts relation is created from a Site <Site> to a VirtualMachine <VirtualMachine>. When, instead a Site provides web-services, Hosts relation is created with EService <EService>. If a site provides container facilities Hosts relation is created with HostingNode <HostingNode>. By defining Hosts relation with target Service <Service>, the model is capable of representing the diverse type of federated systems and service.

Hosts extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Site <Site>	Hosts <Hosts>	0..n	Service <Service>	Hosts relation is used from a Site <Site> a Service <Service> instance. The target of the Hosts relation depends on the service offered by the Site. When the resources provided by a site are virtual machines, Hosts relation is created from a Site <Site> to a VirtualMachine <VirtualMachine>. When, instead a Site provides web-services, Hosts relation is created with EService <EService>. If a site provides container facilities Hosts relation is created with HostingNode <HostingNode>. By defining Hosts relation with target Service <Service>, the model is capable of representing the diverse type of federated systems and service.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Site <Site>	Hosts <Hosts>	0..n	Service <Service>

The Hosts current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Involves

Involves is used to indicate that and Actor <Actor> is involved in a Dataset <Dataset>.

Involves extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Dataset <Dataset>	Involves <Involves>	0..n	Actor <Actor>	Involves is used to indicate that and Actor <Actor> is involved in a Dataset <Dataset>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Dataset <Dataset>	Involves <Involves>	0..n	Actor <Actor>

The Involves current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsCompliantWith

IsCompliantWith is used to indicated a Dataset <Dataset> compliant with a Schema <Schema>.

IsCompliantWith extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Dataset <Dataset>	IsCompliantWith <IsCompliantWith>	0..n	Schema <Schema>	IsCompliantWith is used to indicated a Dataset <Dataset> compliant with a Schema <Schema>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Dataset <Dataset>	IsCompliantWith <IsCompliantWith>	0..n	Schema <Schema>	Any schema characterising the content of the dataset, e.g. the schema describing the 'columns' of a CSV-based dataset.

The IsCompliantWith current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsConfiguredBy

The relation IsConfiguredBy indicates that the source Software <Software> requires a configuration when it is instantiated.

IsConfiguredBy extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Software <Software>	IsConfiguredBy <IsConfiguredBy>	0..n	ConfigurationTemplate <ConfigurationTemplate>	The relation IsConfiguredBy indicates that the source Software <Software> requires a configuration when it is instantiated.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Software <Software>	IsConfiguredBy <IsConfiguredBy>	0..n	ConfigurationTemplate <ConfigurationTemplate>

The IsConfiguredBy current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsCorrelatedTo

IsCorrelatedTo relates a Dataset <Dataset> to another.

IsCorrelatedTo extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Dataset <Dataset>	IsCorrelatedTo <IsCorrelatedTo>	0..n	Dataset <Dataset>	IsCorrelatedTo relates a Dataset <Dataset> to another.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Dataset <Dataset>	IsCorrelatedTo <IsCorrelatedTo>	0..n	Dataset <Dataset>

The IsCorrelatedTo current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsPartOf

IsPartOf is used when a ConcreteDataset <ConcreteDataset> is part of a Dataset <Dataset>.

IsPartOf extends IsCorrelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
ConcreteDataset <ConcreteDataset>	IsPartOf <IsPartOf>	0..n	Dataset <Dataset>	IsPartOf is used when a ConcreteDataset <ConcreteDataset> is part of a Dataset <Dataset>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
ConcreteDataset <ConcreteDataset>	IsPartOf <IsPartOf>	0..n	Dataset <Dataset>	The reference to the 'incarnations'/'manifestations' contributing to a dataset.

The IsPartOf current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsCustomizedBy

IsCustomizedBy evidences that any Service <Service> can be customised by a ConfigurationTemplate <ConfigurationTemplate>.

IsCustomizedBy extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Service <Service>	IsCustomizedBy <IsCustomizedBy>	0..n	ConfigurationTemplate <ConfigurationTemplate>	IsCustomizedBy evidences that any Service <Service> can be customised by a ConfigurationTemplate <ConfigurationTemplate>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Service <Service>	IsCustomizedBy <IsCustomizedBy>	0..n	ConfigurationTemplate <ConfigurationTemplate>
Service <Service>	IsCustomizedBy <IsCustomizedBy>	0..n	ConfigurationTemplate <ConfigurationTemplate>	A reference to any configuration characterising the Service behaviour.

The IsCustomizedBy current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsDerivationOf

IsDerivationOf indicate that the source Configuration <Configuration> is an instantiation of the target ConfigurationTemplate <ConfigurationTemplate>.

IsDerivationOf extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Configuration <Configuration>	IsDerivationOf <IsDerivationOf>	0..n	ConfigurationTemplate <ConfigurationTemplate>	IsDerivationOf indicate that the source Configuration <Configuration> is an instantiation of the target ConfigurationTemplate <ConfigurationTemplate>.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Configuration <Configuration>	IsDerivationOf <IsDerivationOf>	0..n	ConfigurationTemplate <ConfigurationTemplate>

The IsDerivationOf current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

IsOwnedBy

Any Site <Site> is owned by an Actor <Actor> and this is captured by the IsOwnedBy relation. The referenced Actor <Actor> can be used as a contact point during an emergency, to agree on the scheduling of a site downtime and to request additional resources during the downtime of another site.

IsOwnedBy extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Site <Site>	IsOwnedBy <IsOwnedBy>	0..n	Actor <Actor>	Any Site <Site> is owned by an Actor <Actor> and this is captured by the IsOwnedBy relation. The referenced Actor <Actor> can be used as a contact point during an emergency, to agree on the scheduling of a site downtime and to request additional resources during the downtime of another site.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Site <Site>	IsOwnedBy <IsOwnedBy>	0..n	Actor <Actor>

The IsOwnedBy current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Manages

Manages indicates that of the source Service <Service> manages the target Dataset <Dataset>, e.g. read, manipulate, etc.

Manages extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Service <Service>	Manages <Manages>	0..n	Dataset <Dataset>	Manages indicates that of the source Service <Service> manages the target Dataset <Dataset>, e.g. read, manipulate, etc.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Service <Service>	Manages <Manages>	0..n	Dataset <Dataset>	A reference to any Dataset resource managed by the Service instance.
Service <Service>	Manages <Manages>	0..n	Dataset <Dataset>	The link between the service that 'manages' the dataset and the dataset, e.g. the service that hosts the dataset and give access to it.

The Manages current version is 1.0.0.

Changelog:

• 1.0.0: First Version.

Requires

Requires is used to indicate that the source Software <Software> when activated requires to interact with a specific Service <Service> instance, i.e., the target of the relation. This relation usually reflects an administrative constraint than a technological limitation. When there are no constraint on the instance the relation is instead DependsOn <DependsOn> which is between two Software <Software>.Not necessarily all the Software <Software> running in the infrastructure are represented as resources. Only the Software <Software> required for infrastructure administration or the ones to be managed with specific policies are represented. Indeed, Requires relation is normally used as policy constraint. Let imagine an open source software which uses a MySQL database as backend. In many cases, what characterises the software instance is the data present in the backend. The infrastructure manager could stipulate an agreement with a provider having a particular set of data which is not for public domain. The software once deployed, giving the business agreement, is entitled to use the instance of the provider and not a generic MySQL database instance. The infrastructure manager imposes the use of such a particular instance because of the data it contains.

Requires extends IsRelatedTo

Definition
Source	Relation	Multiplicity	Target	Description
Software <Software>	Requires <Requires>	0..n	Service <Service>	Requires is used to indicate that the source Software <Software> when activated requires to interact with a specific Service <Service> instance, i.e., the target of the relation. This relation usually reflects an administrative constraint than a technological limitation. When there are no constraint on the instance the relation is instead DependsOn <DependsOn> which is between two Software <Software>.Not necessarily all the Software <Software> running in the infrastructure are represented as resources. Only the Software <Software> required for infrastructure administration or the ones to be managed with specific policies are represented. Indeed, Requires relation is normally used as policy constraint. Let imagine an open source software which uses a MySQL database as backend. In many cases, what characterises the software instance is the data present in the backend. The infrastructure manager could stipulate an agreement with a provider having a particular set of data which is not for public domain. The software once deployed, giving the business agreement, is entitled to use the instance of the provider and not a generic MySQL database instance. The infrastructure manager imposes the use of such a particular instance because of the data it contains.
Properties
Name	Type	Attributes	Description
This type does not define any additional attributes.
Known Usage
Source	Relation	Multiplicity	Target	Description
Service <Service>	Requires <Requires>	0..n	Service <Service>	A reference to any Service needed by a Software to properly operate, e.g. this can be used to capture a sort of run-time requirements between a software component and the Service it needs.
Software <Software>	Requires <Requires>	0..n	Service <Service>	To capture any dependency between a software artifact and a Service, e.g. A software requiring a specific database instance.

The Requires current version is 1.0.0.

Changelog:

• 1.0.0: First Version.