Software Cluster Editor

The software-cluster-editor Software Cluster Editor supports you in managing your Software Clusters and Function Group Sets.

A Software Cluster represents an uploadable software package. This element allows for referencing all of the required model elements that, in their entirety, make up an Adaptive Application. One of the most prominent contents of the Adaptive Application is the executable software, implicitly referenced as a Process contained within the Software Cluster, as each Process is simply an instance of an Executable.

Each Software Cluster claims one or more so called Function Group, which has a set of States. The Processes contained in the Software Cluster can be mapped to these States, meaning they will be started as the State becomes active. As a result, collections of processes will start and stop during a lifecycle of an Adaptive Application, as various Function Groups cycle through their States.

Open Software Cluster Editor

CTRL + SHIFT + D, C

Open Editor

To open the Software Cluster Editor, expand your DaVinci Adaptive project in the DaVinci Project Explorer and double click on da-vinci-developer-adaptive Open Project Dashboard. The Project Frame opens showing the Project Home. You can then open the Software Cluster Editor as follows:

  • Open the editors Editor menu on the top right of the Project Dashboard and click the software-cluster-editor Software Cluster Editor command.

  • Alternatively, use the context menu command software-cluster-editor Open Software Cluster Editor of the da-vinci-developer-adaptive Open Project Dashboard node in the DaVinci Project Explorer.

  • Alternatively, on the Dashboard page of the Project Home, click software-cluster-editor Software Cluster Editor in the Comfort Editors area.

  • Alternatively, on the Dashboard page of the Project Home, click the arrow of the Current Focus drop-down list and select Machine Integration. In the Software Clusters area, click the Edit button (this requires at least one created Software Cluster).

  • Alternatively, use the context menu command software-cluster-editor Open in Software Cluster Editor of a Software Cluster, Function Group Set, or Process that is contained in a Software Cluster in the AUTOSAR Model Explorer.

The Software Cluster Editor opens in a new tab of the Project Frame.

Functionality

The Software Cluster Editor provides the functionalities listed below. If not otherwise mentioned, the functionalities available in the details-mode-form-mode Form mode are described. If you want to manage the properties of an element textually, switch to the dml-editor DML mode via the toolbar and refer to DaVinci Modeling Language Editor for more information.

Tree View Structure Description of Functionalities

software-clusters Software Clusters

The element Software Clusters is used for grouping and does not contain any modifiable properties.

tree-view-structure-child-elementsoftware-cluster <Software Cluster>

Select a Software Cluster in the tree view on the left side of the editor.

At the top of the form page, the general properties are displayed and can be modified:

  • Name: Displays the name of the Software Cluster. Edit the field to change the name.

  • Description: Displays the description of the Software Cluster. Edit the field to change the description.

  • Software Cluster Category: Displays the category of the Software Cluster. Click the arrow to select a Software Cluster Category.

  • Target Machine: The property Target Machine is provided as an extension to the AUTOSAR Adaptive standard. The Target Machine is used as a guidance when you add Processes to the selected Software Cluster and reference a Software Cluster Design. The selected Target Machine is stored in the Contained AR Element list.

    You can modify the reference to the Target Machine as follows:

    • reference Select Reference Target: Click this icon to select or modify the reference to the Target Machine.

    • skeleton-model-wizard Create Reference Target with the Skeleton Model Wizard.

    • go-to-reference-target Go to Reference Target: Click this icon to open the referenced Target Machine in the AUTOSAR Model Explorer.

  • Vendor Id: Displays the vendor ID of the Software Cluster. Edit the field to change the vendor ID.

  • Version: Displays the version of the Software Cluster. Edit the field to change the version.

  • Type Approval: Displays the Type Approval of the Software Cluster. Edit the field to change the Type Approval.

  • Claimed Function Groups: Lists all claimed Function Groups.
    To claim a Function Group, click addClaim Function Group and select one or more Function Groups to be claimed in the dialog that opens.

Diagnostic Information (Only for Root Software Cluster) Area

In the Diagnostic Information area, the reference to the Diagnostic Deployment Props can be selected or modified as follows:

  • Diagnostic Deployment Props: Displays the target reference for the Diagnostic Deployment Props that are applicable for the corresponding Software Cluster.

    • reference Select Reference Target: Click this icon to select or modify the reference to the Diagnostic Deployment Props.

    • skeleton-model-wizard Create Reference Target with the Skeleton Model Wizard.

    • go-to-reference-target Go to Reference Target: Click this icon to open the referenced Diagnostic Deployment Props in the AUTOSAR Model Explorer.

