Académique Documents
Professionnel Documents
Culture Documents
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
COORDINATION SHEET
02 TB-16 I 01/12/2016 [0] 2 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
Confidential Publication
RECORD OF REVISIONS
APPROVALS
02 TB-16 I 01/12/2016 [0] 5 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
TABLE OF CONTENTS
1. INTRODUCTION .......................................................................................................... 7
1.1 PURPOSE …………………………………………………………………………………7
1.2 SCOPE …………………………………………………………………………………7
1.3 ACRONYMS AND ABBREVIATION ..................................................................................... 7
1.4 REFERENCE DOCUMENTS ................................................................................................ 8
1.4.1 Internal Documents .................................................................................................. 8
1.4.2 External Documents ................................................................................................. 8
2. ACCESSING IFF ........................................................................................................... 9
3. SETUP IFF – AN OVERVIEW ..................................................................................... 9
3.1 DIFFERENT PHASES IN IFF .............................................................................................. 9
3.2 METHODOLOGIES IN IFF ................................................................................................. 9
3.3 SCM SETUP .................................................................................................................... 9
3.4 ADD TOOLS .................................................................................................................. 10
3.5 ADDING USER TO IFF .................................................................................................... 11
4. PROJECT SETUP ........................................................................................................ 12
4.1 PROJECT OVERVIEW ...................................................................................................... 12
5. ADDING/DELETING USERS ..................................................................................... 17
5.1 ADDING NEW USER ....................................................................................................... 17
5.2 DELETE AN EXISTING USER............................................................................................ 18
6. ADD SCM TO IFF........................................................................................................ 18
7. PROJECT ORGANIZATION ..................................................................................... 20
7.1 MULTIPLE WORKFLOWS ................................................................................................ 22
8. ADDING TOOLS INTO IFF ....................................................................................... 22
9. ADDING FRAMEWORK ............................................................................................ 23
10.CREATING A PROJECT ........................................................................................... 23
10.1 CREATING WORKFLOWS AND ASSIGNING PHASES ........................................................... 25
10.2 ADDING TOOLS TO THE PROJECT .................................................................................... 26
10.3 PHASE COMPLETION CRITERIA ....................................................................................... 28
10.4 WORKFLOW COMPLETION CRITERIA .............................................................................. 29
10.5 PROJECT COMPLETION CRITERIA .................................................................................... 30
11.FOLDER STRUCTURE OF IFF PROJECT.............................................................. 31
12.REPORTS .................................................................................................................... 32
12.1 TRACEABILITY REPORT................................................................................................. 33
12.2 PROJECT ANALYSIS REPORT ........................................................................................... 33
12.3 CUSTOM ANALYSIS REPORTS ........................................................................................ 37
13.NOTES AND EMAIL .................................................................................................. 38
13.1 NOTES ………………………………………………………………………………..38
13.2 SENDING AN EMAIL ....................................................................................................... 38
02 TB-16 I 01/12/2016 [0] 6 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
LIST OF FIGURES
Figure 1 SVN setup ............................................................................................................. 10
Figure 2 Adding tool to IFF................................................................................................. 11
Figure 3 Tool added to IFF. ................................................................................................. 11
Figure 4 Users in IFF .......................................................................................................... 12
Figure 5 Project Structure – An Example ............................................................................ 12
Figure 6 Project Configuration ............................................................................................ 13
Figure 7 Workflows in a Project .......................................................................................... 14
Figure 8 Workflow Completion Criteria .............................................................................. 14
Figure 9 Adding Tool to a Phase ......................................................................................... 15
Figure 10 Phase Completion Criteria ................................................................................... 16
Figure 11 Project Completion Criteria ................................................................................. 17
Figure 12 Adding New User to IFF ..................................................................................... 18
Figure 13 User appear in User management list after adding into IFF .................................. 18
Figure 14 Adding New SCM ............................................................................................... 19
Figure 15 Adding more SCM Commands............................................................................ 19
Figure 16 Selecting a SCM for All projects ......................................................................... 20
Figure 17 Root path of SCM ............................................................................................... 20
Figure 18 Entry and Exit Criteria Relationship .................................................................... 21
Figure 19 Tool Details......................................................................................................... 23
Figure 20 SCM Root path.................................................................................................... 24
Figure 21 Fields to be filled while adding a tool .................................................................. 25
Figure 22 Creating Workflow.............................................................................................. 26
Figure 23 Adding Tools to a Phase ...................................................................................... 27
Figure 24 Selected Tools ..................................................................................................... 27
Figure 25 Tool Stages based on Order ................................................................................. 28
Figure 26 Phase completion Criteria .................................................................................... 29
Figure 27 Workflow Completion Criteria ............................................................................ 30
Figure 28 Project Completion Criteria ................................................................................. 30
Figure 29 Multiple workflows in a Project........................................................................... 31
Figure 30 Folder Structure of a Project ................................................................................ 32
Figure 31 Traceability Report.............................................................................................. 33
Figure 32 Analysis Report for Project Methodology ............................................................ 34
Figure 33 Analysis Report for Project Techniques ............................................................... 35
Figure 34 Analysis Report for Project Phases ...................................................................... 36
Figure 35 Analysis Report for Project Users ........................................................................ 37
Figure 36 User notes using keyword search ......................................................................... 38
Figure 37 View the selected note ......................................................................................... 38
Figure 38 Email draft in IFF ................................................................................................ 39
Figure 39 Email popup blocked ........................................................................................... 39
Figure 40 Outlook ............................................................................................................... 39
LIST OF TABLES
Table 1 Acronyms and Abbreviations.................................................................................... 7
Table 2 Internal Referred Document ..................................................................................... 8
Table 3 Tool Name and Tool Priority Order ........................................................................ 28
02 TB-16 I 01/12/2016 [0] 7 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
1. Introduction
Tools/Frameworks
1.1 Purpose
The objective of this document is to provide the procedure to operate the framework.
This document describes the user the steps involved in operating the Integrated Formal
Model-Based Framework (IFF) with proper screen shots of the framework at suitable stages.
1.2 Scope
The scope of this document is to recommend the user with the standard process for
using the Integrated Formal Model-Based Framework (IFF). Before using the framework, the
user should go through the user manual.
ACRONYMS/ABBREVIATIONS EXPANSION
2. Accessing IFF
To access IFF, user needs a login ID and password. Open the link https://IFF.com .
Enter the user name and password to login into IFF framework. All the users are classified as
User, Project leader and Admin. Accessibility is based on roles of the user.
a. Requirement
b. Architecture
c. Design
d. Coding
e. Testing
a. Formal
b. Informal
c. Model Based
d. Valid combination of above three
a. Go to https://localhost:8080/Iff/secure/welcomeUserPage.xhtml
02 TB-16 I 01/12/2016 [0] 10 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
a. Go to https://localhost:8080/Iff/secure/welcomeUserPage.xhtml
b. Click on “Add New Tool” push button in “Configuration” tab.
c. Select Browse to get executable path of the tool e.g.: “C:\Program Files\Osate
2.1.2\osate.exe”.
d. Fill in all the relevant fields.
e. Select the Phases(R, A, D, C, T) in which the tool could be used.
f. Assign the methodology.
g. Select the tool completion criteria and fill up the tool Input, Output requirements.
h. Click on Add tools to IFF
02 TB-16 I 01/12/2016 [0] 11 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
4. Project Setup
4.1 Project overview
Every project of IFF is organized as Project->Workflows->Phases-> Tools. Every
project has multiple work flows and every workflow can be multiple phased. It is depicted in
Figure 5.
a. Make sure the repository path where the project will be created is specified in select SCM
tool page (“SCM repository path in Server”).
b. Go to https://localhost:8080/Iff/secure/welcomeUserPage.xhtml
c. Click on “Create Project” push button in “Configuration” tab.
02 TB-16 I 01/12/2016 [0] 13 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
To create a workflow,
One can add additional phase completion criteria using the “phase completion
criteria” option from “Create Workflow” page.
02 TB-16 I 01/12/2016 [0] 16 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
5. Adding/Deleting Users
IFF being a web application, access is grated only after user registration.
Unlike other applications a user can be added only by admin of IFF.
1. User name
2. Email ID of the format user@domain.com
3. User ID is default set as UserName1, if User name is Username.
4. Default password will be generated – To be changed by user after first login.
Email ID should be unique for a user. E.g. two users can have same name as User One
and User One but Email ID cannot be UserOne@nal.com and UserOne@nal.com. Following
steps illustrate creation of new user:
User will appear in the list after creation. This is shown in figure 4.2.
Figure 13 User appear in User management list after adding into IFF
are, Tortoise SVN and ClearCase. Following is the procured to configure the TortoiseSVN
tool and new SCM commands.
1. Click on “select SCM Tool” button from the welcome page of IFF.
2. Select available SCM from the list as shown in Figure 16
3. Specify SCM repository root path in “SCM repository path in Server” field as show in
Figure 17
7. Project Organization
Project in IFF follows a typical V-Model as shown in figure 6.1. IFF Project consists
of a workflow and workflow is divided into different Phases. Phases in IFF are “R”, “A”,
“D”, “C”, “T”.
02 TB-16 I 01/12/2016 [0] 21 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
Every phase has input and output criteria, Documents/codes/others needed to start a
phase is considered as “Input criteria” of a Phase. Outcomes of a phase i.e.
Artifacts/documents/Codes/Qualification reports are considered as “Output criteria”. Project
leader shall specify Input and Output criteria. R, A, D, C, T are as follows;
1. Requirement (R): R-Phase is the first phase in a project. Typically it is the Requirement
stage of a V-Model. All necessary documents/codes/others are specified in this phase
using entry criteria. Output of this Phase after accomplishing certain tasks is considered
as output criteria.
2. Architecture (A): A-Phase is Architectural phase of a V-Model as shown in figure 6.1.
Input criteria of this phase could be output criteria of R-Phase or input from the workflow
3. Design (D): D-Phase is Design phase of a V-Model as shown in figure 6.1. Input criteria
of this phase could be output criteria of A-Phase or input from the workflow.
4. Coding (C): C-Phase is Coding phase of a V-Model as shown in figure 6.1. Input criteria
of this phase could be output criteria of D-Phase or input from the workflow
5. Testing (T): T-Phase is Testing phase of a V-Model as shown in figure 6.1. Input criteria
of this phase could be output criteria of C-Phase or input from the workflow
02 TB-16 I 01/12/2016 [0] 22 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
1. Version of a tool.
2. Tool qualification.
3. Methodology of the tool.
Tool methodologies are classified as,
a. Formal
b. Informal
c. Formal-Model based
d. Formal-Informal
e. Formal Model based
f. Formal-Informal-Modelbased.
Tools can be associated with one or more Phases of IFF. Tool cannot be used or
invoked in a phase if it is not associated to a phase. Following is the procedure to add a new
tool.
9. Adding Framework
Adding an external framework to IFF follows the same procedure as adding a tool.
2. Type of the system – Depending on the type of the system we are working on , Project
can be classified as follows;
a. Closed Loop system
b. Open loop system
c. Distributed System
d. Hybrid system
e. Modular system
f. Display system
g. Networked system
Based on the version of the IFF the system specification may change. More could be
added.
3. Domain – based on the domain in which we are working IFF project could of following
type
a. Aerospace civil
b. Aerospace Military
c. Nuclear
d. Automotive
e. Medical
f. Space
5. Criticality Level – based on the type of system we are working on, Domain, criticality
and criticality levels are defined. Considering Aerospace Civil for hybrid systems that are
of safety critical type, criticality levels are defined as RTCA DO-178B Level A, B, C, D,
E.
Before creating a project above considerations are to be made. Following are the steps
to create a project,
5. Specify the Project Entry and exit criteria, e.g. to start a project Requirement document
could be specified as Input criteria.
6. Click on Create project to create project in Specified repository path as shown in
figure(To be completed – considering confidentiality)
1. Select a workflow
2. Select a phase from the list of available phases as shown in Figure 23
02 TB-16 I 01/12/2016 [0] 27 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
3. Select the tool and click on Add Tool button to add the tool to selected phase. It is as
shown in figure 9.5
Tools added into phase have order number associated with it. Order defines the input
output relations of the tool with other tools in the list. Figure 24 illustrates the tool order.
Tool A 1
Tool B 2
02 TB-16 I 01/12/2016 [0] 28 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
Tool C 2
Tool D 3
Tool E 1
Tool F 4
Table 3 Tool Name and Tool Priority Order
Order of tool can be viewed as a stage, order 1 tools falls under stage one of the tool
chain, order 2 tools fall under stage 2 and so on. Tool’s outputs of stage 1 become tool’s
inputs in stage 2 and so on. Admin shall decide the tool order based on the Input output
relations of the tools used in a phase.
10.3 Phase completion criteria
Each Phase has completion criteria associated with it. If all the criteria are met only
then a phase is said to be complete. Phase criteria are collection of all the criteria of tools in
that phase.
Input criteria are the collection of all the criteria of the tool and output criteria is
collection of all tool output criteria. IFF allows defining additional criteria at phase level.
This is termed as Additional phase criteria. Figure shows how to add additional phase criteria
in a workflow. To add additional phase criteria click on “Phase completion criteria” and add
input or output criteria at phase level.
02 TB-16 I 01/12/2016 [0] 29 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
Once all the above procedures are complete a project is completely ready for users to start
working on it.
02 TB-16 I 01/12/2016 [0] 31 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
AutoPilot/Master/01_Requirement/reqZtool_1.0.0/Entry and
AutoPilot/Master/01_Requirement/reqZtool_1.0.0/Exit respectively.
Project Name
Workflow name
Phase (Requirement)
Phase entry criteria
Phase exit criteria
ReqZ tool in Requirement phase
Design Phase
Coding Phase
Testing Phase
Workflow Entry criteria
Workflow Entry criteria
Project Entry criteria
Project Entry criteria
12. Reports
IFF provides analysis report of Projects. Broadly there are two types of
reports, Analysis Graphs/Report and Traceability Report. Traceability report gives the entry
and exit criteria of in a project and the file paths that are associated with these. Traceability
and Analysis report can be generated at any stage of project.
02 TB-16 I 01/12/2016 [0] 33 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
1. Methodology – There are two bar graphs associated with methodologies. First,
Methodology graph provides information about how much of the project is executed
using which methodology. Second, gives how much time the methodology has taken to
accomplish the task. Graphs can be generated by selected different methodologies from
the dropdown menu of Methodologies. Figure 32 shows an example of this.
02 TB-16 I 01/12/2016 [0] 34 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
2. Techniques – Every workflow is of one type of technique. Analysis graph gives how
many workflows have these techniques. how much time each technique has taken in
executing a project, This is shown in Figure 33
02 TB-16 I 01/12/2016 [0] 35 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
3. Phases – Phase graph gives the Phase and project relationships. Graph shows number of
projects assigned to a phase. Time graph of phase gives the total time taken to complete a
particular phase. This is show in Figure 34.
02 TB-16 I 01/12/2016 [0] 36 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
4. Users – user graph gives the total time spent by user on a particular project. It also gives
the user assignment to a project. This is shown in Figure 35.
02 TB-16 I 01/12/2016 [0] 37 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
Once the tool is added, select the tool and launch tool from the Analyze Project page
to get access to IFF project data and hence the analysis reports.
02 TB-16 I 01/12/2016 [0] 38 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO
13.1 Notes
User can save a note and retrieve the notes. These notes are saved in IFF. All notes of
a particular day could be retrieved by selecting a calendar date as shown in Figure 36.
Retrieving the notes could be done either using a calendar note or by using the search
provided in the page. Figure 36 and Figure 37 show the two scenarios.
Figure 40 Outlook