Skip to end of metadata
Go to start of metadata

 

Global information

Goal of the Export Interfaces

It allows the user to export a list of all the flows in an arKItect project, or in a particular variant, with some relevant attributes, producer/consumer functions, producer/consumer components and allocations to physical interfaces.
The flows that are produced and consumed by the same component will not be exported.
The following image from the view "5.1. Allocate Functions to Components" shows an example of a project's flows, produced and consumed by functions that are allocated to the system's components.

In this example, Data flow_2 will not be exported, because it is produced and consumed by the same component. Data flow_1 consumed by Function_2_2 will not be exported too, because only leaf function directly allocated to component are extracted.

 


In the next image from the view "5.2. Allocate flows on interfaces" the example is continued, with the flow's allocations to physical interfaces.


The treeview from the view "5.2. Allocate flows on interfaces" allows to better understand the previous image.

Access to the Export Interfaces

The result of running the script "STR_Interface" will constitute the Export Interfaces / ISR deliverable.
Go to the Process view.

Enter the box Object Tools.

Once inside, find the Object DEA-ME and double click on it.

Find the script "STR_Interface"; then, right-click on it and click on run.

Two drop-list windows will appear, asking you to select the desired DEAME system and the top level component.

Select the DEAME system

Select a top level component

The script will exported all flows produced and consumed by functions of the selected system allocated to the selected component.


The desired Excel file will be automatically exported.

NOTE: for each drop-list window, you can either select ONE object or NONE and validate by clicking "OK". If none object is selected, the export will consider all objects to be treated (for example: if you don't select a component and click on "ok", the generated document will contain all top level component).

Prerequisites

  1. Must have created flows in the view "3.1 Define functional architecture". See chapter Define System Functions and Flows.
  2. Must have allocated functions to components in the view "5.1. Allocate Functions to Components". See chapter Allocate Functions to Components.
  3. Must have allocated functions to physical interfaces in the view "5.2. Allocate flows on interfaces". See chapter Allocate flows on interfaces.

Expected results

Description of the Result

The generated STR_Interface has 4 tabs as follow:

  • STR Interface consumer: export the list of external flows consumed by the selected component
  • STR Interface producer: export the list of flows produced by the selected component and consumed by other component
  • Physical Interfaces: export the list of Physical interfaces and the flows allocated to them. Used to match the physical interface for each flow in the 2 STR Interface tabs
  • Relation Diagram: an overview of the Relation Block Diagram centered on the selected component.
       It gives the context of the selected component.
       The Relation Diagram is only exported when ONE component is selected.

In the 2 STR Interface consumer or producer, the exported flow's attributes include:

  • Physical interface: the physical interface hosting the flow
  • Flow id: It represents the ArkiID, an unique value attributed by arKItect to identify each object
  • Flow name
  • Flow type: Data or Physical flow
  • Alias in system: This flow attribute defined by Renault holds the information related to the Controller Area Network (CAN)
  • Producer function: name of function that produces the flow
  • Consumer function: name of function that consumes the flow
  • ISR: the ISR number of flows consumed by the Consumer function
       The Information is contained in Consumer function desc attribute
       If the function consumes multiple flows, all flows and their respective ISR shall be write down in desc with the following rule "Flow name : ISR xxxx"
  • Producer component: the components hosting producer function
  • Consumer component: thecomponents hosting consumer function
  • Producer system: the DEAME systems to whom to which the producer function belongs to
  • Consumer system: the DEAME systems to which the consumer function belongs to

Note: At the moment some actors save the ISR information in the attribute "Alias in system" of flow itself and some others save it in attribute "desc" of consumer function. In both cases. ISR are exported in this deliverable.

The expected results will look similar to this table:

Physical interfaceFlow idFlow nameFlow typeAlias in systemProducer functionConsumer functionISRProducer componentConsumer componentProducer systemConsumer system
physical interface_1FLO__0001Data flow_1Data flow Function_1Function_2 Component_1Component_2FunctionFunction_4
physical interface_1FLO__0001Data flow_1Data flow Function_1Function_2_2 Component_1Component_2FunctionFunction_4

                                 STR Interface consumer

 

Physical interfaceFlow idFlow nameFlow typeAlias in systemProducer functionConsumer functionISRProducer componentConsumer componentProducer systemConsumer system
physical interface_2FLO__0003Physical flow_1Physical flow Function_3Function_1 Component_2Component_1Function_4Function

                                  STR Interface producer

                                  Relation Block Diagram extract


Note: You may see the same flow appear several times in the exported list. This will happen only for the flows that have different consumer and producer functions and/or components.
The following screen capture shows how the result looks like in a real project:

  • No labels