General Functions

  • delete Delete: Click this icon to delete the properties of a respective field or a selected element, respectively. For fields that reference an element, only the reference is deleted but not the referenced element itself.

Software Clusters can also be cloned by clicking the add-multipleClone Software Cluster icon in the toolbar on the left side.

tree-view-structure-child-elementtree-view-structure-child-elementsoftware-cluster-overview Software Cluster Overview

Select Software Cluster Overview in the tree view on the left side of the editor.

The page shows a graphical overview of all contained processes and their connections within a Software Cluster.

Get detailed information in section Software Cluster Overview.

tree-view-structure-child-elementtree-view-structure-child-elementprocesses Contained Processes

Select Contained Processes in the tree view on the left side of the editor.

Add Process to this Software Cluster Tab

The left table lists all available Processes that are not mapped to the current Software Cluster. The right table lists all Processes that are mapped to the current Software Cluster. The mapping can be modified as follows:

  • add Create Process: Click this icon and follow the Create Process wizard to create a Process.

  • delete Delete Process: Click this icon to delete a selected Process.

  • map Map: Click this icon to map the selected Process to the current Software Cluster.

  • unmap Unmap: Click this icon to unmap a selected Process from the Software Cluster.

Local Com Access Control Tab

In this tab, you can control the use of service interfaces and their deployment elements by using ComGrants for a machine. In the table you find a list of expandable processes and their elements, for which you can add ComGrants. ComGrants can be added or removed for the corresponding elements by selecting or deselecting them in the table via check box.

  • Enable Local Com Access Control for <Machine Name>:

    • Check the check box if you want to use Local Com Access Control for the machine.

      The Local Com Access Control can only be enabled if all processes are mapped to the same machine. If not, the tab is displayed as read only.

    • If Local Com Access Control is checked: Select the Type of Access Control (callout or policy-based).

      callout: the user provides the ruleset for the CM Access Control for example, as a database.

      policy-based: the generator creates one policy file defined per User ID.

      To remove the Access Control Type click delete Delete.

      MICROSAR BSW r11.25.08 or newer required.

  • Selection States for Elements:

    • checkbox-selected: A single element or the element and all its children are selected.

    • checkbox-all-children-selected: Not all children of the element are selected.

    • checkbox-not-selected: A single element or the element and all its children are not selected.

    • checkbox-not-selected / checkbox-not-all-children-selected / checkbox-not-selected-read-only: Cannot be checked and is displayed as read only. The selection can either only be determined via a higher-level element or cannot be changed.

      Example: ComGrants for Events and Notifiers can only be added via Event Groups in SOME/IP ServiceInterfaceDeployments.

tree-view-structure-child-elementtree-view-structure-child-elementprocesses <Process>

Select a Process in the tree view on the left side of the editor.

At the top of the form page, the general properties are displayed and can be modified:

  • Name: Displays the name of the Process. Edit the field to change the name.

  • Description: Displays the description of the Process. Edit the field to change the description.

General Area

In the General area, you can change the referenced Process Design, Executable, and Process States as follows:

  • reference Select Reference Target: Opens the Select Reference Target dialog in which the new target reference can be selected.

  • skeleton-model-wizard Create Reference Target with the Skeleton Model Wizard.

  • go-to-reference-target Go to Reference Target: Opens the referenced target in the AUTOSAR Model Explorer.

Note that an Executable reference is not required if the Process Design reference contains an Executable.

Startup Configuration Tab

The Startup Configuration can be added or modified as follows:

  • create Create Startup Configuration: Click this icon to open a dialog in which a new Startup Configuration for the selected Process can be defined.

  • Function Group States: This column displays the Function Group State in which the selected Process should be started. A Process can have one or more Function Group State configurations, which is displayed in multiline column.
    To edit the Function Group States, double click on the entry to open a dialog in which one or more States from one Function Group can be selected.

  • Resource Group: This column displays the resource group reference configured for selected Startup Configuration.
    To edit the Resource Group, double click on the entry and select a Resource Group from the list. The list displays all Resource Groups configured for the selected Process.

  • Startup Config: This column displays the Startup Configuration for the selected Process. The Process can have one or more Startup Configurations, which are displayed in a multiline column.
    To edit the Startup Parameters, double click on the entry to open a dialog in which the Startup Parameters that can be used by the selected Processes can be edited as follows:

    • Startup Config Set: Click the arrow to select the Startup Configuration Set to be configured for the selected Process.

    • Startup Parameters Table: All Startup Parameters of the above selected Startup Configuration Set are displayed in this table. To edit a Startup Parameter, double click the respective field:
      Name: Displays the name of the Startup Parameter.
      Priority: Displays the priority of the Startup Parameter.
      Scheduling Policy: Displays the Scheduling Policy of the Startup Parameter.
      Process Arguments: Displays process arguments in <OptionName> <OptionArgument> manner for the Startup option presented in the Startup Parameter. One or more process arguments are possible, which are displayed in the column as multiline.
      Environment Variables: Displays the Environment Variable configured in <Key> <Value> manner for the Startup option presented in the Startup Parameter. One or more Environment Variable configurations are possible, which are displayed in the column as multiline.
      Termination Behavior: Displays the specified termination behavior of the Process.
      Timeout: Displays the specified Enter and Exit Timeout of the Process.
      Execution Error: Displays the referenced Process Execution Error.
      Used By: Used by is a read-only field that displays the Processes configured for the selected Startup Parameter.

  • Execution Dependency: The Execution Dependency configuration is shown as follows:
    "Target value<Process>" / "Context Value<Function Group State>".
    To edit an Execution Dependency, double click on the respective field to open a dialog in which all Processes are shown that are mapped to the same Machine and that aggregate a State Dependent Startup Configuration that refers to the same Function Group State. Multivalue configuration is supported.

Local Com Access Control Tab

If you select a single process, you can specify for which of its service interfaces and deployment elements ComGrants should be added.

The tab has the same options as the tab under Contained Processes. However, only elements of the individual process are displayed here for selection.
For more details about the Local Com Access Control tab, refer to the description in the Contained Processes row above this one.

Logging Tab

In the Logging table, the Log Channels that are used by the Process can be configured. Click add Map Log Channel to open a wizard in which existing Log Channels can be mapped to the Process. The Logging table displays all Log Channels that are mapped to the Process.

General Functions

  • delete Delete: Click this icon to delete the properties of a respective field or a selected element, respectively. For fields that reference an element, only the reference is deleted but not the referenced element itself.

tree-view-structure-child-elementtree-view-structure-child-elementsoftware-cluster-design Software Cluster Design

Select Software Cluster Design in the tree view on the left side of the editor.

The left table lists all available Software Cluster Designs that are not mapped to the current Software Cluster. The right table lists all Software Cluster Designs that are mapped to the current Software Cluster. The mapping can be modified as follows:

  • add Create Software Cluster Design: Click this icon to open a dialog in which a new Software Cluster Design can be defined.

  • delete Delete Software Cluster Design: Click this icon to delete a selected Software Cluster Design.

  • map Map: Click this icon to map the selected Software Cluster Design to the current Software Cluster.

  • unmap Unmap: Click this icon to unmap a selected Software Cluster Design from the Software Cluster.

tree-view-structure-child-elementtree-view-structure-child-elementtree-view-structure-child-elementsoftware-cluster-design <Software Cluster Design>

For each Software Cluster Design that is mapped to the Software Cluster, you can modify its properties in the DaVinci Modeling Language Editor on the respective subpage.

tree-view-structure-child-elementtree-view-structure-child-elementdepends-on Depends on

Select Depends on in the tree view on the left side of the editor.

On the form page, you can model dependencies to other Software Clusters that are required for installation.

To define new dependencies, a root node must be created first. Open the context menu of the <no formula> entry and click add Add RootNode. On the left side of the form view, specify as follows:

  • Logical Operator: Click the arrow and select whether the logical operator of the root node to be logical AND or OR.

Sub nodes can be created and modified via the following context menu commands of a node:

  • add Add AND/OR: Adds a sub node in which the logical operator can be defined. Refer to the description of the root node above for information on the fields.

  • add Add Condition Expression: Adds a sub node in which a compare condition for a referenced Software Cluster can be defined.

    • Software Cluster ref: Displays the reference to the Software Cluster to be compared.

      reference Select Reference Target: Click this icon to select or modify the reference to the Software Cluster.

    • skeleton-model-wizard Create Reference Target with the Skeleton Model Wizard.

      go-to-reference-target Go to Reference Target: Click this icon to open the referenced Software Cluster in the AUTOSAR Model Explorer.

    • Comparison Operator: Displays with which operator the Software Clusters are compared. Click the arrow to select or modify the comparison operator.

    • Version: Displays the version to be compared. Edit the field to change the version.

    • Consider Build Number: The check box indicates whether or not the build number is included in the comparison. Click the check box to enable or disable the consideration of the build number.

General Functions

  • delete Delete: Click this icon to delete the properties of a respective field or a selected element, respectively. For fields that reference an element, only the reference is deleted but not the referenced element itself.

tree-view-structure-child-elementtree-view-structure-child-elementconflicts-to Conflicts to

Select Conflicts to on in the tree view on the left side of the editor.

On the form page, you can model dependencies to other Software Clusters that are blocking the installation.

To define new dependencies, a root node must be created first. Open the context menu of the <no formula> entry and click add Add RootNode. On the left side of the form view, specify as follows:

  • Logical Operator: Click the arrow and select whether the logical operator of the root node to be logical AND or OR.

Sub nodes can be created and modified via the following context menu commands of a node:

  • add Add AND/OR: Adds a sub node in which the logical operator can be defined. Refer to the description of the root node above for information on the fields.

  • add Add Condition Expression: Adds a sub node in which a compare condition for a referenced Software Cluster can be defined.

    • Software Cluster ref: Displays the reference to the Software Cluster to be compared.

      reference Select Reference Target: Click this icon to select or modify the reference to the Software Cluster.

    • skeleton-model-wizard Create Reference Target with the Skeleton Model Wizard.

      go-to-reference-target Go to Reference Target: Click this icon to open the referenced Software Cluster in the AUTOSAR Model Explorer.

    • Comparison Operator: Displays with which operator the Software Clusters are compared. Click the arrow to select or modify the comparison operator.

    • Version: Displays the version to be compared. Edit the field to change the version.

    • Consider Build Number: The check box indicates whether or not the build number is included in the comparison. Click the check box to enable or disable the consideration of the build number.

General Functions

  • delete Delete: Click this icon to delete the properties of a respective field or a selected element, respectively. For fields that reference an element, only the reference is deleted but not the referenced element itself.

function-group-set Function Group Sets

The element Function Group Sets is used for grouping and does not contain any modifiable properties.

tree-view-structure-child-elementfunction-group-set <Function Group Set>

Select Function Group Sets in the tree view on the left side of the editor.

A Function Group Set is a container for Function Groups. You can modify a Function Group Set as follows:

  • Name: Displays the name of the Function Group Set. Edit the field to change the name.

  • Description: Displays the description of the Function Group Set. Edit the field to change the description.

  • Function Groups: The table lists all Function Groups contained in the Function Group Set. Click add Create Function Group to open a dialog in which a new Function Group can be defined.

General Functions

  • delete Delete: Click this icon to delete the properties of a respective field or a selected element, respectively. For fields that reference an element, only the reference is deleted but not the referenced element itself.

tree-view-structure-child-elementtree-view-structure-child-elementfunction-group <Function Group>

Select a Function Group in the tree view on the left side of the editor.

The Function Group can be modified as follows:

  • Name: Displays the name of the Function Group. Edit the field to change the name.

  • Description: Displays the description of the Function Group. Edit the field to change the description.

  • Mode Declaration: The Mode Declaration specifies the set of states of the Function Group.

    • reference Select Reference Target: Click this icon to select or modify the reference to the Mode Declaration.

    • skeleton-model-wizard Create Reference Target with the Skeleton Model Wizard.

    • edit Edit: Click this icon to open a dialog in which the referenced Mode Declaration can be modified.

    • go-to-reference-target Go to Reference Target: Click this icon to open the referenced Mode Declaration in the AUTOSAR Model Explorer.

  • Process Overview: The Process Overview table provides an overview of all Processes that reference this Function Group from their State Dependent Startup Configuration. It shows how the Processes are mapped to the states of the Mode Declaration and which Startup Configuration is used. If a state is referenced and there is a Startup Configuration specified in the State Dependent Startup Configuration, then the name of the Startup Configuration is shown. If a state is not referenced, then the cell is empty.

MICROSAR Adaptive Parameters Area

This area contains MICROSAR Adaptive Parameters that are specified as Model Extensions (MEX) in the MICROSAR Adaptive BSW Package. Parameters for the selected AUTOSAR model element are displayed in the table of the MICROSAR Adaptive Parameters area on the respective pages of the Software Cluster Editor. Select a parameter in the table to view the editing options.

For more information on the MICROSAR Adaptive Parameters, refer to the Technical Reference in the .\Doc\TechnicalReferences folder of your MICROSAR Adaptive BSW Package.